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/kernel.h>
13 #include <linux/string.h>
14 #include <linux/errno.h>
15 #include <linux/unistd.h>
16 #include <linux/slab.h>
17 #include <linux/interrupt.h>
18 #include <linux/init.h>
19 #include <linux/delay.h>
20 #include <linux/netdevice.h>
21 #include <linux/etherdevice.h>
22 #include <linux/skbuff.h>
24 #include <linux/module.h>
25 #include <linux/mii.h>
26 #include <linux/ethtool.h>
27 #include <linux/bitmap.h>
28 #include <linux/phy.h>
29 #include <linux/phy_led_triggers.h>
30 #include <linux/sfp.h>
31 #include <linux/mdio.h>
33 #include <linux/uaccess.h>
35 MODULE_DESCRIPTION("PHY library");
36 MODULE_AUTHOR("Andy Fleming");
37 MODULE_LICENSE("GPL");
39 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
40 EXPORT_SYMBOL_GPL(phy_basic_features);
42 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
43 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
45 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
46 EXPORT_SYMBOL_GPL(phy_gbit_features);
48 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
49 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
51 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
52 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
54 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
55 EXPORT_SYMBOL_GPL(phy_10gbit_features);
57 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
58 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
60 const int phy_basic_ports_array[3] = {
61 ETHTOOL_LINK_MODE_Autoneg_BIT,
62 ETHTOOL_LINK_MODE_TP_BIT,
63 ETHTOOL_LINK_MODE_MII_BIT,
65 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
67 const int phy_fibre_port_array[1] = {
68 ETHTOOL_LINK_MODE_FIBRE_BIT,
70 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
72 const int phy_all_ports_features_array[7] = {
73 ETHTOOL_LINK_MODE_Autoneg_BIT,
74 ETHTOOL_LINK_MODE_TP_BIT,
75 ETHTOOL_LINK_MODE_MII_BIT,
76 ETHTOOL_LINK_MODE_FIBRE_BIT,
77 ETHTOOL_LINK_MODE_AUI_BIT,
78 ETHTOOL_LINK_MODE_BNC_BIT,
79 ETHTOOL_LINK_MODE_Backplane_BIT,
81 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
83 const int phy_10_100_features_array[4] = {
84 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
85 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
86 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
87 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
89 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
91 const int phy_basic_t1_features_array[2] = {
92 ETHTOOL_LINK_MODE_TP_BIT,
93 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
95 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
97 const int phy_gbit_features_array[2] = {
98 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
99 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
101 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
103 const int phy_10gbit_features_array[1] = {
104 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
106 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
108 const int phy_10gbit_fec_features_array[1] = {
109 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
111 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features_array);
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;
229 extern struct phy_driver genphy_c45_driver;
231 static LIST_HEAD(phy_fixup_list);
232 static DEFINE_MUTEX(phy_fixup_lock);
235 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
237 struct device_driver *drv = phydev->mdio.dev.driver;
238 struct phy_driver *phydrv = to_phy_driver(drv);
239 struct net_device *netdev = phydev->attached_dev;
241 if (!drv || !phydrv->suspend)
244 /* PHY not attached? May suspend if the PHY has not already been
245 * suspended as part of a prior call to phy_disconnect() ->
246 * phy_detach() -> phy_suspend() because the parent netdev might be the
247 * MDIO bus driver and clock gated at this point.
252 if (netdev->wol_enabled)
255 /* As long as not all affected network drivers support the
256 * wol_enabled flag, let's check for hints that WoL is enabled.
257 * Don't suspend PHY if the attached netdev parent may wake up.
258 * The parent may point to a PCI device, as in tg3 driver.
260 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
263 /* Also don't suspend PHY if the netdev itself may wakeup. This
264 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
267 if (device_may_wakeup(&netdev->dev))
271 return !phydev->suspended;
274 static int mdio_bus_phy_suspend(struct device *dev)
276 struct phy_device *phydev = to_phy_device(dev);
278 /* We must stop the state machine manually, otherwise it stops out of
279 * control, possibly with the phydev->lock held. Upon resume, netdev
280 * may call phy routines that try to grab the same lock, and that may
281 * lead to a deadlock.
283 if (phydev->attached_dev && phydev->adjust_link)
284 phy_stop_machine(phydev);
286 if (!mdio_bus_phy_may_suspend(phydev))
289 phydev->suspended_by_mdio_bus = 1;
291 return phy_suspend(phydev);
294 static int mdio_bus_phy_resume(struct device *dev)
296 struct phy_device *phydev = to_phy_device(dev);
299 if (!phydev->suspended_by_mdio_bus)
302 phydev->suspended_by_mdio_bus = 0;
304 ret = phy_resume(phydev);
309 if (phydev->attached_dev && phydev->adjust_link)
310 phy_start_machine(phydev);
315 static int mdio_bus_phy_restore(struct device *dev)
317 struct phy_device *phydev = to_phy_device(dev);
318 struct net_device *netdev = phydev->attached_dev;
324 ret = phy_init_hw(phydev);
328 if (phydev->attached_dev && phydev->adjust_link)
329 phy_start_machine(phydev);
334 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
335 .suspend = mdio_bus_phy_suspend,
336 .resume = mdio_bus_phy_resume,
337 .freeze = mdio_bus_phy_suspend,
338 .thaw = mdio_bus_phy_resume,
339 .restore = mdio_bus_phy_restore,
342 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
346 #define MDIO_BUS_PHY_PM_OPS NULL
348 #endif /* CONFIG_PM */
351 * phy_register_fixup - creates a new phy_fixup and adds it to the list
352 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
353 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
354 * It can also be PHY_ANY_UID
355 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
357 * @run: The actual code to be run when a matching PHY is found
359 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
360 int (*run)(struct phy_device *))
362 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
367 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
368 fixup->phy_uid = phy_uid;
369 fixup->phy_uid_mask = phy_uid_mask;
372 mutex_lock(&phy_fixup_lock);
373 list_add_tail(&fixup->list, &phy_fixup_list);
374 mutex_unlock(&phy_fixup_lock);
378 EXPORT_SYMBOL(phy_register_fixup);
380 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
381 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
382 int (*run)(struct phy_device *))
384 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
386 EXPORT_SYMBOL(phy_register_fixup_for_uid);
388 /* Registers a fixup to be run on the PHY with id string bus_id */
389 int phy_register_fixup_for_id(const char *bus_id,
390 int (*run)(struct phy_device *))
392 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
394 EXPORT_SYMBOL(phy_register_fixup_for_id);
397 * phy_unregister_fixup - remove a phy_fixup from the list
398 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
399 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
400 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
402 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
404 struct list_head *pos, *n;
405 struct phy_fixup *fixup;
410 mutex_lock(&phy_fixup_lock);
411 list_for_each_safe(pos, n, &phy_fixup_list) {
412 fixup = list_entry(pos, struct phy_fixup, list);
414 if ((!strcmp(fixup->bus_id, bus_id)) &&
415 ((fixup->phy_uid & phy_uid_mask) ==
416 (phy_uid & phy_uid_mask))) {
417 list_del(&fixup->list);
423 mutex_unlock(&phy_fixup_lock);
427 EXPORT_SYMBOL(phy_unregister_fixup);
429 /* Unregisters a fixup of any PHY with the UID in phy_uid */
430 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
432 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
434 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
436 /* Unregisters a fixup of the PHY with id string bus_id */
437 int phy_unregister_fixup_for_id(const char *bus_id)
439 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
441 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
443 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
444 * Fixups can be set to match any in one or more fields.
446 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
448 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
449 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
452 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
453 (phydev->phy_id & fixup->phy_uid_mask))
454 if (fixup->phy_uid != PHY_ANY_UID)
460 /* Runs any matching fixups for this phydev */
461 static int phy_scan_fixups(struct phy_device *phydev)
463 struct phy_fixup *fixup;
465 mutex_lock(&phy_fixup_lock);
466 list_for_each_entry(fixup, &phy_fixup_list, list) {
467 if (phy_needs_fixup(phydev, fixup)) {
468 int err = fixup->run(phydev);
471 mutex_unlock(&phy_fixup_lock);
474 phydev->has_fixups = true;
477 mutex_unlock(&phy_fixup_lock);
482 static int phy_bus_match(struct device *dev, struct device_driver *drv)
484 struct phy_device *phydev = to_phy_device(dev);
485 struct phy_driver *phydrv = to_phy_driver(drv);
486 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
489 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
492 if (phydrv->match_phy_device)
493 return phydrv->match_phy_device(phydev);
495 if (phydev->is_c45) {
496 for (i = 1; i < num_ids; i++) {
497 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
500 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
501 (phydev->c45_ids.device_ids[i] &
502 phydrv->phy_id_mask))
507 return (phydrv->phy_id & phydrv->phy_id_mask) ==
508 (phydev->phy_id & phydrv->phy_id_mask);
513 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
515 struct phy_device *phydev = to_phy_device(dev);
517 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
519 static DEVICE_ATTR_RO(phy_id);
522 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
524 struct phy_device *phydev = to_phy_device(dev);
525 const char *mode = NULL;
527 if (phy_is_internal(phydev))
530 mode = phy_modes(phydev->interface);
532 return sprintf(buf, "%s\n", mode);
534 static DEVICE_ATTR_RO(phy_interface);
537 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
540 struct phy_device *phydev = to_phy_device(dev);
542 return sprintf(buf, "%d\n", phydev->has_fixups);
544 static DEVICE_ATTR_RO(phy_has_fixups);
546 static struct attribute *phy_dev_attrs[] = {
547 &dev_attr_phy_id.attr,
548 &dev_attr_phy_interface.attr,
549 &dev_attr_phy_has_fixups.attr,
552 ATTRIBUTE_GROUPS(phy_dev);
554 static const struct device_type mdio_bus_phy_type = {
556 .groups = phy_dev_groups,
557 .release = phy_device_release,
558 .pm = MDIO_BUS_PHY_PM_OPS,
561 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
565 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
566 MDIO_ID_ARGS(phy_id));
567 /* We only check for failures in executing the usermode binary,
568 * not whether a PHY driver module exists for the PHY ID.
569 * Accept -ENOENT because this may occur in case no initramfs exists,
570 * then modprobe isn't available.
572 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
573 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
574 ret, (unsigned long)phy_id);
581 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
583 struct phy_c45_device_ids *c45_ids)
585 struct phy_device *dev;
586 struct mdio_device *mdiodev;
589 /* We allocate the device, and initialize the default values */
590 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
592 return ERR_PTR(-ENOMEM);
594 mdiodev = &dev->mdio;
595 mdiodev->dev.parent = &bus->dev;
596 mdiodev->dev.bus = &mdio_bus_type;
597 mdiodev->dev.type = &mdio_bus_phy_type;
599 mdiodev->bus_match = phy_bus_match;
600 mdiodev->addr = addr;
601 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
602 mdiodev->device_free = phy_mdio_device_free;
603 mdiodev->device_remove = phy_mdio_device_remove;
605 dev->speed = SPEED_UNKNOWN;
606 dev->duplex = DUPLEX_UNKNOWN;
610 dev->interface = PHY_INTERFACE_MODE_GMII;
612 dev->autoneg = AUTONEG_ENABLE;
614 dev->is_c45 = is_c45;
615 dev->phy_id = phy_id;
617 dev->c45_ids = *c45_ids;
618 dev->irq = bus->irq[addr];
619 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
621 dev->state = PHY_DOWN;
623 mutex_init(&dev->lock);
624 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
626 /* Request the appropriate module unconditionally; don't
627 * bother trying to do so only if it isn't already loaded,
628 * because that gets complicated. A hotplug event would have
629 * done an unconditional modprobe anyway.
630 * We don't do normal hotplug because it won't work for MDIO
631 * -- because it relies on the device staying around for long
632 * enough for the driver to get loaded. With MDIO, the NIC
633 * driver will get bored and give up as soon as it finds that
634 * there's no driver _already_ loaded.
636 if (is_c45 && c45_ids) {
637 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
640 for (i = 1; i < num_ids; i++) {
641 if (c45_ids->device_ids[i] == 0xffffffff)
644 ret = phy_request_driver_module(dev,
645 c45_ids->device_ids[i]);
650 ret = phy_request_driver_module(dev, phy_id);
654 device_initialize(&mdiodev->dev);
662 EXPORT_SYMBOL(phy_device_create);
664 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
665 * @bus: the target MII bus
666 * @addr: PHY address on the MII bus
667 * @dev_addr: MMD address in the PHY.
668 * @devices_in_package: where to store the devices in package information.
670 * Description: reads devices in package registers of a MMD at @dev_addr
671 * from PHY at @addr on @bus.
673 * Returns: 0 on success, -EIO on failure.
675 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
676 u32 *devices_in_package)
680 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
683 *devices_in_package = phy_reg << 16;
685 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
688 *devices_in_package |= phy_reg;
690 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
691 *devices_in_package &= ~BIT(0);
697 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
698 * @bus: the target MII bus
699 * @addr: PHY address on the MII bus
700 * @c45_ids: where to store the c45 ID information.
702 * Read the PHY "devices in package". If this appears to be valid, read
703 * the PHY identifiers for each device. Return the "devices in package"
704 * and identifiers in @c45_ids.
706 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
707 * the "devices in package" is invalid.
709 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
710 struct phy_c45_device_ids *c45_ids)
712 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
713 u32 *devs = &c45_ids->devices_in_package;
716 /* Find first non-zero Devices In package. Device zero is reserved
717 * for 802.3 c45 complied PHYs, so don't probe it at first.
719 for (i = 1; i < num_ids && *devs == 0; i++) {
720 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
725 if ((*devs & 0x1fffffff) == 0x1fffffff) {
726 /* If mostly Fs, there is no device there, then let's probe
727 * MMD 0, as some 10G PHYs have zero Devices In package,
728 * e.g. Cortina CS4315/CS4340 PHY.
730 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
734 /* no device there, let's get out of here */
735 if ((*devs & 0x1fffffff) == 0x1fffffff)
739 /* Now probe Device Identifiers for each device present. */
740 for (i = 1; i < num_ids; i++) {
741 if (!(c45_ids->devices_in_package & (1 << i)))
744 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
747 c45_ids->device_ids[i] = phy_reg << 16;
749 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
752 c45_ids->device_ids[i] |= phy_reg;
759 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
760 * @bus: the target MII bus
761 * @addr: PHY address on the MII bus
762 * @phy_id: where to store the ID retrieved.
764 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
765 * placing it in @phy_id. Return zero on successful read and the ID is
766 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
769 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
773 /* Grab the bits from PHYIR1, and put them in the upper half */
774 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
776 /* returning -ENODEV doesn't stop bus scanning */
777 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
780 *phy_id = phy_reg << 16;
782 /* Grab the bits from PHYIR2, and put them in the lower half */
783 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
789 /* If the phy_id is mostly Fs, there is no device there */
790 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
797 * get_phy_device - reads the specified PHY device and returns its @phy_device
799 * @bus: the target MII bus
800 * @addr: PHY address on the MII bus
801 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
803 * Description: Reads the ID registers of the PHY at @addr on the
804 * @bus, then allocates and returns the phy_device to represent it.
806 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
808 struct phy_c45_device_ids c45_ids;
812 c45_ids.devices_in_package = 0;
813 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
816 r = get_phy_c45_ids(bus, addr, &c45_ids);
818 r = get_phy_c22_id(bus, addr, &phy_id);
823 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
825 EXPORT_SYMBOL(get_phy_device);
828 * phy_device_register - Register the phy device on the MDIO bus
829 * @phydev: phy_device structure to be added to the MDIO bus
831 int phy_device_register(struct phy_device *phydev)
835 err = mdiobus_register_device(&phydev->mdio);
839 /* Deassert the reset signal */
840 phy_device_reset(phydev, 0);
842 /* Run all of the fixups for this PHY */
843 err = phy_scan_fixups(phydev);
845 phydev_err(phydev, "failed to initialize\n");
849 err = device_add(&phydev->mdio.dev);
851 phydev_err(phydev, "failed to add\n");
858 /* Assert the reset signal */
859 phy_device_reset(phydev, 1);
861 mdiobus_unregister_device(&phydev->mdio);
864 EXPORT_SYMBOL(phy_device_register);
867 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
868 * @phydev: phy_device structure to remove
870 * This doesn't free the phy_device itself, it merely reverses the effects
871 * of phy_device_register(). Use phy_device_free() to free the device
872 * after calling this function.
874 void phy_device_remove(struct phy_device *phydev)
877 unregister_mii_timestamper(phydev->mii_ts);
879 device_del(&phydev->mdio.dev);
881 /* Assert the reset signal */
882 phy_device_reset(phydev, 1);
884 mdiobus_unregister_device(&phydev->mdio);
886 EXPORT_SYMBOL(phy_device_remove);
889 * phy_find_first - finds the first PHY device on the bus
890 * @bus: the target MII bus
892 struct phy_device *phy_find_first(struct mii_bus *bus)
894 struct phy_device *phydev;
897 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
898 phydev = mdiobus_get_phy(bus, addr);
904 EXPORT_SYMBOL(phy_find_first);
906 static void phy_link_change(struct phy_device *phydev, bool up)
908 struct net_device *netdev = phydev->attached_dev;
911 netif_carrier_on(netdev);
913 netif_carrier_off(netdev);
914 phydev->adjust_link(netdev);
915 if (phydev->mii_ts && phydev->mii_ts->link_state)
916 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
920 * phy_prepare_link - prepares the PHY layer to monitor link status
921 * @phydev: target phy_device struct
922 * @handler: callback function for link status change notifications
924 * Description: Tells the PHY infrastructure to handle the
925 * gory details on monitoring link status (whether through
926 * polling or an interrupt), and to call back to the
927 * connected device driver when the link status changes.
928 * If you want to monitor your own link state, don't call
931 static void phy_prepare_link(struct phy_device *phydev,
932 void (*handler)(struct net_device *))
934 phydev->adjust_link = handler;
938 * phy_connect_direct - connect an ethernet device to a specific phy_device
939 * @dev: the network device to connect
940 * @phydev: the pointer to the phy device
941 * @handler: callback function for state change notifications
942 * @interface: PHY device's interface
944 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
945 void (*handler)(struct net_device *),
946 phy_interface_t interface)
953 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
957 phy_prepare_link(phydev, handler);
958 if (phy_interrupt_is_valid(phydev))
959 phy_request_interrupt(phydev);
963 EXPORT_SYMBOL(phy_connect_direct);
966 * phy_connect - connect an ethernet device to a PHY device
967 * @dev: the network device to connect
968 * @bus_id: the id string of the PHY device to connect
969 * @handler: callback function for state change notifications
970 * @interface: PHY device's interface
972 * Description: Convenience function for connecting ethernet
973 * devices to PHY devices. The default behavior is for
974 * the PHY infrastructure to handle everything, and only notify
975 * the connected driver when the link status changes. If you
976 * don't want, or can't use the provided functionality, you may
977 * choose to call only the subset of functions which provide
978 * the desired functionality.
980 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
981 void (*handler)(struct net_device *),
982 phy_interface_t interface)
984 struct phy_device *phydev;
988 /* Search the list of PHY devices on the mdio bus for the
989 * PHY with the requested name
991 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
993 pr_err("PHY %s not found\n", bus_id);
994 return ERR_PTR(-ENODEV);
996 phydev = to_phy_device(d);
998 rc = phy_connect_direct(dev, phydev, handler, interface);
1005 EXPORT_SYMBOL(phy_connect);
1008 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1010 * @phydev: target phy_device struct
1012 void phy_disconnect(struct phy_device *phydev)
1014 if (phy_is_started(phydev))
1017 if (phy_interrupt_is_valid(phydev))
1018 phy_free_interrupt(phydev);
1020 phydev->adjust_link = NULL;
1024 EXPORT_SYMBOL(phy_disconnect);
1027 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1028 * @phydev: The PHY device to poll
1030 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1031 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1032 * register must be polled until the BMCR_RESET bit clears.
1034 * Furthermore, any attempts to write to PHY registers may have no effect
1035 * or even generate MDIO bus errors until this is complete.
1037 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1038 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1039 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1040 * effort to support such broken PHYs, this function is separate from the
1041 * standard phy_init_hw() which will zero all the other bits in the BMCR
1042 * and reapply all driver-specific and board-specific fixups.
1044 static int phy_poll_reset(struct phy_device *phydev)
1046 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1049 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1050 50000, 600000, true);
1053 /* Some chips (smsc911x) may still need up to another 1ms after the
1054 * BMCR_RESET bit is cleared before they are usable.
1060 int phy_init_hw(struct phy_device *phydev)
1064 /* Deassert the reset signal */
1065 phy_device_reset(phydev, 0);
1070 if (phydev->drv->soft_reset) {
1071 ret = phydev->drv->soft_reset(phydev);
1072 /* see comment in genphy_soft_reset for an explanation */
1074 phydev->suspended = 0;
1080 ret = phy_scan_fixups(phydev);
1084 if (phydev->drv->config_init)
1085 ret = phydev->drv->config_init(phydev);
1089 EXPORT_SYMBOL(phy_init_hw);
1091 void phy_attached_info(struct phy_device *phydev)
1093 phy_attached_print(phydev, NULL);
1095 EXPORT_SYMBOL(phy_attached_info);
1097 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1098 char *phy_attached_info_irq(struct phy_device *phydev)
1103 switch(phydev->irq) {
1107 case PHY_IGNORE_INTERRUPT:
1111 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1116 return kasprintf(GFP_KERNEL, "%s", irq_str);
1118 EXPORT_SYMBOL(phy_attached_info_irq);
1120 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1122 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1123 char *irq_str = phy_attached_info_irq(phydev);
1126 phydev_info(phydev, ATTACHED_FMT "\n",
1127 drv_name, phydev_name(phydev),
1132 phydev_info(phydev, ATTACHED_FMT,
1133 drv_name, phydev_name(phydev),
1142 EXPORT_SYMBOL(phy_attached_print);
1144 static void phy_sysfs_create_links(struct phy_device *phydev)
1146 struct net_device *dev = phydev->attached_dev;
1152 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1157 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1158 &phydev->mdio.dev.kobj,
1161 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1162 kobject_name(&phydev->mdio.dev.kobj),
1164 /* non-fatal - some net drivers can use one netdevice
1165 * with more then one phy
1169 phydev->sysfs_links = true;
1173 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1176 struct phy_device *phydev = to_phy_device(dev);
1178 return sprintf(buf, "%d\n", !phydev->attached_dev);
1180 static DEVICE_ATTR_RO(phy_standalone);
1183 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1184 * @upstream: pointer to the phy device
1185 * @bus: sfp bus representing cage being attached
1187 * This is used to fill in the sfp_upstream_ops .attach member.
1189 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1191 struct phy_device *phydev = upstream;
1193 if (phydev->attached_dev)
1194 phydev->attached_dev->sfp_bus = bus;
1195 phydev->sfp_bus_attached = true;
1197 EXPORT_SYMBOL(phy_sfp_attach);
1200 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1201 * @upstream: pointer to the phy device
1202 * @bus: sfp bus representing cage being attached
1204 * This is used to fill in the sfp_upstream_ops .detach member.
1206 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1208 struct phy_device *phydev = upstream;
1210 if (phydev->attached_dev)
1211 phydev->attached_dev->sfp_bus = NULL;
1212 phydev->sfp_bus_attached = false;
1214 EXPORT_SYMBOL(phy_sfp_detach);
1217 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1218 * @phydev: Pointer to phy_device
1219 * @ops: SFP's upstream operations
1221 int phy_sfp_probe(struct phy_device *phydev,
1222 const struct sfp_upstream_ops *ops)
1224 struct sfp_bus *bus;
1227 if (phydev->mdio.dev.fwnode) {
1228 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1230 return PTR_ERR(bus);
1232 phydev->sfp_bus = bus;
1234 ret = sfp_bus_add_upstream(bus, phydev, ops);
1239 EXPORT_SYMBOL(phy_sfp_probe);
1242 * phy_attach_direct - attach a network device to a given PHY device pointer
1243 * @dev: network device to attach
1244 * @phydev: Pointer to phy_device to attach
1245 * @flags: PHY device's dev_flags
1246 * @interface: PHY device's interface
1248 * Description: Called by drivers to attach to a particular PHY
1249 * device. The phy_device is found, and properly hooked up
1250 * to the phy_driver. If no driver is attached, then a
1251 * generic driver is used. The phy_device is given a ptr to
1252 * the attaching device, and given a callback for link status
1253 * change. The phy_device is returned to the attaching driver.
1254 * This function takes a reference on the phy device.
1256 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1257 u32 flags, phy_interface_t interface)
1259 struct mii_bus *bus = phydev->mdio.bus;
1260 struct device *d = &phydev->mdio.dev;
1261 struct module *ndev_owner = NULL;
1262 bool using_genphy = false;
1265 /* For Ethernet device drivers that register their own MDIO bus, we
1266 * will have bus->owner match ndev_mod, so we do not want to increment
1267 * our own module->refcnt here, otherwise we would not be able to
1271 ndev_owner = dev->dev.parent->driver->owner;
1272 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1273 phydev_err(phydev, "failed to get the bus module\n");
1279 /* Assume that if there is no driver, that it doesn't
1280 * exist, and we should use the genphy driver.
1284 d->driver = &genphy_c45_driver.mdiodrv.driver;
1286 d->driver = &genphy_driver.mdiodrv.driver;
1288 using_genphy = true;
1291 if (!try_module_get(d->driver->owner)) {
1292 phydev_err(phydev, "failed to get the device driver module\n");
1294 goto error_put_device;
1298 err = d->driver->probe(d);
1300 err = device_bind_driver(d);
1303 goto error_module_put;
1306 if (phydev->attached_dev) {
1307 dev_err(&dev->dev, "PHY already attached\n");
1312 phydev->phy_link_change = phy_link_change;
1314 phydev->attached_dev = dev;
1315 dev->phydev = phydev;
1317 if (phydev->sfp_bus_attached)
1318 dev->sfp_bus = phydev->sfp_bus;
1321 /* Some Ethernet drivers try to connect to a PHY device before
1322 * calling register_netdevice() -> netdev_register_kobject() and
1323 * does the dev->dev.kobj initialization. Here we only check for
1324 * success which indicates that the network device kobject is
1325 * ready. Once we do that we still need to keep track of whether
1326 * links were successfully set up or not for phy_detach() to
1327 * remove them accordingly.
1329 phydev->sysfs_links = false;
1331 phy_sysfs_create_links(phydev);
1333 if (!phydev->attached_dev) {
1334 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1335 &dev_attr_phy_standalone.attr);
1337 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1340 phydev->dev_flags |= flags;
1342 phydev->interface = interface;
1344 phydev->state = PHY_READY;
1346 /* Initial carrier state is off as the phy is about to be
1350 netif_carrier_off(phydev->attached_dev);
1352 /* Do initial configuration here, now that
1353 * we have certain key parameters
1354 * (dev_flags and interface)
1356 err = phy_init_hw(phydev);
1361 phy_led_triggers_register(phydev);
1366 /* phy_detach() does all of the cleanup below */
1371 module_put(d->driver->owner);
1374 if (ndev_owner != bus->owner)
1375 module_put(bus->owner);
1378 EXPORT_SYMBOL(phy_attach_direct);
1381 * phy_attach - attach a network device to a particular PHY device
1382 * @dev: network device to attach
1383 * @bus_id: Bus ID of PHY device to attach
1384 * @interface: PHY device's interface
1386 * Description: Same as phy_attach_direct() except that a PHY bus_id
1387 * string is passed instead of a pointer to a struct phy_device.
1389 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1390 phy_interface_t interface)
1392 struct bus_type *bus = &mdio_bus_type;
1393 struct phy_device *phydev;
1398 return ERR_PTR(-EINVAL);
1400 /* Search the list of PHY devices on the mdio bus for the
1401 * PHY with the requested name
1403 d = bus_find_device_by_name(bus, NULL, bus_id);
1405 pr_err("PHY %s not found\n", bus_id);
1406 return ERR_PTR(-ENODEV);
1408 phydev = to_phy_device(d);
1410 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1417 EXPORT_SYMBOL(phy_attach);
1419 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1420 struct device_driver *driver)
1422 struct device *d = &phydev->mdio.dev;
1429 ret = d->driver == driver;
1435 bool phy_driver_is_genphy(struct phy_device *phydev)
1437 return phy_driver_is_genphy_kind(phydev,
1438 &genphy_driver.mdiodrv.driver);
1440 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1442 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1444 return phy_driver_is_genphy_kind(phydev,
1445 &genphy_c45_driver.mdiodrv.driver);
1447 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1450 * phy_package_join - join a common PHY group
1451 * @phydev: target phy_device struct
1452 * @addr: cookie and PHY address for global register access
1453 * @priv_size: if non-zero allocate this amount of bytes for private data
1455 * This joins a PHY group and provides a shared storage for all phydevs in
1456 * this group. This is intended to be used for packages which contain
1457 * more than one PHY, for example a quad PHY transceiver.
1459 * The addr parameter serves as a cookie which has to have the same value
1460 * for all members of one group and as a PHY address to access generic
1461 * registers of a PHY package. Usually, one of the PHY addresses of the
1462 * different PHYs in the package provides access to these global registers.
1463 * The address which is given here, will be used in the phy_package_read()
1464 * and phy_package_write() convenience functions. If your PHY doesn't have
1465 * global registers you can just pick any of the PHY addresses.
1467 * This will set the shared pointer of the phydev to the shared storage.
1468 * If this is the first call for a this cookie the shared storage will be
1469 * allocated. If priv_size is non-zero, the given amount of bytes are
1470 * allocated for the priv member.
1472 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1473 * with the same cookie but a different priv_size is an error.
1475 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1477 struct mii_bus *bus = phydev->mdio.bus;
1478 struct phy_package_shared *shared;
1481 if (addr < 0 || addr >= PHY_MAX_ADDR)
1484 mutex_lock(&bus->shared_lock);
1485 shared = bus->shared[addr];
1488 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1492 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1495 shared->priv_size = priv_size;
1497 shared->addr = addr;
1498 refcount_set(&shared->refcnt, 1);
1499 bus->shared[addr] = shared;
1502 if (priv_size && priv_size != shared->priv_size)
1504 refcount_inc(&shared->refcnt);
1506 mutex_unlock(&bus->shared_lock);
1508 phydev->shared = shared;
1515 mutex_unlock(&bus->shared_lock);
1518 EXPORT_SYMBOL_GPL(phy_package_join);
1521 * phy_package_leave - leave a common PHY group
1522 * @phydev: target phy_device struct
1524 * This leaves a PHY group created by phy_package_join(). If this phydev
1525 * was the last user of the shared data between the group, this data is
1526 * freed. Resets the phydev->shared pointer to NULL.
1528 void phy_package_leave(struct phy_device *phydev)
1530 struct phy_package_shared *shared = phydev->shared;
1531 struct mii_bus *bus = phydev->mdio.bus;
1536 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1537 bus->shared[shared->addr] = NULL;
1538 mutex_unlock(&bus->shared_lock);
1539 kfree(shared->priv);
1543 phydev->shared = NULL;
1545 EXPORT_SYMBOL_GPL(phy_package_leave);
1547 static void devm_phy_package_leave(struct device *dev, void *res)
1549 phy_package_leave(*(struct phy_device **)res);
1553 * devm_phy_package_join - resource managed phy_package_join()
1554 * @dev: device that is registering this PHY package
1555 * @phydev: target phy_device struct
1556 * @addr: cookie and PHY address for global register access
1557 * @priv_size: if non-zero allocate this amount of bytes for private data
1559 * Managed phy_package_join(). Shared storage fetched by this function,
1560 * phy_package_leave() is automatically called on driver detach. See
1561 * phy_package_join() for more information.
1563 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1564 int addr, size_t priv_size)
1566 struct phy_device **ptr;
1569 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1574 ret = phy_package_join(phydev, addr, priv_size);
1578 devres_add(dev, ptr);
1585 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1588 * phy_detach - detach a PHY device from its network device
1589 * @phydev: target phy_device struct
1591 * This detaches the phy device from its network device and the phy
1592 * driver, and drops the reference count taken in phy_attach_direct().
1594 void phy_detach(struct phy_device *phydev)
1596 struct net_device *dev = phydev->attached_dev;
1597 struct module *ndev_owner = NULL;
1598 struct mii_bus *bus;
1600 if (phydev->sysfs_links) {
1602 sysfs_remove_link(&dev->dev.kobj, "phydev");
1603 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1606 if (!phydev->attached_dev)
1607 sysfs_remove_file(&phydev->mdio.dev.kobj,
1608 &dev_attr_phy_standalone.attr);
1610 phy_suspend(phydev);
1612 phydev->attached_dev->phydev = NULL;
1613 phydev->attached_dev = NULL;
1615 phydev->phylink = NULL;
1617 phy_led_triggers_unregister(phydev);
1619 module_put(phydev->mdio.dev.driver->owner);
1621 /* If the device had no specific driver before (i.e. - it
1622 * was using the generic driver), we unbind the device
1623 * from the generic driver so that there's a chance a
1624 * real driver could be loaded
1626 if (phy_driver_is_genphy(phydev) ||
1627 phy_driver_is_genphy_10g(phydev))
1628 device_release_driver(&phydev->mdio.dev);
1631 * The phydev might go away on the put_device() below, so avoid
1632 * a use-after-free bug by reading the underlying bus first.
1634 bus = phydev->mdio.bus;
1636 put_device(&phydev->mdio.dev);
1638 ndev_owner = dev->dev.parent->driver->owner;
1639 if (ndev_owner != bus->owner)
1640 module_put(bus->owner);
1642 /* Assert the reset signal */
1643 phy_device_reset(phydev, 1);
1645 EXPORT_SYMBOL(phy_detach);
1647 int phy_suspend(struct phy_device *phydev)
1649 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1650 struct net_device *netdev = phydev->attached_dev;
1651 struct phy_driver *phydrv = phydev->drv;
1654 if (phydev->suspended)
1657 /* If the device has WOL enabled, we cannot suspend the PHY */
1658 phy_ethtool_get_wol(phydev, &wol);
1659 if (wol.wolopts || (netdev && netdev->wol_enabled))
1662 if (!phydrv || !phydrv->suspend)
1665 ret = phydrv->suspend(phydev);
1667 phydev->suspended = true;
1671 EXPORT_SYMBOL(phy_suspend);
1673 int __phy_resume(struct phy_device *phydev)
1675 struct phy_driver *phydrv = phydev->drv;
1678 WARN_ON(!mutex_is_locked(&phydev->lock));
1680 if (!phydrv || !phydrv->resume)
1683 ret = phydrv->resume(phydev);
1685 phydev->suspended = false;
1689 EXPORT_SYMBOL(__phy_resume);
1691 int phy_resume(struct phy_device *phydev)
1695 mutex_lock(&phydev->lock);
1696 ret = __phy_resume(phydev);
1697 mutex_unlock(&phydev->lock);
1701 EXPORT_SYMBOL(phy_resume);
1703 int phy_loopback(struct phy_device *phydev, bool enable)
1705 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1708 mutex_lock(&phydev->lock);
1710 if (enable && phydev->loopback_enabled) {
1715 if (!enable && !phydev->loopback_enabled) {
1720 if (phydev->drv && phydrv->set_loopback)
1721 ret = phydrv->set_loopback(phydev, enable);
1728 phydev->loopback_enabled = enable;
1731 mutex_unlock(&phydev->lock);
1734 EXPORT_SYMBOL(phy_loopback);
1737 * phy_reset_after_clk_enable - perform a PHY reset if needed
1738 * @phydev: target phy_device struct
1740 * Description: Some PHYs are known to need a reset after their refclk was
1741 * enabled. This function evaluates the flags and perform the reset if it's
1742 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1745 int phy_reset_after_clk_enable(struct phy_device *phydev)
1747 if (!phydev || !phydev->drv)
1750 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1751 phy_device_reset(phydev, 1);
1752 phy_device_reset(phydev, 0);
1758 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1760 /* Generic PHY support and helper functions */
1763 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1764 * @phydev: target phy_device struct
1766 * Description: Writes MII_ADVERTISE with the appropriate values,
1767 * after sanitizing the values to make sure we only advertise
1768 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1769 * hasn't changed, and > 0 if it has changed.
1771 static int genphy_config_advert(struct phy_device *phydev)
1773 int err, bmsr, changed = 0;
1776 /* Only allow advertising what this PHY supports */
1777 linkmode_and(phydev->advertising, phydev->advertising,
1780 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1782 /* Setup standard advertisement */
1783 err = phy_modify_changed(phydev, MII_ADVERTISE,
1784 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1785 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1792 bmsr = phy_read(phydev, MII_BMSR);
1796 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1797 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1800 if (!(bmsr & BMSR_ESTATEN))
1803 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1805 err = phy_modify_changed(phydev, MII_CTRL1000,
1806 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1817 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1818 * @phydev: target phy_device struct
1820 * Description: Writes MII_ADVERTISE with the appropriate values,
1821 * after sanitizing the values to make sure we only advertise
1822 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1823 * hasn't changed, and > 0 if it has changed. This function is intended
1824 * for Clause 37 1000Base-X mode.
1826 static int genphy_c37_config_advert(struct phy_device *phydev)
1830 /* Only allow advertising what this PHY supports */
1831 linkmode_and(phydev->advertising, phydev->advertising,
1834 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1835 phydev->advertising))
1836 adv |= ADVERTISE_1000XFULL;
1837 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1838 phydev->advertising))
1839 adv |= ADVERTISE_1000XPAUSE;
1840 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1841 phydev->advertising))
1842 adv |= ADVERTISE_1000XPSE_ASYM;
1844 return phy_modify_changed(phydev, MII_ADVERTISE,
1845 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1846 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1851 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1852 * @phydev: target phy_device struct
1854 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1855 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1856 * changed, and 1 if it has changed.
1858 int genphy_config_eee_advert(struct phy_device *phydev)
1862 /* Nothing to disable */
1863 if (!phydev->eee_broken_modes)
1866 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1867 phydev->eee_broken_modes, 0);
1868 /* If the call failed, we assume that EEE is not supported */
1869 return err < 0 ? 0 : err;
1871 EXPORT_SYMBOL(genphy_config_eee_advert);
1874 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1875 * @phydev: target phy_device struct
1877 * Description: Configures MII_BMCR to force speed/duplex
1878 * to the values in phydev. Assumes that the values are valid.
1879 * Please see phy_sanitize_settings().
1881 int genphy_setup_forced(struct phy_device *phydev)
1886 phydev->asym_pause = 0;
1888 if (SPEED_1000 == phydev->speed)
1889 ctl |= BMCR_SPEED1000;
1890 else if (SPEED_100 == phydev->speed)
1891 ctl |= BMCR_SPEED100;
1893 if (DUPLEX_FULL == phydev->duplex)
1894 ctl |= BMCR_FULLDPLX;
1896 return phy_modify(phydev, MII_BMCR,
1897 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1899 EXPORT_SYMBOL(genphy_setup_forced);
1901 static int genphy_setup_master_slave(struct phy_device *phydev)
1905 if (!phydev->is_gigabit_capable)
1908 switch (phydev->master_slave_set) {
1909 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1910 ctl |= CTL1000_PREFER_MASTER;
1912 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1914 case MASTER_SLAVE_CFG_MASTER_FORCE:
1915 ctl |= CTL1000_AS_MASTER;
1917 case MASTER_SLAVE_CFG_SLAVE_FORCE:
1918 ctl |= CTL1000_ENABLE_MASTER;
1920 case MASTER_SLAVE_CFG_UNKNOWN:
1921 case MASTER_SLAVE_CFG_UNSUPPORTED:
1924 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
1928 return phy_modify_changed(phydev, MII_CTRL1000,
1929 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
1930 CTL1000_PREFER_MASTER), ctl);
1933 static int genphy_read_master_slave(struct phy_device *phydev)
1938 if (!phydev->is_gigabit_capable) {
1939 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
1940 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
1944 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
1945 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
1947 val = phy_read(phydev, MII_CTRL1000);
1951 if (val & CTL1000_ENABLE_MASTER) {
1952 if (val & CTL1000_AS_MASTER)
1953 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
1955 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
1957 if (val & CTL1000_PREFER_MASTER)
1958 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
1960 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
1963 val = phy_read(phydev, MII_STAT1000);
1967 if (val & LPA_1000MSFAIL) {
1968 state = MASTER_SLAVE_STATE_ERR;
1969 } else if (phydev->link) {
1970 /* this bits are valid only for active link */
1971 if (val & LPA_1000MSRES)
1972 state = MASTER_SLAVE_STATE_MASTER;
1974 state = MASTER_SLAVE_STATE_SLAVE;
1976 state = MASTER_SLAVE_STATE_UNKNOWN;
1979 phydev->master_slave_get = cfg;
1980 phydev->master_slave_state = state;
1986 * genphy_restart_aneg - Enable and Restart Autonegotiation
1987 * @phydev: target phy_device struct
1989 int genphy_restart_aneg(struct phy_device *phydev)
1991 /* Don't isolate the PHY if we're negotiating */
1992 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1993 BMCR_ANENABLE | BMCR_ANRESTART);
1995 EXPORT_SYMBOL(genphy_restart_aneg);
1998 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
1999 * @phydev: target phy_device struct
2000 * @restart: whether aneg restart is requested
2002 * Check, and restart auto-negotiation if needed.
2004 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2009 /* Advertisement hasn't changed, but maybe aneg was never on to
2010 * begin with? Or maybe phy was isolated?
2012 ret = phy_read(phydev, MII_BMCR);
2016 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2021 return genphy_restart_aneg(phydev);
2025 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2028 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2029 * @phydev: target phy_device struct
2030 * @changed: whether autoneg is requested
2032 * Description: If auto-negotiation is enabled, we configure the
2033 * advertising, and then restart auto-negotiation. If it is not
2034 * enabled, then we write the BMCR.
2036 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2040 if (genphy_config_eee_advert(phydev))
2043 err = genphy_setup_master_slave(phydev);
2049 if (AUTONEG_ENABLE != phydev->autoneg)
2050 return genphy_setup_forced(phydev);
2052 err = genphy_config_advert(phydev);
2053 if (err < 0) /* error */
2058 return genphy_check_and_restart_aneg(phydev, changed);
2060 EXPORT_SYMBOL(__genphy_config_aneg);
2063 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2064 * @phydev: target phy_device struct
2066 * Description: If auto-negotiation is enabled, we configure the
2067 * advertising, and then restart auto-negotiation. If it is not
2068 * enabled, then we write the BMCR. This function is intended
2069 * for use with Clause 37 1000Base-X mode.
2071 int genphy_c37_config_aneg(struct phy_device *phydev)
2075 if (phydev->autoneg != AUTONEG_ENABLE)
2076 return genphy_setup_forced(phydev);
2078 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2083 changed = genphy_c37_config_advert(phydev);
2084 if (changed < 0) /* error */
2088 /* Advertisement hasn't changed, but maybe aneg was never on to
2089 * begin with? Or maybe phy was isolated?
2091 int ctl = phy_read(phydev, MII_BMCR);
2096 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2097 changed = 1; /* do restart aneg */
2100 /* Only restart aneg if we are advertising something different
2101 * than we were before.
2104 return genphy_restart_aneg(phydev);
2108 EXPORT_SYMBOL(genphy_c37_config_aneg);
2111 * genphy_aneg_done - return auto-negotiation status
2112 * @phydev: target phy_device struct
2114 * Description: Reads the status register and returns 0 either if
2115 * auto-negotiation is incomplete, or if there was an error.
2116 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2118 int genphy_aneg_done(struct phy_device *phydev)
2120 int retval = phy_read(phydev, MII_BMSR);
2122 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2124 EXPORT_SYMBOL(genphy_aneg_done);
2127 * genphy_update_link - update link status in @phydev
2128 * @phydev: target phy_device struct
2130 * Description: Update the value in phydev->link to reflect the
2131 * current link value. In order to do this, we need to read
2132 * the status register twice, keeping the second value.
2134 int genphy_update_link(struct phy_device *phydev)
2136 int status = 0, bmcr;
2138 bmcr = phy_read(phydev, MII_BMCR);
2142 /* Autoneg is being started, therefore disregard BMSR value and
2143 * report link as down.
2145 if (bmcr & BMCR_ANRESTART)
2148 /* The link state is latched low so that momentary link
2149 * drops can be detected. Do not double-read the status
2150 * in polling mode to detect such short link drops except
2151 * the link was already down.
2153 if (!phy_polling_mode(phydev) || !phydev->link) {
2154 status = phy_read(phydev, MII_BMSR);
2157 else if (status & BMSR_LSTATUS)
2161 /* Read link and autonegotiation status */
2162 status = phy_read(phydev, MII_BMSR);
2166 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2167 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2169 /* Consider the case that autoneg was started and "aneg complete"
2170 * bit has been reset, but "link up" bit not yet.
2172 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2177 EXPORT_SYMBOL(genphy_update_link);
2179 int genphy_read_lpa(struct phy_device *phydev)
2183 if (phydev->autoneg == AUTONEG_ENABLE) {
2184 if (!phydev->autoneg_complete) {
2185 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2187 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2191 if (phydev->is_gigabit_capable) {
2192 lpagb = phy_read(phydev, MII_STAT1000);
2196 if (lpagb & LPA_1000MSFAIL) {
2197 int adv = phy_read(phydev, MII_CTRL1000);
2202 if (adv & CTL1000_ENABLE_MASTER)
2203 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2205 phydev_err(phydev, "Master/Slave resolution failed\n");
2209 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2213 lpa = phy_read(phydev, MII_LPA);
2217 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2219 linkmode_zero(phydev->lp_advertising);
2224 EXPORT_SYMBOL(genphy_read_lpa);
2227 * genphy_read_status_fixed - read the link parameters for !aneg mode
2228 * @phydev: target phy_device struct
2230 * Read the current duplex and speed state for a PHY operating with
2231 * autonegotiation disabled.
2233 int genphy_read_status_fixed(struct phy_device *phydev)
2235 int bmcr = phy_read(phydev, MII_BMCR);
2240 if (bmcr & BMCR_FULLDPLX)
2241 phydev->duplex = DUPLEX_FULL;
2243 phydev->duplex = DUPLEX_HALF;
2245 if (bmcr & BMCR_SPEED1000)
2246 phydev->speed = SPEED_1000;
2247 else if (bmcr & BMCR_SPEED100)
2248 phydev->speed = SPEED_100;
2250 phydev->speed = SPEED_10;
2254 EXPORT_SYMBOL(genphy_read_status_fixed);
2257 * genphy_read_status - check the link status and update current link state
2258 * @phydev: target phy_device struct
2260 * Description: Check the link, then figure out the current state
2261 * by comparing what we advertise with what the link partner
2262 * advertises. Start by checking the gigabit possibilities,
2263 * then move on to 10/100.
2265 int genphy_read_status(struct phy_device *phydev)
2267 int err, old_link = phydev->link;
2269 /* Update the link, but return if there was an error */
2270 err = genphy_update_link(phydev);
2274 /* why bother the PHY if nothing can have changed */
2275 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2278 phydev->speed = SPEED_UNKNOWN;
2279 phydev->duplex = DUPLEX_UNKNOWN;
2281 phydev->asym_pause = 0;
2283 err = genphy_read_master_slave(phydev);
2287 err = genphy_read_lpa(phydev);
2291 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2292 phy_resolve_aneg_linkmode(phydev);
2293 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2294 err = genphy_read_status_fixed(phydev);
2301 EXPORT_SYMBOL(genphy_read_status);
2304 * genphy_c37_read_status - check the link status and update current link state
2305 * @phydev: target phy_device struct
2307 * Description: Check the link, then figure out the current state
2308 * by comparing what we advertise with what the link partner
2309 * advertises. This function is for Clause 37 1000Base-X mode.
2311 int genphy_c37_read_status(struct phy_device *phydev)
2313 int lpa, err, old_link = phydev->link;
2315 /* Update the link, but return if there was an error */
2316 err = genphy_update_link(phydev);
2320 /* why bother the PHY if nothing can have changed */
2321 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2324 phydev->duplex = DUPLEX_UNKNOWN;
2326 phydev->asym_pause = 0;
2328 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2329 lpa = phy_read(phydev, MII_LPA);
2333 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2334 phydev->lp_advertising, lpa & LPA_LPACK);
2335 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2336 phydev->lp_advertising, lpa & LPA_1000XFULL);
2337 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2338 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2339 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2340 phydev->lp_advertising,
2341 lpa & LPA_1000XPAUSE_ASYM);
2343 phy_resolve_aneg_linkmode(phydev);
2344 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2345 int bmcr = phy_read(phydev, MII_BMCR);
2350 if (bmcr & BMCR_FULLDPLX)
2351 phydev->duplex = DUPLEX_FULL;
2353 phydev->duplex = DUPLEX_HALF;
2358 EXPORT_SYMBOL(genphy_c37_read_status);
2361 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2362 * @phydev: target phy_device struct
2364 * Description: Perform a software PHY reset using the standard
2365 * BMCR_RESET bit and poll for the reset bit to be cleared.
2367 * Returns: 0 on success, < 0 on failure
2369 int genphy_soft_reset(struct phy_device *phydev)
2371 u16 res = BMCR_RESET;
2374 if (phydev->autoneg == AUTONEG_ENABLE)
2375 res |= BMCR_ANRESTART;
2377 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2381 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2382 * to their default value. Therefore the POWER DOWN bit is supposed to
2383 * be cleared after soft reset.
2385 phydev->suspended = 0;
2387 ret = phy_poll_reset(phydev);
2391 /* BMCR may be reset to defaults */
2392 if (phydev->autoneg == AUTONEG_DISABLE)
2393 ret = genphy_setup_forced(phydev);
2397 EXPORT_SYMBOL(genphy_soft_reset);
2400 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2401 * @phydev: target phy_device struct
2403 * Description: Reads the PHY's abilities and populates
2404 * phydev->supported accordingly.
2406 * Returns: 0 on success, < 0 on failure
2408 int genphy_read_abilities(struct phy_device *phydev)
2412 linkmode_set_bit_array(phy_basic_ports_array,
2413 ARRAY_SIZE(phy_basic_ports_array),
2416 val = phy_read(phydev, MII_BMSR);
2420 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2421 val & BMSR_ANEGCAPABLE);
2423 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2424 val & BMSR_100FULL);
2425 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2426 val & BMSR_100HALF);
2427 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2429 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2432 if (val & BMSR_ESTATEN) {
2433 val = phy_read(phydev, MII_ESTATUS);
2437 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2438 phydev->supported, val & ESTATUS_1000_TFULL);
2439 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2440 phydev->supported, val & ESTATUS_1000_THALF);
2441 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2442 phydev->supported, val & ESTATUS_1000_XFULL);
2447 EXPORT_SYMBOL(genphy_read_abilities);
2449 /* This is used for the phy device which doesn't support the MMD extended
2450 * register access, but it does have side effect when we are trying to access
2451 * the MMD register via indirect method.
2453 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2457 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2459 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2460 u16 regnum, u16 val)
2464 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2466 int genphy_suspend(struct phy_device *phydev)
2468 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2470 EXPORT_SYMBOL(genphy_suspend);
2472 int genphy_resume(struct phy_device *phydev)
2474 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2476 EXPORT_SYMBOL(genphy_resume);
2478 int genphy_loopback(struct phy_device *phydev, bool enable)
2480 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2481 enable ? BMCR_LOOPBACK : 0);
2483 EXPORT_SYMBOL(genphy_loopback);
2486 * phy_remove_link_mode - Remove a supported link mode
2487 * @phydev: phy_device structure to remove link mode from
2488 * @link_mode: Link mode to be removed
2490 * Description: Some MACs don't support all link modes which the PHY
2491 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2492 * to remove a link mode.
2494 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2496 linkmode_clear_bit(link_mode, phydev->supported);
2497 phy_advertise_supported(phydev);
2499 EXPORT_SYMBOL(phy_remove_link_mode);
2501 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2503 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2504 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2505 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2506 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2510 * phy_advertise_supported - Advertise all supported modes
2511 * @phydev: target phy_device struct
2513 * Description: Called to advertise all supported modes, doesn't touch
2514 * pause mode advertising.
2516 void phy_advertise_supported(struct phy_device *phydev)
2518 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2520 linkmode_copy(new, phydev->supported);
2521 phy_copy_pause_bits(new, phydev->advertising);
2522 linkmode_copy(phydev->advertising, new);
2524 EXPORT_SYMBOL(phy_advertise_supported);
2527 * phy_support_sym_pause - Enable support of symmetrical pause
2528 * @phydev: target phy_device struct
2530 * Description: Called by the MAC to indicate is supports symmetrical
2531 * Pause, but not asym pause.
2533 void phy_support_sym_pause(struct phy_device *phydev)
2535 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2536 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2538 EXPORT_SYMBOL(phy_support_sym_pause);
2541 * phy_support_asym_pause - Enable support of asym pause
2542 * @phydev: target phy_device struct
2544 * Description: Called by the MAC to indicate is supports Asym Pause.
2546 void phy_support_asym_pause(struct phy_device *phydev)
2548 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2550 EXPORT_SYMBOL(phy_support_asym_pause);
2553 * phy_set_sym_pause - Configure symmetric Pause
2554 * @phydev: target phy_device struct
2555 * @rx: Receiver Pause is supported
2556 * @tx: Transmit Pause is supported
2557 * @autoneg: Auto neg should be used
2559 * Description: Configure advertised Pause support depending on if
2560 * receiver pause and pause auto neg is supported. Generally called
2561 * from the set_pauseparam .ndo.
2563 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2566 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2568 if (rx && tx && autoneg)
2569 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2572 linkmode_copy(phydev->advertising, phydev->supported);
2574 EXPORT_SYMBOL(phy_set_sym_pause);
2577 * phy_set_asym_pause - Configure Pause and Asym Pause
2578 * @phydev: target phy_device struct
2579 * @rx: Receiver Pause is supported
2580 * @tx: Transmit Pause is supported
2582 * Description: Configure advertised Pause support depending on if
2583 * transmit and receiver pause is supported. If there has been a
2584 * change in adverting, trigger a new autoneg. Generally called from
2585 * the set_pauseparam .ndo.
2587 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2589 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2591 linkmode_copy(oldadv, phydev->advertising);
2592 linkmode_set_pause(phydev->advertising, tx, rx);
2594 if (!linkmode_equal(oldadv, phydev->advertising) &&
2596 phy_start_aneg(phydev);
2598 EXPORT_SYMBOL(phy_set_asym_pause);
2601 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2602 * @phydev: phy_device struct
2603 * @pp: requested pause configuration
2605 * Description: Test if the PHY/MAC combination supports the Pause
2606 * configuration the user is requesting. Returns True if it is
2607 * supported, false otherwise.
2609 bool phy_validate_pause(struct phy_device *phydev,
2610 struct ethtool_pauseparam *pp)
2612 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2613 phydev->supported) && pp->rx_pause)
2616 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2617 phydev->supported) &&
2618 pp->rx_pause != pp->tx_pause)
2623 EXPORT_SYMBOL(phy_validate_pause);
2626 * phy_get_pause - resolve negotiated pause modes
2627 * @phydev: phy_device struct
2628 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2630 * @rx_pause: pointer to bool to indicate whether receive pause should be
2633 * Resolve and return the flow control modes according to the negotiation
2634 * result. This includes checking that we are operating in full duplex mode.
2635 * See linkmode_resolve_pause() for further details.
2637 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2639 if (phydev->duplex != DUPLEX_FULL) {
2645 return linkmode_resolve_pause(phydev->advertising,
2646 phydev->lp_advertising,
2647 tx_pause, rx_pause);
2649 EXPORT_SYMBOL(phy_get_pause);
2651 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2653 return phydrv->config_intr && phydrv->ack_interrupt;
2657 * phy_probe - probe and init a PHY device
2658 * @dev: device to probe and init
2660 * Description: Take care of setting up the phy_device structure,
2661 * set the state to READY (the driver's init function should
2662 * set it to STARTING if needed).
2664 static int phy_probe(struct device *dev)
2666 struct phy_device *phydev = to_phy_device(dev);
2667 struct device_driver *drv = phydev->mdio.dev.driver;
2668 struct phy_driver *phydrv = to_phy_driver(drv);
2671 phydev->drv = phydrv;
2673 /* Disable the interrupt if the PHY doesn't support it
2674 * but the interrupt is still a valid one
2676 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2677 phydev->irq = PHY_POLL;
2679 if (phydrv->flags & PHY_IS_INTERNAL)
2680 phydev->is_internal = true;
2682 mutex_lock(&phydev->lock);
2684 if (phydev->drv->probe) {
2685 /* Deassert the reset signal */
2686 phy_device_reset(phydev, 0);
2688 err = phydev->drv->probe(phydev);
2690 /* Assert the reset signal */
2691 phy_device_reset(phydev, 1);
2696 /* Start out supporting everything. Eventually,
2697 * a controller will attach, and may modify one
2698 * or both of these values
2700 if (phydrv->features) {
2701 linkmode_copy(phydev->supported, phydrv->features);
2702 } else if (phydrv->get_features) {
2703 err = phydrv->get_features(phydev);
2704 } else if (phydev->is_c45) {
2705 err = genphy_c45_pma_read_abilities(phydev);
2707 err = genphy_read_abilities(phydev);
2713 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2715 phydev->autoneg = 0;
2717 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2719 phydev->is_gigabit_capable = 1;
2720 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2722 phydev->is_gigabit_capable = 1;
2724 of_set_phy_supported(phydev);
2725 phy_advertise_supported(phydev);
2727 /* Get the EEE modes we want to prohibit. We will ask
2728 * the PHY stop advertising these mode later on
2730 of_set_phy_eee_broken(phydev);
2732 /* The Pause Frame bits indicate that the PHY can support passing
2733 * pause frames. During autonegotiation, the PHYs will determine if
2734 * they should allow pause frames to pass. The MAC driver should then
2735 * use that result to determine whether to enable flow control via
2738 * Normally, PHY drivers should not set the Pause bits, and instead
2739 * allow phylib to do that. However, there may be some situations
2740 * (e.g. hardware erratum) where the driver wants to set only one
2743 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2744 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2745 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2747 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2751 /* Set the state to READY by default */
2752 phydev->state = PHY_READY;
2755 mutex_unlock(&phydev->lock);
2760 static int phy_remove(struct device *dev)
2762 struct phy_device *phydev = to_phy_device(dev);
2764 cancel_delayed_work_sync(&phydev->state_queue);
2766 mutex_lock(&phydev->lock);
2767 phydev->state = PHY_DOWN;
2768 mutex_unlock(&phydev->lock);
2770 sfp_bus_del_upstream(phydev->sfp_bus);
2771 phydev->sfp_bus = NULL;
2773 if (phydev->drv && phydev->drv->remove) {
2774 phydev->drv->remove(phydev);
2776 /* Assert the reset signal */
2777 phy_device_reset(phydev, 1);
2785 * phy_driver_register - register a phy_driver with the PHY layer
2786 * @new_driver: new phy_driver to register
2787 * @owner: module owning this PHY
2789 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2793 /* Either the features are hard coded, or dynamically
2794 * determined. It cannot be both.
2796 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2797 pr_err("%s: features and get_features must not both be set\n",
2802 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2803 new_driver->mdiodrv.driver.name = new_driver->name;
2804 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2805 new_driver->mdiodrv.driver.probe = phy_probe;
2806 new_driver->mdiodrv.driver.remove = phy_remove;
2807 new_driver->mdiodrv.driver.owner = owner;
2808 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2810 retval = driver_register(&new_driver->mdiodrv.driver);
2812 pr_err("%s: Error %d in registering driver\n",
2813 new_driver->name, retval);
2818 pr_debug("%s: Registered new driver\n", new_driver->name);
2822 EXPORT_SYMBOL(phy_driver_register);
2824 int phy_drivers_register(struct phy_driver *new_driver, int n,
2825 struct module *owner)
2829 for (i = 0; i < n; i++) {
2830 ret = phy_driver_register(new_driver + i, owner);
2833 phy_driver_unregister(new_driver + i);
2839 EXPORT_SYMBOL(phy_drivers_register);
2841 void phy_driver_unregister(struct phy_driver *drv)
2843 driver_unregister(&drv->mdiodrv.driver);
2845 EXPORT_SYMBOL(phy_driver_unregister);
2847 void phy_drivers_unregister(struct phy_driver *drv, int n)
2851 for (i = 0; i < n; i++)
2852 phy_driver_unregister(drv + i);
2854 EXPORT_SYMBOL(phy_drivers_unregister);
2856 static struct phy_driver genphy_driver = {
2857 .phy_id = 0xffffffff,
2858 .phy_id_mask = 0xffffffff,
2859 .name = "Generic PHY",
2860 .get_features = genphy_read_abilities,
2861 .suspend = genphy_suspend,
2862 .resume = genphy_resume,
2863 .set_loopback = genphy_loopback,
2866 static int __init phy_init(void)
2870 rc = mdio_bus_init();
2876 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2880 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2882 phy_driver_unregister(&genphy_c45_driver);
2890 static void __exit phy_exit(void)
2892 phy_driver_unregister(&genphy_c45_driver);
2893 phy_driver_unregister(&genphy_driver);
2897 subsys_initcall(phy_init);
2898 module_exit(phy_exit);