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