xref: /freebsd/sys/dev/gem/if_gemreg.h (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (C) 2001 Eduardo Horvath.
5  * All rights reserved.
6  *
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR  ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR  BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	from: NetBSD: gemreg.h,v 1.9 2006/11/24 13:01:07 martin Exp
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef	_IF_GEMREG_H
35 #define	_IF_GEMREG_H
36 
37 /* register definitions for Apple GMAC and Sun GEM */
38 
39 #define	GEM_SEB_STATE		0x0000	/* SEB state reg, R/O */
40 #define	GEM_CONFIG		0x0004	/* config reg */
41 #define	GEM_STATUS		0x000c	/* status reg */
42 /* Note: Reading the status reg clears bits 0-6. */
43 #define	GEM_INTMASK		0x0010
44 #define	GEM_INTACK		0x0014	/* Interrupt acknowledge, W/O */
45 #define	GEM_STATUS_ALIAS	0x001c
46 
47 /* Bits in GEM_SEB register */
48 #define	GEM_SEB_ARB		0x00000002	/* Arbitration status */
49 #define	GEM_SEB_RXWON		0x00000004
50 
51 /* Bits in GEM_CONFIG register */
52 #define	GEM_CONFIG_BURST_64	0x00000000	/* maximum burst size 64KB */
53 #define	GEM_CONFIG_BURST_INF	0x00000001	/* infinite for entire packet */
54 #define	GEM_CONFIG_TXDMA_LIMIT	0x0000003e
55 #define	GEM_CONFIG_RXDMA_LIMIT	0x000007c0
56 /* GEM_CONFIG_RONPAULBIT and GEM_CONFIG_BUG2FIX are Apple only. */
57 #define	GEM_CONFIG_RONPAULBIT	0x00000800	/* after infinite burst use */
58 						/* memory read multiple for */
59 						/* PCI commands */
60 #define	GEM_CONFIG_BUG2FIX	0x00001000	/* fix RX hang after overflow */
61 
62 #define	GEM_CONFIG_TXDMA_LIMIT_SHIFT	1
63 #define	GEM_CONFIG_RXDMA_LIMIT_SHIFT	6
64 
65 /* Top part of GEM_STATUS has TX completion information */
66 #define	GEM_STATUS_TX_COMPLETION_MASK	0xfff80000	/* TX completion reg. */
67 #define	GEM_STATUS_TX_COMPLETION_SHFT	19
68 
69 /*
70  * Interrupt bits, for both the GEM_STATUS and GEM_INTMASK regs
71  * Bits 0-6 auto-clear when read.
72  */
73 #define	GEM_INTR_TX_INTME	0x00000001	/* Frame w/INTME bit set sent */
74 #define	GEM_INTR_TX_EMPTY	0x00000002	/* TX ring empty */
75 #define	GEM_INTR_TX_DONE	0x00000004	/* TX complete */
76 #define	GEM_INTR_RX_DONE	0x00000010	/* Got a packet */
77 #define	GEM_INTR_RX_NOBUF	0x00000020
78 #define	GEM_INTR_RX_TAG_ERR	0x00000040
79 #define	GEM_INTR_PERR		0x00000080	/* Parity error */
80 #define	GEM_INTR_PCS		0x00002000	/* Physical Code Sub-layer */
81 #define	GEM_INTR_TX_MAC		0x00004000
82 #define	GEM_INTR_RX_MAC		0x00008000
83 #define	GEM_INTR_MAC_CONTROL	0x00010000	/* MAC control interrupt */
84 #define	GEM_INTR_MIF		0x00020000
85 #define	GEM_INTR_BERR		0x00040000	/* Bus error interrupt */
86 #define	GEM_INTR_BITS	"\177\020"					\
87 			"b\0INTME\0b\1TXEMPTY\0b\2TXDONE\0"		\
88 			"b\4RXDONE\0b\5RXNOBUF\0b\6RX_TAG_ERR\0"	\
89 			"b\xdPCS\0b\xeTXMAC\0b\xfRXMAC\0"		\
90 			"b\x10MAC_CONTROL\0b\x11MIF\0b\x12IBERR\0\0"
91 
92 /* This is the same as the GEM_STATUS reg but reading it does not clear bits. */
93 #define	GEM_PCI_ERROR_STATUS	0x1000	/* PCI error status */
94 #define	GEM_PCI_ERROR_MASK	0x1004	/* PCI error mask */
95 #define	GEM_PCI_BIF_CONFIG	0x1008	/* PCI BIF configuration */
96 #define	GEM_PCI_BIF_DIAG	0x100c	/* PCI BIF diagnostic */
97 
98 #define	GEM_RESET		0x0010	/* software reset */
99 
100 /* GEM_PCI_ERROR_STATUS and GEM_PCI_ERROR_MASK error bits */
101 #define	GEM_PCI_ERR_STAT_BADACK	0x00000001	/* No ACK64# */
102 #define	GEM_PCI_ERR_STAT_DTRTO	0x00000002	/* Delayed xaction timeout */
103 #define	GEM_PCI_ERR_STAT_OTHERS	0x00000004
104 #define	GEM_PCI_ERR_BITS	"\177\020b\0ACKBAD\0b\1DTRTO\0b\2OTHER\0\0"
105 
106 /* GEM_PCI_BIF_CONFIG register bits */
107 #define	GEM_PCI_BIF_CNF_SLOWCLK	0x00000001	/* Parity error timing */
108 #define	GEM_PCI_BIF_CNF_HOST_64	0x00000002	/* 64-bit host */
109 #define	GEM_PCI_BIF_CNF_B64D_DS	0x00000004	/* no 64-bit data cycle */
110 #define	GEM_PCI_BIF_CNF_M66EN	0x00000008
111 #define	GEM_PCI_BIF_CNF_BITS	"\177\020b\0SLOWCLK\0b\1HOST64\0"	\
112 				"b\2B64DIS\0b\3M66EN\0\0"
113 
114 /* GEM_PCI_BIF_DIAG register bits */
115 #define	GEN_PCI_BIF_DIAG_BC_SM	0x007f0000	/* burst ctrl. state machine */
116 #define	GEN_PCI_BIF_DIAG_SM	0xff000000	/* BIF state machine */
117 
118 /* GEM_RESET register bits -- TX and RX self clear when complete. */
119 #define	GEM_RESET_TX		0x00000001	/* Reset TX half. */
120 #define	GEM_RESET_RX		0x00000002	/* Reset RX half. */
121 #define	GEM_RESET_PCI_RSTOUT	0x00000004	/* Force PCI RSTOUT#. */
122 
123 /* TX DMA registers */
124 #define	GEM_TX_KICK		0x2000		/* Write last valid desc + 1 */
125 #define	GEM_TX_CONFIG		0x2004
126 #define	GEM_TX_RING_PTR_LO	0x2008
127 #define	GEM_TX_RING_PTR_HI	0x200c
128 
129 #define	GEM_TX_FIFO_WR_PTR	0x2014		/* FIFO write pointer */
130 #define	GEM_TX_FIFO_SDWR_PTR	0x2018		/* FIFO shadow write pointer */
131 #define	GEM_TX_FIFO_RD_PTR	0x201c		/* FIFO read pointer */
132 #define	GEM_TX_FIFO_SDRD_PTR	0x2020		/* FIFO shadow read pointer */
133 #define	GEM_TX_FIFO_PKT_CNT	0x2024		/* FIFO packet counter */
134 
135 #define	GEM_TX_STATE_MACHINE	0x2028		/* ETX state machine reg */
136 #define	GEM_TX_DATA_PTR_LO	0x2030
137 #define	GEM_TX_DATA_PTR_HI	0x2034
138 
139 #define	GEM_TX_COMPLETION	0x2100
140 #define	GEM_TX_FIFO_ADDRESS	0x2104
141 #define	GEM_TX_FIFO_TAG		0x2108
142 #define	GEM_TX_FIFO_DATA_LO	0x210c
143 #define	GEM_TX_FIFO_DATA_HI_T1	0x2110
144 #define	GEM_TX_FIFO_DATA_HI_T0	0x2114
145 #define	GEM_TX_FIFO_SIZE	0x2118
146 #define	GEM_TX_DEBUG		0x3028
147 
148 /* GEM_TX_CONFIG register bits */
149 #define	GEM_TX_CONFIG_TXDMA_EN	0x00000001	/* TX DMA enable */
150 #define	GEM_TX_CONFIG_TXRING_SZ	0x0000001e	/* TX ring size */
151 #define	GEM_TX_CONFIG_TXFIFO_TH	0x001ffc00	/* TX fifo threshold */
152 #define	GEM_TX_CONFIG_PACED	0x00200000	/* TX_all_int modifier */
153 
154 #define	GEM_RING_SZ_32		(0<<1)	/* 32 descriptors */
155 #define	GEM_RING_SZ_64		(1<<1)
156 #define	GEM_RING_SZ_128		(2<<1)
157 #define	GEM_RING_SZ_256		(3<<1)
158 #define	GEM_RING_SZ_512		(4<<1)
159 #define	GEM_RING_SZ_1024	(5<<1)
160 #define	GEM_RING_SZ_2048	(6<<1)
161 #define	GEM_RING_SZ_4096	(7<<1)
162 #define	GEM_RING_SZ_8192	(8<<1)
163 
164 /* GEM_TX_COMPLETION register bits */
165 #define	GEM_TX_COMPLETION_MASK	0x00001fff	/* # of last descriptor */
166 
167 /* RX DMA registers */
168 #define	GEM_RX_CONFIG		0x4000
169 #define	GEM_RX_RING_PTR_LO	0x4004		/* 64-bits unaligned GAK! */
170 #define	GEM_RX_RING_PTR_HI	0x4008		/* 64-bits unaligned GAK! */
171 
172 #define	GEM_RX_FIFO_WR_PTR	0x400c		/* FIFO write pointer */
173 #define	GEM_RX_FIFO_SDWR_PTR	0x4010		/* FIFO shadow write pointer */
174 #define	GEM_RX_FIFO_RD_PTR	0x4014		/* FIFO read pointer */
175 #define	GEM_RX_FIFO_PKT_CNT	0x4018		/* FIFO packet counter */
176 
177 #define	GEM_RX_STATE_MACHINE	0x401c		/* ERX state machine reg */
178 #define	GEM_RX_PAUSE_THRESH	0x4020
179 
180 #define	GEM_RX_DATA_PTR_LO	0x4024		/* ERX state machine reg */
181 #define	GEM_RX_DATA_PTR_HI	0x4028		/* Damn thing is unaligned */
182 
183 #define	GEM_RX_KICK		0x4100		/* Write last valid desc + 1 */
184 #define	GEM_RX_COMPLETION	0x4104		/* First pending desc */
185 #define	GEM_RX_BLANKING		0x4108		/* Interrupt blanking reg */
186 
187 #define	GEM_RX_FIFO_ADDRESS	0x410c
188 #define	GEM_RX_FIFO_TAG		0x4110
189 #define	GEM_RX_FIFO_DATA_LO	0x4114
190 #define	GEM_RX_FIFO_DATA_HI_T1	0x4118
191 #define	GEM_RX_FIFO_DATA_HI_T0	0x411c
192 #define	GEM_RX_FIFO_SIZE	0x4120
193 
194 /* GEM_RX_CONFIG register bits */
195 #define	GEM_RX_CONFIG_RXDMA_EN	0x00000001	/* RX DMA enable */
196 #define	GEM_RX_CONFIG_RXRING_SZ	0x0000001e	/* RX ring size */
197 #define	GEM_RX_CONFIG_BATCH_DIS	0x00000020	/* desc batching disable */
198 #define	GEM_RX_CONFIG_FBOFF	0x00001c00	/* first byte offset */
199 #define	GEM_RX_CONFIG_CXM_START	0x000fe000	/* cksum start offset bytes */
200 #define	GEM_RX_CONFIG_FIFO_THRS	0x07000000	/* fifo threshold size */
201 
202 #define	GEM_THRSH_64	0
203 #define	GEM_THRSH_128	1
204 #define	GEM_THRSH_256	2
205 #define	GEM_THRSH_512	3
206 #define	GEM_THRSH_1024	4
207 #define	GEM_THRSH_2048	5
208 
209 #define	GEM_RX_CONFIG_FIFO_THRS_SHIFT	24
210 #define	GEM_RX_CONFIG_FBOFF_SHFT	10
211 #define	GEM_RX_CONFIG_CXM_START_SHFT	13
212 
213 /* GEM_RX_PAUSE_THRESH register bits -- sizes in multiples of 64 bytes */
214 #define	GEM_RX_PTH_XOFF_THRESH	0x000001ff
215 #define	GEM_RX_PTH_XON_THRESH	0x001ff000
216 
217 /* GEM_RX_BLANKING register bits */
218 #define	GEM_RX_BLANKING_PACKETS	0x000001ff	/* Delay intr for x packets */
219 #define	GEM_RX_BLANKING_TIME	0x000ff000	/* Delay intr for x ticks */
220 #define	GEM_RX_BLANKING_TIME_SHIFT 12
221 /* One tick is 2048 PCI clocks, or 16us at 66MHz */
222 
223 /* GEM_MAC registers */
224 #define	GEM_MAC_TXRESET		0x6000		/* Store 1, cleared when done */
225 #define	GEM_MAC_RXRESET		0x6004		/* ditto */
226 #define	GEM_MAC_SEND_PAUSE_CMD	0x6008
227 #define	GEM_MAC_TX_STATUS	0x6010
228 #define	GEM_MAC_RX_STATUS	0x6014
229 #define	GEM_MAC_CONTROL_STATUS	0x6018		/* MAC control status reg */
230 #define	GEM_MAC_TX_MASK		0x6020		/* TX MAC mask register */
231 #define	GEM_MAC_RX_MASK		0x6024
232 #define	GEM_MAC_CONTROL_MASK	0x6028
233 #define	GEM_MAC_TX_CONFIG	0x6030
234 #define	GEM_MAC_RX_CONFIG	0x6034
235 #define	GEM_MAC_CONTROL_CONFIG	0x6038
236 #define	GEM_MAC_XIF_CONFIG	0x603c
237 #define	GEM_MAC_IPG0		0x6040		/* inter packet gap 0 */
238 #define	GEM_MAC_IPG1		0x6044		/* inter packet gap 1 */
239 #define	GEM_MAC_IPG2		0x6048		/* inter packet gap 2 */
240 #define	GEM_MAC_SLOT_TIME	0x604c		/* slot time, bits 0-7 */
241 #define	GEM_MAC_MAC_MIN_FRAME	0x6050
242 #define	GEM_MAC_MAC_MAX_FRAME	0x6054
243 #define	GEM_MAC_PREAMBLE_LEN	0x6058
244 #define	GEM_MAC_JAM_SIZE	0x605c
245 #define	GEM_MAC_ATTEMPT_LIMIT	0x6060
246 #define	GEM_MAC_CONTROL_TYPE	0x6064
247 
248 #define	GEM_MAC_ADDR0		0x6080		/* Normal MAC address 0 */
249 #define	GEM_MAC_ADDR1		0x6084
250 #define	GEM_MAC_ADDR2		0x6088
251 #define	GEM_MAC_ADDR3		0x608c		/* Alternate MAC address 0 */
252 #define	GEM_MAC_ADDR4		0x6090
253 #define	GEM_MAC_ADDR5		0x6094
254 #define	GEM_MAC_ADDR6		0x6098		/* Control MAC address 0 */
255 #define	GEM_MAC_ADDR7		0x609c
256 #define	GEM_MAC_ADDR8		0x60a0
257 
258 #define	GEM_MAC_ADDR_FILTER0	0x60a4
259 #define	GEM_MAC_ADDR_FILTER1	0x60a8
260 #define	GEM_MAC_ADDR_FILTER2	0x60ac
261 #define	GEM_MAC_ADR_FLT_MASK1_2	0x60b0		/* Address filter mask 1,2 */
262 #define	GEM_MAC_ADR_FLT_MASK0	0x60b4		/* Address filter mask 0 reg */
263 
264 #define	GEM_MAC_HASH0		0x60c0		/* Hash table 0 */
265 #define	GEM_MAC_HASH1		0x60c4
266 #define	GEM_MAC_HASH2		0x60c8
267 #define	GEM_MAC_HASH3		0x60cc
268 #define	GEM_MAC_HASH4		0x60d0
269 #define	GEM_MAC_HASH5		0x60d4
270 #define	GEM_MAC_HASH6		0x60d8
271 #define	GEM_MAC_HASH7		0x60dc
272 #define	GEM_MAC_HASH8		0x60e0
273 #define	GEM_MAC_HASH9		0x60e4
274 #define	GEM_MAC_HASH10		0x60e8
275 #define	GEM_MAC_HASH11		0x60ec
276 #define	GEM_MAC_HASH12		0x60f0
277 #define	GEM_MAC_HASH13		0x60f4
278 #define	GEM_MAC_HASH14		0x60f8
279 #define	GEM_MAC_HASH15		0x60fc
280 
281 #define	GEM_MAC_NORM_COLL_CNT	0x6100		/* Normal collision counter */
282 #define	GEM_MAC_FIRST_COLL_CNT	0x6104		/* 1st successful collision cntr */
283 #define	GEM_MAC_EXCESS_COLL_CNT	0x6108		/* Excess collision counter */
284 #define	GEM_MAC_LATE_COLL_CNT	0x610c		/* Late collision counter */
285 #define	GEM_MAC_DEFER_TMR_CNT	0x6110		/* defer timer counter */
286 #define	GEM_MAC_PEAK_ATTEMPTS	0x6114
287 #define	GEM_MAC_RX_FRAME_COUNT	0x6118
288 #define	GEM_MAC_RX_LEN_ERR_CNT	0x611c
289 #define	GEM_MAC_RX_ALIGN_ERR	0x6120
290 #define	GEM_MAC_RX_CRC_ERR_CNT	0x6124
291 #define	GEM_MAC_RX_CODE_VIOL	0x6128
292 #define	GEM_MAC_RANDOM_SEED	0x6130
293 #define	GEM_MAC_MAC_STATE	0x6134		/* MAC state machine reg */
294 
295 /* GEM_MAC_SEND_PAUSE_CMD register bits */
296 #define	GEM_MAC_PAUSE_CMD_TIME	0x0000ffff
297 #define	GEM_MAC_PAUSE_CMD_SEND	0x00010000
298 
299 /* GEM_MAC_TX_STATUS and _MASK register bits */
300 #define	GEM_MAC_TX_XMIT_DONE	0x00000001
301 #define	GEM_MAC_TX_UNDERRUN	0x00000002
302 #define	GEM_MAC_TX_PKT_TOO_LONG	0x00000004
303 #define	GEM_MAC_TX_NCC_EXP	0x00000008	/* Normal collision cnt exp */
304 #define	GEM_MAC_TX_ECC_EXP	0x00000010
305 #define	GEM_MAC_TX_LCC_EXP	0x00000020
306 #define	GEM_MAC_TX_FCC_EXP	0x00000040
307 #define	GEM_MAC_TX_DEFER_EXP	0x00000080
308 #define	GEM_MAC_TX_PEAK_EXP	0x00000100
309 
310 /* GEM_MAC_RX_STATUS and _MASK register bits */
311 #define	GEM_MAC_RX_DONE		0x00000001
312 #define	GEM_MAC_RX_OVERFLOW	0x00000002
313 #define	GEM_MAC_RX_FRAME_CNT	0x00000004
314 #define	GEM_MAC_RX_ALIGN_EXP	0x00000008
315 #define	GEM_MAC_RX_CRC_EXP	0x00000010
316 #define	GEM_MAC_RX_LEN_EXP	0x00000020
317 #define	GEM_MAC_RX_CVI_EXP	0x00000040	/* Code violation */
318 
319 /* GEM_MAC_CONTROL_STATUS and GEM_MAC_CONTROL_MASK register bits */
320 #define	GEM_MAC_PAUSED		0x00000001	/* Pause received */
321 #define	GEM_MAC_PAUSE		0x00000002	/* enter pause state */
322 #define	GEM_MAC_RESUME		0x00000004	/* exit pause state */
323 #define	GEM_MAC_PAUSE_TIME_SLTS	0xffff0000	/* pause time in slots */
324 #define	GEM_MAC_STATUS_BITS	"\177\020b\0PAUSED\0b\1PAUSE\0b\2RESUME\0\0"
325 
326 #define	GEM_MAC_PAUSE_TIME_SHFT	16
327 #define	GEM_MAC_PAUSE_TIME(x)						\
328 	(((x) & GEM_MAC_PAUSE_TIME_SLTS) >> GEM_MAC_PAUSE_TIME_SHFT)
329 
330 /* GEM_MAC_XIF_CONFIG register bits */
331 #define	GEM_MAC_XIF_TX_MII_ENA	0x00000001	/* Enable XIF output drivers */
332 #define	GEM_MAC_XIF_MII_LOOPBK	0x00000002	/* Enable MII loopback mode */
333 #define	GEM_MAC_XIF_ECHO_DISABL	0x00000004	/* Disable echo */
334 #define	GEM_MAC_XIF_GMII_MODE	0x00000008	/* Select GMII/MII mode */
335 #define	GEM_MAC_XIF_MII_BUF_ENA	0x00000010	/* Enable MII recv buffers */
336 #define	GEM_MAC_XIF_LINK_LED	0x00000020	/* force link LED active */
337 #define	GEM_MAC_XIF_FDPLX_LED	0x00000040	/* force FDPLX LED active */
338 #define	GEM_MAC_XIF_BITS	"\177\020b\0TXMIIENA\0b\1MIILOOP\0b\2NOECHO" \
339 				"\0b\3GMII\0b\4MIIBUFENA\0b\5LINKLED\0" \
340 				"b\6FDLED\0\0"
341 
342 /*
343  * GEM_MAC_SLOT_TIME register
344  * The slot time is used as PAUSE time unit, value depends on whether carrier
345  * extension is enabled.
346  */
347 #define	GEM_MAC_SLOT_TIME_CARR_EXTEND	0x200
348 #define	GEM_MAC_SLOT_TIME_NORMAL	0x40
349 
350 /* GEM_MAC_TX_CONFIG register bits */
351 #define	GEM_MAC_TX_ENABLE	0x00000001	/* TX enable */
352 #define	GEM_MAC_TX_IGN_CARRIER	0x00000002	/* Ignore carrier sense */
353 #define	GEM_MAC_TX_IGN_COLLIS	0x00000004	/* ignore collisions */
354 #define	GEM_MAC_TX_ENA_IPG0	0x00000008	/* extend RX-to-TX IPG */
355 #define	GEM_MAC_TX_NGU		0x00000010	/* Never give up */
356 #define	GEM_MAC_TX_NGU_LIMIT	0x00000020	/* Never give up limit */
357 #define	GEM_MAC_TX_NO_BACKOFF	0x00000040
358 #define	GEM_MAC_TX_SLOWDOWN	0x00000080
359 #define	GEM_MAC_TX_NO_FCS	0x00000100	/* no FCS will be generated */
360 #define	GEM_MAC_TX_CARR_EXTEND	0x00000200	/* Ena TX Carrier Extension */
361 /* Carrier Extension is required for half duplex Gbps operation. */
362 #define	GEM_MAC_TX_CONFIG_BITS	"\177\020" \
363 				"b\0TXENA\0b\1IGNCAR\0b\2IGNCOLLIS\0" \
364 				"b\3IPG0ENA\0b\4TXNGU\0b\5TXNGULIM\0" \
365 				"b\6NOBKOFF\0b\7SLOWDN\0b\x8NOFCS\0" \
366 				"b\x9TXCARREXT\0\0"
367 
368 /* GEM_MAC_RX_CONFIG register bits */
369 #define	GEM_MAC_RX_ENABLE	0x00000001	/* RX enable */
370 #define	GEM_MAC_RX_STRIP_PAD	0x00000002	/* strip pad bytes */
371 #define	GEM_MAC_RX_STRIP_CRC	0x00000004
372 #define	GEM_MAC_RX_PROMISCUOUS	0x00000008	/* promiscuous mode */
373 #define	GEM_MAC_RX_PROMISC_GRP	0x00000010	/* promiscuous group mode */
374 #define	GEM_MAC_RX_HASH_FILTER	0x00000020	/* enable hash filter */
375 #define	GEM_MAC_RX_ADDR_FILTER	0x00000040	/* enable address filter */
376 #define	GEM_MAC_RX_ERRCHK_DIS	0x00000080	/* disable error checking */
377 #define	GEM_MAC_RX_CARR_EXTEND	0x00000100	/* Ena RX Carrier Extension */
378 /*
379  * Carrier Extension enables reception of packet bursts generated by
380  * senders with carrier extension enabled.
381  */
382 #define	GEM_MAC_RX_CONFIG_BITS	"\177\020" \
383 				"b\0RXENA\0b\1STRPAD\0b\2STRCRC\0" \
384 				"b\3PROMIS\0b\4PROMISCGRP\0b\5HASHFLTR\0" \
385 				"b\6ADDRFLTR\0b\7ERRCHKDIS\0b\x9TXCARREXT\0\0"
386 
387 /* GEM_MAC_CONTROL_CONFIG bits */
388 #define	GEM_MAC_CC_TX_PAUSE	0x00000001	/* send pause enabled */
389 #define	GEM_MAC_CC_RX_PAUSE	0x00000002	/* receive pause enabled */
390 #define	GEM_MAC_CC_PASS_PAUSE	0x00000004	/* pass pause up */
391 #define	GEM_MAC_CC_BITS		"\177\020b\0TXPAUSE\0b\1RXPAUSE\0b\2NOPAUSE\0\0"
392 
393 /*
394  * MIF registers
395  * Bit bang registers use low bit only.
396  */
397 #define	GEM_MIF_BB_CLOCK	0x6200		/* bit bang clock */
398 #define	GEM_MIF_BB_DATA		0x6204		/* bit bang data */
399 #define	GEM_MIF_BB_OUTPUT_ENAB	0x6208
400 #define	GEM_MIF_FRAME		0x620c		/* MIF frame - ctl and data */
401 #define	GEM_MIF_CONFIG		0x6210
402 #define	GEM_MIF_MASK		0x6214
403 #define	GEM_MIF_STATUS		0x6218
404 #define	GEM_MIF_STATE_MACHINE	0x621c
405 
406 /* GEM_MIF_FRAME bits */
407 #define	GEM_MIF_FRAME_DATA	0x0000ffff
408 #define	GEM_MIF_FRAME_TA0	0x00010000	/* TA LSB, 1 for completion */
409 #define	GEM_MIF_FRAME_TA1	0x00020000	/* TA MSB, 1 for instruction */
410 #define	GEM_MIF_FRAME_REG_ADDR	0x007c0000
411 #define	GEM_MIF_FRAME_PHY_ADDR	0x0f800000	/* PHY address */
412 #define	GEM_MIF_FRAME_OP	0x30000000	/* operation - write/read */
413 #define	GEM_MIF_FRAME_START	0xc0000000	/* START bits */
414 
415 #define	GEM_MIF_FRAME_READ	0x60020000
416 #define	GEM_MIF_FRAME_WRITE	0x50020000
417 
418 #define	GEM_MIF_REG_SHIFT	18
419 #define	GEM_MIF_PHY_SHIFT	23
420 
421 /* GEM_MIF_CONFIG register bits */
422 #define	GEM_MIF_CONFIG_PHY_SEL	0x00000001	/* PHY select, 0: MDIO_0 */
423 #define	GEM_MIF_CONFIG_POLL_ENA	0x00000002	/* poll enable */
424 #define	GEM_MIF_CONFIG_BB_ENA	0x00000004	/* bit bang enable */
425 #define	GEM_MIF_CONFIG_REG_ADR	0x000000f8	/* poll register address */
426 #define	GEM_MIF_CONFIG_MDI0	0x00000100	/* MDIO_0 attached/data */
427 #define	GEM_MIF_CONFIG_MDI1	0x00000200	/* MDIO_1 attached/data */
428 #define	GEM_MIF_CONFIG_PHY_ADR	0x00007c00	/* poll PHY address */
429 /* MDI0 is the onboard transceiver, MDI1 is external, PHYAD for both is 0. */
430 #define	GEM_MIF_CONFIG_BITS	"\177\020b\0PHYSEL\0b\1POLL\0b\2BBENA\0" \
431 				"b\x8MDIO0\0b\x9MDIO1\0\0"
432 
433 /* GEM_MIF_STATUS and GEM_MIF_MASK bits */
434 #define	GEM_MIF_POLL_STATUS_MASK	0x0000ffff	/* polling status */
435 #define	GEM_MIF_POLL_STATUS_SHFT	0
436 #define	GEM_MIF_POLL_DATA_MASK		0xffff0000	/* polling data */
437 #define	GEM_MIF_POLL_DATA_SHFT		8
438 /*
439  * The Basic part is the last value read in the POLL field of the config
440  * register.
441  * The status part indicates the bits that have changed.
442  */
443 
444 /* GEM PCS/Serial link registers */
445 #define	GEM_MII_CONTROL		0x9000
446 #define	GEM_MII_STATUS		0x9004
447 #define	GEM_MII_ANAR		0x9008		/* MII advertisement reg */
448 #define	GEM_MII_ANLPAR		0x900c		/* Link Partner Ability Reg */
449 #define	GEM_MII_CONFIG		0x9010
450 #define	GEM_MII_STATE_MACHINE	0x9014
451 #define	GEM_MII_INTERRUP_STATUS	0x9018		/* PCS interrupt state */
452 #define	GEM_MII_DATAPATH_MODE	0x9050
453 #define	GEM_MII_SLINK_CONTROL	0x9054		/* Serial link control */
454 #define	GEM_MII_OUTPUT_SELECT	0x9058
455 #define	GEM_MII_SLINK_STATUS	0x905c		/* Serialink status */
456 
457 /* GEM_MII_CONTROL bits - PCS "BMCR" (Basic Mode Control Reg) */
458 #define	GEM_MII_CONTROL_1000M	0x00000040	/* 1000Mbps speed select */
459 #define	GEM_MII_CONTROL_COL_TST	0x00000080	/* collision test */
460 #define	GEM_MII_CONTROL_FDUPLEX	0x00000100	/* full-duplex, always 0 */
461 #define	GEM_MII_CONTROL_RAN	0x00000200	/* restart auto-negotiation */
462 #define	GEM_MII_CONTROL_ISOLATE	0x00000400	/* isolate PHY from MII */
463 #define	GEM_MII_CONTROL_POWERDN	0x00000800	/* power down */
464 #define	GEM_MII_CONTROL_AUTONEG	0x00001000	/* auto-negotiation enable */
465 #define	GEM_MII_CONTROL_10_100M	0x00002000	/* 10/100Mbps speed select */
466 #define	GEM_MII_CONTROL_LOOPBK	0x00004000	/* 10-bit i/f loopback */
467 #define	GEM_MII_CONTROL_RESET	0x00008000	/* Reset PCS. */
468 #define	GEM_MII_CONTROL_BITS	"\177\020b\7COLTST\0b\x8_FD\0b\x9RAN\0" \
469 				"b\xaISOLATE\0b\xbPWRDWN\0b\xc_ANEG\0" \
470 				"b\xdGIGE\0b\xeLOOP\0b\xfRESET\0\0"
471 
472 /* GEM_MII_STATUS reg - PCS "BMSR" (Basic Mode Status Reg) */
473 #define	GEM_MII_STATUS_EXTCAP	0x00000001	/* extended capability */
474 #define	GEM_MII_STATUS_JABBER	0x00000002	/* jabber condition detected */
475 #define	GEM_MII_STATUS_LINK_STS	0x00000004	/* link status */
476 #define	GEM_MII_STATUS_ACFG	0x00000008	/* can auto-negotiate */
477 #define	GEM_MII_STATUS_REM_FLT	0x00000010	/* remote fault detected */
478 #define	GEM_MII_STATUS_ANEG_CPT	0x00000020	/* auto-negotiate complete */
479 #define	GEM_MII_STATUS_EXTENDED	0x00000100	/* extended status */
480 #define	GEM_MII_STATUS_BITS	"\177\020b\0EXTCAP\0b\1JABBER\0b\2LINKSTS\0" \
481 				"b\3ACFG\0b\4REMFLT\0b\5ANEGCPT\0\0"
482 
483 /* GEM_MII_ANAR and GEM_MII_ANLPAR reg bits */
484 #define	GEM_MII_ANEG_FDUPLX	0x00000020	/* full-duplex */
485 #define	GEM_MII_ANEG_HDUPLX	0x00000040	/* half-duplex */
486 #define	GEM_MII_ANEG_PAUSE	0x00000080	/* symmetric PAUSE */
487 #define	GEM_MII_ANEG_ASM_DIR	0x00000100	/* asymmetric PAUSE */
488 #define	GEM_MII_ANEG_RFLT_FAIL	0x00001000	/* remote fault - fail */
489 #define	GEM_MII_ANEG_RFLT_OFF	0x00002000	/* remote fault - off-line */
490 #define	GEM_MII_ANEG_RFLT_MASK						\
491 (CAS_PCS_ANEG_RFLT_FAIL | CAS_PCS_ANEG_RFLT_OFF)
492 #define	GEM_MII_ANEG_ACK	0x00004000	/* acknowledge */
493 #define	GEM_MII_ANEG_NP		0x00008000	/* next page */
494 #define	GEM_MII_ANEG_BITS	"\177\020b\5FDX\0b\6HDX\0b\7SYMPAUSE\0" \
495 				"\b\x8_ASYMPAUSE\0\b\xdREMFLT\0\b\xeLPACK\0" \
496 				"\b\xfNPBIT\0\0"
497 
498 /* GEM_MII_CONFIG reg */
499 #define	GEM_MII_CONFIG_ENABLE	0x00000001	/* Enable PCS. */
500 #define	GEM_MII_CONFIG_SDO	0x00000002	/* signal detect override */
501 #define	GEM_MII_CONFIG_SDL	0x00000004	/* signal detect active-low */
502 #define	GEM_MII_CONFIG_JS_NORM	0x00000000	/* jitter study - normal op. */
503 #define	GEM_MII_CONFIG_JS_HF	0x00000008	/* jitter study - HF test */
504 #define	GEM_MII_CONFIG_JS_LF	0x00000010	/* jitter study - LF test */
505 #define	GEM_MII_CONFIG_JS_MASK						\
506 	(GEM_MII_CONFIG_JS_HF | GEM_MII_CONFIG_JS_LF)
507 #define	GEM_MII_CONFIG_ANTO	0x00000020	/* auto-neg. timer override */
508 #define	GEM_MII_CONFIG_BITS	"\177\020b\0PCSENA\0\0"
509 
510 /*
511  * GEM_MII_INTERRUP_STATUS reg
512  * No mask register; mask with the global interrupt mask register.
513  */
514 #define	GEM_MII_INTERRUP_LINK	0x00000004	/* PCS link status change */
515 
516 /* GEM_MII_DATAPATH_MODE reg */
517 #define	GEM_MII_DATAPATH_SERIAL	0x00000001	/* Serialink */
518 #define	GEM_MII_DATAPATH_SERDES	0x00000002	/* SERDES via 10-bit */
519 #define	GEM_MII_DATAPATH_MII	0x00000004	/* GMII/MII */
520 #define	GEM_MII_DATAPATH_GMIIOE	0x00000008	/* serial output on GMII en. */
521 #define	GEM_MII_DATAPATH_BITS	"\177\020"	\
522 				"b\0SERIAL\0b\1SERDES\0b\2MII\0b\3GMIIOE\0\0"
523 
524 /* GEM_MII_SLINK_CONTROL reg */
525 #define	GEM_MII_SLINK_LOOPBACK	0x00000001	/* enable loopback at SL, logic
526 						 * reversed for SERDES */
527 #define	GEM_MII_SLINK_EN_SYNC_D	0x00000002	/* enable sync detection */
528 #define	GEM_MII_SLINK_LOCK_REF	0x00000004	/* lock to reference clock */
529 #define	GEM_MII_SLINK_EMPHASIS	0x00000018	/* enable emphasis */
530 #define	GEM_MII_SLINK_SELFTEST	0x000001c0	/* self-test */
531 #define	GEM_MII_SLINK_POWER_OFF	0x00000200	/* Power down Serialink. */
532 #define	GEM_MII_SLINK_RX_ZERO	0x00000c00	/* PLL input to Serialink. */
533 #define	GEM_MII_SLINK_RX_POLE	0x00003000	/* PLL input to Serialink. */
534 #define	GEM_MII_SLINK_TX_ZERO	0x0000c000	/* PLL input to Serialink. */
535 #define	GEM_MII_SLINK_TX_POLE	0x00030000	/* PLL input to Serialink. */
536 #define	GEM_MII_SLINK_CONTROL_BITS		\
537 				"\177\020b\0LOOP\0b\1ENASYNC\0b\2LOCKREF" \
538 				"\0b\3EMPHASIS\0b\x9PWRDWN\0\0"
539 
540 /* GEM_MII_SLINK_STATUS reg */
541 #define	GEM_MII_SLINK_TEST	0x00000000	/* undergoing test */
542 #define	GEM_MII_SLINK_LOCKED	0x00000001	/* waiting 500us w/ lockrefn */
543 #define	GEM_MII_SLINK_COMMA	0x00000002	/* waiting for comma detect */
544 #define	GEM_MII_SLINK_SYNC	0x00000003	/* recv data synchronized */
545 
546 /*
547  * PCI Expansion ROM runtime access
548  * Sun GEMs map a 1MB space for the PCI Expansion ROM as the second half
549  * of the register bank, although they only support up to 64KB ROMs.
550  */
551 #define	GEM_PCI_ROM_OFFSET	0x100000
552 #define	GEM_PCI_ROM_SIZE	0x10000
553 
554 /* Wired PHY addresses */
555 #define	GEM_PHYAD_INTERNAL	1
556 #define	GEM_PHYAD_EXTERNAL	0
557 
558 /*
559  * descriptor table structures
560  */
561 struct gem_desc {
562 	uint64_t	gd_flags;
563 	uint64_t	gd_addr;
564 };
565 
566 /*
567  * Transmit flags
568  * GEM_TD_CXSUM_ENABLE, GEM_TD_CXSUM_START, GEM_TD_CXSUM_STUFF and
569  * GEM_TD_INTERRUPT_ME only need to be set in the first descriptor of a group.
570  */
571 #define	GEM_TD_BUFSIZE		0x0000000000007fffULL
572 #define	GEM_TD_CXSUM_START	0x00000000001f8000ULL	/* Cxsum start offset */
573 #define	GEM_TD_CXSUM_STARTSHFT	15
574 #define	GEM_TD_CXSUM_STUFF	0x000000001fe00000ULL	/* Cxsum stuff offset */
575 #define	GEM_TD_CXSUM_STUFFSHFT	21
576 #define	GEM_TD_CXSUM_ENABLE	0x0000000020000000ULL	/* Cxsum generation enable */
577 #define	GEM_TD_END_OF_PACKET	0x0000000040000000ULL
578 #define	GEM_TD_START_OF_PACKET	0x0000000080000000ULL
579 #define	GEM_TD_INTERRUPT_ME	0x0000000100000000ULL	/* Interrupt me now */
580 #define	GEM_TD_NO_CRC		0x0000000200000000ULL	/* do not insert crc */
581 
582 /* Receive flags */
583 #define	GEM_RD_CHECKSUM		0x000000000000ffffULL	/* is the complement */
584 #define	GEM_RD_BUFSIZE		0x000000007fff0000ULL
585 #define	GEM_RD_OWN		0x0000000080000000ULL	/* 1 - owned by h/w */
586 #define	GEM_RD_HASHVAL		0x0ffff00000000000ULL
587 #define	GEM_RD_HASH_PASS	0x1000000000000000ULL	/* passed hash filter */
588 #define	GEM_RD_ALTERNATE_MAC	0x2000000000000000ULL	/* Alternate MAC adrs */
589 #define	GEM_RD_BAD_CRC		0x4000000000000000ULL
590 #define	GEM_RD_BUFSHIFT		16
591 #define	GEM_RD_BUFLEN(x)	(((x) & GEM_RD_BUFSIZE) >> GEM_RD_BUFSHIFT)
592 
593 #endif
594