[deliverable/linux.git] / drivers / net / fec.h

/****************************************************************************/

/*
 *	fec.h  --  Fast Ethernet Controller for Motorola ColdFire SoC
 *		   processors.
 *
 *	(C) Copyright 2000-2005, Greg Ungerer (gerg@snapgear.com)
 *	(C) Copyright 2000-2001, Lineo (www.lineo.com)
 */

/****************************************************************************/
#ifndef FEC_H
#define	FEC_H
/****************************************************************************/

#if defined(CONFIG_M523x) || defined(CONFIG_M527x) || defined(CONFIG_M528x) || \
    defined(CONFIG_M520x) || defined(CONFIG_M532x) || defined(CONFIG_ARCH_MXC)
/*
 *	Just figures, Motorola would have to change the offsets for
 *	registers in the same peripheral device on different models
 *	of the ColdFire!
 */
typedef struct fec {
	unsigned long	fec_reserved0;
	unsigned long	fec_ievent;		/* Interrupt event reg */
	unsigned long	fec_imask;		/* Interrupt mask reg */
	unsigned long	fec_reserved1;
	unsigned long	fec_r_des_active;	/* Receive descriptor reg */
	unsigned long	fec_x_des_active;	/* Transmit descriptor reg */
	unsigned long	fec_reserved2[3];
	unsigned long	fec_ecntrl;		/* Ethernet control reg */
	unsigned long	fec_reserved3[6];
	unsigned long	fec_mii_data;		/* MII manage frame reg */
	unsigned long	fec_mii_speed;		/* MII speed control reg */
	unsigned long	fec_reserved4[7];
	unsigned long	fec_mib_ctrlstat;	/* MIB control/status reg */
	unsigned long	fec_reserved5[7];
	unsigned long	fec_r_cntrl;		/* Receive control reg */
	unsigned long	fec_reserved6[15];
	unsigned long	fec_x_cntrl;		/* Transmit Control reg */
	unsigned long	fec_reserved7[7];
	unsigned long	fec_addr_low;		/* Low 32bits MAC address */
	unsigned long	fec_addr_high;		/* High 16bits MAC address */
	unsigned long	fec_opd;		/* Opcode + Pause duration */
	unsigned long	fec_reserved8[10];
	unsigned long	fec_hash_table_high;	/* High 32bits hash table */
	unsigned long	fec_hash_table_low;	/* Low 32bits hash table */
	unsigned long	fec_grp_hash_table_high;/* High 32bits hash table */
	unsigned long	fec_grp_hash_table_low;	/* Low 32bits hash table */
	unsigned long	fec_reserved9[7];
	unsigned long	fec_x_wmrk;		/* FIFO transmit water mark */
	unsigned long	fec_reserved10;
	unsigned long	fec_r_bound;		/* FIFO receive bound reg */
	unsigned long	fec_r_fstart;		/* FIFO receive start reg */
	unsigned long	fec_reserved11[11];
	unsigned long	fec_r_des_start;	/* Receive descriptor ring */
	unsigned long	fec_x_des_start;	/* Transmit descriptor ring */
	unsigned long	fec_r_buff_size;	/* Maximum receive buff size */
} fec_t;

#else

/*
 *	Define device register set address map.
 */
