drivers/net/phy/phy.c

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