xref: /openbsd/sys/dev/mii/eephyreg.h (revision 8f0d13a1)
1 /*	$OpenBSD: eephyreg.h,v 1.11 2023/12/28 14:03:21 uwe Exp $	*/
2 /*
3  * Principal Author: Parag Patel
4  * Copyright (c) 2001
5  * 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 unmodified, this list of conditions, and the following
12  *    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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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  * Additional Copyright (c) 2001 by Traakan Software under same licence.
30  * Secondary Author: Matthew Jacob
31  */
32 
33 /*
34  * Derived by information released by Intel under the following license:
35  *
36  * Copyright (c) 1999 - 2001, Intel Corporation
37  *
38  * All rights reserved.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions are met:
42  *
43  *  1. Redistributions of source code must retain the above copyright notice,
44  *     this list of conditions and the following disclaimer.
45  *
46  *  2. Redistributions in binary form must reproduce the above copyright notice,
47  *     this list of conditions and the following disclaimer in the
48  *     documentation and/or other materials provided with the distribution.
49  *
50  *  3. Neither the name of Intel Corporation nor the names of its contributors
51  *     may be used to endorse or promote products derived from this software
52  *     without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
55  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57  * ARE DISCLAIMED. IN NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
58  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
59  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
60  * LOSS OF USE, DATA, OR * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
61  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
62  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
63  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64  *
65  */
66 
67 /*
68  * Marvell E1000 PHY registers
69  */
70 
71 #define E1000_MAX_REG_ADDRESS		0x1F
72 
73 #define E1000_CR			0x00	/* control register */
74 #define E1000_CR_SPEED_SELECT_MSB	0x0040
75 #define E1000_CR_COLL_TEST_ENABLE	0x0080
76 #define E1000_CR_FULL_DUPLEX		0x0100
77 #define E1000_CR_RESTART_AUTO_NEG	0x0200
78 #define E1000_CR_ISOLATE		0x0400
79 #define E1000_CR_POWER_DOWN		0x0800
80 #define E1000_CR_AUTO_NEG_ENABLE	0x1000
81 #define E1000_CR_SPEED_SELECT_LSB	0x2000
82 #define E1000_CR_LOOPBACK		0x4000
83 #define E1000_CR_RESET			0x8000
84 
85 #define E1000_CR_SPEED_1000		0x0040
86 #define E1000_CR_SPEED_100		0x2000
87 #define E1000_CR_SPEED_10		0x0000
88 
89 #define E1000_SR			0x01	/* status register */
90 #define E1000_SR_EXTENDED		0x0001
91 #define E1000_SR_JABBER_DETECT		0x0002
92 #define E1000_SR_LINK_STATUS		0x0004
93 #define E1000_SR_AUTO_NEG		0x0008
94 #define E1000_SR_REMOTE_FAULT		0x0010
95 #define E1000_SR_AUTO_NEG_COMPLETE	0x0020
96 #define E1000_SR_PREAMBLE_SUPPRESS	0x0040
97 #define E1000_SR_EXTENDED_STATUS	0x0100
98 #define E1000_SR_100T2			0x0200
99 #define E1000_SR_100T2_FD		0x0400
100 #define E1000_SR_10T			0x0800
101 #define E1000_SR_10T_FD			0x1000
102 #define E1000_SR_100TX			0x2000
103 #define E1000_SR_100TX_FD		0x4000
104 #define E1000_SR_100T4			0x8000
105 
106 #define E1000_ID1			0x02	/* ID register 1 */
107 #define E1000_ID2			0x03	/* ID register 2 */
108 
109 #define E1000_AR			0x04	/* autonegotiation advertise reg */
110 #define E1000_AR_SELECTOR_FIELD		0x0001
111 #define E1000_AR_10T			0x0020
112 #define E1000_AR_10T_FD			0x0040
113 #define E1000_AR_100TX			0x0080
114 #define E1000_AR_100TX_FD		0x0100
115 #define E1000_AR_100T4			0x0200
116 #define E1000_AR_PAUSE			0x0400
117 #define E1000_AR_ASM_DIR		0x0800
118 #define E1000_AR_REMOTE_FAULT		0x2000
119 #define E1000_AR_NEXT_PAGE		0x8000
120 #define E1000_AR_SPEED_MASK		0x01E0
121 
122 /* Autonegotiation register bits for fiber cards (Alaska Only!) */
123 #define E1000_FA_1000X_FD		0x0020
124 #define E1000_FA_1000X			0x0040
125 #define E1000_FA_SYM_PAUSE		0x0080
126 #define E1000_FA_ASYM_PAUSE		0x0100
127 #define E1000_FA_FAULT1			0x1000
128 #define E1000_FA_FAULT2			0x2000
129 #define E1000_FA_NEXT_PAGE		0x8000
130 
131 #define E1000_LPAR			0x05	/* autoneg link partner abilities reg */
132 #define E1000_LPAR_SELECTOR_FIELD	0x0001
133 #define E1000_LPAR_10T			0x0020
134 #define E1000_LPAR_10T_FD		0x0040
135 #define E1000_LPAR_100TX		0x0080
136 #define E1000_LPAR_100TX_FD		0x0100
137 #define E1000_LPAR_100T4		0x0200
138 #define E1000_LPAR_PAUSE		0x0400
139 #define E1000_LPAR_ASM_DIR		0x0800
140 #define E1000_LPAR_REMOTE_FAULT		0x2000
141 #define E1000_LPAR_ACKNOWLEDGE		0x4000
142 #define E1000_LPAR_NEXT_PAGE		0x8000
143 
144 /* autoneg link partner ability register bits for fiber cards (Alaska Only!) */
145 #define E1000_FPAR_1000X_FD		0x0020
146 #define E1000_FPAR_1000X		0x0040
147 #define E1000_FPAR_SYM_PAUSE		0x0080
148 #define E1000_FPAR_ASYM_PAUSE		0x0100
149 #define E1000_FPAR_FAULT1		0x1000
150 #define E1000_FPAR_FAULT2		0x2000
151 #define E1000_FPAR_ACK			0x4000
152 #define E1000_FPAR_NEXT_PAGE		0x8000
153 
154 #define E1000_ER			0x06	/* autoneg expansion reg */
155 #define E1000_ER_LP_NWAY		0x0001
156 #define E1000_ER_PAGE_RXD		0x0002
157 #define E1000_ER_NEXT_PAGE		0x0004
158 #define E1000_ER_LP_NEXT_PAGE		0x0008
159 #define E1000_ER_PAR_DETECT_FAULT	0x0100
160 
161 #define E1000_NPTX			0x07	/* autoneg next page TX */
162 #define E1000_NPTX_MSG_CODE_FIELD	0x0001
163 #define E1000_NPTX_TOGGLE		0x0800
164 #define E1000_NPTX_ACKNOWLDGE2		0x1000
165 #define E1000_NPTX_MSG_PAGE		0x2000
166 #define E1000_NPTX_NEXT_PAGE		0x8000
167 
168 #define E1000_RNPR			0x08	/* autoneg link-partner (?) next page */
169 #define E1000_RNPR_MSG_CODE_FIELD	0x0001
170 #define E1000_RNPR_TOGGLE		0x0800
171 #define E1000_RNPR_ACKNOWLDGE2		0x1000
172 #define E1000_RNPR_MSG_PAGE		0x2000
173 #define E1000_RNPR_ACKNOWLDGE		0x4000
174 #define E1000_RNPR_NEXT_PAGE		0x8000
175 
176 #define E1000_1GCR			0x09	/* 1000T (1G) control reg */
177 #define E1000_1GCR_ASYM_PAUSE		0x0080
178 #define E1000_1GCR_1000T		0x0100
179 #define E1000_1GCR_1000T_FD		0x0200
180 #define E1000_1GCR_REPEATER_DTE		0x0400
181 #define E1000_1GCR_MS_VALUE		0x0800
182 #define E1000_1GCR_MS_ENABLE		0x1000
183 #define E1000_1GCR_TEST_MODE_NORMAL	0x0000
184 #define E1000_1GCR_TEST_MODE_1		0x2000
185 #define E1000_1GCR_TEST_MODE_2		0x4000
186 #define E1000_1GCR_TEST_MODE_3		0x6000
187 #define E1000_1GCR_TEST_MODE_4		0x8000
188 #define E1000_1GCR_SPEED_MASK		0x0300
189 
190 #define E1000_1GSR			0x0A	/* 1000T (1G) status reg */
191 #define E1000_1GSR_IDLE_ERROR_CNT	0x0000
192 #define E1000_1GSR_ASYM_PAUSE_DIR	0x0100
193 #define E1000_1GSR_LP			0x0400
194 #define E1000_1GSR_LP_FD		0x0800
195 #define E1000_1GSR_REMOTE_RX_STATUS	0x1000
196 #define E1000_1GSR_LOCAL_RX_STATUS	0x2000
197 #define E1000_1GSR_MS_CONFIG_RES	0x4000
198 #define E1000_1GSR_MS_CONFIG_FAULT	0x8000
199 
200 #define E1000_ESR			0x0F	/* IEEE extended status reg */
201 #define E1000_ESR_1000T			0x1000
202 #define E1000_ESR_1000T_FD		0x2000
203 #define E1000_ESR_1000X			0x4000
204 #define E1000_ESR_1000X_FD		0x8000
205 
206 #define E1000_TX_POLARITY_MASK		0x0100
207 #define E1000_TX_NORMAL_POLARITY	0
208 
209 #define E1000_AUTO_POLARITY_DISABLE	0x0010
210 
211 #define E1000_SCR			0x10	/* special control register */
212 #define E1000_SCR_JABBER_DISABLE	0x0001
213 #define E1000_SCR_POLARITY_REVERSAL	0x0002
214 #define E1000_SCR_SQE_TEST		0x0004
215 #define E1000_SCR_INT_FIFO_DISABLE	0x0008
216 #define E1000_SCR_CLK125_DISABLE	0x0010
217 #define E1000_SCR_MDI_MANUAL_MODE	0x0000
218 #define E1000_SCR_MDIX_MANUAL_MODE	0x0020
219 #define E1000_SCR_AUTO_X_1000T		0x0040
220 #define E1000_SCR_AUTO_X_MODE		0x0060
221 #define E1000_SCR_10BT_EXT_ENABLE	0x0080
222 #define E1000_SCR_MII_5BIT_ENABLE	0x0100
223 #define E1000_SCR_FORCE_LINK_GOOD	0x0400
224 #define E1000_SCR_ASSERT_CRS_ON_TX	0x0800
225 #define E1000_SCR_RX_FIFO_DEPTH_6	0x0000
226 #define E1000_SCR_RX_FIFO_DEPTH_8	0x1000
227 #define E1000_SCR_RX_FIFO_DEPTH_10	0x2000
228 #define E1000_SCR_RX_FIFO_DEPTH_12	0x3000
229 #define E1000_SCR_TX_FIFO_DEPTH_6	0x0000
230 #define E1000_SCR_TX_FIFO_DEPTH_8	0x4000
231 #define E1000_SCR_TX_FIFO_DEPTH_10	0x8000
232 #define E1000_SCR_TX_FIFO_DEPTH_12	0xC000
233 
234 #define E1000_SCR_EN_DETECT_MASK	0x0300
235 
236 #define E3000_SCR_SCRAMBLER_DISABLE	0x0200
237 #define E3000_SCR_REG8_NEXT_PAGE	0x1000
238 #define E3000_SCR_EN_DETECT_MASK	0x4000
239 
240 /* 88E1112 page 2 */
241 #define E1000_SCR_MODE_MASK		0x0380
242 #define E1000_SCR_MODE_AUTO		0x0180
243 #define E1000_SCR_MODE_COPPER		0x0280
244 #define E1000_SCR_MODE_1000BX		0x0380
245 
246 #define E1000_SSR			0x11	/* special status register */
247 #define E1000_SSR_JABBER		0x0001
248 #define E1000_SSR_REV_POLARITY		0x0002
249 #define E1000_SSR_MDIX			0x0020
250 #define E1000_SSR_LINK			0x0400
251 #define E1000_SSR_SPD_DPLX_RESOLVED	0x0800
252 #define E1000_SSR_PAGE_RCVD		0x1000
253 #define E1000_SSR_DUPLEX		0x2000
254 #define E1000_SSR_SPEED			0xC000
255 #define E1000_SSR_10MBS			0x0000
256 #define E1000_SSR_100MBS		0x4000
257 #define E1000_SSR_1000MBS		0x8000
258 
259 #define E1000_IER			0x12	/* interrupt enable reg */
260 #define E1000_IER_JABBER		0x0001
261 #define E1000_IER_POLARITY_CHANGE	0x0002
262 #define E1000_IER_MDIX_CHANGE		0x0040
263 #define E1000_IER_FIFO_OVER_UNDERUN	0x0080
264 #define E1000_IER_FALSE_CARRIER		0x0100
265 #define E1000_IER_SYMBOL_ERROR		0x0200
266 #define E1000_IER_LINK_STAT_CHANGE	0x0400
267 #define E1000_IER_AUTO_NEG_COMPLETE	0x0800
268 #define E1000_IER_PAGE_RECEIVED		0x1000
269 #define E1000_IER_DUPLEX_CHANGED	0x2000
270 #define E1000_IER_SPEED_CHANGED		0x4000
271 #define E1000_IER_AUTO_NEG_ERR		0x8000
272 
273 #define E1000_ISR			0x13	/* interrupt status reg */
274 #define E1000_ISR_JABBER		0x0001
275 #define E1000_ISR_POLARITY_CHANGE	0x0002
276 #define E1000_ISR_MDIX_CHANGE		0x0040
277 #define E1000_ISR_FIFO_OVER_UNDERUN	0x0080
278 #define E1000_ISR_FALSE_CARRIER		0x0100
279 #define E1000_ISR_SYMBOL_ERROR		0x0200
280 #define E1000_ISR_LINK_STAT_CHANGE	0x0400
281 #define E1000_ISR_AUTO_NEG_COMPLETE	0x0800
282 #define E1000_ISR_PAGE_RECEIVED		0x1000
283 #define E1000_ISR_DUPLEX_CHANGED	0x2000
284 #define E1000_ISR_SPEED_CHANGED		0x4000
285 #define E1000_ISR_AUTO_NEG_ERR		0x8000
286 
287 /* page any */
288 #define E1000_ESCR			0x14	/* extended special control reg */
289 #define E1000_ESCR_FIBER_LOOPBACK	0x4000
290 #define E1000_ESCR_DOWN_NO_IDLE		0x8000
291 #define E1000_ESCR_TX_CLK_2_5		0x0060
292 #define E1000_ESCR_TX_CLK_25		0x0070
293 #define E1000_ESCR_TX_CLK_0		0x0000
294 
295 #define E1000_RECR			0x15	/* RX error counter reg */
296 
297 #define E1000_EADR			0x16	/* extended address reg */
298 
299 #define E1000_LCR			0x18	/* LED control reg */
300 #define E1000_LCR_LED_TX		0x0001
301 #define E1000_LCR_LED_RX		0x0002
302 #define E1000_LCR_LED_DUPLEX		0x0004
303 #define E1000_LCR_LINK			0x0008
304 #define E1000_LCR_BLINK_42MS		0x0000
305 #define E1000_LCR_BLINK_84MS		0x0100
306 #define E1000_LCR_BLINK_170MS		0x0200
307 #define E1000_LCR_BLINK_340MS		0x0300
308 #define E1000_LCR_BLINK_670MS		0x0400
309 #define E1000_LCR_PULSE_OFF		0x0000
310 #define E1000_LCR_PULSE_21_42MS		0x1000
311 #define E1000_LCR_PULSE_42_84MS		0x2000
312 #define E1000_LCR_PULSE_84_170MS	0x3000
313 #define E1000_LCR_PULSE_170_340MS	0x4000
314 #define E1000_LCR_PULSE_340_670MS	0x5000
315 #define E1000_LCR_PULSE_670_13S		0x6000
316 #define E1000_LCR_PULSE_13_26S		0x7000
317 
318 /* The following register is found only on the 88E1011 Alaska PHY */
319 #define E1000_ESSR			0x1B	/* Extended PHY specific sts */
320 #define E1000_ESSR_DIS_FC		0x8000
321 #define E1000_ESSR_FIBER_LINK		0x2000
322 #define E1000_ESSR_HWCFG_MODE		0x000f
323 #define E1000_ESSR_GMII_COPPER		0x000f
324 #define E1000_ESSR_GMII_FIBER		0x0007
325 #define E1000_ESSR_TBI_COPPER		0x000d
326 #define E1000_ESSR_TBI_FIBER		0x0005
327 #define E1000_ESSR_RGMII_COPPER		0x000b
328 
329 /* The following register is found only on the 88E151x Alaska PHY */
330 /* Page 18 */
331 #define E1000_GCR1			0x14	/* General Control Register 1 */
332 #define E1000_GCR1_RESET		0x8000
333 #define E1000_GCR1_MODE_MASK		0x0007
334 #define E1000_GCR1_MODE_RGMII		0x0000
335 #define E1000_GCR1_MODE_SGMII		0x0001
336 #define E1000_GCR1_MODE_RGMII_1000X	0x0002
337 #define E1000_GCR1_MODE_RGMII_100FX	0x0003
338 #define E1000_GCR1_MODE_RGMII_TO_SGMII	0x0004
339 #define E1000_GCR1_MODE_UNSET		0x0007
340