xref: /freebsd/sys/dev/mii/mii.h (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
1 /*	$NetBSD: mii.h,v 1.9 2001/05/31 03:07:14 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
5  *
6  * Modification to match BSD/OS 3.0 MII interface by Jason R. Thorpe,
7  * Numerical Aerospace Simulation Facility, NASA Ames Research Center.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by Manuel Bouyer.
20  * 4. The name of the author may not be used to endorse or promote products
21  *    derived from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * $FreeBSD$
35  */
36 
37 #ifndef _DEV_MII_MII_H_
38 #define	_DEV_MII_MII_H_
39 
40 /*
41  * Registers common to all PHYs.
42  */
43 
44 #define	MII_NPHY	32	/* max # of PHYs per MII */
45 
46 /*
47  * MII commands, used if a device must drive the MII lines
48  * manually.
49  */
50 #define	MII_COMMAND_START	0x01
51 #define	MII_COMMAND_READ	0x02
52 #define	MII_COMMAND_WRITE	0x01
53 #define	MII_COMMAND_ACK		0x02
54 
55 #define	MII_BMCR	0x00 	/* Basic mode control register (rw) */
56 #define	BMCR_RESET	0x8000	/* reset */
57 #define	BMCR_LOOP	0x4000	/* loopback */
58 #define	BMCR_SPEED0	0x2000	/* speed selection (LSB) */
59 #define	BMCR_AUTOEN	0x1000	/* autonegotiation enable */
60 #define	BMCR_PDOWN	0x0800	/* power down */
61 #define	BMCR_ISO	0x0400	/* isolate */
62 #define	BMCR_STARTNEG	0x0200	/* restart autonegotiation */
63 #define	BMCR_FDX	0x0100	/* Set duplex mode */
64 #define	BMCR_CTEST	0x0080	/* collision test */
65 #define	BMCR_SPEED1	0x0040	/* speed selection (MSB) */
66 
67 #define	BMCR_S10	0x0000		/* 10 Mb/s */
68 #define	BMCR_S100	BMCR_SPEED0	/* 100 Mb/s */
69 #define	BMCR_S1000	BMCR_SPEED1	/* 1000 Mb/s */
70 
71 #define	BMCR_SPEED(x)	((x) & (BMCR_SPEED0|BMCR_SPEED1))
72 
73 #define	MII_BMSR	0x01	/* Basic mode status register (ro) */
74 #define	BMSR_100T4	0x8000	/* 100 base T4 capable */
75 #define	BMSR_100TXFDX	0x4000	/* 100 base Tx full duplex capable */
76 #define	BMSR_100TXHDX	0x2000	/* 100 base Tx half duplex capable */
77 #define	BMSR_10TFDX	0x1000	/* 10 base T full duplex capable */
78 #define	BMSR_10THDX	0x0800	/* 10 base T half duplex capable */
79 #define	BMSR_100T2FDX	0x0400	/* 100 base T2 full duplex capable */
80 #define	BMSR_100T2HDX	0x0200	/* 100 base T2 half duplex capable */
81 #define	BMSR_EXTSTAT	0x0100	/* Extended status in register 15 */
82 #define	BMSR_MFPS	0x0040	/* MII Frame Preamble Suppression */
83 #define	BMSR_ACOMP	0x0020	/* Autonegotiation complete */
84 #define	BMSR_RFAULT	0x0010	/* Link partner fault */
85 #define	BMSR_ANEG	0x0008	/* Autonegotiation capable */
86 #define	BMSR_LINK	0x0004	/* Link status */
87 #define	BMSR_JABBER	0x0002	/* Jabber detected */
88 #define	BMSR_EXTCAP	0x0001	/* Extended capability */
89 
90 /*
91  * Note that the EXTSTAT bit indicates that there is extended status
92  * info available in register 15, but 802.3 section 22.2.4.3 also
93  * states that that all 1000 Mb/s capable PHYs will set this bit to 1.
94  */
95 #if 0
96 #define	BMSR_MEDIAMASK	(BMSR_100T4|BMSR_100TXFDX|BMSR_100TXHDX|BMSR_10TFDX| \
97 			 BMSR_10THDX|BMSR_ANEG)
98 
99 #else
100 /* NetBSD uses: */
101 #define	BMSR_MEDIAMASK	(BMSR_100T4|BMSR_100TXFDX|BMSR_100TXHDX| \
102 			 BMSR_10TFDX|BMSR_10THDX|BMSR_100T2FDX|BMSR_100T2HDX)
103 #endif
104 
105 /*
106  * Convert BMSR media capabilities to ANAR bits for autonegotiation.
107  * Note the shift chopps off the BMSR_ANEG bit.
108  */
109 #define	BMSR_MEDIA_TO_ANAR(x)	(((x) & BMSR_MEDIAMASK) >> 6)
110 
111 #define	MII_PHYIDR1	0x02	/* ID register 1 (ro) */
112 
113 #define	MII_PHYIDR2	0x03	/* ID register 2 (ro) */
114 #define	IDR2_OUILSB	0xfc00	/* OUI LSB */
115 #define	IDR2_MODEL	0x03f0	/* vendor model */
116 #define	IDR2_REV	0x000f	/* vendor revision */
117 
118 #define	MII_OUI(id1, id2)	(((id1) << 6) | ((id2) >> 10))
119 #define	MII_MODEL(id2)		(((id2) & IDR2_MODEL) >> 4)
120 #define	MII_REV(id2)		((id2) & IDR2_REV)
121 
122 #define	MII_ANAR	0x04	/* Autonegotiation advertisement (rw) */
123 		/* section 28.2.4.1 and 37.2.6.1 */
124 #define ANAR_NP		0x8000	/* Next page (ro) */
125 #define	ANAR_ACK	0x4000	/* link partner abilities acknowledged (ro) */
126 #define ANAR_RF		0x2000	/* remote fault (ro) */
127 #define	ANAR_FC		0x0400	/* local device supports PAUSE */
128 #define ANAR_T4		0x0200	/* local device supports 100bT4 */
129 #define ANAR_TX_FD	0x0100	/* local device supports 100bTx FD */
130 #define ANAR_TX		0x0080	/* local device supports 100bTx */
131 #define ANAR_10_FD	0x0040	/* local device supports 10bT FD */
132 #define ANAR_10		0x0020	/* local device supports 10bT */
133 #define	ANAR_CSMA	0x0001	/* protocol selector CSMA/CD */
134 
135 #define	ANAR_X_FD	0x0020	/* local device supports 1000BASE-X FD */
136 #define	ANAR_X_HD	0x0040	/* local device supports 1000BASE-X HD */
137 #define	ANAR_X_PAUSE_NONE	(0 << 7)
138 #define	ANAR_X_PAUSE_SYM	(1 << 7)
139 #define	ANAR_X_PAUSE_ASYM	(2 << 7)
140 #define	ANAR_X_PAUSE_TOWARDS	(3 << 7)
141 
142 #define	MII_ANLPAR	0x05	/* Autonegotiation lnk partner abilities (rw) */
143 		/* section 28.2.4.1 and 37.2.6.1 */
144 #define ANLPAR_NP	0x8000	/* Next page (ro) */
145 #define	ANLPAR_ACK	0x4000	/* link partner accepted ACK (ro) */
146 #define ANLPAR_RF	0x2000	/* remote fault (ro) */
147 #define	ANLPAR_FC	0x0400	/* link partner supports PAUSE */
148 #define ANLPAR_T4	0x0200	/* link partner supports 100bT4 */
149 #define ANLPAR_TX_FD	0x0100	/* link partner supports 100bTx FD */
150 #define ANLPAR_TX	0x0080	/* link partner supports 100bTx */
151 #define ANLPAR_10_FD	0x0040	/* link partner supports 10bT FD */
152 #define ANLPAR_10	0x0020	/* link partner supports 10bT */
153 #define	ANLPAR_CSMA	0x0001	/* protocol selector CSMA/CD */
154 
155 #define	ANLPAR_X_FD	0x0020	/* local device supports 1000BASE-X FD */
156 #define	ANLPAR_X_HD	0x0040	/* local device supports 1000BASE-X HD */
157 #define	ANLPAR_X_PAUSE_MASK	(3 << 7)
158 #define	ANLPAR_X_PAUSE_NONE	(0 << 7)
159 #define	ANLPAR_X_PAUSE_SYM	(1 << 7)
160 #define	ANLPAR_X_PAUSE_ASYM	(2 << 7)
161 #define	ANLPAR_X_PAUSE_TOWARDS	(3 << 7)
162 
163 #define	MII_ANER	0x06	/* Autonegotiation expansion (ro) */
164 		/* section 28.2.4.1 and 37.2.6.1 */
165 #define ANER_MLF	0x0010	/* multiple link detection fault */
166 #define ANER_LPNP	0x0008	/* link parter next page-able */
167 #define ANER_NP		0x0004	/* next page-able */
168 #define ANER_PAGE_RX	0x0002	/* Page received */
169 #define ANER_LPAN	0x0001	/* link parter autoneg-able */
170 
171 #define	MII_ANNP	0x07	/* Autonegotiation next page */
172 		/* section 28.2.4.1 and 37.2.6.1 */
173 
174 #define	MII_ANLPRNP	0x08	/* Autonegotiation link partner rx next page */
175 		/* section 32.5.1 and 37.2.6.1 */
176 
177 			/* This is also the 1000baseT control register */
178 #define	MII_100T2CR	0x09	/* 100base-T2 control register */
179 #define	GTCR_TEST_MASK	0xe000	/* see 802.3ab ss. 40.6.1.1.2 */
180 #define	GTCR_MAN_MS	0x1000	/* enable manual master/slave control */
181 #define	GTCR_ADV_MS	0x0800	/* 1 = adv. master, 0 = adv. slave */
182 #define	GTCR_PORT_TYPE	0x0400	/* 1 = DCE, 0 = DTE (NIC) */
183 #define	GTCR_ADV_1000TFDX 0x0200 /* adv. 1000baseT FDX */
184 #define	GTCR_ADV_1000THDX 0x0100 /* adv. 1000baseT HDX */
185 
186 			/* This is also the 1000baseT status register */
187 #define	MII_100T2SR	0x0a	/* 100base-T2 status register */
188 #define	GTSR_MAN_MS_FLT	0x8000	/* master/slave config fault */
189 #define	GTSR_MS_RES	0x4000	/* result: 1 = master, 0 = slave */
190 #define	GTSR_LRS	0x2000	/* local rx status, 1 = ok */
191 #define	GTSR_RRS	0x1000	/* remove rx status, 1 = ok */
192 #define	GTSR_LP_1000TFDX 0x0800	/* link partner 1000baseT FDX capable */
193 #define	GTSR_LP_1000THDX 0x0400	/* link partner 1000baseT HDX capable */
194 #define	GTSR_LP_ASM_DIR	0x0200	/* link partner asym. pause dir. capable */
195 #define	GTSR_IDLE_ERR	0x00ff	/* IDLE error count */
196 
197 #define	MII_EXTSR	0x0f	/* Extended status register */
198 #define	EXTSR_1000XFDX	0x8000	/* 1000X full-duplex capable */
199 #define	EXTSR_1000XHDX	0x4000	/* 1000X half-duplex capable */
200 #define	EXTSR_1000TFDX	0x2000	/* 1000T full-duplex capable */
201 #define	EXTSR_1000THDX	0x1000	/* 1000T half-duplex capable */
202 
203 #define	EXTSR_MEDIAMASK	(EXTSR_1000XFDX|EXTSR_1000XHDX| \
204 			 EXTSR_1000TFDX|EXTSR_1000THDX)
205 
206 #endif /* _DEV_MII_MII_H_ */
207