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