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_STR(_state)                   \
  33         case PHY_##_state:                      \
  34                 return __stringify(_state);     \
  35
  36 static const char *phy_state_to_str(enum phy_state st)
  37 {
  38         switch (st) {
  39         PHY_STATE_STR(DOWN)
  40         PHY_STATE_STR(READY)
  41         PHY_STATE_STR(UP)
  42         PHY_STATE_STR(RUNNING)
  43         PHY_STATE_STR(NOLINK)
  44         PHY_STATE_STR(FORCING)
  45         PHY_STATE_STR(HALTED)
  46         }
  47
  48         return NULL;
  49 }
  50
  51 static void phy_link_up(struct phy_device *phydev)
  52 {
  53         phydev->phy_link_change(phydev, true, true);
  54         phy_led_trigger_change_speed(phydev);
  55 }
  56
  57 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
  58 {
  59         phydev->phy_link_change(phydev, false, do_carrier);
  60         phy_led_trigger_change_speed(phydev);
  61 }
  62
  63 static const char *phy_pause_str(struct phy_device *phydev)
  64 {
  65         bool local_pause, local_asym_pause;
  66
  67         if (phydev->autoneg == AUTONEG_DISABLE)
  68                 goto no_pause;
  69
  70         local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
  71                                         phydev->advertising);
  72         local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
  73                                              phydev->advertising);
  74
  75         if (local_pause && phydev->pause)
  76                 return "rx/tx";
  77
  78         if (local_asym_pause && phydev->asym_pause) {
  79                 if (local_pause)
  80                         return "rx";
  81                 if (phydev->pause)
  82                         return "tx";
  83         }
  84
  85 no_pause:
  86         return "off";
  87 }
  88
  89 /**
  90  * phy_print_status - Convenience function to print out the current phy status
  91  * @phydev: the phy_device struct
  92  */
  93 void phy_print_status(struct phy_device *phydev)
  94 {
  95         if (phydev->link) {
  96                 netdev_info(phydev->attached_dev,
  97                         "Link is Up - %s/%s - flow control %s\n",
  98                         phy_speed_to_str(phydev->speed),
  99                         phy_duplex_to_str(phydev->duplex),
 100                         phy_pause_str(phydev));
 101         } else  {
 102                 netdev_info(phydev->attached_dev, "Link is Down\n");
 103         }
 104 }
 105 EXPORT_SYMBOL(phy_print_status);
 106
 107 /**
 108  * phy_clear_interrupt - Ack the phy device's interrupt
 109  * @phydev: the phy_device struct
 110  *
 111  * If the @phydev driver has an ack_interrupt function, call it to
 112  * ack and clear the phy device's interrupt.
 113  *
 114  * Returns 0 on success or < 0 on error.
 115  */
 116 static int phy_clear_interrupt(struct phy_device *phydev)
 117 {
 118         if (phydev->drv->ack_interrupt)
 119                 return phydev->drv->ack_interrupt(phydev);
 120
 121         return 0;
 122 }
 123
 124 /**
 125  * phy_config_interrupt - configure the PHY device for the requested interrupts
 126  * @phydev: the phy_device struct
 127  * @interrupts: interrupt flags to configure for this @phydev
 128  *
 129  * Returns 0 on success or < 0 on error.
 130  */
 131 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
 132 {
 133         phydev->interrupts = interrupts ? 1 : 0;
 134         if (phydev->drv->config_intr)
 135                 return phydev->drv->config_intr(phydev);
 136
 137         return 0;
 138 }
 139
 140 /**
 141  * phy_restart_aneg - restart auto-negotiation
 142  * @phydev: target phy_device struct
 143  *
 144  * Restart the autonegotiation on @phydev.  Returns >= 0 on success or
 145  * negative errno on error.
 146  */
 147 int phy_restart_aneg(struct phy_device *phydev)
 148 {
 149         int ret;
 150
 151         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 152                 ret = genphy_c45_restart_aneg(phydev);
 153         else
 154                 ret = genphy_restart_aneg(phydev);
 155
 156         return ret;
 157 }
 158 EXPORT_SYMBOL_GPL(phy_restart_aneg);
 159
 160 /**
 161  * phy_aneg_done - return auto-negotiation status
 162  * @phydev: target phy_device struct
 163  *
 164  * Description: Return the auto-negotiation status from this @phydev
 165  * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
 166  * is still pending.
 167  */
 168 int phy_aneg_done(struct phy_device *phydev)
 169 {
 170         if (phydev->drv && phydev->drv->aneg_done)
 171                 return phydev->drv->aneg_done(phydev);
 172         else if (phydev->is_c45)
 173                 return genphy_c45_aneg_done(phydev);
 174         else
 175                 return genphy_aneg_done(phydev);
 176 }
 177 EXPORT_SYMBOL(phy_aneg_done);
 178
 179 /**
 180  * phy_find_valid - find a PHY setting that matches the requested parameters
 181  * @speed: desired speed
 182  * @duplex: desired duplex
 183  * @supported: mask of supported link modes
 184  *
 185  * Locate a supported phy setting that is, in priority order:
 186  * - an exact match for the specified speed and duplex mode
 187  * - a match for the specified speed, or slower speed
 188  * - the slowest supported speed
 189  * Returns the matched phy_setting entry, or %NULL if no supported phy
 190  * settings were found.
 191  */
 192 static const struct phy_setting *
 193 phy_find_valid(int speed, int duplex, unsigned long *supported)
 194 {
 195         return phy_lookup_setting(speed, duplex, supported, false);
 196 }
 197
 198 /**
 199  * phy_supported_speeds - return all speeds currently supported by a phy device
 200  * @phy: The phy device to return supported speeds of.
 201  * @speeds: buffer to store supported speeds in.
 202  * @size:   size of speeds buffer.
 203  *
 204  * Description: Returns the number of supported speeds, and fills the speeds
 205  * buffer with the supported speeds. If speeds buffer is too small to contain
 206  * all currently supported speeds, will return as many speeds as can fit.
 207  */
 208 unsigned int phy_supported_speeds(struct phy_device *phy,
 209                                   unsigned int *speeds,
 210                                   unsigned int size)
 211 {
 212         return phy_speeds(speeds, size, phy->supported);
 213 }
 214
 215 /**
 216  * phy_check_valid - check if there is a valid PHY setting which matches
 217  *                   speed, duplex, and feature mask
 218  * @speed: speed to match
 219  * @duplex: duplex to match
 220  * @features: A mask of the valid settings
 221  *
 222  * Description: Returns true if there is a valid setting, false otherwise.
 223  */
 224 static inline bool phy_check_valid(int speed, int duplex,
 225                                    unsigned long *features)
 226 {
 227         return !!phy_lookup_setting(speed, duplex, features, true);
 228 }
 229
 230 /**
 231  * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
 232  * @phydev: the target phy_device struct
 233  *
 234  * Description: Make sure the PHY is set to supported speeds and
 235  *   duplexes.  Drop down by one in this order:  1000/FULL,
 236  *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
 237  */
 238 static void phy_sanitize_settings(struct phy_device *phydev)
 239 {
 240         const struct phy_setting *setting;
 241
 242         setting = phy_find_valid(phydev->speed, phydev->duplex,
 243                                  phydev->supported);
 244         if (setting) {
 245                 phydev->speed = setting->speed;
 246                 phydev->duplex = setting->duplex;
 247         } else {
 248                 /* We failed to find anything (no supported speeds?) */
 249                 phydev->speed = SPEED_UNKNOWN;
 250                 phydev->duplex = DUPLEX_UNKNOWN;
 251         }
 252 }
 253
 254 /**
 255  * phy_ethtool_sset - generic ethtool sset function, handles all the details
 256  * @phydev: target phy_device struct
 257  * @cmd: ethtool_cmd
 258  *
 259  * A few notes about parameter checking:
 260  *
 261  * - We don't set port or transceiver, so we don't care what they
 262  *   were set to.
 263  * - phy_start_aneg() will make sure forced settings are sane, and
 264  *   choose the next best ones from the ones selected, so we don't
 265  *   care if ethtool tries to give us bad values.
 266  */
 267 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
 268 {
 269         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 270         u32 speed = ethtool_cmd_speed(cmd);
 271
 272         if (cmd->phy_address != phydev->mdio.addr)
 273                 return -EINVAL;
 274
 275         /* We make sure that we don't pass unsupported values in to the PHY */
 276         ethtool_convert_legacy_u32_to_link_mode(advertising, cmd->advertising);
 277         linkmode_and(advertising, advertising, phydev->supported);
 278
 279         /* Verify the settings we care about. */
 280         if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
 281                 return -EINVAL;
 282
 283         if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
 284                 return -EINVAL;
 285
 286         if (cmd->autoneg == AUTONEG_DISABLE &&
 287             ((speed != SPEED_1000 &&
 288               speed != SPEED_100 &&
 289               speed != SPEED_10) ||
 290              (cmd->duplex != DUPLEX_HALF &&
 291               cmd->duplex != DUPLEX_FULL)))
 292                 return -EINVAL;
 293
 294         phydev->autoneg = cmd->autoneg;
 295
 296         phydev->speed = speed;
 297
 298         linkmode_copy(phydev->advertising, advertising);
 299
 300         if (AUTONEG_ENABLE == cmd->autoneg)
 301                 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
 302                                  phydev->advertising);
 303         else
 304                 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
 305                                    phydev->advertising);
 306
 307         phydev->duplex = cmd->duplex;
 308
 309         phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
 310
 311         /* Restart the PHY */
 312         phy_start_aneg(phydev);
 313
 314         return 0;
 315 }
 316 EXPORT_SYMBOL(phy_ethtool_sset);
 317
 318 int phy_ethtool_ksettings_set(struct phy_device *phydev,
 319                               const struct ethtool_link_ksettings *cmd)
 320 {
 321         __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
 322         u8 autoneg = cmd->base.autoneg;
 323         u8 duplex = cmd->base.duplex;
 324         u32 speed = cmd->base.speed;
 325
 326         if (cmd->base.phy_address != phydev->mdio.addr)
 327                 return -EINVAL;
 328
 329         linkmode_copy(advertising, cmd->link_modes.advertising);
 330
 331         /* We make sure that we don't pass unsupported values in to the PHY */
 332         linkmode_and(advertising, advertising, phydev->supported);
 333
 334         /* Verify the settings we care about. */
 335         if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
 336                 return -EINVAL;
 337
 338         if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
 339                 return -EINVAL;
 340
 341         if (autoneg == AUTONEG_DISABLE &&
 342             ((speed != SPEED_1000 &&
 343               speed != SPEED_100 &&
 344               speed != SPEED_10) ||
 345              (duplex != DUPLEX_HALF &&
 346               duplex != DUPLEX_FULL)))
 347                 return -EINVAL;
 348
 349         phydev->autoneg = autoneg;
 350
 351         phydev->speed = speed;
 352
 353         linkmode_copy(phydev->advertising, advertising);
 354
 355         if (autoneg == AUTONEG_ENABLE)
 356                 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
 357                                  phydev->advertising);
 358         else
 359                 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
 360                                    phydev->advertising);
 361
 362         phydev->duplex = duplex;
 363
 364         phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
 365
 366         /* Restart the PHY */
 367         phy_start_aneg(phydev);
 368
 369         return 0;
 370 }
 371 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
 372
 373 void phy_ethtool_ksettings_get(struct phy_device *phydev,
 374                                struct ethtool_link_ksettings *cmd)
 375 {
 376         linkmode_copy(cmd->link_modes.supported, phydev->supported);
 377         linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
 378         linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
 379
 380         cmd->base.speed = phydev->speed;
 381         cmd->base.duplex = phydev->duplex;
 382         if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
 383                 cmd->base.port = PORT_BNC;
 384         else
 385                 cmd->base.port = PORT_MII;
 386         cmd->base.transceiver = phy_is_internal(phydev) ?
 387                                 XCVR_INTERNAL : XCVR_EXTERNAL;
 388         cmd->base.phy_address = phydev->mdio.addr;
 389         cmd->base.autoneg = phydev->autoneg;
 390         cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
 391         cmd->base.eth_tp_mdix = phydev->mdix;
 392 }
 393 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
 394
 395 /**
 396  * phy_mii_ioctl - generic PHY MII ioctl interface
 397  * @phydev: the phy_device struct
 398  * @ifr: &struct ifreq for socket ioctl's
 399  * @cmd: ioctl cmd to execute
 400  *
 401  * Note that this function is currently incompatible with the
 402  * PHYCONTROL layer.  It changes registers without regard to
 403  * current state.  Use at own risk.
 404  */
 405 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
 406 {
 407         struct mii_ioctl_data *mii_data = if_mii(ifr);
 408         u16 val = mii_data->val_in;
 409         bool change_autoneg = false;
 410
 411         switch (cmd) {
 412         case SIOCGMIIPHY:
 413                 mii_data->phy_id = phydev->mdio.addr;
 414                 /* fall through */
 415
 416         case SIOCGMIIREG:
 417                 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
 418                                                  mii_data->phy_id,
 419                                                  mii_data->reg_num);
 420                 return 0;
 421
 422         case SIOCSMIIREG:
 423                 if (mii_data->phy_id == phydev->mdio.addr) {
 424                         switch (mii_data->reg_num) {
 425                         case MII_BMCR:
 426                                 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
 427                                         if (phydev->autoneg == AUTONEG_ENABLE)
 428                                                 change_autoneg = true;
 429                                         phydev->autoneg = AUTONEG_DISABLE;
 430                                         if (val & BMCR_FULLDPLX)
 431                                                 phydev->duplex = DUPLEX_FULL;
 432                                         else
 433                                                 phydev->duplex = DUPLEX_HALF;
 434                                         if (val & BMCR_SPEED1000)
 435                                                 phydev->speed = SPEED_1000;
 436                                         else if (val & BMCR_SPEED100)
 437                                                 phydev->speed = SPEED_100;
 438                                         else phydev->speed = SPEED_10;
 439                                 }
 440                                 else {
 441                                         if (phydev->autoneg == AUTONEG_DISABLE)
 442                                                 change_autoneg = true;
 443                                         phydev->autoneg = AUTONEG_ENABLE;
 444                                 }
 445                                 break;
 446                         case MII_ADVERTISE:
 447                                 mii_adv_mod_linkmode_adv_t(phydev->advertising,
 448                                                            val);
 449                                 change_autoneg = true;
 450                                 break;
 451                         default:
 452                                 /* do nothing */
 453                                 break;
 454                         }
 455                 }
 456
 457                 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
 458                               mii_data->reg_num, val);
 459
 460                 if (mii_data->phy_id == phydev->mdio.addr &&
 461                     mii_data->reg_num == MII_BMCR &&
 462                     val & BMCR_RESET)
 463                         return phy_init_hw(phydev);
 464
 465                 if (change_autoneg)
 466                         return phy_start_aneg(phydev);
 467
 468                 return 0;
 469
 470         case SIOCSHWTSTAMP:
 471                 if (phydev->drv && phydev->drv->hwtstamp)
 472                         return phydev->drv->hwtstamp(phydev, ifr);
 473                 /* fall through */
 474
 475         default:
 476                 return -EOPNOTSUPP;
 477         }
 478 }
 479 EXPORT_SYMBOL(phy_mii_ioctl);
 480
 481 static void phy_queue_state_machine(struct phy_device *phydev,
 482                                     unsigned int secs)
 483 {
 484         mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
 485                          secs * HZ);
 486 }
 487
 488 static void phy_trigger_machine(struct phy_device *phydev)
 489 {
 490         phy_queue_state_machine(phydev, 0);
 491 }
 492
 493 static int phy_config_aneg(struct phy_device *phydev)
 494 {
 495         if (phydev->drv->config_aneg)
 496                 return phydev->drv->config_aneg(phydev);
 497
 498         /* Clause 45 PHYs that don't implement Clause 22 registers are not
 499          * allowed to call genphy_config_aneg()
 500          */
 501         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 502                 return -EOPNOTSUPP;
 503
 504         return genphy_config_aneg(phydev);
 505 }
 506
 507 /**
 508  * phy_check_link_status - check link status and set state accordingly
 509  * @phydev: the phy_device struct
 510  *
 511  * Description: Check for link and whether autoneg was triggered / is running
 512  * and set state accordingly
 513  */
 514 static int phy_check_link_status(struct phy_device *phydev)
 515 {
 516         int err;
 517
 518         WARN_ON(!mutex_is_locked(&phydev->lock));
 519
 520         err = phy_read_status(phydev);
 521         if (err)
 522                 return err;
 523
 524         if (phydev->link && phydev->state != PHY_RUNNING) {
 525                 phydev->state = PHY_RUNNING;
 526                 phy_link_up(phydev);
 527         } else if (!phydev->link && phydev->state != PHY_NOLINK) {
 528                 phydev->state = PHY_NOLINK;
 529                 phy_link_down(phydev, true);
 530         }
 531
 532         return 0;
 533 }
 534
 535 /**
 536  * phy_start_aneg - start auto-negotiation for this PHY device
 537  * @phydev: the phy_device struct
 538  *
 539  * Description: Sanitizes the settings (if we're not autonegotiating
 540  *   them), and then calls the driver's config_aneg function.
 541  *   If the PHYCONTROL Layer is operating, we change the state to
 542  *   reflect the beginning of Auto-negotiation or forcing.
 543  */
 544 int phy_start_aneg(struct phy_device *phydev)
 545 {
 546         int err;
 547
 548         if (!phydev->drv)
 549                 return -EIO;
 550
 551         mutex_lock(&phydev->lock);
 552
 553         if (AUTONEG_DISABLE == phydev->autoneg)
 554                 phy_sanitize_settings(phydev);
 555
 556         /* Invalidate LP advertising flags */
 557         linkmode_zero(phydev->lp_advertising);
 558
 559         err = phy_config_aneg(phydev);
 560         if (err < 0)
 561                 goto out_unlock;
 562
 563         if (phy_is_started(phydev)) {
 564                 if (phydev->autoneg == AUTONEG_ENABLE) {
 565                         err = phy_check_link_status(phydev);
 566                 } else {
 567                         phydev->state = PHY_FORCING;
 568                         phydev->link_timeout = PHY_FORCE_TIMEOUT;
 569                 }
 570         }
 571
 572 out_unlock:
 573         mutex_unlock(&phydev->lock);
 574
 575         return err;
 576 }
 577 EXPORT_SYMBOL(phy_start_aneg);
 578
 579 static int phy_poll_aneg_done(struct phy_device *phydev)
 580 {
 581         unsigned int retries = 100;
 582         int ret;
 583
 584         do {
 585                 msleep(100);
 586                 ret = phy_aneg_done(phydev);
 587         } while (!ret && --retries);
 588
 589         if (!ret)
 590                 return -ETIMEDOUT;
 591
 592         return ret < 0 ? ret : 0;
 593 }
 594
 595 /**
 596  * phy_speed_down - set speed to lowest speed supported by both link partners
 597  * @phydev: the phy_device struct
 598  * @sync: perform action synchronously
 599  *
 600  * Description: Typically used to save energy when waiting for a WoL packet
 601  *
 602  * WARNING: Setting sync to false may cause the system being unable to suspend
 603  * in case the PHY generates an interrupt when finishing the autonegotiation.
 604  * This interrupt may wake up the system immediately after suspend.
 605  * Therefore use sync = false only if you're sure it's safe with the respective
 606  * network chip.
 607  */
 608 int phy_speed_down(struct phy_device *phydev, bool sync)
 609 {
 610         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
 611         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
 612         int ret;
 613
 614         if (phydev->autoneg != AUTONEG_ENABLE)
 615                 return 0;
 616
 617         linkmode_copy(adv_old, phydev->advertising);
 618         linkmode_copy(adv, phydev->lp_advertising);
 619         linkmode_and(adv, adv, phydev->supported);
 620
 621         if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, adv) ||
 622             linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, adv)) {
 623                 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
 624                                    phydev->advertising);
 625                 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 626                                    phydev->advertising);
 627                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
 628                                    phydev->advertising);
 629                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 630                                    phydev->advertising);
 631         } else if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
 632                                      adv) ||
 633                    linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 634                                      adv)) {
 635                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
 636                                    phydev->advertising);
 637                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 638                                    phydev->advertising);
 639         }
 640
 641         if (linkmode_equal(phydev->advertising, adv_old))
 642                 return 0;
 643
 644         ret = phy_config_aneg(phydev);
 645         if (ret)
 646                 return ret;
 647
 648         return sync ? phy_poll_aneg_done(phydev) : 0;
 649 }
 650 EXPORT_SYMBOL_GPL(phy_speed_down);
 651
 652 /**
 653  * phy_speed_up - (re)set advertised speeds to all supported speeds
 654  * @phydev: the phy_device struct
 655  *
 656  * Description: Used to revert the effect of phy_speed_down
 657  */
 658 int phy_speed_up(struct phy_device *phydev)
 659 {
 660         __ETHTOOL_DECLARE_LINK_MODE_MASK(all_speeds) = { 0, };
 661         __ETHTOOL_DECLARE_LINK_MODE_MASK(not_speeds);
 662         __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 663         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
 664         __ETHTOOL_DECLARE_LINK_MODE_MASK(speeds);
 665
 666         linkmode_copy(adv_old, phydev->advertising);
 667
 668         if (phydev->autoneg != AUTONEG_ENABLE)
 669                 return 0;
 670
 671         linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, all_speeds);
 672         linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, all_speeds);
 673         linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, all_speeds);
 674         linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, all_speeds);
 675         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, all_speeds);
 676         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, all_speeds);
 677
 678         linkmode_andnot(not_speeds, adv_old, all_speeds);
 679         linkmode_copy(supported, phydev->supported);
 680         linkmode_and(speeds, supported, all_speeds);
 681         linkmode_or(phydev->advertising, not_speeds, speeds);
 682
 683         if (linkmode_equal(phydev->advertising, adv_old))
 684                 return 0;
 685
 686         return phy_config_aneg(phydev);
 687 }
 688 EXPORT_SYMBOL_GPL(phy_speed_up);
 689
 690 /**
 691  * phy_start_machine - start PHY state machine tracking
 692  * @phydev: the phy_device struct
 693  *
 694  * Description: The PHY infrastructure can run a state machine
 695  *   which tracks whether the PHY is starting up, negotiating,
 696  *   etc.  This function starts the delayed workqueue which tracks
 697  *   the state of the PHY. If you want to maintain your own state machine,
 698  *   do not call this function.
 699  */
 700 void phy_start_machine(struct phy_device *phydev)
 701 {
 702         phy_trigger_machine(phydev);
 703 }
 704 EXPORT_SYMBOL_GPL(phy_start_machine);
 705
 706 /**
 707  * phy_stop_machine - stop the PHY state machine tracking
 708  * @phydev: target phy_device struct
 709  *
 710  * Description: Stops the state machine delayed workqueue, sets the
 711  *   state to UP (unless it wasn't up yet). This function must be
 712  *   called BEFORE phy_detach.
 713  */
 714 void phy_stop_machine(struct phy_device *phydev)
 715 {
 716         cancel_delayed_work_sync(&phydev->state_queue);
 717
 718         mutex_lock(&phydev->lock);
 719         if (phy_is_started(phydev))
 720                 phydev->state = PHY_UP;
 721         mutex_unlock(&phydev->lock);
 722 }
 723
 724 /**
 725  * phy_error - enter HALTED state for this PHY device
 726  * @phydev: target phy_device struct
 727  *
 728  * Moves the PHY to the HALTED state in response to a read
 729  * or write error, and tells the controller the link is down.
 730  * Must not be called from interrupt context, or while the
 731  * phydev->lock is held.
 732  */
 733 static void phy_error(struct phy_device *phydev)
 734 {
 735         WARN_ON(1);
 736
 737         mutex_lock(&phydev->lock);
 738         phydev->state = PHY_HALTED;
 739         mutex_unlock(&phydev->lock);
 740
 741         phy_trigger_machine(phydev);
 742 }
 743
 744 /**
 745  * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
 746  * @phydev: target phy_device struct
 747  */
 748 static int phy_disable_interrupts(struct phy_device *phydev)
 749 {
 750         int err;
 751
 752         /* Disable PHY interrupts */
 753         err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
 754         if (err)
 755                 return err;
 756
 757         /* Clear the interrupt */
 758         return phy_clear_interrupt(phydev);
 759 }
 760
 761 /**
 762  * phy_interrupt - PHY interrupt handler
 763  * @irq: interrupt line
 764  * @phy_dat: phy_device pointer
 765  *
 766  * Description: Handle PHY interrupt
 767  */
 768 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
 769 {
 770         struct phy_device *phydev = phy_dat;
 771
 772         if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
 773                 return IRQ_NONE;
 774
 775         /* reschedule state queue work to run as soon as possible */
 776         phy_trigger_machine(phydev);
 777
 778         if (phy_clear_interrupt(phydev))
 779                 goto phy_err;
 780         return IRQ_HANDLED;
 781
 782 phy_err:
 783         phy_error(phydev);
 784         return IRQ_NONE;
 785 }
 786
 787 /**
 788  * phy_enable_interrupts - Enable the interrupts from the PHY side
 789  * @phydev: target phy_device struct
 790  */
 791 static int phy_enable_interrupts(struct phy_device *phydev)
 792 {
 793         int err = phy_clear_interrupt(phydev);
 794
 795         if (err < 0)
 796                 return err;
 797
 798         return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
 799 }
 800
 801 /**
 802  * phy_request_interrupt - request interrupt for a PHY device
 803  * @phydev: target phy_device struct
 804  *
 805  * Description: Request the interrupt for the given PHY.
 806  *   If this fails, then we set irq to PHY_POLL.
 807  *   This should only be called with a valid IRQ number.
 808  */
 809 void phy_request_interrupt(struct phy_device *phydev)
 810 {
 811         int err;
 812
 813         err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
 814                                    IRQF_ONESHOT | IRQF_SHARED,
 815                                    phydev_name(phydev), phydev);
 816         if (err) {
 817                 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
 818                             err, phydev->irq);
 819                 phydev->irq = PHY_POLL;
 820         }
 821 }
 822 EXPORT_SYMBOL(phy_request_interrupt);
 823
 824 /**
 825  * phy_stop - Bring down the PHY link, and stop checking the status
 826  * @phydev: target phy_device struct
 827  */
 828 void phy_stop(struct phy_device *phydev)
 829 {
 830         if (!phy_is_started(phydev)) {
 831                 WARN(1, "called from state %s\n",
 832                      phy_state_to_str(phydev->state));
 833                 return;
 834         }
 835
 836         mutex_lock(&phydev->lock);
 837
 838         if (phy_interrupt_is_valid(phydev))
 839                 phy_disable_interrupts(phydev);
 840
 841         phydev->state = PHY_HALTED;
 842
 843         mutex_unlock(&phydev->lock);
 844
 845         phy_state_machine(&phydev->state_queue.work);
 846         phy_stop_machine(phydev);
 847
 848         /* Cannot call flush_scheduled_work() here as desired because
 849          * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
 850          * will not reenable interrupts.
 851          */
 852 }
 853 EXPORT_SYMBOL(phy_stop);
 854
 855 /**
 856  * phy_start - start or restart a PHY device
 857  * @phydev: target phy_device struct
 858  *
 859  * Description: Indicates the attached device's readiness to
 860  *   handle PHY-related work.  Used during startup to start the
 861  *   PHY, and after a call to phy_stop() to resume operation.
 862  *   Also used to indicate the MDIO bus has cleared an error
 863  *   condition.
 864  */
 865 void phy_start(struct phy_device *phydev)
 866 {
 867         int err;
 868
 869         mutex_lock(&phydev->lock);
 870
 871         if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
 872                 WARN(1, "called from state %s\n",
 873                      phy_state_to_str(phydev->state));
 874                 goto out;
 875         }
 876
 877         /* if phy was suspended, bring the physical link up again */
 878         __phy_resume(phydev);
 879
 880         /* make sure interrupts are enabled for the PHY */
 881         if (phy_interrupt_is_valid(phydev)) {
 882                 err = phy_enable_interrupts(phydev);
 883                 if (err < 0)
 884                         goto out;
 885         }
 886
 887         phydev->state = PHY_UP;
 888
 889         phy_start_machine(phydev);
 890 out:
 891         mutex_unlock(&phydev->lock);
 892 }
 893 EXPORT_SYMBOL(phy_start);
 894
 895 /**
 896  * phy_state_machine - Handle the state machine
 897  * @work: work_struct that describes the work to be done
 898  */
 899 void phy_state_machine(struct work_struct *work)
 900 {
 901         struct delayed_work *dwork = to_delayed_work(work);
 902         struct phy_device *phydev =
 903                         container_of(dwork, struct phy_device, state_queue);
 904         bool needs_aneg = false, do_suspend = false;
 905         enum phy_state old_state;
 906         int err = 0;
 907
 908         mutex_lock(&phydev->lock);
 909
 910         old_state = phydev->state;
 911
 912         switch (phydev->state) {
 913         case PHY_DOWN:
 914         case PHY_READY:
 915                 break;
 916         case PHY_UP:
 917                 needs_aneg = true;
 918
 919                 break;
 920         case PHY_NOLINK:
 921         case PHY_RUNNING:
 922                 err = phy_check_link_status(phydev);
 923                 break;
 924         case PHY_FORCING:
 925                 err = genphy_update_link(phydev);
 926                 if (err)
 927                         break;
 928
 929                 if (phydev->link) {
 930                         phydev->state = PHY_RUNNING;
 931                         phy_link_up(phydev);
 932                 } else {
 933                         if (0 == phydev->link_timeout--)
 934                                 needs_aneg = true;
 935                         phy_link_down(phydev, false);
 936                 }
 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);