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/bitmap.h>
13 #include <linux/delay.h>
14 #include <linux/errno.h>
15 #include <linux/etherdevice.h>
16 #include <linux/ethtool.h>
17 #include <linux/init.h>
18 #include <linux/interrupt.h>
20 #include <linux/kernel.h>
21 #include <linux/mdio.h>
22 #include <linux/mii.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/phy.h>
27 #include <linux/phy_led_triggers.h>
28 #include <linux/property.h>
29 #include <linux/sfp.h>
30 #include <linux/skbuff.h>
31 #include <linux/slab.h>
32 #include <linux/string.h>
33 #include <linux/uaccess.h>
34 #include <linux/unistd.h>
36 MODULE_DESCRIPTION("PHY library");
37 MODULE_AUTHOR("Andy Fleming");
38 MODULE_LICENSE("GPL");
40 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
41 EXPORT_SYMBOL_GPL(phy_basic_features);
43 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
44 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
46 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
47 EXPORT_SYMBOL_GPL(phy_gbit_features);
49 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
50 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
52 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
53 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
55 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
56 EXPORT_SYMBOL_GPL(phy_10gbit_features);
58 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
59 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
61 const int phy_basic_ports_array[3] = {
62 ETHTOOL_LINK_MODE_Autoneg_BIT,
63 ETHTOOL_LINK_MODE_TP_BIT,
64 ETHTOOL_LINK_MODE_MII_BIT,
66 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
68 const int phy_fibre_port_array[1] = {
69 ETHTOOL_LINK_MODE_FIBRE_BIT,
71 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
73 const int phy_all_ports_features_array[7] = {
74 ETHTOOL_LINK_MODE_Autoneg_BIT,
75 ETHTOOL_LINK_MODE_TP_BIT,
76 ETHTOOL_LINK_MODE_MII_BIT,
77 ETHTOOL_LINK_MODE_FIBRE_BIT,
78 ETHTOOL_LINK_MODE_AUI_BIT,
79 ETHTOOL_LINK_MODE_BNC_BIT,
80 ETHTOOL_LINK_MODE_Backplane_BIT,
82 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
84 const int phy_10_100_features_array[4] = {
85 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
86 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
87 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
88 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
90 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
92 const int phy_basic_t1_features_array[2] = {
93 ETHTOOL_LINK_MODE_TP_BIT,
94 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
96 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
98 const int phy_gbit_features_array[2] = {
99 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
100 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
102 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
104 const int phy_10gbit_features_array[1] = {
105 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
107 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
109 static const int phy_10gbit_fec_features_array[1] = {
110 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
113 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
114 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
116 static const int phy_10gbit_full_features_array[] = {
117 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
118 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
120 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
123 static void features_init(void)
125 /* 10/100 half/full*/
126 linkmode_set_bit_array(phy_basic_ports_array,
127 ARRAY_SIZE(phy_basic_ports_array),
129 linkmode_set_bit_array(phy_10_100_features_array,
130 ARRAY_SIZE(phy_10_100_features_array),
134 linkmode_set_bit_array(phy_basic_t1_features_array,
135 ARRAY_SIZE(phy_basic_t1_features_array),
136 phy_basic_t1_features);
138 /* 10/100 half/full + 1000 half/full */
139 linkmode_set_bit_array(phy_basic_ports_array,
140 ARRAY_SIZE(phy_basic_ports_array),
142 linkmode_set_bit_array(phy_10_100_features_array,
143 ARRAY_SIZE(phy_10_100_features_array),
145 linkmode_set_bit_array(phy_gbit_features_array,
146 ARRAY_SIZE(phy_gbit_features_array),
149 /* 10/100 half/full + 1000 half/full + fibre*/
150 linkmode_set_bit_array(phy_basic_ports_array,
151 ARRAY_SIZE(phy_basic_ports_array),
152 phy_gbit_fibre_features);
153 linkmode_set_bit_array(phy_10_100_features_array,
154 ARRAY_SIZE(phy_10_100_features_array),
155 phy_gbit_fibre_features);
156 linkmode_set_bit_array(phy_gbit_features_array,
157 ARRAY_SIZE(phy_gbit_features_array),
158 phy_gbit_fibre_features);
159 linkmode_set_bit_array(phy_fibre_port_array,
160 ARRAY_SIZE(phy_fibre_port_array),
161 phy_gbit_fibre_features);
163 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
164 linkmode_set_bit_array(phy_all_ports_features_array,
165 ARRAY_SIZE(phy_all_ports_features_array),
166 phy_gbit_all_ports_features);
167 linkmode_set_bit_array(phy_10_100_features_array,
168 ARRAY_SIZE(phy_10_100_features_array),
169 phy_gbit_all_ports_features);
170 linkmode_set_bit_array(phy_gbit_features_array,
171 ARRAY_SIZE(phy_gbit_features_array),
172 phy_gbit_all_ports_features);
174 /* 10/100 half/full + 1000 half/full + 10G full*/
175 linkmode_set_bit_array(phy_all_ports_features_array,
176 ARRAY_SIZE(phy_all_ports_features_array),
177 phy_10gbit_features);
178 linkmode_set_bit_array(phy_10_100_features_array,
179 ARRAY_SIZE(phy_10_100_features_array),
180 phy_10gbit_features);
181 linkmode_set_bit_array(phy_gbit_features_array,
182 ARRAY_SIZE(phy_gbit_features_array),
183 phy_10gbit_features);
184 linkmode_set_bit_array(phy_10gbit_features_array,
185 ARRAY_SIZE(phy_10gbit_features_array),
186 phy_10gbit_features);
188 /* 10/100/1000/10G full */
189 linkmode_set_bit_array(phy_all_ports_features_array,
190 ARRAY_SIZE(phy_all_ports_features_array),
191 phy_10gbit_full_features);
192 linkmode_set_bit_array(phy_10gbit_full_features_array,
193 ARRAY_SIZE(phy_10gbit_full_features_array),
194 phy_10gbit_full_features);
196 linkmode_set_bit_array(phy_10gbit_fec_features_array,
197 ARRAY_SIZE(phy_10gbit_fec_features_array),
198 phy_10gbit_fec_features);
201 void phy_device_free(struct phy_device *phydev)
203 put_device(&phydev->mdio.dev);
205 EXPORT_SYMBOL(phy_device_free);
207 static void phy_mdio_device_free(struct mdio_device *mdiodev)
209 struct phy_device *phydev;
211 phydev = container_of(mdiodev, struct phy_device, mdio);
212 phy_device_free(phydev);
215 static void phy_device_release(struct device *dev)
217 kfree(to_phy_device(dev));
220 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
222 struct phy_device *phydev;
224 phydev = container_of(mdiodev, struct phy_device, mdio);
225 phy_device_remove(phydev);
228 static struct phy_driver genphy_driver;
230 static LIST_HEAD(phy_fixup_list);
231 static DEFINE_MUTEX(phy_fixup_lock);
233 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
235 struct device_driver *drv = phydev->mdio.dev.driver;
236 struct phy_driver *phydrv = to_phy_driver(drv);
237 struct net_device *netdev = phydev->attached_dev;
239 if (!drv || !phydrv->suspend)
242 /* PHY not attached? May suspend if the PHY has not already been
243 * suspended as part of a prior call to phy_disconnect() ->
244 * phy_detach() -> phy_suspend() because the parent netdev might be the
245 * MDIO bus driver and clock gated at this point.
250 if (netdev->wol_enabled)
253 /* As long as not all affected network drivers support the
254 * wol_enabled flag, let's check for hints that WoL is enabled.
255 * Don't suspend PHY if the attached netdev parent may wake up.
256 * The parent may point to a PCI device, as in tg3 driver.
258 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
261 /* Also don't suspend PHY if the netdev itself may wakeup. This
262 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
265 if (device_may_wakeup(&netdev->dev))
269 return !phydev->suspended;
272 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
274 struct phy_device *phydev = to_phy_device(dev);
276 /* We must stop the state machine manually, otherwise it stops out of
277 * control, possibly with the phydev->lock held. Upon resume, netdev
278 * may call phy routines that try to grab the same lock, and that may
279 * lead to a deadlock.
281 if (phydev->attached_dev && phydev->adjust_link)
282 phy_stop_machine(phydev);
284 if (!mdio_bus_phy_may_suspend(phydev))
287 phydev->suspended_by_mdio_bus = 1;
289 return phy_suspend(phydev);
292 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
294 struct phy_device *phydev = to_phy_device(dev);
297 if (!phydev->suspended_by_mdio_bus)
300 phydev->suspended_by_mdio_bus = 0;
302 ret = phy_init_hw(phydev);
306 ret = phy_resume(phydev);
310 if (phydev->attached_dev && phydev->adjust_link)
311 phy_start_machine(phydev);
316 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
317 mdio_bus_phy_resume);
320 * phy_register_fixup - creates a new phy_fixup and adds it to the list
321 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
322 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
323 * It can also be PHY_ANY_UID
324 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
326 * @run: The actual code to be run when a matching PHY is found
328 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
329 int (*run)(struct phy_device *))
331 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
336 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
337 fixup->phy_uid = phy_uid;
338 fixup->phy_uid_mask = phy_uid_mask;
341 mutex_lock(&phy_fixup_lock);
342 list_add_tail(&fixup->list, &phy_fixup_list);
343 mutex_unlock(&phy_fixup_lock);
347 EXPORT_SYMBOL(phy_register_fixup);
349 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
350 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
351 int (*run)(struct phy_device *))
353 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
355 EXPORT_SYMBOL(phy_register_fixup_for_uid);
357 /* Registers a fixup to be run on the PHY with id string bus_id */
358 int phy_register_fixup_for_id(const char *bus_id,
359 int (*run)(struct phy_device *))
361 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
363 EXPORT_SYMBOL(phy_register_fixup_for_id);
366 * phy_unregister_fixup - remove a phy_fixup from the list
367 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
368 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
369 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
371 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
373 struct list_head *pos, *n;
374 struct phy_fixup *fixup;
379 mutex_lock(&phy_fixup_lock);
380 list_for_each_safe(pos, n, &phy_fixup_list) {
381 fixup = list_entry(pos, struct phy_fixup, list);
383 if ((!strcmp(fixup->bus_id, bus_id)) &&
384 ((fixup->phy_uid & phy_uid_mask) ==
385 (phy_uid & phy_uid_mask))) {
386 list_del(&fixup->list);
392 mutex_unlock(&phy_fixup_lock);
396 EXPORT_SYMBOL(phy_unregister_fixup);
398 /* Unregisters a fixup of any PHY with the UID in phy_uid */
399 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
401 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
403 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
405 /* Unregisters a fixup of the PHY with id string bus_id */
406 int phy_unregister_fixup_for_id(const char *bus_id)
408 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
410 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
412 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
413 * Fixups can be set to match any in one or more fields.
415 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
417 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
418 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
421 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
422 (phydev->phy_id & fixup->phy_uid_mask))
423 if (fixup->phy_uid != PHY_ANY_UID)
429 /* Runs any matching fixups for this phydev */
430 static int phy_scan_fixups(struct phy_device *phydev)
432 struct phy_fixup *fixup;
434 mutex_lock(&phy_fixup_lock);
435 list_for_each_entry(fixup, &phy_fixup_list, list) {
436 if (phy_needs_fixup(phydev, fixup)) {
437 int err = fixup->run(phydev);
440 mutex_unlock(&phy_fixup_lock);
443 phydev->has_fixups = true;
446 mutex_unlock(&phy_fixup_lock);
451 static int phy_bus_match(struct device *dev, struct device_driver *drv)
453 struct phy_device *phydev = to_phy_device(dev);
454 struct phy_driver *phydrv = to_phy_driver(drv);
455 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
458 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
461 if (phydrv->match_phy_device)
462 return phydrv->match_phy_device(phydev);
464 if (phydev->is_c45) {
465 for (i = 1; i < num_ids; i++) {
466 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
469 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
470 (phydev->c45_ids.device_ids[i] &
471 phydrv->phy_id_mask))
476 return (phydrv->phy_id & phydrv->phy_id_mask) ==
477 (phydev->phy_id & phydrv->phy_id_mask);
482 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
484 struct phy_device *phydev = to_phy_device(dev);
486 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
488 static DEVICE_ATTR_RO(phy_id);
491 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
493 struct phy_device *phydev = to_phy_device(dev);
494 const char *mode = NULL;
496 if (phy_is_internal(phydev))
499 mode = phy_modes(phydev->interface);
501 return sprintf(buf, "%s\n", mode);
503 static DEVICE_ATTR_RO(phy_interface);
506 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
509 struct phy_device *phydev = to_phy_device(dev);
511 return sprintf(buf, "%d\n", phydev->has_fixups);
513 static DEVICE_ATTR_RO(phy_has_fixups);
515 static struct attribute *phy_dev_attrs[] = {
516 &dev_attr_phy_id.attr,
517 &dev_attr_phy_interface.attr,
518 &dev_attr_phy_has_fixups.attr,
521 ATTRIBUTE_GROUPS(phy_dev);
523 static const struct device_type mdio_bus_phy_type = {
525 .groups = phy_dev_groups,
526 .release = phy_device_release,
527 .pm = pm_ptr(&mdio_bus_phy_pm_ops),
530 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
534 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
535 MDIO_ID_ARGS(phy_id));
536 /* We only check for failures in executing the usermode binary,
537 * not whether a PHY driver module exists for the PHY ID.
538 * Accept -ENOENT because this may occur in case no initramfs exists,
539 * then modprobe isn't available.
541 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
542 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
543 ret, (unsigned long)phy_id);
550 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
552 struct phy_c45_device_ids *c45_ids)
554 struct phy_device *dev;
555 struct mdio_device *mdiodev;
558 /* We allocate the device, and initialize the default values */
559 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
561 return ERR_PTR(-ENOMEM);
563 mdiodev = &dev->mdio;
564 mdiodev->dev.parent = &bus->dev;
565 mdiodev->dev.bus = &mdio_bus_type;
566 mdiodev->dev.type = &mdio_bus_phy_type;
568 mdiodev->bus_match = phy_bus_match;
569 mdiodev->addr = addr;
570 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
571 mdiodev->device_free = phy_mdio_device_free;
572 mdiodev->device_remove = phy_mdio_device_remove;
574 dev->speed = SPEED_UNKNOWN;
575 dev->duplex = DUPLEX_UNKNOWN;
580 dev->interface = PHY_INTERFACE_MODE_GMII;
582 dev->autoneg = AUTONEG_ENABLE;
584 dev->is_c45 = is_c45;
585 dev->phy_id = phy_id;
587 dev->c45_ids = *c45_ids;
588 dev->irq = bus->irq[addr];
590 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
591 device_initialize(&mdiodev->dev);
593 dev->state = PHY_DOWN;
595 mutex_init(&dev->lock);
596 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
598 /* Request the appropriate module unconditionally; don't
599 * bother trying to do so only if it isn't already loaded,
600 * because that gets complicated. A hotplug event would have
601 * done an unconditional modprobe anyway.
602 * We don't do normal hotplug because it won't work for MDIO
603 * -- because it relies on the device staying around for long
604 * enough for the driver to get loaded. With MDIO, the NIC
605 * driver will get bored and give up as soon as it finds that
606 * there's no driver _already_ loaded.
608 if (is_c45 && c45_ids) {
609 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
612 for (i = 1; i < num_ids; i++) {
613 if (c45_ids->device_ids[i] == 0xffffffff)
616 ret = phy_request_driver_module(dev,
617 c45_ids->device_ids[i]);
622 ret = phy_request_driver_module(dev, phy_id);
626 put_device(&mdiodev->dev);
632 EXPORT_SYMBOL(phy_device_create);
634 /* phy_c45_probe_present - checks to see if a MMD is present in the package
635 * @bus: the target MII bus
636 * @prtad: PHY package address on the MII bus
637 * @devad: PHY device (MMD) address
639 * Read the MDIO_STAT2 register, and check whether a device is responding
642 * Returns: negative error number on bus access error, zero if no device
643 * is responding, or positive if a device is present.
645 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
649 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
653 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
656 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
657 * @bus: the target MII bus
658 * @addr: PHY address on the MII bus
659 * @dev_addr: MMD address in the PHY.
660 * @devices_in_package: where to store the devices in package information.
662 * Description: reads devices in package registers of a MMD at @dev_addr
663 * from PHY at @addr on @bus.
665 * Returns: 0 on success, -EIO on failure.
667 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
668 u32 *devices_in_package)
672 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
675 *devices_in_package = phy_reg << 16;
677 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
680 *devices_in_package |= phy_reg;
686 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
687 * @bus: the target MII bus
688 * @addr: PHY address on the MII bus
689 * @c45_ids: where to store the c45 ID information.
691 * Read the PHY "devices in package". If this appears to be valid, read
692 * the PHY identifiers for each device. Return the "devices in package"
693 * and identifiers in @c45_ids.
695 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
696 * the "devices in package" is invalid.
698 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
699 struct phy_c45_device_ids *c45_ids)
701 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
705 /* Find first non-zero Devices In package. Device zero is reserved
706 * for 802.3 c45 complied PHYs, so don't probe it at first.
708 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
709 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
710 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
711 /* Check that there is a device present at this
712 * address before reading the devices-in-package
713 * register to avoid reading garbage from the PHY.
714 * Some PHYs (88x3310) vendor space is not IEEE802.3
717 ret = phy_c45_probe_present(bus, addr, i);
724 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
729 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
730 /* If mostly Fs, there is no device there, then let's probe
731 * MMD 0, as some 10G PHYs have zero Devices In package,
732 * e.g. Cortina CS4315/CS4340 PHY.
734 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
738 /* no device there, let's get out of here */
739 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
743 /* Now probe Device Identifiers for each device present. */
744 for (i = 1; i < num_ids; i++) {
745 if (!(devs_in_pkg & (1 << i)))
748 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
749 /* Probe the "Device Present" bits for the vendor MMDs
750 * to ignore these if they do not contain IEEE 802.3
753 ret = phy_c45_probe_present(bus, addr, i);
761 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
764 c45_ids->device_ids[i] = phy_reg << 16;
766 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
769 c45_ids->device_ids[i] |= phy_reg;
772 c45_ids->devices_in_package = devs_in_pkg;
773 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
774 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
780 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
781 * @bus: the target MII bus
782 * @addr: PHY address on the MII bus
783 * @phy_id: where to store the ID retrieved.
785 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
786 * placing it in @phy_id. Return zero on successful read and the ID is
787 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
790 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
794 /* Grab the bits from PHYIR1, and put them in the upper half */
795 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
797 /* returning -ENODEV doesn't stop bus scanning */
798 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
801 *phy_id = phy_reg << 16;
803 /* Grab the bits from PHYIR2, and put them in the lower half */
804 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
806 /* returning -ENODEV doesn't stop bus scanning */
807 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
812 /* If the phy_id is mostly Fs, there is no device there */
813 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
820 * get_phy_device - reads the specified PHY device and returns its @phy_device
822 * @bus: the target MII bus
823 * @addr: PHY address on the MII bus
824 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
826 * Probe for a PHY at @addr on @bus.
828 * When probing for a clause 22 PHY, then read the ID registers. If we find
829 * a valid ID, allocate and return a &struct phy_device.
831 * When probing for a clause 45 PHY, read the "devices in package" registers.
832 * If the "devices in package" appears valid, read the ID registers for each
833 * MMD, allocate and return a &struct phy_device.
835 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
836 * no PHY present, or %-EIO on bus access error.
838 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
840 struct phy_c45_device_ids c45_ids;
844 c45_ids.devices_in_package = 0;
845 c45_ids.mmds_present = 0;
846 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
849 r = get_phy_c45_ids(bus, addr, &c45_ids);
851 r = get_phy_c22_id(bus, addr, &phy_id);
856 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
858 EXPORT_SYMBOL(get_phy_device);
861 * phy_device_register - Register the phy device on the MDIO bus
862 * @phydev: phy_device structure to be added to the MDIO bus
864 int phy_device_register(struct phy_device *phydev)
868 err = mdiobus_register_device(&phydev->mdio);
872 /* Deassert the reset signal */
873 phy_device_reset(phydev, 0);
875 /* Run all of the fixups for this PHY */
876 err = phy_scan_fixups(phydev);
878 phydev_err(phydev, "failed to initialize\n");
882 err = device_add(&phydev->mdio.dev);
884 phydev_err(phydev, "failed to add\n");
891 /* Assert the reset signal */
892 phy_device_reset(phydev, 1);
894 mdiobus_unregister_device(&phydev->mdio);
897 EXPORT_SYMBOL(phy_device_register);
900 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
901 * @phydev: phy_device structure to remove
903 * This doesn't free the phy_device itself, it merely reverses the effects
904 * of phy_device_register(). Use phy_device_free() to free the device
905 * after calling this function.
907 void phy_device_remove(struct phy_device *phydev)
910 unregister_mii_timestamper(phydev->mii_ts);
912 device_del(&phydev->mdio.dev);
914 /* Assert the reset signal */
915 phy_device_reset(phydev, 1);
917 mdiobus_unregister_device(&phydev->mdio);
919 EXPORT_SYMBOL(phy_device_remove);
922 * phy_find_first - finds the first PHY device on the bus
923 * @bus: the target MII bus
925 struct phy_device *phy_find_first(struct mii_bus *bus)
927 struct phy_device *phydev;
930 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
931 phydev = mdiobus_get_phy(bus, addr);
937 EXPORT_SYMBOL(phy_find_first);
939 static void phy_link_change(struct phy_device *phydev, bool up)
941 struct net_device *netdev = phydev->attached_dev;
944 netif_carrier_on(netdev);
946 netif_carrier_off(netdev);
947 phydev->adjust_link(netdev);
948 if (phydev->mii_ts && phydev->mii_ts->link_state)
949 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
953 * phy_prepare_link - prepares the PHY layer to monitor link status
954 * @phydev: target phy_device struct
955 * @handler: callback function for link status change notifications
957 * Description: Tells the PHY infrastructure to handle the
958 * gory details on monitoring link status (whether through
959 * polling or an interrupt), and to call back to the
960 * connected device driver when the link status changes.
961 * If you want to monitor your own link state, don't call
964 static void phy_prepare_link(struct phy_device *phydev,
965 void (*handler)(struct net_device *))
967 phydev->adjust_link = handler;
971 * phy_connect_direct - connect an ethernet device to a specific phy_device
972 * @dev: the network device to connect
973 * @phydev: the pointer to the phy device
974 * @handler: callback function for state change notifications
975 * @interface: PHY device's interface
977 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
978 void (*handler)(struct net_device *),
979 phy_interface_t interface)
986 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
990 phy_prepare_link(phydev, handler);
991 if (phy_interrupt_is_valid(phydev))
992 phy_request_interrupt(phydev);
996 EXPORT_SYMBOL(phy_connect_direct);
999 * phy_connect - connect an ethernet device to a PHY device
1000 * @dev: the network device to connect
1001 * @bus_id: the id string of the PHY device to connect
1002 * @handler: callback function for state change notifications
1003 * @interface: PHY device's interface
1005 * Description: Convenience function for connecting ethernet
1006 * devices to PHY devices. The default behavior is for
1007 * the PHY infrastructure to handle everything, and only notify
1008 * the connected driver when the link status changes. If you
1009 * don't want, or can't use the provided functionality, you may
1010 * choose to call only the subset of functions which provide
1011 * the desired functionality.
1013 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1014 void (*handler)(struct net_device *),
1015 phy_interface_t interface)
1017 struct phy_device *phydev;
1021 /* Search the list of PHY devices on the mdio bus for the
1022 * PHY with the requested name
1024 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1026 pr_err("PHY %s not found\n", bus_id);
1027 return ERR_PTR(-ENODEV);
1029 phydev = to_phy_device(d);
1031 rc = phy_connect_direct(dev, phydev, handler, interface);
1038 EXPORT_SYMBOL(phy_connect);
1041 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1043 * @phydev: target phy_device struct
1045 void phy_disconnect(struct phy_device *phydev)
1047 if (phy_is_started(phydev))
1050 if (phy_interrupt_is_valid(phydev))
1051 phy_free_interrupt(phydev);
1053 phydev->adjust_link = NULL;
1057 EXPORT_SYMBOL(phy_disconnect);
1060 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1061 * @phydev: The PHY device to poll
1063 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1064 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1065 * register must be polled until the BMCR_RESET bit clears.
1067 * Furthermore, any attempts to write to PHY registers may have no effect
1068 * or even generate MDIO bus errors until this is complete.
1070 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1071 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1072 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1073 * effort to support such broken PHYs, this function is separate from the
1074 * standard phy_init_hw() which will zero all the other bits in the BMCR
1075 * and reapply all driver-specific and board-specific fixups.
1077 static int phy_poll_reset(struct phy_device *phydev)
1079 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1082 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1083 50000, 600000, true);
1086 /* Some chips (smsc911x) may still need up to another 1ms after the
1087 * BMCR_RESET bit is cleared before they are usable.
1093 int phy_init_hw(struct phy_device *phydev)
1097 /* Deassert the reset signal */
1098 phy_device_reset(phydev, 0);
1103 if (phydev->drv->soft_reset) {
1104 ret = phydev->drv->soft_reset(phydev);
1105 /* see comment in genphy_soft_reset for an explanation */
1107 phydev->suspended = 0;
1113 ret = phy_scan_fixups(phydev);
1117 if (phydev->drv->config_init) {
1118 ret = phydev->drv->config_init(phydev);
1123 if (phydev->drv->config_intr) {
1124 ret = phydev->drv->config_intr(phydev);
1131 EXPORT_SYMBOL(phy_init_hw);
1133 void phy_attached_info(struct phy_device *phydev)
1135 phy_attached_print(phydev, NULL);
1137 EXPORT_SYMBOL(phy_attached_info);
1139 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1140 char *phy_attached_info_irq(struct phy_device *phydev)
1145 switch(phydev->irq) {
1149 case PHY_IGNORE_INTERRUPT:
1153 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1158 return kasprintf(GFP_KERNEL, "%s", irq_str);
1160 EXPORT_SYMBOL(phy_attached_info_irq);
1162 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1164 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1165 char *irq_str = phy_attached_info_irq(phydev);
1168 phydev_info(phydev, ATTACHED_FMT "\n",
1169 drv_name, phydev_name(phydev),
1174 phydev_info(phydev, ATTACHED_FMT,
1175 drv_name, phydev_name(phydev),
1184 EXPORT_SYMBOL(phy_attached_print);
1186 static void phy_sysfs_create_links(struct phy_device *phydev)
1188 struct net_device *dev = phydev->attached_dev;
1194 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1199 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1200 &phydev->mdio.dev.kobj,
1203 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1204 kobject_name(&phydev->mdio.dev.kobj),
1206 /* non-fatal - some net drivers can use one netdevice
1207 * with more then one phy
1211 phydev->sysfs_links = true;
1215 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1218 struct phy_device *phydev = to_phy_device(dev);
1220 return sprintf(buf, "%d\n", !phydev->attached_dev);
1222 static DEVICE_ATTR_RO(phy_standalone);
1225 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1226 * @upstream: pointer to the phy device
1227 * @bus: sfp bus representing cage being attached
1229 * This is used to fill in the sfp_upstream_ops .attach member.
1231 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1233 struct phy_device *phydev = upstream;
1235 if (phydev->attached_dev)
1236 phydev->attached_dev->sfp_bus = bus;
1237 phydev->sfp_bus_attached = true;
1239 EXPORT_SYMBOL(phy_sfp_attach);
1242 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1243 * @upstream: pointer to the phy device
1244 * @bus: sfp bus representing cage being attached
1246 * This is used to fill in the sfp_upstream_ops .detach member.
1248 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1250 struct phy_device *phydev = upstream;
1252 if (phydev->attached_dev)
1253 phydev->attached_dev->sfp_bus = NULL;
1254 phydev->sfp_bus_attached = false;
1256 EXPORT_SYMBOL(phy_sfp_detach);
1259 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1260 * @phydev: Pointer to phy_device
1261 * @ops: SFP's upstream operations
1263 int phy_sfp_probe(struct phy_device *phydev,
1264 const struct sfp_upstream_ops *ops)
1266 struct sfp_bus *bus;
1269 if (phydev->mdio.dev.fwnode) {
1270 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1272 return PTR_ERR(bus);
1274 phydev->sfp_bus = bus;
1276 ret = sfp_bus_add_upstream(bus, phydev, ops);
1281 EXPORT_SYMBOL(phy_sfp_probe);
1284 * phy_attach_direct - attach a network device to a given PHY device pointer
1285 * @dev: network device to attach
1286 * @phydev: Pointer to phy_device to attach
1287 * @flags: PHY device's dev_flags
1288 * @interface: PHY device's interface
1290 * Description: Called by drivers to attach to a particular PHY
1291 * device. The phy_device is found, and properly hooked up
1292 * to the phy_driver. If no driver is attached, then a
1293 * generic driver is used. The phy_device is given a ptr to
1294 * the attaching device, and given a callback for link status
1295 * change. The phy_device is returned to the attaching driver.
1296 * This function takes a reference on the phy device.
1298 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1299 u32 flags, phy_interface_t interface)
1301 struct mii_bus *bus = phydev->mdio.bus;
1302 struct device *d = &phydev->mdio.dev;
1303 struct module *ndev_owner = NULL;
1304 bool using_genphy = false;
1307 /* For Ethernet device drivers that register their own MDIO bus, we
1308 * will have bus->owner match ndev_mod, so we do not want to increment
1309 * our own module->refcnt here, otherwise we would not be able to
1313 ndev_owner = dev->dev.parent->driver->owner;
1314 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1315 phydev_err(phydev, "failed to get the bus module\n");
1321 /* Assume that if there is no driver, that it doesn't
1322 * exist, and we should use the genphy driver.
1326 d->driver = &genphy_c45_driver.mdiodrv.driver;
1328 d->driver = &genphy_driver.mdiodrv.driver;
1330 using_genphy = true;
1333 if (!try_module_get(d->driver->owner)) {
1334 phydev_err(phydev, "failed to get the device driver module\n");
1336 goto error_put_device;
1340 err = d->driver->probe(d);
1342 err = device_bind_driver(d);
1345 goto error_module_put;
1348 if (phydev->attached_dev) {
1349 dev_err(&dev->dev, "PHY already attached\n");
1354 phydev->phy_link_change = phy_link_change;
1356 phydev->attached_dev = dev;
1357 dev->phydev = phydev;
1359 if (phydev->sfp_bus_attached)
1360 dev->sfp_bus = phydev->sfp_bus;
1363 /* Some Ethernet drivers try to connect to a PHY device before
1364 * calling register_netdevice() -> netdev_register_kobject() and
1365 * does the dev->dev.kobj initialization. Here we only check for
1366 * success which indicates that the network device kobject is
1367 * ready. Once we do that we still need to keep track of whether
1368 * links were successfully set up or not for phy_detach() to
1369 * remove them accordingly.
1371 phydev->sysfs_links = false;
1373 phy_sysfs_create_links(phydev);
1375 if (!phydev->attached_dev) {
1376 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1377 &dev_attr_phy_standalone.attr);
1379 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1382 phydev->dev_flags |= flags;
1384 phydev->interface = interface;
1386 phydev->state = PHY_READY;
1388 /* Port is set to PORT_TP by default and the actual PHY driver will set
1389 * it to different value depending on the PHY configuration. If we have
1390 * the generic PHY driver we can't figure it out, thus set the old
1391 * legacy PORT_MII value.
1394 phydev->port = PORT_MII;
1396 /* Initial carrier state is off as the phy is about to be
1400 netif_carrier_off(phydev->attached_dev);
1402 /* Do initial configuration here, now that
1403 * we have certain key parameters
1404 * (dev_flags and interface)
1406 err = phy_init_hw(phydev);
1410 err = phy_disable_interrupts(phydev);
1415 phy_led_triggers_register(phydev);
1420 /* phy_detach() does all of the cleanup below */
1425 module_put(d->driver->owner);
1428 if (ndev_owner != bus->owner)
1429 module_put(bus->owner);
1432 EXPORT_SYMBOL(phy_attach_direct);
1435 * phy_attach - attach a network device to a particular PHY device
1436 * @dev: network device to attach
1437 * @bus_id: Bus ID of PHY device to attach
1438 * @interface: PHY device's interface
1440 * Description: Same as phy_attach_direct() except that a PHY bus_id
1441 * string is passed instead of a pointer to a struct phy_device.
1443 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1444 phy_interface_t interface)
1446 struct bus_type *bus = &mdio_bus_type;
1447 struct phy_device *phydev;
1452 return ERR_PTR(-EINVAL);
1454 /* Search the list of PHY devices on the mdio bus for the
1455 * PHY with the requested name
1457 d = bus_find_device_by_name(bus, NULL, bus_id);
1459 pr_err("PHY %s not found\n", bus_id);
1460 return ERR_PTR(-ENODEV);
1462 phydev = to_phy_device(d);
1464 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1471 EXPORT_SYMBOL(phy_attach);
1473 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1474 struct device_driver *driver)
1476 struct device *d = &phydev->mdio.dev;
1483 ret = d->driver == driver;
1489 bool phy_driver_is_genphy(struct phy_device *phydev)
1491 return phy_driver_is_genphy_kind(phydev,
1492 &genphy_driver.mdiodrv.driver);
1494 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1496 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1498 return phy_driver_is_genphy_kind(phydev,
1499 &genphy_c45_driver.mdiodrv.driver);
1501 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1504 * phy_package_join - join a common PHY group
1505 * @phydev: target phy_device struct
1506 * @addr: cookie and PHY address for global register access
1507 * @priv_size: if non-zero allocate this amount of bytes for private data
1509 * This joins a PHY group and provides a shared storage for all phydevs in
1510 * this group. This is intended to be used for packages which contain
1511 * more than one PHY, for example a quad PHY transceiver.
1513 * The addr parameter serves as a cookie which has to have the same value
1514 * for all members of one group and as a PHY address to access generic
1515 * registers of a PHY package. Usually, one of the PHY addresses of the
1516 * different PHYs in the package provides access to these global registers.
1517 * The address which is given here, will be used in the phy_package_read()
1518 * and phy_package_write() convenience functions. If your PHY doesn't have
1519 * global registers you can just pick any of the PHY addresses.
1521 * This will set the shared pointer of the phydev to the shared storage.
1522 * If this is the first call for a this cookie the shared storage will be
1523 * allocated. If priv_size is non-zero, the given amount of bytes are
1524 * allocated for the priv member.
1526 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1527 * with the same cookie but a different priv_size is an error.
1529 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1531 struct mii_bus *bus = phydev->mdio.bus;
1532 struct phy_package_shared *shared;
1535 if (addr < 0 || addr >= PHY_MAX_ADDR)
1538 mutex_lock(&bus->shared_lock);
1539 shared = bus->shared[addr];
1542 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1546 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1549 shared->priv_size = priv_size;
1551 shared->addr = addr;
1552 refcount_set(&shared->refcnt, 1);
1553 bus->shared[addr] = shared;
1556 if (priv_size && priv_size != shared->priv_size)
1558 refcount_inc(&shared->refcnt);
1560 mutex_unlock(&bus->shared_lock);
1562 phydev->shared = shared;
1569 mutex_unlock(&bus->shared_lock);
1572 EXPORT_SYMBOL_GPL(phy_package_join);
1575 * phy_package_leave - leave a common PHY group
1576 * @phydev: target phy_device struct
1578 * This leaves a PHY group created by phy_package_join(). If this phydev
1579 * was the last user of the shared data between the group, this data is
1580 * freed. Resets the phydev->shared pointer to NULL.
1582 void phy_package_leave(struct phy_device *phydev)
1584 struct phy_package_shared *shared = phydev->shared;
1585 struct mii_bus *bus = phydev->mdio.bus;
1590 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1591 bus->shared[shared->addr] = NULL;
1592 mutex_unlock(&bus->shared_lock);
1593 kfree(shared->priv);
1597 phydev->shared = NULL;
1599 EXPORT_SYMBOL_GPL(phy_package_leave);
1601 static void devm_phy_package_leave(struct device *dev, void *res)
1603 phy_package_leave(*(struct phy_device **)res);
1607 * devm_phy_package_join - resource managed phy_package_join()
1608 * @dev: device that is registering this PHY package
1609 * @phydev: target phy_device struct
1610 * @addr: cookie and PHY address for global register access
1611 * @priv_size: if non-zero allocate this amount of bytes for private data
1613 * Managed phy_package_join(). Shared storage fetched by this function,
1614 * phy_package_leave() is automatically called on driver detach. See
1615 * phy_package_join() for more information.
1617 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1618 int addr, size_t priv_size)
1620 struct phy_device **ptr;
1623 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1628 ret = phy_package_join(phydev, addr, priv_size);
1632 devres_add(dev, ptr);
1639 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1642 * phy_detach - detach a PHY device from its network device
1643 * @phydev: target phy_device struct
1645 * This detaches the phy device from its network device and the phy
1646 * driver, and drops the reference count taken in phy_attach_direct().
1648 void phy_detach(struct phy_device *phydev)
1650 struct net_device *dev = phydev->attached_dev;
1651 struct module *ndev_owner = NULL;
1652 struct mii_bus *bus;
1654 if (phydev->sysfs_links) {
1656 sysfs_remove_link(&dev->dev.kobj, "phydev");
1657 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1660 if (!phydev->attached_dev)
1661 sysfs_remove_file(&phydev->mdio.dev.kobj,
1662 &dev_attr_phy_standalone.attr);
1664 phy_suspend(phydev);
1666 phydev->attached_dev->phydev = NULL;
1667 phydev->attached_dev = NULL;
1669 phydev->phylink = NULL;
1671 phy_led_triggers_unregister(phydev);
1673 if (phydev->mdio.dev.driver)
1674 module_put(phydev->mdio.dev.driver->owner);
1676 /* If the device had no specific driver before (i.e. - it
1677 * was using the generic driver), we unbind the device
1678 * from the generic driver so that there's a chance a
1679 * real driver could be loaded
1681 if (phy_driver_is_genphy(phydev) ||
1682 phy_driver_is_genphy_10g(phydev))
1683 device_release_driver(&phydev->mdio.dev);
1685 /* Assert the reset signal */
1686 phy_device_reset(phydev, 1);
1689 * The phydev might go away on the put_device() below, so avoid
1690 * a use-after-free bug by reading the underlying bus first.
1692 bus = phydev->mdio.bus;
1694 put_device(&phydev->mdio.dev);
1696 ndev_owner = dev->dev.parent->driver->owner;
1697 if (ndev_owner != bus->owner)
1698 module_put(bus->owner);
1700 EXPORT_SYMBOL(phy_detach);
1702 int phy_suspend(struct phy_device *phydev)
1704 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1705 struct net_device *netdev = phydev->attached_dev;
1706 struct phy_driver *phydrv = phydev->drv;
1709 if (phydev->suspended)
1712 /* If the device has WOL enabled, we cannot suspend the PHY */
1713 phy_ethtool_get_wol(phydev, &wol);
1714 if (wol.wolopts || (netdev && netdev->wol_enabled))
1717 if (!phydrv || !phydrv->suspend)
1720 ret = phydrv->suspend(phydev);
1722 phydev->suspended = true;
1726 EXPORT_SYMBOL(phy_suspend);
1728 int __phy_resume(struct phy_device *phydev)
1730 struct phy_driver *phydrv = phydev->drv;
1733 WARN_ON(!mutex_is_locked(&phydev->lock));
1735 if (!phydrv || !phydrv->resume)
1738 ret = phydrv->resume(phydev);
1740 phydev->suspended = false;
1744 EXPORT_SYMBOL(__phy_resume);
1746 int phy_resume(struct phy_device *phydev)
1750 mutex_lock(&phydev->lock);
1751 ret = __phy_resume(phydev);
1752 mutex_unlock(&phydev->lock);
1756 EXPORT_SYMBOL(phy_resume);
1758 int phy_loopback(struct phy_device *phydev, bool enable)
1760 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1763 mutex_lock(&phydev->lock);
1765 if (enable && phydev->loopback_enabled) {
1770 if (!enable && !phydev->loopback_enabled) {
1775 if (phydev->drv && phydrv->set_loopback)
1776 ret = phydrv->set_loopback(phydev, enable);
1783 phydev->loopback_enabled = enable;
1786 mutex_unlock(&phydev->lock);
1789 EXPORT_SYMBOL(phy_loopback);
1792 * phy_reset_after_clk_enable - perform a PHY reset if needed
1793 * @phydev: target phy_device struct
1795 * Description: Some PHYs are known to need a reset after their refclk was
1796 * enabled. This function evaluates the flags and perform the reset if it's
1797 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1800 int phy_reset_after_clk_enable(struct phy_device *phydev)
1802 if (!phydev || !phydev->drv)
1805 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1806 phy_device_reset(phydev, 1);
1807 phy_device_reset(phydev, 0);
1813 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1815 /* Generic PHY support and helper functions */
1818 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1819 * @phydev: target phy_device struct
1821 * Description: Writes MII_ADVERTISE with the appropriate values,
1822 * after sanitizing the values to make sure we only advertise
1823 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1824 * hasn't changed, and > 0 if it has changed.
1826 static int genphy_config_advert(struct phy_device *phydev)
1828 int err, bmsr, changed = 0;
1831 /* Only allow advertising what this PHY supports */
1832 linkmode_and(phydev->advertising, phydev->advertising,
1835 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1837 /* Setup standard advertisement */
1838 err = phy_modify_changed(phydev, MII_ADVERTISE,
1839 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1840 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1847 bmsr = phy_read(phydev, MII_BMSR);
1851 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1852 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1855 if (!(bmsr & BMSR_ESTATEN))
1858 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1860 err = phy_modify_changed(phydev, MII_CTRL1000,
1861 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1872 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1873 * @phydev: target phy_device struct
1875 * Description: Writes MII_ADVERTISE with the appropriate values,
1876 * after sanitizing the values to make sure we only advertise
1877 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1878 * hasn't changed, and > 0 if it has changed. This function is intended
1879 * for Clause 37 1000Base-X mode.
1881 static int genphy_c37_config_advert(struct phy_device *phydev)
1885 /* Only allow advertising what this PHY supports */
1886 linkmode_and(phydev->advertising, phydev->advertising,
1889 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1890 phydev->advertising))
1891 adv |= ADVERTISE_1000XFULL;
1892 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1893 phydev->advertising))
1894 adv |= ADVERTISE_1000XPAUSE;
1895 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1896 phydev->advertising))
1897 adv |= ADVERTISE_1000XPSE_ASYM;
1899 return phy_modify_changed(phydev, MII_ADVERTISE,
1900 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1901 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1906 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1907 * @phydev: target phy_device struct
1909 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1910 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1911 * changed, and 1 if it has changed.
1913 int genphy_config_eee_advert(struct phy_device *phydev)
1917 /* Nothing to disable */
1918 if (!phydev->eee_broken_modes)
1921 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1922 phydev->eee_broken_modes, 0);
1923 /* If the call failed, we assume that EEE is not supported */
1924 return err < 0 ? 0 : err;
1926 EXPORT_SYMBOL(genphy_config_eee_advert);
1929 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1930 * @phydev: target phy_device struct
1932 * Description: Configures MII_BMCR to force speed/duplex
1933 * to the values in phydev. Assumes that the values are valid.
1934 * Please see phy_sanitize_settings().
1936 int genphy_setup_forced(struct phy_device *phydev)
1941 phydev->asym_pause = 0;
1943 if (SPEED_1000 == phydev->speed)
1944 ctl |= BMCR_SPEED1000;
1945 else if (SPEED_100 == phydev->speed)
1946 ctl |= BMCR_SPEED100;
1948 if (DUPLEX_FULL == phydev->duplex)
1949 ctl |= BMCR_FULLDPLX;
1951 return phy_modify(phydev, MII_BMCR,
1952 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1954 EXPORT_SYMBOL(genphy_setup_forced);
1956 static int genphy_setup_master_slave(struct phy_device *phydev)
1960 if (!phydev->is_gigabit_capable)
1963 switch (phydev->master_slave_set) {
1964 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1965 ctl |= CTL1000_PREFER_MASTER;
1967 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1969 case MASTER_SLAVE_CFG_MASTER_FORCE:
1970 ctl |= CTL1000_AS_MASTER;
1972 case MASTER_SLAVE_CFG_SLAVE_FORCE:
1973 ctl |= CTL1000_ENABLE_MASTER;
1975 case MASTER_SLAVE_CFG_UNKNOWN:
1976 case MASTER_SLAVE_CFG_UNSUPPORTED:
1979 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
1983 return phy_modify_changed(phydev, MII_CTRL1000,
1984 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
1985 CTL1000_PREFER_MASTER), ctl);
1988 static int genphy_read_master_slave(struct phy_device *phydev)
1993 if (!phydev->is_gigabit_capable) {
1994 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
1995 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
1999 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2000 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2002 val = phy_read(phydev, MII_CTRL1000);
2006 if (val & CTL1000_ENABLE_MASTER) {
2007 if (val & CTL1000_AS_MASTER)
2008 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2010 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2012 if (val & CTL1000_PREFER_MASTER)
2013 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2015 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2018 val = phy_read(phydev, MII_STAT1000);
2022 if (val & LPA_1000MSFAIL) {
2023 state = MASTER_SLAVE_STATE_ERR;
2024 } else if (phydev->link) {
2025 /* this bits are valid only for active link */
2026 if (val & LPA_1000MSRES)
2027 state = MASTER_SLAVE_STATE_MASTER;
2029 state = MASTER_SLAVE_STATE_SLAVE;
2031 state = MASTER_SLAVE_STATE_UNKNOWN;
2034 phydev->master_slave_get = cfg;
2035 phydev->master_slave_state = state;
2041 * genphy_restart_aneg - Enable and Restart Autonegotiation
2042 * @phydev: target phy_device struct
2044 int genphy_restart_aneg(struct phy_device *phydev)
2046 /* Don't isolate the PHY if we're negotiating */
2047 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2048 BMCR_ANENABLE | BMCR_ANRESTART);
2050 EXPORT_SYMBOL(genphy_restart_aneg);
2053 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2054 * @phydev: target phy_device struct
2055 * @restart: whether aneg restart is requested
2057 * Check, and restart auto-negotiation if needed.
2059 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2064 /* Advertisement hasn't changed, but maybe aneg was never on to
2065 * begin with? Or maybe phy was isolated?
2067 ret = phy_read(phydev, MII_BMCR);
2071 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2076 return genphy_restart_aneg(phydev);
2080 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2083 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2084 * @phydev: target phy_device struct
2085 * @changed: whether autoneg is requested
2087 * Description: If auto-negotiation is enabled, we configure the
2088 * advertising, and then restart auto-negotiation. If it is not
2089 * enabled, then we write the BMCR.
2091 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2095 if (genphy_config_eee_advert(phydev))
2098 err = genphy_setup_master_slave(phydev);
2104 if (AUTONEG_ENABLE != phydev->autoneg)
2105 return genphy_setup_forced(phydev);
2107 err = genphy_config_advert(phydev);
2108 if (err < 0) /* error */
2113 return genphy_check_and_restart_aneg(phydev, changed);
2115 EXPORT_SYMBOL(__genphy_config_aneg);
2118 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2119 * @phydev: target phy_device struct
2121 * Description: If auto-negotiation is enabled, we configure the
2122 * advertising, and then restart auto-negotiation. If it is not
2123 * enabled, then we write the BMCR. This function is intended
2124 * for use with Clause 37 1000Base-X mode.
2126 int genphy_c37_config_aneg(struct phy_device *phydev)
2130 if (phydev->autoneg != AUTONEG_ENABLE)
2131 return genphy_setup_forced(phydev);
2133 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2138 changed = genphy_c37_config_advert(phydev);
2139 if (changed < 0) /* error */
2143 /* Advertisement hasn't changed, but maybe aneg was never on to
2144 * begin with? Or maybe phy was isolated?
2146 int ctl = phy_read(phydev, MII_BMCR);
2151 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2152 changed = 1; /* do restart aneg */
2155 /* Only restart aneg if we are advertising something different
2156 * than we were before.
2159 return genphy_restart_aneg(phydev);
2163 EXPORT_SYMBOL(genphy_c37_config_aneg);
2166 * genphy_aneg_done - return auto-negotiation status
2167 * @phydev: target phy_device struct
2169 * Description: Reads the status register and returns 0 either if
2170 * auto-negotiation is incomplete, or if there was an error.
2171 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2173 int genphy_aneg_done(struct phy_device *phydev)
2175 int retval = phy_read(phydev, MII_BMSR);
2177 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2179 EXPORT_SYMBOL(genphy_aneg_done);
2182 * genphy_update_link - update link status in @phydev
2183 * @phydev: target phy_device struct
2185 * Description: Update the value in phydev->link to reflect the
2186 * current link value. In order to do this, we need to read
2187 * the status register twice, keeping the second value.
2189 int genphy_update_link(struct phy_device *phydev)
2191 int status = 0, bmcr;
2193 bmcr = phy_read(phydev, MII_BMCR);
2197 /* Autoneg is being started, therefore disregard BMSR value and
2198 * report link as down.
2200 if (bmcr & BMCR_ANRESTART)
2203 /* The link state is latched low so that momentary link
2204 * drops can be detected. Do not double-read the status
2205 * in polling mode to detect such short link drops except
2206 * the link was already down.
2208 if (!phy_polling_mode(phydev) || !phydev->link) {
2209 status = phy_read(phydev, MII_BMSR);
2212 else if (status & BMSR_LSTATUS)
2216 /* Read link and autonegotiation status */
2217 status = phy_read(phydev, MII_BMSR);
2221 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2222 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2224 /* Consider the case that autoneg was started and "aneg complete"
2225 * bit has been reset, but "link up" bit not yet.
2227 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2232 EXPORT_SYMBOL(genphy_update_link);
2234 int genphy_read_lpa(struct phy_device *phydev)
2238 if (phydev->autoneg == AUTONEG_ENABLE) {
2239 if (!phydev->autoneg_complete) {
2240 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2242 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2246 if (phydev->is_gigabit_capable) {
2247 lpagb = phy_read(phydev, MII_STAT1000);
2251 if (lpagb & LPA_1000MSFAIL) {
2252 int adv = phy_read(phydev, MII_CTRL1000);
2257 if (adv & CTL1000_ENABLE_MASTER)
2258 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2260 phydev_err(phydev, "Master/Slave resolution failed\n");
2264 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2268 lpa = phy_read(phydev, MII_LPA);
2272 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2274 linkmode_zero(phydev->lp_advertising);
2279 EXPORT_SYMBOL(genphy_read_lpa);
2282 * genphy_read_status_fixed - read the link parameters for !aneg mode
2283 * @phydev: target phy_device struct
2285 * Read the current duplex and speed state for a PHY operating with
2286 * autonegotiation disabled.
2288 int genphy_read_status_fixed(struct phy_device *phydev)
2290 int bmcr = phy_read(phydev, MII_BMCR);
2295 if (bmcr & BMCR_FULLDPLX)
2296 phydev->duplex = DUPLEX_FULL;
2298 phydev->duplex = DUPLEX_HALF;
2300 if (bmcr & BMCR_SPEED1000)
2301 phydev->speed = SPEED_1000;
2302 else if (bmcr & BMCR_SPEED100)
2303 phydev->speed = SPEED_100;
2305 phydev->speed = SPEED_10;
2309 EXPORT_SYMBOL(genphy_read_status_fixed);
2312 * genphy_read_status - check the link status and update current link state
2313 * @phydev: target phy_device struct
2315 * Description: Check the link, then figure out the current state
2316 * by comparing what we advertise with what the link partner
2317 * advertises. Start by checking the gigabit possibilities,
2318 * then move on to 10/100.
2320 int genphy_read_status(struct phy_device *phydev)
2322 int err, old_link = phydev->link;
2324 /* Update the link, but return if there was an error */
2325 err = genphy_update_link(phydev);
2329 /* why bother the PHY if nothing can have changed */
2330 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2333 phydev->speed = SPEED_UNKNOWN;
2334 phydev->duplex = DUPLEX_UNKNOWN;
2336 phydev->asym_pause = 0;
2338 err = genphy_read_master_slave(phydev);
2342 err = genphy_read_lpa(phydev);
2346 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2347 phy_resolve_aneg_linkmode(phydev);
2348 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2349 err = genphy_read_status_fixed(phydev);
2356 EXPORT_SYMBOL(genphy_read_status);
2359 * genphy_c37_read_status - check the link status and update current link state
2360 * @phydev: target phy_device struct
2362 * Description: Check the link, then figure out the current state
2363 * by comparing what we advertise with what the link partner
2364 * advertises. This function is for Clause 37 1000Base-X mode.
2366 int genphy_c37_read_status(struct phy_device *phydev)
2368 int lpa, err, old_link = phydev->link;
2370 /* Update the link, but return if there was an error */
2371 err = genphy_update_link(phydev);
2375 /* why bother the PHY if nothing can have changed */
2376 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2379 phydev->duplex = DUPLEX_UNKNOWN;
2381 phydev->asym_pause = 0;
2383 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2384 lpa = phy_read(phydev, MII_LPA);
2388 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2389 phydev->lp_advertising, lpa & LPA_LPACK);
2390 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2391 phydev->lp_advertising, lpa & LPA_1000XFULL);
2392 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2393 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2394 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2395 phydev->lp_advertising,
2396 lpa & LPA_1000XPAUSE_ASYM);
2398 phy_resolve_aneg_linkmode(phydev);
2399 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2400 int bmcr = phy_read(phydev, MII_BMCR);
2405 if (bmcr & BMCR_FULLDPLX)
2406 phydev->duplex = DUPLEX_FULL;
2408 phydev->duplex = DUPLEX_HALF;
2413 EXPORT_SYMBOL(genphy_c37_read_status);
2416 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2417 * @phydev: target phy_device struct
2419 * Description: Perform a software PHY reset using the standard
2420 * BMCR_RESET bit and poll for the reset bit to be cleared.
2422 * Returns: 0 on success, < 0 on failure
2424 int genphy_soft_reset(struct phy_device *phydev)
2426 u16 res = BMCR_RESET;
2429 if (phydev->autoneg == AUTONEG_ENABLE)
2430 res |= BMCR_ANRESTART;
2432 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2436 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2437 * to their default value. Therefore the POWER DOWN bit is supposed to
2438 * be cleared after soft reset.
2440 phydev->suspended = 0;
2442 ret = phy_poll_reset(phydev);
2446 /* BMCR may be reset to defaults */
2447 if (phydev->autoneg == AUTONEG_DISABLE)
2448 ret = genphy_setup_forced(phydev);
2452 EXPORT_SYMBOL(genphy_soft_reset);
2455 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2456 * @phydev: target phy_device struct
2458 * Description: Reads the PHY's abilities and populates
2459 * phydev->supported accordingly.
2461 * Returns: 0 on success, < 0 on failure
2463 int genphy_read_abilities(struct phy_device *phydev)
2467 linkmode_set_bit_array(phy_basic_ports_array,
2468 ARRAY_SIZE(phy_basic_ports_array),
2471 val = phy_read(phydev, MII_BMSR);
2475 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2476 val & BMSR_ANEGCAPABLE);
2478 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2479 val & BMSR_100FULL);
2480 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2481 val & BMSR_100HALF);
2482 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2484 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2487 if (val & BMSR_ESTATEN) {
2488 val = phy_read(phydev, MII_ESTATUS);
2492 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2493 phydev->supported, val & ESTATUS_1000_TFULL);
2494 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2495 phydev->supported, val & ESTATUS_1000_THALF);
2496 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2497 phydev->supported, val & ESTATUS_1000_XFULL);
2502 EXPORT_SYMBOL(genphy_read_abilities);
2504 /* This is used for the phy device which doesn't support the MMD extended
2505 * register access, but it does have side effect when we are trying to access
2506 * the MMD register via indirect method.
2508 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2512 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2514 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2515 u16 regnum, u16 val)
2519 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2521 int genphy_suspend(struct phy_device *phydev)
2523 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2525 EXPORT_SYMBOL(genphy_suspend);
2527 int genphy_resume(struct phy_device *phydev)
2529 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2531 EXPORT_SYMBOL(genphy_resume);
2533 int genphy_loopback(struct phy_device *phydev, bool enable)
2535 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2536 enable ? BMCR_LOOPBACK : 0);
2538 EXPORT_SYMBOL(genphy_loopback);
2541 * phy_remove_link_mode - Remove a supported link mode
2542 * @phydev: phy_device structure to remove link mode from
2543 * @link_mode: Link mode to be removed
2545 * Description: Some MACs don't support all link modes which the PHY
2546 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2547 * to remove a link mode.
2549 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2551 linkmode_clear_bit(link_mode, phydev->supported);
2552 phy_advertise_supported(phydev);
2554 EXPORT_SYMBOL(phy_remove_link_mode);
2556 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2558 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2559 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2560 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2561 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2565 * phy_advertise_supported - Advertise all supported modes
2566 * @phydev: target phy_device struct
2568 * Description: Called to advertise all supported modes, doesn't touch
2569 * pause mode advertising.
2571 void phy_advertise_supported(struct phy_device *phydev)
2573 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2575 linkmode_copy(new, phydev->supported);
2576 phy_copy_pause_bits(new, phydev->advertising);
2577 linkmode_copy(phydev->advertising, new);
2579 EXPORT_SYMBOL(phy_advertise_supported);
2582 * phy_support_sym_pause - Enable support of symmetrical pause
2583 * @phydev: target phy_device struct
2585 * Description: Called by the MAC to indicate is supports symmetrical
2586 * Pause, but not asym pause.
2588 void phy_support_sym_pause(struct phy_device *phydev)
2590 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2591 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2593 EXPORT_SYMBOL(phy_support_sym_pause);
2596 * phy_support_asym_pause - Enable support of asym pause
2597 * @phydev: target phy_device struct
2599 * Description: Called by the MAC to indicate is supports Asym Pause.
2601 void phy_support_asym_pause(struct phy_device *phydev)
2603 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2605 EXPORT_SYMBOL(phy_support_asym_pause);
2608 * phy_set_sym_pause - Configure symmetric Pause
2609 * @phydev: target phy_device struct
2610 * @rx: Receiver Pause is supported
2611 * @tx: Transmit Pause is supported
2612 * @autoneg: Auto neg should be used
2614 * Description: Configure advertised Pause support depending on if
2615 * receiver pause and pause auto neg is supported. Generally called
2616 * from the set_pauseparam .ndo.
2618 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2621 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2623 if (rx && tx && autoneg)
2624 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2627 linkmode_copy(phydev->advertising, phydev->supported);
2629 EXPORT_SYMBOL(phy_set_sym_pause);
2632 * phy_set_asym_pause - Configure Pause and Asym Pause
2633 * @phydev: target phy_device struct
2634 * @rx: Receiver Pause is supported
2635 * @tx: Transmit Pause is supported
2637 * Description: Configure advertised Pause support depending on if
2638 * transmit and receiver pause is supported. If there has been a
2639 * change in adverting, trigger a new autoneg. Generally called from
2640 * the set_pauseparam .ndo.
2642 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2644 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2646 linkmode_copy(oldadv, phydev->advertising);
2647 linkmode_set_pause(phydev->advertising, tx, rx);
2649 if (!linkmode_equal(oldadv, phydev->advertising) &&
2651 phy_start_aneg(phydev);
2653 EXPORT_SYMBOL(phy_set_asym_pause);
2656 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2657 * @phydev: phy_device struct
2658 * @pp: requested pause configuration
2660 * Description: Test if the PHY/MAC combination supports the Pause
2661 * configuration the user is requesting. Returns True if it is
2662 * supported, false otherwise.
2664 bool phy_validate_pause(struct phy_device *phydev,
2665 struct ethtool_pauseparam *pp)
2667 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2668 phydev->supported) && pp->rx_pause)
2671 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2672 phydev->supported) &&
2673 pp->rx_pause != pp->tx_pause)
2678 EXPORT_SYMBOL(phy_validate_pause);
2681 * phy_get_pause - resolve negotiated pause modes
2682 * @phydev: phy_device struct
2683 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2685 * @rx_pause: pointer to bool to indicate whether receive pause should be
2688 * Resolve and return the flow control modes according to the negotiation
2689 * result. This includes checking that we are operating in full duplex mode.
2690 * See linkmode_resolve_pause() for further details.
2692 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2694 if (phydev->duplex != DUPLEX_FULL) {
2700 return linkmode_resolve_pause(phydev->advertising,
2701 phydev->lp_advertising,
2702 tx_pause, rx_pause);
2704 EXPORT_SYMBOL(phy_get_pause);
2706 #if IS_ENABLED(CONFIG_OF_MDIO)
2707 static int phy_get_int_delay_property(struct device *dev, const char *name)
2712 ret = device_property_read_u32(dev, name, &int_delay);
2719 static int phy_get_int_delay_property(struct device *dev, const char *name)
2726 * phy_get_delay_index - returns the index of the internal delay
2727 * @phydev: phy_device struct
2728 * @dev: pointer to the devices device struct
2729 * @delay_values: array of delays the PHY supports
2730 * @size: the size of the delay array
2731 * @is_rx: boolean to indicate to get the rx internal delay
2733 * Returns the index within the array of internal delay passed in.
2734 * If the device property is not present then the interface type is checked
2735 * if the interface defines use of internal delay then a 1 is returned otherwise
2737 * The array must be in ascending order. If PHY does not have an ascending order
2738 * array then size = 0 and the value of the delay property is returned.
2739 * Return -EINVAL if the delay is invalid or cannot be found.
2741 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2742 const int *delay_values, int size, bool is_rx)
2748 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
2749 if (delay < 0 && size == 0) {
2750 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2751 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
2758 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
2759 if (delay < 0 && size == 0) {
2760 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2761 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
2771 if (delay && size == 0)
2774 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
2775 phydev_err(phydev, "Delay %d is out of range\n", delay);
2779 if (delay == delay_values[0])
2782 for (i = 1; i < size; i++) {
2783 if (delay == delay_values[i])
2786 /* Find an approximate index by looking up the table */
2787 if (delay > delay_values[i - 1] &&
2788 delay < delay_values[i]) {
2789 if (delay - delay_values[i - 1] <
2790 delay_values[i] - delay)
2797 phydev_err(phydev, "error finding internal delay index for %d\n",
2802 EXPORT_SYMBOL(phy_get_internal_delay);
2804 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2806 return phydrv->config_intr && phydrv->ack_interrupt;
2810 * phy_probe - probe and init a PHY device
2811 * @dev: device to probe and init
2813 * Description: Take care of setting up the phy_device structure,
2814 * set the state to READY (the driver's init function should
2815 * set it to STARTING if needed).
2817 static int phy_probe(struct device *dev)
2819 struct phy_device *phydev = to_phy_device(dev);
2820 struct device_driver *drv = phydev->mdio.dev.driver;
2821 struct phy_driver *phydrv = to_phy_driver(drv);
2824 phydev->drv = phydrv;
2826 /* Disable the interrupt if the PHY doesn't support it
2827 * but the interrupt is still a valid one
2829 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2830 phydev->irq = PHY_POLL;
2832 if (phydrv->flags & PHY_IS_INTERNAL)
2833 phydev->is_internal = true;
2835 mutex_lock(&phydev->lock);
2837 /* Deassert the reset signal */
2838 phy_device_reset(phydev, 0);
2840 if (phydev->drv->probe) {
2841 err = phydev->drv->probe(phydev);
2846 /* Start out supporting everything. Eventually,
2847 * a controller will attach, and may modify one
2848 * or both of these values
2850 if (phydrv->features) {
2851 linkmode_copy(phydev->supported, phydrv->features);
2852 } else if (phydrv->get_features) {
2853 err = phydrv->get_features(phydev);
2854 } else if (phydev->is_c45) {
2855 err = genphy_c45_pma_read_abilities(phydev);
2857 err = genphy_read_abilities(phydev);
2863 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2865 phydev->autoneg = 0;
2867 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2869 phydev->is_gigabit_capable = 1;
2870 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2872 phydev->is_gigabit_capable = 1;
2874 of_set_phy_supported(phydev);
2875 phy_advertise_supported(phydev);
2877 /* Get the EEE modes we want to prohibit. We will ask
2878 * the PHY stop advertising these mode later on
2880 of_set_phy_eee_broken(phydev);
2882 /* The Pause Frame bits indicate that the PHY can support passing
2883 * pause frames. During autonegotiation, the PHYs will determine if
2884 * they should allow pause frames to pass. The MAC driver should then
2885 * use that result to determine whether to enable flow control via
2888 * Normally, PHY drivers should not set the Pause bits, and instead
2889 * allow phylib to do that. However, there may be some situations
2890 * (e.g. hardware erratum) where the driver wants to set only one
2893 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2894 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2895 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2897 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2901 /* Set the state to READY by default */
2902 phydev->state = PHY_READY;
2905 /* Assert the reset signal */
2907 phy_device_reset(phydev, 1);
2909 mutex_unlock(&phydev->lock);
2914 static int phy_remove(struct device *dev)
2916 struct phy_device *phydev = to_phy_device(dev);
2918 cancel_delayed_work_sync(&phydev->state_queue);
2920 mutex_lock(&phydev->lock);
2921 phydev->state = PHY_DOWN;
2922 mutex_unlock(&phydev->lock);
2924 sfp_bus_del_upstream(phydev->sfp_bus);
2925 phydev->sfp_bus = NULL;
2927 if (phydev->drv && phydev->drv->remove)
2928 phydev->drv->remove(phydev);
2930 /* Assert the reset signal */
2931 phy_device_reset(phydev, 1);
2939 * phy_driver_register - register a phy_driver with the PHY layer
2940 * @new_driver: new phy_driver to register
2941 * @owner: module owning this PHY
2943 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2947 /* Either the features are hard coded, or dynamically
2948 * determined. It cannot be both.
2950 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2951 pr_err("%s: features and get_features must not both be set\n",
2956 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2957 new_driver->mdiodrv.driver.name = new_driver->name;
2958 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2959 new_driver->mdiodrv.driver.probe = phy_probe;
2960 new_driver->mdiodrv.driver.remove = phy_remove;
2961 new_driver->mdiodrv.driver.owner = owner;
2962 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2964 retval = driver_register(&new_driver->mdiodrv.driver);
2966 pr_err("%s: Error %d in registering driver\n",
2967 new_driver->name, retval);
2972 pr_debug("%s: Registered new driver\n", new_driver->name);
2976 EXPORT_SYMBOL(phy_driver_register);
2978 int phy_drivers_register(struct phy_driver *new_driver, int n,
2979 struct module *owner)
2983 for (i = 0; i < n; i++) {
2984 ret = phy_driver_register(new_driver + i, owner);
2987 phy_driver_unregister(new_driver + i);
2993 EXPORT_SYMBOL(phy_drivers_register);
2995 void phy_driver_unregister(struct phy_driver *drv)
2997 driver_unregister(&drv->mdiodrv.driver);
2999 EXPORT_SYMBOL(phy_driver_unregister);
3001 void phy_drivers_unregister(struct phy_driver *drv, int n)
3005 for (i = 0; i < n; i++)
3006 phy_driver_unregister(drv + i);
3008 EXPORT_SYMBOL(phy_drivers_unregister);
3010 static struct phy_driver genphy_driver = {
3011 .phy_id = 0xffffffff,
3012 .phy_id_mask = 0xffffffff,
3013 .name = "Generic PHY",
3014 .get_features = genphy_read_abilities,
3015 .suspend = genphy_suspend,
3016 .resume = genphy_resume,
3017 .set_loopback = genphy_loopback,
3020 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3021 .get_sset_count = phy_ethtool_get_sset_count,
3022 .get_strings = phy_ethtool_get_strings,
3023 .get_stats = phy_ethtool_get_stats,
3024 .start_cable_test = phy_start_cable_test,
3025 .start_cable_test_tdr = phy_start_cable_test_tdr,
3028 static int __init phy_init(void)
3032 rc = mdio_bus_init();
3036 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3039 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3043 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3045 phy_driver_unregister(&genphy_c45_driver);
3053 static void __exit phy_exit(void)
3055 phy_driver_unregister(&genphy_c45_driver);
3056 phy_driver_unregister(&genphy_driver);
3058 ethtool_set_ethtool_phy_ops(NULL);
3061 subsys_initcall(phy_init);
3062 module_exit(phy_exit);