1 /* Framework for finding and configuring PHYs.
2 * Also contains generic PHY driver
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
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.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
29 #include <linux/module.h>
30 #include <linux/mii.h>
31 #include <linux/ethtool.h>
32 #include <linux/phy.h>
33 #include <linux/mdio.h>
35 #include <linux/uaccess.h>
40 MODULE_DESCRIPTION("PHY library");
41 MODULE_AUTHOR("Andy Fleming");
42 MODULE_LICENSE("GPL");
44 void phy_device_free(struct phy_device *phydev)
46 put_device(&phydev->mdio.dev);
48 EXPORT_SYMBOL(phy_device_free);
50 static void phy_mdio_device_free(struct mdio_device *mdiodev)
52 struct phy_device *phydev;
54 phydev = container_of(mdiodev, struct phy_device, mdio);
55 phy_device_free(phydev);
58 static void phy_device_release(struct device *dev)
60 kfree(to_phy_device(dev));
63 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
65 struct phy_device *phydev;
67 phydev = container_of(mdiodev, struct phy_device, mdio);
68 phy_device_remove(phydev);
77 static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
79 static LIST_HEAD(phy_fixup_list);
80 static DEFINE_MUTEX(phy_fixup_lock);
83 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
85 struct device_driver *drv = phydev->mdio.dev.driver;
86 struct phy_driver *phydrv = to_phy_driver(drv);
87 struct net_device *netdev = phydev->attached_dev;
89 if (!drv || !phydrv->suspend)
92 /* PHY not attached? May suspend if the PHY has not already been
93 * suspended as part of a prior call to phy_disconnect() ->
94 * phy_detach() -> phy_suspend() because the parent netdev might be the
95 * MDIO bus driver and clock gated at this point.
98 return !phydev->suspended;
100 /* Don't suspend PHY if the attached netdev parent may wakeup.
101 * The parent may point to a PCI device, as in tg3 driver.
103 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
106 /* Also don't suspend PHY if the netdev itself may wakeup. This
107 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
110 if (device_may_wakeup(&netdev->dev))
116 static int mdio_bus_phy_suspend(struct device *dev)
118 struct phy_device *phydev = to_phy_device(dev);
120 /* We must stop the state machine manually, otherwise it stops out of
121 * control, possibly with the phydev->lock held. Upon resume, netdev
122 * may call phy routines that try to grab the same lock, and that may
123 * lead to a deadlock.
125 if (phydev->attached_dev && phydev->adjust_link)
126 phy_stop_machine(phydev);
128 if (!mdio_bus_phy_may_suspend(phydev))
131 return phy_suspend(phydev);
134 static int mdio_bus_phy_resume(struct device *dev)
136 struct phy_device *phydev = to_phy_device(dev);
139 if (!mdio_bus_phy_may_suspend(phydev))
142 ret = phy_resume(phydev);
147 if (phydev->attached_dev && phydev->adjust_link)
148 phy_start_machine(phydev);
153 static int mdio_bus_phy_restore(struct device *dev)
155 struct phy_device *phydev = to_phy_device(dev);
156 struct net_device *netdev = phydev->attached_dev;
162 ret = phy_init_hw(phydev);
166 /* The PHY needs to renegotiate. */
168 phydev->state = PHY_UP;
170 phy_start_machine(phydev);
175 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
176 .suspend = mdio_bus_phy_suspend,
177 .resume = mdio_bus_phy_resume,
178 .freeze = mdio_bus_phy_suspend,
179 .thaw = mdio_bus_phy_resume,
180 .restore = mdio_bus_phy_restore,
183 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
187 #define MDIO_BUS_PHY_PM_OPS NULL
189 #endif /* CONFIG_PM */
192 * phy_register_fixup - creates a new phy_fixup and adds it to the list
193 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
194 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
195 * It can also be PHY_ANY_UID
196 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
198 * @run: The actual code to be run when a matching PHY is found
200 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
201 int (*run)(struct phy_device *))
203 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
208 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
209 fixup->phy_uid = phy_uid;
210 fixup->phy_uid_mask = phy_uid_mask;
213 mutex_lock(&phy_fixup_lock);
214 list_add_tail(&fixup->list, &phy_fixup_list);
215 mutex_unlock(&phy_fixup_lock);
219 EXPORT_SYMBOL(phy_register_fixup);
221 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
222 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
223 int (*run)(struct phy_device *))
225 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
227 EXPORT_SYMBOL(phy_register_fixup_for_uid);
229 /* Registers a fixup to be run on the PHY with id string bus_id */
230 int phy_register_fixup_for_id(const char *bus_id,
231 int (*run)(struct phy_device *))
233 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
235 EXPORT_SYMBOL(phy_register_fixup_for_id);
237 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
238 * Fixups can be set to match any in one or more fields.
240 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
242 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
243 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
246 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
247 (phydev->phy_id & fixup->phy_uid_mask))
248 if (fixup->phy_uid != PHY_ANY_UID)
254 /* Runs any matching fixups for this phydev */
255 static int phy_scan_fixups(struct phy_device *phydev)
257 struct phy_fixup *fixup;
259 mutex_lock(&phy_fixup_lock);
260 list_for_each_entry(fixup, &phy_fixup_list, list) {
261 if (phy_needs_fixup(phydev, fixup)) {
262 int err = fixup->run(phydev);
265 mutex_unlock(&phy_fixup_lock);
268 phydev->has_fixups = true;
271 mutex_unlock(&phy_fixup_lock);
276 static int phy_bus_match(struct device *dev, struct device_driver *drv)
278 struct phy_device *phydev = to_phy_device(dev);
279 struct phy_driver *phydrv = to_phy_driver(drv);
280 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
283 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
286 if (phydrv->match_phy_device)
287 return phydrv->match_phy_device(phydev);
289 if (phydev->is_c45) {
290 for (i = 1; i < num_ids; i++) {
291 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
294 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
295 (phydev->c45_ids.device_ids[i] &
296 phydrv->phy_id_mask))
301 return (phydrv->phy_id & phydrv->phy_id_mask) ==
302 (phydev->phy_id & phydrv->phy_id_mask);
306 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
308 struct phy_c45_device_ids *c45_ids)
310 struct phy_device *dev;
311 struct mdio_device *mdiodev;
313 /* We allocate the device, and initialize the default values */
314 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
316 return ERR_PTR(-ENOMEM);
318 mdiodev = &dev->mdio;
319 mdiodev->dev.release = phy_device_release;
320 mdiodev->dev.parent = &bus->dev;
321 mdiodev->dev.bus = &mdio_bus_type;
323 mdiodev->pm_ops = MDIO_BUS_PHY_PM_OPS;
324 mdiodev->bus_match = phy_bus_match;
325 mdiodev->addr = addr;
326 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
327 mdiodev->device_free = phy_mdio_device_free;
328 mdiodev->device_remove = phy_mdio_device_remove;
335 dev->interface = PHY_INTERFACE_MODE_GMII;
337 dev->autoneg = AUTONEG_ENABLE;
339 dev->is_c45 = is_c45;
340 dev->phy_id = phy_id;
342 dev->c45_ids = *c45_ids;
343 dev->irq = bus->irq[addr];
344 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
346 dev->state = PHY_DOWN;
348 mutex_init(&dev->lock);
349 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
350 INIT_WORK(&dev->phy_queue, phy_change);
352 /* Request the appropriate module unconditionally; don't
353 * bother trying to do so only if it isn't already loaded,
354 * because that gets complicated. A hotplug event would have
355 * done an unconditional modprobe anyway.
356 * We don't do normal hotplug because it won't work for MDIO
357 * -- because it relies on the device staying around for long
358 * enough for the driver to get loaded. With MDIO, the NIC
359 * driver will get bored and give up as soon as it finds that
360 * there's no driver _already_ loaded.
362 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
364 device_initialize(&mdiodev->dev);
368 EXPORT_SYMBOL(phy_device_create);
370 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
371 * @bus: the target MII bus
372 * @addr: PHY address on the MII bus
373 * @dev_addr: MMD address in the PHY.
374 * @devices_in_package: where to store the devices in package information.
376 * Description: reads devices in package registers of a MMD at @dev_addr
377 * from PHY at @addr on @bus.
379 * Returns: 0 on success, -EIO on failure.
381 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
382 u32 *devices_in_package)
384 int phy_reg, reg_addr;
386 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
387 phy_reg = mdiobus_read(bus, addr, reg_addr);
390 *devices_in_package = (phy_reg & 0xffff) << 16;
392 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
393 phy_reg = mdiobus_read(bus, addr, reg_addr);
396 *devices_in_package |= (phy_reg & 0xffff);
402 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
403 * @bus: the target MII bus
404 * @addr: PHY address on the MII bus
405 * @phy_id: where to store the ID retrieved.
406 * @c45_ids: where to store the c45 ID information.
408 * If the PHY devices-in-package appears to be valid, it and the
409 * corresponding identifiers are stored in @c45_ids, zero is stored
410 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
414 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
415 struct phy_c45_device_ids *c45_ids) {
418 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
419 u32 *devs = &c45_ids->devices_in_package;
421 /* Find first non-zero Devices In package. Device zero is reserved
422 * for 802.3 c45 complied PHYs, so don't probe it at first.
424 for (i = 1; i < num_ids && *devs == 0; i++) {
425 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
429 if ((*devs & 0x1fffffff) == 0x1fffffff) {
430 /* If mostly Fs, there is no device there,
431 * then let's continue to probe more, as some
432 * 10G PHYs have zero Devices In package,
433 * e.g. Cortina CS4315/CS4340 PHY.
435 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
438 /* no device there, let's get out of here */
439 if ((*devs & 0x1fffffff) == 0x1fffffff) {
440 *phy_id = 0xffffffff;
448 /* Now probe Device Identifiers for each device present. */
449 for (i = 1; i < num_ids; i++) {
450 if (!(c45_ids->devices_in_package & (1 << i)))
453 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
454 phy_reg = mdiobus_read(bus, addr, reg_addr);
457 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
459 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
460 phy_reg = mdiobus_read(bus, addr, reg_addr);
463 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
470 * get_phy_id - reads the specified addr for its ID.
471 * @bus: the target MII bus
472 * @addr: PHY address on the MII bus
473 * @phy_id: where to store the ID retrieved.
474 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
475 * @c45_ids: where to store the c45 ID information.
477 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
478 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
481 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
482 * its return value is in turn returned.
485 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
486 bool is_c45, struct phy_c45_device_ids *c45_ids)
491 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
493 /* Grab the bits from PHYIR1, and put them in the upper half */
494 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
498 *phy_id = (phy_reg & 0xffff) << 16;
500 /* Grab the bits from PHYIR2, and put them in the lower half */
501 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
505 *phy_id |= (phy_reg & 0xffff);
511 * get_phy_device - reads the specified PHY device and returns its @phy_device
513 * @bus: the target MII bus
514 * @addr: PHY address on the MII bus
515 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
517 * Description: Reads the ID registers of the PHY at @addr on the
518 * @bus, then allocates and returns the phy_device to represent it.
520 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
522 struct phy_c45_device_ids c45_ids = {0};
526 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
530 /* If the phy_id is mostly Fs, there is no device there */
531 if ((phy_id & 0x1fffffff) == 0x1fffffff)
532 return ERR_PTR(-ENODEV);
534 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
536 EXPORT_SYMBOL(get_phy_device);
539 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
541 struct phy_device *phydev = to_phy_device(dev);
543 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
545 static DEVICE_ATTR_RO(phy_id);
548 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
550 struct phy_device *phydev = to_phy_device(dev);
551 const char *mode = NULL;
553 if (phy_is_internal(phydev))
556 mode = phy_modes(phydev->interface);
558 return sprintf(buf, "%s\n", mode);
560 static DEVICE_ATTR_RO(phy_interface);
563 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
566 struct phy_device *phydev = to_phy_device(dev);
568 return sprintf(buf, "%d\n", phydev->has_fixups);
570 static DEVICE_ATTR_RO(phy_has_fixups);
572 static struct attribute *phy_dev_attrs[] = {
573 &dev_attr_phy_id.attr,
574 &dev_attr_phy_interface.attr,
575 &dev_attr_phy_has_fixups.attr,
578 ATTRIBUTE_GROUPS(phy_dev);
581 * phy_device_register - Register the phy device on the MDIO bus
582 * @phydev: phy_device structure to be added to the MDIO bus
584 int phy_device_register(struct phy_device *phydev)
588 err = mdiobus_register_device(&phydev->mdio);
592 /* Run all of the fixups for this PHY */
593 err = phy_scan_fixups(phydev);
595 pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
599 phydev->mdio.dev.groups = phy_dev_groups;
601 err = device_add(&phydev->mdio.dev);
603 pr_err("PHY %d failed to add\n", phydev->mdio.addr);
610 mdiobus_unregister_device(&phydev->mdio);
613 EXPORT_SYMBOL(phy_device_register);
616 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
617 * @phydev: phy_device structure to remove
619 * This doesn't free the phy_device itself, it merely reverses the effects
620 * of phy_device_register(). Use phy_device_free() to free the device
621 * after calling this function.
623 void phy_device_remove(struct phy_device *phydev)
625 device_del(&phydev->mdio.dev);
626 mdiobus_unregister_device(&phydev->mdio);
628 EXPORT_SYMBOL(phy_device_remove);
631 * phy_find_first - finds the first PHY device on the bus
632 * @bus: the target MII bus
634 struct phy_device *phy_find_first(struct mii_bus *bus)
636 struct phy_device *phydev;
639 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
640 phydev = mdiobus_get_phy(bus, addr);
646 EXPORT_SYMBOL(phy_find_first);
649 * phy_prepare_link - prepares the PHY layer to monitor link status
650 * @phydev: target phy_device struct
651 * @handler: callback function for link status change notifications
653 * Description: Tells the PHY infrastructure to handle the
654 * gory details on monitoring link status (whether through
655 * polling or an interrupt), and to call back to the
656 * connected device driver when the link status changes.
657 * If you want to monitor your own link state, don't call
660 static void phy_prepare_link(struct phy_device *phydev,
661 void (*handler)(struct net_device *))
663 phydev->adjust_link = handler;
667 * phy_connect_direct - connect an ethernet device to a specific phy_device
668 * @dev: the network device to connect
669 * @phydev: the pointer to the phy device
670 * @handler: callback function for state change notifications
671 * @interface: PHY device's interface
673 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
674 void (*handler)(struct net_device *),
675 phy_interface_t interface)
679 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
683 phy_prepare_link(phydev, handler);
684 phy_start_machine(phydev);
686 phy_start_interrupts(phydev);
690 EXPORT_SYMBOL(phy_connect_direct);
693 * phy_connect - connect an ethernet device to a PHY device
694 * @dev: the network device to connect
695 * @bus_id: the id string of the PHY device to connect
696 * @handler: callback function for state change notifications
697 * @interface: PHY device's interface
699 * Description: Convenience function for connecting ethernet
700 * devices to PHY devices. The default behavior is for
701 * the PHY infrastructure to handle everything, and only notify
702 * the connected driver when the link status changes. If you
703 * don't want, or can't use the provided functionality, you may
704 * choose to call only the subset of functions which provide
705 * the desired functionality.
707 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
708 void (*handler)(struct net_device *),
709 phy_interface_t interface)
711 struct phy_device *phydev;
715 /* Search the list of PHY devices on the mdio bus for the
716 * PHY with the requested name
718 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
720 pr_err("PHY %s not found\n", bus_id);
721 return ERR_PTR(-ENODEV);
723 phydev = to_phy_device(d);
725 rc = phy_connect_direct(dev, phydev, handler, interface);
732 EXPORT_SYMBOL(phy_connect);
735 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
737 * @phydev: target phy_device struct
739 void phy_disconnect(struct phy_device *phydev)
742 phy_stop_interrupts(phydev);
744 phy_stop_machine(phydev);
746 phydev->adjust_link = NULL;
750 EXPORT_SYMBOL(phy_disconnect);
753 * phy_poll_reset - Safely wait until a PHY reset has properly completed
754 * @phydev: The PHY device to poll
756 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
757 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
758 * register must be polled until the BMCR_RESET bit clears.
760 * Furthermore, any attempts to write to PHY registers may have no effect
761 * or even generate MDIO bus errors until this is complete.
763 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
764 * standard and do not fully reset after the BMCR_RESET bit is set, and may
765 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
766 * effort to support such broken PHYs, this function is separate from the
767 * standard phy_init_hw() which will zero all the other bits in the BMCR
768 * and reapply all driver-specific and board-specific fixups.
770 static int phy_poll_reset(struct phy_device *phydev)
772 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
773 unsigned int retries = 12;
778 ret = phy_read(phydev, MII_BMCR);
781 } while (ret & BMCR_RESET && --retries);
782 if (ret & BMCR_RESET)
785 /* Some chips (smsc911x) may still need up to another 1ms after the
786 * BMCR_RESET bit is cleared before they are usable.
792 int phy_init_hw(struct phy_device *phydev)
796 if (!phydev->drv || !phydev->drv->config_init)
799 if (phydev->drv->soft_reset)
800 ret = phydev->drv->soft_reset(phydev);
802 ret = genphy_soft_reset(phydev);
807 ret = phy_scan_fixups(phydev);
811 return phydev->drv->config_init(phydev);
813 EXPORT_SYMBOL(phy_init_hw);
815 void phy_attached_info(struct phy_device *phydev)
817 phy_attached_print(phydev, NULL);
819 EXPORT_SYMBOL(phy_attached_info);
821 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)"
822 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
825 dev_info(&phydev->mdio.dev, ATTACHED_FMT "\n",
826 phydev->drv->name, phydev_name(phydev),
831 dev_info(&phydev->mdio.dev, ATTACHED_FMT,
832 phydev->drv->name, phydev_name(phydev),
840 EXPORT_SYMBOL(phy_attached_print);
843 * phy_attach_direct - attach a network device to a given PHY device pointer
844 * @dev: network device to attach
845 * @phydev: Pointer to phy_device to attach
846 * @flags: PHY device's dev_flags
847 * @interface: PHY device's interface
849 * Description: Called by drivers to attach to a particular PHY
850 * device. The phy_device is found, and properly hooked up
851 * to the phy_driver. If no driver is attached, then a
852 * generic driver is used. The phy_device is given a ptr to
853 * the attaching device, and given a callback for link status
854 * change. The phy_device is returned to the attaching driver.
855 * This function takes a reference on the phy device.
857 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
858 u32 flags, phy_interface_t interface)
860 struct module *ndev_owner = dev->dev.parent->driver->owner;
861 struct mii_bus *bus = phydev->mdio.bus;
862 struct device *d = &phydev->mdio.dev;
865 /* For Ethernet device drivers that register their own MDIO bus, we
866 * will have bus->owner match ndev_mod, so we do not want to increment
867 * our own module->refcnt here, otherwise we would not be able to
870 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
871 dev_err(&dev->dev, "failed to get the bus module\n");
877 /* Assume that if there is no driver, that it doesn't
878 * exist, and we should use the genphy driver.
883 &genphy_driver[GENPHY_DRV_10G].mdiodrv.driver;
886 &genphy_driver[GENPHY_DRV_1G].mdiodrv.driver;
888 err = d->driver->probe(d);
890 err = device_bind_driver(d);
896 if (phydev->attached_dev) {
897 dev_err(&dev->dev, "PHY already attached\n");
902 phydev->attached_dev = dev;
903 dev->phydev = phydev;
905 phydev->dev_flags = flags;
907 phydev->interface = interface;
909 phydev->state = PHY_READY;
911 /* Initial carrier state is off as the phy is about to be
914 netif_carrier_off(phydev->attached_dev);
916 /* Do initial configuration here, now that
917 * we have certain key parameters
918 * (dev_flags and interface)
920 err = phy_init_hw(phydev);
930 if (ndev_owner != bus->owner)
931 module_put(bus->owner);
934 EXPORT_SYMBOL(phy_attach_direct);
937 * phy_attach - attach a network device to a particular PHY device
938 * @dev: network device to attach
939 * @bus_id: Bus ID of PHY device to attach
940 * @interface: PHY device's interface
942 * Description: Same as phy_attach_direct() except that a PHY bus_id
943 * string is passed instead of a pointer to a struct phy_device.
945 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
946 phy_interface_t interface)
948 struct bus_type *bus = &mdio_bus_type;
949 struct phy_device *phydev;
953 /* Search the list of PHY devices on the mdio bus for the
954 * PHY with the requested name
956 d = bus_find_device_by_name(bus, NULL, bus_id);
958 pr_err("PHY %s not found\n", bus_id);
959 return ERR_PTR(-ENODEV);
961 phydev = to_phy_device(d);
963 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
970 EXPORT_SYMBOL(phy_attach);
973 * phy_detach - detach a PHY device from its network device
974 * @phydev: target phy_device struct
976 * This detaches the phy device from its network device and the phy
977 * driver, and drops the reference count taken in phy_attach_direct().
979 void phy_detach(struct phy_device *phydev)
981 struct net_device *dev = phydev->attached_dev;
982 struct module *ndev_owner = dev->dev.parent->driver->owner;
986 phydev->attached_dev->phydev = NULL;
987 phydev->attached_dev = NULL;
990 /* If the device had no specific driver before (i.e. - it
991 * was using the generic driver), we unbind the device
992 * from the generic driver so that there's a chance a
993 * real driver could be loaded
995 for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
996 if (phydev->mdio.dev.driver ==
997 &genphy_driver[i].mdiodrv.driver) {
998 device_release_driver(&phydev->mdio.dev);
1004 * The phydev might go away on the put_device() below, so avoid
1005 * a use-after-free bug by reading the underlying bus first.
1007 bus = phydev->mdio.bus;
1009 put_device(&phydev->mdio.dev);
1010 if (ndev_owner != bus->owner)
1011 module_put(bus->owner);
1013 EXPORT_SYMBOL(phy_detach);
1015 int phy_suspend(struct phy_device *phydev)
1017 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1018 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1021 /* If the device has WOL enabled, we cannot suspend the PHY */
1022 phy_ethtool_get_wol(phydev, &wol);
1026 if (phydrv->suspend)
1027 ret = phydrv->suspend(phydev);
1032 phydev->suspended = true;
1036 EXPORT_SYMBOL(phy_suspend);
1038 int phy_resume(struct phy_device *phydev)
1040 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1044 ret = phydrv->resume(phydev);
1049 phydev->suspended = false;
1053 EXPORT_SYMBOL(phy_resume);
1055 /* Generic PHY support and helper functions */
1058 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1059 * @phydev: target phy_device struct
1061 * Description: Writes MII_ADVERTISE with the appropriate values,
1062 * after sanitizing the values to make sure we only advertise
1063 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1064 * hasn't changed, and > 0 if it has changed.
1066 static int genphy_config_advert(struct phy_device *phydev)
1069 int oldadv, adv, bmsr;
1070 int err, changed = 0;
1072 /* Only allow advertising what this PHY supports */
1073 phydev->advertising &= phydev->supported;
1074 advertise = phydev->advertising;
1076 /* Setup standard advertisement */
1077 adv = phy_read(phydev, MII_ADVERTISE);
1082 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1083 ADVERTISE_PAUSE_ASYM);
1084 adv |= ethtool_adv_to_mii_adv_t(advertise);
1086 if (adv != oldadv) {
1087 err = phy_write(phydev, MII_ADVERTISE, adv);
1094 bmsr = phy_read(phydev, MII_BMSR);
1098 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1099 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1102 if (!(bmsr & BMSR_ESTATEN))
1105 /* Configure gigabit if it's supported */
1106 adv = phy_read(phydev, MII_CTRL1000);
1111 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1113 if (phydev->supported & (SUPPORTED_1000baseT_Half |
1114 SUPPORTED_1000baseT_Full)) {
1115 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1121 err = phy_write(phydev, MII_CTRL1000, adv);
1129 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1130 * @phydev: target phy_device struct
1132 * Description: Configures MII_BMCR to force speed/duplex
1133 * to the values in phydev. Assumes that the values are valid.
1134 * Please see phy_sanitize_settings().
1136 int genphy_setup_forced(struct phy_device *phydev)
1138 int ctl = phy_read(phydev, MII_BMCR);
1140 ctl &= BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN;
1142 phydev->asym_pause = 0;
1144 if (SPEED_1000 == phydev->speed)
1145 ctl |= BMCR_SPEED1000;
1146 else if (SPEED_100 == phydev->speed)
1147 ctl |= BMCR_SPEED100;
1149 if (DUPLEX_FULL == phydev->duplex)
1150 ctl |= BMCR_FULLDPLX;
1152 return phy_write(phydev, MII_BMCR, ctl);
1154 EXPORT_SYMBOL(genphy_setup_forced);
1157 * genphy_restart_aneg - Enable and Restart Autonegotiation
1158 * @phydev: target phy_device struct
1160 int genphy_restart_aneg(struct phy_device *phydev)
1162 int ctl = phy_read(phydev, MII_BMCR);
1167 ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
1169 /* Don't isolate the PHY if we're negotiating */
1170 ctl &= ~BMCR_ISOLATE;
1172 return phy_write(phydev, MII_BMCR, ctl);
1174 EXPORT_SYMBOL(genphy_restart_aneg);
1177 * genphy_config_aneg - restart auto-negotiation or write BMCR
1178 * @phydev: target phy_device struct
1180 * Description: If auto-negotiation is enabled, we configure the
1181 * advertising, and then restart auto-negotiation. If it is not
1182 * enabled, then we write the BMCR.
1184 int genphy_config_aneg(struct phy_device *phydev)
1188 if (AUTONEG_ENABLE != phydev->autoneg)
1189 return genphy_setup_forced(phydev);
1191 result = genphy_config_advert(phydev);
1192 if (result < 0) /* error */
1195 /* Advertisement hasn't changed, but maybe aneg was never on to
1196 * begin with? Or maybe phy was isolated?
1198 int ctl = phy_read(phydev, MII_BMCR);
1203 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1204 result = 1; /* do restart aneg */
1207 /* Only restart aneg if we are advertising something different
1208 * than we were before.
1211 result = genphy_restart_aneg(phydev);
1215 EXPORT_SYMBOL(genphy_config_aneg);
1218 * genphy_aneg_done - return auto-negotiation status
1219 * @phydev: target phy_device struct
1221 * Description: Reads the status register and returns 0 either if
1222 * auto-negotiation is incomplete, or if there was an error.
1223 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1225 int genphy_aneg_done(struct phy_device *phydev)
1227 int retval = phy_read(phydev, MII_BMSR);
1229 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1231 EXPORT_SYMBOL(genphy_aneg_done);
1233 static int gen10g_config_aneg(struct phy_device *phydev)
1239 * genphy_update_link - update link status in @phydev
1240 * @phydev: target phy_device struct
1242 * Description: Update the value in phydev->link to reflect the
1243 * current link value. In order to do this, we need to read
1244 * the status register twice, keeping the second value.
1246 int genphy_update_link(struct phy_device *phydev)
1250 /* Do a fake read */
1251 status = phy_read(phydev, MII_BMSR);
1255 /* Read link and autonegotiation status */
1256 status = phy_read(phydev, MII_BMSR);
1260 if ((status & BMSR_LSTATUS) == 0)
1267 EXPORT_SYMBOL(genphy_update_link);
1270 * genphy_read_status - check the link status and update current link state
1271 * @phydev: target phy_device struct
1273 * Description: Check the link, then figure out the current state
1274 * by comparing what we advertise with what the link partner
1275 * advertises. Start by checking the gigabit possibilities,
1276 * then move on to 10/100.
1278 int genphy_read_status(struct phy_device *phydev)
1285 int common_adv_gb = 0;
1287 /* Update the link, but return if there was an error */
1288 err = genphy_update_link(phydev);
1292 phydev->lp_advertising = 0;
1294 if (AUTONEG_ENABLE == phydev->autoneg) {
1295 if (phydev->supported & (SUPPORTED_1000baseT_Half
1296 | SUPPORTED_1000baseT_Full)) {
1297 lpagb = phy_read(phydev, MII_STAT1000);
1301 adv = phy_read(phydev, MII_CTRL1000);
1305 phydev->lp_advertising =
1306 mii_stat1000_to_ethtool_lpa_t(lpagb);
1307 common_adv_gb = lpagb & adv << 2;
1310 lpa = phy_read(phydev, MII_LPA);
1314 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1316 adv = phy_read(phydev, MII_ADVERTISE);
1320 common_adv = lpa & adv;
1322 phydev->speed = SPEED_10;
1323 phydev->duplex = DUPLEX_HALF;
1325 phydev->asym_pause = 0;
1327 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1328 phydev->speed = SPEED_1000;
1330 if (common_adv_gb & LPA_1000FULL)
1331 phydev->duplex = DUPLEX_FULL;
1332 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1333 phydev->speed = SPEED_100;
1335 if (common_adv & LPA_100FULL)
1336 phydev->duplex = DUPLEX_FULL;
1338 if (common_adv & LPA_10FULL)
1339 phydev->duplex = DUPLEX_FULL;
1341 if (phydev->duplex == DUPLEX_FULL) {
1342 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1343 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1346 int bmcr = phy_read(phydev, MII_BMCR);
1351 if (bmcr & BMCR_FULLDPLX)
1352 phydev->duplex = DUPLEX_FULL;
1354 phydev->duplex = DUPLEX_HALF;
1356 if (bmcr & BMCR_SPEED1000)
1357 phydev->speed = SPEED_1000;
1358 else if (bmcr & BMCR_SPEED100)
1359 phydev->speed = SPEED_100;
1361 phydev->speed = SPEED_10;
1364 phydev->asym_pause = 0;
1369 EXPORT_SYMBOL(genphy_read_status);
1371 static int gen10g_read_status(struct phy_device *phydev)
1374 u32 mmd_mask = phydev->c45_ids.devices_in_package;
1378 /* For now just lie and say it's 10G all the time */
1379 phydev->speed = SPEED_10000;
1380 phydev->duplex = DUPLEX_FULL;
1382 for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1383 if (!(mmd_mask & 1))
1386 /* Read twice because link state is latched and a
1387 * read moves the current state into the register
1389 phy_read_mmd(phydev, devad, MDIO_STAT1);
1390 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1391 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1399 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1400 * @phydev: target phy_device struct
1402 * Description: Perform a software PHY reset using the standard
1403 * BMCR_RESET bit and poll for the reset bit to be cleared.
1405 * Returns: 0 on success, < 0 on failure
1407 int genphy_soft_reset(struct phy_device *phydev)
1411 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1415 return phy_poll_reset(phydev);
1417 EXPORT_SYMBOL(genphy_soft_reset);
1419 int genphy_config_init(struct phy_device *phydev)
1424 features = (SUPPORTED_TP | SUPPORTED_MII
1425 | SUPPORTED_AUI | SUPPORTED_FIBRE |
1426 SUPPORTED_BNC | SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1428 /* Do we support autonegotiation? */
1429 val = phy_read(phydev, MII_BMSR);
1433 if (val & BMSR_ANEGCAPABLE)
1434 features |= SUPPORTED_Autoneg;
1436 if (val & BMSR_100FULL)
1437 features |= SUPPORTED_100baseT_Full;
1438 if (val & BMSR_100HALF)
1439 features |= SUPPORTED_100baseT_Half;
1440 if (val & BMSR_10FULL)
1441 features |= SUPPORTED_10baseT_Full;
1442 if (val & BMSR_10HALF)
1443 features |= SUPPORTED_10baseT_Half;
1445 if (val & BMSR_ESTATEN) {
1446 val = phy_read(phydev, MII_ESTATUS);
1450 if (val & ESTATUS_1000_TFULL)
1451 features |= SUPPORTED_1000baseT_Full;
1452 if (val & ESTATUS_1000_THALF)
1453 features |= SUPPORTED_1000baseT_Half;
1456 phydev->supported &= features;
1457 phydev->advertising &= features;
1462 static int gen10g_soft_reset(struct phy_device *phydev)
1464 /* Do nothing for now */
1467 EXPORT_SYMBOL(genphy_config_init);
1469 static int gen10g_config_init(struct phy_device *phydev)
1471 /* Temporarily just say we support everything */
1472 phydev->supported = SUPPORTED_10000baseT_Full;
1473 phydev->advertising = SUPPORTED_10000baseT_Full;
1478 int genphy_suspend(struct phy_device *phydev)
1482 mutex_lock(&phydev->lock);
1484 value = phy_read(phydev, MII_BMCR);
1485 phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1487 mutex_unlock(&phydev->lock);
1491 EXPORT_SYMBOL(genphy_suspend);
1493 static int gen10g_suspend(struct phy_device *phydev)
1498 int genphy_resume(struct phy_device *phydev)
1502 mutex_lock(&phydev->lock);
1504 value = phy_read(phydev, MII_BMCR);
1505 phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1507 mutex_unlock(&phydev->lock);
1511 EXPORT_SYMBOL(genphy_resume);
1513 static int gen10g_resume(struct phy_device *phydev)
1518 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1520 /* The default values for phydev->supported are provided by the PHY
1521 * driver "features" member, we want to reset to sane defaults first
1522 * before supporting higher speeds.
1524 phydev->supported &= PHY_DEFAULT_FEATURES;
1526 switch (max_speed) {
1530 phydev->supported |= PHY_1000BT_FEATURES;
1533 phydev->supported |= PHY_100BT_FEATURES;
1536 phydev->supported |= PHY_10BT_FEATURES;
1542 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1546 err = __set_phy_supported(phydev, max_speed);
1550 phydev->advertising = phydev->supported;
1554 EXPORT_SYMBOL(phy_set_max_speed);
1556 static void of_set_phy_supported(struct phy_device *phydev)
1558 struct device_node *node = phydev->mdio.dev.of_node;
1561 if (!IS_ENABLED(CONFIG_OF_MDIO))
1567 if (!of_property_read_u32(node, "max-speed", &max_speed))
1568 __set_phy_supported(phydev, max_speed);
1572 * phy_probe - probe and init a PHY device
1573 * @dev: device to probe and init
1575 * Description: Take care of setting up the phy_device structure,
1576 * set the state to READY (the driver's init function should
1577 * set it to STARTING if needed).
1579 static int phy_probe(struct device *dev)
1581 struct phy_device *phydev = to_phy_device(dev);
1582 struct device_driver *drv = phydev->mdio.dev.driver;
1583 struct phy_driver *phydrv = to_phy_driver(drv);
1586 phydev->drv = phydrv;
1588 /* Disable the interrupt if the PHY doesn't support it
1589 * but the interrupt is still a valid one
1591 if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1592 phy_interrupt_is_valid(phydev))
1593 phydev->irq = PHY_POLL;
1595 if (phydrv->flags & PHY_IS_INTERNAL)
1596 phydev->is_internal = true;
1598 mutex_lock(&phydev->lock);
1600 /* Start out supporting everything. Eventually,
1601 * a controller will attach, and may modify one
1602 * or both of these values
1604 phydev->supported = phydrv->features;
1605 of_set_phy_supported(phydev);
1606 phydev->advertising = phydev->supported;
1608 /* Set the state to READY by default */
1609 phydev->state = PHY_READY;
1611 if (phydev->drv->probe)
1612 err = phydev->drv->probe(phydev);
1614 mutex_unlock(&phydev->lock);
1619 static int phy_remove(struct device *dev)
1621 struct phy_device *phydev = to_phy_device(dev);
1623 mutex_lock(&phydev->lock);
1624 phydev->state = PHY_DOWN;
1625 mutex_unlock(&phydev->lock);
1627 if (phydev->drv->remove)
1628 phydev->drv->remove(phydev);
1635 * phy_driver_register - register a phy_driver with the PHY layer
1636 * @new_driver: new phy_driver to register
1637 * @owner: module owning this PHY
1639 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
1643 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
1644 new_driver->mdiodrv.driver.name = new_driver->name;
1645 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
1646 new_driver->mdiodrv.driver.probe = phy_probe;
1647 new_driver->mdiodrv.driver.remove = phy_remove;
1648 new_driver->mdiodrv.driver.owner = owner;
1650 retval = driver_register(&new_driver->mdiodrv.driver);
1652 pr_err("%s: Error %d in registering driver\n",
1653 new_driver->name, retval);
1658 pr_debug("%s: Registered new driver\n", new_driver->name);
1662 EXPORT_SYMBOL(phy_driver_register);
1664 int phy_drivers_register(struct phy_driver *new_driver, int n,
1665 struct module *owner)
1669 for (i = 0; i < n; i++) {
1670 ret = phy_driver_register(new_driver + i, owner);
1673 phy_driver_unregister(new_driver + i);
1679 EXPORT_SYMBOL(phy_drivers_register);
1681 void phy_driver_unregister(struct phy_driver *drv)
1683 driver_unregister(&drv->mdiodrv.driver);
1685 EXPORT_SYMBOL(phy_driver_unregister);
1687 void phy_drivers_unregister(struct phy_driver *drv, int n)
1691 for (i = 0; i < n; i++)
1692 phy_driver_unregister(drv + i);
1694 EXPORT_SYMBOL(phy_drivers_unregister);
1696 static struct phy_driver genphy_driver[] = {
1698 .phy_id = 0xffffffff,
1699 .phy_id_mask = 0xffffffff,
1700 .name = "Generic PHY",
1701 .soft_reset = genphy_soft_reset,
1702 .config_init = genphy_config_init,
1703 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
1704 SUPPORTED_AUI | SUPPORTED_FIBRE |
1706 .config_aneg = genphy_config_aneg,
1707 .aneg_done = genphy_aneg_done,
1708 .read_status = genphy_read_status,
1709 .suspend = genphy_suspend,
1710 .resume = genphy_resume,
1712 .phy_id = 0xffffffff,
1713 .phy_id_mask = 0xffffffff,
1714 .name = "Generic 10G PHY",
1715 .soft_reset = gen10g_soft_reset,
1716 .config_init = gen10g_config_init,
1718 .config_aneg = gen10g_config_aneg,
1719 .read_status = gen10g_read_status,
1720 .suspend = gen10g_suspend,
1721 .resume = gen10g_resume,
1724 static int __init phy_init(void)
1728 rc = mdio_bus_init();
1732 rc = phy_drivers_register(genphy_driver,
1733 ARRAY_SIZE(genphy_driver), THIS_MODULE);
1740 static void __exit phy_exit(void)
1742 phy_drivers_unregister(genphy_driver,
1743 ARRAY_SIZE(genphy_driver));
1747 subsys_initcall(phy_init);
1748 module_exit(phy_exit);