xref: /freebsd/sys/dev/nge/if_ngereg.h (revision b9f654b163bce26de79705e77b872427c9f2afa1)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 2001 Wind River Systems
5  * Copyright (c) 1997, 1998, 1999, 2000, 2001
6  *	Bill Paul <wpaul@bsdi.com>.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by Bill Paul.
19  * 4. Neither the name of the author nor the names of any co-contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
33  * THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  * $FreeBSD$
36  */
37 
38 #define NGE_CSR			0x00
39 #define NGE_CFG			0x04
40 #define NGE_MEAR		0x08
41 #define NGE_PCITST		0x0C
42 #define NGE_ISR			0x10
43 #define NGE_IMR			0x14
44 #define NGE_IER			0x18
45 #define NGE_IHR			0x1C
46 #define NGE_TX_LISTPTR_LO	0x20
47 #define NGE_TX_LISTPTR_HI	0x24
48 #define NGE_TX_LISTPTR		NGE_TX_LISTPTR_LO
49 #define NGE_TX_CFG		0x28
50 #define NGE_GPIO		0x2C
51 #define NGE_RX_LISTPTR_LO	0x30
52 #define NGE_RX_LISTPTR_HI	0x34
53 #define NGE_RX_LISTPTR		NGE_RX_LISTPTR_LO
54 #define NGE_RX_CFG		0x38
55 #define NGE_PRIOQCTL		0x3C
56 #define NGE_WOLCSR		0x40
57 #define NGE_PAUSECSR		0x44
58 #define NGE_RXFILT_CTL		0x48
59 #define NGE_RXFILT_DATA		0x4C
60 #define NGE_BOOTROM_ADDR	0x50
61 #define NGE_BOOTROM_DATA	0x54
62 #define NGE_SILICONREV		0x58
63 #define NGE_MIBCTL		0x5C
64 #define NGE_MIB_RXERRPKT	0x60
65 #define NGE_MIB_RXERRFCS	0x64
66 #define NGE_MIB_RXERRMISSEDPKT	0x68
67 #define NGE_MIB_RXERRALIGN	0x6C
68 #define NGE_MIB_RXERRSYM	0x70
69 #define NGE_MIB_RXERRGIANT	0x74
70 #define NGE_MIB_RXERRRANGLEN	0x78
71 #define NGE_MIB_RXBADOPCODE	0x7C
72 #define NGE_MIB_RXPAUSEPKTS	0x80
73 #define NGE_MIB_TXPAUSEPKTS	0x84
74 #define NGE_MIB_TXERRSQE	0x88
75 #define NGE_TXPRIOQ_PTR1	0xA0
76 #define NGE_TXPRIOQ_PTR2	0xA4
77 #define NGE_TXPRIOQ_PTR3	0xA8
78 #define NGE_RXPRIOQ_PTR1	0xB0
79 #define NGE_RXPRIOQ_PTR2	0xB4
80 #define NGE_RXPRIOQ_PTR3	0xB8
81 #define NGE_VLAN_IP_RXCTL	0xBC
82 #define NGE_VLAN_IP_TXCTL	0xC0
83 #define NGE_VLAN_DATA		0xC4
84 #define NGE_CLKRUN		0xCC
85 #define NGE_TBI_BMCR		0xE0
86 #define NGE_TBI_BMSR		0xE4
87 #define NGE_TBI_ANAR		0xE8
88 #define NGE_TBI_ANLPAR		0xEC
89 #define NGE_TBI_ANER		0xF0
90 #define NGE_TBI_ESR		0xF4
91 
92 /* Control/status register */
93 #define NGE_CSR_TX_ENABLE	0x00000001
94 #define NGE_CSR_TX_DISABLE	0x00000002
95 #define NGE_CSR_RX_ENABLE	0x00000004
96 #define NGE_CSR_RX_DISABLE	0x00000008
97 #define NGE_CSR_TX_RESET	0x00000010
98 #define NGE_CSR_RX_RESET	0x00000020
99 #define NGE_CSR_SOFTINTR	0x00000080
100 #define NGE_CSR_RESET		0x00000100
101 #define NGE_CSR_TX_PRIOQ_ENB0	0x00000200
102 #define NGE_CSR_TX_PRIOQ_ENB1	0x00000400
103 #define NGE_CSR_TX_PRIOQ_ENB2	0x00000800
104 #define NGE_CSR_TX_PRIOQ_ENB3	0x00001000
105 #define NGE_CSR_RX_PRIOQ_ENB0	0x00002000
106 #define NGE_CSR_RX_PRIOQ_ENB1	0x00004000
107 #define NGE_CSR_RX_PRIOQ_ENB2	0x00008000
108 #define NGE_CSR_RX_PRIOQ_ENB3	0x00010000
109 
110 /* Configuration register */
111 #define NGE_CFG_BIGENDIAN	0x00000001
112 #define NGE_CFG_EXT_125MHZ	0x00000002
113 #define NGE_CFG_BOOTROM_DIS	0x00000004
114 #define NGE_CFG_PERR_DETECT	0x00000008
115 #define NGE_CFG_DEFER_DISABLE	0x00000010
116 #define NGE_CFG_OUTOFWIN_TIMER	0x00000020
117 #define NGE_CFG_SINGLE_BACKOFF	0x00000040
118 #define NGE_CFG_PCIREQ_ALG	0x00000080
119 #define NGE_CFG_EXTSTS_ENB	0x00000100
120 #define NGE_CFG_PHY_DIS		0x00000200
121 #define NGE_CFG_PHY_RST		0x00000400
122 #define NGE_CFG_64BIT_ADDR_ENB	0x00000800
123 #define NGE_CFG_64BIT_DATA_ENB	0x00001000
124 #define NGE_CFG_64BIT_PCI_DET	0x00002000
125 #define NGE_CFG_64BIT_TARG	0x00004000
126 #define NGE_CFG_MWI_DIS		0x00008000
127 #define NGE_CFG_MRM_DIS		0x00010000
128 #define NGE_CFG_TMRTST		0x00020000
129 #define NGE_CFG_PHYINTR_SPD	0x00040000
130 #define NGE_CFG_PHYINTR_LNK	0x00080000
131 #define NGE_CFG_PHYINTR_DUP	0x00100000
132 #define NGE_CFG_MODE_1000	0x00400000
133 #define NGE_CFG_TBI_EN		0x01000000
134 #define NGE_CFG_DUPLEX_STS	0x10000000
135 #define NGE_CFG_SPEED_STS	0x60000000
136 #define NGE_CFG_LINK_STS	0x80000000
137 
138 /* MII/EEPROM control register */
139 #define NGE_MEAR_EE_DIN		0x00000001
140 #define NGE_MEAR_EE_DOUT	0x00000002
141 #define NGE_MEAR_EE_CLK		0x00000004
142 #define NGE_MEAR_EE_CSEL	0x00000008
143 #define NGE_MEAR_MII_DATA	0x00000010
144 #define NGE_MEAR_MII_DIR	0x00000020
145 #define NGE_MEAR_MII_CLK	0x00000040
146 
147 #define NGE_EECMD_WRITE		0x140
148 #define NGE_EECMD_READ		0x180
149 #define NGE_EECMD_ERASE		0x1c0
150 
151 #define NGE_EE_NODEADDR		0xA
152 
153 /* PCI control register */
154 #define NGE_PCICTL_SRAMADDR	0x0000001F
155 #define NGE_PCICTL_RAMTSTENB	0x00000020
156 #define NGE_PCICTL_TXTSTENB	0x00000040
157 #define NGE_PCICTL_RXTSTENB	0x00000080
158 #define NGE_PCICTL_BMTSTENB	0x00000200
159 #define NGE_PCICTL_RAMADDR	0x001F0000
160 #define NGE_PCICTL_ROMTIME	0x0F000000
161 #define NGE_PCICTL_DISCTEST	0x40000000
162 
163 /* Interrupt/status register */
164 #define NGE_ISR_RX_OK		0x00000001
165 #define NGE_ISR_RX_DESC_OK	0x00000002
166 #define NGE_ISR_RX_ERR		0x00000004
167 #define NGE_ISR_RX_EARLY	0x00000008
168 #define NGE_ISR_RX_IDLE		0x00000010
169 #define NGE_ISR_RX_OFLOW	0x00000020
170 #define NGE_ISR_TX_OK		0x00000040
171 #define NGE_ISR_TX_DESC_OK	0x00000080
172 #define NGE_ISR_TX_ERR		0x00000100
173 #define NGE_ISR_TX_IDLE		0x00000200
174 #define NGE_ISR_TX_UFLOW	0x00000400
175 #define NGE_ISR_MIB_SERVICE	0x00000800
176 #define NGE_ISR_SOFTINTR	0x00001000
177 #define NGE_ISR_PME_EVENT	0x00002000
178 #define NGE_ISR_PHY_INTR	0x00004000
179 #define NGE_ISR_HIBITS		0x00008000
180 #define NGE_ISR_RX_FIFO_OFLOW	0x00010000
181 #define NGE_ISR_TGT_ABRT	0x00020000
182 #define NGE_ISR_BM_ABRT		0x00040000
183 #define NGE_ISR_SYSERR		0x00080000
184 #define NGE_ISR_PARITY_ERR	0x00100000
185 #define NGE_ISR_RX_RESET_DONE	0x00200000
186 #define NGE_ISR_TX_RESET_DONE	0x00400000
187 #define NGE_ISR_RX_PRIOQ_DESC0	0x00800000
188 #define NGE_ISR_RX_PRIOQ_DESC1	0x01000000
189 #define NGE_ISR_RX_PRIOQ_DESC2	0x02000000
190 #define NGE_ISR_RX_PRIOQ_DESC3	0x04000000
191 #define NGE_ISR_TX_PRIOQ_DESC0	0x08000000
192 #define NGE_ISR_TX_PRIOQ_DESC1	0x10000000
193 #define NGE_ISR_TX_PRIOQ_DESC2	0x20000000
194 #define NGE_ISR_TX_PRIOQ_DESC3	0x40000000
195 
196 /* Interrupt mask register */
197 #define NGE_IMR_RX_OK		0x00000001
198 #define NGE_IMR_RX_DESC_OK	0x00000002
199 #define NGE_IMR_RX_ERR		0x00000004
200 #define NGE_IMR_RX_EARLY	0x00000008
201 #define NGE_IMR_RX_IDLE		0x00000010
202 #define NGE_IMR_RX_OFLOW	0x00000020
203 #define NGE_IMR_TX_OK		0x00000040
204 #define NGE_IMR_TX_DESC_OK	0x00000080
205 #define NGE_IMR_TX_ERR		0x00000100
206 #define NGE_IMR_TX_IDLE		0x00000200
207 #define NGE_IMR_TX_UFLOW	0x00000400
208 #define NGE_IMR_MIB_SERVICE	0x00000800
209 #define NGE_IMR_SOFTINTR	0x00001000
210 #define NGE_IMR_PME_EVENT	0x00002000
211 #define NGE_IMR_PHY_INTR	0x00004000
212 #define NGE_IMR_HIBITS		0x00008000
213 #define NGE_IMR_RX_FIFO_OFLOW	0x00010000
214 #define NGE_IMR_TGT_ABRT	0x00020000
215 #define NGE_IMR_BM_ABRT		0x00040000
216 #define NGE_IMR_SYSERR		0x00080000
217 #define NGE_IMR_PARITY_ERR	0x00100000
218 #define NGE_IMR_RX_RESET_DONE	0x00200000
219 #define NGE_IMR_TX_RESET_DONE	0x00400000
220 #define NGE_IMR_RX_PRIOQ_DESC0	0x00800000
221 #define NGE_IMR_RX_PRIOQ_DESC1	0x01000000
222 #define NGE_IMR_RX_PRIOQ_DESC2	0x02000000
223 #define NGE_IMR_RX_PRIOQ_DESC3	0x04000000
224 #define NGE_IMR_TX_PRIOQ_DESC0	0x08000000
225 #define NGE_IMR_TX_PRIOQ_DESC1	0x10000000
226 #define NGE_IMR_TX_PRIOQ_DESC2	0x20000000
227 #define NGE_IMR_TX_PRIOQ_DESC3	0x40000000
228 
229 #define NGE_INTRS	\
230 	(NGE_IMR_RX_OFLOW|NGE_IMR_TX_UFLOW|NGE_IMR_TX_OK|\
231 	 NGE_IMR_TX_IDLE|NGE_IMR_RX_OK|NGE_IMR_RX_ERR|\
232 	 NGE_IMR_SYSERR|NGE_IMR_PHY_INTR|\
233 	 NGE_IMR_RX_IDLE|NGE_IMR_RX_FIFO_OFLOW)
234 
235 /* Interrupt enable register */
236 #define NGE_IER_INTRENB		0x00000001
237 
238 /* Interrupt moderation timer register */
239 #define NGE_IHR_HOLDOFF		0x000000FF
240 #define NGE_IHR_HOLDCTL		0x00000100
241 
242 /* Transmit configuration register */
243 #define NGE_TXCFG_DRAIN_THRESH	0x000000FF /* 32-byte units */
244 #define NGE_TXCFG_FILL_THRESH	0x0000FF00 /* 32-byte units */
245 #define NGE_1000MB_BURST_DIS	0x00080000
246 #define NGE_TXCFG_DMABURST	0x00700000
247 #define NGE_TXCFG_ECRETRY	0x00800000
248 #define NGE_TXCFG_AUTOPAD	0x10000000
249 #define NGE_TXCFG_LOOPBK	0x20000000
250 #define NGE_TXCFG_IGN_HBEAT	0x40000000
251 #define NGE_TXCFG_IGN_CARR	0x80000000
252 
253 #define NGE_TXCFG_DRAIN(x)	(((x) >> 5) & NGE_TXCFG_DRAIN_THRESH)
254 #define NGE_TXCFG_FILL(x)	((((x) >> 5) << 8) & NGE_TXCFG_FILL_THRESH)
255 
256 #define NGE_TXDMA_1024BYTES	0x00000000
257 #define NGE_TXDMA_8BYTES	0x00100000
258 #define NGE_TXDMA_16BYTES	0x00200000
259 #define NGE_TXDMA_32BYTES	0x00300000
260 #define NGE_TXDMA_64BYTES	0x00400000
261 #define NGE_TXDMA_128BYTES	0x00500000
262 #define NGE_TXDMA_256BYTES	0x00600000
263 #define NGE_TXDMA_512BYTES	0x00700000
264 
265 #define NGE_TXCFG	\
266 	(NGE_TXDMA_512BYTES|NGE_TXCFG_AUTOPAD|\
267 	 NGE_TXCFG_FILL(64)|NGE_TXCFG_DRAIN(6400))
268 
269 /* GPIO register */
270 #define NGE_GPIO_GP1_OUT	0x00000001
271 #define NGE_GPIO_GP2_OUT	0x00000002
272 #define NGE_GPIO_GP3_OUT	0x00000004
273 #define NGE_GPIO_GP4_OUT	0x00000008
274 #define NGE_GPIO_GP5_OUT	0x00000010
275 #define NGE_GPIO_GP1_OUTENB	0x00000020
276 #define NGE_GPIO_GP2_OUTENB	0x00000040
277 #define NGE_GPIO_GP3_OUTENB	0x00000080
278 #define NGE_GPIO_GP4_OUTENB	0x00000100
279 #define NGE_GPIO_GP5_OUTENB	0x00000200
280 #define NGE_GPIO_GP1_IN		0x00000400
281 #define NGE_GPIO_GP2_IN		0x00000800
282 #define NGE_GPIO_GP3_IN		0x00001000
283 #define NGE_GPIO_GP4_IN		0x00002000
284 #define NGE_GPIO_GP5_IN		0x00004000
285 
286 /* Receive configuration register */
287 #define NGE_RXCFG_DRAIN_THRESH	0x0000003E /* 8-byte units */
288 #define NGE_RXCFG_DMABURST	0x00700000
289 #define NGE_RXCFG_RX_RANGEERR	0x04000000 /* accept in-range err frames */
290 #define NGE_RXCFG_RX_GIANTS	0x08000000 /* accept packets > 1518 bytes */
291 #define NGE_RXCFG_RX_FDX	0x10000000 /* full duplex receive */
292 #define NGE_RXCFG_RX_NOCRC	0x20000000 /* strip CRC */
293 #define NGE_RXCFG_RX_RUNT	0x40000000 /* accept short frames */
294 #define NGE_RXCFG_RX_BADPKTS	0x80000000 /* accept error frames */
295 
296 #define NGE_RXCFG_DRAIN(x)	((((x) >> 3) << 1) & NGE_RXCFG_DRAIN_THRESH)
297 
298 #define NGE_RXDMA_1024BYTES	0x00000000
299 #define NGE_RXDMA_8BYTES	0x00100000
300 #define NGE_RXDMA_16BYTES	0x00200000
301 #define NGE_RXDMA_32YTES	0x00300000
302 #define NGE_RXDMA_64BYTES	0x00400000
303 #define NGE_RXDMA_128BYTES	0x00500000
304 #define NGE_RXDMA_256BYTES	0x00600000
305 #define NGE_RXDMA_512BYTES	0x00700000
306 
307 /*
308  * DP83820/DP83821 with H/W VLAN stripping does not accept short VLAN
309  * tagged packets such as ARP, short icmp echo request, etc. It seems
310  * that MAC checks frame length for VLAN tagged packets after stripping
311  * the VLAN tag. For short VLAN tagged packets it would would be 56
312  * (64 - CRC - VLAN info) bytes in length after stripping VLAN tag.
313  * If the VLAN tag stripped frames are less than 60 bytes in length
314  * the hardware think it received runt packets!
315  * Therefore we should accept runt frames to get VLAN tagged ARP
316  * packets. In addition, it is known that some revisions of
317  * DP83820/DP83821 have another bug that prevent fragmented IP packets
318  * from accepting. So we also should accept errored frames.
319  */
320 #define NGE_RXCFG \
321 	(NGE_RXCFG_DRAIN(64) | NGE_RXDMA_256BYTES| \
322 	 NGE_RXCFG_RX_RANGEERR | NGE_RXCFG_RX_BADPKTS | NGE_RXCFG_RX_RUNT | \
323 	 NGE_RXCFG_RX_GIANTS | NGE_RXCFG_RX_NOCRC)
324 
325 /* Priority queue control */
326 #define NGE_PRIOQCTL_TXPRIO_ENB	0x00000001
327 #define NGE_PRIOQCTL_TXFAIR_ENB	0x00000002
328 #define NGE_PRIOQCTL_RXPRIO	0x0000000C
329 
330 #define NGE_RXPRIOQ_DISABLED	0x00000000
331 #define NGE_RXPRIOQ_TWOQS	0x00000004
332 #define NGE_RXPRIOQ_THREEQS	0x00000008
333 #define NGE_RXPRIOQ_FOURQS	0x0000000C
334 
335 /* Wake On LAN command/status register */
336 #define NGE_WOLCSR_WAKE_ON_PHYINTR	0x00000001
337 #define NGE_WOLCSR_WAKE_ON_UNICAST	0x00000002
338 #define NGE_WOLCSR_WAKE_ON_MULTICAST	0x00000004
339 #define NGE_WOLCSR_WAKE_ON_BROADCAST	0x00000008
340 #define NGE_WOLCSR_WAKE_ON_ARP		0x00000010
341 #define NGE_WOLCSR_WAKE_ON_PAT0_MATCH	0x00000020
342 #define NGE_WOLCSR_WAKE_ON_PAT1_MATCH	0x00000040
343 #define NGE_WOLCSR_WAKE_ON_PAT2_MATCH	0x00000080
344 #define NGE_WOLCSR_WAKE_ON_PAT3_MATCH	0x00000100
345 #define NGE_WOLCSR_WAKE_ON_MAGICPKT	0x00000200
346 #define NGE_WOLCSR_SECUREON_ENB		0x00000400
347 #define NGE_WOLCSR_SECUREON_HACK	0x00200000
348 #define NGE_WOLCSR_PHYINTR		0x00400000
349 #define NGE_WOLCSR_UNICAST		0x00800000
350 #define NGE_WOLCSR_MULTICAST		0x01000000
351 #define NGE_WOLCSR_BROADCAST		0x02000000
352 #define NGE_WOLCSR_ARP_RCVD		0x04000000
353 #define NGE_WOLCSR_PAT0_MATCH		0x08000000
354 #define NGE_WOLCSR_PAT1_MATCH		0x10000000
355 #define NGE_WOLCSR_PAT2_MATCH		0x20000000
356 #define NGE_WOLCSR_PAT3_MATCH		0x40000000
357 #define NGE_WOLCSR_MAGICPKT		0x80000000
358 
359 /* Pause control/status register */
360 #define NGE_PAUSECSR_CNT		0x0000FFFF
361 #define NGE_PAUSECSR_PFRAME_SENT	0x00020000
362 #define NGE_PAUSECSR_RX_DATAFIFO_THR_LO	0x000C0000
363 #define NGE_PAUSECSR_RX_DATAFIFO_THR_HI	0x00300000
364 #define NGE_PAUSECSR_RX_STATFIFO_THR_LO	0x00C00000
365 #define NGE_PAUSECSR_RX_STATFIFO_THR_HI	0x03000000
366 #define NGE_PAUSECSR_PFRAME_RCVD	0x08000000
367 #define NGE_PAUSECSR_PAUSE_ACTIVE	0x10000000
368 #define NGE_PAUSECSR_PAUSE_ON_DA	0x20000000 /* pause on direct addr */
369 #define NGE_PAUSECSR_PAUSE_ON_MCAST	0x40000000 /* pause on mcast */
370 #define NGE_PAUSECSR_PAUSE_ENB		0x80000000
371 
372 /* Receive filter/match control message */
373 #define MGE_RXFILTCTL_ADDR	0x000003FF
374 #define NGE_RXFILTCTL_ULMASK	0x00080000
375 #define NGE_RXFILTCTL_UCHASH	0x00100000
376 #define NGE_RXFILTCTL_MCHASH	0x00200000
377 #define NGE_RXFILTCTL_ARP	0x00400000
378 #define NGE_RXFILTCTL_PMATCH0	0x00800000
379 #define NGE_RXFILTCTL_PMATCH1	0x01000000
380 #define NGE_RXFILTCTL_PMATCH2	0x02000000
381 #define NGE_RXFILTCTL_PMATCH3	0x04000000
382 #define NGE_RXFILTCTL_PERFECT	0x08000000
383 #define NGE_RXFILTCTL_ALLPHYS	0x10000000
384 #define NGE_RXFILTCTL_ALLMULTI	0x20000000
385 #define NGE_RXFILTCTL_BROAD	0x40000000
386 #define NGE_RXFILTCTL_ENABLE	0x80000000
387 
388 
389 #define NGE_FILTADDR_PAR0	0x00000000
390 #define NGE_FILTADDR_PAR1	0x00000002
391 #define NGE_FILTADDR_PAR2	0x00000004
392 #define NGE_FILTADDR_PMATCH0	0x00000006
393 #define NGE_FILTADDR_PMATCH1	0x00000008
394 #define NGE_FILTADDR_SOPASS0	0x0000000A
395 #define NGE_FILTADDR_SOPASS1	0x0000000C
396 #define NGE_FILTADDR_SOPASS2	0x0000000E
397 #define NGE_FILTADDR_FMEM_LO	0x00000100
398 #define NGE_FILTADDR_FMEM_HI	0x000003FE
399 #define NGE_FILTADDR_MCAST_LO	0x00000100 /* start of multicast filter */
400 #define NGE_FILTADDR_MCAST_HI	0x000001FE /* end of multicast filter */
401 #define NGE_MCAST_FILTER_LEN	256	   /* bytes */
402 #define NGE_FILTADDR_PBUF0	0x00000200 /* pattern buffer 0 */
403 #define NGE_FILTADDR_PBUF1	0x00000280 /* pattern buffer 1 */
404 #define NGE_FILTADDR_PBUF2	0x00000300 /* pattern buffer 2 */
405 #define NGE_FILTADDR_PBUF3	0x00000380 /* pattern buffer 3 */
406 
407 /* MIB control register */
408 #define NGE_MIBCTL_WARNTEST	0x00000001
409 #define NGE_MIBCTL_FREEZE_CNT	0x00000002
410 #define NGE_MIBCTL_CLEAR_CNT	0x00000004
411 #define NGE_MIBCTL_STROBE_CNT	0x00000008
412 
413 /* VLAN/IP RX control register */
414 #define NGE_VIPRXCTL_TAG_DETECT_ENB	0x00000001
415 #define NGE_VIPRXCTL_TAG_STRIP_ENB	0x00000002
416 #define NGE_VIPRXCTL_DROP_TAGGEDPKTS	0x00000004
417 #define NGE_VIPRXCTL_DROP_UNTAGGEDPKTS	0x00000008
418 #define NGE_VIPRXCTL_IPCSUM_ENB		0x00000010
419 #define NGE_VIPRXCTL_REJECT_BADIPCSUM	0x00000020
420 #define NGE_VIPRXCTL_REJECT_BADTCPCSUM	0x00000040
421 #define NGE_VIPRXCTL_REJECT_BADUDPCSUM	0x00000080
422 
423 /* VLAN/IP TX control register */
424 #define NGE_VIPTXCTL_TAG_ALL		0x00000001
425 #define NGE_VIPTXCTL_TAG_PER_PKT	0x00000002
426 #define NGE_VIPTXCTL_CSUM_ALL		0x00000004
427 #define NGE_VIPTXCTL_CSUM_PER_PKT	0x00000008
428 
429 /* VLAN data register */
430 #define NGE_VLANDATA_VTYPE	0x0000FFFF
431 #define NGE_VLANDATA_VTCI	0xFFFF0000
432 
433 /* Clockrun register */
434 #define NGE_CLKRUN_PMESTS	0x00008000
435 #define NGE_CLKRUN_PMEENB	0x00000100
436 #define NGE_CLNRUN_CLKRUN_ENB	0x00000001
437 
438 
439 /* TBI BMCR */
440 #define NGE_TBIBMCR_RESTART_ANEG	0x00000200
441 #define NGE_TBIBMCR_ENABLE_ANEG		0x00001000
442 #define NGE_TBIBMCR_LOOPBACK		0x00004000
443 
444 /* TBI BMSR */
445 #define NGE_TBIBMSR_ANEG_DONE	0x00000004
446 #define NGE_TBIBMSR_LINKSTAT	0x00000020
447 
448 /* TBI ANAR */
449 #define NGE_TBIANAR_HDX		0x00000020
450 #define NGE_TBIANAR_FDX		0x00000040
451 #define NGE_TBIANAR_PS1		0x00000080
452 #define NGE_TBIANAR_PS2		0x00000100
453 #define NGE_TBIANAR_PCAP	0x00000180
454 #define NGE_TBIANAR_REMFAULT	0x00003000
455 #define NGE_TBIANAR_NEXTPAGE	0x00008000
456 
457 /* TBI ANLPAR */
458 #define NGE_TBIANLPAR_HDX	0x00000020
459 #define NGE_TBIANLPAR_FDX	0x00000040
460 #define NGE_TBIANAR_PS1		0x00000080
461 #define NGE_TBIANAR_PS2		0x00000100
462 #define NGE_TBIANLPAR_PCAP	0x00000180
463 #define NGE_TBIANLPAR_REMFAULT	0x00003000
464 #define NGE_TBIANLPAR_NEXTPAGE	0x00008000
465 
466 /* TBI ANER */
467 #define NGE_TBIANER_PAGERCVD	0x00000002
468 #define NGE_TBIANER_NEXTPGABLE	0x00000004
469 
470 /* TBI EXTSTS */
471 #define NGE_TBIEXTSTS_HXD	0x00004000
472 #define NGE_TBIEXTSTS_FXD	0x00008000
473 
474 /*
475  * DMA descriptor structures. The RX and TX descriptor formats are
476  * deliberately designed to be similar to facilitate passing them between
477  * RX and TX queues on multiple controllers, in the case where you have
478  * multiple MACs in a switching configuration. With the 83820, the pointer
479  * values can be either 64 bits or 32 bits depending on how the chip is
480  * configured. For the 83821, the fields are always 32-bits. There is
481  * also an optional extended status field for VLAN and TCP/IP checksum
482  * functions. We use the checksum feature so we enable the use of this
483  * field. Descriptors must be 64-bit aligned.
484  */
485 struct nge_desc_64 {
486 	/* Hardware descriptor section */
487 	uint32_t	nge_next_lo;
488 	uint32_t	nge_next_hi;
489 	uint32_t	nge_ptr_lo;
490 	uint32_t	nge_ptr_hi;
491 	uint32_t	nge_cmdsts;
492 	uint32_t	nge_extsts;
493 };
494 
495 struct nge_desc_32 {
496 	/* Hardware descriptor section */
497 	uint32_t	nge_next;
498 	uint32_t	nge_ptr;
499 	uint32_t	nge_cmdsts;
500 	uint32_t	nge_extsts;
501 };
502 
503 #define nge_desc	nge_desc_32
504 
505 #define NGE_CMDSTS_BUFLEN	0x0000FFFF
506 #define NGE_CMDSTS_PKT_OK	0x08000000
507 #define NGE_CMDSTS_CRC		0x10000000
508 #define NGE_CMDSTS_INTR		0x20000000
509 #define NGE_CMDSTS_MORE		0x40000000
510 #define NGE_CMDSTS_OWN		0x80000000
511 
512 #define NGE_INC(x, y)		(x) = ((x) + 1) % y
513 
514 #define NGE_RXSTAT_RANGELENERR	0x00010000
515 #define NGE_RXSTAT_LOOPBK	0x00020000
516 #define NGE_RXSTAT_ALIGNERR	0x00040000
517 #define NGE_RXSTAT_CRCERR	0x00080000
518 #define NGE_RXSTAT_SYMBOLERR	0x00100000
519 #define NGE_RXSTAT_RUNT		0x00200000
520 #define NGE_RXSTAT_GIANT	0x00400000
521 #define NGE_RXSTAT_DSTCLASS	0x01800000
522 #define NGE_RXSTAT_OVERRUN	0x02000000
523 #define NGE_RXSTAT_RX_ABORT	0x04000000
524 
525 #define NGE_DSTCLASS_REJECT	0x00000000
526 #define NGE_DSTCLASS_UNICAST	0x00800000
527 #define NGE_DSTCLASS_MULTICAST	0x01000000
528 #define NGE_DSTCLASS_BROADCAST	0x02000000
529 
530 #define NGE_TXSTAT_COLLCNT	0x000F0000
531 #define NGE_TXSTAT_EXCESSCOLLS	0x00100000
532 #define NGE_TXSTAT_OUTOFWINCOLL	0x00200000
533 #define NGE_TXSTAT_EXCESS_DEFER	0x00400000
534 #define NGE_TXSTAT_DEFERED	0x00800000
535 #define NGE_TXSTAT_CARR_LOST	0x01000000
536 #define NGE_TXSTAT_UNDERRUN	0x02000000
537 #define NGE_TXSTAT_TX_ABORT	0x04000000
538 
539 #define NGE_TXEXTSTS_VLAN_TCI	0x0000FFFF
540 #define NGE_TXEXTSTS_VLANPKT	0x00010000
541 #define NGE_TXEXTSTS_IPCSUM	0x00020000
542 #define NGE_TXEXTSTS_TCPCSUM	0x00080000
543 #define NGE_TXEXTSTS_UDPCSUM	0x00200000
544 
545 #define NGE_RXEXTSTS_VTCI	0x0000FFFF
546 #define NGE_RXEXTSTS_VLANPKT	0x00010000
547 #define NGE_RXEXTSTS_IPPKT	0x00020000
548 #define NGE_RXEXTSTS_IPCSUMERR	0x00040000
549 #define NGE_RXEXTSTS_TCPPKT	0x00080000
550 #define NGE_RXEXTSTS_TCPCSUMERR	0x00100000
551 #define NGE_RXEXTSTS_UDPPKT	0x00200000
552 #define NGE_RXEXTSTS_UDPCSUMERR	0x00400000
553 
554 #define NGE_TX_RING_CNT		256
555 #define NGE_RX_RING_CNT		256
556 #define	NGE_TX_RING_SIZE	sizeof(struct nge_desc) * NGE_TX_RING_CNT
557 #define	NGE_RX_RING_SIZE	sizeof(struct nge_desc) * NGE_RX_RING_CNT
558 #define	NGE_RING_ALIGN		sizeof(uint64_t)
559 #define	NGE_RX_ALIGN		sizeof(uint64_t)
560 #define	NGE_MAXTXSEGS		16
561 
562 #define	NGE_ADDR_LO(x)		((uint64_t)(x) & 0xffffffff)
563 #define	NGE_ADDR_HI(x)		((uint64_t)(x) >> 32)
564 #define	NGE_TX_RING_ADDR(sc, i)	\
565     ((sc)->nge_rdata.nge_tx_ring_paddr + sizeof(struct nge_desc) * (i))
566 #define	NGE_RX_RING_ADDR(sc, i)	\
567     ((sc)->nge_rdata.nge_rx_ring_paddr + sizeof(struct nge_desc) * (i))
568 
569 struct nge_txdesc {
570 	struct mbuf		*tx_m;
571 	bus_dmamap_t		tx_dmamap;
572 };
573 
574 struct nge_rxdesc {
575 	struct mbuf		*rx_m;
576 	bus_dmamap_t		rx_dmamap;
577 };
578 
579 struct nge_chain_data {
580 	bus_dma_tag_t		nge_parent_tag;
581 	bus_dma_tag_t		nge_tx_tag;
582 	struct nge_txdesc	nge_txdesc[NGE_TX_RING_CNT];
583 	bus_dma_tag_t		nge_rx_tag;
584 	struct nge_rxdesc	nge_rxdesc[NGE_RX_RING_CNT];
585 	bus_dma_tag_t		nge_tx_ring_tag;
586 	bus_dma_tag_t		nge_rx_ring_tag;
587 	bus_dmamap_t		nge_tx_ring_map;
588 	bus_dmamap_t		nge_rx_ring_map;
589 	bus_dmamap_t		nge_rx_sparemap;
590 	int			nge_tx_prod;
591 	int			nge_tx_cons;
592 	int			nge_tx_cnt;
593 	int			nge_rx_cons;
594 };
595 
596 struct nge_ring_data {
597 	struct nge_desc		*nge_tx_ring;
598 	bus_addr_t		nge_tx_ring_paddr;
599 	struct nge_desc		*nge_rx_ring;
600 	bus_addr_t		nge_rx_ring_paddr;
601 };
602 
603 /*
604  * NatSemi PCI vendor ID.
605  */
606 #define NGE_VENDORID		0x100B
607 
608 /*
609  * 83820/83821 PCI device IDs
610  */
611 #define NGE_DEVICEID		0x0022
612 
613 struct nge_type {
614 	uint16_t		nge_vid;
615 	uint16_t		nge_did;
616 	const char		*nge_name;
617 };
618 
619 #define NGE_JUMBO_FRAMELEN	9022
620 #define NGE_JUMBO_MTU		\
621 	(NGE_JUMBO_FRAMELEN - sizeof(struct ether_vlan_header) - ETHER_CRC_LEN)
622 
623 /* Statistics counters. */
624 struct nge_stats {
625 	uint32_t		rx_pkts_errs;
626 	uint32_t		rx_crc_errs;
627 	uint32_t		rx_fifo_oflows;
628 	uint32_t		rx_align_errs;
629 	uint32_t		rx_sym_errs;
630 	uint32_t		rx_pkts_jumbos;
631 	uint32_t		rx_len_errs;
632 	uint32_t		rx_unctl_frames;
633 	uint32_t		rx_pause;
634 	uint32_t		tx_pause;
635 	uint32_t		tx_seq_errs;
636 };
637 
638 struct nge_softc {
639 	struct ifnet		*nge_ifp;
640 	device_t		nge_dev;
641 	struct resource		*nge_res;
642 	int			nge_res_type;
643 	int			nge_res_id;
644 	struct resource		*nge_irq;
645 	void			*nge_intrhand;
646 	device_t		nge_miibus;
647 	int			nge_if_flags;
648 	uint32_t		nge_flags;
649 #define	NGE_FLAG_TBI		0x0002
650 #define	NGE_FLAG_SUSPENDED	0x2000
651 #define	NGE_FLAG_DETACH		0x4000
652 #define	NGE_FLAG_LINK		0x8000
653 	struct nge_chain_data	nge_cdata;
654 	struct nge_ring_data	nge_rdata;
655 	struct callout		nge_stat_ch;
656 	struct nge_stats	nge_stats;
657 	struct mtx		nge_mtx;
658 #ifdef DEVICE_POLLING
659 	int			rxcycles;
660 #endif
661 	int			nge_watchdog_timer;
662 	int			nge_int_holdoff;
663 	struct mbuf		*nge_head;
664 	struct mbuf		*nge_tail;
665 };
666 
667 #define	NGE_LOCK_INIT(_sc, _name) \
668 	mtx_init(&(_sc)->nge_mtx, _name, MTX_NETWORK_LOCK, MTX_DEF)
669 #define	NGE_LOCK(_sc)		mtx_lock(&(_sc)->nge_mtx)
670 #define	NGE_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->nge_mtx, MA_OWNED)
671 #define	NGE_UNLOCK(_sc)		mtx_unlock(&(_sc)->nge_mtx)
672 #define	NGE_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->nge_mtx)
673 
674 /*
675  * register space access macros
676  */
677 #define CSR_WRITE_4(sc, reg, val)	\
678 	bus_write_4((sc)->nge_res, reg, val)
679 
680 #define CSR_BARRIER_4(sc, reg, flags)	\
681 	bus_barrier((sc)->nge_res, reg, 4, flags)
682 
683 #define CSR_READ_4(sc, reg)		\
684 	bus_read_4((sc)->nge_res, reg)
685 
686 #define NGE_TIMEOUT		1000
687 
688 #define	NGE_INT_HOLDOFF_DEFAULT	1
689 #define	NGE_INT_HOLDOFF_MIN	0
690 #define	NGE_INT_HOLDOFF_MAX	255
691 
692 /*
693  * PCI low memory base and low I/O base register, and
694  * other PCI registers.
695  */
696 
697 #define NGE_PCI_VENDOR_ID	0x00
698 #define NGE_PCI_DEVICE_ID	0x02
699 #define NGE_PCI_COMMAND		0x04
700 #define NGE_PCI_STATUS		0x06
701 #define NGE_PCI_REVID		0x08
702 #define NGE_PCI_CLASSCODE	0x09
703 #define NGE_PCI_CACHELEN	0x0C
704 #define NGE_PCI_LATENCY_TIMER	0x0D
705 #define NGE_PCI_HEADER_TYPE	0x0E
706 #define NGE_PCI_LOIO		0x10
707 #define NGE_PCI_LOMEM		0x14
708 #define NGE_PCI_BIOSROM		0x30
709 #define NGE_PCI_INTLINE		0x3C
710 #define NGE_PCI_INTPIN		0x3D
711 #define NGE_PCI_MINGNT		0x3E
712 #define NGE_PCI_MINLAT		0x0F
713 #define NGE_PCI_RESETOPT	0x48
714 #define NGE_PCI_EEPROM_DATA	0x4C
715 
716 /* power management registers */
717 #define NGE_PCI_CAPID		0x50 /* 8 bits */
718 #define NGE_PCI_NEXTPTR		0x51 /* 8 bits */
719 #define NGE_PCI_PWRMGMTCAP	0x52 /* 16 bits */
720 #define NGE_PCI_PWRMGMTCTRL	0x54 /* 16 bits */
721 
722 #define NGE_PSTATE_MASK		0x0003
723 #define NGE_PSTATE_D0		0x0000
724 #define NGE_PSTATE_D1		0x0001
725 #define NGE_PSTATE_D2		0x0002
726 #define NGE_PSTATE_D3		0x0003
727 #define NGE_PME_EN		0x0010
728 #define NGE_PME_STATUS		0x8000
729