1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/mii.h: definitions for MII-compatible transceivers
4 * Originally drivers/net/sunhme.h.
6 * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
8 #ifndef __LINUX_MII_H__
9 #define __LINUX_MII_H__
13 #include <linux/linkmode.h>
14 #include <uapi/linux/mii.h>
24 unsigned int full_duplex : 1; /* is full duplex? */
25 unsigned int force_media : 1; /* is autoneg. disabled? */
26 unsigned int supports_gmii : 1; /* are GMII registers supported? */
28 struct net_device *dev;
29 int (*mdio_read) (struct net_device *dev, int phy_id, int location);
30 void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
33 extern int mii_link_ok (struct mii_if_info *mii);
34 extern int mii_nway_restart (struct mii_if_info *mii);
35 extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
36 extern void mii_ethtool_get_link_ksettings(
37 struct mii_if_info *mii, struct ethtool_link_ksettings *cmd);
38 extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
39 extern int mii_ethtool_set_link_ksettings(
40 struct mii_if_info *mii, const struct ethtool_link_ksettings *cmd);
41 extern int mii_check_gmii_support(struct mii_if_info *mii);
42 extern void mii_check_link (struct mii_if_info *mii);
43 extern unsigned int mii_check_media (struct mii_if_info *mii,
44 unsigned int ok_to_print,
45 unsigned int init_media);
46 extern int generic_mii_ioctl(struct mii_if_info *mii_if,
47 struct mii_ioctl_data *mii_data, int cmd,
48 unsigned int *duplex_changed);
51 static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
53 return (struct mii_ioctl_data *) &rq->ifr_ifru;
58 * @negotiated: value of MII ANAR and'd with ANLPAR
60 * Given a set of MII abilities, check each bit and returns the
61 * currently supported media, in the priority order defined by
62 * IEEE 802.3u. We use LPA_xxx constants but note this is not the
63 * value of LPA solely, as described above.
65 * The one exception to IEEE 802.3u is that 100baseT4 is placed
66 * between 100T-full and 100T-half. If your phy does not support
67 * 100T4 this is fine. If your phy places 100T4 elsewhere in the
68 * priority order, you will need to roll your own function.
70 static inline unsigned int mii_nway_result (unsigned int negotiated)
74 if (negotiated & LPA_100FULL)
76 else if (negotiated & LPA_100BASE4)
78 else if (negotiated & LPA_100HALF)
80 else if (negotiated & LPA_10FULL)
90 * @duplex_lock: Non-zero if duplex is locked at full
91 * @negotiated: value of MII ANAR and'd with ANLPAR
93 * A small helper function for a common case. Returns one
94 * if the media is operating or locked at full duplex, and
95 * returns zero otherwise.
97 static inline unsigned int mii_duplex (unsigned int duplex_lock,
98 unsigned int negotiated)
102 if (mii_nway_result(negotiated) & LPA_DUPLEX)
108 * ethtool_adv_to_mii_adv_t
109 * @ethadv: the ethtool advertisement settings
111 * A small helper function that translates ethtool advertisement
112 * settings to phy autonegotiation advertisements for the
113 * MII_ADVERTISE register.
115 static inline u32 ethtool_adv_to_mii_adv_t(u32 ethadv)
119 if (ethadv & ADVERTISED_10baseT_Half)
120 result |= ADVERTISE_10HALF;
121 if (ethadv & ADVERTISED_10baseT_Full)
122 result |= ADVERTISE_10FULL;
123 if (ethadv & ADVERTISED_100baseT_Half)
124 result |= ADVERTISE_100HALF;
125 if (ethadv & ADVERTISED_100baseT_Full)
126 result |= ADVERTISE_100FULL;
127 if (ethadv & ADVERTISED_Pause)
128 result |= ADVERTISE_PAUSE_CAP;
129 if (ethadv & ADVERTISED_Asym_Pause)
130 result |= ADVERTISE_PAUSE_ASYM;
136 * linkmode_adv_to_mii_adv_t
137 * @advertising: the linkmode advertisement settings
139 * A small helper function that translates linkmode advertisement
140 * settings to phy autonegotiation advertisements for the
141 * MII_ADVERTISE register.
143 static inline u32 linkmode_adv_to_mii_adv_t(unsigned long *advertising)
147 if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, advertising))
148 result |= ADVERTISE_10HALF;
149 if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, advertising))
150 result |= ADVERTISE_10FULL;
151 if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, advertising))
152 result |= ADVERTISE_100HALF;
153 if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, advertising))
154 result |= ADVERTISE_100FULL;
155 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising))
156 result |= ADVERTISE_PAUSE_CAP;
157 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising))
158 result |= ADVERTISE_PAUSE_ASYM;
164 * mii_adv_to_ethtool_adv_t
165 * @adv: value of the MII_ADVERTISE register
167 * A small helper function that translates MII_ADVERTISE bits
168 * to ethtool advertisement settings.
170 static inline u32 mii_adv_to_ethtool_adv_t(u32 adv)
174 if (adv & ADVERTISE_10HALF)
175 result |= ADVERTISED_10baseT_Half;
176 if (adv & ADVERTISE_10FULL)
177 result |= ADVERTISED_10baseT_Full;
178 if (adv & ADVERTISE_100HALF)
179 result |= ADVERTISED_100baseT_Half;
180 if (adv & ADVERTISE_100FULL)
181 result |= ADVERTISED_100baseT_Full;
182 if (adv & ADVERTISE_PAUSE_CAP)
183 result |= ADVERTISED_Pause;
184 if (adv & ADVERTISE_PAUSE_ASYM)
185 result |= ADVERTISED_Asym_Pause;
191 * ethtool_adv_to_mii_ctrl1000_t
192 * @ethadv: the ethtool advertisement settings
194 * A small helper function that translates ethtool advertisement
195 * settings to phy autonegotiation advertisements for the
196 * MII_CTRL1000 register when in 1000T mode.
198 static inline u32 ethtool_adv_to_mii_ctrl1000_t(u32 ethadv)
202 if (ethadv & ADVERTISED_1000baseT_Half)
203 result |= ADVERTISE_1000HALF;
204 if (ethadv & ADVERTISED_1000baseT_Full)
205 result |= ADVERTISE_1000FULL;
211 * linkmode_adv_to_mii_ctrl1000_t
212 * @advertising: the linkmode advertisement settings
214 * A small helper function that translates linkmode advertisement
215 * settings to phy autonegotiation advertisements for the
216 * MII_CTRL1000 register when in 1000T mode.
218 static inline u32 linkmode_adv_to_mii_ctrl1000_t(unsigned long *advertising)
222 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
224 result |= ADVERTISE_1000HALF;
225 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
227 result |= ADVERTISE_1000FULL;
233 * mii_ctrl1000_to_ethtool_adv_t
234 * @adv: value of the MII_CTRL1000 register
236 * A small helper function that translates MII_CTRL1000
237 * bits, when in 1000Base-T mode, to ethtool
238 * advertisement settings.
240 static inline u32 mii_ctrl1000_to_ethtool_adv_t(u32 adv)
244 if (adv & ADVERTISE_1000HALF)
245 result |= ADVERTISED_1000baseT_Half;
246 if (adv & ADVERTISE_1000FULL)
247 result |= ADVERTISED_1000baseT_Full;
253 * mii_lpa_to_ethtool_lpa_t
254 * @adv: value of the MII_LPA register
256 * A small helper function that translates MII_LPA
257 * bits, when in 1000Base-T mode, to ethtool
258 * LP advertisement settings.
260 static inline u32 mii_lpa_to_ethtool_lpa_t(u32 lpa)
265 result |= ADVERTISED_Autoneg;
267 return result | mii_adv_to_ethtool_adv_t(lpa);
271 * mii_stat1000_to_ethtool_lpa_t
272 * @adv: value of the MII_STAT1000 register
274 * A small helper function that translates MII_STAT1000
275 * bits, when in 1000Base-T mode, to ethtool
276 * advertisement settings.
278 static inline u32 mii_stat1000_to_ethtool_lpa_t(u32 lpa)
282 if (lpa & LPA_1000HALF)
283 result |= ADVERTISED_1000baseT_Half;
284 if (lpa & LPA_1000FULL)
285 result |= ADVERTISED_1000baseT_Full;
291 * mii_stat1000_mod_linkmode_lpa_t
292 * @advertising: target the linkmode advertisement settings
293 * @adv: value of the MII_STAT1000 register
295 * A small helper function that translates MII_STAT1000 bits, when in
296 * 1000Base-T mode, to linkmode advertisement settings. Other bits in
297 * advertising are not changes.
299 static inline void mii_stat1000_mod_linkmode_lpa_t(unsigned long *advertising,
302 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
303 advertising, lpa & LPA_1000HALF);
305 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
306 advertising, lpa & LPA_1000FULL);
310 * ethtool_adv_to_mii_adv_x
311 * @ethadv: the ethtool advertisement settings
313 * A small helper function that translates ethtool advertisement
314 * settings to phy autonegotiation advertisements for the
315 * MII_CTRL1000 register when in 1000Base-X mode.
317 static inline u32 ethtool_adv_to_mii_adv_x(u32 ethadv)
321 if (ethadv & ADVERTISED_1000baseT_Half)
322 result |= ADVERTISE_1000XHALF;
323 if (ethadv & ADVERTISED_1000baseT_Full)
324 result |= ADVERTISE_1000XFULL;
325 if (ethadv & ADVERTISED_Pause)
326 result |= ADVERTISE_1000XPAUSE;
327 if (ethadv & ADVERTISED_Asym_Pause)
328 result |= ADVERTISE_1000XPSE_ASYM;
334 * mii_adv_to_ethtool_adv_x
335 * @adv: value of the MII_CTRL1000 register
337 * A small helper function that translates MII_CTRL1000
338 * bits, when in 1000Base-X mode, to ethtool
339 * advertisement settings.
341 static inline u32 mii_adv_to_ethtool_adv_x(u32 adv)
345 if (adv & ADVERTISE_1000XHALF)
346 result |= ADVERTISED_1000baseT_Half;
347 if (adv & ADVERTISE_1000XFULL)
348 result |= ADVERTISED_1000baseT_Full;
349 if (adv & ADVERTISE_1000XPAUSE)
350 result |= ADVERTISED_Pause;
351 if (adv & ADVERTISE_1000XPSE_ASYM)
352 result |= ADVERTISED_Asym_Pause;
358 * mii_lpa_mod_linkmode_adv_sgmii
359 * @lp_advertising: pointer to destination link mode.
360 * @lpa: value of the MII_LPA register
362 * A small helper function that translates MII_LPA bits to
363 * linkmode advertisement settings for SGMII.
364 * Leaves other bits unchanged.
367 mii_lpa_mod_linkmode_lpa_sgmii(unsigned long *lp_advertising, u32 lpa)
369 u32 speed_duplex = lpa & LPA_SGMII_DPX_SPD_MASK;
371 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, lp_advertising,
372 speed_duplex == LPA_SGMII_1000HALF);
374 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, lp_advertising,
375 speed_duplex == LPA_SGMII_1000FULL);
377 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, lp_advertising,
378 speed_duplex == LPA_SGMII_100HALF);
380 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, lp_advertising,
381 speed_duplex == LPA_SGMII_100FULL);
383 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, lp_advertising,
384 speed_duplex == LPA_SGMII_10HALF);
386 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, lp_advertising,
387 speed_duplex == LPA_SGMII_10FULL);
391 * mii_lpa_to_linkmode_adv_sgmii
392 * @advertising: pointer to destination link mode.
393 * @lpa: value of the MII_LPA register
395 * A small helper function that translates MII_ADVERTISE bits
396 * to linkmode advertisement settings when in SGMII mode.
397 * Clears the old value of advertising.
399 static inline void mii_lpa_to_linkmode_lpa_sgmii(unsigned long *lp_advertising,
402 linkmode_zero(lp_advertising);
404 mii_lpa_mod_linkmode_lpa_sgmii(lp_advertising, lpa);
408 * mii_adv_mod_linkmode_adv_t
409 * @advertising:pointer to destination link mode.
410 * @adv: value of the MII_ADVERTISE register
412 * A small helper function that translates MII_ADVERTISE bits to
413 * linkmode advertisement settings. Leaves other bits unchanged.
415 static inline void mii_adv_mod_linkmode_adv_t(unsigned long *advertising,
418 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT,
419 advertising, adv & ADVERTISE_10HALF);
421 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT,
422 advertising, adv & ADVERTISE_10FULL);
424 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
425 advertising, adv & ADVERTISE_100HALF);
427 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
428 advertising, adv & ADVERTISE_100FULL);
430 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising,
431 adv & ADVERTISE_PAUSE_CAP);
433 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
434 advertising, adv & ADVERTISE_PAUSE_ASYM);
438 * mii_adv_to_linkmode_adv_t
439 * @advertising:pointer to destination link mode.
440 * @adv: value of the MII_ADVERTISE register
442 * A small helper function that translates MII_ADVERTISE bits
443 * to linkmode advertisement settings. Clears the old value
446 static inline void mii_adv_to_linkmode_adv_t(unsigned long *advertising,
449 linkmode_zero(advertising);
451 mii_adv_mod_linkmode_adv_t(advertising, adv);
455 * mii_lpa_to_linkmode_lpa_t
456 * @adv: value of the MII_LPA register
458 * A small helper function that translates MII_LPA bits, when in
459 * 1000Base-T mode, to linkmode LP advertisement settings. Clears the
460 * old value of advertising
462 static inline void mii_lpa_to_linkmode_lpa_t(unsigned long *lp_advertising,
465 mii_adv_to_linkmode_adv_t(lp_advertising, lpa);
468 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
474 * mii_lpa_mod_linkmode_lpa_t
475 * @adv: value of the MII_LPA register
477 * A small helper function that translates MII_LPA bits, when in
478 * 1000Base-T mode, to linkmode LP advertisement settings. Leaves
479 * other bits unchanged.
481 static inline void mii_lpa_mod_linkmode_lpa_t(unsigned long *lp_advertising,
484 mii_adv_mod_linkmode_adv_t(lp_advertising, lpa);
486 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
487 lp_advertising, lpa & LPA_LPACK);
490 static inline void mii_ctrl1000_mod_linkmode_adv_t(unsigned long *advertising,
493 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, advertising,
494 ctrl1000 & ADVERTISE_1000HALF);
495 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, advertising,
496 ctrl1000 & ADVERTISE_1000FULL);
500 * linkmode_adv_to_lcl_adv_t
501 * @advertising:pointer to linkmode advertising
503 * A small helper function that translates linkmode advertising to LVL
504 * pause capabilities.
506 static inline u32 linkmode_adv_to_lcl_adv_t(unsigned long *advertising)
510 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
512 lcl_adv |= ADVERTISE_PAUSE_CAP;
513 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
515 lcl_adv |= ADVERTISE_PAUSE_ASYM;
521 * mii_lpa_mod_linkmode_x - decode the link partner's config_reg to linkmodes
522 * @linkmodes: link modes array
523 * @lpa: config_reg word from link partner
524 * @fd_bit: link mode for 1000XFULL bit
526 static inline void mii_lpa_mod_linkmode_x(unsigned long *linkmodes, u16 lpa,
529 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, linkmodes,
531 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, linkmodes,
532 lpa & LPA_1000XPAUSE);
533 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, linkmodes,
534 lpa & LPA_1000XPAUSE_ASYM);
535 linkmode_mod_bit(fd_bit, linkmodes,
536 lpa & LPA_1000XFULL);
540 * linkmode_adv_to_mii_adv_x - encode a linkmode to config_reg
541 * @linkmodes: linkmodes
542 * @fd_bit: full duplex bit
544 static inline u16 linkmode_adv_to_mii_adv_x(const unsigned long *linkmodes,
549 if (linkmode_test_bit(fd_bit, linkmodes))
550 adv |= ADVERTISE_1000XFULL;
551 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, linkmodes))
552 adv |= ADVERTISE_1000XPAUSE;
553 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, linkmodes))
554 adv |= ADVERTISE_1000XPSE_ASYM;
560 * mii_advertise_flowctrl - get flow control advertisement flags
561 * @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
563 static inline u16 mii_advertise_flowctrl(int cap)
567 if (cap & FLOW_CTRL_RX)
568 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
569 if (cap & FLOW_CTRL_TX)
570 adv ^= ADVERTISE_PAUSE_ASYM;
576 * mii_resolve_flowctrl_fdx
577 * @lcladv: value of MII ADVERTISE register
578 * @rmtadv: value of MII LPA register
580 * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
582 static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
586 if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
587 cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
588 } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
589 if (lcladv & ADVERTISE_PAUSE_CAP)
591 else if (rmtadv & ADVERTISE_PAUSE_CAP)
598 #endif /* __LINUX_MII_H__ */