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/acpi.h>
13 #include <linux/bitmap.h>
14 #include <linux/delay.h>
15 #include <linux/errno.h>
16 #include <linux/etherdevice.h>
17 #include <linux/ethtool.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/mdio.h>
24 #include <linux/mii.h>
26 #include <linux/module.h>
28 #include <linux/netdevice.h>
29 #include <linux/phy.h>
30 #include <linux/phylib_stubs.h>
31 #include <linux/phy_led_triggers.h>
32 #include <linux/pse-pd/pse.h>
33 #include <linux/property.h>
34 #include <linux/rtnetlink.h>
35 #include <linux/sfp.h>
36 #include <linux/skbuff.h>
37 #include <linux/slab.h>
38 #include <linux/string.h>
39 #include <linux/uaccess.h>
40 #include <linux/unistd.h>
42 MODULE_DESCRIPTION("PHY library");
43 MODULE_AUTHOR("Andy Fleming");
44 MODULE_LICENSE("GPL");
46 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
47 EXPORT_SYMBOL_GPL(phy_basic_features);
49 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
50 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
52 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1s_p2mp_features) __ro_after_init;
53 EXPORT_SYMBOL_GPL(phy_basic_t1s_p2mp_features);
55 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
56 EXPORT_SYMBOL_GPL(phy_gbit_features);
58 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
59 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
61 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
62 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
64 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
65 EXPORT_SYMBOL_GPL(phy_10gbit_features);
67 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
68 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
70 const int phy_basic_ports_array[3] = {
71 ETHTOOL_LINK_MODE_Autoneg_BIT,
72 ETHTOOL_LINK_MODE_TP_BIT,
73 ETHTOOL_LINK_MODE_MII_BIT,
75 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
77 const int phy_fibre_port_array[1] = {
78 ETHTOOL_LINK_MODE_FIBRE_BIT,
80 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
82 const int phy_all_ports_features_array[7] = {
83 ETHTOOL_LINK_MODE_Autoneg_BIT,
84 ETHTOOL_LINK_MODE_TP_BIT,
85 ETHTOOL_LINK_MODE_MII_BIT,
86 ETHTOOL_LINK_MODE_FIBRE_BIT,
87 ETHTOOL_LINK_MODE_AUI_BIT,
88 ETHTOOL_LINK_MODE_BNC_BIT,
89 ETHTOOL_LINK_MODE_Backplane_BIT,
91 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
93 const int phy_10_100_features_array[4] = {
94 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
95 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
96 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
97 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
99 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
101 const int phy_basic_t1_features_array[3] = {
102 ETHTOOL_LINK_MODE_TP_BIT,
103 ETHTOOL_LINK_MODE_10baseT1L_Full_BIT,
104 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
106 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
108 const int phy_basic_t1s_p2mp_features_array[2] = {
109 ETHTOOL_LINK_MODE_TP_BIT,
110 ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT,
112 EXPORT_SYMBOL_GPL(phy_basic_t1s_p2mp_features_array);
114 const int phy_gbit_features_array[2] = {
115 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
116 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
118 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
120 const int phy_10gbit_features_array[1] = {
121 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
123 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
125 static const int phy_10gbit_fec_features_array[1] = {
126 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
129 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
130 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
132 static const int phy_10gbit_full_features_array[] = {
133 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
134 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
135 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
136 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
139 static const int phy_eee_cap1_features_array[] = {
140 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
141 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
142 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
143 ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
144 ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
145 ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
148 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap1_features) __ro_after_init;
149 EXPORT_SYMBOL_GPL(phy_eee_cap1_features);
151 static void features_init(void)
153 /* 10/100 half/full*/
154 linkmode_set_bit_array(phy_basic_ports_array,
155 ARRAY_SIZE(phy_basic_ports_array),
157 linkmode_set_bit_array(phy_10_100_features_array,
158 ARRAY_SIZE(phy_10_100_features_array),
162 linkmode_set_bit_array(phy_basic_t1_features_array,
163 ARRAY_SIZE(phy_basic_t1_features_array),
164 phy_basic_t1_features);
166 /* 10 half, P2MP, TP */
167 linkmode_set_bit_array(phy_basic_t1s_p2mp_features_array,
168 ARRAY_SIZE(phy_basic_t1s_p2mp_features_array),
169 phy_basic_t1s_p2mp_features);
171 /* 10/100 half/full + 1000 half/full */
172 linkmode_set_bit_array(phy_basic_ports_array,
173 ARRAY_SIZE(phy_basic_ports_array),
175 linkmode_set_bit_array(phy_10_100_features_array,
176 ARRAY_SIZE(phy_10_100_features_array),
178 linkmode_set_bit_array(phy_gbit_features_array,
179 ARRAY_SIZE(phy_gbit_features_array),
182 /* 10/100 half/full + 1000 half/full + fibre*/
183 linkmode_set_bit_array(phy_basic_ports_array,
184 ARRAY_SIZE(phy_basic_ports_array),
185 phy_gbit_fibre_features);
186 linkmode_set_bit_array(phy_10_100_features_array,
187 ARRAY_SIZE(phy_10_100_features_array),
188 phy_gbit_fibre_features);
189 linkmode_set_bit_array(phy_gbit_features_array,
190 ARRAY_SIZE(phy_gbit_features_array),
191 phy_gbit_fibre_features);
192 linkmode_set_bit_array(phy_fibre_port_array,
193 ARRAY_SIZE(phy_fibre_port_array),
194 phy_gbit_fibre_features);
196 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
197 linkmode_set_bit_array(phy_all_ports_features_array,
198 ARRAY_SIZE(phy_all_ports_features_array),
199 phy_gbit_all_ports_features);
200 linkmode_set_bit_array(phy_10_100_features_array,
201 ARRAY_SIZE(phy_10_100_features_array),
202 phy_gbit_all_ports_features);
203 linkmode_set_bit_array(phy_gbit_features_array,
204 ARRAY_SIZE(phy_gbit_features_array),
205 phy_gbit_all_ports_features);
207 /* 10/100 half/full + 1000 half/full + 10G full*/
208 linkmode_set_bit_array(phy_all_ports_features_array,
209 ARRAY_SIZE(phy_all_ports_features_array),
210 phy_10gbit_features);
211 linkmode_set_bit_array(phy_10_100_features_array,
212 ARRAY_SIZE(phy_10_100_features_array),
213 phy_10gbit_features);
214 linkmode_set_bit_array(phy_gbit_features_array,
215 ARRAY_SIZE(phy_gbit_features_array),
216 phy_10gbit_features);
217 linkmode_set_bit_array(phy_10gbit_features_array,
218 ARRAY_SIZE(phy_10gbit_features_array),
219 phy_10gbit_features);
221 /* 10/100/1000/10G full */
222 linkmode_set_bit_array(phy_all_ports_features_array,
223 ARRAY_SIZE(phy_all_ports_features_array),
224 phy_10gbit_full_features);
225 linkmode_set_bit_array(phy_10gbit_full_features_array,
226 ARRAY_SIZE(phy_10gbit_full_features_array),
227 phy_10gbit_full_features);
229 linkmode_set_bit_array(phy_10gbit_fec_features_array,
230 ARRAY_SIZE(phy_10gbit_fec_features_array),
231 phy_10gbit_fec_features);
232 linkmode_set_bit_array(phy_eee_cap1_features_array,
233 ARRAY_SIZE(phy_eee_cap1_features_array),
234 phy_eee_cap1_features);
238 void phy_device_free(struct phy_device *phydev)
240 put_device(&phydev->mdio.dev);
242 EXPORT_SYMBOL(phy_device_free);
244 static void phy_mdio_device_free(struct mdio_device *mdiodev)
246 struct phy_device *phydev;
248 phydev = container_of(mdiodev, struct phy_device, mdio);
249 phy_device_free(phydev);
252 static void phy_device_release(struct device *dev)
254 fwnode_handle_put(dev->fwnode);
255 kfree(to_phy_device(dev));
258 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
260 struct phy_device *phydev;
262 phydev = container_of(mdiodev, struct phy_device, mdio);
263 phy_device_remove(phydev);
266 static struct phy_driver genphy_driver;
268 static LIST_HEAD(phy_fixup_list);
269 static DEFINE_MUTEX(phy_fixup_lock);
271 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
273 struct device_driver *drv = phydev->mdio.dev.driver;
274 struct phy_driver *phydrv = to_phy_driver(drv);
275 struct net_device *netdev = phydev->attached_dev;
277 if (!drv || !phydrv->suspend)
280 /* PHY not attached? May suspend if the PHY has not already been
281 * suspended as part of a prior call to phy_disconnect() ->
282 * phy_detach() -> phy_suspend() because the parent netdev might be the
283 * MDIO bus driver and clock gated at this point.
288 if (netdev->wol_enabled)
291 /* As long as not all affected network drivers support the
292 * wol_enabled flag, let's check for hints that WoL is enabled.
293 * Don't suspend PHY if the attached netdev parent may wake up.
294 * The parent may point to a PCI device, as in tg3 driver.
296 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
299 /* Also don't suspend PHY if the netdev itself may wakeup. This
300 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
303 if (device_may_wakeup(&netdev->dev))
307 return !phydev->suspended;
310 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
312 struct phy_device *phydev = to_phy_device(dev);
314 if (phydev->mac_managed_pm)
317 /* Wakeup interrupts may occur during the system sleep transition when
318 * the PHY is inaccessible. Set flag to postpone handling until the PHY
319 * has resumed. Wait for concurrent interrupt handler to complete.
321 if (phy_interrupt_is_valid(phydev)) {
322 phydev->irq_suspended = 1;
323 synchronize_irq(phydev->irq);
326 /* We must stop the state machine manually, otherwise it stops out of
327 * control, possibly with the phydev->lock held. Upon resume, netdev
328 * may call phy routines that try to grab the same lock, and that may
329 * lead to a deadlock.
331 if (phydev->attached_dev && phydev->adjust_link)
332 phy_stop_machine(phydev);
334 if (!mdio_bus_phy_may_suspend(phydev))
337 phydev->suspended_by_mdio_bus = 1;
339 return phy_suspend(phydev);
342 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
344 struct phy_device *phydev = to_phy_device(dev);
347 if (phydev->mac_managed_pm)
350 if (!phydev->suspended_by_mdio_bus)
353 phydev->suspended_by_mdio_bus = 0;
355 /* If we managed to get here with the PHY state machine in a state
356 * neither PHY_HALTED, PHY_READY nor PHY_UP, this is an indication
357 * that something went wrong and we should most likely be using
358 * MAC managed PM, but we are not.
360 WARN_ON(phydev->state != PHY_HALTED && phydev->state != PHY_READY &&
361 phydev->state != PHY_UP);
363 ret = phy_init_hw(phydev);
367 ret = phy_resume(phydev);
371 if (phy_interrupt_is_valid(phydev)) {
372 phydev->irq_suspended = 0;
373 synchronize_irq(phydev->irq);
375 /* Rerun interrupts which were postponed by phy_interrupt()
376 * because they occurred during the system sleep transition.
378 if (phydev->irq_rerun) {
379 phydev->irq_rerun = 0;
380 enable_irq(phydev->irq);
381 irq_wake_thread(phydev->irq, phydev);
385 if (phydev->attached_dev && phydev->adjust_link)
386 phy_start_machine(phydev);
391 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
392 mdio_bus_phy_resume);
395 * phy_register_fixup - creates a new phy_fixup and adds it to the list
396 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
397 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
398 * It can also be PHY_ANY_UID
399 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
401 * @run: The actual code to be run when a matching PHY is found
403 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
404 int (*run)(struct phy_device *))
406 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
411 strscpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
412 fixup->phy_uid = phy_uid;
413 fixup->phy_uid_mask = phy_uid_mask;
416 mutex_lock(&phy_fixup_lock);
417 list_add_tail(&fixup->list, &phy_fixup_list);
418 mutex_unlock(&phy_fixup_lock);
422 EXPORT_SYMBOL(phy_register_fixup);
424 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
425 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
426 int (*run)(struct phy_device *))
428 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
430 EXPORT_SYMBOL(phy_register_fixup_for_uid);
432 /* Registers a fixup to be run on the PHY with id string bus_id */
433 int phy_register_fixup_for_id(const char *bus_id,
434 int (*run)(struct phy_device *))
436 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
438 EXPORT_SYMBOL(phy_register_fixup_for_id);
441 * phy_unregister_fixup - remove a phy_fixup from the list
442 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
443 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
444 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
446 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
448 struct list_head *pos, *n;
449 struct phy_fixup *fixup;
454 mutex_lock(&phy_fixup_lock);
455 list_for_each_safe(pos, n, &phy_fixup_list) {
456 fixup = list_entry(pos, struct phy_fixup, list);
458 if ((!strcmp(fixup->bus_id, bus_id)) &&
459 phy_id_compare(fixup->phy_uid, phy_uid, phy_uid_mask)) {
460 list_del(&fixup->list);
466 mutex_unlock(&phy_fixup_lock);
470 EXPORT_SYMBOL(phy_unregister_fixup);
472 /* Unregisters a fixup of any PHY with the UID in phy_uid */
473 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
475 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
477 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
479 /* Unregisters a fixup of the PHY with id string bus_id */
480 int phy_unregister_fixup_for_id(const char *bus_id)
482 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
484 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
486 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
487 * Fixups can be set to match any in one or more fields.
489 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
491 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
492 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
495 if (!phy_id_compare(phydev->phy_id, fixup->phy_uid,
496 fixup->phy_uid_mask))
497 if (fixup->phy_uid != PHY_ANY_UID)
503 /* Runs any matching fixups for this phydev */
504 static int phy_scan_fixups(struct phy_device *phydev)
506 struct phy_fixup *fixup;
508 mutex_lock(&phy_fixup_lock);
509 list_for_each_entry(fixup, &phy_fixup_list, list) {
510 if (phy_needs_fixup(phydev, fixup)) {
511 int err = fixup->run(phydev);
514 mutex_unlock(&phy_fixup_lock);
517 phydev->has_fixups = true;
520 mutex_unlock(&phy_fixup_lock);
525 static int phy_bus_match(struct device *dev, struct device_driver *drv)
527 struct phy_device *phydev = to_phy_device(dev);
528 struct phy_driver *phydrv = to_phy_driver(drv);
529 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
532 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
535 if (phydrv->match_phy_device)
536 return phydrv->match_phy_device(phydev);
538 if (phydev->is_c45) {
539 for (i = 1; i < num_ids; i++) {
540 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
543 if (phy_id_compare(phydev->c45_ids.device_ids[i],
544 phydrv->phy_id, phydrv->phy_id_mask))
549 return phy_id_compare(phydev->phy_id, phydrv->phy_id,
550 phydrv->phy_id_mask);
555 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
557 struct phy_device *phydev = to_phy_device(dev);
559 return sysfs_emit(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
561 static DEVICE_ATTR_RO(phy_id);
564 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
566 struct phy_device *phydev = to_phy_device(dev);
567 const char *mode = NULL;
569 if (phy_is_internal(phydev))
572 mode = phy_modes(phydev->interface);
574 return sysfs_emit(buf, "%s\n", mode);
576 static DEVICE_ATTR_RO(phy_interface);
579 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
582 struct phy_device *phydev = to_phy_device(dev);
584 return sysfs_emit(buf, "%d\n", phydev->has_fixups);
586 static DEVICE_ATTR_RO(phy_has_fixups);
588 static ssize_t phy_dev_flags_show(struct device *dev,
589 struct device_attribute *attr,
592 struct phy_device *phydev = to_phy_device(dev);
594 return sysfs_emit(buf, "0x%08x\n", phydev->dev_flags);
596 static DEVICE_ATTR_RO(phy_dev_flags);
598 static struct attribute *phy_dev_attrs[] = {
599 &dev_attr_phy_id.attr,
600 &dev_attr_phy_interface.attr,
601 &dev_attr_phy_has_fixups.attr,
602 &dev_attr_phy_dev_flags.attr,
605 ATTRIBUTE_GROUPS(phy_dev);
607 static const struct device_type mdio_bus_phy_type = {
609 .groups = phy_dev_groups,
610 .release = phy_device_release,
611 .pm = pm_ptr(&mdio_bus_phy_pm_ops),
614 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
618 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
619 MDIO_ID_ARGS(phy_id));
620 /* We only check for failures in executing the usermode binary,
621 * not whether a PHY driver module exists for the PHY ID.
622 * Accept -ENOENT because this may occur in case no initramfs exists,
623 * then modprobe isn't available.
625 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
626 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
627 ret, (unsigned long)phy_id);
634 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
636 struct phy_c45_device_ids *c45_ids)
638 struct phy_device *dev;
639 struct mdio_device *mdiodev;
642 /* We allocate the device, and initialize the default values */
643 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
645 return ERR_PTR(-ENOMEM);
647 mdiodev = &dev->mdio;
648 mdiodev->dev.parent = &bus->dev;
649 mdiodev->dev.bus = &mdio_bus_type;
650 mdiodev->dev.type = &mdio_bus_phy_type;
652 mdiodev->bus_match = phy_bus_match;
653 mdiodev->addr = addr;
654 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
655 mdiodev->device_free = phy_mdio_device_free;
656 mdiodev->device_remove = phy_mdio_device_remove;
657 mdiodev->reset_state = -1;
659 dev->speed = SPEED_UNKNOWN;
660 dev->duplex = DUPLEX_UNKNOWN;
665 dev->interface = PHY_INTERFACE_MODE_GMII;
667 dev->autoneg = AUTONEG_ENABLE;
669 dev->pma_extable = -ENODATA;
670 dev->is_c45 = is_c45;
671 dev->phy_id = phy_id;
673 dev->c45_ids = *c45_ids;
674 dev->irq = bus->irq[addr];
676 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
677 device_initialize(&mdiodev->dev);
679 dev->state = PHY_DOWN;
680 INIT_LIST_HEAD(&dev->leds);
682 mutex_init(&dev->lock);
683 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
685 /* Request the appropriate module unconditionally; don't
686 * bother trying to do so only if it isn't already loaded,
687 * because that gets complicated. A hotplug event would have
688 * done an unconditional modprobe anyway.
689 * We don't do normal hotplug because it won't work for MDIO
690 * -- because it relies on the device staying around for long
691 * enough for the driver to get loaded. With MDIO, the NIC
692 * driver will get bored and give up as soon as it finds that
693 * there's no driver _already_ loaded.
695 if (is_c45 && c45_ids) {
696 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
699 for (i = 1; i < num_ids; i++) {
700 if (c45_ids->device_ids[i] == 0xffffffff)
703 ret = phy_request_driver_module(dev,
704 c45_ids->device_ids[i]);
709 ret = phy_request_driver_module(dev, phy_id);
713 put_device(&mdiodev->dev);
719 EXPORT_SYMBOL(phy_device_create);
721 /* phy_c45_probe_present - checks to see if a MMD is present in the package
722 * @bus: the target MII bus
723 * @prtad: PHY package address on the MII bus
724 * @devad: PHY device (MMD) address
726 * Read the MDIO_STAT2 register, and check whether a device is responding
729 * Returns: negative error number on bus access error, zero if no device
730 * is responding, or positive if a device is present.
732 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
736 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
740 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
743 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
744 * @bus: the target MII bus
745 * @addr: PHY address on the MII bus
746 * @dev_addr: MMD address in the PHY.
747 * @devices_in_package: where to store the devices in package information.
749 * Description: reads devices in package registers of a MMD at @dev_addr
750 * from PHY at @addr on @bus.
752 * Returns: 0 on success, -EIO on failure.
754 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
755 u32 *devices_in_package)
759 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
762 *devices_in_package = phy_reg << 16;
764 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
767 *devices_in_package |= phy_reg;
773 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
774 * @bus: the target MII bus
775 * @addr: PHY address on the MII bus
776 * @c45_ids: where to store the c45 ID information.
778 * Read the PHY "devices in package". If this appears to be valid, read
779 * the PHY identifiers for each device. Return the "devices in package"
780 * and identifiers in @c45_ids.
782 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
783 * the "devices in package" is invalid or no device responds.
785 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
786 struct phy_c45_device_ids *c45_ids)
788 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
792 /* Find first non-zero Devices In package. Device zero is reserved
793 * for 802.3 c45 complied PHYs, so don't probe it at first.
795 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
796 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
797 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
798 /* Check that there is a device present at this
799 * address before reading the devices-in-package
800 * register to avoid reading garbage from the PHY.
801 * Some PHYs (88x3310) vendor space is not IEEE802.3
804 ret = phy_c45_probe_present(bus, addr, i);
806 /* returning -ENODEV doesn't stop bus
809 return (phy_reg == -EIO ||
810 phy_reg == -ENODEV) ? -ENODEV : -EIO;
815 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
820 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
821 /* If mostly Fs, there is no device there, then let's probe
822 * MMD 0, as some 10G PHYs have zero Devices In package,
823 * e.g. Cortina CS4315/CS4340 PHY.
825 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
829 /* no device there, let's get out of here */
830 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
834 /* Now probe Device Identifiers for each device present. */
835 for (i = 1; i < num_ids; i++) {
836 if (!(devs_in_pkg & (1 << i)))
839 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
840 /* Probe the "Device Present" bits for the vendor MMDs
841 * to ignore these if they do not contain IEEE 802.3
844 ret = phy_c45_probe_present(bus, addr, i);
852 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
855 c45_ids->device_ids[i] = phy_reg << 16;
857 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
860 c45_ids->device_ids[i] |= phy_reg;
863 c45_ids->devices_in_package = devs_in_pkg;
864 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
865 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
871 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
872 * @bus: the target MII bus
873 * @addr: PHY address on the MII bus
874 * @phy_id: where to store the ID retrieved.
876 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
877 * placing it in @phy_id. Return zero on successful read and the ID is
878 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
881 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
885 /* Grab the bits from PHYIR1, and put them in the upper half */
886 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
888 /* returning -ENODEV doesn't stop bus scanning */
889 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
892 *phy_id = phy_reg << 16;
894 /* Grab the bits from PHYIR2, and put them in the lower half */
895 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
897 /* returning -ENODEV doesn't stop bus scanning */
898 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
903 /* If the phy_id is mostly Fs, there is no device there */
904 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
910 /* Extract the phy ID from the compatible string of the form
911 * ethernet-phy-idAAAA.BBBB.
913 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
915 unsigned int upper, lower;
919 ret = fwnode_property_read_string(fwnode, "compatible", &cp);
923 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) != 2)
926 *phy_id = ((upper & GENMASK(15, 0)) << 16) | (lower & GENMASK(15, 0));
929 EXPORT_SYMBOL(fwnode_get_phy_id);
932 * get_phy_device - reads the specified PHY device and returns its @phy_device
934 * @bus: the target MII bus
935 * @addr: PHY address on the MII bus
936 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
938 * Probe for a PHY at @addr on @bus.
940 * When probing for a clause 22 PHY, then read the ID registers. If we find
941 * a valid ID, allocate and return a &struct phy_device.
943 * When probing for a clause 45 PHY, read the "devices in package" registers.
944 * If the "devices in package" appears valid, read the ID registers for each
945 * MMD, allocate and return a &struct phy_device.
947 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
948 * no PHY present, or %-EIO on bus access error.
950 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
952 struct phy_c45_device_ids c45_ids;
956 c45_ids.devices_in_package = 0;
957 c45_ids.mmds_present = 0;
958 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
961 r = get_phy_c45_ids(bus, addr, &c45_ids);
963 r = get_phy_c22_id(bus, addr, &phy_id);
968 /* PHY device such as the Marvell Alaska 88E2110 will return a PHY ID
969 * of 0 when probed using get_phy_c22_id() with no error. Proceed to
970 * probe with C45 to see if we're able to get a valid PHY ID in the C45
971 * space, if successful, create the C45 PHY device.
973 if (!is_c45 && phy_id == 0 && bus->read_c45) {
974 r = get_phy_c45_ids(bus, addr, &c45_ids);
976 return phy_device_create(bus, addr, phy_id,
980 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
982 EXPORT_SYMBOL(get_phy_device);
985 * phy_device_register - Register the phy device on the MDIO bus
986 * @phydev: phy_device structure to be added to the MDIO bus
988 int phy_device_register(struct phy_device *phydev)
992 err = mdiobus_register_device(&phydev->mdio);
996 /* Deassert the reset signal */
997 phy_device_reset(phydev, 0);
999 /* Run all of the fixups for this PHY */
1000 err = phy_scan_fixups(phydev);
1002 phydev_err(phydev, "failed to initialize\n");
1006 err = device_add(&phydev->mdio.dev);
1008 phydev_err(phydev, "failed to add\n");
1015 /* Assert the reset signal */
1016 phy_device_reset(phydev, 1);
1018 mdiobus_unregister_device(&phydev->mdio);
1021 EXPORT_SYMBOL(phy_device_register);
1024 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
1025 * @phydev: phy_device structure to remove
1027 * This doesn't free the phy_device itself, it merely reverses the effects
1028 * of phy_device_register(). Use phy_device_free() to free the device
1029 * after calling this function.
1031 void phy_device_remove(struct phy_device *phydev)
1033 unregister_mii_timestamper(phydev->mii_ts);
1034 pse_control_put(phydev->psec);
1036 device_del(&phydev->mdio.dev);
1038 /* Assert the reset signal */
1039 phy_device_reset(phydev, 1);
1041 mdiobus_unregister_device(&phydev->mdio);
1043 EXPORT_SYMBOL(phy_device_remove);
1046 * phy_get_c45_ids - Read 802.3-c45 IDs for phy device.
1047 * @phydev: phy_device structure to read 802.3-c45 IDs
1049 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
1050 * the "devices in package" is invalid.
1052 int phy_get_c45_ids(struct phy_device *phydev)
1054 return get_phy_c45_ids(phydev->mdio.bus, phydev->mdio.addr,
1057 EXPORT_SYMBOL(phy_get_c45_ids);
1060 * phy_find_first - finds the first PHY device on the bus
1061 * @bus: the target MII bus
1063 struct phy_device *phy_find_first(struct mii_bus *bus)
1065 struct phy_device *phydev;
1068 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
1069 phydev = mdiobus_get_phy(bus, addr);
1075 EXPORT_SYMBOL(phy_find_first);
1077 static void phy_link_change(struct phy_device *phydev, bool up)
1079 struct net_device *netdev = phydev->attached_dev;
1082 netif_carrier_on(netdev);
1084 netif_carrier_off(netdev);
1085 phydev->adjust_link(netdev);
1086 if (phydev->mii_ts && phydev->mii_ts->link_state)
1087 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
1091 * phy_prepare_link - prepares the PHY layer to monitor link status
1092 * @phydev: target phy_device struct
1093 * @handler: callback function for link status change notifications
1095 * Description: Tells the PHY infrastructure to handle the
1096 * gory details on monitoring link status (whether through
1097 * polling or an interrupt), and to call back to the
1098 * connected device driver when the link status changes.
1099 * If you want to monitor your own link state, don't call
1102 static void phy_prepare_link(struct phy_device *phydev,
1103 void (*handler)(struct net_device *))
1105 phydev->adjust_link = handler;
1109 * phy_connect_direct - connect an ethernet device to a specific phy_device
1110 * @dev: the network device to connect
1111 * @phydev: the pointer to the phy device
1112 * @handler: callback function for state change notifications
1113 * @interface: PHY device's interface
1115 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1116 void (*handler)(struct net_device *),
1117 phy_interface_t interface)
1124 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1128 phy_prepare_link(phydev, handler);
1129 if (phy_interrupt_is_valid(phydev))
1130 phy_request_interrupt(phydev);
1134 EXPORT_SYMBOL(phy_connect_direct);
1137 * phy_connect - connect an ethernet device to a PHY device
1138 * @dev: the network device to connect
1139 * @bus_id: the id string of the PHY device to connect
1140 * @handler: callback function for state change notifications
1141 * @interface: PHY device's interface
1143 * Description: Convenience function for connecting ethernet
1144 * devices to PHY devices. The default behavior is for
1145 * the PHY infrastructure to handle everything, and only notify
1146 * the connected driver when the link status changes. If you
1147 * don't want, or can't use the provided functionality, you may
1148 * choose to call only the subset of functions which provide
1149 * the desired functionality.
1151 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1152 void (*handler)(struct net_device *),
1153 phy_interface_t interface)
1155 struct phy_device *phydev;
1159 /* Search the list of PHY devices on the mdio bus for the
1160 * PHY with the requested name
1162 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1164 pr_err("PHY %s not found\n", bus_id);
1165 return ERR_PTR(-ENODEV);
1167 phydev = to_phy_device(d);
1169 rc = phy_connect_direct(dev, phydev, handler, interface);
1176 EXPORT_SYMBOL(phy_connect);
1179 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1181 * @phydev: target phy_device struct
1183 void phy_disconnect(struct phy_device *phydev)
1185 if (phy_is_started(phydev))
1188 if (phy_interrupt_is_valid(phydev))
1189 phy_free_interrupt(phydev);
1191 phydev->adjust_link = NULL;
1195 EXPORT_SYMBOL(phy_disconnect);
1198 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1199 * @phydev: The PHY device to poll
1201 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1202 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1203 * register must be polled until the BMCR_RESET bit clears.
1205 * Furthermore, any attempts to write to PHY registers may have no effect
1206 * or even generate MDIO bus errors until this is complete.
1208 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1209 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1210 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1211 * effort to support such broken PHYs, this function is separate from the
1212 * standard phy_init_hw() which will zero all the other bits in the BMCR
1213 * and reapply all driver-specific and board-specific fixups.
1215 static int phy_poll_reset(struct phy_device *phydev)
1217 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1220 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1221 50000, 600000, true);
1224 /* Some chips (smsc911x) may still need up to another 1ms after the
1225 * BMCR_RESET bit is cleared before they are usable.
1231 int phy_init_hw(struct phy_device *phydev)
1235 /* Deassert the reset signal */
1236 phy_device_reset(phydev, 0);
1241 if (phydev->drv->soft_reset) {
1242 ret = phydev->drv->soft_reset(phydev);
1246 /* see comment in genphy_soft_reset for an explanation */
1247 phydev->suspended = 0;
1250 ret = phy_scan_fixups(phydev);
1254 phy_interface_zero(phydev->possible_interfaces);
1256 if (phydev->drv->config_init) {
1257 ret = phydev->drv->config_init(phydev);
1262 if (phydev->drv->config_intr) {
1263 ret = phydev->drv->config_intr(phydev);
1270 EXPORT_SYMBOL(phy_init_hw);
1272 void phy_attached_info(struct phy_device *phydev)
1274 phy_attached_print(phydev, NULL);
1276 EXPORT_SYMBOL(phy_attached_info);
1278 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1279 char *phy_attached_info_irq(struct phy_device *phydev)
1284 switch(phydev->irq) {
1288 case PHY_MAC_INTERRUPT:
1292 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1297 return kasprintf(GFP_KERNEL, "%s", irq_str);
1299 EXPORT_SYMBOL(phy_attached_info_irq);
1301 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1303 const char *unbound = phydev->drv ? "" : "[unbound] ";
1304 char *irq_str = phy_attached_info_irq(phydev);
1307 phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1308 phydev_name(phydev), irq_str);
1312 phydev_info(phydev, ATTACHED_FMT, unbound,
1313 phydev_name(phydev), irq_str);
1321 EXPORT_SYMBOL(phy_attached_print);
1323 static void phy_sysfs_create_links(struct phy_device *phydev)
1325 struct net_device *dev = phydev->attached_dev;
1331 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1336 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1337 &phydev->mdio.dev.kobj,
1340 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1341 kobject_name(&phydev->mdio.dev.kobj),
1343 /* non-fatal - some net drivers can use one netdevice
1344 * with more then one phy
1348 phydev->sysfs_links = true;
1352 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1355 struct phy_device *phydev = to_phy_device(dev);
1357 return sysfs_emit(buf, "%d\n", !phydev->attached_dev);
1359 static DEVICE_ATTR_RO(phy_standalone);
1362 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1363 * @upstream: pointer to the phy device
1364 * @bus: sfp bus representing cage being attached
1366 * This is used to fill in the sfp_upstream_ops .attach member.
1368 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1370 struct phy_device *phydev = upstream;
1372 if (phydev->attached_dev)
1373 phydev->attached_dev->sfp_bus = bus;
1374 phydev->sfp_bus_attached = true;
1376 EXPORT_SYMBOL(phy_sfp_attach);
1379 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1380 * @upstream: pointer to the phy device
1381 * @bus: sfp bus representing cage being attached
1383 * This is used to fill in the sfp_upstream_ops .detach member.
1385 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1387 struct phy_device *phydev = upstream;
1389 if (phydev->attached_dev)
1390 phydev->attached_dev->sfp_bus = NULL;
1391 phydev->sfp_bus_attached = false;
1393 EXPORT_SYMBOL(phy_sfp_detach);
1396 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1397 * @phydev: Pointer to phy_device
1398 * @ops: SFP's upstream operations
1400 int phy_sfp_probe(struct phy_device *phydev,
1401 const struct sfp_upstream_ops *ops)
1403 struct sfp_bus *bus;
1406 if (phydev->mdio.dev.fwnode) {
1407 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1409 return PTR_ERR(bus);
1411 phydev->sfp_bus = bus;
1413 ret = sfp_bus_add_upstream(bus, phydev, ops);
1418 EXPORT_SYMBOL(phy_sfp_probe);
1420 static bool phy_drv_supports_irq(const struct phy_driver *phydrv)
1422 return phydrv->config_intr && phydrv->handle_interrupt;
1426 * phy_attach_direct - attach a network device to a given PHY device pointer
1427 * @dev: network device to attach
1428 * @phydev: Pointer to phy_device to attach
1429 * @flags: PHY device's dev_flags
1430 * @interface: PHY device's interface
1432 * Description: Called by drivers to attach to a particular PHY
1433 * device. The phy_device is found, and properly hooked up
1434 * to the phy_driver. If no driver is attached, then a
1435 * generic driver is used. The phy_device is given a ptr to
1436 * the attaching device, and given a callback for link status
1437 * change. The phy_device is returned to the attaching driver.
1438 * This function takes a reference on the phy device.
1440 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1441 u32 flags, phy_interface_t interface)
1443 struct mii_bus *bus = phydev->mdio.bus;
1444 struct device *d = &phydev->mdio.dev;
1445 struct module *ndev_owner = NULL;
1446 bool using_genphy = false;
1449 /* For Ethernet device drivers that register their own MDIO bus, we
1450 * will have bus->owner match ndev_mod, so we do not want to increment
1451 * our own module->refcnt here, otherwise we would not be able to
1455 ndev_owner = dev->dev.parent->driver->owner;
1456 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1457 phydev_err(phydev, "failed to get the bus module\n");
1463 /* Assume that if there is no driver, that it doesn't
1464 * exist, and we should use the genphy driver.
1468 d->driver = &genphy_c45_driver.mdiodrv.driver;
1470 d->driver = &genphy_driver.mdiodrv.driver;
1472 using_genphy = true;
1475 if (!try_module_get(d->driver->owner)) {
1476 phydev_err(phydev, "failed to get the device driver module\n");
1478 goto error_put_device;
1482 err = d->driver->probe(d);
1484 err = device_bind_driver(d);
1487 goto error_module_put;
1490 if (phydev->attached_dev) {
1491 dev_err(&dev->dev, "PHY already attached\n");
1496 phydev->phy_link_change = phy_link_change;
1498 phydev->attached_dev = dev;
1499 dev->phydev = phydev;
1501 if (phydev->sfp_bus_attached)
1502 dev->sfp_bus = phydev->sfp_bus;
1505 /* Some Ethernet drivers try to connect to a PHY device before
1506 * calling register_netdevice() -> netdev_register_kobject() and
1507 * does the dev->dev.kobj initialization. Here we only check for
1508 * success which indicates that the network device kobject is
1509 * ready. Once we do that we still need to keep track of whether
1510 * links were successfully set up or not for phy_detach() to
1511 * remove them accordingly.
1513 phydev->sysfs_links = false;
1515 phy_sysfs_create_links(phydev);
1517 if (!phydev->attached_dev) {
1518 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1519 &dev_attr_phy_standalone.attr);
1521 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1524 phydev->dev_flags |= flags;
1526 phydev->interface = interface;
1528 phydev->state = PHY_READY;
1530 phydev->interrupts = PHY_INTERRUPT_DISABLED;
1532 /* PHYs can request to use poll mode even though they have an
1533 * associated interrupt line. This could be the case if they
1534 * detect a broken interrupt handling.
1536 if (phydev->dev_flags & PHY_F_NO_IRQ)
1537 phydev->irq = PHY_POLL;
1539 if (!phy_drv_supports_irq(phydev->drv) && phy_interrupt_is_valid(phydev))
1540 phydev->irq = PHY_POLL;
1542 /* Port is set to PORT_TP by default and the actual PHY driver will set
1543 * it to different value depending on the PHY configuration. If we have
1544 * the generic PHY driver we can't figure it out, thus set the old
1545 * legacy PORT_MII value.
1548 phydev->port = PORT_MII;
1550 /* Initial carrier state is off as the phy is about to be
1554 netif_carrier_off(phydev->attached_dev);
1556 /* Do initial configuration here, now that
1557 * we have certain key parameters
1558 * (dev_flags and interface)
1560 err = phy_init_hw(phydev);
1565 if (!phydev->is_on_sfp_module)
1566 phy_led_triggers_register(phydev);
1569 * If the external phy used by current mac interface is managed by
1570 * another mac interface, so we should create a device link between
1571 * phy dev and mac dev.
1573 if (dev && phydev->mdio.bus->parent && dev->dev.parent != phydev->mdio.bus->parent)
1574 phydev->devlink = device_link_add(dev->dev.parent, &phydev->mdio.dev,
1575 DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS);
1580 /* phy_detach() does all of the cleanup below */
1585 module_put(d->driver->owner);
1589 if (ndev_owner != bus->owner)
1590 module_put(bus->owner);
1593 EXPORT_SYMBOL(phy_attach_direct);
1596 * phy_attach - attach a network device to a particular PHY device
1597 * @dev: network device to attach
1598 * @bus_id: Bus ID of PHY device to attach
1599 * @interface: PHY device's interface
1601 * Description: Same as phy_attach_direct() except that a PHY bus_id
1602 * string is passed instead of a pointer to a struct phy_device.
1604 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1605 phy_interface_t interface)
1607 struct phy_device *phydev;
1612 return ERR_PTR(-EINVAL);
1614 /* Search the list of PHY devices on the mdio bus for the
1615 * PHY with the requested name
1617 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1619 pr_err("PHY %s not found\n", bus_id);
1620 return ERR_PTR(-ENODEV);
1622 phydev = to_phy_device(d);
1624 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1631 EXPORT_SYMBOL(phy_attach);
1633 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1634 struct device_driver *driver)
1636 struct device *d = &phydev->mdio.dev;
1643 ret = d->driver == driver;
1649 bool phy_driver_is_genphy(struct phy_device *phydev)
1651 return phy_driver_is_genphy_kind(phydev,
1652 &genphy_driver.mdiodrv.driver);
1654 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1656 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1658 return phy_driver_is_genphy_kind(phydev,
1659 &genphy_c45_driver.mdiodrv.driver);
1661 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1664 * phy_package_join - join a common PHY group
1665 * @phydev: target phy_device struct
1666 * @base_addr: cookie and base PHY address of PHY package for offset
1667 * calculation of global register access
1668 * @priv_size: if non-zero allocate this amount of bytes for private data
1670 * This joins a PHY group and provides a shared storage for all phydevs in
1671 * this group. This is intended to be used for packages which contain
1672 * more than one PHY, for example a quad PHY transceiver.
1674 * The base_addr parameter serves as cookie which has to have the same values
1675 * for all members of one group and as the base PHY address of the PHY package
1676 * for offset calculation to access generic registers of a PHY package.
1677 * Usually, one of the PHY addresses of the different PHYs in the package
1678 * provides access to these global registers.
1679 * The address which is given here, will be used in the phy_package_read()
1680 * and phy_package_write() convenience functions as base and added to the
1681 * passed offset in those functions.
1683 * This will set the shared pointer of the phydev to the shared storage.
1684 * If this is the first call for a this cookie the shared storage will be
1685 * allocated. If priv_size is non-zero, the given amount of bytes are
1686 * allocated for the priv member.
1688 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1689 * with the same cookie but a different priv_size is an error.
1691 int phy_package_join(struct phy_device *phydev, int base_addr, size_t priv_size)
1693 struct mii_bus *bus = phydev->mdio.bus;
1694 struct phy_package_shared *shared;
1697 if (base_addr < 0 || base_addr >= PHY_MAX_ADDR)
1700 mutex_lock(&bus->shared_lock);
1701 shared = bus->shared[base_addr];
1704 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1708 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1711 shared->priv_size = priv_size;
1713 shared->base_addr = base_addr;
1715 refcount_set(&shared->refcnt, 1);
1716 bus->shared[base_addr] = shared;
1719 if (priv_size && priv_size != shared->priv_size)
1721 refcount_inc(&shared->refcnt);
1723 mutex_unlock(&bus->shared_lock);
1725 phydev->shared = shared;
1732 mutex_unlock(&bus->shared_lock);
1735 EXPORT_SYMBOL_GPL(phy_package_join);
1738 * of_phy_package_join - join a common PHY group in PHY package
1739 * @phydev: target phy_device struct
1740 * @priv_size: if non-zero allocate this amount of bytes for private data
1742 * This is a variant of phy_package_join for PHY package defined in DT.
1744 * The parent node of the @phydev is checked as a valid PHY package node
1745 * structure (by matching the node name "ethernet-phy-package") and the
1746 * base_addr for the PHY package is passed to phy_package_join.
1748 * With this configuration the shared struct will also have the np value
1749 * filled to use additional DT defined properties in PHY specific
1750 * probe_once and config_init_once PHY package OPs.
1752 * Returns < 0 on error, 0 on success. Esp. calling phy_package_join()
1753 * with the same cookie but a different priv_size is an error. Or a parent
1754 * node is not detected or is not valid or doesn't match the expected node
1755 * name for PHY package.
1757 int of_phy_package_join(struct phy_device *phydev, size_t priv_size)
1759 struct device_node *node = phydev->mdio.dev.of_node;
1760 struct device_node *package_node;
1767 package_node = of_get_parent(node);
1771 if (!of_node_name_eq(package_node, "ethernet-phy-package")) {
1776 if (of_property_read_u32(package_node, "reg", &base_addr)) {
1781 ret = phy_package_join(phydev, base_addr, priv_size);
1785 phydev->shared->np = package_node;
1789 of_node_put(package_node);
1792 EXPORT_SYMBOL_GPL(of_phy_package_join);
1795 * phy_package_leave - leave a common PHY group
1796 * @phydev: target phy_device struct
1798 * This leaves a PHY group created by phy_package_join(). If this phydev
1799 * was the last user of the shared data between the group, this data is
1800 * freed. Resets the phydev->shared pointer to NULL.
1802 void phy_package_leave(struct phy_device *phydev)
1804 struct phy_package_shared *shared = phydev->shared;
1805 struct mii_bus *bus = phydev->mdio.bus;
1810 /* Decrease the node refcount on leave if present */
1812 of_node_put(shared->np);
1814 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1815 bus->shared[shared->base_addr] = NULL;
1816 mutex_unlock(&bus->shared_lock);
1817 kfree(shared->priv);
1821 phydev->shared = NULL;
1823 EXPORT_SYMBOL_GPL(phy_package_leave);
1825 static void devm_phy_package_leave(struct device *dev, void *res)
1827 phy_package_leave(*(struct phy_device **)res);
1831 * devm_phy_package_join - resource managed phy_package_join()
1832 * @dev: device that is registering this PHY package
1833 * @phydev: target phy_device struct
1834 * @base_addr: cookie and base PHY address of PHY package for offset
1835 * calculation of global register access
1836 * @priv_size: if non-zero allocate this amount of bytes for private data
1838 * Managed phy_package_join(). Shared storage fetched by this function,
1839 * phy_package_leave() is automatically called on driver detach. See
1840 * phy_package_join() for more information.
1842 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1843 int base_addr, size_t priv_size)
1845 struct phy_device **ptr;
1848 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1853 ret = phy_package_join(phydev, base_addr, priv_size);
1857 devres_add(dev, ptr);
1864 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1867 * devm_of_phy_package_join - resource managed of_phy_package_join()
1868 * @dev: device that is registering this PHY package
1869 * @phydev: target phy_device struct
1870 * @priv_size: if non-zero allocate this amount of bytes for private data
1872 * Managed of_phy_package_join(). Shared storage fetched by this function,
1873 * phy_package_leave() is automatically called on driver detach. See
1874 * of_phy_package_join() for more information.
1876 int devm_of_phy_package_join(struct device *dev, struct phy_device *phydev,
1879 struct phy_device **ptr;
1882 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1887 ret = of_phy_package_join(phydev, priv_size);
1891 devres_add(dev, ptr);
1898 EXPORT_SYMBOL_GPL(devm_of_phy_package_join);
1901 * phy_detach - detach a PHY device from its network device
1902 * @phydev: target phy_device struct
1904 * This detaches the phy device from its network device and the phy
1905 * driver, and drops the reference count taken in phy_attach_direct().
1907 void phy_detach(struct phy_device *phydev)
1909 struct net_device *dev = phydev->attached_dev;
1910 struct module *ndev_owner = NULL;
1911 struct mii_bus *bus;
1913 if (phydev->devlink)
1914 device_link_del(phydev->devlink);
1916 if (phydev->sysfs_links) {
1918 sysfs_remove_link(&dev->dev.kobj, "phydev");
1919 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1922 if (!phydev->attached_dev)
1923 sysfs_remove_file(&phydev->mdio.dev.kobj,
1924 &dev_attr_phy_standalone.attr);
1926 phy_suspend(phydev);
1928 phydev->attached_dev->phydev = NULL;
1929 phydev->attached_dev = NULL;
1931 phydev->phylink = NULL;
1933 if (!phydev->is_on_sfp_module)
1934 phy_led_triggers_unregister(phydev);
1936 if (phydev->mdio.dev.driver)
1937 module_put(phydev->mdio.dev.driver->owner);
1939 /* If the device had no specific driver before (i.e. - it
1940 * was using the generic driver), we unbind the device
1941 * from the generic driver so that there's a chance a
1942 * real driver could be loaded
1944 if (phy_driver_is_genphy(phydev) ||
1945 phy_driver_is_genphy_10g(phydev))
1946 device_release_driver(&phydev->mdio.dev);
1948 /* Assert the reset signal */
1949 phy_device_reset(phydev, 1);
1952 * The phydev might go away on the put_device() below, so avoid
1953 * a use-after-free bug by reading the underlying bus first.
1955 bus = phydev->mdio.bus;
1957 put_device(&phydev->mdio.dev);
1959 ndev_owner = dev->dev.parent->driver->owner;
1960 if (ndev_owner != bus->owner)
1961 module_put(bus->owner);
1963 EXPORT_SYMBOL(phy_detach);
1965 int phy_suspend(struct phy_device *phydev)
1967 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1968 struct net_device *netdev = phydev->attached_dev;
1969 const struct phy_driver *phydrv = phydev->drv;
1972 if (phydev->suspended)
1975 phy_ethtool_get_wol(phydev, &wol);
1976 phydev->wol_enabled = wol.wolopts || (netdev && netdev->wol_enabled);
1977 /* If the device has WOL enabled, we cannot suspend the PHY */
1978 if (phydev->wol_enabled && !(phydrv->flags & PHY_ALWAYS_CALL_SUSPEND))
1981 if (!phydrv || !phydrv->suspend)
1984 ret = phydrv->suspend(phydev);
1986 phydev->suspended = true;
1990 EXPORT_SYMBOL(phy_suspend);
1992 int __phy_resume(struct phy_device *phydev)
1994 const struct phy_driver *phydrv = phydev->drv;
1997 lockdep_assert_held(&phydev->lock);
1999 if (!phydrv || !phydrv->resume)
2002 ret = phydrv->resume(phydev);
2004 phydev->suspended = false;
2008 EXPORT_SYMBOL(__phy_resume);
2010 int phy_resume(struct phy_device *phydev)
2014 mutex_lock(&phydev->lock);
2015 ret = __phy_resume(phydev);
2016 mutex_unlock(&phydev->lock);
2020 EXPORT_SYMBOL(phy_resume);
2022 int phy_loopback(struct phy_device *phydev, bool enable)
2029 mutex_lock(&phydev->lock);
2031 if (enable && phydev->loopback_enabled) {
2036 if (!enable && !phydev->loopback_enabled) {
2041 if (phydev->drv->set_loopback)
2042 ret = phydev->drv->set_loopback(phydev, enable);
2044 ret = genphy_loopback(phydev, enable);
2049 phydev->loopback_enabled = enable;
2052 mutex_unlock(&phydev->lock);
2055 EXPORT_SYMBOL(phy_loopback);
2058 * phy_reset_after_clk_enable - perform a PHY reset if needed
2059 * @phydev: target phy_device struct
2061 * Description: Some PHYs are known to need a reset after their refclk was
2062 * enabled. This function evaluates the flags and perform the reset if it's
2063 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
2066 int phy_reset_after_clk_enable(struct phy_device *phydev)
2068 if (!phydev || !phydev->drv)
2071 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
2072 phy_device_reset(phydev, 1);
2073 phy_device_reset(phydev, 0);
2079 EXPORT_SYMBOL(phy_reset_after_clk_enable);
2081 /* Generic PHY support and helper functions */
2084 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
2085 * @phydev: target phy_device struct
2087 * Description: Writes MII_ADVERTISE with the appropriate values,
2088 * after sanitizing the values to make sure we only advertise
2089 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
2090 * hasn't changed, and > 0 if it has changed.
2092 static int genphy_config_advert(struct phy_device *phydev)
2094 int err, bmsr, changed = 0;
2097 /* Only allow advertising what this PHY supports */
2098 linkmode_and(phydev->advertising, phydev->advertising,
2101 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
2103 /* Setup standard advertisement */
2104 err = phy_modify_changed(phydev, MII_ADVERTISE,
2105 ADVERTISE_ALL | ADVERTISE_100BASE4 |
2106 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
2113 bmsr = phy_read(phydev, MII_BMSR);
2117 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
2118 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
2121 if (!(bmsr & BMSR_ESTATEN))
2124 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
2126 err = phy_modify_changed(phydev, MII_CTRL1000,
2127 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
2138 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
2139 * @phydev: target phy_device struct
2141 * Description: Writes MII_ADVERTISE with the appropriate values,
2142 * after sanitizing the values to make sure we only advertise
2143 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
2144 * hasn't changed, and > 0 if it has changed. This function is intended
2145 * for Clause 37 1000Base-X mode.
2147 static int genphy_c37_config_advert(struct phy_device *phydev)
2151 /* Only allow advertising what this PHY supports */
2152 linkmode_and(phydev->advertising, phydev->advertising,
2155 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2156 phydev->advertising))
2157 adv |= ADVERTISE_1000XFULL;
2158 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2159 phydev->advertising))
2160 adv |= ADVERTISE_1000XPAUSE;
2161 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2162 phydev->advertising))
2163 adv |= ADVERTISE_1000XPSE_ASYM;
2165 return phy_modify_changed(phydev, MII_ADVERTISE,
2166 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
2167 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
2172 * genphy_config_eee_advert - disable unwanted eee mode advertisement
2173 * @phydev: target phy_device struct
2175 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
2176 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
2177 * changed, and 1 if it has changed.
2179 int genphy_config_eee_advert(struct phy_device *phydev)
2183 /* Nothing to disable */
2184 if (!phydev->eee_broken_modes)
2187 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
2188 phydev->eee_broken_modes, 0);
2189 /* If the call failed, we assume that EEE is not supported */
2190 return err < 0 ? 0 : err;
2192 EXPORT_SYMBOL(genphy_config_eee_advert);
2195 * genphy_setup_forced - configures/forces speed/duplex from @phydev
2196 * @phydev: target phy_device struct
2198 * Description: Configures MII_BMCR to force speed/duplex
2199 * to the values in phydev. Assumes that the values are valid.
2200 * Please see phy_sanitize_settings().
2202 int genphy_setup_forced(struct phy_device *phydev)
2207 phydev->asym_pause = 0;
2209 ctl = mii_bmcr_encode_fixed(phydev->speed, phydev->duplex);
2211 return phy_modify(phydev, MII_BMCR,
2212 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
2214 EXPORT_SYMBOL(genphy_setup_forced);
2216 static int genphy_setup_master_slave(struct phy_device *phydev)
2220 if (!phydev->is_gigabit_capable)
2223 switch (phydev->master_slave_set) {
2224 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
2225 ctl |= CTL1000_PREFER_MASTER;
2227 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
2229 case MASTER_SLAVE_CFG_MASTER_FORCE:
2230 ctl |= CTL1000_AS_MASTER;
2232 case MASTER_SLAVE_CFG_SLAVE_FORCE:
2233 ctl |= CTL1000_ENABLE_MASTER;
2235 case MASTER_SLAVE_CFG_UNKNOWN:
2236 case MASTER_SLAVE_CFG_UNSUPPORTED:
2239 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2243 return phy_modify_changed(phydev, MII_CTRL1000,
2244 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2245 CTL1000_PREFER_MASTER), ctl);
2248 int genphy_read_master_slave(struct phy_device *phydev)
2253 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2254 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2256 val = phy_read(phydev, MII_CTRL1000);
2260 if (val & CTL1000_ENABLE_MASTER) {
2261 if (val & CTL1000_AS_MASTER)
2262 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2264 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2266 if (val & CTL1000_PREFER_MASTER)
2267 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2269 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2272 val = phy_read(phydev, MII_STAT1000);
2276 if (val & LPA_1000MSFAIL) {
2277 state = MASTER_SLAVE_STATE_ERR;
2278 } else if (phydev->link) {
2279 /* this bits are valid only for active link */
2280 if (val & LPA_1000MSRES)
2281 state = MASTER_SLAVE_STATE_MASTER;
2283 state = MASTER_SLAVE_STATE_SLAVE;
2285 state = MASTER_SLAVE_STATE_UNKNOWN;
2288 phydev->master_slave_get = cfg;
2289 phydev->master_slave_state = state;
2293 EXPORT_SYMBOL(genphy_read_master_slave);
2296 * genphy_restart_aneg - Enable and Restart Autonegotiation
2297 * @phydev: target phy_device struct
2299 int genphy_restart_aneg(struct phy_device *phydev)
2301 /* Don't isolate the PHY if we're negotiating */
2302 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2303 BMCR_ANENABLE | BMCR_ANRESTART);
2305 EXPORT_SYMBOL(genphy_restart_aneg);
2308 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2309 * @phydev: target phy_device struct
2310 * @restart: whether aneg restart is requested
2312 * Check, and restart auto-negotiation if needed.
2314 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2319 /* Advertisement hasn't changed, but maybe aneg was never on to
2320 * begin with? Or maybe phy was isolated?
2322 ret = phy_read(phydev, MII_BMCR);
2326 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2331 return genphy_restart_aneg(phydev);
2335 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2338 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2339 * @phydev: target phy_device struct
2340 * @changed: whether autoneg is requested
2342 * Description: If auto-negotiation is enabled, we configure the
2343 * advertising, and then restart auto-negotiation. If it is not
2344 * enabled, then we write the BMCR.
2346 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2350 err = genphy_c45_an_config_eee_aneg(phydev);
2356 err = genphy_setup_master_slave(phydev);
2362 if (AUTONEG_ENABLE != phydev->autoneg)
2363 return genphy_setup_forced(phydev);
2365 err = genphy_config_advert(phydev);
2366 if (err < 0) /* error */
2371 return genphy_check_and_restart_aneg(phydev, changed);
2373 EXPORT_SYMBOL(__genphy_config_aneg);
2376 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2377 * @phydev: target phy_device struct
2379 * Description: If auto-negotiation is enabled, we configure the
2380 * advertising, and then restart auto-negotiation. If it is not
2381 * enabled, then we write the BMCR. This function is intended
2382 * for use with Clause 37 1000Base-X mode.
2384 int genphy_c37_config_aneg(struct phy_device *phydev)
2388 if (phydev->autoneg != AUTONEG_ENABLE)
2389 return genphy_setup_forced(phydev);
2391 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2396 changed = genphy_c37_config_advert(phydev);
2397 if (changed < 0) /* error */
2401 /* Advertisement hasn't changed, but maybe aneg was never on to
2402 * begin with? Or maybe phy was isolated?
2404 int ctl = phy_read(phydev, MII_BMCR);
2409 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2410 changed = 1; /* do restart aneg */
2413 /* Only restart aneg if we are advertising something different
2414 * than we were before.
2417 return genphy_restart_aneg(phydev);
2421 EXPORT_SYMBOL(genphy_c37_config_aneg);
2424 * genphy_aneg_done - return auto-negotiation status
2425 * @phydev: target phy_device struct
2427 * Description: Reads the status register and returns 0 either if
2428 * auto-negotiation is incomplete, or if there was an error.
2429 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2431 int genphy_aneg_done(struct phy_device *phydev)
2433 int retval = phy_read(phydev, MII_BMSR);
2435 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2437 EXPORT_SYMBOL(genphy_aneg_done);
2440 * genphy_update_link - update link status in @phydev
2441 * @phydev: target phy_device struct
2443 * Description: Update the value in phydev->link to reflect the
2444 * current link value. In order to do this, we need to read
2445 * the status register twice, keeping the second value.
2447 int genphy_update_link(struct phy_device *phydev)
2449 int status = 0, bmcr;
2451 bmcr = phy_read(phydev, MII_BMCR);
2455 /* Autoneg is being started, therefore disregard BMSR value and
2456 * report link as down.
2458 if (bmcr & BMCR_ANRESTART)
2461 /* The link state is latched low so that momentary link
2462 * drops can be detected. Do not double-read the status
2463 * in polling mode to detect such short link drops except
2464 * the link was already down.
2466 if (!phy_polling_mode(phydev) || !phydev->link) {
2467 status = phy_read(phydev, MII_BMSR);
2470 else if (status & BMSR_LSTATUS)
2474 /* Read link and autonegotiation status */
2475 status = phy_read(phydev, MII_BMSR);
2479 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2480 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2482 /* Consider the case that autoneg was started and "aneg complete"
2483 * bit has been reset, but "link up" bit not yet.
2485 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2490 EXPORT_SYMBOL(genphy_update_link);
2492 int genphy_read_lpa(struct phy_device *phydev)
2496 if (phydev->autoneg == AUTONEG_ENABLE) {
2497 if (!phydev->autoneg_complete) {
2498 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2500 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2504 if (phydev->is_gigabit_capable) {
2505 lpagb = phy_read(phydev, MII_STAT1000);
2509 if (lpagb & LPA_1000MSFAIL) {
2510 int adv = phy_read(phydev, MII_CTRL1000);
2515 if (adv & CTL1000_ENABLE_MASTER)
2516 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2518 phydev_err(phydev, "Master/Slave resolution failed\n");
2522 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2526 lpa = phy_read(phydev, MII_LPA);
2530 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2532 linkmode_zero(phydev->lp_advertising);
2537 EXPORT_SYMBOL(genphy_read_lpa);
2540 * genphy_read_status_fixed - read the link parameters for !aneg mode
2541 * @phydev: target phy_device struct
2543 * Read the current duplex and speed state for a PHY operating with
2544 * autonegotiation disabled.
2546 int genphy_read_status_fixed(struct phy_device *phydev)
2548 int bmcr = phy_read(phydev, MII_BMCR);
2553 if (bmcr & BMCR_FULLDPLX)
2554 phydev->duplex = DUPLEX_FULL;
2556 phydev->duplex = DUPLEX_HALF;
2558 if (bmcr & BMCR_SPEED1000)
2559 phydev->speed = SPEED_1000;
2560 else if (bmcr & BMCR_SPEED100)
2561 phydev->speed = SPEED_100;
2563 phydev->speed = SPEED_10;
2567 EXPORT_SYMBOL(genphy_read_status_fixed);
2570 * genphy_read_status - check the link status and update current link state
2571 * @phydev: target phy_device struct
2573 * Description: Check the link, then figure out the current state
2574 * by comparing what we advertise with what the link partner
2575 * advertises. Start by checking the gigabit possibilities,
2576 * then move on to 10/100.
2578 int genphy_read_status(struct phy_device *phydev)
2580 int err, old_link = phydev->link;
2582 /* Update the link, but return if there was an error */
2583 err = genphy_update_link(phydev);
2587 /* why bother the PHY if nothing can have changed */
2588 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2591 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2592 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2593 phydev->speed = SPEED_UNKNOWN;
2594 phydev->duplex = DUPLEX_UNKNOWN;
2596 phydev->asym_pause = 0;
2598 if (phydev->is_gigabit_capable) {
2599 err = genphy_read_master_slave(phydev);
2604 err = genphy_read_lpa(phydev);
2608 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2609 phy_resolve_aneg_linkmode(phydev);
2610 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2611 err = genphy_read_status_fixed(phydev);
2618 EXPORT_SYMBOL(genphy_read_status);
2621 * genphy_c37_read_status - check the link status and update current link state
2622 * @phydev: target phy_device struct
2623 * @changed: pointer where to store if link changed
2625 * Description: Check the link, then figure out the current state
2626 * by comparing what we advertise with what the link partner
2627 * advertises. This function is for Clause 37 1000Base-X mode.
2629 * If link has changed, @changed is set to true, false otherwise.
2631 int genphy_c37_read_status(struct phy_device *phydev, bool *changed)
2633 int lpa, err, old_link = phydev->link;
2635 /* Update the link, but return if there was an error */
2636 err = genphy_update_link(phydev);
2640 /* why bother the PHY if nothing can have changed */
2641 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link) {
2646 /* Signal link has changed */
2648 phydev->duplex = DUPLEX_UNKNOWN;
2650 phydev->asym_pause = 0;
2652 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2653 lpa = phy_read(phydev, MII_LPA);
2657 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2658 phydev->lp_advertising, lpa & LPA_LPACK);
2659 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2660 phydev->lp_advertising, lpa & LPA_1000XFULL);
2661 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2662 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2663 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2664 phydev->lp_advertising,
2665 lpa & LPA_1000XPAUSE_ASYM);
2667 phy_resolve_aneg_linkmode(phydev);
2668 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2669 int bmcr = phy_read(phydev, MII_BMCR);
2674 if (bmcr & BMCR_FULLDPLX)
2675 phydev->duplex = DUPLEX_FULL;
2677 phydev->duplex = DUPLEX_HALF;
2682 EXPORT_SYMBOL(genphy_c37_read_status);
2685 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2686 * @phydev: target phy_device struct
2688 * Description: Perform a software PHY reset using the standard
2689 * BMCR_RESET bit and poll for the reset bit to be cleared.
2691 * Returns: 0 on success, < 0 on failure
2693 int genphy_soft_reset(struct phy_device *phydev)
2695 u16 res = BMCR_RESET;
2698 if (phydev->autoneg == AUTONEG_ENABLE)
2699 res |= BMCR_ANRESTART;
2701 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2705 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2706 * to their default value. Therefore the POWER DOWN bit is supposed to
2707 * be cleared after soft reset.
2709 phydev->suspended = 0;
2711 ret = phy_poll_reset(phydev);
2715 /* BMCR may be reset to defaults */
2716 if (phydev->autoneg == AUTONEG_DISABLE)
2717 ret = genphy_setup_forced(phydev);
2721 EXPORT_SYMBOL(genphy_soft_reset);
2723 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2725 /* It seems there are cases where the interrupts are handled by another
2726 * entity (ie an IRQ controller embedded inside the PHY) and do not
2727 * need any other interraction from phylib. In this case, just trigger
2728 * the state machine directly.
2730 phy_trigger_machine(phydev);
2734 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2737 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2738 * @phydev: target phy_device struct
2740 * Description: Reads the PHY's abilities and populates
2741 * phydev->supported accordingly.
2743 * Returns: 0 on success, < 0 on failure
2745 int genphy_read_abilities(struct phy_device *phydev)
2749 linkmode_set_bit_array(phy_basic_ports_array,
2750 ARRAY_SIZE(phy_basic_ports_array),
2753 val = phy_read(phydev, MII_BMSR);
2757 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2758 val & BMSR_ANEGCAPABLE);
2760 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2761 val & BMSR_100FULL);
2762 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2763 val & BMSR_100HALF);
2764 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2766 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2769 if (val & BMSR_ESTATEN) {
2770 val = phy_read(phydev, MII_ESTATUS);
2774 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2775 phydev->supported, val & ESTATUS_1000_TFULL);
2776 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2777 phydev->supported, val & ESTATUS_1000_THALF);
2778 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2779 phydev->supported, val & ESTATUS_1000_XFULL);
2782 /* This is optional functionality. If not supported, we may get an error
2783 * which should be ignored.
2785 genphy_c45_read_eee_abilities(phydev);
2789 EXPORT_SYMBOL(genphy_read_abilities);
2791 /* This is used for the phy device which doesn't support the MMD extended
2792 * register access, but it does have side effect when we are trying to access
2793 * the MMD register via indirect method.
2795 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2799 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2801 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2802 u16 regnum, u16 val)
2806 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2808 int genphy_suspend(struct phy_device *phydev)
2810 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2812 EXPORT_SYMBOL(genphy_suspend);
2814 int genphy_resume(struct phy_device *phydev)
2816 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2818 EXPORT_SYMBOL(genphy_resume);
2820 int genphy_loopback(struct phy_device *phydev, bool enable)
2823 u16 val, ctl = BMCR_LOOPBACK;
2826 ctl |= mii_bmcr_encode_fixed(phydev->speed, phydev->duplex);
2828 phy_modify(phydev, MII_BMCR, ~0, ctl);
2830 ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2832 5000, 500000, true);
2836 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2838 phy_config_aneg(phydev);
2843 EXPORT_SYMBOL(genphy_loopback);
2846 * phy_remove_link_mode - Remove a supported link mode
2847 * @phydev: phy_device structure to remove link mode from
2848 * @link_mode: Link mode to be removed
2850 * Description: Some MACs don't support all link modes which the PHY
2851 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2852 * to remove a link mode.
2854 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2856 linkmode_clear_bit(link_mode, phydev->supported);
2857 phy_advertise_supported(phydev);
2859 EXPORT_SYMBOL(phy_remove_link_mode);
2861 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2863 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2864 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2865 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2866 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2870 * phy_advertise_supported - Advertise all supported modes
2871 * @phydev: target phy_device struct
2873 * Description: Called to advertise all supported modes, doesn't touch
2874 * pause mode advertising.
2876 void phy_advertise_supported(struct phy_device *phydev)
2878 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2880 linkmode_copy(new, phydev->supported);
2881 phy_copy_pause_bits(new, phydev->advertising);
2882 linkmode_copy(phydev->advertising, new);
2884 EXPORT_SYMBOL(phy_advertise_supported);
2887 * phy_advertise_eee_all - Advertise all supported EEE modes
2888 * @phydev: target phy_device struct
2890 * Description: Per default phylib preserves the EEE advertising at the time of
2891 * phy probing, which might be a subset of the supported EEE modes. Use this
2892 * function when all supported EEE modes should be advertised. This does not
2893 * trigger auto-negotiation, so must be called before phy_start()/
2894 * phylink_start() which will start auto-negotiation.
2896 void phy_advertise_eee_all(struct phy_device *phydev)
2898 linkmode_copy(phydev->advertising_eee, phydev->supported_eee);
2900 EXPORT_SYMBOL_GPL(phy_advertise_eee_all);
2903 * phy_support_sym_pause - Enable support of symmetrical pause
2904 * @phydev: target phy_device struct
2906 * Description: Called by the MAC to indicate is supports symmetrical
2907 * Pause, but not asym pause.
2909 void phy_support_sym_pause(struct phy_device *phydev)
2911 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2912 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2914 EXPORT_SYMBOL(phy_support_sym_pause);
2917 * phy_support_asym_pause - Enable support of asym pause
2918 * @phydev: target phy_device struct
2920 * Description: Called by the MAC to indicate is supports Asym Pause.
2922 void phy_support_asym_pause(struct phy_device *phydev)
2924 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2926 EXPORT_SYMBOL(phy_support_asym_pause);
2929 * phy_set_sym_pause - Configure symmetric Pause
2930 * @phydev: target phy_device struct
2931 * @rx: Receiver Pause is supported
2932 * @tx: Transmit Pause is supported
2933 * @autoneg: Auto neg should be used
2935 * Description: Configure advertised Pause support depending on if
2936 * receiver pause and pause auto neg is supported. Generally called
2937 * from the set_pauseparam .ndo.
2939 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2942 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2944 if (rx && tx && autoneg)
2945 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2948 linkmode_copy(phydev->advertising, phydev->supported);
2950 EXPORT_SYMBOL(phy_set_sym_pause);
2953 * phy_set_asym_pause - Configure Pause and Asym Pause
2954 * @phydev: target phy_device struct
2955 * @rx: Receiver Pause is supported
2956 * @tx: Transmit Pause is supported
2958 * Description: Configure advertised Pause support depending on if
2959 * transmit and receiver pause is supported. If there has been a
2960 * change in adverting, trigger a new autoneg. Generally called from
2961 * the set_pauseparam .ndo.
2963 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2965 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2967 linkmode_copy(oldadv, phydev->advertising);
2968 linkmode_set_pause(phydev->advertising, tx, rx);
2970 if (!linkmode_equal(oldadv, phydev->advertising) &&
2972 phy_start_aneg(phydev);
2974 EXPORT_SYMBOL(phy_set_asym_pause);
2977 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2978 * @phydev: phy_device struct
2979 * @pp: requested pause configuration
2981 * Description: Test if the PHY/MAC combination supports the Pause
2982 * configuration the user is requesting. Returns True if it is
2983 * supported, false otherwise.
2985 bool phy_validate_pause(struct phy_device *phydev,
2986 struct ethtool_pauseparam *pp)
2988 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2989 phydev->supported) && pp->rx_pause)
2992 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2993 phydev->supported) &&
2994 pp->rx_pause != pp->tx_pause)
2999 EXPORT_SYMBOL(phy_validate_pause);
3002 * phy_get_pause - resolve negotiated pause modes
3003 * @phydev: phy_device struct
3004 * @tx_pause: pointer to bool to indicate whether transmit pause should be
3006 * @rx_pause: pointer to bool to indicate whether receive pause should be
3009 * Resolve and return the flow control modes according to the negotiation
3010 * result. This includes checking that we are operating in full duplex mode.
3011 * See linkmode_resolve_pause() for further details.
3013 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
3015 if (phydev->duplex != DUPLEX_FULL) {
3021 return linkmode_resolve_pause(phydev->advertising,
3022 phydev->lp_advertising,
3023 tx_pause, rx_pause);
3025 EXPORT_SYMBOL(phy_get_pause);
3027 #if IS_ENABLED(CONFIG_OF_MDIO)
3028 static int phy_get_int_delay_property(struct device *dev, const char *name)
3033 ret = device_property_read_u32(dev, name, &int_delay);
3040 static int phy_get_int_delay_property(struct device *dev, const char *name)
3047 * phy_get_internal_delay - returns the index of the internal delay
3048 * @phydev: phy_device struct
3049 * @dev: pointer to the devices device struct
3050 * @delay_values: array of delays the PHY supports
3051 * @size: the size of the delay array
3052 * @is_rx: boolean to indicate to get the rx internal delay
3054 * Returns the index within the array of internal delay passed in.
3055 * If the device property is not present then the interface type is checked
3056 * if the interface defines use of internal delay then a 1 is returned otherwise
3058 * The array must be in ascending order. If PHY does not have an ascending order
3059 * array then size = 0 and the value of the delay property is returned.
3060 * Return -EINVAL if the delay is invalid or cannot be found.
3062 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
3063 const int *delay_values, int size, bool is_rx)
3069 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
3070 if (delay < 0 && size == 0) {
3071 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
3072 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
3079 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
3080 if (delay < 0 && size == 0) {
3081 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
3082 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
3092 if (delay && size == 0)
3095 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
3096 phydev_err(phydev, "Delay %d is out of range\n", delay);
3100 if (delay == delay_values[0])
3103 for (i = 1; i < size; i++) {
3104 if (delay == delay_values[i])
3107 /* Find an approximate index by looking up the table */
3108 if (delay > delay_values[i - 1] &&
3109 delay < delay_values[i]) {
3110 if (delay - delay_values[i - 1] <
3111 delay_values[i] - delay)
3118 phydev_err(phydev, "error finding internal delay index for %d\n",
3123 EXPORT_SYMBOL(phy_get_internal_delay);
3125 static int phy_led_set_brightness(struct led_classdev *led_cdev,
3126 enum led_brightness value)
3128 struct phy_led *phyled = to_phy_led(led_cdev);
3129 struct phy_device *phydev = phyled->phydev;
3132 mutex_lock(&phydev->lock);
3133 err = phydev->drv->led_brightness_set(phydev, phyled->index, value);
3134 mutex_unlock(&phydev->lock);
3139 static int phy_led_blink_set(struct led_classdev *led_cdev,
3140 unsigned long *delay_on,
3141 unsigned long *delay_off)
3143 struct phy_led *phyled = to_phy_led(led_cdev);
3144 struct phy_device *phydev = phyled->phydev;
3147 mutex_lock(&phydev->lock);
3148 err = phydev->drv->led_blink_set(phydev, phyled->index,
3149 delay_on, delay_off);
3150 mutex_unlock(&phydev->lock);
3155 static __maybe_unused struct device *
3156 phy_led_hw_control_get_device(struct led_classdev *led_cdev)
3158 struct phy_led *phyled = to_phy_led(led_cdev);
3159 struct phy_device *phydev = phyled->phydev;
3161 if (phydev->attached_dev)
3162 return &phydev->attached_dev->dev;
3166 static int __maybe_unused
3167 phy_led_hw_control_get(struct led_classdev *led_cdev,
3168 unsigned long *rules)
3170 struct phy_led *phyled = to_phy_led(led_cdev);
3171 struct phy_device *phydev = phyled->phydev;
3174 mutex_lock(&phydev->lock);
3175 err = phydev->drv->led_hw_control_get(phydev, phyled->index, rules);
3176 mutex_unlock(&phydev->lock);
3181 static int __maybe_unused
3182 phy_led_hw_control_set(struct led_classdev *led_cdev,
3183 unsigned long rules)
3185 struct phy_led *phyled = to_phy_led(led_cdev);
3186 struct phy_device *phydev = phyled->phydev;
3189 mutex_lock(&phydev->lock);
3190 err = phydev->drv->led_hw_control_set(phydev, phyled->index, rules);
3191 mutex_unlock(&phydev->lock);
3196 static __maybe_unused int phy_led_hw_is_supported(struct led_classdev *led_cdev,
3197 unsigned long rules)
3199 struct phy_led *phyled = to_phy_led(led_cdev);
3200 struct phy_device *phydev = phyled->phydev;
3203 mutex_lock(&phydev->lock);
3204 err = phydev->drv->led_hw_is_supported(phydev, phyled->index, rules);
3205 mutex_unlock(&phydev->lock);
3210 static void phy_leds_unregister(struct phy_device *phydev)
3212 struct phy_led *phyled;
3214 list_for_each_entry(phyled, &phydev->leds, list) {
3215 led_classdev_unregister(&phyled->led_cdev);
3219 static int of_phy_led(struct phy_device *phydev,
3220 struct device_node *led)
3222 struct device *dev = &phydev->mdio.dev;
3223 struct led_init_data init_data = {};
3224 struct led_classdev *cdev;
3225 unsigned long modes = 0;
3226 struct phy_led *phyled;
3230 phyled = devm_kzalloc(dev, sizeof(*phyled), GFP_KERNEL);
3234 cdev = &phyled->led_cdev;
3235 phyled->phydev = phydev;
3237 err = of_property_read_u32(led, "reg", &index);
3243 if (of_property_read_bool(led, "active-low"))
3244 set_bit(PHY_LED_ACTIVE_LOW, &modes);
3245 if (of_property_read_bool(led, "inactive-high-impedance"))
3246 set_bit(PHY_LED_INACTIVE_HIGH_IMPEDANCE, &modes);
3249 /* Return error if asked to set polarity modes but not supported */
3250 if (!phydev->drv->led_polarity_set)
3253 err = phydev->drv->led_polarity_set(phydev, index, modes);
3258 phyled->index = index;
3259 if (phydev->drv->led_brightness_set)
3260 cdev->brightness_set_blocking = phy_led_set_brightness;
3261 if (phydev->drv->led_blink_set)
3262 cdev->blink_set = phy_led_blink_set;
3264 #ifdef CONFIG_LEDS_TRIGGERS
3265 if (phydev->drv->led_hw_is_supported &&
3266 phydev->drv->led_hw_control_set &&
3267 phydev->drv->led_hw_control_get) {
3268 cdev->hw_control_is_supported = phy_led_hw_is_supported;
3269 cdev->hw_control_set = phy_led_hw_control_set;
3270 cdev->hw_control_get = phy_led_hw_control_get;
3271 cdev->hw_control_trigger = "netdev";
3274 cdev->hw_control_get_device = phy_led_hw_control_get_device;
3276 cdev->max_brightness = 1;
3277 init_data.devicename = dev_name(&phydev->mdio.dev);
3278 init_data.fwnode = of_fwnode_handle(led);
3279 init_data.devname_mandatory = true;
3281 err = led_classdev_register_ext(dev, cdev, &init_data);
3285 list_add(&phyled->list, &phydev->leds);
3290 static int of_phy_leds(struct phy_device *phydev)
3292 struct device_node *node = phydev->mdio.dev.of_node;
3293 struct device_node *leds, *led;
3296 if (!IS_ENABLED(CONFIG_OF_MDIO))
3302 leds = of_get_child_by_name(node, "leds");
3306 for_each_available_child_of_node(leds, led) {
3307 err = of_phy_led(phydev, led);
3310 phy_leds_unregister(phydev);
3319 * fwnode_mdio_find_device - Given a fwnode, find the mdio_device
3320 * @fwnode: pointer to the mdio_device's fwnode
3322 * If successful, returns a pointer to the mdio_device with the embedded
3323 * struct device refcount incremented by one, or NULL on failure.
3324 * The caller should call put_device() on the mdio_device after its use.
3326 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
3333 d = bus_find_device_by_fwnode(&mdio_bus_type, fwnode);
3337 return to_mdio_device(d);
3339 EXPORT_SYMBOL(fwnode_mdio_find_device);
3342 * fwnode_phy_find_device - For provided phy_fwnode, find phy_device.
3344 * @phy_fwnode: Pointer to the phy's fwnode.
3346 * If successful, returns a pointer to the phy_device with the embedded
3347 * struct device refcount incremented by one, or NULL on failure.
3349 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
3351 struct mdio_device *mdiodev;
3353 mdiodev = fwnode_mdio_find_device(phy_fwnode);
3357 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
3358 return to_phy_device(&mdiodev->dev);
3360 put_device(&mdiodev->dev);
3364 EXPORT_SYMBOL(fwnode_phy_find_device);
3367 * device_phy_find_device - For the given device, get the phy_device
3368 * @dev: Pointer to the given device
3370 * Refer return conditions of fwnode_phy_find_device().
3372 struct phy_device *device_phy_find_device(struct device *dev)
3374 return fwnode_phy_find_device(dev_fwnode(dev));
3376 EXPORT_SYMBOL_GPL(device_phy_find_device);
3379 * fwnode_get_phy_node - Get the phy_node using the named reference.
3380 * @fwnode: Pointer to fwnode from which phy_node has to be obtained.
3382 * Refer return conditions of fwnode_find_reference().
3383 * For ACPI, only "phy-handle" is supported. Legacy DT properties "phy"
3384 * and "phy-device" are not supported in ACPI. DT supports all the three
3385 * named references to the phy node.
3387 struct fwnode_handle *fwnode_get_phy_node(const struct fwnode_handle *fwnode)
3389 struct fwnode_handle *phy_node;
3391 /* Only phy-handle is used for ACPI */
3392 phy_node = fwnode_find_reference(fwnode, "phy-handle", 0);
3393 if (is_acpi_node(fwnode) || !IS_ERR(phy_node))
3395 phy_node = fwnode_find_reference(fwnode, "phy", 0);
3396 if (IS_ERR(phy_node))
3397 phy_node = fwnode_find_reference(fwnode, "phy-device", 0);
3400 EXPORT_SYMBOL_GPL(fwnode_get_phy_node);
3403 * phy_probe - probe and init a PHY device
3404 * @dev: device to probe and init
3406 * Take care of setting up the phy_device structure, set the state to READY.
3408 static int phy_probe(struct device *dev)
3410 struct phy_device *phydev = to_phy_device(dev);
3411 struct device_driver *drv = phydev->mdio.dev.driver;
3412 struct phy_driver *phydrv = to_phy_driver(drv);
3415 phydev->drv = phydrv;
3417 /* Disable the interrupt if the PHY doesn't support it
3418 * but the interrupt is still a valid one
3420 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
3421 phydev->irq = PHY_POLL;
3423 if (phydrv->flags & PHY_IS_INTERNAL)
3424 phydev->is_internal = true;
3426 /* Deassert the reset signal */
3427 phy_device_reset(phydev, 0);
3429 if (phydev->drv->probe) {
3430 err = phydev->drv->probe(phydev);
3435 phy_disable_interrupts(phydev);
3437 /* Start out supporting everything. Eventually,
3438 * a controller will attach, and may modify one
3439 * or both of these values
3441 if (phydrv->features) {
3442 linkmode_copy(phydev->supported, phydrv->features);
3443 genphy_c45_read_eee_abilities(phydev);
3445 else if (phydrv->get_features)
3446 err = phydrv->get_features(phydev);
3447 else if (phydev->is_c45)
3448 err = genphy_c45_pma_read_abilities(phydev);
3450 err = genphy_read_abilities(phydev);
3455 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
3457 phydev->autoneg = 0;
3459 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
3461 phydev->is_gigabit_capable = 1;
3462 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
3464 phydev->is_gigabit_capable = 1;
3466 of_set_phy_supported(phydev);
3467 phy_advertise_supported(phydev);
3469 /* Get PHY default EEE advertising modes and handle them as potentially
3470 * safe initial configuration.
3472 err = genphy_c45_read_eee_adv(phydev, phydev->advertising_eee);
3476 /* There is no "enabled" flag. If PHY is advertising, assume it is
3479 phydev->eee_enabled = !linkmode_empty(phydev->advertising_eee);
3481 /* Some PHYs may advertise, by default, not support EEE modes. So,
3482 * we need to clean them.
3484 if (phydev->eee_enabled)
3485 linkmode_and(phydev->advertising_eee, phydev->supported_eee,
3486 phydev->advertising_eee);
3488 /* Get the EEE modes we want to prohibit. We will ask
3489 * the PHY stop advertising these mode later on
3491 of_set_phy_eee_broken(phydev);
3493 /* The Pause Frame bits indicate that the PHY can support passing
3494 * pause frames. During autonegotiation, the PHYs will determine if
3495 * they should allow pause frames to pass. The MAC driver should then
3496 * use that result to determine whether to enable flow control via
3499 * Normally, PHY drivers should not set the Pause bits, and instead
3500 * allow phylib to do that. However, there may be some situations
3501 * (e.g. hardware erratum) where the driver wants to set only one
3504 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
3505 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
3506 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3508 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3512 /* Set the state to READY by default */
3513 phydev->state = PHY_READY;
3515 /* Get the LEDs from the device tree, and instantiate standard
3518 if (IS_ENABLED(CONFIG_PHYLIB_LEDS))
3519 err = of_phy_leds(phydev);
3522 /* Re-assert the reset signal on error */
3524 phy_device_reset(phydev, 1);
3529 static int phy_remove(struct device *dev)
3531 struct phy_device *phydev = to_phy_device(dev);
3533 cancel_delayed_work_sync(&phydev->state_queue);
3535 if (IS_ENABLED(CONFIG_PHYLIB_LEDS))
3536 phy_leds_unregister(phydev);
3538 phydev->state = PHY_DOWN;
3540 sfp_bus_del_upstream(phydev->sfp_bus);
3541 phydev->sfp_bus = NULL;
3543 if (phydev->drv && phydev->drv->remove)
3544 phydev->drv->remove(phydev);
3546 /* Assert the reset signal */
3547 phy_device_reset(phydev, 1);
3555 * phy_driver_register - register a phy_driver with the PHY layer
3556 * @new_driver: new phy_driver to register
3557 * @owner: module owning this PHY
3559 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
3563 /* Either the features are hard coded, or dynamically
3564 * determined. It cannot be both.
3566 if (WARN_ON(new_driver->features && new_driver->get_features)) {
3567 pr_err("%s: features and get_features must not both be set\n",
3572 /* PHYLIB device drivers must not match using a DT compatible table
3573 * as this bypasses our checks that the mdiodev that is being matched
3574 * is backed by a struct phy_device. If such a case happens, we will
3575 * make out-of-bounds accesses and lockup in phydev->lock.
3577 if (WARN(new_driver->mdiodrv.driver.of_match_table,
3578 "%s: driver must not provide a DT match table\n",
3582 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3583 new_driver->mdiodrv.driver.name = new_driver->name;
3584 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3585 new_driver->mdiodrv.driver.probe = phy_probe;
3586 new_driver->mdiodrv.driver.remove = phy_remove;
3587 new_driver->mdiodrv.driver.owner = owner;
3588 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3590 retval = driver_register(&new_driver->mdiodrv.driver);
3592 pr_err("%s: Error %d in registering driver\n",
3593 new_driver->name, retval);
3598 pr_debug("%s: Registered new driver\n", new_driver->name);
3602 EXPORT_SYMBOL(phy_driver_register);
3604 int phy_drivers_register(struct phy_driver *new_driver, int n,
3605 struct module *owner)
3609 for (i = 0; i < n; i++) {
3610 ret = phy_driver_register(new_driver + i, owner);
3613 phy_driver_unregister(new_driver + i);
3619 EXPORT_SYMBOL(phy_drivers_register);
3621 void phy_driver_unregister(struct phy_driver *drv)
3623 driver_unregister(&drv->mdiodrv.driver);
3625 EXPORT_SYMBOL(phy_driver_unregister);
3627 void phy_drivers_unregister(struct phy_driver *drv, int n)
3631 for (i = 0; i < n; i++)
3632 phy_driver_unregister(drv + i);
3634 EXPORT_SYMBOL(phy_drivers_unregister);
3636 static struct phy_driver genphy_driver = {
3637 .phy_id = 0xffffffff,
3638 .phy_id_mask = 0xffffffff,
3639 .name = "Generic PHY",
3640 .get_features = genphy_read_abilities,
3641 .suspend = genphy_suspend,
3642 .resume = genphy_resume,
3643 .set_loopback = genphy_loopback,
3646 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3647 .get_sset_count = phy_ethtool_get_sset_count,
3648 .get_strings = phy_ethtool_get_strings,
3649 .get_stats = phy_ethtool_get_stats,
3650 .get_plca_cfg = phy_ethtool_get_plca_cfg,
3651 .set_plca_cfg = phy_ethtool_set_plca_cfg,
3652 .get_plca_status = phy_ethtool_get_plca_status,
3653 .start_cable_test = phy_start_cable_test,
3654 .start_cable_test_tdr = phy_start_cable_test_tdr,
3657 static const struct phylib_stubs __phylib_stubs = {
3658 .hwtstamp_get = __phy_hwtstamp_get,
3659 .hwtstamp_set = __phy_hwtstamp_set,
3662 static void phylib_register_stubs(void)
3664 phylib_stubs = &__phylib_stubs;
3667 static void phylib_unregister_stubs(void)
3669 phylib_stubs = NULL;
3672 static int __init phy_init(void)
3677 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3678 phylib_register_stubs();
3681 rc = mdio_bus_init();
3683 goto err_ethtool_phy_ops;
3687 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3691 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3698 phy_driver_unregister(&genphy_c45_driver);
3701 err_ethtool_phy_ops:
3703 phylib_unregister_stubs();
3704 ethtool_set_ethtool_phy_ops(NULL);
3710 static void __exit phy_exit(void)
3712 phy_driver_unregister(&genphy_c45_driver);
3713 phy_driver_unregister(&genphy_driver);
3716 phylib_unregister_stubs();
3717 ethtool_set_ethtool_phy_ops(NULL);
3721 subsys_initcall(phy_init);
3722 module_exit(phy_exit);