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