drivers/net/phy/phy.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /* Framework for configuring and reading PHY devices
   3  * Based on code in sungem_phy.c and gianfar_phy.c
   4  *
   5  * Author: Andy Fleming
   6  *
   7  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   8  * Copyright (c) 2006, 2007  Maciej W. Rozycki
   9  */
  10
  11 #include <linux/kernel.h>
  12 #include <linux/string.h>
  13 #include <linux/errno.h>
  14 #include <linux/unistd.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/delay.h>
  17 #include <linux/netdevice.h>
  18 #include <linux/etherdevice.h>
  19 #include <linux/skbuff.h>
  20 #include <linux/mm.h>
  21 #include <linux/module.h>
  22 #include <linux/mii.h>
  23 #include <linux/ethtool.h>
  24 #include <linux/phy.h>
  25 #include <linux/phy_led_triggers.h>
  26 #include <linux/workqueue.h>
  27 #include <linux/mdio.h>
  28 #include <linux/io.h>
  29 #include <linux/uaccess.h>
  30 #include <linux/atomic.h>
  31
  32 #define PHY_STATE_TIME  HZ
  33
  34 #define PHY_STATE_STR(_state)                   \
  35         case PHY_##_state:                      \
  36                 return __stringify(_state);     \
  37
  38 static const char *phy_state_to_str(enum phy_state st)
  39 {
  40         switch (st) {
  41         PHY_STATE_STR(DOWN)
  42         PHY_STATE_STR(READY)
  43         PHY_STATE_STR(UP)
  44         PHY_STATE_STR(RUNNING)
  45         PHY_STATE_STR(NOLINK)
  46         PHY_STATE_STR(HALTED)
  47         }
  48
  49         return NULL;
  50 }
  51
  52 static void phy_link_up(struct phy_device *phydev)
  53 {
  54         phydev->phy_link_change(phydev, true, true);
  55         phy_led_trigger_change_speed(phydev);
  56 }
  57
  58 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
  59 {
  60         phydev->phy_link_change(phydev, false, do_carrier);
  61         phy_led_trigger_change_speed(phydev);
  62 }
  63
  64 static const char *phy_pause_str(struct phy_device *phydev)
  65 {
  66         bool local_pause, local_asym_pause;
  67
  68         if (phydev->autoneg == AUTONEG_DISABLE)
  69                 goto no_pause;
  70
  71         local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
  72                                         phydev->advertising);
  73         local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
  74                                              phydev->advertising);
  75
  76         if (local_pause && phydev->pause)
  77                 return "rx/tx";
  78
  79         if (local_asym_pause && phydev->asym_pause) {
  80                 if (local_pause)
  81                         return "rx";
  82                 if (phydev->pause)
  83                         return "tx";
  84         }
  85
  86 no_pause:
  87         return "off";
  88 }
  89
  90 /**
  91  * phy_print_status - Convenience function to print out the current phy status
  92  * @phydev: the phy_device struct
  93  */
  94 void phy_print_status(struct phy_device *phydev)
  95 {
  96         if (phydev->link) {
  97                 netdev_info(phydev->attached_dev,
  98                         "Link is Up - %s/%s - flow control %s\n",
  99                         phy_speed_to_str(phydev->speed),
 100                         phy_duplex_to_str(phydev->duplex),
 101                         phy_pause_str(phydev));
 102         } else  {
 103                 netdev_info(phydev->attached_dev, "Link is Down\n");
 104         }
 105 }
 106 EXPORT_SYMBOL(phy_print_status);
 107
 108 /**
 109  * phy_clear_interrupt - Ack the phy device's interrupt
 110  * @phydev: the phy_device struct
 111  *
 112  * If the @phydev driver has an ack_interrupt function, call it to
 113  * ack and clear the phy device's interrupt.
 114  *
 115  * Returns 0 on success or < 0 on error.
 116  */
 117 static int phy_clear_interrupt(struct phy_device *phydev)
 118 {
 119         if (phydev->drv->ack_interrupt)
 120                 return phydev->drv->ack_interrupt(phydev);
 121
 122         return 0;
 123 }
 124
 125 /**
 126  * phy_config_interrupt - configure the PHY device for the requested interrupts
 127  * @phydev: the phy_device struct
 128  * @interrupts: interrupt flags to configure for this @phydev
 129  *
 130  * Returns 0 on success or < 0 on error.
 131  */
 132 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
 133 {
 134         phydev->interrupts = interrupts ? 1 : 0;
 135         if (phydev->drv->config_intr)
 136                 return phydev->drv->config_intr(phydev);
 137
 138         return 0;
 139 }
 140
 141 /**
 142  * phy_restart_aneg - restart auto-negotiation
 143  * @phydev: target phy_device struct
 144  *
 145  * Restart the autonegotiation on @phydev.  Returns >= 0 on success or
 146  * negative errno on error.
 147  */
 148 int phy_restart_aneg(struct phy_device *phydev)
 149 {
 150         int ret;
 151
 152         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 153                 ret = genphy_c45_restart_aneg(phydev);
 154         else
 155                 ret = genphy_restart_aneg(phydev);
 156
 157         return ret;
 158 }
 159 EXPORT_SYMBOL_GPL(phy_restart_aneg);
 160
 161 /**
 162  * phy_aneg_done - return auto-negotiation status
 163  * @phydev: target phy_device struct
 164  *
 165  * Description: Return the auto-negotiation status from this @phydev
 166  * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
 167  * is still pending.
 168  */
 169 int phy_aneg_done(struct phy_device *phydev)
 170 {
 171         if (phydev->drv && phydev->drv->aneg_done)
 172                 return phydev->drv->aneg_done(phydev);
 173         else if (phydev->is_c45)
 174                 return genphy_c45_aneg_done(phydev);
 175         else
 176                 return genphy_aneg_done(phydev);
 177 }
 178 EXPORT_SYMBOL(phy_aneg_done);
 179
 180 /**
 181  * phy_find_valid - find a PHY setting that matches the requested parameters
 182  * @speed: desired speed
 183  * @duplex: desired duplex
 184  * @supported: mask of supported link modes
 185  *
 186  * Locate a supported phy setting that is, in priority order:
 187  * - an exact match for the specified speed and duplex mode
 188  * - a match for the specified speed, or slower speed
 189  * - the slowest supported speed
 190  * Returns the matched phy_setting entry, or %NULL if no supported phy
 191  * settings were found.
 192  */
 193 static const struct phy_setting *
 194 phy_find_valid(int speed, int duplex, unsigned long *supported)
 195 {
 196         return phy_lookup_setting(speed, duplex, supported, false);
 197 }
 198
 199 /**
 200  * phy_supported_speeds - return all speeds currently supported by a phy device
 201  * @phy: The phy device to return supported speeds of.
 202  * @speeds: buffer to store supported speeds in.
 203  * @size:   size of speeds buffer.
 204  *
 205  * Description: Returns the number of supported speeds, and fills the speeds
 206  * buffer with the supported speeds. If speeds buffer is too small to contain
 207  * all currently supported speeds, will return as many speeds as can fit.
 208  */
 209 unsigned int phy_supported_speeds(struct phy_device *phy,
 210                                   unsigned int *speeds,
 211                                   unsigned int size)
 212 {
 213         return phy_speeds(speeds, size, phy->supported);
 214 }
 215
 216 /**
 217  * phy_check_valid - check if there is a valid PHY setting which matches
 218  *                   speed, duplex, and feature mask
 219  * @speed: speed to match
 220  * @duplex: duplex to match
 221  * @features: A mask of the valid settings
 222  *
 223  * Description: Returns true if there is a valid setting, false otherwise.
 224  */
 225 static inline bool phy_check_valid(int speed, int duplex,
 226                                    unsigned long *features)
 227 {
 228         return !!phy_lookup_setting(speed, duplex, features, true);
 229 }
 230
 231 /**
 232  * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
 233  * @phydev: the target phy_device struct
 234  *
 235  * Description: Make sure the PHY is set to supported speeds and
 236  *   duplexes.  Drop down by one in this order:  1000/FULL,
 237  *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
 238  */
 239 static void phy_sanitize_settings(struct phy_device *phydev)
 240 {
 241         const struct phy_setting *setting;
 242
 243         setting = phy_find_valid(phydev->speed, phydev->duplex,
 244                                  phydev->supported);
 245         if (setting) {
 246                 phydev->speed = setting->speed;
 247                 phydev->duplex = setting->duplex;
 248         } else {
 249                 /* We failed to find anything (no supported speeds?) */
 250                 phydev->speed = SPEED_UNKNOWN;
 251                 phydev->duplex = DUPLEX_UNKNOWN;
 252         }
 253 }
 254
 255 /**
 256  * phy_ethtool_sset - generic ethtool sset function, handles all the details
 257  * @phydev: target phy_device struct
 258  * @cmd: ethtool_cmd
 259  *
 260  * A few notes about parameter checking:
 261  *
 262  * - We don't set port or transceiver, so we don't care what they
 263  *   were set to.
 264  * - phy_start_aneg() will make sure forced settings are sane, and
 265  *   choose the next best ones from the ones selected, so we don't
 266  *   care if ethtool tries to give us bad values.
 267  */
 268 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
 269 {
 270         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 271         u32 speed = ethtool_cmd_speed(cmd);
 272
 273         if (cmd->phy_address != phydev->mdio.addr)
 274                 return -EINVAL;
 275
 276         /* We make sure that we don't pass unsupported values in to the PHY */
 277         ethtool_convert_legacy_u32_to_link_mode(advertising, cmd->advertising);
 278         linkmode_and(advertising, advertising, phydev->supported);
 279
 280         /* Verify the settings we care about. */
 281         if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
 282                 return -EINVAL;
 283
 284         if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
 285                 return -EINVAL;
 286
 287         if (cmd->autoneg == AUTONEG_DISABLE &&
 288             ((speed != SPEED_1000 &&
 289               speed != SPEED_100 &&
 290               speed != SPEED_10) ||
 291              (cmd->duplex != DUPLEX_HALF &&
 292               cmd->duplex != DUPLEX_FULL)))
 293                 return -EINVAL;
 294
 295         phydev->autoneg = cmd->autoneg;
 296
 297         phydev->speed = speed;
 298
 299         linkmode_copy(phydev->advertising, advertising);
 300
 301         linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
 302                          phydev->advertising, AUTONEG_ENABLE == cmd->autoneg);
 303
 304         phydev->duplex = cmd->duplex;
 305
 306         phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
 307
 308         /* Restart the PHY */
 309         phy_start_aneg(phydev);
 310
 311         return 0;
 312 }
 313 EXPORT_SYMBOL(phy_ethtool_sset);
 314
 315 int phy_ethtool_ksettings_set(struct phy_device *phydev,
 316                               const struct ethtool_link_ksettings *cmd)
 317 {
 318         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 319         u8 autoneg = cmd->base.autoneg;
 320         u8 duplex = cmd->base.duplex;
 321         u32 speed = cmd->base.speed;
 322
 323         if (cmd->base.phy_address != phydev->mdio.addr)
 324                 return -EINVAL;
 325
 326         linkmode_copy(advertising, cmd->link_modes.advertising);
 327
 328         /* We make sure that we don't pass unsupported values in to the PHY */
 329         linkmode_and(advertising, advertising, phydev->supported);
 330
 331         /* Verify the settings we care about. */
 332         if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
 333                 return -EINVAL;
 334
 335         if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
 336                 return -EINVAL;
 337
 338         if (autoneg == AUTONEG_DISABLE &&
 339             ((speed != SPEED_1000 &&
 340               speed != SPEED_100 &&
 341               speed != SPEED_10) ||
 342              (duplex != DUPLEX_HALF &&
 343               duplex != DUPLEX_FULL)))
 344                 return -EINVAL;
 345
 346         phydev->autoneg = autoneg;
 347
 348         phydev->speed = speed;
 349
 350         linkmode_copy(phydev->advertising, advertising);
 351
 352         linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
 353                          phydev->advertising, autoneg == AUTONEG_ENABLE);
 354
 355         phydev->duplex = duplex;
 356
 357         phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
 358
 359         /* Restart the PHY */
 360         phy_start_aneg(phydev);
 361
 362         return 0;
 363 }
 364 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
 365
 366 void phy_ethtool_ksettings_get(struct phy_device *phydev,
 367                                struct ethtool_link_ksettings *cmd)
 368 {
 369         linkmode_copy(cmd->link_modes.supported, phydev->supported);
 370         linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
 371         linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
 372
 373         cmd->base.speed = phydev->speed;
 374         cmd->base.duplex = phydev->duplex;
 375         if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
 376                 cmd->base.port = PORT_BNC;
 377         else
 378                 cmd->base.port = PORT_MII;
 379         cmd->base.transceiver = phy_is_internal(phydev) ?
 380                                 XCVR_INTERNAL : XCVR_EXTERNAL;
 381         cmd->base.phy_address = phydev->mdio.addr;
 382         cmd->base.autoneg = phydev->autoneg;
 383         cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
 384         cmd->base.eth_tp_mdix = phydev->mdix;
 385 }
 386 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
 387
 388 /**
 389  * phy_mii_ioctl - generic PHY MII ioctl interface
 390  * @phydev: the phy_device struct
 391  * @ifr: &struct ifreq for socket ioctl's
 392  * @cmd: ioctl cmd to execute
 393  *
 394  * Note that this function is currently incompatible with the
 395  * PHYCONTROL layer.  It changes registers without regard to
 396  * current state.  Use at own risk.
 397  */
 398 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
 399 {
 400         struct mii_ioctl_data *mii_data = if_mii(ifr);
 401         u16 val = mii_data->val_in;
 402         bool change_autoneg = false;
 403         int prtad, devad;
 404
 405         switch (cmd) {
 406         case SIOCGMIIPHY:
 407                 mii_data->phy_id = phydev->mdio.addr;
 408                 /* fall through */
 409
 410         case SIOCGMIIREG:
 411                 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
 412                         prtad = mdio_phy_id_prtad(mii_data->phy_id);
 413                         devad = mdio_phy_id_devad(mii_data->phy_id);
 414                         devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
 415                 } else {
 416                         prtad = mii_data->phy_id;
 417                         devad = mii_data->reg_num;
 418                 }
 419                 mii_data->val_out = mdiobus_read(phydev->mdio.bus, prtad,
 420                                                  devad);
 421                 return 0;
 422
 423         case SIOCSMIIREG:
 424                 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
 425                         prtad = mdio_phy_id_prtad(mii_data->phy_id);
 426                         devad = mdio_phy_id_devad(mii_data->phy_id);
 427                         devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
 428                 } else {
 429                         prtad = mii_data->phy_id;
 430                         devad = mii_data->reg_num;
 431                 }
 432                 if (prtad == phydev->mdio.addr) {
 433                         switch (devad) {
 434                         case MII_BMCR:
 435                                 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
 436                                         if (phydev->autoneg == AUTONEG_ENABLE)
 437                                                 change_autoneg = true;
 438                                         phydev->autoneg = AUTONEG_DISABLE;
 439                                         if (val & BMCR_FULLDPLX)
 440                                                 phydev->duplex = DUPLEX_FULL;
 441                                         else
 442                                                 phydev->duplex = DUPLEX_HALF;
 443                                         if (val & BMCR_SPEED1000)
 444                                                 phydev->speed = SPEED_1000;
 445                                         else if (val & BMCR_SPEED100)
 446                                                 phydev->speed = SPEED_100;
 447                                         else phydev->speed = SPEED_10;
 448                                 }
 449                                 else {
 450                                         if (phydev->autoneg == AUTONEG_DISABLE)
 451                                                 change_autoneg = true;
 452                                         phydev->autoneg = AUTONEG_ENABLE;
 453                                 }
 454                                 break;
 455                         case MII_ADVERTISE:
 456                                 mii_adv_mod_linkmode_adv_t(phydev->advertising,
 457                                                            val);
 458                                 change_autoneg = true;
 459                                 break;
 460                         default:
 461                                 /* do nothing */
 462                                 break;
 463                         }
 464                 }
 465
 466                 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
 467
 468                 if (prtad == phydev->mdio.addr &&
 469                     devad == MII_BMCR &&
 470                     val & BMCR_RESET)
 471                         return phy_init_hw(phydev);
 472
 473                 if (change_autoneg)
 474                         return phy_start_aneg(phydev);
 475
 476                 return 0;
 477
 478         case SIOCSHWTSTAMP:
 479                 if (phydev->drv && phydev->drv->hwtstamp)
 480                         return phydev->drv->hwtstamp(phydev, ifr);
 481                 /* fall through */
 482
 483         default:
 484                 return -EOPNOTSUPP;
 485         }
 486 }
 487 EXPORT_SYMBOL(phy_mii_ioctl);
 488
 489 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
 490 {
 491         mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
 492                          jiffies);
 493 }
 494 EXPORT_SYMBOL(phy_queue_state_machine);
 495
 496 static void phy_trigger_machine(struct phy_device *phydev)
 497 {
 498         phy_queue_state_machine(phydev, 0);
 499 }
 500
 501 static int phy_config_aneg(struct phy_device *phydev)
 502 {
 503         if (phydev->drv->config_aneg)
 504                 return phydev->drv->config_aneg(phydev);
 505
 506         /* Clause 45 PHYs that don't implement Clause 22 registers are not
 507          * allowed to call genphy_config_aneg()
 508          */
 509         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 510                 return genphy_c45_config_aneg(phydev);
 511
 512         return genphy_config_aneg(phydev);
 513 }
 514
 515 /**
 516  * phy_check_link_status - check link status and set state accordingly
 517  * @phydev: the phy_device struct
 518  *
 519  * Description: Check for link and whether autoneg was triggered / is running
 520  * and set state accordingly
 521  */
 522 static int phy_check_link_status(struct phy_device *phydev)
 523 {
 524         int err;
 525
 526         WARN_ON(!mutex_is_locked(&phydev->lock));
 527
 528         err = phy_read_status(phydev);
 529         if (err)
 530                 return err;
 531
 532         if (phydev->link && phydev->state != PHY_RUNNING) {
 533                 phydev->state = PHY_RUNNING;
 534                 phy_link_up(phydev);
 535         } else if (!phydev->link && phydev->state != PHY_NOLINK) {
 536                 phydev->state = PHY_NOLINK;
 537                 phy_link_down(phydev, true);
 538         }
 539
 540         return 0;
 541 }
 542
 543 /**
 544  * phy_start_aneg - start auto-negotiation for this PHY device
 545  * @phydev: the phy_device struct
 546  *
 547  * Description: Sanitizes the settings (if we're not autonegotiating
 548  *   them), and then calls the driver's config_aneg function.
 549  *   If the PHYCONTROL Layer is operating, we change the state to
 550  *   reflect the beginning of Auto-negotiation or forcing.
 551  */
 552 int phy_start_aneg(struct phy_device *phydev)
 553 {
 554         int err;
 555
 556         if (!phydev->drv)
 557                 return -EIO;
 558
 559         mutex_lock(&phydev->lock);
 560
 561         if (AUTONEG_DISABLE == phydev->autoneg)
 562                 phy_sanitize_settings(phydev);
 563
 564         /* Invalidate LP advertising flags */
 565         linkmode_zero(phydev->lp_advertising);
 566
 567         err = phy_config_aneg(phydev);
 568         if (err < 0)
 569                 goto out_unlock;
 570
 571         if (phy_is_started(phydev))
 572                 err = phy_check_link_status(phydev);
 573 out_unlock:
 574         mutex_unlock(&phydev->lock);
 575
 576         return err;
 577 }
 578 EXPORT_SYMBOL(phy_start_aneg);
 579
 580 static int phy_poll_aneg_done(struct phy_device *phydev)
 581 {
 582         unsigned int retries = 100;
 583         int ret;
 584
 585         do {
 586                 msleep(100);
 587                 ret = phy_aneg_done(phydev);
 588         } while (!ret && --retries);
 589
 590         if (!ret)
 591                 return -ETIMEDOUT;
 592
 593         return ret < 0 ? ret : 0;
 594 }
 595
 596 /**
 597  * phy_speed_down - set speed to lowest speed supported by both link partners
 598  * @phydev: the phy_device struct
 599  * @sync: perform action synchronously
 600  *
 601  * Description: Typically used to save energy when waiting for a WoL packet
 602  *
 603  * WARNING: Setting sync to false may cause the system being unable to suspend
 604  * in case the PHY generates an interrupt when finishing the autonegotiation.
 605  * This interrupt may wake up the system immediately after suspend.
 606  * Therefore use sync = false only if you're sure it's safe with the respective
 607  * network chip.
 608  */
 609 int phy_speed_down(struct phy_device *phydev, bool sync)
 610 {
 611         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
 612         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
 613         int ret;
 614
 615         if (phydev->autoneg != AUTONEG_ENABLE)
 616                 return 0;
 617
 618         linkmode_copy(adv_old, phydev->advertising);
 619         linkmode_copy(adv, phydev->lp_advertising);
 620         linkmode_and(adv, adv, phydev->supported);
 621
 622         if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, adv) ||
 623             linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, adv)) {
 624                 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
 625                                    phydev->advertising);
 626                 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 627                                    phydev->advertising);
 628                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
 629                                    phydev->advertising);
 630                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 631                                    phydev->advertising);
 632         } else if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
 633                                      adv) ||
 634                    linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 635                                      adv)) {
 636                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
 637                                    phydev->advertising);
 638                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 639                                    phydev->advertising);
 640         }
 641
 642         if (linkmode_equal(phydev->advertising, adv_old))
 643                 return 0;
 644
 645         ret = phy_config_aneg(phydev);
 646         if (ret)
 647                 return ret;
 648
 649         return sync ? phy_poll_aneg_done(phydev) : 0;
 650 }
 651 EXPORT_SYMBOL_GPL(phy_speed_down);
 652
 653 /**
 654  * phy_speed_up - (re)set advertised speeds to all supported speeds
 655  * @phydev: the phy_device struct
 656  *
 657  * Description: Used to revert the effect of phy_speed_down
 658  */
 659 int phy_speed_up(struct phy_device *phydev)
 660 {
 661         __ETHTOOL_DECLARE_LINK_MODE_MASK(all_speeds) = { 0, };
 662         __ETHTOOL_DECLARE_LINK_MODE_MASK(not_speeds);
 663         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 664         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
 665         __ETHTOOL_DECLARE_LINK_MODE_MASK(speeds);
 666
 667         linkmode_copy(adv_old, phydev->advertising);
 668
 669         if (phydev->autoneg != AUTONEG_ENABLE)
 670                 return 0;
 671
 672         linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, all_speeds);
 673         linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, all_speeds);
 674         linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, all_speeds);
 675         linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, all_speeds);
 676         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, all_speeds);
 677         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, all_speeds);
 678
 679         linkmode_andnot(not_speeds, adv_old, all_speeds);
 680         linkmode_copy(supported, phydev->supported);
 681         linkmode_and(speeds, supported, all_speeds);
 682         linkmode_or(phydev->advertising, not_speeds, speeds);
 683
 684         if (linkmode_equal(phydev->advertising, adv_old))
 685                 return 0;
 686
 687         return phy_config_aneg(phydev);
 688 }
 689 EXPORT_SYMBOL_GPL(phy_speed_up);
 690
 691 /**
 692  * phy_start_machine - start PHY state machine tracking
 693  * @phydev: the phy_device struct
 694  *
 695  * Description: The PHY infrastructure can run a state machine
 696  *   which tracks whether the PHY is starting up, negotiating,
 697  *   etc.  This function starts the delayed workqueue which tracks
 698  *   the state of the PHY. If you want to maintain your own state machine,
 699  *   do not call this function.
 700  */
 701 void phy_start_machine(struct phy_device *phydev)
 702 {
 703         phy_trigger_machine(phydev);
 704 }
 705 EXPORT_SYMBOL_GPL(phy_start_machine);
 706
 707 /**
 708  * phy_stop_machine - stop the PHY state machine tracking
 709  * @phydev: target phy_device struct
 710  *
 711  * Description: Stops the state machine delayed workqueue, sets the
 712  *   state to UP (unless it wasn't up yet). This function must be
 713  *   called BEFORE phy_detach.
 714  */
 715 void phy_stop_machine(struct phy_device *phydev)
 716 {
 717         cancel_delayed_work_sync(&phydev->state_queue);
 718
 719         mutex_lock(&phydev->lock);
 720         if (phy_is_started(phydev))
 721                 phydev->state = PHY_UP;
 722         mutex_unlock(&phydev->lock);
 723 }
 724
 725 /**
 726  * phy_error - enter HALTED state for this PHY device
 727  * @phydev: target phy_device struct
 728  *
 729  * Moves the PHY to the HALTED state in response to a read
 730  * or write error, and tells the controller the link is down.
 731  * Must not be called from interrupt context, or while the
 732  * phydev->lock is held.
 733  */
 734 static void phy_error(struct phy_device *phydev)
 735 {
 736         WARN_ON(1);
 737
 738         mutex_lock(&phydev->lock);
 739         phydev->state = PHY_HALTED;
 740         mutex_unlock(&phydev->lock);
 741
 742         phy_trigger_machine(phydev);
 743 }
 744
 745 /**
 746  * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
 747  * @phydev: target phy_device struct
 748  */
 749 static int phy_disable_interrupts(struct phy_device *phydev)
 750 {
 751         int err;
 752
 753         /* Disable PHY interrupts */
 754         err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
 755         if (err)
 756                 return err;
 757
 758         /* Clear the interrupt */
 759         return phy_clear_interrupt(phydev);
 760 }
 761
 762 /**
 763  * phy_interrupt - PHY interrupt handler
 764  * @irq: interrupt line
 765  * @phy_dat: phy_device pointer
 766  *
 767  * Description: Handle PHY interrupt
 768  */
 769 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
 770 {
 771         struct phy_device *phydev = phy_dat;
 772
 773         if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
 774                 return IRQ_NONE;
 775
 776         if (phydev->drv->handle_interrupt) {
 777                 if (phydev->drv->handle_interrupt(phydev))
 778                         goto phy_err;
 779         } else {
 780                 /* reschedule state queue work to run as soon as possible */
 781                 phy_trigger_machine(phydev);
 782         }
 783
 784         if (phy_clear_interrupt(phydev))
 785                 goto phy_err;
 786         return IRQ_HANDLED;
 787
 788 phy_err:
 789         phy_error(phydev);
 790         return IRQ_NONE;
 791 }
 792
 793 /**
 794  * phy_enable_interrupts - Enable the interrupts from the PHY side
 795  * @phydev: target phy_device struct
 796  */
 797 static int phy_enable_interrupts(struct phy_device *phydev)
 798 {
 799         int err = phy_clear_interrupt(phydev);
 800
 801         if (err < 0)
 802                 return err;
 803
 804         return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
 805 }
 806
 807 /**
 808  * phy_request_interrupt - request and enable interrupt for a PHY device
 809  * @phydev: target phy_device struct
 810  *
 811  * Description: Request and enable the interrupt for the given PHY.
 812  *   If this fails, then we set irq to PHY_POLL.
 813  *   This should only be called with a valid IRQ number.
 814  */
 815 void phy_request_interrupt(struct phy_device *phydev)
 816 {
 817         int err;
 818
 819         err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
 820                                    IRQF_ONESHOT | IRQF_SHARED,
 821                                    phydev_name(phydev), phydev);
 822         if (err) {
 823                 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
 824                             err, phydev->irq);
 825                 phydev->irq = PHY_POLL;
 826         } else {
 827                 if (phy_enable_interrupts(phydev)) {
 828                         phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
 829                         phy_free_interrupt(phydev);
 830                         phydev->irq = PHY_POLL;
 831                 }
 832         }
 833 }
 834 EXPORT_SYMBOL(phy_request_interrupt);
 835
 836 /**
 837  * phy_free_interrupt - disable and free interrupt for a PHY device
 838  * @phydev: target phy_device struct
 839  *
 840  * Description: Disable and free the interrupt for the given PHY.
 841  *   This should only be called with a valid IRQ number.
 842  */
 843 void phy_free_interrupt(struct phy_device *phydev)
 844 {
 845         phy_disable_interrupts(phydev);
 846         free_irq(phydev->irq, phydev);
 847 }
 848 EXPORT_SYMBOL(phy_free_interrupt);
 849
 850 /**
 851  * phy_stop - Bring down the PHY link, and stop checking the status
 852  * @phydev: target phy_device struct
 853  */
 854 void phy_stop(struct phy_device *phydev)
 855 {
 856         if (!phy_is_started(phydev)) {
 857                 WARN(1, "called from state %s\n",
 858                      phy_state_to_str(phydev->state));
 859                 return;
 860         }
 861
 862         mutex_lock(&phydev->lock);
 863
 864         phydev->state = PHY_HALTED;
 865
 866         mutex_unlock(&phydev->lock);
 867
 868         phy_state_machine(&phydev->state_queue.work);
 869         phy_stop_machine(phydev);
 870
 871         /* Cannot call flush_scheduled_work() here as desired because
 872          * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
 873          * will not reenable interrupts.
 874          */
 875 }
 876 EXPORT_SYMBOL(phy_stop);
 877
 878 /**
 879  * phy_start - start or restart a PHY device
 880  * @phydev: target phy_device struct
 881  *
 882  * Description: Indicates the attached device's readiness to
 883  *   handle PHY-related work.  Used during startup to start the
 884  *   PHY, and after a call to phy_stop() to resume operation.
 885  *   Also used to indicate the MDIO bus has cleared an error
 886  *   condition.
 887  */
 888 void phy_start(struct phy_device *phydev)
 889 {
 890         mutex_lock(&phydev->lock);
 891
 892         if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
 893                 WARN(1, "called from state %s\n",
 894                      phy_state_to_str(phydev->state));
 895                 goto out;
 896         }
 897
 898         /* if phy was suspended, bring the physical link up again */
 899         __phy_resume(phydev);
 900
 901         phydev->state = PHY_UP;
 902
 903         phy_start_machine(phydev);
 904 out:
 905         mutex_unlock(&phydev->lock);
 906 }
 907 EXPORT_SYMBOL(phy_start);
 908
 909 /**
 910  * phy_state_machine - Handle the state machine
 911  * @work: work_struct that describes the work to be done
 912  */
 913 void phy_state_machine(struct work_struct *work)
 914 {
 915         struct delayed_work *dwork = to_delayed_work(work);
 916         struct phy_device *phydev =
 917                         container_of(dwork, struct phy_device, state_queue);
 918         bool needs_aneg = false, do_suspend = false;
 919         enum phy_state old_state;
 920         int err = 0;
 921
 922         mutex_lock(&phydev->lock);
 923
 924         old_state = phydev->state;
 925
 926         switch (phydev->state) {
 927         case PHY_DOWN:
 928         case PHY_READY:
 929                 break;
 930         case PHY_UP:
 931                 needs_aneg = true;
 932
 933                 break;
 934         case PHY_NOLINK:
 935         case PHY_RUNNING:
 936                 err = phy_check_link_status(phydev);
 937                 break;
 938         case PHY_HALTED:
 939                 if (phydev->link) {
 940                         phydev->link = 0;
 941                         phy_link_down(phydev, true);
 942                         do_suspend = true;
 943                 }
 944                 break;
 945         }
 946
 947         mutex_unlock(&phydev->lock);
 948
 949         if (needs_aneg)
 950                 err = phy_start_aneg(phydev);
 951         else if (do_suspend)
 952                 phy_suspend(phydev);
 953
 954         if (err < 0)
 955                 phy_error(phydev);
 956
 957         if (old_state != phydev->state) {
 958                 phydev_dbg(phydev, "PHY state change %s -> %s\n",
 959                            phy_state_to_str(old_state),
 960                            phy_state_to_str(phydev->state));
 961                 if (phydev->drv && phydev->drv->link_change_notify)
 962                         phydev->drv->link_change_notify(phydev);
 963         }
 964
 965         /* Only re-schedule a PHY state machine change if we are polling the
 966          * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
 967          * between states from phy_mac_interrupt().
 968          *
 969          * In state PHY_HALTED the PHY gets suspended, so rescheduling the
 970          * state machine would be pointless and possibly error prone when
 971          * called from phy_disconnect() synchronously.
 972          */
 973         mutex_lock(&phydev->lock);
 974         if (phy_polling_mode(phydev) && phy_is_started(phydev))
 975                 phy_queue_state_machine(phydev, PHY_STATE_TIME);
 976         mutex_unlock(&phydev->lock);
 977 }
 978
 979 /**
 980  * phy_mac_interrupt - MAC says the link has changed
 981  * @phydev: phy_device struct with changed link
 982  *
 983  * The MAC layer is able to indicate there has been a change in the PHY link
 984  * status. Trigger the state machine and work a work queue.
 985  */
 986 void phy_mac_interrupt(struct phy_device *phydev)
 987 {
 988         /* Trigger a state machine change */
 989         phy_trigger_machine(phydev);
 990 }
 991 EXPORT_SYMBOL(phy_mac_interrupt);
 992
 993 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
 994 {
 995         linkmode_zero(advertising);
 996
 997         if (eee_adv & MDIO_EEE_100TX)
 998                 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 999                                  advertising);
