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