drivers/net/phy/phy_device.c

   1 /* Framework for finding and configuring PHYs.
   2  * Also contains generic PHY driver
   3  *
   4  * Author: Andy Fleming
   5  *
   6  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  *
  13  */
  14
  15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  16
  17 #include <linux/kernel.h>
  18 #include <linux/string.h>
  19 #include <linux/errno.h>
  20 #include <linux/unistd.h>
  21 #include <linux/slab.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/phy_led_triggers.h>
  34 #include <linux/mdio.h>
  35 #include <linux/io.h>
  36 #include <linux/uaccess.h>
  37 #include <linux/of.h>
  38
  39 #include <asm/irq.h>
  40
  41 MODULE_DESCRIPTION("PHY library");
  42 MODULE_AUTHOR("Andy Fleming");
  43 MODULE_LICENSE("GPL");
  44
  45 void phy_device_free(struct phy_device *phydev)
  46 {
  47         put_device(&phydev->mdio.dev);
  48 }
  49 EXPORT_SYMBOL(phy_device_free);
  50
  51 static void phy_mdio_device_free(struct mdio_device *mdiodev)
  52 {
  53         struct phy_device *phydev;
  54
  55         phydev = container_of(mdiodev, struct phy_device, mdio);
  56         phy_device_free(phydev);
  57 }
  58
  59 static void phy_device_release(struct device *dev)
  60 {
  61         kfree(to_phy_device(dev));
  62 }
  63
  64 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
  65 {
  66         struct phy_device *phydev;
  67
  68         phydev = container_of(mdiodev, struct phy_device, mdio);
  69         phy_device_remove(phydev);
  70 }
  71
  72 static struct phy_driver genphy_driver;
  73 extern struct phy_driver genphy_10g_driver;
  74
  75 static LIST_HEAD(phy_fixup_list);
  76 static DEFINE_MUTEX(phy_fixup_lock);
  77
  78 #ifdef CONFIG_PM
  79 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
  80 {
  81         struct device_driver *drv = phydev->mdio.dev.driver;
  82         struct phy_driver *phydrv = to_phy_driver(drv);
  83         struct net_device *netdev = phydev->attached_dev;
  84
  85         if (!drv || !phydrv->suspend)
  86                 return false;
  87
  88         /* PHY not attached? May suspend if the PHY has not already been
  89          * suspended as part of a prior call to phy_disconnect() ->
  90          * phy_detach() -> phy_suspend() because the parent netdev might be the
  91          * MDIO bus driver and clock gated at this point.
  92          */
  93         if (!netdev)
  94                 return !phydev->suspended;
  95
  96         /* Don't suspend PHY if the attached netdev parent may wakeup.
  97          * The parent may point to a PCI device, as in tg3 driver.
  98          */
  99         if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
 100                 return false;
 101
 102         /* Also don't suspend PHY if the netdev itself may wakeup. This
 103          * is the case for devices w/o underlaying pwr. mgmt. aware bus,
 104          * e.g. SoC devices.
 105          */
 106         if (device_may_wakeup(&netdev->dev))
 107                 return false;
 108
 109         return true;
 110 }
 111
 112 static int mdio_bus_phy_suspend(struct device *dev)
 113 {
 114         struct phy_device *phydev = to_phy_device(dev);
 115
 116         /* We must stop the state machine manually, otherwise it stops out of
 117          * control, possibly with the phydev->lock held. Upon resume, netdev
 118          * may call phy routines that try to grab the same lock, and that may
 119          * lead to a deadlock.
 120          */
 121         if (phydev->attached_dev && phydev->adjust_link)
 122                 phy_stop_machine(phydev);
 123
 124         if (!mdio_bus_phy_may_suspend(phydev))
 125                 return 0;
 126
 127         return phy_suspend(phydev);
 128 }
 129
 130 static int mdio_bus_phy_resume(struct device *dev)
 131 {
 132         struct phy_device *phydev = to_phy_device(dev);
 133         int ret;
 134
 135         if (!mdio_bus_phy_may_suspend(phydev))
 136                 goto no_resume;
 137
 138         ret = phy_resume(phydev);
 139         if (ret < 0)
 140                 return ret;
 141
 142 no_resume:
 143         if (phydev->attached_dev && phydev->adjust_link)
 144                 phy_start_machine(phydev);
 145
 146         return 0;
 147 }
 148
 149 static int mdio_bus_phy_restore(struct device *dev)
 150 {
 151         struct phy_device *phydev = to_phy_device(dev);
 152         struct net_device *netdev = phydev->attached_dev;
 153         int ret;
 154
 155         if (!netdev)
 156                 return 0;
 157
 158         ret = phy_init_hw(phydev);
 159         if (ret < 0)
 160                 return ret;
 161
 162         /* The PHY needs to renegotiate. */
 163         phydev->link = 0;
 164         phydev->state = PHY_UP;
 165
 166         phy_start_machine(phydev);
 167
 168         return 0;
 169 }
 170
 171 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
 172         .suspend = mdio_bus_phy_suspend,
 173         .resume = mdio_bus_phy_resume,
 174         .freeze = mdio_bus_phy_suspend,
 175         .thaw = mdio_bus_phy_resume,
 176         .restore = mdio_bus_phy_restore,
 177 };
 178
 179 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
 180
 181 #else
 182
 183 #define MDIO_BUS_PHY_PM_OPS NULL
 184
 185 #endif /* CONFIG_PM */
 186
 187 /**
 188  * phy_register_fixup - creates a new phy_fixup and adds it to the list
 189  * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
 190  * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
 191  *      It can also be PHY_ANY_UID
 192  * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
 193  *      comparison
 194  * @run: The actual code to be run when a matching PHY is found
 195  */
 196 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
 197                        int (*run)(struct phy_device *))
 198 {
 199         struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
 200
 201         if (!fixup)
 202                 return -ENOMEM;
 203
 204         strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
 205         fixup->phy_uid = phy_uid;
 206         fixup->phy_uid_mask = phy_uid_mask;
 207         fixup->run = run;
 208
 209         mutex_lock(&phy_fixup_lock);
 210         list_add_tail(&fixup->list, &phy_fixup_list);
 211         mutex_unlock(&phy_fixup_lock);
 212
 213         return 0;
 214 }
 215 EXPORT_SYMBOL(phy_register_fixup);
 216
 217 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
 218 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
 219                                int (*run)(struct phy_device *))
 220 {
 221         return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
 222 }
 223 EXPORT_SYMBOL(phy_register_fixup_for_uid);
 224
 225 /* Registers a fixup to be run on the PHY with id string bus_id */
 226 int phy_register_fixup_for_id(const char *bus_id,
 227                               int (*run)(struct phy_device *))
 228 {
 229         return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
 230 }
 231 EXPORT_SYMBOL(phy_register_fixup_for_id);
 232
 233 /**
 234  * phy_unregister_fixup - remove a phy_fixup from the list
 235  * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
 236  * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
 237  * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
 238  */
 239 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
 240 {
 241         struct list_head *pos, *n;
 242         struct phy_fixup *fixup;
 243         int ret;
 244
 245         ret = -ENODEV;
 246
 247         mutex_lock(&phy_fixup_lock);
 248         list_for_each_safe(pos, n, &phy_fixup_list) {
 249                 fixup = list_entry(pos, struct phy_fixup, list);
 250
 251                 if ((!strcmp(fixup->bus_id, bus_id)) &&
 252                     ((fixup->phy_uid & phy_uid_mask) ==
 253                      (phy_uid & phy_uid_mask))) {
 254                         list_del(&fixup->list);
 255                         kfree(fixup);
 256                         ret = 0;
 257                         break;
 258                 }
 259         }
 260         mutex_unlock(&phy_fixup_lock);
 261
 262         return ret;
 263 }
 264 EXPORT_SYMBOL(phy_unregister_fixup);
 265
 266 /* Unregisters a fixup of any PHY with the UID in phy_uid */
 267 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
 268 {
 269         return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
 270 }
 271 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
 272
 273 /* Unregisters a fixup of the PHY with id string bus_id */
 274 int phy_unregister_fixup_for_id(const char *bus_id)
 275 {
 276         return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
 277 }
 278 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
 279
 280 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
 281  * Fixups can be set to match any in one or more fields.
 282  */
 283 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
 284 {
 285         if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
 286                 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
 287                         return 0;
 288
 289         if ((fixup->phy_uid & fixup->phy_uid_mask) !=
 290             (phydev->phy_id & fixup->phy_uid_mask))
 291                 if (fixup->phy_uid != PHY_ANY_UID)
 292                         return 0;
 293
 294         return 1;
 295 }
 296
 297 /* Runs any matching fixups for this phydev */
 298 static int phy_scan_fixups(struct phy_device *phydev)
 299 {
 300         struct phy_fixup *fixup;
 301
 302         mutex_lock(&phy_fixup_lock);
 303         list_for_each_entry(fixup, &phy_fixup_list, list) {
 304                 if (phy_needs_fixup(phydev, fixup)) {
 305                         int err = fixup->run(phydev);
 306
 307                         if (err < 0) {
 308                                 mutex_unlock(&phy_fixup_lock);
 309                                 return err;
 310                         }
 311                         phydev->has_fixups = true;
 312                 }
 313         }
 314         mutex_unlock(&phy_fixup_lock);
 315
 316         return 0;
 317 }
 318
 319 static int phy_bus_match(struct device *dev, struct device_driver *drv)
 320 {
 321         struct phy_device *phydev = to_phy_device(dev);
 322         struct phy_driver *phydrv = to_phy_driver(drv);
 323         const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
 324         int i;
 325
 326         if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
 327                 return 0;
 328
 329         if (phydrv->match_phy_device)
 330                 return phydrv->match_phy_device(phydev);
 331
 332         if (phydev->is_c45) {
 333                 for (i = 1; i < num_ids; i++) {
 334                         if (!(phydev->c45_ids.devices_in_package & (1 << i)))
 335                                 continue;
 336
 337                         if ((phydrv->phy_id & phydrv->phy_id_mask) ==
 338                             (phydev->c45_ids.device_ids[i] &
 339                              phydrv->phy_id_mask))
 340                                 return 1;
 341                 }
 342                 return 0;
 343         } else {
 344                 return (phydrv->phy_id & phydrv->phy_id_mask) ==
 345                         (phydev->phy_id & phydrv->phy_id_mask);
 346         }
 347 }
 348
 349 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
 350                                      bool is_c45,
 351                                      struct phy_c45_device_ids *c45_ids)
 352 {
 353         struct phy_device *dev;
 354         struct mdio_device *mdiodev;
 355
 356         /* We allocate the device, and initialize the default values */
 357         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 358         if (!dev)
 359                 return ERR_PTR(-ENOMEM);
 360
 361         mdiodev = &dev->mdio;
 362         mdiodev->dev.release = phy_device_release;
 363         mdiodev->dev.parent = &bus->dev;
 364         mdiodev->dev.bus = &mdio_bus_type;
 365         mdiodev->bus = bus;
 366         mdiodev->pm_ops = MDIO_BUS_PHY_PM_OPS;
 367         mdiodev->bus_match = phy_bus_match;
 368         mdiodev->addr = addr;
 369         mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
 370         mdiodev->device_free = phy_mdio_device_free;
 371         mdiodev->device_remove = phy_mdio_device_remove;
 372
 373         dev->speed = 0;
 374         dev->duplex = -1;
 375         dev->pause = 0;
 376         dev->asym_pause = 0;
 377         dev->link = 1;
 378         dev->interface = PHY_INTERFACE_MODE_GMII;
 379
 380         dev->autoneg = AUTONEG_ENABLE;
 381
 382         dev->is_c45 = is_c45;
 383         dev->phy_id = phy_id;
 384         if (c45_ids)
 385                 dev->c45_ids = *c45_ids;
 386         dev->irq = bus->irq[addr];
 387         dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
 388
 389         dev->state = PHY_DOWN;
 390
 391         mutex_init(&dev->lock);
 392         INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
 393         INIT_WORK(&dev->phy_queue, phy_change_work);
 394
 395         /* Request the appropriate module unconditionally; don't
 396          * bother trying to do so only if it isn't already loaded,
 397          * because that gets complicated. A hotplug event would have
 398          * done an unconditional modprobe anyway.
 399          * We don't do normal hotplug because it won't work for MDIO
 400          * -- because it relies on the device staying around for long
 401          * enough for the driver to get loaded. With MDIO, the NIC
 402          * driver will get bored and give up as soon as it finds that
 403          * there's no driver _already_ loaded.
 404          */
 405         request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
 406
 407         device_initialize(&mdiodev->dev);
 408
 409         return dev;
 410 }
 411 EXPORT_SYMBOL(phy_device_create);
 412
 413 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
 414  * @bus: the target MII bus
 415  * @addr: PHY address on the MII bus
 416  * @dev_addr: MMD address in the PHY.
 417  * @devices_in_package: where to store the devices in package information.
 418  *
 419  * Description: reads devices in package registers of a MMD at @dev_addr
 420  * from PHY at @addr on @bus.
 421  *
 422  * Returns: 0 on success, -EIO on failure.
 423  */
 424 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
 425                                    u32 *devices_in_package)
 426 {
 427         int phy_reg, reg_addr;
 428
 429         reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
 430         phy_reg = mdiobus_read(bus, addr, reg_addr);
 431         if (phy_reg < 0)
 432                 return -EIO;
 433         *devices_in_package = (phy_reg & 0xffff) << 16;
 434
 435         reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
 436         phy_reg = mdiobus_read(bus, addr, reg_addr);
 437         if (phy_reg < 0)
 438                 return -EIO;
 439         *devices_in_package |= (phy_reg & 0xffff);
 440
 441         return 0;
 442 }
 443
 444 /**
 445  * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
 446  * @bus: the target MII bus
 447  * @addr: PHY address on the MII bus
 448  * @phy_id: where to store the ID retrieved.
 449  * @c45_ids: where to store the c45 ID information.
 450  *
 451  *   If the PHY devices-in-package appears to be valid, it and the
 452  *   corresponding identifiers are stored in @c45_ids, zero is stored
 453  *   in @phy_id.  Otherwise 0xffffffff is stored in @phy_id.  Returns
 454  *   zero on success.
 455  *
 456  */
 457 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
 458                            struct phy_c45_device_ids *c45_ids) {
 459         int phy_reg;
 460         int i, reg_addr;
 461         const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
 462         u32 *devs = &c45_ids->devices_in_package;
 463
 464         /* Find first non-zero Devices In package. Device zero is reserved
 465          * for 802.3 c45 complied PHYs, so don't probe it at first.
 466          */
 467         for (i = 1; i < num_ids && *devs == 0; i++) {
 468                 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
 469                 if (phy_reg < 0)
 470                         return -EIO;
 471
 472                 if ((*devs & 0x1fffffff) == 0x1fffffff) {
 473                         /*  If mostly Fs, there is no device there,
 474                          *  then let's continue to probe more, as some
 475                          *  10G PHYs have zero Devices In package,
 476                          *  e.g. Cortina CS4315/CS4340 PHY.
 477                          */
 478                         phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
 479                         if (phy_reg < 0)
 480                                 return -EIO;
 481                         /* no device there, let's get out of here */
 482                         if ((*devs & 0x1fffffff) == 0x1fffffff) {
 483                                 *phy_id = 0xffffffff;
 484                                 return 0;
 485                         } else {
 486                                 break;
 487                         }
 488                 }
 489         }
 490
 491         /* Now probe Device Identifiers for each device present. */
 492         for (i = 1; i < num_ids; i++) {
 493                 if (!(c45_ids->devices_in_package & (1 << i)))
 494                         continue;
 495
 496                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
 497                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 498                 if (phy_reg < 0)
 499                         return -EIO;
 500                 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
 501
 502                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
 503                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 504                 if (phy_reg < 0)
 505                         return -EIO;
 506                 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
 507         }
 508         *phy_id = 0;
 509         return 0;
 510 }
 511
 512 /**
 513  * get_phy_id - reads the specified addr for its ID.
 514  * @bus: the target MII bus
 515  * @addr: PHY address on the MII bus
 516  * @phy_id: where to store the ID retrieved.
 517  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 518  * @c45_ids: where to store the c45 ID information.
 519  *
 520  * Description: In the case of a 802.3-c22 PHY, reads the ID registers
 521  *   of the PHY at @addr on the @bus, stores it in @phy_id and returns
 522  *   zero on success.
 523  *
 524  *   In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
 525  *   its return value is in turn returned.
 526  *
 527  */
 528 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
 529                       bool is_c45, struct phy_c45_device_ids *c45_ids)
 530 {
 531         int phy_reg;
 532
 533         if (is_c45)
 534                 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
 535
 536         /* Grab the bits from PHYIR1, and put them in the upper half */
 537         phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
 538         if (phy_reg < 0)
 539                 return -EIO;
 540
 541         *phy_id = (phy_reg & 0xffff) << 16;
 542
 543         /* Grab the bits from PHYIR2, and put them in the lower half */
 544         phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
 545         if (phy_reg < 0)
 546                 return -EIO;
 547
 548         *phy_id |= (phy_reg & 0xffff);
 549
 550         return 0;
 551 }
 552
 553 /**
 554  * get_phy_device - reads the specified PHY device and returns its @phy_device
 555  *                  struct
 556  * @bus: the target MII bus
 557  * @addr: PHY address on the MII bus
 558  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 559  *
 560  * Description: Reads the ID registers of the PHY at @addr on the
 561  *   @bus, then allocates and returns the phy_device to represent it.
 562  */
 563 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
 564 {
 565         struct phy_c45_device_ids c45_ids = {0};
 566         u32 phy_id = 0;
 567         int r;
 568
 569         r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
 570         if (r)
 571                 return ERR_PTR(r);
 572
 573         /* If the phy_id is mostly Fs, there is no device there */
 574         if ((phy_id & 0x1fffffff) == 0x1fffffff)
 575                 return ERR_PTR(-ENODEV);
 576
 577         return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
 578 }
 579 EXPORT_SYMBOL(get_phy_device);
 580
 581 static ssize_t
 582 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
 583 {
 584         struct phy_device *phydev = to_phy_device(dev);
 585
 586         return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
 587 }
 588 static DEVICE_ATTR_RO(phy_id);
 589
 590 static ssize_t
 591 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
 592 {
 593         struct phy_device *phydev = to_phy_device(dev);
 594         const char *mode = NULL;
 595
 596         if (phy_is_internal(phydev))
 597                 mode = "internal";
 598         else
 599                 mode = phy_modes(phydev->interface);
 600
 601         return sprintf(buf, "%s\n", mode);
 602 }
 603 static DEVICE_ATTR_RO(phy_interface);
 604
 605 static ssize_t
 606 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
 607                     char *buf)
 608 {
 609         struct phy_device *phydev = to_phy_device(dev);
 610
 611         return sprintf(buf, "%d\n", phydev->has_fixups);
 612 }
 613 static DEVICE_ATTR_RO(phy_has_fixups);
 614
 615 static struct attribute *phy_dev_attrs[] = {
 616         &dev_attr_phy_id.attr,
 617         &dev_attr_phy_interface.attr,
 618         &dev_attr_phy_has_fixups.attr,
 619         NULL,
 620 };
 621 ATTRIBUTE_GROUPS(phy_dev);
 622
 623 /**
 624  * phy_device_register - Register the phy device on the MDIO bus
 625  * @phydev: phy_device structure to be added to the MDIO bus
 626  */
 627 int phy_device_register(struct phy_device *phydev)
 628 {
 629         int err;
 630
 631         err = mdiobus_register_device(&phydev->mdio);
 632         if (err)
 633                 return err;
 634
 635         /* Run all of the fixups for this PHY */
 636         err = phy_scan_fixups(phydev);
 637         if (err) {
 638                 pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
 639                 goto out;
 640         }
 641
 642         phydev->mdio.dev.groups = phy_dev_groups;
 643
 644         err = device_add(&phydev->mdio.dev);
 645         if (err) {
 646                 pr_err("PHY %d failed to add\n", phydev->mdio.addr);
 647                 goto out;
 648         }
 649
 650         return 0;
 651
 652  out:
 653         mdiobus_unregister_device(&phydev->mdio);
 654         return err;
 655 }
 656 EXPORT_SYMBOL(phy_device_register);
 657
 658 /**
 659  * phy_device_remove - Remove a previously registered phy device from the MDIO bus
 660  * @phydev: phy_device structure to remove
 661  *
 662  * This doesn't free the phy_device itself, it merely reverses the effects
 663  * of phy_device_register(). Use phy_device_free() to free the device
 664  * after calling this function.
 665  */
 666 void phy_device_remove(struct phy_device *phydev)
 667 {
 668         device_del(&phydev->mdio.dev);
 669         mdiobus_unregister_device(&phydev->mdio);
 670 }
 671 EXPORT_SYMBOL(phy_device_remove);
 672
 673 /**
 674  * phy_find_first - finds the first PHY device on the bus
 675  * @bus: the target MII bus
 676  */
 677 struct phy_device *phy_find_first(struct mii_bus *bus)
 678 {
 679         struct phy_device *phydev;
 680         int addr;
 681
 682         for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
 683                 phydev = mdiobus_get_phy(bus, addr);
 684                 if (phydev)
 685                         return phydev;
 686         }
 687         return NULL;
 688 }
 689 EXPORT_SYMBOL(phy_find_first);
 690
 691 /**
 692  * phy_prepare_link - prepares the PHY layer to monitor link status
 693  * @phydev: target phy_device struct
 694  * @handler: callback function for link status change notifications
 695  *
 696  * Description: Tells the PHY infrastructure to handle the
 697  *   gory details on monitoring link status (whether through
 698  *   polling or an interrupt), and to call back to the
 699  *   connected device driver when the link status changes.
 700  *   If you want to monitor your own link state, don't call
 701  *   this function.
 702  */
 703 static void phy_prepare_link(struct phy_device *phydev,
 704                              void (*handler)(struct net_device *))
 705 {
 706         phydev->adjust_link = handler;
 707 }
 708
 709 /**
 710  * phy_connect_direct - connect an ethernet device to a specific phy_device
 711  * @dev: the network device to connect
 712  * @phydev: the pointer to the phy device
 713  * @handler: callback function for state change notifications
 714  * @interface: PHY device's interface
 715  */
 716 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 717                        void (*handler)(struct net_device *),
 718                        phy_interface_t interface)
 719 {
 720         int rc;
 721
 722         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
 723         if (rc)
 724                 return rc;
 725
 726         phy_prepare_link(phydev, handler);
 727         phy_start_machine(phydev);
 728         if (phydev->irq > 0)
 729                 phy_start_interrupts(phydev);
 730
 731         return 0;
 732 }
 733 EXPORT_SYMBOL(phy_connect_direct);
 734
 735 /**
 736  * phy_connect - connect an ethernet device to a PHY device
 737  * @dev: the network device to connect
 738  * @bus_id: the id string of the PHY device to connect
 739  * @handler: callback function for state change notifications
 740  * @interface: PHY device's interface
 741  *
 742  * Description: Convenience function for connecting ethernet
 743  *   devices to PHY devices.  The default behavior is for
 744  *   the PHY infrastructure to handle everything, and only notify
 745  *   the connected driver when the link status changes.  If you
 746  *   don't want, or can't use the provided functionality, you may
 747  *   choose to call only the subset of functions which provide
 748  *   the desired functionality.
 749  */
 750 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 751                                void (*handler)(struct net_device *),
 752                                phy_interface_t interface)
 753 {
 754         struct phy_device *phydev;
 755         struct device *d;
 756         int rc;
 757
 758         /* Search the list of PHY devices on the mdio bus for the
 759          * PHY with the requested name
 760          */
 761         d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
 762         if (!d) {
 763                 pr_err("PHY %s not found\n", bus_id);
 764                 return ERR_PTR(-ENODEV);
 765         }
 766         phydev = to_phy_device(d);
 767
 768         rc = phy_connect_direct(dev, phydev, handler, interface);
 769         put_device(d);
 770         if (rc)
 771                 return ERR_PTR(rc);
 772
 773         return phydev;
 774 }
 775 EXPORT_SYMBOL(phy_connect);
 776
 777 /**
 778  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
 779  *                  device
 780  * @phydev: target phy_device struct
 781  */
 782 void phy_disconnect(struct phy_device *phydev)
 783 {
 784         if (phydev->irq > 0)
 785                 phy_stop_interrupts(phydev);
 786
 787         phy_stop_machine(phydev);
 788
 789         phydev->adjust_link = NULL;
 790
 791         phy_detach(phydev);
 792 }
 793 EXPORT_SYMBOL(phy_disconnect);
 794
 795 /**
 796  * phy_poll_reset - Safely wait until a PHY reset has properly completed
 797  * @phydev: The PHY device to poll
 798  *
 799  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
 800  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
 801  *   register must be polled until the BMCR_RESET bit clears.
 802  *
 803  *   Furthermore, any attempts to write to PHY registers may have no effect
 804  *   or even generate MDIO bus errors until this is complete.
 805  *
 806  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
 807  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
 808  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
 809  *   effort to support such broken PHYs, this function is separate from the
 810  *   standard phy_init_hw() which will zero all the other bits in the BMCR
 811  *   and reapply all driver-specific and board-specific fixups.
 812  */
 813 static int phy_poll_reset(struct phy_device *phydev)
 814 {
 815         /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
 816         unsigned int retries = 12;
 817         int ret;
 818
 819         do {
 820                 msleep(50);
 821                 ret = phy_read(phydev, MII_BMCR);
 822                 if (ret < 0)
 823                         return ret;
 824         } while (ret & BMCR_RESET && --retries);
 825         if (ret & BMCR_RESET)
 826                 return -ETIMEDOUT;
 827
 828         /* Some chips (smsc911x) may still need up to another 1ms after the
 829          * BMCR_RESET bit is cleared before they are usable.
 830          */
 831         msleep(1);
 832         return 0;
 833 }
 834
 835 int phy_init_hw(struct phy_device *phydev)
 836 {
 837         int ret = 0;
 838
 839         if (!phydev->drv || !phydev->drv->config_init)
 840                 return 0;
 841
 842         if (phydev->drv->soft_reset)
 843                 ret = phydev->drv->soft_reset(phydev);
 844         else
 845                 ret = genphy_soft_reset(phydev);
 846
 847         if (ret < 0)
 848                 return ret;
 849
 850         ret = phy_scan_fixups(phydev);
 851         if (ret < 0)
 852                 return ret;
 853
 854         return phydev->drv->config_init(phydev);
 855 }
 856 EXPORT_SYMBOL(phy_init_hw);
 857
 858 void phy_attached_info(struct phy_device *phydev)
 859 {
 860         phy_attached_print(phydev, NULL);
 861 }
 862 EXPORT_SYMBOL(phy_attached_info);
 863
 864 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)"
 865 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
 866 {
 867         const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
 868
 869         if (!fmt) {
 870                 dev_info(&phydev->mdio.dev, ATTACHED_FMT "\n",
 871                          drv_name, phydev_name(phydev),
 872                          phydev->irq);
 873         } else {
 874                 va_list ap;
 875
 876                 dev_info(&phydev->mdio.dev, ATTACHED_FMT,
 877                          drv_name, phydev_name(phydev),
 878                          phydev->irq);
 879
 880                 va_start(ap, fmt);
 881                 vprintk(fmt, ap);
 882                 va_end(ap);
 883         }
 884 }
 885 EXPORT_SYMBOL(phy_attached_print);
 886
 887 /**
 888  * phy_attach_direct - attach a network device to a given PHY device pointer
 889  * @dev: network device to attach
 890  * @phydev: Pointer to phy_device to attach
 891  * @flags: PHY device's dev_flags
 892  * @interface: PHY device's interface
 893  *
 894  * Description: Called by drivers to attach to a particular PHY
 895  *     device. The phy_device is found, and properly hooked up
 896  *     to the phy_driver.  If no driver is attached, then a
 897  *     generic driver is used.  The phy_device is given a ptr to
 898  *     the attaching device, and given a callback for link status
 899  *     change.  The phy_device is returned to the attaching driver.
 900  *     This function takes a reference on the phy device.
 901  */
 902 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 903                       u32 flags, phy_interface_t interface)
 904 {
 905         struct module *ndev_owner = dev->dev.parent->driver->owner;
 906         struct mii_bus *bus = phydev->mdio.bus;
 907         struct device *d = &phydev->mdio.dev;
 908         bool using_genphy = false;
 909         int err;
 910
 911         /* For Ethernet device drivers that register their own MDIO bus, we
 912          * will have bus->owner match ndev_mod, so we do not want to increment
 913          * our own module->refcnt here, otherwise we would not be able to
 914          * unload later on.
 915          */
 916         if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
 917                 dev_err(&dev->dev, "failed to get the bus module\n");
 918                 return -EIO;
 919         }
 920
 921         get_device(d);
 922
 923         /* Assume that if there is no driver, that it doesn't
 924          * exist, and we should use the genphy driver.
 925          */
 926         if (!d->driver) {
 927                 if (phydev->is_c45)
 928                         d->driver = &genphy_10g_driver.mdiodrv.driver;
 929                 else
 930                         d->driver = &genphy_driver.mdiodrv.driver;
 931
 932                 using_genphy = true;
 933         }
 934
 935         if (!try_module_get(d->driver->owner)) {
 936                 dev_err(&dev->dev, "failed to get the device driver module\n");
 937                 err = -EIO;
 938                 goto error_put_device;
 939         }
 940
 941         if (using_genphy) {
 942                 err = d->driver->probe(d);
 943                 if (err >= 0)
 944                         err = device_bind_driver(d);
 945
 946                 if (err)
 947                         goto error_module_put;
 948         }
 949
 950         if (phydev->attached_dev) {
 951                 dev_err(&dev->dev, "PHY already attached\n");
 952                 err = -EBUSY;
 953                 goto error;
 954         }
 955
 956         phydev->attached_dev = dev;
 957         dev->phydev = phydev;
 958
 959         /* Some Ethernet drivers try to connect to a PHY device before
 960          * calling register_netdevice() -> netdev_register_kobject() and
 961          * does the dev->dev.kobj initialization. Here we only check for
 962          * success which indicates that the network device kobject is
 963          * ready. Once we do that we still need to keep track of whether
 964          * links were successfully set up or not for phy_detach() to
 965          * remove them accordingly.
 966          */
 967         phydev->sysfs_links = false;
 968
 969         err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
 970                                 "attached_dev");
 971         if (!err) {
 972                 err = sysfs_create_link(&dev->dev.kobj, &phydev->mdio.dev.kobj,
 973                                         "phydev");
 974                 if (err)
 975                         goto error;
 976
 977                 phydev->sysfs_links = true;
 978         }
 979
 980         phydev->dev_flags = flags;
 981
 982         phydev->interface = interface;
 983
 984         phydev->state = PHY_READY;
 985
 986         /* Initial carrier state is off as the phy is about to be
 987          * (re)initialized.
 988          */
 989         netif_carrier_off(phydev->attached_dev);
 990
 991         /* Do initial configuration here, now that
 992          * we have certain key parameters
 993          * (dev_flags and interface)
 994          */
 995         err = phy_init_hw(phydev);
 996         if (err)
 997                 goto error;
 998
 999         phy_resume(phydev);
