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                         case MII_CTRL1000:
 461                                 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
 462                                                                 val);
 463                                 change_autoneg = true;
 464                                 break;
 465                         default:
 466                                 /* do nothing */
 467                                 break;
 468                         }
 469                 }
 470
 471                 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
 472
 473                 if (prtad == phydev->mdio.addr &&
 474                     devad == MII_BMCR &&
 475                     val & BMCR_RESET)
 476                         return phy_init_hw(phydev);
 477
 478                 if (change_autoneg)
 479                         return phy_start_aneg(phydev);
 480
 481                 return 0;
 482
 483         case SIOCSHWTSTAMP:
 484                 if (phydev->drv && phydev->drv->hwtstamp)
 485                         return phydev->drv->hwtstamp(phydev, ifr);
 486                 /* fall through */
 487
 488         default:
 489                 return -EOPNOTSUPP;
 490         }
 491 }
 492 EXPORT_SYMBOL(phy_mii_ioctl);
 493
 494 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
 495 {
 496         mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
 497                          jiffies);
 498 }
 499 EXPORT_SYMBOL(phy_queue_state_machine);
 500
 501 static void phy_trigger_machine(struct phy_device *phydev)
 502 {
 503         phy_queue_state_machine(phydev, 0);
 504 }
 505
 506 static int phy_config_aneg(struct phy_device *phydev)
 507 {
 508         if (phydev->drv->config_aneg)
 509                 return phydev->drv->config_aneg(phydev);
 510
 511         /* Clause 45 PHYs that don't implement Clause 22 registers are not
 512          * allowed to call genphy_config_aneg()
 513          */
 514         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 515                 return genphy_c45_config_aneg(phydev);
 516
 517         return genphy_config_aneg(phydev);
 518 }
 519
 520 /**
 521  * phy_check_link_status - check link status and set state accordingly
 522  * @phydev: the phy_device struct
 523  *
 524  * Description: Check for link and whether autoneg was triggered / is running
 525  * and set state accordingly
 526  */
 527 static int phy_check_link_status(struct phy_device *phydev)
 528 {
 529         int err;
 530
 531         WARN_ON(!mutex_is_locked(&phydev->lock));
 532
 533         /* Keep previous state if loopback is enabled because some PHYs
 534          * report that Link is Down when loopback is enabled.
 535          */
 536         if (phydev->loopback_enabled)
 537                 return 0;
 538
 539         err = phy_read_status(phydev);
 540         if (err)
 541                 return err;
 542
 543         if (phydev->link && phydev->state != PHY_RUNNING) {
 544                 phydev->state = PHY_RUNNING;
 545                 phy_link_up(phydev);
 546         } else if (!phydev->link && phydev->state != PHY_NOLINK) {
 547                 phydev->state = PHY_NOLINK;
 548                 phy_link_down(phydev, true);
 549         }
 550
 551         return 0;
 552 }
 553
 554 /**
 555  * phy_start_aneg - start auto-negotiation for this PHY device
 556  * @phydev: the phy_device struct
 557  *
 558  * Description: Sanitizes the settings (if we're not autonegotiating
 559  *   them), and then calls the driver's config_aneg function.
 560  *   If the PHYCONTROL Layer is operating, we change the state to
 561  *   reflect the beginning of Auto-negotiation or forcing.
 562  */
 563 int phy_start_aneg(struct phy_device *phydev)
 564 {
 565         int err;
 566
 567         if (!phydev->drv)
 568                 return -EIO;
 569
 570         mutex_lock(&phydev->lock);
 571
 572         if (AUTONEG_DISABLE == phydev->autoneg)
 573                 phy_sanitize_settings(phydev);
 574
 575         /* Invalidate LP advertising flags */
 576         linkmode_zero(phydev->lp_advertising);
 577
 578         err = phy_config_aneg(phydev);
 579         if (err < 0)
 580                 goto out_unlock;
 581
 582         if (phy_is_started(phydev))
 583                 err = phy_check_link_status(phydev);
 584 out_unlock:
 585         mutex_unlock(&phydev->lock);
 586
 587         return err;
 588 }
 589 EXPORT_SYMBOL(phy_start_aneg);
 590
 591 static int phy_poll_aneg_done(struct phy_device *phydev)
 592 {
 593         unsigned int retries = 100;
 594         int ret;
 595
 596         do {
 597                 msleep(100);
 598                 ret = phy_aneg_done(phydev);
 599         } while (!ret && --retries);
 600
 601         if (!ret)
 602                 return -ETIMEDOUT;
 603
 604         return ret < 0 ? ret : 0;
 605 }
 606
 607 /**
 608  * phy_speed_down - set speed to lowest speed supported by both link partners
 609  * @phydev: the phy_device struct
 610  * @sync: perform action synchronously
 611  *
 612  * Description: Typically used to save energy when waiting for a WoL packet
 613  *
 614  * WARNING: Setting sync to false may cause the system being unable to suspend
 615  * in case the PHY generates an interrupt when finishing the autonegotiation.
 616  * This interrupt may wake up the system immediately after suspend.
 617  * Therefore use sync = false only if you're sure it's safe with the respective
 618  * network chip.
 619  */
 620 int phy_speed_down(struct phy_device *phydev, bool sync)
 621 {
 622         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
 623         int ret;
 624
 625         if (phydev->autoneg != AUTONEG_ENABLE)
 626                 return 0;
 627
 628         linkmode_copy(adv_tmp, phydev->advertising);
 629
 630         ret = phy_speed_down_core(phydev);
 631         if (ret)
 632                 return ret;
 633
 634         linkmode_copy(phydev->adv_old, adv_tmp);
 635
 636         if (linkmode_equal(phydev->advertising, adv_tmp))
 637                 return 0;
 638
 639         ret = phy_config_aneg(phydev);
 640         if (ret)
 641                 return ret;
 642
 643         return sync ? phy_poll_aneg_done(phydev) : 0;
 644 }
 645 EXPORT_SYMBOL_GPL(phy_speed_down);
 646
 647 /**
 648  * phy_speed_up - (re)set advertised speeds to all supported speeds
 649  * @phydev: the phy_device struct
 650  *
 651  * Description: Used to revert the effect of phy_speed_down
 652  */
 653 int phy_speed_up(struct phy_device *phydev)
 654 {
 655         __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
 656
 657         if (phydev->autoneg != AUTONEG_ENABLE)
 658                 return 0;
 659
 660         if (linkmode_empty(phydev->adv_old))
 661                 return 0;
 662
 663         linkmode_copy(adv_tmp, phydev->advertising);
 664         linkmode_copy(phydev->advertising, phydev->adv_old);
 665         linkmode_zero(phydev->adv_old);
 666
 667         if (linkmode_equal(phydev->advertising, adv_tmp))
 668                 return 0;
 669
 670         return phy_config_aneg(phydev);
 671 }
 672 EXPORT_SYMBOL_GPL(phy_speed_up);
 673
 674 /**
 675  * phy_start_machine - start PHY state machine tracking
 676  * @phydev: the phy_device struct
 677  *
 678  * Description: The PHY infrastructure can run a state machine
 679  *   which tracks whether the PHY is starting up, negotiating,
 680  *   etc.  This function starts the delayed workqueue which tracks
 681  *   the state of the PHY. If you want to maintain your own state machine,
 682  *   do not call this function.
 683  */
 684 void phy_start_machine(struct phy_device *phydev)
 685 {
 686         phy_trigger_machine(phydev);
 687 }
 688 EXPORT_SYMBOL_GPL(phy_start_machine);
 689
 690 /**
 691  * phy_stop_machine - stop the PHY state machine tracking
 692  * @phydev: target phy_device struct
 693  *
 694  * Description: Stops the state machine delayed workqueue, sets the
 695  *   state to UP (unless it wasn't up yet). This function must be
 696  *   called BEFORE phy_detach.
 697  */
 698 void phy_stop_machine(struct phy_device *phydev)
 699 {
 700         cancel_delayed_work_sync(&phydev->state_queue);
 701
 702         mutex_lock(&phydev->lock);
 703         if (phy_is_started(phydev))
 704                 phydev->state = PHY_UP;
 705         mutex_unlock(&phydev->lock);
 706 }
 707
 708 /**
 709  * phy_error - enter HALTED state for this PHY device
 710  * @phydev: target phy_device struct
 711  *
 712  * Moves the PHY to the HALTED state in response to a read
 713  * or write error, and tells the controller the link is down.
 714  * Must not be called from interrupt context, or while the
 715  * phydev->lock is held.
 716  */
 717 static void phy_error(struct phy_device *phydev)
 718 {
 719         WARN_ON(1);
 720
 721         mutex_lock(&phydev->lock);
 722         phydev->state = PHY_HALTED;
 723         mutex_unlock(&phydev->lock);
 724
 725         phy_trigger_machine(phydev);
 726 }
 727
 728 /**
 729  * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
 730  * @phydev: target phy_device struct
 731  */
 732 static int phy_disable_interrupts(struct phy_device *phydev)
 733 {
 734         int err;
 735
 736         /* Disable PHY interrupts */
 737         err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
 738         if (err)
 739                 return err;
 740
 741         /* Clear the interrupt */
 742         return phy_clear_interrupt(phydev);
 743 }
 744
 745 /**
 746  * phy_interrupt - PHY interrupt handler
 747  * @irq: interrupt line
 748  * @phy_dat: phy_device pointer
 749  *
 750  * Description: Handle PHY interrupt
 751  */
 752 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
 753 {
 754         struct phy_device *phydev = phy_dat;
 755
 756         if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
 757                 return IRQ_NONE;
 758
 759         if (phydev->drv->handle_interrupt) {
 760                 if (phydev->drv->handle_interrupt(phydev))
 761                         goto phy_err;
 762         } else {
 763                 /* reschedule state queue work to run as soon as possible */
 764                 phy_trigger_machine(phydev);
 765         }
 766
 767         if (phy_clear_interrupt(phydev))
 768                 goto phy_err;
 769         return IRQ_HANDLED;
 770
 771 phy_err:
 772         phy_error(phydev);
 773         return IRQ_NONE;
 774 }
 775
 776 /**
 777  * phy_enable_interrupts - Enable the interrupts from the PHY side
 778  * @phydev: target phy_device struct
 779  */
 780 static int phy_enable_interrupts(struct phy_device *phydev)
 781 {
 782         int err = phy_clear_interrupt(phydev);
 783
 784         if (err < 0)
 785                 return err;
 786
 787         return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
 788 }
 789
 790 /**
 791  * phy_request_interrupt - request and enable interrupt for a PHY device
 792  * @phydev: target phy_device struct
 793  *
 794  * Description: Request and enable the interrupt for the given PHY.
 795  *   If this fails, then we set irq to PHY_POLL.
 796  *   This should only be called with a valid IRQ number.
 797  */
 798 void phy_request_interrupt(struct phy_device *phydev)
 799 {
 800         int err;
 801
 802         err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
 803                                    IRQF_ONESHOT | IRQF_SHARED,
 804                                    phydev_name(phydev), phydev);
 805         if (err) {
 806                 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
 807                             err, phydev->irq);
 808                 phydev->irq = PHY_POLL;
 809         } else {
 810                 if (phy_enable_interrupts(phydev)) {
 811                         phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
 812                         phy_free_interrupt(phydev);
 813                         phydev->irq = PHY_POLL;
 814                 }
 815         }
 816 }
 817 EXPORT_SYMBOL(phy_request_interrupt);
 818
 819 /**
 820  * phy_free_interrupt - disable and free interrupt for a PHY device
 821  * @phydev: target phy_device struct
 822  *
 823  * Description: Disable and free the interrupt for the given PHY.
 824  *   This should only be called with a valid IRQ number.
 825  */
 826 void phy_free_interrupt(struct phy_device *phydev)
 827 {
 828         phy_disable_interrupts(phydev);
 829         free_irq(phydev->irq, phydev);
 830 }
 831 EXPORT_SYMBOL(phy_free_interrupt);
 832
 833 /**
 834  * phy_stop - Bring down the PHY link, and stop checking the status
 835  * @phydev: target phy_device struct
 836  */
 837 void phy_stop(struct phy_device *phydev)
 838 {
 839         if (!phy_is_started(phydev)) {
 840                 WARN(1, "called from state %s\n",
 841                      phy_state_to_str(phydev->state));
 842                 return;
 843         }
 844
 845         mutex_lock(&phydev->lock);
 846
 847         phydev->state = PHY_HALTED;
 848
 849         mutex_unlock(&phydev->lock);
 850
 851         phy_state_machine(&phydev->state_queue.work);
 852         phy_stop_machine(phydev);
 853
 854         /* Cannot call flush_scheduled_work() here as desired because
 855          * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
 856          * will not reenable interrupts.
 857          */
 858 }
 859 EXPORT_SYMBOL(phy_stop);
 860
 861 /**
 862  * phy_start - start or restart a PHY device
 863  * @phydev: target phy_device struct
 864  *
 865  * Description: Indicates the attached device's readiness to
 866  *   handle PHY-related work.  Used during startup to start the
 867  *   PHY, and after a call to phy_stop() to resume operation.
 868  *   Also used to indicate the MDIO bus has cleared an error
 869  *   condition.
 870  */
 871 void phy_start(struct phy_device *phydev)
 872 {
 873         mutex_lock(&phydev->lock);
 874
 875         if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
 876                 WARN(1, "called from state %s\n",
 877                      phy_state_to_str(phydev->state));
 878                 goto out;
 879         }
 880
 881         /* if phy was suspended, bring the physical link up again */
 882         __phy_resume(phydev);
 883
 884         phydev->state = PHY_UP;
 885
 886         phy_start_machine(phydev);
 887 out:
 888         mutex_unlock(&phydev->lock);
 889 }
 890 EXPORT_SYMBOL(phy_start);
 891
 892 /**
 893  * phy_state_machine - Handle the state machine
 894  * @work: work_struct that describes the work to be done
 895  */
 896 void phy_state_machine(struct work_struct *work)
 897 {
 898         struct delayed_work *dwork = to_delayed_work(work);
 899         struct phy_device *phydev =
 900                         container_of(dwork, struct phy_device, state_queue);
 901         bool needs_aneg = false, do_suspend = false;
 902         enum phy_state old_state;
 903         int err = 0;
 904
 905         mutex_lock(&phydev->lock);
 906
 907         old_state = phydev->state;
 908
 909         switch (phydev->state) {
 910         case PHY_DOWN:
 911         case PHY_READY:
 912                 break;
 913         case PHY_UP:
 914                 needs_aneg = true;
 915
 916                 break;
 917         case PHY_NOLINK:
 918         case PHY_RUNNING:
 919                 err = phy_check_link_status(phydev);
 920                 break;
 921         case PHY_HALTED:
 922                 if (phydev->link) {
 923                         phydev->link = 0;
 924                         phy_link_down(phydev, true);
 925                 }
 926                 do_suspend = true;
 927                 break;
 928         }
 929
 930         mutex_unlock(&phydev->lock);
 931
 932         if (needs_aneg)
 933                 err = phy_start_aneg(phydev);
 934         else if (do_suspend)
 935                 phy_suspend(phydev);
 936
 937         if (err < 0)
 938                 phy_error(phydev);
 939
 940         if (old_state != phydev->state) {
 941                 phydev_dbg(phydev, "PHY state change %s -> %s\n",
 942                            phy_state_to_str(old_state),
 943                            phy_state_to_str(phydev->state));
 944                 if (phydev->drv && phydev->drv->link_change_notify)
 945                         phydev->drv->link_change_notify(phydev);
 946         }
 947
 948         /* Only re-schedule a PHY state machine change if we are polling the
 949          * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
 950          * between states from phy_mac_interrupt().
 951          *
 952          * In state PHY_HALTED the PHY gets suspended, so rescheduling the
 953          * state machine would be pointless and possibly error prone when
 954          * called from phy_disconnect() synchronously.
 955          */
 956         mutex_lock(&phydev->lock);
 957         if (phy_polling_mode(phydev) && phy_is_started(phydev))
 958                 phy_queue_state_machine(phydev, PHY_STATE_TIME);
 959         mutex_unlock(&phydev->lock);
 960 }
 961
 962 /**
 963  * phy_mac_interrupt - MAC says the link has changed
 964  * @phydev: phy_device struct with changed link
 965  *
 966  * The MAC layer is able to indicate there has been a change in the PHY link
 967  * status. Trigger the state machine and work a work queue.
 968  */
 969 void phy_mac_interrupt(struct phy_device *phydev)
 970 {
 971         /* Trigger a state machine change */
 972         phy_trigger_machine(phydev);
 973 }
 974 EXPORT_SYMBOL(phy_mac_interrupt);
 975
 976 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
 977 {
 978         linkmode_zero(advertising);
 979
 980         if (eee_adv & MDIO_EEE_100TX)
 981                 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 982                                  advertising);
 983         if (eee_adv & MDIO_EEE_1000T)
 984                 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 985                                  advertising);
 986         if (eee_adv & MDIO_EEE_10GT)
 987                 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
 988                                  advertising);
 989         if (eee_adv & MDIO_EEE_1000KX)
 990                 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
 991                                  advertising);
 992         if (eee_adv & MDIO_EEE_10GKX4)
 993                 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
 994                                  advertising);
 995         if (eee_adv & MDIO_EEE_10GKR)
 996                 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
 997                                  advertising);
 998 }
 999
