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