1000         if (eee_adv & MDIO_EEE_1000T)
1001                 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1002                                  advertising);
1003         if (eee_adv & MDIO_EEE_10GT)
1004                 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
1005                                  advertising);
1006         if (eee_adv & MDIO_EEE_1000KX)
1007                 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
1008                                  advertising);
1009         if (eee_adv & MDIO_EEE_10GKX4)
1010                 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
1011                                  advertising);
1012         if (eee_adv & MDIO_EEE_10GKR)
1013                 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
1014                                  advertising);
1015 }
1016
1017 /**
1018  * phy_init_eee - init and check the EEE feature
1019  * @phydev: target phy_device struct
1020  * @clk_stop_enable: PHY may stop the clock during LPI
1021  *
1022  * Description: it checks if the Energy-Efficient Ethernet (EEE)
1023  * is supported by looking at the MMD registers 3.20 and 7.60/61
1024  * and it programs the MMD register 3.0 setting the "Clock stop enable"
1025  * bit if required.
1026  */
1027 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1028 {
1029         if (!phydev->drv)
1030                 return -EIO;
1031
1032         /* According to 802.3az,the EEE is supported only in full duplex-mode.
1033          */
1034         if (phydev->duplex == DUPLEX_FULL) {
1035                 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1036                 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1037                 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1038                 int eee_lp, eee_cap, eee_adv;
1039                 int status;
1040                 u32 cap;
1041
1042                 /* Read phy status to properly get the right settings */
1043                 status = phy_read_status(phydev);
1044                 if (status)
1045                         return status;
1046
1047                 /* First check if the EEE ability is supported */
1048                 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1049                 if (eee_cap <= 0)
1050                         goto eee_exit_err;
1051
1052                 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1053                 if (!cap)
1054                         goto eee_exit_err;
1055
1056                 /* Check which link settings negotiated and verify it in
1057                  * the EEE advertising registers.
1058                  */
1059                 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1060                 if (eee_lp <= 0)
1061                         goto eee_exit_err;
1062
1063                 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1064                 if (eee_adv <= 0)
1065                         goto eee_exit_err;
1066
1067                 mmd_eee_adv_to_linkmode(adv, eee_adv);
1068                 mmd_eee_adv_to_linkmode(lp, eee_lp);
1069                 linkmode_and(common, adv, lp);
1070
1071                 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1072                         goto eee_exit_err;
1073
1074                 if (clk_stop_enable)
1075                         /* Configure the PHY to stop receiving xMII
1076                          * clock while it is signaling LPI.
1077                          */
1078                         phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1079                                          MDIO_PCS_CTRL1_CLKSTOP_EN);
1080
1081                 return 0; /* EEE supported */
1082         }
1083 eee_exit_err:
1084         return -EPROTONOSUPPORT;
1085 }
1086 EXPORT_SYMBOL(phy_init_eee);
1087
1088 /**
1089  * phy_get_eee_err - report the EEE wake error count
1090  * @phydev: target phy_device struct
1091  *
1092  * Description: it is to report the number of time where the PHY
1093  * failed to complete its normal wake sequence.
1094  */
1095 int phy_get_eee_err(struct phy_device *phydev)
1096 {
1097         if (!phydev->drv)
1098                 return -EIO;
1099
1100         return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1101 }
1102 EXPORT_SYMBOL(phy_get_eee_err);
1103
1104 /**
1105  * phy_ethtool_get_eee - get EEE supported and status
1106  * @phydev: target phy_device struct
1107  * @data: ethtool_eee data
1108  *
1109  * Description: it reportes the Supported/Advertisement/LP Advertisement
1110  * capabilities.
1111  */
1112 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1113 {
1114         int val;
1115
1116         if (!phydev->drv)
1117                 return -EIO;
1118
1119         /* Get Supported EEE */
1120         val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1121         if (val < 0)
1122                 return val;
1123         data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1124
1125         /* Get advertisement EEE */
1126         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1127         if (val < 0)
1128                 return val;
1129         data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1130         data->eee_enabled = !!data->advertised;
1131
1132         /* Get LP advertisement EEE */
1133         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1134         if (val < 0)
1135                 return val;
1136         data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1137
1138         data->eee_active = !!(data->advertised & data->lp_advertised);
1139
1140         return 0;
1141 }
1142 EXPORT_SYMBOL(phy_ethtool_get_eee);
1143
1144 /**
1145  * phy_ethtool_set_eee - set EEE supported and status
1146  * @phydev: target phy_device struct
1147  * @data: ethtool_eee data
1148  *
1149  * Description: it is to program the Advertisement EEE register.
1150  */
1151 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1152 {
1153         int cap, old_adv, adv = 0, ret;
1154
1155         if (!phydev->drv)
1156                 return -EIO;
1157
1158         /* Get Supported EEE */
1159         cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1160         if (cap < 0)
1161                 return cap;
1162
1163         old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1164         if (old_adv < 0)
1165                 return old_adv;
1166
1167         if (data->eee_enabled) {
1168                 adv = !data->advertised ? cap :
1169                       ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1170                 /* Mask prohibited EEE modes */
1171                 adv &= ~phydev->eee_broken_modes;
1172         }
1173
1174         if (old_adv != adv) {
1175                 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1176                 if (ret < 0)
1177                         return ret;
1178
1179                 /* Restart autonegotiation so the new modes get sent to the
1180                  * link partner.
1181                  */
1182                 ret = phy_restart_aneg(phydev);
1183                 if (ret < 0)
1184                         return ret;
1185         }
1186
1187         return 0;
1188 }
1189 EXPORT_SYMBOL(phy_ethtool_set_eee);
1190
1191 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1192 {
1193         if (phydev->drv && phydev->drv->set_wol)
1194                 return phydev->drv->set_wol(phydev, wol);
1195
1196         return -EOPNOTSUPP;
1197 }
1198 EXPORT_SYMBOL(phy_ethtool_set_wol);
1199
1200 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1201 {
1202         if (phydev->drv && phydev->drv->get_wol)
1203                 phydev->drv->get_wol(phydev, wol);
1204 }
1205 EXPORT_SYMBOL(phy_ethtool_get_wol);
1206
1207 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1208                                    struct ethtool_link_ksettings *cmd)
1209 {
1210         struct phy_device *phydev = ndev->phydev;
1211
1212         if (!phydev)
1213                 return -ENODEV;
1214
1215         phy_ethtool_ksettings_get(phydev, cmd);
1216
1217         return 0;
1218 }
1219 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1220
1221 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1222                                    const struct ethtool_link_ksettings *cmd)
1223 {
1224         struct phy_device *phydev = ndev->phydev;
1225
1226         if (!phydev)
1227                 return -ENODEV;
1228
1229         return phy_ethtool_ksettings_set(phydev, cmd);
1230 }
1231 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1232
1233 int phy_ethtool_nway_reset(struct net_device *ndev)
1234 {
1235         struct phy_device *phydev = ndev->phydev;
1236
1237         if (!phydev)
1238                 return -ENODEV;
1239
1240         if (!phydev->drv)
1241                 return -EIO;
1242
1243         return phy_restart_aneg(phydev);
1244 }
1245 EXPORT_SYMBOL(phy_ethtool_nway_reset);