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