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 static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
 692 {
 693         struct net_device *netdev = phydev->attached_dev;
 694
 695         if (do_carrier) {
 696                 if (up)
 697                         netif_carrier_on(netdev);
 698                 else
 699                         netif_carrier_off(netdev);
 700         }
 701         phydev->adjust_link(netdev);
 702 }
 703
 704 /**
 705  * phy_prepare_link - prepares the PHY layer to monitor link status
 706  * @phydev: target phy_device struct
 707  * @handler: callback function for link status change notifications
 708  *
 709  * Description: Tells the PHY infrastructure to handle the
 710  *   gory details on monitoring link status (whether through
 711  *   polling or an interrupt), and to call back to the
 712  *   connected device driver when the link status changes.
 713  *   If you want to monitor your own link state, don't call
 714  *   this function.
 715  */
 716 static void phy_prepare_link(struct phy_device *phydev,
 717                              void (*handler)(struct net_device *))
 718 {
 719         phydev->adjust_link = handler;
 720 }
 721
 722 /**
 723  * phy_connect_direct - connect an ethernet device to a specific phy_device
 724  * @dev: the network device to connect
 725  * @phydev: the pointer to the phy device
 726  * @handler: callback function for state change notifications
 727  * @interface: PHY device's interface
 728  */
 729 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 730                        void (*handler)(struct net_device *),
 731                        phy_interface_t interface)
 732 {
 733         int rc;
 734
 735         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
 736         if (rc)
 737                 return rc;
 738
 739         phy_prepare_link(phydev, handler);
 740         phy_start_machine(phydev);
 741         if (phydev->irq > 0)
 742                 phy_start_interrupts(phydev);
 743
 744         return 0;
 745 }
 746 EXPORT_SYMBOL(phy_connect_direct);
 747
 748 /**
 749  * phy_connect - connect an ethernet device to a PHY device
 750  * @dev: the network device to connect
 751  * @bus_id: the id string of the PHY device to connect
 752  * @handler: callback function for state change notifications
 753  * @interface: PHY device's interface
 754  *
 755  * Description: Convenience function for connecting ethernet
 756  *   devices to PHY devices.  The default behavior is for
 757  *   the PHY infrastructure to handle everything, and only notify
 758  *   the connected driver when the link status changes.  If you
 759  *   don't want, or can't use the provided functionality, you may
 760  *   choose to call only the subset of functions which provide
 761  *   the desired functionality.
 762  */
 763 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 764                                void (*handler)(struct net_device *),
 765                                phy_interface_t interface)
 766 {
 767         struct phy_device *phydev;
 768         struct device *d;
 769         int rc;
 770
 771         /* Search the list of PHY devices on the mdio bus for the
 772          * PHY with the requested name
 773          */
 774         d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
 775         if (!d) {
 776                 pr_err("PHY %s not found\n", bus_id);
 777                 return ERR_PTR(-ENODEV);
 778         }
 779         phydev = to_phy_device(d);
 780
 781         rc = phy_connect_direct(dev, phydev, handler, interface);
 782         put_device(d);
 783         if (rc)
 784                 return ERR_PTR(rc);
 785
 786         return phydev;
 787 }
 788 EXPORT_SYMBOL(phy_connect);
 789
 790 /**
 791  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
 792  *                  device
 793  * @phydev: target phy_device struct
 794  */
 795 void phy_disconnect(struct phy_device *phydev)
 796 {
 797         if (phydev->irq > 0)
 798                 phy_stop_interrupts(phydev);
 799
 800         phy_stop_machine(phydev);
 801
 802         phydev->adjust_link = NULL;
 803
 804         phy_detach(phydev);
 805 }
 806 EXPORT_SYMBOL(phy_disconnect);
 807
 808 /**
 809  * phy_poll_reset - Safely wait until a PHY reset has properly completed
 810  * @phydev: The PHY device to poll
 811  *
 812  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
 813  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
 814  *   register must be polled until the BMCR_RESET bit clears.
 815  *
 816  *   Furthermore, any attempts to write to PHY registers may have no effect
 817  *   or even generate MDIO bus errors until this is complete.
 818  *
 819  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
 820  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
 821  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
 822  *   effort to support such broken PHYs, this function is separate from the
 823  *   standard phy_init_hw() which will zero all the other bits in the BMCR
 824  *   and reapply all driver-specific and board-specific fixups.
 825  */
 826 static int phy_poll_reset(struct phy_device *phydev)
 827 {
 828         /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
 829         unsigned int retries = 12;
 830         int ret;
 831
 832         do {
 833                 msleep(50);
 834                 ret = phy_read(phydev, MII_BMCR);
 835                 if (ret < 0)
 836                         return ret;
 837         } while (ret & BMCR_RESET && --retries);
 838         if (ret & BMCR_RESET)
 839                 return -ETIMEDOUT;
 840
 841         /* Some chips (smsc911x) may still need up to another 1ms after the
 842          * BMCR_RESET bit is cleared before they are usable.
 843          */
 844         msleep(1);
 845         return 0;
 846 }
 847
 848 int phy_init_hw(struct phy_device *phydev)
 849 {
 850         int ret = 0;
 851
 852         if (!phydev->drv || !phydev->drv->config_init)
 853                 return 0;
 854
 855         if (phydev->drv->soft_reset)
 856                 ret = phydev->drv->soft_reset(phydev);
 857         else
 858                 ret = genphy_soft_reset(phydev);
 859
 860         if (ret < 0)
 861                 return ret;
 862
 863         ret = phy_scan_fixups(phydev);
 864         if (ret < 0)
 865                 return ret;
 866
 867         return phydev->drv->config_init(phydev);
 868 }
 869 EXPORT_SYMBOL(phy_init_hw);
 870
 871 void phy_attached_info(struct phy_device *phydev)
 872 {
 873         phy_attached_print(phydev, NULL);
 874 }
 875 EXPORT_SYMBOL(phy_attached_info);
 876
 877 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
 878 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
 879 {
 880         const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
 881         char *irq_str;
 882         char irq_num[8];
 883
 884         switch(phydev->irq) {
 885         case PHY_POLL:
 886                 irq_str = "POLL";
 887                 break;
 888         case PHY_IGNORE_INTERRUPT:
 889                 irq_str = "IGNORE";
 890                 break;
 891         default:
 892                 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
 893                 irq_str = irq_num;
 894                 break;
 895         }
 896
 897
 898         if (!fmt) {
 899                 dev_info(&phydev->mdio.dev, ATTACHED_FMT "\n",
 900                          drv_name, phydev_name(phydev),
 901                          irq_str);
 902         } else {
 903                 va_list ap;
 904
 905                 dev_info(&phydev->mdio.dev, ATTACHED_FMT,
 906                          drv_name, phydev_name(phydev),
 907                          irq_str);
 908
 909                 va_start(ap, fmt);
 910                 vprintk(fmt, ap);
 911                 va_end(ap);
 912         }
 913 }
 914 EXPORT_SYMBOL(phy_attached_print);
 915
 916 /**
 917  * phy_attach_direct - attach a network device to a given PHY device pointer
 918  * @dev: network device to attach
 919  * @phydev: Pointer to phy_device to attach
 920  * @flags: PHY device's dev_flags
 921  * @interface: PHY device's interface
 922  *
 923  * Description: Called by drivers to attach to a particular PHY
 924  *     device. The phy_device is found, and properly hooked up
 925  *     to the phy_driver.  If no driver is attached, then a
 926  *     generic driver is used.  The phy_device is given a ptr to
 927  *     the attaching device, and given a callback for link status
 928  *     change.  The phy_device is returned to the attaching driver.
 929  *     This function takes a reference on the phy device.
 930  */
 931 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 932                       u32 flags, phy_interface_t interface)
 933 {
 934         struct module *ndev_owner = dev->dev.parent->driver->owner;
 935         struct mii_bus *bus = phydev->mdio.bus;
 936         struct device *d = &phydev->mdio.dev;
 937         bool using_genphy = false;
 938         int err;
 939
 940         /* For Ethernet device drivers that register their own MDIO bus, we
 941          * will have bus->owner match ndev_mod, so we do not want to increment
 942          * our own module->refcnt here, otherwise we would not be able to
 943          * unload later on.
 944          */
 945         if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
 946                 dev_err(&dev->dev, "failed to get the bus module\n");
 947                 return -EIO;
 948         }
 949
 950         get_device(d);
 951
 952         /* Assume that if there is no driver, that it doesn't
 953          * exist, and we should use the genphy driver.
 954          */
 955         if (!d->driver) {
 956                 if (phydev->is_c45)
 957                         d->driver = &genphy_10g_driver.mdiodrv.driver;
 958                 else
 959                         d->driver = &genphy_driver.mdiodrv.driver;
 960
 961                 using_genphy = true;
 962         }
 963
 964         if (!try_module_get(d->driver->owner)) {
 965                 dev_err(&dev->dev, "failed to get the device driver module\n");
 966                 err = -EIO;
 967                 goto error_put_device;
 968         }
 969
 970         if (using_genphy) {
 971                 err = d->driver->probe(d);
 972                 if (err >= 0)
 973                         err = device_bind_driver(d);
 974
 975                 if (err)
 976                         goto error_module_put;
 977         }
 978
 979         if (phydev->attached_dev) {
 980                 dev_err(&dev->dev, "PHY already attached\n");
 981                 err = -EBUSY;
 982                 goto error;
 983         }
 984
 985         phydev->phy_link_change = phy_link_change;
 986         phydev->attached_dev = dev;
 987         dev->phydev = phydev;
 988
 989         /* Some Ethernet drivers try to connect to a PHY device before
 990          * calling register_netdevice() -> netdev_register_kobject() and
 991          * does the dev->dev.kobj initialization. Here we only check for
 992          * success which indicates that the network device kobject is
 993          * ready. Once we do that we still need to keep track of whether
 994          * links were successfully set up or not for phy_detach() to
 995          * remove them accordingly.
 996          */
 997         phydev->sysfs_links = false;
 998
 999         err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1000                                 "attached_dev");
