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