rtl81x9reg.h revision 1.97
1/*	$OpenBSD: rtl81x9reg.h,v 1.97 2015/12/28 05:49:15 jmatthew Exp $	*/
2
3/*
4 * Copyright (c) 1997, 1998
5 *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *	This product includes software developed by Bill Paul.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 * $FreeBSD: src/sys/pci/if_rlreg.h,v 1.14 1999/10/21 19:42:03 wpaul Exp $
35 */
36
37/*
38 * Realtek 8129/8139 register offsets
39 */
40#define	RL_IDR0		0x0000		/* ID register 0 (station addr) */
41#define RL_IDR1		0x0001		/* Must use 32-bit accesses (?) */
42#define RL_IDR2		0x0002
43#define RL_IDR3		0x0003
44#define RL_IDR4		0x0004
45#define RL_IDR5		0x0005
46					/* 0006-0007 reserved */
47#define RL_MAR0		0x0008		/* Multicast hash table */
48#define RL_MAR1		0x0009
49#define RL_MAR2		0x000A
50#define RL_MAR3		0x000B
51#define RL_MAR4		0x000C
52#define RL_MAR5		0x000D
53#define RL_MAR6		0x000E
54#define RL_MAR7		0x000F
55
56#define RL_TXSTAT0	0x0010		/* status of TX descriptor 0 */
57#define RL_TXSTAT1	0x0014		/* status of TX descriptor 1 */
58#define RL_TXSTAT2	0x0018		/* status of TX descriptor 2 */
59#define RL_TXSTAT3	0x001C		/* status of TX descriptor 3 */
60
61#define RL_TXADDR0	0x0020		/* address of TX descriptor 0 */
62#define RL_TXADDR1	0x0024		/* address of TX descriptor 1 */
63#define RL_TXADDR2	0x0028		/* address of TX descriptor 2 */
64#define RL_TXADDR3	0x002C		/* address of TX descriptor 3 */
65
66#define RL_RXADDR		0x0030	/* RX ring start address */
67#define RL_RX_EARLY_BYTES	0x0034	/* RX early byte count */
68#define RL_RX_EARLY_STAT	0x0036	/* RX early status */
69#define RL_COMMAND	0x0037		/* command register */
70#define RL_CURRXADDR	0x0038		/* current address of packet read */
71#define RL_CURRXBUF	0x003A		/* current RX buffer address */
72#define RL_IMR		0x003C		/* interrupt mask register */
73#define RL_ISR		0x003E		/* interrupt status register */
74#define RL_TXCFG	0x0040		/* transmit config */
75#define RL_RXCFG	0x0044		/* receive config */
76#define RL_TIMERCNT	0x0048		/* timer count register */
77#define RL_MISSEDPKT	0x004C		/* missed packet counter */
78#define RL_EECMD	0x0050		/* EEPROM command register */
79
80/* RTL8139/RTL8139C+ only */
81#define RL_8139_CFG0	0x0051		/* config register #0 */
82#define RL_8139_CFG1	0x0052		/* config register #1 */
83#define RL_8139_CFG3	0x0059		/* config register #3 */
84#define RL_8139_CFG4	0x005A		/* config register #4 */
85#define RL_8139_CFG5	0x00D8		/* config register #5 */
86
87#define RL_CFG0		0x0051		/* config register #0 */
88#define RL_CFG1		0x0052		/* config register #1 */
89#define RL_CFG2		0x0053		/* config register #2 */
90#define RL_CFG3		0x0054		/* config register #3 */
91#define RL_CFG4		0x0055		/* config register #4 */
92#define RL_CFG5		0x0056		/* config register #5 */
93					/* 0057 reserved */
94#define RL_MEDIASTAT	0x0058		/* media status register (8139) */
95					/* 0059-005A reserved */
96#define RL_MII		0x005A		/* 8129 chip only */
97#define RL_HALTCLK	0x005B
98#define RL_MULTIINTR	0x005C		/* multiple interrupt */
99#define RL_PCIREV	0x005E		/* PCI revision value */
100					/* 005F reserved */
101#define RL_TXSTAT_ALL	0x0060		/* TX status of all descriptors */
102
103#define RL_CSIDR	0x0064
104#define RL_CSIAR	0x0068
105
106/* Direct PHY access registers only available on 8139 */
107#define RL_BMCR		0x0062		/* PHY basic mode control */
108#define RL_BMSR		0x0064		/* PHY basic mode status */
109#define RL_ANAR		0x0066		/* PHY autoneg advert */
110#define RL_LPAR		0x0068		/* PHY link partner ability */
111#define RL_ANER		0x006A		/* PHY autoneg expansion */
112
113#define RL_DISCCNT	0x006C		/* disconnect counter */
114#define RL_FALSECAR	0x006E		/* false carrier counter */
115#define RL_NWAYTST	0x0070		/* NWAY test register */
116#define RL_RX_ER	0x0072		/* RX_ER counter */
117#define RL_CSCFG	0x0074		/* CS configuration register */
118
119/*
120 * When operating in special C+ mode, some of the registers in an
121 * 8139C+ chip have different definitions. These are also used for
122 * the 8169 gigE chip.
123 */
124#define RL_DUMPSTATS_LO	0x0010	/* counter dump command register */
125#define RL_DUMPSTATS_HI	0x0014	/* counter dump command register */
126#define RL_TXLIST_ADDR_LO	0x0020	/* 64 bits, 256 byte alignment */
127#define RL_TXLIST_ADDR_HI	0x0024	/* 64 bits, 256 byte alignment */
128#define RL_TXLIST_ADDR_HPRIO_LO	0x0028	/* 64 bits, 256 byte aligned */
129#define RL_TXLIST_ADDR_HPRIO_HI	0x002C	/* 64 bits, 256 byte aligned */
130#define RL_TIMERINT		0x0054	/* interrupt on timer expire */
131#define RL_TXSTART		0x00D9	/* 8 bits */
132#define RL_CPLUS_CMD		0x00E0	/* 16 bits */
133#define RL_RXLIST_ADDR_LO	0x00E4	/* 64 bits, 256 byte alignment */
134#define RL_RXLIST_ADDR_HI	0x00E8	/* 64 bits, 256 byte alignment */
135#define RL_EARLY_TX_THRESH	0x00EC	/* 8 bits */
136
137/*
138 * Registers specific to the 8169 gigE chip
139 */
140#define RL_GTXSTART		0x0038	/* 8 bits */
141#define RL_TIMERINT_8169	0x0058	/* different offset than 8139 */
142#define RL_PHYAR		0x0060
143#define RL_TBICSR		0x0064
144#define RL_TBI_ANAR		0x0068
145#define RL_TBI_LPAR		0x006A
146#define RL_GMEDIASTAT		0x006C	/* 8 bits */
147#define RL_MACDBG		0x006D	/* 8 bits */
148#define RL_GPIO			0x006E	/* 8 bits */
149#define RL_PMCH			0x006F	/* 8 bits */
150#define RL_LDPS			0x0082	/* Link Down Power Saving */
151#define RL_MAXRXPKTLEN		0x00DA	/* 16 bits, chip multiplies by 8 */
152#define RL_IM			0x00E2
153#define RL_MISC			0x00F0
154
155/*
156 * TX config register bits
157 */
158#define RL_TXCFG_CLRABRT	0x00000001	/* retransmit aborted pkt */
159#define RL_TXCFG_MAXDMA		0x00000700	/* max DMA burst size */
160#define RL_TXCFG_QUEUE_EMPTY	0x00000800	/* 8168E-VL or higher */
161#define RL_TXCFG_CRCAPPEND	0x00010000	/* CRC append (0 = yes) */
162#define RL_TXCFG_LOOPBKTST	0x00060000	/* loopback test */
163#define RL_TXCFG_IFG2		0x00080000	/* 8169 only */
164#define RL_TXCFG_IFG		0x03000000	/* interframe gap */
165#define RL_TXCFG_HWREV		0x7C800000
166
167#define RL_LOOPTEST_OFF		0x00000000
168#define RL_LOOPTEST_ON		0x00020000
169#define RL_LOOPTEST_ON_CPLUS	0x00060000
170
171/* Known revision codes. */
172
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_8110SCd	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_8100E_SPIN2	0x38800000
193#define RL_HWREV_8168C		0x3c000000
194#define RL_HWREV_8168C_SPIN2	0x3c400000
195#define RL_HWREV_8168CP		0x3c800000
196#define RL_HWREV_8105E		0x40800000
197#define RL_HWREV_8105E_SPIN1	0x40C00000
198#define RL_HWREV_8402		0x44000000
199#define RL_HWREV_8106E		0x44800000
200#define RL_HWREV_8168F		0x48000000
201#define RL_HWREV_8411		0x48800000
202#define RL_HWREV_8168G		0x4c000000
203#define RL_HWREV_8168EP		0x50000000
204#define RL_HWREV_8168GU		0x50800000
205#define RL_HWREV_8168H		0x54000000
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
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#define RL_INTRS_CPLUS	\
267	(RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|			\
268	RL_ISR_RX_OVERRUN|RL_ISR_FIFO_OFLOW|				\
269	RL_ISR_SYSTEM_ERR|RL_ISR_TX_OK)
270
271#define RL_INTRS_TIMER	\
272	(RL_ISR_RX_ERR|RL_ISR_TX_ERR|RL_ISR_SYSTEM_ERR|			\
273	RL_ISR_TIMEOUT_EXPIRED)
274
275/*
276 * Media status register. (8139 only)
277 */
278#define RL_MEDIASTAT_RXPAUSE	0x01
279#define RL_MEDIASTAT_TXPAUSE	0x02
280#define RL_MEDIASTAT_LINK	0x04
281#define RL_MEDIASTAT_SPEED10	0x08
282#define RL_MEDIASTAT_RXFLOWCTL	0x40	/* duplex mode */
283#define RL_MEDIASTAT_TXFLOWCTL	0x80	/* duplex mode */
284
285/*
286 * Receive config register.
287 */
288#define RL_RXCFG_RX_ALLPHYS	0x00000001	/* accept all nodes */
289#define RL_RXCFG_RX_INDIV	0x00000002	/* match filter */
290#define RL_RXCFG_RX_MULTI	0x00000004	/* accept all multicast */
291#define RL_RXCFG_RX_BROAD	0x00000008	/* accept all broadcast */
292#define RL_RXCFG_RX_RUNT	0x00000010
293#define RL_RXCFG_RX_ERRPKT	0x00000020
294#define RL_RXCFG_WRAP		0x00000080
295#define RL_RXCFG_EARLYOFFV2	0x00000800
296#define RL_RXCFG_MAXDMA		0x00000700
297#define RL_RXCFG_BURSZ		0x00001800
298#define RL_RXCFG_EARLYOFF	0x00003800
299#define RL_RXCFG_FIFOTHRESH	0x0000E000
300#define RL_RXCFG_EARLYTHRESH	0x07000000
301
302#define RL_RXDMA_16BYTES	0x00000000
303#define RL_RXDMA_32BYTES	0x00000100
304#define RL_RXDMA_64BYTES	0x00000200
305#define RL_RXDMA_128BYTES	0x00000300
306#define RL_RXDMA_256BYTES	0x00000400
307#define RL_RXDMA_512BYTES	0x00000500
308#define RL_RXDMA_1024BYTES	0x00000600
309#define RL_RXDMA_UNLIMITED	0x00000700
310
311#define RL_RXBUF_8		0x00000000
312#define RL_RXBUF_16		0x00000800
313#define RL_RXBUF_32		0x00001000
314#define RL_RXBUF_64		0x00001800
315
316#define RL_RXFIFO_16BYTES	0x00000000
317#define RL_RXFIFO_32BYTES	0x00002000
318#define RL_RXFIFO_64BYTES	0x00004000
319#define RL_RXFIFO_128BYTES	0x00006000
320#define RL_RXFIFO_256BYTES	0x00008000
321#define RL_RXFIFO_512BYTES	0x0000A000
322#define RL_RXFIFO_1024BYTES	0x0000C000
323#define RL_RXFIFO_NOTHRESH	0x0000E000
324
325/*
326 * Bits in RX status header (included with RX'ed packet
327 * in ring buffer).
328 */
329#define RL_RXSTAT_RXOK		0x00000001
330#define RL_RXSTAT_ALIGNERR	0x00000002
331#define RL_RXSTAT_CRCERR	0x00000004
332#define RL_RXSTAT_GIANT		0x00000008
333#define RL_RXSTAT_RUNT		0x00000010
334#define RL_RXSTAT_BADSYM	0x00000020
335#define RL_RXSTAT_BROAD		0x00002000
336#define RL_RXSTAT_INDIV		0x00004000
337#define RL_RXSTAT_MULTI		0x00008000
338#define RL_RXSTAT_LENMASK	0xFFFF0000
339
340#define RL_RXSTAT_UNFINISHED	0xFFF0		/* DMA still in progress */
341/*
342 * Command register.
343 */
344#define RL_CMD_EMPTY_RXBUF	0x0001
345#define RL_CMD_TX_ENB		0x0004
346#define RL_CMD_RX_ENB		0x0008
347#define RL_CMD_RESET		0x0010
348#define RL_CMD_STOPREQ		0x0080
349
350/*
351 * EEPROM control register
352 */
353#define RL_EE_DATAOUT		0x01	/* Data out */
354#define RL_EE_DATAIN		0x02	/* Data in */
355#define RL_EE_CLK		0x04	/* clock */
356#define RL_EE_SEL		0x08	/* chip select */
357#define RL_EE_MODE		(0x40|0x80)
358
359#define RL_EEMODE_OFF		0x00
360#define RL_EEMODE_AUTOLOAD	0x40
361#define RL_EEMODE_PROGRAM	0x80
362#define RL_EEMODE_WRITECFG	(0x80|0x40)
363
364/* 9346/9356 EEPROM commands */
365
366#define RL_9346_ADDR_LEN	6	/* 93C46 1K: 128x16 */
367#define RL_9356_ADDR_LEN	8	/* 93C56 2K: 256x16 */
368
369#define RL_9346_WRITE		0x5
370#define RL_9346_READ		0x6
371#define RL_9346_ERASE		0x7
372#define RL_9346_EWEN		0x4
373#define RL_9346_EWEN_ADDR	0x30
374#define RL_9456_EWDS		0x4
375#define RL_9346_EWDS_ADDR	0x00
376
377#define RL_EECMD_WRITE		0x5	/* 0101b */
378#define RL_EECMD_READ		0x6	/* 0110b */
379#define RL_EECMD_ERASE		0x7	/* 0111b */
380#define RL_EECMD_LEN		4
381
382#define RL_EEADDR_LEN0		6	/* 9346 */
383#define RL_EEADDR_LEN1		8	/* 9356 */
384
385#define RL_EECMD_READ_6BIT	0x180	/* XXX  */
386#define RL_EECMD_READ_8BIT	0x600	/* EECMD_READ above maybe wrong? */
387
388#define RL_EE_ID		0x00
389#define RL_EE_PCI_VID		0x01
390#define RL_EE_PCI_DID		0x02
391/* Location of station address inside EEPROM */
392#define RL_EE_EADDR		0x07
393
394/*
395 * MII register (8129 only)
396 */
397#define RL_MII_CLK		0x01
398#define RL_MII_DATAIN		0x02
399#define RL_MII_DATAOUT		0x04
400#define RL_MII_DIR		0x80	/* 0 == input, 1 == output */
401
402/*
403 * Config 0 register
404 */
405#define RL_CFG0_ROM0		0x01
406#define RL_CFG0_ROM1		0x02
407#define RL_CFG0_ROM2		0x04
408#define RL_CFG0_PL0		0x08
409#define RL_CFG0_PL1		0x10
410#define RL_CFG0_10MBPS		0x20	/* 10 Mbps internal mode */
411#define RL_CFG0_PCS		0x40
412#define RL_CFG0_SCR		0x80
413
414/*
415 * Config 1 register
416 */
417#define RL_CFG1_PWRDWN		0x01
418#define RL_CFG1_PME		0x01
419#define RL_CFG1_SLEEP		0x02
420#define RL_CFG1_VPDEN		0x02
421#define RL_CFG1_IOMAP		0x04
422#define RL_CFG1_MEMMAP		0x08
423#define RL_CFG1_RSVD		0x10
424#define RL_CFG1_LWACT		0x10
425#define RL_CFG1_DRVLOAD		0x20
426#define RL_CFG1_LED0		0x40
427#define RL_CFG1_FULLDUPLEX	0x40	/* 8129 only */
428#define RL_CFG1_LED1		0x80
429
430/*
431 * Config 2 register
432 */
433#define RL_CFG2_PCI_MASK	0x07
434#define RL_CFG2_PCI_33MHZ	0x00
435#define RL_CFG2_PCI_66MHZ	0x01
436#define RL_CFG2_PCI_64BIT	0x08
437#define RL_CFG2_AUXPWR		0x10
438#define RL_CFG2_MSI		0x20
439
440/*
441 * Config 3 register
442 */
443#define RL_CFG3_GRANTSEL	0x80
444#define RL_CFG3_WOL_MAGIC	0x20
445#define RL_CFG3_WOL_LINK	0x10
446#define RL_CFG3_JUMBO_EN0	0x04
447#define RL_CFG3_FAST_B2B	0x01
448
449/*
450 * Config 4 register
451 */
452#define RL_CFG4_LWPTN		0x04
453#define RL_CFG4_LWPME		0x10
454#define RL_CFG4_JUMBO_EN1	0x02
455#define RL_CFG4_8168E_JUMBO_EN1 0x01
456
457/*
458 * Config 5 register
459 */
460#define RL_CFG5_WOL_BCAST	0x40
461#define RL_CFG5_WOL_MCAST	0x20
462#define RL_CFG5_WOL_UCAST	0x10
463#define RL_CFG5_WOL_LANWAKE	0x02
464#define RL_CFG5_PME_STS		0x01
465
466/*
467 * 8139C+ register definitions
468 */
469
470/* RL_DUMPSTATS_LO register */
471
472#define RL_DUMPSTATS_START	0x00000008
473
474/* Transmit start register */
475
476#define RL_TXSTART_SWI		0x01	/* generate TX interrupt */
477#define RL_TXSTART_START	0x40	/* start normal queue transmit */
478#define RL_TXSTART_HPRIO_START	0x80	/* start hi prio queue transmit */
479
480/*
481 * Config 2 register, 8139C+/8169/8169S/8110S only
482 */
483#define RL_CFG2_BUSFREQ		0x07
484#define RL_CFG2_BUSWIDTH	0x08
485#define RL_CFG2_AUXPWRSTS	0x10
486
487#define RL_BUSFREQ_33MHZ	0x00
488#define RL_BUSFREQ_66MHZ	0x01
489
490#define RL_BUSWIDTH_32BITS	0x00
491#define RL_BUSWIDTH_64BITS	0x08
492
493/* C+ mode command register */
494
495#define RL_CPLUSCMD_TXENB	0x0001	/* enable C+ transmit mode */
496#define RL_CPLUSCMD_RXENB	0x0002	/* enable C+ receive mode */
497#define RL_CPLUSCMD_PCI_MRW	0x0008	/* enable PCI multi-read/write */
498#define RL_CPLUSCMD_PCI_DAC	0x0010	/* PCI dual-address cycle only */
499#define RL_CPLUSCMD_RXCSUM_ENB	0x0020	/* enable RX checksum offload */
500#define RL_CPLUSCMD_VLANSTRIP	0x0040	/* enable VLAN tag stripping */
501#define	RL_CPLUSCMD_MACSTAT_DIS	0x0080	/* 8168B/C/CP */
502#define	RL_CPLUSCMD_ASF		0x0100	/* 8168C/CP */
503#define	RL_CPLUSCMD_DBG_SEL	0x0200	/* 8168C/CP */
504#define	RL_CPLUSCMD_FORCE_TXFC	0x0400	/* 8168C/CP */
505#define	RL_CPLUSCMD_FORCE_RXFC	0x0800	/* 8168C/CP */
506#define	RL_CPLUSCMD_FORCE_HDPX	0x1000	/* 8168C/CP */
507#define	RL_CPLUSCMD_NORMAL_MODE	0x2000	/* 8168C/CP */
508#define	RL_CPLUSCMD_DBG_ENB	0x4000	/* 8168C/CP */
509#define	RL_CPLUSCMD_BIST_ENB	0x8000	/* 8168C/CP */
510
511/* C+ early transmit threshold */
512
513#define RL_EARLYTXTHRESH_CNT	0x003F	/* byte count times 8 */
514
515/*
516 * Gigabit PHY access register (8169 only)
517 */
518
519#define RL_PHYAR_PHYDATA	0x0000FFFF
520#define RL_PHYAR_PHYREG		0x001F0000
521#define RL_PHYAR_BUSY		0x80000000
522
523/*
524 * Gigabit media status (8169 only)
525 */
526#define RL_GMEDIASTAT_FDX	0x01	/* full duplex */
527#define RL_GMEDIASTAT_LINK	0x02	/* link up */
528#define RL_GMEDIASTAT_10MBPS	0x04	/* 10mps link */
529#define RL_GMEDIASTAT_100MBPS	0x08	/* 100mbps link */
530#define RL_GMEDIASTAT_1000MBPS	0x10	/* gigE link */
531#define RL_GMEDIASTAT_RXFLOW	0x20	/* RX flow control on */
532#define RL_GMEDIASTAT_TXFLOW	0x40	/* TX flow control on */
533#define RL_GMEDIASTAT_TBI	0x80	/* TBI enabled */
534
535/*
536 * The Realtek doesn't use a fragment-based descriptor mechanism.
537 * Instead, there are only four register sets, each of which represents
538 * one 'descriptor.' Basically, each TX descriptor is just a contiguous
539 * packet buffer (32-bit aligned!) and we place the buffer addresses in
540 * the registers so the chip knows where they are.
541 *
542 * We can sort of kludge together the same kind of buffer management
543 * used in previous drivers, but we have to do buffer copies almost all
544 * the time, so it doesn't really buy us much.
545 *
546 * For reception, there's just one large buffer where the chip stores
547 * all received packets.
548 */
549
550#define RL_RX_BUF_SZ		RL_RXBUF_64
551#define RL_RXBUFLEN		(1 << ((RL_RX_BUF_SZ >> 11) + 13))
552#define RL_TX_LIST_CNT		4
553#define RL_MIN_FRAMELEN		60
554#define RL_TXTHRESH(x)		((x) << 11)
555#define RL_TX_THRESH_INIT	96
556#define RL_RX_FIFOTHRESH	RL_RXFIFO_NOTHRESH
557#define RL_RX_MAXDMA		RL_RXDMA_UNLIMITED
558#define RL_TX_MAXDMA		RL_TXDMA_2048BYTES
559
560#define RL_RXCFG_CONFIG		(RL_RX_FIFOTHRESH|RL_RX_MAXDMA|RL_RX_BUF_SZ)
561#define RL_TXCFG_CONFIG		(RL_TXCFG_IFG|RL_TX_MAXDMA)
562
563#define RL_IM_MAGIC		0x5050
564#define RL_IM_RXTIME(t)		((t) & 0xf)
565#define RL_IM_TXTIME(t)		(((t) & 0xf) << 8)
566
567struct rl_chain_data {
568	u_int16_t		cur_rx;
569	caddr_t			rl_rx_buf;
570	caddr_t			rl_rx_buf_ptr;
571	bus_addr_t		rl_rx_buf_pa;
572
573	struct mbuf		*rl_tx_chain[RL_TX_LIST_CNT];
574	bus_dmamap_t		rl_tx_dmamap[RL_TX_LIST_CNT];
575	u_int8_t		last_tx;
576	u_int8_t		cur_tx;
577};
578
579
580/*
581 * The 8139C+ and 8160 gigE chips support descriptor-based TX
582 * and RX. In fact, they even support TCP large send. Descriptors
583 * must be allocated in contiguous blocks that are aligned on a
584 * 256-byte boundary. The rings can hold a maximum of 64 descriptors.
585 */
586
587/*
588 * RX/TX descriptor definition. When large send mode is enabled, the
589 * lower 11 bits of the TX rl_cmd word are used to hold the MSS, and
590 * the checksum offload bits are disabled. The structure layout is
591 * the same for RX and TX descriptors
592 */
593
594struct rl_desc {
595	volatile u_int32_t	rl_cmdstat;
596	volatile u_int32_t	rl_vlanctl;
597	volatile u_int32_t	rl_bufaddr_lo;
598	volatile u_int32_t	rl_bufaddr_hi;
599};
600
601#define RL_TDESC_CMD_FRAGLEN	0x0000FFFF
602#define RL_TDESC_CMD_TCPCSUM	0x00010000	/* TCP checksum enable */
603#define RL_TDESC_CMD_UDPCSUM	0x00020000	/* UDP checksum enable */
604#define RL_TDESC_CMD_IPCSUM	0x00040000	/* IP header checksum enable */
605#define RL_TDESC_CMD_MSSVAL	0x07FF0000	/* Large send MSS value */
606#define RL_TDESC_CMD_LGSEND	0x08000000	/* TCP large send enb */
607#define RL_TDESC_CMD_EOF	0x10000000	/* end of frame marker */
608#define RL_TDESC_CMD_SOF	0x20000000	/* start of frame marker */
609#define RL_TDESC_CMD_EOR	0x40000000	/* end of ring marker */
610#define RL_TDESC_CMD_OWN	0x80000000	/* chip owns descriptor */
611
612#define RL_TDESC_VLANCTL_TAG	0x00020000	/* Insert VLAN tag */
613#define RL_TDESC_VLANCTL_DATA	0x0000FFFF	/* TAG data */
614/* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
615#define	RL_TDESC_CMD_IPCSUMV2	0x20000000
616#define	RL_TDESC_CMD_TCPCSUMV2	0x40000000
617#define	RL_TDESC_CMD_UDPCSUMV2	0x80000000
618
619/*
620 * Error bits are valid only on the last descriptor of a frame
621 * (i.e. RL_TDESC_CMD_EOF == 1)
622 */
623
624#define RL_TDESC_STAT_COLCNT	0x000F0000	/* collision count */
625#define RL_TDESC_STAT_EXCESSCOL	0x00100000	/* excessive collisions */
626#define RL_TDESC_STAT_LINKFAIL	0x00200000	/* link faulure */
627#define RL_TDESC_STAT_OWINCOL	0x00400000	/* out-of-window collision */
628#define RL_TDESC_STAT_TXERRSUM	0x00800000	/* transmit error summary */
629#define RL_TDESC_STAT_UNDERRUN	0x02000000	/* TX underrun occured */
630#define RL_TDESC_STAT_OWN	0x80000000
631
632/*
633 * RX descriptor cmd/vlan definitions
634 */
635
636#define RL_RDESC_CMD_EOR	0x40000000
637#define RL_RDESC_CMD_OWN	0x80000000
638#define RL_RDESC_CMD_BUFLEN	0x00001FFF
639
640#define RL_RDESC_STAT_OWN	0x80000000
641#define RL_RDESC_STAT_EOR	0x40000000
642#define RL_RDESC_STAT_SOF	0x20000000
643#define RL_RDESC_STAT_EOF	0x10000000
644#define RL_RDESC_STAT_FRALIGN	0x08000000	/* frame alignment error */
645#define RL_RDESC_STAT_MCAST	0x04000000	/* multicast pkt received */
646#define RL_RDESC_STAT_UCAST	0x02000000	/* unicast pkt received */
647#define RL_RDESC_STAT_BCAST	0x01000000	/* broadcast pkt received */
648#define RL_RDESC_STAT_BUFOFLOW	0x00800000	/* out of buffer space */
649#define RL_RDESC_STAT_FIFOOFLOW	0x00400000	/* FIFO overrun */
650#define RL_RDESC_STAT_GIANT	0x00200000	/* pkt > 4096 bytes */
651#define RL_RDESC_STAT_RXERRSUM	0x00100000	/* RX error summary */
652#define RL_RDESC_STAT_RUNT	0x00080000	/* runt packet received */
653#define RL_RDESC_STAT_CRCERR	0x00040000	/* CRC error */
654#define RL_RDESC_STAT_PROTOID	0x00030000	/* Protocol type */
655#define	RL_RDESC_STAT_UDP	0x00020000	/* UDP, 8168C/CP, 8111C/CP */
656#define	RL_RDESC_STAT_TCP	0x00010000	/* TCP, 8168C/CP, 8111C/CP */
657#define RL_RDESC_STAT_IPSUMBAD	0x00008000	/* IP header checksum bad */
658#define RL_RDESC_STAT_UDPSUMBAD	0x00004000	/* UDP checksum bad */
659#define RL_RDESC_STAT_TCPSUMBAD	0x00002000	/* TCP checksum bad */
660#define RL_RDESC_STAT_FRAGLEN	0x00001FFF	/* RX'ed frame/frag len */
661#define RL_RDESC_STAT_GFRAGLEN	0x00003FFF	/* RX'ed frame/frag len */
662#define RL_RDESC_STAT_ERRS	(RL_RDESC_STAT_GIANT|RL_RDESC_STAT_RUNT| \
663				 RL_RDESC_STAT_CRCERR)
664
665#define RL_RDESC_VLANCTL_TAG	0x00010000	/* VLAN tag available
666						   (rl_vlandata valid)*/
667#define RL_RDESC_VLANCTL_DATA	0x0000FFFF	/* TAG data */
668/* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
669#define	RL_RDESC_IPV6		0x80000000
670#define	RL_RDESC_IPV4		0x40000000
671
672#define RL_PROTOID_NONIP	0x00000000
673#define RL_PROTOID_TCPIP	0x00010000
674#define RL_PROTOID_UDPIP	0x00020000
675#define RL_PROTOID_IP		0x00030000
676#define RL_TCPPKT(x)		(((x) & RL_RDESC_STAT_PROTOID) == \
677				 RL_PROTOID_TCPIP)
678#define RL_UDPPKT(x)		(((x) & RL_RDESC_STAT_PROTOID) == \
679				 RL_PROTOID_UDPIP)
680
681/*
682 * Statistics counter structure (8139C+ and 8169 only)
683 */
684struct rl_stats {
685	u_int32_t		rl_tx_pkts_lo;
686	u_int32_t		rl_tx_pkts_hi;
687	u_int32_t		rl_tx_errs_lo;
688	u_int32_t		rl_tx_errs_hi;
689	u_int32_t		rl_tx_errs;
690	u_int16_t		rl_missed_pkts;
691	u_int16_t		rl_rx_framealign_errs;
692	u_int32_t		rl_tx_onecoll;
693	u_int32_t		rl_tx_multicolls;
694	u_int32_t		rl_rx_ucasts_hi;
695	u_int32_t		rl_rx_ucasts_lo;
696	u_int32_t		rl_rx_bcasts_lo;
697	u_int32_t		rl_rx_bcasts_hi;
698	u_int32_t		rl_rx_mcasts;
699	u_int16_t		rl_tx_aborts;
700	u_int16_t		rl_rx_underruns;
701};
702
703/*
704 * Rx/Tx descriptor parameters (8139C+ and 8169 only)
705 *
706 * 8139C+
707 *  Number of descriptors supported : up to 64
708 *  Descriptor alignment : 256 bytes
709 *  Tx buffer : At least 4 bytes in length.
710 *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
711 *
712 * 8169
713 *  Number of descriptors supported : up to 1024
714 *  Descriptor alignment : 256 bytes
715 *  Tx buffer : At least 4 bytes in length.
716 *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
717 */
718#define RL_8169_TX_DESC_CNT	1024
719#define RL_8169_RX_DESC_CNT	1024
720#define RL_8139_TX_DESC_CNT	64
721#define RL_8139_RX_DESC_CNT	64
722#define RL_TX_DESC_CNT		RL_8169_TX_DESC_CNT
723#define RL_RX_DESC_CNT		RL_8169_RX_DESC_CNT
724#define RL_8169_NTXSEGS		32
725#define RL_8139_NTXSEGS		8
726
727#define RL_TX_QLEN		64
728
729#define RL_RING_ALIGN		256
730#define RL_PKTSZ(x)		((x)/* >> 3*/)
731#ifdef __STRICT_ALIGNMENT
732#define RE_ETHER_ALIGN		2
733#define RE_RX_DESC_BUFLEN	(MCLBYTES - RE_ETHER_ALIGN)
734#else
735#define RE_ETHER_ALIGN		0
736#define RE_RX_DESC_BUFLEN	MCLBYTES
737#endif
738
739#define RL_TX_LIST_SZ(sc)	\
740	((sc)->rl_ldata.rl_tx_desc_cnt * sizeof(struct rl_desc))
741#define RL_RX_LIST_SZ(sc)	\
742	((sc)->rl_ldata.rl_rx_desc_cnt * sizeof(struct rl_desc))
743#define RL_NEXT_TX_DESC(sc, x)	\
744	(((x) + 1) % (sc)->rl_ldata.rl_tx_desc_cnt)
745#define RL_NEXT_RX_DESC(sc, x)	\
746	(((x) + 1) % (sc)->rl_ldata.rl_rx_desc_cnt)
747#define RL_NEXT_TXQ(sc, x)	\
748	(((x) + 1) % RL_TX_QLEN)
749
750#define RL_TXDESCSYNC(sc, idx, ops)		\
751	bus_dmamap_sync((sc)->sc_dmat,		\
752	    (sc)->rl_ldata.rl_tx_list_map,	\
753	    sizeof(struct rl_desc) * (idx),	\
754	    sizeof(struct rl_desc),		\
755	    (ops))
756#define RL_RXDESCSYNC(sc, idx, ops)		\
757	bus_dmamap_sync((sc)->sc_dmat,		\
758	    (sc)->rl_ldata.rl_rx_list_map,	\
759	    sizeof(struct rl_desc) * (idx),	\
760	    sizeof(struct rl_desc),		\
761	    (ops))
762
763#define RL_ADDR_LO(y)	((u_int64_t) (y) & 0xFFFFFFFF)
764#define RL_ADDR_HI(y)	((u_int64_t) (y) >> 32)
765
766#define RL_JUMBO_FRAMELEN 	(9 * 1024)
767#define RL_JUMBO_MTU_4K		\
768	((4 * 1024) - ETHER_HDR_LEN - ETHER_CRC_LEN - ETHER_VLAN_ENCAP_LEN)
769#define RL_JUMBO_MTU_6K		\
770	((6 * 1024) - ETHER_HDR_LEN - ETHER_CRC_LEN - ETHER_VLAN_ENCAP_LEN)
771#define RL_JUMBO_MTU_7K		\
772	((7 * 1024) - ETHER_HDR_LEN - ETHER_CRC_LEN - ETHER_VLAN_ENCAP_LEN)
773#define RL_JUMBO_MTU_9K		\
774	((9 * 1024) - ETHER_HDR_LEN - ETHER_CRC_LEN - ETHER_VLAN_ENCAP_LEN)
775#define RL_MTU			ETHERMTU
776
777#define MAX_NUM_MULTICAST_ADDRESSES	128
778
779#define RL_INC(x)		(x = (x + 1) % RL_TX_LIST_CNT)
780#define RL_CUR_TXADDR(x)	((x->rl_cdata.cur_tx * 4) + RL_TXADDR0)
781#define RL_CUR_TXSTAT(x)	((x->rl_cdata.cur_tx * 4) + RL_TXSTAT0)
782#define RL_CUR_TXMBUF(x)	(x->rl_cdata.rl_tx_chain[x->rl_cdata.cur_tx])
783#define RL_CUR_TXMAP(x)		(x->rl_cdata.rl_tx_dmamap[x->rl_cdata.cur_tx])
784#define RL_LAST_TXADDR(x)	((x->rl_cdata.last_tx * 4) + RL_TXADDR0)
785#define RL_LAST_TXSTAT(x)	((x->rl_cdata.last_tx * 4) + RL_TXSTAT0)
786#define RL_LAST_TXMBUF(x)	(x->rl_cdata.rl_tx_chain[x->rl_cdata.last_tx])
787#define RL_LAST_TXMAP(x)	(x->rl_cdata.rl_tx_dmamap[x->rl_cdata.last_tx])
788
789struct rl_type {
790	u_int16_t		rl_vid;
791	u_int16_t		rl_did;
792};
793
794struct rl_mii_frame {
795	u_int8_t		mii_stdelim;
796	u_int8_t		mii_opcode;
797	u_int8_t		mii_phyaddr;
798	u_int8_t		mii_regaddr;
799	u_int8_t		mii_turnaround;
800	u_int16_t		mii_data;
801};
802
803/*
804 * MII constants
805 */
806#define RL_MII_STARTDELIM	0x01
807#define RL_MII_READOP		0x02
808#define RL_MII_WRITEOP		0x01
809#define RL_MII_TURNAROUND	0x02
810
811#define	RL_UNKNOWN		0
812#define RL_8129			1
813#define RL_8139			2
814
815struct rl_rxsoft {
816	struct mbuf		*rxs_mbuf;
817	bus_dmamap_t		rxs_dmamap;
818};
819
820struct rl_txq {
821	struct mbuf *txq_mbuf;
822	bus_dmamap_t txq_dmamap;
823	int txq_descidx;
824	int txq_nsegs;
825};
826
827struct rl_list_data {
828	struct rl_txq		rl_txq[RL_TX_QLEN];
829	int			rl_txq_considx;
830	int			rl_txq_prodidx;
831
832	bus_dmamap_t		rl_tx_list_map;
833	struct rl_desc		*rl_tx_list;
834	int			rl_tx_free;	/* # of free descriptors */
835	int			rl_tx_nextfree; /* next descriptor to use */
836	int			rl_tx_desc_cnt; /* # of descriptors */
837	bus_dma_segment_t	rl_tx_listseg;
838	int			rl_tx_listnseg;
839
840	struct rl_rxsoft	rl_rxsoft[RL_RX_DESC_CNT];
841	bus_dmamap_t		rl_rx_list_map;
842	struct rl_desc		*rl_rx_list;
843	int			rl_rx_considx;
844	int			rl_rx_prodidx;
845	int			rl_rx_desc_cnt;	/* # of descriptors */
846	struct if_rxring	rl_rx_ring;
847	bus_dma_segment_t	rl_rx_listseg;
848	int			rl_rx_listnseg;
849};
850
851struct rl_softc {
852	struct device		sc_dev;		/* us, as a device */
853	void *			sc_ih;		/* interrupt vectoring */
854	bus_space_handle_t	rl_bhandle;	/* bus space handle */
855	bus_space_tag_t		rl_btag;	/* bus space tag */
856	bus_dma_tag_t		sc_dmat;
857	bus_dma_segment_t 	sc_rx_seg;
858	bus_dmamap_t		sc_rx_dmamap;
859	struct arpcom		sc_arpcom;	/* interface info */
860	struct mii_data		sc_mii;		/* MII information */
861	u_int8_t		rl_type;
862	u_int32_t		sc_hwrev;
863	u_int16_t		sc_product;
864	int			rl_max_mtu;
865	int			rl_eecmd_read;
866	int			rl_eewidth;
867	int			rl_bus_speed;
868	int			rl_txthresh;
869	bus_size_t		rl_cfg0;
870	bus_size_t		rl_cfg1;
871	bus_size_t		rl_cfg2;
872	bus_size_t		rl_cfg3;
873	bus_size_t		rl_cfg4;
874	bus_size_t		rl_cfg5;
875	struct rl_chain_data	rl_cdata;
876	struct timeout		sc_tick_tmo;
877
878	struct rl_list_data	rl_ldata;
879	struct mbuf		*rl_head;
880	struct mbuf		*rl_tail;
881	u_int32_t		rl_rxlenmask;
882	struct timeout		timer_handle;
883
884	int			rl_txstart;
885	u_int32_t		rl_flags;
886#define	RL_FLAG_MSI		0x00000001
887#define	RL_FLAG_PCI64		0x00000002
888#define	RL_FLAG_PCIE		0x00000004
889#define	RL_FLAG_PHYWAKE		0x00000008
890#define	RL_FLAG_PAR		0x00000010
891#define	RL_FLAG_DESCV2		0x00000020
892#define	RL_FLAG_MACSTAT		0x00000040
893#define	RL_FLAG_HWIM		0x00000080
894#define	RL_FLAG_TIMERINTR	0x00000100
895#define	RL_FLAG_MACRESET	0x00000200
896#define	RL_FLAG_CMDSTOP		0x00000400
897#define	RL_FLAG_MACSLEEP	0x00000800
898#define	RL_FLAG_AUTOPAD		0x00001000
899#define	RL_FLAG_LINK		0x00002000
900#define	RL_FLAG_PHYWAKE_PM	0x00004000
901#define	RL_FLAG_EARLYOFF	0x00008000
902#define	RL_FLAG_EARLYOFFV2	0x00010000
903#define	RL_FLAG_RXDV_GATED	0x00020000
904#define	RL_FLAG_FASTETHER	0x00040000
905#define	RL_FLAG_CMDSTOP_WAIT_TXQ 0x00080000
906#define	RL_FLAG_JUMBOV2		0x00100000
907#define	RL_FLAG_WOL_MANLINK	0x00200000
908#define	RL_FLAG_WAIT_TXPOLL	0x00400000
909#define	RL_FLAG_WOLRXENB	0x00800000
910
911	u_int16_t		rl_intrs;
912	u_int16_t		rl_tx_ack;
913	u_int16_t		rl_rx_ack;
914	int			rl_tx_time;
915	int			rl_rx_time;
916	int			rl_sim_time;
917	int			rl_imtype;
918#define	RL_IMTYPE_NONE		0
919#define	RL_IMTYPE_SIM		1	/* simulated */
920#define	RL_IMTYPE_HW		2	/* hardware based */
921	int			rl_timerintr;
922};
923
924/*
925 * re(4) hardware ip4csum-tx could be mangled with 28 byte or less IP packets
926 */
927#define RL_IP4CSUMTX_MINLEN	28
928#define RL_IP4CSUMTX_PADLEN	(ETHER_HDR_LEN + RL_IP4CSUMTX_MINLEN)
929/*
930 * XXX
931 * We are allocating pad DMA buffer after RX DMA descs for now
932 * because RL_TX_LIST_SZ(sc) always occupies whole page but
933 * RL_RX_LIST_SZ is less than PAGE_SIZE so there is some unused region.
934 */
935#define RL_RX_DMAMEM_SZ(sc)	(RL_RX_LIST_SZ(sc) + RL_IP4CSUMTX_PADLEN)
936#define RL_TXPADOFF(sc)		RL_RX_LIST_SZ(sc)
937#define RL_TXPADDADDR(sc)	\
938	((sc)->rl_ldata.rl_rx_list_map->dm_segs[0].ds_addr + RL_TXPADOFF(sc))
939
940/*
941 * register space access macros
942 */
943#define CSR_WRITE_RAW_4(sc, csr, val) \
944	bus_space_write_raw_region_4(sc->rl_btag, sc->rl_bhandle, csr, val, 4)
945#define CSR_WRITE_4(sc, csr, val) \
946	bus_space_write_4(sc->rl_btag, sc->rl_bhandle, csr, val)
947#define CSR_WRITE_2(sc, csr, val) \
948	bus_space_write_2(sc->rl_btag, sc->rl_bhandle, csr, val)
949#define CSR_WRITE_1(sc, csr, val) \
950	bus_space_write_1(sc->rl_btag, sc->rl_bhandle, csr, val)
951
952#define CSR_READ_4(sc, csr) \
953	bus_space_read_4(sc->rl_btag, sc->rl_bhandle, csr)
954#define CSR_READ_2(sc, csr) \
955	bus_space_read_2(sc->rl_btag, sc->rl_bhandle, csr)
956#define CSR_READ_1(sc, csr) \
957	bus_space_read_1(sc->rl_btag, sc->rl_bhandle, csr)
958
959#define CSR_SETBIT_1(sc, offset, val)		\
960	CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) | (val))
961
962#define CSR_CLRBIT_1(sc, offset, val)		\
963	CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) & ~(val))
964
965#define CSR_SETBIT_2(sc, offset, val)		\
966	CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) | (val))
967
968#define CSR_CLRBIT_2(sc, offset, val)		\
969	CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) & ~(val))
970
971#define CSR_SETBIT_4(sc, offset, val)		\
972	CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) | (val))
973
974#define CSR_CLRBIT_4(sc, offset, val)		\
975	CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) & ~(val))
976
977#define RL_TIMEOUT		1000
978#define RL_PHY_TIMEOUT		20
979
980/*
981 * General constants that are fun to know.
982 *
983 * Realtek PCI vendor ID
984 */
985#define	RT_VENDORID				0x10EC
986
987/*
988 * Realtek chip device IDs.
989 */
990#define RT_DEVICEID_8129			0x8129
991#define RT_DEVICEID_8101E			0x8136
992#define RT_DEVICEID_8138			0x8138
993#define RT_DEVICEID_8139			0x8139
994#define RT_DEVICEID_8169SC			0x8167
995#define RT_DEVICEID_8168			0x8168
996#define RT_DEVICEID_8169			0x8169
997#define RT_DEVICEID_8100			0x8100
998
999/*
1000 * Accton PCI vendor ID
1001 */
1002#define ACCTON_VENDORID				0x1113
1003
1004/*
1005 * Accton MPX 5030/5038 device ID.
1006 */
1007#define ACCTON_DEVICEID_5030			0x1211
1008
1009/*
1010 * Delta Electronics Vendor ID.
1011 */
1012#define DELTA_VENDORID				0x1500
1013
1014/*
1015 * Delta device IDs.
1016 */
1017#define DELTA_DEVICEID_8139			0x1360
1018
1019/*
1020 * Addtron vendor ID.
1021 */
1022#define ADDTRON_VENDORID			0x4033
1023
1024/*
1025 * Addtron device IDs.
1026 */
1027#define ADDTRON_DEVICEID_8139			0x1360
1028
1029/* D-Link Vendor ID */
1030#define DLINK_VENDORID				0x1186
1031
1032/* D-Link device IDs */
1033#define DLINK_DEVICEID_8139			0x1300
1034#define DLINK_DEVICEID_8139_2			0x1340
1035
1036/* Abocom device IDs */
1037#define ABOCOM_DEVICEID_8139			0xab06
1038
1039/*
1040 * PCI low memory base and low I/O base register, and
1041 * other PCI registers. Note: some are only available on
1042 * the 3c905B, in particular those that related to power management.
1043 */
1044
1045#define RL_PCI_VENDOR_ID	0x00
1046#define RL_PCI_DEVICE_ID	0x02
1047#define RL_PCI_COMMAND		0x04
1048#define RL_PCI_STATUS		0x06
1049#define RL_PCI_CLASSCODE	0x09
1050#define RL_PCI_LATENCY_TIMER	0x0D
1051#define RL_PCI_HEADER_TYPE	0x0E
1052#define RL_PCI_LOIO		0x10
1053#define RL_PCI_LOMEM		0x14
1054#define RL_PCI_BIOSROM		0x30
1055#define RL_PCI_INTLINE		0x3C
1056#define RL_PCI_INTPIN		0x3D
1057#define RL_PCI_MINGNT		0x3E
1058#define RL_PCI_MINLAT		0x0F
1059#define RL_PCI_PMCSR		0x44
1060#define RL_PCI_RESETOPT		0x48
1061#define RL_PCI_EEPROM_DATA	0x4C
1062
1063#define RL_PCI_CAPID		0x50 /* 8 bits */
1064#define RL_PCI_NEXTPTR		0x51 /* 8 bits */
1065#define RL_PCI_PWRMGMTCAP	0x52 /* 16 bits */
1066#define RL_PCI_PWRMGMTCTRL	0x54 /* 16 bits */
1067
1068#define RL_PSTATE_MASK		0x0003
1069#define RL_PSTATE_D0		0x0000
1070#define RL_PSTATE_D1		0x0001
1071#define RL_PSTATE_D2		0x0002
1072#define RL_PSTATE_D3		0x0003
1073#define RL_PME_EN		0x0100
1074#define RL_PME_STATUS		0x8000
1075
1076extern int rl_attach(struct rl_softc *);
1077extern int rl_intr(void *);
1078extern void rl_setmulti(struct rl_softc *);
1079int rl_detach(struct rl_softc *);
1080int rl_activate(struct device *, int);
1081