typedef struct fec {
	unsigned long	fec_ecntrl;		/* Ethernet control reg */
	unsigned long	fec_ievent;		/* Interrupt even reg */
	unsigned long	fec_imask;		/* Interrupt mask reg */
	unsigned long	fec_ivec;		/* Interrupt vec status reg */
	unsigned long	fec_r_des_active;	/* Receive descriptor reg */
	unsigned long	fec_x_des_active;	/* Transmit descriptor reg */
	unsigned long	fec_reserved1[10];
	unsigned long	fec_mii_data;		/* MII manage frame reg */
	unsigned long	fec_mii_speed;		/* MII speed control reg */
	unsigned long	fec_reserved2[17];
	unsigned long	fec_r_bound;		/* FIFO receive bound reg */
	unsigned long	fec_r_fstart;		/* FIFO receive start reg */
	unsigned long	fec_reserved3[4];
	unsigned long	fec_x_wmrk;		/* FIFO transmit water mark */
	unsigned long	fec_reserved4;
	unsigned long	fec_x_fstart;		/* FIFO transmit start reg */
	unsigned long	fec_reserved5[21];
	unsigned long	fec_r_cntrl;		/* Receive control reg */
	unsigned long	fec_max_frm_len;	/* Maximum frame length reg */
	unsigned long	fec_reserved6[14];
	unsigned long	fec_x_cntrl;		/* Transmit Control reg */
	unsigned long	fec_reserved7[158];
	unsigned long	fec_addr_low;		/* Low 32bits MAC address */
	unsigned long	fec_addr_high;		/* High 16bits MAC address */
	unsigned long	fec_grp_hash_table_high;/* High 32bits hash table */
	unsigned long	fec_grp_hash_table_low;	/* Low 32bits hash table */
	unsigned long	fec_r_des_start;	/* Receive descriptor ring */
	unsigned long	fec_x_des_start;	/* Transmit descriptor ring */
	unsigned long	fec_r_buff_size;	/* Maximum receive buff size */
	unsigned long	reserved8[9];
	unsigned long	fec_fifo_ram[112];	/* FIFO RAM buffer */
} fec_t;

#endif /* CONFIG_M5272 */


/*
 *	Define the buffer descriptor structure.
 */
#ifdef CONFIG_ARCH_MXC
typedef struct bufdesc {
	unsigned short cbd_datlen;	/* Data length */
	unsigned short cbd_sc;	/* Control and status info */
	unsigned long cbd_bufaddr;	/* Buffer address */
} cbd_t;
#else
typedef struct bufdesc {
	unsigned short	cbd_sc;			/* Control and status info */
	unsigned short	cbd_datlen;		/* Data length */
	unsigned long	cbd_bufaddr;		/* Buffer address */
} cbd_t;
#endif

/*
 *	The following definitions courtesy of commproc.h, which where
 *	Copyright (c) 1997 Dan Malek (dmalek@jlc.net).
 */
#define BD_SC_EMPTY     ((ushort)0x8000)        /* Recieve is empty */
#define BD_SC_READY     ((ushort)0x8000)        /* Transmit is ready */
#define BD_SC_WRAP      ((ushort)0x2000)        /* Last buffer descriptor */
#define BD_SC_INTRPT    ((ushort)0x1000)        /* Interrupt on change */
#define BD_SC_CM        ((ushort)0x0200)        /* Continous mode */
#define BD_SC_ID        ((ushort)0x0100)        /* Rec'd too many idles */
#define BD_SC_P         ((ushort)0x0100)        /* xmt preamble */
#define BD_SC_BR        ((ushort)0x0020)        /* Break received */
#define BD_SC_FR        ((ushort)0x0010)        /* Framing error */
#define BD_SC_PR        ((ushort)0x0008)        /* Parity error */
#define BD_SC_OV        ((ushort)0x0002)        /* Overrun */
#define BD_SC_CD        ((ushort)0x0001)        /* ?? */

/* Buffer descriptor control/status used by Ethernet receive.
*/
#define BD_ENET_RX_EMPTY        ((ushort)0x8000)
#define BD_ENET_RX_WRAP         ((ushort)0x2000)
#define BD_ENET_RX_INTR         ((ushort)0x1000)
#define BD_ENET_RX_LAST         ((ushort)0x0800)
#define BD_ENET_RX_FIRST        ((ushort)0x0400)
#define BD_ENET_RX_MISS         ((ushort)0x0100)
#define BD_ENET_RX_LG           ((ushort)0x0020)
#define BD_ENET_RX_NO           ((ushort)0x0010)
#define BD_ENET_RX_SH           ((ushort)0x0008)
#define BD_ENET_RX_CR           ((ushort)0x0004)
#define BD_ENET_RX_OV           ((ushort)0x0002)
#define BD_ENET_RX_CL           ((ushort)0x0001)
#define BD_ENET_RX_STATS        ((ushort)0x013f)        /* All status bits */

