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