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 net_device *netdev = phydev->attached_dev;
238 if (!phydev->drv->suspend)
241 /* PHY not attached? May suspend if the PHY has not already been
242 * suspended as part of a prior call to phy_disconnect() ->
243 * phy_detach() -> phy_suspend() because the parent netdev might be the
244 * MDIO bus driver and clock gated at this point.
249 if (netdev->wol_enabled)
252 /* As long as not all affected network drivers support the
253 * wol_enabled flag, let's check for hints that WoL is enabled.
254 * Don't suspend PHY if the attached netdev parent may wake up.
255 * The parent may point to a PCI device, as in tg3 driver.
257 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
260 /* Also don't suspend PHY if the netdev itself may wakeup. This
261 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
264 if (device_may_wakeup(&netdev->dev))
268 return !phydev->suspended;
271 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
273 struct phy_device *phydev = to_phy_device(dev);
275 if (phydev->mac_managed_pm)
278 /* We must stop the state machine manually, otherwise it stops out of
279 * control, possibly with the phydev->lock held. Upon resume, netdev
280 * may call phy routines that try to grab the same lock, and that may
281 * lead to a deadlock.
283 if (phydev->attached_dev && phydev->adjust_link)
284 phy_stop_machine(phydev);
286 if (!mdio_bus_phy_may_suspend(phydev))
289 phydev->suspended_by_mdio_bus = 1;
291 return phy_suspend(phydev);
294 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
296 struct phy_device *phydev = to_phy_device(dev);
299 if (phydev->mac_managed_pm)
302 if (!phydev->suspended_by_mdio_bus)
305 phydev->suspended_by_mdio_bus = 0;
307 ret = phy_init_hw(phydev);
311 ret = phy_resume(phydev);
315 if (phydev->attached_dev && phydev->adjust_link)
316 phy_start_machine(phydev);
321 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
322 mdio_bus_phy_resume);
325 * phy_register_fixup - creates a new phy_fixup and adds it to the list
326 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
327 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
328 * It can also be PHY_ANY_UID
329 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
331 * @run: The actual code to be run when a matching PHY is found
333 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
334 int (*run)(struct phy_device *))
336 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
341 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
342 fixup->phy_uid = phy_uid;
343 fixup->phy_uid_mask = phy_uid_mask;
346 mutex_lock(&phy_fixup_lock);
347 list_add_tail(&fixup->list, &phy_fixup_list);
348 mutex_unlock(&phy_fixup_lock);
352 EXPORT_SYMBOL(phy_register_fixup);
354 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
355 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
356 int (*run)(struct phy_device *))
358 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
360 EXPORT_SYMBOL(phy_register_fixup_for_uid);
362 /* Registers a fixup to be run on the PHY with id string bus_id */
363 int phy_register_fixup_for_id(const char *bus_id,
364 int (*run)(struct phy_device *))
366 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
368 EXPORT_SYMBOL(phy_register_fixup_for_id);
371 * phy_unregister_fixup - remove a phy_fixup from the list
372 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
373 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
374 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
376 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
378 struct list_head *pos, *n;
379 struct phy_fixup *fixup;
384 mutex_lock(&phy_fixup_lock);
385 list_for_each_safe(pos, n, &phy_fixup_list) {
386 fixup = list_entry(pos, struct phy_fixup, list);
388 if ((!strcmp(fixup->bus_id, bus_id)) &&
389 ((fixup->phy_uid & phy_uid_mask) ==
390 (phy_uid & phy_uid_mask))) {
391 list_del(&fixup->list);
397 mutex_unlock(&phy_fixup_lock);
401 EXPORT_SYMBOL(phy_unregister_fixup);
403 /* Unregisters a fixup of any PHY with the UID in phy_uid */
404 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
406 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
408 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
410 /* Unregisters a fixup of the PHY with id string bus_id */
411 int phy_unregister_fixup_for_id(const char *bus_id)
413 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
415 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
417 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
418 * Fixups can be set to match any in one or more fields.
420 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
422 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
423 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
426 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
427 (phydev->phy_id & fixup->phy_uid_mask))
428 if (fixup->phy_uid != PHY_ANY_UID)
434 /* Runs any matching fixups for this phydev */
435 static int phy_scan_fixups(struct phy_device *phydev)
437 struct phy_fixup *fixup;
439 mutex_lock(&phy_fixup_lock);
440 list_for_each_entry(fixup, &phy_fixup_list, list) {
441 if (phy_needs_fixup(phydev, fixup)) {
442 int err = fixup->run(phydev);
445 mutex_unlock(&phy_fixup_lock);
448 phydev->has_fixups = true;
451 mutex_unlock(&phy_fixup_lock);
456 static int phy_bus_match(struct device *dev, struct device_driver *drv)
458 struct phy_device *phydev = to_phy_device(dev);
459 struct phy_driver *phydrv = to_phy_driver(drv);
460 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
463 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
466 if (phydrv->match_phy_device)
467 return phydrv->match_phy_device(phydev);
469 if (phydev->is_c45) {
470 for (i = 1; i < num_ids; i++) {
471 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
474 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
475 (phydev->c45_ids.device_ids[i] &
476 phydrv->phy_id_mask))
481 return (phydrv->phy_id & phydrv->phy_id_mask) ==
482 (phydev->phy_id & phydrv->phy_id_mask);
487 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
489 struct phy_device *phydev = to_phy_device(dev);
491 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
493 static DEVICE_ATTR_RO(phy_id);
496 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
498 struct phy_device *phydev = to_phy_device(dev);
499 const char *mode = NULL;
501 if (phy_is_internal(phydev))
504 mode = phy_modes(phydev->interface);
506 return sprintf(buf, "%s\n", mode);
508 static DEVICE_ATTR_RO(phy_interface);
511 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
514 struct phy_device *phydev = to_phy_device(dev);
516 return sprintf(buf, "%d\n", phydev->has_fixups);
518 static DEVICE_ATTR_RO(phy_has_fixups);
520 static ssize_t phy_dev_flags_show(struct device *dev,
521 struct device_attribute *attr,
524 struct phy_device *phydev = to_phy_device(dev);
526 return sprintf(buf, "0x%08x\n", phydev->dev_flags);
528 static DEVICE_ATTR_RO(phy_dev_flags);
530 static struct attribute *phy_dev_attrs[] = {
531 &dev_attr_phy_id.attr,
532 &dev_attr_phy_interface.attr,
533 &dev_attr_phy_has_fixups.attr,
534 &dev_attr_phy_dev_flags.attr,
537 ATTRIBUTE_GROUPS(phy_dev);
539 static const struct device_type mdio_bus_phy_type = {
541 .groups = phy_dev_groups,
542 .release = phy_device_release,
543 .pm = pm_ptr(&mdio_bus_phy_pm_ops),
546 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
550 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
551 MDIO_ID_ARGS(phy_id));
552 /* We only check for failures in executing the usermode binary,
553 * not whether a PHY driver module exists for the PHY ID.
554 * Accept -ENOENT because this may occur in case no initramfs exists,
555 * then modprobe isn't available.
557 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
558 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
559 ret, (unsigned long)phy_id);
566 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
568 struct phy_c45_device_ids *c45_ids)
570 struct phy_device *dev;
571 struct mdio_device *mdiodev;
574 /* We allocate the device, and initialize the default values */
575 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
577 return ERR_PTR(-ENOMEM);
579 mdiodev = &dev->mdio;
580 mdiodev->dev.parent = &bus->dev;
581 mdiodev->dev.bus = &mdio_bus_type;
582 mdiodev->dev.type = &mdio_bus_phy_type;
584 mdiodev->bus_match = phy_bus_match;
585 mdiodev->addr = addr;
586 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
587 mdiodev->device_free = phy_mdio_device_free;
588 mdiodev->device_remove = phy_mdio_device_remove;
590 dev->speed = SPEED_UNKNOWN;
591 dev->duplex = DUPLEX_UNKNOWN;
596 dev->interface = PHY_INTERFACE_MODE_GMII;
598 dev->autoneg = AUTONEG_ENABLE;
600 dev->is_c45 = is_c45;
601 dev->phy_id = phy_id;
603 dev->c45_ids = *c45_ids;
604 dev->irq = bus->irq[addr];
606 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
607 device_initialize(&mdiodev->dev);
609 dev->state = PHY_DOWN;
611 mutex_init(&dev->lock);
612 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
614 /* Request the appropriate module unconditionally; don't
615 * bother trying to do so only if it isn't already loaded,
616 * because that gets complicated. A hotplug event would have
617 * done an unconditional modprobe anyway.
618 * We don't do normal hotplug because it won't work for MDIO
619 * -- because it relies on the device staying around for long
620 * enough for the driver to get loaded. With MDIO, the NIC
621 * driver will get bored and give up as soon as it finds that
622 * there's no driver _already_ loaded.
624 if (is_c45 && c45_ids) {
625 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
628 for (i = 1; i < num_ids; i++) {
629 if (c45_ids->device_ids[i] == 0xffffffff)
632 ret = phy_request_driver_module(dev,
633 c45_ids->device_ids[i]);
638 ret = phy_request_driver_module(dev, phy_id);
642 put_device(&mdiodev->dev);
648 EXPORT_SYMBOL(phy_device_create);
650 /* phy_c45_probe_present - checks to see if a MMD is present in the package
651 * @bus: the target MII bus
652 * @prtad: PHY package address on the MII bus
653 * @devad: PHY device (MMD) address
655 * Read the MDIO_STAT2 register, and check whether a device is responding
658 * Returns: negative error number on bus access error, zero if no device
659 * is responding, or positive if a device is present.
661 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
665 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
669 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
672 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
673 * @bus: the target MII bus
674 * @addr: PHY address on the MII bus
675 * @dev_addr: MMD address in the PHY.
676 * @devices_in_package: where to store the devices in package information.
678 * Description: reads devices in package registers of a MMD at @dev_addr
679 * from PHY at @addr on @bus.
681 * Returns: 0 on success, -EIO on failure.
683 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
684 u32 *devices_in_package)
688 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
691 *devices_in_package = phy_reg << 16;
693 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
696 *devices_in_package |= phy_reg;
702 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
703 * @bus: the target MII bus
704 * @addr: PHY address on the MII bus
705 * @c45_ids: where to store the c45 ID information.
707 * Read the PHY "devices in package". If this appears to be valid, read
708 * the PHY identifiers for each device. Return the "devices in package"
709 * and identifiers in @c45_ids.
711 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
712 * the "devices in package" is invalid.
714 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
715 struct phy_c45_device_ids *c45_ids)
717 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
721 /* Find first non-zero Devices In package. Device zero is reserved
722 * for 802.3 c45 complied PHYs, so don't probe it at first.
724 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
725 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
726 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
727 /* Check that there is a device present at this
728 * address before reading the devices-in-package
729 * register to avoid reading garbage from the PHY.
730 * Some PHYs (88x3310) vendor space is not IEEE802.3
733 ret = phy_c45_probe_present(bus, addr, i);
740 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
745 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
746 /* If mostly Fs, there is no device there, then let's probe
747 * MMD 0, as some 10G PHYs have zero Devices In package,
748 * e.g. Cortina CS4315/CS4340 PHY.
750 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
754 /* no device there, let's get out of here */
755 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
759 /* Now probe Device Identifiers for each device present. */
760 for (i = 1; i < num_ids; i++) {
761 if (!(devs_in_pkg & (1 << i)))
764 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
765 /* Probe the "Device Present" bits for the vendor MMDs
766 * to ignore these if they do not contain IEEE 802.3
769 ret = phy_c45_probe_present(bus, addr, i);
777 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
780 c45_ids->device_ids[i] = phy_reg << 16;
782 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
785 c45_ids->device_ids[i] |= phy_reg;
788 c45_ids->devices_in_package = devs_in_pkg;
789 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
790 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
796 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
797 * @bus: the target MII bus
798 * @addr: PHY address on the MII bus
799 * @phy_id: where to store the ID retrieved.
801 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
802 * placing it in @phy_id. Return zero on successful read and the ID is
803 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
806 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
810 /* Grab the bits from PHYIR1, and put them in the upper half */
811 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
813 /* returning -ENODEV doesn't stop bus scanning */
814 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
817 *phy_id = phy_reg << 16;
819 /* Grab the bits from PHYIR2, and put them in the lower half */
820 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
822 /* returning -ENODEV doesn't stop bus scanning */
823 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
828 /* If the phy_id is mostly Fs, there is no device there */
829 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
835 /* Extract the phy ID from the compatible string of the form
836 * ethernet-phy-idAAAA.BBBB.
838 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
840 unsigned int upper, lower;
844 ret = fwnode_property_read_string(fwnode, "compatible", &cp);
848 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) != 2)
851 *phy_id = ((upper & GENMASK(15, 0)) << 16) | (lower & GENMASK(15, 0));
854 EXPORT_SYMBOL(fwnode_get_phy_id);
857 * get_phy_device - reads the specified PHY device and returns its @phy_device
859 * @bus: the target MII bus
860 * @addr: PHY address on the MII bus
861 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
863 * Probe for a PHY at @addr on @bus.
865 * When probing for a clause 22 PHY, then read the ID registers. If we find
866 * a valid ID, allocate and return a &struct phy_device.
868 * When probing for a clause 45 PHY, read the "devices in package" registers.
869 * If the "devices in package" appears valid, read the ID registers for each
870 * MMD, allocate and return a &struct phy_device.
872 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
873 * no PHY present, or %-EIO on bus access error.
875 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
877 struct phy_c45_device_ids c45_ids;
881 c45_ids.devices_in_package = 0;
882 c45_ids.mmds_present = 0;
883 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
886 r = get_phy_c45_ids(bus, addr, &c45_ids);
888 r = get_phy_c22_id(bus, addr, &phy_id);
893 /* PHY device such as the Marvell Alaska 88E2110 will return a PHY ID
894 * of 0 when probed using get_phy_c22_id() with no error. Proceed to
895 * probe with C45 to see if we're able to get a valid PHY ID in the C45
896 * space, if successful, create the C45 PHY device.
898 if (!is_c45 && phy_id == 0 && bus->probe_capabilities >= MDIOBUS_C45) {
899 r = get_phy_c45_ids(bus, addr, &c45_ids);
901 return phy_device_create(bus, addr, phy_id,
905 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
907 EXPORT_SYMBOL(get_phy_device);
910 * phy_device_register - Register the phy device on the MDIO bus
911 * @phydev: phy_device structure to be added to the MDIO bus
913 int phy_device_register(struct phy_device *phydev)
917 err = mdiobus_register_device(&phydev->mdio);
921 /* Deassert the reset signal */
922 phy_device_reset(phydev, 0);
924 /* Run all of the fixups for this PHY */
925 err = phy_scan_fixups(phydev);
927 phydev_err(phydev, "failed to initialize\n");
931 err = device_add(&phydev->mdio.dev);
933 phydev_err(phydev, "failed to add\n");
940 /* Assert the reset signal */
941 phy_device_reset(phydev, 1);
943 mdiobus_unregister_device(&phydev->mdio);
946 EXPORT_SYMBOL(phy_device_register);
949 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
950 * @phydev: phy_device structure to remove
952 * This doesn't free the phy_device itself, it merely reverses the effects
953 * of phy_device_register(). Use phy_device_free() to free the device
954 * after calling this function.
956 void phy_device_remove(struct phy_device *phydev)
958 unregister_mii_timestamper(phydev->mii_ts);
960 device_del(&phydev->mdio.dev);
962 /* Assert the reset signal */
963 phy_device_reset(phydev, 1);
965 mdiobus_unregister_device(&phydev->mdio);
967 EXPORT_SYMBOL(phy_device_remove);
970 * phy_get_c45_ids - Read 802.3-c45 IDs for phy device.
971 * @phydev: phy_device structure to read 802.3-c45 IDs
973 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
974 * the "devices in package" is invalid.
976 int phy_get_c45_ids(struct phy_device *phydev)
978 return get_phy_c45_ids(phydev->mdio.bus, phydev->mdio.addr,
981 EXPORT_SYMBOL(phy_get_c45_ids);
984 * phy_find_first - finds the first PHY device on the bus
985 * @bus: the target MII bus
987 struct phy_device *phy_find_first(struct mii_bus *bus)
989 struct phy_device *phydev;
992 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
993 phydev = mdiobus_get_phy(bus, addr);
999 EXPORT_SYMBOL(phy_find_first);
1001 static void phy_link_change(struct phy_device *phydev, bool up)
1003 struct net_device *netdev = phydev->attached_dev;
1006 netif_carrier_on(netdev);
1008 netif_carrier_off(netdev);
1009 phydev->adjust_link(netdev);
1010 if (phydev->mii_ts && phydev->mii_ts->link_state)
1011 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
1015 * phy_prepare_link - prepares the PHY layer to monitor link status
1016 * @phydev: target phy_device struct
1017 * @handler: callback function for link status change notifications
1019 * Description: Tells the PHY infrastructure to handle the
1020 * gory details on monitoring link status (whether through
1021 * polling or an interrupt), and to call back to the
1022 * connected device driver when the link status changes.
1023 * If you want to monitor your own link state, don't call
1026 static void phy_prepare_link(struct phy_device *phydev,
1027 void (*handler)(struct net_device *))
1029 phydev->adjust_link = handler;
1033 * phy_connect_direct - connect an ethernet device to a specific phy_device
1034 * @dev: the network device to connect
1035 * @phydev: the pointer to the phy device
1036 * @handler: callback function for state change notifications
1037 * @interface: PHY device's interface
1039 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1040 void (*handler)(struct net_device *),
1041 phy_interface_t interface)
1048 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1052 phy_prepare_link(phydev, handler);
1053 if (phy_interrupt_is_valid(phydev))
1054 phy_request_interrupt(phydev);
1058 EXPORT_SYMBOL(phy_connect_direct);
1061 * phy_connect - connect an ethernet device to a PHY device
1062 * @dev: the network device to connect
1063 * @bus_id: the id string of the PHY device to connect
1064 * @handler: callback function for state change notifications
1065 * @interface: PHY device's interface
1067 * Description: Convenience function for connecting ethernet
1068 * devices to PHY devices. The default behavior is for
1069 * the PHY infrastructure to handle everything, and only notify
1070 * the connected driver when the link status changes. If you
1071 * don't want, or can't use the provided functionality, you may
1072 * choose to call only the subset of functions which provide
1073 * the desired functionality.
1075 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1076 void (*handler)(struct net_device *),
1077 phy_interface_t interface)
1079 struct phy_device *phydev;
1083 /* Search the list of PHY devices on the mdio bus for the
1084 * PHY with the requested name
1086 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1088 pr_err("PHY %s not found\n", bus_id);
1089 return ERR_PTR(-ENODEV);
1091 phydev = to_phy_device(d);
1093 rc = phy_connect_direct(dev, phydev, handler, interface);
1100 EXPORT_SYMBOL(phy_connect);
1103 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1105 * @phydev: target phy_device struct
1107 void phy_disconnect(struct phy_device *phydev)
1109 if (phy_is_started(phydev))
1112 if (phy_interrupt_is_valid(phydev))
1113 phy_free_interrupt(phydev);
1115 phydev->adjust_link = NULL;
1119 EXPORT_SYMBOL(phy_disconnect);
1122 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1123 * @phydev: The PHY device to poll
1125 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1126 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1127 * register must be polled until the BMCR_RESET bit clears.
1129 * Furthermore, any attempts to write to PHY registers may have no effect
1130 * or even generate MDIO bus errors until this is complete.
1132 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1133 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1134 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1135 * effort to support such broken PHYs, this function is separate from the
1136 * standard phy_init_hw() which will zero all the other bits in the BMCR
1137 * and reapply all driver-specific and board-specific fixups.
1139 static int phy_poll_reset(struct phy_device *phydev)
1141 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1144 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1145 50000, 600000, true);
1148 /* Some chips (smsc911x) may still need up to another 1ms after the
1149 * BMCR_RESET bit is cleared before they are usable.
1155 int phy_init_hw(struct phy_device *phydev)
1159 /* Deassert the reset signal */
1160 phy_device_reset(phydev, 0);
1165 if (phydev->drv->soft_reset) {
1166 ret = phydev->drv->soft_reset(phydev);
1167 /* see comment in genphy_soft_reset for an explanation */
1169 phydev->suspended = 0;
1175 ret = phy_scan_fixups(phydev);
1179 if (phydev->drv->config_init) {
1180 ret = phydev->drv->config_init(phydev);
1185 if (phydev->drv->config_intr) {
1186 ret = phydev->drv->config_intr(phydev);
1193 EXPORT_SYMBOL(phy_init_hw);
1195 void phy_attached_info(struct phy_device *phydev)
1197 phy_attached_print(phydev, NULL);
1199 EXPORT_SYMBOL(phy_attached_info);
1201 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1202 char *phy_attached_info_irq(struct phy_device *phydev)
1207 switch(phydev->irq) {
1211 case PHY_MAC_INTERRUPT:
1215 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1220 return kasprintf(GFP_KERNEL, "%s", irq_str);
1222 EXPORT_SYMBOL(phy_attached_info_irq);
1224 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1226 const char *unbound = phydev->drv ? "" : "[unbound] ";
1227 char *irq_str = phy_attached_info_irq(phydev);
1230 phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1231 phydev_name(phydev), irq_str);
1235 phydev_info(phydev, ATTACHED_FMT, unbound,
1236 phydev_name(phydev), irq_str);
1244 EXPORT_SYMBOL(phy_attached_print);
1246 static void phy_sysfs_create_links(struct phy_device *phydev)
1248 struct net_device *dev = phydev->attached_dev;
1254 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1259 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1260 &phydev->mdio.dev.kobj,
1263 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1264 kobject_name(&phydev->mdio.dev.kobj),
1266 /* non-fatal - some net drivers can use one netdevice
1267 * with more then one phy
1271 phydev->sysfs_links = true;
1275 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1278 struct phy_device *phydev = to_phy_device(dev);
1280 return sprintf(buf, "%d\n", !phydev->attached_dev);
1282 static DEVICE_ATTR_RO(phy_standalone);
1285 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1286 * @upstream: pointer to the phy device
1287 * @bus: sfp bus representing cage being attached
1289 * This is used to fill in the sfp_upstream_ops .attach member.
1291 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1293 struct phy_device *phydev = upstream;
1295 if (phydev->attached_dev)
1296 phydev->attached_dev->sfp_bus = bus;
1297 phydev->sfp_bus_attached = true;
1299 EXPORT_SYMBOL(phy_sfp_attach);
1302 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1303 * @upstream: pointer to the phy device
1304 * @bus: sfp bus representing cage being attached
1306 * This is used to fill in the sfp_upstream_ops .detach member.
1308 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1310 struct phy_device *phydev = upstream;
1312 if (phydev->attached_dev)
1313 phydev->attached_dev->sfp_bus = NULL;
1314 phydev->sfp_bus_attached = false;
1316 EXPORT_SYMBOL(phy_sfp_detach);
1319 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1320 * @phydev: Pointer to phy_device
1321 * @ops: SFP's upstream operations
1323 int phy_sfp_probe(struct phy_device *phydev,
1324 const struct sfp_upstream_ops *ops)
1326 struct sfp_bus *bus;
1329 if (phydev->mdio.dev.fwnode) {
1330 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1332 return PTR_ERR(bus);
1334 phydev->sfp_bus = bus;
1336 ret = sfp_bus_add_upstream(bus, phydev, ops);
1341 EXPORT_SYMBOL(phy_sfp_probe);
1344 * phy_attach_direct - attach a network device to a given PHY device pointer
1345 * @dev: network device to attach
1346 * @phydev: Pointer to phy_device to attach
1347 * @flags: PHY device's dev_flags
1348 * @interface: PHY device's interface
1350 * Description: Called by drivers to attach to a particular PHY
1351 * device. The phy_device is found, and properly hooked up
1352 * to the phy_driver. If no driver is attached, then a
1353 * generic driver is used. The phy_device is given a ptr to
1354 * the attaching device, and given a callback for link status
1355 * change. The phy_device is returned to the attaching driver.
1356 * This function takes a reference on the phy device.
1358 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1359 u32 flags, phy_interface_t interface)
1361 struct mii_bus *bus = phydev->mdio.bus;
1362 struct device *d = &phydev->mdio.dev;
1363 struct module *ndev_owner = NULL;
1364 bool using_genphy = false;
1367 /* For Ethernet device drivers that register their own MDIO bus, we
1368 * will have bus->owner match ndev_mod, so we do not want to increment
1369 * our own module->refcnt here, otherwise we would not be able to
1373 ndev_owner = dev->dev.parent->driver->owner;
1374 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1375 phydev_err(phydev, "failed to get the bus module\n");
1381 /* Assume that if there is no driver, that it doesn't
1382 * exist, and we should use the genphy driver.
1386 d->driver = &genphy_c45_driver.mdiodrv.driver;
1388 d->driver = &genphy_driver.mdiodrv.driver;
1390 using_genphy = true;
1393 if (!try_module_get(d->driver->owner)) {
1394 phydev_err(phydev, "failed to get the device driver module\n");
1396 goto error_put_device;
1400 err = d->driver->probe(d);
1402 err = device_bind_driver(d);
1405 goto error_module_put;
1408 if (phydev->attached_dev) {
1409 dev_err(&dev->dev, "PHY already attached\n");
1414 phydev->phy_link_change = phy_link_change;
1416 phydev->attached_dev = dev;
1417 dev->phydev = phydev;
1419 if (phydev->sfp_bus_attached)
1420 dev->sfp_bus = phydev->sfp_bus;
1421 else if (dev->sfp_bus)
1422 phydev->is_on_sfp_module = true;
1425 /* Some Ethernet drivers try to connect to a PHY device before
1426 * calling register_netdevice() -> netdev_register_kobject() and
1427 * does the dev->dev.kobj initialization. Here we only check for
1428 * success which indicates that the network device kobject is
1429 * ready. Once we do that we still need to keep track of whether
1430 * links were successfully set up or not for phy_detach() to
1431 * remove them accordingly.
1433 phydev->sysfs_links = false;
1435 phy_sysfs_create_links(phydev);
1437 if (!phydev->attached_dev) {
1438 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1439 &dev_attr_phy_standalone.attr);
1441 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1444 phydev->dev_flags |= flags;
1446 phydev->interface = interface;
1448 phydev->state = PHY_READY;
1450 /* Port is set to PORT_TP by default and the actual PHY driver will set
1451 * it to different value depending on the PHY configuration. If we have
1452 * the generic PHY driver we can't figure it out, thus set the old
1453 * legacy PORT_MII value.
1456 phydev->port = PORT_MII;
1458 /* Initial carrier state is off as the phy is about to be
1462 netif_carrier_off(phydev->attached_dev);
1464 /* Do initial configuration here, now that
1465 * we have certain key parameters
1466 * (dev_flags and interface)
1468 err = phy_init_hw(phydev);
1472 err = phy_disable_interrupts(phydev);
1477 phy_led_triggers_register(phydev);
1482 /* phy_detach() does all of the cleanup below */
1487 module_put(d->driver->owner);
1490 if (ndev_owner != bus->owner)
1491 module_put(bus->owner);
1494 EXPORT_SYMBOL(phy_attach_direct);
1497 * phy_attach - attach a network device to a particular PHY device
1498 * @dev: network device to attach
1499 * @bus_id: Bus ID of PHY device to attach
1500 * @interface: PHY device's interface
1502 * Description: Same as phy_attach_direct() except that a PHY bus_id
1503 * string is passed instead of a pointer to a struct phy_device.
1505 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1506 phy_interface_t interface)
1508 struct bus_type *bus = &mdio_bus_type;
1509 struct phy_device *phydev;
1514 return ERR_PTR(-EINVAL);
1516 /* Search the list of PHY devices on the mdio bus for the
1517 * PHY with the requested name
1519 d = bus_find_device_by_name(bus, NULL, bus_id);
1521 pr_err("PHY %s not found\n", bus_id);
1522 return ERR_PTR(-ENODEV);
1524 phydev = to_phy_device(d);
1526 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1533 EXPORT_SYMBOL(phy_attach);
1535 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1536 struct device_driver *driver)
1538 struct device *d = &phydev->mdio.dev;
1545 ret = d->driver == driver;
1551 bool phy_driver_is_genphy(struct phy_device *phydev)
1553 return phy_driver_is_genphy_kind(phydev,
1554 &genphy_driver.mdiodrv.driver);
1556 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1558 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1560 return phy_driver_is_genphy_kind(phydev,
1561 &genphy_c45_driver.mdiodrv.driver);
1563 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1566 * phy_package_join - join a common PHY group
1567 * @phydev: target phy_device struct
1568 * @addr: cookie and PHY address for global register access
1569 * @priv_size: if non-zero allocate this amount of bytes for private data
1571 * This joins a PHY group and provides a shared storage for all phydevs in
1572 * this group. This is intended to be used for packages which contain
1573 * more than one PHY, for example a quad PHY transceiver.
1575 * The addr parameter serves as a cookie which has to have the same value
1576 * for all members of one group and as a PHY address to access generic
1577 * registers of a PHY package. Usually, one of the PHY addresses of the
1578 * different PHYs in the package provides access to these global registers.
1579 * The address which is given here, will be used in the phy_package_read()
1580 * and phy_package_write() convenience functions. If your PHY doesn't have
1581 * global registers you can just pick any of the PHY addresses.
1583 * This will set the shared pointer of the phydev to the shared storage.
1584 * If this is the first call for a this cookie the shared storage will be
1585 * allocated. If priv_size is non-zero, the given amount of bytes are
1586 * allocated for the priv member.
1588 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1589 * with the same cookie but a different priv_size is an error.
1591 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1593 struct mii_bus *bus = phydev->mdio.bus;
1594 struct phy_package_shared *shared;
1597 if (addr < 0 || addr >= PHY_MAX_ADDR)
1600 mutex_lock(&bus->shared_lock);
1601 shared = bus->shared[addr];
1604 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1608 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1611 shared->priv_size = priv_size;
1613 shared->addr = addr;
1614 refcount_set(&shared->refcnt, 1);
1615 bus->shared[addr] = shared;
1618 if (priv_size && priv_size != shared->priv_size)
1620 refcount_inc(&shared->refcnt);
1622 mutex_unlock(&bus->shared_lock);
1624 phydev->shared = shared;
1631 mutex_unlock(&bus->shared_lock);
1634 EXPORT_SYMBOL_GPL(phy_package_join);
1637 * phy_package_leave - leave a common PHY group
1638 * @phydev: target phy_device struct
1640 * This leaves a PHY group created by phy_package_join(). If this phydev
1641 * was the last user of the shared data between the group, this data is
1642 * freed. Resets the phydev->shared pointer to NULL.
1644 void phy_package_leave(struct phy_device *phydev)
1646 struct phy_package_shared *shared = phydev->shared;
1647 struct mii_bus *bus = phydev->mdio.bus;
1652 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1653 bus->shared[shared->addr] = NULL;
1654 mutex_unlock(&bus->shared_lock);
1655 kfree(shared->priv);
1659 phydev->shared = NULL;
1661 EXPORT_SYMBOL_GPL(phy_package_leave);
1663 static void devm_phy_package_leave(struct device *dev, void *res)
1665 phy_package_leave(*(struct phy_device **)res);
1669 * devm_phy_package_join - resource managed phy_package_join()
1670 * @dev: device that is registering this PHY package
1671 * @phydev: target phy_device struct
1672 * @addr: cookie and PHY address for global register access
1673 * @priv_size: if non-zero allocate this amount of bytes for private data
1675 * Managed phy_package_join(). Shared storage fetched by this function,
1676 * phy_package_leave() is automatically called on driver detach. See
1677 * phy_package_join() for more information.
1679 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1680 int addr, size_t priv_size)
1682 struct phy_device **ptr;
1685 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1690 ret = phy_package_join(phydev, addr, priv_size);
1694 devres_add(dev, ptr);
1701 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1704 * phy_detach - detach a PHY device from its network device
1705 * @phydev: target phy_device struct
1707 * This detaches the phy device from its network device and the phy
1708 * driver, and drops the reference count taken in phy_attach_direct().
1710 void phy_detach(struct phy_device *phydev)
1712 struct net_device *dev = phydev->attached_dev;
1713 struct module *ndev_owner = NULL;
1714 struct mii_bus *bus;
1716 if (phydev->sysfs_links) {
1718 sysfs_remove_link(&dev->dev.kobj, "phydev");
1719 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1722 if (!phydev->attached_dev)
1723 sysfs_remove_file(&phydev->mdio.dev.kobj,
1724 &dev_attr_phy_standalone.attr);
1726 phy_suspend(phydev);
1728 phydev->attached_dev->phydev = NULL;
1729 phydev->attached_dev = NULL;
1731 phydev->phylink = NULL;
1733 phy_led_triggers_unregister(phydev);
1735 if (phydev->mdio.dev.driver)
1736 module_put(phydev->mdio.dev.driver->owner);
1738 /* If the device had no specific driver before (i.e. - it
1739 * was using the generic driver), we unbind the device
1740 * from the generic driver so that there's a chance a
1741 * real driver could be loaded
1743 if (phy_driver_is_genphy(phydev) ||
1744 phy_driver_is_genphy_10g(phydev))
1745 device_release_driver(&phydev->mdio.dev);
1748 * The phydev might go away on the put_device() below, so avoid
1749 * a use-after-free bug by reading the underlying bus first.
1751 bus = phydev->mdio.bus;
1753 put_device(&phydev->mdio.dev);
1755 ndev_owner = dev->dev.parent->driver->owner;
1756 if (ndev_owner != bus->owner)
1757 module_put(bus->owner);
1759 /* Assert the reset signal */
1760 phy_device_reset(phydev, 1);
1762 EXPORT_SYMBOL(phy_detach);
1764 int phy_suspend(struct phy_device *phydev)
1766 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1767 struct net_device *netdev = phydev->attached_dev;
1768 struct phy_driver *phydrv = phydev->drv;
1771 if (phydev->suspended)
1774 /* If the device has WOL enabled, we cannot suspend the PHY */
1775 phy_ethtool_get_wol(phydev, &wol);
1776 if (wol.wolopts || (netdev && netdev->wol_enabled))
1779 if (!phydrv || !phydrv->suspend)
1782 ret = phydrv->suspend(phydev);
1784 phydev->suspended = true;
1788 EXPORT_SYMBOL(phy_suspend);
1790 int __phy_resume(struct phy_device *phydev)
1792 struct phy_driver *phydrv = phydev->drv;
1795 lockdep_assert_held(&phydev->lock);
1797 if (!phydrv || !phydrv->resume)
1800 ret = phydrv->resume(phydev);
1802 phydev->suspended = false;
1806 EXPORT_SYMBOL(__phy_resume);
1808 int phy_resume(struct phy_device *phydev)
1812 mutex_lock(&phydev->lock);
1813 ret = __phy_resume(phydev);
1814 mutex_unlock(&phydev->lock);
1818 EXPORT_SYMBOL(phy_resume);
1820 int phy_loopback(struct phy_device *phydev, bool enable)
1827 mutex_lock(&phydev->lock);
1829 if (enable && phydev->loopback_enabled) {
1834 if (!enable && !phydev->loopback_enabled) {
1839 if (phydev->drv->set_loopback)
1840 ret = phydev->drv->set_loopback(phydev, enable);
1842 ret = genphy_loopback(phydev, enable);
1847 phydev->loopback_enabled = enable;
1850 mutex_unlock(&phydev->lock);
1853 EXPORT_SYMBOL(phy_loopback);
1856 * phy_reset_after_clk_enable - perform a PHY reset if needed
1857 * @phydev: target phy_device struct
1859 * Description: Some PHYs are known to need a reset after their refclk was
1860 * enabled. This function evaluates the flags and perform the reset if it's
1861 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1864 int phy_reset_after_clk_enable(struct phy_device *phydev)
1866 if (!phydev || !phydev->drv)
1869 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1870 phy_device_reset(phydev, 1);
1871 phy_device_reset(phydev, 0);
1877 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1879 /* Generic PHY support and helper functions */
1882 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1883 * @phydev: target phy_device struct
1885 * Description: Writes MII_ADVERTISE with the appropriate values,
1886 * after sanitizing the values to make sure we only advertise
1887 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1888 * hasn't changed, and > 0 if it has changed.
1890 static int genphy_config_advert(struct phy_device *phydev)
1892 int err, bmsr, changed = 0;
1895 /* Only allow advertising what this PHY supports */
1896 linkmode_and(phydev->advertising, phydev->advertising,
1899 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1901 /* Setup standard advertisement */
1902 err = phy_modify_changed(phydev, MII_ADVERTISE,
1903 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1904 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1911 bmsr = phy_read(phydev, MII_BMSR);
1915 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1916 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1919 if (!(bmsr & BMSR_ESTATEN))
1922 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1924 err = phy_modify_changed(phydev, MII_CTRL1000,
1925 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1936 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1937 * @phydev: target phy_device struct
1939 * Description: Writes MII_ADVERTISE with the appropriate values,
1940 * after sanitizing the values to make sure we only advertise
1941 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1942 * hasn't changed, and > 0 if it has changed. This function is intended
1943 * for Clause 37 1000Base-X mode.
1945 static int genphy_c37_config_advert(struct phy_device *phydev)
1949 /* Only allow advertising what this PHY supports */
1950 linkmode_and(phydev->advertising, phydev->advertising,
1953 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1954 phydev->advertising))
1955 adv |= ADVERTISE_1000XFULL;
1956 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1957 phydev->advertising))
1958 adv |= ADVERTISE_1000XPAUSE;
1959 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1960 phydev->advertising))
1961 adv |= ADVERTISE_1000XPSE_ASYM;
1963 return phy_modify_changed(phydev, MII_ADVERTISE,
1964 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1965 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1970 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1971 * @phydev: target phy_device struct
1973 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1974 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1975 * changed, and 1 if it has changed.
1977 int genphy_config_eee_advert(struct phy_device *phydev)
1981 /* Nothing to disable */
1982 if (!phydev->eee_broken_modes)
1985 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1986 phydev->eee_broken_modes, 0);
1987 /* If the call failed, we assume that EEE is not supported */
1988 return err < 0 ? 0 : err;
1990 EXPORT_SYMBOL(genphy_config_eee_advert);
1993 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1994 * @phydev: target phy_device struct
1996 * Description: Configures MII_BMCR to force speed/duplex
1997 * to the values in phydev. Assumes that the values are valid.
1998 * Please see phy_sanitize_settings().
2000 int genphy_setup_forced(struct phy_device *phydev)
2005 phydev->asym_pause = 0;
2007 if (SPEED_1000 == phydev->speed)
2008 ctl |= BMCR_SPEED1000;
2009 else if (SPEED_100 == phydev->speed)
2010 ctl |= BMCR_SPEED100;
2012 if (DUPLEX_FULL == phydev->duplex)
2013 ctl |= BMCR_FULLDPLX;
2015 return phy_modify(phydev, MII_BMCR,
2016 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
2018 EXPORT_SYMBOL(genphy_setup_forced);
2020 static int genphy_setup_master_slave(struct phy_device *phydev)
2024 if (!phydev->is_gigabit_capable)
2027 switch (phydev->master_slave_set) {
2028 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
2029 ctl |= CTL1000_PREFER_MASTER;
2031 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
2033 case MASTER_SLAVE_CFG_MASTER_FORCE:
2034 ctl |= CTL1000_AS_MASTER;
2036 case MASTER_SLAVE_CFG_SLAVE_FORCE:
2037 ctl |= CTL1000_ENABLE_MASTER;
2039 case MASTER_SLAVE_CFG_UNKNOWN:
2040 case MASTER_SLAVE_CFG_UNSUPPORTED:
2043 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2047 return phy_modify_changed(phydev, MII_CTRL1000,
2048 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2049 CTL1000_PREFER_MASTER), ctl);
2052 static int genphy_read_master_slave(struct phy_device *phydev)
2057 if (!phydev->is_gigabit_capable) {
2058 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2059 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2063 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2064 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2066 val = phy_read(phydev, MII_CTRL1000);
2070 if (val & CTL1000_ENABLE_MASTER) {
2071 if (val & CTL1000_AS_MASTER)
2072 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2074 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2076 if (val & CTL1000_PREFER_MASTER)
2077 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2079 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2082 val = phy_read(phydev, MII_STAT1000);
2086 if (val & LPA_1000MSFAIL) {
2087 state = MASTER_SLAVE_STATE_ERR;
2088 } else if (phydev->link) {
2089 /* this bits are valid only for active link */
2090 if (val & LPA_1000MSRES)
2091 state = MASTER_SLAVE_STATE_MASTER;
2093 state = MASTER_SLAVE_STATE_SLAVE;
2095 state = MASTER_SLAVE_STATE_UNKNOWN;
2098 phydev->master_slave_get = cfg;
2099 phydev->master_slave_state = state;
2105 * genphy_restart_aneg - Enable and Restart Autonegotiation
2106 * @phydev: target phy_device struct
2108 int genphy_restart_aneg(struct phy_device *phydev)
2110 /* Don't isolate the PHY if we're negotiating */
2111 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2112 BMCR_ANENABLE | BMCR_ANRESTART);
2114 EXPORT_SYMBOL(genphy_restart_aneg);
2117 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2118 * @phydev: target phy_device struct
2119 * @restart: whether aneg restart is requested
2121 * Check, and restart auto-negotiation if needed.
2123 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2128 /* Advertisement hasn't changed, but maybe aneg was never on to
2129 * begin with? Or maybe phy was isolated?
2131 ret = phy_read(phydev, MII_BMCR);
2135 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2140 return genphy_restart_aneg(phydev);
2144 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2147 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2148 * @phydev: target phy_device struct
2149 * @changed: whether autoneg is requested
2151 * Description: If auto-negotiation is enabled, we configure the
2152 * advertising, and then restart auto-negotiation. If it is not
2153 * enabled, then we write the BMCR.
2155 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2159 if (genphy_config_eee_advert(phydev))
2162 err = genphy_setup_master_slave(phydev);
2168 if (AUTONEG_ENABLE != phydev->autoneg)
2169 return genphy_setup_forced(phydev);
2171 err = genphy_config_advert(phydev);
2172 if (err < 0) /* error */
2177 return genphy_check_and_restart_aneg(phydev, changed);
2179 EXPORT_SYMBOL(__genphy_config_aneg);
2182 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2183 * @phydev: target phy_device struct
2185 * Description: If auto-negotiation is enabled, we configure the
2186 * advertising, and then restart auto-negotiation. If it is not
2187 * enabled, then we write the BMCR. This function is intended
2188 * for use with Clause 37 1000Base-X mode.
2190 int genphy_c37_config_aneg(struct phy_device *phydev)
2194 if (phydev->autoneg != AUTONEG_ENABLE)
2195 return genphy_setup_forced(phydev);
2197 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2202 changed = genphy_c37_config_advert(phydev);
2203 if (changed < 0) /* error */
2207 /* Advertisement hasn't changed, but maybe aneg was never on to
2208 * begin with? Or maybe phy was isolated?
2210 int ctl = phy_read(phydev, MII_BMCR);
2215 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2216 changed = 1; /* do restart aneg */
2219 /* Only restart aneg if we are advertising something different
2220 * than we were before.
2223 return genphy_restart_aneg(phydev);
2227 EXPORT_SYMBOL(genphy_c37_config_aneg);
2230 * genphy_aneg_done - return auto-negotiation status
2231 * @phydev: target phy_device struct
2233 * Description: Reads the status register and returns 0 either if
2234 * auto-negotiation is incomplete, or if there was an error.
2235 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2237 int genphy_aneg_done(struct phy_device *phydev)
2239 int retval = phy_read(phydev, MII_BMSR);
2241 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2243 EXPORT_SYMBOL(genphy_aneg_done);
2246 * genphy_update_link - update link status in @phydev
2247 * @phydev: target phy_device struct
2249 * Description: Update the value in phydev->link to reflect the
2250 * current link value. In order to do this, we need to read
2251 * the status register twice, keeping the second value.
2253 int genphy_update_link(struct phy_device *phydev)
2255 int status = 0, bmcr;
2257 bmcr = phy_read(phydev, MII_BMCR);
2261 /* Autoneg is being started, therefore disregard BMSR value and
2262 * report link as down.
2264 if (bmcr & BMCR_ANRESTART)
2267 /* The link state is latched low so that momentary link
2268 * drops can be detected. Do not double-read the status
2269 * in polling mode to detect such short link drops except
2270 * the link was already down.
2272 if (!phy_polling_mode(phydev) || !phydev->link) {
2273 status = phy_read(phydev, MII_BMSR);
2276 else if (status & BMSR_LSTATUS)
2280 /* Read link and autonegotiation status */
2281 status = phy_read(phydev, MII_BMSR);
2285 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2286 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2288 /* Consider the case that autoneg was started and "aneg complete"
2289 * bit has been reset, but "link up" bit not yet.
2291 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2296 EXPORT_SYMBOL(genphy_update_link);
2298 int genphy_read_lpa(struct phy_device *phydev)
2302 if (phydev->autoneg == AUTONEG_ENABLE) {
2303 if (!phydev->autoneg_complete) {
2304 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2306 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2310 if (phydev->is_gigabit_capable) {
2311 lpagb = phy_read(phydev, MII_STAT1000);
2315 if (lpagb & LPA_1000MSFAIL) {
2316 int adv = phy_read(phydev, MII_CTRL1000);
2321 if (adv & CTL1000_ENABLE_MASTER)
2322 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2324 phydev_err(phydev, "Master/Slave resolution failed\n");
2328 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2332 lpa = phy_read(phydev, MII_LPA);
2336 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2338 linkmode_zero(phydev->lp_advertising);
2343 EXPORT_SYMBOL(genphy_read_lpa);
2346 * genphy_read_status_fixed - read the link parameters for !aneg mode
2347 * @phydev: target phy_device struct
2349 * Read the current duplex and speed state for a PHY operating with
2350 * autonegotiation disabled.
2352 int genphy_read_status_fixed(struct phy_device *phydev)
2354 int bmcr = phy_read(phydev, MII_BMCR);
2359 if (bmcr & BMCR_FULLDPLX)
2360 phydev->duplex = DUPLEX_FULL;
2362 phydev->duplex = DUPLEX_HALF;
2364 if (bmcr & BMCR_SPEED1000)
2365 phydev->speed = SPEED_1000;
2366 else if (bmcr & BMCR_SPEED100)
2367 phydev->speed = SPEED_100;
2369 phydev->speed = SPEED_10;
2373 EXPORT_SYMBOL(genphy_read_status_fixed);
2376 * genphy_read_status - check the link status and update current link state
2377 * @phydev: target phy_device struct
2379 * Description: Check the link, then figure out the current state
2380 * by comparing what we advertise with what the link partner
2381 * advertises. Start by checking the gigabit possibilities,
2382 * then move on to 10/100.
2384 int genphy_read_status(struct phy_device *phydev)
2386 int err, old_link = phydev->link;
2388 /* Update the link, but return if there was an error */
2389 err = genphy_update_link(phydev);
2393 /* why bother the PHY if nothing can have changed */
2394 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2397 phydev->speed = SPEED_UNKNOWN;
2398 phydev->duplex = DUPLEX_UNKNOWN;
2400 phydev->asym_pause = 0;
2402 err = genphy_read_master_slave(phydev);
2406 err = genphy_read_lpa(phydev);
2410 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2411 phy_resolve_aneg_linkmode(phydev);
2412 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2413 err = genphy_read_status_fixed(phydev);
2420 EXPORT_SYMBOL(genphy_read_status);
2423 * genphy_c37_read_status - check the link status and update current link state
2424 * @phydev: target phy_device struct
2426 * Description: Check the link, then figure out the current state
2427 * by comparing what we advertise with what the link partner
2428 * advertises. This function is for Clause 37 1000Base-X mode.
2430 int genphy_c37_read_status(struct phy_device *phydev)
2432 int lpa, err, old_link = phydev->link;
2434 /* Update the link, but return if there was an error */
2435 err = genphy_update_link(phydev);
2439 /* why bother the PHY if nothing can have changed */
2440 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2443 phydev->duplex = DUPLEX_UNKNOWN;
2445 phydev->asym_pause = 0;
2447 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2448 lpa = phy_read(phydev, MII_LPA);
2452 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2453 phydev->lp_advertising, lpa & LPA_LPACK);
2454 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2455 phydev->lp_advertising, lpa & LPA_1000XFULL);
2456 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2457 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2458 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2459 phydev->lp_advertising,
2460 lpa & LPA_1000XPAUSE_ASYM);
2462 phy_resolve_aneg_linkmode(phydev);
2463 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2464 int bmcr = phy_read(phydev, MII_BMCR);
2469 if (bmcr & BMCR_FULLDPLX)
2470 phydev->duplex = DUPLEX_FULL;
2472 phydev->duplex = DUPLEX_HALF;
2477 EXPORT_SYMBOL(genphy_c37_read_status);
2480 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2481 * @phydev: target phy_device struct
2483 * Description: Perform a software PHY reset using the standard
2484 * BMCR_RESET bit and poll for the reset bit to be cleared.
2486 * Returns: 0 on success, < 0 on failure
2488 int genphy_soft_reset(struct phy_device *phydev)
2490 u16 res = BMCR_RESET;
2493 if (phydev->autoneg == AUTONEG_ENABLE)
2494 res |= BMCR_ANRESTART;
2496 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2500 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2501 * to their default value. Therefore the POWER DOWN bit is supposed to
2502 * be cleared after soft reset.
2504 phydev->suspended = 0;
2506 ret = phy_poll_reset(phydev);
2510 /* BMCR may be reset to defaults */
2511 if (phydev->autoneg == AUTONEG_DISABLE)
2512 ret = genphy_setup_forced(phydev);
2516 EXPORT_SYMBOL(genphy_soft_reset);
2518 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2520 /* It seems there are cases where the interrupts are handled by another
2521 * entity (ie an IRQ controller embedded inside the PHY) and do not
2522 * need any other interraction from phylib. In this case, just trigger
2523 * the state machine directly.
2525 phy_trigger_machine(phydev);
2529 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2532 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2533 * @phydev: target phy_device struct
2535 * Description: Reads the PHY's abilities and populates
2536 * phydev->supported accordingly.
2538 * Returns: 0 on success, < 0 on failure
2540 int genphy_read_abilities(struct phy_device *phydev)
2544 linkmode_set_bit_array(phy_basic_ports_array,
2545 ARRAY_SIZE(phy_basic_ports_array),
2548 val = phy_read(phydev, MII_BMSR);
2552 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2553 val & BMSR_ANEGCAPABLE);
2555 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2556 val & BMSR_100FULL);
2557 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2558 val & BMSR_100HALF);
2559 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2561 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2564 if (val & BMSR_ESTATEN) {
2565 val = phy_read(phydev, MII_ESTATUS);
2569 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2570 phydev->supported, val & ESTATUS_1000_TFULL);
2571 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2572 phydev->supported, val & ESTATUS_1000_THALF);
2573 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2574 phydev->supported, val & ESTATUS_1000_XFULL);
2579 EXPORT_SYMBOL(genphy_read_abilities);
2581 /* This is used for the phy device which doesn't support the MMD extended
2582 * register access, but it does have side effect when we are trying to access
2583 * the MMD register via indirect method.
2585 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2589 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2591 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2592 u16 regnum, u16 val)
2596 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2598 int genphy_suspend(struct phy_device *phydev)
2600 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2602 EXPORT_SYMBOL(genphy_suspend);
2604 int genphy_resume(struct phy_device *phydev)
2606 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2608 EXPORT_SYMBOL(genphy_resume);
2610 int genphy_loopback(struct phy_device *phydev, bool enable)
2613 u16 val, ctl = BMCR_LOOPBACK;
2616 if (phydev->speed == SPEED_1000)
2617 ctl |= BMCR_SPEED1000;
2618 else if (phydev->speed == SPEED_100)
2619 ctl |= BMCR_SPEED100;
2621 if (phydev->duplex == DUPLEX_FULL)
2622 ctl |= BMCR_FULLDPLX;
2624 phy_modify(phydev, MII_BMCR, ~0, ctl);
2626 ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2628 5000, 500000, true);
2632 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2634 phy_config_aneg(phydev);
2639 EXPORT_SYMBOL(genphy_loopback);
2642 * phy_remove_link_mode - Remove a supported link mode
2643 * @phydev: phy_device structure to remove link mode from
2644 * @link_mode: Link mode to be removed
2646 * Description: Some MACs don't support all link modes which the PHY
2647 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2648 * to remove a link mode.
2650 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2652 linkmode_clear_bit(link_mode, phydev->supported);
2653 phy_advertise_supported(phydev);
2655 EXPORT_SYMBOL(phy_remove_link_mode);
2657 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2659 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2660 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2661 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2662 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2666 * phy_advertise_supported - Advertise all supported modes
2667 * @phydev: target phy_device struct
2669 * Description: Called to advertise all supported modes, doesn't touch
2670 * pause mode advertising.
2672 void phy_advertise_supported(struct phy_device *phydev)
2674 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2676 linkmode_copy(new, phydev->supported);
2677 phy_copy_pause_bits(new, phydev->advertising);
2678 linkmode_copy(phydev->advertising, new);
2680 EXPORT_SYMBOL(phy_advertise_supported);
2683 * phy_support_sym_pause - Enable support of symmetrical pause
2684 * @phydev: target phy_device struct
2686 * Description: Called by the MAC to indicate is supports symmetrical
2687 * Pause, but not asym pause.
2689 void phy_support_sym_pause(struct phy_device *phydev)
2691 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2692 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2694 EXPORT_SYMBOL(phy_support_sym_pause);
2697 * phy_support_asym_pause - Enable support of asym pause
2698 * @phydev: target phy_device struct
2700 * Description: Called by the MAC to indicate is supports Asym Pause.
2702 void phy_support_asym_pause(struct phy_device *phydev)
2704 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2706 EXPORT_SYMBOL(phy_support_asym_pause);
2709 * phy_set_sym_pause - Configure symmetric Pause
2710 * @phydev: target phy_device struct
2711 * @rx: Receiver Pause is supported
2712 * @tx: Transmit Pause is supported
2713 * @autoneg: Auto neg should be used
2715 * Description: Configure advertised Pause support depending on if
2716 * receiver pause and pause auto neg is supported. Generally called
2717 * from the set_pauseparam .ndo.
2719 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2722 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2724 if (rx && tx && autoneg)
2725 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2728 linkmode_copy(phydev->advertising, phydev->supported);
2730 EXPORT_SYMBOL(phy_set_sym_pause);
2733 * phy_set_asym_pause - Configure Pause and Asym Pause
2734 * @phydev: target phy_device struct
2735 * @rx: Receiver Pause is supported
2736 * @tx: Transmit Pause is supported
2738 * Description: Configure advertised Pause support depending on if
2739 * transmit and receiver pause is supported. If there has been a
2740 * change in adverting, trigger a new autoneg. Generally called from
2741 * the set_pauseparam .ndo.
2743 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2745 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2747 linkmode_copy(oldadv, phydev->advertising);
2748 linkmode_set_pause(phydev->advertising, tx, rx);
2750 if (!linkmode_equal(oldadv, phydev->advertising) &&
2752 phy_start_aneg(phydev);
2754 EXPORT_SYMBOL(phy_set_asym_pause);
2757 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2758 * @phydev: phy_device struct
2759 * @pp: requested pause configuration
2761 * Description: Test if the PHY/MAC combination supports the Pause
2762 * configuration the user is requesting. Returns True if it is
2763 * supported, false otherwise.
2765 bool phy_validate_pause(struct phy_device *phydev,
2766 struct ethtool_pauseparam *pp)
2768 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2769 phydev->supported) && pp->rx_pause)
2772 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2773 phydev->supported) &&
2774 pp->rx_pause != pp->tx_pause)
2779 EXPORT_SYMBOL(phy_validate_pause);
2782 * phy_get_pause - resolve negotiated pause modes
2783 * @phydev: phy_device struct
2784 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2786 * @rx_pause: pointer to bool to indicate whether receive pause should be
2789 * Resolve and return the flow control modes according to the negotiation
2790 * result. This includes checking that we are operating in full duplex mode.
2791 * See linkmode_resolve_pause() for further details.
2793 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2795 if (phydev->duplex != DUPLEX_FULL) {
2801 return linkmode_resolve_pause(phydev->advertising,
2802 phydev->lp_advertising,
2803 tx_pause, rx_pause);
2805 EXPORT_SYMBOL(phy_get_pause);
2807 #if IS_ENABLED(CONFIG_OF_MDIO)
2808 static int phy_get_int_delay_property(struct device *dev, const char *name)
2813 ret = device_property_read_u32(dev, name, &int_delay);
2820 static int phy_get_int_delay_property(struct device *dev, const char *name)
2827 * phy_get_internal_delay - returns the index of the internal delay
2828 * @phydev: phy_device struct
2829 * @dev: pointer to the devices device struct
2830 * @delay_values: array of delays the PHY supports
2831 * @size: the size of the delay array
2832 * @is_rx: boolean to indicate to get the rx internal delay
2834 * Returns the index within the array of internal delay passed in.
2835 * If the device property is not present then the interface type is checked
2836 * if the interface defines use of internal delay then a 1 is returned otherwise
2838 * The array must be in ascending order. If PHY does not have an ascending order
2839 * array then size = 0 and the value of the delay property is returned.
2840 * Return -EINVAL if the delay is invalid or cannot be found.
2842 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2843 const int *delay_values, int size, bool is_rx)
2849 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
2850 if (delay < 0 && size == 0) {
2851 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2852 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
2859 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
2860 if (delay < 0 && size == 0) {
2861 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2862 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
2872 if (delay && size == 0)
2875 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
2876 phydev_err(phydev, "Delay %d is out of range\n", delay);
2880 if (delay == delay_values[0])
2883 for (i = 1; i < size; i++) {
2884 if (delay == delay_values[i])
2887 /* Find an approximate index by looking up the table */
2888 if (delay > delay_values[i - 1] &&
2889 delay < delay_values[i]) {
2890 if (delay - delay_values[i - 1] <
2891 delay_values[i] - delay)
2898 phydev_err(phydev, "error finding internal delay index for %d\n",
2903 EXPORT_SYMBOL(phy_get_internal_delay);
2905 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2907 return phydrv->config_intr && phydrv->handle_interrupt;
2911 * fwnode_mdio_find_device - Given a fwnode, find the mdio_device
2912 * @fwnode: pointer to the mdio_device's fwnode
2914 * If successful, returns a pointer to the mdio_device with the embedded
2915 * struct device refcount incremented by one, or NULL on failure.
2916 * The caller should call put_device() on the mdio_device after its use.
2918 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
2925 d = bus_find_device_by_fwnode(&mdio_bus_type, fwnode);
2929 return to_mdio_device(d);
2931 EXPORT_SYMBOL(fwnode_mdio_find_device);
2934 * fwnode_phy_find_device - For provided phy_fwnode, find phy_device.
2936 * @phy_fwnode: Pointer to the phy's fwnode.
2938 * If successful, returns a pointer to the phy_device with the embedded
2939 * struct device refcount incremented by one, or NULL on failure.
2941 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
2943 struct mdio_device *mdiodev;
2945 mdiodev = fwnode_mdio_find_device(phy_fwnode);
2949 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
2950 return to_phy_device(&mdiodev->dev);
2952 put_device(&mdiodev->dev);
2956 EXPORT_SYMBOL(fwnode_phy_find_device);
2959 * device_phy_find_device - For the given device, get the phy_device
2960 * @dev: Pointer to the given device
2962 * Refer return conditions of fwnode_phy_find_device().
2964 struct phy_device *device_phy_find_device(struct device *dev)
2966 return fwnode_phy_find_device(dev_fwnode(dev));
2968 EXPORT_SYMBOL_GPL(device_phy_find_device);
2971 * fwnode_get_phy_node - Get the phy_node using the named reference.
2972 * @fwnode: Pointer to fwnode from which phy_node has to be obtained.
2974 * Refer return conditions of fwnode_find_reference().
2975 * For ACPI, only "phy-handle" is supported. Legacy DT properties "phy"
2976 * and "phy-device" are not supported in ACPI. DT supports all the three
2977 * named references to the phy node.
2979 struct fwnode_handle *fwnode_get_phy_node(struct fwnode_handle *fwnode)
2981 struct fwnode_handle *phy_node;
2983 /* Only phy-handle is used for ACPI */
2984 phy_node = fwnode_find_reference(fwnode, "phy-handle", 0);
2985 if (is_acpi_node(fwnode) || !IS_ERR(phy_node))
2987 phy_node = fwnode_find_reference(fwnode, "phy", 0);
2988 if (IS_ERR(phy_node))
2989 phy_node = fwnode_find_reference(fwnode, "phy-device", 0);
2992 EXPORT_SYMBOL_GPL(fwnode_get_phy_node);
2995 * phy_probe - probe and init a PHY device
2996 * @dev: device to probe and init
2998 * Description: Take care of setting up the phy_device structure,
2999 * set the state to READY (the driver's init function should
3000 * set it to STARTING if needed).
3002 static int phy_probe(struct device *dev)
3004 struct phy_device *phydev = to_phy_device(dev);
3005 struct device_driver *drv = phydev->mdio.dev.driver;
3006 struct phy_driver *phydrv = to_phy_driver(drv);
3009 phydev->drv = phydrv;
3011 /* Disable the interrupt if the PHY doesn't support it
3012 * but the interrupt is still a valid one
3014 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
3015 phydev->irq = PHY_POLL;
3017 if (phydrv->flags & PHY_IS_INTERNAL)
3018 phydev->is_internal = true;
3020 mutex_lock(&phydev->lock);
3022 /* Deassert the reset signal */
3023 phy_device_reset(phydev, 0);
3025 if (phydev->drv->probe) {
3026 err = phydev->drv->probe(phydev);
3031 /* Start out supporting everything. Eventually,
3032 * a controller will attach, and may modify one
3033 * or both of these values
3035 if (phydrv->features)
3036 linkmode_copy(phydev->supported, phydrv->features);
3037 else if (phydrv->get_features)
3038 err = phydrv->get_features(phydev);
3039 else if (phydev->is_c45)
3040 err = genphy_c45_pma_read_abilities(phydev);
3042 err = genphy_read_abilities(phydev);
3047 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
3049 phydev->autoneg = 0;
3051 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
3053 phydev->is_gigabit_capable = 1;
3054 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
3056 phydev->is_gigabit_capable = 1;
3058 of_set_phy_supported(phydev);
3059 phy_advertise_supported(phydev);
3061 /* Get the EEE modes we want to prohibit. We will ask
3062 * the PHY stop advertising these mode later on
3064 of_set_phy_eee_broken(phydev);
3066 /* The Pause Frame bits indicate that the PHY can support passing
3067 * pause frames. During autonegotiation, the PHYs will determine if
3068 * they should allow pause frames to pass. The MAC driver should then
3069 * use that result to determine whether to enable flow control via
3072 * Normally, PHY drivers should not set the Pause bits, and instead
3073 * allow phylib to do that. However, there may be some situations
3074 * (e.g. hardware erratum) where the driver wants to set only one
3077 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
3078 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
3079 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3081 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3085 /* Set the state to READY by default */
3086 phydev->state = PHY_READY;
3089 /* Assert the reset signal */
3091 phy_device_reset(phydev, 1);
3093 mutex_unlock(&phydev->lock);
3098 static int phy_remove(struct device *dev)
3100 struct phy_device *phydev = to_phy_device(dev);
3102 cancel_delayed_work_sync(&phydev->state_queue);
3104 mutex_lock(&phydev->lock);
3105 phydev->state = PHY_DOWN;
3106 mutex_unlock(&phydev->lock);
3108 sfp_bus_del_upstream(phydev->sfp_bus);
3109 phydev->sfp_bus = NULL;
3111 if (phydev->drv && phydev->drv->remove)
3112 phydev->drv->remove(phydev);
3114 /* Assert the reset signal */
3115 phy_device_reset(phydev, 1);
3122 static void phy_shutdown(struct device *dev)
3124 struct phy_device *phydev = to_phy_device(dev);
3126 phy_disable_interrupts(phydev);
3130 * phy_driver_register - register a phy_driver with the PHY layer
3131 * @new_driver: new phy_driver to register
3132 * @owner: module owning this PHY
3134 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
3138 /* Either the features are hard coded, or dynamically
3139 * determined. It cannot be both.
3141 if (WARN_ON(new_driver->features && new_driver->get_features)) {
3142 pr_err("%s: features and get_features must not both be set\n",
3147 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3148 new_driver->mdiodrv.driver.name = new_driver->name;
3149 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3150 new_driver->mdiodrv.driver.probe = phy_probe;
3151 new_driver->mdiodrv.driver.remove = phy_remove;
3152 new_driver->mdiodrv.driver.shutdown = phy_shutdown;
3153 new_driver->mdiodrv.driver.owner = owner;
3154 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3156 retval = driver_register(&new_driver->mdiodrv.driver);
3158 pr_err("%s: Error %d in registering driver\n",
3159 new_driver->name, retval);
3164 pr_debug("%s: Registered new driver\n", new_driver->name);
3168 EXPORT_SYMBOL(phy_driver_register);
3170 int phy_drivers_register(struct phy_driver *new_driver, int n,
3171 struct module *owner)
3175 for (i = 0; i < n; i++) {
3176 ret = phy_driver_register(new_driver + i, owner);
3179 phy_driver_unregister(new_driver + i);
3185 EXPORT_SYMBOL(phy_drivers_register);
3187 void phy_driver_unregister(struct phy_driver *drv)
3189 driver_unregister(&drv->mdiodrv.driver);
3191 EXPORT_SYMBOL(phy_driver_unregister);
3193 void phy_drivers_unregister(struct phy_driver *drv, int n)
3197 for (i = 0; i < n; i++)
3198 phy_driver_unregister(drv + i);
3200 EXPORT_SYMBOL(phy_drivers_unregister);
3202 static struct phy_driver genphy_driver = {
3203 .phy_id = 0xffffffff,
3204 .phy_id_mask = 0xffffffff,
3205 .name = "Generic PHY",
3206 .get_features = genphy_read_abilities,
3207 .suspend = genphy_suspend,
3208 .resume = genphy_resume,
3209 .set_loopback = genphy_loopback,
3212 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3213 .get_sset_count = phy_ethtool_get_sset_count,
3214 .get_strings = phy_ethtool_get_strings,
3215 .get_stats = phy_ethtool_get_stats,
3216 .start_cable_test = phy_start_cable_test,
3217 .start_cable_test_tdr = phy_start_cable_test_tdr,
3220 static int __init phy_init(void)
3224 rc = mdio_bus_init();
3228 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3231 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3235 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3237 phy_driver_unregister(&genphy_c45_driver);
3245 static void __exit phy_exit(void)
3247 phy_driver_unregister(&genphy_c45_driver);
3248 phy_driver_unregister(&genphy_driver);
3250 ethtool_set_ethtool_phy_ops(NULL);
3253 subsys_initcall(phy_init);
3254 module_exit(phy_exit);