1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for finding and configuring PHYs.
3 * Also contains generic PHY driver
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/kernel.h>
13 #include <linux/string.h>
14 #include <linux/errno.h>
15 #include <linux/unistd.h>
16 #include <linux/slab.h>
17 #include <linux/interrupt.h>
18 #include <linux/init.h>
19 #include <linux/delay.h>
20 #include <linux/netdevice.h>
21 #include <linux/etherdevice.h>
22 #include <linux/skbuff.h>
24 #include <linux/module.h>
25 #include <linux/mii.h>
26 #include <linux/ethtool.h>
27 #include <linux/bitmap.h>
28 #include <linux/phy.h>
29 #include <linux/phy_led_triggers.h>
30 #include <linux/mdio.h>
32 #include <linux/uaccess.h>
34 MODULE_DESCRIPTION("PHY library");
35 MODULE_AUTHOR("Andy Fleming");
36 MODULE_LICENSE("GPL");
38 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
39 EXPORT_SYMBOL_GPL(phy_basic_features);
41 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
42 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
44 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
45 EXPORT_SYMBOL_GPL(phy_gbit_features);
47 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
48 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
50 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
51 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
53 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
54 EXPORT_SYMBOL_GPL(phy_10gbit_features);
56 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
57 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
59 const int phy_basic_ports_array[3] = {
60 ETHTOOL_LINK_MODE_Autoneg_BIT,
61 ETHTOOL_LINK_MODE_TP_BIT,
62 ETHTOOL_LINK_MODE_MII_BIT,
64 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
66 const int phy_fibre_port_array[1] = {
67 ETHTOOL_LINK_MODE_FIBRE_BIT,
69 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
71 const int phy_all_ports_features_array[7] = {
72 ETHTOOL_LINK_MODE_Autoneg_BIT,
73 ETHTOOL_LINK_MODE_TP_BIT,
74 ETHTOOL_LINK_MODE_MII_BIT,
75 ETHTOOL_LINK_MODE_FIBRE_BIT,
76 ETHTOOL_LINK_MODE_AUI_BIT,
77 ETHTOOL_LINK_MODE_BNC_BIT,
78 ETHTOOL_LINK_MODE_Backplane_BIT,
80 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
82 const int phy_10_100_features_array[4] = {
83 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
84 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
85 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
86 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
88 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
90 const int phy_basic_t1_features_array[2] = {
91 ETHTOOL_LINK_MODE_TP_BIT,
92 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
94 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
96 const int phy_gbit_features_array[2] = {
97 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
98 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
100 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
102 const int phy_10gbit_features_array[1] = {
103 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
105 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
107 const int phy_10gbit_fec_features_array[1] = {
108 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
110 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features_array);
112 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
113 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
115 static const int phy_10gbit_full_features_array[] = {
116 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
117 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
118 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
122 static void features_init(void)
124 /* 10/100 half/full*/
125 linkmode_set_bit_array(phy_basic_ports_array,
126 ARRAY_SIZE(phy_basic_ports_array),
128 linkmode_set_bit_array(phy_10_100_features_array,
129 ARRAY_SIZE(phy_10_100_features_array),
133 linkmode_set_bit_array(phy_basic_t1_features_array,
134 ARRAY_SIZE(phy_basic_t1_features_array),
135 phy_basic_t1_features);
137 /* 10/100 half/full + 1000 half/full */
138 linkmode_set_bit_array(phy_basic_ports_array,
139 ARRAY_SIZE(phy_basic_ports_array),
141 linkmode_set_bit_array(phy_10_100_features_array,
142 ARRAY_SIZE(phy_10_100_features_array),
144 linkmode_set_bit_array(phy_gbit_features_array,
145 ARRAY_SIZE(phy_gbit_features_array),
148 /* 10/100 half/full + 1000 half/full + fibre*/
149 linkmode_set_bit_array(phy_basic_ports_array,
150 ARRAY_SIZE(phy_basic_ports_array),
151 phy_gbit_fibre_features);
152 linkmode_set_bit_array(phy_10_100_features_array,
153 ARRAY_SIZE(phy_10_100_features_array),
154 phy_gbit_fibre_features);
155 linkmode_set_bit_array(phy_gbit_features_array,
156 ARRAY_SIZE(phy_gbit_features_array),
157 phy_gbit_fibre_features);
158 linkmode_set_bit_array(phy_fibre_port_array,
159 ARRAY_SIZE(phy_fibre_port_array),
160 phy_gbit_fibre_features);
162 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
163 linkmode_set_bit_array(phy_all_ports_features_array,
164 ARRAY_SIZE(phy_all_ports_features_array),
165 phy_gbit_all_ports_features);
166 linkmode_set_bit_array(phy_10_100_features_array,
167 ARRAY_SIZE(phy_10_100_features_array),
168 phy_gbit_all_ports_features);
169 linkmode_set_bit_array(phy_gbit_features_array,
170 ARRAY_SIZE(phy_gbit_features_array),
171 phy_gbit_all_ports_features);
173 /* 10/100 half/full + 1000 half/full + 10G full*/
174 linkmode_set_bit_array(phy_all_ports_features_array,
175 ARRAY_SIZE(phy_all_ports_features_array),
176 phy_10gbit_features);
177 linkmode_set_bit_array(phy_10_100_features_array,
178 ARRAY_SIZE(phy_10_100_features_array),
179 phy_10gbit_features);
180 linkmode_set_bit_array(phy_gbit_features_array,
181 ARRAY_SIZE(phy_gbit_features_array),
182 phy_10gbit_features);
183 linkmode_set_bit_array(phy_10gbit_features_array,
184 ARRAY_SIZE(phy_10gbit_features_array),
185 phy_10gbit_features);
187 /* 10/100/1000/10G full */
188 linkmode_set_bit_array(phy_all_ports_features_array,
189 ARRAY_SIZE(phy_all_ports_features_array),
190 phy_10gbit_full_features);
191 linkmode_set_bit_array(phy_10gbit_full_features_array,
192 ARRAY_SIZE(phy_10gbit_full_features_array),
193 phy_10gbit_full_features);
195 linkmode_set_bit_array(phy_10gbit_fec_features_array,
196 ARRAY_SIZE(phy_10gbit_fec_features_array),
197 phy_10gbit_fec_features);
200 void phy_device_free(struct phy_device *phydev)
202 put_device(&phydev->mdio.dev);
204 EXPORT_SYMBOL(phy_device_free);
206 static void phy_mdio_device_free(struct mdio_device *mdiodev)
208 struct phy_device *phydev;
210 phydev = container_of(mdiodev, struct phy_device, mdio);
211 phy_device_free(phydev);
214 static void phy_device_release(struct device *dev)
216 kfree(to_phy_device(dev));
219 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
221 struct phy_device *phydev;
223 phydev = container_of(mdiodev, struct phy_device, mdio);
224 phy_device_remove(phydev);
227 static struct phy_driver genphy_driver;
228 extern struct phy_driver genphy_c45_driver;
230 static LIST_HEAD(phy_fixup_list);
231 static DEFINE_MUTEX(phy_fixup_lock);
234 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
236 struct device_driver *drv = phydev->mdio.dev.driver;
237 struct phy_driver *phydrv = to_phy_driver(drv);
238 struct net_device *netdev = phydev->attached_dev;
240 if (!drv || !phydrv->suspend)
243 /* PHY not attached? May suspend if the PHY has not already been
244 * suspended as part of a prior call to phy_disconnect() ->
245 * phy_detach() -> phy_suspend() because the parent netdev might be the
246 * MDIO bus driver and clock gated at this point.
249 return !phydev->suspended;
251 if (netdev->wol_enabled)
254 /* As long as not all affected network drivers support the
255 * wol_enabled flag, let's check for hints that WoL is enabled.
256 * Don't suspend PHY if the attached netdev parent may wake up.
257 * The parent may point to a PCI device, as in tg3 driver.
259 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
262 /* Also don't suspend PHY if the netdev itself may wakeup. This
263 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
266 if (device_may_wakeup(&netdev->dev))
272 static int mdio_bus_phy_suspend(struct device *dev)
274 struct phy_device *phydev = to_phy_device(dev);
276 /* We must stop the state machine manually, otherwise it stops out of
277 * control, possibly with the phydev->lock held. Upon resume, netdev
278 * may call phy routines that try to grab the same lock, and that may
279 * lead to a deadlock.
281 if (phydev->attached_dev && phydev->adjust_link)
282 phy_stop_machine(phydev);
284 if (!mdio_bus_phy_may_suspend(phydev))
287 return phy_suspend(phydev);
290 static int mdio_bus_phy_resume(struct device *dev)
292 struct phy_device *phydev = to_phy_device(dev);
295 if (!mdio_bus_phy_may_suspend(phydev))
298 ret = phy_resume(phydev);
303 if (phydev->attached_dev && phydev->adjust_link)
304 phy_start_machine(phydev);
309 static int mdio_bus_phy_restore(struct device *dev)
311 struct phy_device *phydev = to_phy_device(dev);
312 struct net_device *netdev = phydev->attached_dev;
318 ret = phy_init_hw(phydev);
322 if (phydev->attached_dev && phydev->adjust_link)
323 phy_start_machine(phydev);
328 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
329 .suspend = mdio_bus_phy_suspend,
330 .resume = mdio_bus_phy_resume,
331 .freeze = mdio_bus_phy_suspend,
332 .thaw = mdio_bus_phy_resume,
333 .restore = mdio_bus_phy_restore,
336 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
340 #define MDIO_BUS_PHY_PM_OPS NULL
342 #endif /* CONFIG_PM */
345 * phy_register_fixup - creates a new phy_fixup and adds it to the list
346 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
347 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
348 * It can also be PHY_ANY_UID
349 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
351 * @run: The actual code to be run when a matching PHY is found
353 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
354 int (*run)(struct phy_device *))
356 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
361 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
362 fixup->phy_uid = phy_uid;
363 fixup->phy_uid_mask = phy_uid_mask;
366 mutex_lock(&phy_fixup_lock);
367 list_add_tail(&fixup->list, &phy_fixup_list);
368 mutex_unlock(&phy_fixup_lock);
372 EXPORT_SYMBOL(phy_register_fixup);
374 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
375 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
376 int (*run)(struct phy_device *))
378 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
380 EXPORT_SYMBOL(phy_register_fixup_for_uid);
382 /* Registers a fixup to be run on the PHY with id string bus_id */
383 int phy_register_fixup_for_id(const char *bus_id,
384 int (*run)(struct phy_device *))
386 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
388 EXPORT_SYMBOL(phy_register_fixup_for_id);
391 * phy_unregister_fixup - remove a phy_fixup from the list
392 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
393 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
394 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
396 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
398 struct list_head *pos, *n;
399 struct phy_fixup *fixup;
404 mutex_lock(&phy_fixup_lock);
405 list_for_each_safe(pos, n, &phy_fixup_list) {
406 fixup = list_entry(pos, struct phy_fixup, list);
408 if ((!strcmp(fixup->bus_id, bus_id)) &&
409 ((fixup->phy_uid & phy_uid_mask) ==
410 (phy_uid & phy_uid_mask))) {
411 list_del(&fixup->list);
417 mutex_unlock(&phy_fixup_lock);
421 EXPORT_SYMBOL(phy_unregister_fixup);
423 /* Unregisters a fixup of any PHY with the UID in phy_uid */
424 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
426 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
428 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
430 /* Unregisters a fixup of the PHY with id string bus_id */
431 int phy_unregister_fixup_for_id(const char *bus_id)
433 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
435 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
437 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
438 * Fixups can be set to match any in one or more fields.
440 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
442 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
443 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
446 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
447 (phydev->phy_id & fixup->phy_uid_mask))
448 if (fixup->phy_uid != PHY_ANY_UID)
454 /* Runs any matching fixups for this phydev */
455 static int phy_scan_fixups(struct phy_device *phydev)
457 struct phy_fixup *fixup;
459 mutex_lock(&phy_fixup_lock);
460 list_for_each_entry(fixup, &phy_fixup_list, list) {
461 if (phy_needs_fixup(phydev, fixup)) {
462 int err = fixup->run(phydev);
465 mutex_unlock(&phy_fixup_lock);
468 phydev->has_fixups = true;
471 mutex_unlock(&phy_fixup_lock);
476 static int phy_bus_match(struct device *dev, struct device_driver *drv)
478 struct phy_device *phydev = to_phy_device(dev);
479 struct phy_driver *phydrv = to_phy_driver(drv);
480 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
483 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
486 if (phydrv->match_phy_device)
487 return phydrv->match_phy_device(phydev);
489 if (phydev->is_c45) {
490 for (i = 1; i < num_ids; i++) {
491 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
494 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
495 (phydev->c45_ids.device_ids[i] &
496 phydrv->phy_id_mask))
501 return (phydrv->phy_id & phydrv->phy_id_mask) ==
502 (phydev->phy_id & phydrv->phy_id_mask);
507 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
509 struct phy_device *phydev = to_phy_device(dev);
511 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
513 static DEVICE_ATTR_RO(phy_id);
516 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
518 struct phy_device *phydev = to_phy_device(dev);
519 const char *mode = NULL;
521 if (phy_is_internal(phydev))
524 mode = phy_modes(phydev->interface);
526 return sprintf(buf, "%s\n", mode);
528 static DEVICE_ATTR_RO(phy_interface);
531 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
534 struct phy_device *phydev = to_phy_device(dev);
536 return sprintf(buf, "%d\n", phydev->has_fixups);
538 static DEVICE_ATTR_RO(phy_has_fixups);
540 static struct attribute *phy_dev_attrs[] = {
541 &dev_attr_phy_id.attr,
542 &dev_attr_phy_interface.attr,
543 &dev_attr_phy_has_fixups.attr,
546 ATTRIBUTE_GROUPS(phy_dev);
548 static const struct device_type mdio_bus_phy_type = {
550 .groups = phy_dev_groups,
551 .release = phy_device_release,
552 .pm = MDIO_BUS_PHY_PM_OPS,
555 static int phy_request_driver_module(struct phy_device *dev, int phy_id)
559 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
560 MDIO_ID_ARGS(phy_id));
561 /* We only check for failures in executing the usermode binary,
562 * not whether a PHY driver module exists for the PHY ID.
563 * Accept -ENOENT because this may occur in case no initramfs exists,
564 * then modprobe isn't available.
566 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
567 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08x\n",
575 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
577 struct phy_c45_device_ids *c45_ids)
579 struct phy_device *dev;
580 struct mdio_device *mdiodev;
583 /* We allocate the device, and initialize the default values */
584 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
586 return ERR_PTR(-ENOMEM);
588 mdiodev = &dev->mdio;
589 mdiodev->dev.parent = &bus->dev;
590 mdiodev->dev.bus = &mdio_bus_type;
591 mdiodev->dev.type = &mdio_bus_phy_type;
593 mdiodev->bus_match = phy_bus_match;
594 mdiodev->addr = addr;
595 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
596 mdiodev->device_free = phy_mdio_device_free;
597 mdiodev->device_remove = phy_mdio_device_remove;
604 dev->interface = PHY_INTERFACE_MODE_GMII;
606 dev->autoneg = AUTONEG_ENABLE;
608 dev->is_c45 = is_c45;
609 dev->phy_id = phy_id;
611 dev->c45_ids = *c45_ids;
612 dev->irq = bus->irq[addr];
613 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
615 dev->state = PHY_DOWN;
617 mutex_init(&dev->lock);
618 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
620 /* Request the appropriate module unconditionally; don't
621 * bother trying to do so only if it isn't already loaded,
622 * because that gets complicated. A hotplug event would have
623 * done an unconditional modprobe anyway.
624 * We don't do normal hotplug because it won't work for MDIO
625 * -- because it relies on the device staying around for long
626 * enough for the driver to get loaded. With MDIO, the NIC
627 * driver will get bored and give up as soon as it finds that
628 * there's no driver _already_ loaded.
630 if (is_c45 && c45_ids) {
631 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
634 for (i = 1; i < num_ids; i++) {
635 if (!(c45_ids->devices_in_package & (1 << i)))
638 ret = phy_request_driver_module(dev,
639 c45_ids->device_ids[i]);
644 ret = phy_request_driver_module(dev, phy_id);
648 device_initialize(&mdiodev->dev);
656 EXPORT_SYMBOL(phy_device_create);
658 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
659 * @bus: the target MII bus
660 * @addr: PHY address on the MII bus
661 * @dev_addr: MMD address in the PHY.
662 * @devices_in_package: where to store the devices in package information.
664 * Description: reads devices in package registers of a MMD at @dev_addr
665 * from PHY at @addr on @bus.
667 * Returns: 0 on success, -EIO on failure.
669 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
670 u32 *devices_in_package)
672 int phy_reg, reg_addr;
674 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
675 phy_reg = mdiobus_read(bus, addr, reg_addr);
678 *devices_in_package = phy_reg << 16;
680 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
681 phy_reg = mdiobus_read(bus, addr, reg_addr);
684 *devices_in_package |= phy_reg;
686 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
687 *devices_in_package &= ~BIT(0);
693 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
694 * @bus: the target MII bus
695 * @addr: PHY address on the MII bus
696 * @phy_id: where to store the ID retrieved.
697 * @c45_ids: where to store the c45 ID information.
699 * If the PHY devices-in-package appears to be valid, it and the
700 * corresponding identifiers are stored in @c45_ids, zero is stored
701 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
705 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
706 struct phy_c45_device_ids *c45_ids) {
709 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
710 u32 *devs = &c45_ids->devices_in_package;
712 /* Find first non-zero Devices In package. Device zero is reserved
713 * for 802.3 c45 complied PHYs, so don't probe it at first.
715 for (i = 1; i < num_ids && *devs == 0; i++) {
716 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
720 if ((*devs & 0x1fffffff) == 0x1fffffff) {
721 /* If mostly Fs, there is no device there,
722 * then let's continue to probe more, as some
723 * 10G PHYs have zero Devices In package,
724 * e.g. Cortina CS4315/CS4340 PHY.
726 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
729 /* no device there, let's get out of here */
730 if ((*devs & 0x1fffffff) == 0x1fffffff) {
731 *phy_id = 0xffffffff;
739 /* Now probe Device Identifiers for each device present. */
740 for (i = 1; i < num_ids; i++) {
741 if (!(c45_ids->devices_in_package & (1 << i)))
744 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
745 phy_reg = mdiobus_read(bus, addr, reg_addr);
748 c45_ids->device_ids[i] = phy_reg << 16;
750 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
751 phy_reg = mdiobus_read(bus, addr, reg_addr);
754 c45_ids->device_ids[i] |= phy_reg;
761 * get_phy_id - reads the specified addr for its ID.
762 * @bus: the target MII bus
763 * @addr: PHY address on the MII bus
764 * @phy_id: where to store the ID retrieved.
765 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
766 * @c45_ids: where to store the c45 ID information.
768 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
769 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
772 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
773 * its return value is in turn returned.
776 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
777 bool is_c45, struct phy_c45_device_ids *c45_ids)
782 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
784 /* Grab the bits from PHYIR1, and put them in the upper half */
785 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
787 /* returning -ENODEV doesn't stop bus scanning */
788 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
791 *phy_id = phy_reg << 16;
793 /* Grab the bits from PHYIR2, and put them in the lower half */
794 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
804 * get_phy_device - reads the specified PHY device and returns its @phy_device
806 * @bus: the target MII bus
807 * @addr: PHY address on the MII bus
808 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
810 * Description: Reads the ID registers of the PHY at @addr on the
811 * @bus, then allocates and returns the phy_device to represent it.
813 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
815 struct phy_c45_device_ids c45_ids = {0};
819 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
823 /* If the phy_id is mostly Fs, there is no device there */
824 if ((phy_id & 0x1fffffff) == 0x1fffffff)
825 return ERR_PTR(-ENODEV);
827 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
829 EXPORT_SYMBOL(get_phy_device);
832 * phy_device_register - Register the phy device on the MDIO bus
833 * @phydev: phy_device structure to be added to the MDIO bus
835 int phy_device_register(struct phy_device *phydev)
839 err = mdiobus_register_device(&phydev->mdio);
843 /* Deassert the reset signal */
844 phy_device_reset(phydev, 0);
846 /* Run all of the fixups for this PHY */
847 err = phy_scan_fixups(phydev);
849 phydev_err(phydev, "failed to initialize\n");
853 err = device_add(&phydev->mdio.dev);
855 phydev_err(phydev, "failed to add\n");
862 /* Assert the reset signal */
863 phy_device_reset(phydev, 1);
865 mdiobus_unregister_device(&phydev->mdio);
868 EXPORT_SYMBOL(phy_device_register);
871 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
872 * @phydev: phy_device structure to remove
874 * This doesn't free the phy_device itself, it merely reverses the effects
875 * of phy_device_register(). Use phy_device_free() to free the device
876 * after calling this function.
878 void phy_device_remove(struct phy_device *phydev)
880 device_del(&phydev->mdio.dev);
882 /* Assert the reset signal */
883 phy_device_reset(phydev, 1);
885 mdiobus_unregister_device(&phydev->mdio);
887 EXPORT_SYMBOL(phy_device_remove);
890 * phy_find_first - finds the first PHY device on the bus
891 * @bus: the target MII bus
893 struct phy_device *phy_find_first(struct mii_bus *bus)
895 struct phy_device *phydev;
898 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
899 phydev = mdiobus_get_phy(bus, addr);
905 EXPORT_SYMBOL(phy_find_first);
907 static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
909 struct net_device *netdev = phydev->attached_dev;
913 netif_carrier_on(netdev);
915 netif_carrier_off(netdev);
917 phydev->adjust_link(netdev);
921 * phy_prepare_link - prepares the PHY layer to monitor link status
922 * @phydev: target phy_device struct
923 * @handler: callback function for link status change notifications
925 * Description: Tells the PHY infrastructure to handle the
926 * gory details on monitoring link status (whether through
927 * polling or an interrupt), and to call back to the
928 * connected device driver when the link status changes.
929 * If you want to monitor your own link state, don't call
932 static void phy_prepare_link(struct phy_device *phydev,
933 void (*handler)(struct net_device *))
935 phydev->adjust_link = handler;
939 * phy_connect_direct - connect an ethernet device to a specific phy_device
940 * @dev: the network device to connect
941 * @phydev: the pointer to the phy device
942 * @handler: callback function for state change notifications
943 * @interface: PHY device's interface
945 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
946 void (*handler)(struct net_device *),
947 phy_interface_t interface)
954 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
958 phy_prepare_link(phydev, handler);
959 if (phy_interrupt_is_valid(phydev))
960 phy_request_interrupt(phydev);
964 EXPORT_SYMBOL(phy_connect_direct);
967 * phy_connect - connect an ethernet device to a PHY device
968 * @dev: the network device to connect
969 * @bus_id: the id string of the PHY device to connect
970 * @handler: callback function for state change notifications
971 * @interface: PHY device's interface
973 * Description: Convenience function for connecting ethernet
974 * devices to PHY devices. The default behavior is for
975 * the PHY infrastructure to handle everything, and only notify
976 * the connected driver when the link status changes. If you
977 * don't want, or can't use the provided functionality, you may
978 * choose to call only the subset of functions which provide
979 * the desired functionality.
981 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
982 void (*handler)(struct net_device *),
983 phy_interface_t interface)
985 struct phy_device *phydev;
989 /* Search the list of PHY devices on the mdio bus for the
990 * PHY with the requested name
992 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
994 pr_err("PHY %s not found\n", bus_id);
995 return ERR_PTR(-ENODEV);
997 phydev = to_phy_device(d);
999 rc = phy_connect_direct(dev, phydev, handler, interface);
1006 EXPORT_SYMBOL(phy_connect);
1009 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1011 * @phydev: target phy_device struct
1013 void phy_disconnect(struct phy_device *phydev)
1015 if (phy_is_started(phydev))
1018 if (phy_interrupt_is_valid(phydev))
1019 phy_free_interrupt(phydev);
1021 phydev->adjust_link = NULL;
1025 EXPORT_SYMBOL(phy_disconnect);
1028 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1029 * @phydev: The PHY device to poll
1031 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1032 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1033 * register must be polled until the BMCR_RESET bit clears.
1035 * Furthermore, any attempts to write to PHY registers may have no effect
1036 * or even generate MDIO bus errors until this is complete.
1038 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1039 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1040 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1041 * effort to support such broken PHYs, this function is separate from the
1042 * standard phy_init_hw() which will zero all the other bits in the BMCR
1043 * and reapply all driver-specific and board-specific fixups.
1045 static int phy_poll_reset(struct phy_device *phydev)
1047 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1048 unsigned int retries = 12;
1053 ret = phy_read(phydev, MII_BMCR);
1056 } while (ret & BMCR_RESET && --retries);
1057 if (ret & BMCR_RESET)
1060 /* Some chips (smsc911x) may still need up to another 1ms after the
1061 * BMCR_RESET bit is cleared before they are usable.
1067 int phy_init_hw(struct phy_device *phydev)
1071 /* Deassert the reset signal */
1072 phy_device_reset(phydev, 0);
1077 if (phydev->drv->soft_reset)
1078 ret = phydev->drv->soft_reset(phydev);
1083 ret = phy_scan_fixups(phydev);
1087 if (phydev->drv->config_init)
1088 ret = phydev->drv->config_init(phydev);
1092 EXPORT_SYMBOL(phy_init_hw);
1094 void phy_attached_info(struct phy_device *phydev)
1096 phy_attached_print(phydev, NULL);
1098 EXPORT_SYMBOL(phy_attached_info);
1100 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1101 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1103 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1107 switch(phydev->irq) {
1111 case PHY_IGNORE_INTERRUPT:
1115 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1122 phydev_info(phydev, ATTACHED_FMT "\n",
1123 drv_name, phydev_name(phydev),
1128 phydev_info(phydev, ATTACHED_FMT,
1129 drv_name, phydev_name(phydev),
1137 EXPORT_SYMBOL(phy_attached_print);
1139 static void phy_sysfs_create_links(struct phy_device *phydev)
1141 struct net_device *dev = phydev->attached_dev;
1147 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1152 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1153 &phydev->mdio.dev.kobj,
1156 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1157 kobject_name(&phydev->mdio.dev.kobj),
1159 /* non-fatal - some net drivers can use one netdevice
1160 * with more then one phy
1164 phydev->sysfs_links = true;
1168 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1171 struct phy_device *phydev = to_phy_device(dev);
1173 return sprintf(buf, "%d\n", !phydev->attached_dev);
1175 static DEVICE_ATTR_RO(phy_standalone);
1178 * phy_attach_direct - attach a network device to a given PHY device pointer
1179 * @dev: network device to attach
1180 * @phydev: Pointer to phy_device to attach
1181 * @flags: PHY device's dev_flags
1182 * @interface: PHY device's interface
1184 * Description: Called by drivers to attach to a particular PHY
1185 * device. The phy_device is found, and properly hooked up
1186 * to the phy_driver. If no driver is attached, then a
1187 * generic driver is used. The phy_device is given a ptr to
1188 * the attaching device, and given a callback for link status
1189 * change. The phy_device is returned to the attaching driver.
1190 * This function takes a reference on the phy device.
1192 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1193 u32 flags, phy_interface_t interface)
1195 struct mii_bus *bus = phydev->mdio.bus;
1196 struct device *d = &phydev->mdio.dev;
1197 struct module *ndev_owner = NULL;
1198 bool using_genphy = false;
1201 /* For Ethernet device drivers that register their own MDIO bus, we
1202 * will have bus->owner match ndev_mod, so we do not want to increment
1203 * our own module->refcnt here, otherwise we would not be able to
1207 ndev_owner = dev->dev.parent->driver->owner;
1208 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1209 phydev_err(phydev, "failed to get the bus module\n");
1215 /* Assume that if there is no driver, that it doesn't
1216 * exist, and we should use the genphy driver.
1220 d->driver = &genphy_c45_driver.mdiodrv.driver;
1222 d->driver = &genphy_driver.mdiodrv.driver;
1224 using_genphy = true;
1227 if (!try_module_get(d->driver->owner)) {
1228 phydev_err(phydev, "failed to get the device driver module\n");
1230 goto error_put_device;
1234 err = d->driver->probe(d);
1236 err = device_bind_driver(d);
1239 goto error_module_put;
1242 if (phydev->attached_dev) {
1243 dev_err(&dev->dev, "PHY already attached\n");
1248 phydev->phy_link_change = phy_link_change;
1250 phydev->attached_dev = dev;
1251 dev->phydev = phydev;
1254 /* Some Ethernet drivers try to connect to a PHY device before
1255 * calling register_netdevice() -> netdev_register_kobject() and
1256 * does the dev->dev.kobj initialization. Here we only check for
1257 * success which indicates that the network device kobject is
1258 * ready. Once we do that we still need to keep track of whether
1259 * links were successfully set up or not for phy_detach() to
1260 * remove them accordingly.
1262 phydev->sysfs_links = false;
1264 phy_sysfs_create_links(phydev);
1266 if (!phydev->attached_dev) {
1267 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1268 &dev_attr_phy_standalone.attr);
1270 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1273 phydev->dev_flags = flags;
1275 phydev->interface = interface;
1277 phydev->state = PHY_READY;
1279 /* Initial carrier state is off as the phy is about to be
1283 netif_carrier_off(phydev->attached_dev);
1285 /* Do initial configuration here, now that
1286 * we have certain key parameters
1287 * (dev_flags and interface)
1289 err = phy_init_hw(phydev);
1294 phy_led_triggers_register(phydev);
1299 /* phy_detach() does all of the cleanup below */
1304 module_put(d->driver->owner);
1307 if (ndev_owner != bus->owner)
1308 module_put(bus->owner);
1311 EXPORT_SYMBOL(phy_attach_direct);
1314 * phy_attach - attach a network device to a particular PHY device
1315 * @dev: network device to attach
1316 * @bus_id: Bus ID of PHY device to attach
1317 * @interface: PHY device's interface
1319 * Description: Same as phy_attach_direct() except that a PHY bus_id
1320 * string is passed instead of a pointer to a struct phy_device.
1322 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1323 phy_interface_t interface)
1325 struct bus_type *bus = &mdio_bus_type;
1326 struct phy_device *phydev;
1331 return ERR_PTR(-EINVAL);
1333 /* Search the list of PHY devices on the mdio bus for the
1334 * PHY with the requested name
1336 d = bus_find_device_by_name(bus, NULL, bus_id);
1338 pr_err("PHY %s not found\n", bus_id);
1339 return ERR_PTR(-ENODEV);
1341 phydev = to_phy_device(d);
1343 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1350 EXPORT_SYMBOL(phy_attach);
1352 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1353 struct device_driver *driver)
1355 struct device *d = &phydev->mdio.dev;
1362 ret = d->driver == driver;
1368 bool phy_driver_is_genphy(struct phy_device *phydev)
1370 return phy_driver_is_genphy_kind(phydev,
1371 &genphy_driver.mdiodrv.driver);
1373 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1375 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1377 return phy_driver_is_genphy_kind(phydev,
1378 &genphy_c45_driver.mdiodrv.driver);
1380 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1383 * phy_detach - detach a PHY device from its network device
1384 * @phydev: target phy_device struct
1386 * This detaches the phy device from its network device and the phy
1387 * driver, and drops the reference count taken in phy_attach_direct().
1389 void phy_detach(struct phy_device *phydev)
1391 struct net_device *dev = phydev->attached_dev;
1392 struct module *ndev_owner = NULL;
1393 struct mii_bus *bus;
1395 if (phydev->sysfs_links) {
1397 sysfs_remove_link(&dev->dev.kobj, "phydev");
1398 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1401 if (!phydev->attached_dev)
1402 sysfs_remove_file(&phydev->mdio.dev.kobj,
1403 &dev_attr_phy_standalone.attr);
1405 phy_suspend(phydev);
1407 phydev->attached_dev->phydev = NULL;
1408 phydev->attached_dev = NULL;
1410 phydev->phylink = NULL;
1412 phy_led_triggers_unregister(phydev);
1414 module_put(phydev->mdio.dev.driver->owner);
1416 /* If the device had no specific driver before (i.e. - it
1417 * was using the generic driver), we unbind the device
1418 * from the generic driver so that there's a chance a
1419 * real driver could be loaded
1421 if (phy_driver_is_genphy(phydev) ||
1422 phy_driver_is_genphy_10g(phydev))
1423 device_release_driver(&phydev->mdio.dev);
1426 * The phydev might go away on the put_device() below, so avoid
1427 * a use-after-free bug by reading the underlying bus first.
1429 bus = phydev->mdio.bus;
1431 put_device(&phydev->mdio.dev);
1433 ndev_owner = dev->dev.parent->driver->owner;
1434 if (ndev_owner != bus->owner)
1435 module_put(bus->owner);
1437 /* Assert the reset signal */
1438 phy_device_reset(phydev, 1);
1440 EXPORT_SYMBOL(phy_detach);
1442 int phy_suspend(struct phy_device *phydev)
1444 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1445 struct net_device *netdev = phydev->attached_dev;
1446 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1449 /* If the device has WOL enabled, we cannot suspend the PHY */
1450 phy_ethtool_get_wol(phydev, &wol);
1451 if (wol.wolopts || (netdev && netdev->wol_enabled))
1454 if (phydev->drv && phydrv->suspend)
1455 ret = phydrv->suspend(phydev);
1460 phydev->suspended = true;
1464 EXPORT_SYMBOL(phy_suspend);
1466 int __phy_resume(struct phy_device *phydev)
1468 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1471 WARN_ON(!mutex_is_locked(&phydev->lock));
1473 if (phydev->drv && phydrv->resume)
1474 ret = phydrv->resume(phydev);
1479 phydev->suspended = false;
1483 EXPORT_SYMBOL(__phy_resume);
1485 int phy_resume(struct phy_device *phydev)
1489 mutex_lock(&phydev->lock);
1490 ret = __phy_resume(phydev);
1491 mutex_unlock(&phydev->lock);
1495 EXPORT_SYMBOL(phy_resume);
1497 int phy_loopback(struct phy_device *phydev, bool enable)
1499 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1502 mutex_lock(&phydev->lock);
1504 if (enable && phydev->loopback_enabled) {
1509 if (!enable && !phydev->loopback_enabled) {
1514 if (phydev->drv && phydrv->set_loopback)
1515 ret = phydrv->set_loopback(phydev, enable);
1522 phydev->loopback_enabled = enable;
1525 mutex_unlock(&phydev->lock);
1528 EXPORT_SYMBOL(phy_loopback);
1531 * phy_reset_after_clk_enable - perform a PHY reset if needed
1532 * @phydev: target phy_device struct
1534 * Description: Some PHYs are known to need a reset after their refclk was
1535 * enabled. This function evaluates the flags and perform the reset if it's
1536 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1539 int phy_reset_after_clk_enable(struct phy_device *phydev)
1541 if (!phydev || !phydev->drv)
1544 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1545 phy_device_reset(phydev, 1);
1546 phy_device_reset(phydev, 0);
1552 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1554 /* Generic PHY support and helper functions */
1557 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1558 * @phydev: target phy_device struct
1560 * Description: Writes MII_ADVERTISE with the appropriate values,
1561 * after sanitizing the values to make sure we only advertise
1562 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1563 * hasn't changed, and > 0 if it has changed.
1565 static int genphy_config_advert(struct phy_device *phydev)
1567 int err, bmsr, changed = 0;
1570 /* Only allow advertising what this PHY supports */
1571 linkmode_and(phydev->advertising, phydev->advertising,
1574 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1576 /* Setup standard advertisement */
1577 err = phy_modify_changed(phydev, MII_ADVERTISE,
1578 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1579 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1586 bmsr = phy_read(phydev, MII_BMSR);
1590 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1591 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1594 if (!(bmsr & BMSR_ESTATEN))
1597 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1599 err = phy_modify_changed(phydev, MII_CTRL1000,
1600 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1611 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1612 * @phydev: target phy_device struct
1614 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1615 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1616 * changed, and 1 if it has changed.
1618 int genphy_config_eee_advert(struct phy_device *phydev)
1622 /* Nothing to disable */
1623 if (!phydev->eee_broken_modes)
1626 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1627 phydev->eee_broken_modes, 0);
1628 /* If the call failed, we assume that EEE is not supported */
1629 return err < 0 ? 0 : err;
1631 EXPORT_SYMBOL(genphy_config_eee_advert);
1634 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1635 * @phydev: target phy_device struct
1637 * Description: Configures MII_BMCR to force speed/duplex
1638 * to the values in phydev. Assumes that the values are valid.
1639 * Please see phy_sanitize_settings().
1641 int genphy_setup_forced(struct phy_device *phydev)
1646 phydev->asym_pause = 0;
1648 if (SPEED_1000 == phydev->speed)
1649 ctl |= BMCR_SPEED1000;
1650 else if (SPEED_100 == phydev->speed)
1651 ctl |= BMCR_SPEED100;
1653 if (DUPLEX_FULL == phydev->duplex)
1654 ctl |= BMCR_FULLDPLX;
1656 return phy_modify(phydev, MII_BMCR,
1657 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1659 EXPORT_SYMBOL(genphy_setup_forced);
1662 * genphy_restart_aneg - Enable and Restart Autonegotiation
1663 * @phydev: target phy_device struct
1665 int genphy_restart_aneg(struct phy_device *phydev)
1667 /* Don't isolate the PHY if we're negotiating */
1668 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1669 BMCR_ANENABLE | BMCR_ANRESTART);
1671 EXPORT_SYMBOL(genphy_restart_aneg);
1674 * __genphy_config_aneg - restart auto-negotiation or write BMCR
1675 * @phydev: target phy_device struct
1676 * @changed: whether autoneg is requested
1678 * Description: If auto-negotiation is enabled, we configure the
1679 * advertising, and then restart auto-negotiation. If it is not
1680 * enabled, then we write the BMCR.
1682 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
1686 if (genphy_config_eee_advert(phydev))
1689 if (AUTONEG_ENABLE != phydev->autoneg)
1690 return genphy_setup_forced(phydev);
1692 err = genphy_config_advert(phydev);
1693 if (err < 0) /* error */
1699 /* Advertisement hasn't changed, but maybe aneg was never on to
1700 * begin with? Or maybe phy was isolated?
1702 int ctl = phy_read(phydev, MII_BMCR);
1707 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1708 changed = true; /* do restart aneg */
1711 /* Only restart aneg if we are advertising something different
1712 * than we were before.
1714 return changed ? genphy_restart_aneg(phydev) : 0;
1716 EXPORT_SYMBOL(__genphy_config_aneg);
1719 * genphy_aneg_done - return auto-negotiation status
1720 * @phydev: target phy_device struct
1722 * Description: Reads the status register and returns 0 either if
1723 * auto-negotiation is incomplete, or if there was an error.
1724 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1726 int genphy_aneg_done(struct phy_device *phydev)
1728 int retval = phy_read(phydev, MII_BMSR);
1730 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1732 EXPORT_SYMBOL(genphy_aneg_done);
1735 * genphy_update_link - update link status in @phydev
1736 * @phydev: target phy_device struct
1738 * Description: Update the value in phydev->link to reflect the
1739 * current link value. In order to do this, we need to read
1740 * the status register twice, keeping the second value.
1742 int genphy_update_link(struct phy_device *phydev)
1744 int status = 0, bmcr;
1746 bmcr = phy_read(phydev, MII_BMCR);
1750 /* Autoneg is being started, therefore disregard BMSR value and
1751 * report link as down.
1753 if (bmcr & BMCR_ANRESTART)
1756 /* The link state is latched low so that momentary link
1757 * drops can be detected. Do not double-read the status
1758 * in polling mode to detect such short link drops.
1760 if (!phy_polling_mode(phydev)) {
1761 status = phy_read(phydev, MII_BMSR);
1764 else if (status & BMSR_LSTATUS)
1768 /* Read link and autonegotiation status */
1769 status = phy_read(phydev, MII_BMSR);
1773 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
1774 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
1776 /* Consider the case that autoneg was started and "aneg complete"
1777 * bit has been reset, but "link up" bit not yet.
1779 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
1784 EXPORT_SYMBOL(genphy_update_link);
1787 * genphy_read_status - check the link status and update current link state
1788 * @phydev: target phy_device struct
1790 * Description: Check the link, then figure out the current state
1791 * by comparing what we advertise with what the link partner
1792 * advertises. Start by checking the gigabit possibilities,
1793 * then move on to 10/100.
1795 int genphy_read_status(struct phy_device *phydev)
1797 int lpa, lpagb, err, old_link = phydev->link;
1799 /* Update the link, but return if there was an error */
1800 err = genphy_update_link(phydev);
1804 /* why bother the PHY if nothing can have changed */
1805 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
1808 phydev->speed = SPEED_UNKNOWN;
1809 phydev->duplex = DUPLEX_UNKNOWN;
1811 phydev->asym_pause = 0;
1813 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
1814 if (phydev->is_gigabit_capable) {
1815 lpagb = phy_read(phydev, MII_STAT1000);
1819 if (lpagb & LPA_1000MSFAIL) {
1820 int adv = phy_read(phydev, MII_CTRL1000);
1825 if (adv & CTL1000_ENABLE_MASTER)
1826 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1828 phydev_err(phydev, "Master/Slave resolution failed\n");
1832 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1836 lpa = phy_read(phydev, MII_LPA);
1840 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
1841 phy_resolve_aneg_linkmode(phydev);
1842 } else if (phydev->autoneg == AUTONEG_DISABLE) {
1843 int bmcr = phy_read(phydev, MII_BMCR);
1848 if (bmcr & BMCR_FULLDPLX)
1849 phydev->duplex = DUPLEX_FULL;
1851 phydev->duplex = DUPLEX_HALF;
1853 if (bmcr & BMCR_SPEED1000)
1854 phydev->speed = SPEED_1000;
1855 else if (bmcr & BMCR_SPEED100)
1856 phydev->speed = SPEED_100;
1858 phydev->speed = SPEED_10;
1863 EXPORT_SYMBOL(genphy_read_status);
1866 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1867 * @phydev: target phy_device struct
1869 * Description: Perform a software PHY reset using the standard
1870 * BMCR_RESET bit and poll for the reset bit to be cleared.
1872 * Returns: 0 on success, < 0 on failure
1874 int genphy_soft_reset(struct phy_device *phydev)
1876 u16 res = BMCR_RESET;
1879 if (phydev->autoneg == AUTONEG_ENABLE)
1880 res |= BMCR_ANRESTART;
1882 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
1886 ret = phy_poll_reset(phydev);
1890 /* BMCR may be reset to defaults */
1891 if (phydev->autoneg == AUTONEG_DISABLE)
1892 ret = genphy_setup_forced(phydev);
1896 EXPORT_SYMBOL(genphy_soft_reset);
1899 * genphy_read_abilities - read PHY abilities from Clause 22 registers
1900 * @phydev: target phy_device struct
1902 * Description: Reads the PHY's abilities and populates
1903 * phydev->supported accordingly.
1905 * Returns: 0 on success, < 0 on failure
1907 int genphy_read_abilities(struct phy_device *phydev)
1911 linkmode_set_bit_array(phy_basic_ports_array,
1912 ARRAY_SIZE(phy_basic_ports_array),
1915 val = phy_read(phydev, MII_BMSR);
1919 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
1920 val & BMSR_ANEGCAPABLE);
1922 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
1923 val & BMSR_100FULL);
1924 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
1925 val & BMSR_100HALF);
1926 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
1928 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
1931 if (val & BMSR_ESTATEN) {
1932 val = phy_read(phydev, MII_ESTATUS);
1936 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1937 phydev->supported, val & ESTATUS_1000_TFULL);
1938 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1939 phydev->supported, val & ESTATUS_1000_THALF);
1940 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1941 phydev->supported, val & ESTATUS_1000_XFULL);
1946 EXPORT_SYMBOL(genphy_read_abilities);
1948 /* This is used for the phy device which doesn't support the MMD extended
1949 * register access, but it does have side effect when we are trying to access
1950 * the MMD register via indirect method.
1952 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
1956 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
1958 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1959 u16 regnum, u16 val)
1963 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
1965 int genphy_suspend(struct phy_device *phydev)
1967 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
1969 EXPORT_SYMBOL(genphy_suspend);
1971 int genphy_resume(struct phy_device *phydev)
1973 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
1975 EXPORT_SYMBOL(genphy_resume);
1977 int genphy_loopback(struct phy_device *phydev, bool enable)
1979 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
1980 enable ? BMCR_LOOPBACK : 0);
1982 EXPORT_SYMBOL(genphy_loopback);
1985 * phy_remove_link_mode - Remove a supported link mode
1986 * @phydev: phy_device structure to remove link mode from
1987 * @link_mode: Link mode to be removed
1989 * Description: Some MACs don't support all link modes which the PHY
1990 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
1991 * to remove a link mode.
1993 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
1995 linkmode_clear_bit(link_mode, phydev->supported);
1996 phy_advertise_supported(phydev);
1998 EXPORT_SYMBOL(phy_remove_link_mode);
2000 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2002 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2003 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2004 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2005 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2009 * phy_advertise_supported - Advertise all supported modes
2010 * @phydev: target phy_device struct
2012 * Description: Called to advertise all supported modes, doesn't touch
2013 * pause mode advertising.
2015 void phy_advertise_supported(struct phy_device *phydev)
2017 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2019 linkmode_copy(new, phydev->supported);
2020 phy_copy_pause_bits(new, phydev->advertising);
2021 linkmode_copy(phydev->advertising, new);
2023 EXPORT_SYMBOL(phy_advertise_supported);
2026 * phy_support_sym_pause - Enable support of symmetrical pause
2027 * @phydev: target phy_device struct
2029 * Description: Called by the MAC to indicate is supports symmetrical
2030 * Pause, but not asym pause.
2032 void phy_support_sym_pause(struct phy_device *phydev)
2034 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2035 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2037 EXPORT_SYMBOL(phy_support_sym_pause);
2040 * phy_support_asym_pause - Enable support of asym pause
2041 * @phydev: target phy_device struct
2043 * Description: Called by the MAC to indicate is supports Asym Pause.
2045 void phy_support_asym_pause(struct phy_device *phydev)
2047 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2049 EXPORT_SYMBOL(phy_support_asym_pause);
2052 * phy_set_sym_pause - Configure symmetric Pause
2053 * @phydev: target phy_device struct
2054 * @rx: Receiver Pause is supported
2055 * @tx: Transmit Pause is supported
2056 * @autoneg: Auto neg should be used
2058 * Description: Configure advertised Pause support depending on if
2059 * receiver pause and pause auto neg is supported. Generally called
2060 * from the set_pauseparam .ndo.
2062 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2065 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2067 if (rx && tx && autoneg)
2068 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2071 linkmode_copy(phydev->advertising, phydev->supported);
2073 EXPORT_SYMBOL(phy_set_sym_pause);
2076 * phy_set_asym_pause - Configure Pause and Asym Pause
2077 * @phydev: target phy_device struct
2078 * @rx: Receiver Pause is supported
2079 * @tx: Transmit Pause is supported
2081 * Description: Configure advertised Pause support depending on if
2082 * transmit and receiver pause is supported. If there has been a
2083 * change in adverting, trigger a new autoneg. Generally called from
2084 * the set_pauseparam .ndo.
2086 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2088 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2090 linkmode_copy(oldadv, phydev->advertising);
2092 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2093 phydev->advertising);
2094 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2095 phydev->advertising);
2098 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2099 phydev->advertising);
2100 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2101 phydev->advertising);
2105 linkmode_change_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2106 phydev->advertising);
2108 if (!linkmode_equal(oldadv, phydev->advertising) &&
2110 phy_start_aneg(phydev);
2112 EXPORT_SYMBOL(phy_set_asym_pause);
2115 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2116 * @phydev: phy_device struct
2117 * @pp: requested pause configuration
2119 * Description: Test if the PHY/MAC combination supports the Pause
2120 * configuration the user is requesting. Returns True if it is
2121 * supported, false otherwise.
2123 bool phy_validate_pause(struct phy_device *phydev,
2124 struct ethtool_pauseparam *pp)
2126 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2127 phydev->supported) && pp->rx_pause)
2130 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2131 phydev->supported) &&
2132 pp->rx_pause != pp->tx_pause)
2137 EXPORT_SYMBOL(phy_validate_pause);
2139 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2141 return phydrv->config_intr && phydrv->ack_interrupt;
2145 * phy_probe - probe and init a PHY device
2146 * @dev: device to probe and init
2148 * Description: Take care of setting up the phy_device structure,
2149 * set the state to READY (the driver's init function should
2150 * set it to STARTING if needed).
2152 static int phy_probe(struct device *dev)
2154 struct phy_device *phydev = to_phy_device(dev);
2155 struct device_driver *drv = phydev->mdio.dev.driver;
2156 struct phy_driver *phydrv = to_phy_driver(drv);
2159 phydev->drv = phydrv;
2161 /* Disable the interrupt if the PHY doesn't support it
2162 * but the interrupt is still a valid one
2164 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2165 phydev->irq = PHY_POLL;
2167 if (phydrv->flags & PHY_IS_INTERNAL)
2168 phydev->is_internal = true;
2170 mutex_lock(&phydev->lock);
2172 if (phydev->drv->probe) {
2173 /* Deassert the reset signal */
2174 phy_device_reset(phydev, 0);
2176 err = phydev->drv->probe(phydev);
2178 /* Assert the reset signal */
2179 phy_device_reset(phydev, 1);
2184 /* Start out supporting everything. Eventually,
2185 * a controller will attach, and may modify one
2186 * or both of these values
2188 if (phydrv->features) {
2189 linkmode_copy(phydev->supported, phydrv->features);
2190 } else if (phydrv->get_features) {
2191 err = phydrv->get_features(phydev);
2192 } else if (phydev->is_c45) {
2193 err = genphy_c45_pma_read_abilities(phydev);
2195 err = genphy_read_abilities(phydev);
2201 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2203 phydev->autoneg = 0;
2205 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2207 phydev->is_gigabit_capable = 1;
2208 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2210 phydev->is_gigabit_capable = 1;
2212 of_set_phy_supported(phydev);
2213 phy_advertise_supported(phydev);
2215 /* Get the EEE modes we want to prohibit. We will ask
2216 * the PHY stop advertising these mode later on
2218 of_set_phy_eee_broken(phydev);
2220 /* The Pause Frame bits indicate that the PHY can support passing
2221 * pause frames. During autonegotiation, the PHYs will determine if
2222 * they should allow pause frames to pass. The MAC driver should then
2223 * use that result to determine whether to enable flow control via
2226 * Normally, PHY drivers should not set the Pause bits, and instead
2227 * allow phylib to do that. However, there may be some situations
2228 * (e.g. hardware erratum) where the driver wants to set only one
2231 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2232 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2233 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2235 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2239 /* Set the state to READY by default */
2240 phydev->state = PHY_READY;
2243 mutex_unlock(&phydev->lock);
2248 static int phy_remove(struct device *dev)
2250 struct phy_device *phydev = to_phy_device(dev);
2252 cancel_delayed_work_sync(&phydev->state_queue);
2254 mutex_lock(&phydev->lock);
2255 phydev->state = PHY_DOWN;
2256 mutex_unlock(&phydev->lock);
2258 if (phydev->drv && phydev->drv->remove) {
2259 phydev->drv->remove(phydev);
2261 /* Assert the reset signal */
2262 phy_device_reset(phydev, 1);
2270 * phy_driver_register - register a phy_driver with the PHY layer
2271 * @new_driver: new phy_driver to register
2272 * @owner: module owning this PHY
2274 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2278 /* Either the features are hard coded, or dynamically
2279 * determined. It cannot be both.
2281 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2282 pr_err("%s: features and get_features must not both be set\n",
2287 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2288 new_driver->mdiodrv.driver.name = new_driver->name;
2289 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2290 new_driver->mdiodrv.driver.probe = phy_probe;
2291 new_driver->mdiodrv.driver.remove = phy_remove;
2292 new_driver->mdiodrv.driver.owner = owner;
2294 retval = driver_register(&new_driver->mdiodrv.driver);
2296 pr_err("%s: Error %d in registering driver\n",
2297 new_driver->name, retval);
2302 pr_debug("%s: Registered new driver\n", new_driver->name);
2306 EXPORT_SYMBOL(phy_driver_register);
2308 int phy_drivers_register(struct phy_driver *new_driver, int n,
2309 struct module *owner)
2313 for (i = 0; i < n; i++) {
2314 ret = phy_driver_register(new_driver + i, owner);
2317 phy_driver_unregister(new_driver + i);
2323 EXPORT_SYMBOL(phy_drivers_register);
2325 void phy_driver_unregister(struct phy_driver *drv)
2327 driver_unregister(&drv->mdiodrv.driver);
2329 EXPORT_SYMBOL(phy_driver_unregister);
2331 void phy_drivers_unregister(struct phy_driver *drv, int n)
2335 for (i = 0; i < n; i++)
2336 phy_driver_unregister(drv + i);
2338 EXPORT_SYMBOL(phy_drivers_unregister);
2340 static struct phy_driver genphy_driver = {
2341 .phy_id = 0xffffffff,
2342 .phy_id_mask = 0xffffffff,
2343 .name = "Generic PHY",
2344 .soft_reset = genphy_no_soft_reset,
2345 .get_features = genphy_read_abilities,
2346 .aneg_done = genphy_aneg_done,
2347 .suspend = genphy_suspend,
2348 .resume = genphy_resume,
2349 .set_loopback = genphy_loopback,
2352 static int __init phy_init(void)
2356 rc = mdio_bus_init();
2362 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2366 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2368 phy_driver_unregister(&genphy_c45_driver);
2376 static void __exit phy_exit(void)
2378 phy_driver_unregister(&genphy_c45_driver);
2379 phy_driver_unregister(&genphy_driver);
2383 subsys_initcall(phy_init);
2384 module_exit(phy_exit);