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>
37 #include <linux/gpio/consumer.h>
41 MODULE_DESCRIPTION("PHY library");
42 MODULE_AUTHOR("Andy Fleming");
43 MODULE_LICENSE("GPL");
45 void phy_device_free(struct phy_device *phydev)
47 put_device(&phydev->mdio.dev);
49 EXPORT_SYMBOL(phy_device_free);
51 static void phy_mdio_device_free(struct mdio_device *mdiodev)
53 struct phy_device *phydev;
55 phydev = container_of(mdiodev, struct phy_device, mdio);
56 phy_device_free(phydev);
59 static void phy_device_release(struct device *dev)
61 kfree(to_phy_device(dev));
64 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
66 struct phy_device *phydev;
68 phydev = container_of(mdiodev, struct phy_device, mdio);
69 phy_device_remove(phydev);
78 static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
80 static LIST_HEAD(phy_fixup_list);
81 static DEFINE_MUTEX(phy_fixup_lock);
84 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
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;
90 if (!drv || !phydrv->suspend)
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.
99 return !phydev->suspended;
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.
104 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
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,
111 if (device_may_wakeup(&netdev->dev))
117 static int mdio_bus_phy_suspend(struct device *dev)
119 struct phy_device *phydev = to_phy_device(dev);
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.
126 if (phydev->attached_dev && phydev->adjust_link)
127 phy_stop_machine(phydev);
129 if (!mdio_bus_phy_may_suspend(phydev))
132 return phy_suspend(phydev);
135 static int mdio_bus_phy_resume(struct device *dev)
137 struct phy_device *phydev = to_phy_device(dev);
140 if (!mdio_bus_phy_may_suspend(phydev))
143 ret = phy_resume(phydev);
148 if (phydev->attached_dev && phydev->adjust_link)
149 phy_start_machine(phydev);
154 static int mdio_bus_phy_restore(struct device *dev)
156 struct phy_device *phydev = to_phy_device(dev);
157 struct net_device *netdev = phydev->attached_dev;
163 ret = phy_init_hw(phydev);
167 /* The PHY needs to renegotiate. */
169 phydev->state = PHY_UP;
171 phy_start_machine(phydev);
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,
184 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
188 #define MDIO_BUS_PHY_PM_OPS NULL
190 #endif /* CONFIG_PM */
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
199 * @run: The actual code to be run when a matching PHY is found
201 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
202 int (*run)(struct phy_device *))
204 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
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;
214 mutex_lock(&phy_fixup_lock);
215 list_add_tail(&fixup->list, &phy_fixup_list);
216 mutex_unlock(&phy_fixup_lock);
220 EXPORT_SYMBOL(phy_register_fixup);
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 *))
226 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
228 EXPORT_SYMBOL(phy_register_fixup_for_uid);
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 *))
234 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
236 EXPORT_SYMBOL(phy_register_fixup_for_id);
238 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
239 * Fixups can be set to match any in one or more fields.
241 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
243 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
244 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
247 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
248 (phydev->phy_id & fixup->phy_uid_mask))
249 if (fixup->phy_uid != PHY_ANY_UID)
255 /* Runs any matching fixups for this phydev */
256 static int phy_scan_fixups(struct phy_device *phydev)
258 struct phy_fixup *fixup;
260 mutex_lock(&phy_fixup_lock);
261 list_for_each_entry(fixup, &phy_fixup_list, list) {
262 if (phy_needs_fixup(phydev, fixup)) {
263 int err = fixup->run(phydev);
266 mutex_unlock(&phy_fixup_lock);
269 phydev->has_fixups = true;
272 mutex_unlock(&phy_fixup_lock);
277 static int phy_bus_match(struct device *dev, struct device_driver *drv)
279 struct phy_device *phydev = to_phy_device(dev);
280 struct phy_driver *phydrv = to_phy_driver(drv);
281 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
284 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
287 if (phydrv->match_phy_device)
288 return phydrv->match_phy_device(phydev);
290 if (phydev->is_c45) {
291 for (i = 1; i < num_ids; i++) {
292 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
295 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
296 (phydev->c45_ids.device_ids[i] &
297 phydrv->phy_id_mask))
302 return (phydrv->phy_id & phydrv->phy_id_mask) ==
303 (phydev->phy_id & phydrv->phy_id_mask);
307 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
309 struct phy_c45_device_ids *c45_ids)
311 struct phy_device *dev;
312 struct mdio_device *mdiodev;
314 /* We allocate the device, and initialize the default values */
315 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
317 return ERR_PTR(-ENOMEM);
319 mdiodev = &dev->mdio;
320 mdiodev->dev.release = phy_device_release;
321 mdiodev->dev.parent = &bus->dev;
322 mdiodev->dev.bus = &mdio_bus_type;
324 mdiodev->pm_ops = MDIO_BUS_PHY_PM_OPS;
325 mdiodev->bus_match = phy_bus_match;
326 mdiodev->addr = addr;
327 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
328 mdiodev->device_free = phy_mdio_device_free;
329 mdiodev->device_remove = phy_mdio_device_remove;
336 dev->interface = PHY_INTERFACE_MODE_GMII;
338 dev->autoneg = AUTONEG_ENABLE;
340 dev->is_c45 = is_c45;
341 dev->phy_id = phy_id;
343 dev->c45_ids = *c45_ids;
344 dev->irq = bus->irq[addr];
345 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
347 dev->state = PHY_DOWN;
349 mutex_init(&dev->lock);
350 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
351 INIT_WORK(&dev->phy_queue, phy_change);
353 /* Request the appropriate module unconditionally; don't
354 * bother trying to do so only if it isn't already loaded,
355 * because that gets complicated. A hotplug event would have
356 * done an unconditional modprobe anyway.
357 * We don't do normal hotplug because it won't work for MDIO
358 * -- because it relies on the device staying around for long
359 * enough for the driver to get loaded. With MDIO, the NIC
360 * driver will get bored and give up as soon as it finds that
361 * there's no driver _already_ loaded.
363 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
365 device_initialize(&mdiodev->dev);
369 EXPORT_SYMBOL(phy_device_create);
371 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
372 * @bus: the target MII bus
373 * @addr: PHY address on the MII bus
374 * @dev_addr: MMD address in the PHY.
375 * @devices_in_package: where to store the devices in package information.
377 * Description: reads devices in package registers of a MMD at @dev_addr
378 * from PHY at @addr on @bus.
380 * Returns: 0 on success, -EIO on failure.
382 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
383 u32 *devices_in_package)
385 int phy_reg, reg_addr;
387 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
388 phy_reg = mdiobus_read(bus, addr, reg_addr);
391 *devices_in_package = (phy_reg & 0xffff) << 16;
393 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
394 phy_reg = mdiobus_read(bus, addr, reg_addr);
397 *devices_in_package |= (phy_reg & 0xffff);
403 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
404 * @bus: the target MII bus
405 * @addr: PHY address on the MII bus
406 * @phy_id: where to store the ID retrieved.
407 * @c45_ids: where to store the c45 ID information.
409 * If the PHY devices-in-package appears to be valid, it and the
410 * corresponding identifiers are stored in @c45_ids, zero is stored
411 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
415 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
416 struct phy_c45_device_ids *c45_ids) {
419 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
420 u32 *devs = &c45_ids->devices_in_package;
422 /* Find first non-zero Devices In package. Device zero is reserved
423 * for 802.3 c45 complied PHYs, so don't probe it at first.
425 for (i = 1; i < num_ids && *devs == 0; i++) {
426 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
430 if ((*devs & 0x1fffffff) == 0x1fffffff) {
431 /* If mostly Fs, there is no device there,
432 * then let's continue to probe more, as some
433 * 10G PHYs have zero Devices In package,
434 * e.g. Cortina CS4315/CS4340 PHY.
436 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
439 /* no device there, let's get out of here */
440 if ((*devs & 0x1fffffff) == 0x1fffffff) {
441 *phy_id = 0xffffffff;
449 /* Now probe Device Identifiers for each device present. */
450 for (i = 1; i < num_ids; i++) {
451 if (!(c45_ids->devices_in_package & (1 << i)))
454 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
455 phy_reg = mdiobus_read(bus, addr, reg_addr);
458 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
460 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
461 phy_reg = mdiobus_read(bus, addr, reg_addr);
464 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
471 * get_phy_id - reads the specified addr for its ID.
472 * @bus: the target MII bus
473 * @addr: PHY address on the MII bus
474 * @phy_id: where to store the ID retrieved.
475 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
476 * @c45_ids: where to store the c45 ID information.
478 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
479 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
482 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
483 * its return value is in turn returned.
486 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
487 bool is_c45, struct phy_c45_device_ids *c45_ids)
492 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
494 /* Grab the bits from PHYIR1, and put them in the upper half */
495 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
499 *phy_id = (phy_reg & 0xffff) << 16;
501 /* Grab the bits from PHYIR2, and put them in the lower half */
502 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
506 *phy_id |= (phy_reg & 0xffff);
512 * get_phy_device - reads the specified PHY device and returns its @phy_device
514 * @bus: the target MII bus
515 * @addr: PHY address on the MII bus
516 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
518 * Description: Reads the ID registers of the PHY at @addr on the
519 * @bus, then allocates and returns the phy_device to represent it.
521 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
523 struct phy_c45_device_ids c45_ids = {0};
527 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
531 /* If the phy_id is mostly Fs, there is no device there */
532 if ((phy_id & 0x1fffffff) == 0x1fffffff)
533 return ERR_PTR(-ENODEV);
535 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
537 EXPORT_SYMBOL(get_phy_device);
540 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
542 struct phy_device *phydev = to_phy_device(dev);
544 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
546 static DEVICE_ATTR_RO(phy_id);
549 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
551 struct phy_device *phydev = to_phy_device(dev);
552 const char *mode = NULL;
554 if (phy_is_internal(phydev))
557 mode = phy_modes(phydev->interface);
559 return sprintf(buf, "%s\n", mode);
561 static DEVICE_ATTR_RO(phy_interface);
564 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
567 struct phy_device *phydev = to_phy_device(dev);
569 return sprintf(buf, "%d\n", phydev->has_fixups);
571 static DEVICE_ATTR_RO(phy_has_fixups);
573 static struct attribute *phy_dev_attrs[] = {
574 &dev_attr_phy_id.attr,
575 &dev_attr_phy_interface.attr,
576 &dev_attr_phy_has_fixups.attr,
579 ATTRIBUTE_GROUPS(phy_dev);
582 * phy_device_register - Register the phy device on the MDIO bus
583 * @phydev: phy_device structure to be added to the MDIO bus
585 int phy_device_register(struct phy_device *phydev)
589 err = mdiobus_register_device(&phydev->mdio);
593 /* Run all of the fixups for this PHY */
594 err = phy_scan_fixups(phydev);
596 pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
600 phydev->mdio.dev.groups = phy_dev_groups;
602 err = device_add(&phydev->mdio.dev);
604 pr_err("PHY %d failed to add\n", phydev->mdio.addr);
611 mdiobus_unregister_device(&phydev->mdio);
614 EXPORT_SYMBOL(phy_device_register);
617 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
618 * @phydev: phy_device structure to remove
620 * This doesn't free the phy_device itself, it merely reverses the effects
621 * of phy_device_register(). Use phy_device_free() to free the device
622 * after calling this function.
624 void phy_device_remove(struct phy_device *phydev)
626 device_del(&phydev->mdio.dev);
627 mdiobus_unregister_device(&phydev->mdio);
629 EXPORT_SYMBOL(phy_device_remove);
632 * phy_find_first - finds the first PHY device on the bus
633 * @bus: the target MII bus
635 struct phy_device *phy_find_first(struct mii_bus *bus)
637 struct phy_device *phydev;
640 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
641 phydev = mdiobus_get_phy(bus, addr);
647 EXPORT_SYMBOL(phy_find_first);
650 * phy_prepare_link - prepares the PHY layer to monitor link status
651 * @phydev: target phy_device struct
652 * @handler: callback function for link status change notifications
654 * Description: Tells the PHY infrastructure to handle the
655 * gory details on monitoring link status (whether through
656 * polling or an interrupt), and to call back to the
657 * connected device driver when the link status changes.
658 * If you want to monitor your own link state, don't call
661 static void phy_prepare_link(struct phy_device *phydev,
662 void (*handler)(struct net_device *))
664 phydev->adjust_link = handler;
668 * phy_connect_direct - connect an ethernet device to a specific phy_device
669 * @dev: the network device to connect
670 * @phydev: the pointer to the phy device
671 * @handler: callback function for state change notifications
672 * @interface: PHY device's interface
674 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
675 void (*handler)(struct net_device *),
676 phy_interface_t interface)
680 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
684 phy_prepare_link(phydev, handler);
685 phy_start_machine(phydev);
687 phy_start_interrupts(phydev);
691 EXPORT_SYMBOL(phy_connect_direct);
694 * phy_connect - connect an ethernet device to a PHY device
695 * @dev: the network device to connect
696 * @bus_id: the id string of the PHY device to connect
697 * @handler: callback function for state change notifications
698 * @interface: PHY device's interface
700 * Description: Convenience function for connecting ethernet
701 * devices to PHY devices. The default behavior is for
702 * the PHY infrastructure to handle everything, and only notify
703 * the connected driver when the link status changes. If you
704 * don't want, or can't use the provided functionality, you may
705 * choose to call only the subset of functions which provide
706 * the desired functionality.
708 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
709 void (*handler)(struct net_device *),
710 phy_interface_t interface)
712 struct phy_device *phydev;
716 /* Search the list of PHY devices on the mdio bus for the
717 * PHY with the requested name
719 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
721 pr_err("PHY %s not found\n", bus_id);
722 return ERR_PTR(-ENODEV);
724 phydev = to_phy_device(d);
726 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 mii_bus *bus = phydev->mdio.bus;
861 struct device *d = &phydev->mdio.dev;
864 if (!try_module_get(bus->owner)) {
865 dev_err(&dev->dev, "failed to get the bus module\n");
871 /* Assume that if there is no driver, that it doesn't
872 * exist, and we should use the genphy driver.
877 &genphy_driver[GENPHY_DRV_10G].mdiodrv.driver;
880 &genphy_driver[GENPHY_DRV_1G].mdiodrv.driver;
882 err = d->driver->probe(d);
884 err = device_bind_driver(d);
890 if (phydev->attached_dev) {
891 dev_err(&dev->dev, "PHY already attached\n");
896 phydev->attached_dev = dev;
897 dev->phydev = phydev;
899 phydev->dev_flags = flags;
901 phydev->interface = interface;
903 phydev->state = PHY_READY;
905 /* Initial carrier state is off as the phy is about to be
908 netif_carrier_off(phydev->attached_dev);
910 /* Do initial configuration here, now that
911 * we have certain key parameters
912 * (dev_flags and interface)
914 err = phy_init_hw(phydev);
924 module_put(bus->owner);
927 EXPORT_SYMBOL(phy_attach_direct);
930 * phy_attach - attach a network device to a particular PHY device
931 * @dev: network device to attach
932 * @bus_id: Bus ID of PHY device to attach
933 * @interface: PHY device's interface
935 * Description: Same as phy_attach_direct() except that a PHY bus_id
936 * string is passed instead of a pointer to a struct phy_device.
938 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
939 phy_interface_t interface)
941 struct bus_type *bus = &mdio_bus_type;
942 struct phy_device *phydev;
946 /* Search the list of PHY devices on the mdio bus for the
947 * PHY with the requested name
949 d = bus_find_device_by_name(bus, NULL, bus_id);
951 pr_err("PHY %s not found\n", bus_id);
952 return ERR_PTR(-ENODEV);
954 phydev = to_phy_device(d);
956 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
962 EXPORT_SYMBOL(phy_attach);
965 * phy_detach - detach a PHY device from its network device
966 * @phydev: target phy_device struct
968 * This detaches the phy device from its network device and the phy
969 * driver, and drops the reference count taken in phy_attach_direct().
971 void phy_detach(struct phy_device *phydev)
976 phydev->attached_dev->phydev = NULL;
977 phydev->attached_dev = NULL;
980 /* If the device had no specific driver before (i.e. - it
981 * was using the generic driver), we unbind the device
982 * from the generic driver so that there's a chance a
983 * real driver could be loaded
985 for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
986 if (phydev->mdio.dev.driver ==
987 &genphy_driver[i].mdiodrv.driver) {
988 device_release_driver(&phydev->mdio.dev);
994 * The phydev might go away on the put_device() below, so avoid
995 * a use-after-free bug by reading the underlying bus first.
997 bus = phydev->mdio.bus;
999 put_device(&phydev->mdio.dev);
1000 module_put(bus->owner);
1002 EXPORT_SYMBOL(phy_detach);
1004 int phy_suspend(struct phy_device *phydev)
1006 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1007 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1010 /* If the device has WOL enabled, we cannot suspend the PHY */
1011 phy_ethtool_get_wol(phydev, &wol);
1015 if (phydrv->suspend)
1016 ret = phydrv->suspend(phydev);
1021 phydev->suspended = true;
1025 EXPORT_SYMBOL(phy_suspend);
1027 int phy_resume(struct phy_device *phydev)
1029 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1033 ret = phydrv->resume(phydev);
1038 phydev->suspended = false;
1042 EXPORT_SYMBOL(phy_resume);
1044 /* Generic PHY support and helper functions */
1047 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1048 * @phydev: target phy_device struct
1050 * Description: Writes MII_ADVERTISE with the appropriate values,
1051 * after sanitizing the values to make sure we only advertise
1052 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1053 * hasn't changed, and > 0 if it has changed.
1055 static int genphy_config_advert(struct phy_device *phydev)
1058 int oldadv, adv, bmsr;
1059 int err, changed = 0;
1061 /* Only allow advertising what this PHY supports */
1062 phydev->advertising &= phydev->supported;
1063 advertise = phydev->advertising;
1065 /* Setup standard advertisement */
1066 adv = phy_read(phydev, MII_ADVERTISE);
1071 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1072 ADVERTISE_PAUSE_ASYM);
1073 adv |= ethtool_adv_to_mii_adv_t(advertise);
1075 if (adv != oldadv) {
1076 err = phy_write(phydev, MII_ADVERTISE, adv);
1083 bmsr = phy_read(phydev, MII_BMSR);
1087 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1088 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1091 if (!(bmsr & BMSR_ESTATEN))
1094 /* Configure gigabit if it's supported */
1095 adv = phy_read(phydev, MII_CTRL1000);
1100 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1102 if (phydev->supported & (SUPPORTED_1000baseT_Half |
1103 SUPPORTED_1000baseT_Full)) {
1104 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1110 err = phy_write(phydev, MII_CTRL1000, adv);
1118 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1119 * @phydev: target phy_device struct
1121 * Description: Configures MII_BMCR to force speed/duplex
1122 * to the values in phydev. Assumes that the values are valid.
1123 * Please see phy_sanitize_settings().
1125 int genphy_setup_forced(struct phy_device *phydev)
1127 int ctl = phy_read(phydev, MII_BMCR);
1129 ctl &= BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN;
1131 phydev->asym_pause = 0;
1133 if (SPEED_1000 == phydev->speed)
1134 ctl |= BMCR_SPEED1000;
1135 else if (SPEED_100 == phydev->speed)
1136 ctl |= BMCR_SPEED100;
1138 if (DUPLEX_FULL == phydev->duplex)
1139 ctl |= BMCR_FULLDPLX;
1141 return phy_write(phydev, MII_BMCR, ctl);
1143 EXPORT_SYMBOL(genphy_setup_forced);
1146 * genphy_restart_aneg - Enable and Restart Autonegotiation
1147 * @phydev: target phy_device struct
1149 int genphy_restart_aneg(struct phy_device *phydev)
1151 int ctl = phy_read(phydev, MII_BMCR);
1156 ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
1158 /* Don't isolate the PHY if we're negotiating */
1159 ctl &= ~BMCR_ISOLATE;
1161 return phy_write(phydev, MII_BMCR, ctl);
1163 EXPORT_SYMBOL(genphy_restart_aneg);
1166 * genphy_config_aneg - restart auto-negotiation or write BMCR
1167 * @phydev: target phy_device struct
1169 * Description: If auto-negotiation is enabled, we configure the
1170 * advertising, and then restart auto-negotiation. If it is not
1171 * enabled, then we write the BMCR.
1173 int genphy_config_aneg(struct phy_device *phydev)
1177 if (AUTONEG_ENABLE != phydev->autoneg)
1178 return genphy_setup_forced(phydev);
1180 result = genphy_config_advert(phydev);
1181 if (result < 0) /* error */
1184 /* Advertisement hasn't changed, but maybe aneg was never on to
1185 * begin with? Or maybe phy was isolated?
1187 int ctl = phy_read(phydev, MII_BMCR);
1192 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1193 result = 1; /* do restart aneg */
1196 /* Only restart aneg if we are advertising something different
1197 * than we were before.
1200 result = genphy_restart_aneg(phydev);
1204 EXPORT_SYMBOL(genphy_config_aneg);
1207 * genphy_aneg_done - return auto-negotiation status
1208 * @phydev: target phy_device struct
1210 * Description: Reads the status register and returns 0 either if
1211 * auto-negotiation is incomplete, or if there was an error.
1212 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1214 int genphy_aneg_done(struct phy_device *phydev)
1216 int retval = phy_read(phydev, MII_BMSR);
1218 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1220 EXPORT_SYMBOL(genphy_aneg_done);
1222 static int gen10g_config_aneg(struct phy_device *phydev)
1228 * genphy_update_link - update link status in @phydev
1229 * @phydev: target phy_device struct
1231 * Description: Update the value in phydev->link to reflect the
1232 * current link value. In order to do this, we need to read
1233 * the status register twice, keeping the second value.
1235 int genphy_update_link(struct phy_device *phydev)
1239 /* Do a fake read */
1240 status = phy_read(phydev, MII_BMSR);
1244 /* Read link and autonegotiation status */
1245 status = phy_read(phydev, MII_BMSR);
1249 if ((status & BMSR_LSTATUS) == 0)
1256 EXPORT_SYMBOL(genphy_update_link);
1259 * genphy_read_status - check the link status and update current link state
1260 * @phydev: target phy_device struct
1262 * Description: Check the link, then figure out the current state
1263 * by comparing what we advertise with what the link partner
1264 * advertises. Start by checking the gigabit possibilities,
1265 * then move on to 10/100.
1267 int genphy_read_status(struct phy_device *phydev)
1274 int common_adv_gb = 0;
1276 /* Update the link, but return if there was an error */
1277 err = genphy_update_link(phydev);
1281 phydev->lp_advertising = 0;
1283 if (AUTONEG_ENABLE == phydev->autoneg) {
1284 if (phydev->supported & (SUPPORTED_1000baseT_Half
1285 | SUPPORTED_1000baseT_Full)) {
1286 lpagb = phy_read(phydev, MII_STAT1000);
1290 adv = phy_read(phydev, MII_CTRL1000);
1294 phydev->lp_advertising =
1295 mii_stat1000_to_ethtool_lpa_t(lpagb);
1296 common_adv_gb = lpagb & adv << 2;
1299 lpa = phy_read(phydev, MII_LPA);
1303 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1305 adv = phy_read(phydev, MII_ADVERTISE);
1309 common_adv = lpa & adv;
1311 phydev->speed = SPEED_10;
1312 phydev->duplex = DUPLEX_HALF;
1314 phydev->asym_pause = 0;
1316 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1317 phydev->speed = SPEED_1000;
1319 if (common_adv_gb & LPA_1000FULL)
1320 phydev->duplex = DUPLEX_FULL;
1321 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1322 phydev->speed = SPEED_100;
1324 if (common_adv & LPA_100FULL)
1325 phydev->duplex = DUPLEX_FULL;
1327 if (common_adv & LPA_10FULL)
1328 phydev->duplex = DUPLEX_FULL;
1330 if (phydev->duplex == DUPLEX_FULL) {
1331 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1332 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1335 int bmcr = phy_read(phydev, MII_BMCR);
1340 if (bmcr & BMCR_FULLDPLX)
1341 phydev->duplex = DUPLEX_FULL;
1343 phydev->duplex = DUPLEX_HALF;
1345 if (bmcr & BMCR_SPEED1000)
1346 phydev->speed = SPEED_1000;
1347 else if (bmcr & BMCR_SPEED100)
1348 phydev->speed = SPEED_100;
1350 phydev->speed = SPEED_10;
1353 phydev->asym_pause = 0;
1358 EXPORT_SYMBOL(genphy_read_status);
1360 static int gen10g_read_status(struct phy_device *phydev)
1363 u32 mmd_mask = phydev->c45_ids.devices_in_package;
1367 /* For now just lie and say it's 10G all the time */
1368 phydev->speed = SPEED_10000;
1369 phydev->duplex = DUPLEX_FULL;
1371 for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1372 if (!(mmd_mask & 1))
1375 /* Read twice because link state is latched and a
1376 * read moves the current state into the register
1378 phy_read_mmd(phydev, devad, MDIO_STAT1);
1379 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1380 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1388 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1389 * @phydev: target phy_device struct
1391 * Description: Perform a software PHY reset using the standard
1392 * BMCR_RESET bit and poll for the reset bit to be cleared.
1394 * Returns: 0 on success, < 0 on failure
1396 int genphy_soft_reset(struct phy_device *phydev)
1400 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1404 return phy_poll_reset(phydev);
1406 EXPORT_SYMBOL(genphy_soft_reset);
1408 int genphy_config_init(struct phy_device *phydev)
1413 features = (SUPPORTED_TP | SUPPORTED_MII
1414 | SUPPORTED_AUI | SUPPORTED_FIBRE |
1415 SUPPORTED_BNC | SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1417 /* Do we support autonegotiation? */
1418 val = phy_read(phydev, MII_BMSR);
1422 if (val & BMSR_ANEGCAPABLE)
1423 features |= SUPPORTED_Autoneg;
1425 if (val & BMSR_100FULL)
1426 features |= SUPPORTED_100baseT_Full;
1427 if (val & BMSR_100HALF)
1428 features |= SUPPORTED_100baseT_Half;
1429 if (val & BMSR_10FULL)
1430 features |= SUPPORTED_10baseT_Full;
1431 if (val & BMSR_10HALF)
1432 features |= SUPPORTED_10baseT_Half;
1434 if (val & BMSR_ESTATEN) {
1435 val = phy_read(phydev, MII_ESTATUS);
1439 if (val & ESTATUS_1000_TFULL)
1440 features |= SUPPORTED_1000baseT_Full;
1441 if (val & ESTATUS_1000_THALF)
1442 features |= SUPPORTED_1000baseT_Half;
1445 phydev->supported &= features;
1446 phydev->advertising &= features;
1451 static int gen10g_soft_reset(struct phy_device *phydev)
1453 /* Do nothing for now */
1456 EXPORT_SYMBOL(genphy_config_init);
1458 static int gen10g_config_init(struct phy_device *phydev)
1460 /* Temporarily just say we support everything */
1461 phydev->supported = SUPPORTED_10000baseT_Full;
1462 phydev->advertising = SUPPORTED_10000baseT_Full;
1467 int genphy_suspend(struct phy_device *phydev)
1471 mutex_lock(&phydev->lock);
1473 value = phy_read(phydev, MII_BMCR);
1474 phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1476 mutex_unlock(&phydev->lock);
1480 EXPORT_SYMBOL(genphy_suspend);
1482 static int gen10g_suspend(struct phy_device *phydev)
1487 int genphy_resume(struct phy_device *phydev)
1491 mutex_lock(&phydev->lock);
1493 value = phy_read(phydev, MII_BMCR);
1494 phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1496 mutex_unlock(&phydev->lock);
1500 EXPORT_SYMBOL(genphy_resume);
1502 static int gen10g_resume(struct phy_device *phydev)
1507 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1509 /* The default values for phydev->supported are provided by the PHY
1510 * driver "features" member, we want to reset to sane defaults first
1511 * before supporting higher speeds.
1513 phydev->supported &= PHY_DEFAULT_FEATURES;
1515 switch (max_speed) {
1519 phydev->supported |= PHY_1000BT_FEATURES;
1522 phydev->supported |= PHY_100BT_FEATURES;
1525 phydev->supported |= PHY_10BT_FEATURES;
1531 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1535 err = __set_phy_supported(phydev, max_speed);
1539 phydev->advertising = phydev->supported;
1543 EXPORT_SYMBOL(phy_set_max_speed);
1545 static void of_set_phy_supported(struct phy_device *phydev)
1547 struct device_node *node = phydev->mdio.dev.of_node;
1550 if (!IS_ENABLED(CONFIG_OF_MDIO))
1556 if (!of_property_read_u32(node, "max-speed", &max_speed))
1557 __set_phy_supported(phydev, max_speed);
1561 * phy_probe - probe and init a PHY device
1562 * @dev: device to probe and init
1564 * Description: Take care of setting up the phy_device structure,
1565 * set the state to READY (the driver's init function should
1566 * set it to STARTING if needed).
1568 static int phy_probe(struct device *dev)
1570 struct phy_device *phydev = to_phy_device(dev);
1571 struct device_driver *drv = phydev->mdio.dev.driver;
1572 struct phy_driver *phydrv = to_phy_driver(drv);
1574 struct gpio_descs *reset_gpios;
1576 phydev->drv = phydrv;
1578 /* take phy out of reset */
1579 reset_gpios = devm_gpiod_get_array_optional(dev, "reset",
1581 if (IS_ERR(reset_gpios))
1582 return PTR_ERR(reset_gpios);
1584 /* Disable the interrupt if the PHY doesn't support it
1585 * but the interrupt is still a valid one
1587 if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1588 phy_interrupt_is_valid(phydev))
1589 phydev->irq = PHY_POLL;
1591 if (phydrv->flags & PHY_IS_INTERNAL)
1592 phydev->is_internal = true;
1594 mutex_lock(&phydev->lock);
1596 /* Start out supporting everything. Eventually,
1597 * a controller will attach, and may modify one
1598 * or both of these values
1600 phydev->supported = phydrv->features;
1601 of_set_phy_supported(phydev);
1602 phydev->advertising = phydev->supported;
1604 /* Set the state to READY by default */
1605 phydev->state = PHY_READY;
1607 if (phydev->drv->probe)
1608 err = phydev->drv->probe(phydev);
1610 mutex_unlock(&phydev->lock);
1615 static int phy_remove(struct device *dev)
1617 struct phy_device *phydev = to_phy_device(dev);
1619 mutex_lock(&phydev->lock);
1620 phydev->state = PHY_DOWN;
1621 mutex_unlock(&phydev->lock);
1623 if (phydev->drv->remove)
1624 phydev->drv->remove(phydev);
1631 * phy_driver_register - register a phy_driver with the PHY layer
1632 * @new_driver: new phy_driver to register
1633 * @owner: module owning this PHY
1635 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
1639 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
1640 new_driver->mdiodrv.driver.name = new_driver->name;
1641 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
1642 new_driver->mdiodrv.driver.probe = phy_probe;
1643 new_driver->mdiodrv.driver.remove = phy_remove;
1644 new_driver->mdiodrv.driver.owner = owner;
1646 retval = driver_register(&new_driver->mdiodrv.driver);
1648 pr_err("%s: Error %d in registering driver\n",
1649 new_driver->name, retval);
1654 pr_debug("%s: Registered new driver\n", new_driver->name);
1658 EXPORT_SYMBOL(phy_driver_register);
1660 int phy_drivers_register(struct phy_driver *new_driver, int n,
1661 struct module *owner)
1665 for (i = 0; i < n; i++) {
1666 ret = phy_driver_register(new_driver + i, owner);
1669 phy_driver_unregister(new_driver + i);
1675 EXPORT_SYMBOL(phy_drivers_register);
1677 void phy_driver_unregister(struct phy_driver *drv)
1679 driver_unregister(&drv->mdiodrv.driver);
1681 EXPORT_SYMBOL(phy_driver_unregister);
1683 void phy_drivers_unregister(struct phy_driver *drv, int n)
1687 for (i = 0; i < n; i++)
1688 phy_driver_unregister(drv + i);
1690 EXPORT_SYMBOL(phy_drivers_unregister);
1692 static struct phy_driver genphy_driver[] = {
1694 .phy_id = 0xffffffff,
1695 .phy_id_mask = 0xffffffff,
1696 .name = "Generic PHY",
1697 .soft_reset = genphy_soft_reset,
1698 .config_init = genphy_config_init,
1699 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
1700 SUPPORTED_AUI | SUPPORTED_FIBRE |
1702 .config_aneg = genphy_config_aneg,
1703 .aneg_done = genphy_aneg_done,
1704 .read_status = genphy_read_status,
1705 .suspend = genphy_suspend,
1706 .resume = genphy_resume,
1708 .phy_id = 0xffffffff,
1709 .phy_id_mask = 0xffffffff,
1710 .name = "Generic 10G PHY",
1711 .soft_reset = gen10g_soft_reset,
1712 .config_init = gen10g_config_init,
1714 .config_aneg = gen10g_config_aneg,
1715 .read_status = gen10g_read_status,
1716 .suspend = gen10g_suspend,
1717 .resume = gen10g_resume,
1720 static int __init phy_init(void)
1724 rc = mdio_bus_init();
1728 rc = phy_drivers_register(genphy_driver,
1729 ARRAY_SIZE(genphy_driver), THIS_MODULE);
1736 static void __exit phy_exit(void)
1738 phy_drivers_unregister(genphy_driver,
1739 ARRAY_SIZE(genphy_driver));
1743 subsys_initcall(phy_init);
1744 module_exit(phy_exit);