1000         phy_led_triggers_register(phydev);
1001
1002         return err;
1003
1004 error:
1005         /* phy_detach() does all of the cleanup below */
1006         phy_detach(phydev);
1007         return err;
1008
1009 error_module_put:
1010         module_put(d->driver->owner);
1011 error_put_device:
1012         put_device(d);
1013         if (ndev_owner != bus->owner)
1014                 module_put(bus->owner);
1015         return err;
1016 }
1017 EXPORT_SYMBOL(phy_attach_direct);
1018
1019 /**
1020  * phy_attach - attach a network device to a particular PHY device
1021  * @dev: network device to attach
1022  * @bus_id: Bus ID of PHY device to attach
1023  * @interface: PHY device's interface
1024  *
1025  * Description: Same as phy_attach_direct() except that a PHY bus_id
1026  *     string is passed instead of a pointer to a struct phy_device.
1027  */
1028 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1029                               phy_interface_t interface)
1030 {
1031         struct bus_type *bus = &mdio_bus_type;
1032         struct phy_device *phydev;
1033         struct device *d;
1034         int rc;
1035
1036         /* Search the list of PHY devices on the mdio bus for the
1037          * PHY with the requested name
1038          */
1039         d = bus_find_device_by_name(bus, NULL, bus_id);
1040         if (!d) {
1041                 pr_err("PHY %s not found\n", bus_id);
1042                 return ERR_PTR(-ENODEV);
1043         }
1044         phydev = to_phy_device(d);
1045
1046         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1047         put_device(d);
1048         if (rc)
1049                 return ERR_PTR(rc);
1050
1051         return phydev;
1052 }
1053 EXPORT_SYMBOL(phy_attach);
1054
1055 /**
1056  * phy_detach - detach a PHY device from its network device
1057  * @phydev: target phy_device struct
1058  *
1059  * This detaches the phy device from its network device and the phy
1060  * driver, and drops the reference count taken in phy_attach_direct().
1061  */
1062 void phy_detach(struct phy_device *phydev)
1063 {
1064         struct net_device *dev = phydev->attached_dev;
1065         struct module *ndev_owner = dev->dev.parent->driver->owner;
1066         struct mii_bus *bus;
1067
1068         if (phydev->sysfs_links) {
1069                 sysfs_remove_link(&dev->dev.kobj, "phydev");
1070                 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1071         }
1072         phydev->attached_dev->phydev = NULL;
1073         phydev->attached_dev = NULL;
1074         phy_suspend(phydev);
1075
1076         phy_led_triggers_unregister(phydev);
1077
1078         module_put(phydev->mdio.dev.driver->owner);
1079
1080         /* If the device had no specific driver before (i.e. - it
1081          * was using the generic driver), we unbind the device
1082          * from the generic driver so that there's a chance a
1083          * real driver could be loaded
1084          */
1085         if (phydev->mdio.dev.driver == &genphy_10g_driver.mdiodrv.driver ||
1086             phydev->mdio.dev.driver == &genphy_driver.mdiodrv.driver)
1087                 device_release_driver(&phydev->mdio.dev);
1088
1089         /*
1090          * The phydev might go away on the put_device() below, so avoid
1091          * a use-after-free bug by reading the underlying bus first.
1092          */
1093         bus = phydev->mdio.bus;
1094
1095         put_device(&phydev->mdio.dev);
1096         if (ndev_owner != bus->owner)
1097                 module_put(bus->owner);
1098 }
1099 EXPORT_SYMBOL(phy_detach);
1100
1101 int phy_suspend(struct phy_device *phydev)
1102 {
1103         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1104         struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1105         int ret = 0;
1106
1107         /* If the device has WOL enabled, we cannot suspend the PHY */
1108         phy_ethtool_get_wol(phydev, &wol);
1109         if (wol.wolopts)
1110                 return -EBUSY;
1111
1112         if (phydev->drv && phydrv->suspend)
1113                 ret = phydrv->suspend(phydev);
1114
1115         if (ret)
1116                 return ret;
1117
1118         phydev->suspended = true;
1119
1120         return ret;
1121 }
1122 EXPORT_SYMBOL(phy_suspend);
1123
1124 int phy_resume(struct phy_device *phydev)
1125 {
1126         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1127         int ret = 0;
1128
1129         if (phydev->drv && phydrv->resume)
1130                 ret = phydrv->resume(phydev);
1131
1132         if (ret)
1133                 return ret;
1134
1135         phydev->suspended = false;
1136
1137         return ret;
1138 }
1139 EXPORT_SYMBOL(phy_resume);
1140
1141 int phy_loopback(struct phy_device *phydev, bool enable)
1142 {
1143         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1144         int ret = 0;
1145
1146         mutex_lock(&phydev->lock);
1147
1148         if (enable && phydev->loopback_enabled) {
1149                 ret = -EBUSY;
1150                 goto out;
1151         }
1152
1153         if (!enable && !phydev->loopback_enabled) {
1154                 ret = -EINVAL;
1155                 goto out;
1156         }
1157
1158         if (phydev->drv && phydrv->set_loopback)
1159                 ret = phydrv->set_loopback(phydev, enable);
1160         else
1161                 ret = -EOPNOTSUPP;
1162
1163         if (ret)
1164                 goto out;
1165
1166         phydev->loopback_enabled = enable;
1167
1168 out:
1169         mutex_unlock(&phydev->lock);
1170         return ret;
1171 }
1172 EXPORT_SYMBOL(phy_loopback);
1173
1174 /* Generic PHY support and helper functions */
1175
1176 /**
1177  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1178  * @phydev: target phy_device struct
1179  *
1180  * Description: Writes MII_ADVERTISE with the appropriate values,
1181  *   after sanitizing the values to make sure we only advertise
1182  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
1183  *   hasn't changed, and > 0 if it has changed.
1184  */
1185 static int genphy_config_advert(struct phy_device *phydev)
1186 {
1187         u32 advertise;
1188         int oldadv, adv, bmsr;
1189         int err, changed = 0;
1190
1191         /* Only allow advertising what this PHY supports */
1192         phydev->advertising &= phydev->supported;
1193         advertise = phydev->advertising;
1194
1195         /* Setup standard advertisement */
1196         adv = phy_read(phydev, MII_ADVERTISE);
1197         if (adv < 0)
1198                 return adv;
1199
1200         oldadv = adv;
1201         adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1202                  ADVERTISE_PAUSE_ASYM);
1203         adv |= ethtool_adv_to_mii_adv_t(advertise);
1204
1205         if (adv != oldadv) {
1206                 err = phy_write(phydev, MII_ADVERTISE, adv);
1207
1208                 if (err < 0)
1209                         return err;
1210                 changed = 1;
1211         }
1212
1213         bmsr = phy_read(phydev, MII_BMSR);
1214         if (bmsr < 0)
1215                 return bmsr;
1216
1217         /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1218          * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1219          * logical 1.
1220          */
1221         if (!(bmsr & BMSR_ESTATEN))
1222                 return changed;
1223
1224         /* Configure gigabit if it's supported */
1225         adv = phy_read(phydev, MII_CTRL1000);
1226         if (adv < 0)
1227                 return adv;
1228
1229         oldadv = adv;
1230         adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1231
1232         if (phydev->supported & (SUPPORTED_1000baseT_Half |
1233                                  SUPPORTED_1000baseT_Full)) {
1234                 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1235         }
1236
1237         if (adv != oldadv)
1238                 changed = 1;
1239
1240         err = phy_write(phydev, MII_CTRL1000, adv);
1241         if (err < 0)
1242                 return err;
1243
1244         return changed;
1245 }
1246
1247 /**
1248  * genphy_config_eee_advert - disable unwanted eee mode advertisement
1249  * @phydev: target phy_device struct
1250  *
1251  * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1252  *   efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1253  *   changed, and 1 if it has changed.
1254  */
1255 static int genphy_config_eee_advert(struct phy_device *phydev)
1256 {
1257         int broken = phydev->eee_broken_modes;
1258         int old_adv, adv;
1259
1260         /* Nothing to disable */
1261         if (!broken)
1262                 return 0;
1263
1264         /* If the following call fails, we assume that EEE is not
1265          * supported by the phy. If we read 0, EEE is not advertised
1266          * In both case, we don't need to continue
1267          */
1268         adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1269         if (adv <= 0)
1270                 return 0;
1271
1272         old_adv = adv;
1273         adv &= ~broken;
1274
1275         /* Advertising remains unchanged with the broken mask */
1276         if (old_adv == adv)
1277                 return 0;
1278
1279         phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1280
1281         return 1;
1282 }
1283
1284 /**
1285  * genphy_setup_forced - configures/forces speed/duplex from @phydev
1286  * @phydev: target phy_device struct
1287  *
1288  * Description: Configures MII_BMCR to force speed/duplex
1289  *   to the values in phydev. Assumes that the values are valid.
1290  *   Please see phy_sanitize_settings().
1291  */
1292 int genphy_setup_forced(struct phy_device *phydev)
1293 {
1294         int ctl = phy_read(phydev, MII_BMCR);
1295
1296         ctl &= BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN;
1297         phydev->pause = 0;
1298         phydev->asym_pause = 0;
1299
1300         if (SPEED_1000 == phydev->speed)
1301                 ctl |= BMCR_SPEED1000;
1302         else if (SPEED_100 == phydev->speed)
1303                 ctl |= BMCR_SPEED100;
1304
1305         if (DUPLEX_FULL == phydev->duplex)
1306                 ctl |= BMCR_FULLDPLX;
1307
1308         return phy_write(phydev, MII_BMCR, ctl);
1309 }
1310 EXPORT_SYMBOL(genphy_setup_forced);
1311
1312 /**
1313  * genphy_restart_aneg - Enable and Restart Autonegotiation
1314  * @phydev: target phy_device struct
1315  */
1316 int genphy_restart_aneg(struct phy_device *phydev)
1317 {
1318         int ctl = phy_read(phydev, MII_BMCR);
1319
1320         if (ctl < 0)
1321                 return ctl;
1322
1323         ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
1324
1325         /* Don't isolate the PHY if we're negotiating */
1326         ctl &= ~BMCR_ISOLATE;
1327
1328         return phy_write(phydev, MII_BMCR, ctl);
1329 }
1330 EXPORT_SYMBOL(genphy_restart_aneg);
1331
1332 /**
1333  * genphy_config_aneg - restart auto-negotiation or write BMCR
1334  * @phydev: target phy_device struct
1335  *
1336  * Description: If auto-negotiation is enabled, we configure the
1337  *   advertising, and then restart auto-negotiation.  If it is not
1338  *   enabled, then we write the BMCR.
1339  */
1340 int genphy_config_aneg(struct phy_device *phydev)
1341 {
1342         int err, changed;
1343
1344         changed = genphy_config_eee_advert(phydev);
1345
1346         if (AUTONEG_ENABLE != phydev->autoneg)
1347                 return genphy_setup_forced(phydev);
1348
1349         err = genphy_config_advert(phydev);
1350         if (err < 0) /* error */
1351                 return err;
1352
1353         changed |= err;
1354
1355         if (changed == 0) {
1356                 /* Advertisement hasn't changed, but maybe aneg was never on to
1357                  * begin with?  Or maybe phy was isolated?
1358                  */
1359                 int ctl = phy_read(phydev, MII_BMCR);
1360
1361                 if (ctl < 0)
1362                         return ctl;
1363
1364                 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1365                         changed = 1; /* do restart aneg */
1366         }
1367
1368         /* Only restart aneg if we are advertising something different
1369          * than we were before.
1370          */
1371         if (changed > 0)
1372                 return genphy_restart_aneg(phydev);
1373
1374         return 0;
1375 }
1376 EXPORT_SYMBOL(genphy_config_aneg);
1377
1378 /**
1379  * genphy_aneg_done - return auto-negotiation status
1380  * @phydev: target phy_device struct
1381  *
1382  * Description: Reads the status register and returns 0 either if
1383  *   auto-negotiation is incomplete, or if there was an error.
1384  *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1385  */
1386 int genphy_aneg_done(struct phy_device *phydev)
1387 {
1388         int retval = phy_read(phydev, MII_BMSR);
1389
1390         return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1391 }
1392 EXPORT_SYMBOL(genphy_aneg_done);
1393
1394 /**
1395  * genphy_update_link - update link status in @phydev
1396  * @phydev: target phy_device struct
1397  *
1398  * Description: Update the value in phydev->link to reflect the
1399  *   current link value.  In order to do this, we need to read
1400  *   the status register twice, keeping the second value.
1401  */
1402 int genphy_update_link(struct phy_device *phydev)
1403 {
1404         int status;
1405
1406         /* Do a fake read */
1407         status = phy_read(phydev, MII_BMSR);
1408         if (status < 0)
1409                 return status;
1410
1411         /* Read link and autonegotiation status */
1412         status = phy_read(phydev, MII_BMSR);
1413         if (status < 0)
1414                 return status;
1415
1416         if ((status & BMSR_LSTATUS) == 0)
1417                 phydev->link = 0;
1418         else
1419                 phydev->link = 1;
1420
1421         return 0;
1422 }
1423 EXPORT_SYMBOL(genphy_update_link);
1424
1425 /**
1426  * genphy_read_status - check the link status and update current link state
1427  * @phydev: target phy_device struct
1428  *
1429  * Description: Check the link, then figure out the current state
1430  *   by comparing what we advertise with what the link partner
1431  *   advertises.  Start by checking the gigabit possibilities,
1432  *   then move on to 10/100.
1433  */
1434 int genphy_read_status(struct phy_device *phydev)
1435 {
1436         int adv;
1437         int err;
1438         int lpa;
1439         int lpagb = 0;
1440         int common_adv;
1441         int common_adv_gb = 0;
1442
1443         /* Update the link, but return if there was an error */
1444         err = genphy_update_link(phydev);
1445         if (err)
1446                 return err;
1447
1448         phydev->lp_advertising = 0;
1449
1450         if (AUTONEG_ENABLE == phydev->autoneg) {
1451                 if (phydev->supported & (SUPPORTED_1000baseT_Half
1452                                         | SUPPORTED_1000baseT_Full)) {
1453                         lpagb = phy_read(phydev, MII_STAT1000);
1454                         if (lpagb < 0)
1455                                 return lpagb;
1456
1457                         adv = phy_read(phydev, MII_CTRL1000);
1458                         if (adv < 0)
1459                                 return adv;
1460
1461                         phydev->lp_advertising =
1462                                 mii_stat1000_to_ethtool_lpa_t(lpagb);
1463                         common_adv_gb = lpagb & adv << 2;
1464                 }
1465
1466                 lpa = phy_read(phydev, MII_LPA);
1467                 if (lpa < 0)
1468                         return lpa;
1469
1470                 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1471
1472                 adv = phy_read(phydev, MII_ADVERTISE);
1473                 if (adv < 0)
1474                         return adv;
1475
1476                 common_adv = lpa & adv;
1477
1478                 phydev->speed = SPEED_10;
1479                 phydev->duplex = DUPLEX_HALF;
1480                 phydev->pause = 0;
1481                 phydev->asym_pause = 0;
1482
1483                 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1484                         phydev->speed = SPEED_1000;
1485
1486                         if (common_adv_gb & LPA_1000FULL)
1487                                 phydev->duplex = DUPLEX_FULL;
1488                 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1489                         phydev->speed = SPEED_100;
1490
1491                         if (common_adv & LPA_100FULL)
1492                                 phydev->duplex = DUPLEX_FULL;
1493                 } else
1494                         if (common_adv & LPA_10FULL)
1495                                 phydev->duplex = DUPLEX_FULL;
1496
1497                 if (phydev->duplex == DUPLEX_FULL) {
1498                         phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1499                         phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1500                 }
1501         } else {
1502                 int bmcr = phy_read(phydev, MII_BMCR);
1503
1504                 if (bmcr < 0)
1505                         return bmcr;
1506
1507                 if (bmcr & BMCR_FULLDPLX)
1508                         phydev->duplex = DUPLEX_FULL;
1509                 else
1510                         phydev->duplex = DUPLEX_HALF;
1511
1512                 if (bmcr & BMCR_SPEED1000)
1513                         phydev->speed = SPEED_1000;
1514                 else if (bmcr & BMCR_SPEED100)
1515                         phydev->speed = SPEED_100;
1516                 else
1517                         phydev->speed = SPEED_10;
1518
1519                 phydev->pause = 0;
1520                 phydev->asym_pause = 0;
1521         }
1522
1523         return 0;
1524 }
1525 EXPORT_SYMBOL(genphy_read_status);
1526
1527 /**
1528  * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1529  * @phydev: target phy_device struct
1530  *
1531  * Description: Perform a software PHY reset using the standard
1532  * BMCR_RESET bit and poll for the reset bit to be cleared.
1533  *
1534  * Returns: 0 on success, < 0 on failure
1535  */
1536 int genphy_soft_reset(struct phy_device *phydev)
1537 {
1538         int ret;
1539
1540         ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1541         if (ret < 0)
1542                 return ret;
1543
1544         return phy_poll_reset(phydev);
1545 }
1546 EXPORT_SYMBOL(genphy_soft_reset);
1547
1548 int genphy_config_init(struct phy_device *phydev)
1549 {
1550         int val;
1551         u32 features;
1552
1553         features = (SUPPORTED_TP | SUPPORTED_MII
1554                         | SUPPORTED_AUI | SUPPORTED_FIBRE |
1555                         SUPPORTED_BNC | SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1556
1557         /* Do we support autonegotiation? */
1558         val = phy_read(phydev, MII_BMSR);
1559         if (val < 0)
1560                 return val;
1561
1562         if (val & BMSR_ANEGCAPABLE)
1563                 features |= SUPPORTED_Autoneg;
1564
1565         if (val & BMSR_100FULL)
1566                 features |= SUPPORTED_100baseT_Full;
1567         if (val & BMSR_100HALF)
1568                 features |= SUPPORTED_100baseT_Half;
1569         if (val & BMSR_10FULL)
1570                 features |= SUPPORTED_10baseT_Full;
1571         if (val & BMSR_10HALF)
1572                 features |= SUPPORTED_10baseT_Half;
1573
1574         if (val & BMSR_ESTATEN) {
1575                 val = phy_read(phydev, MII_ESTATUS);
1576                 if (val < 0)
1577                         return val;
1578
1579                 if (val & ESTATUS_1000_TFULL)
1580                         features |= SUPPORTED_1000baseT_Full;
1581                 if (val & ESTATUS_1000_THALF)
1582                         features |= SUPPORTED_1000baseT_Half;
1583         }
1584
1585         phydev->supported &= features;
1586         phydev->advertising &= features;
1587
1588         return 0;
1589 }
1590 EXPORT_SYMBOL(genphy_config_init);
1591
1592 int genphy_suspend(struct phy_device *phydev)
1593 {
1594         int value;
1595
1596         mutex_lock(&phydev->lock);
1597
1598         value = phy_read(phydev, MII_BMCR);
1599         phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1600
1601         mutex_unlock(&phydev->lock);
1602
1603         return 0;
1604 }
1605 EXPORT_SYMBOL(genphy_suspend);
1606
1607 int genphy_resume(struct phy_device *phydev)
1608 {
1609         int value;
1610
1611         mutex_lock(&phydev->lock);
1612
1613         value = phy_read(phydev, MII_BMCR);
1614         phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1615
1616         mutex_unlock(&phydev->lock);
1617
1618         return 0;
1619 }
1620 EXPORT_SYMBOL(genphy_resume);
1621
1622 int genphy_loopback(struct phy_device *phydev, bool enable)
1623 {
1624         int value;
1625
1626         value = phy_read(phydev, MII_BMCR);
1627         if (value < 0)
1628                 return value;
1629
1630         if (enable)
1631                 value |= BMCR_LOOPBACK;
1632         else
1633                 value &= ~BMCR_LOOPBACK;
1634
1635         return phy_write(phydev, MII_BMCR, value);
1636 }
1637 EXPORT_SYMBOL(genphy_loopback);
1638
1639 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1640 {
1641         /* The default values for phydev->supported are provided by the PHY
1642          * driver "features" member, we want to reset to sane defaults first
1643          * before supporting higher speeds.
1644          */
1645         phydev->supported &= PHY_DEFAULT_FEATURES;
1646
1647         switch (max_speed) {
1648         default:
1649                 return -ENOTSUPP;
1650         case SPEED_1000:
1651                 phydev->supported |= PHY_1000BT_FEATURES;
1652                 /* fall through */
1653         case SPEED_100:
1654                 phydev->supported |= PHY_100BT_FEATURES;
1655                 /* fall through */
1656         case SPEED_10:
1657                 phydev->supported |= PHY_10BT_FEATURES;
1658         }
1659
1660         return 0;
1661 }
1662
1663 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1664 {
1665         int err;
1666
1667         err = __set_phy_supported(phydev, max_speed);
1668         if (err)
1669                 return err;
1670
1671         phydev->advertising = phydev->supported;
1672
1673         return 0;
1674 }
1675 EXPORT_SYMBOL(phy_set_max_speed);
1676
1677 static void of_set_phy_supported(struct phy_device *phydev)
1678 {
1679         struct device_node *node = phydev->mdio.dev.of_node;
1680         u32 max_speed;
1681
1682         if (!IS_ENABLED(CONFIG_OF_MDIO))
1683                 return;
1684
1685         if (!node)
1686                 return;
1687
1688         if (!of_property_read_u32(node, "max-speed", &max_speed))
1689                 __set_phy_supported(phydev, max_speed);
1690 }
1691
1692 static void of_set_phy_eee_broken(struct phy_device *phydev)
1693 {
1694         struct device_node *node = phydev->mdio.dev.of_node;
1695         u32 broken = 0;
1696
1697         if (!IS_ENABLED(CONFIG_OF_MDIO))
1698                 return;
1699
1700         if (!node)
1701                 return;
1702
1703         if (of_property_read_bool(node, "eee-broken-100tx"))
1704                 broken |= MDIO_EEE_100TX;
1705         if (of_property_read_bool(node, "eee-broken-1000t"))
1706                 broken |= MDIO_EEE_1000T;
1707         if (of_property_read_bool(node, "eee-broken-10gt"))
1708                 broken |= MDIO_EEE_10GT;
1709         if (of_property_read_bool(node, "eee-broken-1000kx"))
1710                 broken |= MDIO_EEE_1000KX;
1711         if (of_property_read_bool(node, "eee-broken-10gkx4"))
1712                 broken |= MDIO_EEE_10GKX4;
1713         if (of_property_read_bool(node, "eee-broken-10gkr"))
1714                 broken |= MDIO_EEE_10GKR;
1715
1716         phydev->eee_broken_modes = broken;
1717 }
1718
1719 /**
1720  * phy_probe - probe and init a PHY device
1721  * @dev: device to probe and init
1722  *
1723  * Description: Take care of setting up the phy_device structure,
1724  *   set the state to READY (the driver's init function should
1725  *   set it to STARTING if needed).
1726  */
1727 static int phy_probe(struct device *dev)
1728 {
1729         struct phy_device *phydev = to_phy_device(dev);
1730         struct device_driver *drv = phydev->mdio.dev.driver;
1731         struct phy_driver *phydrv = to_phy_driver(drv);
1732         int err = 0;
1733
1734         phydev->drv = phydrv;
1735
1736         /* Disable the interrupt if the PHY doesn't support it
1737          * but the interrupt is still a valid one
1738          */
1739         if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1740             phy_interrupt_is_valid(phydev))
1741                 phydev->irq = PHY_POLL;
1742
1743         if (phydrv->flags & PHY_IS_INTERNAL)
1744                 phydev->is_internal = true;
1745
1746         mutex_lock(&phydev->lock);
1747
1748         /* Start out supporting everything. Eventually,
1749          * a controller will attach, and may modify one
1750          * or both of these values
1751          */
1752         phydev->supported = phydrv->features;
1753         of_set_phy_supported(phydev);
1754         phydev->advertising = phydev->supported;
1755
1756         /* Get the EEE modes we want to prohibit. We will ask
1757          * the PHY stop advertising these mode later on
1758          */
1759         of_set_phy_eee_broken(phydev);
1760
1761         /* The Pause Frame bits indicate that the PHY can support passing
1762          * pause frames. During autonegotiation, the PHYs will determine if
1763          * they should allow pause frames to pass.  The MAC driver should then
1764          * use that result to determine whether to enable flow control via
1765          * pause frames.
1766          *
1767          * Normally, PHY drivers should not set the Pause bits, and instead
1768          * allow phylib to do that.  However, there may be some situations
1769          * (e.g. hardware erratum) where the driver wants to set only one
1770          * of these bits.
1771          */
1772         if (phydrv->features & (SUPPORTED_Pause | SUPPORTED_Asym_Pause)) {
1773                 phydev->supported &= ~(SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1774                 phydev->supported |= phydrv->features &
1775                                      (SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1776         } else {
1777                 phydev->supported |= SUPPORTED_Pause | SUPPORTED_Asym_Pause;
1778         }
1779
1780         /* Set the state to READY by default */
1781         phydev->state = PHY_READY;
1782
1783         if (phydev->drv->probe)
1784                 err = phydev->drv->probe(phydev);
1785
1786         mutex_unlock(&phydev->lock);
1787
1788         return err;
1789 }
1790
1791 static int phy_remove(struct device *dev)
1792 {
1793         struct phy_device *phydev = to_phy_device(dev);
1794
1795         cancel_delayed_work_sync(&phydev->state_queue);
1796
1797         mutex_lock(&phydev->lock);
1798         phydev->state = PHY_DOWN;
1799         mutex_unlock(&phydev->lock);
1800
1801         if (phydev->drv && phydev->drv->remove)
1802                 phydev->drv->remove(phydev);
1803         phydev->drv = NULL;
1804
1805         return 0;
1806 }
1807
1808 /**
1809  * phy_driver_register - register a phy_driver with the PHY layer
1810  * @new_driver: new phy_driver to register
1811  * @owner: module owning this PHY
1812  */
1813 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
1814 {
1815         int retval;
1816
1817         new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
1818         new_driver->mdiodrv.driver.name = new_driver->name;
1819         new_driver->mdiodrv.driver.bus = &mdio_bus_type;
1820         new_driver->mdiodrv.driver.probe = phy_probe;
1821         new_driver->mdiodrv.driver.remove = phy_remove;
1822         new_driver->mdiodrv.driver.owner = owner;
1823
1824         retval = driver_register(&new_driver->mdiodrv.driver);
1825         if (retval) {
1826                 pr_err("%s: Error %d in registering driver\n",
1827                        new_driver->name, retval);
1828
1829                 return retval;
1830         }
1831
1832         pr_debug("%s: Registered new driver\n", new_driver->name);
1833
1834         return 0;
1835 }
1836 EXPORT_SYMBOL(phy_driver_register);
1837
1838 int phy_drivers_register(struct phy_driver *new_driver, int n,
1839                          struct module *owner)
1840 {
1841         int i, ret = 0;
1842
1843         for (i = 0; i < n; i++) {
1844                 ret = phy_driver_register(new_driver + i, owner);
1845                 if (ret) {
1846                         while (i-- > 0)
1847                                 phy_driver_unregister(new_driver + i);
1848                         break;
1849                 }
1850         }
1851         return ret;
1852 }
1853 EXPORT_SYMBOL(phy_drivers_register);
1854
1855 void phy_driver_unregister(struct phy_driver *drv)
1856 {
1857         driver_unregister(&drv->mdiodrv.driver);
1858 }
1859 EXPORT_SYMBOL(phy_driver_unregister);
1860
1861 void phy_drivers_unregister(struct phy_driver *drv, int n)
1862 {
1863         int i;
1864
1865         for (i = 0; i < n; i++)
1866                 phy_driver_unregister(drv + i);
1867 }
1868 EXPORT_SYMBOL(phy_drivers_unregister);
1869
1870 static struct phy_driver genphy_driver = {
1871         .phy_id         = 0xffffffff,
1872         .phy_id_mask    = 0xffffffff,
1873         .name           = "Generic PHY",
1874         .soft_reset     = genphy_no_soft_reset,
1875         .config_init    = genphy_config_init,
1876         .features       = PHY_GBIT_FEATURES | SUPPORTED_MII |
1877                           SUPPORTED_AUI | SUPPORTED_FIBRE |
1878                           SUPPORTED_BNC,
1879         .config_aneg    = genphy_config_aneg,
1880         .aneg_done      = genphy_aneg_done,
1881         .read_status    = genphy_read_status,
1882         .suspend        = genphy_suspend,
1883         .resume         = genphy_resume,
1884         .set_loopback   = genphy_loopback,
1885 };
1886
1887 static int __init phy_init(void)
1888 {
1889         int rc;
1890
1891         rc = mdio_bus_init();
1892         if (rc)
1893                 return rc;
1894
1895         rc = phy_driver_register(&genphy_10g_driver, THIS_MODULE);
1896         if (rc)
1897                 goto err_10g;
1898
1899         rc = phy_driver_register(&genphy_driver, THIS_MODULE);
1900         if (rc) {
1901                 phy_driver_unregister(&genphy_10g_driver);
1902 err_10g:
1903                 mdio_bus_exit();
1904         }
1905
1906         return rc;
1907 }
1908
1909 static void __exit phy_exit(void)
1910 {
1911         phy_driver_unregister(&genphy_10g_driver);
1912         phy_driver_unregister(&genphy_driver);
1913         mdio_bus_exit();
1914 }
1915
1916 subsys_initcall(phy_init);
1917 module_exit(phy_exit);