/* Buffer descriptor control/status used by Ethernet transmit.
*/
#define BD_ENET_TX_READY        ((ushort)0x8000)
#define BD_ENET_TX_PAD          ((ushort)0x4000)
#define BD_ENET_TX_WRAP         ((ushort)0x2000)
#define BD_ENET_TX_INTR         ((ushort)0x1000)
#define BD_ENET_TX_LAST         ((ushort)0x0800)
#define BD_ENET_TX_TC           ((ushort)0x0400)
#define BD_ENET_TX_DEF          ((ushort)0x0200)
#define BD_ENET_TX_HB           ((ushort)0x0100)
#define BD_ENET_TX_LC           ((ushort)0x0080)
#define BD_ENET_TX_RL           ((ushort)0x0040)
#define BD_ENET_TX_RCMASK       ((ushort)0x003c)
#define BD_ENET_TX_UN           ((ushort)0x0002)
#define BD_ENET_TX_CSL          ((ushort)0x0001)
#define BD_ENET_TX_STATS        ((ushort)0x03ff)        /* All status bits */


/****************************************************************************/
#endif /* FEC_H */
Commit	Line	Data
1da177e4 LT	1	/****************************************************************************/
	2
	3	/*
7a77d918 GU	4	* fec.h -- Fast Ethernet Controller for Motorola ColdFire SoC
7a77d918 GU	5	* processors.
1da177e4	6	*
7a77d918	7	* (C) Copyright 2000-2005, Greg Ungerer (gerg@snapgear.com)
1da177e4 LT	8	* (C) Copyright 2000-2001, Lineo (www.lineo.com)
	9	*/
	10
	11	/****************************************************************************/
	12	#ifndef FEC_H
	13	#define FEC_H
	14	/****************************************************************************/
	15
