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 const int phy_eee_cap2_features_array[] = {
152 ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
153 ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
156 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap2_features) __ro_after_init;
157 EXPORT_SYMBOL_GPL(phy_eee_cap2_features);
159 static void features_init(void)
161 /* 10/100 half/full*/
162 linkmode_set_bit_array(phy_basic_ports_array,
163 ARRAY_SIZE(phy_basic_ports_array),
165 linkmode_set_bit_array(phy_10_100_features_array,
166 ARRAY_SIZE(phy_10_100_features_array),
170 linkmode_set_bit_array(phy_basic_t1_features_array,
171 ARRAY_SIZE(phy_basic_t1_features_array),
172 phy_basic_t1_features);
174 /* 10 half, P2MP, TP */
175 linkmode_set_bit_array(phy_basic_t1s_p2mp_features_array,
176 ARRAY_SIZE(phy_basic_t1s_p2mp_features_array),
177 phy_basic_t1s_p2mp_features);
179 /* 10/100 half/full + 1000 half/full */
180 linkmode_set_bit_array(phy_basic_ports_array,
181 ARRAY_SIZE(phy_basic_ports_array),
183 linkmode_set_bit_array(phy_10_100_features_array,
184 ARRAY_SIZE(phy_10_100_features_array),
186 linkmode_set_bit_array(phy_gbit_features_array,
187 ARRAY_SIZE(phy_gbit_features_array),
190 /* 10/100 half/full + 1000 half/full + fibre*/
191 linkmode_set_bit_array(phy_basic_ports_array,
192 ARRAY_SIZE(phy_basic_ports_array),
193 phy_gbit_fibre_features);
194 linkmode_set_bit_array(phy_10_100_features_array,
195 ARRAY_SIZE(phy_10_100_features_array),
196 phy_gbit_fibre_features);
197 linkmode_set_bit_array(phy_gbit_features_array,
198 ARRAY_SIZE(phy_gbit_features_array),
199 phy_gbit_fibre_features);
200 linkmode_set_bit_array(phy_fibre_port_array,
201 ARRAY_SIZE(phy_fibre_port_array),
202 phy_gbit_fibre_features);
204 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
205 linkmode_set_bit_array(phy_all_ports_features_array,
206 ARRAY_SIZE(phy_all_ports_features_array),
207 phy_gbit_all_ports_features);
208 linkmode_set_bit_array(phy_10_100_features_array,
209 ARRAY_SIZE(phy_10_100_features_array),
210 phy_gbit_all_ports_features);
211 linkmode_set_bit_array(phy_gbit_features_array,
212 ARRAY_SIZE(phy_gbit_features_array),
213 phy_gbit_all_ports_features);
215 /* 10/100 half/full + 1000 half/full + 10G full*/
216 linkmode_set_bit_array(phy_all_ports_features_array,
217 ARRAY_SIZE(phy_all_ports_features_array),
218 phy_10gbit_features);
219 linkmode_set_bit_array(phy_10_100_features_array,
220 ARRAY_SIZE(phy_10_100_features_array),
221 phy_10gbit_features);
222 linkmode_set_bit_array(phy_gbit_features_array,
223 ARRAY_SIZE(phy_gbit_features_array),
224 phy_10gbit_features);
225 linkmode_set_bit_array(phy_10gbit_features_array,
226 ARRAY_SIZE(phy_10gbit_features_array),
227 phy_10gbit_features);
229 /* 10/100/1000/10G full */
230 linkmode_set_bit_array(phy_all_ports_features_array,
231 ARRAY_SIZE(phy_all_ports_features_array),
232 phy_10gbit_full_features);
233 linkmode_set_bit_array(phy_10gbit_full_features_array,
234 ARRAY_SIZE(phy_10gbit_full_features_array),
235 phy_10gbit_full_features);
237 linkmode_set_bit_array(phy_10gbit_fec_features_array,
238 ARRAY_SIZE(phy_10gbit_fec_features_array),
239 phy_10gbit_fec_features);
240 linkmode_set_bit_array(phy_eee_cap1_features_array,
241 ARRAY_SIZE(phy_eee_cap1_features_array),
242 phy_eee_cap1_features);
243 linkmode_set_bit_array(phy_eee_cap2_features_array,
244 ARRAY_SIZE(phy_eee_cap2_features_array),
245 phy_eee_cap2_features);
249 void phy_device_free(struct phy_device *phydev)
251 put_device(&phydev->mdio.dev);
253 EXPORT_SYMBOL(phy_device_free);
255 static void phy_mdio_device_free(struct mdio_device *mdiodev)
257 struct phy_device *phydev;
259 phydev = container_of(mdiodev, struct phy_device, mdio);
260 phy_device_free(phydev);
263 static void phy_device_release(struct device *dev)
265 fwnode_handle_put(dev->fwnode);
266 kfree(to_phy_device(dev));
269 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
271 struct phy_device *phydev;
273 phydev = container_of(mdiodev, struct phy_device, mdio);
274 phy_device_remove(phydev);
277 static struct phy_driver genphy_driver;
279 static LIST_HEAD(phy_fixup_list);
280 static DEFINE_MUTEX(phy_fixup_lock);
282 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
284 struct device_driver *drv = phydev->mdio.dev.driver;
285 struct phy_driver *phydrv = to_phy_driver(drv);
286 struct net_device *netdev = phydev->attached_dev;
288 if (!drv || !phydrv->suspend)
291 /* PHY not attached? May suspend if the PHY has not already been
292 * suspended as part of a prior call to phy_disconnect() ->
293 * phy_detach() -> phy_suspend() because the parent netdev might be the
294 * MDIO bus driver and clock gated at this point.
299 if (netdev->wol_enabled)
302 /* As long as not all affected network drivers support the
303 * wol_enabled flag, let's check for hints that WoL is enabled.
304 * Don't suspend PHY if the attached netdev parent may wake up.
305 * The parent may point to a PCI device, as in tg3 driver.
307 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
310 /* Also don't suspend PHY if the netdev itself may wakeup. This
311 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
314 if (device_may_wakeup(&netdev->dev))
318 return !phydev->suspended;
321 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
323 struct phy_device *phydev = to_phy_device(dev);
325 if (phydev->mac_managed_pm)
328 /* Wakeup interrupts may occur during the system sleep transition when
329 * the PHY is inaccessible. Set flag to postpone handling until the PHY
330 * has resumed. Wait for concurrent interrupt handler to complete.
332 if (phy_interrupt_is_valid(phydev)) {
333 phydev->irq_suspended = 1;
334 synchronize_irq(phydev->irq);
337 /* We must stop the state machine manually, otherwise it stops out of
338 * control, possibly with the phydev->lock held. Upon resume, netdev
339 * may call phy routines that try to grab the same lock, and that may
340 * lead to a deadlock.
342 if (phydev->attached_dev && phydev->adjust_link)
343 phy_stop_machine(phydev);
345 if (!mdio_bus_phy_may_suspend(phydev))
348 phydev->suspended_by_mdio_bus = 1;
350 return phy_suspend(phydev);
353 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
355 struct phy_device *phydev = to_phy_device(dev);
358 if (phydev->mac_managed_pm)
361 if (!phydev->suspended_by_mdio_bus)
364 phydev->suspended_by_mdio_bus = 0;
366 /* If we managed to get here with the PHY state machine in a state
367 * neither PHY_HALTED, PHY_READY nor PHY_UP, this is an indication
368 * that something went wrong and we should most likely be using
369 * MAC managed PM, but we are not.
371 WARN_ON(phydev->state != PHY_HALTED && phydev->state != PHY_READY &&
372 phydev->state != PHY_UP);
374 ret = phy_init_hw(phydev);
378 ret = phy_resume(phydev);
382 if (phy_interrupt_is_valid(phydev)) {
383 phydev->irq_suspended = 0;
384 synchronize_irq(phydev->irq);
386 /* Rerun interrupts which were postponed by phy_interrupt()
387 * because they occurred during the system sleep transition.
389 if (phydev->irq_rerun) {
390 phydev->irq_rerun = 0;
391 enable_irq(phydev->irq);
392 irq_wake_thread(phydev->irq, phydev);
396 if (phydev->attached_dev && phydev->adjust_link)
397 phy_start_machine(phydev);
402 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
403 mdio_bus_phy_resume);
406 * phy_register_fixup - creates a new phy_fixup and adds it to the list
407 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
408 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
409 * It can also be PHY_ANY_UID
410 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
412 * @run: The actual code to be run when a matching PHY is found
414 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
415 int (*run)(struct phy_device *))
417 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
422 strscpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
423 fixup->phy_uid = phy_uid;
424 fixup->phy_uid_mask = phy_uid_mask;
427 mutex_lock(&phy_fixup_lock);
428 list_add_tail(&fixup->list, &phy_fixup_list);
429 mutex_unlock(&phy_fixup_lock);
433 EXPORT_SYMBOL(phy_register_fixup);
435 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
436 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
437 int (*run)(struct phy_device *))
439 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
441 EXPORT_SYMBOL(phy_register_fixup_for_uid);
443 /* Registers a fixup to be run on the PHY with id string bus_id */
444 int phy_register_fixup_for_id(const char *bus_id,
445 int (*run)(struct phy_device *))
447 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
449 EXPORT_SYMBOL(phy_register_fixup_for_id);
452 * phy_unregister_fixup - remove a phy_fixup from the list
453 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
454 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
455 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
457 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
459 struct list_head *pos, *n;
460 struct phy_fixup *fixup;
465 mutex_lock(&phy_fixup_lock);
466 list_for_each_safe(pos, n, &phy_fixup_list) {
467 fixup = list_entry(pos, struct phy_fixup, list);
469 if ((!strcmp(fixup->bus_id, bus_id)) &&
470 phy_id_compare(fixup->phy_uid, phy_uid, phy_uid_mask)) {
471 list_del(&fixup->list);
477 mutex_unlock(&phy_fixup_lock);
481 EXPORT_SYMBOL(phy_unregister_fixup);
483 /* Unregisters a fixup of any PHY with the UID in phy_uid */
484 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
486 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
488 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
490 /* Unregisters a fixup of the PHY with id string bus_id */
491 int phy_unregister_fixup_for_id(const char *bus_id)
493 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
495 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
497 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
498 * Fixups can be set to match any in one or more fields.
500 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
502 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
503 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
506 if (!phy_id_compare(phydev->phy_id, fixup->phy_uid,
507 fixup->phy_uid_mask))
508 if (fixup->phy_uid != PHY_ANY_UID)
514 /* Runs any matching fixups for this phydev */
515 static int phy_scan_fixups(struct phy_device *phydev)
517 struct phy_fixup *fixup;
519 mutex_lock(&phy_fixup_lock);
520 list_for_each_entry(fixup, &phy_fixup_list, list) {
521 if (phy_needs_fixup(phydev, fixup)) {
522 int err = fixup->run(phydev);
525 mutex_unlock(&phy_fixup_lock);
528 phydev->has_fixups = true;
531 mutex_unlock(&phy_fixup_lock);
536 static int phy_bus_match(struct device *dev, struct device_driver *drv)
538 struct phy_device *phydev = to_phy_device(dev);
539 struct phy_driver *phydrv = to_phy_driver(drv);
540 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
543 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
546 if (phydrv->match_phy_device)
547 return phydrv->match_phy_device(phydev);
549 if (phydev->is_c45) {
550 for (i = 1; i < num_ids; i++) {
551 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
554 if (phy_id_compare(phydev->c45_ids.device_ids[i],
555 phydrv->phy_id, phydrv->phy_id_mask))
560 return phy_id_compare(phydev->phy_id, phydrv->phy_id,
561 phydrv->phy_id_mask);
566 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
568 struct phy_device *phydev = to_phy_device(dev);
570 return sysfs_emit(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
572 static DEVICE_ATTR_RO(phy_id);
575 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
577 struct phy_device *phydev = to_phy_device(dev);
578 const char *mode = NULL;
580 if (phy_is_internal(phydev))
583 mode = phy_modes(phydev->interface);
585 return sysfs_emit(buf, "%s\n", mode);
587 static DEVICE_ATTR_RO(phy_interface);
590 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
593 struct phy_device *phydev = to_phy_device(dev);
595 return sysfs_emit(buf, "%d\n", phydev->has_fixups);
597 static DEVICE_ATTR_RO(phy_has_fixups);
599 static ssize_t phy_dev_flags_show(struct device *dev,
600 struct device_attribute *attr,
603 struct phy_device *phydev = to_phy_device(dev);
605 return sysfs_emit(buf, "0x%08x\n", phydev->dev_flags);
607 static DEVICE_ATTR_RO(phy_dev_flags);
609 static struct attribute *phy_dev_attrs[] = {
610 &dev_attr_phy_id.attr,
611 &dev_attr_phy_interface.attr,
612 &dev_attr_phy_has_fixups.attr,
613 &dev_attr_phy_dev_flags.attr,
616 ATTRIBUTE_GROUPS(phy_dev);
618 static const struct device_type mdio_bus_phy_type = {
620 .groups = phy_dev_groups,
621 .release = phy_device_release,
622 .pm = pm_ptr(&mdio_bus_phy_pm_ops),
625 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
629 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
630 MDIO_ID_ARGS(phy_id));
631 /* We only check for failures in executing the usermode binary,
632 * not whether a PHY driver module exists for the PHY ID.
633 * Accept -ENOENT because this may occur in case no initramfs exists,
634 * then modprobe isn't available.
636 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
637 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
638 ret, (unsigned long)phy_id);
645 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
647 struct phy_c45_device_ids *c45_ids)
649 struct phy_device *dev;
650 struct mdio_device *mdiodev;
653 /* We allocate the device, and initialize the default values */
654 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
656 return ERR_PTR(-ENOMEM);
658 mdiodev = &dev->mdio;
659 mdiodev->dev.parent = &bus->dev;
660 mdiodev->dev.bus = &mdio_bus_type;
661 mdiodev->dev.type = &mdio_bus_phy_type;
663 mdiodev->bus_match = phy_bus_match;
664 mdiodev->addr = addr;
665 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
666 mdiodev->device_free = phy_mdio_device_free;
667 mdiodev->device_remove = phy_mdio_device_remove;
668 mdiodev->reset_state = -1;
670 dev->speed = SPEED_UNKNOWN;
671 dev->duplex = DUPLEX_UNKNOWN;
676 dev->interface = PHY_INTERFACE_MODE_GMII;
678 dev->autoneg = AUTONEG_ENABLE;
680 dev->pma_extable = -ENODATA;
681 dev->is_c45 = is_c45;
682 dev->phy_id = phy_id;
684 dev->c45_ids = *c45_ids;
685 dev->irq = bus->irq[addr];
687 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
688 device_initialize(&mdiodev->dev);
690 dev->state = PHY_DOWN;
691 INIT_LIST_HEAD(&dev->leds);
693 mutex_init(&dev->lock);
694 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
696 /* Request the appropriate module unconditionally; don't
697 * bother trying to do so only if it isn't already loaded,
698 * because that gets complicated. A hotplug event would have
699 * done an unconditional modprobe anyway.
700 * We don't do normal hotplug because it won't work for MDIO
701 * -- because it relies on the device staying around for long
702 * enough for the driver to get loaded. With MDIO, the NIC
703 * driver will get bored and give up as soon as it finds that
704 * there's no driver _already_ loaded.
706 if (is_c45 && c45_ids) {
707 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
710 for (i = 1; i < num_ids; i++) {
711 if (c45_ids->device_ids[i] == 0xffffffff)
714 ret = phy_request_driver_module(dev,
715 c45_ids->device_ids[i]);
720 ret = phy_request_driver_module(dev, phy_id);
724 put_device(&mdiodev->dev);
730 EXPORT_SYMBOL(phy_device_create);
732 /* phy_c45_probe_present - checks to see if a MMD is present in the package
733 * @bus: the target MII bus
734 * @prtad: PHY package address on the MII bus
735 * @devad: PHY device (MMD) address
737 * Read the MDIO_STAT2 register, and check whether a device is responding
740 * Returns: negative error number on bus access error, zero if no device
741 * is responding, or positive if a device is present.
743 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
747 stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
751 return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
754 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
755 * @bus: the target MII bus
756 * @addr: PHY address on the MII bus
757 * @dev_addr: MMD address in the PHY.
758 * @devices_in_package: where to store the devices in package information.
760 * Description: reads devices in package registers of a MMD at @dev_addr
761 * from PHY at @addr on @bus.
763 * Returns: 0 on success, -EIO on failure.
765 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
766 u32 *devices_in_package)
770 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
773 *devices_in_package = phy_reg << 16;
775 phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
778 *devices_in_package |= phy_reg;
784 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
785 * @bus: the target MII bus
786 * @addr: PHY address on the MII bus
787 * @c45_ids: where to store the c45 ID information.
789 * Read the PHY "devices in package". If this appears to be valid, read
790 * the PHY identifiers for each device. Return the "devices in package"
791 * and identifiers in @c45_ids.
793 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
794 * the "devices in package" is invalid or no device responds.
796 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
797 struct phy_c45_device_ids *c45_ids)
799 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
803 /* Find first non-zero Devices In package. Device zero is reserved
804 * for 802.3 c45 complied PHYs, so don't probe it at first.
806 for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
807 (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
808 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
809 /* Check that there is a device present at this
810 * address before reading the devices-in-package
811 * register to avoid reading garbage from the PHY.
812 * Some PHYs (88x3310) vendor space is not IEEE802.3
815 ret = phy_c45_probe_present(bus, addr, i);
817 /* returning -ENODEV doesn't stop bus
820 return (phy_reg == -EIO ||
821 phy_reg == -ENODEV) ? -ENODEV : -EIO;
826 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
831 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
832 /* If mostly Fs, there is no device there, then let's probe
833 * MMD 0, as some 10G PHYs have zero Devices In package,
834 * e.g. Cortina CS4315/CS4340 PHY.
836 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
840 /* no device there, let's get out of here */
841 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
845 /* Now probe Device Identifiers for each device present. */
846 for (i = 1; i < num_ids; i++) {
847 if (!(devs_in_pkg & (1 << i)))
850 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
851 /* Probe the "Device Present" bits for the vendor MMDs
852 * to ignore these if they do not contain IEEE 802.3
855 ret = phy_c45_probe_present(bus, addr, i);
863 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
866 c45_ids->device_ids[i] = phy_reg << 16;
868 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
871 c45_ids->device_ids[i] |= phy_reg;
874 c45_ids->devices_in_package = devs_in_pkg;
875 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
876 c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
882 * get_phy_c22_id - reads the specified addr for its clause 22 ID.
883 * @bus: the target MII bus
884 * @addr: PHY address on the MII bus
885 * @phy_id: where to store the ID retrieved.
887 * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
888 * placing it in @phy_id. Return zero on successful read and the ID is
889 * valid, %-EIO on bus access error, or %-ENODEV if no device responds
892 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
896 /* Grab the bits from PHYIR1, and put them in the upper half */
897 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
899 /* returning -ENODEV doesn't stop bus scanning */
900 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
903 *phy_id = phy_reg << 16;
905 /* Grab the bits from PHYIR2, and put them in the lower half */
906 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
908 /* returning -ENODEV doesn't stop bus scanning */
909 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
914 /* If the phy_id is mostly Fs, there is no device there */
915 if ((*phy_id & 0x1fffffff) == 0x1fffffff)
921 /* Extract the phy ID from the compatible string of the form
922 * ethernet-phy-idAAAA.BBBB.
924 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
926 unsigned int upper, lower;
930 ret = fwnode_property_read_string(fwnode, "compatible", &cp);
934 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) != 2)
937 *phy_id = ((upper & GENMASK(15, 0)) << 16) | (lower & GENMASK(15, 0));
940 EXPORT_SYMBOL(fwnode_get_phy_id);
943 * get_phy_device - reads the specified PHY device and returns its @phy_device
945 * @bus: the target MII bus
946 * @addr: PHY address on the MII bus
947 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
949 * Probe for a PHY at @addr on @bus.
951 * When probing for a clause 22 PHY, then read the ID registers. If we find
952 * a valid ID, allocate and return a &struct phy_device.
954 * When probing for a clause 45 PHY, read the "devices in package" registers.
955 * If the "devices in package" appears valid, read the ID registers for each
956 * MMD, allocate and return a &struct phy_device.
958 * Returns an allocated &struct phy_device on success, %-ENODEV if there is
959 * no PHY present, or %-EIO on bus access error.
961 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
963 struct phy_c45_device_ids c45_ids;
967 c45_ids.devices_in_package = 0;
968 c45_ids.mmds_present = 0;
969 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
972 r = get_phy_c45_ids(bus, addr, &c45_ids);
974 r = get_phy_c22_id(bus, addr, &phy_id);
979 /* PHY device such as the Marvell Alaska 88E2110 will return a PHY ID
980 * of 0 when probed using get_phy_c22_id() with no error. Proceed to
981 * probe with C45 to see if we're able to get a valid PHY ID in the C45
982 * space, if successful, create the C45 PHY device.
984 if (!is_c45 && phy_id == 0 && bus->read_c45) {
985 r = get_phy_c45_ids(bus, addr, &c45_ids);
987 return phy_device_create(bus, addr, phy_id,
991 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
993 EXPORT_SYMBOL(get_phy_device);
996 * phy_device_register - Register the phy device on the MDIO bus
997 * @phydev: phy_device structure to be added to the MDIO bus
999 int phy_device_register(struct phy_device *phydev)
1003 err = mdiobus_register_device(&phydev->mdio);
1007 /* Deassert the reset signal */
1008 phy_device_reset(phydev, 0);
1010 /* Run all of the fixups for this PHY */
1011 err = phy_scan_fixups(phydev);
1013 phydev_err(phydev, "failed to initialize\n");
1017 err = device_add(&phydev->mdio.dev);
1019 phydev_err(phydev, "failed to add\n");
1026 /* Assert the reset signal */
1027 phy_device_reset(phydev, 1);
1029 mdiobus_unregister_device(&phydev->mdio);
1032 EXPORT_SYMBOL(phy_device_register);
1035 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
1036 * @phydev: phy_device structure to remove
1038 * This doesn't free the phy_device itself, it merely reverses the effects
1039 * of phy_device_register(). Use phy_device_free() to free the device
1040 * after calling this function.
1042 void phy_device_remove(struct phy_device *phydev)
1044 unregister_mii_timestamper(phydev->mii_ts);
1045 pse_control_put(phydev->psec);
1047 device_del(&phydev->mdio.dev);
1049 /* Assert the reset signal */
1050 phy_device_reset(phydev, 1);
1052 mdiobus_unregister_device(&phydev->mdio);
1054 EXPORT_SYMBOL(phy_device_remove);
1057 * phy_get_c45_ids - Read 802.3-c45 IDs for phy device.
1058 * @phydev: phy_device structure to read 802.3-c45 IDs
1060 * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
1061 * the "devices in package" is invalid.
1063 int phy_get_c45_ids(struct phy_device *phydev)
1065 return get_phy_c45_ids(phydev->mdio.bus, phydev->mdio.addr,
1068 EXPORT_SYMBOL(phy_get_c45_ids);
1071 * phy_find_first - finds the first PHY device on the bus
1072 * @bus: the target MII bus
1074 struct phy_device *phy_find_first(struct mii_bus *bus)
1076 struct phy_device *phydev;
1079 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
1080 phydev = mdiobus_get_phy(bus, addr);
1086 EXPORT_SYMBOL(phy_find_first);
1088 static void phy_link_change(struct phy_device *phydev, bool up)
1090 struct net_device *netdev = phydev->attached_dev;
1093 netif_carrier_on(netdev);
1095 netif_carrier_off(netdev);
1096 phydev->adjust_link(netdev);
1097 if (phydev->mii_ts && phydev->mii_ts->link_state)
1098 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
1102 * phy_prepare_link - prepares the PHY layer to monitor link status
1103 * @phydev: target phy_device struct
1104 * @handler: callback function for link status change notifications
1106 * Description: Tells the PHY infrastructure to handle the
1107 * gory details on monitoring link status (whether through
1108 * polling or an interrupt), and to call back to the
1109 * connected device driver when the link status changes.
1110 * If you want to monitor your own link state, don't call
1113 static void phy_prepare_link(struct phy_device *phydev,
1114 void (*handler)(struct net_device *))
1116 phydev->adjust_link = handler;
1120 * phy_connect_direct - connect an ethernet device to a specific phy_device
1121 * @dev: the network device to connect
1122 * @phydev: the pointer to the phy device
1123 * @handler: callback function for state change notifications
1124 * @interface: PHY device's interface
1126 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1127 void (*handler)(struct net_device *),
1128 phy_interface_t interface)
1135 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1139 phy_prepare_link(phydev, handler);
1140 if (phy_interrupt_is_valid(phydev))
1141 phy_request_interrupt(phydev);
1145 EXPORT_SYMBOL(phy_connect_direct);
1148 * phy_connect - connect an ethernet device to a PHY device
1149 * @dev: the network device to connect
1150 * @bus_id: the id string of the PHY device to connect
1151 * @handler: callback function for state change notifications
1152 * @interface: PHY device's interface
1154 * Description: Convenience function for connecting ethernet
1155 * devices to PHY devices. The default behavior is for
1156 * the PHY infrastructure to handle everything, and only notify
1157 * the connected driver when the link status changes. If you
1158 * don't want, or can't use the provided functionality, you may
1159 * choose to call only the subset of functions which provide
1160 * the desired functionality.
1162 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1163 void (*handler)(struct net_device *),
1164 phy_interface_t interface)
1166 struct phy_device *phydev;
1170 /* Search the list of PHY devices on the mdio bus for the
1171 * PHY with the requested name
1173 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1175 pr_err("PHY %s not found\n", bus_id);
1176 return ERR_PTR(-ENODEV);
1178 phydev = to_phy_device(d);
1180 rc = phy_connect_direct(dev, phydev, handler, interface);
1187 EXPORT_SYMBOL(phy_connect);
1190 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1192 * @phydev: target phy_device struct
1194 void phy_disconnect(struct phy_device *phydev)
1196 if (phy_is_started(phydev))
1199 if (phy_interrupt_is_valid(phydev))
1200 phy_free_interrupt(phydev);
1202 phydev->adjust_link = NULL;
1206 EXPORT_SYMBOL(phy_disconnect);
1209 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1210 * @phydev: The PHY device to poll
1212 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1213 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1214 * register must be polled until the BMCR_RESET bit clears.
1216 * Furthermore, any attempts to write to PHY registers may have no effect
1217 * or even generate MDIO bus errors until this is complete.
1219 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1220 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1221 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1222 * effort to support such broken PHYs, this function is separate from the
1223 * standard phy_init_hw() which will zero all the other bits in the BMCR
1224 * and reapply all driver-specific and board-specific fixups.
1226 static int phy_poll_reset(struct phy_device *phydev)
1228 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1231 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1232 50000, 600000, true);
1235 /* Some chips (smsc911x) may still need up to another 1ms after the
1236 * BMCR_RESET bit is cleared before they are usable.
1242 int phy_init_hw(struct phy_device *phydev)
1246 /* Deassert the reset signal */
1247 phy_device_reset(phydev, 0);
1252 if (phydev->drv->soft_reset) {
1253 ret = phydev->drv->soft_reset(phydev);
1257 /* see comment in genphy_soft_reset for an explanation */
1258 phydev->suspended = 0;
1261 ret = phy_scan_fixups(phydev);
1265 phy_interface_zero(phydev->possible_interfaces);
1267 if (phydev->drv->config_init) {
1268 ret = phydev->drv->config_init(phydev);
1273 if (phydev->drv->config_intr) {
1274 ret = phydev->drv->config_intr(phydev);
1281 EXPORT_SYMBOL(phy_init_hw);
1283 void phy_attached_info(struct phy_device *phydev)
1285 phy_attached_print(phydev, NULL);
1287 EXPORT_SYMBOL(phy_attached_info);
1289 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1290 char *phy_attached_info_irq(struct phy_device *phydev)
1295 switch(phydev->irq) {
1299 case PHY_MAC_INTERRUPT:
1303 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1308 return kasprintf(GFP_KERNEL, "%s", irq_str);
1310 EXPORT_SYMBOL(phy_attached_info_irq);
1312 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1314 const char *unbound = phydev->drv ? "" : "[unbound] ";
1315 char *irq_str = phy_attached_info_irq(phydev);
1318 phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1319 phydev_name(phydev), irq_str);
1323 phydev_info(phydev, ATTACHED_FMT, unbound,
1324 phydev_name(phydev), irq_str);
1332 EXPORT_SYMBOL(phy_attached_print);
1334 static void phy_sysfs_create_links(struct phy_device *phydev)
1336 struct net_device *dev = phydev->attached_dev;
1342 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1347 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1348 &phydev->mdio.dev.kobj,
1351 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1352 kobject_name(&phydev->mdio.dev.kobj),
1354 /* non-fatal - some net drivers can use one netdevice
1355 * with more then one phy
1359 phydev->sysfs_links = true;
1363 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1366 struct phy_device *phydev = to_phy_device(dev);
1368 return sysfs_emit(buf, "%d\n", !phydev->attached_dev);
1370 static DEVICE_ATTR_RO(phy_standalone);
1373 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1374 * @upstream: pointer to the phy device
1375 * @bus: sfp bus representing cage being attached
1377 * This is used to fill in the sfp_upstream_ops .attach member.
1379 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1381 struct phy_device *phydev = upstream;
1383 if (phydev->attached_dev)
1384 phydev->attached_dev->sfp_bus = bus;
1385 phydev->sfp_bus_attached = true;
1387 EXPORT_SYMBOL(phy_sfp_attach);
1390 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1391 * @upstream: pointer to the phy device
1392 * @bus: sfp bus representing cage being attached
1394 * This is used to fill in the sfp_upstream_ops .detach member.
1396 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1398 struct phy_device *phydev = upstream;
1400 if (phydev->attached_dev)
1401 phydev->attached_dev->sfp_bus = NULL;
1402 phydev->sfp_bus_attached = false;
1404 EXPORT_SYMBOL(phy_sfp_detach);
1407 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1408 * @phydev: Pointer to phy_device
1409 * @ops: SFP's upstream operations
1411 int phy_sfp_probe(struct phy_device *phydev,
1412 const struct sfp_upstream_ops *ops)
1414 struct sfp_bus *bus;
1417 if (phydev->mdio.dev.fwnode) {
1418 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1420 return PTR_ERR(bus);
1422 phydev->sfp_bus = bus;
1424 ret = sfp_bus_add_upstream(bus, phydev, ops);
1429 EXPORT_SYMBOL(phy_sfp_probe);
1431 static bool phy_drv_supports_irq(const struct phy_driver *phydrv)
1433 return phydrv->config_intr && phydrv->handle_interrupt;
1437 * phy_attach_direct - attach a network device to a given PHY device pointer
1438 * @dev: network device to attach
1439 * @phydev: Pointer to phy_device to attach
1440 * @flags: PHY device's dev_flags
1441 * @interface: PHY device's interface
1443 * Description: Called by drivers to attach to a particular PHY
1444 * device. The phy_device is found, and properly hooked up
1445 * to the phy_driver. If no driver is attached, then a
1446 * generic driver is used. The phy_device is given a ptr to
1447 * the attaching device, and given a callback for link status
1448 * change. The phy_device is returned to the attaching driver.
1449 * This function takes a reference on the phy device.
1451 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1452 u32 flags, phy_interface_t interface)
1454 struct mii_bus *bus = phydev->mdio.bus;
1455 struct device *d = &phydev->mdio.dev;
1456 struct module *ndev_owner = NULL;
1457 bool using_genphy = false;
1460 /* For Ethernet device drivers that register their own MDIO bus, we
1461 * will have bus->owner match ndev_mod, so we do not want to increment
1462 * our own module->refcnt here, otherwise we would not be able to
1466 ndev_owner = dev->dev.parent->driver->owner;
1467 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1468 phydev_err(phydev, "failed to get the bus module\n");
1474 /* Assume that if there is no driver, that it doesn't
1475 * exist, and we should use the genphy driver.
1479 d->driver = &genphy_c45_driver.mdiodrv.driver;
1481 d->driver = &genphy_driver.mdiodrv.driver;
1483 using_genphy = true;
1486 if (!try_module_get(d->driver->owner)) {
1487 phydev_err(phydev, "failed to get the device driver module\n");
1489 goto error_put_device;
1493 err = d->driver->probe(d);
1495 err = device_bind_driver(d);
1498 goto error_module_put;
1501 if (phydev->attached_dev) {
1502 dev_err(&dev->dev, "PHY already attached\n");
1507 phydev->phy_link_change = phy_link_change;
1509 phydev->attached_dev = dev;
1510 dev->phydev = phydev;
1512 if (phydev->sfp_bus_attached)
1513 dev->sfp_bus = phydev->sfp_bus;
1516 /* Some Ethernet drivers try to connect to a PHY device before
1517 * calling register_netdevice() -> netdev_register_kobject() and
1518 * does the dev->dev.kobj initialization. Here we only check for
1519 * success which indicates that the network device kobject is
1520 * ready. Once we do that we still need to keep track of whether
1521 * links were successfully set up or not for phy_detach() to
1522 * remove them accordingly.
1524 phydev->sysfs_links = false;
1526 phy_sysfs_create_links(phydev);
1528 if (!phydev->attached_dev) {
1529 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1530 &dev_attr_phy_standalone.attr);
1532 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1535 phydev->dev_flags |= flags;
1537 phydev->interface = interface;
1539 phydev->state = PHY_READY;
1541 phydev->interrupts = PHY_INTERRUPT_DISABLED;
1543 /* PHYs can request to use poll mode even though they have an
1544 * associated interrupt line. This could be the case if they
1545 * detect a broken interrupt handling.
1547 if (phydev->dev_flags & PHY_F_NO_IRQ)
1548 phydev->irq = PHY_POLL;
1550 if (!phy_drv_supports_irq(phydev->drv) && phy_interrupt_is_valid(phydev))
1551 phydev->irq = PHY_POLL;
1553 /* Port is set to PORT_TP by default and the actual PHY driver will set
1554 * it to different value depending on the PHY configuration. If we have
1555 * the generic PHY driver we can't figure it out, thus set the old
1556 * legacy PORT_MII value.
1559 phydev->port = PORT_MII;
1561 /* Initial carrier state is off as the phy is about to be
1565 netif_carrier_off(phydev->attached_dev);
1567 /* Do initial configuration here, now that
1568 * we have certain key parameters
1569 * (dev_flags and interface)
1571 err = phy_init_hw(phydev);
1576 if (!phydev->is_on_sfp_module)
1577 phy_led_triggers_register(phydev);
1580 * If the external phy used by current mac interface is managed by
1581 * another mac interface, so we should create a device link between
1582 * phy dev and mac dev.
1584 if (dev && phydev->mdio.bus->parent && dev->dev.parent != phydev->mdio.bus->parent)
1585 phydev->devlink = device_link_add(dev->dev.parent, &phydev->mdio.dev,
1586 DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS);
1591 /* phy_detach() does all of the cleanup below */
1596 module_put(d->driver->owner);
1600 if (ndev_owner != bus->owner)
1601 module_put(bus->owner);
1604 EXPORT_SYMBOL(phy_attach_direct);
1607 * phy_attach - attach a network device to a particular PHY device
1608 * @dev: network device to attach
1609 * @bus_id: Bus ID of PHY device to attach
1610 * @interface: PHY device's interface
1612 * Description: Same as phy_attach_direct() except that a PHY bus_id
1613 * string is passed instead of a pointer to a struct phy_device.
1615 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1616 phy_interface_t interface)
1618 struct phy_device *phydev;
1623 return ERR_PTR(-EINVAL);
1625 /* Search the list of PHY devices on the mdio bus for the
1626 * PHY with the requested name
1628 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1630 pr_err("PHY %s not found\n", bus_id);
1631 return ERR_PTR(-ENODEV);
1633 phydev = to_phy_device(d);
1635 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1642 EXPORT_SYMBOL(phy_attach);
1644 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1645 struct device_driver *driver)
1647 struct device *d = &phydev->mdio.dev;
1654 ret = d->driver == driver;
1660 bool phy_driver_is_genphy(struct phy_device *phydev)
1662 return phy_driver_is_genphy_kind(phydev,
1663 &genphy_driver.mdiodrv.driver);
1665 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1667 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1669 return phy_driver_is_genphy_kind(phydev,
1670 &genphy_c45_driver.mdiodrv.driver);
1672 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1675 * phy_package_join - join a common PHY group
1676 * @phydev: target phy_device struct
1677 * @base_addr: cookie and base PHY address of PHY package for offset
1678 * calculation of global register access
1679 * @priv_size: if non-zero allocate this amount of bytes for private data
1681 * This joins a PHY group and provides a shared storage for all phydevs in
1682 * this group. This is intended to be used for packages which contain
1683 * more than one PHY, for example a quad PHY transceiver.
1685 * The base_addr parameter serves as cookie which has to have the same values
1686 * for all members of one group and as the base PHY address of the PHY package
1687 * for offset calculation to access generic registers of a PHY package.
1688 * Usually, one of the PHY addresses of the different PHYs in the package
1689 * provides access to these global registers.
1690 * The address which is given here, will be used in the phy_package_read()
1691 * and phy_package_write() convenience functions as base and added to the
1692 * passed offset in those functions.
1694 * This will set the shared pointer of the phydev to the shared storage.
1695 * If this is the first call for a this cookie the shared storage will be
1696 * allocated. If priv_size is non-zero, the given amount of bytes are
1697 * allocated for the priv member.
1699 * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1700 * with the same cookie but a different priv_size is an error.
1702 int phy_package_join(struct phy_device *phydev, int base_addr, size_t priv_size)
1704 struct mii_bus *bus = phydev->mdio.bus;
1705 struct phy_package_shared *shared;
1708 if (base_addr < 0 || base_addr >= PHY_MAX_ADDR)
1711 mutex_lock(&bus->shared_lock);
1712 shared = bus->shared[base_addr];
1715 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1719 shared->priv = kzalloc(priv_size, GFP_KERNEL);
1722 shared->priv_size = priv_size;
1724 shared->base_addr = base_addr;
1726 refcount_set(&shared->refcnt, 1);
1727 bus->shared[base_addr] = shared;
1730 if (priv_size && priv_size != shared->priv_size)
1732 refcount_inc(&shared->refcnt);
1734 mutex_unlock(&bus->shared_lock);
1736 phydev->shared = shared;
1743 mutex_unlock(&bus->shared_lock);
1746 EXPORT_SYMBOL_GPL(phy_package_join);
1749 * of_phy_package_join - join a common PHY group in PHY package
1750 * @phydev: target phy_device struct
1751 * @priv_size: if non-zero allocate this amount of bytes for private data
1753 * This is a variant of phy_package_join for PHY package defined in DT.
1755 * The parent node of the @phydev is checked as a valid PHY package node
1756 * structure (by matching the node name "ethernet-phy-package") and the
1757 * base_addr for the PHY package is passed to phy_package_join.
1759 * With this configuration the shared struct will also have the np value
1760 * filled to use additional DT defined properties in PHY specific
1761 * probe_once and config_init_once PHY package OPs.
1763 * Returns < 0 on error, 0 on success. Esp. calling phy_package_join()
1764 * with the same cookie but a different priv_size is an error. Or a parent
1765 * node is not detected or is not valid or doesn't match the expected node
1766 * name for PHY package.
1768 int of_phy_package_join(struct phy_device *phydev, size_t priv_size)
1770 struct device_node *node = phydev->mdio.dev.of_node;
1771 struct device_node *package_node;
1778 package_node = of_get_parent(node);
1782 if (!of_node_name_eq(package_node, "ethernet-phy-package")) {
1787 if (of_property_read_u32(package_node, "reg", &base_addr)) {
1792 ret = phy_package_join(phydev, base_addr, priv_size);
1796 phydev->shared->np = package_node;
1800 of_node_put(package_node);
1803 EXPORT_SYMBOL_GPL(of_phy_package_join);
1806 * phy_package_leave - leave a common PHY group
1807 * @phydev: target phy_device struct
1809 * This leaves a PHY group created by phy_package_join(). If this phydev
1810 * was the last user of the shared data between the group, this data is
1811 * freed. Resets the phydev->shared pointer to NULL.
1813 void phy_package_leave(struct phy_device *phydev)
1815 struct phy_package_shared *shared = phydev->shared;
1816 struct mii_bus *bus = phydev->mdio.bus;
1821 /* Decrease the node refcount on leave if present */
1823 of_node_put(shared->np);
1825 if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1826 bus->shared[shared->base_addr] = NULL;
1827 mutex_unlock(&bus->shared_lock);
1828 kfree(shared->priv);
1832 phydev->shared = NULL;
1834 EXPORT_SYMBOL_GPL(phy_package_leave);
1836 static void devm_phy_package_leave(struct device *dev, void *res)
1838 phy_package_leave(*(struct phy_device **)res);
1842 * devm_phy_package_join - resource managed phy_package_join()
1843 * @dev: device that is registering this PHY package
1844 * @phydev: target phy_device struct
1845 * @base_addr: cookie and base PHY address of PHY package for offset
1846 * calculation of global register access
1847 * @priv_size: if non-zero allocate this amount of bytes for private data
1849 * Managed phy_package_join(). Shared storage fetched by this function,
1850 * phy_package_leave() is automatically called on driver detach. See
1851 * phy_package_join() for more information.
1853 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1854 int base_addr, size_t priv_size)
1856 struct phy_device **ptr;
1859 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1864 ret = phy_package_join(phydev, base_addr, priv_size);
1868 devres_add(dev, ptr);
1875 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1878 * devm_of_phy_package_join - resource managed of_phy_package_join()
1879 * @dev: device that is registering this PHY package
1880 * @phydev: target phy_device struct
1881 * @priv_size: if non-zero allocate this amount of bytes for private data
1883 * Managed of_phy_package_join(). Shared storage fetched by this function,
1884 * phy_package_leave() is automatically called on driver detach. See
1885 * of_phy_package_join() for more information.
1887 int devm_of_phy_package_join(struct device *dev, struct phy_device *phydev,
1890 struct phy_device **ptr;
1893 ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1898 ret = of_phy_package_join(phydev, priv_size);
1902 devres_add(dev, ptr);
1909 EXPORT_SYMBOL_GPL(devm_of_phy_package_join);
1912 * phy_detach - detach a PHY device from its network device
1913 * @phydev: target phy_device struct
1915 * This detaches the phy device from its network device and the phy
1916 * driver, and drops the reference count taken in phy_attach_direct().
1918 void phy_detach(struct phy_device *phydev)
1920 struct net_device *dev = phydev->attached_dev;
1921 struct module *ndev_owner = NULL;
1922 struct mii_bus *bus;
1924 if (phydev->devlink)
1925 device_link_del(phydev->devlink);
1927 if (phydev->sysfs_links) {
1929 sysfs_remove_link(&dev->dev.kobj, "phydev");
1930 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1933 if (!phydev->attached_dev)
1934 sysfs_remove_file(&phydev->mdio.dev.kobj,
1935 &dev_attr_phy_standalone.attr);
1937 phy_suspend(phydev);
1939 phydev->attached_dev->phydev = NULL;
1940 phydev->attached_dev = NULL;
1942 phydev->phylink = NULL;
1944 if (!phydev->is_on_sfp_module)
1945 phy_led_triggers_unregister(phydev);
1947 if (phydev->mdio.dev.driver)
1948 module_put(phydev->mdio.dev.driver->owner);
1950 /* If the device had no specific driver before (i.e. - it
1951 * was using the generic driver), we unbind the device
1952 * from the generic driver so that there's a chance a
1953 * real driver could be loaded
1955 if (phy_driver_is_genphy(phydev) ||
1956 phy_driver_is_genphy_10g(phydev))
1957 device_release_driver(&phydev->mdio.dev);
1959 /* Assert the reset signal */
1960 phy_device_reset(phydev, 1);
1963 * The phydev might go away on the put_device() below, so avoid
1964 * a use-after-free bug by reading the underlying bus first.
1966 bus = phydev->mdio.bus;
1968 put_device(&phydev->mdio.dev);
1970 ndev_owner = dev->dev.parent->driver->owner;
1971 if (ndev_owner != bus->owner)
1972 module_put(bus->owner);
1974 EXPORT_SYMBOL(phy_detach);
1976 int phy_suspend(struct phy_device *phydev)
1978 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1979 struct net_device *netdev = phydev->attached_dev;
1980 const struct phy_driver *phydrv = phydev->drv;
1983 if (phydev->suspended)
1986 phy_ethtool_get_wol(phydev, &wol);
1987 phydev->wol_enabled = wol.wolopts || (netdev && netdev->wol_enabled);
1988 /* If the device has WOL enabled, we cannot suspend the PHY */
1989 if (phydev->wol_enabled && !(phydrv->flags & PHY_ALWAYS_CALL_SUSPEND))
1992 if (!phydrv || !phydrv->suspend)
1995 ret = phydrv->suspend(phydev);
1997 phydev->suspended = true;
2001 EXPORT_SYMBOL(phy_suspend);
2003 int __phy_resume(struct phy_device *phydev)
2005 const struct phy_driver *phydrv = phydev->drv;
2008 lockdep_assert_held(&phydev->lock);
2010 if (!phydrv || !phydrv->resume)
2013 ret = phydrv->resume(phydev);
2015 phydev->suspended = false;
2019 EXPORT_SYMBOL(__phy_resume);
2021 int phy_resume(struct phy_device *phydev)
2025 mutex_lock(&phydev->lock);
2026 ret = __phy_resume(phydev);
2027 mutex_unlock(&phydev->lock);
2031 EXPORT_SYMBOL(phy_resume);
2033 int phy_loopback(struct phy_device *phydev, bool enable)
2040 mutex_lock(&phydev->lock);
2042 if (enable && phydev->loopback_enabled) {
2047 if (!enable && !phydev->loopback_enabled) {
2052 if (phydev->drv->set_loopback)
2053 ret = phydev->drv->set_loopback(phydev, enable);
2055 ret = genphy_loopback(phydev, enable);
2060 phydev->loopback_enabled = enable;
2063 mutex_unlock(&phydev->lock);
2066 EXPORT_SYMBOL(phy_loopback);
2069 * phy_reset_after_clk_enable - perform a PHY reset if needed
2070 * @phydev: target phy_device struct
2072 * Description: Some PHYs are known to need a reset after their refclk was
2073 * enabled. This function evaluates the flags and perform the reset if it's
2074 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
2077 int phy_reset_after_clk_enable(struct phy_device *phydev)
2079 if (!phydev || !phydev->drv)
2082 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
2083 phy_device_reset(phydev, 1);
2084 phy_device_reset(phydev, 0);
2090 EXPORT_SYMBOL(phy_reset_after_clk_enable);
2092 /* Generic PHY support and helper functions */
2095 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
2096 * @phydev: target phy_device struct
2098 * Description: Writes MII_ADVERTISE with the appropriate values,
2099 * after sanitizing the values to make sure we only advertise
2100 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
2101 * hasn't changed, and > 0 if it has changed.
2103 static int genphy_config_advert(struct phy_device *phydev)
2105 int err, bmsr, changed = 0;
2108 /* Only allow advertising what this PHY supports */
2109 linkmode_and(phydev->advertising, phydev->advertising,
2112 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
2114 /* Setup standard advertisement */
2115 err = phy_modify_changed(phydev, MII_ADVERTISE,
2116 ADVERTISE_ALL | ADVERTISE_100BASE4 |
2117 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
2124 bmsr = phy_read(phydev, MII_BMSR);
2128 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
2129 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
2132 if (!(bmsr & BMSR_ESTATEN))
2135 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
2137 err = phy_modify_changed(phydev, MII_CTRL1000,
2138 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
2149 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
2150 * @phydev: target phy_device struct
2152 * Description: Writes MII_ADVERTISE with the appropriate values,
2153 * after sanitizing the values to make sure we only advertise
2154 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
2155 * hasn't changed, and > 0 if it has changed. This function is intended
2156 * for Clause 37 1000Base-X mode.
2158 static int genphy_c37_config_advert(struct phy_device *phydev)
2162 /* Only allow advertising what this PHY supports */
2163 linkmode_and(phydev->advertising, phydev->advertising,
2166 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2167 phydev->advertising))
2168 adv |= ADVERTISE_1000XFULL;
2169 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2170 phydev->advertising))
2171 adv |= ADVERTISE_1000XPAUSE;
2172 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2173 phydev->advertising))
2174 adv |= ADVERTISE_1000XPSE_ASYM;
2176 return phy_modify_changed(phydev, MII_ADVERTISE,
2177 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
2178 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
2183 * genphy_config_eee_advert - disable unwanted eee mode advertisement
2184 * @phydev: target phy_device struct
2186 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
2187 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
2188 * changed, and 1 if it has changed.
2190 int genphy_config_eee_advert(struct phy_device *phydev)
2194 /* Nothing to disable */
2195 if (!phydev->eee_broken_modes)
2198 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
2199 phydev->eee_broken_modes, 0);
2200 /* If the call failed, we assume that EEE is not supported */
2201 return err < 0 ? 0 : err;
2203 EXPORT_SYMBOL(genphy_config_eee_advert);
2206 * genphy_setup_forced - configures/forces speed/duplex from @phydev
2207 * @phydev: target phy_device struct
2209 * Description: Configures MII_BMCR to force speed/duplex
2210 * to the values in phydev. Assumes that the values are valid.
2211 * Please see phy_sanitize_settings().
2213 int genphy_setup_forced(struct phy_device *phydev)
2218 phydev->asym_pause = 0;
2220 ctl = mii_bmcr_encode_fixed(phydev->speed, phydev->duplex);
2222 return phy_modify(phydev, MII_BMCR,
2223 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
2225 EXPORT_SYMBOL(genphy_setup_forced);
2227 static int genphy_setup_master_slave(struct phy_device *phydev)
2231 if (!phydev->is_gigabit_capable)
2234 switch (phydev->master_slave_set) {
2235 case MASTER_SLAVE_CFG_MASTER_PREFERRED:
2236 ctl |= CTL1000_PREFER_MASTER;
2238 case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
2240 case MASTER_SLAVE_CFG_MASTER_FORCE:
2241 ctl |= CTL1000_AS_MASTER;
2243 case MASTER_SLAVE_CFG_SLAVE_FORCE:
2244 ctl |= CTL1000_ENABLE_MASTER;
2246 case MASTER_SLAVE_CFG_UNKNOWN:
2247 case MASTER_SLAVE_CFG_UNSUPPORTED:
2250 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2254 return phy_modify_changed(phydev, MII_CTRL1000,
2255 (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2256 CTL1000_PREFER_MASTER), ctl);
2259 int genphy_read_master_slave(struct phy_device *phydev)
2264 phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2265 phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2267 val = phy_read(phydev, MII_CTRL1000);
2271 if (val & CTL1000_ENABLE_MASTER) {
2272 if (val & CTL1000_AS_MASTER)
2273 cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2275 cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2277 if (val & CTL1000_PREFER_MASTER)
2278 cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2280 cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2283 val = phy_read(phydev, MII_STAT1000);
2287 if (val & LPA_1000MSFAIL) {
2288 state = MASTER_SLAVE_STATE_ERR;
2289 } else if (phydev->link) {
2290 /* this bits are valid only for active link */
2291 if (val & LPA_1000MSRES)
2292 state = MASTER_SLAVE_STATE_MASTER;
2294 state = MASTER_SLAVE_STATE_SLAVE;
2296 state = MASTER_SLAVE_STATE_UNKNOWN;
2299 phydev->master_slave_get = cfg;
2300 phydev->master_slave_state = state;
2304 EXPORT_SYMBOL(genphy_read_master_slave);
2307 * genphy_restart_aneg - Enable and Restart Autonegotiation
2308 * @phydev: target phy_device struct
2310 int genphy_restart_aneg(struct phy_device *phydev)
2312 /* Don't isolate the PHY if we're negotiating */
2313 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2314 BMCR_ANENABLE | BMCR_ANRESTART);
2316 EXPORT_SYMBOL(genphy_restart_aneg);
2319 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2320 * @phydev: target phy_device struct
2321 * @restart: whether aneg restart is requested
2323 * Check, and restart auto-negotiation if needed.
2325 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2330 /* Advertisement hasn't changed, but maybe aneg was never on to
2331 * begin with? Or maybe phy was isolated?
2333 ret = phy_read(phydev, MII_BMCR);
2337 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2342 return genphy_restart_aneg(phydev);
2346 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2349 * __genphy_config_aneg - restart auto-negotiation or write BMCR
2350 * @phydev: target phy_device struct
2351 * @changed: whether autoneg is requested
2353 * Description: If auto-negotiation is enabled, we configure the
2354 * advertising, and then restart auto-negotiation. If it is not
2355 * enabled, then we write the BMCR.
2357 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2361 err = genphy_c45_an_config_eee_aneg(phydev);
2367 err = genphy_setup_master_slave(phydev);
2373 if (AUTONEG_ENABLE != phydev->autoneg)
2374 return genphy_setup_forced(phydev);
2376 err = genphy_config_advert(phydev);
2377 if (err < 0) /* error */
2382 return genphy_check_and_restart_aneg(phydev, changed);
2384 EXPORT_SYMBOL(__genphy_config_aneg);
2387 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2388 * @phydev: target phy_device struct
2390 * Description: If auto-negotiation is enabled, we configure the
2391 * advertising, and then restart auto-negotiation. If it is not
2392 * enabled, then we write the BMCR. This function is intended
2393 * for use with Clause 37 1000Base-X mode.
2395 int genphy_c37_config_aneg(struct phy_device *phydev)
2399 if (phydev->autoneg != AUTONEG_ENABLE)
2400 return genphy_setup_forced(phydev);
2402 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2407 changed = genphy_c37_config_advert(phydev);
2408 if (changed < 0) /* error */
2412 /* Advertisement hasn't changed, but maybe aneg was never on to
2413 * begin with? Or maybe phy was isolated?
2415 int ctl = phy_read(phydev, MII_BMCR);
2420 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2421 changed = 1; /* do restart aneg */
2424 /* Only restart aneg if we are advertising something different
2425 * than we were before.
2428 return genphy_restart_aneg(phydev);
2432 EXPORT_SYMBOL(genphy_c37_config_aneg);
2435 * genphy_aneg_done - return auto-negotiation status
2436 * @phydev: target phy_device struct
2438 * Description: Reads the status register and returns 0 either if
2439 * auto-negotiation is incomplete, or if there was an error.
2440 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2442 int genphy_aneg_done(struct phy_device *phydev)
2444 int retval = phy_read(phydev, MII_BMSR);
2446 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2448 EXPORT_SYMBOL(genphy_aneg_done);
2451 * genphy_update_link - update link status in @phydev
2452 * @phydev: target phy_device struct
2454 * Description: Update the value in phydev->link to reflect the
2455 * current link value. In order to do this, we need to read
2456 * the status register twice, keeping the second value.
2458 int genphy_update_link(struct phy_device *phydev)
2460 int status = 0, bmcr;
2462 bmcr = phy_read(phydev, MII_BMCR);
2466 /* Autoneg is being started, therefore disregard BMSR value and
2467 * report link as down.
2469 if (bmcr & BMCR_ANRESTART)
2472 /* The link state is latched low so that momentary link
2473 * drops can be detected. Do not double-read the status
2474 * in polling mode to detect such short link drops except
2475 * the link was already down.
2477 if (!phy_polling_mode(phydev) || !phydev->link) {
2478 status = phy_read(phydev, MII_BMSR);
2481 else if (status & BMSR_LSTATUS)
2485 /* Read link and autonegotiation status */
2486 status = phy_read(phydev, MII_BMSR);
2490 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2491 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2493 /* Consider the case that autoneg was started and "aneg complete"
2494 * bit has been reset, but "link up" bit not yet.
2496 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2501 EXPORT_SYMBOL(genphy_update_link);
2503 int genphy_read_lpa(struct phy_device *phydev)
2507 if (phydev->autoneg == AUTONEG_ENABLE) {
2508 if (!phydev->autoneg_complete) {
2509 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2511 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2515 if (phydev->is_gigabit_capable) {
2516 lpagb = phy_read(phydev, MII_STAT1000);
2520 if (lpagb & LPA_1000MSFAIL) {
2521 int adv = phy_read(phydev, MII_CTRL1000);
2526 if (adv & CTL1000_ENABLE_MASTER)
2527 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2529 phydev_err(phydev, "Master/Slave resolution failed\n");
2533 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2537 lpa = phy_read(phydev, MII_LPA);
2541 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2543 linkmode_zero(phydev->lp_advertising);
2548 EXPORT_SYMBOL(genphy_read_lpa);
2551 * genphy_read_status_fixed - read the link parameters for !aneg mode
2552 * @phydev: target phy_device struct
2554 * Read the current duplex and speed state for a PHY operating with
2555 * autonegotiation disabled.
2557 int genphy_read_status_fixed(struct phy_device *phydev)
2559 int bmcr = phy_read(phydev, MII_BMCR);
2564 if (bmcr & BMCR_FULLDPLX)
2565 phydev->duplex = DUPLEX_FULL;
2567 phydev->duplex = DUPLEX_HALF;
2569 if (bmcr & BMCR_SPEED1000)
2570 phydev->speed = SPEED_1000;
2571 else if (bmcr & BMCR_SPEED100)
2572 phydev->speed = SPEED_100;
2574 phydev->speed = SPEED_10;
2578 EXPORT_SYMBOL(genphy_read_status_fixed);
2581 * genphy_read_status - check the link status and update current link state
2582 * @phydev: target phy_device struct
2584 * Description: Check the link, then figure out the current state
2585 * by comparing what we advertise with what the link partner
2586 * advertises. Start by checking the gigabit possibilities,
2587 * then move on to 10/100.
2589 int genphy_read_status(struct phy_device *phydev)
2591 int err, old_link = phydev->link;
2593 /* Update the link, but return if there was an error */
2594 err = genphy_update_link(phydev);
2598 /* why bother the PHY if nothing can have changed */
2599 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2602 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2603 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2604 phydev->speed = SPEED_UNKNOWN;
2605 phydev->duplex = DUPLEX_UNKNOWN;
2607 phydev->asym_pause = 0;
2609 if (phydev->is_gigabit_capable) {
2610 err = genphy_read_master_slave(phydev);
2615 err = genphy_read_lpa(phydev);
2619 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2620 phy_resolve_aneg_linkmode(phydev);
2621 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2622 err = genphy_read_status_fixed(phydev);
2629 EXPORT_SYMBOL(genphy_read_status);
2632 * genphy_c37_read_status - check the link status and update current link state
2633 * @phydev: target phy_device struct
2634 * @changed: pointer where to store if link changed
2636 * Description: Check the link, then figure out the current state
2637 * by comparing what we advertise with what the link partner
2638 * advertises. This function is for Clause 37 1000Base-X mode.
2640 * If link has changed, @changed is set to true, false otherwise.
2642 int genphy_c37_read_status(struct phy_device *phydev, bool *changed)
2644 int lpa, err, old_link = phydev->link;
2646 /* Update the link, but return if there was an error */
2647 err = genphy_update_link(phydev);
2651 /* why bother the PHY if nothing can have changed */
2652 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link) {
2657 /* Signal link has changed */
2659 phydev->duplex = DUPLEX_UNKNOWN;
2661 phydev->asym_pause = 0;
2663 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2664 lpa = phy_read(phydev, MII_LPA);
2668 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2669 phydev->lp_advertising, lpa & LPA_LPACK);
2670 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2671 phydev->lp_advertising, lpa & LPA_1000XFULL);
2672 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2673 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2674 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2675 phydev->lp_advertising,
2676 lpa & LPA_1000XPAUSE_ASYM);
2678 phy_resolve_aneg_linkmode(phydev);
2679 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2680 int bmcr = phy_read(phydev, MII_BMCR);
2685 if (bmcr & BMCR_FULLDPLX)
2686 phydev->duplex = DUPLEX_FULL;
2688 phydev->duplex = DUPLEX_HALF;
2693 EXPORT_SYMBOL(genphy_c37_read_status);
2696 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2697 * @phydev: target phy_device struct
2699 * Description: Perform a software PHY reset using the standard
2700 * BMCR_RESET bit and poll for the reset bit to be cleared.
2702 * Returns: 0 on success, < 0 on failure
2704 int genphy_soft_reset(struct phy_device *phydev)
2706 u16 res = BMCR_RESET;
2709 if (phydev->autoneg == AUTONEG_ENABLE)
2710 res |= BMCR_ANRESTART;
2712 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2716 /* Clause 22 states that setting bit BMCR_RESET sets control registers
2717 * to their default value. Therefore the POWER DOWN bit is supposed to
2718 * be cleared after soft reset.
2720 phydev->suspended = 0;
2722 ret = phy_poll_reset(phydev);
2726 /* BMCR may be reset to defaults */
2727 if (phydev->autoneg == AUTONEG_DISABLE)
2728 ret = genphy_setup_forced(phydev);
2732 EXPORT_SYMBOL(genphy_soft_reset);
2734 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2736 /* It seems there are cases where the interrupts are handled by another
2737 * entity (ie an IRQ controller embedded inside the PHY) and do not
2738 * need any other interraction from phylib. In this case, just trigger
2739 * the state machine directly.
2741 phy_trigger_machine(phydev);
2745 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2748 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2749 * @phydev: target phy_device struct
2751 * Description: Reads the PHY's abilities and populates
2752 * phydev->supported accordingly.
2754 * Returns: 0 on success, < 0 on failure
2756 int genphy_read_abilities(struct phy_device *phydev)
2760 linkmode_set_bit_array(phy_basic_ports_array,
2761 ARRAY_SIZE(phy_basic_ports_array),
2764 val = phy_read(phydev, MII_BMSR);
2768 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2769 val & BMSR_ANEGCAPABLE);
2771 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2772 val & BMSR_100FULL);
2773 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2774 val & BMSR_100HALF);
2775 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2777 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2780 if (val & BMSR_ESTATEN) {
2781 val = phy_read(phydev, MII_ESTATUS);
2785 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2786 phydev->supported, val & ESTATUS_1000_TFULL);
2787 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2788 phydev->supported, val & ESTATUS_1000_THALF);
2789 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2790 phydev->supported, val & ESTATUS_1000_XFULL);
2793 /* This is optional functionality. If not supported, we may get an error
2794 * which should be ignored.
2796 genphy_c45_read_eee_abilities(phydev);
2800 EXPORT_SYMBOL(genphy_read_abilities);
2802 /* This is used for the phy device which doesn't support the MMD extended
2803 * register access, but it does have side effect when we are trying to access
2804 * the MMD register via indirect method.
2806 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2810 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2812 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2813 u16 regnum, u16 val)
2817 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2819 int genphy_suspend(struct phy_device *phydev)
2821 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2823 EXPORT_SYMBOL(genphy_suspend);
2825 int genphy_resume(struct phy_device *phydev)
2827 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2829 EXPORT_SYMBOL(genphy_resume);
2831 int genphy_loopback(struct phy_device *phydev, bool enable)
2834 u16 val, ctl = BMCR_LOOPBACK;
2837 ctl |= mii_bmcr_encode_fixed(phydev->speed, phydev->duplex);
2839 phy_modify(phydev, MII_BMCR, ~0, ctl);
2841 ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2843 5000, 500000, true);
2847 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2849 phy_config_aneg(phydev);
2854 EXPORT_SYMBOL(genphy_loopback);
2857 * phy_remove_link_mode - Remove a supported link mode
2858 * @phydev: phy_device structure to remove link mode from
2859 * @link_mode: Link mode to be removed
2861 * Description: Some MACs don't support all link modes which the PHY
2862 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2863 * to remove a link mode.
2865 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2867 linkmode_clear_bit(link_mode, phydev->supported);
2868 phy_advertise_supported(phydev);
2870 EXPORT_SYMBOL(phy_remove_link_mode);
2872 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2874 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2875 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2876 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2877 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2881 * phy_advertise_supported - Advertise all supported modes
2882 * @phydev: target phy_device struct
2884 * Description: Called to advertise all supported modes, doesn't touch
2885 * pause mode advertising.
2887 void phy_advertise_supported(struct phy_device *phydev)
2889 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2891 linkmode_copy(new, phydev->supported);
2892 phy_copy_pause_bits(new, phydev->advertising);
2893 linkmode_copy(phydev->advertising, new);
2895 EXPORT_SYMBOL(phy_advertise_supported);
2898 * phy_advertise_eee_all - Advertise all supported EEE modes
2899 * @phydev: target phy_device struct
2901 * Description: Per default phylib preserves the EEE advertising at the time of
2902 * phy probing, which might be a subset of the supported EEE modes. Use this
2903 * function when all supported EEE modes should be advertised. This does not
2904 * trigger auto-negotiation, so must be called before phy_start()/
2905 * phylink_start() which will start auto-negotiation.
2907 void phy_advertise_eee_all(struct phy_device *phydev)
2909 linkmode_copy(phydev->advertising_eee, phydev->supported_eee);
2911 EXPORT_SYMBOL_GPL(phy_advertise_eee_all);
2914 * phy_support_eee - Set initial EEE policy configuration
2915 * @phydev: Target phy_device struct
2917 * This function configures the initial policy for Energy Efficient Ethernet
2918 * (EEE) on the specified PHY device, influencing that EEE capabilities are
2919 * advertised before the link is established. It should be called during PHY
2920 * registration by the MAC driver and/or the PHY driver (for SmartEEE PHYs)
2921 * if MAC supports LPI or PHY is capable to compensate missing LPI functionality
2924 * The function sets default EEE policy parameters, including preparing the PHY
2925 * to advertise EEE capabilities based on hardware support.
2927 * It also sets the expected configuration for Low Power Idle (LPI) in the MAC
2928 * driver. If the PHY framework determines that both local and remote
2929 * advertisements support EEE, and the negotiated link mode is compatible with
2930 * EEE, it will set enable_tx_lpi = true. The MAC driver is expected to act on
2931 * this setting by enabling the LPI timer if enable_tx_lpi is set.
2933 void phy_support_eee(struct phy_device *phydev)
2935 linkmode_copy(phydev->advertising_eee, phydev->supported_eee);
2936 phydev->eee_cfg.tx_lpi_enabled = true;
2937 phydev->eee_cfg.eee_enabled = true;
2939 EXPORT_SYMBOL(phy_support_eee);
2942 * phy_support_sym_pause - Enable support of symmetrical pause
2943 * @phydev: target phy_device struct
2945 * Description: Called by the MAC to indicate is supports symmetrical
2946 * Pause, but not asym pause.
2948 void phy_support_sym_pause(struct phy_device *phydev)
2950 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2951 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2953 EXPORT_SYMBOL(phy_support_sym_pause);
2956 * phy_support_asym_pause - Enable support of asym pause
2957 * @phydev: target phy_device struct
2959 * Description: Called by the MAC to indicate is supports Asym Pause.
2961 void phy_support_asym_pause(struct phy_device *phydev)
2963 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2965 EXPORT_SYMBOL(phy_support_asym_pause);
2968 * phy_set_sym_pause - Configure symmetric Pause
2969 * @phydev: target phy_device struct
2970 * @rx: Receiver Pause is supported
2971 * @tx: Transmit Pause is supported
2972 * @autoneg: Auto neg should be used
2974 * Description: Configure advertised Pause support depending on if
2975 * receiver pause and pause auto neg is supported. Generally called
2976 * from the set_pauseparam .ndo.
2978 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2981 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2983 if (rx && tx && autoneg)
2984 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2987 linkmode_copy(phydev->advertising, phydev->supported);
2989 EXPORT_SYMBOL(phy_set_sym_pause);
2992 * phy_set_asym_pause - Configure Pause and Asym Pause
2993 * @phydev: target phy_device struct
2994 * @rx: Receiver Pause is supported
2995 * @tx: Transmit Pause is supported
2997 * Description: Configure advertised Pause support depending on if
2998 * transmit and receiver pause is supported. If there has been a
2999 * change in adverting, trigger a new autoneg. Generally called from
3000 * the set_pauseparam .ndo.
3002 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
3004 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
3006 linkmode_copy(oldadv, phydev->advertising);
3007 linkmode_set_pause(phydev->advertising, tx, rx);
3009 if (!linkmode_equal(oldadv, phydev->advertising) &&
3011 phy_start_aneg(phydev);
3013 EXPORT_SYMBOL(phy_set_asym_pause);
3016 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
3017 * @phydev: phy_device struct
3018 * @pp: requested pause configuration
3020 * Description: Test if the PHY/MAC combination supports the Pause
3021 * configuration the user is requesting. Returns True if it is
3022 * supported, false otherwise.
3024 bool phy_validate_pause(struct phy_device *phydev,
3025 struct ethtool_pauseparam *pp)
3027 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3028 phydev->supported) && pp->rx_pause)
3031 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3032 phydev->supported) &&
3033 pp->rx_pause != pp->tx_pause)
3038 EXPORT_SYMBOL(phy_validate_pause);
3041 * phy_get_pause - resolve negotiated pause modes
3042 * @phydev: phy_device struct
3043 * @tx_pause: pointer to bool to indicate whether transmit pause should be
3045 * @rx_pause: pointer to bool to indicate whether receive pause should be
3048 * Resolve and return the flow control modes according to the negotiation
3049 * result. This includes checking that we are operating in full duplex mode.
3050 * See linkmode_resolve_pause() for further details.
3052 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
3054 if (phydev->duplex != DUPLEX_FULL) {
3060 return linkmode_resolve_pause(phydev->advertising,
3061 phydev->lp_advertising,
3062 tx_pause, rx_pause);
3064 EXPORT_SYMBOL(phy_get_pause);
3066 #if IS_ENABLED(CONFIG_OF_MDIO)
3067 static int phy_get_int_delay_property(struct device *dev, const char *name)
3072 ret = device_property_read_u32(dev, name, &int_delay);
3079 static int phy_get_int_delay_property(struct device *dev, const char *name)
3086 * phy_get_internal_delay - returns the index of the internal delay
3087 * @phydev: phy_device struct
3088 * @dev: pointer to the devices device struct
3089 * @delay_values: array of delays the PHY supports
3090 * @size: the size of the delay array
3091 * @is_rx: boolean to indicate to get the rx internal delay
3093 * Returns the index within the array of internal delay passed in.
3094 * If the device property is not present then the interface type is checked
3095 * if the interface defines use of internal delay then a 1 is returned otherwise
3097 * The array must be in ascending order. If PHY does not have an ascending order
3098 * array then size = 0 and the value of the delay property is returned.
3099 * Return -EINVAL if the delay is invalid or cannot be found.
3101 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
3102 const int *delay_values, int size, bool is_rx)
3108 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
3109 if (delay < 0 && size == 0) {
3110 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
3111 phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
3118 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
3119 if (delay < 0 && size == 0) {
3120 if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
3121 phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
3134 if (delay < delay_values[0] || delay > delay_values[size - 1]) {
3135 phydev_err(phydev, "Delay %d is out of range\n", delay);
3139 if (delay == delay_values[0])
3142 for (i = 1; i < size; i++) {
3143 if (delay == delay_values[i])
3146 /* Find an approximate index by looking up the table */
3147 if (delay > delay_values[i - 1] &&
3148 delay < delay_values[i]) {
3149 if (delay - delay_values[i - 1] <
3150 delay_values[i] - delay)
3157 phydev_err(phydev, "error finding internal delay index for %d\n",
3162 EXPORT_SYMBOL(phy_get_internal_delay);
3164 static int phy_led_set_brightness(struct led_classdev *led_cdev,
3165 enum led_brightness value)
3167 struct phy_led *phyled = to_phy_led(led_cdev);
3168 struct phy_device *phydev = phyled->phydev;
3171 mutex_lock(&phydev->lock);
3172 err = phydev->drv->led_brightness_set(phydev, phyled->index, value);
3173 mutex_unlock(&phydev->lock);
3178 static int phy_led_blink_set(struct led_classdev *led_cdev,
3179 unsigned long *delay_on,
3180 unsigned long *delay_off)
3182 struct phy_led *phyled = to_phy_led(led_cdev);
3183 struct phy_device *phydev = phyled->phydev;
3186 mutex_lock(&phydev->lock);
3187 err = phydev->drv->led_blink_set(phydev, phyled->index,
3188 delay_on, delay_off);
3189 mutex_unlock(&phydev->lock);
3194 static __maybe_unused struct device *
3195 phy_led_hw_control_get_device(struct led_classdev *led_cdev)
3197 struct phy_led *phyled = to_phy_led(led_cdev);
3198 struct phy_device *phydev = phyled->phydev;
3200 if (phydev->attached_dev)
3201 return &phydev->attached_dev->dev;
3205 static int __maybe_unused
3206 phy_led_hw_control_get(struct led_classdev *led_cdev,
3207 unsigned long *rules)
3209 struct phy_led *phyled = to_phy_led(led_cdev);
3210 struct phy_device *phydev = phyled->phydev;
3213 mutex_lock(&phydev->lock);
3214 err = phydev->drv->led_hw_control_get(phydev, phyled->index, rules);
3215 mutex_unlock(&phydev->lock);
3220 static int __maybe_unused
3221 phy_led_hw_control_set(struct led_classdev *led_cdev,
3222 unsigned long rules)
3224 struct phy_led *phyled = to_phy_led(led_cdev);
3225 struct phy_device *phydev = phyled->phydev;
3228 mutex_lock(&phydev->lock);
3229 err = phydev->drv->led_hw_control_set(phydev, phyled->index, rules);
3230 mutex_unlock(&phydev->lock);
3235 static __maybe_unused int phy_led_hw_is_supported(struct led_classdev *led_cdev,
3236 unsigned long rules)
3238 struct phy_led *phyled = to_phy_led(led_cdev);
3239 struct phy_device *phydev = phyled->phydev;
3242 mutex_lock(&phydev->lock);
3243 err = phydev->drv->led_hw_is_supported(phydev, phyled->index, rules);
3244 mutex_unlock(&phydev->lock);
3249 static void phy_leds_unregister(struct phy_device *phydev)
3251 struct phy_led *phyled;
3253 list_for_each_entry(phyled, &phydev->leds, list) {
3254 led_classdev_unregister(&phyled->led_cdev);
3258 static int of_phy_led(struct phy_device *phydev,
3259 struct device_node *led)
3261 struct device *dev = &phydev->mdio.dev;
3262 struct led_init_data init_data = {};
3263 struct led_classdev *cdev;
3264 unsigned long modes = 0;
3265 struct phy_led *phyled;
3269 phyled = devm_kzalloc(dev, sizeof(*phyled), GFP_KERNEL);
3273 cdev = &phyled->led_cdev;
3274 phyled->phydev = phydev;
3276 err = of_property_read_u32(led, "reg", &index);
3282 if (of_property_read_bool(led, "active-low"))
3283 set_bit(PHY_LED_ACTIVE_LOW, &modes);
3284 if (of_property_read_bool(led, "inactive-high-impedance"))
3285 set_bit(PHY_LED_INACTIVE_HIGH_IMPEDANCE, &modes);
3288 /* Return error if asked to set polarity modes but not supported */
3289 if (!phydev->drv->led_polarity_set)
3292 err = phydev->drv->led_polarity_set(phydev, index, modes);
3297 phyled->index = index;
3298 if (phydev->drv->led_brightness_set)
3299 cdev->brightness_set_blocking = phy_led_set_brightness;
3300 if (phydev->drv->led_blink_set)
3301 cdev->blink_set = phy_led_blink_set;
3303 #ifdef CONFIG_LEDS_TRIGGERS
3304 if (phydev->drv->led_hw_is_supported &&
3305 phydev->drv->led_hw_control_set &&
3306 phydev->drv->led_hw_control_get) {
3307 cdev->hw_control_is_supported = phy_led_hw_is_supported;
3308 cdev->hw_control_set = phy_led_hw_control_set;
3309 cdev->hw_control_get = phy_led_hw_control_get;
3310 cdev->hw_control_trigger = "netdev";
3313 cdev->hw_control_get_device = phy_led_hw_control_get_device;
3315 cdev->max_brightness = 1;
3316 init_data.devicename = dev_name(&phydev->mdio.dev);
3317 init_data.fwnode = of_fwnode_handle(led);
3318 init_data.devname_mandatory = true;
3320 err = led_classdev_register_ext(dev, cdev, &init_data);
3324 list_add(&phyled->list, &phydev->leds);
3329 static int of_phy_leds(struct phy_device *phydev)
3331 struct device_node *node = phydev->mdio.dev.of_node;
3332 struct device_node *leds, *led;
3335 if (!IS_ENABLED(CONFIG_OF_MDIO))
3341 leds = of_get_child_by_name(node, "leds");
3345 for_each_available_child_of_node(leds, led) {
3346 err = of_phy_led(phydev, led);
3349 phy_leds_unregister(phydev);
3358 * fwnode_mdio_find_device - Given a fwnode, find the mdio_device
3359 * @fwnode: pointer to the mdio_device's fwnode
3361 * If successful, returns a pointer to the mdio_device with the embedded
3362 * struct device refcount incremented by one, or NULL on failure.
3363 * The caller should call put_device() on the mdio_device after its use.
3365 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
3372 d = bus_find_device_by_fwnode(&mdio_bus_type, fwnode);
3376 return to_mdio_device(d);
3378 EXPORT_SYMBOL(fwnode_mdio_find_device);
3381 * fwnode_phy_find_device - For provided phy_fwnode, find phy_device.
3383 * @phy_fwnode: Pointer to the phy's fwnode.
3385 * If successful, returns a pointer to the phy_device with the embedded
3386 * struct device refcount incremented by one, or NULL on failure.
3388 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
3390 struct mdio_device *mdiodev;
3392 mdiodev = fwnode_mdio_find_device(phy_fwnode);
3396 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
3397 return to_phy_device(&mdiodev->dev);
3399 put_device(&mdiodev->dev);
3403 EXPORT_SYMBOL(fwnode_phy_find_device);
3406 * device_phy_find_device - For the given device, get the phy_device
3407 * @dev: Pointer to the given device
3409 * Refer return conditions of fwnode_phy_find_device().
3411 struct phy_device *device_phy_find_device(struct device *dev)
3413 return fwnode_phy_find_device(dev_fwnode(dev));
3415 EXPORT_SYMBOL_GPL(device_phy_find_device);
3418 * fwnode_get_phy_node - Get the phy_node using the named reference.
3419 * @fwnode: Pointer to fwnode from which phy_node has to be obtained.
3421 * Refer return conditions of fwnode_find_reference().
3422 * For ACPI, only "phy-handle" is supported. Legacy DT properties "phy"
3423 * and "phy-device" are not supported in ACPI. DT supports all the three
3424 * named references to the phy node.
3426 struct fwnode_handle *fwnode_get_phy_node(const struct fwnode_handle *fwnode)
3428 struct fwnode_handle *phy_node;
3430 /* Only phy-handle is used for ACPI */
3431 phy_node = fwnode_find_reference(fwnode, "phy-handle", 0);
3432 if (is_acpi_node(fwnode) || !IS_ERR(phy_node))
3434 phy_node = fwnode_find_reference(fwnode, "phy", 0);
3435 if (IS_ERR(phy_node))
3436 phy_node = fwnode_find_reference(fwnode, "phy-device", 0);
3439 EXPORT_SYMBOL_GPL(fwnode_get_phy_node);
3442 * phy_probe - probe and init a PHY device
3443 * @dev: device to probe and init
3445 * Take care of setting up the phy_device structure, set the state to READY.
3447 static int phy_probe(struct device *dev)
3449 struct phy_device *phydev = to_phy_device(dev);
3450 struct device_driver *drv = phydev->mdio.dev.driver;
3451 struct phy_driver *phydrv = to_phy_driver(drv);
3454 phydev->drv = phydrv;
3456 /* Disable the interrupt if the PHY doesn't support it
3457 * but the interrupt is still a valid one
3459 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
3460 phydev->irq = PHY_POLL;
3462 if (phydrv->flags & PHY_IS_INTERNAL)
3463 phydev->is_internal = true;
3465 /* Deassert the reset signal */
3466 phy_device_reset(phydev, 0);
3468 if (phydev->drv->probe) {
3469 err = phydev->drv->probe(phydev);
3474 phy_disable_interrupts(phydev);
3476 /* Start out supporting everything. Eventually,
3477 * a controller will attach, and may modify one
3478 * or both of these values
3480 if (phydrv->features) {
3481 linkmode_copy(phydev->supported, phydrv->features);
3482 genphy_c45_read_eee_abilities(phydev);
3484 else if (phydrv->get_features)
3485 err = phydrv->get_features(phydev);
3486 else if (phydev->is_c45)
3487 err = genphy_c45_pma_read_abilities(phydev);
3489 err = genphy_read_abilities(phydev);
3494 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
3496 phydev->autoneg = 0;
3498 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
3500 phydev->is_gigabit_capable = 1;
3501 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
3503 phydev->is_gigabit_capable = 1;
3505 of_set_phy_supported(phydev);
3506 phy_advertise_supported(phydev);
3508 /* Get PHY default EEE advertising modes and handle them as potentially
3509 * safe initial configuration.
3511 err = genphy_c45_read_eee_adv(phydev, phydev->advertising_eee);
3515 /* There is no "enabled" flag. If PHY is advertising, assume it is
3518 phydev->eee_enabled = !linkmode_empty(phydev->advertising_eee);
3520 /* Some PHYs may advertise, by default, not support EEE modes. So,
3521 * we need to clean them.
3523 if (phydev->eee_enabled)
3524 linkmode_and(phydev->advertising_eee, phydev->supported_eee,
3525 phydev->advertising_eee);
3527 /* Get the EEE modes we want to prohibit. We will ask
3528 * the PHY stop advertising these mode later on
3530 of_set_phy_eee_broken(phydev);
3532 /* The Pause Frame bits indicate that the PHY can support passing
3533 * pause frames. During autonegotiation, the PHYs will determine if
3534 * they should allow pause frames to pass. The MAC driver should then
3535 * use that result to determine whether to enable flow control via
3538 * Normally, PHY drivers should not set the Pause bits, and instead
3539 * allow phylib to do that. However, there may be some situations
3540 * (e.g. hardware erratum) where the driver wants to set only one
3543 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
3544 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
3545 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3547 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3551 /* Set the state to READY by default */
3552 phydev->state = PHY_READY;
3554 /* Get the LEDs from the device tree, and instantiate standard
3557 if (IS_ENABLED(CONFIG_PHYLIB_LEDS))
3558 err = of_phy_leds(phydev);
3561 /* Re-assert the reset signal on error */
3563 phy_device_reset(phydev, 1);
3568 static int phy_remove(struct device *dev)
3570 struct phy_device *phydev = to_phy_device(dev);
3572 cancel_delayed_work_sync(&phydev->state_queue);
3574 if (IS_ENABLED(CONFIG_PHYLIB_LEDS))
3575 phy_leds_unregister(phydev);
3577 phydev->state = PHY_DOWN;
3579 sfp_bus_del_upstream(phydev->sfp_bus);
3580 phydev->sfp_bus = NULL;
3582 if (phydev->drv && phydev->drv->remove)
3583 phydev->drv->remove(phydev);
3585 /* Assert the reset signal */
3586 phy_device_reset(phydev, 1);
3594 * phy_driver_register - register a phy_driver with the PHY layer
3595 * @new_driver: new phy_driver to register
3596 * @owner: module owning this PHY
3598 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
3602 /* Either the features are hard coded, or dynamically
3603 * determined. It cannot be both.
3605 if (WARN_ON(new_driver->features && new_driver->get_features)) {
3606 pr_err("%s: features and get_features must not both be set\n",
3611 /* PHYLIB device drivers must not match using a DT compatible table
3612 * as this bypasses our checks that the mdiodev that is being matched
3613 * is backed by a struct phy_device. If such a case happens, we will
3614 * make out-of-bounds accesses and lockup in phydev->lock.
3616 if (WARN(new_driver->mdiodrv.driver.of_match_table,
3617 "%s: driver must not provide a DT match table\n",
3621 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3622 new_driver->mdiodrv.driver.name = new_driver->name;
3623 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3624 new_driver->mdiodrv.driver.probe = phy_probe;
3625 new_driver->mdiodrv.driver.remove = phy_remove;
3626 new_driver->mdiodrv.driver.owner = owner;
3627 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3629 retval = driver_register(&new_driver->mdiodrv.driver);
3631 pr_err("%s: Error %d in registering driver\n",
3632 new_driver->name, retval);
3637 pr_debug("%s: Registered new driver\n", new_driver->name);
3641 EXPORT_SYMBOL(phy_driver_register);
3643 int phy_drivers_register(struct phy_driver *new_driver, int n,
3644 struct module *owner)
3648 for (i = 0; i < n; i++) {
3649 ret = phy_driver_register(new_driver + i, owner);
3652 phy_driver_unregister(new_driver + i);
3658 EXPORT_SYMBOL(phy_drivers_register);
3660 void phy_driver_unregister(struct phy_driver *drv)
3662 driver_unregister(&drv->mdiodrv.driver);
3664 EXPORT_SYMBOL(phy_driver_unregister);
3666 void phy_drivers_unregister(struct phy_driver *drv, int n)
3670 for (i = 0; i < n; i++)
3671 phy_driver_unregister(drv + i);
3673 EXPORT_SYMBOL(phy_drivers_unregister);
3675 static struct phy_driver genphy_driver = {
3676 .phy_id = 0xffffffff,
3677 .phy_id_mask = 0xffffffff,
3678 .name = "Generic PHY",
3679 .get_features = genphy_read_abilities,
3680 .suspend = genphy_suspend,
3681 .resume = genphy_resume,
3682 .set_loopback = genphy_loopback,
3685 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3686 .get_sset_count = phy_ethtool_get_sset_count,
3687 .get_strings = phy_ethtool_get_strings,
3688 .get_stats = phy_ethtool_get_stats,
3689 .get_plca_cfg = phy_ethtool_get_plca_cfg,
3690 .set_plca_cfg = phy_ethtool_set_plca_cfg,
3691 .get_plca_status = phy_ethtool_get_plca_status,
3692 .start_cable_test = phy_start_cable_test,
3693 .start_cable_test_tdr = phy_start_cable_test_tdr,
3696 static const struct phylib_stubs __phylib_stubs = {
3697 .hwtstamp_get = __phy_hwtstamp_get,
3698 .hwtstamp_set = __phy_hwtstamp_set,
3701 static void phylib_register_stubs(void)
3703 phylib_stubs = &__phylib_stubs;
3706 static void phylib_unregister_stubs(void)
3708 phylib_stubs = NULL;
3711 static int __init phy_init(void)
3716 ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3717 phylib_register_stubs();
3720 rc = mdio_bus_init();
3722 goto err_ethtool_phy_ops;
3726 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3730 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3737 phy_driver_unregister(&genphy_c45_driver);
3740 err_ethtool_phy_ops:
3742 phylib_unregister_stubs();
3743 ethtool_set_ethtool_phy_ops(NULL);
3749 static void __exit phy_exit(void)
3751 phy_driver_unregister(&genphy_c45_driver);
3752 phy_driver_unregister(&genphy_driver);
3755 phylib_unregister_stubs();
3756 ethtool_set_ethtool_phy_ops(NULL);
3760 subsys_initcall(phy_init);
3761 module_exit(phy_exit);