iPXE
eepro100.h
Go to the documentation of this file.
1 
2 #ifndef __EEPRO100_H_
3 #define __EEPRO100_H_
4 
5 FILE_LICENCE ( GPL2_OR_LATER );
6 
7 #define CONGENB 0 /* Enable congestion control in the DP83840. */
8 #define TX_FIFO 8 /* Tx FIFO threshold in 4 byte units, 0-15 */
9 #define RX_FIFO 8 /* Rx FIFO threshold, default 32 bytes. */
10 #define TX_DMA_COUNT 0 /* Tx DMA burst length, 0-127, default 0. */
11 #define RX_DMA_COUNT 0 /* Rx DMA length, 0 means no preemption. */
12 #define CU_CMD_TIMEOUT 1000 /* CU command accept timeout in microseconds */
13 #define LINK_CHECK_PERIOD 1000 /* # of poll() calls between link checks */
14 
15 #define RFD_PACKET_LEN 1518
16 #define RFD_IOB_LEN 1536
17 #define RFD_HEADER_LEN 16
18 #define CB_ALIGN 2 /* Alignment of command blocks */
19 
20 #define RFD_COUNT 4
21 #define TCB_COUNT 4
22 #define RX_RING_BYTES ( RFD_COUNT * sizeof ( struct ifec_rfd ) )
23 #define TX_RING_BYTES ( TCB_COUNT * sizeof ( struct ifec_tcb ) )
24 
25 /* some EEPROM addresses */
26 #define EEPROM_ADDR_MAC_0 0
27 #define EEPROM_ADDR_MDIO_REGISTER 6
28 
29 /* Control / Status Register byte offsets - SDM Table 11 */
30 enum CSROffsets {
32  CSRPort=8, CSRFlash=12, CSREeprom = 14,
34 };
35 
36 /* System Control Block Command Word - SDM Table 12 */
37 enum SCBCmdBits {
38  /* SCB Interrupt Masks - SDM Table 14 */
41  SCBTriggerIntr=0x0200, SCBMaskAll=0x0100,
42  /* SCB Control Commands - SDM Table 14-16 */
43  CUStart=0x0010, CUResume=0x0020, CUStatsAddr=0x0040,
44  CUShowStats=0x0050, CUCmdBase=0x0060, CUDumpStats=0x0070,
45  RUStart=0x0001, RUResume=0x0002, RUAbort=0x0004,
47 };
48 
51 };
52 
53 /* Action Commands - SDM Table 14,37 */
56  CmdMulticastList = 3, CmdTx = 4, CmdTDR = 5,
57  CmdDump = 6, CmdDiagnose = 7,
58  /* And some extra flags: */
59  CmdEndOfList = 0x8000,
60  CmdSuspend = 0x4000, CmdIntr = 0x2000, CmdTxFlex = 0x0008
61 };
62 
63 enum TCBBits {
64  TCB_C=0x8000, TCB_OK=0x2000, TCB_U=0x1000
65 };
66 
67 enum RFDBits {
68  /* Status Word Bits */
69  RFDRxCol=0x0001, RFDIAMatch=0x0002, RFDNoMatch=0x0004,
70  RFDReserved3=0x0008, RFDRxErr=0x0010, RFDEthType=0x0020,
71  RFDReserved6=0x0040, RFDShort=0x0080, RFDDMAOverrun=0x0100,
72  RFDNoBufs=0x0200, RFDCRCAlign=0x0400, RFDCRCError=0x0800,
73  RFDReserved12=0x1000, RFD_OK=0x2000, RFDComplete=0x8000,
74  /* Command Word Bits */
75  //RFD_SF=0x0008, RFDSuspend=0x4000, RFDEndOfList=0x8000,
76  /* Other */
77  RFDMaskCount=0x3FFF
78 };
79 
80 enum phy_chips {
84 };
85 
86 /* Serial EEPROM section.
87  A "bit" grungy, but we work our way through bit-by-bit :->. */
88 /* EEPROM_Ctrl bits. */
89 #define EE_SHIFT_CLK 0x01 /* EEPROM shift clock. */
90 #define EE_CS 0x02 /* EEPROM chip select. */
91 #define EE_DATA_WRITE 0x04 /* EEPROM chip data in. */
92 #define EE_DATA_READ 0x08 /* EEPROM chip data out. */
93 #define EE_ENB ( 0x4800 | EE_CS )
94 
95 /* Elements of the dump_statistics block. This block must be lword aligned. */
96 struct ifec_stats {
97  u32
104 };
105 
106 struct ifec_tcb { /* A Transmit Command Block & TBD. Must be */
107  volatile s16 status; /* word (even address) aligned */
109  u32 link; /* PHYSICAL next ifec_tcb, doesn't change */
110  u32 tbda_addr; /* TBD Array, points to TBD below */
111  s32 count; /* # of TBD, Tx start thresh., etc. */
112  /* The following constitutes a Transmit Buffer Descriptor (TBD).
113  * TBDs must be aligned on an even address (word-aligned). */
114  u32 tbd_addr0; /* PHYSICAL ptr to Tx data */
115  s32 tbd_size0; /* Length of Tx data */
116  /* Driver-specific data; not part of TCB format. */
117  struct io_buffer *iob; /* Exists from tx() to completion poll() */
118  struct ifec_tcb *next; /* VIRTUAL next ifec_tcb, doesn't change */
119 };
120 
121 struct ifec_rfd { /* A Receive Frame Descriptor. Must be aligned */
122  volatile s16 status; /* on a physical word (even address) */
124  u32 link; /* PHYSICAL next ifec_rfd, doesn't change */
125  u32 rx_buf_addr; /* Unused. Flex rx mode is not documented */
126  u16 count; /* and may be impossible */
129 };
130 
131 struct ifec_ias { /* Individual Address Setup command block. */
132  volatile s16 status; /* Must be word (even address) aligned. */
134  u32 link; /* PHYSICAL next command block to process */
135  u8 ia[6];
136 };
137 
138 struct ifec_cfg { /* The configure command format. */
139  volatile s16 status;
141  u32 link; /* PHYSICAL next command block to process */
142  u8 byte[22]; /* 22 configuration bytes */
143 };
144 
145 struct ifec_private {
146  unsigned long ioaddr;
148  unsigned short mdio_register;
149 
150  struct ifec_tcb *tcbs;
155  int cur_rx;
156  int tx_curr;
157  int tx_tail;
158  int tx_cnt;
159  /*
160  * The configured flag indicates if a Config command was last issued.
161  * The following attempt to issue a command (in ifec_tx_wake) will
162  * use a START rather than RESUME SCB command. It seems the card won't
163  * RESUME after a configure command.
164  */
168 
169 };
170 
171 /**************************** Function prototypes ****************************/
172 
173 /* PCI device API prototypes */
174 static int ifec_pci_probe ( struct pci_device *pci );
175 static void ifec_pci_remove ( struct pci_device *pci );
176 
177 /* Network device API prototypes */
178 static void ifec_net_close ( struct net_device* );
179 static void ifec_net_irq ( struct net_device*, int enable );
180 static int ifec_net_open ( struct net_device* );
181 static void ifec_net_poll ( struct net_device* );
182 static int ifec_net_transmit ( struct net_device*, struct io_buffer *iobuf );
183 
184 /* Local function prototypes */
185 static void ifec_init_eeprom ( struct net_device * );
186 static int ifec_mdio_read ( struct net_device *, int phy, int location );
187 static void ifec_mdio_setup ( struct net_device *, int options );
188 static int ifec_mdio_write ( struct net_device *, int phy, int loc, int val);
189 static void ifec_reset ( struct net_device * );
190 static void ifec_free ( struct net_device * );
191 static void ifec_rfd_init ( struct ifec_rfd *rfd, s16 command, u32 link );
192 static void ifec_rx_process ( struct net_device * );
193 static void ifec_reprime_ru ( struct net_device * );
194 static void ifec_check_ru_status ( struct net_device *, unsigned short );
195 static int ifec_get_rx_desc ( struct net_device *, int ,int ,int );
196 static void ifec_refill_rx_ring ( struct net_device * );
197 static int ifec_rx_setup ( struct net_device * );
198 static int ifec_scb_cmd ( struct net_device *, u32 ptr, u8 cmd );
199 static int ifec_scb_cmd_wait ( struct net_device * );
200 static void ifec_tx_process ( struct net_device * );
201 static int ifec_tx_setup ( struct net_device * );
202 static void ifec_tx_wake ( struct net_device * );
203 
204 #endif
s16 command
Definition: eepro100.h:123
uint16_t u16
Definition: stdint.h:21
static void ifec_rfd_init(struct ifec_rfd *rfd, s16 command, u32 link)
u32 rx_align_errs
Definition: eepro100.h:98
struct spi_bit_basher spi
Definition: eepro100.h:166
u32 tx_one_colls
Definition: eepro100.h:98
int16_t s16
Definition: stdint.h:20
static int ifec_mdio_read(struct net_device *, int phy, int location)
u16 command
Definition: eepro100.h:133
u16 size
Definition: eepro100.h:127
u32 tbda_addr
Definition: eepro100.h:110
static int ifec_scb_cmd_wait(struct net_device *)
int32_t s32
Definition: stdint.h:22
s32 tbd_size0
Definition: eepro100.h:115
A command-line command.
Definition: command.h:9
u32 link
Definition: eepro100.h:141
static void ifec_net_irq(struct net_device *, int enable)
u32 tx_multi_colls
Definition: eepro100.h:98
SCBCmdBits
Definition: eepro100.h:37
static void ifec_reprime_ru(struct net_device *)
Definition: eepro100.h:56
u32 rx_good_frames
Definition: eepro100.h:98
volatile s16 status
Definition: eepro100.h:122
struct io_buffer * rx_iobs[RFD_COUNT]
Definition: eepro100.h:154
static void ifec_check_ru_status(struct net_device *, unsigned short)
u32 tx_underruns
Definition: eepro100.h:98
s32 count
Definition: eepro100.h:111
struct io_buffer * iob
Definition: eepro100.h:117
struct ifec_tcb * tcb_tail
Definition: eepro100.h:152
u32 link
Definition: eepro100.h:124
struct ifec_stats stats
Definition: eepro100.h:147
u32 done_marker
Definition: eepro100.h:98
u32 rx_buf_addr
Definition: eepro100.h:125
u32 rx_runt_errs
Definition: eepro100.h:98
u8 ia[6]
Definition: eepro100.h:135
eeprom
Definition: 3c90x.h:232
volatile s16 status
Definition: eepro100.h:139
u32 rx_colls_errs
Definition: eepro100.h:98
u32 tbd_addr0
Definition: eepro100.h:114
static void ifec_reset(struct net_device *)
static void ifec_net_close(struct net_device *)
TCBBits
Definition: eepro100.h:63
static int ifec_pci_probe(struct pci_device *pci)
u32 tx_good_frames
Definition: eepro100.h:98
static int options
Definition: 3c515.c:286
struct ifec_tcb * tcbs
Definition: eepro100.h:150
static int ifec_mdio_write(struct net_device *, int phy, int loc, int val)
Definition: eepro100.h:64
u16 command
Definition: eepro100.h:140
u32 link
Link to next descriptor.
Definition: ar9003_mac.h:68
struct ifec_rfd * rfds[RFD_COUNT]
Definition: eepro100.h:151
volatile s16 status
Definition: eepro100.h:107
phy_chips
Definition: eepro100.h:80
A bit-bashing SPI bus.
Definition: spi_bit.h:16
static void ifec_free(struct net_device *)
u32 tx_deferred
Definition: eepro100.h:98
static int ifec_get_rx_desc(struct net_device *, int, int, int)
u32 tx_late_colls
Definition: eepro100.h:98
static int ifec_net_transmit(struct net_device *, struct io_buffer *iobuf)
struct ifec_tcb * next
Definition: eepro100.h:118
struct io_buffer * tx_iobs[TCB_COUNT]
Definition: eepro100.h:153
A PCI device.
Definition: pci.h:187
A network device.
Definition: netdevice.h:348
u32 tx_total_colls
Definition: eepro100.h:98
char packet[RFD_PACKET_LEN]
Definition: eepro100.h:128
void __asmcall int val
Definition: setjmp.h:28
static void ifec_mdio_setup(struct net_device *, int options)
RFDBits
Definition: eepro100.h:67
unsigned short mdio_register
Definition: eepro100.h:148
u16 count
Definition: eepro100.h:126
u32 tx_coll16_errs
Definition: eepro100.h:98
SCBPortCmds
Definition: eepro100.h:49
static void ifec_tx_process(struct net_device *)
#define RFD_COUNT
Definition: eepro100.h:20
unsigned long ioaddr
Definition: eepro100.h:146
u32 rx_resource_errs
Definition: eepro100.h:98
Definition: eepro100.h:64
u16 command
Definition: eepro100.h:108
#define RFD_PACKET_LEN
Definition: eepro100.h:15
static int ifec_tx_setup(struct net_device *)
static int ifec_net_open(struct net_device *)
ActionCommands
Definition: eepro100.h:54
An SPI device.
Definition: spi.h:86
CSROffsets
Definition: eepro100.h:30
u32 rx_crc_errs
Definition: eepro100.h:98
static void ifec_rx_process(struct net_device *)
u32 rx_overrun_errs
Definition: eepro100.h:98
u32 link
Definition: eepro100.h:134
volatile s16 status
Definition: eepro100.h:132
int configured
Definition: eepro100.h:165
u32 link
Definition: eepro100.h:109
u32 tx_lost_carrier
Definition: eepro100.h:98
struct ifec_tcb * tcb_head
Definition: eepro100.h:152
static int ifec_rx_setup(struct net_device *)
FILE_LICENCE(GPL2_OR_LATER)
#define TCB_COUNT
Definition: eepro100.h:21
struct golan_eqe_cmd cmd
Definition: CIB_PRM.h:29
static void ifec_init_eeprom(struct net_device *)
static int ifec_scb_cmd(struct net_device *, u32 ptr, u8 cmd)
static void ifec_refill_rx_ring(struct net_device *)
uint8_t u8
Definition: stdint.h:19
static void ifec_tx_wake(struct net_device *)
Definition: eepro100.c:1072
uint32_t u32
Definition: stdint.h:23
static void ifec_pci_remove(struct pci_device *pci)
A persistent I/O buffer.
Definition: iobuf.h:32
static void ifec_net_poll(struct net_device *)