include/linux/mii.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * linux/mii.h: definitions for MII-compatible transceivers
   4  * Originally drivers/net/sunhme.h.
   5  *
   6  * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
   7  */
   8 #ifndef __LINUX_MII_H__
   9 #define __LINUX_MII_H__
  10
  11
  12 #include <linux/if.h>
  13 #include <linux/linkmode.h>
  14 #include <uapi/linux/mii.h>
  15
  16 struct ethtool_cmd;
  17
  18 struct mii_if_info {
  19         int phy_id;
  20         int advertising;
  21         int phy_id_mask;
  22         int reg_num_mask;
  23
  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? */
  27
  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);
  31 };
  32
  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);
  49
  50
  51 static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
  52 {
  53         return (struct mii_ioctl_data *) &rq->ifr_ifru;
  54 }
  55
  56 /**
  57  * mii_nway_result
  58  * @negotiated: value of MII ANAR and'd with ANLPAR
  59  *
  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.
  64  *
  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.
  69  */
  70 static inline unsigned int mii_nway_result (unsigned int negotiated)
  71 {
  72         unsigned int ret;
  73
  74         if (negotiated & LPA_100FULL)
  75                 ret = LPA_100FULL;
  76         else if (negotiated & LPA_100BASE4)
  77                 ret = LPA_100BASE4;
  78         else if (negotiated & LPA_100HALF)
  79                 ret = LPA_100HALF;
  80         else if (negotiated & LPA_10FULL)
  81                 ret = LPA_10FULL;
  82         else
  83                 ret = LPA_10HALF;
  84
  85         return ret;
  86 }
  87
  88 /**
  89  * mii_duplex
  90  * @duplex_lock: Non-zero if duplex is locked at full
  91  * @negotiated: value of MII ANAR and'd with ANLPAR
  92  *
  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.
  96  */
  97 static inline unsigned int mii_duplex (unsigned int duplex_lock,
  98                                        unsigned int negotiated)
  99 {
 100         if (duplex_lock)
 101                 return 1;
 102         if (mii_nway_result(negotiated) & LPA_DUPLEX)
 103                 return 1;
 104         return 0;
 105 }
 106
 107 /**
 108  * ethtool_adv_to_mii_adv_t
 109  * @ethadv: the ethtool advertisement settings
 110  *
 111  * A small helper function that translates ethtool advertisement
 112  * settings to phy autonegotiation advertisements for the
 113  * MII_ADVERTISE register.
 114  */
 115 static inline u32 ethtool_adv_to_mii_adv_t(u32 ethadv)
 116 {
 117         u32 result = 0;
 118
 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;
 131
 132         return result;
 133 }
 134
 135 /**
 136  * linkmode_adv_to_mii_adv_t
 137  * @advertising: the linkmode advertisement settings
 138  *
 139  * A small helper function that translates linkmode advertisement
 140  * settings to phy autonegotiation advertisements for the
 141  * MII_ADVERTISE register.
 142  */
 143 static inline u32 linkmode_adv_to_mii_adv_t(unsigned long *advertising)
 144 {
 145         u32 result = 0;
 146
 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;
 159
 160         return result;
 161 }
 162
 163 /**
 164  * mii_adv_to_ethtool_adv_t
 165  * @adv: value of the MII_ADVERTISE register
 166  *
 167  * A small helper function that translates MII_ADVERTISE bits
 168  * to ethtool advertisement settings.
 169  */
 170 static inline u32 mii_adv_to_ethtool_adv_t(u32 adv)
 171 {
 172         u32 result = 0;
 173
 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;
 186
 187         return result;
 188 }
 189
 190 /**
 191  * ethtool_adv_to_mii_ctrl1000_t
 192  * @ethadv: the ethtool advertisement settings
 193  *
 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.
 197  */
 198 static inline u32 ethtool_adv_to_mii_ctrl1000_t(u32 ethadv)
 199 {
 200         u32 result = 0;
 201
 202         if (ethadv & ADVERTISED_1000baseT_Half)
 203                 result |= ADVERTISE_1000HALF;
 204         if (ethadv & ADVERTISED_1000baseT_Full)
 205                 result |= ADVERTISE_1000FULL;
 206
 207         return result;
 208 }
 209
 210 /**
 211  * linkmode_adv_to_mii_ctrl1000_t
 212  * advertising: the linkmode advertisement settings
 213  *
 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.
 217  */
 218 static inline u32 linkmode_adv_to_mii_ctrl1000_t(unsigned long *advertising)
 219 {
 220         u32 result = 0;
 221
 222         if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
 223                               advertising))
 224                 result |= ADVERTISE_1000HALF;
 225         if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 226                               advertising))
 227                 result |= ADVERTISE_1000FULL;
 228
 229         return result;
 230 }
 231
 232 /**
 233  * mii_ctrl1000_to_ethtool_adv_t
 234  * @adv: value of the MII_CTRL1000 register
 235  *
 236  * A small helper function that translates MII_CTRL1000
 237  * bits, when in 1000Base-T mode, to ethtool
 238  * advertisement settings.
 239  */
 240 static inline u32 mii_ctrl1000_to_ethtool_adv_t(u32 adv)
 241 {
 242         u32 result = 0;
 243
 244         if (adv & ADVERTISE_1000HALF)
 245                 result |= ADVERTISED_1000baseT_Half;
 246         if (adv & ADVERTISE_1000FULL)
 247                 result |= ADVERTISED_1000baseT_Full;
 248
 249         return result;
 250 }
 251
 252 /**
 253  * mii_lpa_to_ethtool_lpa_t
 254  * @adv: value of the MII_LPA register
 255  *
 256  * A small helper function that translates MII_LPA
 257  * bits, when in 1000Base-T mode, to ethtool
 258  * LP advertisement settings.
 259  */
 260 static inline u32 mii_lpa_to_ethtool_lpa_t(u32 lpa)
 261 {
 262         u32 result = 0;
 263
 264         if (lpa & LPA_LPACK)
 265                 result |= ADVERTISED_Autoneg;
 266
 267         return result | mii_adv_to_ethtool_adv_t(lpa);
 268 }
 269
 270 /**
 271  * mii_stat1000_to_ethtool_lpa_t
 272  * @adv: value of the MII_STAT1000 register
 273  *
 274  * A small helper function that translates MII_STAT1000
 275  * bits, when in 1000Base-T mode, to ethtool
 276  * advertisement settings.
 277  */
 278 static inline u32 mii_stat1000_to_ethtool_lpa_t(u32 lpa)
 279 {
 280         u32 result = 0;
 281
 282         if (lpa & LPA_1000HALF)
 283                 result |= ADVERTISED_1000baseT_Half;
 284         if (lpa & LPA_1000FULL)
 285                 result |= ADVERTISED_1000baseT_Full;
 286
 287         return result;
 288 }
 289
 290 /**
 291  * ethtool_adv_to_mii_adv_x
 292  * @ethadv: the ethtool advertisement settings
 293  *
 294  * A small helper function that translates ethtool advertisement
 295  * settings to phy autonegotiation advertisements for the
 296  * MII_CTRL1000 register when in 1000Base-X mode.
 297  */
 298 static inline u32 ethtool_adv_to_mii_adv_x(u32 ethadv)
 299 {
 300         u32 result = 0;
 301
 302         if (ethadv & ADVERTISED_1000baseT_Half)
 303                 result |= ADVERTISE_1000XHALF;
 304         if (ethadv & ADVERTISED_1000baseT_Full)
 305                 result |= ADVERTISE_1000XFULL;
 306         if (ethadv & ADVERTISED_Pause)
 307                 result |= ADVERTISE_1000XPAUSE;
 308         if (ethadv & ADVERTISED_Asym_Pause)
 309                 result |= ADVERTISE_1000XPSE_ASYM;
 310
 311         return result;
 312 }
 313
 314 /**
 315  * mii_adv_to_ethtool_adv_x
 316  * @adv: value of the MII_CTRL1000 register
 317  *
 318  * A small helper function that translates MII_CTRL1000
 319  * bits, when in 1000Base-X mode, to ethtool
 320  * advertisement settings.
 321  */
 322 static inline u32 mii_adv_to_ethtool_adv_x(u32 adv)
 323 {
 324         u32 result = 0;
 325
 326         if (adv & ADVERTISE_1000XHALF)
 327                 result |= ADVERTISED_1000baseT_Half;
 328         if (adv & ADVERTISE_1000XFULL)
 329                 result |= ADVERTISED_1000baseT_Full;
 330         if (adv & ADVERTISE_1000XPAUSE)
 331                 result |= ADVERTISED_Pause;
 332         if (adv & ADVERTISE_1000XPSE_ASYM)
 333                 result |= ADVERTISED_Asym_Pause;
 334
 335         return result;
 336 }
 337
 338 /**
 339  * mii_lpa_to_ethtool_lpa_x
 340  * @adv: value of the MII_LPA register
 341  *
 342  * A small helper function that translates MII_LPA
 343  * bits, when in 1000Base-X mode, to ethtool
 344  * LP advertisement settings.
 345  */
 346 static inline u32 mii_lpa_to_ethtool_lpa_x(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_x(lpa);
 354 }
 355
 356 /**
 357  * mii_adv_to_linkmode_adv_t
 358  * @advertising:pointer to destination link mode.
 359  * @adv: value of the MII_ADVERTISE register
 360  *
 361  * A small helper function that translates MII_ADVERTISE bits
 362  * to linkmode advertisement settings.
 363  */
 364 static inline void mii_adv_to_linkmode_adv_t(unsigned long *advertising,
 365                                              u32 adv)
 366 {
 367         linkmode_zero(advertising);
 368
 369         if (adv & ADVERTISE_10HALF)
 370                 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT,
 371                                  advertising);
 372         if (adv & ADVERTISE_10FULL)
 373                 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT,
 374                                  advertising);
 375         if (adv & ADVERTISE_100HALF)
 376                 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
 377                                  advertising);
 378         if (adv & ADVERTISE_100FULL)
 379                 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 380                                  advertising);
 381         if (adv & ADVERTISE_PAUSE_CAP)
 382                 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, advertising);
 383         if (adv & ADVERTISE_PAUSE_ASYM)
 384                 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, advertising);
 385 }
 386
 387 /**
 388  * ethtool_adv_to_lcl_adv_t
 389  * @advertising:pointer to ethtool advertising
 390  *
 391  * A small helper function that translates ethtool advertising to LVL
 392  * pause capabilities.
 393  */
 394 static inline u32 ethtool_adv_to_lcl_adv_t(u32 advertising)
 395 {
 396         u32 lcl_adv = 0;
 397
 398         if (advertising & ADVERTISED_Pause)
 399                 lcl_adv |= ADVERTISE_PAUSE_CAP;
 400         if (advertising & ADVERTISED_Asym_Pause)
 401                 lcl_adv |= ADVERTISE_PAUSE_ASYM;
 402
 403         return lcl_adv;
 404 }
 405
 406 /**
 407  * mii_advertise_flowctrl - get flow control advertisement flags
 408  * @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
 409  */
 410 static inline u16 mii_advertise_flowctrl(int cap)
 411 {
 412         u16 adv = 0;
 413
 414         if (cap & FLOW_CTRL_RX)
 415                 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
 416         if (cap & FLOW_CTRL_TX)
 417                 adv ^= ADVERTISE_PAUSE_ASYM;
 418
 419         return adv;
 420 }
 421
 422 /**
 423  * mii_resolve_flowctrl_fdx
 424  * @lcladv: value of MII ADVERTISE register
 425  * @rmtadv: value of MII LPA register
 426  *
 427  * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
 428  */
 429 static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
 430 {
 431         u8 cap = 0;
 432
 433         if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
 434                 cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
 435         } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
 436                 if (lcladv & ADVERTISE_PAUSE_CAP)
 437                         cap = FLOW_CTRL_RX;
 438                 else if (rmtadv & ADVERTISE_PAUSE_CAP)
 439                         cap = FLOW_CTRL_TX;
 440         }
 441
 442         return cap;
 443 }
 444
 445 #endif /* __LINUX_MII_H__ */