The 8169 and mii from gpxe now build
[akaros.git] / kern / include / mii.h
1 /*
2  * linux/mii.h: definitions for MII-compatible transceivers
3  * Originally drivers/net/sunhme.h.
4  *
5  * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
6  *
7  * Copied Form Linux 2.4.25 an unneeded items removed by:
8  * Timothy Legge (timlegge at etherboot dot org)
9  *
10  * 03/26/2004
11  */
12
13 #ifndef _MII_H_
14 #define _MII_H_
15
16 /* Generic MII registers. */
17
18 #define MII_BMCR            0x00        /* Basic mode control register */
19 #define MII_BMSR            0x01        /* Basic mode status register  */
20 #define MII_PHYSID1         0x02        /* PHYS ID 1                   */
21 #define MII_PHYSID2         0x03        /* PHYS ID 2                   */
22 #define MII_ADVERTISE       0x04        /* Advertisement control reg   */
23 #define MII_LPA             0x05        /* Link partner ability reg    */
24 #define MII_EXPANSION       0x06        /* Expansion register          */
25 #define MII_CTRL1000        0x09        /* 1000BASE-T control          */
26 #define MII_STAT1000        0x0a        /* 1000BASE-T status           */
27 #define MII_ESTATUS         0x0f        /* Extended Status */
28 #define MII_DCOUNTER        0x12        /* Disconnect counter          */
29 #define MII_FCSCOUNTER      0x13        /* False carrier counter       */
30 #define MII_NWAYTEST        0x14        /* N-way auto-neg test reg     */
31 #define MII_RERRCOUNTER     0x15        /* Receive error counter       */
32 #define MII_SREVISION       0x16        /* Silicon revision            */
33 #define MII_RESV1           0x17        /* Reserved...                 */
34 #define MII_LBRERROR        0x18        /* Lpback, rx, bypass error    */
35 #define MII_PHYADDR         0x19        /* PHY address                 */
36 #define MII_RESV2           0x1a        /* Reserved...                 */
37 #define MII_TPISTATUS       0x1b        /* TPI status for 10mbps       */
38 #define MII_NCONFIG         0x1c        /* Network interface config    */
39
40 /* Basic mode control register. */
41 #define BMCR_RESV               0x003f  /* Unused...                   */
42 #define BMCR_SPEED1000          0x0040  /* MSB of Speed (1000)         */
43 #define BMCR_CTST               0x0080  /* Collision test              */
44 #define BMCR_FULLDPLX           0x0100  /* Full duplex                 */
45 #define BMCR_ANRESTART          0x0200  /* Auto negotiation restart    */
46 #define BMCR_ISOLATE            0x0400  /* Disconnect DP83840 from MII */
47 #define BMCR_PDOWN              0x0800  /* Powerdown the DP83840       */
48 #define BMCR_ANENABLE           0x1000  /* Enable auto negotiation     */
49 #define BMCR_SPEED100           0x2000  /* Select 100Mbps              */
50 #define BMCR_LOOPBACK           0x4000  /* TXD loopback bits           */
51 #define BMCR_RESET              0x8000  /* Reset the DP83840           */
52
53 /* Basic mode status register. */
54 #define BMSR_ERCAP              0x0001  /* Ext-reg capability          */
55 #define BMSR_JCD                0x0002  /* Jabber detected             */
56 #define BMSR_LSTATUS            0x0004  /* Link status                 */
57 #define BMSR_ANEGCAPABLE        0x0008  /* Able to do auto-negotiation */
58 #define BMSR_RFAULT             0x0010  /* Remote fault detected       */
59 #define BMSR_ANEGCOMPLETE       0x0020  /* Auto-negotiation complete   */
60 #define BMSR_RESV               0x00c0  /* Unused...                   */
61 #define BMSR_ESTATEN            0x0100  /* Extended Status in R15 */
62 #define BMSR_100HALF2           0x0200  /* Can do 100BASE-T2 HDX */
63 #define BMSR_100FULL2           0x0400  /* Can do 100BASE-T2 FDX */
64 #define BMSR_10HALF             0x0800  /* Can do 10mbps, half-duplex  */
65 #define BMSR_10FULL             0x1000  /* Can do 10mbps, full-duplex  */
66 #define BMSR_100HALF            0x2000  /* Can do 100mbps, half-duplex */
67 #define BMSR_100FULL            0x4000  /* Can do 100mbps, full-duplex */
68 #define BMSR_100BASE4           0x8000  /* Can do 100mbps, 4k packets  */
69
70 /* Advertisement control register. */
71 #define ADVERTISE_SLCT          0x001f  /* Selector bits               */
72 #define ADVERTISE_CSMA          0x0001  /* Only selector supported     */
73 #define ADVERTISE_10HALF        0x0020  /* Try for 10mbps half-duplex  */
74 #define ADVERTISE_1000XFULL     0x0020  /* Try for 1000BASE-X full-duplex */
75 #define ADVERTISE_10FULL        0x0040  /* Try for 10mbps full-duplex  */
76 #define ADVERTISE_1000XHALF     0x0040  /* Try for 1000BASE-X half-duplex */
77 #define ADVERTISE_100HALF       0x0080  /* Try for 100mbps half-duplex */
78 #define ADVERTISE_1000XPAUSE    0x0080  /* Try for 1000BASE-X pause    */
79 #define ADVERTISE_100FULL       0x0100  /* Try for 100mbps full-duplex */
80 #define ADVERTISE_1000XPSE_ASYM 0x0100  /* Try for 1000BASE-X asym pause */
81 #define ADVERTISE_100BASE4      0x0200  /* Try for 100mbps 4k packets  */
82 #define ADVERTISE_PAUSE_CAP     0x0400  /* Try for pause               */
83 #define ADVERTISE_PAUSE_ASYM    0x0800  /* Try for asymetric pause     */
84 #define ADVERTISE_RESV          0x1000  /* Unused...                   */
85 #define ADVERTISE_RFAULT        0x2000  /* Say we can detect faults    */
86 #define ADVERTISE_LPACK         0x4000  /* Ack link partners response  */
87 #define ADVERTISE_NPAGE         0x8000  /* Next page bit               */
88
89 #define ADVERTISE_FULL (ADVERTISE_100FULL | ADVERTISE_10FULL | \
90                         ADVERTISE_CSMA)
91 #define ADVERTISE_ALL (ADVERTISE_10HALF | ADVERTISE_10FULL | \
92                       ADVERTISE_100HALF | ADVERTISE_100FULL)
93
94 /* Link partner ability register. */
95 #define LPA_SLCT                0x001f  /* Same as advertise selector  */
96 #define LPA_10HALF              0x0020  /* Can do 10mbps half-duplex   */
97 #define LPA_1000XFULL           0x0020  /* Can do 1000BASE-X full-duplex */
98 #define LPA_10FULL              0x0040  /* Can do 10mbps full-duplex   */
99 #define LPA_1000XHALF           0x0040  /* Can do 1000BASE-X half-duplex */
100 #define LPA_100HALF             0x0080  /* Can do 100mbps half-duplex  */
101 #define LPA_1000XPAUSE          0x0080  /* Can do 1000BASE-X pause     */
102 #define LPA_100FULL             0x0100  /* Can do 100mbps full-duplex  */
103 #define LPA_1000XPAUSE_ASYM     0x0100  /* Can do 1000BASE-X pause asym*/
104 #define LPA_100BASE4            0x0200  /* Can do 100mbps 4k packets   */
105 #define LPA_PAUSE_CAP           0x0400  /* Can pause                   */
106 #define LPA_PAUSE_ASYM          0x0800  /* Can pause asymetrically     */
107 #define LPA_RESV                0x1000  /* Unused...                   */
108 #define LPA_RFAULT              0x2000  /* Link partner faulted        */
109 #define LPA_LPACK               0x4000  /* Link partner acked us       */
110 #define LPA_NPAGE               0x8000  /* Next page bit               */
111
112 #define LPA_DUPLEX            (LPA_10FULL | LPA_100FULL)
113 #define LPA_100                       (LPA_100FULL | LPA_100HALF | LPA_100BASE4)
114
115 /* Expansion register for auto-negotiation. */
116 #define EXPANSION_NWAY          0x0001  /* Can do N-way auto-nego      */
117 #define EXPANSION_LCWP          0x0002  /* Got new RX page code word   */
118 #define EXPANSION_ENABLENPAGE   0x0004  /* This enables npage words    */
119 #define EXPANSION_NPCAPABLE     0x0008  /* Link partner supports npage */
120 #define EXPANSION_MFAULTS       0x0010  /* Multiple faults detected    */
121 #define EXPANSION_RESV          0xffe0  /* Unused...                   */
122
123 #define ESTATUS_1000_TFULL      0x2000  /* Can do 1000BT Full */
124 #define ESTATUS_1000_THALF      0x1000  /* Can do 1000BT Half */
125
126 /* N-way test register. */
127 #define NWAYTEST_RESV1          0x00ff  /* Unused...                   */
128 #define NWAYTEST_LOOPBACK       0x0100  /* Enable loopback for N-way   */
129 #define NWAYTEST_RESV2          0xfe00  /* Unused...                   */
130
131 /* 1000BASE-T Control register */
132 #define ADVERTISE_1000FULL      0x0200  /* Advertise 1000BASE-T full duplex */
133 #define ADVERTISE_1000HALF      0x0100  /* Advertise 1000BASE-T half duplex */
134
135 /* 1000BASE-T Status register */
136 #define LPA_1000LOCALRXOK       0x2000  /* Link partner local receiver status */
137 #define LPA_1000REMRXOK         0x1000  /* Link partner remote receiver status */
138 #define LPA_1000FULL            0x0800  /* Link partner 1000BASE-T full duplex */
139 #define LPA_1000HALF            0x0400  /* Link partner 1000BASE-T half duplex */
140
141 struct mii_if_info {
142         int phy_id;
143         int advertising;
144         int phy_id_mask;
145         int reg_num_mask;
146
147         unsigned int full_duplex : 1;   /* is full duplex? */
148         unsigned int force_media : 1;   /* is autoneg. disabled? */
149         unsigned int supports_gmii : 1; /* are GMII registers supported? */
150
151         struct net_device *dev;
152         int (*mdio_read) (struct net_device *dev, int phy_id, int location);
153         void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
154 };
155
156
157 extern int mii_link_ok (struct mii_if_info *mii);
158 extern void mii_check_link (struct mii_if_info *mii);
159 extern unsigned int mii_check_media (struct mii_if_info *mii,
160                                        unsigned int ok_to_print,
161                                        unsigned int init_media);
162
163
164 /**
165  * mii_nway_result
166  * @negotiated: value of MII ANAR and'd with ANLPAR
167  *
168  * Given a set of MII abilities, check each bit and returns the
169  * currently supported media, in the priority order defined by
170  * IEEE 802.3u.  We use LPA_xxx constants but note this is not the
171  * value of LPA solely, as described above.
172  *
173  * The one exception to IEEE 802.3u is that 100baseT4 is placed
174  * between 100T-full and 100T-half.  If your phy does not support
175  * 100T4 this is fine.  If your phy places 100T4 elsewhere in the
176  * priority order, you will need to roll your own function.
177  */
178 static inline unsigned int mii_nway_result (unsigned int negotiated)
179 {
180         unsigned int ret;
181
182         if (negotiated & LPA_100FULL)
183                 ret = LPA_100FULL;
184         else if (negotiated & LPA_100BASE4)
185                 ret = LPA_100BASE4;
186         else if (negotiated & LPA_100HALF)
187                 ret = LPA_100HALF;
188         else if (negotiated & LPA_10FULL)
189                 ret = LPA_10FULL;
190         else
191                 ret = LPA_10HALF;
192
193         return ret;
194 }
195
196 /**
197  * mii_duplex
198  * @duplex_lock: Non-zero if duplex is locked at full
199  * @negotiated: value of MII ANAR and'd with ANLPAR
200  *
201  * A small helper function for a common case.  Returns one
202  * if the media is operating or locked at full duplex, and
203  * returns zero otherwise.
204  */
205 static inline unsigned int mii_duplex (unsigned int duplex_lock,
206                                        unsigned int negotiated)
207 {
208         if (duplex_lock)
209                 return 1;
210         if (mii_nway_result(negotiated) & LPA_DUPLEX)
211                 return 1;
212         return 0;
213 }
214
215 #endif