Merge remote-tracking branch 'hofmann/wlan_serialize'
[dragonfly.git] / sys / dev / netif / re / if_rereg.h
1 /*
2  * Copyright (c) 2004
3  *      Joerg Sonnenberger <joerg@bec.de>.  All rights reserved.
4  *
5  * Copyright (c) 1997, 1998-2003
6  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by Bill Paul.
19  * 4. Neither the name of the author nor the names of any co-contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
33  * THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  * $FreeBSD: src/sys/pci/if_rlreg.h,v 1.42 2004/05/24 19:39:23 jhb Exp $
36  */
37
38 /*
39  * RealTek 8129/8139 register offsets
40  */
41 #define RE_IDR0         0x0000          /* ID register 0 (station addr) */
42 #define RE_IDR1         0x0001          /* Must use 32-bit accesses (?) */
43 #define RE_IDR2         0x0002
44 #define RE_IDR3         0x0003
45 #define RE_IDR4         0x0004
46 #define RE_IDR5         0x0005
47                                         /* 0006-0007 reserved */
48 #define RE_MAR0         0x0008          /* Multicast hash table */
49 #define RE_MAR1         0x0009
50 #define RE_MAR2         0x000A
51 #define RE_MAR3         0x000B
52 #define RE_MAR4         0x000C
53 #define RE_MAR5         0x000D
54 #define RE_MAR6         0x000E
55 #define RE_MAR7         0x000F
56
57 #define RE_RXADDR               0x0030  /* RX ring start address */
58 #define RE_RX_EARLY_BYTES       0x0034  /* RX early byte count */
59 #define RE_RX_EARLY_STAT        0x0036  /* RX early status */
60 #define RE_COMMAND      0x0037          /* command register */
61 #define RE_CURRXADDR    0x0038          /* current address of packet read */
62 #define RE_CURRXBUF     0x003A          /* current RX buffer address */
63 #define RE_IMR          0x003C          /* interrupt mask register */
64 #define RE_ISR          0x003E          /* interrupt status register */
65 #define RE_TXCFG        0x0040          /* transmit config */
66 #define RE_RXCFG        0x0044          /* receive config */
67 #define RE_TIMERCNT     0x0048          /* timer count register */
68 #define RE_MISSEDPKT    0x004C          /* missed packet counter */
69 #define RE_EECMD        0x0050          /* EEPROM command register */
70 #define RE_CFG0         0x0051          /* config register #0 */
71 #define RE_CFG1         0x0052          /* config register #1 */
72 #define RE_CFG2         0x0053          /* config register #2 */
73                                         /* 0054-0057 reserved */   
74 #define RE_MEDIASTAT    0x0058          /* media status register (8139) */
75                                         /* 0059-005A reserved */
76 #define RE_MII          0x005A          /* 8129 chip only */
77 #define RE_HALTCLK      0x005B
78 #define RE_MULTIINTR    0x005C          /* multiple interrupt */
79 #define RE_PCIREV       0x005E          /* PCI revision value */
80                                         /* 005F reserved */
81 #define RE_TXSTAT_ALL   0x0060          /* TX status of all descriptors */
82
83 /* Direct PHY access registers only available on 8139 */
84 #define RE_BMCR         0x0062          /* PHY basic mode control */
85 #define RE_BMSR         0x0064          /* PHY basic mode status */
86 #define RE_ANAR         0x0066          /* PHY autoneg advert */
87 #define RE_LPAR         0x0068          /* PHY link partner ability */
88 #define RE_ANER         0x006A          /* PHY autoneg expansion */
89
90 #define RE_DISCCNT      0x006C          /* disconnect counter */
91 #define RE_FALSECAR     0x006E          /* false carrier counter */
92 #define RE_NWAYTST      0x0070          /* NWAY test register */
93 #define RE_RX_ER        0x0072          /* RX_ER counter */
94 #define RE_CSCFG        0x0074          /* CS configuration register */
95
96 /*
97  * When operating in special C+ mode, some of the registers in an
98  * 8139C+ chip have different definitions. These are also used for
99  * the 8169 gigE chip.
100  */
101 #define RE_DUMPSTATS_LO         0x0010  /* counter dump command register */
102 #define RE_DUMPSTATS_HI         0x0014  /* counter dump command register */
103 #define RE_TXLIST_ADDR_LO       0x0020  /* 64 bits, 256 byte alignment */
104 #define RE_TXLIST_ADDR_HI       0x0024  /* 64 bits, 256 byte alignment */
105 #define RE_TXLIST_ADDR_HPRIO_LO 0x0028  /* 64 bits, 256 byte alignment */
106 #define RE_TXLIST_ADDR_HPRIO_HI 0x002C  /* 64 bits, 256 byte alignment */
107 #define RE_CFG2                 0x0053
108 #define RE_TIMERINT             0x0054  /* interrupt on timer expire */
109 #define RE_TXSTART              0x00D9  /* 8 bits */
110 #define RE_CPLUS_CMD            0x00E0  /* 16 bits */
111 #define RE_IM                   0x00E2  /* 16 bits */
112 #define RE_RXLIST_ADDR_LO       0x00E4  /* 64 bits, 256 byte alignment */
113 #define RE_RXLIST_ADDR_HI       0x00E8  /* 64 bits, 256 byte alignment */
114 #define RE_EARLY_TX_THRESH      0x00EC  /* 8 bits */
115
116 /*
117  * Registers specific to the 8169 gigE chip
118  */
119 #define RE_TIMERINT_8169        0x0058  /* different offset than 8139 */
120 #define RE_PHYAR                0x0060
121 #define RE_TBICSR               0x0064
122 #define RE_TBI_ANAR             0x0068
123 #define RE_TBI_LPAR             0x006A
124 #define RE_GMEDIASTAT           0x006C  /* 8 bits */
125 #define RE_MAXRXPKTLEN          0x00DA  /* 16 bits, chip multiplies by 8 */
126 #define RE_GTXSTART             0x0038  /* 16 bits */
127
128 /*
129  * TX config register bits
130  */
131 #define RE_TXCFG_CLRABRT        0x00000001      /* retransmit aborted pkt */
132 #define RE_TXCFG_MAXDMA         0x00000700      /* max DMA burst size */
133 #define RE_TXCFG_CRCAPPEND      0x00010000      /* CRC append (0 = yes) */
134 #define RE_TXCFG_LOOPBKTST      0x00060000      /* loopback test */
135 #define RE_TXCFG_IFG2           0x00080000      /* 8169 only */
136 #define RE_TXCFG_IFG            0x03000000      /* interframe gap */
137 #define RE_TXCFG_HWREV          0xFC800000
138 #define RE_TXCFG_MACMODE        0x00700000
139
140 /*
141  * Config 2 register bits
142  */
143 #define RE_CFG2_PCICLK_MASK     0x07
144 #define RE_CFG2_PCICLK_33MHZ    0x00
145 #define RE_CFG2_PCICLK_66MHZ    0x01
146 #define RE_CFG2_PCI64           0x08
147
148 #define RE_LOOPTEST_OFF         0x00000000
149 #define RE_LOOPTEST_ON          0x00020000
150 #define RE_LOOPTEST_ON_CPLUS    0x00060000
151
152 #define RE_HWREV_8169           0x00000000
153 #define RE_HWREV_8110S          0x00800000
154 #define RE_HWREV_8169S          0x04000000
155 #define RE_HWREV_8169SB         0x10000000
156 #define RE_HWREV_8169SC1        0x18000000
157 #define RE_HWREV_8102EL         0x24800000
158 #define RE_HWREV_8168D          0x28000000
159 #define RE_HWREV_8168DP         0x28800000
160 #define RE_HWREV_8168E          0x2C000000
161 #define RE_HWREV_8168F          0x2C800000
162 #define RE_HWREV_8168B1         0x30000000
163 #define RE_HWREV_8100E          0x30800000
164 #define RE_HWREV_8101E1         0x34000000
165 #define RE_HWREV_8102E          0x34800000
166 #define RE_HWREV_8168B2         0x38000000
167 #define RE_HWREV_8168C          0x3C000000
168 #define RE_HWREV_8168CP         0x3C800000
169 #define RE_HWREV_8105E          0x40800000
170 #define RE_HWREV_8111F          0x48000000
171 #define RE_HWREV_8139CPLUS      0x74800000
172 #define RE_HWREV_8169SC2        0x98000000
173 #define RE_HWREV_8101E2         0xB4000000
174 #define RE_HWREV_8168B3         0xB8000000
175 #define RE_HWREV_NULL           0xffffffff
176
177 #define RE_TXDMA_16BYTES        0x00000000
178 #define RE_TXDMA_32BYTES        0x00000100
179 #define RE_TXDMA_64BYTES        0x00000200
180 #define RE_TXDMA_128BYTES       0x00000300
181 #define RE_TXDMA_256BYTES       0x00000400
182 #define RE_TXDMA_512BYTES       0x00000500
183 #define RE_TXDMA_1024BYTES      0x00000600
184 #define RE_TXDMA_2048BYTES      0x00000700
185
186 /*
187  * Transmit descriptor status register bits.
188  */
189 #define RE_TXSTAT_LENMASK       0x00001FFF
190 #define RE_TXSTAT_OWN           0x00002000
191 #define RE_TXSTAT_TX_UNDERRUN   0x00004000
192 #define RE_TXSTAT_TX_OK         0x00008000
193 #define RE_TXSTAT_EARLY_THRESH  0x003F0000
194 #define RE_TXSTAT_COLLCNT       0x0F000000
195 #define RE_TXSTAT_CARR_HBEAT    0x10000000
196 #define RE_TXSTAT_OUTOFWIN      0x20000000
197 #define RE_TXSTAT_TXABRT        0x40000000
198 #define RE_TXSTAT_CARRLOSS      0x80000000
199
200 /*
201  * Interrupt status register bits.
202  */
203 #define RE_ISR_RX_OK            0x0001
204 #define RE_ISR_RX_ERR           0x0002
205 #define RE_ISR_TX_OK            0x0004
206 #define RE_ISR_TX_ERR           0x0008
207 #define RE_ISR_RX_OVERRUN       0x0010
208 #define RE_ISR_LINKCHG          0x0020  /* 8169 only */
209 #define RE_ISR_FIFO_OFLOW       0x0040  /* 8139 only */
210 #define RE_ISR_TX_DESC_UNAVAIL  0x0080  /* C+ only */
211 #define RE_ISR_SWI              0x0100  /* C+ only */
212 #define RE_ISR_CABLE_LEN_CHGD   0x2000
213 #define RE_ISR_TIMEOUT_EXPIRED  0x4000
214 #define RE_ISR_SYSTEM_ERR       0x8000
215
216 #define RE_INTRS \
217         (RE_ISR_RX_OK|RE_ISR_RX_ERR|RE_ISR_TX_ERR| \
218         RE_ISR_RX_OVERRUN|RE_ISR_FIFO_OFLOW|RE_ISR_LINKCHG| \
219         RE_ISR_SYSTEM_ERR|RE_ISR_TX_OK)
220
221 #define RE_INTRS_TIMER \
222         (RE_ISR_RX_ERR|RE_ISR_TX_ERR| \
223         RE_ISR_LINKCHG|RE_ISR_SYSTEM_ERR| \
224         RE_ISR_TIMEOUT_EXPIRED)
225
226 #ifdef RE_DIAG
227 #define RE_INTRS_DIAG \
228         (RE_ISR_TX_OK|RE_ISR_RX_OK|RE_ISR_RX_ERR|RE_ISR_TX_ERR| \
229         RE_ISR_RX_OVERRUN|RE_ISR_FIFO_OFLOW|RE_ISR_LINKCHG| \
230         RE_ISR_SYSTEM_ERR)
231 #endif
232
233 /*
234  * Media status register. (8139 only)
235  */
236 #define RE_MEDIASTAT_RXPAUSE    0x01
237 #define RE_MEDIASTAT_TXPAUSE    0x02
238 #define RE_MEDIASTAT_LINK       0x04
239 #define RE_MEDIASTAT_SPEED10    0x08
240 #define RE_MEDIASTAT_RXFLOWCTL  0x40    /* duplex mode */
241 #define RE_MEDIASTAT_TXFLOWCTL  0x80    /* duplex mode */
242
243 /*
244  * Receive config register.
245  */
246 #define RE_RXCFG_RX_ALLPHYS     0x00000001      /* accept all nodes */
247 #define RE_RXCFG_RX_INDIV       0x00000002      /* match filter */
248 #define RE_RXCFG_RX_MULTI       0x00000004      /* accept all multicast */
249 #define RE_RXCFG_RX_BROAD       0x00000008      /* accept all broadcast */
250 #define RE_RXCFG_RX_RUNT        0x00000010
251 #define RE_RXCFG_RX_ERRPKT      0x00000020
252 #define RE_RXCFG_WRAP           0x00000080
253 #define RE_RXCFG_MAXDMA         0x00000700
254 #define RE_RXCFG_BUFSZ          0x00001800
255 #define RE_RXCFG_FIFOTHRESH     0x0000E000
256 #define RE_RXCFG_EARLYTHRESH    0x07000000
257
258 #define RE_RXDMA_16BYTES        0x00000000
259 #define RE_RXDMA_32BYTES        0x00000100
260 #define RE_RXDMA_64BYTES        0x00000200
261 #define RE_RXDMA_128BYTES       0x00000300
262 #define RE_RXDMA_256BYTES       0x00000400
263 #define RE_RXDMA_512BYTES       0x00000500
264 #define RE_RXDMA_1024BYTES      0x00000600
265 #define RE_RXDMA_UNLIMITED      0x00000700
266
267 #define RE_RXBUF_8              0x00000000
268 #define RE_RXBUF_16             0x00000800
269 #define RE_RXBUF_32             0x00001000
270 #define RE_RXBUF_64             0x00001800
271
272 #define RE_RXFIFO_16BYTES       0x00000000
273 #define RE_RXFIFO_32BYTES       0x00002000
274 #define RE_RXFIFO_64BYTES       0x00004000
275 #define RE_RXFIFO_128BYTES      0x00006000
276 #define RE_RXFIFO_256BYTES      0x00008000
277 #define RE_RXFIFO_512BYTES      0x0000A000
278 #define RE_RXFIFO_1024BYTES     0x0000C000
279 #define RE_RXFIFO_NOTHRESH      0x0000E000
280
281 /*
282  * Bits in RX status header (included with RX'ed packet
283  * in ring buffer).
284  */
285 #define RE_RXSTAT_RXOK          0x00000001
286 #define RE_RXSTAT_ALIGNERR      0x00000002
287 #define RE_RXSTAT_CRCERR        0x00000004
288 #define RE_RXSTAT_GIANT         0x00000008
289 #define RE_RXSTAT_RUNT          0x00000010
290 #define RE_RXSTAT_BADSYM        0x00000020
291 #define RE_RXSTAT_BROAD         0x00002000
292 #define RE_RXSTAT_INDIV         0x00004000
293 #define RE_RXSTAT_MULTI         0x00008000
294 #define RE_RXSTAT_LENMASK       0xFFFF0000
295
296 #define RE_RXSTAT_UNFINISHED    0xFFF0          /* DMA still in progress */
297 /*
298  * Command register.
299  */
300 #define RE_CMD_EMPTY_RXBUF      0x0001
301 #define RE_CMD_TX_ENB           0x0004
302 #define RE_CMD_RX_ENB           0x0008
303 #define RE_CMD_RESET            0x0010
304 #define RE_CMD_STOPREQ          0x0080
305
306 /*
307  * EEPROM control register
308  */
309 #define RE_EE_DATAOUT           0x01    /* Data out */
310 #define RE_EE_DATAIN            0x02    /* Data in */
311 #define RE_EE_CLK               0x04    /* clock */
312 #define RE_EE_SEL               0x08    /* chip select */
313 #define RE_EE_MODE              (0x40|0x80)
314
315 #define RE_EEMODE_OFF           0x00
316 #define RE_EEMODE_AUTOLOAD      0x40
317 #define RE_EEMODE_PROGRAM       0x80
318 #define RE_EEMODE_WRITECFG      (0x80|0x40)
319
320 /* 9346 EEPROM commands */
321 #define RE_9346_READ            0x6
322 #define RE_EECMD_WRITE          0x140
323 #define RE_EECMD_READ_6BIT      0x180
324 #define RE_EECMD_READ_8BIT      0x600
325 #define RE_EECMD_ERASE          0x1c0
326
327 #define RE_EE_ID                0x00
328 #define RE_EE_PCI_VID           0x01
329 #define RE_EE_PCI_DID           0x02
330 /* Location of station address inside EEPROM */
331 #define RE_EE_EADDR0            0x07
332 #define RE_EE_EADDR1            0x01
333
334 /*
335  * Config 0 register
336  */
337 #define RE_CFG0_ROM0            0x01
338 #define RE_CFG0_ROM1            0x02
339 #define RE_CFG0_ROM2            0x04
340 #define RE_CFG0_PL0             0x08
341 #define RE_CFG0_PL1             0x10
342 #define RE_CFG0_10MBPS          0x20    /* 10 Mbps internal mode */
343 #define RE_CFG0_PCS             0x40
344 #define RE_CFG0_SCR             0x80
345
346 /*
347  * Config 1 register
348  */
349 #define RE_CFG1_PWRDWN          0x01
350 #define RE_CFG1_SLEEP           0x02
351 #define RE_CFG1_IOMAP           0x04
352 #define RE_CFG1_MEMMAP          0x08
353 #define RE_CFG1_RSVD            0x10
354 #define RE_CFG1_DRVLOAD         0x20
355 #define RE_CFG1_LED0            0x40
356 #define RE_CFG1_FULLDUPLEX      0x40    /* 8129 only */
357 #define RE_CFG1_LED1            0x80
358
359 /*
360  * 8139C+ register definitions
361  */
362
363 /* RE_DUMPSTATS_LO register */
364
365 #define RE_DUMPSTATS_START      0x00000008
366
367 /* Transmit start register */
368
369 #define RE_TXSTART_SWI          0x01    /* generate TX interrupt */
370 #define RE_TXSTART_START        0x40    /* start normal queue transmit */
371 #define RE_TXSTART_HPRIO_START  0x80    /* start hi prio queue transmit */
372
373 /*
374  * Config 2 register, 8139C+/8169/8169S/8110S only
375  */
376 #define RE_CFG2_BUSFREQ         0x07
377 #define RE_CFG2_BUSWIDTH        0x08
378 #define RE_CFG2_AUXPWRSTS       0x10
379
380 #define RE_BUSFREQ_33MHZ        0x00
381 #define RE_BUSFREQ_66MHZ        0x01
382                                         
383 #define RE_BUSWIDTH_32BITS      0x00
384 #define RE_BUSWIDTH_64BITS      0x08
385
386 /* C+ mode command register */
387
388 #define RE_CPLUSCMD_TXENB       0x0001  /* enable C+ transmit mode */
389 #define RE_CPLUSCMD_RXENB       0x0002  /* enable C+ receive mode */
390 #define RE_CPLUSCMD_PCI_MRW     0x0008  /* enable PCI multi-read/write */
391 #define RE_CPLUSCMD_PCI_DAC     0x0010  /* PCI dual-address cycle only */
392 #define RE_CPLUSCMD_RXCSUM_ENB  0x0020  /* enable RX checksum offload */
393 #define RE_CPLUSCMD_VLANSTRIP   0x0040  /* enable VLAN tag stripping */
394
395 /* C+ early transmit threshold */
396
397 #define RE_EARLYTXTHRESH_CNT    0x003F  /* byte count times 8 */ 
398
399 /*
400  * Gigabit PHY access register (8169 only)
401  */
402
403 #define RE_PHYAR_PHYDATA        0x0000FFFF
404 #define RE_PHYAR_PHYREG         0x001F0000
405 #define RE_PHYAR_BUSY           0x80000000
406
407 /*
408  * Gigabit media status (8169 only)
409  */
410 #define RE_GMEDIASTAT_FDX       0x01    /* full duplex */
411 #define RE_GMEDIASTAT_LINK      0x02    /* link up */
412 #define RE_GMEDIASTAT_10MBPS    0x04    /* 10mps link */
413 #define RE_GMEDIASTAT_100MBPS   0x08    /* 100mbps link */
414 #define RE_GMEDIASTAT_1000MBPS  0x10    /* gigE link */
415 #define RE_GMEDIASTAT_RXFLOW    0x20    /* RX flow control on */
416 #define RE_GMEDIASTAT_TXFLOW    0x40    /* TX flow control on */
417 #define RE_GMEDIASTAT_TBI       0x80    /* TBI enabled */
418
419 /*
420  * The RealTek doesn't use a fragment-based descriptor mechanism.
421  * Instead, there are only four register sets, each or which represents
422  * one 'descriptor.' Basically, each TX descriptor is just a contiguous
423  * packet buffer (32-bit aligned!) and we place the buffer addresses in
424  * the registers so the chip knows where they are.
425  *
426  * We can sort of kludge together the same kind of buffer management
427  * used in previous drivers, but we have to do buffer copies almost all
428  * the time, so it doesn't really buy us much.
429  *
430  * For reception, there's just one large buffer where the chip stores
431  * all received packets.
432  */
433
434 #define RE_RX_BUF_SZ            RE_RXBUF_64
435 #define RE_RXBUFLEN             (1 << ((RE_RX_BUF_SZ >> 11) + 13))
436 #define RE_TX_LIST_CNT          4
437 #define RE_MIN_FRAMELEN         60
438 #define RE_TXTHRESH(x)          ((x) << 11)
439 #define RE_TX_THRESH_INIT       96
440 #define RE_RX_FIFOTHRESH        RE_RXFIFO_NOTHRESH
441 #define RE_RX_MAXDMA            RE_RXDMA_UNLIMITED
442 #define RE_TX_MAXDMA            RE_TXDMA_2048BYTES
443
444 #define RE_RXCFG_CONFIG (RE_RX_FIFOTHRESH|RE_RX_MAXDMA|RE_RX_BUF_SZ)
445 #define RE_TXCFG_CONFIG (RE_TXCFG_IFG|RE_TX_MAXDMA)
446
447 #define RE_IM_MAGIC             0x5050
448 #define RE_IM_RXTIME(t)         ((t) & 0xf)
449 #define RE_IM_TXTIME(t)         (((t) & 0xf) << 8)
450
451 #if 0
452 struct re_mii_frame {
453         uint8_t                 mii_stdelim;
454         uint8_t                 mii_opcode;
455         uint8_t                 mii_phyaddr;
456         uint8_t                 mii_regaddr;
457         uint8_t                 mii_turnaround;
458         uint16_t                mii_data;
459 };
460 #endif
461
462 /*
463  * MII constants
464  */
465 #define RE_MII_STARTDELIM       0x01
466 #define RE_MII_READOP           0x02
467 #define RE_MII_WRITEOP          0x01
468 #define RE_MII_TURNAROUND       0x02
469
470 /*
471  * The 8139C+ and 8160 gigE chips support descriptor-based TX
472  * and RX. In fact, they even support TCP large send. Descriptors
473  * must be allocated in contiguous blocks that are aligned on a
474  * 256-byte boundary. The rings can hold a maximum of 64 descriptors.
475  */
476
477 /*
478  * RX/TX descriptor definition. When large send mode is enabled, the
479  * lower 11 bits of the TX re_cmd word are used to hold the MSS, and
480  * the checksum offload bits are disabled. The structure layout is
481  * the same for RX and TX descriptors
482  */
483
484 struct re_desc {
485         uint32_t                re_cmdstat;
486         uint32_t                re_control;
487         uint32_t                re_bufaddr_lo;
488         uint32_t                re_bufaddr_hi;
489 };
490
491 #define RE_TDESC_CMD_FRAGLEN    0x0000FFFF
492 #define RE_TDESC_CMD_TCPCSUM    0x00010000      /* TCP checksum enable */
493 #define RE_TDESC_CMD_UDPCSUM    0x00020000      /* UDP checksum enable */
494 #define RE_TDESC_CMD_IPCSUM     0x00040000      /* IP header checksum enable */
495 #define RE_TDESC_CMD_MSSVAL     0x07FF0000      /* Large send MSS value */
496 #define RE_TDESC_CMD_LGSEND     0x08000000      /* TCP large send enb */
497 #define RE_TDESC_CMD_EOF        0x10000000      /* end of frame marker */
498 #define RE_TDESC_CMD_SOF        0x20000000      /* start of frame marker */
499 #define RE_TDESC_CMD_EOR        0x40000000      /* end of ring marker */
500 #define RE_TDESC_CMD_OWN        0x80000000      /* chip owns descriptor */
501
502 #define RE_TDESC_CTL_INSTAG     0x00020000      /* Insert VLAN tag */
503 #define RE_TDESC_CTL_TAGDATA    0x0000FFFF      /* TAG data */
504 #define RE_TDESC_CTL_IPCSUM     0x20000000      /* IP header csum, MAC2 only */
505 #define RE_TDESC_CTL_TCPCSUM    0x60000000      /* TCP csum, MAC2 only */
506 #define RE_TDESC_CTL_UDPCSUM    0xa0000000      /* UDP csum, MAC2 only */
507
508 /*
509  * Error bits are valid only on the last descriptor of a frame
510  * (i.e. RE_TDESC_CMD_EOF == 1)
511  */
512
513 #define RE_TDESC_STAT_COLCNT    0x000F0000      /* collision count */
514 #define RE_TDESC_STAT_EXCESSCOL 0x00100000      /* excessive collisions */
515 #define RE_TDESC_STAT_LINKFAIL  0x00200000      /* link faulure */
516 #define RE_TDESC_STAT_OWINCOL   0x00400000      /* out-of-window collision */
517 #define RE_TDESC_STAT_TXERRSUM  0x00800000      /* transmit error summary */
518 #define RE_TDESC_STAT_UNDERRUN  0x02000000      /* TX underrun occured */
519 #define RE_TDESC_STAT_OWN       0x80000000
520
521 /*
522  * RX descriptor cmd/vlan definitions
523  */
524
525 #define RE_RDESC_CMD_EOR        0x40000000
526 #define RE_RDESC_CMD_OWN        0x80000000
527 #define RE_RDESC_CMD_BUFLEN     0x00001FFF
528
529 #define RE_RDESC_STAT_OWN       0x80000000
530 #define RE_RDESC_STAT_EOR       0x40000000
531 #define RE_RDESC_STAT_SOF       0x20000000
532 #define RE_RDESC_STAT_EOF       0x10000000
533 #define RE_RDESC_STAT_FRALIGN   0x08000000      /* frame alignment error */
534 #define RE_RDESC_STAT_MCAST     0x04000000      /* multicast pkt received */
535 #define RE_RDESC_STAT_UCAST     0x02000000      /* unicast pkt received */
536 #define RE_RDESC_STAT_BCAST     0x01000000      /* broadcast pkt received */
537 #define RE_RDESC_STAT_BUFOFLOW  0x00800000      /* out of buffer space */
538 #define RE_RDESC_STAT_FIFOOFLOW 0x00400000      /* FIFO overrun */
539 #define RE_RDESC_STAT_GIANT     0x00200000      /* pkt > 4096 bytes */
540 #define RE_RDESC_STAT_RXERRSUM  0x00100000      /* RX error summary */
541 #define RE_RDESC_STAT_RUNT      0x00080000      /* runt packet received */
542 #define RE_RDESC_STAT_CRCERR    0x00040000      /* CRC error */
543 #define RE_RDESC_STAT_PROTOID   0x00030000      /* Protocol type */
544 #define RE_RDESC_STAT_IPSUMBAD  0x00008000      /* IP header checksum bad */
545 #define RE_RDESC_STAT_UDPSUMBAD 0x00004000      /* UDP checksum bad */
546 #define RE_RDESC_STAT_TCPSUMBAD 0x00002000      /* TCP checksum bad */
547 #define RE_RDESC_STAT_FRAGLEN   0x00001FFF      /* RX'ed frame/frag len */
548 #define RE_RDESC_STAT_GFRAGLEN  0x00003FFF      /* RX'ed frame/frag len */
549
550 #define RE_RDESC_CTL_HASTAG     0x00010000      /* VLAN tag available
551                                                    (TAG data valid) */
552 #define RE_RDESC_CTL_TAGDATA    0x0000FFFF      /* TAG data */
553 #define RE_RDESC_CTL_PROTOIP4   0x40000000      /* IPv4 packet, MAC2 only */
554 #define RE_RDESC_CTL_PROTOIP6   0x80000000      /* IPv6 packet, MAC2 only */
555
556 #define RE_PROTOID_NONIP        0x00000000
557 #define RE_PROTOID_TCPIP        0x00010000
558 #define RE_PROTOID_UDPIP        0x00020000
559 #define RE_PROTOID_IP           0x00030000
560 #define RE_TCPPKT(x)            (((x) & RE_RDESC_STAT_PROTOID) == \
561                                  RE_PROTOID_TCPIP)
562 #define RE_UDPPKT(x)            (((x) & RE_RDESC_STAT_PROTOID) == \
563                                  RE_PROTOID_UDPIP)
564
565 /*
566  * Statistics counter structure (8139C+ and 8169 only)
567  */
568 struct re_stats {
569         uint32_t                re_tx_pkts_lo;
570         uint32_t                re_tx_pkts_hi;
571         uint32_t                re_tx_errs_lo;
572         uint32_t                re_tx_errs_hi;
573         uint32_t                re_tx_errs;
574         uint16_t                re_missed_pkts;
575         uint16_t                re_rx_framealign_errs;
576         uint32_t                re_tx_onecoll;
577         uint32_t                re_tx_multicolls;
578         uint32_t                re_rx_ucasts_hi;
579         uint32_t                re_rx_ucasts_lo;
580         uint32_t                re_rx_bcasts_lo;
581         uint32_t                re_rx_bcasts_hi;
582         uint32_t                re_rx_mcasts;
583         uint16_t                re_tx_aborts;
584         uint16_t                re_rx_underruns;
585 };
586
587 /*
588  * General constants that are fun to know.
589  *
590  * PCI low memory base and low I/O base register, and
591  * other PCI registers.
592  */
593
594 #define RE_PCI_LOMEM            0x14
595 #define RE_PCI_LOIO             0x10
596
597 #define PCI_SUBDEVICE_LINKSYS_EG1032_REV3       0x0024
598 #define PCI_REVID_REALTEK_RT8139CP              0x20