drivers/net/phy/phy.c

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