1000 /**
1001  * phy_init_eee - init and check the EEE feature
1002  * @phydev: target phy_device struct
1003  * @clk_stop_enable: PHY may stop the clock during LPI
1004  *
1005  * Description: it checks if the Energy-Efficient Ethernet (EEE)
1006  * is supported by looking at the MMD registers 3.20 and 7.60/61
1007  * and it programs the MMD register 3.0 setting the "Clock stop enable"
1008  * bit if required.
1009  */
1010 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1011 {
1012         if (!phydev->drv)
1013                 return -EIO;
1014
1015         /* According to 802.3az,the EEE is supported only in full duplex-mode.
1016          */
1017         if (phydev->duplex == DUPLEX_FULL) {
1018                 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1019                 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1020                 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1021                 int eee_lp, eee_cap, eee_adv;
1022                 int status;
1023                 u32 cap;
1024
1025                 /* Read phy status to properly get the right settings */
1026                 status = phy_read_status(phydev);
1027                 if (status)
1028                         return status;
1029
1030                 /* First check if the EEE ability is supported */
1031                 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1032                 if (eee_cap <= 0)
1033                         goto eee_exit_err;
1034
1035                 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1036                 if (!cap)
1037                         goto eee_exit_err;
1038
1039                 /* Check which link settings negotiated and verify it in
1040                  * the EEE advertising registers.
1041                  */
1042                 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1043                 if (eee_lp <= 0)
1044                         goto eee_exit_err;
1045
1046                 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1047                 if (eee_adv <= 0)
1048                         goto eee_exit_err;
1049
1050                 mmd_eee_adv_to_linkmode(adv, eee_adv);
1051                 mmd_eee_adv_to_linkmode(lp, eee_lp);
1052                 linkmode_and(common, adv, lp);
1053
1054                 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1055                         goto eee_exit_err;
1056
1057                 if (clk_stop_enable)
1058                         /* Configure the PHY to stop receiving xMII
1059                          * clock while it is signaling LPI.
1060                          */
1061                         phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1062                                          MDIO_PCS_CTRL1_CLKSTOP_EN);
1063
1064                 return 0; /* EEE supported */
1065         }
1066 eee_exit_err:
1067         return -EPROTONOSUPPORT;
1068 }
1069 EXPORT_SYMBOL(phy_init_eee);
1070
1071 /**
1072  * phy_get_eee_err - report the EEE wake error count
1073  * @phydev: target phy_device struct
1074  *
1075  * Description: it is to report the number of time where the PHY
1076  * failed to complete its normal wake sequence.
1077  */
1078 int phy_get_eee_err(struct phy_device *phydev)
1079 {
1080         if (!phydev->drv)
1081                 return -EIO;
1082
1083         return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1084 }
1085 EXPORT_SYMBOL(phy_get_eee_err);
1086
1087 /**
1088  * phy_ethtool_get_eee - get EEE supported and status
1089  * @phydev: target phy_device struct
1090  * @data: ethtool_eee data
1091  *
1092  * Description: it reportes the Supported/Advertisement/LP Advertisement
1093  * capabilities.
1094  */
1095 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1096 {
1097         int val;
1098
1099         if (!phydev->drv)
1100                 return -EIO;
1101
1102         /* Get Supported EEE */
1103         val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1104         if (val < 0)
1105                 return val;
1106         data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1107
1108         /* Get advertisement EEE */
1109         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1110         if (val < 0)
1111                 return val;
1112         data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1113         data->eee_enabled = !!data->advertised;
1114
1115         /* Get LP advertisement EEE */
1116         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1117         if (val < 0)
1118                 return val;
1119         data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1120
1121         data->eee_active = !!(data->advertised & data->lp_advertised);
1122
1123         return 0;
1124 }
1125 EXPORT_SYMBOL(phy_ethtool_get_eee);
1126
1127 /**
1128  * phy_ethtool_set_eee - set EEE supported and status
1129  * @phydev: target phy_device struct
1130  * @data: ethtool_eee data
1131  *
1132  * Description: it is to program the Advertisement EEE register.
1133  */
1134 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1135 {
1136         int cap, old_adv, adv = 0, ret;
1137
1138         if (!phydev->drv)
1139                 return -EIO;
1140
1141         /* Get Supported EEE */
1142         cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1143         if (cap < 0)
1144                 return cap;
1145
1146         old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1147         if (old_adv < 0)
1148                 return old_adv;
1149
1150         if (data->eee_enabled) {
1151                 adv = !data->advertised ? cap :
1152                       ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1153                 /* Mask prohibited EEE modes */
1154                 adv &= ~phydev->eee_broken_modes;
1155         }
1156
1157         if (old_adv != adv) {
1158                 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1159                 if (ret < 0)
1160                         return ret;
1161
1162                 /* Restart autonegotiation so the new modes get sent to the
1163                  * link partner.
1164                  */
1165                 ret = phy_restart_aneg(phydev);
1166                 if (ret < 0)
1167                         return ret;
1168         }
1169
1170         return 0;
1171 }
1172 EXPORT_SYMBOL(phy_ethtool_set_eee);
1173
1174 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1175 {
1176         if (phydev->drv && phydev->drv->set_wol)
1177                 return phydev->drv->set_wol(phydev, wol);
1178
1179         return -EOPNOTSUPP;
1180 }
1181 EXPORT_SYMBOL(phy_ethtool_set_wol);
1182
1183 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1184 {
1185         if (phydev->drv && phydev->drv->get_wol)
1186                 phydev->drv->get_wol(phydev, wol);
1187 }
1188 EXPORT_SYMBOL(phy_ethtool_get_wol);
1189
1190 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1191                                    struct ethtool_link_ksettings *cmd)
1192 {
1193         struct phy_device *phydev = ndev->phydev;
1194
1195         if (!phydev)
1196                 return -ENODEV;
1197
1198         phy_ethtool_ksettings_get(phydev, cmd);
1199
1200         return 0;
1201 }
1202 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1203
1204 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1205                                    const struct ethtool_link_ksettings *cmd)
1206 {
1207         struct phy_device *phydev = ndev->phydev;
1208
1209         if (!phydev)
1210                 return -ENODEV;
1211
1212         return phy_ethtool_ksettings_set(phydev, cmd);
1213 }
1214 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1215
1216 int phy_ethtool_nway_reset(struct net_device *ndev)
1217 {
1218         struct phy_device *phydev = ndev->phydev;
1219
1220         if (!phydev)
1221                 return -ENODEV;
1222
1223         if (!phydev->drv)
1224                 return -EIO;
1225
1226         return phy_restart_aneg(phydev);
1227 }
1228 EXPORT_SYMBOL(phy_ethtool_nway_reset);