1001         if (!err) {
1002                 err = sysfs_create_link(&dev->dev.kobj, &phydev->mdio.dev.kobj,
1003                                         "phydev");
1004                 if (err)
1005                         goto error;
1006
1007                 phydev->sysfs_links = true;
1008         }
1009
1010         phydev->dev_flags = flags;
1011
1012         phydev->interface = interface;
1013
1014         phydev->state = PHY_READY;
1015
1016         /* Initial carrier state is off as the phy is about to be
1017          * (re)initialized.
1018          */
1019         netif_carrier_off(phydev->attached_dev);
1020
1021         /* Do initial configuration here, now that
1022          * we have certain key parameters
1023          * (dev_flags and interface)
1024          */
1025         err = phy_init_hw(phydev);
1026         if (err)
1027                 goto error;
1028
1029         phy_resume(phydev);
1030         phy_led_triggers_register(phydev);
1031
1032         return err;
1033
1034 error:
1035         /* phy_detach() does all of the cleanup below */
1036         phy_detach(phydev);
1037         return err;
1038
1039 error_module_put:
1040         module_put(d->driver->owner);
1041 error_put_device:
1042         put_device(d);
1043         if (ndev_owner != bus->owner)
1044                 module_put(bus->owner);
1045         return err;
1046 }
1047 EXPORT_SYMBOL(phy_attach_direct);
1048
1049 /**
1050  * phy_attach - attach a network device to a particular PHY device
1051  * @dev: network device to attach
1052  * @bus_id: Bus ID of PHY device to attach
1053  * @interface: PHY device's interface
1054  *
1055  * Description: Same as phy_attach_direct() except that a PHY bus_id
1056  *     string is passed instead of a pointer to a struct phy_device.
1057  */
1058 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1059                               phy_interface_t interface)
1060 {
1061         struct bus_type *bus = &mdio_bus_type;
1062         struct phy_device *phydev;
1063         struct device *d;
1064         int rc;
1065
1066         /* Search the list of PHY devices on the mdio bus for the
1067          * PHY with the requested name
1068          */
1069         d = bus_find_device_by_name(bus, NULL, bus_id);
1070         if (!d) {
1071                 pr_err("PHY %s not found\n", bus_id);
1072                 return ERR_PTR(-ENODEV);
1073         }
1074         phydev = to_phy_device(d);
1075
1076         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1077         put_device(d);
1078         if (rc)
1079                 return ERR_PTR(rc);
1080
1081         return phydev;
1082 }
1083 EXPORT_SYMBOL(phy_attach);
1084
1085 /**
1086  * phy_detach - detach a PHY device from its network device
1087  * @phydev: target phy_device struct
1088  *
1089  * This detaches the phy device from its network device and the phy
1090  * driver, and drops the reference count taken in phy_attach_direct().
1091  */
1092 void phy_detach(struct phy_device *phydev)
1093 {
1094         struct net_device *dev = phydev->attached_dev;
1095         struct module *ndev_owner = dev->dev.parent->driver->owner;
1096         struct mii_bus *bus;
1097
1098         if (phydev->sysfs_links) {
1099                 sysfs_remove_link(&dev->dev.kobj, "phydev");
1100                 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1101         }
1102         phydev->attached_dev->phydev = NULL;
1103         phydev->attached_dev = NULL;
1104         phy_suspend(phydev);
1105         phydev->phylink = NULL;
1106
1107         phy_led_triggers_unregister(phydev);
1108
1109         module_put(phydev->mdio.dev.driver->owner);
1110
1111         /* If the device had no specific driver before (i.e. - it
1112          * was using the generic driver), we unbind the device
1113          * from the generic driver so that there's a chance a
1114          * real driver could be loaded
1115          */
1116         if (phydev->mdio.dev.driver == &genphy_10g_driver.mdiodrv.driver ||
1117             phydev->mdio.dev.driver == &genphy_driver.mdiodrv.driver)
1118                 device_release_driver(&phydev->mdio.dev);
1119
1120         /*
1121          * The phydev might go away on the put_device() below, so avoid
1122          * a use-after-free bug by reading the underlying bus first.
1123          */
1124         bus = phydev->mdio.bus;
1125
1126         put_device(&phydev->mdio.dev);
1127         if (ndev_owner != bus->owner)
1128                 module_put(bus->owner);
1129 }
1130 EXPORT_SYMBOL(phy_detach);
1131
1132 int phy_suspend(struct phy_device *phydev)
1133 {
1134         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1135         struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1136         int ret = 0;
1137
1138         /* If the device has WOL enabled, we cannot suspend the PHY */
1139         phy_ethtool_get_wol(phydev, &wol);
1140         if (wol.wolopts)
1141                 return -EBUSY;
1142
1143         if (phydev->drv && phydrv->suspend)
1144                 ret = phydrv->suspend(phydev);
1145
1146         if (ret)
1147                 return ret;
1148
1149         phydev->suspended = true;
1150
1151         return ret;
1152 }
1153 EXPORT_SYMBOL(phy_suspend);
1154
1155 int phy_resume(struct phy_device *phydev)
1156 {
1157         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1158         int ret = 0;
1159
1160         if (phydev->drv && phydrv->resume)
1161                 ret = phydrv->resume(phydev);
1162
1163         if (ret)
1164                 return ret;
1165
1166         phydev->suspended = false;
1167
1168         return ret;
1169 }
1170 EXPORT_SYMBOL(phy_resume);
1171
1172 int phy_loopback(struct phy_device *phydev, bool enable)
1173 {
1174         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1175         int ret = 0;
1176
1177         mutex_lock(&phydev->lock);
1178
1179         if (enable && phydev->loopback_enabled) {
1180                 ret = -EBUSY;
1181                 goto out;
1182         }
1183
1184         if (!enable && !phydev->loopback_enabled) {
1185                 ret = -EINVAL;
1186                 goto out;
1187         }
1188
1189         if (phydev->drv && phydrv->set_loopback)
1190                 ret = phydrv->set_loopback(phydev, enable);
1191         else
1192                 ret = -EOPNOTSUPP;
1193
1194         if (ret)
1195                 goto out;
1196
1197         phydev->loopback_enabled = enable;
1198
1199 out:
1200         mutex_unlock(&phydev->lock);
1201         return ret;
1202 }
1203 EXPORT_SYMBOL(phy_loopback);
1204
1205 /* Generic PHY support and helper functions */
1206
1207 /**
1208  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1209  * @phydev: target phy_device struct
1210  *
1211  * Description: Writes MII_ADVERTISE with the appropriate values,
1212  *   after sanitizing the values to make sure we only advertise
1213  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
1214  *   hasn't changed, and > 0 if it has changed.
1215  */
1216 static int genphy_config_advert(struct phy_device *phydev)
1217 {
1218         u32 advertise;
1219         int oldadv, adv, bmsr;
1220         int err, changed = 0;
1221
1222         /* Only allow advertising what this PHY supports */
1223         phydev->advertising &= phydev->supported;
1224         advertise = phydev->advertising;
1225
1226         /* Setup standard advertisement */
1227         adv = phy_read(phydev, MII_ADVERTISE);
1228         if (adv < 0)
1229                 return adv;
1230
1231         oldadv = adv;
1232         adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1233                  ADVERTISE_PAUSE_ASYM);
1234         adv |= ethtool_adv_to_mii_adv_t(advertise);
1235
1236         if (adv != oldadv) {
1237                 err = phy_write(phydev, MII_ADVERTISE, adv);
1238
1239                 if (err < 0)
1240                         return err;
1241                 changed = 1;
1242         }
1243
1244         bmsr = phy_read(phydev, MII_BMSR);
1245         if (bmsr < 0)
1246                 return bmsr;
1247
1248         /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1249          * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1250          * logical 1.
1251          */
1252         if (!(bmsr & BMSR_ESTATEN))
1253                 return changed;
1254
1255         /* Configure gigabit if it's supported */
1256         adv = phy_read(phydev, MII_CTRL1000);
1257         if (adv < 0)
1258                 return adv;
1259
1260         oldadv = adv;
1261         adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1262
1263         if (phydev->supported & (SUPPORTED_1000baseT_Half |
1264                                  SUPPORTED_1000baseT_Full)) {
1265                 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1266         }
1267
1268         if (adv != oldadv)
1269                 changed = 1;
1270
1271         err = phy_write(phydev, MII_CTRL1000, adv);
1272         if (err < 0)
1273                 return err;
1274
1275         return changed;
1276 }
1277
1278 /**
1279  * genphy_config_eee_advert - disable unwanted eee mode advertisement
1280  * @phydev: target phy_device struct
1281  *
1282  * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1283  *   efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1284  *   changed, and 1 if it has changed.
1285  */
1286 static int genphy_config_eee_advert(struct phy_device *phydev)
1287 {
1288         int broken = phydev->eee_broken_modes;
1289         int old_adv, adv;
1290
1291         /* Nothing to disable */
1292         if (!broken)
1293                 return 0;
1294
1295         /* If the following call fails, we assume that EEE is not
1296          * supported by the phy. If we read 0, EEE is not advertised
1297          * In both case, we don't need to continue
1298          */
1299         adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1300         if (adv <= 0)
1301                 return 0;
1302
1303         old_adv = adv;
1304         adv &= ~broken;
1305
1306         /* Advertising remains unchanged with the broken mask */
1307         if (old_adv == adv)
1308                 return 0;
1309
1310         phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1311
1312         return 1;
1313 }
1314
1315 /**
1316  * genphy_setup_forced - configures/forces speed/duplex from @phydev
1317  * @phydev: target phy_device struct
1318  *
1319  * Description: Configures MII_BMCR to force speed/duplex
1320  *   to the values in phydev. Assumes that the values are valid.
1321  *   Please see phy_sanitize_settings().
1322  */
1323 int genphy_setup_forced(struct phy_device *phydev)
1324 {
1325         int ctl = phy_read(phydev, MII_BMCR);
1326
1327         ctl &= BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN;
1328         phydev->pause = 0;
1329         phydev->asym_pause = 0;
1330
1331         if (SPEED_1000 == phydev->speed)
1332                 ctl |= BMCR_SPEED1000;
1333         else if (SPEED_100 == phydev->speed)
1334                 ctl |= BMCR_SPEED100;
1335
1336         if (DUPLEX_FULL == phydev->duplex)
1337                 ctl |= BMCR_FULLDPLX;
1338
1339         return phy_write(phydev, MII_BMCR, ctl);
1340 }
1341 EXPORT_SYMBOL(genphy_setup_forced);
1342
1343 /**
1344  * genphy_restart_aneg - Enable and Restart Autonegotiation
1345  * @phydev: target phy_device struct
1346  */
1347 int genphy_restart_aneg(struct phy_device *phydev)
1348 {
1349         int ctl = phy_read(phydev, MII_BMCR);
1350
1351         if (ctl < 0)
1352                 return ctl;
1353
1354         ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
1355
1356         /* Don't isolate the PHY if we're negotiating */
1357         ctl &= ~BMCR_ISOLATE;
1358
1359         return phy_write(phydev, MII_BMCR, ctl);
1360 }
1361 EXPORT_SYMBOL(genphy_restart_aneg);
1362
1363 /**
1364  * genphy_config_aneg - restart auto-negotiation or write BMCR
1365  * @phydev: target phy_device struct
1366  *
1367  * Description: If auto-negotiation is enabled, we configure the
1368  *   advertising, and then restart auto-negotiation.  If it is not
1369  *   enabled, then we write the BMCR.
1370  */
1371 int genphy_config_aneg(struct phy_device *phydev)
1372 {
1373         int err, changed;
1374
1375         changed = genphy_config_eee_advert(phydev);
1376
1377         if (AUTONEG_ENABLE != phydev->autoneg)
1378                 return genphy_setup_forced(phydev);
1379
1380         err = genphy_config_advert(phydev);
1381         if (err < 0) /* error */
1382                 return err;
1383
1384         changed |= err;
1385
1386         if (changed == 0) {
1387                 /* Advertisement hasn't changed, but maybe aneg was never on to
1388                  * begin with?  Or maybe phy was isolated?
1389                  */
1390                 int ctl = phy_read(phydev, MII_BMCR);
1391
1392                 if (ctl < 0)
1393                         return ctl;
1394
1395                 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1396                         changed = 1; /* do restart aneg */
1397         }
1398
1399         /* Only restart aneg if we are advertising something different
1400          * than we were before.
1401          */
1402         if (changed > 0)
1403                 return genphy_restart_aneg(phydev);
1404
1405         return 0;
1406 }
1407 EXPORT_SYMBOL(genphy_config_aneg);
1408
1409 /**
1410  * genphy_aneg_done - return auto-negotiation status
1411  * @phydev: target phy_device struct
1412  *
1413  * Description: Reads the status register and returns 0 either if
1414  *   auto-negotiation is incomplete, or if there was an error.
1415  *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1416  */
1417 int genphy_aneg_done(struct phy_device *phydev)
1418 {
1419         int retval = phy_read(phydev, MII_BMSR);
1420
1421         return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1422 }
1423 EXPORT_SYMBOL(genphy_aneg_done);
1424
1425 /**
1426  * genphy_update_link - update link status in @phydev
1427  * @phydev: target phy_device struct
1428  *
1429  * Description: Update the value in phydev->link to reflect the
1430  *   current link value.  In order to do this, we need to read
1431  *   the status register twice, keeping the second value.
1432  */
1433 int genphy_update_link(struct phy_device *phydev)
1434 {
1435         int status;
1436
1437         /* Do a fake read */
1438         status = phy_read(phydev, MII_BMSR);
1439         if (status < 0)
1440                 return status;
1441
1442         /* Read link and autonegotiation status */
1443         status = phy_read(phydev, MII_BMSR);
1444         if (status < 0)
1445                 return status;
1446
1447         if ((status & BMSR_LSTATUS) == 0)
1448                 phydev->link = 0;
1449         else
1450                 phydev->link = 1;
1451
1452         return 0;
1453 }
1454 EXPORT_SYMBOL(genphy_update_link);
1455
1456 /**
1457  * genphy_read_status - check the link status and update current link state
1458  * @phydev: target phy_device struct
1459  *
1460  * Description: Check the link, then figure out the current state
1461  *   by comparing what we advertise with what the link partner
1462  *   advertises.  Start by checking the gigabit possibilities,
1463  *   then move on to 10/100.
1464  */
1465 int genphy_read_status(struct phy_device *phydev)
1466 {
1467         int adv;
1468         int err;
1469         int lpa;
1470         int lpagb = 0;
1471         int common_adv;
1472         int common_adv_gb = 0;
1473
1474         /* Update the link, but return if there was an error */
1475         err = genphy_update_link(phydev);
1476         if (err)
1477                 return err;
1478
1479         phydev->lp_advertising = 0;
1480
1481         if (AUTONEG_ENABLE == phydev->autoneg) {
1482                 if (phydev->supported & (SUPPORTED_1000baseT_Half
1483                                         | SUPPORTED_1000baseT_Full)) {
1484                         lpagb = phy_read(phydev, MII_STAT1000);
1485                         if (lpagb < 0)
1486                                 return lpagb;
1487
1488                         adv = phy_read(phydev, MII_CTRL1000);
1489                         if (adv < 0)
1490                                 return adv;
1491
1492                         phydev->lp_advertising =
1493                                 mii_stat1000_to_ethtool_lpa_t(lpagb);
1494                         common_adv_gb = lpagb & adv << 2;
1495                 }
1496
1497                 lpa = phy_read(phydev, MII_LPA);
1498                 if (lpa < 0)
1499                         return lpa;
1500
1501                 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1502
1503                 adv = phy_read(phydev, MII_ADVERTISE);
1504                 if (adv < 0)
1505                         return adv;
1506
1507                 common_adv = lpa & adv;
1508
1509                 phydev->speed = SPEED_10;
1510                 phydev->duplex = DUPLEX_HALF;
1511                 phydev->pause = 0;
1512                 phydev->asym_pause = 0;
1513
1514                 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1515                         phydev->speed = SPEED_1000;
1516
1517                         if (common_adv_gb & LPA_1000FULL)
1518                                 phydev->duplex = DUPLEX_FULL;
1519                 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1520                         phydev->speed = SPEED_100;
1521
1522                         if (common_adv & LPA_100FULL)
1523                                 phydev->duplex = DUPLEX_FULL;
1524                 } else
1525                         if (common_adv & LPA_10FULL)
1526                                 phydev->duplex = DUPLEX_FULL;
1527
1528                 if (phydev->duplex == DUPLEX_FULL) {
1529                         phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1530                         phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1531                 }
1532         } else {
1533                 int bmcr = phy_read(phydev, MII_BMCR);
1534
1535                 if (bmcr < 0)
1536                         return bmcr;
1537
1538                 if (bmcr & BMCR_FULLDPLX)
1539                         phydev->duplex = DUPLEX_FULL;
1540                 else
1541                         phydev->duplex = DUPLEX_HALF;
1542
1543                 if (bmcr & BMCR_SPEED1000)
1544                         phydev->speed = SPEED_1000;
1545                 else if (bmcr & BMCR_SPEED100)
1546                         phydev->speed = SPEED_100;
1547                 else
1548                         phydev->speed = SPEED_10;
1549
1550                 phydev->pause = 0;
1551                 phydev->asym_pause = 0;
1552         }
1553
1554         return 0;
1555 }
1556 EXPORT_SYMBOL(genphy_read_status);
1557
1558 /**
1559  * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1560  * @phydev: target phy_device struct
1561  *
1562  * Description: Perform a software PHY reset using the standard
1563  * BMCR_RESET bit and poll for the reset bit to be cleared.
1564  *
1565  * Returns: 0 on success, < 0 on failure
1566  */
1567 int genphy_soft_reset(struct phy_device *phydev)
1568 {
1569         int ret;
1570
1571         ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1572         if (ret < 0)
1573                 return ret;
1574
1575         return phy_poll_reset(phydev);
1576 }
1577 EXPORT_SYMBOL(genphy_soft_reset);
1578
1579 int genphy_config_init(struct phy_device *phydev)
1580 {
1581         int val;
1582         u32 features;
1583
1584         features = (SUPPORTED_TP | SUPPORTED_MII
1585                         | SUPPORTED_AUI | SUPPORTED_FIBRE |
1586                         SUPPORTED_BNC | SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1587
1588         /* Do we support autonegotiation? */
1589         val = phy_read(phydev, MII_BMSR);
1590         if (val < 0)
1591                 return val;
1592
1593         if (val & BMSR_ANEGCAPABLE)
1594                 features |= SUPPORTED_Autoneg;
1595
1596         if (val & BMSR_100FULL)
1597                 features |= SUPPORTED_100baseT_Full;
1598         if (val & BMSR_100HALF)
1599                 features |= SUPPORTED_100baseT_Half;
1600         if (val & BMSR_10FULL)
1601                 features |= SUPPORTED_10baseT_Full;
1602         if (val & BMSR_10HALF)
1603                 features |= SUPPORTED_10baseT_Half;
1604
1605         if (val & BMSR_ESTATEN) {
1606                 val = phy_read(phydev, MII_ESTATUS);
1607                 if (val < 0)
1608                         return val;
1609
1610                 if (val & ESTATUS_1000_TFULL)
1611                         features |= SUPPORTED_1000baseT_Full;
1612                 if (val & ESTATUS_1000_THALF)
1613                         features |= SUPPORTED_1000baseT_Half;
1614         }
1615
1616         phydev->supported &= features;
1617         phydev->advertising &= features;
1618
1619         return 0;
1620 }
1621 EXPORT_SYMBOL(genphy_config_init);
1622
1623 int genphy_suspend(struct phy_device *phydev)
1624 {
1625         int value;
1626
1627         mutex_lock(&phydev->lock);
1628
1629         value = phy_read(phydev, MII_BMCR);
1630         phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1631
1632         mutex_unlock(&phydev->lock);
1633
1634         return 0;
1635 }
1636 EXPORT_SYMBOL(genphy_suspend);
1637
1638 int genphy_resume(struct phy_device *phydev)
1639 {
1640         int value;
1641
1642         mutex_lock(&phydev->lock);
1643
1644         value = phy_read(phydev, MII_BMCR);
1645         phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1646
1647         mutex_unlock(&phydev->lock);
1648
1649         return 0;
1650 }
1651 EXPORT_SYMBOL(genphy_resume);
1652
1653 int genphy_loopback(struct phy_device *phydev, bool enable)
1654 {
1655         int value;
1656
1657         value = phy_read(phydev, MII_BMCR);
1658         if (value < 0)
1659                 return value;
1660
1661         if (enable)
1662                 value |= BMCR_LOOPBACK;
1663         else
1664                 value &= ~BMCR_LOOPBACK;
1665
1666         return phy_write(phydev, MII_BMCR, value);
1667 }
1668 EXPORT_SYMBOL(genphy_loopback);
1669
1670 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1671 {
1672         /* The default values for phydev->supported are provided by the PHY
1673          * driver "features" member, we want to reset to sane defaults first
1674          * before supporting higher speeds.
1675          */
1676         phydev->supported &= PHY_DEFAULT_FEATURES;
1677
1678         switch (max_speed) {
1679         default:
1680                 return -ENOTSUPP;
1681         case SPEED_1000:
1682                 phydev->supported |= PHY_1000BT_FEATURES;
1683                 /* fall through */
1684         case SPEED_100:
1685                 phydev->supported |= PHY_100BT_FEATURES;
1686                 /* fall through */
1687         case SPEED_10:
1688                 phydev->supported |= PHY_10BT_FEATURES;
1689         }
1690
1691         return 0;
1692 }
1693
1694 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1695 {
1696         int err;
1697
1698         err = __set_phy_supported(phydev, max_speed);
1699         if (err)
1700                 return err;
1701
1702         phydev->advertising = phydev->supported;
1703
1704         return 0;
1705 }
1706 EXPORT_SYMBOL(phy_set_max_speed);
1707
1708 static void of_set_phy_supported(struct phy_device *phydev)
1709 {
1710         struct device_node *node = phydev->mdio.dev.of_node;
1711         u32 max_speed;
1712
1713         if (!IS_ENABLED(CONFIG_OF_MDIO))
1714                 return;
1715
1716         if (!node)
1717                 return;
1718
1719         if (!of_property_read_u32(node, "max-speed", &max_speed))
1720                 __set_phy_supported(phydev, max_speed);
1721 }
1722
1723 static void of_set_phy_eee_broken(struct phy_device *phydev)
1724 {
1725         struct device_node *node = phydev->mdio.dev.of_node;
1726         u32 broken = 0;
1727
1728         if (!IS_ENABLED(CONFIG_OF_MDIO))
1729                 return;
1730
1731         if (!node)
1732                 return;
1733
1734         if (of_property_read_bool(node, "eee-broken-100tx"))
1735                 broken |= MDIO_EEE_100TX;
1736         if (of_property_read_bool(node, "eee-broken-1000t"))
1737                 broken |= MDIO_EEE_1000T;
1738         if (of_property_read_bool(node, "eee-broken-10gt"))
1739                 broken |= MDIO_EEE_10GT;
1740         if (of_property_read_bool(node, "eee-broken-1000kx"))
1741                 broken |= MDIO_EEE_1000KX;
1742         if (of_property_read_bool(node, "eee-broken-10gkx4"))
1743                 broken |= MDIO_EEE_10GKX4;
1744         if (of_property_read_bool(node, "eee-broken-10gkr"))
1745                 broken |= MDIO_EEE_10GKR;
1746
1747         phydev->eee_broken_modes = broken;
1748 }
1749
1750 /**
1751  * phy_probe - probe and init a PHY device
1752  * @dev: device to probe and init
1753  *
1754  * Description: Take care of setting up the phy_device structure,
1755  *   set the state to READY (the driver's init function should
1756  *   set it to STARTING if needed).
1757  */
1758 static int phy_probe(struct device *dev)
1759 {
1760         struct phy_device *phydev = to_phy_device(dev);
1761         struct device_driver *drv = phydev->mdio.dev.driver;
1762         struct phy_driver *phydrv = to_phy_driver(drv);
1763         int err = 0;
1764
1765         phydev->drv = phydrv;
1766
1767         /* Disable the interrupt if the PHY doesn't support it
1768          * but the interrupt is still a valid one
1769          */
1770         if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1771             phy_interrupt_is_valid(phydev))
1772                 phydev->irq = PHY_POLL;
1773
1774         if (phydrv->flags & PHY_IS_INTERNAL)
1775                 phydev->is_internal = true;
1776
1777         mutex_lock(&phydev->lock);
1778
1779         /* Start out supporting everything. Eventually,
1780          * a controller will attach, and may modify one
1781          * or both of these values
1782          */
1783         phydev->supported = phydrv->features;
1784         of_set_phy_supported(phydev);
1785         phydev->advertising = phydev->supported;
1786
1787         /* Get the EEE modes we want to prohibit. We will ask
1788          * the PHY stop advertising these mode later on
1789          */
1790         of_set_phy_eee_broken(phydev);
1791
1792         /* The Pause Frame bits indicate that the PHY can support passing
1793          * pause frames. During autonegotiation, the PHYs will determine if
1794          * they should allow pause frames to pass.  The MAC driver should then
1795          * use that result to determine whether to enable flow control via
1796          * pause frames.
1797          *
1798          * Normally, PHY drivers should not set the Pause bits, and instead
1799          * allow phylib to do that.  However, there may be some situations
1800          * (e.g. hardware erratum) where the driver wants to set only one
1801          * of these bits.
1802          */
1803         if (phydrv->features & (SUPPORTED_Pause | SUPPORTED_Asym_Pause)) {
1804                 phydev->supported &= ~(SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1805                 phydev->supported |= phydrv->features &
1806                                      (SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1807         } else {
1808                 phydev->supported |= SUPPORTED_Pause | SUPPORTED_Asym_Pause;
1809         }
1810
1811         /* Set the state to READY by default */
1812         phydev->state = PHY_READY;
1813
1814         if (phydev->drv->probe)
1815                 err = phydev->drv->probe(phydev);
1816
1817         mutex_unlock(&phydev->lock);
1818
1819         return err;
1820 }
1821
1822 static int phy_remove(struct device *dev)
1823 {
1824         struct phy_device *phydev = to_phy_device(dev);
1825
1826         cancel_delayed_work_sync(&phydev->state_queue);
1827
1828         mutex_lock(&phydev->lock);
1829         phydev->state = PHY_DOWN;
1830         mutex_unlock(&phydev->lock);
1831
1832         if (phydev->drv && phydev->drv->remove)
1833                 phydev->drv->remove(phydev);
1834         phydev->drv = NULL;
1835
1836         return 0;
1837 }
1838
1839 /**
1840  * phy_driver_register - register a phy_driver with the PHY layer
1841  * @new_driver: new phy_driver to register
1842  * @owner: module owning this PHY
1843  */
1844 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
1845 {
1846         int retval;
1847
1848         new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
1849         new_driver->mdiodrv.driver.name = new_driver->name;
1850         new_driver->mdiodrv.driver.bus = &mdio_bus_type;
1851         new_driver->mdiodrv.driver.probe = phy_probe;
1852         new_driver->mdiodrv.driver.remove = phy_remove;
1853         new_driver->mdiodrv.driver.owner = owner;
1854
1855         retval = driver_register(&new_driver->mdiodrv.driver);
1856         if (retval) {
1857                 pr_err("%s: Error %d in registering driver\n",
1858                        new_driver->name, retval);
1859
1860                 return retval;
1861         }
1862
1863         pr_debug("%s: Registered new driver\n", new_driver->name);
1864
1865         return 0;
1866 }
1867 EXPORT_SYMBOL(phy_driver_register);
1868
1869 int phy_drivers_register(struct phy_driver *new_driver, int n,
1870                          struct module *owner)
1871 {
1872         int i, ret = 0;
1873
1874         for (i = 0; i < n; i++) {
1875                 ret = phy_driver_register(new_driver + i, owner);
1876                 if (ret) {
1877                         while (i-- > 0)
1878                                 phy_driver_unregister(new_driver + i);
1879                         break;
1880                 }
1881         }
1882         return ret;
1883 }
1884 EXPORT_SYMBOL(phy_drivers_register);
1885
1886 void phy_driver_unregister(struct phy_driver *drv)
1887 {
1888         driver_unregister(&drv->mdiodrv.driver);
1889 }
1890 EXPORT_SYMBOL(phy_driver_unregister);
1891
1892 void phy_drivers_unregister(struct phy_driver *drv, int n)
1893 {
1894         int i;
1895
1896         for (i = 0; i < n; i++)
1897                 phy_driver_unregister(drv + i);
1898 }
1899 EXPORT_SYMBOL(phy_drivers_unregister);
1900
1901 static struct phy_driver genphy_driver = {
1902         .phy_id         = 0xffffffff,
1903         .phy_id_mask    = 0xffffffff,
1904         .name           = "Generic PHY",
1905         .soft_reset     = genphy_no_soft_reset,
1906         .config_init    = genphy_config_init,
1907         .features       = PHY_GBIT_FEATURES | SUPPORTED_MII |
1908                           SUPPORTED_AUI | SUPPORTED_FIBRE |
1909                           SUPPORTED_BNC,
1910         .config_aneg    = genphy_config_aneg,
1911         .aneg_done      = genphy_aneg_done,
1912         .read_status    = genphy_read_status,
1913         .suspend        = genphy_suspend,
1914         .resume         = genphy_resume,
1915         .set_loopback   = genphy_loopback,
1916 };
1917
1918 static int __init phy_init(void)
1919 {
1920         int rc;
1921
1922         rc = mdio_bus_init();
1923         if (rc)
1924                 return rc;
1925
1926         rc = phy_driver_register(&genphy_10g_driver, THIS_MODULE);
1927         if (rc)
1928                 goto err_10g;
1929
1930         rc = phy_driver_register(&genphy_driver, THIS_MODULE);
1931         if (rc) {
1932                 phy_driver_unregister(&genphy_10g_driver);
1933 err_10g:
1934                 mdio_bus_exit();
1935         }
1936
1937         return rc;
1938 }
1939
1940 static void __exit phy_exit(void)
1941 {
1942         phy_driver_unregister(&genphy_10g_driver);
1943         phy_driver_unregister(&genphy_driver);
1944         mdio_bus_exit();
1945 }
1946
1947 subsys_initcall(phy_init);
1948 module_exit(phy_exit);