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