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 * @phy_id: where to store the ID retrieved.
701 * @c45_ids: where to store the c45 ID information.
703 * If the PHY devices-in-package appears to be valid, it and the
704 * corresponding identifiers are stored in @c45_ids, zero is stored
705 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
709 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
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);
724 if ((*devs & 0x1fffffff) == 0x1fffffff) {
725 /* If mostly Fs, there is no device there,
726 * then let's continue to probe more, as some
727 * 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);
733 /* no device there, let's get out of here */
734 if ((*devs & 0x1fffffff) == 0x1fffffff) {
735 *phy_id = 0xffffffff;
743 /* Now probe Device Identifiers for each device present. */
744 for (i = 1; i < num_ids; i++) {
745 if (!(c45_ids->devices_in_package & (1 << i)))
748 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
751 c45_ids->device_ids[i] = phy_reg << 16;
753 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
756 c45_ids->device_ids[i] |= phy_reg;
763 * get_phy_id - reads the specified addr for its ID.
764 * @bus: the target MII bus
765 * @addr: PHY address on the MII bus
766 * @phy_id: where to store the ID retrieved.
767 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
768 * @c45_ids: where to store the c45 ID information.
770 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
771 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
774 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
775 * its return value is in turn returned.
778 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
779 bool is_c45, struct phy_c45_device_ids *c45_ids)
784 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
786 /* Grab the bits from PHYIR1, and put them in the upper half */
787 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
789 /* returning -ENODEV doesn't stop bus scanning */
790 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
793 *phy_id = phy_reg << 16;
795 /* Grab the bits from PHYIR2, and put them in the lower half */
796 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
806 * get_phy_device - reads the specified PHY device and returns its @phy_device
808 * @bus: the target MII bus
809 * @addr: PHY address on the MII bus
810 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
812 * Description: Reads the ID registers of the PHY at @addr on the
813 * @bus, then allocates and returns the phy_device to represent it.
815 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
817 struct phy_c45_device_ids c45_ids;
821 c45_ids.devices_in_package = 0;
822 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
824 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
828 /* If the phy_id is mostly Fs, there is no device there */
829 if ((phy_id & 0x1fffffff) == 0x1fffffff)
830 return ERR_PTR(-ENODEV);
832 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
834 EXPORT_SYMBOL(get_phy_device);
837 * phy_device_register - Register the phy device on the MDIO bus
838 * @phydev: phy_device structure to be added to the MDIO bus
840 int phy_device_register(struct phy_device *phydev)
844 err = mdiobus_register_device(&phydev->mdio);
848 /* Deassert the reset signal */
849 phy_device_reset(phydev, 0);
851 /* Run all of the fixups for this PHY */
852 err = phy_scan_fixups(phydev);
854 phydev_err(phydev, "failed to initialize\n");
858 err = device_add(&phydev->mdio.dev);
860 phydev_err(phydev, "failed to add\n");
867 /* Assert the reset signal */
868 phy_device_reset(phydev, 1);
870 mdiobus_unregister_device(&phydev->mdio);
873 EXPORT_SYMBOL(phy_device_register);
876 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
877 * @phydev: phy_device structure to remove
879 * This doesn't free the phy_device itself, it merely reverses the effects
880 * of phy_device_register(). Use phy_device_free() to free the device
881 * after calling this function.
883 void phy_device_remove(struct phy_device *phydev)
886 unregister_mii_timestamper(phydev->mii_ts);
888 device_del(&phydev->mdio.dev);
890 /* Assert the reset signal */
891 phy_device_reset(phydev, 1);
893 mdiobus_unregister_device(&phydev->mdio);
895 EXPORT_SYMBOL(phy_device_remove);
898 * phy_find_first - finds the first PHY device on the bus
899 * @bus: the target MII bus
901 struct phy_device *phy_find_first(struct mii_bus *bus)
903 struct phy_device *phydev;
906 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
907 phydev = mdiobus_get_phy(bus, addr);
913 EXPORT_SYMBOL(phy_find_first);
915 static void phy_link_change(struct phy_device *phydev, bool up)
917 struct net_device *netdev = phydev->attached_dev;
920 netif_carrier_on(netdev);
922 netif_carrier_off(netdev);
923 phydev->adjust_link(netdev);
924 if (phydev->mii_ts && phydev->mii_ts->link_state)
925 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
929 * phy_prepare_link - prepares the PHY layer to monitor link status
930 * @phydev: target phy_device struct
931 * @handler: callback function for link status change notifications
933 * Description: Tells the PHY infrastructure to handle the
934 * gory details on monitoring link status (whether through
935 * polling or an interrupt), and to call back to the
936 * connected device driver when the link status changes.
937 * If you want to monitor your own link state, don't call
940 static void phy_prepare_link(struct phy_device *phydev,
941 void (*handler)(struct net_device *))
943 phydev->adjust_link = handler;
947 * phy_connect_direct - connect an ethernet device to a specific phy_device
948 * @dev: the network device to connect
949 * @phydev: the pointer to the phy device
950 * @handler: callback function for state change notifications
951 * @interface: PHY device's interface
953 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
954 void (*handler)(struct net_device *),
955 phy_interface_t interface)
962 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
966 phy_prepare_link(phydev, handler);
967 if (phy_interrupt_is_valid(phydev))
968 phy_request_interrupt(phydev);
972 EXPORT_SYMBOL(phy_connect_direct);
975 * phy_connect - connect an ethernet device to a PHY device
976 * @dev: the network device to connect
977 * @bus_id: the id string of the PHY device to connect
978 * @handler: callback function for state change notifications
979 * @interface: PHY device's interface
981 * Description: Convenience function for connecting ethernet
982 * devices to PHY devices. The default behavior is for
983 * the PHY infrastructure to handle everything, and only notify
984 * the connected driver when the link status changes. If you
985 * don't want, or can't use the provided functionality, you may
986 * choose to call only the subset of functions which provide
987 * the desired functionality.
989 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
990 void (*handler)(struct net_device *),
991 phy_interface_t interface)
993 struct phy_device *phydev;
997 /* Search the list of PHY devices on the mdio bus for the
998 * PHY with the requested name
1000 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1002 pr_err("PHY %s not found\n", bus_id);
1003 return ERR_PTR(-ENODEV);
1005 phydev = to_phy_device(d);
1007 rc = phy_connect_direct(dev, phydev, handler, interface);
1014 EXPORT_SYMBOL(phy_connect);
1017 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1019 * @phydev: target phy_device struct
1021 void phy_disconnect(struct phy_device *phydev)
1023 if (phy_is_started(phydev))
1026 if (phy_interrupt_is_valid(phydev))
1027 phy_free_interrupt(phydev);
1029 phydev->adjust_link = NULL;
1033 EXPORT_SYMBOL(phy_disconnect);
1036 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1037 * @phydev: The PHY device to poll
1039 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1040 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1041 * register must be polled until the BMCR_RESET bit clears.
1043 * Furthermore, any attempts to write to PHY registers may have no effect
1044 * or even generate MDIO bus errors until this is complete.
1046 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1047 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1048 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1049 * effort to support such broken PHYs, this function is separate from the
1050 * standard phy_init_hw() which will zero all the other bits in the BMCR
1051 * and reapply all driver-specific and board-specific fixups.
1053 static int phy_poll_reset(struct phy_device *phydev)
1055 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1058 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1059 50000, 600000, true);
1062 /* Some chips (smsc911x) may still need up to another 1ms after the
1063 * BMCR_RESET bit is cleared before they are usable.
1069 int phy_init_hw(struct phy_device *phydev)
1073 /* Deassert the reset signal */
1074 phy_device_reset(phydev, 0);
1079 if (phydev->drv->soft_reset) {
1080 ret = phydev->drv->soft_reset(phydev);
1081 /* see comment in genphy_soft_reset for an explanation */
1083 phydev->suspended = 0;
1089 ret = phy_scan_fixups(phydev);
1093 if (phydev->drv->config_init)
1094 ret = phydev->drv->config_init(phydev);
1098 EXPORT_SYMBOL(phy_init_hw);
1100 void phy_attached_info(struct phy_device *phydev)
1102 phy_attached_print(phydev, NULL);
1104 EXPORT_SYMBOL(phy_attached_info);
1106 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1107 char *phy_attached_info_irq(struct phy_device *phydev)
1112 switch(phydev->irq) {
1116 case PHY_IGNORE_INTERRUPT:
1120 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1125 return kasprintf(GFP_KERNEL, "%s", irq_str);
1127 EXPORT_SYMBOL(phy_attached_info_irq);
1129 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1131 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1132 char *irq_str = phy_attached_info_irq(phydev);
1135 phydev_info(phydev, ATTACHED_FMT "\n",
1136 drv_name, phydev_name(phydev),
1141 phydev_info(phydev, ATTACHED_FMT,
1142 drv_name, phydev_name(phydev),
1151 EXPORT_SYMBOL(phy_attached_print);
1153 static void phy_sysfs_create_links(struct phy_device *phydev)
1155 struct net_device *dev = phydev->attached_dev;
1161 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1166 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1167 &phydev->mdio.dev.kobj,
1170 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1171 kobject_name(&phydev->mdio.dev.kobj),
1173 /* non-fatal - some net drivers can use one netdevice
1174 * with more then one phy
1178 phydev->sysfs_links = true;
1182 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1185 struct phy_device *phydev = to_phy_device(dev);
1187 return sprintf(buf, "%d\n", !phydev->attached_dev);
1189 static DEVICE_ATTR_RO(phy_standalone);
1192 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1193 * @upstream: pointer to the phy device
1194 * @bus: sfp bus representing cage being attached
1196 * This is used to fill in the sfp_upstream_ops .attach member.
1198 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1200 struct phy_device *phydev = upstream;
1202 if (phydev->attached_dev)
1203 phydev->attached_dev->sfp_bus = bus;
1204 phydev->sfp_bus_attached = true;
1206 EXPORT_SYMBOL(phy_sfp_attach);
1209 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1210 * @upstream: pointer to the phy device
1211 * @bus: sfp bus representing cage being attached
1213 * This is used to fill in the sfp_upstream_ops .detach member.
1215 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1217 struct phy_device *phydev = upstream;
1219 if (phydev->attached_dev)
1220 phydev->attached_dev->sfp_bus = NULL;
1221 phydev->sfp_bus_attached = false;
1223 EXPORT_SYMBOL(phy_sfp_detach);
1226 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1227 * @phydev: Pointer to phy_device
1228 * @ops: SFP's upstream operations
1230 int phy_sfp_probe(struct phy_device *phydev,
1231 const struct sfp_upstream_ops *ops)
1233 struct sfp_bus *bus;
1236 if (phydev->mdio.dev.fwnode) {
1237 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1239 return PTR_ERR(bus);
1241 phydev->sfp_bus = bus;
1243 ret = sfp_bus_add_upstream(bus, phydev, ops);
1248 EXPORT_SYMBOL(phy_sfp_probe);
1251 * phy_attach_direct - attach a network device to a given PHY device pointer
1252 * @dev: network device to attach
1253 * @phydev: Pointer to phy_device to attach
1254 * @flags: PHY device's dev_flags
1255 * @interface: PHY device's interface
1257 * Description: Called by drivers to attach to a particular PHY
1258 * device. The phy_device is found, and properly hooked up
1259 * to the phy_driver. If no driver is attached, then a
1260 * generic driver is used. The phy_device is given a ptr to
1261 * the attaching device, and given a callback for link status
1262 * change. The phy_device is returned to the attaching driver.
1263 * This function takes a reference on the phy device.
1265 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1266 u32 flags, phy_interface_t interface)
1268 struct mii_bus *bus = phydev->mdio.bus;
1269 struct device *d = &phydev->mdio.dev;
1270 struct module *ndev_owner = NULL;
1271 bool using_genphy = false;
1274 /* For Ethernet device drivers that register their own MDIO bus, we
1275 * will have bus->owner match ndev_mod, so we do not want to increment
1276 * our own module->refcnt here, otherwise we would not be able to
1280 ndev_owner = dev->dev.parent->driver->owner;
1281 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1282 phydev_err(phydev, "failed to get the bus module\n");
1288 /* Assume that if there is no driver, that it doesn't
1289 * exist, and we should use the genphy driver.
1293 d->driver = &genphy_c45_driver.mdiodrv.driver;
1295 d->driver = &genphy_driver.mdiodrv.driver;
1297 using_genphy = true;
1300 if (!try_module_get(d->driver->owner)) {
1301 phydev_err(phydev, "failed to get the device driver module\n");
1303 goto error_put_device;
1307 err = d->driver->probe(d);
1309 err = device_bind_driver(d);
1312 goto error_module_put;
1315 if (phydev->attached_dev) {
1316 dev_err(&dev->dev, "PHY already attached\n");
1321 phydev->phy_link_change = phy_link_change;
1323 phydev->attached_dev = dev;
1324 dev->phydev = phydev;
1326 if (phydev->sfp_bus_attached)
1327 dev->sfp_bus = phydev->sfp_bus;
1330 /* Some Ethernet drivers try to connect to a PHY device before
1331 * calling register_netdevice() -> netdev_register_kobject() and
1332 * does the dev->dev.kobj initialization. Here we only check for
1333 * success which indicates that the network device kobject is
1334 * ready. Once we do that we still need to keep track of whether
1335 * links were successfully set up or not for phy_detach() to
1336 * remove them accordingly.
1338 phydev->sysfs_links = false;
1340 phy_sysfs_create_links(phydev);
1342 if (!phydev->attached_dev) {
1343 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1344 &dev_attr_phy_standalone.attr);
1346 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1349 phydev->dev_flags |= flags;
1351 phydev->interface = interface;
1353 phydev->state = PHY_READY;
1355 /* Initial carrier state is off as the phy is about to be
1359 netif_carrier_off(phydev->attached_dev);
1361 /* Do initial configuration here, now that
1362 * we have certain key parameters
1363 * (dev_flags and interface)
1365 err = phy_init_hw(phydev);
1370 phy_led_triggers_register(phydev);
1375 /* phy_detach() does all of the cleanup below */
1380 module_put(d->driver->owner);
1383 if (ndev_owner != bus->owner)
1384 module_put(bus->owner);
1387 EXPORT_SYMBOL(phy_attach_direct);
1390 * phy_attach - attach a network device to a particular PHY device
1391 * @dev: network device to attach
1392 * @bus_id: Bus ID of PHY device to attach
1393 * @interface: PHY device's interface
1395 * Description: Same as phy_attach_direct() except that a PHY bus_id
1396 * string is passed instead of a pointer to a struct phy_device.
1398 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1399 phy_interface_t interface)
1401 struct bus_type *bus = &mdio_bus_type;
1402 struct phy_device *phydev;
1407 return ERR_PTR(-EINVAL);
1409 /* Search the list of PHY devices on the mdio bus for the
1410 * PHY with the requested name
1412 d = bus_find_device_by_name(bus, NULL, bus_id);
1414 pr_err("PHY %s not found\n", bus_id);
1415 return ERR_PTR(-ENODEV);
1417 phydev = to_phy_device(d);
1419 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1426 EXPORT_SYMBOL(phy_attach);
1428 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1429 struct device_driver *driver)
1431 struct device *d = &phydev->mdio.dev;
1438 ret = d->driver == driver;
1444 bool phy_driver_is_genphy(struct phy_device *phydev)
1446 return phy_driver_is_genphy_kind(phydev,
1447 &genphy_driver.mdiodrv.driver);
1449 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1451 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1453 return phy_driver_is_genphy_kind(phydev,
1454 &genphy_c45_driver.mdiodrv.driver);
1456 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1459 * phy_package_join - join a common PHY group
1460 * @phydev: target phy_device struct
1461 * @addr: cookie and PHY address for global register access
1462 * @priv_size: if non-zero allocate this amount of bytes for private data
1464 * This joins a PHY group and provides a shared storage for all phydevs in
1465 * this group. This is intended to be used for packages which contain
1466 * more than one PHY, for example a quad PHY transceiver.
1468 * The addr parameter serves as a cookie which has to have the same value
1469 * for all members of one group and as a PHY address to access generic
1470 * registers of a PHY package. Usually, one of the PHY addresses of the
1471 * different PHYs in the package provides access to these global registers.
1472 * The address which is given here, will be used in the phy_package_read()
1473 * and phy_package_write() convenience functions. If your PHY doesn't have
1474 * global registers you can just pick any of the PHY addresses.
1476 * This will set the shared pointer of the phydev to the shared storage.
1477 * If this is the first call for a this cookie the shared storage will be
1478 * allocated. If priv_size is non-zero, the given amount of bytes are
1479 * allocated for the priv member.
1481 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1482 * with the same cookie but a different priv_size is an error.
1484 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1486 struct mii_bus *bus = phydev->mdio.bus;
1487 struct phy_package_shared *shared;
1490 if (addr < 0 || addr >= PHY_MAX_ADDR)
1493 mutex_lock(&bus->shared_lock);
1494 shared = bus->shared[addr];
1497 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1501 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1504 shared->priv_size = priv_size;
1506 shared->addr = addr;
1507 refcount_set(&shared->refcnt, 1);
1508 bus->shared[addr] = shared;
1511 if (priv_size && priv_size != shared->priv_size)
1513 refcount_inc(&shared->refcnt);
1515 mutex_unlock(&bus->shared_lock);
1517 phydev->shared = shared;
1524 mutex_unlock(&bus->shared_lock);
1527 EXPORT_SYMBOL_GPL(phy_package_join);
1530 * phy_package_leave - leave a common PHY group
1531 * @phydev: target phy_device struct
1533 * This leaves a PHY group created by phy_package_join(). If this phydev
1534 * was the last user of the shared data between the group, this data is
1535 * freed. Resets the phydev->shared pointer to NULL.
1537 void phy_package_leave(struct phy_device *phydev)
1539 struct phy_package_shared *shared = phydev->shared;
1540 struct mii_bus *bus = phydev->mdio.bus;
1545 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1546 bus->shared[shared->addr] = NULL;
1547 mutex_unlock(&bus->shared_lock);
1548 kfree(shared->priv);
1552 phydev->shared = NULL;
1554 EXPORT_SYMBOL_GPL(phy_package_leave);
1556 static void devm_phy_package_leave(struct device *dev, void *res)
1558 phy_package_leave(*(struct phy_device **)res);
1562 * devm_phy_package_join - resource managed phy_package_join()
1563 * @dev: device that is registering this PHY package
1564 * @phydev: target phy_device struct
1565 * @addr: cookie and PHY address for global register access
1566 * @priv_size: if non-zero allocate this amount of bytes for private data
1568 * Managed phy_package_join(). Shared storage fetched by this function,
1569 * phy_package_leave() is automatically called on driver detach. See
1570 * phy_package_join() for more information.
1572 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1573 int addr, size_t priv_size)
1575 struct phy_device **ptr;
1578 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1583 ret = phy_package_join(phydev, addr, priv_size);
1587 devres_add(dev, ptr);
1594 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1597 * phy_detach - detach a PHY device from its network device
1598 * @phydev: target phy_device struct
1600 * This detaches the phy device from its network device and the phy
1601 * driver, and drops the reference count taken in phy_attach_direct().
1603 void phy_detach(struct phy_device *phydev)
1605 struct net_device *dev = phydev->attached_dev;
1606 struct module *ndev_owner = NULL;
1607 struct mii_bus *bus;
1609 if (phydev->sysfs_links) {
1611 sysfs_remove_link(&dev->dev.kobj, "phydev");
1612 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1615 if (!phydev->attached_dev)
1616 sysfs_remove_file(&phydev->mdio.dev.kobj,
1617 &dev_attr_phy_standalone.attr);
1619 phy_suspend(phydev);
1621 phydev->attached_dev->phydev = NULL;
1622 phydev->attached_dev = NULL;
1624 phydev->phylink = NULL;
1626 phy_led_triggers_unregister(phydev);
1628 module_put(phydev->mdio.dev.driver->owner);
1630 /* If the device had no specific driver before (i.e. - it
1631 * was using the generic driver), we unbind the device
1632 * from the generic driver so that there's a chance a
1633 * real driver could be loaded
1635 if (phy_driver_is_genphy(phydev) ||
1636 phy_driver_is_genphy_10g(phydev))
1637 device_release_driver(&phydev->mdio.dev);
1640 * The phydev might go away on the put_device() below, so avoid
1641 * a use-after-free bug by reading the underlying bus first.
1643 bus = phydev->mdio.bus;
1645 put_device(&phydev->mdio.dev);
1647 ndev_owner = dev->dev.parent->driver->owner;
1648 if (ndev_owner != bus->owner)
1649 module_put(bus->owner);
1651 /* Assert the reset signal */
1652 phy_device_reset(phydev, 1);
1654 EXPORT_SYMBOL(phy_detach);
1656 int phy_suspend(struct phy_device *phydev)
1658 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1659 struct net_device *netdev = phydev->attached_dev;
1660 struct phy_driver *phydrv = phydev->drv;
1663 if (phydev->suspended)
1666 /* If the device has WOL enabled, we cannot suspend the PHY */
1667 phy_ethtool_get_wol(phydev, &wol);
1668 if (wol.wolopts || (netdev && netdev->wol_enabled))
1671 if (!phydrv || !phydrv->suspend)
1674 ret = phydrv->suspend(phydev);
1676 phydev->suspended = true;
1680 EXPORT_SYMBOL(phy_suspend);
1682 int __phy_resume(struct phy_device *phydev)
1684 struct phy_driver *phydrv = phydev->drv;
1687 WARN_ON(!mutex_is_locked(&phydev->lock));
1689 if (!phydrv || !phydrv->resume)
1692 ret = phydrv->resume(phydev);
1694 phydev->suspended = false;
1698 EXPORT_SYMBOL(__phy_resume);
1700 int phy_resume(struct phy_device *phydev)
1704 mutex_lock(&phydev->lock);
1705 ret = __phy_resume(phydev);
1706 mutex_unlock(&phydev->lock);
1710 EXPORT_SYMBOL(phy_resume);
1712 int phy_loopback(struct phy_device *phydev, bool enable)
1714 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1717 mutex_lock(&phydev->lock);
1719 if (enable && phydev->loopback_enabled) {
1724 if (!enable && !phydev->loopback_enabled) {
1729 if (phydev->drv && phydrv->set_loopback)
1730 ret = phydrv->set_loopback(phydev, enable);
1737 phydev->loopback_enabled = enable;
1740 mutex_unlock(&phydev->lock);
1743 EXPORT_SYMBOL(phy_loopback);
1746 * phy_reset_after_clk_enable - perform a PHY reset if needed
1747 * @phydev: target phy_device struct
1749 * Description: Some PHYs are known to need a reset after their refclk was
1750 * enabled. This function evaluates the flags and perform the reset if it's
1751 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1754 int phy_reset_after_clk_enable(struct phy_device *phydev)
1756 if (!phydev || !phydev->drv)
1759 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1760 phy_device_reset(phydev, 1);
1761 phy_device_reset(phydev, 0);
1767 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1769 /* Generic PHY support and helper functions */
1772 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1773 * @phydev: target phy_device struct
1775 * Description: Writes MII_ADVERTISE with the appropriate values,
1776 * after sanitizing the values to make sure we only advertise
1777 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1778 * hasn't changed, and > 0 if it has changed.
1780 static int genphy_config_advert(struct phy_device *phydev)
1782 int err, bmsr, changed = 0;
1785 /* Only allow advertising what this PHY supports */
1786 linkmode_and(phydev->advertising, phydev->advertising,
1789 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1791 /* Setup standard advertisement */
1792 err = phy_modify_changed(phydev, MII_ADVERTISE,
1793 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1794 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1801 bmsr = phy_read(phydev, MII_BMSR);
1805 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1806 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1809 if (!(bmsr & BMSR_ESTATEN))
1812 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1814 err = phy_modify_changed(phydev, MII_CTRL1000,
1815 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1826 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1827 * @phydev: target phy_device struct
1829 * Description: Writes MII_ADVERTISE with the appropriate values,
1830 * after sanitizing the values to make sure we only advertise
1831 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1832 * hasn't changed, and > 0 if it has changed. This function is intended
1833 * for Clause 37 1000Base-X mode.
1835 static int genphy_c37_config_advert(struct phy_device *phydev)
1839 /* Only allow advertising what this PHY supports */
1840 linkmode_and(phydev->advertising, phydev->advertising,
1843 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1844 phydev->advertising))
1845 adv |= ADVERTISE_1000XFULL;
1846 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1847 phydev->advertising))
1848 adv |= ADVERTISE_1000XPAUSE;
1849 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1850 phydev->advertising))
1851 adv |= ADVERTISE_1000XPSE_ASYM;
1853 return phy_modify_changed(phydev, MII_ADVERTISE,
1854 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1855 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1860 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1861 * @phydev: target phy_device struct
1863 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1864 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1865 * changed, and 1 if it has changed.
1867 int genphy_config_eee_advert(struct phy_device *phydev)
1871 /* Nothing to disable */
1872 if (!phydev->eee_broken_modes)
1875 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1876 phydev->eee_broken_modes, 0);
1877 /* If the call failed, we assume that EEE is not supported */
1878 return err < 0 ? 0 : err;
1880 EXPORT_SYMBOL(genphy_config_eee_advert);
1883 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1884 * @phydev: target phy_device struct
1886 * Description: Configures MII_BMCR to force speed/duplex
1887 * to the values in phydev. Assumes that the values are valid.
1888 * Please see phy_sanitize_settings().
1890 int genphy_setup_forced(struct phy_device *phydev)
1895 phydev->asym_pause = 0;
1897 if (SPEED_1000 == phydev->speed)
1898 ctl |= BMCR_SPEED1000;
1899 else if (SPEED_100 == phydev->speed)
1900 ctl |= BMCR_SPEED100;
1902 if (DUPLEX_FULL == phydev->duplex)
1903 ctl |= BMCR_FULLDPLX;
1905 return phy_modify(phydev, MII_BMCR,
1906 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1908 EXPORT_SYMBOL(genphy_setup_forced);
1910 static int genphy_setup_master_slave(struct phy_device *phydev)
1914 if (!phydev->is_gigabit_capable)
1917 switch (phydev->master_slave_set) {
1918 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1919 ctl |= CTL1000_PREFER_MASTER;
1921 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1923 case MASTER_SLAVE_CFG_MASTER_FORCE:
1924 ctl |= CTL1000_AS_MASTER;
1926 case MASTER_SLAVE_CFG_SLAVE_FORCE:
1927 ctl |= CTL1000_ENABLE_MASTER;
1929 case MASTER_SLAVE_CFG_UNKNOWN:
1930 case MASTER_SLAVE_CFG_UNSUPPORTED:
1933 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
1937 return phy_modify_changed(phydev, MII_CTRL1000,
1938 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
1939 CTL1000_PREFER_MASTER), ctl);
1942 static int genphy_read_master_slave(struct phy_device *phydev)
1947 if (!phydev->is_gigabit_capable) {
1948 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
1949 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
1953 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
1954 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
1956 val = phy_read(phydev, MII_CTRL1000);
1960 if (val & CTL1000_ENABLE_MASTER) {
1961 if (val & CTL1000_AS_MASTER)
1962 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
1964 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
1966 if (val & CTL1000_PREFER_MASTER)
1967 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
1969 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
1972 val = phy_read(phydev, MII_STAT1000);
1976 if (val & LPA_1000MSFAIL) {
1977 state = MASTER_SLAVE_STATE_ERR;
1978 } else if (phydev->link) {
1979 /* this bits are valid only for active link */
1980 if (val & LPA_1000MSRES)
1981 state = MASTER_SLAVE_STATE_MASTER;
1983 state = MASTER_SLAVE_STATE_SLAVE;
1985 state = MASTER_SLAVE_STATE_UNKNOWN;
1988 phydev->master_slave_get = cfg;
1989 phydev->master_slave_state = state;
1995 * genphy_restart_aneg - Enable and Restart Autonegotiation
1996 * @phydev: target phy_device struct
1998 int genphy_restart_aneg(struct phy_device *phydev)
2000 /* Don't isolate the PHY if we're negotiating */
2001 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2002 BMCR_ANENABLE | BMCR_ANRESTART);
2004 EXPORT_SYMBOL(genphy_restart_aneg);
2007 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2008 * @phydev: target phy_device struct
2009 * @restart: whether aneg restart is requested
2011 * Check, and restart auto-negotiation if needed.
2013 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2018 /* Advertisement hasn't changed, but maybe aneg was never on to
2019 * begin with? Or maybe phy was isolated?
2021 ret = phy_read(phydev, MII_BMCR);
2025 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2030 return genphy_restart_aneg(phydev);
2034 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2037 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2038 * @phydev: target phy_device struct
2039 * @changed: whether autoneg is requested
2041 * Description: If auto-negotiation is enabled, we configure the
2042 * advertising, and then restart auto-negotiation. If it is not
2043 * enabled, then we write the BMCR.
2045 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2049 if (genphy_config_eee_advert(phydev))
2052 err = genphy_setup_master_slave(phydev);
2058 if (AUTONEG_ENABLE != phydev->autoneg)
2059 return genphy_setup_forced(phydev);
2061 err = genphy_config_advert(phydev);
2062 if (err < 0) /* error */
2067 return genphy_check_and_restart_aneg(phydev, changed);
2069 EXPORT_SYMBOL(__genphy_config_aneg);
2072 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2073 * @phydev: target phy_device struct
2075 * Description: If auto-negotiation is enabled, we configure the
2076 * advertising, and then restart auto-negotiation. If it is not
2077 * enabled, then we write the BMCR. This function is intended
2078 * for use with Clause 37 1000Base-X mode.
2080 int genphy_c37_config_aneg(struct phy_device *phydev)
2084 if (phydev->autoneg != AUTONEG_ENABLE)
2085 return genphy_setup_forced(phydev);
2087 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2092 changed = genphy_c37_config_advert(phydev);
2093 if (changed < 0) /* error */
2097 /* Advertisement hasn't changed, but maybe aneg was never on to
2098 * begin with? Or maybe phy was isolated?
2100 int ctl = phy_read(phydev, MII_BMCR);
2105 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2106 changed = 1; /* do restart aneg */
2109 /* Only restart aneg if we are advertising something different
2110 * than we were before.
2113 return genphy_restart_aneg(phydev);
2117 EXPORT_SYMBOL(genphy_c37_config_aneg);
2120 * genphy_aneg_done - return auto-negotiation status
2121 * @phydev: target phy_device struct
2123 * Description: Reads the status register and returns 0 either if
2124 * auto-negotiation is incomplete, or if there was an error.
2125 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2127 int genphy_aneg_done(struct phy_device *phydev)
2129 int retval = phy_read(phydev, MII_BMSR);
2131 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2133 EXPORT_SYMBOL(genphy_aneg_done);
2136 * genphy_update_link - update link status in @phydev
2137 * @phydev: target phy_device struct
2139 * Description: Update the value in phydev->link to reflect the
2140 * current link value. In order to do this, we need to read
2141 * the status register twice, keeping the second value.
2143 int genphy_update_link(struct phy_device *phydev)
2145 int status = 0, bmcr;
2147 bmcr = phy_read(phydev, MII_BMCR);
2151 /* Autoneg is being started, therefore disregard BMSR value and
2152 * report link as down.
2154 if (bmcr & BMCR_ANRESTART)
2157 /* The link state is latched low so that momentary link
2158 * drops can be detected. Do not double-read the status
2159 * in polling mode to detect such short link drops except
2160 * the link was already down.
2162 if (!phy_polling_mode(phydev) || !phydev->link) {
2163 status = phy_read(phydev, MII_BMSR);
2166 else if (status & BMSR_LSTATUS)
2170 /* Read link and autonegotiation status */
2171 status = phy_read(phydev, MII_BMSR);
2175 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2176 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2178 /* Consider the case that autoneg was started and "aneg complete"
2179 * bit has been reset, but "link up" bit not yet.
2181 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2186 EXPORT_SYMBOL(genphy_update_link);
2188 int genphy_read_lpa(struct phy_device *phydev)
2192 if (phydev->autoneg == AUTONEG_ENABLE) {
2193 if (!phydev->autoneg_complete) {
2194 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2196 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2200 if (phydev->is_gigabit_capable) {
2201 lpagb = phy_read(phydev, MII_STAT1000);
2205 if (lpagb & LPA_1000MSFAIL) {
2206 int adv = phy_read(phydev, MII_CTRL1000);
2211 if (adv & CTL1000_ENABLE_MASTER)
2212 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2214 phydev_err(phydev, "Master/Slave resolution failed\n");
2218 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2222 lpa = phy_read(phydev, MII_LPA);
2226 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2228 linkmode_zero(phydev->lp_advertising);
2233 EXPORT_SYMBOL(genphy_read_lpa);
2236 * genphy_read_status_fixed - read the link parameters for !aneg mode
2237 * @phydev: target phy_device struct
2239 * Read the current duplex and speed state for a PHY operating with
2240 * autonegotiation disabled.
2242 int genphy_read_status_fixed(struct phy_device *phydev)
2244 int bmcr = phy_read(phydev, MII_BMCR);
2249 if (bmcr & BMCR_FULLDPLX)
2250 phydev->duplex = DUPLEX_FULL;
2252 phydev->duplex = DUPLEX_HALF;
2254 if (bmcr & BMCR_SPEED1000)
2255 phydev->speed = SPEED_1000;
2256 else if (bmcr & BMCR_SPEED100)
2257 phydev->speed = SPEED_100;
2259 phydev->speed = SPEED_10;
2263 EXPORT_SYMBOL(genphy_read_status_fixed);
2266 * genphy_read_status - check the link status and update current link state
2267 * @phydev: target phy_device struct
2269 * Description: Check the link, then figure out the current state
2270 * by comparing what we advertise with what the link partner
2271 * advertises. Start by checking the gigabit possibilities,
2272 * then move on to 10/100.
2274 int genphy_read_status(struct phy_device *phydev)
2276 int err, old_link = phydev->link;
2278 /* Update the link, but return if there was an error */
2279 err = genphy_update_link(phydev);
2283 /* why bother the PHY if nothing can have changed */
2284 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2287 phydev->speed = SPEED_UNKNOWN;
2288 phydev->duplex = DUPLEX_UNKNOWN;
2290 phydev->asym_pause = 0;
2292 err = genphy_read_master_slave(phydev);
2296 err = genphy_read_lpa(phydev);
2300 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2301 phy_resolve_aneg_linkmode(phydev);
2302 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2303 err = genphy_read_status_fixed(phydev);
2310 EXPORT_SYMBOL(genphy_read_status);
2313 * genphy_c37_read_status - check the link status and update current link state
2314 * @phydev: target phy_device struct
2316 * Description: Check the link, then figure out the current state
2317 * by comparing what we advertise with what the link partner
2318 * advertises. This function is for Clause 37 1000Base-X mode.
2320 int genphy_c37_read_status(struct phy_device *phydev)
2322 int lpa, err, old_link = phydev->link;
2324 /* Update the link, but return if there was an error */
2325 err = genphy_update_link(phydev);
2329 /* why bother the PHY if nothing can have changed */
2330 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2333 phydev->duplex = DUPLEX_UNKNOWN;
2335 phydev->asym_pause = 0;
2337 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2338 lpa = phy_read(phydev, MII_LPA);
2342 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2343 phydev->lp_advertising, lpa & LPA_LPACK);
2344 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2345 phydev->lp_advertising, lpa & LPA_1000XFULL);
2346 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2347 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2348 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2349 phydev->lp_advertising,
2350 lpa & LPA_1000XPAUSE_ASYM);
2352 phy_resolve_aneg_linkmode(phydev);
2353 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2354 int bmcr = phy_read(phydev, MII_BMCR);
2359 if (bmcr & BMCR_FULLDPLX)
2360 phydev->duplex = DUPLEX_FULL;
2362 phydev->duplex = DUPLEX_HALF;
2367 EXPORT_SYMBOL(genphy_c37_read_status);
2370 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2371 * @phydev: target phy_device struct
2373 * Description: Perform a software PHY reset using the standard
2374 * BMCR_RESET bit and poll for the reset bit to be cleared.
2376 * Returns: 0 on success, < 0 on failure
2378 int genphy_soft_reset(struct phy_device *phydev)
2380 u16 res = BMCR_RESET;
2383 if (phydev->autoneg == AUTONEG_ENABLE)
2384 res |= BMCR_ANRESTART;
2386 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2390 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2391 * to their default value. Therefore the POWER DOWN bit is supposed to
2392 * be cleared after soft reset.
2394 phydev->suspended = 0;
2396 ret = phy_poll_reset(phydev);
2400 /* BMCR may be reset to defaults */
2401 if (phydev->autoneg == AUTONEG_DISABLE)
2402 ret = genphy_setup_forced(phydev);
2406 EXPORT_SYMBOL(genphy_soft_reset);
2409 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2410 * @phydev: target phy_device struct
2412 * Description: Reads the PHY's abilities and populates
2413 * phydev->supported accordingly.
2415 * Returns: 0 on success, < 0 on failure
2417 int genphy_read_abilities(struct phy_device *phydev)
2421 linkmode_set_bit_array(phy_basic_ports_array,
2422 ARRAY_SIZE(phy_basic_ports_array),
2425 val = phy_read(phydev, MII_BMSR);
2429 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2430 val & BMSR_ANEGCAPABLE);
2432 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2433 val & BMSR_100FULL);
2434 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2435 val & BMSR_100HALF);
2436 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2438 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2441 if (val & BMSR_ESTATEN) {
2442 val = phy_read(phydev, MII_ESTATUS);
2446 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2447 phydev->supported, val & ESTATUS_1000_TFULL);
2448 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2449 phydev->supported, val & ESTATUS_1000_THALF);
2450 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2451 phydev->supported, val & ESTATUS_1000_XFULL);
2456 EXPORT_SYMBOL(genphy_read_abilities);
2458 /* This is used for the phy device which doesn't support the MMD extended
2459 * register access, but it does have side effect when we are trying to access
2460 * the MMD register via indirect method.
2462 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2466 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2468 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2469 u16 regnum, u16 val)
2473 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2475 int genphy_suspend(struct phy_device *phydev)
2477 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2479 EXPORT_SYMBOL(genphy_suspend);
2481 int genphy_resume(struct phy_device *phydev)
2483 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2485 EXPORT_SYMBOL(genphy_resume);
2487 int genphy_loopback(struct phy_device *phydev, bool enable)
2489 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2490 enable ? BMCR_LOOPBACK : 0);
2492 EXPORT_SYMBOL(genphy_loopback);
2495 * phy_remove_link_mode - Remove a supported link mode
2496 * @phydev: phy_device structure to remove link mode from
2497 * @link_mode: Link mode to be removed
2499 * Description: Some MACs don't support all link modes which the PHY
2500 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2501 * to remove a link mode.
2503 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2505 linkmode_clear_bit(link_mode, phydev->supported);
2506 phy_advertise_supported(phydev);
2508 EXPORT_SYMBOL(phy_remove_link_mode);
2510 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2512 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2513 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2514 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2515 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2519 * phy_advertise_supported - Advertise all supported modes
2520 * @phydev: target phy_device struct
2522 * Description: Called to advertise all supported modes, doesn't touch
2523 * pause mode advertising.
2525 void phy_advertise_supported(struct phy_device *phydev)
2527 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2529 linkmode_copy(new, phydev->supported);
2530 phy_copy_pause_bits(new, phydev->advertising);
2531 linkmode_copy(phydev->advertising, new);
2533 EXPORT_SYMBOL(phy_advertise_supported);
2536 * phy_support_sym_pause - Enable support of symmetrical pause
2537 * @phydev: target phy_device struct
2539 * Description: Called by the MAC to indicate is supports symmetrical
2540 * Pause, but not asym pause.
2542 void phy_support_sym_pause(struct phy_device *phydev)
2544 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2545 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2547 EXPORT_SYMBOL(phy_support_sym_pause);
2550 * phy_support_asym_pause - Enable support of asym pause
2551 * @phydev: target phy_device struct
2553 * Description: Called by the MAC to indicate is supports Asym Pause.
2555 void phy_support_asym_pause(struct phy_device *phydev)
2557 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2559 EXPORT_SYMBOL(phy_support_asym_pause);
2562 * phy_set_sym_pause - Configure symmetric Pause
2563 * @phydev: target phy_device struct
2564 * @rx: Receiver Pause is supported
2565 * @tx: Transmit Pause is supported
2566 * @autoneg: Auto neg should be used
2568 * Description: Configure advertised Pause support depending on if
2569 * receiver pause and pause auto neg is supported. Generally called
2570 * from the set_pauseparam .ndo.
2572 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2575 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2577 if (rx && tx && autoneg)
2578 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2581 linkmode_copy(phydev->advertising, phydev->supported);
2583 EXPORT_SYMBOL(phy_set_sym_pause);
2586 * phy_set_asym_pause - Configure Pause and Asym Pause
2587 * @phydev: target phy_device struct
2588 * @rx: Receiver Pause is supported
2589 * @tx: Transmit Pause is supported
2591 * Description: Configure advertised Pause support depending on if
2592 * transmit and receiver pause is supported. If there has been a
2593 * change in adverting, trigger a new autoneg. Generally called from
2594 * the set_pauseparam .ndo.
2596 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2598 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2600 linkmode_copy(oldadv, phydev->advertising);
2601 linkmode_set_pause(phydev->advertising, tx, rx);
2603 if (!linkmode_equal(oldadv, phydev->advertising) &&
2605 phy_start_aneg(phydev);
2607 EXPORT_SYMBOL(phy_set_asym_pause);
2610 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2611 * @phydev: phy_device struct
2612 * @pp: requested pause configuration
2614 * Description: Test if the PHY/MAC combination supports the Pause
2615 * configuration the user is requesting. Returns True if it is
2616 * supported, false otherwise.
2618 bool phy_validate_pause(struct phy_device *phydev,
2619 struct ethtool_pauseparam *pp)
2621 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2622 phydev->supported) && pp->rx_pause)
2625 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2626 phydev->supported) &&
2627 pp->rx_pause != pp->tx_pause)
2632 EXPORT_SYMBOL(phy_validate_pause);
2635 * phy_get_pause - resolve negotiated pause modes
2636 * @phydev: phy_device struct
2637 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2639 * @rx_pause: pointer to bool to indicate whether receive pause should be
2642 * Resolve and return the flow control modes according to the negotiation
2643 * result. This includes checking that we are operating in full duplex mode.
2644 * See linkmode_resolve_pause() for further details.
2646 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2648 if (phydev->duplex != DUPLEX_FULL) {
2654 return linkmode_resolve_pause(phydev->advertising,
2655 phydev->lp_advertising,
2656 tx_pause, rx_pause);
2658 EXPORT_SYMBOL(phy_get_pause);
2660 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2662 return phydrv->config_intr && phydrv->ack_interrupt;
2666 * phy_probe - probe and init a PHY device
2667 * @dev: device to probe and init
2669 * Description: Take care of setting up the phy_device structure,
2670 * set the state to READY (the driver's init function should
2671 * set it to STARTING if needed).
2673 static int phy_probe(struct device *dev)
2675 struct phy_device *phydev = to_phy_device(dev);
2676 struct device_driver *drv = phydev->mdio.dev.driver;
2677 struct phy_driver *phydrv = to_phy_driver(drv);
2680 phydev->drv = phydrv;
2682 /* Disable the interrupt if the PHY doesn't support it
2683 * but the interrupt is still a valid one
2685 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2686 phydev->irq = PHY_POLL;
2688 if (phydrv->flags & PHY_IS_INTERNAL)
2689 phydev->is_internal = true;
2691 mutex_lock(&phydev->lock);
2693 if (phydev->drv->probe) {
2694 /* Deassert the reset signal */
2695 phy_device_reset(phydev, 0);
2697 err = phydev->drv->probe(phydev);
2699 /* Assert the reset signal */
2700 phy_device_reset(phydev, 1);
2705 /* Start out supporting everything. Eventually,
2706 * a controller will attach, and may modify one
2707 * or both of these values
2709 if (phydrv->features) {
2710 linkmode_copy(phydev->supported, phydrv->features);
2711 } else if (phydrv->get_features) {
2712 err = phydrv->get_features(phydev);
2713 } else if (phydev->is_c45) {
2714 err = genphy_c45_pma_read_abilities(phydev);
2716 err = genphy_read_abilities(phydev);
2722 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2724 phydev->autoneg = 0;
2726 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2728 phydev->is_gigabit_capable = 1;
2729 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2731 phydev->is_gigabit_capable = 1;
2733 of_set_phy_supported(phydev);
2734 phy_advertise_supported(phydev);
2736 /* Get the EEE modes we want to prohibit. We will ask
2737 * the PHY stop advertising these mode later on
2739 of_set_phy_eee_broken(phydev);
2741 /* The Pause Frame bits indicate that the PHY can support passing
2742 * pause frames. During autonegotiation, the PHYs will determine if
2743 * they should allow pause frames to pass. The MAC driver should then
2744 * use that result to determine whether to enable flow control via
2747 * Normally, PHY drivers should not set the Pause bits, and instead
2748 * allow phylib to do that. However, there may be some situations
2749 * (e.g. hardware erratum) where the driver wants to set only one
2752 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2753 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2754 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2756 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2760 /* Set the state to READY by default */
2761 phydev->state = PHY_READY;
2764 mutex_unlock(&phydev->lock);
2769 static int phy_remove(struct device *dev)
2771 struct phy_device *phydev = to_phy_device(dev);
2773 cancel_delayed_work_sync(&phydev->state_queue);
2775 mutex_lock(&phydev->lock);
2776 phydev->state = PHY_DOWN;
2777 mutex_unlock(&phydev->lock);
2779 sfp_bus_del_upstream(phydev->sfp_bus);
2780 phydev->sfp_bus = NULL;
2782 if (phydev->drv && phydev->drv->remove) {
2783 phydev->drv->remove(phydev);
2785 /* Assert the reset signal */
2786 phy_device_reset(phydev, 1);
2794 * phy_driver_register - register a phy_driver with the PHY layer
2795 * @new_driver: new phy_driver to register
2796 * @owner: module owning this PHY
2798 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2802 /* Either the features are hard coded, or dynamically
2803 * determined. It cannot be both.
2805 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2806 pr_err("%s: features and get_features must not both be set\n",
2811 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2812 new_driver->mdiodrv.driver.name = new_driver->name;
2813 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2814 new_driver->mdiodrv.driver.probe = phy_probe;
2815 new_driver->mdiodrv.driver.remove = phy_remove;
2816 new_driver->mdiodrv.driver.owner = owner;
2817 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2819 retval = driver_register(&new_driver->mdiodrv.driver);
2821 pr_err("%s: Error %d in registering driver\n",
2822 new_driver->name, retval);
2827 pr_debug("%s: Registered new driver\n", new_driver->name);
2831 EXPORT_SYMBOL(phy_driver_register);
2833 int phy_drivers_register(struct phy_driver *new_driver, int n,
2834 struct module *owner)
2838 for (i = 0; i < n; i++) {
2839 ret = phy_driver_register(new_driver + i, owner);
2842 phy_driver_unregister(new_driver + i);
2848 EXPORT_SYMBOL(phy_drivers_register);
2850 void phy_driver_unregister(struct phy_driver *drv)
2852 driver_unregister(&drv->mdiodrv.driver);
2854 EXPORT_SYMBOL(phy_driver_unregister);
2856 void phy_drivers_unregister(struct phy_driver *drv, int n)
2860 for (i = 0; i < n; i++)
2861 phy_driver_unregister(drv + i);
2863 EXPORT_SYMBOL(phy_drivers_unregister);
2865 static struct phy_driver genphy_driver = {
2866 .phy_id = 0xffffffff,
2867 .phy_id_mask = 0xffffffff,
2868 .name = "Generic PHY",
2869 .get_features = genphy_read_abilities,
2870 .suspend = genphy_suspend,
2871 .resume = genphy_resume,
2872 .set_loopback = genphy_loopback,
2875 static int __init phy_init(void)
2879 rc = mdio_bus_init();
2885 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2889 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2891 phy_driver_unregister(&genphy_c45_driver);
2899 static void __exit phy_exit(void)
2901 phy_driver_unregister(&genphy_c45_driver);
2902 phy_driver_unregister(&genphy_driver);
2906 subsys_initcall(phy_init);
2907 module_exit(phy_exit);