7a77d918	16	#if defined(CONFIG_M523x) \|\| defined(CONFIG_M527x) \|\| defined(CONFIG_M528x) \|\| \
196719ec	17	defined(CONFIG_M520x) \|\| defined(CONFIG_M532x) \|\| defined(CONFIG_ARCH_MXC)
1da177e4 LT	18	/*
	19	* Just figures, Motorola would have to change the offsets for
	20	* registers in the same peripheral device on different models
	21	* of the ColdFire!
	22	*/
	23	typedef struct fec {
	24	unsigned long fec_reserved0;
	25	unsigned long fec_ievent; /* Interrupt event reg */
	26	unsigned long fec_imask; /* Interrupt mask reg */
	27	unsigned long fec_reserved1;
	28	unsigned long fec_r_des_active; /* Receive descriptor reg */
	29	unsigned long fec_x_des_active; /* Transmit descriptor reg */
	30	unsigned long fec_reserved2[3];
	31	unsigned long fec_ecntrl; /* Ethernet control reg */
	32	unsigned long fec_reserved3[6];
	33	unsigned long fec_mii_data; /* MII manage frame reg */
	34	unsigned long fec_mii_speed; /* MII speed control reg */
	35	unsigned long fec_reserved4[7];
	36	unsigned long fec_mib_ctrlstat; /* MIB control/status reg */
	37	unsigned long fec_reserved5[7];
	38	unsigned long fec_r_cntrl; /* Receive control reg */
	39	unsigned long fec_reserved6[15];
	40	unsigned long fec_x_cntrl; /* Transmit Control reg */
	41	unsigned long fec_reserved7[7];
	42	unsigned long fec_addr_low; /* Low 32bits MAC address */
	43	unsigned long fec_addr_high; /* High 16bits MAC address */
	44	unsigned long fec_opd; /* Opcode + Pause duration */
	45	unsigned long fec_reserved8[10];
	46	unsigned long fec_hash_table_high; /* High 32bits hash table */
	47	unsigned long fec_hash_table_low; /* Low 32bits hash table */
	48	unsigned long fec_grp_hash_table_high;/* High 32bits hash table */
	49	unsigned long fec_grp_hash_table_low; /* Low 32bits hash table */
	50	unsigned long fec_reserved9[7];
	51	unsigned long fec_x_wmrk; /* FIFO transmit water mark */
	52	unsigned long fec_reserved10;
	53	unsigned long fec_r_bound; /* FIFO receive bound reg */
	54	unsigned long fec_r_fstart; /* FIFO receive start reg */
	55	unsigned long fec_reserved11[11];
	56	unsigned long fec_r_des_start; /* Receive descriptor ring */
	57	unsigned long fec_x_des_start; /* Transmit descriptor ring */
	58	unsigned long fec_r_buff_size; /* Maximum receive buff size */
	59	} fec_t;
	60
	61	#else
	62
	63	/*
	64	* Define device register set address map.
	65	*/
	66	typedef struct fec {
	67	unsigned long fec_ecntrl; /* Ethernet control reg */
	68	unsigned long fec_ievent; /* Interrupt even reg */
	69	unsigned long fec_imask; /* Interrupt mask reg */
	70	unsigned long fec_ivec; /* Interrupt vec status reg */
	71	unsigned long fec_r_des_active; /* Receive descriptor reg */
	72	unsigned long fec_x_des_active; /* Transmit descriptor reg */
	73	unsigned long fec_reserved1[10];
	74	unsigned long fec_mii_data; /* MII manage frame reg */
	75	unsigned long fec_mii_speed; /* MII speed control reg */
	76	unsigned long fec_reserved2[17];
	77	unsigned long fec_r_bound; /* FIFO receive bound reg */
	78	unsigned long fec_r_fstart; /* FIFO receive start reg */
	79	unsigned long fec_reserved3[4];
	80	unsigned long fec_x_wmrk; /* FIFO transmit water mark */
	81	unsigned long fec_reserved4;
82	unsigned long fec_x_fstart; /* FIFO transmit start reg */
83	unsigned long fec_reserved5[21];
84	unsigned long fec_r_cntrl; /* Receive control reg */
85	unsigned long fec_max_frm_len; /* Maximum frame length reg */
86	unsigned long fec_reserved6[14];
87	unsigned long fec_x_cntrl; /* Transmit Control reg */
88	unsigned long fec_reserved7[158];
89	unsigned long fec_addr_low; /* Low 32bits MAC address */
90	unsigned long fec_addr_high; /* High 16bits MAC address */
cc462f7d GU	91	unsigned long fec_grp_hash_table_high;/* High 32bits hash table */
cc462f7d GU	92	unsigned long fec_grp_hash_table_low; /* Low 32bits hash table */
1da177e4 LT	93	unsigned long fec_r_des_start; /* Receive descriptor ring */
	94	unsigned long fec_x_des_start; /* Transmit descriptor ring */
	95	unsigned long fec_r_buff_size; /* Maximum receive buff size */
	96	unsigned long reserved8[9];
	97	unsigned long fec_fifo_ram[112]; /* FIFO RAM buffer */
	98	} fec_t;
	99
	100	#endif /* CONFIG_M5272 */
	101
	102
	103	/*
	104	* Define the buffer descriptor structure.
	105	*/
196719ec SH	106	#ifdef CONFIG_ARCH_MXC
	107	typedef struct bufdesc {
	108	unsigned short cbd_datlen; /* Data length */
	109	unsigned short cbd_sc; /* Control and status info */
	110	unsigned long cbd_bufaddr; /* Buffer address */
	111	} cbd_t;
	112	#else
