1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for finding and configuring PHYs.
3 * Also contains generic PHY driver
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/bitmap.h>
13 #include <linux/delay.h>
14 #include <linux/errno.h>
15 #include <linux/etherdevice.h>
16 #include <linux/ethtool.h>
17 #include <linux/init.h>
18 #include <linux/interrupt.h>
20 #include <linux/kernel.h>
21 #include <linux/mdio.h>
22 #include <linux/mii.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/phy.h>
27 #include <linux/phy_led_triggers.h>
28 #include <linux/property.h>
29 #include <linux/sfp.h>
30 #include <linux/skbuff.h>
31 #include <linux/slab.h>
32 #include <linux/string.h>
33 #include <linux/uaccess.h>
34 #include <linux/unistd.h>
36 MODULE_DESCRIPTION("PHY library");
37 MODULE_AUTHOR("Andy Fleming");
38 MODULE_LICENSE("GPL");
40 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
41 EXPORT_SYMBOL_GPL(phy_basic_features);
43 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
44 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
46 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
47 EXPORT_SYMBOL_GPL(phy_gbit_features);
49 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
50 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
52 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
53 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
55 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
56 EXPORT_SYMBOL_GPL(phy_10gbit_features);
58 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
59 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
61 const int phy_basic_ports_array[3] = {
62 ETHTOOL_LINK_MODE_Autoneg_BIT,
63 ETHTOOL_LINK_MODE_TP_BIT,
64 ETHTOOL_LINK_MODE_MII_BIT,
66 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
68 const int phy_fibre_port_array[1] = {
69 ETHTOOL_LINK_MODE_FIBRE_BIT,
71 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
73 const int phy_all_ports_features_array[7] = {
74 ETHTOOL_LINK_MODE_Autoneg_BIT,
75 ETHTOOL_LINK_MODE_TP_BIT,
76 ETHTOOL_LINK_MODE_MII_BIT,
77 ETHTOOL_LINK_MODE_FIBRE_BIT,
78 ETHTOOL_LINK_MODE_AUI_BIT,
79 ETHTOOL_LINK_MODE_BNC_BIT,
80 ETHTOOL_LINK_MODE_Backplane_BIT,
82 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
84 const int phy_10_100_features_array[4] = {
85 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
86 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
87 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
88 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
90 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
92 const int phy_basic_t1_features_array[2] = {
93 ETHTOOL_LINK_MODE_TP_BIT,
94 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
96 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
98 const int phy_gbit_features_array[2] = {
99 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
100 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
102 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
104 const int phy_10gbit_features_array[1] = {
105 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
107 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
109 static const int phy_10gbit_fec_features_array[1] = {
110 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
113 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
114 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
116 static const int phy_10gbit_full_features_array[] = {
117 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
118 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
120 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
123 static void features_init(void)
125 /* 10/100 half/full*/
126 linkmode_set_bit_array(phy_basic_ports_array,
127 ARRAY_SIZE(phy_basic_ports_array),
129 linkmode_set_bit_array(phy_10_100_features_array,
130 ARRAY_SIZE(phy_10_100_features_array),
134 linkmode_set_bit_array(phy_basic_t1_features_array,
135 ARRAY_SIZE(phy_basic_t1_features_array),
136 phy_basic_t1_features);
138 /* 10/100 half/full + 1000 half/full */
139 linkmode_set_bit_array(phy_basic_ports_array,
140 ARRAY_SIZE(phy_basic_ports_array),
142 linkmode_set_bit_array(phy_10_100_features_array,
143 ARRAY_SIZE(phy_10_100_features_array),
145 linkmode_set_bit_array(phy_gbit_features_array,
146 ARRAY_SIZE(phy_gbit_features_array),
149 /* 10/100 half/full + 1000 half/full + fibre*/
150 linkmode_set_bit_array(phy_basic_ports_array,
151 ARRAY_SIZE(phy_basic_ports_array),
152 phy_gbit_fibre_features);
153 linkmode_set_bit_array(phy_10_100_features_array,
154 ARRAY_SIZE(phy_10_100_features_array),
155 phy_gbit_fibre_features);
156 linkmode_set_bit_array(phy_gbit_features_array,
157 ARRAY_SIZE(phy_gbit_features_array),
158 phy_gbit_fibre_features);
159 linkmode_set_bit_array(phy_fibre_port_array,
160 ARRAY_SIZE(phy_fibre_port_array),
161 phy_gbit_fibre_features);
163 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
164 linkmode_set_bit_array(phy_all_ports_features_array,
165 ARRAY_SIZE(phy_all_ports_features_array),
166 phy_gbit_all_ports_features);
167 linkmode_set_bit_array(phy_10_100_features_array,
168 ARRAY_SIZE(phy_10_100_features_array),
169 phy_gbit_all_ports_features);
170 linkmode_set_bit_array(phy_gbit_features_array,
171 ARRAY_SIZE(phy_gbit_features_array),
172 phy_gbit_all_ports_features);
174 /* 10/100 half/full + 1000 half/full + 10G full*/
175 linkmode_set_bit_array(phy_all_ports_features_array,
176 ARRAY_SIZE(phy_all_ports_features_array),
177 phy_10gbit_features);
178 linkmode_set_bit_array(phy_10_100_features_array,
179 ARRAY_SIZE(phy_10_100_features_array),
180 phy_10gbit_features);
181 linkmode_set_bit_array(phy_gbit_features_array,
182 ARRAY_SIZE(phy_gbit_features_array),
183 phy_10gbit_features);
184 linkmode_set_bit_array(phy_10gbit_features_array,
185 ARRAY_SIZE(phy_10gbit_features_array),
186 phy_10gbit_features);
188 /* 10/100/1000/10G full */
189 linkmode_set_bit_array(phy_all_ports_features_array,
190 ARRAY_SIZE(phy_all_ports_features_array),
191 phy_10gbit_full_features);
192 linkmode_set_bit_array(phy_10gbit_full_features_array,
193 ARRAY_SIZE(phy_10gbit_full_features_array),
194 phy_10gbit_full_features);
196 linkmode_set_bit_array(phy_10gbit_fec_features_array,
197 ARRAY_SIZE(phy_10gbit_fec_features_array),
198 phy_10gbit_fec_features);
201 void phy_device_free(struct phy_device *phydev)
203 put_device(&phydev->mdio.dev);
205 EXPORT_SYMBOL(phy_device_free);
207 static void phy_mdio_device_free(struct mdio_device *mdiodev)
209 struct phy_device *phydev;
211 phydev = container_of(mdiodev, struct phy_device, mdio);
212 phy_device_free(phydev);
215 static void phy_device_release(struct device *dev)
217 kfree(to_phy_device(dev));
220 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
222 struct phy_device *phydev;
224 phydev = container_of(mdiodev, struct phy_device, mdio);
225 phy_device_remove(phydev);
228 static struct phy_driver genphy_driver;
230 static LIST_HEAD(phy_fixup_list);
231 static DEFINE_MUTEX(phy_fixup_lock);
233 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
235 struct device_driver *drv = phydev->mdio.dev.driver;
236 struct phy_driver *phydrv = to_phy_driver(drv);
237 struct net_device *netdev = phydev->attached_dev;
239 if (!drv || !phydrv->suspend)
242 /* PHY not attached? May suspend if the PHY has not already been
243 * suspended as part of a prior call to phy_disconnect() ->
244 * phy_detach() -> phy_suspend() because the parent netdev might be the
245 * MDIO bus driver and clock gated at this point.
250 if (netdev->wol_enabled)
253 /* As long as not all affected network drivers support the
254 * wol_enabled flag, let's check for hints that WoL is enabled.
255 * Don't suspend PHY if the attached netdev parent may wake up.
256 * The parent may point to a PCI device, as in tg3 driver.
258 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
261 /* Also don't suspend PHY if the netdev itself may wakeup. This
262 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
265 if (device_may_wakeup(&netdev->dev))
269 return !phydev->suspended;
272 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
274 struct phy_device *phydev = to_phy_device(dev);
276 if (phydev->mac_managed_pm)
279 /* We must stop the state machine manually, otherwise it stops out of
280 * control, possibly with the phydev->lock held. Upon resume, netdev
281 * may call phy routines that try to grab the same lock, and that may
282 * lead to a deadlock.
284 if (phydev->attached_dev && phydev->adjust_link)
285 phy_stop_machine(phydev);
287 if (!mdio_bus_phy_may_suspend(phydev))
290 phydev->suspended_by_mdio_bus = 1;
292 return phy_suspend(phydev);
295 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
297 struct phy_device *phydev = to_phy_device(dev);
300 if (phydev->mac_managed_pm)
303 if (!phydev->suspended_by_mdio_bus)
306 phydev->suspended_by_mdio_bus = 0;
308 ret = phy_init_hw(phydev);
312 ret = phy_resume(phydev);
316 if (phydev->attached_dev && phydev->adjust_link)
317 phy_start_machine(phydev);
322 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
323 mdio_bus_phy_resume);
326 * phy_register_fixup - creates a new phy_fixup and adds it to the list
327 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
328 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
329 * It can also be PHY_ANY_UID
330 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
332 * @run: The actual code to be run when a matching PHY is found
334 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
335 int (*run)(struct phy_device *))
337 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
342 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
343 fixup->phy_uid = phy_uid;
344 fixup->phy_uid_mask = phy_uid_mask;
347 mutex_lock(&phy_fixup_lock);
348 list_add_tail(&fixup->list, &phy_fixup_list);
349 mutex_unlock(&phy_fixup_lock);
353 EXPORT_SYMBOL(phy_register_fixup);
355 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
356 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
357 int (*run)(struct phy_device *))
359 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
361 EXPORT_SYMBOL(phy_register_fixup_for_uid);
363 /* Registers a fixup to be run on the PHY with id string bus_id */
364 int phy_register_fixup_for_id(const char *bus_id,
365 int (*run)(struct phy_device *))
367 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
369 EXPORT_SYMBOL(phy_register_fixup_for_id);
372 * phy_unregister_fixup - remove a phy_fixup from the list
373 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
374 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
375 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
377 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
379 struct list_head *pos, *n;
380 struct phy_fixup *fixup;
385 mutex_lock(&phy_fixup_lock);
386 list_for_each_safe(pos, n, &phy_fixup_list) {
387 fixup = list_entry(pos, struct phy_fixup, list);
389 if ((!strcmp(fixup->bus_id, bus_id)) &&
390 ((fixup->phy_uid & phy_uid_mask) ==
391 (phy_uid & phy_uid_mask))) {
392 list_del(&fixup->list);
398 mutex_unlock(&phy_fixup_lock);
402 EXPORT_SYMBOL(phy_unregister_fixup);
404 /* Unregisters a fixup of any PHY with the UID in phy_uid */
405 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
407 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
409 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
411 /* Unregisters a fixup of the PHY with id string bus_id */
412 int phy_unregister_fixup_for_id(const char *bus_id)
414 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
416 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
418 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
419 * Fixups can be set to match any in one or more fields.
421 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
423 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
424 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
427 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
428 (phydev->phy_id & fixup->phy_uid_mask))
429 if (fixup->phy_uid != PHY_ANY_UID)
435 /* Runs any matching fixups for this phydev */
436 static int phy_scan_fixups(struct phy_device *phydev)
438 struct phy_fixup *fixup;
440 mutex_lock(&phy_fixup_lock);
441 list_for_each_entry(fixup, &phy_fixup_list, list) {
442 if (phy_needs_fixup(phydev, fixup)) {
443 int err = fixup->run(phydev);
446 mutex_unlock(&phy_fixup_lock);
449 phydev->has_fixups = true;
452 mutex_unlock(&phy_fixup_lock);
457 static int phy_bus_match(struct device *dev, struct device_driver *drv)
459 struct phy_device *phydev = to_phy_device(dev);
460 struct phy_driver *phydrv = to_phy_driver(drv);
461 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
464 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
467 if (phydrv->match_phy_device)
468 return phydrv->match_phy_device(phydev);
470 if (phydev->is_c45) {
471 for (i = 1; i < num_ids; i++) {
472 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
475 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
476 (phydev->c45_ids.device_ids[i] &
477 phydrv->phy_id_mask))
482 return (phydrv->phy_id & phydrv->phy_id_mask) ==
483 (phydev->phy_id & phydrv->phy_id_mask);
488 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
490 struct phy_device *phydev = to_phy_device(dev);
492 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
494 static DEVICE_ATTR_RO(phy_id);
497 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
499 struct phy_device *phydev = to_phy_device(dev);
500 const char *mode = NULL;
502 if (phy_is_internal(phydev))
505 mode = phy_modes(phydev->interface);
507 return sprintf(buf, "%s\n", mode);
509 static DEVICE_ATTR_RO(phy_interface);
512 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
515 struct phy_device *phydev = to_phy_device(dev);
517 return sprintf(buf, "%d\n", phydev->has_fixups);
519 static DEVICE_ATTR_RO(phy_has_fixups);
521 static ssize_t phy_dev_flags_show(struct device *dev,
522 struct device_attribute *attr,
525 struct phy_device *phydev = to_phy_device(dev);
527 return sprintf(buf, "0x%08x\n", phydev->dev_flags);
529 static DEVICE_ATTR_RO(phy_dev_flags);
531 static struct attribute *phy_dev_attrs[] = {
532 &dev_attr_phy_id.attr,
533 &dev_attr_phy_interface.attr,
534 &dev_attr_phy_has_fixups.attr,
535 &dev_attr_phy_dev_flags.attr,
538 ATTRIBUTE_GROUPS(phy_dev);
540 static const struct device_type mdio_bus_phy_type = {
542 .groups = phy_dev_groups,
543 .release = phy_device_release,
544 .pm = pm_ptr(&mdio_bus_phy_pm_ops),
547 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
551 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
552 MDIO_ID_ARGS(phy_id));
553 /* We only check for failures in executing the usermode binary,
554 * not whether a PHY driver module exists for the PHY ID.
555 * Accept -ENOENT because this may occur in case no initramfs exists,
556 * then modprobe isn't available.
558 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
559 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
560 ret, (unsigned long)phy_id);
567 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
569 struct phy_c45_device_ids *c45_ids)
571 struct phy_device *dev;
572 struct mdio_device *mdiodev;
575 /* We allocate the device, and initialize the default values */
576 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
578 return ERR_PTR(-ENOMEM);
580 mdiodev = &dev->mdio;
581 mdiodev->dev.parent = &bus->dev;
582 mdiodev->dev.bus = &mdio_bus_type;
583 mdiodev->dev.type = &mdio_bus_phy_type;
585 mdiodev->bus_match = phy_bus_match;
586 mdiodev->addr = addr;
587 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
588 mdiodev->device_free = phy_mdio_device_free;
589 mdiodev->device_remove = phy_mdio_device_remove;
591 dev->speed = SPEED_UNKNOWN;
592 dev->duplex = DUPLEX_UNKNOWN;
597 dev->interface = PHY_INTERFACE_MODE_GMII;
599 dev->autoneg = AUTONEG_ENABLE;
601 dev->is_c45 = is_c45;
602 dev->phy_id = phy_id;
604 dev->c45_ids = *c45_ids;
605 dev->irq = bus->irq[addr];
607 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
608 device_initialize(&mdiodev->dev);
610 dev->state = PHY_DOWN;
612 mutex_init(&dev->lock);
613 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
615 /* Request the appropriate module unconditionally; don't
616 * bother trying to do so only if it isn't already loaded,
617 * because that gets complicated. A hotplug event would have
618 * done an unconditional modprobe anyway.
619 * We don't do normal hotplug because it won't work for MDIO
620 * -- because it relies on the device staying around for long
621 * enough for the driver to get loaded. With MDIO, the NIC
622 * driver will get bored and give up as soon as it finds that
623 * there's no driver _already_ loaded.
625 if (is_c45 && c45_ids) {
626 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
629 for (i = 1; i < num_ids; i++) {
630 if (c45_ids->device_ids[i] == 0xffffffff)
633 ret = phy_request_driver_module(dev,
634 c45_ids->device_ids[i]);
639 ret = phy_request_driver_module(dev, phy_id);
643 put_device(&mdiodev->dev);
649 EXPORT_SYMBOL(phy_device_create);
651 /* phy_c45_probe_present - checks to see if a MMD is present in the package
652 * @bus: the target MII bus
653 * @prtad: PHY package address on the MII bus
654 * @devad: PHY device (MMD) address
656 * Read the MDIO_STAT2 register, and check whether a device is responding
659 * Returns: negative error number on bus access error, zero if no device
660 * is responding, or positive if a device is present.
662 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
666 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
670 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
673 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
674 * @bus: the target MII bus
675 * @addr: PHY address on the MII bus
676 * @dev_addr: MMD address in the PHY.
677 * @devices_in_package: where to store the devices in package information.
679 * Description: reads devices in package registers of a MMD at @dev_addr
680 * from PHY at @addr on @bus.
682 * Returns: 0 on success, -EIO on failure.
684 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
685 u32 *devices_in_package)
689 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
692 *devices_in_package = phy_reg << 16;
694 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
697 *devices_in_package |= phy_reg;
703 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
704 * @bus: the target MII bus
705 * @addr: PHY address on the MII bus
706 * @c45_ids: where to store the c45 ID information.
708 * Read the PHY "devices in package". If this appears to be valid, read
709 * the PHY identifiers for each device. Return the "devices in package"
710 * and identifiers in @c45_ids.
712 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
713 * the "devices in package" is invalid.
715 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
716 struct phy_c45_device_ids *c45_ids)
718 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
722 /* Find first non-zero Devices In package. Device zero is reserved
723 * for 802.3 c45 complied PHYs, so don't probe it at first.
725 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
726 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
727 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
728 /* Check that there is a device present at this
729 * address before reading the devices-in-package
730 * register to avoid reading garbage from the PHY.
731 * Some PHYs (88x3310) vendor space is not IEEE802.3
734 ret = phy_c45_probe_present(bus, addr, i);
741 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
746 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
747 /* If mostly Fs, there is no device there, then let's probe
748 * MMD 0, as some 10G PHYs have zero Devices In package,
749 * e.g. Cortina CS4315/CS4340 PHY.
751 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
755 /* no device there, let's get out of here */
756 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
760 /* Now probe Device Identifiers for each device present. */
761 for (i = 1; i < num_ids; i++) {
762 if (!(devs_in_pkg & (1 << i)))
765 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
766 /* Probe the "Device Present" bits for the vendor MMDs
767 * to ignore these if they do not contain IEEE 802.3
770 ret = phy_c45_probe_present(bus, addr, i);
778 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
781 c45_ids->device_ids[i] = phy_reg << 16;
783 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
786 c45_ids->device_ids[i] |= phy_reg;
789 c45_ids->devices_in_package = devs_in_pkg;
790 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
791 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
797 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
798 * @bus: the target MII bus
799 * @addr: PHY address on the MII bus
800 * @phy_id: where to store the ID retrieved.
802 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
803 * placing it in @phy_id. Return zero on successful read and the ID is
804 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
807 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
811 /* Grab the bits from PHYIR1, and put them in the upper half */
812 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
814 /* returning -ENODEV doesn't stop bus scanning */
815 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
818 *phy_id = phy_reg << 16;
820 /* Grab the bits from PHYIR2, and put them in the lower half */
821 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
823 /* returning -ENODEV doesn't stop bus scanning */
824 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
829 /* If the phy_id is mostly Fs, there is no device there */
830 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
837 * get_phy_device - reads the specified PHY device and returns its @phy_device
839 * @bus: the target MII bus
840 * @addr: PHY address on the MII bus
841 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
843 * Probe for a PHY at @addr on @bus.
845 * When probing for a clause 22 PHY, then read the ID registers. If we find
846 * a valid ID, allocate and return a &struct phy_device.
848 * When probing for a clause 45 PHY, read the "devices in package" registers.
849 * If the "devices in package" appears valid, read the ID registers for each
850 * MMD, allocate and return a &struct phy_device.
852 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
853 * no PHY present, or %-EIO on bus access error.
855 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
857 struct phy_c45_device_ids c45_ids;
861 c45_ids.devices_in_package = 0;
862 c45_ids.mmds_present = 0;
863 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
866 r = get_phy_c45_ids(bus, addr, &c45_ids);
868 r = get_phy_c22_id(bus, addr, &phy_id);
873 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
875 EXPORT_SYMBOL(get_phy_device);
878 * phy_device_register - Register the phy device on the MDIO bus
879 * @phydev: phy_device structure to be added to the MDIO bus
881 int phy_device_register(struct phy_device *phydev)
885 err = mdiobus_register_device(&phydev->mdio);
889 /* Deassert the reset signal */
890 phy_device_reset(phydev, 0);
892 /* Run all of the fixups for this PHY */
893 err = phy_scan_fixups(phydev);
895 phydev_err(phydev, "failed to initialize\n");
899 err = device_add(&phydev->mdio.dev);
901 phydev_err(phydev, "failed to add\n");
908 /* Assert the reset signal */
909 phy_device_reset(phydev, 1);
911 mdiobus_unregister_device(&phydev->mdio);
914 EXPORT_SYMBOL(phy_device_register);
917 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
918 * @phydev: phy_device structure to remove
920 * This doesn't free the phy_device itself, it merely reverses the effects
921 * of phy_device_register(). Use phy_device_free() to free the device
922 * after calling this function.
924 void phy_device_remove(struct phy_device *phydev)
927 unregister_mii_timestamper(phydev->mii_ts);
929 device_del(&phydev->mdio.dev);
931 /* Assert the reset signal */
932 phy_device_reset(phydev, 1);
934 mdiobus_unregister_device(&phydev->mdio);
936 EXPORT_SYMBOL(phy_device_remove);
939 * phy_find_first - finds the first PHY device on the bus
940 * @bus: the target MII bus
942 struct phy_device *phy_find_first(struct mii_bus *bus)
944 struct phy_device *phydev;
947 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
948 phydev = mdiobus_get_phy(bus, addr);
954 EXPORT_SYMBOL(phy_find_first);
956 static void phy_link_change(struct phy_device *phydev, bool up)
958 struct net_device *netdev = phydev->attached_dev;
961 netif_carrier_on(netdev);
963 netif_carrier_off(netdev);
964 phydev->adjust_link(netdev);
965 if (phydev->mii_ts && phydev->mii_ts->link_state)
966 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
970 * phy_prepare_link - prepares the PHY layer to monitor link status
971 * @phydev: target phy_device struct
972 * @handler: callback function for link status change notifications
974 * Description: Tells the PHY infrastructure to handle the
975 * gory details on monitoring link status (whether through
976 * polling or an interrupt), and to call back to the
977 * connected device driver when the link status changes.
978 * If you want to monitor your own link state, don't call
981 static void phy_prepare_link(struct phy_device *phydev,
982 void (*handler)(struct net_device *))
984 phydev->adjust_link = handler;
988 * phy_connect_direct - connect an ethernet device to a specific phy_device
989 * @dev: the network device to connect
990 * @phydev: the pointer to the phy device
991 * @handler: callback function for state change notifications
992 * @interface: PHY device's interface
994 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
995 void (*handler)(struct net_device *),
996 phy_interface_t interface)
1003 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1007 phy_prepare_link(phydev, handler);
1008 if (phy_interrupt_is_valid(phydev))
1009 phy_request_interrupt(phydev);
1013 EXPORT_SYMBOL(phy_connect_direct);
1016 * phy_connect - connect an ethernet device to a PHY device
1017 * @dev: the network device to connect
1018 * @bus_id: the id string of the PHY device to connect
1019 * @handler: callback function for state change notifications
1020 * @interface: PHY device's interface
1022 * Description: Convenience function for connecting ethernet
1023 * devices to PHY devices. The default behavior is for
1024 * the PHY infrastructure to handle everything, and only notify
1025 * the connected driver when the link status changes. If you
1026 * don't want, or can't use the provided functionality, you may
1027 * choose to call only the subset of functions which provide
1028 * the desired functionality.
1030 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1031 void (*handler)(struct net_device *),
1032 phy_interface_t interface)
1034 struct phy_device *phydev;
1038 /* Search the list of PHY devices on the mdio bus for the
1039 * PHY with the requested name
1041 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1043 pr_err("PHY %s not found\n", bus_id);
1044 return ERR_PTR(-ENODEV);
1046 phydev = to_phy_device(d);
1048 rc = phy_connect_direct(dev, phydev, handler, interface);
1055 EXPORT_SYMBOL(phy_connect);
1058 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1060 * @phydev: target phy_device struct
1062 void phy_disconnect(struct phy_device *phydev)
1064 if (phy_is_started(phydev))
1067 if (phy_interrupt_is_valid(phydev))
1068 phy_free_interrupt(phydev);
1070 phydev->adjust_link = NULL;
1074 EXPORT_SYMBOL(phy_disconnect);
1077 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1078 * @phydev: The PHY device to poll
1080 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1081 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1082 * register must be polled until the BMCR_RESET bit clears.
1084 * Furthermore, any attempts to write to PHY registers may have no effect
1085 * or even generate MDIO bus errors until this is complete.
1087 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1088 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1089 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1090 * effort to support such broken PHYs, this function is separate from the
1091 * standard phy_init_hw() which will zero all the other bits in the BMCR
1092 * and reapply all driver-specific and board-specific fixups.
1094 static int phy_poll_reset(struct phy_device *phydev)
1096 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1099 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1100 50000, 600000, true);
1103 /* Some chips (smsc911x) may still need up to another 1ms after the
1104 * BMCR_RESET bit is cleared before they are usable.
1110 int phy_init_hw(struct phy_device *phydev)
1114 /* Deassert the reset signal */
1115 phy_device_reset(phydev, 0);
1120 if (phydev->drv->soft_reset) {
1121 ret = phydev->drv->soft_reset(phydev);
1122 /* see comment in genphy_soft_reset for an explanation */
1124 phydev->suspended = 0;
1130 ret = phy_scan_fixups(phydev);
1134 if (phydev->drv->config_init) {
1135 ret = phydev->drv->config_init(phydev);
1140 if (phydev->drv->config_intr) {
1141 ret = phydev->drv->config_intr(phydev);
1148 EXPORT_SYMBOL(phy_init_hw);
1150 void phy_attached_info(struct phy_device *phydev)
1152 phy_attached_print(phydev, NULL);
1154 EXPORT_SYMBOL(phy_attached_info);
1156 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1157 char *phy_attached_info_irq(struct phy_device *phydev)
1162 switch(phydev->irq) {
1166 case PHY_MAC_INTERRUPT:
1170 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1175 return kasprintf(GFP_KERNEL, "%s", irq_str);
1177 EXPORT_SYMBOL(phy_attached_info_irq);
1179 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1181 const char *unbound = phydev->drv ? "" : "[unbound] ";
1182 char *irq_str = phy_attached_info_irq(phydev);
1185 phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1186 phydev_name(phydev), irq_str);
1190 phydev_info(phydev, ATTACHED_FMT, unbound,
1191 phydev_name(phydev), irq_str);
1199 EXPORT_SYMBOL(phy_attached_print);
1201 static void phy_sysfs_create_links(struct phy_device *phydev)
1203 struct net_device *dev = phydev->attached_dev;
1209 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1214 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1215 &phydev->mdio.dev.kobj,
1218 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1219 kobject_name(&phydev->mdio.dev.kobj),
1221 /* non-fatal - some net drivers can use one netdevice
1222 * with more then one phy
1226 phydev->sysfs_links = true;
1230 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1233 struct phy_device *phydev = to_phy_device(dev);
1235 return sprintf(buf, "%d\n", !phydev->attached_dev);
1237 static DEVICE_ATTR_RO(phy_standalone);
1240 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1241 * @upstream: pointer to the phy device
1242 * @bus: sfp bus representing cage being attached
1244 * This is used to fill in the sfp_upstream_ops .attach member.
1246 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1248 struct phy_device *phydev = upstream;
1250 if (phydev->attached_dev)
1251 phydev->attached_dev->sfp_bus = bus;
1252 phydev->sfp_bus_attached = true;
1254 EXPORT_SYMBOL(phy_sfp_attach);
1257 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1258 * @upstream: pointer to the phy device
1259 * @bus: sfp bus representing cage being attached
1261 * This is used to fill in the sfp_upstream_ops .detach member.
1263 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1265 struct phy_device *phydev = upstream;
1267 if (phydev->attached_dev)
1268 phydev->attached_dev->sfp_bus = NULL;
1269 phydev->sfp_bus_attached = false;
1271 EXPORT_SYMBOL(phy_sfp_detach);
1274 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1275 * @phydev: Pointer to phy_device
1276 * @ops: SFP's upstream operations
1278 int phy_sfp_probe(struct phy_device *phydev,
1279 const struct sfp_upstream_ops *ops)
1281 struct sfp_bus *bus;
1284 if (phydev->mdio.dev.fwnode) {
1285 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1287 return PTR_ERR(bus);
1289 phydev->sfp_bus = bus;
1291 ret = sfp_bus_add_upstream(bus, phydev, ops);
1296 EXPORT_SYMBOL(phy_sfp_probe);
1299 * phy_attach_direct - attach a network device to a given PHY device pointer
1300 * @dev: network device to attach
1301 * @phydev: Pointer to phy_device to attach
1302 * @flags: PHY device's dev_flags
1303 * @interface: PHY device's interface
1305 * Description: Called by drivers to attach to a particular PHY
1306 * device. The phy_device is found, and properly hooked up
1307 * to the phy_driver. If no driver is attached, then a
1308 * generic driver is used. The phy_device is given a ptr to
1309 * the attaching device, and given a callback for link status
1310 * change. The phy_device is returned to the attaching driver.
1311 * This function takes a reference on the phy device.
1313 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1314 u32 flags, phy_interface_t interface)
1316 struct mii_bus *bus = phydev->mdio.bus;
1317 struct device *d = &phydev->mdio.dev;
1318 struct module *ndev_owner = NULL;
1319 bool using_genphy = false;
1322 /* For Ethernet device drivers that register their own MDIO bus, we
1323 * will have bus->owner match ndev_mod, so we do not want to increment
1324 * our own module->refcnt here, otherwise we would not be able to
1328 ndev_owner = dev->dev.parent->driver->owner;
1329 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1330 phydev_err(phydev, "failed to get the bus module\n");
1336 /* Assume that if there is no driver, that it doesn't
1337 * exist, and we should use the genphy driver.
1341 d->driver = &genphy_c45_driver.mdiodrv.driver;
1343 d->driver = &genphy_driver.mdiodrv.driver;
1345 using_genphy = true;
1348 if (!try_module_get(d->driver->owner)) {
1349 phydev_err(phydev, "failed to get the device driver module\n");
1351 goto error_put_device;
1355 err = d->driver->probe(d);
1357 err = device_bind_driver(d);
1360 goto error_module_put;
1363 if (phydev->attached_dev) {
1364 dev_err(&dev->dev, "PHY already attached\n");
1369 phydev->phy_link_change = phy_link_change;
1371 phydev->attached_dev = dev;
1372 dev->phydev = phydev;
1374 if (phydev->sfp_bus_attached)
1375 dev->sfp_bus = phydev->sfp_bus;
1376 else if (dev->sfp_bus)
1377 phydev->is_on_sfp_module = true;
1380 /* Some Ethernet drivers try to connect to a PHY device before
1381 * calling register_netdevice() -> netdev_register_kobject() and
1382 * does the dev->dev.kobj initialization. Here we only check for
1383 * success which indicates that the network device kobject is
1384 * ready. Once we do that we still need to keep track of whether
1385 * links were successfully set up or not for phy_detach() to
1386 * remove them accordingly.
1388 phydev->sysfs_links = false;
1390 phy_sysfs_create_links(phydev);
1392 if (!phydev->attached_dev) {
1393 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1394 &dev_attr_phy_standalone.attr);
1396 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1399 phydev->dev_flags |= flags;
1401 phydev->interface = interface;
1403 phydev->state = PHY_READY;
1405 /* Port is set to PORT_TP by default and the actual PHY driver will set
1406 * it to different value depending on the PHY configuration. If we have
1407 * the generic PHY driver we can't figure it out, thus set the old
1408 * legacy PORT_MII value.
1411 phydev->port = PORT_MII;
1413 /* Initial carrier state is off as the phy is about to be
1417 netif_carrier_off(phydev->attached_dev);
1419 /* Do initial configuration here, now that
1420 * we have certain key parameters
1421 * (dev_flags and interface)
1423 err = phy_init_hw(phydev);
1427 err = phy_disable_interrupts(phydev);
1432 phy_led_triggers_register(phydev);
1437 /* phy_detach() does all of the cleanup below */
1442 module_put(d->driver->owner);
1445 if (ndev_owner != bus->owner)
1446 module_put(bus->owner);
1449 EXPORT_SYMBOL(phy_attach_direct);
1452 * phy_attach - attach a network device to a particular PHY device
1453 * @dev: network device to attach
1454 * @bus_id: Bus ID of PHY device to attach
1455 * @interface: PHY device's interface
1457 * Description: Same as phy_attach_direct() except that a PHY bus_id
1458 * string is passed instead of a pointer to a struct phy_device.
1460 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1461 phy_interface_t interface)
1463 struct bus_type *bus = &mdio_bus_type;
1464 struct phy_device *phydev;
1469 return ERR_PTR(-EINVAL);
1471 /* Search the list of PHY devices on the mdio bus for the
1472 * PHY with the requested name
1474 d = bus_find_device_by_name(bus, NULL, bus_id);
1476 pr_err("PHY %s not found\n", bus_id);
1477 return ERR_PTR(-ENODEV);
1479 phydev = to_phy_device(d);
1481 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1488 EXPORT_SYMBOL(phy_attach);
1490 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1491 struct device_driver *driver)
1493 struct device *d = &phydev->mdio.dev;
1500 ret = d->driver == driver;
1506 bool phy_driver_is_genphy(struct phy_device *phydev)
1508 return phy_driver_is_genphy_kind(phydev,
1509 &genphy_driver.mdiodrv.driver);
1511 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1513 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1515 return phy_driver_is_genphy_kind(phydev,
1516 &genphy_c45_driver.mdiodrv.driver);
1518 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1521 * phy_package_join - join a common PHY group
1522 * @phydev: target phy_device struct
1523 * @addr: cookie and PHY address for global register access
1524 * @priv_size: if non-zero allocate this amount of bytes for private data
1526 * This joins a PHY group and provides a shared storage for all phydevs in
1527 * this group. This is intended to be used for packages which contain
1528 * more than one PHY, for example a quad PHY transceiver.
1530 * The addr parameter serves as a cookie which has to have the same value
1531 * for all members of one group and as a PHY address to access generic
1532 * registers of a PHY package. Usually, one of the PHY addresses of the
1533 * different PHYs in the package provides access to these global registers.
1534 * The address which is given here, will be used in the phy_package_read()
1535 * and phy_package_write() convenience functions. If your PHY doesn't have
1536 * global registers you can just pick any of the PHY addresses.
1538 * This will set the shared pointer of the phydev to the shared storage.
1539 * If this is the first call for a this cookie the shared storage will be
1540 * allocated. If priv_size is non-zero, the given amount of bytes are
1541 * allocated for the priv member.
1543 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1544 * with the same cookie but a different priv_size is an error.
1546 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1548 struct mii_bus *bus = phydev->mdio.bus;
1549 struct phy_package_shared *shared;
1552 if (addr < 0 || addr >= PHY_MAX_ADDR)
1555 mutex_lock(&bus->shared_lock);
1556 shared = bus->shared[addr];
1559 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1563 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1566 shared->priv_size = priv_size;
1568 shared->addr = addr;
1569 refcount_set(&shared->refcnt, 1);
1570 bus->shared[addr] = shared;
1573 if (priv_size && priv_size != shared->priv_size)
1575 refcount_inc(&shared->refcnt);
1577 mutex_unlock(&bus->shared_lock);
1579 phydev->shared = shared;
1586 mutex_unlock(&bus->shared_lock);
1589 EXPORT_SYMBOL_GPL(phy_package_join);
1592 * phy_package_leave - leave a common PHY group
1593 * @phydev: target phy_device struct
1595 * This leaves a PHY group created by phy_package_join(). If this phydev
1596 * was the last user of the shared data between the group, this data is
1597 * freed. Resets the phydev->shared pointer to NULL.
1599 void phy_package_leave(struct phy_device *phydev)
1601 struct phy_package_shared *shared = phydev->shared;
1602 struct mii_bus *bus = phydev->mdio.bus;
1607 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1608 bus->shared[shared->addr] = NULL;
1609 mutex_unlock(&bus->shared_lock);
1610 kfree(shared->priv);
1614 phydev->shared = NULL;
1616 EXPORT_SYMBOL_GPL(phy_package_leave);
1618 static void devm_phy_package_leave(struct device *dev, void *res)
1620 phy_package_leave(*(struct phy_device **)res);
1624 * devm_phy_package_join - resource managed phy_package_join()
1625 * @dev: device that is registering this PHY package
1626 * @phydev: target phy_device struct
1627 * @addr: cookie and PHY address for global register access
1628 * @priv_size: if non-zero allocate this amount of bytes for private data
1630 * Managed phy_package_join(). Shared storage fetched by this function,
1631 * phy_package_leave() is automatically called on driver detach. See
1632 * phy_package_join() for more information.
1634 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1635 int addr, size_t priv_size)
1637 struct phy_device **ptr;
1640 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1645 ret = phy_package_join(phydev, addr, priv_size);
1649 devres_add(dev, ptr);
1656 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1659 * phy_detach - detach a PHY device from its network device
1660 * @phydev: target phy_device struct
1662 * This detaches the phy device from its network device and the phy
1663 * driver, and drops the reference count taken in phy_attach_direct().
1665 void phy_detach(struct phy_device *phydev)
1667 struct net_device *dev = phydev->attached_dev;
1668 struct module *ndev_owner = NULL;
1669 struct mii_bus *bus;
1671 if (phydev->sysfs_links) {
1673 sysfs_remove_link(&dev->dev.kobj, "phydev");
1674 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1677 if (!phydev->attached_dev)
1678 sysfs_remove_file(&phydev->mdio.dev.kobj,
1679 &dev_attr_phy_standalone.attr);
1681 phy_suspend(phydev);
1683 phydev->attached_dev->phydev = NULL;
1684 phydev->attached_dev = NULL;
1686 phydev->phylink = NULL;
1688 phy_led_triggers_unregister(phydev);
1690 if (phydev->mdio.dev.driver)
1691 module_put(phydev->mdio.dev.driver->owner);
1693 /* If the device had no specific driver before (i.e. - it
1694 * was using the generic driver), we unbind the device
1695 * from the generic driver so that there's a chance a
1696 * real driver could be loaded
1698 if (phy_driver_is_genphy(phydev) ||
1699 phy_driver_is_genphy_10g(phydev))
1700 device_release_driver(&phydev->mdio.dev);
1703 * The phydev might go away on the put_device() below, so avoid
1704 * a use-after-free bug by reading the underlying bus first.
1706 bus = phydev->mdio.bus;
1708 put_device(&phydev->mdio.dev);
1710 ndev_owner = dev->dev.parent->driver->owner;
1711 if (ndev_owner != bus->owner)
1712 module_put(bus->owner);
1714 /* Assert the reset signal */
1715 phy_device_reset(phydev, 1);
1717 EXPORT_SYMBOL(phy_detach);
1719 int phy_suspend(struct phy_device *phydev)
1721 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1722 struct net_device *netdev = phydev->attached_dev;
1723 struct phy_driver *phydrv = phydev->drv;
1726 if (phydev->suspended)
1729 /* If the device has WOL enabled, we cannot suspend the PHY */
1730 phy_ethtool_get_wol(phydev, &wol);
1731 if (wol.wolopts || (netdev && netdev->wol_enabled))
1734 if (!phydrv || !phydrv->suspend)
1737 ret = phydrv->suspend(phydev);
1739 phydev->suspended = true;
1743 EXPORT_SYMBOL(phy_suspend);
1745 int __phy_resume(struct phy_device *phydev)
1747 struct phy_driver *phydrv = phydev->drv;
1750 lockdep_assert_held(&phydev->lock);
1752 if (!phydrv || !phydrv->resume)
1755 ret = phydrv->resume(phydev);
1757 phydev->suspended = false;
1761 EXPORT_SYMBOL(__phy_resume);
1763 int phy_resume(struct phy_device *phydev)
1767 mutex_lock(&phydev->lock);
1768 ret = __phy_resume(phydev);
1769 mutex_unlock(&phydev->lock);
1773 EXPORT_SYMBOL(phy_resume);
1775 int phy_loopback(struct phy_device *phydev, bool enable)
1777 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1783 mutex_lock(&phydev->lock);
1785 if (enable && phydev->loopback_enabled) {
1790 if (!enable && !phydev->loopback_enabled) {
1795 if (phydrv->set_loopback)
1796 ret = phydrv->set_loopback(phydev, enable);
1798 ret = genphy_loopback(phydev, enable);
1803 phydev->loopback_enabled = enable;
1806 mutex_unlock(&phydev->lock);
1809 EXPORT_SYMBOL(phy_loopback);
1812 * phy_reset_after_clk_enable - perform a PHY reset if needed
1813 * @phydev: target phy_device struct
1815 * Description: Some PHYs are known to need a reset after their refclk was
1816 * enabled. This function evaluates the flags and perform the reset if it's
1817 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1820 int phy_reset_after_clk_enable(struct phy_device *phydev)
1822 if (!phydev || !phydev->drv)
1825 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1826 phy_device_reset(phydev, 1);
1827 phy_device_reset(phydev, 0);
1833 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1835 /* Generic PHY support and helper functions */
1838 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1839 * @phydev: target phy_device struct
1841 * Description: Writes MII_ADVERTISE with the appropriate values,
1842 * after sanitizing the values to make sure we only advertise
1843 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1844 * hasn't changed, and > 0 if it has changed.
1846 static int genphy_config_advert(struct phy_device *phydev)
1848 int err, bmsr, changed = 0;
1851 /* Only allow advertising what this PHY supports */
1852 linkmode_and(phydev->advertising, phydev->advertising,
1855 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1857 /* Setup standard advertisement */
1858 err = phy_modify_changed(phydev, MII_ADVERTISE,
1859 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1860 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1867 bmsr = phy_read(phydev, MII_BMSR);
1871 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1872 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1875 if (!(bmsr & BMSR_ESTATEN))
1878 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1880 err = phy_modify_changed(phydev, MII_CTRL1000,
1881 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1892 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1893 * @phydev: target phy_device struct
1895 * Description: Writes MII_ADVERTISE with the appropriate values,
1896 * after sanitizing the values to make sure we only advertise
1897 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1898 * hasn't changed, and > 0 if it has changed. This function is intended
1899 * for Clause 37 1000Base-X mode.
1901 static int genphy_c37_config_advert(struct phy_device *phydev)
1905 /* Only allow advertising what this PHY supports */
1906 linkmode_and(phydev->advertising, phydev->advertising,
1909 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1910 phydev->advertising))
1911 adv |= ADVERTISE_1000XFULL;
1912 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1913 phydev->advertising))
1914 adv |= ADVERTISE_1000XPAUSE;
1915 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1916 phydev->advertising))
1917 adv |= ADVERTISE_1000XPSE_ASYM;
1919 return phy_modify_changed(phydev, MII_ADVERTISE,
1920 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1921 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1926 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1927 * @phydev: target phy_device struct
1929 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1930 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1931 * changed, and 1 if it has changed.
1933 int genphy_config_eee_advert(struct phy_device *phydev)
1937 /* Nothing to disable */
1938 if (!phydev->eee_broken_modes)
1941 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1942 phydev->eee_broken_modes, 0);
1943 /* If the call failed, we assume that EEE is not supported */
1944 return err < 0 ? 0 : err;
1946 EXPORT_SYMBOL(genphy_config_eee_advert);
1949 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1950 * @phydev: target phy_device struct
1952 * Description: Configures MII_BMCR to force speed/duplex
1953 * to the values in phydev. Assumes that the values are valid.
1954 * Please see phy_sanitize_settings().
1956 int genphy_setup_forced(struct phy_device *phydev)
1961 phydev->asym_pause = 0;
1963 if (SPEED_1000 == phydev->speed)
1964 ctl |= BMCR_SPEED1000;
1965 else if (SPEED_100 == phydev->speed)
1966 ctl |= BMCR_SPEED100;
1968 if (DUPLEX_FULL == phydev->duplex)
1969 ctl |= BMCR_FULLDPLX;
1971 return phy_modify(phydev, MII_BMCR,
1972 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1974 EXPORT_SYMBOL(genphy_setup_forced);
1976 static int genphy_setup_master_slave(struct phy_device *phydev)
1980 if (!phydev->is_gigabit_capable)
1983 switch (phydev->master_slave_set) {
1984 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1985 ctl |= CTL1000_PREFER_MASTER;
1987 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1989 case MASTER_SLAVE_CFG_MASTER_FORCE:
1990 ctl |= CTL1000_AS_MASTER;
1992 case MASTER_SLAVE_CFG_SLAVE_FORCE:
1993 ctl |= CTL1000_ENABLE_MASTER;
1995 case MASTER_SLAVE_CFG_UNKNOWN:
1996 case MASTER_SLAVE_CFG_UNSUPPORTED:
1999 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2003 return phy_modify_changed(phydev, MII_CTRL1000,
2004 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2005 CTL1000_PREFER_MASTER), ctl);
2008 static int genphy_read_master_slave(struct phy_device *phydev)
2013 if (!phydev->is_gigabit_capable) {
2014 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2015 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2019 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2020 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2022 val = phy_read(phydev, MII_CTRL1000);
2026 if (val & CTL1000_ENABLE_MASTER) {
2027 if (val & CTL1000_AS_MASTER)
2028 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2030 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2032 if (val & CTL1000_PREFER_MASTER)
2033 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2035 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2038 val = phy_read(phydev, MII_STAT1000);
2042 if (val & LPA_1000MSFAIL) {
2043 state = MASTER_SLAVE_STATE_ERR;
2044 } else if (phydev->link) {
2045 /* this bits are valid only for active link */
2046 if (val & LPA_1000MSRES)
2047 state = MASTER_SLAVE_STATE_MASTER;
2049 state = MASTER_SLAVE_STATE_SLAVE;
2051 state = MASTER_SLAVE_STATE_UNKNOWN;
2054 phydev->master_slave_get = cfg;
2055 phydev->master_slave_state = state;
2061 * genphy_restart_aneg - Enable and Restart Autonegotiation
2062 * @phydev: target phy_device struct
2064 int genphy_restart_aneg(struct phy_device *phydev)
2066 /* Don't isolate the PHY if we're negotiating */
2067 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2068 BMCR_ANENABLE | BMCR_ANRESTART);
2070 EXPORT_SYMBOL(genphy_restart_aneg);
2073 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2074 * @phydev: target phy_device struct
2075 * @restart: whether aneg restart is requested
2077 * Check, and restart auto-negotiation if needed.
2079 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2084 /* Advertisement hasn't changed, but maybe aneg was never on to
2085 * begin with? Or maybe phy was isolated?
2087 ret = phy_read(phydev, MII_BMCR);
2091 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2096 return genphy_restart_aneg(phydev);
2100 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2103 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2104 * @phydev: target phy_device struct
2105 * @changed: whether autoneg is requested
2107 * Description: If auto-negotiation is enabled, we configure the
2108 * advertising, and then restart auto-negotiation. If it is not
2109 * enabled, then we write the BMCR.
2111 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2115 if (genphy_config_eee_advert(phydev))
2118 err = genphy_setup_master_slave(phydev);
2124 if (AUTONEG_ENABLE != phydev->autoneg)
2125 return genphy_setup_forced(phydev);
2127 err = genphy_config_advert(phydev);
2128 if (err < 0) /* error */
2133 return genphy_check_and_restart_aneg(phydev, changed);
2135 EXPORT_SYMBOL(__genphy_config_aneg);
2138 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2139 * @phydev: target phy_device struct
2141 * Description: If auto-negotiation is enabled, we configure the
2142 * advertising, and then restart auto-negotiation. If it is not
2143 * enabled, then we write the BMCR. This function is intended
2144 * for use with Clause 37 1000Base-X mode.
2146 int genphy_c37_config_aneg(struct phy_device *phydev)
2150 if (phydev->autoneg != AUTONEG_ENABLE)
2151 return genphy_setup_forced(phydev);
2153 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2158 changed = genphy_c37_config_advert(phydev);
2159 if (changed < 0) /* error */
2163 /* Advertisement hasn't changed, but maybe aneg was never on to
2164 * begin with? Or maybe phy was isolated?
2166 int ctl = phy_read(phydev, MII_BMCR);
2171 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2172 changed = 1; /* do restart aneg */
2175 /* Only restart aneg if we are advertising something different
2176 * than we were before.
2179 return genphy_restart_aneg(phydev);
2183 EXPORT_SYMBOL(genphy_c37_config_aneg);
2186 * genphy_aneg_done - return auto-negotiation status
2187 * @phydev: target phy_device struct
2189 * Description: Reads the status register and returns 0 either if
2190 * auto-negotiation is incomplete, or if there was an error.
2191 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2193 int genphy_aneg_done(struct phy_device *phydev)
2195 int retval = phy_read(phydev, MII_BMSR);
2197 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2199 EXPORT_SYMBOL(genphy_aneg_done);
2202 * genphy_update_link - update link status in @phydev
2203 * @phydev: target phy_device struct
2205 * Description: Update the value in phydev->link to reflect the
2206 * current link value. In order to do this, we need to read
2207 * the status register twice, keeping the second value.
2209 int genphy_update_link(struct phy_device *phydev)
2211 int status = 0, bmcr;
2213 bmcr = phy_read(phydev, MII_BMCR);
2217 /* Autoneg is being started, therefore disregard BMSR value and
2218 * report link as down.
2220 if (bmcr & BMCR_ANRESTART)
2223 /* The link state is latched low so that momentary link
2224 * drops can be detected. Do not double-read the status
2225 * in polling mode to detect such short link drops except
2226 * the link was already down.
2228 if (!phy_polling_mode(phydev) || !phydev->link) {
2229 status = phy_read(phydev, MII_BMSR);
2232 else if (status & BMSR_LSTATUS)
2236 /* Read link and autonegotiation status */
2237 status = phy_read(phydev, MII_BMSR);
2241 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2242 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2244 /* Consider the case that autoneg was started and "aneg complete"
2245 * bit has been reset, but "link up" bit not yet.
2247 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2252 EXPORT_SYMBOL(genphy_update_link);
2254 int genphy_read_lpa(struct phy_device *phydev)
2258 if (phydev->autoneg == AUTONEG_ENABLE) {
2259 if (!phydev->autoneg_complete) {
2260 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2262 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2266 if (phydev->is_gigabit_capable) {
2267 lpagb = phy_read(phydev, MII_STAT1000);
2271 if (lpagb & LPA_1000MSFAIL) {
2272 int adv = phy_read(phydev, MII_CTRL1000);
2277 if (adv & CTL1000_ENABLE_MASTER)
2278 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2280 phydev_err(phydev, "Master/Slave resolution failed\n");
2284 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2288 lpa = phy_read(phydev, MII_LPA);
2292 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2294 linkmode_zero(phydev->lp_advertising);
2299 EXPORT_SYMBOL(genphy_read_lpa);
2302 * genphy_read_status_fixed - read the link parameters for !aneg mode
2303 * @phydev: target phy_device struct
2305 * Read the current duplex and speed state for a PHY operating with
2306 * autonegotiation disabled.
2308 int genphy_read_status_fixed(struct phy_device *phydev)
2310 int bmcr = phy_read(phydev, MII_BMCR);
2315 if (bmcr & BMCR_FULLDPLX)
2316 phydev->duplex = DUPLEX_FULL;
2318 phydev->duplex = DUPLEX_HALF;
2320 if (bmcr & BMCR_SPEED1000)
2321 phydev->speed = SPEED_1000;
2322 else if (bmcr & BMCR_SPEED100)
2323 phydev->speed = SPEED_100;
2325 phydev->speed = SPEED_10;
2329 EXPORT_SYMBOL(genphy_read_status_fixed);
2332 * genphy_read_status - check the link status and update current link state
2333 * @phydev: target phy_device struct
2335 * Description: Check the link, then figure out the current state
2336 * by comparing what we advertise with what the link partner
2337 * advertises. Start by checking the gigabit possibilities,
2338 * then move on to 10/100.
2340 int genphy_read_status(struct phy_device *phydev)
2342 int err, old_link = phydev->link;
2344 /* Update the link, but return if there was an error */
2345 err = genphy_update_link(phydev);
2349 /* why bother the PHY if nothing can have changed */
2350 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2353 phydev->speed = SPEED_UNKNOWN;
2354 phydev->duplex = DUPLEX_UNKNOWN;
2356 phydev->asym_pause = 0;
2358 err = genphy_read_master_slave(phydev);
2362 err = genphy_read_lpa(phydev);
2366 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2367 phy_resolve_aneg_linkmode(phydev);
2368 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2369 err = genphy_read_status_fixed(phydev);
2376 EXPORT_SYMBOL(genphy_read_status);
2379 * genphy_c37_read_status - check the link status and update current link state
2380 * @phydev: target phy_device struct
2382 * Description: Check the link, then figure out the current state
2383 * by comparing what we advertise with what the link partner
2384 * advertises. This function is for Clause 37 1000Base-X mode.
2386 int genphy_c37_read_status(struct phy_device *phydev)
2388 int lpa, err, old_link = phydev->link;
2390 /* Update the link, but return if there was an error */
2391 err = genphy_update_link(phydev);
2395 /* why bother the PHY if nothing can have changed */
2396 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2399 phydev->duplex = DUPLEX_UNKNOWN;
2401 phydev->asym_pause = 0;
2403 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2404 lpa = phy_read(phydev, MII_LPA);
2408 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2409 phydev->lp_advertising, lpa & LPA_LPACK);
2410 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2411 phydev->lp_advertising, lpa & LPA_1000XFULL);
2412 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2413 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2414 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2415 phydev->lp_advertising,
2416 lpa & LPA_1000XPAUSE_ASYM);
2418 phy_resolve_aneg_linkmode(phydev);
2419 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2420 int bmcr = phy_read(phydev, MII_BMCR);
2425 if (bmcr & BMCR_FULLDPLX)
2426 phydev->duplex = DUPLEX_FULL;
2428 phydev->duplex = DUPLEX_HALF;
2433 EXPORT_SYMBOL(genphy_c37_read_status);
2436 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2437 * @phydev: target phy_device struct
2439 * Description: Perform a software PHY reset using the standard
2440 * BMCR_RESET bit and poll for the reset bit to be cleared.
2442 * Returns: 0 on success, < 0 on failure
2444 int genphy_soft_reset(struct phy_device *phydev)
2446 u16 res = BMCR_RESET;
2449 if (phydev->autoneg == AUTONEG_ENABLE)
2450 res |= BMCR_ANRESTART;
2452 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2456 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2457 * to their default value. Therefore the POWER DOWN bit is supposed to
2458 * be cleared after soft reset.
2460 phydev->suspended = 0;
2462 ret = phy_poll_reset(phydev);
2466 /* BMCR may be reset to defaults */
2467 if (phydev->autoneg == AUTONEG_DISABLE)
2468 ret = genphy_setup_forced(phydev);
2472 EXPORT_SYMBOL(genphy_soft_reset);
2474 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2476 /* It seems there are cases where the interrupts are handled by another
2477 * entity (ie an IRQ controller embedded inside the PHY) and do not
2478 * need any other interraction from phylib. In this case, just trigger
2479 * the state machine directly.
2481 phy_trigger_machine(phydev);
2485 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2488 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2489 * @phydev: target phy_device struct
2491 * Description: Reads the PHY's abilities and populates
2492 * phydev->supported accordingly.
2494 * Returns: 0 on success, < 0 on failure
2496 int genphy_read_abilities(struct phy_device *phydev)
2500 linkmode_set_bit_array(phy_basic_ports_array,
2501 ARRAY_SIZE(phy_basic_ports_array),
2504 val = phy_read(phydev, MII_BMSR);
2508 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2509 val & BMSR_ANEGCAPABLE);
2511 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2512 val & BMSR_100FULL);
2513 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2514 val & BMSR_100HALF);
2515 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2517 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2520 if (val & BMSR_ESTATEN) {
2521 val = phy_read(phydev, MII_ESTATUS);
2525 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2526 phydev->supported, val & ESTATUS_1000_TFULL);
2527 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2528 phydev->supported, val & ESTATUS_1000_THALF);
2529 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2530 phydev->supported, val & ESTATUS_1000_XFULL);
2535 EXPORT_SYMBOL(genphy_read_abilities);
2537 /* This is used for the phy device which doesn't support the MMD extended
2538 * register access, but it does have side effect when we are trying to access
2539 * the MMD register via indirect method.
2541 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2545 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2547 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2548 u16 regnum, u16 val)
2552 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2554 int genphy_suspend(struct phy_device *phydev)
2556 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2558 EXPORT_SYMBOL(genphy_suspend);
2560 int genphy_resume(struct phy_device *phydev)
2562 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2564 EXPORT_SYMBOL(genphy_resume);
2566 int genphy_loopback(struct phy_device *phydev, bool enable)
2569 u16 val, ctl = BMCR_LOOPBACK;
2572 if (phydev->speed == SPEED_1000)
2573 ctl |= BMCR_SPEED1000;
2574 else if (phydev->speed == SPEED_100)
2575 ctl |= BMCR_SPEED100;
2577 if (phydev->duplex == DUPLEX_FULL)
2578 ctl |= BMCR_FULLDPLX;
2580 phy_modify(phydev, MII_BMCR, ~0, ctl);
2582 ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2584 5000, 500000, true);
2588 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2590 phy_config_aneg(phydev);
2595 EXPORT_SYMBOL(genphy_loopback);
2598 * phy_remove_link_mode - Remove a supported link mode
2599 * @phydev: phy_device structure to remove link mode from
2600 * @link_mode: Link mode to be removed
2602 * Description: Some MACs don't support all link modes which the PHY
2603 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2604 * to remove a link mode.
2606 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2608 linkmode_clear_bit(link_mode, phydev->supported);
2609 phy_advertise_supported(phydev);
2611 EXPORT_SYMBOL(phy_remove_link_mode);
2613 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2615 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2616 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2617 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2618 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2622 * phy_advertise_supported - Advertise all supported modes
2623 * @phydev: target phy_device struct
2625 * Description: Called to advertise all supported modes, doesn't touch
2626 * pause mode advertising.
2628 void phy_advertise_supported(struct phy_device *phydev)
2630 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2632 linkmode_copy(new, phydev->supported);
2633 phy_copy_pause_bits(new, phydev->advertising);
2634 linkmode_copy(phydev->advertising, new);
2636 EXPORT_SYMBOL(phy_advertise_supported);
2639 * phy_support_sym_pause - Enable support of symmetrical pause
2640 * @phydev: target phy_device struct
2642 * Description: Called by the MAC to indicate is supports symmetrical
2643 * Pause, but not asym pause.
2645 void phy_support_sym_pause(struct phy_device *phydev)
2647 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2648 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2650 EXPORT_SYMBOL(phy_support_sym_pause);
2653 * phy_support_asym_pause - Enable support of asym pause
2654 * @phydev: target phy_device struct
2656 * Description: Called by the MAC to indicate is supports Asym Pause.
2658 void phy_support_asym_pause(struct phy_device *phydev)
2660 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2662 EXPORT_SYMBOL(phy_support_asym_pause);
2665 * phy_set_sym_pause - Configure symmetric Pause
2666 * @phydev: target phy_device struct
2667 * @rx: Receiver Pause is supported
2668 * @tx: Transmit Pause is supported
2669 * @autoneg: Auto neg should be used
2671 * Description: Configure advertised Pause support depending on if
2672 * receiver pause and pause auto neg is supported. Generally called
2673 * from the set_pauseparam .ndo.
2675 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2678 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2680 if (rx && tx && autoneg)
2681 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2684 linkmode_copy(phydev->advertising, phydev->supported);
2686 EXPORT_SYMBOL(phy_set_sym_pause);
2689 * phy_set_asym_pause - Configure Pause and Asym Pause
2690 * @phydev: target phy_device struct
2691 * @rx: Receiver Pause is supported
2692 * @tx: Transmit Pause is supported
2694 * Description: Configure advertised Pause support depending on if
2695 * transmit and receiver pause is supported. If there has been a
2696 * change in adverting, trigger a new autoneg. Generally called from
2697 * the set_pauseparam .ndo.
2699 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2701 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2703 linkmode_copy(oldadv, phydev->advertising);
2704 linkmode_set_pause(phydev->advertising, tx, rx);
2706 if (!linkmode_equal(oldadv, phydev->advertising) &&
2708 phy_start_aneg(phydev);
2710 EXPORT_SYMBOL(phy_set_asym_pause);
2713 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2714 * @phydev: phy_device struct
2715 * @pp: requested pause configuration
2717 * Description: Test if the PHY/MAC combination supports the Pause
2718 * configuration the user is requesting. Returns True if it is
2719 * supported, false otherwise.
2721 bool phy_validate_pause(struct phy_device *phydev,
2722 struct ethtool_pauseparam *pp)
2724 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2725 phydev->supported) && pp->rx_pause)
2728 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2729 phydev->supported) &&
2730 pp->rx_pause != pp->tx_pause)
2735 EXPORT_SYMBOL(phy_validate_pause);
2738 * phy_get_pause - resolve negotiated pause modes
2739 * @phydev: phy_device struct
2740 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2742 * @rx_pause: pointer to bool to indicate whether receive pause should be
2745 * Resolve and return the flow control modes according to the negotiation
2746 * result. This includes checking that we are operating in full duplex mode.
2747 * See linkmode_resolve_pause() for further details.
2749 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2751 if (phydev->duplex != DUPLEX_FULL) {
2757 return linkmode_resolve_pause(phydev->advertising,
2758 phydev->lp_advertising,
2759 tx_pause, rx_pause);
2761 EXPORT_SYMBOL(phy_get_pause);
2763 #if IS_ENABLED(CONFIG_OF_MDIO)
2764 static int phy_get_int_delay_property(struct device *dev, const char *name)
2769 ret = device_property_read_u32(dev, name, &int_delay);
2776 static int phy_get_int_delay_property(struct device *dev, const char *name)
2783 * phy_get_internal_delay - returns the index of the internal delay
2784 * @phydev: phy_device struct
2785 * @dev: pointer to the devices device struct
2786 * @delay_values: array of delays the PHY supports
2787 * @size: the size of the delay array
2788 * @is_rx: boolean to indicate to get the rx internal delay
2790 * Returns the index within the array of internal delay passed in.
2791 * If the device property is not present then the interface type is checked
2792 * if the interface defines use of internal delay then a 1 is returned otherwise
2794 * The array must be in ascending order. If PHY does not have an ascending order
2795 * array then size = 0 and the value of the delay property is returned.
2796 * Return -EINVAL if the delay is invalid or cannot be found.
2798 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2799 const int *delay_values, int size, bool is_rx)
2805 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
2806 if (delay < 0 && size == 0) {
2807 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2808 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
2815 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
2816 if (delay < 0 && size == 0) {
2817 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2818 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
2828 if (delay && size == 0)
2831 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
2832 phydev_err(phydev, "Delay %d is out of range\n", delay);
2836 if (delay == delay_values[0])
2839 for (i = 1; i < size; i++) {
2840 if (delay == delay_values[i])
2843 /* Find an approximate index by looking up the table */
2844 if (delay > delay_values[i - 1] &&
2845 delay < delay_values[i]) {
2846 if (delay - delay_values[i - 1] <
2847 delay_values[i] - delay)
2854 phydev_err(phydev, "error finding internal delay index for %d\n",
2859 EXPORT_SYMBOL(phy_get_internal_delay);
2861 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2863 return phydrv->config_intr && phydrv->handle_interrupt;
2867 * phy_probe - probe and init a PHY device
2868 * @dev: device to probe and init
2870 * Description: Take care of setting up the phy_device structure,
2871 * set the state to READY (the driver's init function should
2872 * set it to STARTING if needed).
2874 static int phy_probe(struct device *dev)
2876 struct phy_device *phydev = to_phy_device(dev);
2877 struct device_driver *drv = phydev->mdio.dev.driver;
2878 struct phy_driver *phydrv = to_phy_driver(drv);
2881 phydev->drv = phydrv;
2883 /* Disable the interrupt if the PHY doesn't support it
2884 * but the interrupt is still a valid one
2886 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2887 phydev->irq = PHY_POLL;
2889 if (phydrv->flags & PHY_IS_INTERNAL)
2890 phydev->is_internal = true;
2892 mutex_lock(&phydev->lock);
2894 /* Deassert the reset signal */
2895 phy_device_reset(phydev, 0);
2897 if (phydev->drv->probe) {
2898 err = phydev->drv->probe(phydev);
2903 /* Start out supporting everything. Eventually,
2904 * a controller will attach, and may modify one
2905 * or both of these values
2907 if (phydrv->features) {
2908 linkmode_copy(phydev->supported, phydrv->features);
2909 } else if (phydrv->get_features) {
2910 err = phydrv->get_features(phydev);
2911 } else if (phydev->is_c45) {
2912 err = genphy_c45_pma_read_abilities(phydev);
2914 err = genphy_read_abilities(phydev);
2920 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2922 phydev->autoneg = 0;
2924 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2926 phydev->is_gigabit_capable = 1;
2927 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2929 phydev->is_gigabit_capable = 1;
2931 of_set_phy_supported(phydev);
2932 phy_advertise_supported(phydev);
2934 /* Get the EEE modes we want to prohibit. We will ask
2935 * the PHY stop advertising these mode later on
2937 of_set_phy_eee_broken(phydev);
2939 /* The Pause Frame bits indicate that the PHY can support passing
2940 * pause frames. During autonegotiation, the PHYs will determine if
2941 * they should allow pause frames to pass. The MAC driver should then
2942 * use that result to determine whether to enable flow control via
2945 * Normally, PHY drivers should not set the Pause bits, and instead
2946 * allow phylib to do that. However, there may be some situations
2947 * (e.g. hardware erratum) where the driver wants to set only one
2950 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2951 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2952 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2954 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2958 /* Set the state to READY by default */
2959 phydev->state = PHY_READY;
2962 /* Assert the reset signal */
2964 phy_device_reset(phydev, 1);
2966 mutex_unlock(&phydev->lock);
2971 static int phy_remove(struct device *dev)
2973 struct phy_device *phydev = to_phy_device(dev);
2975 cancel_delayed_work_sync(&phydev->state_queue);
2977 mutex_lock(&phydev->lock);
2978 phydev->state = PHY_DOWN;
2979 mutex_unlock(&phydev->lock);
2981 sfp_bus_del_upstream(phydev->sfp_bus);
2982 phydev->sfp_bus = NULL;
2984 if (phydev->drv && phydev->drv->remove)
2985 phydev->drv->remove(phydev);
2987 /* Assert the reset signal */
2988 phy_device_reset(phydev, 1);
2995 static void phy_shutdown(struct device *dev)
2997 struct phy_device *phydev = to_phy_device(dev);
2999 phy_disable_interrupts(phydev);
3003 * phy_driver_register - register a phy_driver with the PHY layer
3004 * @new_driver: new phy_driver to register
3005 * @owner: module owning this PHY
3007 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
3011 /* Either the features are hard coded, or dynamically
3012 * determined. It cannot be both.
3014 if (WARN_ON(new_driver->features && new_driver->get_features)) {
3015 pr_err("%s: features and get_features must not both be set\n",
3020 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3021 new_driver->mdiodrv.driver.name = new_driver->name;
3022 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3023 new_driver->mdiodrv.driver.probe = phy_probe;
3024 new_driver->mdiodrv.driver.remove = phy_remove;
3025 new_driver->mdiodrv.driver.shutdown = phy_shutdown;
3026 new_driver->mdiodrv.driver.owner = owner;
3027 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3029 retval = driver_register(&new_driver->mdiodrv.driver);
3031 pr_err("%s: Error %d in registering driver\n",
3032 new_driver->name, retval);
3037 pr_debug("%s: Registered new driver\n", new_driver->name);
3041 EXPORT_SYMBOL(phy_driver_register);
3043 int phy_drivers_register(struct phy_driver *new_driver, int n,
3044 struct module *owner)
3048 for (i = 0; i < n; i++) {
3049 ret = phy_driver_register(new_driver + i, owner);
3052 phy_driver_unregister(new_driver + i);
3058 EXPORT_SYMBOL(phy_drivers_register);
3060 void phy_driver_unregister(struct phy_driver *drv)
3062 driver_unregister(&drv->mdiodrv.driver);
3064 EXPORT_SYMBOL(phy_driver_unregister);
3066 void phy_drivers_unregister(struct phy_driver *drv, int n)
3070 for (i = 0; i < n; i++)
3071 phy_driver_unregister(drv + i);
3073 EXPORT_SYMBOL(phy_drivers_unregister);
3075 static struct phy_driver genphy_driver = {
3076 .phy_id = 0xffffffff,
3077 .phy_id_mask = 0xffffffff,
3078 .name = "Generic PHY",
3079 .get_features = genphy_read_abilities,
3080 .suspend = genphy_suspend,
3081 .resume = genphy_resume,
3082 .set_loopback = genphy_loopback,
3085 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3086 .get_sset_count = phy_ethtool_get_sset_count,
3087 .get_strings = phy_ethtool_get_strings,
3088 .get_stats = phy_ethtool_get_stats,
3089 .start_cable_test = phy_start_cable_test,
3090 .start_cable_test_tdr = phy_start_cable_test_tdr,
3093 static int __init phy_init(void)
3097 rc = mdio_bus_init();
3101 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3104 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3108 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3110 phy_driver_unregister(&genphy_c45_driver);
3118 static void __exit phy_exit(void)
3120 phy_driver_unregister(&genphy_c45_driver);
3121 phy_driver_unregister(&genphy_driver);
3123 ethtool_set_ethtool_phy_ops(NULL);
3126 subsys_initcall(phy_init);
3127 module_exit(phy_exit);