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