xref: /dragonfly/sys/dev/netif/mii_layer/mii.h (revision 6421ab1dd66d7f647f437699dcad80e6ce2db09f)
1 /*        $NetBSD: mii.h,v 1.13 2005/12/11 12:22:42 christos 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: src/sys/dev/mii/mii.h,v 1.2 1999/08/28 00:42:14 peter Exp $
35  * $DragonFly: src/sys/dev/netif/mii_layer/mii.h,v 1.4 2006/08/06 10:32:23 sephe Exp $
36  */
37 
38 #ifndef _DEV_MII_MII_H_
39 #define   _DEV_MII_MII_H_
40 
41 /*
42  * Registers common to all PHYs.
43  */
44 
45 #define   MII_NPHY  32        /* max # of PHYs per MII */
46 
47 /*
48  * MII commands, used if a device must drive the MII lines
49  * manually.
50  */
51 #define   MII_COMMAND_START   0x01
52 #define   MII_COMMAND_READ    0x02
53 #define   MII_COMMAND_WRITE   0x01
54 #define   MII_COMMAND_ACK               0x02
55 
56 #define   MII_BMCR  0x00      /* Basic mode control register (rw) */
57 #define   BMCR_RESET          0x8000    /* reset */
58 #define   BMCR_LOOP 0x4000    /* loopback */
59 #define   BMCR_S100 0x2000    /* speed (10/100) select (low bit) */
60 #define   BMCR_AUTOEN         0x1000    /* autonegotiation enable */
61 #define   BMCR_PDOWN          0x0800    /* power down */
62 #define   BMCR_ISO  0x0400    /* isolate */
63 #define   BMCR_STARTNEG       0x0200    /* restart autonegotiation */
64 #define   BMCR_FDX  0x0100    /* Set duplex mode */
65 #define   BMCR_CTEST          0x0080    /* collision test */
66 #define BMCR_S1000  0x0040    /* speed select (high bit) (note 1) */
67 #define   BMCR_S10  0x0000    /* 10 Mb/s */
68 #define   BMCR_SPEED(x)       ((x) & (BMCR_S1000 | BMCR_S100))
69 
70 /*
71  * Note that the EXTSTAT bit indicates that there is extended status
72  * info available in register 15, but 802.3 section 22.2.4.3 also
73  * states that that all 1000 Mb/s capable PHYs will set this bit to 1.
74  */
75 #define   MII_BMSR  0x01      /* Basic mode status register (ro) */
76 #define   BMSR_100T4          0x8000    /* 100 base T4 capable */
77 #define   BMSR_100TXFDX       0x4000    /* 100 base Tx full duplex capable */
78 #define   BMSR_100TXHDX       0x2000    /* 100 base Tx half duplex capable */
79 #define   BMSR_10TFDX         0x1000    /* 10 base T full duplex capable */
80 #define   BMSR_10THDX         0x0800    /* 10 base T half duplex capable */
81 #define   BMSR_100T2FDX       0x0400    /* 100 base T2 full duplex capable */
82 #define   BMSR_100T2HDX       0x0200    /* 100 base T2 half duplex capable */
83 #define   BMSR_EXTSTAT        0x0100    /* Extended status in register 15 */
84 #define   BMSR_MFPS 0x0040    /* MII Frame Preamble Suppression */
85 #define   BMSR_ACOMP          0x0020    /* Autonegotiation complete */
86 #define   BMSR_RFAULT         0x0010    /* Link partner fault */
87 #define   BMSR_ANEG 0x0008    /* Autonegotiation capable */
88 #define   BMSR_LINK 0x0004    /* Link status */
89 #define   BMSR_JABBER         0x0002    /* Jabber detected */
90 #define   BMSR_EXTCAP         0x0001    /* Extended capability */
91 
92 #define   BMSR_MEDIAMASK      (BMSR_100T4 | BMSR_100TXFDX | BMSR_100TXHDX | \
93                                BMSR_10TFDX | BMSR_10THDX| BMSR_100T2FDX | \
94                                BMSR_100T2HDX)
95 
96 /*
97  * Convert BMSR media capabilities to ANAR bits for autonegotiation.
98  * Note the shift chopps off the BMSR_ANEG bit.
99  */
100 #define   BMSR_MEDIA_TO_ANAR(x)         (((x) & BMSR_MEDIAMASK) >> 6)
101 
102 #define   MII_PHYIDR1         0x02      /* ID register 1 (ro) */
103 
104 #define   MII_PHYIDR2         0x03      /* ID register 2 (ro) */
105 #define   IDR2_OUILSB         0xfc00    /* OUI LSB */
106 #define   IDR2_MODEL          0x03f0    /* vendor model */
107 #define   IDR2_REV  0x000f    /* vendor revision */
108 
109 #define   MII_OUI(id1, id2)   (((id1) << 6) | ((id2) >> 10))
110 #define   MII_MODEL(id2)                (((id2) & IDR2_MODEL) >> 4)
111 #define   MII_REV(id2)                  ((id2) & IDR2_REV)
112 
113 #define   MII_ANAR  0x04      /* Autonegotiation advertisement (rw) */
114                     /* section 28.2.4.1 and 37.2.6.1 */
115 #define ANAR_NP               0x8000    /* Next page (ro) */
116 #define   ANAR_ACK  0x4000    /* link partner abilities acknowledged (ro) */
117 #define ANAR_RF               0x2000    /* remote fault (ro) */
118 #define   ANAR_FC             0x0400    /* local device supports PAUSE */
119 #define ANAR_T4               0x0200    /* local device supports 100bT4 */
120 #define ANAR_TX_FD  0x0100    /* local device supports 100bTx FD */
121 #define ANAR_TX               0x0080    /* local device supports 100bTx */
122 #define ANAR_10_FD  0x0040    /* local device supports 10bT FD */
123 #define ANAR_10               0x0020    /* local device supports 10bT */
124 #define   ANAR_CSMA 0x0001    /* protocol selector CSMA/CD */
125 #define ANAR_PAUSE_NONE         (0 << 10)
126 #define ANAR_PAUSE_SYM          (1 << 10)
127 #define ANAR_PAUSE_ASYM         (2 << 10)
128 #define ANAR_PAUSE_TOWARDS      (3 << 10)
129 
130 #define   ANAR_X_FD 0x0020    /* local device supports 1000BASE-X FD */
131 #define   ANAR_X_HD 0x0040    /* local device supports 1000BASE-X HD */
132 #define   ANAR_X_PAUSE_NONE   (0 << 10)
133 #define   ANAR_X_PAUSE_SYM    (1 << 10)
134 #define   ANAR_X_PAUSE_ASYM   (2 << 10)
135 #define   ANAR_X_PAUSE_TOWARDS          (3 << 10)
136 
137 #define   MII_ANLPAR          0x05      /* Autonegotiation lnk partner abilities (rw) */
138                     /* section 28.2.4.1 and 37.2.6.1 */
139 #define ANLPAR_NP   0x8000    /* Next page (ro) */
140 #define   ANLPAR_ACK          0x4000    /* link partner accepted ACK (ro) */
141 #define ANLPAR_RF   0x2000    /* remote fault (ro) */
142 #define   ANLPAR_FC 0x0400    /* link partner supports PAUSE */
143 #define ANLPAR_T4   0x0200    /* link partner supports 100bT4 */
144 #define ANLPAR_TX_FD          0x0100    /* link partner supports 100bTx FD */
145 #define ANLPAR_TX   0x0080    /* link partner supports 100bTx */
146 #define ANLPAR_10_FD          0x0040    /* link partner supports 10bT FD */
147 #define ANLPAR_10   0x0020    /* link partner supports 10bT */
148 #define   ANLPAR_CSMA         0x0001    /* protocol selector CSMA/CD */
149 
150 #define   ANLPAR_X_FD         0x0020    /* local device supports 1000BASE-X FD */
151 #define   ANLPAR_X_HD         0x0040    /* local device supports 1000BASE-X HD */
152 #define   ANLPAR_X_PAUSE_MASK (3 << 10)
153 #define   ANLPAR_X_PAUSE_NONE (0 << 10)
154 #define   ANLPAR_X_PAUSE_SYM  (1 << 10)
155 #define   ANLPAR_X_PAUSE_ASYM (2 << 10)
156 #define   ANLPAR_X_PAUSE_TOWARDS        (3 << 10)
157 
158 #define   MII_ANER  0x06      /* Autonegotiation expansion (ro) */
159                     /* section 28.2.4.1 and 37.2.6.1 */
160 #define ANER_MLF    0x0010    /* multiple link detection fault */
161 #define ANER_LPNP   0x0008    /* link parter next page-able */
162 #define ANER_NP               0x0004    /* next page-able */
163 #define ANER_PAGE_RX          0x0002    /* Page received */
164 #define ANER_LPAN   0x0001    /* link parter autoneg-able */
165 
166 #define   MII_ANNP  0x07      /* Autonegotiation next page */
167                     /* section 28.2.4.1 and 37.2.6.1 */
168 
169 #define   MII_ANLPRNP         0x08      /* Autonegotiation link partner rx next page */
170                     /* section 32.5.1 and 37.2.6.1 */
171 
172                               /* This is also the 1000baseT control register */
173 #define   MII_100T2CR         0x09      /* 100base-T2 control register */
174 #define   GTCR_TEST_MASK      0xe000    /* see 802.3ab ss. 40.6.1.1.2 */
175 #define   GTCR_MAN_MS         0x1000    /* enable manual master/slave control */
176 #define   GTCR_ADV_MS         0x0800    /* 1 = adv. master, 0 = adv. slave */
177 #define   GTCR_PORT_TYPE      0x0400    /* 1 = DCE, 0 = DTE (NIC) */
178 #define   GTCR_ADV_1000TFDX 0x0200 /* adv. 1000baseT FDX */
179 #define   GTCR_ADV_1000THDX 0x0100 /* adv. 1000baseT HDX */
180 
181                               /* This is also the 1000baseT status register */
182 #define   MII_100T2SR         0x0a      /* 100base-T2 status register */
183 #define   GTSR_MAN_MS_FLT     0x8000    /* master/slave config fault */
184 #define   GTSR_MS_RES         0x4000    /* result: 1 = master, 0 = slave */
185 #define   GTSR_LRS  0x2000    /* local rx status, 1 = ok */
186 #define   GTSR_RRS  0x1000    /* remove rx status, 1 = ok */
187 #define   GTSR_LP_1000TFDX 0x0800       /* link partner 1000baseT FDX capable */
188 #define   GTSR_LP_1000THDX 0x0400       /* link partner 1000baseT HDX capable */
189 #define   GTSR_LP_ASM_DIR     0x0200    /* link partner asym. pause dir. capable */
190 #define   GTSR_IDLE_ERR       0x00ff    /* IDLE error count */
191 
192 #define   MII_EXTSR 0x0f      /* Extended status register */
193 #define   EXTSR_1000XFDX      0x8000    /* 1000X full-duplex capable */
194 #define   EXTSR_1000XHDX      0x4000    /* 1000X half-duplex capable */
195 #define   EXTSR_1000TFDX      0x2000    /* 1000T full-duplex capable */
196 #define   EXTSR_1000THDX      0x1000    /* 1000T half-duplex capable */
197 
198 #define   EXTSR_MEDIAMASK     (EXTSR_1000XFDX | EXTSR_1000XHDX | \
199                                EXTSR_1000TFDX | EXTSR_1000THDX)
200 
201 #endif /* _DEV_MII_MII_H_ */
202