xref: /freebsd/sys/dev/rl/if_rlreg.h (revision 64038db825d64fb4827fc8ee264ea0fa1a046d82)
1 /*-
2  * Copyright (c) 1997, 1998-2003
3  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by Bill Paul.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30  * THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Realtek 8129/8139 register offsets
35  */
36 #define	RL_IDR0		0x0000		/* ID register 0 (station addr) */
37 #define	RL_IDR1		0x0001		/* Must use 32-bit accesses (?) */
38 #define	RL_IDR2		0x0002
39 #define	RL_IDR3		0x0003
40 #define	RL_IDR4		0x0004
41 #define	RL_IDR5		0x0005
42 					/* 0006-0007 reserved */
43 #define	RL_MAR0		0x0008		/* Multicast hash table */
44 #define	RL_MAR1		0x0009
45 #define	RL_MAR2		0x000A
46 #define	RL_MAR3		0x000B
47 #define	RL_MAR4		0x000C
48 #define	RL_MAR5		0x000D
49 #define	RL_MAR6		0x000E
50 #define	RL_MAR7		0x000F
51 
52 #define	RL_TXSTAT0	0x0010		/* status of TX descriptor 0 */
53 #define	RL_TXSTAT1	0x0014		/* status of TX descriptor 1 */
54 #define	RL_TXSTAT2	0x0018		/* status of TX descriptor 2 */
55 #define	RL_TXSTAT3	0x001C		/* status of TX descriptor 3 */
56 
57 #define	RL_TXADDR0	0x0020		/* address of TX descriptor 0 */
58 #define	RL_TXADDR1	0x0024		/* address of TX descriptor 1 */
59 #define	RL_TXADDR2	0x0028		/* address of TX descriptor 2 */
60 #define	RL_TXADDR3	0x002C		/* address of TX descriptor 3 */
61 
62 #define	RL_RXADDR		0x0030	/* RX ring start address */
63 #define	RL_RX_EARLY_BYTES	0x0034	/* RX early byte count */
64 #define	RL_RX_EARLY_STAT	0x0036	/* RX early status */
65 #define	RL_COMMAND	0x0037		/* command register */
66 #define	RL_CURRXADDR	0x0038		/* current address of packet read */
67 #define	RL_CURRXBUF	0x003A		/* current RX buffer address */
68 #define	RL_IMR		0x003C		/* interrupt mask register */
69 #define	RL_ISR		0x003E		/* interrupt status register */
70 #define	RL_TXCFG	0x0040		/* transmit config */
71 #define	RL_RXCFG	0x0044		/* receive config */
72 #define	RL_TIMERCNT	0x0048		/* timer count register */
73 #define	RL_MISSEDPKT	0x004C		/* missed packet counter */
74 #define	RL_EECMD	0x0050		/* EEPROM command register */
75 
76 /* RTL8139/RTL8139C+ only */
77 #define	RL_8139_CFG0	0x0051		/* config register #0 */
78 #define	RL_8139_CFG1	0x0052		/* config register #1 */
79 #define	RL_8139_CFG3	0x0059		/* config register #3 */
80 #define	RL_8139_CFG4	0x005A		/* config register #4 */
81 #define	RL_8139_CFG5	0x00D8		/* config register #5 */
82 
83 #define	RL_CFG0		0x0051		/* config register #0 */
84 #define	RL_CFG1		0x0052		/* config register #1 */
85 #define	RL_CFG2		0x0053		/* config register #2 */
86 #define	RL_CFG3		0x0054		/* config register #3 */
87 #define	RL_CFG4		0x0055		/* config register #4 */
88 #define	RL_CFG5		0x0056		/* config register #5 */
89 					/* 0057 reserved */
90 #define	RL_MEDIASTAT	0x0058		/* media status register (8139) */
91 					/* 0059-005A reserved */
92 #define	RL_MII		0x005A		/* 8129 chip only */
93 #define	RL_HALTCLK	0x005B
94 #define	RL_MULTIINTR	0x005C		/* multiple interrupt */
95 #define	RL_PCIREV	0x005E		/* PCI revision value */
96 					/* 005F reserved */
97 #define	RL_TXSTAT_ALL	0x0060		/* TX status of all descriptors */
98 
99 /* Direct PHY access registers only available on 8139 */
100 #define	RL_BMCR		0x0062		/* PHY basic mode control */
101 #define	RL_BMSR		0x0064		/* PHY basic mode status */
102 #define	RL_ANAR		0x0066		/* PHY autoneg advert */
103 #define	RL_LPAR		0x0068		/* PHY link partner ability */
104 #define	RL_ANER		0x006A		/* PHY autoneg expansion */
105 
106 #define	RL_DISCCNT	0x006C		/* disconnect counter */
107 #define	RL_FALSECAR	0x006E		/* false carrier counter */
108 #define	RL_NWAYTST	0x0070		/* NWAY test register */
109 #define	RL_RX_ER	0x0072		/* RX_ER counter */
110 #define	RL_CSCFG	0x0074		/* CS configuration register */
111 
112 /*
113  * When operating in special C+ mode, some of the registers in an
114  * 8139C+ chip have different definitions. These are also used for
115  * the 8169 gigE chip.
116  */
117 #define	RL_DUMPSTATS_LO		0x0010	/* counter dump command register */
118 #define	RL_DUMPSTATS_HI		0x0014	/* counter dump command register */
119 #define	RL_TXLIST_ADDR_LO	0x0020	/* 64 bits, 256 byte alignment */
120 #define	RL_TXLIST_ADDR_HI	0x0024	/* 64 bits, 256 byte alignment */
121 #define	RL_TXLIST_ADDR_HPRIO_LO	0x0028	/* 64 bits, 256 byte alignment */
122 #define	RL_TXLIST_ADDR_HPRIO_HI	0x002C	/* 64 bits, 256 byte alignment */
123 #define	RL_CFG2			0x0053
124 #define	RL_TIMERINT		0x0054	/* interrupt on timer expire */
125 #define	RL_TXSTART		0x00D9	/* 8 bits */
126 #define	RL_CPLUS_CMD		0x00E0	/* 16 bits */
127 #define	RL_RXLIST_ADDR_LO	0x00E4	/* 64 bits, 256 byte alignment */
128 #define	RL_RXLIST_ADDR_HI	0x00E8	/* 64 bits, 256 byte alignment */
129 #define	RL_EARLY_TX_THRESH	0x00EC	/* 8 bits */
130 
131 /*
132  * Registers specific to the 8169 gigE chip
133  */
134 #define	RL_GTXSTART		0x0038	/* 8 bits */
135 #define	RL_TIMERINT_8169	0x0058	/* different offset than 8139 */
136 #define	RL_PHYAR		0x0060
137 #define	RL_TBICSR		0x0064
138 #define	RL_TBI_ANAR		0x0068
139 #define	RL_TBI_LPAR		0x006A
140 #define	RL_GMEDIASTAT		0x006C	/* 8 bits */
141 #define	RL_MACDBG		0x006D	/* 8 bits, 8168C SPIN2 only */
142 #define	RL_GPIO			0x006E	/* 8 bits, 8168C SPIN2 only */
143 #define	RL_PMCH			0x006F	/* 8 bits */
144 #define	RL_MAXRXPKTLEN		0x00DA	/* 16 bits, chip multiplies by 8 */
145 #define	RL_INTRMOD		0x00E2	/* 16 bits */
146 #define	RL_MISC			0x00F0
147 
148 /*
149  * MCU command / FIFO status register (RTL8168G and later).  Polled to
150  * confirm the on-chip TX/RX FIFOs have drained before a controller reset.
151  */
152 #define	RL_MCU_CMD		0x00D3
153 #define	RL_MCU_TXFIFO_EMPTY	0x20	/* bit 5 */
154 #define	RL_MCU_RXFIFO_EMPTY	0x10	/* bit 4 */
155 
156 /*
157  * TX config register bits
158  */
159 #define	RL_TXCFG_CLRABRT	0x00000001	/* retransmit aborted pkt */
160 #define	RL_TXCFG_MAXDMA		0x00000700	/* max DMA burst size */
161 #define	RL_TXCFG_QUEUE_EMPTY	0x00000800	/* 8168E-VL or higher */
162 #define	RL_TXCFG_CRCAPPEND	0x00010000	/* CRC append (0 = yes) */
163 #define	RL_TXCFG_LOOPBKTST	0x00060000	/* loopback test */
164 #define	RL_TXCFG_IFG2		0x00080000	/* 8169 only */
165 #define	RL_TXCFG_IFG		0x03000000	/* interframe gap */
166 #define	RL_TXCFG_HWREV		0x7CC00000
167 
168 #define	RL_LOOPTEST_OFF		0x00000000
169 #define	RL_LOOPTEST_ON		0x00020000
170 #define	RL_LOOPTEST_ON_CPLUS	0x00060000
171 
172 /* Known revision codes. */
173 #define	RL_HWREV_8169		0x00000000
174 #define	RL_HWREV_8169S		0x00800000
175 #define	RL_HWREV_8110S		0x04000000
176 #define	RL_HWREV_8169_8110SB	0x10000000
177 #define	RL_HWREV_8169_8110SC	0x18000000
178 #define	RL_HWREV_8401E		0x24000000
179 #define	RL_HWREV_8102EL		0x24800000
180 #define	RL_HWREV_8102EL_SPIN1	0x24C00000
181 #define	RL_HWREV_8168D		0x28000000
182 #define	RL_HWREV_8168DP		0x28800000
183 #define	RL_HWREV_8168E		0x2C000000
184 #define	RL_HWREV_8168E_VL	0x2C800000
185 #define	RL_HWREV_8168B_SPIN1	0x30000000
186 #define	RL_HWREV_8100E		0x30800000
187 #define	RL_HWREV_8101E		0x34000000
188 #define	RL_HWREV_8102E		0x34800000
189 #define	RL_HWREV_8103E		0x34C00000
190 #define	RL_HWREV_8168B_SPIN2	0x38000000
191 #define	RL_HWREV_8168B_SPIN3	0x38400000
192 #define	RL_HWREV_8168C		0x3C000000
193 #define	RL_HWREV_8168C_SPIN2	0x3C400000
194 #define	RL_HWREV_8168CP		0x3C800000
195 #define	RL_HWREV_8105E		0x40800000
196 #define	RL_HWREV_8105E_SPIN1	0x40C00000
197 #define	RL_HWREV_8402		0x44000000
198 #define	RL_HWREV_8106E		0x44800000
199 #define	RL_HWREV_8168F		0x48000000
200 #define	RL_HWREV_8411		0x48800000
201 #define	RL_HWREV_8168G		0x4C000000
202 #define	RL_HWREV_8168EP		0x50000000
203 #define	RL_HWREV_8168GU		0x50800000
204 #define	RL_HWREV_8168H		0x54000000
205 #define	RL_HWREV_8168FP		0x54800000
206 #define	RL_HWREV_8411B		0x5C800000
207 #define	RL_HWREV_8139		0x60000000
208 #define	RL_HWREV_8139A		0x70000000
209 #define	RL_HWREV_8139AG		0x70800000
210 #define	RL_HWREV_8139B		0x78000000
211 #define	RL_HWREV_8130		0x7C000000
212 #define	RL_HWREV_8139C		0x74000000
213 #define	RL_HWREV_8139D		0x74400000
214 #define	RL_HWREV_8139CPLUS	0x74800000
215 #define	RL_HWREV_8101		0x74C00000
216 #define	RL_HWREV_8100		0x78800000
217 #define	RL_HWREV_8169_8110SBL	0x7CC00000
218 #define	RL_HWREV_8169_8110SCE	0x98000000
219 
220 #define	RL_TXDMA_16BYTES	0x00000000
221 #define	RL_TXDMA_32BYTES	0x00000100
222 #define	RL_TXDMA_64BYTES	0x00000200
223 #define	RL_TXDMA_128BYTES	0x00000300
224 #define	RL_TXDMA_256BYTES	0x00000400
225 #define	RL_TXDMA_512BYTES	0x00000500
226 #define	RL_TXDMA_1024BYTES	0x00000600
227 #define	RL_TXDMA_2048BYTES	0x00000700
228 
229 /*
230  * Transmit descriptor status register bits.
231  */
232 #define	RL_TXSTAT_LENMASK	0x00001FFF
233 #define	RL_TXSTAT_OWN		0x00002000
234 #define	RL_TXSTAT_TX_UNDERRUN	0x00004000
235 #define	RL_TXSTAT_TX_OK		0x00008000
236 #define	RL_TXSTAT_EARLY_THRESH	0x003F0000
237 #define	RL_TXSTAT_COLLCNT	0x0F000000
238 #define	RL_TXSTAT_CARR_HBEAT	0x10000000
239 #define	RL_TXSTAT_OUTOFWIN	0x20000000
240 #define	RL_TXSTAT_TXABRT	0x40000000
241 #define	RL_TXSTAT_CARRLOSS	0x80000000
242 
243 /*
244  * Interrupt status register bits.
245  */
246 #define	RL_ISR_RX_OK		0x0001
247 #define	RL_ISR_RX_ERR		0x0002
248 #define	RL_ISR_TX_OK		0x0004
249 #define	RL_ISR_TX_ERR		0x0008
250 #define	RL_ISR_RX_OVERRUN	0x0010
251 #define	RL_ISR_PKT_UNDERRUN	0x0020
252 #define	RL_ISR_LINKCHG		0x0020	/* 8169 only */
253 #define	RL_ISR_FIFO_OFLOW	0x0040	/* 8139 only */
254 #define	RL_ISR_TX_DESC_UNAVAIL	0x0080	/* C+ only */
255 #define	RL_ISR_SWI		0x0100	/* C+ only */
256 #define	RL_ISR_CABLE_LEN_CHGD	0x2000
257 #define	RL_ISR_PCS_TIMEOUT	0x4000	/* 8129 only */
258 #define	RL_ISR_TIMEOUT_EXPIRED	0x4000
259 #define	RL_ISR_SYSTEM_ERR	0x8000
260 
261 #define	RL_INTRS	\
262 	(RL_ISR_TX_OK|RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|		\
263 	RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|	\
264 	RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR)
265 
266 #ifdef RE_TX_MODERATION
267 #define	RL_INTRS_CPLUS	\
268 	(RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|			\
269 	RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|	\
270 	RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED)
271 #else
272 #define	RL_INTRS_CPLUS	\
273 	(RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|RL_ISR_TX_OK|		\
274 	RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|	\
275 	RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED)
276 #endif
277 
278 /*
279  * Media status register. (8139 only)
280  */
281 #define	RL_MEDIASTAT_RXPAUSE	0x01
282 #define	RL_MEDIASTAT_TXPAUSE	0x02
283 #define	RL_MEDIASTAT_LINK	0x04
284 #define	RL_MEDIASTAT_SPEED10	0x08
285 #define	RL_MEDIASTAT_RXFLOWCTL	0x40	/* duplex mode */
286 #define	RL_MEDIASTAT_TXFLOWCTL	0x80	/* duplex mode */
287 
288 /*
289  * Receive config register.
290  */
291 #define	RL_RXCFG_RX_ALLPHYS	0x00000001	/* accept all nodes */
292 #define	RL_RXCFG_RX_INDIV	0x00000002	/* match filter */
293 #define	RL_RXCFG_RX_MULTI	0x00000004	/* accept all multicast */
294 #define	RL_RXCFG_RX_BROAD	0x00000008	/* accept all broadcast */
295 #define	RL_RXCFG_RX_RUNT	0x00000010
296 #define	RL_RXCFG_RX_ERRPKT	0x00000020
297 #define	RL_RXCFG_WRAP		0x00000080
298 #define	RL_RXCFG_EARLYOFFV2	0x00000800
299 #define	RL_RXCFG_MAXDMA		0x00000700
300 #define	RL_RXCFG_BUFSZ		0x00001800
301 #define	RL_RXCFG_EARLYOFF	0x00003800
302 #define	RL_RXCFG_FIFOTHRESH	0x0000E000
303 #define	RL_RXCFG_EARLYTHRESH	0x07000000
304 
305 #define	RL_RXDMA_16BYTES	0x00000000
306 #define	RL_RXDMA_32BYTES	0x00000100
307 #define	RL_RXDMA_64BYTES	0x00000200
308 #define	RL_RXDMA_128BYTES	0x00000300
309 #define	RL_RXDMA_256BYTES	0x00000400
310 #define	RL_RXDMA_512BYTES	0x00000500
311 #define	RL_RXDMA_1024BYTES	0x00000600
312 #define	RL_RXDMA_UNLIMITED	0x00000700
313 
314 #define	RL_RXBUF_8		0x00000000
315 #define	RL_RXBUF_16		0x00000800
316 #define	RL_RXBUF_32		0x00001000
317 #define	RL_RXBUF_64		0x00001800
318 
319 #define	RL_RXFIFO_16BYTES	0x00000000
320 #define	RL_RXFIFO_32BYTES	0x00002000
321 #define	RL_RXFIFO_64BYTES	0x00004000
322 #define	RL_RXFIFO_128BYTES	0x00006000
323 #define	RL_RXFIFO_256BYTES	0x00008000
324 #define	RL_RXFIFO_512BYTES	0x0000A000
325 #define	RL_RXFIFO_1024BYTES	0x0000C000
326 #define	RL_RXFIFO_NOTHRESH	0x0000E000
327 
328 /*
329  * Bits in RX status header (included with RX'ed packet
330  * in ring buffer).
331  */
332 #define	RL_RXSTAT_RXOK		0x00000001
333 #define	RL_RXSTAT_ALIGNERR	0x00000002
334 #define	RL_RXSTAT_CRCERR	0x00000004
335 #define	RL_RXSTAT_GIANT		0x00000008
336 #define	RL_RXSTAT_RUNT		0x00000010
337 #define	RL_RXSTAT_BADSYM	0x00000020
338 #define	RL_RXSTAT_BROAD		0x00002000
339 #define	RL_RXSTAT_INDIV		0x00004000
340 #define	RL_RXSTAT_MULTI		0x00008000
341 #define	RL_RXSTAT_LENMASK	0xFFFF0000
342 #define	RL_RXSTAT_UNFINISHED	0x0000FFF0	/* DMA still in progress */
343 
344 /*
345  * Command register.
346  */
347 #define	RL_CMD_EMPTY_RXBUF	0x0001
348 #define	RL_CMD_TX_ENB		0x0004
349 #define	RL_CMD_RX_ENB		0x0008
350 #define	RL_CMD_RESET		0x0010
351 #define	RL_CMD_STOPREQ		0x0080
352 
353 /*
354  * Twister register values.  These are completely undocumented and derived
355  * from public sources.
356  */
357 #define	RL_CSCFG_LINK_OK	0x0400
358 #define	RL_CSCFG_CHANGE		0x0800
359 #define	RL_CSCFG_STATUS		0xf000
360 #define	RL_CSCFG_ROW3		0x7000
361 #define	RL_CSCFG_ROW2		0x3000
362 #define	RL_CSCFG_ROW1		0x1000
363 #define	RL_CSCFG_LINK_DOWN_OFF_CMD 0x03c0
364 #define	RL_CSCFG_LINK_DOWN_CMD	0xf3c0
365 
366 #define	RL_NWAYTST_RESET	0
367 #define	RL_NWAYTST_CBL_TEST	0x20
368 
369 #define	RL_PARA78		0x78
370 #define	RL_PARA78_DEF		0x78fa8388
371 #define	RL_PARA7C		0x7C
372 #define	RL_PARA7C_DEF		0xcb38de43
373 #define	RL_PARA7C_RETUNE	0xfb38de03
374 
375 /*
376  * EEPROM control register
377  */
378 #define	RL_EE_DATAOUT		0x01	/* Data out */
379 #define	RL_EE_DATAIN		0x02	/* Data in */
380 #define	RL_EE_CLK		0x04	/* clock */
381 #define	RL_EE_SEL		0x08	/* chip select */
382 #define	RL_EE_MODE		(0x40|0x80)
383 
384 #define	RL_EEMODE_OFF		0x00
385 #define	RL_EEMODE_AUTOLOAD	0x40
386 #define	RL_EEMODE_PROGRAM	0x80
387 #define	RL_EEMODE_WRITECFG	(0x80|0x40)
388 
389 /* 9346 EEPROM commands */
390 #define	RL_9346_ADDR_LEN	6	/* 93C46 1K: 128x16 */
391 #define	RL_9356_ADDR_LEN	8	/* 93C56 2K: 256x16 */
392 
393 #define	RL_9346_WRITE		0x5
394 #define	RL_9346_READ		0x6
395 #define	RL_9346_ERASE		0x7
396 #define	RL_9346_EWEN		0x4
397 #define	RL_9346_EWEN_ADDR	0x30
398 #define	RL_9456_EWDS		0x4
399 #define	RL_9346_EWDS_ADDR	0x00
400 
401 #define	RL_EECMD_WRITE		0x140
402 #define	RL_EECMD_READ_6BIT	0x180
403 #define	RL_EECMD_READ_8BIT	0x600
404 #define	RL_EECMD_ERASE		0x1c0
405 
406 #define	RL_EE_ID		0x00
407 #define	RL_EE_PCI_VID		0x01
408 #define	RL_EE_PCI_DID		0x02
409 /* Location of station address inside EEPROM */
410 #define	RL_EE_EADDR		0x07
411 
412 /*
413  * MII register (8129 only)
414  */
415 #define	RL_MII_CLK		0x01
416 #define	RL_MII_DATAIN		0x02
417 #define	RL_MII_DATAOUT		0x04
418 #define	RL_MII_DIR		0x80	/* 0 == input, 1 == output */
419 
420 /*
421  * Config 0 register
422  */
423 #define	RL_CFG0_ROM0		0x01
424 #define	RL_CFG0_ROM1		0x02
425 #define	RL_CFG0_ROM2		0x04
426 #define	RL_CFG0_PL0		0x08
427 #define	RL_CFG0_PL1		0x10
428 #define	RL_CFG0_10MBPS		0x20	/* 10 Mbps internal mode */
429 #define	RL_CFG0_PCS		0x40
430 #define	RL_CFG0_SCR		0x80
431 
432 /*
433  * Config 1 register
434  */
435 #define	RL_CFG1_PWRDWN		0x01
436 #define	RL_CFG1_PME		0x01
437 #define	RL_CFG1_SLEEP		0x02
438 #define	RL_CFG1_VPDEN		0x02
439 #define	RL_CFG1_IOMAP		0x04
440 #define	RL_CFG1_MEMMAP		0x08
441 #define	RL_CFG1_RSVD		0x10
442 #define	RL_CFG1_LWACT		0x10
443 #define	RL_CFG1_DRVLOAD		0x20
444 #define	RL_CFG1_LED0		0x40
445 #define	RL_CFG1_FULLDUPLEX	0x40	/* 8129 only */
446 #define	RL_CFG1_LED1		0x80
447 
448 /*
449  * Config 2 register
450  */
451 #define	RL_CFG2_PCI33MHZ	0x00
452 #define	RL_CFG2_PCI66MHZ	0x01
453 #define	RL_CFG2_PCI64BIT	0x08
454 #define	RL_CFG2_AUXPWR		0x10
455 #define	RL_CFG2_MSI		0x20
456 
457 /*
458  * Config 3 register
459  */
460 #define	RL_CFG3_GRANTSEL	0x80
461 #define	RL_CFG3_WOL_MAGIC	0x20
462 #define	RL_CFG3_WOL_LINK	0x10
463 #define	RL_CFG3_JUMBO_EN0	0x04	/* RTL8168C or later. */
464 #define	RL_CFG3_FAST_B2B	0x01
465 
466 /*
467  * Config 4 register
468  */
469 #define	RL_CFG4_LWPTN		0x04
470 #define	RL_CFG4_LWPME		0x10
471 #define	RL_CFG4_JUMBO_EN1	0x02	/* RTL8168C or later. */
472 
473 /*
474  * Config 5 register
475  */
476 #define	RL_CFG5_WOL_BCAST	0x40
477 #define	RL_CFG5_WOL_MCAST	0x20
478 #define	RL_CFG5_WOL_UCAST	0x10
479 #define	RL_CFG5_WOL_LANWAKE	0x02
480 #define	RL_CFG5_PME_STS		0x01
481 
482 /*
483  * 8139C+ register definitions
484  */
485 
486 /* RL_DUMPSTATS_LO register */
487 #define	RL_DUMPSTATS_START	0x00000008
488 
489 /* Transmit start register */
490 #define	RL_TXSTART_SWI		0x01	/* generate TX interrupt */
491 #define	RL_TXSTART_START	0x40	/* start normal queue transmit */
492 #define	RL_TXSTART_HPRIO_START	0x80	/* start hi prio queue transmit */
493 
494 /*
495  * Config 2 register, 8139C+/8169/8169S/8110S only
496  */
497 #define	RL_CFG2_BUSFREQ		0x07
498 #define	RL_CFG2_BUSWIDTH	0x08
499 #define	RL_CFG2_AUXPWRSTS	0x10
500 
501 #define	RL_BUSFREQ_33MHZ	0x00
502 #define	RL_BUSFREQ_66MHZ	0x01
503 
504 #define	RL_BUSWIDTH_32BITS	0x00
505 #define	RL_BUSWIDTH_64BITS	0x08
506 
507 /* C+ mode command register */
508 #define	RL_CPLUSCMD_TXENB	0x0001	/* enable C+ transmit mode */
509 #define	RL_CPLUSCMD_RXENB	0x0002	/* enable C+ receive mode */
510 #define	RL_CPLUSCMD_PCI_MRW	0x0008	/* enable PCI multi-read/write */
511 #define	RL_CPLUSCMD_PCI_DAC	0x0010	/* PCI dual-address cycle only */
512 #define	RL_CPLUSCMD_RXCSUM_ENB	0x0020	/* enable RX checksum offload */
513 #define	RL_CPLUSCMD_VLANSTRIP	0x0040	/* enable VLAN tag stripping */
514 #define	RL_CPLUSCMD_MACSTAT_DIS	0x0080	/* 8168B/C/CP */
515 #define	RL_CPLUSCMD_ASF		0x0100	/* 8168C/CP */
516 #define	RL_CPLUSCMD_DBG_SEL	0x0200	/* 8168C/CP */
517 #define	RL_CPLUSCMD_FORCE_TXFC	0x0400	/* 8168C/CP */
518 #define	RL_CPLUSCMD_FORCE_RXFC	0x0800	/* 8168C/CP */
519 #define	RL_CPLUSCMD_FORCE_HDPX	0x1000	/* 8168C/CP */
520 #define	RL_CPLUSCMD_NORMAL_MODE	0x2000	/* 8168C/CP */
521 #define	RL_CPLUSCMD_DBG_ENB	0x4000	/* 8168C/CP */
522 #define	RL_CPLUSCMD_BIST_ENB	0x8000	/* 8168C/CP */
523 
524 /* C+ early transmit threshold */
525 #define	RL_EARLYTXTHRESH_CNT	0x003F	/* byte count times 8 */
526 
527 /* Timer interrupt register */
528 #define	RL_TIMERINT_8169_VAL	0x00001FFF
529 #define	RL_TIMER_MIN		0
530 #define	RL_TIMER_MAX		65	/* 65.528us */
531 #define	RL_TIMER_DEFAULT	RL_TIMER_MAX
532 #define	RL_TIMER_PCIE_CLK	125	/* 125MHZ */
533 #define	RL_USECS(x)		((x) * RL_TIMER_PCIE_CLK)
534 
535 /*
536  * Gigabit PHY access register (8169 only)
537  */
538 #define	RL_PHYAR_PHYDATA	0x0000FFFF
539 #define	RL_PHYAR_PHYREG		0x001F0000
540 #define	RL_PHYAR_BUSY		0x80000000
541 
542 /*
543  * Gigabit media status (8169 only)
544  */
545 #define	RL_GMEDIASTAT_FDX	0x01	/* full duplex */
546 #define	RL_GMEDIASTAT_LINK	0x02	/* link up */
547 #define	RL_GMEDIASTAT_10MBPS	0x04	/* 10mps link */
548 #define	RL_GMEDIASTAT_100MBPS	0x08	/* 100mbps link */
549 #define	RL_GMEDIASTAT_1000MBPS	0x10	/* gigE link */
550 #define	RL_GMEDIASTAT_RXFLOW	0x20	/* RX flow control on */
551 #define	RL_GMEDIASTAT_TXFLOW	0x40	/* TX flow control on */
552 #define	RL_GMEDIASTAT_TBI	0x80	/* TBI enabled */
553 
554 /*
555  * The Realtek doesn't use a fragment-based descriptor mechanism.
556  * Instead, there are only four register sets, each of which represents
557  * one 'descriptor.' Basically, each TX descriptor is just a contiguous
558  * packet buffer (32-bit aligned!) and we place the buffer addresses in
559  * the registers so the chip knows where they are.
560  *
561  * We can sort of kludge together the same kind of buffer management
562  * used in previous drivers, but we have to do buffer copies almost all
563  * the time, so it doesn't really buy us much.
564  *
565  * For reception, there's just one large buffer where the chip stores
566  * all received packets.
567  */
568 #define	RL_RX_BUF_SZ		RL_RXBUF_64
569 #define	RL_RXBUFLEN		(1 << ((RL_RX_BUF_SZ >> 11) + 13))
570 #define	RL_TX_LIST_CNT		4
571 #define	RL_MIN_FRAMELEN		60
572 #define	RL_TX_8139_BUF_ALIGN	4
573 #define	RL_RX_8139_BUF_ALIGN	8
574 #define	RL_RX_8139_BUF_RESERVE	sizeof(int64_t)
575 #define	RL_RX_8139_BUF_GUARD_SZ	\
576 	(ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN + RL_RX_8139_BUF_RESERVE)
577 #define	RL_TXTHRESH(x)		((x) << 11)
578 #define	RL_TX_THRESH_INIT	96
579 #define	RL_RX_FIFOTHRESH	RL_RXFIFO_NOTHRESH
580 #define	RL_RX_MAXDMA		RL_RXDMA_UNLIMITED
581 #define	RL_TX_MAXDMA		RL_TXDMA_2048BYTES
582 
583 #define	RL_RXCFG_CONFIG (RL_RX_FIFOTHRESH|RL_RX_MAXDMA|RL_RX_BUF_SZ)
584 #define	RL_TXCFG_CONFIG	(RL_TXCFG_IFG|RL_TX_MAXDMA)
585 
586 #define	RL_ETHER_ALIGN	2
587 
588 /*
589  * re(4) hardware ip4csum-tx could be mangled with 28 bytes or less IP packets.
590  */
591 #define	RL_IP4CSUMTX_MINLEN	28
592 #define	RL_IP4CSUMTX_PADLEN	(ETHER_HDR_LEN + RL_IP4CSUMTX_MINLEN)
593 
594 struct rl_chain_data {
595 	uint16_t		cur_rx;
596 	uint8_t			*rl_rx_buf;
597 	uint8_t			*rl_rx_buf_ptr;
598 
599 	struct mbuf		*rl_tx_chain[RL_TX_LIST_CNT];
600 	bus_dmamap_t		rl_tx_dmamap[RL_TX_LIST_CNT];
601 	bus_dma_tag_t		rl_tx_tag;
602 	bus_dma_tag_t		rl_rx_tag;
603 	bus_dmamap_t		rl_rx_dmamap;
604 	bus_addr_t		rl_rx_buf_paddr;
605 	uint8_t			last_tx;
606 	uint8_t			cur_tx;
607 };
608 
609 #define	RL_INC(x)		(x = (x + 1) % RL_TX_LIST_CNT)
610 #define	RL_CUR_TXADDR(x)	((x->rl_cdata.cur_tx * 4) + RL_TXADDR0)
611 #define	RL_CUR_TXSTAT(x)	((x->rl_cdata.cur_tx * 4) + RL_TXSTAT0)
612 #define	RL_CUR_TXMBUF(x)	(x->rl_cdata.rl_tx_chain[x->rl_cdata.cur_tx])
613 #define	RL_CUR_DMAMAP(x)	(x->rl_cdata.rl_tx_dmamap[x->rl_cdata.cur_tx])
614 #define	RL_LAST_TXADDR(x)	((x->rl_cdata.last_tx * 4) + RL_TXADDR0)
615 #define	RL_LAST_TXSTAT(x)	((x->rl_cdata.last_tx * 4) + RL_TXSTAT0)
616 #define	RL_LAST_TXMBUF(x)	(x->rl_cdata.rl_tx_chain[x->rl_cdata.last_tx])
617 #define	RL_LAST_DMAMAP(x)	(x->rl_cdata.rl_tx_dmamap[x->rl_cdata.last_tx])
618 
619 struct rl_type {
620 	uint16_t		rl_vid;
621 	uint16_t		rl_did;
622 	int			rl_basetype;
623 	const char		*rl_name;
624 };
625 
626 struct rl_hwrev {
627 	uint32_t		rl_rev;
628 	int			rl_type;
629 	const char		*rl_desc;
630 	int			rl_max_mtu;
631 };
632 
633 #define	RL_8129			1
634 #define	RL_8139			2
635 #define	RL_8139CPLUS		3
636 #define	RL_8169			4
637 
638 #define	RL_ISCPLUS(x)		((x)->rl_type == RL_8139CPLUS ||	\
639 				 (x)->rl_type == RL_8169)
640 
641 /*
642  * The 8139C+ and 8160 gigE chips support descriptor-based TX
643  * and RX. In fact, they even support TCP large send. Descriptors
644  * must be allocated in contiguous blocks that are aligned on a
645  * 256-byte boundary. The rings can hold a maximum of 64 descriptors.
646  */
647 
648 /*
649  * RX/TX descriptor definition. When large send mode is enabled, the
650  * lower 11 bits of the TX rl_cmdstat word are used to hold the MSS, and
651  * the checksum offload bits are disabled. The structure layout is
652  * the same for RX and TX descriptors
653  */
654 struct rl_desc {
655 	uint32_t		rl_cmdstat;
656 	uint32_t		rl_vlanctl;
657 	uint32_t		rl_bufaddr_lo;
658 	uint32_t		rl_bufaddr_hi;
659 };
660 
661 #define	RL_TDESC_CMD_FRAGLEN	0x0000FFFF
662 #define	RL_TDESC_CMD_TCPCSUM	0x00010000	/* TCP checksum enable */
663 #define	RL_TDESC_CMD_UDPCSUM	0x00020000	/* UDP checksum enable */
664 #define	RL_TDESC_CMD_IPCSUM	0x00040000	/* IP header checksum enable */
665 #define	RL_TDESC_CMD_MSSVAL	0x07FF0000	/* Large send MSS value */
666 #define	RL_TDESC_CMD_MSSVAL_SHIFT	16	/* Large send MSS value shift */
667 #define	RL_TDESC_CMD_LGSEND	0x08000000	/* TCP large send enb */
668 #define	RL_TDESC_CMD_EOF	0x10000000	/* end of frame marker */
669 #define	RL_TDESC_CMD_SOF	0x20000000	/* start of frame marker */
670 #define	RL_TDESC_CMD_EOR	0x40000000	/* end of ring marker */
671 #define	RL_TDESC_CMD_OWN	0x80000000	/* chip owns descriptor */
672 
673 #define	RL_TDESC_VLANCTL_TAG	0x00020000	/* Insert VLAN tag */
674 #define	RL_TDESC_VLANCTL_DATA	0x0000FFFF	/* TAG data */
675 /* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
676 #define	RL_TDESC_CMD_UDPCSUMV2	0x80000000
677 #define	RL_TDESC_CMD_TCPCSUMV2	0x40000000
678 #define	RL_TDESC_CMD_IPCSUMV2	0x20000000
679 #define	RL_TDESC_CMD_MSSVALV2	0x1FFC0000
680 #define	RL_TDESC_CMD_MSSVALV2_SHIFT	18
681 
682 /*
683  * Error bits are valid only on the last descriptor of a frame
684  * (i.e. RL_TDESC_CMD_EOF == 1)
685  */
686 #define	RL_TDESC_STAT_COLCNT	0x000F0000	/* collision count */
687 #define	RL_TDESC_STAT_EXCESSCOL	0x00100000	/* excessive collisions */
688 #define	RL_TDESC_STAT_LINKFAIL	0x00200000	/* link faulure */
689 #define	RL_TDESC_STAT_OWINCOL	0x00400000	/* out-of-window collision */
690 #define	RL_TDESC_STAT_TXERRSUM	0x00800000	/* transmit error summary */
691 #define	RL_TDESC_STAT_UNDERRUN	0x02000000	/* TX underrun occurred */
692 #define	RL_TDESC_STAT_OWN	0x80000000
693 
694 /*
695  * RX descriptor cmd/vlan definitions
696  */
697 #define	RL_RDESC_CMD_EOR	0x40000000
698 #define	RL_RDESC_CMD_OWN	0x80000000
699 #define	RL_RDESC_CMD_BUFLEN	0x00001FFF
700 
701 #define	RL_RDESC_STAT_OWN	0x80000000
702 #define	RL_RDESC_STAT_EOR	0x40000000
703 #define	RL_RDESC_STAT_SOF	0x20000000
704 #define	RL_RDESC_STAT_EOF	0x10000000
705 #define	RL_RDESC_STAT_FRALIGN	0x08000000	/* frame alignment error */
706 #define	RL_RDESC_STAT_MCAST	0x04000000	/* multicast pkt received */
707 #define	RL_RDESC_STAT_UCAST	0x02000000	/* unicast pkt received */
708 #define	RL_RDESC_STAT_BCAST	0x01000000	/* broadcast pkt received */
709 #define	RL_RDESC_STAT_BUFOFLOW	0x00800000	/* out of buffer space */
710 #define	RL_RDESC_STAT_FIFOOFLOW	0x00400000	/* FIFO overrun */
711 #define	RL_RDESC_STAT_GIANT	0x00200000	/* pkt > 4096 bytes */
712 #define	RL_RDESC_STAT_RXERRSUM	0x00100000	/* RX error summary */
713 #define	RL_RDESC_STAT_RUNT	0x00080000	/* runt packet received */
714 #define	RL_RDESC_STAT_CRCERR	0x00040000	/* CRC error */
715 #define	RL_RDESC_STAT_PROTOID	0x00030000	/* Protocol type */
716 #define	RL_RDESC_STAT_UDP	0x00020000	/* UDP, 8168C/CP, 8111C/CP */
717 #define	RL_RDESC_STAT_TCP	0x00010000	/* TCP, 8168C/CP, 8111C/CP */
718 #define	RL_RDESC_STAT_IPSUMBAD	0x00008000	/* IP header checksum bad */
719 #define	RL_RDESC_STAT_UDPSUMBAD	0x00004000	/* UDP checksum bad */
720 #define	RL_RDESC_STAT_TCPSUMBAD	0x00002000	/* TCP checksum bad */
721 #define	RL_RDESC_STAT_FRAGLEN	0x00001FFF	/* RX'ed frame/frag len */
722 #define	RL_RDESC_STAT_GFRAGLEN	0x00003FFF	/* RX'ed frame/frag len */
723 #define	RL_RDESC_STAT_ERRS	(RL_RDESC_STAT_GIANT|RL_RDESC_STAT_RUNT| \
724 				 RL_RDESC_STAT_CRCERR)
725 
726 #define	RL_RDESC_VLANCTL_TAG	0x00010000	/* VLAN tag available
727 						   (rl_vlandata valid)*/
728 #define	RL_RDESC_VLANCTL_DATA	0x0000FFFF	/* TAG data */
729 /* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
730 #define	RL_RDESC_IPV6		0x80000000
731 #define	RL_RDESC_IPV4		0x40000000
732 
733 #define	RL_PROTOID_NONIP	0x00000000
734 #define	RL_PROTOID_TCPIP	0x00010000
735 #define	RL_PROTOID_UDPIP	0x00020000
736 #define	RL_PROTOID_IP		0x00030000
737 #define	RL_TCPPKT(x)		(((x) & RL_RDESC_STAT_PROTOID) == \
738 				 RL_PROTOID_TCPIP)
739 #define	RL_UDPPKT(x)		(((x) & RL_RDESC_STAT_PROTOID) == \
740 				 RL_PROTOID_UDPIP)
741 
742 /*
743  * Statistics counter structure (8139C+ and 8169 only)
744  */
745 struct rl_stats {
746 	uint64_t		rl_tx_pkts;
747 	uint64_t		rl_rx_pkts;
748 	uint64_t		rl_tx_errs;
749 	uint32_t		rl_rx_errs;
750 	uint16_t		rl_missed_pkts;
751 	uint16_t		rl_rx_framealign_errs;
752 	uint32_t		rl_tx_onecoll;
753 	uint32_t		rl_tx_multicolls;
754 	uint64_t		rl_rx_ucasts;
755 	uint64_t		rl_rx_bcasts;
756 	uint32_t		rl_rx_mcasts;
757 	uint16_t		rl_tx_aborts;
758 	uint16_t		rl_rx_underruns;
759 };
760 
761 /*
762  * Rx/Tx descriptor parameters (8139C+ and 8169 only)
763  *
764  * 8139C+
765  *  Number of descriptors supported : up to 64
766  *  Descriptor alignment : 256 bytes
767  *  Tx buffer : At least 4 bytes in length.
768  *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
769  *
770  * 8169
771  *  Number of descriptors supported : up to 1024
772  *  Descriptor alignment : 256 bytes
773  *  Tx buffer : At least 4 bytes in length.
774  *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
775  */
776 #ifndef	__NO_STRICT_ALIGNMENT
777 #define	RE_FIXUP_RX	1
778 #endif
779 
780 #define	RL_8169_TX_DESC_CNT	256
781 #define	RL_8169_RX_DESC_CNT	256
782 #define	RL_8139_TX_DESC_CNT	64
783 #define	RL_8139_RX_DESC_CNT	64
784 #define	RL_TX_DESC_CNT		RL_8169_TX_DESC_CNT
785 #define	RL_RX_DESC_CNT		RL_8169_RX_DESC_CNT
786 #define	RL_RX_JUMBO_DESC_CNT	RL_RX_DESC_CNT
787 #define	RL_NTXSEGS		35
788 
789 #define	RL_RING_ALIGN		256
790 #define	RL_DUMP_ALIGN		64
791 #define	RL_IFQ_MAXLEN		512
792 #define	RL_TX_DESC_NXT(sc,x)	((x + 1) & ((sc)->rl_ldata.rl_tx_desc_cnt - 1))
793 #define	RL_TX_DESC_PRV(sc,x)	((x - 1) & ((sc)->rl_ldata.rl_tx_desc_cnt - 1))
794 #define	RL_RX_DESC_NXT(sc,x)	((x + 1) & ((sc)->rl_ldata.rl_rx_desc_cnt - 1))
795 #define	RL_OWN(x)		(le32toh((x)->rl_cmdstat) & RL_RDESC_STAT_OWN)
796 #define	RL_RXBYTES(x)		(le32toh((x)->rl_cmdstat) & sc->rl_rxlenmask)
797 #define	RL_PKTSZ(x)		((x)/* >> 3*/)
798 #ifdef RE_FIXUP_RX
799 #define	RE_ETHER_ALIGN	sizeof(uint64_t)
800 #define	RE_RX_DESC_BUFLEN	(MCLBYTES - RE_ETHER_ALIGN)
801 #else
802 #define	RE_ETHER_ALIGN	0
803 #define	RE_RX_DESC_BUFLEN	MCLBYTES
804 #endif
805 
806 #define	RL_MSI_MESSAGES	1
807 
808 #define	RL_ADDR_LO(y)		((uint64_t) (y) & 0xFFFFFFFF)
809 #define	RL_ADDR_HI(y)		((uint64_t) (y) >> 32)
810 
811 /*
812  * The number of bits reserved for MSS in Realtek controllers is
813  * 11bits. This limits the maximum interface MTU size in TSO case
814  * as upper stack should not generate TCP segments with MSS greater
815  * than the limit.
816  */
817 #define	RL_TSO_MTU		(2047 - ETHER_HDR_LEN - ETHER_CRC_LEN)
818 
819 /* see comment in dev/re/if_re.c */
820 #define	RL_JUMBO_FRAMELEN	7440
821 #define	RL_JUMBO_MTU		\
822 	(RL_JUMBO_FRAMELEN-ETHER_VLAN_ENCAP_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
823 #define	RL_JUMBO_MTU_6K		\
824 	((6 * 1024) - ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
825 #define	RL_JUMBO_MTU_9K		\
826 	((9 * 1024) - ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
827 #define	RL_MTU			\
828 	(ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
829 
830 struct rl_txdesc {
831 	struct mbuf		*tx_m;
832 	bus_dmamap_t		tx_dmamap;
833 };
834 
835 struct rl_rxdesc {
836 	struct mbuf		*rx_m;
837 	bus_dmamap_t		rx_dmamap;
838 	bus_size_t		rx_size;
839 };
840 
841 struct rl_list_data {
842 	struct rl_txdesc	rl_tx_desc[RL_TX_DESC_CNT];
843 	struct rl_rxdesc	rl_rx_desc[RL_RX_DESC_CNT];
844 	struct rl_rxdesc	rl_jrx_desc[RL_RX_JUMBO_DESC_CNT];
845 	int			rl_tx_desc_cnt;
846 	int			rl_rx_desc_cnt;
847 	int			rl_tx_prodidx;
848 	int			rl_rx_prodidx;
849 	int			rl_tx_considx;
850 	int			rl_tx_free;
851 	bus_dma_tag_t		rl_tx_mtag;	/* mbuf TX mapping tag */
852 	bus_dma_tag_t		rl_rx_mtag;	/* mbuf RX mapping tag */
853 	bus_dma_tag_t		rl_jrx_mtag;	/* mbuf RX mapping tag */
854 	bus_dmamap_t		rl_rx_sparemap;
855 	bus_dmamap_t		rl_jrx_sparemap;
856 	bus_dma_tag_t		rl_stag;	/* stats mapping tag */
857 	bus_dmamap_t		rl_smap;	/* stats map */
858 	struct rl_stats		*rl_stats;
859 	bus_addr_t		rl_stats_addr;
860 	bus_dma_tag_t		rl_rx_list_tag;
861 	bus_dmamap_t		rl_rx_list_map;
862 	struct rl_desc		*rl_rx_list;
863 	bus_addr_t		rl_rx_list_addr;
864 	bus_dma_tag_t		rl_tx_list_tag;
865 	bus_dmamap_t		rl_tx_list_map;
866 	struct rl_desc		*rl_tx_list;
867 	bus_addr_t		rl_tx_list_addr;
868 };
869 
870 enum rl_twist { DONE, CHK_LINK, FIND_ROW, SET_PARAM, RECHK_LONG, RETUNE };
871 
872 struct rl_softc {
873 	if_t			rl_ifp;	/* interface info */
874 	bus_space_handle_t	rl_bhandle;	/* bus space handle */
875 	bus_space_tag_t		rl_btag;	/* bus space tag */
876 	device_t		rl_dev;
877 	struct resource		*rl_res;
878 	int			rl_res_id;
879 	int			rl_res_type;
880 	struct resource		*rl_res_pba;
881 	struct resource		*rl_irq[RL_MSI_MESSAGES];
882 	void			*rl_intrhand[RL_MSI_MESSAGES];
883 	device_t		rl_miibus;
884 	bus_dma_tag_t		rl_parent_tag;
885 	uint8_t			rl_type;
886 	const struct rl_hwrev	*rl_hwrev;
887 	uint32_t		rl_macrev;
888 	int			rl_eecmd_read;
889 	int			rl_eewidth;
890 	int			rl_expcap;
891 	int			rl_txthresh;
892 	bus_size_t		rl_cfg0;
893 	bus_size_t		rl_cfg1;
894 	bus_size_t		rl_cfg2;
895 	bus_size_t		rl_cfg3;
896 	bus_size_t		rl_cfg4;
897 	bus_size_t		rl_cfg5;
898 	struct rl_chain_data	rl_cdata;
899 	struct rl_list_data	rl_ldata;
900 	struct callout		rl_stat_callout;
901 	int			rl_watchdog_timer;
902 	struct mtx		rl_mtx;
903 	struct mbuf		*rl_head;
904 	struct mbuf		*rl_tail;
905 	uint32_t		rl_rxlenmask;
906 	int			rl_testmode;
907 	int			rl_if_flags;
908 	int			rl_twister_enable;
909 	enum rl_twist		rl_twister;
910 	int			rl_twist_row;
911 	int			rl_twist_col;
912 	int			suspended;	/* 0 = normal  1 = suspended */
913 #ifdef DEVICE_POLLING
914 	int			rxcycles;
915 #endif
916 
917 	struct task		rl_inttask;
918 
919 	int			rl_txstart;
920 	int			rl_int_rx_act;
921 	int			rl_int_rx_mod;
922 	uint32_t		rl_flags;
923 #define	RL_FLAG_MSI		0x00000001
924 #define	RL_FLAG_AUTOPAD		0x00000002
925 #define	RL_FLAG_PHYWAKE_PM	0x00000004
926 #define	RL_FLAG_PHYWAKE		0x00000008
927 #define	RL_FLAG_JUMBOV2		0x00000010
928 #define	RL_FLAG_PAR		0x00000020
929 #define	RL_FLAG_DESCV2		0x00000040
930 #define	RL_FLAG_MACSTAT		0x00000080
931 #define	RL_FLAG_FASTETHER	0x00000100
932 #define	RL_FLAG_CMDSTOP		0x00000200
933 #define	RL_FLAG_MACRESET	0x00000400
934 #define	RL_FLAG_MSIX		0x00000800
935 #define	RL_FLAG_WOLRXENB	0x00001000
936 #define	RL_FLAG_MACSLEEP	0x00002000
937 #define	RL_FLAG_WAIT_TXPOLL	0x00004000
938 #define	RL_FLAG_CMDSTOP_WAIT_TXQ	0x00008000
939 #define	RL_FLAG_WOL_MANLINK	0x00010000
940 #define	RL_FLAG_EARLYOFF	0x00020000
941 #define	RL_FLAG_8168G_PLUS	0x00040000
942 #define	RL_FLAG_PCIE		0x40000000
943 #define	RL_FLAG_LINK		0x80000000
944 };
945 
946 #define	RL_LOCK(_sc)		mtx_lock(&(_sc)->rl_mtx)
947 #define	RL_UNLOCK(_sc)		mtx_unlock(&(_sc)->rl_mtx)
948 #define	RL_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->rl_mtx, MA_OWNED)
949 
950 /*
951  * register space access macros
952  */
953 #define	CSR_WRITE_STREAM_4(sc, reg, val)	\
954 	bus_space_write_stream_4(sc->rl_btag, sc->rl_bhandle, reg, val)
955 #define	CSR_WRITE_4(sc, reg, val)	\
956 	bus_space_write_4(sc->rl_btag, sc->rl_bhandle, reg, val)
957 #define	CSR_WRITE_2(sc, reg, val)	\
958 	bus_space_write_2(sc->rl_btag, sc->rl_bhandle, reg, val)
959 #define	CSR_WRITE_1(sc, reg, val)	\
960 	bus_space_write_1(sc->rl_btag, sc->rl_bhandle, reg, val)
961 
962 #define	CSR_READ_4(sc, reg)		\
963 	bus_space_read_4(sc->rl_btag, sc->rl_bhandle, reg)
964 #define	CSR_READ_2(sc, reg)		\
965 	bus_space_read_2(sc->rl_btag, sc->rl_bhandle, reg)
966 #define	CSR_READ_1(sc, reg)		\
967 	bus_space_read_1(sc->rl_btag, sc->rl_bhandle, reg)
968 
969 #define	CSR_BARRIER(sc, reg, length, flags)				\
970 	bus_space_barrier(sc->rl_btag, sc->rl_bhandle, reg, length, flags)
971 
972 #define	CSR_SETBIT_1(sc, offset, val)		\
973 	CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) | (val))
974 
975 #define	CSR_CLRBIT_1(sc, offset, val)		\
976 	CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) & ~(val))
977 
978 #define	CSR_SETBIT_2(sc, offset, val)		\
979 	CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) | (val))
980 
981 #define	CSR_CLRBIT_2(sc, offset, val)		\
982 	CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) & ~(val))
983 
984 #define	CSR_SETBIT_4(sc, offset, val)		\
985 	CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) | (val))
986 
987 #define	CSR_CLRBIT_4(sc, offset, val)		\
988 	CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) & ~(val))
989 
990 #define	RL_TIMEOUT		1000
991 #define	RL_PHY_TIMEOUT		2000
992 
993 /*
994  * General constants that are fun to know.
995  *
996  * Realtek PCI vendor ID
997  */
998 #define	RT_VENDORID				0x10EC
999 
1000 /*
1001  * Realtek chip device IDs.
1002  */
1003 #define	RT_DEVICEID_2600          		0x2600
1004 #define	RT_DEVICEID_8139D			0x8039
1005 #define	RT_DEVICEID_8129			0x8129
1006 #define	RT_DEVICEID_8101E			0x8136
1007 #define	RT_DEVICEID_8138			0x8138
1008 #define	RT_DEVICEID_8139			0x8139
1009 #define	RT_DEVICEID_8169SC			0x8167
1010 #define	RT_DEVICEID_8161			0x8161
1011 #define	RT_DEVICEID_8168			0x8168
1012 #define	RT_DEVICEID_8169			0x8169
1013 #define	RT_DEVICEID_8100			0x8100
1014 
1015 #define	RT_REVID_8139CPLUS			0x20
1016 
1017 /*
1018  * Accton PCI vendor ID
1019  */
1020 #define	ACCTON_VENDORID				0x1113
1021 
1022 /*
1023  * Accton MPX 5030/5038 device ID.
1024  */
1025 #define	ACCTON_DEVICEID_5030			0x1211
1026 
1027 /*
1028  * Nortel PCI vendor ID
1029  */
1030 #define	NORTEL_VENDORID				0x126C
1031 
1032 /*
1033  * Delta Electronics Vendor ID.
1034  */
1035 #define	DELTA_VENDORID				0x1500
1036 
1037 /*
1038  * Delta device IDs.
1039  */
1040 #define	DELTA_DEVICEID_8139			0x1360
1041 
1042 /*
1043  * Addtron vendor ID.
1044  */
1045 #define	ADDTRON_VENDORID			0x4033
1046 
1047 /*
1048  * Addtron device IDs.
1049  */
1050 #define	ADDTRON_DEVICEID_8139			0x1360
1051 
1052 /*
1053  * D-Link vendor ID.
1054  */
1055 #define	DLINK_VENDORID				0x1186
1056 
1057 /*
1058  * D-Link DFE-530TX+ device ID
1059  */
1060 #define	DLINK_DEVICEID_530TXPLUS		0x1300
1061 
1062 /*
1063  * D-Link DFE-520TX rev. C1 device ID
1064  */
1065 #define	DLINK_DEVICEID_520TX_REVC1		0x4200
1066 
1067 /*
1068  * D-Link DFE-5280T device ID
1069  */
1070 #define	DLINK_DEVICEID_528T			0x4300
1071 #define	DLINK_DEVICEID_530T_REVC		0x4302
1072 
1073 /*
1074  * D-Link DFE-690TXD device ID
1075  */
1076 #define	DLINK_DEVICEID_690TXD			0x1340
1077 
1078 /*
1079  * Corega K.K vendor ID
1080  */
1081 #define	COREGA_VENDORID				0x1259
1082 
1083 /*
1084  * Corega FEther CB-TXD device ID
1085  */
1086 #define	COREGA_DEVICEID_FETHERCBTXD		0xa117
1087 
1088 /*
1089  * Corega FEtherII CB-TXD device ID
1090  */
1091 #define	COREGA_DEVICEID_FETHERIICBTXD		0xa11e
1092 
1093 /*
1094  * Corega CG-LAPCIGT device ID
1095  */
1096 #define	COREGA_DEVICEID_CGLAPCIGT		0xc107
1097 
1098 /*
1099  * Linksys vendor ID
1100  */
1101 #define	LINKSYS_VENDORID			0x1737
1102 
1103 /*
1104  * Linksys EG1032 device ID
1105  */
1106 #define	LINKSYS_DEVICEID_EG1032			0x1032
1107 
1108 /*
1109  * Linksys EG1032 rev 3 sub-device ID
1110  */
1111 #define	LINKSYS_SUBDEVICE_EG1032_REV3		0x0024
1112 
1113 /*
1114  * Peppercon vendor ID
1115  */
1116 #define	PEPPERCON_VENDORID			0x1743
1117 
1118 /*
1119  * Peppercon ROL-F device ID
1120  */
1121 #define	PEPPERCON_DEVICEID_ROLF			0x8139
1122 
1123 /*
1124  * Planex Communications, Inc. vendor ID
1125  */
1126 #define	PLANEX_VENDORID				0x14ea
1127 
1128 /*
1129  * Planex FNW-3603-TX device ID
1130  */
1131 #define	PLANEX_DEVICEID_FNW3603TX		0xab06
1132 
1133 /*
1134  * Planex FNW-3800-TX device ID
1135  */
1136 #define	PLANEX_DEVICEID_FNW3800TX		0xab07
1137 
1138 /*
1139  * LevelOne vendor ID
1140  */
1141 #define	LEVEL1_VENDORID				0x018A
1142 
1143 /*
1144  * LevelOne FPC-0106TX devide ID
1145  */
1146 #define	LEVEL1_DEVICEID_FPC0106TX		0x0106
1147 
1148 /*
1149  * Compaq vendor ID
1150  */
1151 #define	CP_VENDORID				0x021B
1152 
1153 /*
1154  * Edimax vendor ID
1155  */
1156 #define	EDIMAX_VENDORID				0x13D1
1157 
1158 /*
1159  * Edimax EP-4103DL cardbus device ID
1160  */
1161 #define	EDIMAX_DEVICEID_EP4103DL		0xAB06
1162 
1163 /* US Robotics vendor ID */
1164 
1165 #define	USR_VENDORID		0x16EC
1166 
1167 /* US Robotics 997902 device ID */
1168 
1169 #define	USR_DEVICEID_997902	0x0116
1170 
1171 /*
1172  * NCube vendor ID
1173  */
1174 #define	NCUBE_VENDORID		0x10FF
1175