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
8 #ifndef __LINUX_MII_H__
9 #define __LINUX_MII_H__
10
11 #include <linux/types.h>
12 #include <linux/ethtool.h>
13
14 /* Generic MII registers. */
15 #define MII_BMCR 0x00 /* Basic mode control register */
16 #define MII_BMSR 0x01 /* Basic mode status register */
17 #define MII_PHYSID1 0x02 /* PHYS ID 1 */
18 #define MII_PHYSID2 0x03 /* PHYS ID 2 */
19 #define MII_ADVERTISE 0x04 /* Advertisement control reg */
20 #define MII_LPA 0x05 /* Link partner ability reg */
21 #define MII_EXPANSION 0x06 /* Expansion register */
22 #define MII_CTRL1000 0x09 /* 1000BASE-T control */
23 #define MII_STAT1000 0x0a /* 1000BASE-T status */
24 #define MII_ESTATUS 0x0f /* Extended Status */
25 #define MII_DCOUNTER 0x12 /* Disconnect counter */
26 #define MII_FCSCOUNTER 0x13 /* False carrier counter */
27 #define MII_NWAYTEST 0x14 /* N-way auto-neg test reg */
28 #define MII_RERRCOUNTER 0x15 /* Receive error counter */
29 #define MII_SREVISION 0x16 /* Silicon revision */
30 #define MII_RESV1 0x17 /* Reserved... */
31 #define MII_LBRERROR 0x18 /* Lpback, rx, bypass error */
32 #define MII_PHYADDR 0x19 /* PHY address */
33 #define MII_RESV2 0x1a /* Reserved... */
34 #define MII_TPISTATUS 0x1b /* TPI status for 10mbps */
35 #define MII_NCONFIG 0x1c /* Network interface config */
36
37 /* Basic mode control register. */
38 #define BMCR_RESV 0x003f /* Unused... */
39 #define BMCR_SPEED1000 0x0040 /* MSB of Speed (1000) */
40 #define BMCR_CTST 0x0080 /* Collision test */
41 #define BMCR_FULLDPLX 0x0100 /* Full duplex */
42 #define BMCR_ANRESTART 0x0200 /* Auto negotiation restart */
43 #define BMCR_ISOLATE 0x0400 /* Isolate data paths from MII */
44 #define BMCR_PDOWN 0x0800 /* Enable low power state */
45 #define BMCR_ANENABLE 0x1000 /* Enable auto negotiation */
46 #define BMCR_SPEED100 0x2000 /* Select 100Mbps */
47 #define BMCR_LOOPBACK 0x4000 /* TXD loopback bits */
48 #define BMCR_RESET 0x8000 /* Reset to default state */
49
50 /* Basic mode status register. */
51 #define BMSR_ERCAP 0x0001 /* Ext-reg capability */
52 #define BMSR_JCD 0x0002 /* Jabber detected */
53 #define BMSR_LSTATUS 0x0004 /* Link status */
54 #define BMSR_ANEGCAPABLE 0x0008 /* Able to do auto-negotiation */
55 #define BMSR_RFAULT 0x0010 /* Remote fault detected */
56 #define BMSR_ANEGCOMPLETE 0x0020 /* Auto-negotiation complete */
57 #define BMSR_RESV 0x00c0 /* Unused... */
58 #define BMSR_ESTATEN 0x0100 /* Extended Status in R15 */
59 #define BMSR_100HALF2 0x0200 /* Can do 100BASE-T2 HDX */
60 #define BMSR_100FULL2 0x0400 /* Can do 100BASE-T2 FDX */
61 #define BMSR_10HALF 0x0800 /* Can do 10mbps, half-duplex */
62 #define BMSR_10FULL 0x1000 /* Can do 10mbps, full-duplex */
63 #define BMSR_100HALF 0x2000 /* Can do 100mbps, half-duplex */
64 #define BMSR_100FULL 0x4000 /* Can do 100mbps, full-duplex */
65 #define BMSR_100BASE4 0x8000 /* Can do 100mbps, 4k packets */
66
67 /* Advertisement control register. */
68 #define ADVERTISE_SLCT 0x001f /* Selector bits */
69 #define ADVERTISE_CSMA 0x0001 /* Only selector supported */
70 #define ADVERTISE_10HALF 0x0020 /* Try for 10mbps half-duplex */
71 #define ADVERTISE_1000XFULL 0x0020 /* Try for 1000BASE-X full-duplex */
72 #define ADVERTISE_10FULL 0x0040 /* Try for 10mbps full-duplex */
73 #define ADVERTISE_1000XHALF 0x0040 /* Try for 1000BASE-X half-duplex */
74 #define ADVERTISE_100HALF 0x0080 /* Try for 100mbps half-duplex */
75 #define ADVERTISE_1000XPAUSE 0x0080 /* Try for 1000BASE-X pause */
76 #define ADVERTISE_100FULL 0x0100 /* Try for 100mbps full-duplex */
77 #define ADVERTISE_1000XPSE_ASYM 0x0100 /* Try for 1000BASE-X asym pause */
78 #define ADVERTISE_100BASE4 0x0200 /* Try for 100mbps 4k packets */
79 #define ADVERTISE_PAUSE_CAP 0x0400 /* Try for pause */
80 #define ADVERTISE_PAUSE_ASYM 0x0800 /* Try for asymetric pause */
81 #define ADVERTISE_RESV 0x1000 /* Unused... */
82 #define ADVERTISE_RFAULT 0x2000 /* Say we can detect faults */
83 #define ADVERTISE_LPACK 0x4000 /* Ack link partners response */
84 #define ADVERTISE_NPAGE 0x8000 /* Next page bit */
85
86 #define ADVERTISE_FULL (ADVERTISE_100FULL | ADVERTISE_10FULL | \
87 ADVERTISE_CSMA)
88 #define ADVERTISE_ALL (ADVERTISE_10HALF | ADVERTISE_10FULL | \
89 ADVERTISE_100HALF | ADVERTISE_100FULL)
90
91 /* Link partner ability register. */
92 #define LPA_SLCT 0x001f /* Same as advertise selector */
93 #define LPA_10HALF 0x0020 /* Can do 10mbps half-duplex */
94 #define LPA_1000XFULL 0x0020 /* Can do 1000BASE-X full-duplex */
95 #define LPA_10FULL 0x0040 /* Can do 10mbps full-duplex */
96 #define LPA_1000XHALF 0x0040 /* Can do 1000BASE-X half-duplex */
97 #define LPA_100HALF 0x0080 /* Can do 100mbps half-duplex */
98 #define LPA_1000XPAUSE 0x0080 /* Can do 1000BASE-X pause */
99 #define LPA_100FULL 0x0100 /* Can do 100mbps full-duplex */
100 #define LPA_1000XPAUSE_ASYM 0x0100 /* Can do 1000BASE-X pause asym*/
101 #define LPA_100BASE4 0x0200 /* Can do 100mbps 4k packets */
102 #define LPA_PAUSE_CAP 0x0400 /* Can pause */
103 #define LPA_PAUSE_ASYM 0x0800 /* Can pause asymetrically */
104 #define LPA_RESV 0x1000 /* Unused... */
105 #define LPA_RFAULT 0x2000 /* Link partner faulted */
106 #define LPA_LPACK 0x4000 /* Link partner acked us */
107 #define LPA_NPAGE 0x8000 /* Next page bit */
108
109 #define LPA_DUPLEX (LPA_10FULL | LPA_100FULL)
110 #define LPA_100 (LPA_100FULL | LPA_100HALF | LPA_100BASE4)
111
112 /* Expansion register for auto-negotiation. */
113 #define EXPANSION_NWAY 0x0001 /* Can do N-way auto-nego */
114 #define EXPANSION_LCWP 0x0002 /* Got new RX page code word */
115 #define EXPANSION_ENABLENPAGE 0x0004 /* This enables npage words */
116 #define EXPANSION_NPCAPABLE 0x0008 /* Link partner supports npage */
117 #define EXPANSION_MFAULTS 0x0010 /* Multiple faults detected */
118 #define EXPANSION_RESV 0xffe0 /* Unused... */
119
120 #define ESTATUS_1000_TFULL 0x2000 /* Can do 1000BT Full */
121 #define ESTATUS_1000_THALF 0x1000 /* Can do 1000BT Half */
122
123 /* N-way test register. */
124 #define NWAYTEST_RESV1 0x00ff /* Unused... */
125 #define NWAYTEST_LOOPBACK 0x0100 /* Enable loopback for N-way */
126 #define NWAYTEST_RESV2 0xfe00 /* Unused... */
127
128 /* 1000BASE-T Control register */
129 #define ADVERTISE_1000FULL 0x0200 /* Advertise 1000BASE-T full duplex */
130 #define ADVERTISE_1000HALF 0x0100 /* Advertise 1000BASE-T half duplex */
131 #define CTL1000_AS_MASTER 0x0800
132 #define CTL1000_ENABLE_MASTER 0x1000
133
134 /* 1000BASE-T Status register */
135 #define LPA_1000LOCALRXOK 0x2000 /* Link partner local receiver status */
136 #define LPA_1000REMRXOK 0x1000 /* Link partner remote receiver status */
137 #define LPA_1000FULL 0x0800 /* Link partner 1000BASE-T full duplex */
138 #define LPA_1000HALF 0x0400 /* Link partner 1000BASE-T half duplex */
139
140 /* Flow control flags */
141 #define FLOW_CTRL_TX 0x01
142 #define FLOW_CTRL_RX 0x02
143
144 /* This structure is used in all SIOCxMIIxxx ioctl calls */
145 struct mii_ioctl_data {
146 __u16 phy_id;
147 __u16 reg_num;
148 __u16 val_in;
149 __u16 val_out;
150 };
151
152 #ifdef __KERNEL__
153
154 #include <linux/if.h>
155
156 struct ethtool_cmd;
157
158 struct mii_if_info {
159 int phy_id;
160 int advertising;
161 int phy_id_mask;
162 int reg_num_mask;
163
164 unsigned int full_duplex : 1; /* is full duplex? */
165 unsigned int force_media : 1; /* is autoneg. disabled? */
166 unsigned int supports_gmii : 1; /* are GMII registers supported? */
167
168 struct net_device *dev;
169 int (*mdio_read) (struct net_device *dev, int phy_id, int location);
170 void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
171 };
172
173 extern int mii_link_ok (struct mii_if_info *mii);
174 extern int mii_nway_restart (struct mii_if_info *mii);
175 extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
176 extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
177 extern int mii_check_gmii_support(struct mii_if_info *mii);
178 extern void mii_check_link (struct mii_if_info *mii);
179 extern unsigned int mii_check_media (struct mii_if_info *mii,
180 unsigned int ok_to_print,
181 unsigned int init_media);
182 extern int generic_mii_ioctl(struct mii_if_info *mii_if,
183 struct mii_ioctl_data *mii_data, int cmd,
184 unsigned int *duplex_changed);
185
186
if_mii(struct ifreq * rq)187 static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
188 {
189 return (struct mii_ioctl_data *) &rq->ifr_ifru;
190 }
191
192 /**
193 * mii_nway_result
194 * @negotiated: value of MII ANAR and'd with ANLPAR
195 *
196 * Given a set of MII abilities, check each bit and returns the
197 * currently supported media, in the priority order defined by
198 * IEEE 802.3u. We use LPA_xxx constants but note this is not the
199 * value of LPA solely, as described above.
200 *
201 * The one exception to IEEE 802.3u is that 100baseT4 is placed
202 * between 100T-full and 100T-half. If your phy does not support
203 * 100T4 this is fine. If your phy places 100T4 elsewhere in the
204 * priority order, you will need to roll your own function.
205 */
mii_nway_result(unsigned int negotiated)206 static inline unsigned int mii_nway_result (unsigned int negotiated)
207 {
208 unsigned int ret;
209
210 if (negotiated & LPA_100FULL)
211 ret = LPA_100FULL;
212 else if (negotiated & LPA_100BASE4)
213 ret = LPA_100BASE4;
214 else if (negotiated & LPA_100HALF)
215 ret = LPA_100HALF;
216 else if (negotiated & LPA_10FULL)
217 ret = LPA_10FULL;
218 else
219 ret = LPA_10HALF;
220
221 return ret;
222 }
223
224 /**
225 * mii_duplex
226 * @duplex_lock: Non-zero if duplex is locked at full
227 * @negotiated: value of MII ANAR and'd with ANLPAR
228 *
229 * A small helper function for a common case. Returns one
230 * if the media is operating or locked at full duplex, and
231 * returns zero otherwise.
232 */
mii_duplex(unsigned int duplex_lock,unsigned int negotiated)233 static inline unsigned int mii_duplex (unsigned int duplex_lock,
234 unsigned int negotiated)
235 {
236 if (duplex_lock)
237 return 1;
238 if (mii_nway_result(negotiated) & LPA_DUPLEX)
239 return 1;
240 return 0;
241 }
242
243 /**
244 * ethtool_adv_to_mii_adv_t
245 * @ethadv: the ethtool advertisement settings
246 *
247 * A small helper function that translates ethtool advertisement
248 * settings to phy autonegotiation advertisements for the
249 * MII_ADVERTISE register.
250 */
ethtool_adv_to_mii_adv_t(u32 ethadv)251 static inline u32 ethtool_adv_to_mii_adv_t(u32 ethadv)
252 {
253 u32 result = 0;
254
255 if (ethadv & ADVERTISED_10baseT_Half)
256 result |= ADVERTISE_10HALF;
257 if (ethadv & ADVERTISED_10baseT_Full)
258 result |= ADVERTISE_10FULL;
259 if (ethadv & ADVERTISED_100baseT_Half)
260 result |= ADVERTISE_100HALF;
261 if (ethadv & ADVERTISED_100baseT_Full)
262 result |= ADVERTISE_100FULL;
263 if (ethadv & ADVERTISED_Pause)
264 result |= ADVERTISE_PAUSE_CAP;
265 if (ethadv & ADVERTISED_Asym_Pause)
266 result |= ADVERTISE_PAUSE_ASYM;
267
268 return result;
269 }
270
271 /**
272 * mii_adv_to_ethtool_adv_t
273 * @adv: value of the MII_ADVERTISE register
274 *
275 * A small helper function that translates MII_ADVERTISE bits
276 * to ethtool advertisement settings.
277 */
mii_adv_to_ethtool_adv_t(u32 adv)278 static inline u32 mii_adv_to_ethtool_adv_t(u32 adv)
279 {
280 u32 result = 0;
281
282 if (adv & ADVERTISE_10HALF)
283 result |= ADVERTISED_10baseT_Half;
284 if (adv & ADVERTISE_10FULL)
285 result |= ADVERTISED_10baseT_Full;
286 if (adv & ADVERTISE_100HALF)
287 result |= ADVERTISED_100baseT_Half;
288 if (adv & ADVERTISE_100FULL)
289 result |= ADVERTISED_100baseT_Full;
290 if (adv & ADVERTISE_PAUSE_CAP)
291 result |= ADVERTISED_Pause;
292 if (adv & ADVERTISE_PAUSE_ASYM)
293 result |= ADVERTISED_Asym_Pause;
294
295 return result;
296 }
297
298 /**
299 * ethtool_adv_to_mii_ctrl1000_t
300 * @ethadv: the ethtool advertisement settings
301 *
302 * A small helper function that translates ethtool advertisement
303 * settings to phy autonegotiation advertisements for the
304 * MII_CTRL1000 register when in 1000T mode.
305 */
ethtool_adv_to_mii_ctrl1000_t(u32 ethadv)306 static inline u32 ethtool_adv_to_mii_ctrl1000_t(u32 ethadv)
307 {
308 u32 result = 0;
309
310 if (ethadv & ADVERTISED_1000baseT_Half)
311 result |= ADVERTISE_1000HALF;
312 if (ethadv & ADVERTISED_1000baseT_Full)
313 result |= ADVERTISE_1000FULL;
314
315 return result;
316 }
317
318 /**
319 * mii_ctrl1000_to_ethtool_adv_t
320 * @adv: value of the MII_CTRL1000 register
321 *
322 * A small helper function that translates MII_CTRL1000
323 * bits, when in 1000Base-T mode, to ethtool
324 * advertisement settings.
325 */
mii_ctrl1000_to_ethtool_adv_t(u32 adv)326 static inline u32 mii_ctrl1000_to_ethtool_adv_t(u32 adv)
327 {
328 u32 result = 0;
329
330 if (adv & ADVERTISE_1000HALF)
331 result |= ADVERTISED_1000baseT_Half;
332 if (adv & ADVERTISE_1000FULL)
333 result |= ADVERTISED_1000baseT_Full;
334
335 return result;
336 }
337
338 /**
339 * mii_lpa_to_ethtool_lpa_t
340 * @adv: value of the MII_LPA register
341 *
342 * A small helper function that translates MII_LPA
343 * bits, when in 1000Base-T mode, to ethtool
344 * LP advertisement settings.
345 */
mii_lpa_to_ethtool_lpa_t(u32 lpa)346 static inline u32 mii_lpa_to_ethtool_lpa_t(u32 lpa)
347 {
348 u32 result = 0;
349
350 if (lpa & LPA_LPACK)
351 result |= ADVERTISED_Autoneg;
352
353 return result | mii_adv_to_ethtool_adv_t(lpa);
354 }
355
356 /**
357 * mii_stat1000_to_ethtool_lpa_t
358 * @adv: value of the MII_STAT1000 register
359 *
360 * A small helper function that translates MII_STAT1000
361 * bits, when in 1000Base-T mode, to ethtool
362 * advertisement settings.
363 */
mii_stat1000_to_ethtool_lpa_t(u32 lpa)364 static inline u32 mii_stat1000_to_ethtool_lpa_t(u32 lpa)
365 {
366 u32 result = 0;
367
368 if (lpa & LPA_1000HALF)
369 result |= ADVERTISED_1000baseT_Half;
370 if (lpa & LPA_1000FULL)
371 result |= ADVERTISED_1000baseT_Full;
372
373 return result;
374 }
375
376 /**
377 * ethtool_adv_to_mii_adv_x
378 * @ethadv: the ethtool advertisement settings
379 *
380 * A small helper function that translates ethtool advertisement
381 * settings to phy autonegotiation advertisements for the
382 * MII_CTRL1000 register when in 1000Base-X mode.
383 */
ethtool_adv_to_mii_adv_x(u32 ethadv)384 static inline u32 ethtool_adv_to_mii_adv_x(u32 ethadv)
385 {
386 u32 result = 0;
387
388 if (ethadv & ADVERTISED_1000baseT_Half)
389 result |= ADVERTISE_1000XHALF;
390 if (ethadv & ADVERTISED_1000baseT_Full)
391 result |= ADVERTISE_1000XFULL;
392 if (ethadv & ADVERTISED_Pause)
393 result |= ADVERTISE_1000XPAUSE;
394 if (ethadv & ADVERTISED_Asym_Pause)
395 result |= ADVERTISE_1000XPSE_ASYM;
396
397 return result;
398 }
399
400 /**
401 * mii_adv_to_ethtool_adv_x
402 * @adv: value of the MII_CTRL1000 register
403 *
404 * A small helper function that translates MII_CTRL1000
405 * bits, when in 1000Base-X mode, to ethtool
406 * advertisement settings.
407 */
mii_adv_to_ethtool_adv_x(u32 adv)408 static inline u32 mii_adv_to_ethtool_adv_x(u32 adv)
409 {
410 u32 result = 0;
411
412 if (adv & ADVERTISE_1000XHALF)
413 result |= ADVERTISED_1000baseT_Half;
414 if (adv & ADVERTISE_1000XFULL)
415 result |= ADVERTISED_1000baseT_Full;
416 if (adv & ADVERTISE_1000XPAUSE)
417 result |= ADVERTISED_Pause;
418 if (adv & ADVERTISE_1000XPSE_ASYM)
419 result |= ADVERTISED_Asym_Pause;
420
421 return result;
422 }
423
424 /**
425 * mii_lpa_to_ethtool_lpa_x
426 * @adv: value of the MII_LPA register
427 *
428 * A small helper function that translates MII_LPA
429 * bits, when in 1000Base-X mode, to ethtool
430 * LP advertisement settings.
431 */
mii_lpa_to_ethtool_lpa_x(u32 lpa)432 static inline u32 mii_lpa_to_ethtool_lpa_x(u32 lpa)
433 {
434 u32 result = 0;
435
436 if (lpa & LPA_LPACK)
437 result |= ADVERTISED_Autoneg;
438
439 return result | mii_adv_to_ethtool_adv_x(lpa);
440 }
441
442 /**
443 * mii_advertise_flowctrl - get flow control advertisement flags
444 * @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
445 */
mii_advertise_flowctrl(int cap)446 static inline u16 mii_advertise_flowctrl(int cap)
447 {
448 u16 adv = 0;
449
450 if (cap & FLOW_CTRL_RX)
451 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
452 if (cap & FLOW_CTRL_TX)
453 adv ^= ADVERTISE_PAUSE_ASYM;
454
455 return adv;
456 }
457
458 /**
459 * mii_resolve_flowctrl_fdx
460 * @lcladv: value of MII ADVERTISE register
461 * @rmtadv: value of MII LPA register
462 *
463 * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
464 */
mii_resolve_flowctrl_fdx(u16 lcladv,u16 rmtadv)465 static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
466 {
467 u8 cap = 0;
468
469 if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
470 cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
471 } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
472 if (lcladv & ADVERTISE_PAUSE_CAP)
473 cap = FLOW_CTRL_RX;
474 else if (rmtadv & ADVERTISE_PAUSE_CAP)
475 cap = FLOW_CTRL_TX;
476 }
477
478 return cap;
479 }
480
481 #endif /* __KERNEL__ */
482 #endif /* __LINUX_MII_H__ */
483