1da177e4 LT	113	typedef struct bufdesc {
	114	unsigned short cbd_sc; /* Control and status info */
	115	unsigned short cbd_datlen; /* Data length */
	116	unsigned long cbd_bufaddr; /* Buffer address */
	117	} cbd_t;
196719ec	118	#endif
1da177e4 LT	119
	120	/*
	121	* The following definitions courtesy of commproc.h, which where
	122	* Copyright (c) 1997 Dan Malek (dmalek@jlc.net).
	123	*/
	124	#define BD_SC_EMPTY ((ushort)0x8000) /* Recieve is empty */
	125	#define BD_SC_READY ((ushort)0x8000) /* Transmit is ready */
	126	#define BD_SC_WRAP ((ushort)0x2000) /* Last buffer descriptor */
	127	#define BD_SC_INTRPT ((ushort)0x1000) /* Interrupt on change */
	128	#define BD_SC_CM ((ushort)0x0200) /* Continous mode */
	129	#define BD_SC_ID ((ushort)0x0100) /* Rec'd too many idles */
	130	#define BD_SC_P ((ushort)0x0100) /* xmt preamble */
	131	#define BD_SC_BR ((ushort)0x0020) /* Break received */
	132	#define BD_SC_FR ((ushort)0x0010) /* Framing error */
	133	#define BD_SC_PR ((ushort)0x0008) /* Parity error */
	134	#define BD_SC_OV ((ushort)0x0002) /* Overrun */
	135	#define BD_SC_CD ((ushort)0x0001) /* ?? */
	136
	137	/* Buffer descriptor control/status used by Ethernet receive.
	138	*/
	139	#define BD_ENET_RX_EMPTY ((ushort)0x8000)
	140	#define BD_ENET_RX_WRAP ((ushort)0x2000)
	141	#define BD_ENET_RX_INTR ((ushort)0x1000)
	142	#define BD_ENET_RX_LAST ((ushort)0x0800)
	143	#define BD_ENET_RX_FIRST ((ushort)0x0400)
	144	#define BD_ENET_RX_MISS ((ushort)0x0100)
	145	#define BD_ENET_RX_LG ((ushort)0x0020)
	146	#define BD_ENET_RX_NO ((ushort)0x0010)
	147	#define BD_ENET_RX_SH ((ushort)0x0008)
	148	#define BD_ENET_RX_CR ((ushort)0x0004)
	149	#define BD_ENET_RX_OV ((ushort)0x0002)
	150	#define BD_ENET_RX_CL ((ushort)0x0001)
	151	#define BD_ENET_RX_STATS ((ushort)0x013f) /* All status bits */
	152
	153	/* Buffer descriptor control/status used by Ethernet transmit.
	154	*/
	155	#define BD_ENET_TX_READY ((ushort)0x8000)
	156	#define BD_ENET_TX_PAD ((ushort)0x4000)
	157	#define BD_ENET_TX_WRAP ((ushort)0x2000)
	158	#define BD_ENET_TX_INTR ((ushort)0x1000)
	159	#define BD_ENET_TX_LAST ((ushort)0x0800)
	160	#define BD_ENET_TX_TC ((ushort)0x0400)
	161	#define BD_ENET_TX_DEF ((ushort)0x0200)
	162	#define BD_ENET_TX_HB ((ushort)0x0100)
	163	#define BD_ENET_TX_LC ((ushort)0x0080)
	164	#define BD_ENET_TX_RL ((ushort)0x0040)
	165	#define BD_ENET_TX_RCMASK ((ushort)0x003c)
	166	#define BD_ENET_TX_UN ((ushort)0x0002)
	167	#define BD_ENET_TX_CSL ((ushort)0x0001)
	168	#define BD_ENET_TX_STATS ((ushort)0x03ff) /* All status bits */
	169
	170
	171	/****************************************************************************/
	172	#endif /* FEC_H */