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);
234 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
236 struct device_driver *drv = phydev->mdio.dev.driver;
237 struct phy_driver *phydrv = to_phy_driver(drv);
238 struct net_device *netdev = phydev->attached_dev;
240 if (!drv || !phydrv->suspend)
243 /* PHY not attached? May suspend if the PHY has not already been
244 * suspended as part of a prior call to phy_disconnect() ->
245 * phy_detach() -> phy_suspend() because the parent netdev might be the
246 * MDIO bus driver and clock gated at this point.
251 if (netdev->wol_enabled)
254 /* As long as not all affected network drivers support the
255 * wol_enabled flag, let's check for hints that WoL is enabled.
256 * Don't suspend PHY if the attached netdev parent may wake up.
257 * The parent may point to a PCI device, as in tg3 driver.
259 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
262 /* Also don't suspend PHY if the netdev itself may wakeup. This
263 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
266 if (device_may_wakeup(&netdev->dev))
270 return !phydev->suspended;
273 static int mdio_bus_phy_suspend(struct device *dev)
275 struct phy_device *phydev = to_phy_device(dev);
277 /* We must stop the state machine manually, otherwise it stops out of
278 * control, possibly with the phydev->lock held. Upon resume, netdev
279 * may call phy routines that try to grab the same lock, and that may
280 * lead to a deadlock.
282 if (phydev->attached_dev && phydev->adjust_link)
283 phy_stop_machine(phydev);
285 if (!mdio_bus_phy_may_suspend(phydev))
288 phydev->suspended_by_mdio_bus = 1;
290 return phy_suspend(phydev);
293 static int mdio_bus_phy_resume(struct device *dev)
295 struct phy_device *phydev = to_phy_device(dev);
298 if (!phydev->suspended_by_mdio_bus)
301 phydev->suspended_by_mdio_bus = 0;
303 ret = phy_resume(phydev);
308 if (phydev->attached_dev && phydev->adjust_link)
309 phy_start_machine(phydev);
314 static int mdio_bus_phy_restore(struct device *dev)
316 struct phy_device *phydev = to_phy_device(dev);
317 struct net_device *netdev = phydev->attached_dev;
323 ret = phy_init_hw(phydev);
327 if (phydev->attached_dev && phydev->adjust_link)
328 phy_start_machine(phydev);
333 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
334 .suspend = mdio_bus_phy_suspend,
335 .resume = mdio_bus_phy_resume,
336 .freeze = mdio_bus_phy_suspend,
337 .thaw = mdio_bus_phy_resume,
338 .restore = mdio_bus_phy_restore,
341 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
345 #define MDIO_BUS_PHY_PM_OPS NULL
347 #endif /* CONFIG_PM */
350 * phy_register_fixup - creates a new phy_fixup and adds it to the list
351 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
352 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
353 * It can also be PHY_ANY_UID
354 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
356 * @run: The actual code to be run when a matching PHY is found
358 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
359 int (*run)(struct phy_device *))
361 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
366 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
367 fixup->phy_uid = phy_uid;
368 fixup->phy_uid_mask = phy_uid_mask;
371 mutex_lock(&phy_fixup_lock);
372 list_add_tail(&fixup->list, &phy_fixup_list);
373 mutex_unlock(&phy_fixup_lock);
377 EXPORT_SYMBOL(phy_register_fixup);
379 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
380 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
381 int (*run)(struct phy_device *))
383 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
385 EXPORT_SYMBOL(phy_register_fixup_for_uid);
387 /* Registers a fixup to be run on the PHY with id string bus_id */
388 int phy_register_fixup_for_id(const char *bus_id,
389 int (*run)(struct phy_device *))
391 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
393 EXPORT_SYMBOL(phy_register_fixup_for_id);
396 * phy_unregister_fixup - remove a phy_fixup from the list
397 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
398 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
399 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
401 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
403 struct list_head *pos, *n;
404 struct phy_fixup *fixup;
409 mutex_lock(&phy_fixup_lock);
410 list_for_each_safe(pos, n, &phy_fixup_list) {
411 fixup = list_entry(pos, struct phy_fixup, list);
413 if ((!strcmp(fixup->bus_id, bus_id)) &&
414 ((fixup->phy_uid & phy_uid_mask) ==
415 (phy_uid & phy_uid_mask))) {
416 list_del(&fixup->list);
422 mutex_unlock(&phy_fixup_lock);
426 EXPORT_SYMBOL(phy_unregister_fixup);
428 /* Unregisters a fixup of any PHY with the UID in phy_uid */
429 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
431 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
433 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
435 /* Unregisters a fixup of the PHY with id string bus_id */
436 int phy_unregister_fixup_for_id(const char *bus_id)
438 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
440 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
442 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
443 * Fixups can be set to match any in one or more fields.
445 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
447 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
448 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
451 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
452 (phydev->phy_id & fixup->phy_uid_mask))
453 if (fixup->phy_uid != PHY_ANY_UID)
459 /* Runs any matching fixups for this phydev */
460 static int phy_scan_fixups(struct phy_device *phydev)
462 struct phy_fixup *fixup;
464 mutex_lock(&phy_fixup_lock);
465 list_for_each_entry(fixup, &phy_fixup_list, list) {
466 if (phy_needs_fixup(phydev, fixup)) {
467 int err = fixup->run(phydev);
470 mutex_unlock(&phy_fixup_lock);
473 phydev->has_fixups = true;
476 mutex_unlock(&phy_fixup_lock);
481 static int phy_bus_match(struct device *dev, struct device_driver *drv)
483 struct phy_device *phydev = to_phy_device(dev);
484 struct phy_driver *phydrv = to_phy_driver(drv);
485 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
488 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
491 if (phydrv->match_phy_device)
492 return phydrv->match_phy_device(phydev);
494 if (phydev->is_c45) {
495 for (i = 1; i < num_ids; i++) {
496 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
499 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
500 (phydev->c45_ids.device_ids[i] &
501 phydrv->phy_id_mask))
506 return (phydrv->phy_id & phydrv->phy_id_mask) ==
507 (phydev->phy_id & phydrv->phy_id_mask);
512 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
514 struct phy_device *phydev = to_phy_device(dev);
516 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
518 static DEVICE_ATTR_RO(phy_id);
521 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
523 struct phy_device *phydev = to_phy_device(dev);
524 const char *mode = NULL;
526 if (phy_is_internal(phydev))
529 mode = phy_modes(phydev->interface);
531 return sprintf(buf, "%s\n", mode);
533 static DEVICE_ATTR_RO(phy_interface);
536 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
539 struct phy_device *phydev = to_phy_device(dev);
541 return sprintf(buf, "%d\n", phydev->has_fixups);
543 static DEVICE_ATTR_RO(phy_has_fixups);
545 static struct attribute *phy_dev_attrs[] = {
546 &dev_attr_phy_id.attr,
547 &dev_attr_phy_interface.attr,
548 &dev_attr_phy_has_fixups.attr,
551 ATTRIBUTE_GROUPS(phy_dev);
553 static const struct device_type mdio_bus_phy_type = {
555 .groups = phy_dev_groups,
556 .release = phy_device_release,
557 .pm = MDIO_BUS_PHY_PM_OPS,
560 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
564 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
565 MDIO_ID_ARGS(phy_id));
566 /* We only check for failures in executing the usermode binary,
567 * not whether a PHY driver module exists for the PHY ID.
568 * Accept -ENOENT because this may occur in case no initramfs exists,
569 * then modprobe isn't available.
571 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
572 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
573 ret, (unsigned long)phy_id);
580 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
582 struct phy_c45_device_ids *c45_ids)
584 struct phy_device *dev;
585 struct mdio_device *mdiodev;
588 /* We allocate the device, and initialize the default values */
589 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
591 return ERR_PTR(-ENOMEM);
593 mdiodev = &dev->mdio;
594 mdiodev->dev.parent = &bus->dev;
595 mdiodev->dev.bus = &mdio_bus_type;
596 mdiodev->dev.type = &mdio_bus_phy_type;
598 mdiodev->bus_match = phy_bus_match;
599 mdiodev->addr = addr;
600 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
601 mdiodev->device_free = phy_mdio_device_free;
602 mdiodev->device_remove = phy_mdio_device_remove;
604 dev->speed = SPEED_UNKNOWN;
605 dev->duplex = DUPLEX_UNKNOWN;
609 dev->interface = PHY_INTERFACE_MODE_GMII;
611 dev->autoneg = AUTONEG_ENABLE;
613 dev->is_c45 = is_c45;
614 dev->phy_id = phy_id;
616 dev->c45_ids = *c45_ids;
617 dev->irq = bus->irq[addr];
619 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
620 device_initialize(&mdiodev->dev);
622 dev->state = PHY_DOWN;
624 mutex_init(&dev->lock);
625 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
627 /* Request the appropriate module unconditionally; don't
628 * bother trying to do so only if it isn't already loaded,
629 * because that gets complicated. A hotplug event would have
630 * done an unconditional modprobe anyway.
631 * We don't do normal hotplug because it won't work for MDIO
632 * -- because it relies on the device staying around for long
633 * enough for the driver to get loaded. With MDIO, the NIC
634 * driver will get bored and give up as soon as it finds that
635 * there's no driver _already_ loaded.
637 if (is_c45 && c45_ids) {
638 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
641 for (i = 1; i < num_ids; i++) {
642 if (c45_ids->device_ids[i] == 0xffffffff)
645 ret = phy_request_driver_module(dev,
646 c45_ids->device_ids[i]);
651 ret = phy_request_driver_module(dev, phy_id);
655 put_device(&mdiodev->dev);
661 EXPORT_SYMBOL(phy_device_create);
663 /* phy_c45_probe_present - checks to see if a MMD is present in the package
664 * @bus: the target MII bus
665 * @prtad: PHY package address on the MII bus
666 * @devad: PHY device (MMD) address
668 * Read the MDIO_STAT2 register, and check whether a device is responding
671 * Returns: negative error number on bus access error, zero if no device
672 * is responding, or positive if a device is present.
674 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
678 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
682 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
685 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
686 * @bus: the target MII bus
687 * @addr: PHY address on the MII bus
688 * @dev_addr: MMD address in the PHY.
689 * @devices_in_package: where to store the devices in package information.
691 * Description: reads devices in package registers of a MMD at @dev_addr
692 * from PHY at @addr on @bus.
694 * Returns: 0 on success, -EIO on failure.
696 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
697 u32 *devices_in_package)
701 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
704 *devices_in_package = phy_reg << 16;
706 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
709 *devices_in_package |= phy_reg;
715 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
716 * @bus: the target MII bus
717 * @addr: PHY address on the MII bus
718 * @c45_ids: where to store the c45 ID information.
720 * Read the PHY "devices in package". If this appears to be valid, read
721 * the PHY identifiers for each device. Return the "devices in package"
722 * and identifiers in @c45_ids.
724 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
725 * the "devices in package" is invalid.
727 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
728 struct phy_c45_device_ids *c45_ids)
730 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
734 /* Find first non-zero Devices In package. Device zero is reserved
735 * for 802.3 c45 complied PHYs, so don't probe it at first.
737 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
738 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
739 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
740 /* Check that there is a device present at this
741 * address before reading the devices-in-package
742 * register to avoid reading garbage from the PHY.
743 * Some PHYs (88x3310) vendor space is not IEEE802.3
746 ret = phy_c45_probe_present(bus, addr, i);
753 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
758 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
759 /* If mostly Fs, there is no device there, then let's probe
760 * MMD 0, as some 10G PHYs have zero Devices In package,
761 * e.g. Cortina CS4315/CS4340 PHY.
763 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
767 /* no device there, let's get out of here */
768 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
772 /* Now probe Device Identifiers for each device present. */
773 for (i = 1; i < num_ids; i++) {
774 if (!(devs_in_pkg & (1 << i)))
777 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
778 /* Probe the "Device Present" bits for the vendor MMDs
779 * to ignore these if they do not contain IEEE 802.3
782 ret = phy_c45_probe_present(bus, addr, i);
790 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
793 c45_ids->device_ids[i] = phy_reg << 16;
795 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
798 c45_ids->device_ids[i] |= phy_reg;
801 c45_ids->devices_in_package = devs_in_pkg;
802 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
803 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
809 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
810 * @bus: the target MII bus
811 * @addr: PHY address on the MII bus
812 * @phy_id: where to store the ID retrieved.
814 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
815 * placing it in @phy_id. Return zero on successful read and the ID is
816 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
819 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
823 /* Grab the bits from PHYIR1, and put them in the upper half */
824 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
826 /* returning -ENODEV doesn't stop bus scanning */
827 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
830 *phy_id = phy_reg << 16;
832 /* Grab the bits from PHYIR2, and put them in the lower half */
833 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
835 /* returning -ENODEV doesn't stop bus scanning */
836 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
841 /* If the phy_id is mostly Fs, there is no device there */
842 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
849 * get_phy_device - reads the specified PHY device and returns its @phy_device
851 * @bus: the target MII bus
852 * @addr: PHY address on the MII bus
853 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
855 * Probe for a PHY at @addr on @bus.
857 * When probing for a clause 22 PHY, then read the ID registers. If we find
858 * a valid ID, allocate and return a &struct phy_device.
860 * When probing for a clause 45 PHY, read the "devices in package" registers.
861 * If the "devices in package" appears valid, read the ID registers for each
862 * MMD, allocate and return a &struct phy_device.
864 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
865 * no PHY present, or %-EIO on bus access error.
867 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
869 struct phy_c45_device_ids c45_ids;
873 c45_ids.devices_in_package = 0;
874 c45_ids.mmds_present = 0;
875 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
878 r = get_phy_c45_ids(bus, addr, &c45_ids);
880 r = get_phy_c22_id(bus, addr, &phy_id);
885 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
887 EXPORT_SYMBOL(get_phy_device);
890 * phy_device_register - Register the phy device on the MDIO bus
891 * @phydev: phy_device structure to be added to the MDIO bus
893 int phy_device_register(struct phy_device *phydev)
897 err = mdiobus_register_device(&phydev->mdio);
901 /* Deassert the reset signal */
902 phy_device_reset(phydev, 0);
904 /* Run all of the fixups for this PHY */
905 err = phy_scan_fixups(phydev);
907 phydev_err(phydev, "failed to initialize\n");
911 err = device_add(&phydev->mdio.dev);
913 phydev_err(phydev, "failed to add\n");
920 /* Assert the reset signal */
921 phy_device_reset(phydev, 1);
923 mdiobus_unregister_device(&phydev->mdio);
926 EXPORT_SYMBOL(phy_device_register);
929 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
930 * @phydev: phy_device structure to remove
932 * This doesn't free the phy_device itself, it merely reverses the effects
933 * of phy_device_register(). Use phy_device_free() to free the device
934 * after calling this function.
936 void phy_device_remove(struct phy_device *phydev)
939 unregister_mii_timestamper(phydev->mii_ts);
941 device_del(&phydev->mdio.dev);
943 /* Assert the reset signal */
944 phy_device_reset(phydev, 1);
946 mdiobus_unregister_device(&phydev->mdio);
948 EXPORT_SYMBOL(phy_device_remove);
951 * phy_find_first - finds the first PHY device on the bus
952 * @bus: the target MII bus
954 struct phy_device *phy_find_first(struct mii_bus *bus)
956 struct phy_device *phydev;
959 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
960 phydev = mdiobus_get_phy(bus, addr);
966 EXPORT_SYMBOL(phy_find_first);
968 static void phy_link_change(struct phy_device *phydev, bool up)
970 struct net_device *netdev = phydev->attached_dev;
973 netif_carrier_on(netdev);
975 netif_carrier_off(netdev);
976 phydev->adjust_link(netdev);
977 if (phydev->mii_ts && phydev->mii_ts->link_state)
978 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
982 * phy_prepare_link - prepares the PHY layer to monitor link status
983 * @phydev: target phy_device struct
984 * @handler: callback function for link status change notifications
986 * Description: Tells the PHY infrastructure to handle the
987 * gory details on monitoring link status (whether through
988 * polling or an interrupt), and to call back to the
989 * connected device driver when the link status changes.
990 * If you want to monitor your own link state, don't call
993 static void phy_prepare_link(struct phy_device *phydev,
994 void (*handler)(struct net_device *))
996 phydev->adjust_link = handler;
1000 * phy_connect_direct - connect an ethernet device to a specific phy_device
1001 * @dev: the network device to connect
1002 * @phydev: the pointer to the phy device
1003 * @handler: callback function for state change notifications
1004 * @interface: PHY device's interface
1006 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1007 void (*handler)(struct net_device *),
1008 phy_interface_t interface)
1015 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1019 phy_prepare_link(phydev, handler);
1020 if (phy_interrupt_is_valid(phydev))
1021 phy_request_interrupt(phydev);
1025 EXPORT_SYMBOL(phy_connect_direct);
1028 * phy_connect - connect an ethernet device to a PHY device
1029 * @dev: the network device to connect
1030 * @bus_id: the id string of the PHY device to connect
1031 * @handler: callback function for state change notifications
1032 * @interface: PHY device's interface
1034 * Description: Convenience function for connecting ethernet
1035 * devices to PHY devices. The default behavior is for
1036 * the PHY infrastructure to handle everything, and only notify
1037 * the connected driver when the link status changes. If you
1038 * don't want, or can't use the provided functionality, you may
1039 * choose to call only the subset of functions which provide
1040 * the desired functionality.
1042 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1043 void (*handler)(struct net_device *),
1044 phy_interface_t interface)
1046 struct phy_device *phydev;
1050 /* Search the list of PHY devices on the mdio bus for the
1051 * PHY with the requested name
1053 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1055 pr_err("PHY %s not found\n", bus_id);
1056 return ERR_PTR(-ENODEV);
1058 phydev = to_phy_device(d);
1060 rc = phy_connect_direct(dev, phydev, handler, interface);
1067 EXPORT_SYMBOL(phy_connect);
1070 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1072 * @phydev: target phy_device struct
1074 void phy_disconnect(struct phy_device *phydev)
1076 if (phy_is_started(phydev))
1079 if (phy_interrupt_is_valid(phydev))
1080 phy_free_interrupt(phydev);
1082 phydev->adjust_link = NULL;
1086 EXPORT_SYMBOL(phy_disconnect);
1089 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1090 * @phydev: The PHY device to poll
1092 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1093 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1094 * register must be polled until the BMCR_RESET bit clears.
1096 * Furthermore, any attempts to write to PHY registers may have no effect
1097 * or even generate MDIO bus errors until this is complete.
1099 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1100 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1101 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1102 * effort to support such broken PHYs, this function is separate from the
1103 * standard phy_init_hw() which will zero all the other bits in the BMCR
1104 * and reapply all driver-specific and board-specific fixups.
1106 static int phy_poll_reset(struct phy_device *phydev)
1108 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1111 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1112 50000, 600000, true);
1115 /* Some chips (smsc911x) may still need up to another 1ms after the
1116 * BMCR_RESET bit is cleared before they are usable.
1122 int phy_init_hw(struct phy_device *phydev)
1126 /* Deassert the reset signal */
1127 phy_device_reset(phydev, 0);
1132 if (phydev->drv->soft_reset) {
1133 ret = phydev->drv->soft_reset(phydev);
1134 /* see comment in genphy_soft_reset for an explanation */
1136 phydev->suspended = 0;
1142 ret = phy_scan_fixups(phydev);
1146 if (phydev->drv->config_init)
1147 ret = phydev->drv->config_init(phydev);
1151 EXPORT_SYMBOL(phy_init_hw);
1153 void phy_attached_info(struct phy_device *phydev)
1155 phy_attached_print(phydev, NULL);
1157 EXPORT_SYMBOL(phy_attached_info);
1159 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1160 char *phy_attached_info_irq(struct phy_device *phydev)
1165 switch(phydev->irq) {
1169 case PHY_IGNORE_INTERRUPT:
1173 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1178 return kasprintf(GFP_KERNEL, "%s", irq_str);
1180 EXPORT_SYMBOL(phy_attached_info_irq);
1182 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1184 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1185 char *irq_str = phy_attached_info_irq(phydev);
1188 phydev_info(phydev, ATTACHED_FMT "\n",
1189 drv_name, phydev_name(phydev),
1194 phydev_info(phydev, ATTACHED_FMT,
1195 drv_name, phydev_name(phydev),
1204 EXPORT_SYMBOL(phy_attached_print);
1206 static void phy_sysfs_create_links(struct phy_device *phydev)
1208 struct net_device *dev = phydev->attached_dev;
1214 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1219 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1220 &phydev->mdio.dev.kobj,
1223 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1224 kobject_name(&phydev->mdio.dev.kobj),
1226 /* non-fatal - some net drivers can use one netdevice
1227 * with more then one phy
1231 phydev->sysfs_links = true;
1235 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1238 struct phy_device *phydev = to_phy_device(dev);
1240 return sprintf(buf, "%d\n", !phydev->attached_dev);
1242 static DEVICE_ATTR_RO(phy_standalone);
1245 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1246 * @upstream: pointer to the phy device
1247 * @bus: sfp bus representing cage being attached
1249 * This is used to fill in the sfp_upstream_ops .attach member.
1251 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1253 struct phy_device *phydev = upstream;
1255 if (phydev->attached_dev)
1256 phydev->attached_dev->sfp_bus = bus;
1257 phydev->sfp_bus_attached = true;
1259 EXPORT_SYMBOL(phy_sfp_attach);
1262 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1263 * @upstream: pointer to the phy device
1264 * @bus: sfp bus representing cage being attached
1266 * This is used to fill in the sfp_upstream_ops .detach member.
1268 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1270 struct phy_device *phydev = upstream;
1272 if (phydev->attached_dev)
1273 phydev->attached_dev->sfp_bus = NULL;
1274 phydev->sfp_bus_attached = false;
1276 EXPORT_SYMBOL(phy_sfp_detach);
1279 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1280 * @phydev: Pointer to phy_device
1281 * @ops: SFP's upstream operations
1283 int phy_sfp_probe(struct phy_device *phydev,
1284 const struct sfp_upstream_ops *ops)
1286 struct sfp_bus *bus;
1289 if (phydev->mdio.dev.fwnode) {
1290 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1292 return PTR_ERR(bus);
1294 phydev->sfp_bus = bus;
1296 ret = sfp_bus_add_upstream(bus, phydev, ops);
1301 EXPORT_SYMBOL(phy_sfp_probe);
1304 * phy_attach_direct - attach a network device to a given PHY device pointer
1305 * @dev: network device to attach
1306 * @phydev: Pointer to phy_device to attach
1307 * @flags: PHY device's dev_flags
1308 * @interface: PHY device's interface
1310 * Description: Called by drivers to attach to a particular PHY
1311 * device. The phy_device is found, and properly hooked up
1312 * to the phy_driver. If no driver is attached, then a
1313 * generic driver is used. The phy_device is given a ptr to
1314 * the attaching device, and given a callback for link status
1315 * change. The phy_device is returned to the attaching driver.
1316 * This function takes a reference on the phy device.
1318 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1319 u32 flags, phy_interface_t interface)
1321 struct mii_bus *bus = phydev->mdio.bus;
1322 struct device *d = &phydev->mdio.dev;
1323 struct module *ndev_owner = NULL;
1324 bool using_genphy = false;
1327 /* For Ethernet device drivers that register their own MDIO bus, we
1328 * will have bus->owner match ndev_mod, so we do not want to increment
1329 * our own module->refcnt here, otherwise we would not be able to
1333 ndev_owner = dev->dev.parent->driver->owner;
1334 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1335 phydev_err(phydev, "failed to get the bus module\n");
1341 /* Assume that if there is no driver, that it doesn't
1342 * exist, and we should use the genphy driver.
1346 d->driver = &genphy_c45_driver.mdiodrv.driver;
1348 d->driver = &genphy_driver.mdiodrv.driver;
1350 using_genphy = true;
1353 if (!try_module_get(d->driver->owner)) {
1354 phydev_err(phydev, "failed to get the device driver module\n");
1356 goto error_put_device;
1360 err = d->driver->probe(d);
1362 err = device_bind_driver(d);
1365 goto error_module_put;
1368 if (phydev->attached_dev) {
1369 dev_err(&dev->dev, "PHY already attached\n");
1374 phydev->phy_link_change = phy_link_change;
1376 phydev->attached_dev = dev;
1377 dev->phydev = phydev;
1379 if (phydev->sfp_bus_attached)
1380 dev->sfp_bus = phydev->sfp_bus;
1383 /* Some Ethernet drivers try to connect to a PHY device before
1384 * calling register_netdevice() -> netdev_register_kobject() and
1385 * does the dev->dev.kobj initialization. Here we only check for
1386 * success which indicates that the network device kobject is
1387 * ready. Once we do that we still need to keep track of whether
1388 * links were successfully set up or not for phy_detach() to
1389 * remove them accordingly.
1391 phydev->sysfs_links = false;
1393 phy_sysfs_create_links(phydev);
1395 if (!phydev->attached_dev) {
1396 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1397 &dev_attr_phy_standalone.attr);
1399 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1402 phydev->dev_flags |= flags;
1404 phydev->interface = interface;
1406 phydev->state = PHY_READY;
1408 /* Initial carrier state is off as the phy is about to be
1412 netif_carrier_off(phydev->attached_dev);
1414 /* Do initial configuration here, now that
1415 * we have certain key parameters
1416 * (dev_flags and interface)
1418 err = phy_init_hw(phydev);
1422 err = phy_disable_interrupts(phydev);
1427 phy_led_triggers_register(phydev);
1432 /* phy_detach() does all of the cleanup below */
1437 module_put(d->driver->owner);
1440 if (ndev_owner != bus->owner)
1441 module_put(bus->owner);
1444 EXPORT_SYMBOL(phy_attach_direct);
1447 * phy_attach - attach a network device to a particular PHY device
1448 * @dev: network device to attach
1449 * @bus_id: Bus ID of PHY device to attach
1450 * @interface: PHY device's interface
1452 * Description: Same as phy_attach_direct() except that a PHY bus_id
1453 * string is passed instead of a pointer to a struct phy_device.
1455 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1456 phy_interface_t interface)
1458 struct bus_type *bus = &mdio_bus_type;
1459 struct phy_device *phydev;
1464 return ERR_PTR(-EINVAL);
1466 /* Search the list of PHY devices on the mdio bus for the
1467 * PHY with the requested name
1469 d = bus_find_device_by_name(bus, NULL, bus_id);
1471 pr_err("PHY %s not found\n", bus_id);
1472 return ERR_PTR(-ENODEV);
1474 phydev = to_phy_device(d);
1476 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1483 EXPORT_SYMBOL(phy_attach);
1485 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1486 struct device_driver *driver)
1488 struct device *d = &phydev->mdio.dev;
1495 ret = d->driver == driver;
1501 bool phy_driver_is_genphy(struct phy_device *phydev)
1503 return phy_driver_is_genphy_kind(phydev,
1504 &genphy_driver.mdiodrv.driver);
1506 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1508 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1510 return phy_driver_is_genphy_kind(phydev,
1511 &genphy_c45_driver.mdiodrv.driver);
1513 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1516 * phy_package_join - join a common PHY group
1517 * @phydev: target phy_device struct
1518 * @addr: cookie and PHY address for global register access
1519 * @priv_size: if non-zero allocate this amount of bytes for private data
1521 * This joins a PHY group and provides a shared storage for all phydevs in
1522 * this group. This is intended to be used for packages which contain
1523 * more than one PHY, for example a quad PHY transceiver.
1525 * The addr parameter serves as a cookie which has to have the same value
1526 * for all members of one group and as a PHY address to access generic
1527 * registers of a PHY package. Usually, one of the PHY addresses of the
1528 * different PHYs in the package provides access to these global registers.
1529 * The address which is given here, will be used in the phy_package_read()
1530 * and phy_package_write() convenience functions. If your PHY doesn't have
1531 * global registers you can just pick any of the PHY addresses.
1533 * This will set the shared pointer of the phydev to the shared storage.
1534 * If this is the first call for a this cookie the shared storage will be
1535 * allocated. If priv_size is non-zero, the given amount of bytes are
1536 * allocated for the priv member.
1538 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1539 * with the same cookie but a different priv_size is an error.
1541 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1543 struct mii_bus *bus = phydev->mdio.bus;
1544 struct phy_package_shared *shared;
1547 if (addr < 0 || addr >= PHY_MAX_ADDR)
1550 mutex_lock(&bus->shared_lock);
1551 shared = bus->shared[addr];
1554 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1558 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1561 shared->priv_size = priv_size;
1563 shared->addr = addr;
1564 refcount_set(&shared->refcnt, 1);
1565 bus->shared[addr] = shared;
1568 if (priv_size && priv_size != shared->priv_size)
1570 refcount_inc(&shared->refcnt);
1572 mutex_unlock(&bus->shared_lock);
1574 phydev->shared = shared;
1581 mutex_unlock(&bus->shared_lock);
1584 EXPORT_SYMBOL_GPL(phy_package_join);
1587 * phy_package_leave - leave a common PHY group
1588 * @phydev: target phy_device struct
1590 * This leaves a PHY group created by phy_package_join(). If this phydev
1591 * was the last user of the shared data between the group, this data is
1592 * freed. Resets the phydev->shared pointer to NULL.
1594 void phy_package_leave(struct phy_device *phydev)
1596 struct phy_package_shared *shared = phydev->shared;
1597 struct mii_bus *bus = phydev->mdio.bus;
1602 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1603 bus->shared[shared->addr] = NULL;
1604 mutex_unlock(&bus->shared_lock);
1605 kfree(shared->priv);
1609 phydev->shared = NULL;
1611 EXPORT_SYMBOL_GPL(phy_package_leave);
1613 static void devm_phy_package_leave(struct device *dev, void *res)
1615 phy_package_leave(*(struct phy_device **)res);
1619 * devm_phy_package_join - resource managed phy_package_join()
1620 * @dev: device that is registering this PHY package
1621 * @phydev: target phy_device struct
1622 * @addr: cookie and PHY address for global register access
1623 * @priv_size: if non-zero allocate this amount of bytes for private data
1625 * Managed phy_package_join(). Shared storage fetched by this function,
1626 * phy_package_leave() is automatically called on driver detach. See
1627 * phy_package_join() for more information.
1629 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1630 int addr, size_t priv_size)
1632 struct phy_device **ptr;
1635 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1640 ret = phy_package_join(phydev, addr, priv_size);
1644 devres_add(dev, ptr);
1651 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1654 * phy_detach - detach a PHY device from its network device
1655 * @phydev: target phy_device struct
1657 * This detaches the phy device from its network device and the phy
1658 * driver, and drops the reference count taken in phy_attach_direct().
1660 void phy_detach(struct phy_device *phydev)
1662 struct net_device *dev = phydev->attached_dev;
1663 struct module *ndev_owner = NULL;
1664 struct mii_bus *bus;
1666 if (phydev->sysfs_links) {
1668 sysfs_remove_link(&dev->dev.kobj, "phydev");
1669 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1672 if (!phydev->attached_dev)
1673 sysfs_remove_file(&phydev->mdio.dev.kobj,
1674 &dev_attr_phy_standalone.attr);
1676 phy_suspend(phydev);
1678 phydev->attached_dev->phydev = NULL;
1679 phydev->attached_dev = NULL;
1681 phydev->phylink = NULL;
1683 phy_led_triggers_unregister(phydev);
1685 if (phydev->mdio.dev.driver)
1686 module_put(phydev->mdio.dev.driver->owner);
1688 /* If the device had no specific driver before (i.e. - it
1689 * was using the generic driver), we unbind the device
1690 * from the generic driver so that there's a chance a
1691 * real driver could be loaded
1693 if (phy_driver_is_genphy(phydev) ||
1694 phy_driver_is_genphy_10g(phydev))
1695 device_release_driver(&phydev->mdio.dev);
1698 * The phydev might go away on the put_device() below, so avoid
1699 * a use-after-free bug by reading the underlying bus first.
1701 bus = phydev->mdio.bus;
1703 put_device(&phydev->mdio.dev);
1705 ndev_owner = dev->dev.parent->driver->owner;
1706 if (ndev_owner != bus->owner)
1707 module_put(bus->owner);
1709 /* Assert the reset signal */
1710 phy_device_reset(phydev, 1);
1712 EXPORT_SYMBOL(phy_detach);
1714 int phy_suspend(struct phy_device *phydev)
1716 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1717 struct net_device *netdev = phydev->attached_dev;
1718 struct phy_driver *phydrv = phydev->drv;
1721 if (phydev->suspended)
1724 /* If the device has WOL enabled, we cannot suspend the PHY */
1725 phy_ethtool_get_wol(phydev, &wol);
1726 if (wol.wolopts || (netdev && netdev->wol_enabled))
1729 if (!phydrv || !phydrv->suspend)
1732 ret = phydrv->suspend(phydev);
1734 phydev->suspended = true;
1738 EXPORT_SYMBOL(phy_suspend);
1740 int __phy_resume(struct phy_device *phydev)
1742 struct phy_driver *phydrv = phydev->drv;
1745 WARN_ON(!mutex_is_locked(&phydev->lock));
1747 if (!phydrv || !phydrv->resume)
1750 ret = phydrv->resume(phydev);
1752 phydev->suspended = false;
1756 EXPORT_SYMBOL(__phy_resume);
1758 int phy_resume(struct phy_device *phydev)
1762 mutex_lock(&phydev->lock);
1763 ret = __phy_resume(phydev);
1764 mutex_unlock(&phydev->lock);
1768 EXPORT_SYMBOL(phy_resume);
1770 int phy_loopback(struct phy_device *phydev, bool enable)
1772 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1775 mutex_lock(&phydev->lock);
1777 if (enable && phydev->loopback_enabled) {
1782 if (!enable && !phydev->loopback_enabled) {
1787 if (phydev->drv && phydrv->set_loopback)
1788 ret = phydrv->set_loopback(phydev, enable);
1795 phydev->loopback_enabled = enable;
1798 mutex_unlock(&phydev->lock);
1801 EXPORT_SYMBOL(phy_loopback);
1804 * phy_reset_after_clk_enable - perform a PHY reset if needed
1805 * @phydev: target phy_device struct
1807 * Description: Some PHYs are known to need a reset after their refclk was
1808 * enabled. This function evaluates the flags and perform the reset if it's
1809 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1812 int phy_reset_after_clk_enable(struct phy_device *phydev)
1814 if (!phydev || !phydev->drv)
1817 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1818 phy_device_reset(phydev, 1);
1819 phy_device_reset(phydev, 0);
1825 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1827 /* Generic PHY support and helper functions */
1830 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1831 * @phydev: target phy_device struct
1833 * Description: Writes MII_ADVERTISE with the appropriate values,
1834 * after sanitizing the values to make sure we only advertise
1835 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1836 * hasn't changed, and > 0 if it has changed.
1838 static int genphy_config_advert(struct phy_device *phydev)
1840 int err, bmsr, changed = 0;
1843 /* Only allow advertising what this PHY supports */
1844 linkmode_and(phydev->advertising, phydev->advertising,
1847 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1849 /* Setup standard advertisement */
1850 err = phy_modify_changed(phydev, MII_ADVERTISE,
1851 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1852 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1859 bmsr = phy_read(phydev, MII_BMSR);
1863 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1864 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1867 if (!(bmsr & BMSR_ESTATEN))
1870 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1872 err = phy_modify_changed(phydev, MII_CTRL1000,
1873 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1884 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1885 * @phydev: target phy_device struct
1887 * Description: Writes MII_ADVERTISE with the appropriate values,
1888 * after sanitizing the values to make sure we only advertise
1889 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1890 * hasn't changed, and > 0 if it has changed. This function is intended
1891 * for Clause 37 1000Base-X mode.
1893 static int genphy_c37_config_advert(struct phy_device *phydev)
1897 /* Only allow advertising what this PHY supports */
1898 linkmode_and(phydev->advertising, phydev->advertising,
1901 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1902 phydev->advertising))
1903 adv |= ADVERTISE_1000XFULL;
1904 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1905 phydev->advertising))
1906 adv |= ADVERTISE_1000XPAUSE;
1907 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1908 phydev->advertising))
1909 adv |= ADVERTISE_1000XPSE_ASYM;
1911 return phy_modify_changed(phydev, MII_ADVERTISE,
1912 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1913 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1918 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1919 * @phydev: target phy_device struct
1921 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1922 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1923 * changed, and 1 if it has changed.
1925 int genphy_config_eee_advert(struct phy_device *phydev)
1929 /* Nothing to disable */
1930 if (!phydev->eee_broken_modes)
1933 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1934 phydev->eee_broken_modes, 0);
1935 /* If the call failed, we assume that EEE is not supported */
1936 return err < 0 ? 0 : err;
1938 EXPORT_SYMBOL(genphy_config_eee_advert);
1941 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1942 * @phydev: target phy_device struct
1944 * Description: Configures MII_BMCR to force speed/duplex
1945 * to the values in phydev. Assumes that the values are valid.
1946 * Please see phy_sanitize_settings().
1948 int genphy_setup_forced(struct phy_device *phydev)
1953 phydev->asym_pause = 0;
1955 if (SPEED_1000 == phydev->speed)
1956 ctl |= BMCR_SPEED1000;
1957 else if (SPEED_100 == phydev->speed)
1958 ctl |= BMCR_SPEED100;
1960 if (DUPLEX_FULL == phydev->duplex)
1961 ctl |= BMCR_FULLDPLX;
1963 return phy_modify(phydev, MII_BMCR,
1964 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1966 EXPORT_SYMBOL(genphy_setup_forced);
1968 static int genphy_setup_master_slave(struct phy_device *phydev)
1972 if (!phydev->is_gigabit_capable)
1975 switch (phydev->master_slave_set) {
1976 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1977 ctl |= CTL1000_PREFER_MASTER;
1979 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1981 case MASTER_SLAVE_CFG_MASTER_FORCE:
1982 ctl |= CTL1000_AS_MASTER;
1984 case MASTER_SLAVE_CFG_SLAVE_FORCE:
1985 ctl |= CTL1000_ENABLE_MASTER;
1987 case MASTER_SLAVE_CFG_UNKNOWN:
1988 case MASTER_SLAVE_CFG_UNSUPPORTED:
1991 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
1995 return phy_modify_changed(phydev, MII_CTRL1000,
1996 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
1997 CTL1000_PREFER_MASTER), ctl);
2000 static int genphy_read_master_slave(struct phy_device *phydev)
2005 if (!phydev->is_gigabit_capable) {
2006 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2007 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2011 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2012 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2014 val = phy_read(phydev, MII_CTRL1000);
2018 if (val & CTL1000_ENABLE_MASTER) {
2019 if (val & CTL1000_AS_MASTER)
2020 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2022 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2024 if (val & CTL1000_PREFER_MASTER)
2025 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2027 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2030 val = phy_read(phydev, MII_STAT1000);
2034 if (val & LPA_1000MSFAIL) {
2035 state = MASTER_SLAVE_STATE_ERR;
2036 } else if (phydev->link) {
2037 /* this bits are valid only for active link */
2038 if (val & LPA_1000MSRES)
2039 state = MASTER_SLAVE_STATE_MASTER;
2041 state = MASTER_SLAVE_STATE_SLAVE;
2043 state = MASTER_SLAVE_STATE_UNKNOWN;
2046 phydev->master_slave_get = cfg;
2047 phydev->master_slave_state = state;
2053 * genphy_restart_aneg - Enable and Restart Autonegotiation
2054 * @phydev: target phy_device struct
2056 int genphy_restart_aneg(struct phy_device *phydev)
2058 /* Don't isolate the PHY if we're negotiating */
2059 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2060 BMCR_ANENABLE | BMCR_ANRESTART);
2062 EXPORT_SYMBOL(genphy_restart_aneg);
2065 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2066 * @phydev: target phy_device struct
2067 * @restart: whether aneg restart is requested
2069 * Check, and restart auto-negotiation if needed.
2071 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2076 /* Advertisement hasn't changed, but maybe aneg was never on to
2077 * begin with? Or maybe phy was isolated?
2079 ret = phy_read(phydev, MII_BMCR);
2083 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2088 return genphy_restart_aneg(phydev);
2092 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2095 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2096 * @phydev: target phy_device struct
2097 * @changed: whether autoneg is requested
2099 * Description: If auto-negotiation is enabled, we configure the
2100 * advertising, and then restart auto-negotiation. If it is not
2101 * enabled, then we write the BMCR.
2103 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2107 if (genphy_config_eee_advert(phydev))
2110 err = genphy_setup_master_slave(phydev);
2116 if (AUTONEG_ENABLE != phydev->autoneg)
2117 return genphy_setup_forced(phydev);
2119 err = genphy_config_advert(phydev);
2120 if (err < 0) /* error */
2125 return genphy_check_and_restart_aneg(phydev, changed);
2127 EXPORT_SYMBOL(__genphy_config_aneg);
2130 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2131 * @phydev: target phy_device struct
2133 * Description: If auto-negotiation is enabled, we configure the
2134 * advertising, and then restart auto-negotiation. If it is not
2135 * enabled, then we write the BMCR. This function is intended
2136 * for use with Clause 37 1000Base-X mode.
2138 int genphy_c37_config_aneg(struct phy_device *phydev)
2142 if (phydev->autoneg != AUTONEG_ENABLE)
2143 return genphy_setup_forced(phydev);
2145 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2150 changed = genphy_c37_config_advert(phydev);
2151 if (changed < 0) /* error */
2155 /* Advertisement hasn't changed, but maybe aneg was never on to
2156 * begin with? Or maybe phy was isolated?
2158 int ctl = phy_read(phydev, MII_BMCR);
2163 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2164 changed = 1; /* do restart aneg */
2167 /* Only restart aneg if we are advertising something different
2168 * than we were before.
2171 return genphy_restart_aneg(phydev);
2175 EXPORT_SYMBOL(genphy_c37_config_aneg);
2178 * genphy_aneg_done - return auto-negotiation status
2179 * @phydev: target phy_device struct
2181 * Description: Reads the status register and returns 0 either if
2182 * auto-negotiation is incomplete, or if there was an error.
2183 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2185 int genphy_aneg_done(struct phy_device *phydev)
2187 int retval = phy_read(phydev, MII_BMSR);
2189 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2191 EXPORT_SYMBOL(genphy_aneg_done);
2194 * genphy_update_link - update link status in @phydev
2195 * @phydev: target phy_device struct
2197 * Description: Update the value in phydev->link to reflect the
2198 * current link value. In order to do this, we need to read
2199 * the status register twice, keeping the second value.
2201 int genphy_update_link(struct phy_device *phydev)
2203 int status = 0, bmcr;
2205 bmcr = phy_read(phydev, MII_BMCR);
2209 /* Autoneg is being started, therefore disregard BMSR value and
2210 * report link as down.
2212 if (bmcr & BMCR_ANRESTART)
2215 /* The link state is latched low so that momentary link
2216 * drops can be detected. Do not double-read the status
2217 * in polling mode to detect such short link drops except
2218 * the link was already down.
2220 if (!phy_polling_mode(phydev) || !phydev->link) {
2221 status = phy_read(phydev, MII_BMSR);
2224 else if (status & BMSR_LSTATUS)
2228 /* Read link and autonegotiation status */
2229 status = phy_read(phydev, MII_BMSR);
2233 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2234 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2236 /* Consider the case that autoneg was started and "aneg complete"
2237 * bit has been reset, but "link up" bit not yet.
2239 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2244 EXPORT_SYMBOL(genphy_update_link);
2246 int genphy_read_lpa(struct phy_device *phydev)
2250 if (phydev->autoneg == AUTONEG_ENABLE) {
2251 if (!phydev->autoneg_complete) {
2252 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2254 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2258 if (phydev->is_gigabit_capable) {
2259 lpagb = phy_read(phydev, MII_STAT1000);
2263 if (lpagb & LPA_1000MSFAIL) {
2264 int adv = phy_read(phydev, MII_CTRL1000);
2269 if (adv & CTL1000_ENABLE_MASTER)
2270 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2272 phydev_err(phydev, "Master/Slave resolution failed\n");
2276 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2280 lpa = phy_read(phydev, MII_LPA);
2284 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2286 linkmode_zero(phydev->lp_advertising);
2291 EXPORT_SYMBOL(genphy_read_lpa);
2294 * genphy_read_status_fixed - read the link parameters for !aneg mode
2295 * @phydev: target phy_device struct
2297 * Read the current duplex and speed state for a PHY operating with
2298 * autonegotiation disabled.
2300 int genphy_read_status_fixed(struct phy_device *phydev)
2302 int bmcr = phy_read(phydev, MII_BMCR);
2307 if (bmcr & BMCR_FULLDPLX)
2308 phydev->duplex = DUPLEX_FULL;
2310 phydev->duplex = DUPLEX_HALF;
2312 if (bmcr & BMCR_SPEED1000)
2313 phydev->speed = SPEED_1000;
2314 else if (bmcr & BMCR_SPEED100)
2315 phydev->speed = SPEED_100;
2317 phydev->speed = SPEED_10;
2321 EXPORT_SYMBOL(genphy_read_status_fixed);
2324 * genphy_read_status - check the link status and update current link state
2325 * @phydev: target phy_device struct
2327 * Description: Check the link, then figure out the current state
2328 * by comparing what we advertise with what the link partner
2329 * advertises. Start by checking the gigabit possibilities,
2330 * then move on to 10/100.
2332 int genphy_read_status(struct phy_device *phydev)
2334 int err, old_link = phydev->link;
2336 /* Update the link, but return if there was an error */
2337 err = genphy_update_link(phydev);
2341 /* why bother the PHY if nothing can have changed */
2342 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2345 phydev->speed = SPEED_UNKNOWN;
2346 phydev->duplex = DUPLEX_UNKNOWN;
2348 phydev->asym_pause = 0;
2350 err = genphy_read_master_slave(phydev);
2354 err = genphy_read_lpa(phydev);
2358 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2359 phy_resolve_aneg_linkmode(phydev);
2360 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2361 err = genphy_read_status_fixed(phydev);
2368 EXPORT_SYMBOL(genphy_read_status);
2371 * genphy_c37_read_status - check the link status and update current link state
2372 * @phydev: target phy_device struct
2374 * Description: Check the link, then figure out the current state
2375 * by comparing what we advertise with what the link partner
2376 * advertises. This function is for Clause 37 1000Base-X mode.
2378 int genphy_c37_read_status(struct phy_device *phydev)
2380 int lpa, err, old_link = phydev->link;
2382 /* Update the link, but return if there was an error */
2383 err = genphy_update_link(phydev);
2387 /* why bother the PHY if nothing can have changed */
2388 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2391 phydev->duplex = DUPLEX_UNKNOWN;
2393 phydev->asym_pause = 0;
2395 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2396 lpa = phy_read(phydev, MII_LPA);
2400 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2401 phydev->lp_advertising, lpa & LPA_LPACK);
2402 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2403 phydev->lp_advertising, lpa & LPA_1000XFULL);
2404 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2405 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2406 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2407 phydev->lp_advertising,
2408 lpa & LPA_1000XPAUSE_ASYM);
2410 phy_resolve_aneg_linkmode(phydev);
2411 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2412 int bmcr = phy_read(phydev, MII_BMCR);
2417 if (bmcr & BMCR_FULLDPLX)
2418 phydev->duplex = DUPLEX_FULL;
2420 phydev->duplex = DUPLEX_HALF;
2425 EXPORT_SYMBOL(genphy_c37_read_status);
2428 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2429 * @phydev: target phy_device struct
2431 * Description: Perform a software PHY reset using the standard
2432 * BMCR_RESET bit and poll for the reset bit to be cleared.
2434 * Returns: 0 on success, < 0 on failure
2436 int genphy_soft_reset(struct phy_device *phydev)
2438 u16 res = BMCR_RESET;
2441 if (phydev->autoneg == AUTONEG_ENABLE)
2442 res |= BMCR_ANRESTART;
2444 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2448 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2449 * to their default value. Therefore the POWER DOWN bit is supposed to
2450 * be cleared after soft reset.
2452 phydev->suspended = 0;
2454 ret = phy_poll_reset(phydev);
2458 /* BMCR may be reset to defaults */
2459 if (phydev->autoneg == AUTONEG_DISABLE)
2460 ret = genphy_setup_forced(phydev);
2464 EXPORT_SYMBOL(genphy_soft_reset);
2467 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2468 * @phydev: target phy_device struct
2470 * Description: Reads the PHY's abilities and populates
2471 * phydev->supported accordingly.
2473 * Returns: 0 on success, < 0 on failure
2475 int genphy_read_abilities(struct phy_device *phydev)
2479 linkmode_set_bit_array(phy_basic_ports_array,
2480 ARRAY_SIZE(phy_basic_ports_array),
2483 val = phy_read(phydev, MII_BMSR);
2487 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2488 val & BMSR_ANEGCAPABLE);
2490 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2491 val & BMSR_100FULL);
2492 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2493 val & BMSR_100HALF);
2494 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2496 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2499 if (val & BMSR_ESTATEN) {
2500 val = phy_read(phydev, MII_ESTATUS);
2504 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2505 phydev->supported, val & ESTATUS_1000_TFULL);
2506 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2507 phydev->supported, val & ESTATUS_1000_THALF);
2508 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2509 phydev->supported, val & ESTATUS_1000_XFULL);
2514 EXPORT_SYMBOL(genphy_read_abilities);
2516 /* This is used for the phy device which doesn't support the MMD extended
2517 * register access, but it does have side effect when we are trying to access
2518 * the MMD register via indirect method.
2520 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2524 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2526 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2527 u16 regnum, u16 val)
2531 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2533 int genphy_suspend(struct phy_device *phydev)
2535 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2537 EXPORT_SYMBOL(genphy_suspend);
2539 int genphy_resume(struct phy_device *phydev)
2541 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2543 EXPORT_SYMBOL(genphy_resume);
2545 int genphy_loopback(struct phy_device *phydev, bool enable)
2547 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2548 enable ? BMCR_LOOPBACK : 0);
2550 EXPORT_SYMBOL(genphy_loopback);
2553 * phy_remove_link_mode - Remove a supported link mode
2554 * @phydev: phy_device structure to remove link mode from
2555 * @link_mode: Link mode to be removed
2557 * Description: Some MACs don't support all link modes which the PHY
2558 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2559 * to remove a link mode.
2561 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2563 linkmode_clear_bit(link_mode, phydev->supported);
2564 phy_advertise_supported(phydev);
2566 EXPORT_SYMBOL(phy_remove_link_mode);
2568 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2570 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2571 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2572 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2573 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2577 * phy_advertise_supported - Advertise all supported modes
2578 * @phydev: target phy_device struct
2580 * Description: Called to advertise all supported modes, doesn't touch
2581 * pause mode advertising.
2583 void phy_advertise_supported(struct phy_device *phydev)
2585 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2587 linkmode_copy(new, phydev->supported);
2588 phy_copy_pause_bits(new, phydev->advertising);
2589 linkmode_copy(phydev->advertising, new);
2591 EXPORT_SYMBOL(phy_advertise_supported);
2594 * phy_support_sym_pause - Enable support of symmetrical pause
2595 * @phydev: target phy_device struct
2597 * Description: Called by the MAC to indicate is supports symmetrical
2598 * Pause, but not asym pause.
2600 void phy_support_sym_pause(struct phy_device *phydev)
2602 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2603 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2605 EXPORT_SYMBOL(phy_support_sym_pause);
2608 * phy_support_asym_pause - Enable support of asym pause
2609 * @phydev: target phy_device struct
2611 * Description: Called by the MAC to indicate is supports Asym Pause.
2613 void phy_support_asym_pause(struct phy_device *phydev)
2615 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2617 EXPORT_SYMBOL(phy_support_asym_pause);
2620 * phy_set_sym_pause - Configure symmetric Pause
2621 * @phydev: target phy_device struct
2622 * @rx: Receiver Pause is supported
2623 * @tx: Transmit Pause is supported
2624 * @autoneg: Auto neg should be used
2626 * Description: Configure advertised Pause support depending on if
2627 * receiver pause and pause auto neg is supported. Generally called
2628 * from the set_pauseparam .ndo.
2630 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2633 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2635 if (rx && tx && autoneg)
2636 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2639 linkmode_copy(phydev->advertising, phydev->supported);
2641 EXPORT_SYMBOL(phy_set_sym_pause);
2644 * phy_set_asym_pause - Configure Pause and Asym Pause
2645 * @phydev: target phy_device struct
2646 * @rx: Receiver Pause is supported
2647 * @tx: Transmit Pause is supported
2649 * Description: Configure advertised Pause support depending on if
2650 * transmit and receiver pause is supported. If there has been a
2651 * change in adverting, trigger a new autoneg. Generally called from
2652 * the set_pauseparam .ndo.
2654 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2656 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2658 linkmode_copy(oldadv, phydev->advertising);
2659 linkmode_set_pause(phydev->advertising, tx, rx);
2661 if (!linkmode_equal(oldadv, phydev->advertising) &&
2663 phy_start_aneg(phydev);
2665 EXPORT_SYMBOL(phy_set_asym_pause);
2668 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2669 * @phydev: phy_device struct
2670 * @pp: requested pause configuration
2672 * Description: Test if the PHY/MAC combination supports the Pause
2673 * configuration the user is requesting. Returns True if it is
2674 * supported, false otherwise.
2676 bool phy_validate_pause(struct phy_device *phydev,
2677 struct ethtool_pauseparam *pp)
2679 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2680 phydev->supported) && pp->rx_pause)
2683 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2684 phydev->supported) &&
2685 pp->rx_pause != pp->tx_pause)
2690 EXPORT_SYMBOL(phy_validate_pause);
2693 * phy_get_pause - resolve negotiated pause modes
2694 * @phydev: phy_device struct
2695 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2697 * @rx_pause: pointer to bool to indicate whether receive pause should be
2700 * Resolve and return the flow control modes according to the negotiation
2701 * result. This includes checking that we are operating in full duplex mode.
2702 * See linkmode_resolve_pause() for further details.
2704 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2706 if (phydev->duplex != DUPLEX_FULL) {
2712 return linkmode_resolve_pause(phydev->advertising,
2713 phydev->lp_advertising,
2714 tx_pause, rx_pause);
2716 EXPORT_SYMBOL(phy_get_pause);
2718 #if IS_ENABLED(CONFIG_OF_MDIO)
2719 static int phy_get_int_delay_property(struct device *dev, const char *name)
2724 ret = device_property_read_u32(dev, name, &int_delay);
2731 static int phy_get_int_delay_property(struct device *dev, const char *name)
2738 * phy_get_delay_index - returns the index of the internal delay
2739 * @phydev: phy_device struct
2740 * @dev: pointer to the devices device struct
2741 * @delay_values: array of delays the PHY supports
2742 * @size: the size of the delay array
2743 * @is_rx: boolean to indicate to get the rx internal delay
2745 * Returns the index within the array of internal delay passed in.
2746 * If the device property is not present then the interface type is checked
2747 * if the interface defines use of internal delay then a 1 is returned otherwise
2749 * The array must be in ascending order. If PHY does not have an ascending order
2750 * array then size = 0 and the value of the delay property is returned.
2751 * Return -EINVAL if the delay is invalid or cannot be found.
2753 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2754 const int *delay_values, int size, bool is_rx)
2760 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
2761 if (delay < 0 && size == 0) {
2762 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2763 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
2770 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
2771 if (delay < 0 && size == 0) {
2772 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2773 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
2783 if (delay && size == 0)
2786 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
2787 phydev_err(phydev, "Delay %d is out of range\n", delay);
2791 if (delay == delay_values[0])
2794 for (i = 1; i < size; i++) {
2795 if (delay == delay_values[i])
2798 /* Find an approximate index by looking up the table */
2799 if (delay > delay_values[i - 1] &&
2800 delay < delay_values[i]) {
2801 if (delay - delay_values[i - 1] <
2802 delay_values[i] - delay)
2809 phydev_err(phydev, "error finding internal delay index for %d\n",
2814 EXPORT_SYMBOL(phy_get_internal_delay);
2816 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2818 return phydrv->config_intr && (phydrv->ack_interrupt || phydrv->handle_interrupt);
2822 * phy_probe - probe and init a PHY device
2823 * @dev: device to probe and init
2825 * Description: Take care of setting up the phy_device structure,
2826 * set the state to READY (the driver's init function should
2827 * set it to STARTING if needed).
2829 static int phy_probe(struct device *dev)
2831 struct phy_device *phydev = to_phy_device(dev);
2832 struct device_driver *drv = phydev->mdio.dev.driver;
2833 struct phy_driver *phydrv = to_phy_driver(drv);
2836 phydev->drv = phydrv;
2838 /* Disable the interrupt if the PHY doesn't support it
2839 * but the interrupt is still a valid one
2841 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2842 phydev->irq = PHY_POLL;
2844 if (phydrv->flags & PHY_IS_INTERNAL)
2845 phydev->is_internal = true;
2847 mutex_lock(&phydev->lock);
2849 /* Deassert the reset signal */
2850 phy_device_reset(phydev, 0);
2852 if (phydev->drv->probe) {
2853 err = phydev->drv->probe(phydev);
2858 /* Start out supporting everything. Eventually,
2859 * a controller will attach, and may modify one
2860 * or both of these values
2862 if (phydrv->features) {
2863 linkmode_copy(phydev->supported, phydrv->features);
2864 } else if (phydrv->get_features) {
2865 err = phydrv->get_features(phydev);
2866 } else if (phydev->is_c45) {
2867 err = genphy_c45_pma_read_abilities(phydev);
2869 err = genphy_read_abilities(phydev);
2875 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2877 phydev->autoneg = 0;
2879 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2881 phydev->is_gigabit_capable = 1;
2882 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2884 phydev->is_gigabit_capable = 1;
2886 of_set_phy_supported(phydev);
2887 phy_advertise_supported(phydev);
2889 /* Get the EEE modes we want to prohibit. We will ask
2890 * the PHY stop advertising these mode later on
2892 of_set_phy_eee_broken(phydev);
2894 /* The Pause Frame bits indicate that the PHY can support passing
2895 * pause frames. During autonegotiation, the PHYs will determine if
2896 * they should allow pause frames to pass. The MAC driver should then
2897 * use that result to determine whether to enable flow control via
2900 * Normally, PHY drivers should not set the Pause bits, and instead
2901 * allow phylib to do that. However, there may be some situations
2902 * (e.g. hardware erratum) where the driver wants to set only one
2905 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2906 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2907 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2909 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2913 /* Set the state to READY by default */
2914 phydev->state = PHY_READY;
2917 /* Assert the reset signal */
2919 phy_device_reset(phydev, 1);
2921 mutex_unlock(&phydev->lock);
2926 static int phy_remove(struct device *dev)
2928 struct phy_device *phydev = to_phy_device(dev);
2930 cancel_delayed_work_sync(&phydev->state_queue);
2932 mutex_lock(&phydev->lock);
2933 phydev->state = PHY_DOWN;
2934 mutex_unlock(&phydev->lock);
2936 sfp_bus_del_upstream(phydev->sfp_bus);
2937 phydev->sfp_bus = NULL;
2939 if (phydev->drv && phydev->drv->remove)
2940 phydev->drv->remove(phydev);
2942 /* Assert the reset signal */
2943 phy_device_reset(phydev, 1);
2950 static void phy_shutdown(struct device *dev)
2952 struct phy_device *phydev = to_phy_device(dev);
2954 phy_disable_interrupts(phydev);
2958 * phy_driver_register - register a phy_driver with the PHY layer
2959 * @new_driver: new phy_driver to register
2960 * @owner: module owning this PHY
2962 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2966 /* Either the features are hard coded, or dynamically
2967 * determined. It cannot be both.
2969 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2970 pr_err("%s: features and get_features must not both be set\n",
2975 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2976 new_driver->mdiodrv.driver.name = new_driver->name;
2977 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2978 new_driver->mdiodrv.driver.probe = phy_probe;
2979 new_driver->mdiodrv.driver.remove = phy_remove;
2980 new_driver->mdiodrv.driver.shutdown = phy_shutdown;
2981 new_driver->mdiodrv.driver.owner = owner;
2982 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2984 retval = driver_register(&new_driver->mdiodrv.driver);
2986 pr_err("%s: Error %d in registering driver\n",
2987 new_driver->name, retval);
2992 pr_debug("%s: Registered new driver\n", new_driver->name);
2996 EXPORT_SYMBOL(phy_driver_register);
2998 int phy_drivers_register(struct phy_driver *new_driver, int n,
2999 struct module *owner)
3003 for (i = 0; i < n; i++) {
3004 ret = phy_driver_register(new_driver + i, owner);
3007 phy_driver_unregister(new_driver + i);
3013 EXPORT_SYMBOL(phy_drivers_register);
3015 void phy_driver_unregister(struct phy_driver *drv)
3017 driver_unregister(&drv->mdiodrv.driver);
3019 EXPORT_SYMBOL(phy_driver_unregister);
3021 void phy_drivers_unregister(struct phy_driver *drv, int n)
3025 for (i = 0; i < n; i++)
3026 phy_driver_unregister(drv + i);
3028 EXPORT_SYMBOL(phy_drivers_unregister);
3030 static struct phy_driver genphy_driver = {
3031 .phy_id = 0xffffffff,
3032 .phy_id_mask = 0xffffffff,
3033 .name = "Generic PHY",
3034 .get_features = genphy_read_abilities,
3035 .suspend = genphy_suspend,
3036 .resume = genphy_resume,
3037 .set_loopback = genphy_loopback,
3040 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3041 .get_sset_count = phy_ethtool_get_sset_count,
3042 .get_strings = phy_ethtool_get_strings,
3043 .get_stats = phy_ethtool_get_stats,
3044 .start_cable_test = phy_start_cable_test,
3045 .start_cable_test_tdr = phy_start_cable_test_tdr,
3048 static int __init phy_init(void)
3052 rc = mdio_bus_init();
3056 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3059 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3063 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3065 phy_driver_unregister(&genphy_c45_driver);
3073 static void __exit phy_exit(void)
3075 phy_driver_unregister(&genphy_c45_driver);
3076 phy_driver_unregister(&genphy_driver);
3078 ethtool_set_ethtool_phy_ops(NULL);
3081 subsys_initcall(phy_init);
3082 module_exit(phy_exit);