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/timer.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 static const char *phy_speed_to_str(int speed)
  42 {
  43         switch (speed) {
  44         case SPEED_10:
  45                 return "10Mbps";
  46         case SPEED_100:
  47                 return "100Mbps";
  48         case SPEED_1000:
  49                 return "1Gbps";
  50         case SPEED_2500:
  51                 return "2.5Gbps";
  52         case SPEED_10000:
  53                 return "10Gbps";
  54         case SPEED_UNKNOWN:
  55                 return "Unknown";
  56         default:
  57                 return "Unsupported (update phy.c)";
  58         }
  59 }
  60
  61 #define PHY_STATE_STR(_state)                   \
  62         case PHY_##_state:                      \
  63                 return __stringify(_state);     \
  64
  65 static const char *phy_state_to_str(enum phy_state st)
  66 {
  67         switch (st) {
  68         PHY_STATE_STR(DOWN)
  69         PHY_STATE_STR(STARTING)
  70         PHY_STATE_STR(READY)
  71         PHY_STATE_STR(PENDING)
  72         PHY_STATE_STR(UP)
  73         PHY_STATE_STR(AN)
  74         PHY_STATE_STR(RUNNING)
  75         PHY_STATE_STR(NOLINK)
  76         PHY_STATE_STR(FORCING)
  77         PHY_STATE_STR(CHANGELINK)
  78         PHY_STATE_STR(HALTED)
  79         PHY_STATE_STR(RESUMING)
  80         }
  81
  82         return NULL;
  83 }
  84
  85
  86 /**
  87  * phy_print_status - Convenience function to print out the current phy status
  88  * @phydev: the phy_device struct
  89  */
  90 void phy_print_status(struct phy_device *phydev)
  91 {
  92         if (phydev->link) {
  93                 netdev_info(phydev->attached_dev,
  94                         "Link is Up - %s/%s - flow control %s\n",
  95                         phy_speed_to_str(phydev->speed),
  96                         DUPLEX_FULL == phydev->duplex ? "Full" : "Half",
  97                         phydev->pause ? "rx/tx" : "off");
  98         } else  {
  99                 netdev_info(phydev->attached_dev, "Link is Down\n");
 100         }
 101 }
 102 EXPORT_SYMBOL(phy_print_status);
 103
 104 /**
 105  * phy_clear_interrupt - Ack the phy device's interrupt
 106  * @phydev: the phy_device struct
 107  *
 108  * If the @phydev driver has an ack_interrupt function, call it to
 109  * ack and clear the phy device's interrupt.
 110  *
 111  * Returns 0 on success or < 0 on error.
 112  */
 113 static int phy_clear_interrupt(struct phy_device *phydev)
 114 {
 115         if (phydev->drv->ack_interrupt)
 116                 return phydev->drv->ack_interrupt(phydev);
 117
 118         return 0;
 119 }
 120
 121 /**
 122  * phy_config_interrupt - configure the PHY device for the requested interrupts
 123  * @phydev: the phy_device struct
 124  * @interrupts: interrupt flags to configure for this @phydev
 125  *
 126  * Returns 0 on success or < 0 on error.
 127  */
 128 static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
 129 {
 130         phydev->interrupts = interrupts;
 131         if (phydev->drv->config_intr)
 132                 return phydev->drv->config_intr(phydev);
 133
 134         return 0;
 135 }
 136
 137
 138 /**
 139  * phy_aneg_done - return auto-negotiation status
 140  * @phydev: target phy_device struct
 141  *
 142  * Description: Return the auto-negotiation status from this @phydev
 143  * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
 144  * is still pending.
 145  */
 146 static inline int phy_aneg_done(struct phy_device *phydev)
 147 {
 148         if (phydev->drv->aneg_done)
 149                 return phydev->drv->aneg_done(phydev);
 150
 151         return genphy_aneg_done(phydev);
 152 }
 153
 154 /* A structure for mapping a particular speed and duplex
 155  * combination to a particular SUPPORTED and ADVERTISED value
 156  */
 157 struct phy_setting {
 158         int speed;
 159         int duplex;
 160         u32 setting;
 161 };
 162
 163 /* A mapping of all SUPPORTED settings to speed/duplex */
 164 static const struct phy_setting settings[] = {
 165         {
 166                 .speed = SPEED_10000,
 167                 .duplex = DUPLEX_FULL,
 168                 .setting = SUPPORTED_10000baseKR_Full,
 169         },
 170         {
 171                 .speed = SPEED_10000,
 172                 .duplex = DUPLEX_FULL,
 173                 .setting = SUPPORTED_10000baseKX4_Full,
 174         },
 175         {
 176                 .speed = SPEED_10000,
 177                 .duplex = DUPLEX_FULL,
 178                 .setting = SUPPORTED_10000baseT_Full,
 179         },
 180         {
 181                 .speed = SPEED_2500,
 182                 .duplex = DUPLEX_FULL,
 183                 .setting = SUPPORTED_2500baseX_Full,
 184         },
 185         {
 186                 .speed = SPEED_1000,
 187                 .duplex = DUPLEX_FULL,
 188                 .setting = SUPPORTED_1000baseKX_Full,
 189         },
 190         {
 191                 .speed = SPEED_1000,
 192                 .duplex = DUPLEX_FULL,
 193                 .setting = SUPPORTED_1000baseT_Full,
 194         },
 195         {
 196                 .speed = SPEED_1000,
 197                 .duplex = DUPLEX_HALF,
 198                 .setting = SUPPORTED_1000baseT_Half,
 199         },
 200         {
 201                 .speed = SPEED_100,
 202                 .duplex = DUPLEX_FULL,
 203                 .setting = SUPPORTED_100baseT_Full,
 204         },
 205         {
 206                 .speed = SPEED_100,
 207                 .duplex = DUPLEX_HALF,
 208                 .setting = SUPPORTED_100baseT_Half,
 209         },
 210         {
 211                 .speed = SPEED_10,
 212                 .duplex = DUPLEX_FULL,
 213                 .setting = SUPPORTED_10baseT_Full,
 214         },
 215         {
 216                 .speed = SPEED_10,
 217                 .duplex = DUPLEX_HALF,
 218                 .setting = SUPPORTED_10baseT_Half,
 219         },
 220 };
 221
 222 #define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
 223
 224 /**
 225  * phy_find_setting - find a PHY settings array entry that matches speed & duplex
 226  * @speed: speed to match
 227  * @duplex: duplex to match
 228  *
 229  * Description: Searches the settings array for the setting which
 230  *   matches the desired speed and duplex, and returns the index
 231  *   of that setting.  Returns the index of the last setting if
 232  *   none of the others match.
 233  */
 234 static inline unsigned int phy_find_setting(int speed, int duplex)
 235 {
 236         unsigned int idx = 0;
 237
 238         while (idx < ARRAY_SIZE(settings) &&
 239                (settings[idx].speed != speed || settings[idx].duplex != duplex))
 240                 idx++;
 241
 242         return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
 243 }
 244
 245 /**
 246  * phy_find_valid - find a PHY setting that matches the requested features mask
 247  * @idx: The first index in settings[] to search
 248  * @features: A mask of the valid settings
 249  *
 250  * Description: Returns the index of the first valid setting less
 251  *   than or equal to the one pointed to by idx, as determined by
 252  *   the mask in features.  Returns the index of the last setting
 253  *   if nothing else matches.
 254  */
 255 static inline unsigned int phy_find_valid(unsigned int idx, u32 features)
 256 {
 257         while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
 258                 idx++;
 259
 260         return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
 261 }
 262
 263 /**
 264  * phy_check_valid - check if there is a valid PHY setting which matches
 265  *                   speed, duplex, and feature mask
 266  * @speed: speed to match
 267  * @duplex: duplex to match
 268  * @features: A mask of the valid settings
 269  *
 270  * Description: Returns true if there is a valid setting, false otherwise.
 271  */
 272 static inline bool phy_check_valid(int speed, int duplex, u32 features)
 273 {
 274         unsigned int idx;
 275
 276         idx = phy_find_valid(phy_find_setting(speed, duplex), features);
 277
 278         return settings[idx].speed == speed && settings[idx].duplex == duplex &&
 279                 (settings[idx].setting & features);
 280 }
 281
 282 /**
 283  * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
 284  * @phydev: the target phy_device struct
 285  *
 286  * Description: Make sure the PHY is set to supported speeds and
 287  *   duplexes.  Drop down by one in this order:  1000/FULL,
 288  *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
 289  */
 290 static void phy_sanitize_settings(struct phy_device *phydev)
 291 {
 292         u32 features = phydev->supported;
 293         unsigned int idx;
 294
 295         /* Sanitize settings based on PHY capabilities */
 296         if ((features & SUPPORTED_Autoneg) == 0)
 297                 phydev->autoneg = AUTONEG_DISABLE;
 298
 299         idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
 300                         features);
 301
 302         phydev->speed = settings[idx].speed;
 303         phydev->duplex = settings[idx].duplex;
 304 }
 305
 306 /**
 307  * phy_ethtool_sset - generic ethtool sset function, handles all the details
 308  * @phydev: target phy_device struct
 309  * @cmd: ethtool_cmd
 310  *
 311  * A few notes about parameter checking:
 312  * - We don't set port or transceiver, so we don't care what they
 313  *   were set to.
 314  * - phy_start_aneg() will make sure forced settings are sane, and
 315  *   choose the next best ones from the ones selected, so we don't
 316  *   care if ethtool tries to give us bad values.
 317  */
 318 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
 319 {
 320         u32 speed = ethtool_cmd_speed(cmd);
 321
 322         if (cmd->phy_address != phydev->addr)
 323                 return -EINVAL;
 324
 325         /* We make sure that we don't pass unsupported values in to the PHY */
 326         cmd->advertising &= phydev->supported;
 327
 328         /* Verify the settings we care about. */
 329         if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
 330                 return -EINVAL;
 331
 332         if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
 333                 return -EINVAL;
 334
 335         if (cmd->autoneg == AUTONEG_DISABLE &&
 336             ((speed != SPEED_1000 &&
 337               speed != SPEED_100 &&
 338               speed != SPEED_10) ||
 339              (cmd->duplex != DUPLEX_HALF &&
 340               cmd->duplex != DUPLEX_FULL)))
 341                 return -EINVAL;
 342
 343         phydev->autoneg = cmd->autoneg;
 344
 345         phydev->speed = speed;
 346
 347         phydev->advertising = cmd->advertising;
 348
 349         if (AUTONEG_ENABLE == cmd->autoneg)
 350                 phydev->advertising |= ADVERTISED_Autoneg;
 351         else
 352                 phydev->advertising &= ~ADVERTISED_Autoneg;
 353
 354         phydev->duplex = cmd->duplex;
 355
 356         phydev->mdix = cmd->eth_tp_mdix_ctrl;
 357
 358         /* Restart the PHY */
 359         phy_start_aneg(phydev);
 360
 361         return 0;
 362 }
 363 EXPORT_SYMBOL(phy_ethtool_sset);
 364
 365 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
 366 {
 367         cmd->supported = phydev->supported;
 368
 369         cmd->advertising = phydev->advertising;
 370         cmd->lp_advertising = phydev->lp_advertising;
 371
 372         ethtool_cmd_speed_set(cmd, phydev->speed);
 373         cmd->duplex = phydev->duplex;
 374         if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
 375                 cmd->port = PORT_BNC;
 376         else
 377                 cmd->port = PORT_MII;
 378         cmd->phy_address = phydev->addr;
 379         cmd->transceiver = phy_is_internal(phydev) ?
 380                 XCVR_INTERNAL : XCVR_EXTERNAL;
 381         cmd->autoneg = phydev->autoneg;
 382
 383         return 0;
 384 }
 385 EXPORT_SYMBOL(phy_ethtool_gset);
 386
 387 /**
 388  * phy_mii_ioctl - generic PHY MII ioctl interface
 389  * @phydev: the phy_device struct
 390  * @ifr: &struct ifreq for socket ioctl's
 391  * @cmd: ioctl cmd to execute
 392  *
 393  * Note that this function is currently incompatible with the
 394  * PHYCONTROL layer.  It changes registers without regard to
 395  * current state.  Use at own risk.
 396  */
 397 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
 398 {
 399         struct mii_ioctl_data *mii_data = if_mii(ifr);
 400         u16 val = mii_data->val_in;
 401         bool change_autoneg = false;
 402
 403         switch (cmd) {
 404         case SIOCGMIIPHY:
 405                 mii_data->phy_id = phydev->addr;
 406                 /* fall through */
 407
 408         case SIOCGMIIREG:
 409                 mii_data->val_out = mdiobus_read(phydev->bus, mii_data->phy_id,
 410                                                  mii_data->reg_num);
 411                 return 0;
 412
 413         case SIOCSMIIREG:
 414                 if (mii_data->phy_id == phydev->addr) {
 415                         switch (mii_data->reg_num) {
 416                         case MII_BMCR:
 417                                 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
 418                                         if (phydev->autoneg == AUTONEG_ENABLE)
 419                                                 change_autoneg = true;
 420                                         phydev->autoneg = AUTONEG_DISABLE;
 421                                         if (val & BMCR_FULLDPLX)
 422                                                 phydev->duplex = DUPLEX_FULL;
 423                                         else
 424                                                 phydev->duplex = DUPLEX_HALF;
 425                                         if (val & BMCR_SPEED1000)
 426                                                 phydev->speed = SPEED_1000;
 427                                         else if (val & BMCR_SPEED100)
 428                                                 phydev->speed = SPEED_100;
 429                                         else phydev->speed = SPEED_10;
 430                                 }
 431                                 else {
 432                                         if (phydev->autoneg == AUTONEG_DISABLE)
 433                                                 change_autoneg = true;
 434                                         phydev->autoneg = AUTONEG_ENABLE;
 435                                 }
 436                                 break;
 437                         case MII_ADVERTISE:
 438                                 phydev->advertising = mii_adv_to_ethtool_adv_t(val);
 439                                 change_autoneg = true;
 440                                 break;
 441                         default:
 442                                 /* do nothing */
 443                                 break;
 444                         }
 445                 }
 446
 447                 mdiobus_write(phydev->bus, mii_data->phy_id,
 448                               mii_data->reg_num, val);
 449
 450                 if (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->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 - start auto-negotiation for this PHY device
 472  * @phydev: the phy_device struct
 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 int phy_start_aneg(struct phy_device *phydev)
 480 {
 481         int err;
 482
 483         mutex_lock(&phydev->lock);
 484
 485         if (AUTONEG_DISABLE == phydev->autoneg)
 486                 phy_sanitize_settings(phydev);
 487
 488         /* Invalidate LP advertising flags */
 489         phydev->lp_advertising = 0;
 490
 491         err = phydev->drv->config_aneg(phydev);
 492         if (err < 0)
 493                 goto out_unlock;
 494
 495         if (phydev->state != PHY_HALTED) {
 496                 if (AUTONEG_ENABLE == phydev->autoneg) {
 497                         phydev->state = PHY_AN;
 498                         phydev->link_timeout = PHY_AN_TIMEOUT;
 499                 } else {
 500                         phydev->state = PHY_FORCING;
 501                         phydev->link_timeout = PHY_FORCE_TIMEOUT;
 502                 }
 503         }
 504
 505 out_unlock:
 506         mutex_unlock(&phydev->lock);
 507         return err;
 508 }
 509 EXPORT_SYMBOL(phy_start_aneg);
 510
 511 /**
 512  * phy_start_machine - start PHY state machine tracking
 513  * @phydev: the phy_device struct
 514  *
 515  * Description: The PHY infrastructure can run a state machine
 516  *   which tracks whether the PHY is starting up, negotiating,
 517  *   etc.  This function starts the timer which tracks the state
 518  *   of the PHY.  If you want to maintain your own state machine,
 519  *   do not call this function.
 520  */
 521 void phy_start_machine(struct phy_device *phydev)
 522 {
 523         queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
 524 }
 525
 526 /**
 527  * phy_stop_machine - stop the PHY state machine tracking
 528  * @phydev: target phy_device struct
 529  *
 530  * Description: Stops the state machine timer, sets the state to UP
 531  *   (unless it wasn't up yet). This function must be called BEFORE
 532  *   phy_detach.
 533  */
 534 void phy_stop_machine(struct phy_device *phydev)
 535 {
 536         cancel_delayed_work_sync(&phydev->state_queue);
 537
 538         mutex_lock(&phydev->lock);
 539         if (phydev->state > PHY_UP)
 540                 phydev->state = PHY_UP;
 541         mutex_unlock(&phydev->lock);
 542 }
 543
 544 /**
 545  * phy_error - enter HALTED state for this PHY device
 546  * @phydev: target phy_device struct
 547  *
 548  * Moves the PHY to the HALTED state in response to a read
 549  * or write error, and tells the controller the link is down.
 550  * Must not be called from interrupt context, or while the
 551  * phydev->lock is held.
 552  */
 553 static void phy_error(struct phy_device *phydev)
 554 {
 555         mutex_lock(&phydev->lock);
 556         phydev->state = PHY_HALTED;
 557         mutex_unlock(&phydev->lock);
 558 }
 559
 560 /**
 561  * phy_interrupt - PHY interrupt handler
 562  * @irq: interrupt line
 563  * @phy_dat: phy_device pointer
 564  *
 565  * Description: When a PHY interrupt occurs, the handler disables
 566  * interrupts, and schedules a work task to clear the interrupt.
 567  */
 568 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
 569 {
 570         struct phy_device *phydev = phy_dat;
 571
 572         if (PHY_HALTED == phydev->state)
 573                 return IRQ_NONE;                /* It can't be ours.  */
 574
 575         /* The MDIO bus is not allowed to be written in interrupt
 576          * context, so we need to disable the irq here.  A work
 577          * queue will write the PHY to disable and clear the
 578          * interrupt, and then reenable the irq line.
 579          */
 580         disable_irq_nosync(irq);
 581         atomic_inc(&phydev->irq_disable);
 582
 583         queue_work(system_power_efficient_wq, &phydev->phy_queue);
 584
 585         return IRQ_HANDLED;
 586 }
 587
 588 /**
 589  * phy_enable_interrupts - Enable the interrupts from the PHY side
 590  * @phydev: target phy_device struct
 591  */
 592 static int phy_enable_interrupts(struct phy_device *phydev)
 593 {
 594         int err = phy_clear_interrupt(phydev);
 595
 596         if (err < 0)
 597                 return err;
 598
 599         return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
 600 }
 601
 602 /**
 603  * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
 604  * @phydev: target phy_device struct
 605  */
 606 static int phy_disable_interrupts(struct phy_device *phydev)
 607 {
 608         int err;
 609
 610         /* Disable PHY interrupts */
 611         err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
 612         if (err)
 613                 goto phy_err;
 614
 615         /* Clear the interrupt */
 616         err = phy_clear_interrupt(phydev);
 617         if (err)
 618                 goto phy_err;
 619
 620         return 0;
 621
 622 phy_err:
 623         phy_error(phydev);
 624
 625         return err;
 626 }
 627
 628 /**
 629  * phy_start_interrupts - request and enable interrupts for a PHY device
 630  * @phydev: target phy_device struct
 631  *
 632  * Description: Request the interrupt for the given PHY.
 633  *   If this fails, then we set irq to PHY_POLL.
 634  *   Otherwise, we enable the interrupts in the PHY.
 635  *   This should only be called with a valid IRQ number.
 636  *   Returns 0 on success or < 0 on error.
 637  */
 638 int phy_start_interrupts(struct phy_device *phydev)
 639 {
 640         atomic_set(&phydev->irq_disable, 0);
 641         if (request_irq(phydev->irq, phy_interrupt, 0, "phy_interrupt",
 642                         phydev) < 0) {
 643                 pr_warn("%s: Can't get IRQ %d (PHY)\n",
 644                         phydev->bus->name, phydev->irq);
 645                 phydev->irq = PHY_POLL;
 646                 return 0;
 647         }
 648
 649         return phy_enable_interrupts(phydev);
 650 }
 651 EXPORT_SYMBOL(phy_start_interrupts);
 652
 653 /**
 654  * phy_stop_interrupts - disable interrupts from a PHY device
 655  * @phydev: target phy_device struct
 656  */
 657 int phy_stop_interrupts(struct phy_device *phydev)
 658 {
 659         int err = phy_disable_interrupts(phydev);
 660
 661         if (err)
 662                 phy_error(phydev);
 663
 664         free_irq(phydev->irq, phydev);
 665
 666         /* Cannot call flush_scheduled_work() here as desired because
 667          * of rtnl_lock(), but we do not really care about what would
 668          * be done, except from enable_irq(), so cancel any work
 669          * possibly pending and take care of the matter below.
 670          */
 671         cancel_work_sync(&phydev->phy_queue);
 672         /* If work indeed has been cancelled, disable_irq() will have
 673          * been left unbalanced from phy_interrupt() and enable_irq()
 674          * has to be called so that other devices on the line work.
 675          */
 676         while (atomic_dec_return(&phydev->irq_disable) >= 0)
 677                 enable_irq(phydev->irq);
 678
 679         return err;
 680 }
 681 EXPORT_SYMBOL(phy_stop_interrupts);
 682
 683 /**
 684  * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
 685  * @work: work_struct that describes the work to be done
 686  */
 687 void phy_change(struct work_struct *work)
 688 {
 689         struct phy_device *phydev =
 690                 container_of(work, struct phy_device, phy_queue);
 691
 692         if (phydev->drv->did_interrupt &&
 693             !phydev->drv->did_interrupt(phydev))
 694                 goto ignore;
 695
 696         if (phy_disable_interrupts(phydev))
 697                 goto phy_err;
 698
 699         mutex_lock(&phydev->lock);
 700         if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
 701                 phydev->state = PHY_CHANGELINK;
 702         mutex_unlock(&phydev->lock);
 703
 704         atomic_dec(&phydev->irq_disable);
 705         enable_irq(phydev->irq);
 706
 707         /* Reenable interrupts */
 708         if (PHY_HALTED != phydev->state &&
 709             phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
 710                 goto irq_enable_err;
 711
 712         /* reschedule state queue work to run as soon as possible */
 713         cancel_delayed_work_sync(&phydev->state_queue);
 714         queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
 715         return;
 716
 717 ignore:
 718         atomic_dec(&phydev->irq_disable);
 719         enable_irq(phydev->irq);
 720         return;
 721
 722 irq_enable_err:
 723         disable_irq(phydev->irq);
 724         atomic_inc(&phydev->irq_disable);
 725 phy_err:
 726         phy_error(phydev);
 727 }
 728
 729 /**
 730  * phy_stop - Bring down the PHY link, and stop checking the status
 731  * @phydev: target phy_device struct
 732  */
 733 void phy_stop(struct phy_device *phydev)
 734 {
 735         mutex_lock(&phydev->lock);
 736
 737         if (PHY_HALTED == phydev->state)
 738                 goto out_unlock;
 739
 740         if (phy_interrupt_is_valid(phydev)) {
 741                 /* Disable PHY Interrupts */
 742                 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
 743
 744                 /* Clear any pending interrupts */
 745                 phy_clear_interrupt(phydev);
 746         }
 747
 748         phydev->state = PHY_HALTED;
 749
 750 out_unlock:
 751         mutex_unlock(&phydev->lock);
 752
 753         /* Cannot call flush_scheduled_work() here as desired because
 754          * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
 755          * will not reenable interrupts.
 756          */
 757 }
 758 EXPORT_SYMBOL(phy_stop);
 759
 760 /**
 761  * phy_start - start or restart a PHY device
 762  * @phydev: target phy_device struct
 763  *
 764  * Description: Indicates the attached device's readiness to
 765  *   handle PHY-related work.  Used during startup to start the
 766  *   PHY, and after a call to phy_stop() to resume operation.
 767  *   Also used to indicate the MDIO bus has cleared an error
 768  *   condition.
 769  */
 770 void phy_start(struct phy_device *phydev)
 771 {
 772         bool do_resume = false;
 773         int err = 0;
 774
 775         mutex_lock(&phydev->lock);
 776
 777         switch (phydev->state) {
 778         case PHY_STARTING:
 779                 phydev->state = PHY_PENDING;
 780                 break;
 781         case PHY_READY:
 782                 phydev->state = PHY_UP;
 783                 break;
 784         case PHY_HALTED:
 785                 /* make sure interrupts are re-enabled for the PHY */
 786                 err = phy_enable_interrupts(phydev);
 787                 if (err < 0)
 788                         break;
 789
 790                 phydev->state = PHY_RESUMING;
 791                 do_resume = true;
 792                 break;
 793         default:
 794                 break;
 795         }
 796         mutex_unlock(&phydev->lock);
 797
 798         /* if phy was suspended, bring the physical link up again */
 799         if (do_resume)
 800                 phy_resume(phydev);
 801 }
 802 EXPORT_SYMBOL(phy_start);
 803
 804 /**
 805  * phy_state_machine - Handle the state machine
 806  * @work: work_struct that describes the work to be done
 807  */
 808 void phy_state_machine(struct work_struct *work)
 809 {
 810         struct delayed_work *dwork = to_delayed_work(work);
 811         struct phy_device *phydev =
 812                         container_of(dwork, struct phy_device, state_queue);
 813         bool needs_aneg = false, do_suspend = false;
 814         enum phy_state old_state;
 815         int err = 0;
 816
 817         mutex_lock(&phydev->lock);
 818
 819         old_state = phydev->state;
 820
 821         if (phydev->drv->link_change_notify)
 822                 phydev->drv->link_change_notify(phydev);
 823
 824         switch (phydev->state) {
 825         case PHY_DOWN:
 826         case PHY_STARTING:
 827         case PHY_READY:
 828         case PHY_PENDING:
 829                 break;
 830         case PHY_UP:
 831                 needs_aneg = true;
 832
 833                 phydev->link_timeout = PHY_AN_TIMEOUT;
 834
 835                 break;
 836         case PHY_AN:
 837                 err = phy_read_status(phydev);
 838                 if (err < 0)
 839                         break;
 840
 841                 /* If the link is down, give up on negotiation for now */
 842                 if (!phydev->link) {
 843                         phydev->state = PHY_NOLINK;
 844                         netif_carrier_off(phydev->attached_dev);
 845                         phydev->adjust_link(phydev->attached_dev);
 846                         break;
 847                 }
 848
 849                 /* Check if negotiation is done.  Break if there's an error */
 850                 err = phy_aneg_done(phydev);
 851                 if (err < 0)
 852                         break;
 853
 854                 /* If AN is done, we're running */
 855                 if (err > 0) {
 856                         phydev->state = PHY_RUNNING;
 857                         netif_carrier_on(phydev->attached_dev);
 858                         phydev->adjust_link(phydev->attached_dev);
 859
 860                 } else if (0 == phydev->link_timeout--)
 861                         needs_aneg = true;
 862                 break;
 863         case PHY_NOLINK:
 864                 err = phy_read_status(phydev);
 865                 if (err)
 866                         break;
 867
 868                 if (phydev->link) {
 869                         if (AUTONEG_ENABLE == phydev->autoneg) {
 870                                 err = phy_aneg_done(phydev);
 871                                 if (err < 0)
 872                                         break;
 873
 874                                 if (!err) {
 875                                         phydev->state = PHY_AN;
 876                                         phydev->link_timeout = PHY_AN_TIMEOUT;
 877                                         break;
 878                                 }
 879                         }
 880                         phydev->state = PHY_RUNNING;
 881                         netif_carrier_on(phydev->attached_dev);
 882                         phydev->adjust_link(phydev->attached_dev);
 883                 }
 884                 break;
 885         case PHY_FORCING:
 886                 err = genphy_update_link(phydev);
 887                 if (err)
 888                         break;
 889
 890                 if (phydev->link) {
 891                         phydev->state = PHY_RUNNING;
 892                         netif_carrier_on(phydev->attached_dev);
 893                 } else {
 894                         if (0 == phydev->link_timeout--)
 895                                 needs_aneg = true;
 896                 }
 897
 898                 phydev->adjust_link(phydev->attached_dev);
 899                 break;
 900         case PHY_RUNNING:
 901                 /* Only register a CHANGE if we are
 902                  * polling or ignoring interrupts
 903                  */
 904                 if (!phy_interrupt_is_valid(phydev))
 905                         phydev->state = PHY_CHANGELINK;
 906                 break;
 907         case PHY_CHANGELINK:
 908                 err = phy_read_status(phydev);
 909                 if (err)
 910                         break;
 911
 912                 if (phydev->link) {
 913                         phydev->state = PHY_RUNNING;
 914                         netif_carrier_on(phydev->attached_dev);
 915                 } else {
 916                         phydev->state = PHY_NOLINK;
 917                         netif_carrier_off(phydev->attached_dev);
 918                 }
 919
 920                 phydev->adjust_link(phydev->attached_dev);
 921
 922                 if (phy_interrupt_is_valid(phydev))
 923                         err = phy_config_interrupt(phydev,
 924                                                    PHY_INTERRUPT_ENABLED);
 925                 break;
 926         case PHY_HALTED:
 927                 if (phydev->link) {
 928                         phydev->link = 0;
 929                         netif_carrier_off(phydev->attached_dev);
 930                         phydev->adjust_link(phydev->attached_dev);
 931                         do_suspend = true;
 932                 }
 933                 break;
 934         case PHY_RESUMING:
 935                 if (AUTONEG_ENABLE == phydev->autoneg) {
 936                         err = phy_aneg_done(phydev);
 937                         if (err < 0)
 938                                 break;
 939
 940                         /* err > 0 if AN is done.
 941                          * Otherwise, it's 0, and we're  still waiting for AN
 942                          */
 943                         if (err > 0) {
 944                                 err = phy_read_status(phydev);
 945                                 if (err)
 946                                         break;
 947
 948                                 if (phydev->link) {
 949                                         phydev->state = PHY_RUNNING;
 950                                         netif_carrier_on(phydev->attached_dev);
 951                                 } else  {
 952                                         phydev->state = PHY_NOLINK;
 953                                 }
 954                                 phydev->adjust_link(phydev->attached_dev);
 955                         } else {
 956                                 phydev->state = PHY_AN;
 957                                 phydev->link_timeout = PHY_AN_TIMEOUT;
 958                         }
 959                 } else {
 960                         err = phy_read_status(phydev);
 961                         if (err)
 962                                 break;
 963
 964                         if (phydev->link) {
 965                                 phydev->state = PHY_RUNNING;
 966                                 netif_carrier_on(phydev->attached_dev);
 967                         } else  {
 968                                 phydev->state = PHY_NOLINK;
 969                         }
 970                         phydev->adjust_link(phydev->attached_dev);
 971                 }
 972                 break;
 973         }
 974
 975         mutex_unlock(&phydev->lock);
 976
 977         if (needs_aneg)
 978                 err = phy_start_aneg(phydev);
 979         else if (do_suspend)
 980                 phy_suspend(phydev);
 981
 982         if (err < 0)
 983                 phy_error(phydev);
 984
 985         dev_dbg(&phydev->dev, "PHY state change %s -> %s\n",
 986                 phy_state_to_str(old_state), phy_state_to_str(phydev->state));
 987
 988         queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
 989                            PHY_STATE_TIME * HZ);
 990 }
 991
 992 void phy_mac_interrupt(struct phy_device *phydev, int new_link)
 993 {
 994         cancel_work_sync(&phydev->phy_queue);
 995         phydev->link = new_link;
 996         schedule_work(&phydev->phy_queue);
 997 }
 998 EXPORT_SYMBOL(phy_mac_interrupt);
 999
1000 static inline void mmd_phy_indirect(struct mii_bus *bus, int prtad, int devad,
1001                                     int addr)
1002 {
1003         /* Write the desired MMD Devad */
1004         bus->write(bus, addr, MII_MMD_CTRL, devad);
1005
1006         /* Write the desired MMD register address */
1007         bus->write(bus, addr, MII_MMD_DATA, prtad);
1008
1009         /* Select the Function : DATA with no post increment */
1010         bus->write(bus, addr, MII_MMD_CTRL, (devad | MII_MMD_CTRL_NOINCR));
1011 }
1012
1013 /**
1014  * phy_read_mmd_indirect - reads data from the MMD registers
1015  * @phydev: The PHY device bus
1016  * @prtad: MMD Address
1017  * @devad: MMD DEVAD
1018  * @addr: PHY address on the MII bus
1019  *
1020  * Description: it reads data from the MMD registers (clause 22 to access to
1021  * clause 45) of the specified phy address.
1022  * To read these register we have:
1023  * 1) Write reg 13 // DEVAD
1024  * 2) Write reg 14 // MMD Address
1025  * 3) Write reg 13 // MMD Data Command for MMD DEVAD
1026  * 3) Read  reg 14 // Read MMD data
1027  */
1028 int phy_read_mmd_indirect(struct phy_device *phydev, int prtad,
1029                                  int devad, int addr)
1030 {
1031         struct phy_driver *phydrv = phydev->drv;
1032         int value = -1;
1033
1034         if (phydrv->read_mmd_indirect == NULL) {
1035                 mmd_phy_indirect(phydev->bus, prtad, devad, addr);
1036
1037                 /* Read the content of the MMD's selected register */
1038                 value = phydev->bus->read(phydev->bus, addr, MII_MMD_DATA);
1039         } else {
1040                 value = phydrv->read_mmd_indirect(phydev, prtad, devad, addr);
1041         }
1042         return value;
1043 }
1044 EXPORT_SYMBOL(phy_read_mmd_indirect);
1045
1046 /**
1047  * phy_write_mmd_indirect - writes data to the MMD registers
1048  * @phydev: The PHY device
1049  * @prtad: MMD Address
1050  * @devad: MMD DEVAD
1051  * @addr: PHY address on the MII bus
1052  * @data: data to write in the MMD register
1053  *
1054  * Description: Write data from the MMD registers of the specified
1055  * phy address.
1056  * To write these register we have:
1057  * 1) Write reg 13 // DEVAD
1058  * 2) Write reg 14 // MMD Address
1059  * 3) Write reg 13 // MMD Data Command for MMD DEVAD
1060  * 3) Write reg 14 // Write MMD data
1061  */
1062 void phy_write_mmd_indirect(struct phy_device *phydev, int prtad,
1063                                    int devad, int addr, u32 data)
1064 {
1065         struct phy_driver *phydrv = phydev->drv;
1066
1067         if (phydrv->write_mmd_indirect == NULL) {
1068                 mmd_phy_indirect(phydev->bus, prtad, devad, addr);
1069
1070                 /* Write the data into MMD's selected register */
1071                 phydev->bus->write(phydev->bus, addr, MII_MMD_DATA, data);
1072         } else {
1073                 phydrv->write_mmd_indirect(phydev, prtad, devad, addr, data);
1074         }
1075 }
1076 EXPORT_SYMBOL(phy_write_mmd_indirect);
1077
1078 /**
1079  * phy_init_eee - init and check the EEE feature
1080  * @phydev: target phy_device struct
1081  * @clk_stop_enable: PHY may stop the clock during LPI
1082  *
1083  * Description: it checks if the Energy-Efficient Ethernet (EEE)
1084  * is supported by looking at the MMD registers 3.20 and 7.60/61
1085  * and it programs the MMD register 3.0 setting the "Clock stop enable"
1086  * bit if required.
1087  */
1088 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1089 {
1090         /* According to 802.3az,the EEE is supported only in full duplex-mode.
1091          * Also EEE feature is active when core is operating with MII, GMII
1092          * or RGMII (all kinds). Internal PHYs are also allowed to proceed and
1093          * should return an error if they do not support EEE.
1094          */
1095         if ((phydev->duplex == DUPLEX_FULL) &&
1096             ((phydev->interface == PHY_INTERFACE_MODE_MII) ||
1097             (phydev->interface == PHY_INTERFACE_MODE_GMII) ||
1098              phy_interface_is_rgmii(phydev) ||
1099              phy_is_internal(phydev))) {
1100                 int eee_lp, eee_cap, eee_adv;
1101                 u32 lp, cap, adv;
1102                 int status;
1103
1104                 /* Read phy status to properly get the right settings */
1105                 status = phy_read_status(phydev);
1106                 if (status)
1107                         return status;
1108
1109                 /* First check if the EEE ability is supported */
1110                 eee_cap = phy_read_mmd_indirect(phydev, MDIO_PCS_EEE_ABLE,
1111                                                 MDIO_MMD_PCS, phydev->addr);
1112                 if (eee_cap <= 0)
1113                         goto eee_exit_err;
1114
1115                 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1116                 if (!cap)
1117                         goto eee_exit_err;
1118
1119                 /* Check which link settings negotiated and verify it in
1120                  * the EEE advertising registers.
1121                  */
1122                 eee_lp = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_LPABLE,
1123                                                MDIO_MMD_AN, phydev->addr);
1124                 if (eee_lp <= 0)
1125                         goto eee_exit_err;
1126
1127                 eee_adv = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_ADV,
1128                                                 MDIO_MMD_AN, phydev->addr);
1129                 if (eee_adv <= 0)
1130                         goto eee_exit_err;
1131
1132                 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1133                 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1134                 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1135                         goto eee_exit_err;
1136
1137                 if (clk_stop_enable) {
1138                         /* Configure the PHY to stop receiving xMII
1139                          * clock while it is signaling LPI.
1140                          */
1141                         int val = phy_read_mmd_indirect(phydev, MDIO_CTRL1,
1142                                                         MDIO_MMD_PCS,
1143                                                         phydev->addr);
1144                         if (val < 0)
1145                                 return val;
1146
1147                         val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1148                         phy_write_mmd_indirect(phydev, MDIO_CTRL1,
1149                                                MDIO_MMD_PCS, phydev->addr,
1150                                                val);
1151                 }
1152
1153                 return 0; /* EEE supported */
1154         }
1155 eee_exit_err:
1156         return -EPROTONOSUPPORT;
1157 }
1158 EXPORT_SYMBOL(phy_init_eee);
1159
1160 /**
1161  * phy_get_eee_err - report the EEE wake error count
1162  * @phydev: target phy_device struct
1163  *
1164  * Description: it is to report the number of time where the PHY
1165  * failed to complete its normal wake sequence.
1166  */
1167 int phy_get_eee_err(struct phy_device *phydev)
1168 {
1169         return phy_read_mmd_indirect(phydev, MDIO_PCS_EEE_WK_ERR,
1170                                      MDIO_MMD_PCS, phydev->addr);
1171 }
1172 EXPORT_SYMBOL(phy_get_eee_err);
1173
1174 /**
1175  * phy_ethtool_get_eee - get EEE supported and status
1176  * @phydev: target phy_device struct
1177  * @data: ethtool_eee data
1178  *
1179  * Description: it reportes the Supported/Advertisement/LP Advertisement
1180  * capabilities.
1181  */
1182 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1183 {
1184         int val;
1185
1186         /* Get Supported EEE */
1187         val = phy_read_mmd_indirect(phydev, MDIO_PCS_EEE_ABLE,
1188                                     MDIO_MMD_PCS, phydev->addr);
1189         if (val < 0)
1190                 return val;
1191         data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1192
1193         /* Get advertisement EEE */
1194         val = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_ADV,
1195                                     MDIO_MMD_AN, phydev->addr);
1196         if (val < 0)
1197                 return val;
1198         data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1199
1200         /* Get LP advertisement EEE */
1201         val = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_LPABLE,
1202                                     MDIO_MMD_AN, phydev->addr);
1203         if (val < 0)
1204                 return val;
1205         data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1206
1207         return 0;
1208 }
1209 EXPORT_SYMBOL(phy_ethtool_get_eee);
1210
1211 /**
1212  * phy_ethtool_set_eee - set EEE supported and status
1213  * @phydev: target phy_device struct
1214  * @data: ethtool_eee data
1215  *
1216  * Description: it is to program the Advertisement EEE register.
1217  */
1218 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1219 {
1220         int val = ethtool_adv_to_mmd_eee_adv_t(data->advertised);
1221
1222         phy_write_mmd_indirect(phydev, MDIO_AN_EEE_ADV, MDIO_MMD_AN,
1223                                phydev->addr, val);
1224
1225         return 0;
1226 }
1227 EXPORT_SYMBOL(phy_ethtool_set_eee);
1228
1229 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1230 {
1231         if (phydev->drv->set_wol)
1232                 return phydev->drv->set_wol(phydev, wol);
1233
1234         return -EOPNOTSUPP;
1235 }
1236 EXPORT_SYMBOL(phy_ethtool_set_wol);
1237
1238 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1239 {
1240         if (phydev->drv->get_wol)
1241                 phydev->drv->get_wol(phydev, wol);
1242 }
1243 EXPORT_SYMBOL(phy_ethtool_get_wol);