xref: /freebsd/sys/dev/sk/xmaciireg.h (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1997, 1998, 1999, 2000
5  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD$
35  */
36 
37 /*
38  * Registers and data structures for the XaQti Corporation XMAC II
39  * Gigabit Ethernet MAC. Datasheet is available from http://www.xaqti.com.
40  * The XMAC can be programmed for 16-bit or 32-bit register access modes.
41  * The SysKonnect gigabit ethernet adapters use 16-bit mode, so that's
42  * how the registers are laid out here.
43  */
44 
45 #define XM_DEVICEID		0x00E0AE20
46 #define XM_XAQTI_OUI		0x00E0AE
47 
48 #define XM_XMAC_REV(x)		(((x) & 0x000000E0) >> 5)
49 
50 #define XM_XMAC_REV_B2		0x0
51 #define XM_XMAC_REV_C1		0x1
52 
53 #define XM_MMUCMD		0x0000
54 #define XM_POFF			0x0008
55 #define XM_BURST		0x000C
56 #define XM_VLAN_TAGLEV1		0x0010
57 #define XM_VLAN_TAGLEV2		0x0014
58 #define XM_TXCMD		0x0020
59 #define XM_TX_RETRYLIMIT	0x0024
60 #define XM_TX_SLOTTIME		0x0028
61 #define XM_TX_IPG		0x003C
62 #define XM_RXCMD		0x0030
63 #define XM_PHY_ADDR		0x0034
64 #define XM_PHY_DATA		0x0038
65 #define XM_GPIO			0x0040
66 #define XM_IMR			0x0044
67 #define XM_ISR			0x0048
68 #define XM_HWCFG		0x004C
69 #define XM_TX_LOWAT		0x0060
70 #define XM_TX_HIWAT		0x0062
71 #define XM_TX_REQTHRESH_LO	0x0064
72 #define XM_TX_REQTHRESH_HI	0x0066
73 #define XM_TX_REQTHRESH		XM_TX_REQTHRESH_LO
74 #define XM_PAUSEDST0		0x0068
75 #define XM_PAUSEDST1		0x006A
76 #define XM_PAUSEDST2		0x006C
77 #define XM_CTLPARM_LO		0x0070
78 #define XM_CTLPARM_HI		0x0072
79 #define XM_CTLPARM		XM_CTLPARM_LO
80 #define XM_OPCODE_PAUSE_TIMER	0x0074
81 #define XM_TXSTAT_LIFO		0x0078
82 
83 /*
84  * Perfect filter registers. The XMAC has a table of 16 perfect
85  * filter entries, spaced 8 bytes apart. This is in addition to
86  * the station address registers, which appear below.
87  */
88 #define XM_RXFILT_BASE		0x0080
89 #define XM_RXFILT_END		0x0107
90 #define XM_RXFILT_MAX		16
91 #define XM_RXFILT_ENTRY(ent)		(XM_RXFILT_BASE + ((ent * 8)))
92 
93 /* Primary station address. */
94 #define XM_PAR0			0x0108
95 #define XM_PAR1			0x010A
96 #define XM_PAR2			0x010C
97 
98 /* 64-bit multicast hash table registers */
99 #define XM_MAR0			0x0110
100 #define XM_MAR1			0x0112
101 #define XM_MAR2			0x0114
102 #define XM_MAR3			0x0116
103 #define XM_RX_LOWAT		0x0118
104 #define XM_RX_HIWAT		0x011A
105 #define XM_RX_REQTHRESH_LO	0x011C
106 #define XM_RX_REQTHRESH_HI	0x011E
107 #define XM_RX_REQTHRESH		XM_RX_REQTHRESH_LO
108 #define XM_DEVID_LO		0x0120
109 #define XM_DEVID_HI		0x0122
110 #define XM_DEVID		XM_DEVID_LO
111 #define XM_MODE_LO		0x0124
112 #define XM_MODE_HI		0x0126
113 #define XM_MODE			XM_MODE_LO
114 #define XM_LASTSRC0		0x0128
115 #define XM_LASTSRC1		0x012A
116 #define XM_LASTSRC2		0x012C
117 #define XM_TSTAMP_READ		0x0130
118 #define XM_TSTAMP_LOAD		0x0134
119 #define XM_STATS_CMD		0x0200
120 #define XM_RXCNT_EVENT_LO	0x0204
121 #define XM_RXCNT_EVENT_HI	0x0206
122 #define XM_RXCNT_EVENT		XM_RXCNT_EVENT_LO
123 #define XM_TXCNT_EVENT_LO	0x0208
124 #define XM_TXCNT_EVENT_HI	0x020A
125 #define XM_TXCNT_EVENT		XM_TXCNT_EVENT_LO
126 #define XM_RXCNT_EVMASK_LO	0x020C
127 #define XM_RXCNT_EVMASK_HI	0x020E
128 #define XM_RXCNT_EVMASK		XM_RXCNT_EVMASK_LO
129 #define XM_TXCNT_EVMASK_LO	0x0210
130 #define XM_TXCNT_EVMASK_HI	0x0212
131 #define XM_TXCNT_EVMASK		XM_TXCNT_EVMASK_LO
132 
133 /* Statistics command register */
134 #define XM_STATCMD_CLR_TX	0x0001
135 #define XM_STATCMD_CLR_RX	0x0002
136 #define XM_STATCMD_COPY_TX	0x0004
137 #define XM_STATCMD_COPY_RX	0x0008
138 #define XM_STATCMD_SNAP_TX	0x0010
139 #define XM_STATCMD_SNAP_RX	0x0020
140 
141 /* TX statistics registers */
142 #define XM_TXSTATS_PKTSOK	0x280
143 #define XM_TXSTATS_BYTESOK_HI	0x284
144 #define XM_TXSTATS_BYTESOK_LO	0x288
145 #define XM_TXSTATS_BCASTSOK	0x28C
146 #define XM_TXSTATS_MCASTSOK	0x290
147 #define XM_TXSTATS_UCASTSOK	0x294
148 #define XM_TXSTATS_GIANTS	0x298
149 #define XM_TXSTATS_BURSTCNT	0x29C
150 #define XM_TXSTATS_PAUSEPKTS	0x2A0
151 #define XM_TXSTATS_MACCTLPKTS	0x2A4
152 #define XM_TXSTATS_SINGLECOLS	0x2A8
153 #define XM_TXSTATS_MULTICOLS	0x2AC
154 #define XM_TXSTATS_EXCESSCOLS	0x2B0
155 #define XM_TXSTATS_LATECOLS	0x2B4
156 #define XM_TXSTATS_DEFER	0x2B8
157 #define XM_TXSTATS_EXCESSDEFER	0x2BC
158 #define XM_TXSTATS_UNDERRUN	0x2C0
159 #define XM_TXSTATS_CARRIERSENSE	0x2C4
160 #define XM_TXSTATS_UTILIZATION	0x2C8
161 #define XM_TXSTATS_64		0x2D0
162 #define XM_TXSTATS_65_127	0x2D4
163 #define XM_TXSTATS_128_255	0x2D8
164 #define XM_TXSTATS_256_511	0x2DC
165 #define XM_TXSTATS_512_1023	0x2E0
166 #define XM_TXSTATS_1024_MAX	0x2E4
167 
168 /* RX statistics registers */
169 #define XM_RXSTATS_PKTSOK	0x300
170 #define XM_RXSTATS_BYTESOK_HI	0x304
171 #define XM_RXSTATS_BYTESOK_LO	0x308
172 #define XM_RXSTATS_BCASTSOK	0x30C
173 #define XM_RXSTATS_MCASTSOK	0x310
174 #define XM_RXSTATS_UCASTSOK	0x314
175 #define XM_RXSTATS_PAUSEPKTS	0x318
176 #define XM_RXSTATS_MACCTLPKTS	0x31C
177 #define XM_RXSTATS_BADPAUSEPKTS	0x320
178 #define XM_RXSTATS_BADMACCTLPKTS	0x324
179 #define XM_RXSTATS_BURSTCNT	0x328
180 #define XM_RXSTATS_MISSEDPKTS	0x32C
181 #define XM_RXSTATS_FRAMEERRS	0x330
182 #define XM_RXSTATS_OVERRUN	0x334
183 #define XM_RXSTATS_JABBER	0x338
184 #define XM_RXSTATS_CARRLOSS	0x33C
185 #define XM_RXSTATS_INRNGLENERR	0x340
186 #define XM_RXSTATS_SYMERR	0x344
187 #define XM_RXSTATS_SHORTEVENT	0x348
188 #define XM_RXSTATS_RUNTS	0x34C
189 #define XM_RXSTATS_GIANTS	0x350
190 #define XM_RXSTATS_CRCERRS	0x354
191 #define XM_RXSTATS_CEXTERRS	0x35C
192 #define XM_RXSTATS_UTILIZATION	0x360
193 #define XM_RXSTATS_64		0x368
194 #define XM_RXSTATS_65_127	0x36C
195 #define XM_RXSTATS_128_255	0x370
196 #define XM_RXSTATS_256_511	0x374
197 #define XM_RXSTATS_512_1023	0x378
198 #define XM_RXSTATS_1024_MAX	0x37C
199 
200 #define XM_MMUCMD_TX_ENB	0x0001
201 #define XM_MMUCMD_RX_ENB	0x0002
202 #define XM_MMUCMD_GMIILOOP	0x0004
203 #define XM_MMUCMD_RATECTL	0x0008
204 #define XM_MMUCMD_GMIIFDX	0x0010
205 #define XM_MMUCMD_NO_MGMT_PRMB	0x0020
206 #define XM_MMUCMD_SIMCOL	0x0040
207 #define XM_MMUCMD_FORCETX	0x0080
208 #define XM_MMUCMD_LOOPENB	0x0200
209 #define XM_MMUCMD_IGNPAUSE	0x0400
210 #define XM_MMUCMD_PHYBUSY	0x0800
211 #define XM_MMUCMD_PHYDATARDY	0x1000
212 
213 #define XM_TXCMD_AUTOPAD	0x0001
214 #define XM_TXCMD_NOCRC		0x0002
215 #define XM_TXCMD_NOPREAMBLE	0x0004
216 #define XM_TXCMD_NOGIGAMODE	0x0008
217 #define XM_TXCMD_SAMPLELINE	0x0010
218 #define XM_TXCMD_ENCBYPASS	0x0020
219 #define XM_TXCMD_XMITBK2BK	0x0040
220 #define XM_TXCMD_FAIRSHARE	0x0080
221 
222 #define XM_RXCMD_DISABLE_CEXT	0x0001
223 #define XM_RXCMD_STRIPPAD	0x0002
224 #define XM_RXCMD_SAMPLELINE	0x0004
225 #define XM_RXCMD_SELFRX		0x0008
226 #define XM_RXCMD_STRIPFCS	0x0010
227 #define XM_RXCMD_TRANSPARENT	0x0020
228 #define XM_RXCMD_IPGCAPTURE	0x0040
229 #define XM_RXCMD_BIGPKTOK	0x0080
230 #define XM_RXCMD_LENERROK	0x0100
231 
232 #define XM_GPIO_GP0_SET		0x0001
233 #define XM_GPIO_RESETSTATS	0x0004
234 #define XM_GPIO_RESETMAC	0x0008
235 #define XM_GPIO_FORCEINT	0x0020
236 #define XM_GPIO_ANEGINPROG	0x0040
237 
238 #define XM_IMR_RX_EOF		0x0001
239 #define XM_IMR_TX_EOF		0x0002
240 #define XM_IMR_TX_UNDERRUN	0x0004
241 #define XM_IMR_RX_OVERRUN	0x0008
242 #define XM_IMR_TX_STATS_OFLOW	0x0010
243 #define XM_IMR_RX_STATS_OFLOW	0x0020
244 #define XM_IMR_TSTAMP_OFLOW	0x0040
245 #define XM_IMR_AUTONEG_DONE	0x0080
246 #define XM_IMR_NEXTPAGE_RDY	0x0100
247 #define XM_IMR_PAGE_RECEIVED	0x0200
248 #define XM_IMR_LP_REQCFG	0x0400
249 #define XM_IMR_GP0_SET		0x0800
250 #define XM_IMR_FORCEINTR	0x1000
251 #define XM_IMR_TX_ABORT		0x2000
252 #define XM_IMR_LINKEVENT	0x4000
253 
254 #define XM_INTRS	\
255 	(~(XM_IMR_GP0_SET|XM_IMR_AUTONEG_DONE|XM_IMR_TX_UNDERRUN))
256 
257 #define XM_ISR_RX_EOF		0x0001
258 #define XM_ISR_TX_EOF		0x0002
259 #define XM_ISR_TX_UNDERRUN	0x0004
260 #define XM_ISR_RX_OVERRUN	0x0008
261 #define XM_ISR_TX_STATS_OFLOW	0x0010
262 #define XM_ISR_RX_STATS_OFLOW	0x0020
263 #define XM_ISR_TSTAMP_OFLOW	0x0040
264 #define XM_ISR_AUTONEG_DONE	0x0080
265 #define XM_ISR_NEXTPAGE_RDY	0x0100
266 #define XM_ISR_PAGE_RECEIVED	0x0200
267 #define XM_ISR_LP_REQCFG	0x0400
268 #define XM_ISR_GP0_SET		0x0800
269 #define XM_ISR_FORCEINTR	0x1000
270 #define XM_ISR_TX_ABORT		0x2000
271 #define XM_ISR_LINKEVENT	0x4000
272 
273 #define XM_HWCFG_GENEOP		0x0008
274 #define XM_HWCFG_SIGSTATCKH	0x0004
275 #define XM_HWCFG_GMIIMODE	0x0001
276 
277 #define XM_MODE_FLUSH_RXFIFO	0x00000001
278 #define XM_MODE_FLUSH_TXFIFO	0x00000002
279 #define XM_MODE_BIGENDIAN	0x00000004
280 #define XM_MODE_RX_PROMISC	0x00000008
281 #define XM_MODE_RX_NOBROAD	0x00000010
282 #define XM_MODE_RX_NOMULTI	0x00000020
283 #define XM_MODE_RX_NOUNI	0x00000040
284 #define XM_MODE_RX_BADFRAMES	0x00000080
285 #define XM_MODE_RX_CRCERRS	0x00000100
286 #define XM_MODE_RX_GIANTS	0x00000200
287 #define XM_MODE_RX_INRANGELEN	0x00000400
288 #define XM_MODE_RX_RUNTS	0x00000800
289 #define XM_MODE_RX_MACCTL	0x00001000
290 #define XM_MODE_RX_USE_PERFECT	0x00002000
291 #define XM_MODE_RX_USE_STATION	0x00004000
292 #define XM_MODE_RX_USE_HASH	0x00008000
293 #define XM_MODE_RX_ADDRPAIR	0x00010000
294 #define XM_MODE_PAUSEONHI	0x00020000
295 #define XM_MODE_PAUSEONLO	0x00040000
296 #define XM_MODE_TIMESTAMP	0x00080000
297 #define XM_MODE_SENDPAUSE	0x00100000
298 #define XM_MODE_SENDCONTINUOUS	0x00200000
299 #define XM_MODE_LE_STATUSWORD	0x00400000
300 #define XM_MODE_AUTOFIFOPAUSE	0x00800000
301 #define XM_MODE_EXPAUSEGEN	0x02000000
302 #define XM_MODE_RX_INVERSE	0x04000000
303 
304 #define XM_RXSTAT_MACCTL	0x00000001
305 #define XM_RXSTAT_ERRFRAME	0x00000002
306 #define XM_RXSTAT_CRCERR	0x00000004
307 #define XM_RXSTAT_GIANT		0x00000008
308 #define XM_RXSTAT_RUNT		0x00000010
309 #define XM_RXSTAT_FRAMEERR	0x00000020
310 #define XM_RXSTAT_INRANGEERR	0x00000040
311 #define XM_RXSTAT_CARRIERERR	0x00000080
312 #define XM_RXSTAT_COLLERR	0x00000100
313 #define XM_RXSTAT_802_3		0x00000200
314 #define XM_RXSTAT_CARREXTERR	0x00000400
315 #define XM_RXSTAT_BURSTMODE	0x00000800
316 #define XM_RXSTAT_UNICAST	0x00002000
317 #define XM_RXSTAT_MULTICAST	0x00004000
318 #define XM_RXSTAT_BROADCAST	0x00008000
319 #define XM_RXSTAT_VLAN_LEV1	0x00010000
320 #define XM_RXSTAT_VLAN_LEV2	0x00020000
321 #define XM_RXSTAT_LEN		0xFFFC0000
322 #define	XM_RXSTAT_LENSHIFT	18
323 
324 #define	XM_RXSTAT_BYTES(x)	((x) >> XM_RXSTAT_LENSHIFT)
325 
326 /*
327  * XMAC PHY registers, indirectly accessed through
328  * XM_PHY_ADDR and XM_PHY_REG.
329  */
330 
331 #define XM_PHY_BMCR		0x0000	/* control */
332 #define XM_PHY_BMSR		0x0001	/* status */
333 #define XM_PHY_VENID		0x0002	/* vendor id */
334 #define XM_PHY_DEVID		0x0003	/* device id */
335 #define XM_PHY_ANAR		0x0004	/* autoneg advertisenemt */
336 #define XM_PHY_LPAR		0x0005	/* link partner ability */
337 #define XM_PHY_ANEXP		0x0006	/* autoneg expansion */
338 #define XM_PHY_NEXTP		0x0007	/* nextpage */
339 #define XM_PHY_LPNEXTP		0x0008	/* link partner's nextpage */
340 #define XM_PHY_EXTSTS		0x000F	/* extented status */
341 #define XM_PHY_RESAB		0x0010	/* resolved ability */
342 
343 #define XM_BMCR_DUPLEX		0x0100
344 #define XM_BMCR_RENEGOTIATE	0x0200
345 #define XM_BMCR_AUTONEGENBL	0x1000
346 #define XM_BMCR_LOOPBACK	0x4000
347 #define XM_BMCR_RESET		0x8000
348 
349 #define XM_BMSR_EXTCAP		0x0001
350 #define XM_BMSR_LINKSTAT	0x0004
351 #define XM_BMSR_AUTONEGABLE	0x0008
352 #define XM_BMSR_REMFAULT	0x0010
353 #define XM_BMSR_AUTONEGDONE	0x0020
354 #define XM_BMSR_EXTSTAT		0x0100
355 
356 #define XM_VENID_XAQTI		0xD14C
357 #define XM_DEVID_XMAC		0x0002
358 
359 #define XM_ANAR_FULLDUPLEX	0x0020
360 #define XM_ANAR_HALFDUPLEX	0x0040
361 #define XM_ANAR_PAUSEBITS	0x0180
362 #define XM_ANAR_REMFAULTBITS	0x1800
363 #define XM_ANAR_ACK		0x4000
364 #define XM_ANAR_NEXTPAGE	0x8000
365 
366 #define XM_LPAR_FULLDUPLEX	0x0020
367 #define XM_LPAR_HALFDUPLEX	0x0040
368 #define XM_LPAR_PAUSEBITS	0x0180
369 #define XM_LPAR_REMFAULTBITS	0x1800
370 #define XM_LPAR_ACK		0x4000
371 #define XM_LPAR_NEXTPAGE	0x8000
372 
373 #define XM_PAUSE_NOPAUSE	0x0000
374 #define XM_PAUSE_SYMPAUSE	0x0080
375 #define XM_PAUSE_ASYMPAUSE	0x0100
376 #define XM_PAUSE_BOTH		0x0180
377 
378 #define XM_REMFAULT_LINKOK	0x0000
379 #define XM_REMFAULT_LINKFAIL	0x0800
380 #define XM_REMFAULT_OFFLINE	0x1000
381 #define XM_REMFAULT_ANEGERR	0x1800
382 
383 #define XM_ANEXP_GOTPAGE	0x0002
384 #define XM_ANEXP_NEXTPAGE_SELF	0x0004
385 #define XM_ANEXP_NEXTPAGE_LP	0x0008
386 
387 #define XM_NEXTP_MESSAGE	0x07FF
388 #define XM_NEXTP_TOGGLE		0x0800
389 #define XM_NEXTP_ACK2		0x1000
390 #define XM_NEXTP_MPAGE		0x2000
391 #define XM_NEXTP_ACK1		0x4000
392 #define XM_NEXTP_NPAGE		0x8000
393 
394 #define XM_LPNEXTP_MESSAGE	0x07FF
395 #define XM_LPNEXTP_TOGGLE	0x0800
396 #define XM_LPNEXTP_ACK2		0x1000
397 #define XM_LPNEXTP_MPAGE	0x2000
398 #define XM_LPNEXTP_ACK1		0x4000
399 #define XM_LPNEXTP_NPAGE	0x8000
400 
401 #define XM_EXTSTS_HALFDUPLEX	0x4000
402 #define XM_EXTSTS_FULLDUPLEX	0x8000
403 
404 #define XM_RESAB_PAUSEMISMATCH	0x0008
405 #define XM_RESAB_ABLMISMATCH	0x0010
406 #define XM_RESAB_FDMODESEL	0x0020
407 #define XM_RESAB_HDMODESEL	0x0040
408 #define XM_RESAB_PAUSEBITS	0x0180
409