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 /* phy_c45_probe_present - checks to see if a MMD is present in the package
665 * @bus: the target MII bus
666 * @prtad: PHY package address on the MII bus
667 * @devad: PHY device (MMD) address
669 * Read the MDIO_STAT2 register, and check whether a device is responding
672 * Returns: negative error number on bus access error, zero if no device
673 * is responding, or positive if a device is present.
675 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
679 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
683 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
686 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
687 * @bus: the target MII bus
688 * @addr: PHY address on the MII bus
689 * @dev_addr: MMD address in the PHY.
690 * @devices_in_package: where to store the devices in package information.
692 * Description: reads devices in package registers of a MMD at @dev_addr
693 * from PHY at @addr on @bus.
695 * Returns: 0 on success, -EIO on failure.
697 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
698 u32 *devices_in_package)
702 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
705 *devices_in_package = phy_reg << 16;
707 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
710 *devices_in_package |= phy_reg;
712 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
713 *devices_in_package &= ~BIT(0);
719 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
720 * @bus: the target MII bus
721 * @addr: PHY address on the MII bus
722 * @c45_ids: where to store the c45 ID information.
724 * Read the PHY "devices in package". If this appears to be valid, read
725 * the PHY identifiers for each device. Return the "devices in package"
726 * and identifiers in @c45_ids.
728 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
729 * the "devices in package" is invalid.
731 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
732 struct phy_c45_device_ids *c45_ids)
734 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
735 u32 *devs = &c45_ids->devices_in_package;
738 /* Find first non-zero Devices In package. Device zero is reserved
739 * for 802.3 c45 complied PHYs, so don't probe it at first.
741 for (i = 1; i < MDIO_MMD_NUM && *devs == 0; i++) {
742 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
743 /* Check that there is a device present at this
744 * address before reading the devices-in-package
745 * register to avoid reading garbage from the PHY.
746 * Some PHYs (88x3310) vendor space is not IEEE802.3
749 ret = phy_c45_probe_present(bus, addr, i);
756 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
761 if ((*devs & 0x1fffffff) == 0x1fffffff) {
762 /* If mostly Fs, there is no device there, then let's probe
763 * MMD 0, as some 10G PHYs have zero Devices In package,
764 * e.g. Cortina CS4315/CS4340 PHY.
766 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
770 /* no device there, let's get out of here */
771 if ((*devs & 0x1fffffff) == 0x1fffffff)
775 /* Now probe Device Identifiers for each device present. */
776 for (i = 1; i < num_ids; i++) {
777 if (!(c45_ids->devices_in_package & (1 << i)))
780 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
783 c45_ids->device_ids[i] = phy_reg << 16;
785 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
788 c45_ids->device_ids[i] |= phy_reg;
795 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
796 * @bus: the target MII bus
797 * @addr: PHY address on the MII bus
798 * @phy_id: where to store the ID retrieved.
800 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
801 * placing it in @phy_id. Return zero on successful read and the ID is
802 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
805 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
809 /* Grab the bits from PHYIR1, and put them in the upper half */
810 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
812 /* returning -ENODEV doesn't stop bus scanning */
813 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
816 *phy_id = phy_reg << 16;
818 /* Grab the bits from PHYIR2, and put them in the lower half */
819 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
825 /* If the phy_id is mostly Fs, there is no device there */
826 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
833 * get_phy_device - reads the specified PHY device and returns its @phy_device
835 * @bus: the target MII bus
836 * @addr: PHY address on the MII bus
837 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
839 * Probe for a PHY at @addr on @bus.
841 * When probing for a clause 22 PHY, then read the ID registers. If we find
842 * a valid ID, allocate and return a &struct phy_device.
844 * When probing for a clause 45 PHY, read the "devices in package" registers.
845 * If the "devices in package" appears valid, read the ID registers for each
846 * MMD, allocate and return a &struct phy_device.
848 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
849 * no PHY present, or %-EIO on bus access error.
851 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
853 struct phy_c45_device_ids c45_ids;
857 c45_ids.devices_in_package = 0;
858 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
861 r = get_phy_c45_ids(bus, addr, &c45_ids);
863 r = get_phy_c22_id(bus, addr, &phy_id);
868 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
870 EXPORT_SYMBOL(get_phy_device);
873 * phy_device_register - Register the phy device on the MDIO bus
874 * @phydev: phy_device structure to be added to the MDIO bus
876 int phy_device_register(struct phy_device *phydev)
880 err = mdiobus_register_device(&phydev->mdio);
884 /* Deassert the reset signal */
885 phy_device_reset(phydev, 0);
887 /* Run all of the fixups for this PHY */
888 err = phy_scan_fixups(phydev);
890 phydev_err(phydev, "failed to initialize\n");
894 err = device_add(&phydev->mdio.dev);
896 phydev_err(phydev, "failed to add\n");
903 /* Assert the reset signal */
904 phy_device_reset(phydev, 1);
906 mdiobus_unregister_device(&phydev->mdio);
909 EXPORT_SYMBOL(phy_device_register);
912 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
913 * @phydev: phy_device structure to remove
915 * This doesn't free the phy_device itself, it merely reverses the effects
916 * of phy_device_register(). Use phy_device_free() to free the device
917 * after calling this function.
919 void phy_device_remove(struct phy_device *phydev)
922 unregister_mii_timestamper(phydev->mii_ts);
924 device_del(&phydev->mdio.dev);
926 /* Assert the reset signal */
927 phy_device_reset(phydev, 1);
929 mdiobus_unregister_device(&phydev->mdio);
931 EXPORT_SYMBOL(phy_device_remove);
934 * phy_find_first - finds the first PHY device on the bus
935 * @bus: the target MII bus
937 struct phy_device *phy_find_first(struct mii_bus *bus)
939 struct phy_device *phydev;
942 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
943 phydev = mdiobus_get_phy(bus, addr);
949 EXPORT_SYMBOL(phy_find_first);
951 static void phy_link_change(struct phy_device *phydev, bool up)
953 struct net_device *netdev = phydev->attached_dev;
956 netif_carrier_on(netdev);
958 netif_carrier_off(netdev);
959 phydev->adjust_link(netdev);
960 if (phydev->mii_ts && phydev->mii_ts->link_state)
961 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
965 * phy_prepare_link - prepares the PHY layer to monitor link status
966 * @phydev: target phy_device struct
967 * @handler: callback function for link status change notifications
969 * Description: Tells the PHY infrastructure to handle the
970 * gory details on monitoring link status (whether through
971 * polling or an interrupt), and to call back to the
972 * connected device driver when the link status changes.
973 * If you want to monitor your own link state, don't call
976 static void phy_prepare_link(struct phy_device *phydev,
977 void (*handler)(struct net_device *))
979 phydev->adjust_link = handler;
983 * phy_connect_direct - connect an ethernet device to a specific phy_device
984 * @dev: the network device to connect
985 * @phydev: the pointer to the phy device
986 * @handler: callback function for state change notifications
987 * @interface: PHY device's interface
989 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
990 void (*handler)(struct net_device *),
991 phy_interface_t interface)
998 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1002 phy_prepare_link(phydev, handler);
1003 if (phy_interrupt_is_valid(phydev))
1004 phy_request_interrupt(phydev);
1008 EXPORT_SYMBOL(phy_connect_direct);
1011 * phy_connect - connect an ethernet device to a PHY device
1012 * @dev: the network device to connect
1013 * @bus_id: the id string of the PHY device to connect
1014 * @handler: callback function for state change notifications
1015 * @interface: PHY device's interface
1017 * Description: Convenience function for connecting ethernet
1018 * devices to PHY devices. The default behavior is for
1019 * the PHY infrastructure to handle everything, and only notify
1020 * the connected driver when the link status changes. If you
1021 * don't want, or can't use the provided functionality, you may
1022 * choose to call only the subset of functions which provide
1023 * the desired functionality.
1025 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1026 void (*handler)(struct net_device *),
1027 phy_interface_t interface)
1029 struct phy_device *phydev;
1033 /* Search the list of PHY devices on the mdio bus for the
1034 * PHY with the requested name
1036 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1038 pr_err("PHY %s not found\n", bus_id);
1039 return ERR_PTR(-ENODEV);
1041 phydev = to_phy_device(d);
1043 rc = phy_connect_direct(dev, phydev, handler, interface);
1050 EXPORT_SYMBOL(phy_connect);
1053 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1055 * @phydev: target phy_device struct
1057 void phy_disconnect(struct phy_device *phydev)
1059 if (phy_is_started(phydev))
1062 if (phy_interrupt_is_valid(phydev))
1063 phy_free_interrupt(phydev);
1065 phydev->adjust_link = NULL;
1069 EXPORT_SYMBOL(phy_disconnect);
1072 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1073 * @phydev: The PHY device to poll
1075 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1076 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1077 * register must be polled until the BMCR_RESET bit clears.
1079 * Furthermore, any attempts to write to PHY registers may have no effect
1080 * or even generate MDIO bus errors until this is complete.
1082 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1083 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1084 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1085 * effort to support such broken PHYs, this function is separate from the
1086 * standard phy_init_hw() which will zero all the other bits in the BMCR
1087 * and reapply all driver-specific and board-specific fixups.
1089 static int phy_poll_reset(struct phy_device *phydev)
1091 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1094 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1095 50000, 600000, true);
1098 /* Some chips (smsc911x) may still need up to another 1ms after the
1099 * BMCR_RESET bit is cleared before they are usable.
1105 int phy_init_hw(struct phy_device *phydev)
1109 /* Deassert the reset signal */
1110 phy_device_reset(phydev, 0);
1115 if (phydev->drv->soft_reset) {
1116 ret = phydev->drv->soft_reset(phydev);
1117 /* see comment in genphy_soft_reset for an explanation */
1119 phydev->suspended = 0;
1125 ret = phy_scan_fixups(phydev);
1129 if (phydev->drv->config_init)
1130 ret = phydev->drv->config_init(phydev);
1134 EXPORT_SYMBOL(phy_init_hw);
1136 void phy_attached_info(struct phy_device *phydev)
1138 phy_attached_print(phydev, NULL);
1140 EXPORT_SYMBOL(phy_attached_info);
1142 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1143 char *phy_attached_info_irq(struct phy_device *phydev)
1148 switch(phydev->irq) {
1152 case PHY_IGNORE_INTERRUPT:
1156 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1161 return kasprintf(GFP_KERNEL, "%s", irq_str);
1163 EXPORT_SYMBOL(phy_attached_info_irq);
1165 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1167 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1168 char *irq_str = phy_attached_info_irq(phydev);
1171 phydev_info(phydev, ATTACHED_FMT "\n",
1172 drv_name, phydev_name(phydev),
1177 phydev_info(phydev, ATTACHED_FMT,
1178 drv_name, phydev_name(phydev),
1187 EXPORT_SYMBOL(phy_attached_print);
1189 static void phy_sysfs_create_links(struct phy_device *phydev)
1191 struct net_device *dev = phydev->attached_dev;
1197 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1202 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1203 &phydev->mdio.dev.kobj,
1206 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1207 kobject_name(&phydev->mdio.dev.kobj),
1209 /* non-fatal - some net drivers can use one netdevice
1210 * with more then one phy
1214 phydev->sysfs_links = true;
1218 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1221 struct phy_device *phydev = to_phy_device(dev);
1223 return sprintf(buf, "%d\n", !phydev->attached_dev);
1225 static DEVICE_ATTR_RO(phy_standalone);
1228 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1229 * @upstream: pointer to the phy device
1230 * @bus: sfp bus representing cage being attached
1232 * This is used to fill in the sfp_upstream_ops .attach member.
1234 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1236 struct phy_device *phydev = upstream;
1238 if (phydev->attached_dev)
1239 phydev->attached_dev->sfp_bus = bus;
1240 phydev->sfp_bus_attached = true;
1242 EXPORT_SYMBOL(phy_sfp_attach);
1245 * phy_sfp_detach - detach the SFP bus from 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 .detach member.
1251 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1253 struct phy_device *phydev = upstream;
1255 if (phydev->attached_dev)
1256 phydev->attached_dev->sfp_bus = NULL;
1257 phydev->sfp_bus_attached = false;
1259 EXPORT_SYMBOL(phy_sfp_detach);
1262 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1263 * @phydev: Pointer to phy_device
1264 * @ops: SFP's upstream operations
1266 int phy_sfp_probe(struct phy_device *phydev,
1267 const struct sfp_upstream_ops *ops)
1269 struct sfp_bus *bus;
1272 if (phydev->mdio.dev.fwnode) {
1273 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1275 return PTR_ERR(bus);
1277 phydev->sfp_bus = bus;
1279 ret = sfp_bus_add_upstream(bus, phydev, ops);
1284 EXPORT_SYMBOL(phy_sfp_probe);
1287 * phy_attach_direct - attach a network device to a given PHY device pointer
1288 * @dev: network device to attach
1289 * @phydev: Pointer to phy_device to attach
1290 * @flags: PHY device's dev_flags
1291 * @interface: PHY device's interface
1293 * Description: Called by drivers to attach to a particular PHY
1294 * device. The phy_device is found, and properly hooked up
1295 * to the phy_driver. If no driver is attached, then a
1296 * generic driver is used. The phy_device is given a ptr to
1297 * the attaching device, and given a callback for link status
1298 * change. The phy_device is returned to the attaching driver.
1299 * This function takes a reference on the phy device.
1301 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1302 u32 flags, phy_interface_t interface)
1304 struct mii_bus *bus = phydev->mdio.bus;
1305 struct device *d = &phydev->mdio.dev;
1306 struct module *ndev_owner = NULL;
1307 bool using_genphy = false;
1310 /* For Ethernet device drivers that register their own MDIO bus, we
1311 * will have bus->owner match ndev_mod, so we do not want to increment
1312 * our own module->refcnt here, otherwise we would not be able to
1316 ndev_owner = dev->dev.parent->driver->owner;
1317 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1318 phydev_err(phydev, "failed to get the bus module\n");
1324 /* Assume that if there is no driver, that it doesn't
1325 * exist, and we should use the genphy driver.
1329 d->driver = &genphy_c45_driver.mdiodrv.driver;
1331 d->driver = &genphy_driver.mdiodrv.driver;
1333 using_genphy = true;
1336 if (!try_module_get(d->driver->owner)) {
1337 phydev_err(phydev, "failed to get the device driver module\n");
1339 goto error_put_device;
1343 err = d->driver->probe(d);
1345 err = device_bind_driver(d);
1348 goto error_module_put;
1351 if (phydev->attached_dev) {
1352 dev_err(&dev->dev, "PHY already attached\n");
1357 phydev->phy_link_change = phy_link_change;
1359 phydev->attached_dev = dev;
1360 dev->phydev = phydev;
1362 if (phydev->sfp_bus_attached)
1363 dev->sfp_bus = phydev->sfp_bus;
1366 /* Some Ethernet drivers try to connect to a PHY device before
1367 * calling register_netdevice() -> netdev_register_kobject() and
1368 * does the dev->dev.kobj initialization. Here we only check for
1369 * success which indicates that the network device kobject is
1370 * ready. Once we do that we still need to keep track of whether
1371 * links were successfully set up or not for phy_detach() to
1372 * remove them accordingly.
1374 phydev->sysfs_links = false;
1376 phy_sysfs_create_links(phydev);
1378 if (!phydev->attached_dev) {
1379 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1380 &dev_attr_phy_standalone.attr);
1382 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1385 phydev->dev_flags |= flags;
1387 phydev->interface = interface;
1389 phydev->state = PHY_READY;
1391 /* Initial carrier state is off as the phy is about to be
1395 netif_carrier_off(phydev->attached_dev);
1397 /* Do initial configuration here, now that
1398 * we have certain key parameters
1399 * (dev_flags and interface)
1401 err = phy_init_hw(phydev);
1406 phy_led_triggers_register(phydev);
1411 /* phy_detach() does all of the cleanup below */
1416 module_put(d->driver->owner);
1419 if (ndev_owner != bus->owner)
1420 module_put(bus->owner);
1423 EXPORT_SYMBOL(phy_attach_direct);
1426 * phy_attach - attach a network device to a particular PHY device
1427 * @dev: network device to attach
1428 * @bus_id: Bus ID of PHY device to attach
1429 * @interface: PHY device's interface
1431 * Description: Same as phy_attach_direct() except that a PHY bus_id
1432 * string is passed instead of a pointer to a struct phy_device.
1434 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1435 phy_interface_t interface)
1437 struct bus_type *bus = &mdio_bus_type;
1438 struct phy_device *phydev;
1443 return ERR_PTR(-EINVAL);
1445 /* Search the list of PHY devices on the mdio bus for the
1446 * PHY with the requested name
1448 d = bus_find_device_by_name(bus, NULL, bus_id);
1450 pr_err("PHY %s not found\n", bus_id);
1451 return ERR_PTR(-ENODEV);
1453 phydev = to_phy_device(d);
1455 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1462 EXPORT_SYMBOL(phy_attach);
1464 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1465 struct device_driver *driver)
1467 struct device *d = &phydev->mdio.dev;
1474 ret = d->driver == driver;
1480 bool phy_driver_is_genphy(struct phy_device *phydev)
1482 return phy_driver_is_genphy_kind(phydev,
1483 &genphy_driver.mdiodrv.driver);
1485 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1487 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1489 return phy_driver_is_genphy_kind(phydev,
1490 &genphy_c45_driver.mdiodrv.driver);
1492 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1495 * phy_package_join - join a common PHY group
1496 * @phydev: target phy_device struct
1497 * @addr: cookie and PHY address for global register access
1498 * @priv_size: if non-zero allocate this amount of bytes for private data
1500 * This joins a PHY group and provides a shared storage for all phydevs in
1501 * this group. This is intended to be used for packages which contain
1502 * more than one PHY, for example a quad PHY transceiver.
1504 * The addr parameter serves as a cookie which has to have the same value
1505 * for all members of one group and as a PHY address to access generic
1506 * registers of a PHY package. Usually, one of the PHY addresses of the
1507 * different PHYs in the package provides access to these global registers.
1508 * The address which is given here, will be used in the phy_package_read()
1509 * and phy_package_write() convenience functions. If your PHY doesn't have
1510 * global registers you can just pick any of the PHY addresses.
1512 * This will set the shared pointer of the phydev to the shared storage.
1513 * If this is the first call for a this cookie the shared storage will be
1514 * allocated. If priv_size is non-zero, the given amount of bytes are
1515 * allocated for the priv member.
1517 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1518 * with the same cookie but a different priv_size is an error.
1520 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1522 struct mii_bus *bus = phydev->mdio.bus;
1523 struct phy_package_shared *shared;
1526 if (addr < 0 || addr >= PHY_MAX_ADDR)
1529 mutex_lock(&bus->shared_lock);
1530 shared = bus->shared[addr];
1533 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1537 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1540 shared->priv_size = priv_size;
1542 shared->addr = addr;
1543 refcount_set(&shared->refcnt, 1);
1544 bus->shared[addr] = shared;
1547 if (priv_size && priv_size != shared->priv_size)
1549 refcount_inc(&shared->refcnt);
1551 mutex_unlock(&bus->shared_lock);
1553 phydev->shared = shared;
1560 mutex_unlock(&bus->shared_lock);
1563 EXPORT_SYMBOL_GPL(phy_package_join);
1566 * phy_package_leave - leave a common PHY group
1567 * @phydev: target phy_device struct
1569 * This leaves a PHY group created by phy_package_join(). If this phydev
1570 * was the last user of the shared data between the group, this data is
1571 * freed. Resets the phydev->shared pointer to NULL.
1573 void phy_package_leave(struct phy_device *phydev)
1575 struct phy_package_shared *shared = phydev->shared;
1576 struct mii_bus *bus = phydev->mdio.bus;
1581 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1582 bus->shared[shared->addr] = NULL;
1583 mutex_unlock(&bus->shared_lock);
1584 kfree(shared->priv);
1588 phydev->shared = NULL;
1590 EXPORT_SYMBOL_GPL(phy_package_leave);
1592 static void devm_phy_package_leave(struct device *dev, void *res)
1594 phy_package_leave(*(struct phy_device **)res);
1598 * devm_phy_package_join - resource managed phy_package_join()
1599 * @dev: device that is registering this PHY package
1600 * @phydev: target phy_device struct
1601 * @addr: cookie and PHY address for global register access
1602 * @priv_size: if non-zero allocate this amount of bytes for private data
1604 * Managed phy_package_join(). Shared storage fetched by this function,
1605 * phy_package_leave() is automatically called on driver detach. See
1606 * phy_package_join() for more information.
1608 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1609 int addr, size_t priv_size)
1611 struct phy_device **ptr;
1614 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1619 ret = phy_package_join(phydev, addr, priv_size);
1623 devres_add(dev, ptr);
1630 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1633 * phy_detach - detach a PHY device from its network device
1634 * @phydev: target phy_device struct
1636 * This detaches the phy device from its network device and the phy
1637 * driver, and drops the reference count taken in phy_attach_direct().
1639 void phy_detach(struct phy_device *phydev)
1641 struct net_device *dev = phydev->attached_dev;
1642 struct module *ndev_owner = NULL;
1643 struct mii_bus *bus;
1645 if (phydev->sysfs_links) {
1647 sysfs_remove_link(&dev->dev.kobj, "phydev");
1648 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1651 if (!phydev->attached_dev)
1652 sysfs_remove_file(&phydev->mdio.dev.kobj,
1653 &dev_attr_phy_standalone.attr);
1655 phy_suspend(phydev);
1657 phydev->attached_dev->phydev = NULL;
1658 phydev->attached_dev = NULL;
1660 phydev->phylink = NULL;
1662 phy_led_triggers_unregister(phydev);
1664 module_put(phydev->mdio.dev.driver->owner);
1666 /* If the device had no specific driver before (i.e. - it
1667 * was using the generic driver), we unbind the device
1668 * from the generic driver so that there's a chance a
1669 * real driver could be loaded
1671 if (phy_driver_is_genphy(phydev) ||
1672 phy_driver_is_genphy_10g(phydev))
1673 device_release_driver(&phydev->mdio.dev);
1676 * The phydev might go away on the put_device() below, so avoid
1677 * a use-after-free bug by reading the underlying bus first.
1679 bus = phydev->mdio.bus;
1681 put_device(&phydev->mdio.dev);
1683 ndev_owner = dev->dev.parent->driver->owner;
1684 if (ndev_owner != bus->owner)
1685 module_put(bus->owner);
1687 /* Assert the reset signal */
1688 phy_device_reset(phydev, 1);
1690 EXPORT_SYMBOL(phy_detach);
1692 int phy_suspend(struct phy_device *phydev)
1694 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1695 struct net_device *netdev = phydev->attached_dev;
1696 struct phy_driver *phydrv = phydev->drv;
1699 if (phydev->suspended)
1702 /* If the device has WOL enabled, we cannot suspend the PHY */
1703 phy_ethtool_get_wol(phydev, &wol);
1704 if (wol.wolopts || (netdev && netdev->wol_enabled))
1707 if (!phydrv || !phydrv->suspend)
1710 ret = phydrv->suspend(phydev);
1712 phydev->suspended = true;
1716 EXPORT_SYMBOL(phy_suspend);
1718 int __phy_resume(struct phy_device *phydev)
1720 struct phy_driver *phydrv = phydev->drv;
1723 WARN_ON(!mutex_is_locked(&phydev->lock));
1725 if (!phydrv || !phydrv->resume)
1728 ret = phydrv->resume(phydev);
1730 phydev->suspended = false;
1734 EXPORT_SYMBOL(__phy_resume);
1736 int phy_resume(struct phy_device *phydev)
1740 mutex_lock(&phydev->lock);
1741 ret = __phy_resume(phydev);
1742 mutex_unlock(&phydev->lock);
1746 EXPORT_SYMBOL(phy_resume);
1748 int phy_loopback(struct phy_device *phydev, bool enable)
1750 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1753 mutex_lock(&phydev->lock);
1755 if (enable && phydev->loopback_enabled) {
1760 if (!enable && !phydev->loopback_enabled) {
1765 if (phydev->drv && phydrv->set_loopback)
1766 ret = phydrv->set_loopback(phydev, enable);
1773 phydev->loopback_enabled = enable;
1776 mutex_unlock(&phydev->lock);
1779 EXPORT_SYMBOL(phy_loopback);
1782 * phy_reset_after_clk_enable - perform a PHY reset if needed
1783 * @phydev: target phy_device struct
1785 * Description: Some PHYs are known to need a reset after their refclk was
1786 * enabled. This function evaluates the flags and perform the reset if it's
1787 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1790 int phy_reset_after_clk_enable(struct phy_device *phydev)
1792 if (!phydev || !phydev->drv)
1795 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1796 phy_device_reset(phydev, 1);
1797 phy_device_reset(phydev, 0);
1803 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1805 /* Generic PHY support and helper functions */
1808 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1809 * @phydev: target phy_device struct
1811 * Description: Writes MII_ADVERTISE with the appropriate values,
1812 * after sanitizing the values to make sure we only advertise
1813 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1814 * hasn't changed, and > 0 if it has changed.
1816 static int genphy_config_advert(struct phy_device *phydev)
1818 int err, bmsr, changed = 0;
1821 /* Only allow advertising what this PHY supports */
1822 linkmode_and(phydev->advertising, phydev->advertising,
1825 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1827 /* Setup standard advertisement */
1828 err = phy_modify_changed(phydev, MII_ADVERTISE,
1829 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1830 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1837 bmsr = phy_read(phydev, MII_BMSR);
1841 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1842 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1845 if (!(bmsr & BMSR_ESTATEN))
1848 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1850 err = phy_modify_changed(phydev, MII_CTRL1000,
1851 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1862 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1863 * @phydev: target phy_device struct
1865 * Description: Writes MII_ADVERTISE with the appropriate values,
1866 * after sanitizing the values to make sure we only advertise
1867 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1868 * hasn't changed, and > 0 if it has changed. This function is intended
1869 * for Clause 37 1000Base-X mode.
1871 static int genphy_c37_config_advert(struct phy_device *phydev)
1875 /* Only allow advertising what this PHY supports */
1876 linkmode_and(phydev->advertising, phydev->advertising,
1879 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1880 phydev->advertising))
1881 adv |= ADVERTISE_1000XFULL;
1882 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1883 phydev->advertising))
1884 adv |= ADVERTISE_1000XPAUSE;
1885 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1886 phydev->advertising))
1887 adv |= ADVERTISE_1000XPSE_ASYM;
1889 return phy_modify_changed(phydev, MII_ADVERTISE,
1890 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1891 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1896 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1897 * @phydev: target phy_device struct
1899 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1900 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1901 * changed, and 1 if it has changed.
1903 int genphy_config_eee_advert(struct phy_device *phydev)
1907 /* Nothing to disable */
1908 if (!phydev->eee_broken_modes)
1911 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1912 phydev->eee_broken_modes, 0);
1913 /* If the call failed, we assume that EEE is not supported */
1914 return err < 0 ? 0 : err;
1916 EXPORT_SYMBOL(genphy_config_eee_advert);
1919 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1920 * @phydev: target phy_device struct
1922 * Description: Configures MII_BMCR to force speed/duplex
1923 * to the values in phydev. Assumes that the values are valid.
1924 * Please see phy_sanitize_settings().
1926 int genphy_setup_forced(struct phy_device *phydev)
1931 phydev->asym_pause = 0;
1933 if (SPEED_1000 == phydev->speed)
1934 ctl |= BMCR_SPEED1000;
1935 else if (SPEED_100 == phydev->speed)
1936 ctl |= BMCR_SPEED100;
1938 if (DUPLEX_FULL == phydev->duplex)
1939 ctl |= BMCR_FULLDPLX;
1941 return phy_modify(phydev, MII_BMCR,
1942 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1944 EXPORT_SYMBOL(genphy_setup_forced);
1946 static int genphy_setup_master_slave(struct phy_device *phydev)
1950 if (!phydev->is_gigabit_capable)
1953 switch (phydev->master_slave_set) {
1954 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1955 ctl |= CTL1000_PREFER_MASTER;
1957 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1959 case MASTER_SLAVE_CFG_MASTER_FORCE:
1960 ctl |= CTL1000_AS_MASTER;
1962 case MASTER_SLAVE_CFG_SLAVE_FORCE:
1963 ctl |= CTL1000_ENABLE_MASTER;
1965 case MASTER_SLAVE_CFG_UNKNOWN:
1966 case MASTER_SLAVE_CFG_UNSUPPORTED:
1969 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
1973 return phy_modify_changed(phydev, MII_CTRL1000,
1974 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
1975 CTL1000_PREFER_MASTER), ctl);
1978 static int genphy_read_master_slave(struct phy_device *phydev)
1983 if (!phydev->is_gigabit_capable) {
1984 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
1985 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
1989 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
1990 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
1992 val = phy_read(phydev, MII_CTRL1000);
1996 if (val & CTL1000_ENABLE_MASTER) {
1997 if (val & CTL1000_AS_MASTER)
1998 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2000 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2002 if (val & CTL1000_PREFER_MASTER)
2003 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2005 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2008 val = phy_read(phydev, MII_STAT1000);
2012 if (val & LPA_1000MSFAIL) {
2013 state = MASTER_SLAVE_STATE_ERR;
2014 } else if (phydev->link) {
2015 /* this bits are valid only for active link */
2016 if (val & LPA_1000MSRES)
2017 state = MASTER_SLAVE_STATE_MASTER;
2019 state = MASTER_SLAVE_STATE_SLAVE;
2021 state = MASTER_SLAVE_STATE_UNKNOWN;
2024 phydev->master_slave_get = cfg;
2025 phydev->master_slave_state = state;
2031 * genphy_restart_aneg - Enable and Restart Autonegotiation
2032 * @phydev: target phy_device struct
2034 int genphy_restart_aneg(struct phy_device *phydev)
2036 /* Don't isolate the PHY if we're negotiating */
2037 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2038 BMCR_ANENABLE | BMCR_ANRESTART);
2040 EXPORT_SYMBOL(genphy_restart_aneg);
2043 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2044 * @phydev: target phy_device struct
2045 * @restart: whether aneg restart is requested
2047 * Check, and restart auto-negotiation if needed.
2049 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2054 /* Advertisement hasn't changed, but maybe aneg was never on to
2055 * begin with? Or maybe phy was isolated?
2057 ret = phy_read(phydev, MII_BMCR);
2061 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2066 return genphy_restart_aneg(phydev);
2070 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2073 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2074 * @phydev: target phy_device struct
2075 * @changed: whether autoneg is requested
2077 * Description: If auto-negotiation is enabled, we configure the
2078 * advertising, and then restart auto-negotiation. If it is not
2079 * enabled, then we write the BMCR.
2081 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2085 if (genphy_config_eee_advert(phydev))
2088 err = genphy_setup_master_slave(phydev);
2094 if (AUTONEG_ENABLE != phydev->autoneg)
2095 return genphy_setup_forced(phydev);
2097 err = genphy_config_advert(phydev);
2098 if (err < 0) /* error */
2103 return genphy_check_and_restart_aneg(phydev, changed);
2105 EXPORT_SYMBOL(__genphy_config_aneg);
2108 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2109 * @phydev: target phy_device struct
2111 * Description: If auto-negotiation is enabled, we configure the
2112 * advertising, and then restart auto-negotiation. If it is not
2113 * enabled, then we write the BMCR. This function is intended
2114 * for use with Clause 37 1000Base-X mode.
2116 int genphy_c37_config_aneg(struct phy_device *phydev)
2120 if (phydev->autoneg != AUTONEG_ENABLE)
2121 return genphy_setup_forced(phydev);
2123 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2128 changed = genphy_c37_config_advert(phydev);
2129 if (changed < 0) /* error */
2133 /* Advertisement hasn't changed, but maybe aneg was never on to
2134 * begin with? Or maybe phy was isolated?
2136 int ctl = phy_read(phydev, MII_BMCR);
2141 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2142 changed = 1; /* do restart aneg */
2145 /* Only restart aneg if we are advertising something different
2146 * than we were before.
2149 return genphy_restart_aneg(phydev);
2153 EXPORT_SYMBOL(genphy_c37_config_aneg);
2156 * genphy_aneg_done - return auto-negotiation status
2157 * @phydev: target phy_device struct
2159 * Description: Reads the status register and returns 0 either if
2160 * auto-negotiation is incomplete, or if there was an error.
2161 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2163 int genphy_aneg_done(struct phy_device *phydev)
2165 int retval = phy_read(phydev, MII_BMSR);
2167 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2169 EXPORT_SYMBOL(genphy_aneg_done);
2172 * genphy_update_link - update link status in @phydev
2173 * @phydev: target phy_device struct
2175 * Description: Update the value in phydev->link to reflect the
2176 * current link value. In order to do this, we need to read
2177 * the status register twice, keeping the second value.
2179 int genphy_update_link(struct phy_device *phydev)
2181 int status = 0, bmcr;
2183 bmcr = phy_read(phydev, MII_BMCR);
2187 /* Autoneg is being started, therefore disregard BMSR value and
2188 * report link as down.
2190 if (bmcr & BMCR_ANRESTART)
2193 /* The link state is latched low so that momentary link
2194 * drops can be detected. Do not double-read the status
2195 * in polling mode to detect such short link drops except
2196 * the link was already down.
2198 if (!phy_polling_mode(phydev) || !phydev->link) {
2199 status = phy_read(phydev, MII_BMSR);
2202 else if (status & BMSR_LSTATUS)
2206 /* Read link and autonegotiation status */
2207 status = phy_read(phydev, MII_BMSR);
2211 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2212 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2214 /* Consider the case that autoneg was started and "aneg complete"
2215 * bit has been reset, but "link up" bit not yet.
2217 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2222 EXPORT_SYMBOL(genphy_update_link);
2224 int genphy_read_lpa(struct phy_device *phydev)
2228 if (phydev->autoneg == AUTONEG_ENABLE) {
2229 if (!phydev->autoneg_complete) {
2230 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2232 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2236 if (phydev->is_gigabit_capable) {
2237 lpagb = phy_read(phydev, MII_STAT1000);
2241 if (lpagb & LPA_1000MSFAIL) {
2242 int adv = phy_read(phydev, MII_CTRL1000);
2247 if (adv & CTL1000_ENABLE_MASTER)
2248 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2250 phydev_err(phydev, "Master/Slave resolution failed\n");
2254 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2258 lpa = phy_read(phydev, MII_LPA);
2262 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2264 linkmode_zero(phydev->lp_advertising);
2269 EXPORT_SYMBOL(genphy_read_lpa);
2272 * genphy_read_status_fixed - read the link parameters for !aneg mode
2273 * @phydev: target phy_device struct
2275 * Read the current duplex and speed state for a PHY operating with
2276 * autonegotiation disabled.
2278 int genphy_read_status_fixed(struct phy_device *phydev)
2280 int bmcr = phy_read(phydev, MII_BMCR);
2285 if (bmcr & BMCR_FULLDPLX)
2286 phydev->duplex = DUPLEX_FULL;
2288 phydev->duplex = DUPLEX_HALF;
2290 if (bmcr & BMCR_SPEED1000)
2291 phydev->speed = SPEED_1000;
2292 else if (bmcr & BMCR_SPEED100)
2293 phydev->speed = SPEED_100;
2295 phydev->speed = SPEED_10;
2299 EXPORT_SYMBOL(genphy_read_status_fixed);
2302 * genphy_read_status - check the link status and update current link state
2303 * @phydev: target phy_device struct
2305 * Description: Check the link, then figure out the current state
2306 * by comparing what we advertise with what the link partner
2307 * advertises. Start by checking the gigabit possibilities,
2308 * then move on to 10/100.
2310 int genphy_read_status(struct phy_device *phydev)
2312 int err, old_link = phydev->link;
2314 /* Update the link, but return if there was an error */
2315 err = genphy_update_link(phydev);
2319 /* why bother the PHY if nothing can have changed */
2320 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2323 phydev->speed = SPEED_UNKNOWN;
2324 phydev->duplex = DUPLEX_UNKNOWN;
2326 phydev->asym_pause = 0;
2328 err = genphy_read_master_slave(phydev);
2332 err = genphy_read_lpa(phydev);
2336 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2337 phy_resolve_aneg_linkmode(phydev);
2338 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2339 err = genphy_read_status_fixed(phydev);
2346 EXPORT_SYMBOL(genphy_read_status);
2349 * genphy_c37_read_status - check the link status and update current link state
2350 * @phydev: target phy_device struct
2352 * Description: Check the link, then figure out the current state
2353 * by comparing what we advertise with what the link partner
2354 * advertises. This function is for Clause 37 1000Base-X mode.
2356 int genphy_c37_read_status(struct phy_device *phydev)
2358 int lpa, err, old_link = phydev->link;
2360 /* Update the link, but return if there was an error */
2361 err = genphy_update_link(phydev);
2365 /* why bother the PHY if nothing can have changed */
2366 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2369 phydev->duplex = DUPLEX_UNKNOWN;
2371 phydev->asym_pause = 0;
2373 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2374 lpa = phy_read(phydev, MII_LPA);
2378 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2379 phydev->lp_advertising, lpa & LPA_LPACK);
2380 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2381 phydev->lp_advertising, lpa & LPA_1000XFULL);
2382 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2383 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2384 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2385 phydev->lp_advertising,
2386 lpa & LPA_1000XPAUSE_ASYM);
2388 phy_resolve_aneg_linkmode(phydev);
2389 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2390 int bmcr = phy_read(phydev, MII_BMCR);
2395 if (bmcr & BMCR_FULLDPLX)
2396 phydev->duplex = DUPLEX_FULL;
2398 phydev->duplex = DUPLEX_HALF;
2403 EXPORT_SYMBOL(genphy_c37_read_status);
2406 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2407 * @phydev: target phy_device struct
2409 * Description: Perform a software PHY reset using the standard
2410 * BMCR_RESET bit and poll for the reset bit to be cleared.
2412 * Returns: 0 on success, < 0 on failure
2414 int genphy_soft_reset(struct phy_device *phydev)
2416 u16 res = BMCR_RESET;
2419 if (phydev->autoneg == AUTONEG_ENABLE)
2420 res |= BMCR_ANRESTART;
2422 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2426 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2427 * to their default value. Therefore the POWER DOWN bit is supposed to
2428 * be cleared after soft reset.
2430 phydev->suspended = 0;
2432 ret = phy_poll_reset(phydev);
2436 /* BMCR may be reset to defaults */
2437 if (phydev->autoneg == AUTONEG_DISABLE)
2438 ret = genphy_setup_forced(phydev);
2442 EXPORT_SYMBOL(genphy_soft_reset);
2445 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2446 * @phydev: target phy_device struct
2448 * Description: Reads the PHY's abilities and populates
2449 * phydev->supported accordingly.
2451 * Returns: 0 on success, < 0 on failure
2453 int genphy_read_abilities(struct phy_device *phydev)
2457 linkmode_set_bit_array(phy_basic_ports_array,
2458 ARRAY_SIZE(phy_basic_ports_array),
2461 val = phy_read(phydev, MII_BMSR);
2465 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2466 val & BMSR_ANEGCAPABLE);
2468 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2469 val & BMSR_100FULL);
2470 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2471 val & BMSR_100HALF);
2472 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2474 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2477 if (val & BMSR_ESTATEN) {
2478 val = phy_read(phydev, MII_ESTATUS);
2482 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2483 phydev->supported, val & ESTATUS_1000_TFULL);
2484 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2485 phydev->supported, val & ESTATUS_1000_THALF);
2486 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2487 phydev->supported, val & ESTATUS_1000_XFULL);
2492 EXPORT_SYMBOL(genphy_read_abilities);
2494 /* This is used for the phy device which doesn't support the MMD extended
2495 * register access, but it does have side effect when we are trying to access
2496 * the MMD register via indirect method.
2498 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2502 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2504 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2505 u16 regnum, u16 val)
2509 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2511 int genphy_suspend(struct phy_device *phydev)
2513 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2515 EXPORT_SYMBOL(genphy_suspend);
2517 int genphy_resume(struct phy_device *phydev)
2519 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2521 EXPORT_SYMBOL(genphy_resume);
2523 int genphy_loopback(struct phy_device *phydev, bool enable)
2525 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2526 enable ? BMCR_LOOPBACK : 0);
2528 EXPORT_SYMBOL(genphy_loopback);
2531 * phy_remove_link_mode - Remove a supported link mode
2532 * @phydev: phy_device structure to remove link mode from
2533 * @link_mode: Link mode to be removed
2535 * Description: Some MACs don't support all link modes which the PHY
2536 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2537 * to remove a link mode.
2539 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2541 linkmode_clear_bit(link_mode, phydev->supported);
2542 phy_advertise_supported(phydev);
2544 EXPORT_SYMBOL(phy_remove_link_mode);
2546 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2548 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2549 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2550 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2551 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2555 * phy_advertise_supported - Advertise all supported modes
2556 * @phydev: target phy_device struct
2558 * Description: Called to advertise all supported modes, doesn't touch
2559 * pause mode advertising.
2561 void phy_advertise_supported(struct phy_device *phydev)
2563 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2565 linkmode_copy(new, phydev->supported);
2566 phy_copy_pause_bits(new, phydev->advertising);
2567 linkmode_copy(phydev->advertising, new);
2569 EXPORT_SYMBOL(phy_advertise_supported);
2572 * phy_support_sym_pause - Enable support of symmetrical pause
2573 * @phydev: target phy_device struct
2575 * Description: Called by the MAC to indicate is supports symmetrical
2576 * Pause, but not asym pause.
2578 void phy_support_sym_pause(struct phy_device *phydev)
2580 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2581 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2583 EXPORT_SYMBOL(phy_support_sym_pause);
2586 * phy_support_asym_pause - Enable support of asym pause
2587 * @phydev: target phy_device struct
2589 * Description: Called by the MAC to indicate is supports Asym Pause.
2591 void phy_support_asym_pause(struct phy_device *phydev)
2593 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2595 EXPORT_SYMBOL(phy_support_asym_pause);
2598 * phy_set_sym_pause - Configure symmetric Pause
2599 * @phydev: target phy_device struct
2600 * @rx: Receiver Pause is supported
2601 * @tx: Transmit Pause is supported
2602 * @autoneg: Auto neg should be used
2604 * Description: Configure advertised Pause support depending on if
2605 * receiver pause and pause auto neg is supported. Generally called
2606 * from the set_pauseparam .ndo.
2608 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2611 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2613 if (rx && tx && autoneg)
2614 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2617 linkmode_copy(phydev->advertising, phydev->supported);
2619 EXPORT_SYMBOL(phy_set_sym_pause);
2622 * phy_set_asym_pause - Configure Pause and Asym Pause
2623 * @phydev: target phy_device struct
2624 * @rx: Receiver Pause is supported
2625 * @tx: Transmit Pause is supported
2627 * Description: Configure advertised Pause support depending on if
2628 * transmit and receiver pause is supported. If there has been a
2629 * change in adverting, trigger a new autoneg. Generally called from
2630 * the set_pauseparam .ndo.
2632 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2634 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2636 linkmode_copy(oldadv, phydev->advertising);
2637 linkmode_set_pause(phydev->advertising, tx, rx);
2639 if (!linkmode_equal(oldadv, phydev->advertising) &&
2641 phy_start_aneg(phydev);
2643 EXPORT_SYMBOL(phy_set_asym_pause);
2646 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2647 * @phydev: phy_device struct
2648 * @pp: requested pause configuration
2650 * Description: Test if the PHY/MAC combination supports the Pause
2651 * configuration the user is requesting. Returns True if it is
2652 * supported, false otherwise.
2654 bool phy_validate_pause(struct phy_device *phydev,
2655 struct ethtool_pauseparam *pp)
2657 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2658 phydev->supported) && pp->rx_pause)
2661 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2662 phydev->supported) &&
2663 pp->rx_pause != pp->tx_pause)
2668 EXPORT_SYMBOL(phy_validate_pause);
2671 * phy_get_pause - resolve negotiated pause modes
2672 * @phydev: phy_device struct
2673 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2675 * @rx_pause: pointer to bool to indicate whether receive pause should be
2678 * Resolve and return the flow control modes according to the negotiation
2679 * result. This includes checking that we are operating in full duplex mode.
2680 * See linkmode_resolve_pause() for further details.
2682 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2684 if (phydev->duplex != DUPLEX_FULL) {
2690 return linkmode_resolve_pause(phydev->advertising,
2691 phydev->lp_advertising,
2692 tx_pause, rx_pause);
2694 EXPORT_SYMBOL(phy_get_pause);
2696 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2698 return phydrv->config_intr && phydrv->ack_interrupt;
2702 * phy_probe - probe and init a PHY device
2703 * @dev: device to probe and init
2705 * Description: Take care of setting up the phy_device structure,
2706 * set the state to READY (the driver's init function should
2707 * set it to STARTING if needed).
2709 static int phy_probe(struct device *dev)
2711 struct phy_device *phydev = to_phy_device(dev);
2712 struct device_driver *drv = phydev->mdio.dev.driver;
2713 struct phy_driver *phydrv = to_phy_driver(drv);
2716 phydev->drv = phydrv;
2718 /* Disable the interrupt if the PHY doesn't support it
2719 * but the interrupt is still a valid one
2721 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2722 phydev->irq = PHY_POLL;
2724 if (phydrv->flags & PHY_IS_INTERNAL)
2725 phydev->is_internal = true;
2727 mutex_lock(&phydev->lock);
2729 if (phydev->drv->probe) {
2730 /* Deassert the reset signal */
2731 phy_device_reset(phydev, 0);
2733 err = phydev->drv->probe(phydev);
2735 /* Assert the reset signal */
2736 phy_device_reset(phydev, 1);
2741 /* Start out supporting everything. Eventually,
2742 * a controller will attach, and may modify one
2743 * or both of these values
2745 if (phydrv->features) {
2746 linkmode_copy(phydev->supported, phydrv->features);
2747 } else if (phydrv->get_features) {
2748 err = phydrv->get_features(phydev);
2749 } else if (phydev->is_c45) {
2750 err = genphy_c45_pma_read_abilities(phydev);
2752 err = genphy_read_abilities(phydev);
2758 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2760 phydev->autoneg = 0;
2762 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2764 phydev->is_gigabit_capable = 1;
2765 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2767 phydev->is_gigabit_capable = 1;
2769 of_set_phy_supported(phydev);
2770 phy_advertise_supported(phydev);
2772 /* Get the EEE modes we want to prohibit. We will ask
2773 * the PHY stop advertising these mode later on
2775 of_set_phy_eee_broken(phydev);
2777 /* The Pause Frame bits indicate that the PHY can support passing
2778 * pause frames. During autonegotiation, the PHYs will determine if
2779 * they should allow pause frames to pass. The MAC driver should then
2780 * use that result to determine whether to enable flow control via
2783 * Normally, PHY drivers should not set the Pause bits, and instead
2784 * allow phylib to do that. However, there may be some situations
2785 * (e.g. hardware erratum) where the driver wants to set only one
2788 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2789 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2790 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2792 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2796 /* Set the state to READY by default */
2797 phydev->state = PHY_READY;
2800 mutex_unlock(&phydev->lock);
2805 static int phy_remove(struct device *dev)
2807 struct phy_device *phydev = to_phy_device(dev);
2809 cancel_delayed_work_sync(&phydev->state_queue);
2811 mutex_lock(&phydev->lock);
2812 phydev->state = PHY_DOWN;
2813 mutex_unlock(&phydev->lock);
2815 sfp_bus_del_upstream(phydev->sfp_bus);
2816 phydev->sfp_bus = NULL;
2818 if (phydev->drv && phydev->drv->remove) {
2819 phydev->drv->remove(phydev);
2821 /* Assert the reset signal */
2822 phy_device_reset(phydev, 1);
2830 * phy_driver_register - register a phy_driver with the PHY layer
2831 * @new_driver: new phy_driver to register
2832 * @owner: module owning this PHY
2834 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2838 /* Either the features are hard coded, or dynamically
2839 * determined. It cannot be both.
2841 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2842 pr_err("%s: features and get_features must not both be set\n",
2847 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2848 new_driver->mdiodrv.driver.name = new_driver->name;
2849 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2850 new_driver->mdiodrv.driver.probe = phy_probe;
2851 new_driver->mdiodrv.driver.remove = phy_remove;
2852 new_driver->mdiodrv.driver.owner = owner;
2853 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2855 retval = driver_register(&new_driver->mdiodrv.driver);
2857 pr_err("%s: Error %d in registering driver\n",
2858 new_driver->name, retval);
2863 pr_debug("%s: Registered new driver\n", new_driver->name);
2867 EXPORT_SYMBOL(phy_driver_register);
2869 int phy_drivers_register(struct phy_driver *new_driver, int n,
2870 struct module *owner)
2874 for (i = 0; i < n; i++) {
2875 ret = phy_driver_register(new_driver + i, owner);
2878 phy_driver_unregister(new_driver + i);
2884 EXPORT_SYMBOL(phy_drivers_register);
2886 void phy_driver_unregister(struct phy_driver *drv)
2888 driver_unregister(&drv->mdiodrv.driver);
2890 EXPORT_SYMBOL(phy_driver_unregister);
2892 void phy_drivers_unregister(struct phy_driver *drv, int n)
2896 for (i = 0; i < n; i++)
2897 phy_driver_unregister(drv + i);
2899 EXPORT_SYMBOL(phy_drivers_unregister);
2901 static struct phy_driver genphy_driver = {
2902 .phy_id = 0xffffffff,
2903 .phy_id_mask = 0xffffffff,
2904 .name = "Generic PHY",
2905 .get_features = genphy_read_abilities,
2906 .suspend = genphy_suspend,
2907 .resume = genphy_resume,
2908 .set_loopback = genphy_loopback,
2911 static int __init phy_init(void)
2915 rc = mdio_bus_init();
2921 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2925 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2927 phy_driver_unregister(&genphy_c45_driver);
2935 static void __exit phy_exit(void)
2937 phy_driver_unregister(&genphy_c45_driver);
2938 phy_driver_unregister(&genphy_driver);
2942 subsys_initcall(phy_init);
2943 module_exit(phy_exit);