1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for finding and configuring PHYs.
3 * Also contains generic PHY driver
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/acpi.h>
13 #include <linux/bitmap.h>
14 #include <linux/delay.h>
15 #include <linux/errno.h>
16 #include <linux/etherdevice.h>
17 #include <linux/ethtool.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <linux/mdio.h>
23 #include <linux/mii.h>
25 #include <linux/module.h>
26 #include <linux/netdevice.h>
27 #include <linux/phy.h>
28 #include <linux/phy_led_triggers.h>
29 #include <linux/property.h>
30 #include <linux/sfp.h>
31 #include <linux/skbuff.h>
32 #include <linux/slab.h>
33 #include <linux/string.h>
34 #include <linux/uaccess.h>
35 #include <linux/unistd.h>
37 MODULE_DESCRIPTION("PHY library");
38 MODULE_AUTHOR("Andy Fleming");
39 MODULE_LICENSE("GPL");
41 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
42 EXPORT_SYMBOL_GPL(phy_basic_features);
44 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
45 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
47 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
48 EXPORT_SYMBOL_GPL(phy_gbit_features);
50 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
51 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
53 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
54 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
56 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
57 EXPORT_SYMBOL_GPL(phy_10gbit_features);
59 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
60 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
62 const int phy_basic_ports_array[3] = {
63 ETHTOOL_LINK_MODE_Autoneg_BIT,
64 ETHTOOL_LINK_MODE_TP_BIT,
65 ETHTOOL_LINK_MODE_MII_BIT,
67 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
69 const int phy_fibre_port_array[1] = {
70 ETHTOOL_LINK_MODE_FIBRE_BIT,
72 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
74 const int phy_all_ports_features_array[7] = {
75 ETHTOOL_LINK_MODE_Autoneg_BIT,
76 ETHTOOL_LINK_MODE_TP_BIT,
77 ETHTOOL_LINK_MODE_MII_BIT,
78 ETHTOOL_LINK_MODE_FIBRE_BIT,
79 ETHTOOL_LINK_MODE_AUI_BIT,
80 ETHTOOL_LINK_MODE_BNC_BIT,
81 ETHTOOL_LINK_MODE_Backplane_BIT,
83 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
85 const int phy_10_100_features_array[4] = {
86 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
87 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
88 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
89 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
91 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
93 const int phy_basic_t1_features_array[2] = {
94 ETHTOOL_LINK_MODE_TP_BIT,
95 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
97 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
99 const int phy_gbit_features_array[2] = {
100 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
101 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
103 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
105 const int phy_10gbit_features_array[1] = {
106 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
108 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
110 static const int phy_10gbit_fec_features_array[1] = {
111 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
114 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
115 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
117 static const int phy_10gbit_full_features_array[] = {
118 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
120 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
121 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
124 static void features_init(void)
126 /* 10/100 half/full*/
127 linkmode_set_bit_array(phy_basic_ports_array,
128 ARRAY_SIZE(phy_basic_ports_array),
130 linkmode_set_bit_array(phy_10_100_features_array,
131 ARRAY_SIZE(phy_10_100_features_array),
135 linkmode_set_bit_array(phy_basic_t1_features_array,
136 ARRAY_SIZE(phy_basic_t1_features_array),
137 phy_basic_t1_features);
139 /* 10/100 half/full + 1000 half/full */
140 linkmode_set_bit_array(phy_basic_ports_array,
141 ARRAY_SIZE(phy_basic_ports_array),
143 linkmode_set_bit_array(phy_10_100_features_array,
144 ARRAY_SIZE(phy_10_100_features_array),
146 linkmode_set_bit_array(phy_gbit_features_array,
147 ARRAY_SIZE(phy_gbit_features_array),
150 /* 10/100 half/full + 1000 half/full + fibre*/
151 linkmode_set_bit_array(phy_basic_ports_array,
152 ARRAY_SIZE(phy_basic_ports_array),
153 phy_gbit_fibre_features);
154 linkmode_set_bit_array(phy_10_100_features_array,
155 ARRAY_SIZE(phy_10_100_features_array),
156 phy_gbit_fibre_features);
157 linkmode_set_bit_array(phy_gbit_features_array,
158 ARRAY_SIZE(phy_gbit_features_array),
159 phy_gbit_fibre_features);
160 linkmode_set_bit_array(phy_fibre_port_array,
161 ARRAY_SIZE(phy_fibre_port_array),
162 phy_gbit_fibre_features);
164 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
165 linkmode_set_bit_array(phy_all_ports_features_array,
166 ARRAY_SIZE(phy_all_ports_features_array),
167 phy_gbit_all_ports_features);
168 linkmode_set_bit_array(phy_10_100_features_array,
169 ARRAY_SIZE(phy_10_100_features_array),
170 phy_gbit_all_ports_features);
171 linkmode_set_bit_array(phy_gbit_features_array,
172 ARRAY_SIZE(phy_gbit_features_array),
173 phy_gbit_all_ports_features);
175 /* 10/100 half/full + 1000 half/full + 10G full*/
176 linkmode_set_bit_array(phy_all_ports_features_array,
177 ARRAY_SIZE(phy_all_ports_features_array),
178 phy_10gbit_features);
179 linkmode_set_bit_array(phy_10_100_features_array,
180 ARRAY_SIZE(phy_10_100_features_array),
181 phy_10gbit_features);
182 linkmode_set_bit_array(phy_gbit_features_array,
183 ARRAY_SIZE(phy_gbit_features_array),
184 phy_10gbit_features);
185 linkmode_set_bit_array(phy_10gbit_features_array,
186 ARRAY_SIZE(phy_10gbit_features_array),
187 phy_10gbit_features);
189 /* 10/100/1000/10G full */
190 linkmode_set_bit_array(phy_all_ports_features_array,
191 ARRAY_SIZE(phy_all_ports_features_array),
192 phy_10gbit_full_features);
193 linkmode_set_bit_array(phy_10gbit_full_features_array,
194 ARRAY_SIZE(phy_10gbit_full_features_array),
195 phy_10gbit_full_features);
197 linkmode_set_bit_array(phy_10gbit_fec_features_array,
198 ARRAY_SIZE(phy_10gbit_fec_features_array),
199 phy_10gbit_fec_features);
202 void phy_device_free(struct phy_device *phydev)
204 put_device(&phydev->mdio.dev);
206 EXPORT_SYMBOL(phy_device_free);
208 static void phy_mdio_device_free(struct mdio_device *mdiodev)
210 struct phy_device *phydev;
212 phydev = container_of(mdiodev, struct phy_device, mdio);
213 phy_device_free(phydev);
216 static void phy_device_release(struct device *dev)
218 kfree(to_phy_device(dev));
221 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
223 struct phy_device *phydev;
225 phydev = container_of(mdiodev, struct phy_device, mdio);
226 phy_device_remove(phydev);
229 static struct phy_driver genphy_driver;
231 static LIST_HEAD(phy_fixup_list);
232 static DEFINE_MUTEX(phy_fixup_lock);
234 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
236 struct device_driver *drv = phydev->mdio.dev.driver;
237 struct phy_driver *phydrv = to_phy_driver(drv);
238 struct net_device *netdev = phydev->attached_dev;
240 if (!drv || !phydrv->suspend)
243 /* PHY not attached? May suspend if the PHY has not already been
244 * suspended as part of a prior call to phy_disconnect() ->
245 * phy_detach() -> phy_suspend() because the parent netdev might be the
246 * MDIO bus driver and clock gated at this point.
251 if (netdev->wol_enabled)
254 /* As long as not all affected network drivers support the
255 * wol_enabled flag, let's check for hints that WoL is enabled.
256 * Don't suspend PHY if the attached netdev parent may wake up.
257 * The parent may point to a PCI device, as in tg3 driver.
259 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
262 /* Also don't suspend PHY if the netdev itself may wakeup. This
263 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
266 if (device_may_wakeup(&netdev->dev))
270 return !phydev->suspended;
273 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
275 struct phy_device *phydev = to_phy_device(dev);
277 if (phydev->mac_managed_pm)
280 /* We must stop the state machine manually, otherwise it stops out of
281 * control, possibly with the phydev->lock held. Upon resume, netdev
282 * may call phy routines that try to grab the same lock, and that may
283 * lead to a deadlock.
285 if (phydev->attached_dev && phydev->adjust_link)
286 phy_stop_machine(phydev);
288 if (!mdio_bus_phy_may_suspend(phydev))
291 phydev->suspended_by_mdio_bus = 1;
293 return phy_suspend(phydev);
296 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
298 struct phy_device *phydev = to_phy_device(dev);
301 if (phydev->mac_managed_pm)
304 if (!phydev->suspended_by_mdio_bus)
307 phydev->suspended_by_mdio_bus = 0;
309 ret = phy_init_hw(phydev);
313 ret = phy_resume(phydev);
317 if (phydev->attached_dev && phydev->adjust_link)
318 phy_start_machine(phydev);
323 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
324 mdio_bus_phy_resume);
327 * phy_register_fixup - creates a new phy_fixup and adds it to the list
328 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
329 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
330 * It can also be PHY_ANY_UID
331 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
333 * @run: The actual code to be run when a matching PHY is found
335 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
336 int (*run)(struct phy_device *))
338 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
343 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
344 fixup->phy_uid = phy_uid;
345 fixup->phy_uid_mask = phy_uid_mask;
348 mutex_lock(&phy_fixup_lock);
349 list_add_tail(&fixup->list, &phy_fixup_list);
350 mutex_unlock(&phy_fixup_lock);
354 EXPORT_SYMBOL(phy_register_fixup);
356 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
357 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
358 int (*run)(struct phy_device *))
360 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
362 EXPORT_SYMBOL(phy_register_fixup_for_uid);
364 /* Registers a fixup to be run on the PHY with id string bus_id */
365 int phy_register_fixup_for_id(const char *bus_id,
366 int (*run)(struct phy_device *))
368 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
370 EXPORT_SYMBOL(phy_register_fixup_for_id);
373 * phy_unregister_fixup - remove a phy_fixup from the list
374 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
375 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
376 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
378 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
380 struct list_head *pos, *n;
381 struct phy_fixup *fixup;
386 mutex_lock(&phy_fixup_lock);
387 list_for_each_safe(pos, n, &phy_fixup_list) {
388 fixup = list_entry(pos, struct phy_fixup, list);
390 if ((!strcmp(fixup->bus_id, bus_id)) &&
391 ((fixup->phy_uid & phy_uid_mask) ==
392 (phy_uid & phy_uid_mask))) {
393 list_del(&fixup->list);
399 mutex_unlock(&phy_fixup_lock);
403 EXPORT_SYMBOL(phy_unregister_fixup);
405 /* Unregisters a fixup of any PHY with the UID in phy_uid */
406 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
408 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
410 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
412 /* Unregisters a fixup of the PHY with id string bus_id */
413 int phy_unregister_fixup_for_id(const char *bus_id)
415 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
417 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
419 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
420 * Fixups can be set to match any in one or more fields.
422 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
424 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
425 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
428 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
429 (phydev->phy_id & fixup->phy_uid_mask))
430 if (fixup->phy_uid != PHY_ANY_UID)
436 /* Runs any matching fixups for this phydev */
437 static int phy_scan_fixups(struct phy_device *phydev)
439 struct phy_fixup *fixup;
441 mutex_lock(&phy_fixup_lock);
442 list_for_each_entry(fixup, &phy_fixup_list, list) {
443 if (phy_needs_fixup(phydev, fixup)) {
444 int err = fixup->run(phydev);
447 mutex_unlock(&phy_fixup_lock);
450 phydev->has_fixups = true;
453 mutex_unlock(&phy_fixup_lock);
458 static int phy_bus_match(struct device *dev, struct device_driver *drv)
460 struct phy_device *phydev = to_phy_device(dev);
461 struct phy_driver *phydrv = to_phy_driver(drv);
462 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
465 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
468 if (phydrv->match_phy_device)
469 return phydrv->match_phy_device(phydev);
471 if (phydev->is_c45) {
472 for (i = 1; i < num_ids; i++) {
473 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
476 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
477 (phydev->c45_ids.device_ids[i] &
478 phydrv->phy_id_mask))
483 return (phydrv->phy_id & phydrv->phy_id_mask) ==
484 (phydev->phy_id & phydrv->phy_id_mask);
489 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
491 struct phy_device *phydev = to_phy_device(dev);
493 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
495 static DEVICE_ATTR_RO(phy_id);
498 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
500 struct phy_device *phydev = to_phy_device(dev);
501 const char *mode = NULL;
503 if (phy_is_internal(phydev))
506 mode = phy_modes(phydev->interface);
508 return sprintf(buf, "%s\n", mode);
510 static DEVICE_ATTR_RO(phy_interface);
513 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
516 struct phy_device *phydev = to_phy_device(dev);
518 return sprintf(buf, "%d\n", phydev->has_fixups);
520 static DEVICE_ATTR_RO(phy_has_fixups);
522 static ssize_t phy_dev_flags_show(struct device *dev,
523 struct device_attribute *attr,
526 struct phy_device *phydev = to_phy_device(dev);
528 return sprintf(buf, "0x%08x\n", phydev->dev_flags);
530 static DEVICE_ATTR_RO(phy_dev_flags);
532 static struct attribute *phy_dev_attrs[] = {
533 &dev_attr_phy_id.attr,
534 &dev_attr_phy_interface.attr,
535 &dev_attr_phy_has_fixups.attr,
536 &dev_attr_phy_dev_flags.attr,
539 ATTRIBUTE_GROUPS(phy_dev);
541 static const struct device_type mdio_bus_phy_type = {
543 .groups = phy_dev_groups,
544 .release = phy_device_release,
545 .pm = pm_ptr(&mdio_bus_phy_pm_ops),
548 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
552 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
553 MDIO_ID_ARGS(phy_id));
554 /* We only check for failures in executing the usermode binary,
555 * not whether a PHY driver module exists for the PHY ID.
556 * Accept -ENOENT because this may occur in case no initramfs exists,
557 * then modprobe isn't available.
559 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
560 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
561 ret, (unsigned long)phy_id);
568 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
570 struct phy_c45_device_ids *c45_ids)
572 struct phy_device *dev;
573 struct mdio_device *mdiodev;
576 /* We allocate the device, and initialize the default values */
577 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
579 return ERR_PTR(-ENOMEM);
581 mdiodev = &dev->mdio;
582 mdiodev->dev.parent = &bus->dev;
583 mdiodev->dev.bus = &mdio_bus_type;
584 mdiodev->dev.type = &mdio_bus_phy_type;
586 mdiodev->bus_match = phy_bus_match;
587 mdiodev->addr = addr;
588 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
589 mdiodev->device_free = phy_mdio_device_free;
590 mdiodev->device_remove = phy_mdio_device_remove;
592 dev->speed = SPEED_UNKNOWN;
593 dev->duplex = DUPLEX_UNKNOWN;
598 dev->interface = PHY_INTERFACE_MODE_GMII;
600 dev->autoneg = AUTONEG_ENABLE;
602 dev->is_c45 = is_c45;
603 dev->phy_id = phy_id;
605 dev->c45_ids = *c45_ids;
606 dev->irq = bus->irq[addr];
608 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
609 device_initialize(&mdiodev->dev);
611 dev->state = PHY_DOWN;
613 mutex_init(&dev->lock);
614 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
616 /* Request the appropriate module unconditionally; don't
617 * bother trying to do so only if it isn't already loaded,
618 * because that gets complicated. A hotplug event would have
619 * done an unconditional modprobe anyway.
620 * We don't do normal hotplug because it won't work for MDIO
621 * -- because it relies on the device staying around for long
622 * enough for the driver to get loaded. With MDIO, the NIC
623 * driver will get bored and give up as soon as it finds that
624 * there's no driver _already_ loaded.
626 if (is_c45 && c45_ids) {
627 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
630 for (i = 1; i < num_ids; i++) {
631 if (c45_ids->device_ids[i] == 0xffffffff)
634 ret = phy_request_driver_module(dev,
635 c45_ids->device_ids[i]);
640 ret = phy_request_driver_module(dev, phy_id);
644 put_device(&mdiodev->dev);
650 EXPORT_SYMBOL(phy_device_create);
652 /* phy_c45_probe_present - checks to see if a MMD is present in the package
653 * @bus: the target MII bus
654 * @prtad: PHY package address on the MII bus
655 * @devad: PHY device (MMD) address
657 * Read the MDIO_STAT2 register, and check whether a device is responding
660 * Returns: negative error number on bus access error, zero if no device
661 * is responding, or positive if a device is present.
663 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
667 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
671 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
674 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
675 * @bus: the target MII bus
676 * @addr: PHY address on the MII bus
677 * @dev_addr: MMD address in the PHY.
678 * @devices_in_package: where to store the devices in package information.
680 * Description: reads devices in package registers of a MMD at @dev_addr
681 * from PHY at @addr on @bus.
683 * Returns: 0 on success, -EIO on failure.
685 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
686 u32 *devices_in_package)
690 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
693 *devices_in_package = phy_reg << 16;
695 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
698 *devices_in_package |= phy_reg;
704 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
705 * @bus: the target MII bus
706 * @addr: PHY address on the MII bus
707 * @c45_ids: where to store the c45 ID information.
709 * Read the PHY "devices in package". If this appears to be valid, read
710 * the PHY identifiers for each device. Return the "devices in package"
711 * and identifiers in @c45_ids.
713 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
714 * the "devices in package" is invalid.
716 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
717 struct phy_c45_device_ids *c45_ids)
719 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
723 /* Find first non-zero Devices In package. Device zero is reserved
724 * for 802.3 c45 complied PHYs, so don't probe it at first.
726 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
727 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
728 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
729 /* Check that there is a device present at this
730 * address before reading the devices-in-package
731 * register to avoid reading garbage from the PHY.
732 * Some PHYs (88x3310) vendor space is not IEEE802.3
735 ret = phy_c45_probe_present(bus, addr, i);
742 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
747 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
748 /* If mostly Fs, there is no device there, then let's probe
749 * MMD 0, as some 10G PHYs have zero Devices In package,
750 * e.g. Cortina CS4315/CS4340 PHY.
752 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
756 /* no device there, let's get out of here */
757 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
761 /* Now probe Device Identifiers for each device present. */
762 for (i = 1; i < num_ids; i++) {
763 if (!(devs_in_pkg & (1 << i)))
766 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
767 /* Probe the "Device Present" bits for the vendor MMDs
768 * to ignore these if they do not contain IEEE 802.3
771 ret = phy_c45_probe_present(bus, addr, i);
779 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
782 c45_ids->device_ids[i] = phy_reg << 16;
784 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
787 c45_ids->device_ids[i] |= phy_reg;
790 c45_ids->devices_in_package = devs_in_pkg;
791 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
792 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
798 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
799 * @bus: the target MII bus
800 * @addr: PHY address on the MII bus
801 * @phy_id: where to store the ID retrieved.
803 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
804 * placing it in @phy_id. Return zero on successful read and the ID is
805 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
808 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
812 /* Grab the bits from PHYIR1, and put them in the upper half */
813 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
815 /* returning -ENODEV doesn't stop bus scanning */
816 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
819 *phy_id = phy_reg << 16;
821 /* Grab the bits from PHYIR2, and put them in the lower half */
822 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
824 /* returning -ENODEV doesn't stop bus scanning */
825 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
830 /* If the phy_id is mostly Fs, there is no device there */
831 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
837 /* Extract the phy ID from the compatible string of the form
838 * ethernet-phy-idAAAA.BBBB.
840 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
842 unsigned int upper, lower;
846 ret = fwnode_property_read_string(fwnode, "compatible", &cp);
850 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) != 2)
853 *phy_id = ((upper & GENMASK(15, 0)) << 16) | (lower & GENMASK(15, 0));
856 EXPORT_SYMBOL(fwnode_get_phy_id);
859 * get_phy_device - reads the specified PHY device and returns its @phy_device
861 * @bus: the target MII bus
862 * @addr: PHY address on the MII bus
863 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
865 * Probe for a PHY at @addr on @bus.
867 * When probing for a clause 22 PHY, then read the ID registers. If we find
868 * a valid ID, allocate and return a &struct phy_device.
870 * When probing for a clause 45 PHY, read the "devices in package" registers.
871 * If the "devices in package" appears valid, read the ID registers for each
872 * MMD, allocate and return a &struct phy_device.
874 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
875 * no PHY present, or %-EIO on bus access error.
877 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
879 struct phy_c45_device_ids c45_ids;
883 c45_ids.devices_in_package = 0;
884 c45_ids.mmds_present = 0;
885 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
888 r = get_phy_c45_ids(bus, addr, &c45_ids);
890 r = get_phy_c22_id(bus, addr, &phy_id);
895 /* PHY device such as the Marvell Alaska 88E2110 will return a PHY ID
896 * of 0 when probed using get_phy_c22_id() with no error. Proceed to
897 * probe with C45 to see if we're able to get a valid PHY ID in the C45
898 * space, if successful, create the C45 PHY device.
900 if (!is_c45 && phy_id == 0 && bus->probe_capabilities >= MDIOBUS_C45) {
901 r = get_phy_c45_ids(bus, addr, &c45_ids);
903 return phy_device_create(bus, addr, phy_id,
907 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
909 EXPORT_SYMBOL(get_phy_device);
912 * phy_device_register - Register the phy device on the MDIO bus
913 * @phydev: phy_device structure to be added to the MDIO bus
915 int phy_device_register(struct phy_device *phydev)
919 err = mdiobus_register_device(&phydev->mdio);
923 /* Deassert the reset signal */
924 phy_device_reset(phydev, 0);
926 /* Run all of the fixups for this PHY */
927 err = phy_scan_fixups(phydev);
929 phydev_err(phydev, "failed to initialize\n");
933 err = device_add(&phydev->mdio.dev);
935 phydev_err(phydev, "failed to add\n");
942 /* Assert the reset signal */
943 phy_device_reset(phydev, 1);
945 mdiobus_unregister_device(&phydev->mdio);
948 EXPORT_SYMBOL(phy_device_register);
951 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
952 * @phydev: phy_device structure to remove
954 * This doesn't free the phy_device itself, it merely reverses the effects
955 * of phy_device_register(). Use phy_device_free() to free the device
956 * after calling this function.
958 void phy_device_remove(struct phy_device *phydev)
960 unregister_mii_timestamper(phydev->mii_ts);
962 device_del(&phydev->mdio.dev);
964 /* Assert the reset signal */
965 phy_device_reset(phydev, 1);
967 mdiobus_unregister_device(&phydev->mdio);
969 EXPORT_SYMBOL(phy_device_remove);
972 * phy_get_c45_ids - Read 802.3-c45 IDs for phy device.
973 * @phydev: phy_device structure to read 802.3-c45 IDs
975 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
976 * the "devices in package" is invalid.
978 int phy_get_c45_ids(struct phy_device *phydev)
980 return get_phy_c45_ids(phydev->mdio.bus, phydev->mdio.addr,
983 EXPORT_SYMBOL(phy_get_c45_ids);
986 * phy_find_first - finds the first PHY device on the bus
987 * @bus: the target MII bus
989 struct phy_device *phy_find_first(struct mii_bus *bus)
991 struct phy_device *phydev;
994 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
995 phydev = mdiobus_get_phy(bus, addr);
1001 EXPORT_SYMBOL(phy_find_first);
1003 static void phy_link_change(struct phy_device *phydev, bool up)
1005 struct net_device *netdev = phydev->attached_dev;
1008 netif_carrier_on(netdev);
1010 netif_carrier_off(netdev);
1011 phydev->adjust_link(netdev);
1012 if (phydev->mii_ts && phydev->mii_ts->link_state)
1013 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
1017 * phy_prepare_link - prepares the PHY layer to monitor link status
1018 * @phydev: target phy_device struct
1019 * @handler: callback function for link status change notifications
1021 * Description: Tells the PHY infrastructure to handle the
1022 * gory details on monitoring link status (whether through
1023 * polling or an interrupt), and to call back to the
1024 * connected device driver when the link status changes.
1025 * If you want to monitor your own link state, don't call
1028 static void phy_prepare_link(struct phy_device *phydev,
1029 void (*handler)(struct net_device *))
1031 phydev->adjust_link = handler;
1035 * phy_connect_direct - connect an ethernet device to a specific phy_device
1036 * @dev: the network device to connect
1037 * @phydev: the pointer to the phy device
1038 * @handler: callback function for state change notifications
1039 * @interface: PHY device's interface
1041 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1042 void (*handler)(struct net_device *),
1043 phy_interface_t interface)
1050 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1054 phy_prepare_link(phydev, handler);
1055 if (phy_interrupt_is_valid(phydev))
1056 phy_request_interrupt(phydev);
1060 EXPORT_SYMBOL(phy_connect_direct);
1063 * phy_connect - connect an ethernet device to a PHY device
1064 * @dev: the network device to connect
1065 * @bus_id: the id string of the PHY device to connect
1066 * @handler: callback function for state change notifications
1067 * @interface: PHY device's interface
1069 * Description: Convenience function for connecting ethernet
1070 * devices to PHY devices. The default behavior is for
1071 * the PHY infrastructure to handle everything, and only notify
1072 * the connected driver when the link status changes. If you
1073 * don't want, or can't use the provided functionality, you may
1074 * choose to call only the subset of functions which provide
1075 * the desired functionality.
1077 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1078 void (*handler)(struct net_device *),
1079 phy_interface_t interface)
1081 struct phy_device *phydev;
1085 /* Search the list of PHY devices on the mdio bus for the
1086 * PHY with the requested name
1088 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1090 pr_err("PHY %s not found\n", bus_id);
1091 return ERR_PTR(-ENODEV);
1093 phydev = to_phy_device(d);
1095 rc = phy_connect_direct(dev, phydev, handler, interface);
1102 EXPORT_SYMBOL(phy_connect);
1105 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1107 * @phydev: target phy_device struct
1109 void phy_disconnect(struct phy_device *phydev)
1111 if (phy_is_started(phydev))
1114 if (phy_interrupt_is_valid(phydev))
1115 phy_free_interrupt(phydev);
1117 phydev->adjust_link = NULL;
1121 EXPORT_SYMBOL(phy_disconnect);
1124 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1125 * @phydev: The PHY device to poll
1127 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1128 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1129 * register must be polled until the BMCR_RESET bit clears.
1131 * Furthermore, any attempts to write to PHY registers may have no effect
1132 * or even generate MDIO bus errors until this is complete.
1134 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1135 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1136 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1137 * effort to support such broken PHYs, this function is separate from the
1138 * standard phy_init_hw() which will zero all the other bits in the BMCR
1139 * and reapply all driver-specific and board-specific fixups.
1141 static int phy_poll_reset(struct phy_device *phydev)
1143 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1146 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1147 50000, 600000, true);
1150 /* Some chips (smsc911x) may still need up to another 1ms after the
1151 * BMCR_RESET bit is cleared before they are usable.
1157 int phy_init_hw(struct phy_device *phydev)
1161 /* Deassert the reset signal */
1162 phy_device_reset(phydev, 0);
1167 if (phydev->drv->soft_reset) {
1168 ret = phydev->drv->soft_reset(phydev);
1169 /* see comment in genphy_soft_reset for an explanation */
1171 phydev->suspended = 0;
1177 ret = phy_scan_fixups(phydev);
1181 if (phydev->drv->config_init) {
1182 ret = phydev->drv->config_init(phydev);
1187 if (phydev->drv->config_intr) {
1188 ret = phydev->drv->config_intr(phydev);
1195 EXPORT_SYMBOL(phy_init_hw);
1197 void phy_attached_info(struct phy_device *phydev)
1199 phy_attached_print(phydev, NULL);
1201 EXPORT_SYMBOL(phy_attached_info);
1203 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1204 char *phy_attached_info_irq(struct phy_device *phydev)
1209 switch(phydev->irq) {
1213 case PHY_MAC_INTERRUPT:
1217 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1222 return kasprintf(GFP_KERNEL, "%s", irq_str);
1224 EXPORT_SYMBOL(phy_attached_info_irq);
1226 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1228 const char *unbound = phydev->drv ? "" : "[unbound] ";
1229 char *irq_str = phy_attached_info_irq(phydev);
1232 phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1233 phydev_name(phydev), irq_str);
1237 phydev_info(phydev, ATTACHED_FMT, unbound,
1238 phydev_name(phydev), irq_str);
1246 EXPORT_SYMBOL(phy_attached_print);
1248 static void phy_sysfs_create_links(struct phy_device *phydev)
1250 struct net_device *dev = phydev->attached_dev;
1256 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1261 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1262 &phydev->mdio.dev.kobj,
1265 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1266 kobject_name(&phydev->mdio.dev.kobj),
1268 /* non-fatal - some net drivers can use one netdevice
1269 * with more then one phy
1273 phydev->sysfs_links = true;
1277 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1280 struct phy_device *phydev = to_phy_device(dev);
1282 return sprintf(buf, "%d\n", !phydev->attached_dev);
1284 static DEVICE_ATTR_RO(phy_standalone);
1287 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1288 * @upstream: pointer to the phy device
1289 * @bus: sfp bus representing cage being attached
1291 * This is used to fill in the sfp_upstream_ops .attach member.
1293 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1295 struct phy_device *phydev = upstream;
1297 if (phydev->attached_dev)
1298 phydev->attached_dev->sfp_bus = bus;
1299 phydev->sfp_bus_attached = true;
1301 EXPORT_SYMBOL(phy_sfp_attach);
1304 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1305 * @upstream: pointer to the phy device
1306 * @bus: sfp bus representing cage being attached
1308 * This is used to fill in the sfp_upstream_ops .detach member.
1310 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1312 struct phy_device *phydev = upstream;
1314 if (phydev->attached_dev)
1315 phydev->attached_dev->sfp_bus = NULL;
1316 phydev->sfp_bus_attached = false;
1318 EXPORT_SYMBOL(phy_sfp_detach);
1321 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1322 * @phydev: Pointer to phy_device
1323 * @ops: SFP's upstream operations
1325 int phy_sfp_probe(struct phy_device *phydev,
1326 const struct sfp_upstream_ops *ops)
1328 struct sfp_bus *bus;
1331 if (phydev->mdio.dev.fwnode) {
1332 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1334 return PTR_ERR(bus);
1336 phydev->sfp_bus = bus;
1338 ret = sfp_bus_add_upstream(bus, phydev, ops);
1343 EXPORT_SYMBOL(phy_sfp_probe);
1346 * phy_attach_direct - attach a network device to a given PHY device pointer
1347 * @dev: network device to attach
1348 * @phydev: Pointer to phy_device to attach
1349 * @flags: PHY device's dev_flags
1350 * @interface: PHY device's interface
1352 * Description: Called by drivers to attach to a particular PHY
1353 * device. The phy_device is found, and properly hooked up
1354 * to the phy_driver. If no driver is attached, then a
1355 * generic driver is used. The phy_device is given a ptr to
1356 * the attaching device, and given a callback for link status
1357 * change. The phy_device is returned to the attaching driver.
1358 * This function takes a reference on the phy device.
1360 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1361 u32 flags, phy_interface_t interface)
1363 struct mii_bus *bus = phydev->mdio.bus;
1364 struct device *d = &phydev->mdio.dev;
1365 struct module *ndev_owner = NULL;
1366 bool using_genphy = false;
1369 /* For Ethernet device drivers that register their own MDIO bus, we
1370 * will have bus->owner match ndev_mod, so we do not want to increment
1371 * our own module->refcnt here, otherwise we would not be able to
1375 ndev_owner = dev->dev.parent->driver->owner;
1376 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1377 phydev_err(phydev, "failed to get the bus module\n");
1383 /* Assume that if there is no driver, that it doesn't
1384 * exist, and we should use the genphy driver.
1388 d->driver = &genphy_c45_driver.mdiodrv.driver;
1390 d->driver = &genphy_driver.mdiodrv.driver;
1392 using_genphy = true;
1395 if (!try_module_get(d->driver->owner)) {
1396 phydev_err(phydev, "failed to get the device driver module\n");
1398 goto error_put_device;
1402 err = d->driver->probe(d);
1404 err = device_bind_driver(d);
1407 goto error_module_put;
1410 if (phydev->attached_dev) {
1411 dev_err(&dev->dev, "PHY already attached\n");
1416 phydev->phy_link_change = phy_link_change;
1418 phydev->attached_dev = dev;
1419 dev->phydev = phydev;
1421 if (phydev->sfp_bus_attached)
1422 dev->sfp_bus = phydev->sfp_bus;
1423 else if (dev->sfp_bus)
1424 phydev->is_on_sfp_module = true;
1427 /* Some Ethernet drivers try to connect to a PHY device before
1428 * calling register_netdevice() -> netdev_register_kobject() and
1429 * does the dev->dev.kobj initialization. Here we only check for
1430 * success which indicates that the network device kobject is
1431 * ready. Once we do that we still need to keep track of whether
1432 * links were successfully set up or not for phy_detach() to
1433 * remove them accordingly.
1435 phydev->sysfs_links = false;
1437 phy_sysfs_create_links(phydev);
1439 if (!phydev->attached_dev) {
1440 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1441 &dev_attr_phy_standalone.attr);
1443 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1446 phydev->dev_flags |= flags;
1448 phydev->interface = interface;
1450 phydev->state = PHY_READY;
1452 /* Port is set to PORT_TP by default and the actual PHY driver will set
1453 * it to different value depending on the PHY configuration. If we have
1454 * the generic PHY driver we can't figure it out, thus set the old
1455 * legacy PORT_MII value.
1458 phydev->port = PORT_MII;
1460 /* Initial carrier state is off as the phy is about to be
1464 netif_carrier_off(phydev->attached_dev);
1466 /* Do initial configuration here, now that
1467 * we have certain key parameters
1468 * (dev_flags and interface)
1470 err = phy_init_hw(phydev);
1474 err = phy_disable_interrupts(phydev);
1479 phy_led_triggers_register(phydev);
1484 /* phy_detach() does all of the cleanup below */
1489 module_put(d->driver->owner);
1492 if (ndev_owner != bus->owner)
1493 module_put(bus->owner);
1496 EXPORT_SYMBOL(phy_attach_direct);
1499 * phy_attach - attach a network device to a particular PHY device
1500 * @dev: network device to attach
1501 * @bus_id: Bus ID of PHY device to attach
1502 * @interface: PHY device's interface
1504 * Description: Same as phy_attach_direct() except that a PHY bus_id
1505 * string is passed instead of a pointer to a struct phy_device.
1507 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1508 phy_interface_t interface)
1510 struct bus_type *bus = &mdio_bus_type;
1511 struct phy_device *phydev;
1516 return ERR_PTR(-EINVAL);
1518 /* Search the list of PHY devices on the mdio bus for the
1519 * PHY with the requested name
1521 d = bus_find_device_by_name(bus, NULL, bus_id);
1523 pr_err("PHY %s not found\n", bus_id);
1524 return ERR_PTR(-ENODEV);
1526 phydev = to_phy_device(d);
1528 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1535 EXPORT_SYMBOL(phy_attach);
1537 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1538 struct device_driver *driver)
1540 struct device *d = &phydev->mdio.dev;
1547 ret = d->driver == driver;
1553 bool phy_driver_is_genphy(struct phy_device *phydev)
1555 return phy_driver_is_genphy_kind(phydev,
1556 &genphy_driver.mdiodrv.driver);
1558 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1560 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1562 return phy_driver_is_genphy_kind(phydev,
1563 &genphy_c45_driver.mdiodrv.driver);
1565 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1568 * phy_package_join - join a common PHY group
1569 * @phydev: target phy_device struct
1570 * @addr: cookie and PHY address for global register access
1571 * @priv_size: if non-zero allocate this amount of bytes for private data
1573 * This joins a PHY group and provides a shared storage for all phydevs in
1574 * this group. This is intended to be used for packages which contain
1575 * more than one PHY, for example a quad PHY transceiver.
1577 * The addr parameter serves as a cookie which has to have the same value
1578 * for all members of one group and as a PHY address to access generic
1579 * registers of a PHY package. Usually, one of the PHY addresses of the
1580 * different PHYs in the package provides access to these global registers.
1581 * The address which is given here, will be used in the phy_package_read()
1582 * and phy_package_write() convenience functions. If your PHY doesn't have
1583 * global registers you can just pick any of the PHY addresses.
1585 * This will set the shared pointer of the phydev to the shared storage.
1586 * If this is the first call for a this cookie the shared storage will be
1587 * allocated. If priv_size is non-zero, the given amount of bytes are
1588 * allocated for the priv member.
1590 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1591 * with the same cookie but a different priv_size is an error.
1593 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1595 struct mii_bus *bus = phydev->mdio.bus;
1596 struct phy_package_shared *shared;
1599 if (addr < 0 || addr >= PHY_MAX_ADDR)
1602 mutex_lock(&bus->shared_lock);
1603 shared = bus->shared[addr];
1606 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1610 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1613 shared->priv_size = priv_size;
1615 shared->addr = addr;
1616 refcount_set(&shared->refcnt, 1);
1617 bus->shared[addr] = shared;
1620 if (priv_size && priv_size != shared->priv_size)
1622 refcount_inc(&shared->refcnt);
1624 mutex_unlock(&bus->shared_lock);
1626 phydev->shared = shared;
1633 mutex_unlock(&bus->shared_lock);
1636 EXPORT_SYMBOL_GPL(phy_package_join);
1639 * phy_package_leave - leave a common PHY group
1640 * @phydev: target phy_device struct
1642 * This leaves a PHY group created by phy_package_join(). If this phydev
1643 * was the last user of the shared data between the group, this data is
1644 * freed. Resets the phydev->shared pointer to NULL.
1646 void phy_package_leave(struct phy_device *phydev)
1648 struct phy_package_shared *shared = phydev->shared;
1649 struct mii_bus *bus = phydev->mdio.bus;
1654 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1655 bus->shared[shared->addr] = NULL;
1656 mutex_unlock(&bus->shared_lock);
1657 kfree(shared->priv);
1661 phydev->shared = NULL;
1663 EXPORT_SYMBOL_GPL(phy_package_leave);
1665 static void devm_phy_package_leave(struct device *dev, void *res)
1667 phy_package_leave(*(struct phy_device **)res);
1671 * devm_phy_package_join - resource managed phy_package_join()
1672 * @dev: device that is registering this PHY package
1673 * @phydev: target phy_device struct
1674 * @addr: cookie and PHY address for global register access
1675 * @priv_size: if non-zero allocate this amount of bytes for private data
1677 * Managed phy_package_join(). Shared storage fetched by this function,
1678 * phy_package_leave() is automatically called on driver detach. See
1679 * phy_package_join() for more information.
1681 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1682 int addr, size_t priv_size)
1684 struct phy_device **ptr;
1687 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1692 ret = phy_package_join(phydev, addr, priv_size);
1696 devres_add(dev, ptr);
1703 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1706 * phy_detach - detach a PHY device from its network device
1707 * @phydev: target phy_device struct
1709 * This detaches the phy device from its network device and the phy
1710 * driver, and drops the reference count taken in phy_attach_direct().
1712 void phy_detach(struct phy_device *phydev)
1714 struct net_device *dev = phydev->attached_dev;
1715 struct module *ndev_owner = NULL;
1716 struct mii_bus *bus;
1718 if (phydev->sysfs_links) {
1720 sysfs_remove_link(&dev->dev.kobj, "phydev");
1721 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1724 if (!phydev->attached_dev)
1725 sysfs_remove_file(&phydev->mdio.dev.kobj,
1726 &dev_attr_phy_standalone.attr);
1728 phy_suspend(phydev);
1730 phydev->attached_dev->phydev = NULL;
1731 phydev->attached_dev = NULL;
1733 phydev->phylink = NULL;
1735 phy_led_triggers_unregister(phydev);
1737 if (phydev->mdio.dev.driver)
1738 module_put(phydev->mdio.dev.driver->owner);
1740 /* If the device had no specific driver before (i.e. - it
1741 * was using the generic driver), we unbind the device
1742 * from the generic driver so that there's a chance a
1743 * real driver could be loaded
1745 if (phy_driver_is_genphy(phydev) ||
1746 phy_driver_is_genphy_10g(phydev))
1747 device_release_driver(&phydev->mdio.dev);
1750 * The phydev might go away on the put_device() below, so avoid
1751 * a use-after-free bug by reading the underlying bus first.
1753 bus = phydev->mdio.bus;
1755 put_device(&phydev->mdio.dev);
1757 ndev_owner = dev->dev.parent->driver->owner;
1758 if (ndev_owner != bus->owner)
1759 module_put(bus->owner);
1761 /* Assert the reset signal */
1762 phy_device_reset(phydev, 1);
1764 EXPORT_SYMBOL(phy_detach);
1766 int phy_suspend(struct phy_device *phydev)
1768 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1769 struct net_device *netdev = phydev->attached_dev;
1770 struct phy_driver *phydrv = phydev->drv;
1773 if (phydev->suspended)
1776 /* If the device has WOL enabled, we cannot suspend the PHY */
1777 phy_ethtool_get_wol(phydev, &wol);
1778 if (wol.wolopts || (netdev && netdev->wol_enabled))
1781 if (!phydrv || !phydrv->suspend)
1784 ret = phydrv->suspend(phydev);
1786 phydev->suspended = true;
1790 EXPORT_SYMBOL(phy_suspend);
1792 int __phy_resume(struct phy_device *phydev)
1794 struct phy_driver *phydrv = phydev->drv;
1797 lockdep_assert_held(&phydev->lock);
1799 if (!phydrv || !phydrv->resume)
1802 ret = phydrv->resume(phydev);
1804 phydev->suspended = false;
1808 EXPORT_SYMBOL(__phy_resume);
1810 int phy_resume(struct phy_device *phydev)
1814 mutex_lock(&phydev->lock);
1815 ret = __phy_resume(phydev);
1816 mutex_unlock(&phydev->lock);
1820 EXPORT_SYMBOL(phy_resume);
1822 int phy_loopback(struct phy_device *phydev, bool enable)
1829 mutex_lock(&phydev->lock);
1831 if (enable && phydev->loopback_enabled) {
1836 if (!enable && !phydev->loopback_enabled) {
1841 if (phydev->drv->set_loopback)
1842 ret = phydev->drv->set_loopback(phydev, enable);
1844 ret = genphy_loopback(phydev, enable);
1849 phydev->loopback_enabled = enable;
1852 mutex_unlock(&phydev->lock);
1855 EXPORT_SYMBOL(phy_loopback);
1858 * phy_reset_after_clk_enable - perform a PHY reset if needed
1859 * @phydev: target phy_device struct
1861 * Description: Some PHYs are known to need a reset after their refclk was
1862 * enabled. This function evaluates the flags and perform the reset if it's
1863 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1866 int phy_reset_after_clk_enable(struct phy_device *phydev)
1868 if (!phydev || !phydev->drv)
1871 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1872 phy_device_reset(phydev, 1);
1873 phy_device_reset(phydev, 0);
1879 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1881 /* Generic PHY support and helper functions */
1884 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1885 * @phydev: target phy_device struct
1887 * Description: Writes MII_ADVERTISE with the appropriate values,
1888 * after sanitizing the values to make sure we only advertise
1889 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1890 * hasn't changed, and > 0 if it has changed.
1892 static int genphy_config_advert(struct phy_device *phydev)
1894 int err, bmsr, changed = 0;
1897 /* Only allow advertising what this PHY supports */
1898 linkmode_and(phydev->advertising, phydev->advertising,
1901 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1903 /* Setup standard advertisement */
1904 err = phy_modify_changed(phydev, MII_ADVERTISE,
1905 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1906 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1913 bmsr = phy_read(phydev, MII_BMSR);
1917 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1918 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1921 if (!(bmsr & BMSR_ESTATEN))
1924 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1926 err = phy_modify_changed(phydev, MII_CTRL1000,
1927 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1938 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1939 * @phydev: target phy_device struct
1941 * Description: Writes MII_ADVERTISE with the appropriate values,
1942 * after sanitizing the values to make sure we only advertise
1943 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1944 * hasn't changed, and > 0 if it has changed. This function is intended
1945 * for Clause 37 1000Base-X mode.
1947 static int genphy_c37_config_advert(struct phy_device *phydev)
1951 /* Only allow advertising what this PHY supports */
1952 linkmode_and(phydev->advertising, phydev->advertising,
1955 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1956 phydev->advertising))
1957 adv |= ADVERTISE_1000XFULL;
1958 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1959 phydev->advertising))
1960 adv |= ADVERTISE_1000XPAUSE;
1961 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1962 phydev->advertising))
1963 adv |= ADVERTISE_1000XPSE_ASYM;
1965 return phy_modify_changed(phydev, MII_ADVERTISE,
1966 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1967 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1972 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1973 * @phydev: target phy_device struct
1975 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1976 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1977 * changed, and 1 if it has changed.
1979 int genphy_config_eee_advert(struct phy_device *phydev)
1983 /* Nothing to disable */
1984 if (!phydev->eee_broken_modes)
1987 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1988 phydev->eee_broken_modes, 0);
1989 /* If the call failed, we assume that EEE is not supported */
1990 return err < 0 ? 0 : err;
1992 EXPORT_SYMBOL(genphy_config_eee_advert);
1995 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1996 * @phydev: target phy_device struct
1998 * Description: Configures MII_BMCR to force speed/duplex
1999 * to the values in phydev. Assumes that the values are valid.
2000 * Please see phy_sanitize_settings().
2002 int genphy_setup_forced(struct phy_device *phydev)
2007 phydev->asym_pause = 0;
2009 if (SPEED_1000 == phydev->speed)
2010 ctl |= BMCR_SPEED1000;
2011 else if (SPEED_100 == phydev->speed)
2012 ctl |= BMCR_SPEED100;
2014 if (DUPLEX_FULL == phydev->duplex)
2015 ctl |= BMCR_FULLDPLX;
2017 return phy_modify(phydev, MII_BMCR,
2018 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
2020 EXPORT_SYMBOL(genphy_setup_forced);
2022 static int genphy_setup_master_slave(struct phy_device *phydev)
2026 if (!phydev->is_gigabit_capable)
2029 switch (phydev->master_slave_set) {
2030 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
2031 ctl |= CTL1000_PREFER_MASTER;
2033 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
2035 case MASTER_SLAVE_CFG_MASTER_FORCE:
2036 ctl |= CTL1000_AS_MASTER;
2038 case MASTER_SLAVE_CFG_SLAVE_FORCE:
2039 ctl |= CTL1000_ENABLE_MASTER;
2041 case MASTER_SLAVE_CFG_UNKNOWN:
2042 case MASTER_SLAVE_CFG_UNSUPPORTED:
2045 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2049 return phy_modify_changed(phydev, MII_CTRL1000,
2050 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2051 CTL1000_PREFER_MASTER), ctl);
2054 static int genphy_read_master_slave(struct phy_device *phydev)
2059 if (!phydev->is_gigabit_capable) {
2060 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2061 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2065 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2066 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2068 val = phy_read(phydev, MII_CTRL1000);
2072 if (val & CTL1000_ENABLE_MASTER) {
2073 if (val & CTL1000_AS_MASTER)
2074 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2076 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2078 if (val & CTL1000_PREFER_MASTER)
2079 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2081 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2084 val = phy_read(phydev, MII_STAT1000);
2088 if (val & LPA_1000MSFAIL) {
2089 state = MASTER_SLAVE_STATE_ERR;
2090 } else if (phydev->link) {
2091 /* this bits are valid only for active link */
2092 if (val & LPA_1000MSRES)
2093 state = MASTER_SLAVE_STATE_MASTER;
2095 state = MASTER_SLAVE_STATE_SLAVE;
2097 state = MASTER_SLAVE_STATE_UNKNOWN;
2100 phydev->master_slave_get = cfg;
2101 phydev->master_slave_state = state;
2107 * genphy_restart_aneg - Enable and Restart Autonegotiation
2108 * @phydev: target phy_device struct
2110 int genphy_restart_aneg(struct phy_device *phydev)
2112 /* Don't isolate the PHY if we're negotiating */
2113 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2114 BMCR_ANENABLE | BMCR_ANRESTART);
2116 EXPORT_SYMBOL(genphy_restart_aneg);
2119 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2120 * @phydev: target phy_device struct
2121 * @restart: whether aneg restart is requested
2123 * Check, and restart auto-negotiation if needed.
2125 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2130 /* Advertisement hasn't changed, but maybe aneg was never on to
2131 * begin with? Or maybe phy was isolated?
2133 ret = phy_read(phydev, MII_BMCR);
2137 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2142 return genphy_restart_aneg(phydev);
2146 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2149 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2150 * @phydev: target phy_device struct
2151 * @changed: whether autoneg is requested
2153 * Description: If auto-negotiation is enabled, we configure the
2154 * advertising, and then restart auto-negotiation. If it is not
2155 * enabled, then we write the BMCR.
2157 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2161 if (genphy_config_eee_advert(phydev))
2164 err = genphy_setup_master_slave(phydev);
2170 if (AUTONEG_ENABLE != phydev->autoneg)
2171 return genphy_setup_forced(phydev);
2173 err = genphy_config_advert(phydev);
2174 if (err < 0) /* error */
2179 return genphy_check_and_restart_aneg(phydev, changed);
2181 EXPORT_SYMBOL(__genphy_config_aneg);
2184 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2185 * @phydev: target phy_device struct
2187 * Description: If auto-negotiation is enabled, we configure the
2188 * advertising, and then restart auto-negotiation. If it is not
2189 * enabled, then we write the BMCR. This function is intended
2190 * for use with Clause 37 1000Base-X mode.
2192 int genphy_c37_config_aneg(struct phy_device *phydev)
2196 if (phydev->autoneg != AUTONEG_ENABLE)
2197 return genphy_setup_forced(phydev);
2199 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2204 changed = genphy_c37_config_advert(phydev);
2205 if (changed < 0) /* error */
2209 /* Advertisement hasn't changed, but maybe aneg was never on to
2210 * begin with? Or maybe phy was isolated?
2212 int ctl = phy_read(phydev, MII_BMCR);
2217 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2218 changed = 1; /* do restart aneg */
2221 /* Only restart aneg if we are advertising something different
2222 * than we were before.
2225 return genphy_restart_aneg(phydev);
2229 EXPORT_SYMBOL(genphy_c37_config_aneg);
2232 * genphy_aneg_done - return auto-negotiation status
2233 * @phydev: target phy_device struct
2235 * Description: Reads the status register and returns 0 either if
2236 * auto-negotiation is incomplete, or if there was an error.
2237 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2239 int genphy_aneg_done(struct phy_device *phydev)
2241 int retval = phy_read(phydev, MII_BMSR);
2243 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2245 EXPORT_SYMBOL(genphy_aneg_done);
2248 * genphy_update_link - update link status in @phydev
2249 * @phydev: target phy_device struct
2251 * Description: Update the value in phydev->link to reflect the
2252 * current link value. In order to do this, we need to read
2253 * the status register twice, keeping the second value.
2255 int genphy_update_link(struct phy_device *phydev)
2257 int status = 0, bmcr;
2259 bmcr = phy_read(phydev, MII_BMCR);
2263 /* Autoneg is being started, therefore disregard BMSR value and
2264 * report link as down.
2266 if (bmcr & BMCR_ANRESTART)
2269 /* The link state is latched low so that momentary link
2270 * drops can be detected. Do not double-read the status
2271 * in polling mode to detect such short link drops except
2272 * the link was already down.
2274 if (!phy_polling_mode(phydev) || !phydev->link) {
2275 status = phy_read(phydev, MII_BMSR);
2278 else if (status & BMSR_LSTATUS)
2282 /* Read link and autonegotiation status */
2283 status = phy_read(phydev, MII_BMSR);
2287 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2288 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2290 /* Consider the case that autoneg was started and "aneg complete"
2291 * bit has been reset, but "link up" bit not yet.
2293 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2298 EXPORT_SYMBOL(genphy_update_link);
2300 int genphy_read_lpa(struct phy_device *phydev)
2304 if (phydev->autoneg == AUTONEG_ENABLE) {
2305 if (!phydev->autoneg_complete) {
2306 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2308 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2312 if (phydev->is_gigabit_capable) {
2313 lpagb = phy_read(phydev, MII_STAT1000);
2317 if (lpagb & LPA_1000MSFAIL) {
2318 int adv = phy_read(phydev, MII_CTRL1000);
2323 if (adv & CTL1000_ENABLE_MASTER)
2324 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2326 phydev_err(phydev, "Master/Slave resolution failed\n");
2330 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2334 lpa = phy_read(phydev, MII_LPA);
2338 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2340 linkmode_zero(phydev->lp_advertising);
2345 EXPORT_SYMBOL(genphy_read_lpa);
2348 * genphy_read_status_fixed - read the link parameters for !aneg mode
2349 * @phydev: target phy_device struct
2351 * Read the current duplex and speed state for a PHY operating with
2352 * autonegotiation disabled.
2354 int genphy_read_status_fixed(struct phy_device *phydev)
2356 int bmcr = phy_read(phydev, MII_BMCR);
2361 if (bmcr & BMCR_FULLDPLX)
2362 phydev->duplex = DUPLEX_FULL;
2364 phydev->duplex = DUPLEX_HALF;
2366 if (bmcr & BMCR_SPEED1000)
2367 phydev->speed = SPEED_1000;
2368 else if (bmcr & BMCR_SPEED100)
2369 phydev->speed = SPEED_100;
2371 phydev->speed = SPEED_10;
2375 EXPORT_SYMBOL(genphy_read_status_fixed);
2378 * genphy_read_status - check the link status and update current link state
2379 * @phydev: target phy_device struct
2381 * Description: Check the link, then figure out the current state
2382 * by comparing what we advertise with what the link partner
2383 * advertises. Start by checking the gigabit possibilities,
2384 * then move on to 10/100.
2386 int genphy_read_status(struct phy_device *phydev)
2388 int err, old_link = phydev->link;
2390 /* Update the link, but return if there was an error */
2391 err = genphy_update_link(phydev);
2395 /* why bother the PHY if nothing can have changed */
2396 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2399 phydev->speed = SPEED_UNKNOWN;
2400 phydev->duplex = DUPLEX_UNKNOWN;
2402 phydev->asym_pause = 0;
2404 err = genphy_read_master_slave(phydev);
2408 err = genphy_read_lpa(phydev);
2412 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2413 phy_resolve_aneg_linkmode(phydev);
2414 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2415 err = genphy_read_status_fixed(phydev);
2422 EXPORT_SYMBOL(genphy_read_status);
2425 * genphy_c37_read_status - check the link status and update current link state
2426 * @phydev: target phy_device struct
2428 * Description: Check the link, then figure out the current state
2429 * by comparing what we advertise with what the link partner
2430 * advertises. This function is for Clause 37 1000Base-X mode.
2432 int genphy_c37_read_status(struct phy_device *phydev)
2434 int lpa, err, old_link = phydev->link;
2436 /* Update the link, but return if there was an error */
2437 err = genphy_update_link(phydev);
2441 /* why bother the PHY if nothing can have changed */
2442 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2445 phydev->duplex = DUPLEX_UNKNOWN;
2447 phydev->asym_pause = 0;
2449 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2450 lpa = phy_read(phydev, MII_LPA);
2454 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2455 phydev->lp_advertising, lpa & LPA_LPACK);
2456 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2457 phydev->lp_advertising, lpa & LPA_1000XFULL);
2458 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2459 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2460 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2461 phydev->lp_advertising,
2462 lpa & LPA_1000XPAUSE_ASYM);
2464 phy_resolve_aneg_linkmode(phydev);
2465 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2466 int bmcr = phy_read(phydev, MII_BMCR);
2471 if (bmcr & BMCR_FULLDPLX)
2472 phydev->duplex = DUPLEX_FULL;
2474 phydev->duplex = DUPLEX_HALF;
2479 EXPORT_SYMBOL(genphy_c37_read_status);
2482 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2483 * @phydev: target phy_device struct
2485 * Description: Perform a software PHY reset using the standard
2486 * BMCR_RESET bit and poll for the reset bit to be cleared.
2488 * Returns: 0 on success, < 0 on failure
2490 int genphy_soft_reset(struct phy_device *phydev)
2492 u16 res = BMCR_RESET;
2495 if (phydev->autoneg == AUTONEG_ENABLE)
2496 res |= BMCR_ANRESTART;
2498 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2502 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2503 * to their default value. Therefore the POWER DOWN bit is supposed to
2504 * be cleared after soft reset.
2506 phydev->suspended = 0;
2508 ret = phy_poll_reset(phydev);
2512 /* BMCR may be reset to defaults */
2513 if (phydev->autoneg == AUTONEG_DISABLE)
2514 ret = genphy_setup_forced(phydev);
2518 EXPORT_SYMBOL(genphy_soft_reset);
2520 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2522 /* It seems there are cases where the interrupts are handled by another
2523 * entity (ie an IRQ controller embedded inside the PHY) and do not
2524 * need any other interraction from phylib. In this case, just trigger
2525 * the state machine directly.
2527 phy_trigger_machine(phydev);
2531 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2534 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2535 * @phydev: target phy_device struct
2537 * Description: Reads the PHY's abilities and populates
2538 * phydev->supported accordingly.
2540 * Returns: 0 on success, < 0 on failure
2542 int genphy_read_abilities(struct phy_device *phydev)
2546 linkmode_set_bit_array(phy_basic_ports_array,
2547 ARRAY_SIZE(phy_basic_ports_array),
2550 val = phy_read(phydev, MII_BMSR);
2554 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2555 val & BMSR_ANEGCAPABLE);
2557 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2558 val & BMSR_100FULL);
2559 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2560 val & BMSR_100HALF);
2561 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2563 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2566 if (val & BMSR_ESTATEN) {
2567 val = phy_read(phydev, MII_ESTATUS);
2571 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2572 phydev->supported, val & ESTATUS_1000_TFULL);
2573 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2574 phydev->supported, val & ESTATUS_1000_THALF);
2575 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2576 phydev->supported, val & ESTATUS_1000_XFULL);
2581 EXPORT_SYMBOL(genphy_read_abilities);
2583 /* This is used for the phy device which doesn't support the MMD extended
2584 * register access, but it does have side effect when we are trying to access
2585 * the MMD register via indirect method.
2587 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2591 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2593 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2594 u16 regnum, u16 val)
2598 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2600 int genphy_suspend(struct phy_device *phydev)
2602 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2604 EXPORT_SYMBOL(genphy_suspend);
2606 int genphy_resume(struct phy_device *phydev)
2608 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2610 EXPORT_SYMBOL(genphy_resume);
2612 int genphy_loopback(struct phy_device *phydev, bool enable)
2615 u16 val, ctl = BMCR_LOOPBACK;
2618 if (phydev->speed == SPEED_1000)
2619 ctl |= BMCR_SPEED1000;
2620 else if (phydev->speed == SPEED_100)
2621 ctl |= BMCR_SPEED100;
2623 if (phydev->duplex == DUPLEX_FULL)
2624 ctl |= BMCR_FULLDPLX;
2626 phy_modify(phydev, MII_BMCR, ~0, ctl);
2628 ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2630 5000, 500000, true);
2634 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2636 phy_config_aneg(phydev);
2641 EXPORT_SYMBOL(genphy_loopback);
2644 * phy_remove_link_mode - Remove a supported link mode
2645 * @phydev: phy_device structure to remove link mode from
2646 * @link_mode: Link mode to be removed
2648 * Description: Some MACs don't support all link modes which the PHY
2649 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2650 * to remove a link mode.
2652 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2654 linkmode_clear_bit(link_mode, phydev->supported);
2655 phy_advertise_supported(phydev);
2657 EXPORT_SYMBOL(phy_remove_link_mode);
2659 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2661 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2662 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2663 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2664 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2668 * phy_advertise_supported - Advertise all supported modes
2669 * @phydev: target phy_device struct
2671 * Description: Called to advertise all supported modes, doesn't touch
2672 * pause mode advertising.
2674 void phy_advertise_supported(struct phy_device *phydev)
2676 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2678 linkmode_copy(new, phydev->supported);
2679 phy_copy_pause_bits(new, phydev->advertising);
2680 linkmode_copy(phydev->advertising, new);
2682 EXPORT_SYMBOL(phy_advertise_supported);
2685 * phy_support_sym_pause - Enable support of symmetrical pause
2686 * @phydev: target phy_device struct
2688 * Description: Called by the MAC to indicate is supports symmetrical
2689 * Pause, but not asym pause.
2691 void phy_support_sym_pause(struct phy_device *phydev)
2693 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2694 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2696 EXPORT_SYMBOL(phy_support_sym_pause);
2699 * phy_support_asym_pause - Enable support of asym pause
2700 * @phydev: target phy_device struct
2702 * Description: Called by the MAC to indicate is supports Asym Pause.
2704 void phy_support_asym_pause(struct phy_device *phydev)
2706 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2708 EXPORT_SYMBOL(phy_support_asym_pause);
2711 * phy_set_sym_pause - Configure symmetric Pause
2712 * @phydev: target phy_device struct
2713 * @rx: Receiver Pause is supported
2714 * @tx: Transmit Pause is supported
2715 * @autoneg: Auto neg should be used
2717 * Description: Configure advertised Pause support depending on if
2718 * receiver pause and pause auto neg is supported. Generally called
2719 * from the set_pauseparam .ndo.
2721 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2724 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2726 if (rx && tx && autoneg)
2727 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2730 linkmode_copy(phydev->advertising, phydev->supported);
2732 EXPORT_SYMBOL(phy_set_sym_pause);
2735 * phy_set_asym_pause - Configure Pause and Asym Pause
2736 * @phydev: target phy_device struct
2737 * @rx: Receiver Pause is supported
2738 * @tx: Transmit Pause is supported
2740 * Description: Configure advertised Pause support depending on if
2741 * transmit and receiver pause is supported. If there has been a
2742 * change in adverting, trigger a new autoneg. Generally called from
2743 * the set_pauseparam .ndo.
2745 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2747 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2749 linkmode_copy(oldadv, phydev->advertising);
2750 linkmode_set_pause(phydev->advertising, tx, rx);
2752 if (!linkmode_equal(oldadv, phydev->advertising) &&
2754 phy_start_aneg(phydev);
2756 EXPORT_SYMBOL(phy_set_asym_pause);
2759 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2760 * @phydev: phy_device struct
2761 * @pp: requested pause configuration
2763 * Description: Test if the PHY/MAC combination supports the Pause
2764 * configuration the user is requesting. Returns True if it is
2765 * supported, false otherwise.
2767 bool phy_validate_pause(struct phy_device *phydev,
2768 struct ethtool_pauseparam *pp)
2770 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2771 phydev->supported) && pp->rx_pause)
2774 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2775 phydev->supported) &&
2776 pp->rx_pause != pp->tx_pause)
2781 EXPORT_SYMBOL(phy_validate_pause);
2784 * phy_get_pause - resolve negotiated pause modes
2785 * @phydev: phy_device struct
2786 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2788 * @rx_pause: pointer to bool to indicate whether receive pause should be
2791 * Resolve and return the flow control modes according to the negotiation
2792 * result. This includes checking that we are operating in full duplex mode.
2793 * See linkmode_resolve_pause() for further details.
2795 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2797 if (phydev->duplex != DUPLEX_FULL) {
2803 return linkmode_resolve_pause(phydev->advertising,
2804 phydev->lp_advertising,
2805 tx_pause, rx_pause);
2807 EXPORT_SYMBOL(phy_get_pause);
2809 #if IS_ENABLED(CONFIG_OF_MDIO)
2810 static int phy_get_int_delay_property(struct device *dev, const char *name)
2815 ret = device_property_read_u32(dev, name, &int_delay);
2822 static int phy_get_int_delay_property(struct device *dev, const char *name)
2829 * phy_get_internal_delay - returns the index of the internal delay
2830 * @phydev: phy_device struct
2831 * @dev: pointer to the devices device struct
2832 * @delay_values: array of delays the PHY supports
2833 * @size: the size of the delay array
2834 * @is_rx: boolean to indicate to get the rx internal delay
2836 * Returns the index within the array of internal delay passed in.
2837 * If the device property is not present then the interface type is checked
2838 * if the interface defines use of internal delay then a 1 is returned otherwise
2840 * The array must be in ascending order. If PHY does not have an ascending order
2841 * array then size = 0 and the value of the delay property is returned.
2842 * Return -EINVAL if the delay is invalid or cannot be found.
2844 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2845 const int *delay_values, int size, bool is_rx)
2851 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
2852 if (delay < 0 && size == 0) {
2853 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2854 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
2861 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
2862 if (delay < 0 && size == 0) {
2863 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2864 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
2874 if (delay && size == 0)
2877 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
2878 phydev_err(phydev, "Delay %d is out of range\n", delay);
2882 if (delay == delay_values[0])
2885 for (i = 1; i < size; i++) {
2886 if (delay == delay_values[i])
2889 /* Find an approximate index by looking up the table */
2890 if (delay > delay_values[i - 1] &&
2891 delay < delay_values[i]) {
2892 if (delay - delay_values[i - 1] <
2893 delay_values[i] - delay)
2900 phydev_err(phydev, "error finding internal delay index for %d\n",
2905 EXPORT_SYMBOL(phy_get_internal_delay);
2907 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2909 return phydrv->config_intr && phydrv->handle_interrupt;
2913 * fwnode_mdio_find_device - Given a fwnode, find the mdio_device
2914 * @fwnode: pointer to the mdio_device's fwnode
2916 * If successful, returns a pointer to the mdio_device with the embedded
2917 * struct device refcount incremented by one, or NULL on failure.
2918 * The caller should call put_device() on the mdio_device after its use.
2920 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
2927 d = bus_find_device_by_fwnode(&mdio_bus_type, fwnode);
2931 return to_mdio_device(d);
2933 EXPORT_SYMBOL(fwnode_mdio_find_device);
2936 * fwnode_phy_find_device - For provided phy_fwnode, find phy_device.
2938 * @phy_fwnode: Pointer to the phy's fwnode.
2940 * If successful, returns a pointer to the phy_device with the embedded
2941 * struct device refcount incremented by one, or NULL on failure.
2943 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
2945 struct mdio_device *mdiodev;
2947 mdiodev = fwnode_mdio_find_device(phy_fwnode);
2951 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
2952 return to_phy_device(&mdiodev->dev);
2954 put_device(&mdiodev->dev);
2958 EXPORT_SYMBOL(fwnode_phy_find_device);
2961 * device_phy_find_device - For the given device, get the phy_device
2962 * @dev: Pointer to the given device
2964 * Refer return conditions of fwnode_phy_find_device().
2966 struct phy_device *device_phy_find_device(struct device *dev)
2968 return fwnode_phy_find_device(dev_fwnode(dev));
2970 EXPORT_SYMBOL_GPL(device_phy_find_device);
2973 * fwnode_get_phy_node - Get the phy_node using the named reference.
2974 * @fwnode: Pointer to fwnode from which phy_node has to be obtained.
2976 * Refer return conditions of fwnode_find_reference().
2977 * For ACPI, only "phy-handle" is supported. Legacy DT properties "phy"
2978 * and "phy-device" are not supported in ACPI. DT supports all the three
2979 * named references to the phy node.
2981 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode)
2983 struct fwnode_handle *phy_node;
2985 /* Only phy-handle is used for ACPI */
2986 phy_node = fwnode_find_reference(fwnode, "phy-handle", 0);
2987 if (is_acpi_node(fwnode) || !IS_ERR(phy_node))
2989 phy_node = fwnode_find_reference(fwnode, "phy", 0);
2990 if (IS_ERR(phy_node))
2991 phy_node = fwnode_find_reference(fwnode, "phy-device", 0);
2994 EXPORT_SYMBOL_GPL(fwnode_get_phy_node);
2997 * phy_probe - probe and init a PHY device
2998 * @dev: device to probe and init
3000 * Description: Take care of setting up the phy_device structure,
3001 * set the state to READY (the driver's init function should
3002 * set it to STARTING if needed).
3004 static int phy_probe(struct device *dev)
3006 struct phy_device *phydev = to_phy_device(dev);
3007 struct device_driver *drv = phydev->mdio.dev.driver;
3008 struct phy_driver *phydrv = to_phy_driver(drv);
3011 phydev->drv = phydrv;
3013 /* Disable the interrupt if the PHY doesn't support it
3014 * but the interrupt is still a valid one
3016 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
3017 phydev->irq = PHY_POLL;
3019 if (phydrv->flags & PHY_IS_INTERNAL)
3020 phydev->is_internal = true;
3022 mutex_lock(&phydev->lock);
3024 /* Deassert the reset signal */
3025 phy_device_reset(phydev, 0);
3027 if (phydev->drv->probe) {
3028 err = phydev->drv->probe(phydev);
3033 /* Start out supporting everything. Eventually,
3034 * a controller will attach, and may modify one
3035 * or both of these values
3037 if (phydrv->features)
3038 linkmode_copy(phydev->supported, phydrv->features);
3039 else if (phydrv->get_features)
3040 err = phydrv->get_features(phydev);
3041 else if (phydev->is_c45)
3042 err = genphy_c45_pma_read_abilities(phydev);
3044 err = genphy_read_abilities(phydev);
3049 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
3051 phydev->autoneg = 0;
3053 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
3055 phydev->is_gigabit_capable = 1;
3056 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
3058 phydev->is_gigabit_capable = 1;
3060 of_set_phy_supported(phydev);
3061 phy_advertise_supported(phydev);
3063 /* Get the EEE modes we want to prohibit. We will ask
3064 * the PHY stop advertising these mode later on
3066 of_set_phy_eee_broken(phydev);
3068 /* The Pause Frame bits indicate that the PHY can support passing
3069 * pause frames. During autonegotiation, the PHYs will determine if
3070 * they should allow pause frames to pass. The MAC driver should then
3071 * use that result to determine whether to enable flow control via
3074 * Normally, PHY drivers should not set the Pause bits, and instead
3075 * allow phylib to do that. However, there may be some situations
3076 * (e.g. hardware erratum) where the driver wants to set only one
3079 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
3080 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
3081 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3083 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3087 /* Set the state to READY by default */
3088 phydev->state = PHY_READY;
3091 /* Assert the reset signal */
3093 phy_device_reset(phydev, 1);
3095 mutex_unlock(&phydev->lock);
3100 static int phy_remove(struct device *dev)
3102 struct phy_device *phydev = to_phy_device(dev);
3104 cancel_delayed_work_sync(&phydev->state_queue);
3106 mutex_lock(&phydev->lock);
3107 phydev->state = PHY_DOWN;
3108 mutex_unlock(&phydev->lock);
3110 sfp_bus_del_upstream(phydev->sfp_bus);
3111 phydev->sfp_bus = NULL;
3113 if (phydev->drv && phydev->drv->remove)
3114 phydev->drv->remove(phydev);
3116 /* Assert the reset signal */
3117 phy_device_reset(phydev, 1);
3124 static void phy_shutdown(struct device *dev)
3126 struct phy_device *phydev = to_phy_device(dev);
3128 phy_disable_interrupts(phydev);
3132 * phy_driver_register - register a phy_driver with the PHY layer
3133 * @new_driver: new phy_driver to register
3134 * @owner: module owning this PHY
3136 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
3140 /* Either the features are hard coded, or dynamically
3141 * determined. It cannot be both.
3143 if (WARN_ON(new_driver->features && new_driver->get_features)) {
3144 pr_err("%s: features and get_features must not both be set\n",
3149 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3150 new_driver->mdiodrv.driver.name = new_driver->name;
3151 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3152 new_driver->mdiodrv.driver.probe = phy_probe;
3153 new_driver->mdiodrv.driver.remove = phy_remove;
3154 new_driver->mdiodrv.driver.shutdown = phy_shutdown;
3155 new_driver->mdiodrv.driver.owner = owner;
3156 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3158 retval = driver_register(&new_driver->mdiodrv.driver);
3160 pr_err("%s: Error %d in registering driver\n",
3161 new_driver->name, retval);
3166 pr_debug("%s: Registered new driver\n", new_driver->name);
3170 EXPORT_SYMBOL(phy_driver_register);
3172 int phy_drivers_register(struct phy_driver *new_driver, int n,
3173 struct module *owner)
3177 for (i = 0; i < n; i++) {
3178 ret = phy_driver_register(new_driver + i, owner);
3181 phy_driver_unregister(new_driver + i);
3187 EXPORT_SYMBOL(phy_drivers_register);
3189 void phy_driver_unregister(struct phy_driver *drv)
3191 driver_unregister(&drv->mdiodrv.driver);
3193 EXPORT_SYMBOL(phy_driver_unregister);
3195 void phy_drivers_unregister(struct phy_driver *drv, int n)
3199 for (i = 0; i < n; i++)
3200 phy_driver_unregister(drv + i);
3202 EXPORT_SYMBOL(phy_drivers_unregister);
3204 static struct phy_driver genphy_driver = {
3205 .phy_id = 0xffffffff,
3206 .phy_id_mask = 0xffffffff,
3207 .name = "Generic PHY",
3208 .get_features = genphy_read_abilities,
3209 .suspend = genphy_suspend,
3210 .resume = genphy_resume,
3211 .set_loopback = genphy_loopback,
3214 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3215 .get_sset_count = phy_ethtool_get_sset_count,
3216 .get_strings = phy_ethtool_get_strings,
3217 .get_stats = phy_ethtool_get_stats,
3218 .start_cable_test = phy_start_cable_test,
3219 .start_cable_test_tdr = phy_start_cable_test_tdr,
3222 static int __init phy_init(void)
3226 rc = mdio_bus_init();
3230 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3233 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3237 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3239 phy_driver_unregister(&genphy_c45_driver);
3247 static void __exit phy_exit(void)
3249 phy_driver_unregister(&genphy_c45_driver);
3250 phy_driver_unregister(&genphy_driver);
3252 ethtool_set_ethtool_phy_ops(NULL);
3255 subsys_initcall(phy_init);
3256 module_exit(phy_exit);