xref: /titanic_41/usr/src/uts/common/io/bge/bge_hw.h (revision 4d6eaea5019b5d24b19a812b20291ec4f8b8fa3d)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _BGE_HW_H
28 #define	_BGE_HW_H
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #include <sys/types.h>
35 
36 
37 /*
38  * First section:
39  *	Identification of the various Broadcom chips
40  *
41  * Note: the various ID values are *not* all unique ;-(
42  *
43  * Note: the presence of an ID here does *not* imply that the chip is
44  * supported.  At this time, only the 5703C, 5704C, and 5704S devices
45  * used on the motherboards of certain Sun products are supported.
46  *
47  * Note: the revision-id values in the PCI revision ID register are
48  * *NOT* guaranteed correct.  Use the chip ID from the MHCR instead.
49  */
50 
51 #define	VENDOR_ID_BROADCOM		0x14e4
52 #define	VENDOR_ID_SUN			0x108e
53 
54 #define	DEVICE_ID_5700			0x1644
55 #define	DEVICE_ID_5700x			0x0003
56 #define	DEVICE_ID_5701			0x1645
57 #define	DEVICE_ID_5702			0x16a6
58 #define	DEVICE_ID_5702fe		0x164d
59 #define	DEVICE_ID_5703C			0x16a7
60 #define	DEVICE_ID_5703S			0x1647
61 #define	DEVICE_ID_5703			0x16c7
62 #define	DEVICE_ID_5704C			0x1648
63 #define	DEVICE_ID_5704S			0x16a8
64 #define	DEVICE_ID_5704			0x1649
65 #define	DEVICE_ID_5705C			0x1653
66 #define	DEVICE_ID_5705_2		0x1654
67 #define	DEVICE_ID_5705M			0x165d
68 #define	DEVICE_ID_5705MA3		0x165e
69 #define	DEVICE_ID_5705F			0x166e
70 #define	DEVICE_ID_5780			0x166a
71 #define	DEVICE_ID_5782			0x1696
72 #define	DEVICE_ID_5787			0x169b
73 #define	DEVICE_ID_5787M			0x1693
74 #define	DEVICE_ID_5788			0x169c
75 #define	DEVICE_ID_5789			0x169d
76 #define	DEVICE_ID_5751			0x1677
77 #define	DEVICE_ID_5751M			0x167d
78 #define	DEVICE_ID_5752			0x1600
79 #define	DEVICE_ID_5752M			0x1601
80 #define	DEVICE_ID_5753			0x16fd
81 #define	DEVICE_ID_5754			0x167a
82 #define	DEVICE_ID_5755			0x167b
83 #define	DEVICE_ID_5755M			0x1673
84 #define	DEVICE_ID_5756M			0x1674
85 #define	DEVICE_ID_5721			0x1659
86 #define	DEVICE_ID_5722			0x165a
87 #define	DEVICE_ID_5723			0x165b
88 #define	DEVICE_ID_5714C			0x1668
89 #define	DEVICE_ID_5714S			0x1669
90 #define	DEVICE_ID_5715C			0x1678
91 #define	DEVICE_ID_5715S			0x1679
92 #define	DEVICE_ID_5761E			0x1680
93 #define	DEVICE_ID_5761			0x1681
94 #define	DEVICE_ID_5906			0x1712
95 #define	DEVICE_ID_5906M			0x1713
96 
97 #define	REVISION_ID_5700_B0		0x10
98 #define	REVISION_ID_5700_B2		0x12
99 #define	REVISION_ID_5700_B3		0x13
100 #define	REVISION_ID_5700_C0		0x20
101 #define	REVISION_ID_5700_C1		0x21
102 #define	REVISION_ID_5700_C2		0x22
103 
104 #define	REVISION_ID_5701_A0		0x08
105 #define	REVISION_ID_5701_A2		0x12
106 #define	REVISION_ID_5701_A3		0x15
107 
108 #define	REVISION_ID_5702_A0		0x00
109 
110 #define	REVISION_ID_5703_A0		0x00
111 #define	REVISION_ID_5703_A1		0x01
112 #define	REVISION_ID_5703_A2		0x02
113 
114 #define	REVISION_ID_5704_A0		0x00
115 #define	REVISION_ID_5704_A1		0x01
116 #define	REVISION_ID_5704_A2		0x02
117 #define	REVISION_ID_5704_A3		0x03
118 #define	REVISION_ID_5704_B0		0x10
119 
120 #define	REVISION_ID_5705_A0		0x00
121 #define	REVISION_ID_5705_A1		0x01
122 #define	REVISION_ID_5705_A2		0x02
123 #define	REVISION_ID_5705_A3		0x03
124 
125 #define	REVISION_ID_5721_A0		0x00
126 #define	REVISION_ID_5721_A1		0x01
127 
128 #define	REVISION_ID_5751_A0		0x00
129 #define	REVISION_ID_5751_A1		0x01
130 
131 #define	REVISION_ID_5714_A0		0x00
132 #define	REVISION_ID_5714_A1		0x01
133 #define	REVISION_ID_5714_A2		0xA2
134 #define	REVISION_ID_5714_A3		0xA3
135 
136 #define	REVISION_ID_5715_A0		0x00
137 #define	REVISION_ID_5715_A1		0x01
138 #define	REVISION_ID_5715_A2		0xA2
139 
140 #define	REVISION_ID_5715S_A0		0x00
141 #define	REVISION_ID_5715S_A1		0x01
142 
143 #define	REVISION_ID_5754_A0		0x00
144 #define	REVISION_ID_5754_A1		0x01
145 
146 #define	DEVICE_5704_SERIES_CHIPSETS(bgep)\
147 		((bgep->chipid.device == DEVICE_ID_5700) ||\
148 		(bgep->chipid.device == DEVICE_ID_5701) ||\
149 		(bgep->chipid.device == DEVICE_ID_5702) ||\
150 		(bgep->chipid.device == DEVICE_ID_5702fe)||\
151 		(bgep->chipid.device == DEVICE_ID_5703C) ||\
152 		(bgep->chipid.device == DEVICE_ID_5703S) ||\
153 		(bgep->chipid.device == DEVICE_ID_5703) ||\
154 		(bgep->chipid.device == DEVICE_ID_5704C) ||\
155 		(bgep->chipid.device == DEVICE_ID_5704S) ||\
156 		(bgep->chipid.device == DEVICE_ID_5704))
157 
158 #define	DEVICE_5702_SERIES_CHIPSETS(bgep) \
159 		((bgep->chipid.device == DEVICE_ID_5702) ||\
160 		(bgep->chipid.device == DEVICE_ID_5702fe))
161 
162 #define	DEVICE_5705_SERIES_CHIPSETS(bgep) \
163 		((bgep->chipid.device == DEVICE_ID_5705C) ||\
164 		(bgep->chipid.device == DEVICE_ID_5705M) ||\
165 		(bgep->chipid.device == DEVICE_ID_5705MA3) ||\
166 		(bgep->chipid.device == DEVICE_ID_5705F) ||\
167 		(bgep->chipid.device == DEVICE_ID_5780) ||\
168 		(bgep->chipid.device == DEVICE_ID_5782) ||\
169 		(bgep->chipid.device == DEVICE_ID_5788) ||\
170 		(bgep->chipid.device == DEVICE_ID_5705_2) ||\
171 		(bgep->chipid.device == DEVICE_ID_5754) ||\
172 		(bgep->chipid.device == DEVICE_ID_5755) ||\
173 		(bgep->chipid.device == DEVICE_ID_5756M) ||\
174 		(bgep->chipid.device == DEVICE_ID_5753))
175 
176 #define	DEVICE_5721_SERIES_CHIPSETS(bgep) \
177 		((bgep->chipid.device == DEVICE_ID_5721) ||\
178 		(bgep->chipid.device == DEVICE_ID_5751) ||\
179 		(bgep->chipid.device == DEVICE_ID_5751M) ||\
180 		(bgep->chipid.device == DEVICE_ID_5752) ||\
181 		(bgep->chipid.device == DEVICE_ID_5752M) ||\
182 		(bgep->chipid.device == DEVICE_ID_5789))
183 
184 #define	DEVICE_5723_SERIES_CHIPSETS(bgep) \
185 		((bgep->chipid.device == DEVICE_ID_5723) ||\
186 		(bgep->chipid.device == DEVICE_ID_5761) ||\
187 		(bgep->chipid.device == DEVICE_ID_5761E))
188 
189 #define	DEVICE_5714_SERIES_CHIPSETS(bgep) \
190 		((bgep->chipid.device == DEVICE_ID_5714C) ||\
191 		(bgep->chipid.device == DEVICE_ID_5714S) ||\
192 		(bgep->chipid.device == DEVICE_ID_5715C) ||\
193 		(bgep->chipid.device == DEVICE_ID_5715S))
194 
195 #define	DEVICE_5906_SERIES_CHIPSETS(bgep) \
196 		((bgep->chipid.device == DEVICE_ID_5906) ||\
197 		(bgep->chipid.device == DEVICE_ID_5906M))
198 
199 /*
200  * Second section:
201  *	Offsets of important registers & definitions for bits therein
202  */
203 
204 /*
205  * PCI-X registers & bits
206  */
207 #define	PCIX_CONF_COMM			0x42
208 #define	PCIX_COMM_RELAXED		0x0002
209 
210 /*
211  * Miscellaneous Host Control Register, in PCI config space
212  */
213 #define	PCI_CONF_BGE_MHCR		0x68
214 #define	MHCR_CHIP_REV_MASK		0xffff0000
215 #define	MHCR_ENABLE_TAGGED_STATUS_MODE	0x00000200
216 #define	MHCR_MASK_INTERRUPT_MODE	0x00000100
217 #define	MHCR_ENABLE_INDIRECT_ACCESS	0x00000080
218 #define	MHCR_ENABLE_REGISTER_WORD_SWAP	0x00000040
219 #define	MHCR_ENABLE_CLOCK_CONTROL_WRITE	0x00000020
220 #define	MHCR_ENABLE_PCI_STATE_WRITE	0x00000010
221 #define	MHCR_ENABLE_ENDIAN_WORD_SWAP	0x00000008
222 #define	MHCR_ENABLE_ENDIAN_BYTE_SWAP	0x00000004
223 #define	MHCR_MASK_PCI_INT_OUTPUT	0x00000002
224 #define	MHCR_CLEAR_INTERRUPT_INTA	0x00000001
225 
226 #define	MHCR_CHIP_REV_5700_B0		0x71000000
227 #define	MHCR_CHIP_REV_5700_B2		0x71020000
228 #define	MHCR_CHIP_REV_5700_B3		0x71030000
229 #define	MHCR_CHIP_REV_5700_C0		0x72000000
230 #define	MHCR_CHIP_REV_5700_C1		0x72010000
231 #define	MHCR_CHIP_REV_5700_C2		0x72020000
232 
233 #define	MHCR_CHIP_REV_5701_A0		0x00000000
234 #define	MHCR_CHIP_REV_5701_A2		0x00020000
235 #define	MHCR_CHIP_REV_5701_A3		0x00030000
236 #define	MHCR_CHIP_REV_5701_A5		0x01050000
237 
238 #define	MHCR_CHIP_REV_5702_A0		0x10000000
239 #define	MHCR_CHIP_REV_5702_A1		0x10010000
240 #define	MHCR_CHIP_REV_5702_A2		0x10020000
241 
242 #define	MHCR_CHIP_REV_5703_A0		0x10000000
243 #define	MHCR_CHIP_REV_5703_A1		0x10010000
244 #define	MHCR_CHIP_REV_5703_A2		0x10020000
245 #define	MHCR_CHIP_REV_5703_B0		0x11000000
246 #define	MHCR_CHIP_REV_5703_B1		0x11010000
247 
248 #define	MHCR_CHIP_REV_5704_A0		0x20000000
249 #define	MHCR_CHIP_REV_5704_A1		0x20010000
250 #define	MHCR_CHIP_REV_5704_A2		0x20020000
251 #define	MHCR_CHIP_REV_5704_A3		0x20030000
252 #define	MHCR_CHIP_REV_5704_B0		0x21000000
253 
254 #define	MHCR_CHIP_REV_5705_A0		0x30000000
255 #define	MHCR_CHIP_REV_5705_A1		0x30010000
256 #define	MHCR_CHIP_REV_5705_A2		0x30020000
257 #define	MHCR_CHIP_REV_5705_A3		0x30030000
258 #define	MHCR_CHIP_REV_5705_A5		0x30050000
259 
260 #define	MHCR_CHIP_REV_5782_A0		0x30030000
261 #define	MHCR_CHIP_REV_5782_A1		0x30030088
262 
263 #define	MHCR_CHIP_REV_5788_A1		0x30050000
264 
265 #define	MHCR_CHIP_REV_5751_A0		0x40000000
266 #define	MHCR_CHIP_REV_5751_A1		0x40010000
267 
268 #define	MHCR_CHIP_REV_5721_A0		0x41000000
269 #define	MHCR_CHIP_REV_5721_A1		0x41010000
270 
271 #define	MHCR_CHIP_REV_5714_A0		0x50000000
272 #define	MHCR_CHIP_REV_5714_A1		0x90010000
273 
274 #define	MHCR_CHIP_REV_5715_A0		0x50000000
275 #define	MHCR_CHIP_REV_5715_A1		0x90010000
276 
277 #define	MHCR_CHIP_REV_5715S_A0		0x50000000
278 #define	MHCR_CHIP_REV_5715S_A1		0x90010000
279 
280 #define	MHCR_CHIP_REV_5754_A0		0xb0000000
281 #define	MHCR_CHIP_REV_5754_A1		0xb0010000
282 
283 #define	MHCR_CHIP_REV_5787_A0		0xb0000000
284 #define	MHCR_CHIP_REV_5787_A1		0xb0010000
285 #define	MHCR_CHIP_REV_5787_A2		0xb0020000
286 
287 #define	MHCR_CHIP_REV_5755_A0		0xa0000000
288 #define	MHCR_CHIP_REV_5755_A1		0xa0010000
289 
290 #define	MHCR_CHIP_REV_5906_A0		0xc0000000
291 #define	MHCR_CHIP_REV_5906_A1		0xc0010000
292 #define	MHCR_CHIP_REV_5906_A2		0xc0020000
293 
294 #define	MHCR_CHIP_REV_5723_A0		0xf0000000
295 #define	MHCR_CHIP_REV_5723_A1		0xf0010000
296 #define	MHCR_CHIP_REV_5723_A2		0xf0020000
297 #define	MHCR_CHIP_REV_5723_B0		0xf1000000
298 
299 #define	MHCR_CHIP_ASIC_REV(ChipRevId)	((ChipRevId) & 0xf0000000)
300 #define	MHCR_CHIP_ASIC_REV_5700		(0x7 << 28)
301 #define	MHCR_CHIP_ASIC_REV_5701		(0x0 << 28)
302 #define	MHCR_CHIP_ASIC_REV_5703		(0x1 << 28)
303 #define	MHCR_CHIP_ASIC_REV_5704		(0x2 << 28)
304 #define	MHCR_CHIP_ASIC_REV_5705		(0x3 << 28)
305 #define	MHCR_CHIP_ASIC_REV_5721_5751	(0x4 << 28)
306 #define	MHCR_CHIP_ASIC_REV_5714 	(0x5 << 28)
307 #define	MHCR_CHIP_ASIC_REV_5752		(0x6 << 28)
308 #define	MHCR_CHIP_ASIC_REV_5754		(0xb << 28)
309 #define	MHCR_CHIP_ASIC_REV_5787		((uint32_t)0xb << 28)
310 #define	MHCR_CHIP_ASIC_REV_5755		((uint32_t)0xa << 28)
311 #define	MHCR_CHIP_ASIC_REV_5715 	((uint32_t)0x9 << 28)
312 #define	MHCR_CHIP_ASIC_REV_5906		((uint32_t)0xc << 28)
313 #define	MHCR_CHIP_ASIC_REV_5723		((uint32_t)0xf << 28)
314 
315 
316 /*
317  * PCI DMA read/write Control Register, in PCI config space
318  *
319  * Note that several fields previously defined here have been deleted
320  * as they are not implemented in the 5703/4.
321  *
322  * Note: the value of this register is critical.  It is possible to
323  * cause various unpleasant effects (DTOs, transaction deadlock, etc)
324  * by programming the wrong value.  The value #defined below has been
325  * tested and shown to avoid all known problems.  If it is to be changed,
326  * correct operation must be reverified on all supported platforms.
327  *
328  * In particular, we set both watermark fields to 2xCacheLineSize (128)
329  * bytes and DMA_MIN_BEATS to 0 in order to avoid unfortunate interactions
330  * with Tomatillo's internal pipelines, that otherwise result in stalls,
331  * repeated retries, and DTOs.
332  */
333 #define	PCI_CONF_BGE_PDRWCR		0x6c
334 #define	PDRWCR_RWCMD_MASK		0xFF000000
335 #define	PDRWCR_PCIX32_BUGFIX_MASK	0x00800000
336 #define	PDRWCR_WRITE_WATERMARK_MASK	0x00380000
337 #define	PDRWCR_READ_WATERMARK_MASK	0x00070000
338 #define	PDRWCR_CONCURRENCY_MASK		0x0000c000
339 #define	PDRWCR_5704_FLOP_ON_RETRY	0x00008000
340 #define	PDRWCR_ONE_DMA_AT_ONCE		0x00004000
341 #define	PDRWCR_MIN_BEAT_MASK		0x000000ff
342 
343 /*
344  * These are the actual values to be put into the fields shown above
345  */
346 #define	PDRWCR_RWCMDS			0x76000000	/* MW and MR	*/
347 #define	PDRWCR_DMA_WRITE_WATERMARK	0x00180000	/* 011 => 128	*/
348 #define	PDRWCR_DMA_READ_WATERMARK	0x00030000	/* 011 => 128	*/
349 #define	PDRWCR_MIN_BEATS		0x00000000
350 
351 #define	PDRWCR_VAR_DEFAULT		0x761b0000
352 #define	PDRWCR_VAR_5721			0x76180000
353 #define	PDRWCR_VAR_5714			0x76148000	/* OR of above	*/
354 #define	PDRWCR_VAR_5715			0x76144000	/* OR of above	*/
355 
356 /*
357  * PCI State Register, in PCI config space
358  *
359  * Note: this register is read-only unless the ENABLE_PCI_STATE_WRITE bit
360  * is set in the MHCR, EXCEPT for the RETRY_SAME_DMA bit which is always RW
361  */
362 #define	PCI_CONF_BGE_PCISTATE		0x70
363 #define	PCISTATE_RETRY_SAME_DMA		0x00002000
364 #define	PCISTATE_FLAT_VIEW		0x00000100
365 #define	PCISTATE_EXT_ROM_RETRY		0x00000040
366 #define	PCISTATE_EXT_ROM_ENABLE		0x00000020
367 #define	PCISTATE_BUS_IS_32_BIT		0x00000010
368 #define	PCISTATE_BUS_IS_FAST		0x00000008
369 #define	PCISTATE_BUS_IS_PCI		0x00000004
370 #define	PCISTATE_INTA_STATE		0x00000002
371 #define	PCISTATE_FORCE_RESET		0x00000001
372 
373 /*
374  * PCI Clock Control Register, in PCI config space
375  */
376 #define	PCI_CONF_BGE_CLKCTL		0x74
377 #define	CLKCTL_PCIE_PLP_DISABLE		0x80000000
378 #define	CLKCTL_PCIE_DLP_DISABLE		0x40000000
379 #define	CLKCTL_PCIE_TLP_DISABLE		0x20000000
380 #define	CLKCTL_PCI_READ_TOO_LONG_FIX	0x04000000
381 #define	CLKCTL_PCI_WRITE_TOO_LONG_FIX	0x02000000
382 #define	CLKCTL_PCIE_A0_FIX		0x00101000
383 
384 /*
385  * Dual MAC Control Register, in PCI config space
386  */
387 #define	PCI_CONF_BGE_DUAL_MAC_CONTROL	0xB8
388 #define	DUALMAC_CHANNEL_CONTROL_MASK	0x00000003	/* RW	*/
389 #define	DUALMAC_CHANNEL_ID_MASK		0x00000004	/* RO	*/
390 
391 /*
392  * Register Indirect Access Address Register, 0x78 in PCI config
393  * space.  Once this is set, accesses to the Register Indirect
394  * Access Data Register (0x80) refer to the register whose address
395  * is given by *this* register.  This allows access to all the
396  * operating registers, while using only config space accesses.
397  *
398  * Note that the address written to the RIIAR should lie in one
399  * of the following ranges:
400  *	0x00000000 <= address < 0x00008000 (regular registers)
401  *	0x00030000 <= address < 0x00034000 (RxRISC scratchpad)
402  *	0x00034000 <= address < 0x00038000 (TxRISC scratchpad)
403  *	0x00038000 <= address < 0x00038800 (RxRISC ROM)
404  */
405 #define	PCI_CONF_BGE_RIAAR		0x78
406 #define	PCI_CONF_BGE_RIADR		0x80
407 
408 #define	RIAAR_REGISTER_MIN		0x00000000
409 #define	RIAAR_REGISTER_MAX		0x00008000
410 #define	RIAAR_RX_SCRATCH_MIN		0x00030000
411 #define	RIAAR_RX_SCRATCH_MAX		0x00034000
412 #define	RIAAR_TX_SCRATCH_MIN		0x00034000
413 #define	RIAAR_TX_SCRATCH_MAX		0x00038000
414 #define	RIAAR_RXROM_MIN			0x00038000
415 #define	RIAAR_RXROM_MAX			0x00038800
416 
417 /*
418  * Memory Window Base Address Register, 0x7c in PCI config space
419  * Once this is set, accesses to the Memory Window Data Access Register
420  * (0x84) refer to the word of NIC-local memory whose address is given
421  * by this register.  When used in this way, the whole of the address
422  * written to this register is significant.
423  *
424  * This register also provides the 32K-aligned base address for a 32K
425  * region of NIC-local memory that the host can directly address in
426  * the upper 32K of the 64K of PCI memory space allocated to the chip.
427  * In this case, the bottom 15 bits of the register are ignored.
428  *
429  * Note that the address written to the MWBAR should lie in the range
430  * 0x00000000 <= address < 0x00020000.  The rest of the range up to 1M
431  * (i.e. 0x00200000 <= address < 0x01000000) would be valid if external
432  * memory were present, but it's only supported on the 5700, not the
433  * 5701/5703/5704.
434  */
435 #define	PCI_CONF_BGE_MWBAR		0x7c
436 #define	PCI_CONF_BGE_MWDAR		0x84
437 #define	MWBAR_GRANULARITY		0x00008000	/* 32k	*/
438 #define	MWBAR_GRANULE_MASK		(MWBAR_GRANULARITY-1)
439 #define	MWBAR_ONCHIP_MAX		0x00020000	/* 128k */
440 
441 /*
442  * The PCI express device control register and device status register
443  * which are only applicable on BCM5751 and BCM5721.
444  */
445 #define	PCI_CONF_DEV_CTRL		0xd8
446 #define	PCI_CONF_DEV_CTRL_5723		0xd4
447 #define	READ_REQ_SIZE_MAX		0x5000
448 #define	DEV_CTRL_NO_SNOOP		0x0800
449 #define	DEV_CTRL_RELAXED		0x0010
450 
451 #define	PCI_CONF_DEV_STUS		0xda
452 #define	PCI_CONF_DEV_STUS_5723		0xd6
453 #define	DEVICE_ERROR_STUS		0xf
454 
455 #define	NIC_MEM_WINDOW_OFFSET		0x00008000	/* 32k	*/
456 
457 /*
458  * Where to find things in NIC-local (on-chip) memory
459  */
460 #define	NIC_MEM_SEND_RINGS		0x0100
461 #define	NIC_MEM_SEND_RING(ring)		(0x0100+16*(ring))
462 #define	NIC_MEM_RECV_RINGS		0x0200
463 #define	NIC_MEM_RECV_RING(ring)		(0x0200+16*(ring))
464 #define	NIC_MEM_STATISTICS		0x0300
465 #define	NIC_MEM_STATISTICS_SIZE		0x0800
466 #define	NIC_MEM_STATUS_BLOCK		0x0b00
467 #define	NIC_MEM_STATUS_SIZE		0x0050
468 #define	NIC_MEM_GENCOMM			0x0b50
469 
470 
471 /*
472  * Note: the (non-bogus) values below are appropriate for systems
473  * without external memory.  They would be different on a 5700 with
474  * external memory.
475  *
476  * Note: The higher send ring addresses and the mini ring shadow
477  * buffer address are dummies - systems without external memory
478  * are limited to 4 send rings and no mini receive ring.
479  */
480 #define	NIC_MEM_SHADOW_DMA		0x2000
481 #define	NIC_MEM_SHADOW_SEND_1_4		0x4000
482 #define	NIC_MEM_SHADOW_SEND_5_6		0x6000		/* bogus	*/
483 #define	NIC_MEM_SHADOW_SEND_7_8		0x7000		/* bogus	*/
484 #define	NIC_MEM_SHADOW_SEND_9_16	0x8000		/* bogus	*/
485 #define	NIC_MEM_SHADOW_BUFF_STD		0x6000
486 #define	NIC_MEM_SHADOW_BUFF_JUMBO	0x7000
487 #define	NIC_MEM_SHADOW_BUFF_MINI	0x8000		/* bogus	*/
488 #define	NIC_MEM_SHADOW_SEND_RING(ring, nslots)	(0x4000 + 4*(ring)*(nslots))
489 
490 /*
491  * Put this in the GENCOMM port to tell the firmware not to run PXE
492  */
493 #define	T3_MAGIC_NUMBER			0x4b657654u
494 
495 /*
496  * The remaining registers appear in the low 32K of regular
497  * PCI Memory Address Space
498  */
499 
500 /*
501  * All the state machine control registers below have at least a
502  * <RESET> bit and an <ENABLE> bit as defined below.  Some also
503  * have an <ATTN_ENABLE> bit.
504  */
505 #define	STATE_MACHINE_ATTN_ENABLE_BIT	0x00000004
506 #define	STATE_MACHINE_ENABLE_BIT	0x00000002
507 #define	STATE_MACHINE_RESET_BIT		0x00000001
508 
509 #define	TRANSMIT_MAC_MODE_REG		0x045c
510 #define	SEND_DATA_INITIATOR_MODE_REG	0x0c00
511 #define	SEND_DATA_COMPLETION_MODE_REG	0x1000
512 #define	SEND_BD_SELECTOR_MODE_REG	0x1400
513 #define	SEND_BD_INITIATOR_MODE_REG	0x1800
514 #define	SEND_BD_COMPLETION_MODE_REG	0x1c00
515 
516 #define	RECEIVE_MAC_MODE_REG		0x0468
517 #define	RCV_LIST_PLACEMENT_MODE_REG	0x2000
518 #define	RCV_DATA_BD_INITIATOR_MODE_REG	0x2400
519 #define	RCV_DATA_COMPLETION_MODE_REG	0x2800
520 #define	RCV_BD_INITIATOR_MODE_REG	0x2c00
521 #define	RCV_BD_COMPLETION_MODE_REG	0x3000
522 #define	RCV_LIST_SELECTOR_MODE_REG	0x3400
523 
524 #define	MBUF_CLUSTER_FREE_MODE_REG	0x3800
525 #define	HOST_COALESCE_MODE_REG		0x3c00
526 #define	MEMORY_ARBITER_MODE_REG		0x4000
527 #define	BUFFER_MANAGER_MODE_REG		0x4400
528 #define	READ_DMA_MODE_REG		0x4800
529 #define	WRITE_DMA_MODE_REG		0x4c00
530 #define	DMA_COMPLETION_MODE_REG		0x6400
531 
532 /*
533  * Other bits in some of the above state machine control registers
534  */
535 
536 /*
537  * Transmit MAC Mode Register
538  * (TRANSMIT_MAC_MODE_REG, 0x045c)
539  */
540 #define	TRANSMIT_MODE_LONG_PAUSE	0x00000040
541 #define	TRANSMIT_MODE_BIG_BACKOFF	0x00000020
542 #define	TRANSMIT_MODE_FLOW_CONTROL	0x00000010
543 
544 /*
545  * Receive MAC Mode Register
546  * (RECEIVE_MAC_MODE_REG, 0x0468)
547  */
548 #define	RECEIVE_MODE_KEEP_VLAN_TAG	0x00000400
549 #define	RECEIVE_MODE_NO_CRC_CHECK	0x00000200
550 #define	RECEIVE_MODE_PROMISCUOUS	0x00000100
551 #define	RECEIVE_MODE_LENGTH_CHECK	0x00000080
552 #define	RECEIVE_MODE_ACCEPT_RUNTS	0x00000040
553 #define	RECEIVE_MODE_ACCEPT_OVERSIZE	0x00000020
554 #define	RECEIVE_MODE_KEEP_PAUSE		0x00000010
555 #define	RECEIVE_MODE_FLOW_CONTROL	0x00000004
556 
557 /*
558  * Receive BD Initiator Mode Register
559  * (RCV_BD_INITIATOR_MODE_REG, 0x2c00)
560  *
561  * Each of these bits controls whether ATTN is asserted
562  * on a particular condition
563  */
564 #define	RCV_BD_DISABLED_RING_ATTN	0x00000004
565 
566 /*
567  * Receive Data & Receive BD Initiator Mode Register
568  * (RCV_DATA_BD_INITIATOR_MODE_REG, 0x2400)
569  *
570  * Each of these bits controls whether ATTN is asserted
571  * on a particular condition
572  */
573 #define	RCV_DATA_BD_ILL_RING_ATTN	0x00000010
574 #define	RCV_DATA_BD_FRAME_SIZE_ATTN	0x00000008
575 #define	RCV_DATA_BD_NEED_JUMBO_ATTN	0x00000004
576 
577 #define	RCV_DATA_BD_ALL_ATTN_BITS	0x0000001c
578 
579 /*
580  * Host Coalescing Mode Control Register
581  * (HOST_COALESCE_MODE_REG, 0x3c00)
582  */
583 #define	COALESCE_64_BYTE_RINGS		12
584 #define	COALESCE_NO_INT_ON_COAL_FORCE	0x00001000
585 #define	COALESCE_NO_INT_ON_DMAD_FORCE	0x00000800
586 #define	COALESCE_CLR_TICKS_TX		0x00000400
587 #define	COALESCE_CLR_TICKS_RX		0x00000200
588 #define	COALESCE_32_BYTE_STATUS		0x00000100
589 #define	COALESCE_64_BYTE_STATUS		0x00000080
590 #define	COALESCE_NOW			0x00000008
591 
592 /*
593  * Memory Arbiter Mode Register
594  * (MEMORY_ARBITER_MODE_REG, 0x4000)
595  */
596 #define	MEMORY_ARBITER_ENABLE		0x00000002
597 
598 /*
599  * Buffer Manager Mode Register
600  * (BUFFER_MANAGER_MODE_REG, 0x4400)
601  *
602  * In addition to the usual error-attn common to most state machines
603  * this register has a separate bit for attn on running-low-on-mbufs
604  */
605 #define	BUFF_MGR_TEST_MODE		0x00000008
606 #define	BUFF_MGR_MBUF_LOW_ATTN_ENABLE	0x00000010
607 
608 #define	BUFF_MGR_ALL_ATTN_BITS		0x00000014
609 
610 /*
611  * Read and Write DMA Mode Registers (READ_DMA_MODE_REG,
612  * 0x4800 and WRITE_DMA_MODE_REG, 0x4c00)
613  *
614  * These registers each contain a 2-bit priority field, which controls
615  * the relative priority of that type of DMA (read vs. write vs. MSI),
616  * and a set of bits that control whether ATTN is asserted on each
617  * particular condition
618  */
619 #define	DMA_PRIORITY_MASK		0xc0000000
620 #define	DMA_PRIORITY_SHIFT		30
621 #define	ALL_DMA_ATTN_BITS		0x000003fc
622 
623 /*
624  * BCM5755, 5755M, 5906, 5906M only
625  * 1 - Enable Fix. Device will send out the status block before
626  *     the interrupt message
627  * 0 - Disable fix. Device will send out the interrupt message
628  *     before the status block
629  */
630 #define	DMA_STATUS_TAG_FIX_CQ12384	0x20000000
631 
632 /*
633  * End of state machine control register definitions
634  */
635 
636 
637 /*
638  * High priority mailbox registers.
639  * Mailbox Registers (8 bytes each, but high half unused)
640  */
641 #define	INTERRUPT_MBOX_0_REG		0x0200
642 #define	INTERRUPT_MBOX_1_REG		0x0208
643 #define	INTERRUPT_MBOX_2_REG		0x0210
644 #define	INTERRUPT_MBOX_3_REG		0x0218
645 #define	INTERRUPT_MBOX_REG(n)		(0x0200+8*(n))
646 
647 /*
648  * Low priority mailbox registers, for BCM5906, BCM5906M.
649  */
650 #define	INTERRUPT_LP_MBOX_0_REG		0x5800
651 
652 /*
653  * Ring Producer/Consumer Index (Mailbox) Registers
654  */
655 #define	RECV_STD_PROD_INDEX_REG		0x0268
656 #define	RECV_JUMBO_PROD_INDEX_REG	0x0270
657 #define	RECV_MINI_PROD_INDEX_REG	0x0278
658 #define	RECV_RING_CONS_INDEX_REGS	0x0280
659 #define	SEND_RING_HOST_PROD_INDEX_REGS	0x0300
660 #define	SEND_RING_NIC_PROD_INDEX_REGS	0x0380
661 
662 #define	RECV_RING_CONS_INDEX_REG(ring)	(0x0280+8*(ring))
663 #define	SEND_RING_HOST_INDEX_REG(ring)	(0x0300+8*(ring))
664 #define	SEND_RING_NIC_INDEX_REG(ring)	(0x0380+8*(ring))
665 
666 /*
667  * Ethernet MAC Mode Register
668  */
669 #define	ETHERNET_MAC_MODE_REG		0x0400
670 #define	ETHERNET_MODE_ENABLE_FHDE	0x00800000
671 #define	ETHERNET_MODE_ENABLE_RDE	0x00400000
672 #define	ETHERNET_MODE_ENABLE_TDE	0x00200000
673 #define	ETHERNET_MODE_ENABLE_MIP	0x00100000
674 #define	ETHERNET_MODE_ENABLE_ACPI	0x00080000
675 #define	ETHERNET_MODE_ENABLE_MAGIC_PKT	0x00040000
676 #define	ETHERNET_MODE_SEND_CFGS		0x00020000
677 #define	ETHERNET_MODE_FLUSH_TX_STATS	0x00010000
678 #define	ETHERNET_MODE_CLEAR_TX_STATS	0x00008000
679 #define	ETHERNET_MODE_ENABLE_TX_STATS	0x00004000
680 #define	ETHERNET_MODE_FLUSH_RX_STATS	0x00002000
681 #define	ETHERNET_MODE_CLEAR_RX_STATS	0x00001000
682 #define	ETHERNET_MODE_ENABLE_RX_STATS	0x00000800
683 #define	ETHERNET_MODE_LINK_POLARITY	0x00000400
684 #define	ETHERNET_MODE_MAX_DEFER		0x00000200
685 #define	ETHERNET_MODE_ENABLE_TX_BURST	0x00000100
686 #define	ETHERNET_MODE_TAGGED_MODE	0x00000080
687 #define	ETHERNET_MODE_MAC_LOOPBACK	0x00000010
688 #define	ETHERNET_MODE_PORTMODE_MASK	0x0000000c
689 #define	ETHERNET_MODE_PORTMODE_TBI	0x0000000c
690 #define	ETHERNET_MODE_PORTMODE_GMII	0x00000008
691 #define	ETHERNET_MODE_PORTMODE_MII	0x00000004
692 #define	ETHERNET_MODE_PORTMODE_NONE	0x00000000
693 #define	ETHERNET_MODE_HALF_DUPLEX	0x00000002
694 #define	ETHERNET_MODE_GLOBAL_RESET	0x00000001
695 
696 /*
697  * Ethernet MAC Status & Event Registers
698  */
699 #define	ETHERNET_MAC_STATUS_REG		0x0404
700 #define	ETHERNET_STATUS_MI_INT		0x00800000
701 #define	ETHERNET_STATUS_MI_COMPLETE	0x00400000
702 #define	ETHERNET_STATUS_LINK_CHANGED	0x00001000
703 #define	ETHERNET_STATUS_PCS_ERROR	0x00000400
704 #define	ETHERNET_STATUS_SYNC_CHANGED	0x00000010
705 #define	ETHERNET_STATUS_CFG_CHANGED	0x00000008
706 #define	ETHERNET_STATUS_RECEIVING_CFG	0x00000004
707 #define	ETHERNET_STATUS_SIGNAL_DETECT	0x00000002
708 #define	ETHERNET_STATUS_PCS_SYNCHED	0x00000001
709 
710 #define	ETHERNET_MAC_EVENT_ENABLE_REG	0x0408
711 #define	ETHERNET_EVENT_MI_INT		0x00800000
712 #define	ETHERNET_EVENT_LINK_INT		0x00001000
713 #define	ETHERNET_STATUS_PCS_ERROR_INT	0x00000400
714 
715 /*
716  * Ethernet MAC LED Control Register
717  *
718  * NOTE: PHY mode 1 *MUST* be selected; this is the hardware default and
719  * the external LED driver circuitry is wired up to assume that this mode
720  * will always be selected.  Software must not change it!
721  */
722 #define	ETHERNET_MAC_LED_CONTROL_REG	0x040c
723 #define	LED_CONTROL_OVERRIDE_BLINK	0x80000000
724 #define	LED_CONTROL_BLINK_PERIOD_MASK	0x7ff80000
725 #define	LED_CONTROL_LED_MODE_MASK	0x00001800
726 #define	LED_CONTROL_LED_MODE_5700	0x00000000
727 #define	LED_CONTROL_LED_MODE_PHY_1	0x00000800	/* mandatory	*/
728 #define	LED_CONTROL_LED_MODE_PHY_2	0x00001000
729 #define	LED_CONTROL_LED_MODE_RESERVED	0x00001800
730 #define	LED_CONTROL_TRAFFIC_LED_STATUS	0x00000400
731 #define	LED_CONTROL_10MBPS_LED_STATUS	0x00000200
732 #define	LED_CONTROL_100MBPS_LED_STATUS	0x00000100
733 #define	LED_CONTROL_1000MBPS_LED_STATUS	0x00000080
734 #define	LED_CONTROL_BLINK_TRAFFIC	0x00000040
735 #define	LED_CONTROL_TRAFFIC_LED		0x00000020
736 #define	LED_CONTROL_OVERRIDE_TRAFFIC	0x00000010
737 #define	LED_CONTROL_10MBPS_LED		0x00000008
738 #define	LED_CONTROL_100MBPS_LED		0x00000004
739 #define	LED_CONTROL_1000MBPS_LED	0x00000002
740 #define	LED_CONTROL_OVERRIDE_LINK	0x00000001
741 #define	LED_CONTROL_DEFAULT		0x02000800
742 
743 /*
744  * MAC Address registers
745  *
746  * These four eight-byte registers each hold one unicast address
747  * (six bytes), right justified & zero-filled on the left.
748  * They will normally all be set to the same value, as a station
749  * usually only has one h/w address.  The value in register 0 is
750  * used for pause packets; any of the four can be specified for
751  * substitution into other transmitted packets if required.
752  */
753 #define	MAC_ADDRESS_0_REG		0x0410
754 #define	MAC_ADDRESS_1_REG		0x0418
755 #define	MAC_ADDRESS_2_REG		0x0420
756 #define	MAC_ADDRESS_3_REG		0x0428
757 
758 #define	MAC_ADDRESS_REG(n)		(0x0410+8*(n))
759 #define	MAC_ADDRESS_REGS_MAX		4
760 
761 /*
762  * More MAC Registers ...
763  */
764 #define	MAC_TX_RANDOM_BACKOFF_REG	0x0438
765 #define	MAC_RX_MTU_SIZE_REG		0x043c
766 #define	MAC_RX_MTU_DEFAULT		0x000005f2	/* 1522	*/
767 #define	MAC_TX_LENGTHS_REG		0x0464
768 #define	MAC_TX_LENGTHS_DEFAULT		0x00002620
769 
770 /*
771  * MII access registers
772  */
773 #define	MI_COMMS_REG			0x044c
774 #define	MI_COMMS_START			0x20000000
775 #define	MI_COMMS_READ_FAILED		0x10000000
776 #define	MI_COMMS_COMMAND_MASK		0x0c000000
777 #define	MI_COMMS_COMMAND_READ		0x08000000
778 #define	MI_COMMS_COMMAND_WRITE		0x04000000
779 #define	MI_COMMS_ADDRESS_MASK		0x03e00000
780 #define	MI_COMMS_ADDRESS_SHIFT		21
781 #define	MI_COMMS_REGISTER_MASK		0x001f0000
782 #define	MI_COMMS_REGISTER_SHIFT		16
783 #define	MI_COMMS_DATA_MASK		0x0000ffff
784 #define	MI_COMMS_DATA_SHIFT		0
785 
786 #define	MI_STATUS_REG			0x0450
787 #define	MI_STATUS_10MBPS		0x00000002
788 #define	MI_STATUS_LINK			0x00000001
789 
790 #define	MI_MODE_REG			0x0454
791 #define	MI_MODE_CLOCK_MASK		0x001f0000
792 #define	MI_MODE_AUTOPOLL		0x00000010
793 #define	MI_MODE_POLL_SHORT_PREAMBLE	0x00000002
794 #define	MI_MODE_DEFAULT			0x000c0000
795 
796 #define	MI_AUTOPOLL_STATUS_REG		0x0458
797 #define	MI_AUTOPOLL_ERROR		0x00000001
798 
799 #define	TRANSMIT_MAC_STATUS_REG		0x0460
800 #define	TRANSMIT_STATUS_ODI_OVERRUN	0x00000020
801 #define	TRANSMIT_STATUS_ODI_UNDERRUN	0x00000010
802 #define	TRANSMIT_STATUS_LINK_UP		0x00000008
803 #define	TRANSMIT_STATUS_SENT_XON	0x00000004
804 #define	TRANSMIT_STATUS_SENT_XOFF	0x00000002
805 #define	TRANSMIT_STATUS_RCVD_XOFF	0x00000001
806 
807 #define	RECEIVE_MAC_STATUS_REG		0x046c
808 #define	RECEIVE_STATUS_RCVD_XON		0x00000004
809 #define	RECEIVE_STATUS_RCVD_XOFF	0x00000002
810 #define	RECEIVE_STATUS_SENT_XOFF	0x00000001
811 
812 /*
813  * These four-byte registers constitute a hash table for deciding
814  * whether to accept incoming multicast packets.  The bits are
815  * numbered in big-endian fashion, from hash 0 => the MSB of
816  * register 0 to hash 127 => the LSB of the highest-numbered
817  * register.
818  *
819  * NOTE: the 5704 can use a 256-bit table (registers 0-7) if
820  * enabled by setting the appropriate bit in the Rx MAC mode
821  * register.  Otherwise, and on all earlier chips, the table
822  * is only 128 bits (registers 0-3).
823  */
824 #define	MAC_HASH_0_REG			0x0470
825 #define	MAC_HASH_1_REG			0x0474
826 #define	MAC_HASH_2_REG			0x0478
827 #define	MAC_HASH_3_REG			0x047c
828 #define	MAC_HASH_4_REG			0x????
829 #define	MAC_HASH_5_REG			0x????
830 #define	MAC_HASH_6_REG			0x????
831 #define	MAC_HASH_7_REG			0x????
832 #define	MAC_HASH_REG(n)			(0x470+4*(n))
833 
834 /*
835  * Receive Rules Registers: 16 pairs of control+mask/value pairs
836  */
837 #define	RCV_RULES_CONTROL_0_REG		0x0480
838 #define	RCV_RULES_MASK_0_REG		0x0484
839 #define	RCV_RULES_CONTROL_15_REG	0x04f8
840 #define	RCV_RULES_MASK_15_REG		0x04fc
841 #define	RCV_RULES_CONFIG_REG		0x0500
842 #define	RCV_RULES_CONFIG_DEFAULT	0x00000008
843 
844 #define	RECV_RULES_NUM_MAX		16
845 #define	RECV_RULE_CONTROL_REG(rule)	(RCV_RULES_CONTROL_0_REG+8*(rule))
846 #define	RECV_RULE_MASK_REG(rule)	(RCV_RULES_MASK_0_REG+8*(rule))
847 
848 #define	RECV_RULE_CTL_ENABLE		0x80000000
849 #define	RECV_RULE_CTL_AND		0x40000000
850 #define	RECV_RULE_CTL_P1		0x20000000
851 #define	RECV_RULE_CTL_P2		0x10000000
852 #define	RECV_RULE_CTL_P3		0x08000000
853 #define	RECV_RULE_CTL_MASK		0x04000000
854 #define	RECV_RULE_CTL_DISCARD		0x02000000
855 #define	RECV_RULE_CTL_MAP		0x01000000
856 #define	RECV_RULE_CTL_RESV_BITS		0x00fc0000
857 #define	RECV_RULE_CTL_OP		0x00030000
858 #define	RECV_RULE_CTL_OP_EQ		0x00000000
859 #define	RECV_RULE_CTL_OP_NEQ		0x00010000
860 #define	RECV_RULE_CTL_OP_GREAT		0x00020000
861 #define	RECV_RULE_CTL_OP_LESS		0x00030000
862 #define	RECV_RULE_CTL_HEADER		0x0000e000
863 #define	RECV_RULE_CTL_HEADER_FRAME	0x00000000
864 #define	RECV_RULE_CTL_HEADER_IP		0x00002000
865 #define	RECV_RULE_CTL_HEADER_TCP	0x00004000
866 #define	RECV_RULE_CTL_HEADER_UDP	0x00006000
867 #define	RECV_RULE_CTL_HEADER_DATA	0x00008000
868 #define	RECV_RULE_CTL_CLASS_BITS	0x00001f00
869 #define	RECV_RULE_CTL_CLASS(ring)	(((ring) << 8) & \
870 					    RECV_RULE_CTL_CLASS_BITS)
871 #define	RECV_RULE_CTL_OFFSET		0x000000ff
872 
873 /*
874  * Receive Rules definition
875  */
876 #define	ETHERHEADER_DEST_OFFSET		0x00
877 #define	IPHEADER_PROTO_OFFSET		0x08
878 #define	IPHEADER_SIP_OFFSET		0x0c
879 #define	IPHEADER_DIP_OFFSET		0x10
880 #define	TCPHEADER_SPORT_OFFSET		0x00
881 #define	TCPHEADER_DPORT_OFFSET		0x02
882 #define	UDPHEADER_SPORT_OFFSET		0x00
883 #define	UDPHEADER_DPORT_OFFSET		0x02
884 
885 #define	RULE_MATCH(ring)	(RECV_RULE_CTL_ENABLE | RECV_RULE_CTL_OP_EQ | \
886 				    RECV_RULE_CTL_CLASS((ring)))
887 
888 #define	RULE_MATCH_MASK(ring)	(RULE_MATCH(ring) | RECV_RULE_CTL_MASK)
889 
890 #define	RULE_DEST_MAC_1(ring)	(RULE_MATCH(ring) | \
891 				    RECV_RULE_CTL_HEADER_FRAME | \
892 				    ETHERHEADER_DEST_OFFSET)
893 
894 #define	RULE_DEST_MAC_2(ring)	(RULE_MATCH_MASK(ring) | \
895 				    RECV_RULE_CTL_HEADER_FRAME | \
896 				    ETHERHEADER_DEST_OFFSET + 4)
897 
898 #define	RULE_LOCAL_IP(ring)	(RULE_MATCH(ring) | RECV_RULE_CTL_HEADER_IP | \
899 				    IPHEADER_DIP_OFFSET)
900 
901 #define	RULE_REMOTE_IP(ring)	(RULE_MATCH(ring) | RECV_RULE_CTL_HEADER_IP | \
902 				    IPHEADER_SIP_OFFSET)
903 
904 #define	RULE_IP_PROTO(ring)	(RULE_MATCH_MASK(ring) | \
905 				    RECV_RULE_CTL_HEADER_IP | \
906 				    IPHEADER_PROTO_OFFSET)
907 
908 #define	RULE_TCP_SPORT(ring)	(RULE_MATCH_MASK(ring) | \
909 				    RECV_RULE_CTL_HEADER_TCP | \
910 				    TCPHEADER_SPORT_OFFSET)
911 
912 #define	RULE_TCP_DPORT(ring)	(RULE_MATCH_MASK(ring) | \
913 				    RECV_RULE_CTL_HEADER_TCP | \
914 				    TCPHEADER_DPORT_OFFSET)
915 
916 #define	RULE_UDP_SPORT(ring)	(RULE_MATCH_MASK(ring) | \
917 				    RECV_RULE_CTL_HEADER_UDP | \
918 				    UDPHEADER_SPORT_OFFSET)
919 
920 #define	RULE_UDP_DPORT(ring)	(RULE_MATCH_MASK(ring) | \
921 				    RECV_RULE_CTL_HEADER_UDP | \
922 				    UDPHEADER_DPORT_OFFSET)
923 
924 /*
925  * 1000BaseX low-level access registers
926  */
927 #define	MAC_GIGABIT_PCS_TEST_REG	0x0440
928 #define	MAC_GIGABIT_PCS_TEST_ENABLE	0x00100000
929 #define	MAC_GIGABIT_PCS_TEST_PATTERN	0x000fffff
930 #define	TX_1000BASEX_AUTONEG_REG	0x0444
931 #define	RX_1000BASEX_AUTONEG_REG	0x0448
932 
933 /*
934  * Autoneg code bits for the 1000BASE-X AUTONEG registers
935  */
936 #define	AUTONEG_CODE_PAUSE		0x00008000
937 #define	AUTONEG_CODE_HALF_DUPLEX	0x00004000
938 #define	AUTONEG_CODE_FULL_DUPLEX	0x00002000
939 #define	AUTONEG_CODE_NEXT_PAGE		0x00000080
940 #define	AUTONEG_CODE_ACKNOWLEDGE	0x00000040
941 #define	AUTONEG_CODE_FAULT_MASK		0x00000030
942 #define	AUTONEG_CODE_FAULT_ANEG_ERR	0x00000030
943 #define	AUTONEG_CODE_FAULT_LINK_FAIL	0x00000020
944 #define	AUTONEG_CODE_FAULT_OFFLINE	0x00000010
945 #define	AUTONEG_CODE_ASYM_PAUSE		0x00000001
946 
947 /*
948  * SerDes Registers (5703S/5704S only)
949  */
950 #define	SERDES_CONTROL_REG		0x0590
951 #define	SERDES_CONTROL_TBI_LOOPBACK	0x00020000
952 #define	SERDES_CONTROL_COMMA_DETECT	0x00010000
953 #define	SERDES_CONTROL_TX_DISABLE	0x00004000
954 #define	SERDES_STATUS_REG		0x0594
955 #define	SERDES_STATUS_COMMA_DETECTED	0x00000100
956 #define	SERDES_STATUS_RXSTAT		0x000000ff
957 
958 /*
959  * Statistic Registers (5705/5788/5721/5751/5752/5714/5715 only)
960  */
961 #define	STAT_IFHCOUT_OCTETS_REG		0x0800
962 #define	STAT_ETHER_COLLIS_REG		0x0808
963 #define	STAT_OUTXON_SENT_REG		0x080c
964 #define	STAT_OUTXOFF_SENT_REG		0x0810
965 #define	STAT_DOT3_INTMACTX_ERR_REG		0x0818
966 #define	STAT_DOT3_SCOLLI_FRAME_REG		0x081c
967 #define	STAT_DOT3_MCOLLI_FRAME_REG		0x0820
968 #define	STAT_DOT3_DEFERED_TX_REG		0x0824
969 #define	STAT_DOT3_EXCE_COLLI_REG		0x082c
970 #define	STAT_DOT3_LATE_COLLI_REG		0x0830
971 #define	STAT_IFHCOUT_UPKGS_REG		0x086c
972 #define	STAT_IFHCOUT_MPKGS_REG		0x0870
973 #define	STAT_IFHCOUT_BPKGS_REG		0x0874
974 
975 #define	STAT_IFHCIN_OCTETS_REG		0x0880
976 #define	STAT_ETHER_FRAGMENT_REG		0x0888
977 #define	STAT_IFHCIN_UPKGS_REG		0x088c
978 #define	STAT_IFHCIN_MPKGS_REG		0x0890
979 #define	STAT_IFHCIN_BPKGS_REG		0x0894
980 
981 #define	STAT_DOT3_FCS_ERR_REG		0x0898
982 #define	STAT_DOT3_ALIGN_ERR_REG		0x089c
983 #define	STAT_XON_PAUSE_RX_REG		0x08a0
984 #define	STAT_XOFF_PAUSE_RX_REG		0x08a4
985 #define	STAT_MAC_CTRL_RX_REG		0x08a8
986 #define	STAT_XOFF_STATE_ENTER_REG		0x08ac
987 #define	STAT_DOT3_FRAME_TOOLONG_REG		0x08b0
988 #define	STAT_ETHER_JABBERS_REG		0x08b4
989 #define	STAT_ETHER_UNDERSIZE_REG		0x08b8
990 #define	SIZE_OF_STATISTIC_REG		0x1B
991 /*
992  * Send Data Initiator Registers
993  */
994 #define	SEND_INIT_STATS_CONTROL_REG	0x0c08
995 #define	SEND_INIT_STATS_ZERO		0x00000010
996 #define	SEND_INIT_STATS_FLUSH		0x00000008
997 #define	SEND_INIT_STATS_CLEAR		0x00000004
998 #define	SEND_INIT_STATS_FASTER		0x00000002
999 #define	SEND_INIT_STATS_ENABLE		0x00000001
1000 
1001 #define	SEND_INIT_STATS_ENABLE_MASK_REG	0x0c0c
1002 
1003 /*
1004  * Send Buffer Descriptor Selector Control Registers
1005  */
1006 #define	SEND_BD_SELECTOR_STATUS_REG	0x1404
1007 #define	SEND_BD_SELECTOR_HWDIAG_REG	0x1408
1008 #define	SEND_BD_SELECTOR_INDEX_REG(n)	(0x1440+4*(n))
1009 
1010 /*
1011  * Receive List Placement Registers
1012  */
1013 #define	RCV_LP_CONFIG_REG		0x2010
1014 #define	RCV_LP_CONFIG_DEFAULT		0x00000009
1015 #define	RCV_LP_CONFIG(rings)		(((rings) << 3) | 0x1)
1016 
1017 #define	RCV_LP_STATS_CONTROL_REG	0x2014
1018 #define	RCV_LP_STATS_ZERO		0x00000010
1019 #define	RCV_LP_STATS_FLUSH		0x00000008
1020 #define	RCV_LP_STATS_CLEAR		0x00000004
1021 #define	RCV_LP_STATS_FASTER		0x00000002
1022 #define	RCV_LP_STATS_ENABLE		0x00000001
1023 
1024 #define	RCV_LP_STATS_ENABLE_MASK_REG	0x2018
1025 #define	RCV_LP_STATS_DISABLE_MACTQ	0x040000
1026 
1027 /*
1028  * Receive Data & BD Initiator Registers
1029  */
1030 #define	RCV_INITIATOR_STATUS_REG	0x2404
1031 
1032 /*
1033  * Receive Buffer Descriptor Ring Control Block Registers
1034  * NB: sixteen bytes (128 bits) each
1035  */
1036 #define	JUMBO_RCV_BD_RING_RCB_REG	0x2440
1037 #define	STD_RCV_BD_RING_RCB_REG		0x2450
1038 #define	MINI_RCV_BD_RING_RCB_REG	0x2460
1039 
1040 /*
1041  * Receive Buffer Descriptor Ring Replenish Threshold Registers
1042  */
1043 #define	MINI_RCV_BD_REPLENISH_REG	0x2c14
1044 #define	MINI_RCV_BD_REPLENISH_DEFAULT	0x00000080	/* 128	*/
1045 #define	STD_RCV_BD_REPLENISH_REG	0x2c18
1046 #define	STD_RCV_BD_REPLENISH_DEFAULT	0x00000002	/* 2	*/
1047 #define	JUMBO_RCV_BD_REPLENISH_REG	0x2c1c
1048 #define	JUMBO_RCV_BD_REPLENISH_DEFAULT	0x00000020	/* 32	*/
1049 
1050 /*
1051  * Host Coalescing Engine Control Registers
1052  */
1053 #define	RCV_COALESCE_TICKS_REG		0x3c08
1054 #define	RCV_COALESCE_TICKS_DEFAULT	0x00000096	/* 150	*/
1055 #define	SEND_COALESCE_TICKS_REG		0x3c0c
1056 #define	SEND_COALESCE_TICKS_DEFAULT	0x00000096	/* 150	*/
1057 #define	RCV_COALESCE_MAX_BD_REG		0x3c10
1058 #define	RCV_COALESCE_MAX_BD_DEFAULT	0x0000000a	/* 10	*/
1059 #define	SEND_COALESCE_MAX_BD_REG	0x3c14
1060 #define	SEND_COALESCE_MAX_BD_DEFAULT	0x0000000a	/* 10	*/
1061 #define	RCV_COALESCE_INT_TICKS_REG	0x3c18
1062 #define	RCV_COALESCE_INT_TICKS_DEFAULT	0x00000000	/* 0	*/
1063 #define	SEND_COALESCE_INT_TICKS_REG	0x3c1c
1064 #define	SEND_COALESCE_INT_TICKS_DEFAULT	0x00000000	/* 0	*/
1065 #define	RCV_COALESCE_INT_BD_REG		0x3c20
1066 #define	RCV_COALESCE_INT_BD_DEFAULT	0x00000000	/* 0	*/
1067 #define	SEND_COALESCE_INT_BD_REG	0x3c24
1068 #define	SEND_COALESCE_INT_BD_DEFAULT	0x00000000	/* 0	*/
1069 #define	STATISTICS_TICKS_REG		0x3c28
1070 #define	STATISTICS_TICKS_DEFAULT	0x000f4240	/* 1000000 */
1071 #define	STATISTICS_HOST_ADDR_REG	0x3c30
1072 #define	STATUS_BLOCK_HOST_ADDR_REG	0x3c38
1073 #define	STATISTICS_BASE_ADDR_REG	0x3c40
1074 #define	STATUS_BLOCK_BASE_ADDR_REG	0x3c44
1075 #define	FLOW_ATTN_REG			0x3c48
1076 
1077 #define	NIC_JUMBO_RECV_INDEX_REG	0x3c50
1078 #define	NIC_STD_RECV_INDEX_REG		0x3c54
1079 #define	NIC_MINI_RECV_INDEX_REG		0x3c58
1080 #define	NIC_DIAG_RETURN_INDEX_REG(n)	(0x3c80+4*(n))
1081 #define	NIC_DIAG_SEND_INDEX_REG(n)	(0x3cc0+4*(n))
1082 
1083 /*
1084  * Mbuf Pool Initialisation & Watermark Registers
1085  *
1086  * There are some conflicts in the PRM; compare the recommendations
1087  * on pp. 115, 236, and 339.  The values here were recommended by
1088  * dkim@broadcom.com (and the PRM should be corrected soon ;-)
1089  */
1090 #define	BUFFER_MANAGER_STATUS_REG	0x4404
1091 #define	MBUF_POOL_BASE_REG		0x4408
1092 #define	MBUF_POOL_BASE_DEFAULT		0x00008000
1093 #define	MBUF_POOL_BASE_5721		0x00010000
1094 #define	MBUF_POOL_BASE_5704		0x00010000
1095 #define	MBUF_POOL_BASE_5705		0x00010000
1096 #define	MBUF_POOL_LENGTH_REG		0x440c
1097 #define	MBUF_POOL_LENGTH_DEFAULT	0x00018000
1098 #define	MBUF_POOL_LENGTH_5704		0x00010000
1099 #define	MBUF_POOL_LENGTH_5705		0x00008000
1100 #define	MBUF_POOL_LENGTH_5721		0x00008000
1101 #define	RDMA_MBUF_LOWAT_REG		0x4410
1102 #define	RDMA_MBUF_LOWAT_DEFAULT		0x00000050
1103 #define	RDMA_MBUF_LOWAT_5705		0x00000000
1104 #define	RDMA_MBUF_LOWAT_5906		0x00000000
1105 #define	RDMA_MBUF_LOWAT_JUMBO		0x00000130
1106 #define	RDMA_MBUF_LOWAT_5714_JUMBO	0x00000000
1107 #define	MAC_RX_MBUF_LOWAT_REG		0x4414
1108 #define	MAC_RX_MBUF_LOWAT_DEFAULT	0x00000020
1109 #define	MAC_RX_MBUF_LOWAT_5705		0x00000010
1110 #define	MAC_RX_MBUF_LOWAT_5906		0x00000004
1111 #define	MAC_RX_MBUF_LOWAT_JUMBO		0x00000098
1112 #define	MAC_RX_MBUF_LOWAT_5714_JUMBO	0x0000004b
1113 #define	MBUF_HIWAT_REG			0x4418
1114 #define	MBUF_HIWAT_DEFAULT		0x00000060
1115 #define	MBUF_HIWAT_5705			0x00000060
1116 #define	MBUF_HIWAT_5906			0x00000010
1117 #define	MBUF_HIWAT_JUMBO		0x0000017c
1118 #define	MBUF_HIWAT_5714_JUMBO		0x00000096
1119 
1120 /*
1121  * DMA Descriptor Pool Initialisation & Watermark Registers
1122  */
1123 #define	DMAD_POOL_BASE_REG		0x442c
1124 #define	DMAD_POOL_BASE_DEFAULT		0x00002000
1125 #define	DMAD_POOL_LENGTH_REG		0x4430
1126 #define	DMAD_POOL_LENGTH_DEFAULT	0x00002000
1127 #define	DMAD_POOL_LOWAT_REG		0x4434
1128 #define	DMAD_POOL_LOWAT_DEFAULT		0x00000005	/* 5	*/
1129 #define	DMAD_POOL_HIWAT_REG		0x4438
1130 #define	DMAD_POOL_HIWAT_DEFAULT		0x0000000a	/* 10	*/
1131 
1132 /*
1133  * More threshold/watermark registers ...
1134  */
1135 #define	RECV_FLOW_THRESHOLD_REG		0x4458
1136 #define	LOWAT_MAX_RECV_FRAMES_REG	0x0504
1137 #define	LOWAT_MAX_RECV_FRAMES_DEFAULT	0x00000002
1138 
1139 /*
1140  * Read/Write DMA Status Registers
1141  */
1142 #define	READ_DMA_STATUS_REG		0x4804
1143 #define	WRITE_DMA_STATUS_REG		0x4c04
1144 
1145 /*
1146  * RX/TX RISC Registers
1147  */
1148 #define	RX_RISC_MODE_REG		0x5000
1149 #define	RX_RISC_STATE_REG		0x5004
1150 #define	RX_RISC_PC_REG			0x501c
1151 #define	TX_RISC_MODE_REG		0x5400
1152 #define	TX_RISC_STATE_REG		0x5404
1153 #define	TX_RISC_PC_REG			0x541c
1154 
1155 /*
1156  * V? RISC Registerss
1157  */
1158 #define	VCPU_STATUS_REG			0x5100
1159 #define	VCPU_INIT_DONE			0x04000000
1160 #define	VCPU_DRV_RESET			0x08000000
1161 
1162 #define	VCPU_EXT_CTL			0x6890
1163 #define	VCPU_EXT_CTL_HALF		0x00400000
1164 
1165 #define	FTQ_RESET_REG			0x5c00
1166 
1167 #define	MSI_MODE_REG			0x6000
1168 #define	MSI_PRI_HIGHEST			0xc0000000
1169 #define	MSI_MSI_ENABLE			0x00000002
1170 #define	MSI_ERROR_ATTENTION		0x0000001c
1171 
1172 #define	MSI_STATUS_REG			0x6004
1173 
1174 #define	MODE_CONTROL_REG		0x6800
1175 #define	MODE_ROUTE_MCAST_TO_RX_RISC	0x40000000
1176 #define	MODE_4X_NIC_SEND_RINGS		0x20000000
1177 #define	MODE_INT_ON_FLOW_ATTN		0x10000000
1178 #define	MODE_INT_ON_DMA_ATTN		0x08000000
1179 #define	MODE_INT_ON_MAC_ATTN		0x04000000
1180 #define	MODE_INT_ON_RXRISC_ATTN		0x02000000
1181 #define	MODE_INT_ON_TXRISC_ATTN		0x01000000
1182 #define	MODE_RECV_NO_PSEUDO_HDR_CSUM	0x00800000
1183 #define	MODE_SEND_NO_PSEUDO_HDR_CSUM	0x00100000
1184 #define	MODE_HOST_SEND_BDS		0x00020000
1185 #define	MODE_HOST_STACK_UP		0x00010000
1186 #define	MODE_FORCE_32_BIT_PCI		0x00008000
1187 #define	MODE_NO_INT_ON_RECV		0x00004000
1188 #define	MODE_NO_INT_ON_SEND		0x00002000
1189 #define	MODE_ALLOW_BAD_FRAMES		0x00000800
1190 #define	MODE_NO_CRC			0x00000400
1191 #define	MODE_NO_FRAME_CRACKING		0x00000200
1192 #define	MODE_WORD_SWAP_FRAME		0x00000020
1193 #define	MODE_BYTE_SWAP_FRAME		0x00000010
1194 #define	MODE_WORD_SWAP_NONFRAME		0x00000004
1195 #define	MODE_BYTE_SWAP_NONFRAME		0x00000002
1196 #define	MODE_UPDATE_ON_COAL_ONLY	0x00000001
1197 
1198 /*
1199  * Miscellaneous Configuration Register
1200  *
1201  * This contains various bits relating to power control (which differ
1202  * among different members of the chip family), but the important bits
1203  * for our purposes are the RESET bit and the Timer Prescaler field.
1204  *
1205  * The RESET bit in this register serves to reset the whole chip, even
1206  * including the PCI interface(!)  Once it's set, the chip will not
1207  * respond to ANY accesses -- not even CONFIG space -- until the reset
1208  * completes internally.  According to the PRM, this should take less
1209  * than 100us.  Any access during this period will get a bus error.
1210  *
1211  * The Timer Prescaler field must be programmed so that the timer period
1212  * is as near as possible to 1us.  The value in this field should be
1213  * the Core Clock frequency in MHz minus 1.  From my reading of the PRM,
1214  * the Core Clock should always be 66MHz (independently of the bus speed,
1215  * at least for PCI rather than PCI-X), so this register must be set to
1216  * the value 0x82 ((66-1) << 1).
1217  */
1218 #define	CORE_CLOCK_MHZ			66
1219 #define	MISC_CONFIG_REG			0x6804
1220 #define	MISC_CONFIG_GRC_RESET_DISABLE   0x20000000
1221 #define	MISC_CONFIG_GPHY_POWERDOWN_OVERRIDE 0x04000000
1222 #define	MISC_CONFIG_POWERDOWN		0x00100000
1223 #define	MISC_CONFIG_POWER_STATE		0x00060000
1224 #define	MISC_CONFIG_PRESCALE_MASK	0x000000fe
1225 #define	MISC_CONFIG_RESET_BIT		0x00000001
1226 #define	MISC_CONFIG_DEFAULT		(((CORE_CLOCK_MHZ)-1) << 1)
1227 #define	MISC_CONFIG_EPHY_IDDQ		0x00200000
1228 
1229 /*
1230  * Miscellaneous Local Control Register (MLCR)
1231  */
1232 #define	MISC_LOCAL_CONTROL_REG		0x6808
1233 #define	MLCR_PCI_CTRL_SELECT		0x10000000
1234 #define	MLCR_LEGACY_PCI_MODE		0x08000000
1235 #define	MLCR_AUTO_SEEPROM_ACCESS	0x01000000
1236 #define	MLCR_SSRAM_CYCLE_DESELECT	0x00800000
1237 #define	MLCR_SSRAM_TYPE			0x00400000
1238 #define	MLCR_BANK_SELECT		0x00200000
1239 #define	MLCR_SRAM_SIZE_MASK		0x001c0000
1240 #define	MLCR_ENABLE_EXTERNAL_MEMORY	0x00020000
1241 
1242 #define	MLCR_MISC_PINS_OUTPUT_2		0x00010000
1243 #define	MLCR_MISC_PINS_OUTPUT_1		0x00008000
1244 #define	MLCR_MISC_PINS_OUTPUT_0		0x00004000
1245 #define	MLCR_MISC_PINS_OUTPUT_ENABLE_2	0x00002000
1246 #define	MLCR_MISC_PINS_OUTPUT_ENABLE_1	0x00001000
1247 #define	MLCR_MISC_PINS_OUTPUT_ENABLE_0	0x00000800
1248 #define	MLCR_MISC_PINS_INPUT_2		0x00000400	/* R/O	*/
1249 #define	MLCR_MISC_PINS_INPUT_1		0x00000200	/* R/O	*/
1250 #define	MLCR_MISC_PINS_INPUT_0		0x00000100	/* R/O	*/
1251 
1252 #define	MLCR_INT_ON_ATTN		0x00000008	/* R/W	*/
1253 #define	MLCR_SET_INT			0x00000004	/* W/O	*/
1254 #define	MLCR_CLR_INT			0x00000002	/* W/O	*/
1255 #define	MLCR_INTA_STATE			0x00000001	/* R/O	*/
1256 
1257 /*
1258  * This value defines all GPIO bits as INPUTS, but sets their default
1259  * values as outputs to HIGH, on the assumption that external circuits
1260  * (if any) will probably be active-LOW with passive pullups.
1261  *
1262  * The Claymore blade uses GPIO1 to control writing to the SEEPROM in
1263  * just this fashion.  It has to be set as an OUTPUT and driven LOW to
1264  * enable writing.  Otherwise, the SEEPROM is protected.
1265  */
1266 #define	MLCR_DEFAULT			0x0101c000
1267 #define	MLCR_DEFAULT_5714		0x1901c000
1268 
1269 /*
1270  * Serial EEPROM Data/Address Registers (auto-access mode)
1271  */
1272 #define	SERIAL_EEPROM_DATA_REG		0x683c
1273 #define	SERIAL_EEPROM_ADDRESS_REG	0x6838
1274 #define	SEEPROM_ACCESS_READ		0x80000000
1275 #define	SEEPROM_ACCESS_WRITE		0x00000000
1276 #define	SEEPROM_ACCESS_COMPLETE		0x40000000
1277 #define	SEEPROM_ACCESS_RESET		0x20000000
1278 #define	SEEPROM_ACCESS_DEVID_MASK	0x1c000000
1279 #define	SEEPROM_ACCESS_START		0x02000000
1280 #define	SEEPROM_ACCESS_HALFCLOCK_MASK	0x01ff0000
1281 #define	SEEPROM_ACCESS_ADDRESS_MASK	0x0000fffc
1282 
1283 #define	SEEPROM_ACCESS_DEVID_SHIFT	26		/* bits	*/
1284 #define	SEEPROM_ACCESS_HALFCLOCK_SHIFT	16		/* bits */
1285 #define	SEEPROM_ACCESS_ADDRESS_SIZE	16		/* bits	*/
1286 
1287 #define	SEEPROM_ACCESS_HALFCLOCK_340KHZ	0x0060		/* 340kHz */
1288 #define	SEEPROM_ACCESS_INIT		0x20600000	/* reset+clock	*/
1289 
1290 /*
1291  * "Linearised" address mask, treating multiple devices as consecutive
1292  */
1293 #define	SEEPROM_DEV_AND_ADDR_MASK	0x0007fffc	/* 8x64k devices */
1294 
1295 /*
1296  * Non-Volatile Memory Interface Registers
1297  * Note: on chips that support the flash interface (5702+), flash is the
1298  * default and the legacy seeprom interface must be explicitly enabled
1299  * if required. On older chips (5700/01), SEEPROM is the default (and
1300  * only) non-volatile memory available, and these registers don't exist!
1301  */
1302 #define	NVM_FLASH_CMD_REG		0x7000
1303 #define	NVM_FLASH_CMD_LAST		0x00000100
1304 #define	NVM_FLASH_CMD_FIRST		0x00000080
1305 #define	NVM_FLASH_CMD_RD		0x00000000
1306 #define	NVM_FLASH_CMD_WR		0x00000020
1307 #define	NVM_FLASH_CMD_DOIT		0x00000010
1308 #define	NVM_FLASH_CMD_DONE		0x00000008
1309 
1310 #define	NVM_FLASH_WRITE_REG		0x7008
1311 #define	NVM_FLASH_READ_REG		0x7010
1312 
1313 #define	NVM_FLASH_ADDR_REG		0x700c
1314 #define	NVM_FLASH_ADDR_MASK		0x00fffffc
1315 
1316 #define	NVM_CONFIG1_REG			0x7014
1317 #define	NVM_CFG1_LEGACY_SEEPROM_MODE	0x80000000
1318 #define	NVM_CFG1_SEE_CLK_DIV_MASK	0x003ff800
1319 #define	NVM_CFG1_SPI_CLK_DIV_MASK	0x00000780
1320 #define	NVM_CFG1_BUFFERED_MODE		0x00000002
1321 #define	NVM_CFG1_FLASH_MODE		0x00000001
1322 
1323 #define	NVM_SW_ARBITRATION_REG		0x7020
1324 #define	NVM_READ_REQ3			0X00008000
1325 #define	NVM_READ_REQ2			0X00004000
1326 #define	NVM_READ_REQ1			0X00002000
1327 #define	NVM_READ_REQ0			0X00001000
1328 #define	NVM_WON_REQ3			0X00000800
1329 #define	NVM_WON_REQ2			0X00000400
1330 #define	NVM_WON_REQ1			0X00000200
1331 #define	NVM_WON_REQ0			0X00000100
1332 #define	NVM_RESET_REQ3			0X00000080
1333 #define	NVM_RESET_REQ2			0X00000040
1334 #define	NVM_RESET_REQ1			0X00000020
1335 #define	NVM_RESET_REQ0			0X00000010
1336 #define	NVM_SET_REQ3			0X00000008
1337 #define	NVM_SET_REQ2			0X00000004
1338 #define	NVM_SET_REQ1			0X00000002
1339 #define	NVM_SET_REQ0			0X00000001
1340 
1341 /*
1342  * NVM access register
1343  * Applicable to BCM5721,BCM5751,BCM5752,BCM5714
1344  * and BCM5715 only.
1345  */
1346 #define	NVM_ACCESS_REG			0X7024
1347 #define	NVM_WRITE_ENABLE		0X00000002
1348 #define	NVM_ACCESS_ENABLE		0X00000001
1349 
1350 /*
1351  * TLP Control Register
1352  * Applicable to BCM5721 and BCM5751 only
1353  */
1354 #define	TLP_CONTROL_REG			0x7c00
1355 #define	TLP_DATA_FIFO_PROTECT		0x02000000
1356 
1357 /*
1358  * PHY Test Control Register
1359  * Applicable to BCM5721 and BCM5751 only
1360  */
1361 #define	PHY_TEST_CTRL_REG		0x7e2c
1362 #define	PHY_PCIE_SCRAM_MODE		0x20
1363 #define	PHY_PCIE_LTASS_MODE		0x40
1364 
1365 /*
1366  * The internal firmware expects a certain layout of the non-volatile
1367  * memory (if fitted), and will check for it during startup, and use the
1368  * contents to initialise various internal parameters if it looks good.
1369  *
1370  * The offsets and field definitions below refer to where to find some
1371  * important values, and how to interpret them ...
1372  */
1373 #define	NVMEM_DATA_MAC_ADDRESS		0x007c		/* 8 bytes	*/
1374 #define	NVMEM_DATA_MAC_ADDRESS_5906	0x0010		/* 8 bytes	*/
1375 
1376 /*
1377  * MII (PHY) registers, beyond those already defined in <sys/miiregs.h>
1378  */
1379 
1380 #define	MII_AN_LPNXTPG			8
1381 #define	MII_1000BASE_T_CONTROL		9
1382 #define	MII_1000BASE_T_STATUS		10
1383 #define	MII_IEEE_EXT_STATUS		15
1384 
1385 /*
1386  * New bits in the MII_CONTROL register
1387  */
1388 #define	MII_CONTROL_1000MB		0x0040
1389 
1390 /*
1391  * New bits in the MII_AN_ADVERT register
1392  */
1393 #define	MII_ABILITY_ASYM_PAUSE		0x0800
1394 #define	MII_ABILITY_PAUSE		0x0400
1395 
1396 /*
1397  * Values for the <selector> field of the MII_AN_ADVERT register
1398  */
1399 #define	MII_AN_SELECTOR_8023		0x0001
1400 
1401 /*
1402  * Bits in the MII_1000BASE_T_CONTROL register
1403  *
1404  * The MASTER_CFG bit enables manual configuration of Master/Slave mode
1405  * (otherwise, roles are automatically negotiated).  When this bit is set,
1406  * the MASTER_SEL bit forces Master mode, otherwise Slave mode is forced.
1407  */
1408 #define	MII_1000BT_CTL_MASTER_CFG	0x1000	/* enable role select	*/
1409 #define	MII_1000BT_CTL_MASTER_SEL	0x0800	/* role select bit	*/
1410 #define	MII_1000BT_CTL_ADV_FDX		0x0200
1411 #define	MII_1000BT_CTL_ADV_HDX		0x0100
1412 
1413 /*
1414  * Bits in the MII_1000BASE_T_STATUS register
1415  */
1416 #define	MII_1000BT_STAT_MASTER_FAULT	0x8000
1417 #define	MII_1000BT_STAT_MASTER_MODE	0x4000	/* shows role selected	*/
1418 #define	MII_1000BT_STAT_LCL_RCV_OK	0x2000
1419 #define	MII_1000BT_STAT_RMT_RCV_OK	0x1000
1420 #define	MII_1000BT_STAT_LP_FDX_CAP	0x0800
1421 #define	MII_1000BT_STAT_LP_HDX_CAP	0x0400
1422 
1423 /*
1424  * Vendor-specific MII registers
1425  */
1426 #define	MII_EXT_CONTROL			MII_VENDOR(0)
1427 #define	MII_EXT_STATUS			MII_VENDOR(1)
1428 #define	MII_RCV_ERR_COUNT		MII_VENDOR(2)
1429 #define	MII_FALSE_CARR_COUNT		MII_VENDOR(3)
1430 #define	MII_RCV_NOT_OK_COUNT		MII_VENDOR(4)
1431 #define	MII_AUX_CONTROL			MII_VENDOR(8)
1432 #define	MII_AUX_STATUS			MII_VENDOR(9)
1433 #define	MII_INTR_STATUS			MII_VENDOR(10)
1434 #define	MII_INTR_MASK			MII_VENDOR(11)
1435 #define	MII_HCD_STATUS			MII_VENDOR(13)
1436 
1437 #define	MII_MAXREG			MII_VENDOR(15)	/* 31, 0x1f	*/
1438 
1439 /*
1440  * Bits in the MII_EXT_CONTROL register
1441  */
1442 #define	MII_EXT_CTRL_INTERFACE_TBI	0x8000
1443 #define	MII_EXT_CTRL_DISABLE_AUTO_MDIX	0x4000
1444 #define	MII_EXT_CTRL_DISABLE_TRANSMIT	0x2000
1445 #define	MII_EXT_CTRL_DISABLE_INTERRUPT	0x1000
1446 #define	MII_EXT_CTRL_FORCE_INTERRUPT	0x0800
1447 #define	MII_EXT_CTRL_BYPASS_4B5B	0x0400
1448 #define	MII_EXT_CTRL_BYPASS_SCRAMBLER	0x0200
1449 #define	MII_EXT_CTRL_BYPASS_MLT3	0x0100
1450 #define	MII_EXT_CTRL_BYPASS_RX_ALIGN	0x0080
1451 #define	MII_EXT_CTRL_RESET_SCRAMBLER	0x0040
1452 #define	MII_EXT_CTRL_LED_TRAFFIC_MODE	0x0020
1453 #define	MII_EXT_CTRL_FORCE_LEDS_ON	0x0010
1454 #define	MII_EXT_CTRL_FORCE_LEDS_OFF	0x0008
1455 #define	MII_EXT_CTRL_EXTEND_TX_IPG	0x0004
1456 #define	MII_EXT_CTRL_3LINK_LED_MODE	0x0002
1457 #define	MII_EXT_CTRL_FIFO_ELASTICITY	0x0001
1458 
1459 /*
1460  * Bits in the MII_EXT_STATUS register
1461  */
1462 #define	MII_EXT_STAT_S3MII_FIFO_ERROR	0x8000
1463 #define	MII_EXT_STAT_WIRESPEED_DOWNGRADE 0x4000
1464 #define	MII_EXT_STAT_MDIX_STATE		0x2000
1465 #define	MII_EXT_STAT_INTERRUPT_STATUS	0x1000
1466 #define	MII_EXT_STAT_REMOTE_RCVR_STATUS	0x0800
1467 #define	MII_EXT_STAT_LOCAL_RDVR_STATUS	0x0400
1468 #define	MII_EXT_STAT_DESCRAMBLER_LOCKED	0x0200
1469 #define	MII_EXT_STAT_LINK_STATUS	0x0100
1470 #define	MII_EXT_STAT_CRC_ERROR		0x0080
1471 #define	MII_EXT_STAT_CARR_EXT_ERROR	0x0040
1472 #define	MII_EXT_STAT_BAD_SSD_ERROR	0x0020
1473 #define	MII_EXT_STAT_BAD_ESD_ERROR	0x0010
1474 #define	MII_EXT_STAT_RECEIVE_ERROR	0x0008
1475 #define	MII_EXT_STAT_TRANSMIT_ERROR	0x0004
1476 #define	MII_EXT_STAT_LOCK_ERROR		0x0002
1477 #define	MII_EXT_STAT_MLT3_CODE_ERROR	0x0001
1478 
1479 /*
1480  * The AUX CONTROL register is seriously weird!
1481  *
1482  * It hides (up to) eight 'shadow' registers.  When writing, which one
1483  * of them is written is determined by the low-order bits of the data
1484  * written(!), but when reading, which one is read is determined by the
1485  * value previously written to (part of) one of the shadow registers!!!
1486  */
1487 
1488 /*
1489  * Shadow register numbers
1490  */
1491 #define	MII_AUX_CTRL_NORMAL		0
1492 #define	MII_AUX_CTRL_10BASE_T		1
1493 #define	MII_AUX_CTRL_POWER		2
1494 #define	MII_AUX_CTRL_TEST_1		4
1495 #define	MII_AUX_CTRL_MISC		7
1496 
1497 /*
1498  * Selected bits in some of the shadow registers ...
1499  */
1500 #define	MII_AUX_CTRL_NORM_EXT_LOOPBACK	0x8000
1501 #define	MII_AUX_CTRL_NORM_LONG_PKTS	0x4000
1502 #define	MII_AUX_CTRL_NORM_EDGE_CTRL	0x3000
1503 #define	MII_AUX_CTRL_NORM_TX_MODE	0x0400
1504 #define	MII_AUX_CTRL_NORM_CABLE_TEST	0x0008
1505 
1506 #define	MII_AUX_CTRL_TEST_TX_HALF	0x0008
1507 
1508 #define	MII_AUX_CTRL_MISC_WRITE_ENABLE	0x8000
1509 #define	MII_AUX_CTRL_MISC_WIRE_SPEED	0x0010
1510 
1511 /*
1512  * Write this value to the AUX control register
1513  * to select which shadow register will be read
1514  */
1515 #define	MII_AUX_CTRL_SHADOW_READ(x)	(((x) << 12) | MII_AUX_CTRL_MISC)
1516 
1517 /*
1518  * Bits in the MII_AUX_STATUS register
1519  */
1520 #define	MII_AUX_STATUS_MODE_MASK	0x0700
1521 #define	MII_AUX_STATUS_MODE_1000_F	0x0700
1522 #define	MII_AUX_STATUS_MODE_1000_H	0x0600
1523 #define	MII_AUX_STATUS_MODE_100_F	0x0500
1524 #define	MII_AUX_STATUS_MODE_100_4	0x0400
1525 #define	MII_AUX_STATUS_MODE_100_H	0x0300
1526 #define	MII_AUX_STATUS_MODE_10_F	0x0200
1527 #define	MII_AUX_STATUS_MODE_10_H	0x0100
1528 #define	MII_AUX_STATUS_MODE_NONE	0x0000
1529 #define	MII_AUX_STATUS_MODE_SHIFT	8
1530 
1531 #define	MII_AUX_STATUS_PAR_FAULT	0x0080
1532 #define	MII_AUX_STATUS_REM_FAULT	0x0040
1533 #define	MII_AUX_STATUS_LP_ANEG_ABLE	0x0010
1534 #define	MII_AUX_STATUS_LP_NP_ABLE	0x0008
1535 
1536 #define	MII_AUX_STATUS_LINKUP		0x0004
1537 #define	MII_AUX_STATUS_RX_PAUSE		0x0002
1538 #define	MII_AUX_STATUS_TX_PAUSE		0x0001
1539 
1540 #define	MII_AUX_STATUS_SPEED_IND_5906	0x0008
1541 #define	MII_AUX_STATUS_NEG_ENABLED_5906		0x0002
1542 #define	MII_AUX_STATUS_DUPLEX_IND_5906		0x0001
1543 
1544 /*
1545  * Bits in the MII_INTR_STATUS and MII_INTR_MASK registers
1546  */
1547 #define	MII_INTR_RMT_RX_STATUS_CHANGE	0x0020
1548 #define	MII_INTR_LCL_RX_STATUS_CHANGE	0x0010
1549 #define	MII_INTR_LINK_DUPLEX_CHANGE	0x0008
1550 #define	MII_INTR_LINK_SPEED_CHANGE	0x0004
1551 #define	MII_INTR_LINK_STATUS_CHANGE	0x0002
1552 
1553 
1554 /*
1555  * Third section:
1556  * 	Hardware-defined data structures
1557  *
1558  * Note that the chip is naturally BIG-endian, so, for a big-endian
1559  * host, the structures defined below match those described in the PRM.
1560  * For little-endian hosts, some structures have to be swapped around.
1561  */
1562 
1563 #if	!defined(_BIG_ENDIAN) && !defined(_LITTLE_ENDIAN)
1564 #error	Host endianness not defined
1565 #endif
1566 
1567 /*
1568  * Architectural constants: absolute maximum numbers of each type of ring
1569  */
1570 #ifdef BGE_EXT_MEM
1571 #define	BGE_SEND_RINGS_MAX		16	/* only with ext mem	*/
1572 #else
1573 #define	BGE_SEND_RINGS_MAX		4
1574 #endif
1575 #define	BGE_SEND_RINGS_MAX_5705		1
1576 #define	BGE_RECV_RINGS_MAX		16
1577 #define	BGE_RECV_RINGS_MAX_5705		1
1578 #define	BGE_BUFF_RINGS_MAX		3	/* jumbo/std/mini (mini	*/
1579 						/* only with ext mem)	*/
1580 
1581 #define	BGE_SEND_SLOTS_MAX		512
1582 #define	BGE_STD_SLOTS_MAX		512
1583 #define	BGE_JUMBO_SLOTS_MAX		256
1584 #define	BGE_MINI_SLOTS_MAX		1024
1585 #define	BGE_RECV_SLOTS_MAX		2048
1586 #define	BGE_RECV_SLOTS_5705		512
1587 #define	BGE_RECV_SLOTS_5782		512
1588 #define	BGE_RECV_SLOTS_5721		512
1589 
1590 /*
1591  * Hardware-defined Ring Control Block
1592  */
1593 typedef struct {
1594 	uint64_t	host_ring_addr;
1595 #ifdef	_BIG_ENDIAN
1596 	uint16_t	max_len;
1597 	uint16_t	flags;
1598 	uint32_t	nic_ring_addr;
1599 #else
1600 	uint32_t	nic_ring_addr;
1601 	uint16_t	flags;
1602 	uint16_t	max_len;
1603 #endif	/* _BIG_ENDIAN */
1604 } bge_rcb_t;
1605 
1606 #define	RCB_FLAG_USE_EXT_RCV_BD		0x0001
1607 #define	RCB_FLAG_RING_DISABLED		0x0002
1608 
1609 /*
1610  * Hardware-defined Send Buffer Descriptor
1611  */
1612 typedef struct {
1613 	uint64_t	host_buf_addr;
1614 #ifdef	_BIG_ENDIAN
1615 	uint16_t	len;
1616 	uint16_t	flags;
1617 	uint16_t	reserved;
1618 	uint16_t	vlan_tci;
1619 #else
1620 	uint16_t	vlan_tci;
1621 	uint16_t	reserved;
1622 	uint16_t	flags;
1623 	uint16_t	len;
1624 #endif	/* _BIG_ENDIAN */
1625 } bge_sbd_t;
1626 
1627 #define	SBD_FLAG_TCP_UDP_CKSUM		0x0001
1628 #define	SBD_FLAG_IP_CKSUM		0x0002
1629 #define	SBD_FLAG_PACKET_END		0x0004
1630 #define	SBD_FLAG_IP_FRAG		0x0008
1631 #define	SBD_FLAG_IP_FRAG_END		0x0010
1632 
1633 #define	SBD_FLAG_VLAN_TAG		0x0040
1634 #define	SBD_FLAG_COAL_NOW		0x0080
1635 #define	SBD_FLAG_CPU_PRE_DMA		0x0100
1636 #define	SBD_FLAG_CPU_POST_DMA		0x0200
1637 
1638 #define	SBD_FLAG_INSERT_SRC_ADDR	0x1000
1639 #define	SBD_FLAG_CHOOSE_SRC_ADDR	0x6000
1640 #define	SBD_FLAG_DONT_GEN_CRC		0x8000
1641 
1642 /*
1643  * Hardware-defined Receive Buffer Descriptor
1644  */
1645 typedef struct {
1646 	uint64_t	host_buf_addr;
1647 #ifdef	_BIG_ENDIAN
1648 	uint16_t	index;
1649 	uint16_t	len;
1650 	uint16_t	type;
1651 	uint16_t	flags;
1652 	uint16_t	ip_cksum;
1653 	uint16_t	tcp_udp_cksum;
1654 	uint16_t	error_flag;
1655 	uint16_t	vlan_tci;
1656 	uint32_t	reserved;
1657 	uint32_t	opaque;
1658 #else
1659 	uint16_t	flags;
1660 	uint16_t	type;
1661 	uint16_t	len;
1662 	uint16_t	index;
1663 	uint16_t	vlan_tci;
1664 	uint16_t	error_flag;
1665 	uint16_t	tcp_udp_cksum;
1666 	uint16_t	ip_cksum;
1667 	uint32_t	opaque;
1668 	uint32_t	reserved;
1669 #endif	/* _BIG_ENDIAN */
1670 } bge_rbd_t;
1671 
1672 #define	RBD_FLAG_STD_RING		0x0000
1673 #define	RBD_FLAG_PACKET_END		0x0004
1674 
1675 #define	RBD_FLAG_JUMBO_RING		0x0020
1676 #define	RBD_FLAG_VLAN_TAG		0x0040
1677 
1678 #define	RBD_FLAG_FRAME_HAS_ERROR	0x0400
1679 #define	RBD_FLAG_MINI_RING		0x0800
1680 #define	RBD_FLAG_IP_CHECKSUM		0x1000
1681 #define	RBD_FLAG_TCP_UDP_CHECKSUM	0x2000
1682 #define	RBD_FLAG_TCP_UDP_IS_TCP		0x4000
1683 
1684 #define	RBD_FLAG_DEFAULT		0x0000
1685 
1686 #define	RBD_ERROR_BAD_CRC		0x00010000
1687 #define	RBD_ERROR_COLL_DETECT		0x00020000
1688 #define	RBD_ERROR_LINK_LOST		0x00040000
1689 #define	RBD_ERROR_PHY_DECODE_ERR	0x00080000
1690 #define	RBD_ERROR_ODD_NIBBLE_RX_MII	0x00100000
1691 #define	RBD_ERROR_MAC_ABORT		0x00200000
1692 #define	RBD_ERROR_LEN_LESS_64		0x00400000
1693 #define	RBD_ERROR_TRUNC_NO_RES		0x00800000
1694 #define	RBD_ERROR_GIANT_PKT_RCVD	0x01000000
1695 
1696 /*
1697  * Hardware-defined Status Block,Size of status block
1698  * is actually 0x50 bytes.Use 0x80 bytes for cache line
1699  * alignment.For BCM5705/5788/5721/5751/5752/5714
1700  * and 5715,there is only 1 recv and send ring index,but
1701  * driver defined 16 indexs here,please pay attention only
1702  * one ring is enabled in these chipsets.
1703  */
1704 typedef struct {
1705 	uint64_t	flags_n_tag;
1706 	uint16_t	buff_cons_index[4];
1707 	struct {
1708 #ifdef	_BIG_ENDIAN
1709 		uint16_t	send_cons_index;
1710 		uint16_t	recv_prod_index;
1711 #else
1712 		uint16_t	recv_prod_index;
1713 		uint16_t	send_cons_index;
1714 #endif	/* _BIG_ENDIAN */
1715 	} index[16];
1716 } bge_status_t;
1717 
1718 /*
1719  * Hardware-defined Receive BD Rule
1720  */
1721 typedef struct {
1722 	uint32_t	control;
1723 	uint32_t	mask_value;
1724 } bge_recv_rule_t;
1725 
1726 /*
1727  * This describes which sub-rule slots are used by a particular rule.
1728  */
1729 typedef struct {
1730 	int		start;
1731 	int		count;
1732 } bge_rule_info_t;
1733 
1734 /*
1735  * Indexes into the <buff_cons_index> array
1736  */
1737 #ifdef	_BIG_ENDIAN
1738 #define	STATUS_STD_BUFF_CONS_INDEX	0
1739 #define	STATUS_JUMBO_BUFF_CONS_INDEX	1
1740 #define	STATUS_MINI_BUFF_CONS_INDEX	3
1741 #define	SEND_INDEX_P(bsp, ring)	(&(bsp)->index[(ring)^0].send_cons_index)
1742 #define	RECV_INDEX_P(bsp, ring)	(&(bsp)->index[(ring)^0].recv_prod_index)
1743 #else
1744 #define	STATUS_STD_BUFF_CONS_INDEX	3
1745 #define	STATUS_JUMBO_BUFF_CONS_INDEX	2
1746 #define	STATUS_MINI_BUFF_CONS_INDEX	0
1747 #define	SEND_INDEX_P(bsp, ring)	(&(bsp)->index[(ring)^1].send_cons_index)
1748 #define	RECV_INDEX_P(bsp, ring)	(&(bsp)->index[(ring)^1].recv_prod_index)
1749 #endif	/* _BIG_ENDIAN */
1750 
1751 /*
1752  * Bits in the <flags_n_tag> word
1753  */
1754 #define	STATUS_FLAG_UPDATED		0x0000000100000000ull
1755 #define	STATUS_FLAG_LINK_CHANGED	0x0000000200000000ull
1756 #define	STATUS_FLAG_ERROR		0x0000000400000000ull
1757 #define	STATUS_TAG_MASK			0x00000000000000FFull
1758 
1759 /*
1760  * The tag from the status block is fed back to Interrupt Mailbox 0
1761  * (INTERRUPT_MBOX_0_REG, 0x0200) after servicing an interrupt.  This
1762  * lets the chip know what updates have been processed, so it can
1763  * reassert its interrupt if more updates have occurred since.
1764  *
1765  * These macros extract the tag from the <flags_n_tag> word, shift
1766  * it to the proper position in the Mailbox register, and provide
1767  * the complete values to write to INTERRUPT_MBOX_0_REG to disable
1768  * or enable interrupts
1769  */
1770 #define	STATUS_TAG(fnt)			((fnt) & STATUS_TAG_MASK)
1771 #define	INTERRUPT_TAG(fnt)		(STATUS_TAG(fnt) << 24)
1772 #define	INTERRUPT_MBOX_DISABLE(fnt)	(INTERRUPT_TAG(fnt) | 1)
1773 #define	INTERRUPT_MBOX_ENABLE(fnt)	(INTERRUPT_TAG(fnt) | 0)
1774 
1775 /*
1776  * Hardware-defined Statistics Block Offsets
1777  *
1778  * These are given in the manual as addresses in NIC memory, starting
1779  * from the NIC statistics area base address of 0x300; but here we
1780  * convert them into indexes into an array of (uint64_t)s, so we can
1781  * use them directly for accessing the copy of the statistics block
1782  * that the chip DMAs into main memory ...
1783  */
1784 
1785 #define	KS_BASE				0x300
1786 #define	KS_ADDR(x)			(((x)-KS_BASE)/sizeof (uint64_t))
1787 
1788 typedef enum {
1789 	KS_ifHCInOctets = KS_ADDR(0x400),
1790 	KS_etherStatsFragments = KS_ADDR(0x410),
1791 	KS_ifHCInUcastPkts,
1792 	KS_ifHCInMulticastPkts,
1793 	KS_ifHCInBroadcastPkts,
1794 	KS_dot3StatsFCSErrors,
1795 	KS_dot3StatsAlignmentErrors,
1796 	KS_xonPauseFramesReceived,
1797 	KS_xoffPauseFramesReceived,
1798 	KS_macControlFramesReceived,
1799 	KS_xoffStateEntered,
1800 	KS_dot3StatsFrameTooLongs,
1801 	KS_etherStatsJabbers,
1802 	KS_etherStatsUndersizePkts,
1803 	KS_inRangeLengthError,
1804 	KS_outRangeLengthError,
1805 	KS_etherStatsPkts64Octets,
1806 	KS_etherStatsPkts65to127Octets,
1807 	KS_etherStatsPkts128to255Octets,
1808 	KS_etherStatsPkts256to511Octets,
1809 	KS_etherStatsPkts512to1023Octets,
1810 	KS_etherStatsPkts1024to1518Octets,
1811 	KS_etherStatsPkts1519to2047Octets,
1812 	KS_etherStatsPkts2048to4095Octets,
1813 	KS_etherStatsPkts4096to8191Octets,
1814 	KS_etherStatsPkts8192to9022Octets,
1815 
1816 	KS_ifHCOutOctets = KS_ADDR(0x600),
1817 	KS_etherStatsCollisions = KS_ADDR(0x610),
1818 	KS_outXonSent,
1819 	KS_outXoffSent,
1820 	KS_flowControlDone,
1821 	KS_dot3StatsInternalMacTransmitErrors,
1822 	KS_dot3StatsSingleCollisionFrames,
1823 	KS_dot3StatsMultipleCollisionFrames,
1824 	KS_dot3StatsDeferredTransmissions,
1825 	KS_dot3StatsExcessiveCollisions = KS_ADDR(0x658),
1826 	KS_dot3StatsLateCollisions,
1827 	KS_dot3Collided2Times,
1828 	KS_dot3Collided3Times,
1829 	KS_dot3Collided4Times,
1830 	KS_dot3Collided5Times,
1831 	KS_dot3Collided6Times,
1832 	KS_dot3Collided7Times,
1833 	KS_dot3Collided8Times,
1834 	KS_dot3Collided9Times,
1835 	KS_dot3Collided10Times,
1836 	KS_dot3Collided11Times,
1837 	KS_dot3Collided12Times,
1838 	KS_dot3Collided13Times,
1839 	KS_dot3Collided14Times,
1840 	KS_dot3Collided15Times,
1841 	KS_ifHCOutUcastPkts,
1842 	KS_ifHCOutMulticastPkts,
1843 	KS_ifHCOutBroadcastPkts,
1844 	KS_dot3StatsCarrierSenseErrors,
1845 	KS_ifOutDiscards,
1846 	KS_ifOutErrors,
1847 
1848 	KS_COSIfHCInPkts_1 = KS_ADDR(0x800),		/* [16]	*/
1849 	KS_COSIfHCInPkts_2,
1850 	KS_COSIfHCInPkts_3,
1851 	KS_COSIfHCInPkts_4,
1852 	KS_COSIfHCInPkts_5,
1853 	KS_COSIfHCInPkts_6,
1854 	KS_COSIfHCInPkts_7,
1855 	KS_COSIfHCInPkts_8,
1856 	KS_COSIfHCInPkts_9,
1857 	KS_COSIfHCInPkts_10,
1858 	KS_COSIfHCInPkts_11,
1859 	KS_COSIfHCInPkts_12,
1860 	KS_COSIfHCInPkts_13,
1861 	KS_COSIfHCInPkts_14,
1862 	KS_COSIfHCInPkts_15,
1863 	KS_COSIfHCInPkts_16,
1864 	KS_COSFramesDroppedDueToFilters,
1865 	KS_nicDmaWriteQueueFull,
1866 	KS_nicDmaWriteHighPriQueueFull,
1867 	KS_nicNoMoreRxBDs,
1868 	KS_ifInDiscards,
1869 	KS_ifInErrors,
1870 	KS_nicRecvThresholdHit,
1871 
1872 	KS_COSIfHCOutPkts_1 = KS_ADDR(0x900),		/* [16]	*/
1873 	KS_COSIfHCOutPkts_2,
1874 	KS_COSIfHCOutPkts_3,
1875 	KS_COSIfHCOutPkts_4,
1876 	KS_COSIfHCOutPkts_5,
1877 	KS_COSIfHCOutPkts_6,
1878 	KS_COSIfHCOutPkts_7,
1879 	KS_COSIfHCOutPkts_8,
1880 	KS_COSIfHCOutPkts_9,
1881 	KS_COSIfHCOutPkts_10,
1882 	KS_COSIfHCOutPkts_11,
1883 	KS_COSIfHCOutPkts_12,
1884 	KS_COSIfHCOutPkts_13,
1885 	KS_COSIfHCOutPkts_14,
1886 	KS_COSIfHCOutPkts_15,
1887 	KS_COSIfHCOutPkts_16,
1888 	KS_nicDmaReadQueueFull,
1889 	KS_nicDmaReadHighPriQueueFull,
1890 	KS_nicSendDataCompQueueFull,
1891 	KS_nicRingSetSendProdIndex,
1892 	KS_nicRingStatusUpdate,
1893 	KS_nicInterrupts,
1894 	KS_nicAvoidedInterrupts,
1895 	KS_nicSendThresholdHit,
1896 
1897 	KS_STATS_SIZE = KS_ADDR(0xb00)
1898 } bge_stats_offset_t;
1899 
1900 /*
1901  * Hardware-defined Statistics Block
1902  *
1903  * Another view of the statistic block, as a array and a structure ...
1904  */
1905 
1906 typedef union {
1907 	uint64_t		a[KS_STATS_SIZE];
1908 	struct {
1909 		uint64_t	spare1[(0x400-0x300)/sizeof (uint64_t)];
1910 
1911 		uint64_t	ifHCInOctets;		/* 0x0400	*/
1912 		uint64_t	spare2[1];
1913 		uint64_t	etherStatsFragments;
1914 		uint64_t	ifHCInUcastPkts;
1915 		uint64_t	ifHCInMulticastPkts;
1916 		uint64_t	ifHCInBroadcastPkts;
1917 		uint64_t	dot3StatsFCSErrors;
1918 		uint64_t	dot3StatsAlignmentErrors;
1919 		uint64_t	xonPauseFramesReceived;
1920 		uint64_t	xoffPauseFramesReceived;
1921 		uint64_t	macControlFramesReceived;
1922 		uint64_t	xoffStateEntered;
1923 		uint64_t	dot3StatsFrameTooLongs;
1924 		uint64_t	etherStatsJabbers;
1925 		uint64_t	etherStatsUndersizePkts;
1926 		uint64_t	inRangeLengthError;
1927 		uint64_t	outRangeLengthError;
1928 		uint64_t	etherStatsPkts64Octets;
1929 		uint64_t	etherStatsPkts65to127Octets;
1930 		uint64_t	etherStatsPkts128to255Octets;
1931 		uint64_t	etherStatsPkts256to511Octets;
1932 		uint64_t	etherStatsPkts512to1023Octets;
1933 		uint64_t	etherStatsPkts1024to1518Octets;
1934 		uint64_t	etherStatsPkts1519to2047Octets;
1935 		uint64_t	etherStatsPkts2048to4095Octets;
1936 		uint64_t	etherStatsPkts4096to8191Octets;
1937 		uint64_t	etherStatsPkts8192to9022Octets;
1938 		uint64_t	spare3[(0x600-0x4d8)/sizeof (uint64_t)];
1939 
1940 		uint64_t	ifHCOutOctets;		/* 0x0600	*/
1941 		uint64_t	spare4[1];
1942 		uint64_t	etherStatsCollisions;
1943 		uint64_t	outXonSent;
1944 		uint64_t	outXoffSent;
1945 		uint64_t	flowControlDone;
1946 		uint64_t	dot3StatsInternalMacTransmitErrors;
1947 		uint64_t	dot3StatsSingleCollisionFrames;
1948 		uint64_t	dot3StatsMultipleCollisionFrames;
1949 		uint64_t	dot3StatsDeferredTransmissions;
1950 		uint64_t	spare5[1];
1951 		uint64_t	dot3StatsExcessiveCollisions;
1952 		uint64_t	dot3StatsLateCollisions;
1953 		uint64_t	dot3Collided2Times;
1954 		uint64_t	dot3Collided3Times;
1955 		uint64_t	dot3Collided4Times;
1956 		uint64_t	dot3Collided5Times;
1957 		uint64_t	dot3Collided6Times;
1958 		uint64_t	dot3Collided7Times;
1959 		uint64_t	dot3Collided8Times;
1960 		uint64_t	dot3Collided9Times;
1961 		uint64_t	dot3Collided10Times;
1962 		uint64_t	dot3Collided11Times;
1963 		uint64_t	dot3Collided12Times;
1964 		uint64_t	dot3Collided13Times;
1965 		uint64_t	dot3Collided14Times;
1966 		uint64_t	dot3Collided15Times;
1967 		uint64_t	ifHCOutUcastPkts;
1968 		uint64_t	ifHCOutMulticastPkts;
1969 		uint64_t	ifHCOutBroadcastPkts;
1970 		uint64_t	dot3StatsCarrierSenseErrors;
1971 		uint64_t	ifOutDiscards;
1972 		uint64_t	ifOutErrors;
1973 		uint64_t	spare6[(0x800-0x708)/sizeof (uint64_t)];
1974 
1975 		uint64_t	COSIfHCInPkts[16];	/* 0x0800	*/
1976 		uint64_t	COSFramesDroppedDueToFilters;
1977 		uint64_t	nicDmaWriteQueueFull;
1978 		uint64_t	nicDmaWriteHighPriQueueFull;
1979 		uint64_t	nicNoMoreRxBDs;
1980 		uint64_t	ifInDiscards;
1981 		uint64_t	ifInErrors;
1982 		uint64_t	nicRecvThresholdHit;
1983 		uint64_t	spare7[(0x900-0x8b8)/sizeof (uint64_t)];
1984 
1985 		uint64_t	COSIfHCOutPkts[16];	/* 0x0900	*/
1986 		uint64_t	nicDmaReadQueueFull;
1987 		uint64_t	nicDmaReadHighPriQueueFull;
1988 		uint64_t	nicSendDataCompQueueFull;
1989 		uint64_t	nicRingSetSendProdIndex;
1990 		uint64_t	nicRingStatusUpdate;
1991 		uint64_t	nicInterrupts;
1992 		uint64_t	nicAvoidedInterrupts;
1993 		uint64_t	nicSendThresholdHit;
1994 		uint64_t	spare8[(0xb00-0x9c0)/sizeof (uint64_t)];
1995 	} s;
1996 } bge_statistics_t;
1997 
1998 #define	KS_STAT_REG_SIZE	(0x1B)
1999 #define	KS_STAT_REG_BASE	(0x800)
2000 
2001 typedef struct {
2002 	uint32_t	ifHCOutOctets;
2003 	uint32_t	etherStatsCollisions;
2004 	uint32_t	outXonSent;
2005 	uint32_t	outXoffSent;
2006 	uint32_t	dot3StatsInternalMacTransmitErrors;
2007 	uint32_t	dot3StatsSingleCollisionFrames;
2008 	uint32_t	dot3StatsMultipleCollisionFrames;
2009 	uint32_t	dot3StatsDeferredTransmissions;
2010 	uint32_t	dot3StatsExcessiveCollisions;
2011 	uint32_t	dot3StatsLateCollisions;
2012 	uint32_t	ifHCOutUcastPkts;
2013 	uint32_t	ifHCOutMulticastPkts;
2014 	uint32_t	ifHCOutBroadcastPkts;
2015 	uint32_t	ifHCInOctets;
2016 	uint32_t	etherStatsFragments;
2017 	uint32_t	ifHCInUcastPkts;
2018 	uint32_t	ifHCInMulticastPkts;
2019 	uint32_t	ifHCInBroadcastPkts;
2020 	uint32_t	dot3StatsFCSErrors;
2021 	uint32_t	dot3StatsAlignmentErrors;
2022 	uint32_t	xonPauseFramesReceived;
2023 	uint32_t	xoffPauseFramesReceived;
2024 	uint32_t	macControlFramesReceived;
2025 	uint32_t	xoffStateEntered;
2026 	uint32_t	dot3StatsFrameTooLongs;
2027 	uint32_t	etherStatsJabbers;
2028 	uint32_t	etherStatsUndersizePkts;
2029 } bge_statistics_reg_t;
2030 
2031 
2032 #ifdef BGE_IPMI_ASF
2033 
2034 /*
2035  * Device internal memory entries
2036  */
2037 
2038 #define	BGE_FIRMWARE_MAILBOX				0x0b50
2039 #define	BGE_MAGIC_NUM_FIRMWARE_INIT_DONE		0x4b657654
2040 #define	BGE_MAGIC_NUM_DISABLE_DMAW_ON_LINK_CHANGE	0x4861764b
2041 
2042 
2043 #define	BGE_NIC_DATA_SIG_ADDR			0x0b54
2044 #define	BGE_NIC_DATA_SIG			0x4b657654
2045 
2046 
2047 #define	BGE_NIC_DATA_NIC_CFG_ADDR		0x0b58
2048 
2049 #define	BGE_NIC_CFG_LED_MODE_TRIPLE_SPEED	0x000004
2050 #define	BGE_NIC_CFG_LED_MODE_LINK_SPEED		0x000008
2051 #define	BGE_NIC_CFG_LED_MODE_OPEN_DRAIN		0x000004
2052 #define	BGE_NIC_CFG_LED_MODE_OUTPUT		0x000008
2053 #define	BGE_NIC_CFG_LED_MODE_MASK		0x00000c
2054 
2055 #define	BGE_NIC_CFG_PHY_TYPE_UNKNOWN		0x000000
2056 #define	BGE_NIC_CFG_PHY_TYPE_COPPER		0x000010
2057 #define	BGE_NIC_CFG_PHY_TYPE_FIBER		0x000020
2058 #define	BGE_NIC_CFG_PHY_TYPE_MASK		0x000030
2059 
2060 #define	BGE_NIC_CFG_ENABLE_WOL			0x000040
2061 #define	BGE_NIC_CFG_ENABLE_ASF			0x000080
2062 #define	BGE_NIC_CFG_EEPROM_WP			0x000100
2063 #define	BGE_NIC_CFG_POWER_SAVING		0x000200
2064 #define	BGE_NIC_CFG_SWAP_PORT			0x000800
2065 #define	BGE_NIC_CFG_MINI_PCI			0x001000
2066 #define	BGE_NIC_CFG_FIBER_WOL_CAPABLE		0x004000
2067 #define	BGE_NIC_CFG_5753_12x12			0x100000
2068 
2069 
2070 #define	BGE_NIC_DATA_FIRMWARE_VERSION		0x0b5c
2071 
2072 
2073 #define	BGE_NIC_DATA_PHY_ID_ADDR		0x0b74
2074 #define	BGE_NIC_PHY_ID1_MASK			0xffff0000
2075 #define	BGE_NIC_PHY_ID2_MASK			0x0000ffff
2076 
2077 
2078 #define	BGE_CMD_MAILBOX				0x0b78
2079 #define	BGE_CMD_NICDRV_ALIVE			0x00000001
2080 #define	BGE_CMD_NICDRV_PAUSE_FW			0x00000002
2081 #define	BGE_CMD_NICDRV_IPV4ADDR_CHANGE		0x00000003
2082 #define	BGE_CMD_NICDRV_IPV6ADDR_CHANGE		0x00000004
2083 
2084 
2085 #define	BGE_CMD_LENGTH_MAILBOX			0x0b7c
2086 #define	BGE_CMD_DATA_MAILBOX			0x0b80
2087 #define	BGE_ASF_FW_STATUS_MAILBOX		0x0c00
2088 
2089 #define	BGE_DRV_STATE_MAILBOX			0x0c04
2090 #define	BGE_DRV_STATE_START			0x00000001
2091 #define	BGE_DRV_STATE_START_DONE		0x80000001
2092 #define	BGE_DRV_STATE_UNLOAD			0x00000002
2093 #define	BGE_DRV_STATE_UNLOAD_DONE		0x80000002
2094 #define	BGE_DRV_STATE_WOL			0x00000003
2095 #define	BGE_DRV_STATE_SUSPEND			0x00000004
2096 
2097 
2098 #define	BGE_FW_LAST_RESET_TYPE_MAILBOX		0x0c08
2099 #define	BGE_FW_LAST_RESET_TYPE_WARM		0x0001
2100 #define	BGE_FW_LAST_RESET_TYPE_COLD		0x0002
2101 
2102 
2103 #define	BGE_MAC_ADDR_HIGH_MAILBOX		0x0c14
2104 #define	BGE_MAC_ADDR_LOW_MAILBOX		0x0c18
2105 
2106 
2107 /*
2108  * RX-RISC event register
2109  */
2110 #define	RX_RISC_EVENT_REG			0x6810
2111 #define	RRER_ASF_EVENT				0x4000
2112 
2113 #endif /* BGE_IPMI_ASF */
2114 
2115 #ifdef __cplusplus
2116 }
2117 #endif
2118 
2119 #endif	/* _BGE_HW_H */
2120