1 /* Framework for finding and configuring PHYs.
2 * Also contains generic PHY driver
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/kernel.h>
18 #include <linux/string.h>
19 #include <linux/errno.h>
20 #include <linux/unistd.h>
21 #include <linux/slab.h>
22 #include <linux/interrupt.h>
23 #include <linux/init.h>
24 #include <linux/delay.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/skbuff.h>
29 #include <linux/module.h>
30 #include <linux/mii.h>
31 #include <linux/ethtool.h>
32 #include <linux/bitmap.h>
33 #include <linux/phy.h>
34 #include <linux/phy_led_triggers.h>
35 #include <linux/mdio.h>
37 #include <linux/uaccess.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_gbit_features) __ro_after_init;
53 EXPORT_SYMBOL_GPL(phy_gbit_features);
55 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
56 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
58 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
59 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
61 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
62 EXPORT_SYMBOL_GPL(phy_10gbit_features);
64 static const int phy_basic_ports_array[] = {
65 ETHTOOL_LINK_MODE_Autoneg_BIT,
66 ETHTOOL_LINK_MODE_TP_BIT,
67 ETHTOOL_LINK_MODE_MII_BIT,
69 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
71 static const int phy_fibre_port_array[] = {
72 ETHTOOL_LINK_MODE_FIBRE_BIT,
74 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
76 static const int phy_all_ports_features_array[] = {
77 ETHTOOL_LINK_MODE_Autoneg_BIT,
78 ETHTOOL_LINK_MODE_TP_BIT,
79 ETHTOOL_LINK_MODE_MII_BIT,
80 ETHTOOL_LINK_MODE_FIBRE_BIT,
81 ETHTOOL_LINK_MODE_AUI_BIT,
82 ETHTOOL_LINK_MODE_BNC_BIT,
83 ETHTOOL_LINK_MODE_Backplane_BIT,
85 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
87 const int phy_10_100_features_array[4] = {
88 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
89 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
90 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
91 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
93 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
95 const int phy_basic_t1_features_array[2] = {
96 ETHTOOL_LINK_MODE_TP_BIT,
97 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
99 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
101 const int phy_gbit_features_array[2] = {
102 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
103 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
105 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
107 const int phy_10gbit_features_array[1] = {
108 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
110 EXPORT_SYMBOL_GPL(phy_10gbit_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);
196 void phy_device_free(struct phy_device *phydev)
198 put_device(&phydev->mdio.dev);
200 EXPORT_SYMBOL(phy_device_free);
202 static void phy_mdio_device_free(struct mdio_device *mdiodev)
204 struct phy_device *phydev;
206 phydev = container_of(mdiodev, struct phy_device, mdio);
207 phy_device_free(phydev);
210 static void phy_device_release(struct device *dev)
212 kfree(to_phy_device(dev));
215 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
217 struct phy_device *phydev;
219 phydev = container_of(mdiodev, struct phy_device, mdio);
220 phy_device_remove(phydev);
223 static struct phy_driver genphy_driver;
224 extern struct phy_driver genphy_10g_driver;
226 static LIST_HEAD(phy_fixup_list);
227 static DEFINE_MUTEX(phy_fixup_lock);
230 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
232 struct device_driver *drv = phydev->mdio.dev.driver;
233 struct phy_driver *phydrv = to_phy_driver(drv);
234 struct net_device *netdev = phydev->attached_dev;
236 if (!drv || !phydrv->suspend)
239 /* PHY not attached? May suspend if the PHY has not already been
240 * suspended as part of a prior call to phy_disconnect() ->
241 * phy_detach() -> phy_suspend() because the parent netdev might be the
242 * MDIO bus driver and clock gated at this point.
245 return !phydev->suspended;
247 if (netdev->wol_enabled)
250 /* As long as not all affected network drivers support the
251 * wol_enabled flag, let's check for hints that WoL is enabled.
252 * Don't suspend PHY if the attached netdev parent may wake up.
253 * The parent may point to a PCI device, as in tg3 driver.
255 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
258 /* Also don't suspend PHY if the netdev itself may wakeup. This
259 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
262 if (device_may_wakeup(&netdev->dev))
268 static int mdio_bus_phy_suspend(struct device *dev)
270 struct phy_device *phydev = to_phy_device(dev);
272 /* We must stop the state machine manually, otherwise it stops out of
273 * control, possibly with the phydev->lock held. Upon resume, netdev
274 * may call phy routines that try to grab the same lock, and that may
275 * lead to a deadlock.
277 if (phydev->attached_dev && phydev->adjust_link)
278 phy_stop_machine(phydev);
280 if (!mdio_bus_phy_may_suspend(phydev))
283 return phy_suspend(phydev);
286 static int mdio_bus_phy_resume(struct device *dev)
288 struct phy_device *phydev = to_phy_device(dev);
291 if (!mdio_bus_phy_may_suspend(phydev))
294 ret = phy_resume(phydev);
299 if (phydev->attached_dev && phydev->adjust_link)
300 phy_start_machine(phydev);
305 static int mdio_bus_phy_restore(struct device *dev)
307 struct phy_device *phydev = to_phy_device(dev);
308 struct net_device *netdev = phydev->attached_dev;
314 ret = phy_init_hw(phydev);
318 if (phydev->attached_dev && phydev->adjust_link)
319 phy_start_machine(phydev);
324 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
325 .suspend = mdio_bus_phy_suspend,
326 .resume = mdio_bus_phy_resume,
327 .freeze = mdio_bus_phy_suspend,
328 .thaw = mdio_bus_phy_resume,
329 .restore = mdio_bus_phy_restore,
332 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
336 #define MDIO_BUS_PHY_PM_OPS NULL
338 #endif /* CONFIG_PM */
341 * phy_register_fixup - creates a new phy_fixup and adds it to the list
342 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
343 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
344 * It can also be PHY_ANY_UID
345 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
347 * @run: The actual code to be run when a matching PHY is found
349 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
350 int (*run)(struct phy_device *))
352 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
357 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
358 fixup->phy_uid = phy_uid;
359 fixup->phy_uid_mask = phy_uid_mask;
362 mutex_lock(&phy_fixup_lock);
363 list_add_tail(&fixup->list, &phy_fixup_list);
364 mutex_unlock(&phy_fixup_lock);
368 EXPORT_SYMBOL(phy_register_fixup);
370 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
371 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
372 int (*run)(struct phy_device *))
374 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
376 EXPORT_SYMBOL(phy_register_fixup_for_uid);
378 /* Registers a fixup to be run on the PHY with id string bus_id */
379 int phy_register_fixup_for_id(const char *bus_id,
380 int (*run)(struct phy_device *))
382 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
384 EXPORT_SYMBOL(phy_register_fixup_for_id);
387 * phy_unregister_fixup - remove a phy_fixup from the list
388 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
389 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
390 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
392 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
394 struct list_head *pos, *n;
395 struct phy_fixup *fixup;
400 mutex_lock(&phy_fixup_lock);
401 list_for_each_safe(pos, n, &phy_fixup_list) {
402 fixup = list_entry(pos, struct phy_fixup, list);
404 if ((!strcmp(fixup->bus_id, bus_id)) &&
405 ((fixup->phy_uid & phy_uid_mask) ==
406 (phy_uid & phy_uid_mask))) {
407 list_del(&fixup->list);
413 mutex_unlock(&phy_fixup_lock);
417 EXPORT_SYMBOL(phy_unregister_fixup);
419 /* Unregisters a fixup of any PHY with the UID in phy_uid */
420 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
422 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
424 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
426 /* Unregisters a fixup of the PHY with id string bus_id */
427 int phy_unregister_fixup_for_id(const char *bus_id)
429 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
431 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
433 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
434 * Fixups can be set to match any in one or more fields.
436 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
438 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
439 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
442 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
443 (phydev->phy_id & fixup->phy_uid_mask))
444 if (fixup->phy_uid != PHY_ANY_UID)
450 /* Runs any matching fixups for this phydev */
451 static int phy_scan_fixups(struct phy_device *phydev)
453 struct phy_fixup *fixup;
455 mutex_lock(&phy_fixup_lock);
456 list_for_each_entry(fixup, &phy_fixup_list, list) {
457 if (phy_needs_fixup(phydev, fixup)) {
458 int err = fixup->run(phydev);
461 mutex_unlock(&phy_fixup_lock);
464 phydev->has_fixups = true;
467 mutex_unlock(&phy_fixup_lock);
472 static int phy_bus_match(struct device *dev, struct device_driver *drv)
474 struct phy_device *phydev = to_phy_device(dev);
475 struct phy_driver *phydrv = to_phy_driver(drv);
476 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
479 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
482 if (phydrv->match_phy_device)
483 return phydrv->match_phy_device(phydev);
485 if (phydev->is_c45) {
486 for (i = 1; i < num_ids; i++) {
487 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
490 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
491 (phydev->c45_ids.device_ids[i] &
492 phydrv->phy_id_mask))
497 return (phydrv->phy_id & phydrv->phy_id_mask) ==
498 (phydev->phy_id & phydrv->phy_id_mask);
503 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
505 struct phy_device *phydev = to_phy_device(dev);
507 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
509 static DEVICE_ATTR_RO(phy_id);
512 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
514 struct phy_device *phydev = to_phy_device(dev);
515 const char *mode = NULL;
517 if (phy_is_internal(phydev))
520 mode = phy_modes(phydev->interface);
522 return sprintf(buf, "%s\n", mode);
524 static DEVICE_ATTR_RO(phy_interface);
527 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
530 struct phy_device *phydev = to_phy_device(dev);
532 return sprintf(buf, "%d\n", phydev->has_fixups);
534 static DEVICE_ATTR_RO(phy_has_fixups);
536 static struct attribute *phy_dev_attrs[] = {
537 &dev_attr_phy_id.attr,
538 &dev_attr_phy_interface.attr,
539 &dev_attr_phy_has_fixups.attr,
542 ATTRIBUTE_GROUPS(phy_dev);
544 static const struct device_type mdio_bus_phy_type = {
546 .groups = phy_dev_groups,
547 .release = phy_device_release,
548 .pm = MDIO_BUS_PHY_PM_OPS,
551 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
553 struct phy_c45_device_ids *c45_ids)
555 struct phy_device *dev;
556 struct mdio_device *mdiodev;
558 /* We allocate the device, and initialize the default values */
559 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
561 return ERR_PTR(-ENOMEM);
563 mdiodev = &dev->mdio;
564 mdiodev->dev.parent = &bus->dev;
565 mdiodev->dev.bus = &mdio_bus_type;
566 mdiodev->dev.type = &mdio_bus_phy_type;
568 mdiodev->bus_match = phy_bus_match;
569 mdiodev->addr = addr;
570 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
571 mdiodev->device_free = phy_mdio_device_free;
572 mdiodev->device_remove = phy_mdio_device_remove;
579 dev->interface = PHY_INTERFACE_MODE_GMII;
581 dev->autoneg = AUTONEG_ENABLE;
583 dev->is_c45 = is_c45;
584 dev->phy_id = phy_id;
586 dev->c45_ids = *c45_ids;
587 dev->irq = bus->irq[addr];
588 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
590 dev->state = PHY_DOWN;
592 mutex_init(&dev->lock);
593 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
595 /* Request the appropriate module unconditionally; don't
596 * bother trying to do so only if it isn't already loaded,
597 * because that gets complicated. A hotplug event would have
598 * done an unconditional modprobe anyway.
599 * We don't do normal hotplug because it won't work for MDIO
600 * -- because it relies on the device staying around for long
601 * enough for the driver to get loaded. With MDIO, the NIC
602 * driver will get bored and give up as soon as it finds that
603 * there's no driver _already_ loaded.
605 if (is_c45 && c45_ids) {
606 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
609 for (i = 1; i < num_ids; i++) {
610 if (!(c45_ids->devices_in_package & (1 << i)))
613 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
614 MDIO_ID_ARGS(c45_ids->device_ids[i]));
617 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
618 MDIO_ID_ARGS(phy_id));
621 device_initialize(&mdiodev->dev);
625 EXPORT_SYMBOL(phy_device_create);
627 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
628 * @bus: the target MII bus
629 * @addr: PHY address on the MII bus
630 * @dev_addr: MMD address in the PHY.
631 * @devices_in_package: where to store the devices in package information.
633 * Description: reads devices in package registers of a MMD at @dev_addr
634 * from PHY at @addr on @bus.
636 * Returns: 0 on success, -EIO on failure.
638 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
639 u32 *devices_in_package)
641 int phy_reg, reg_addr;
643 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
644 phy_reg = mdiobus_read(bus, addr, reg_addr);
647 *devices_in_package = (phy_reg & 0xffff) << 16;
649 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
650 phy_reg = mdiobus_read(bus, addr, reg_addr);
653 *devices_in_package |= (phy_reg & 0xffff);
659 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
660 * @bus: the target MII bus
661 * @addr: PHY address on the MII bus
662 * @phy_id: where to store the ID retrieved.
663 * @c45_ids: where to store the c45 ID information.
665 * If the PHY devices-in-package appears to be valid, it and the
666 * corresponding identifiers are stored in @c45_ids, zero is stored
667 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
671 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
672 struct phy_c45_device_ids *c45_ids) {
675 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
676 u32 *devs = &c45_ids->devices_in_package;
678 /* Find first non-zero Devices In package. Device zero is reserved
679 * for 802.3 c45 complied PHYs, so don't probe it at first.
681 for (i = 1; i < num_ids && *devs == 0; i++) {
682 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
686 if ((*devs & 0x1fffffff) == 0x1fffffff) {
687 /* If mostly Fs, there is no device there,
688 * then let's continue to probe more, as some
689 * 10G PHYs have zero Devices In package,
690 * e.g. Cortina CS4315/CS4340 PHY.
692 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
695 /* no device there, let's get out of here */
696 if ((*devs & 0x1fffffff) == 0x1fffffff) {
697 *phy_id = 0xffffffff;
705 /* Now probe Device Identifiers for each device present. */
706 for (i = 1; i < num_ids; i++) {
707 if (!(c45_ids->devices_in_package & (1 << i)))
710 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
711 phy_reg = mdiobus_read(bus, addr, reg_addr);
714 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
716 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
717 phy_reg = mdiobus_read(bus, addr, reg_addr);
720 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
727 * get_phy_id - reads the specified addr for its ID.
728 * @bus: the target MII bus
729 * @addr: PHY address on the MII bus
730 * @phy_id: where to store the ID retrieved.
731 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
732 * @c45_ids: where to store the c45 ID information.
734 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
735 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
738 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
739 * its return value is in turn returned.
742 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
743 bool is_c45, struct phy_c45_device_ids *c45_ids)
748 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
750 /* Grab the bits from PHYIR1, and put them in the upper half */
751 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
753 /* if there is no device, return without an error so scanning
754 * the bus works properly
756 if (phy_reg == -EIO || phy_reg == -ENODEV) {
757 *phy_id = 0xffffffff;
764 *phy_id = (phy_reg & 0xffff) << 16;
766 /* Grab the bits from PHYIR2, and put them in the lower half */
767 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
771 *phy_id |= (phy_reg & 0xffff);
777 * get_phy_device - reads the specified PHY device and returns its @phy_device
779 * @bus: the target MII bus
780 * @addr: PHY address on the MII bus
781 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
783 * Description: Reads the ID registers of the PHY at @addr on the
784 * @bus, then allocates and returns the phy_device to represent it.
786 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
788 struct phy_c45_device_ids c45_ids = {0};
792 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
796 /* If the phy_id is mostly Fs, there is no device there */
797 if ((phy_id & 0x1fffffff) == 0x1fffffff)
798 return ERR_PTR(-ENODEV);
800 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
802 EXPORT_SYMBOL(get_phy_device);
805 * phy_device_register - Register the phy device on the MDIO bus
806 * @phydev: phy_device structure to be added to the MDIO bus
808 int phy_device_register(struct phy_device *phydev)
812 err = mdiobus_register_device(&phydev->mdio);
816 /* Deassert the reset signal */
817 phy_device_reset(phydev, 0);
819 /* Run all of the fixups for this PHY */
820 err = phy_scan_fixups(phydev);
822 pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
826 err = device_add(&phydev->mdio.dev);
828 pr_err("PHY %d failed to add\n", phydev->mdio.addr);
835 /* Assert the reset signal */
836 phy_device_reset(phydev, 1);
838 mdiobus_unregister_device(&phydev->mdio);
841 EXPORT_SYMBOL(phy_device_register);
844 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
845 * @phydev: phy_device structure to remove
847 * This doesn't free the phy_device itself, it merely reverses the effects
848 * of phy_device_register(). Use phy_device_free() to free the device
849 * after calling this function.
851 void phy_device_remove(struct phy_device *phydev)
853 device_del(&phydev->mdio.dev);
855 /* Assert the reset signal */
856 phy_device_reset(phydev, 1);
858 mdiobus_unregister_device(&phydev->mdio);
860 EXPORT_SYMBOL(phy_device_remove);
863 * phy_find_first - finds the first PHY device on the bus
864 * @bus: the target MII bus
866 struct phy_device *phy_find_first(struct mii_bus *bus)
868 struct phy_device *phydev;
871 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
872 phydev = mdiobus_get_phy(bus, addr);
878 EXPORT_SYMBOL(phy_find_first);
880 static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
882 struct net_device *netdev = phydev->attached_dev;
886 netif_carrier_on(netdev);
888 netif_carrier_off(netdev);
890 phydev->adjust_link(netdev);
894 * phy_prepare_link - prepares the PHY layer to monitor link status
895 * @phydev: target phy_device struct
896 * @handler: callback function for link status change notifications
898 * Description: Tells the PHY infrastructure to handle the
899 * gory details on monitoring link status (whether through
900 * polling or an interrupt), and to call back to the
901 * connected device driver when the link status changes.
902 * If you want to monitor your own link state, don't call
905 static void phy_prepare_link(struct phy_device *phydev,
906 void (*handler)(struct net_device *))
908 phydev->adjust_link = handler;
912 * phy_connect_direct - connect an ethernet device to a specific phy_device
913 * @dev: the network device to connect
914 * @phydev: the pointer to the phy device
915 * @handler: callback function for state change notifications
916 * @interface: PHY device's interface
918 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
919 void (*handler)(struct net_device *),
920 phy_interface_t interface)
924 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
928 phy_prepare_link(phydev, handler);
929 phy_start_machine(phydev);
931 phy_start_interrupts(phydev);
935 EXPORT_SYMBOL(phy_connect_direct);
938 * phy_connect - connect an ethernet device to a PHY device
939 * @dev: the network device to connect
940 * @bus_id: the id string of the PHY device to connect
941 * @handler: callback function for state change notifications
942 * @interface: PHY device's interface
944 * Description: Convenience function for connecting ethernet
945 * devices to PHY devices. The default behavior is for
946 * the PHY infrastructure to handle everything, and only notify
947 * the connected driver when the link status changes. If you
948 * don't want, or can't use the provided functionality, you may
949 * choose to call only the subset of functions which provide
950 * the desired functionality.
952 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
953 void (*handler)(struct net_device *),
954 phy_interface_t interface)
956 struct phy_device *phydev;
960 /* Search the list of PHY devices on the mdio bus for the
961 * PHY with the requested name
963 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
965 pr_err("PHY %s not found\n", bus_id);
966 return ERR_PTR(-ENODEV);
968 phydev = to_phy_device(d);
970 rc = phy_connect_direct(dev, phydev, handler, interface);
977 EXPORT_SYMBOL(phy_connect);
980 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
982 * @phydev: target phy_device struct
984 void phy_disconnect(struct phy_device *phydev)
987 phy_stop_interrupts(phydev);
989 phy_stop_machine(phydev);
991 phydev->adjust_link = NULL;
995 EXPORT_SYMBOL(phy_disconnect);
998 * phy_poll_reset - Safely wait until a PHY reset has properly completed
999 * @phydev: The PHY device to poll
1001 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1002 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1003 * register must be polled until the BMCR_RESET bit clears.
1005 * Furthermore, any attempts to write to PHY registers may have no effect
1006 * or even generate MDIO bus errors until this is complete.
1008 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1009 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1010 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1011 * effort to support such broken PHYs, this function is separate from the
1012 * standard phy_init_hw() which will zero all the other bits in the BMCR
1013 * and reapply all driver-specific and board-specific fixups.
1015 static int phy_poll_reset(struct phy_device *phydev)
1017 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1018 unsigned int retries = 12;
1023 ret = phy_read(phydev, MII_BMCR);
1026 } while (ret & BMCR_RESET && --retries);
1027 if (ret & BMCR_RESET)
1030 /* Some chips (smsc911x) may still need up to another 1ms after the
1031 * BMCR_RESET bit is cleared before they are usable.
1037 int phy_init_hw(struct phy_device *phydev)
1041 /* Deassert the reset signal */
1042 phy_device_reset(phydev, 0);
1044 if (!phydev->drv || !phydev->drv->config_init)
1047 if (phydev->drv->soft_reset)
1048 ret = phydev->drv->soft_reset(phydev);
1053 ret = phy_scan_fixups(phydev);
1057 return phydev->drv->config_init(phydev);
1059 EXPORT_SYMBOL(phy_init_hw);
1061 void phy_attached_info(struct phy_device *phydev)
1063 phy_attached_print(phydev, NULL);
1065 EXPORT_SYMBOL(phy_attached_info);
1067 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1068 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1070 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1074 switch(phydev->irq) {
1078 case PHY_IGNORE_INTERRUPT:
1082 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1089 phydev_info(phydev, ATTACHED_FMT "\n",
1090 drv_name, phydev_name(phydev),
1095 phydev_info(phydev, ATTACHED_FMT,
1096 drv_name, phydev_name(phydev),
1104 EXPORT_SYMBOL(phy_attached_print);
1107 * phy_attach_direct - attach a network device to a given PHY device pointer
1108 * @dev: network device to attach
1109 * @phydev: Pointer to phy_device to attach
1110 * @flags: PHY device's dev_flags
1111 * @interface: PHY device's interface
1113 * Description: Called by drivers to attach to a particular PHY
1114 * device. The phy_device is found, and properly hooked up
1115 * to the phy_driver. If no driver is attached, then a
1116 * generic driver is used. The phy_device is given a ptr to
1117 * the attaching device, and given a callback for link status
1118 * change. The phy_device is returned to the attaching driver.
1119 * This function takes a reference on the phy device.
1121 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1122 u32 flags, phy_interface_t interface)
1124 struct module *ndev_owner = dev->dev.parent->driver->owner;
1125 struct mii_bus *bus = phydev->mdio.bus;
1126 struct device *d = &phydev->mdio.dev;
1127 bool using_genphy = false;
1130 /* For Ethernet device drivers that register their own MDIO bus, we
1131 * will have bus->owner match ndev_mod, so we do not want to increment
1132 * our own module->refcnt here, otherwise we would not be able to
1135 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1136 dev_err(&dev->dev, "failed to get the bus module\n");
1142 /* Assume that if there is no driver, that it doesn't
1143 * exist, and we should use the genphy driver.
1147 d->driver = &genphy_10g_driver.mdiodrv.driver;
1149 d->driver = &genphy_driver.mdiodrv.driver;
1151 using_genphy = true;
1154 if (!try_module_get(d->driver->owner)) {
1155 dev_err(&dev->dev, "failed to get the device driver module\n");
1157 goto error_put_device;
1161 err = d->driver->probe(d);
1163 err = device_bind_driver(d);
1166 goto error_module_put;
1169 if (phydev->attached_dev) {
1170 dev_err(&dev->dev, "PHY already attached\n");
1175 phydev->phy_link_change = phy_link_change;
1176 phydev->attached_dev = dev;
1177 dev->phydev = phydev;
1179 /* Some Ethernet drivers try to connect to a PHY device before
1180 * calling register_netdevice() -> netdev_register_kobject() and
1181 * does the dev->dev.kobj initialization. Here we only check for
1182 * success which indicates that the network device kobject is
1183 * ready. Once we do that we still need to keep track of whether
1184 * links were successfully set up or not for phy_detach() to
1185 * remove them accordingly.
1187 phydev->sysfs_links = false;
1189 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1192 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1193 &phydev->mdio.dev.kobj,
1196 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1197 kobject_name(&phydev->mdio.dev.kobj),
1199 /* non-fatal - some net drivers can use one netdevice
1200 * with more then one phy
1204 phydev->sysfs_links = true;
1207 phydev->dev_flags = flags;
1209 phydev->interface = interface;
1211 phydev->state = PHY_READY;
1213 /* Initial carrier state is off as the phy is about to be
1216 netif_carrier_off(phydev->attached_dev);
1218 /* Do initial configuration here, now that
1219 * we have certain key parameters
1220 * (dev_flags and interface)
1222 err = phy_init_hw(phydev);
1227 phy_led_triggers_register(phydev);
1232 /* phy_detach() does all of the cleanup below */
1237 module_put(d->driver->owner);
1240 if (ndev_owner != bus->owner)
1241 module_put(bus->owner);
1244 EXPORT_SYMBOL(phy_attach_direct);
1247 * phy_attach - attach a network device to a particular PHY device
1248 * @dev: network device to attach
1249 * @bus_id: Bus ID of PHY device to attach
1250 * @interface: PHY device's interface
1252 * Description: Same as phy_attach_direct() except that a PHY bus_id
1253 * string is passed instead of a pointer to a struct phy_device.
1255 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1256 phy_interface_t interface)
1258 struct bus_type *bus = &mdio_bus_type;
1259 struct phy_device *phydev;
1263 /* Search the list of PHY devices on the mdio bus for the
1264 * PHY with the requested name
1266 d = bus_find_device_by_name(bus, NULL, bus_id);
1268 pr_err("PHY %s not found\n", bus_id);
1269 return ERR_PTR(-ENODEV);
1271 phydev = to_phy_device(d);
1273 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1280 EXPORT_SYMBOL(phy_attach);
1283 * phy_detach - detach a PHY device from its network device
1284 * @phydev: target phy_device struct
1286 * This detaches the phy device from its network device and the phy
1287 * driver, and drops the reference count taken in phy_attach_direct().
1289 void phy_detach(struct phy_device *phydev)
1291 struct net_device *dev = phydev->attached_dev;
1292 struct module *ndev_owner = dev->dev.parent->driver->owner;
1293 struct mii_bus *bus;
1295 if (phydev->sysfs_links) {
1296 sysfs_remove_link(&dev->dev.kobj, "phydev");
1297 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1299 phy_suspend(phydev);
1300 phydev->attached_dev->phydev = NULL;
1301 phydev->attached_dev = NULL;
1302 phydev->phylink = NULL;
1304 phy_led_triggers_unregister(phydev);
1306 module_put(phydev->mdio.dev.driver->owner);
1308 /* If the device had no specific driver before (i.e. - it
1309 * was using the generic driver), we unbind the device
1310 * from the generic driver so that there's a chance a
1311 * real driver could be loaded
1313 if (phydev->mdio.dev.driver == &genphy_10g_driver.mdiodrv.driver ||
1314 phydev->mdio.dev.driver == &genphy_driver.mdiodrv.driver)
1315 device_release_driver(&phydev->mdio.dev);
1318 * The phydev might go away on the put_device() below, so avoid
1319 * a use-after-free bug by reading the underlying bus first.
1321 bus = phydev->mdio.bus;
1323 put_device(&phydev->mdio.dev);
1324 if (ndev_owner != bus->owner)
1325 module_put(bus->owner);
1327 /* Assert the reset signal */
1328 phy_device_reset(phydev, 1);
1330 EXPORT_SYMBOL(phy_detach);
1332 int phy_suspend(struct phy_device *phydev)
1334 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1335 struct net_device *netdev = phydev->attached_dev;
1336 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1339 /* If the device has WOL enabled, we cannot suspend the PHY */
1340 phy_ethtool_get_wol(phydev, &wol);
1341 if (wol.wolopts || (netdev && netdev->wol_enabled))
1344 if (phydev->drv && phydrv->suspend)
1345 ret = phydrv->suspend(phydev);
1350 phydev->suspended = true;
1354 EXPORT_SYMBOL(phy_suspend);
1356 int __phy_resume(struct phy_device *phydev)
1358 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1361 WARN_ON(!mutex_is_locked(&phydev->lock));
1363 if (phydev->drv && phydrv->resume)
1364 ret = phydrv->resume(phydev);
1369 phydev->suspended = false;
1373 EXPORT_SYMBOL(__phy_resume);
1375 int phy_resume(struct phy_device *phydev)
1379 mutex_lock(&phydev->lock);
1380 ret = __phy_resume(phydev);
1381 mutex_unlock(&phydev->lock);
1385 EXPORT_SYMBOL(phy_resume);
1387 int phy_loopback(struct phy_device *phydev, bool enable)
1389 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1392 mutex_lock(&phydev->lock);
1394 if (enable && phydev->loopback_enabled) {
1399 if (!enable && !phydev->loopback_enabled) {
1404 if (phydev->drv && phydrv->set_loopback)
1405 ret = phydrv->set_loopback(phydev, enable);
1412 phydev->loopback_enabled = enable;
1415 mutex_unlock(&phydev->lock);
1418 EXPORT_SYMBOL(phy_loopback);
1421 * phy_reset_after_clk_enable - perform a PHY reset if needed
1422 * @phydev: target phy_device struct
1424 * Description: Some PHYs are known to need a reset after their refclk was
1425 * enabled. This function evaluates the flags and perform the reset if it's
1426 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1429 int phy_reset_after_clk_enable(struct phy_device *phydev)
1431 if (!phydev || !phydev->drv)
1434 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1435 phy_device_reset(phydev, 1);
1436 phy_device_reset(phydev, 0);
1442 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1444 /* Generic PHY support and helper functions */
1447 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1448 * @phydev: target phy_device struct
1450 * Description: Writes MII_ADVERTISE with the appropriate values,
1451 * after sanitizing the values to make sure we only advertise
1452 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1453 * hasn't changed, and > 0 if it has changed.
1455 static int genphy_config_advert(struct phy_device *phydev)
1458 int oldadv, adv, bmsr;
1459 int err, changed = 0;
1461 /* Only allow advertising what this PHY supports */
1462 linkmode_and(phydev->advertising, phydev->advertising,
1464 if (!ethtool_convert_link_mode_to_legacy_u32(&advertise,
1465 phydev->advertising))
1466 phydev_warn(phydev, "PHY advertising (%*pb) more modes than genphy supports, some modes not advertised.\n",
1467 __ETHTOOL_LINK_MODE_MASK_NBITS,
1468 phydev->advertising);
1470 /* Setup standard advertisement */
1471 adv = phy_read(phydev, MII_ADVERTISE);
1476 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1477 ADVERTISE_PAUSE_ASYM);
1478 adv |= ethtool_adv_to_mii_adv_t(advertise);
1480 if (adv != oldadv) {
1481 err = phy_write(phydev, MII_ADVERTISE, adv);
1488 bmsr = phy_read(phydev, MII_BMSR);
1492 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1493 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1496 if (!(bmsr & BMSR_ESTATEN))
1499 /* Configure gigabit if it's supported */
1500 adv = phy_read(phydev, MII_CTRL1000);
1505 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1507 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1508 phydev->supported) ||
1509 linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1511 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1516 err = phy_write(phydev, MII_CTRL1000, adv);
1524 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1525 * @phydev: target phy_device struct
1527 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1528 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1529 * changed, and 1 if it has changed.
1531 static int genphy_config_eee_advert(struct phy_device *phydev)
1533 int broken = phydev->eee_broken_modes;
1536 /* Nothing to disable */
1540 /* If the following call fails, we assume that EEE is not
1541 * supported by the phy. If we read 0, EEE is not advertised
1542 * In both case, we don't need to continue
1544 adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1551 /* Advertising remains unchanged with the broken mask */
1555 phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1561 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1562 * @phydev: target phy_device struct
1564 * Description: Configures MII_BMCR to force speed/duplex
1565 * to the values in phydev. Assumes that the values are valid.
1566 * Please see phy_sanitize_settings().
1568 int genphy_setup_forced(struct phy_device *phydev)
1573 phydev->asym_pause = 0;
1575 if (SPEED_1000 == phydev->speed)
1576 ctl |= BMCR_SPEED1000;
1577 else if (SPEED_100 == phydev->speed)
1578 ctl |= BMCR_SPEED100;
1580 if (DUPLEX_FULL == phydev->duplex)
1581 ctl |= BMCR_FULLDPLX;
1583 return phy_modify(phydev, MII_BMCR,
1584 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1586 EXPORT_SYMBOL(genphy_setup_forced);
1589 * genphy_restart_aneg - Enable and Restart Autonegotiation
1590 * @phydev: target phy_device struct
1592 int genphy_restart_aneg(struct phy_device *phydev)
1594 /* Don't isolate the PHY if we're negotiating */
1595 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1596 BMCR_ANENABLE | BMCR_ANRESTART);
1598 EXPORT_SYMBOL(genphy_restart_aneg);
1601 * genphy_config_aneg - restart auto-negotiation or write BMCR
1602 * @phydev: target phy_device struct
1604 * Description: If auto-negotiation is enabled, we configure the
1605 * advertising, and then restart auto-negotiation. If it is not
1606 * enabled, then we write the BMCR.
1608 int genphy_config_aneg(struct phy_device *phydev)
1612 changed = genphy_config_eee_advert(phydev);
1614 if (AUTONEG_ENABLE != phydev->autoneg)
1615 return genphy_setup_forced(phydev);
1617 err = genphy_config_advert(phydev);
1618 if (err < 0) /* error */
1624 /* Advertisement hasn't changed, but maybe aneg was never on to
1625 * begin with? Or maybe phy was isolated?
1627 int ctl = phy_read(phydev, MII_BMCR);
1632 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1633 changed = 1; /* do restart aneg */
1636 /* Only restart aneg if we are advertising something different
1637 * than we were before.
1640 return genphy_restart_aneg(phydev);
1644 EXPORT_SYMBOL(genphy_config_aneg);
1647 * genphy_aneg_done - return auto-negotiation status
1648 * @phydev: target phy_device struct
1650 * Description: Reads the status register and returns 0 either if
1651 * auto-negotiation is incomplete, or if there was an error.
1652 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1654 int genphy_aneg_done(struct phy_device *phydev)
1656 int retval = phy_read(phydev, MII_BMSR);
1658 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1660 EXPORT_SYMBOL(genphy_aneg_done);
1663 * genphy_update_link - update link status in @phydev
1664 * @phydev: target phy_device struct
1666 * Description: Update the value in phydev->link to reflect the
1667 * current link value. In order to do this, we need to read
1668 * the status register twice, keeping the second value.
1670 int genphy_update_link(struct phy_device *phydev)
1674 /* Do a fake read */
1675 status = phy_read(phydev, MII_BMSR);
1679 /* Read link and autonegotiation status */
1680 status = phy_read(phydev, MII_BMSR);
1684 if ((status & BMSR_LSTATUS) == 0)
1691 EXPORT_SYMBOL(genphy_update_link);
1694 * genphy_read_status - check the link status and update current link state
1695 * @phydev: target phy_device struct
1697 * Description: Check the link, then figure out the current state
1698 * by comparing what we advertise with what the link partner
1699 * advertises. Start by checking the gigabit possibilities,
1700 * then move on to 10/100.
1702 int genphy_read_status(struct phy_device *phydev)
1709 int common_adv_gb = 0;
1711 /* Update the link, but return if there was an error */
1712 err = genphy_update_link(phydev);
1716 linkmode_zero(phydev->lp_advertising);
1718 if (AUTONEG_ENABLE == phydev->autoneg) {
1719 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1720 phydev->supported) ||
1721 linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1722 phydev->supported)) {
1723 lpagb = phy_read(phydev, MII_STAT1000);
1727 adv = phy_read(phydev, MII_CTRL1000);
1731 if (lpagb & LPA_1000MSFAIL) {
1732 if (adv & CTL1000_ENABLE_MASTER)
1733 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1735 phydev_err(phydev, "Master/Slave resolution failed\n");
1739 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1741 common_adv_gb = lpagb & adv << 2;
1744 lpa = phy_read(phydev, MII_LPA);
1748 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
1750 adv = phy_read(phydev, MII_ADVERTISE);
1754 common_adv = lpa & adv;
1756 phydev->speed = SPEED_10;
1757 phydev->duplex = DUPLEX_HALF;
1759 phydev->asym_pause = 0;
1761 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1762 phydev->speed = SPEED_1000;
1764 if (common_adv_gb & LPA_1000FULL)
1765 phydev->duplex = DUPLEX_FULL;
1766 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1767 phydev->speed = SPEED_100;
1769 if (common_adv & LPA_100FULL)
1770 phydev->duplex = DUPLEX_FULL;
1772 if (common_adv & LPA_10FULL)
1773 phydev->duplex = DUPLEX_FULL;
1775 if (phydev->duplex == DUPLEX_FULL) {
1776 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1777 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1780 int bmcr = phy_read(phydev, MII_BMCR);
1785 if (bmcr & BMCR_FULLDPLX)
1786 phydev->duplex = DUPLEX_FULL;
1788 phydev->duplex = DUPLEX_HALF;
1790 if (bmcr & BMCR_SPEED1000)
1791 phydev->speed = SPEED_1000;
1792 else if (bmcr & BMCR_SPEED100)
1793 phydev->speed = SPEED_100;
1795 phydev->speed = SPEED_10;
1798 phydev->asym_pause = 0;
1803 EXPORT_SYMBOL(genphy_read_status);
1806 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1807 * @phydev: target phy_device struct
1809 * Description: Perform a software PHY reset using the standard
1810 * BMCR_RESET bit and poll for the reset bit to be cleared.
1812 * Returns: 0 on success, < 0 on failure
1814 int genphy_soft_reset(struct phy_device *phydev)
1818 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1822 return phy_poll_reset(phydev);
1824 EXPORT_SYMBOL(genphy_soft_reset);
1826 int genphy_config_init(struct phy_device *phydev)
1829 __ETHTOOL_DECLARE_LINK_MODE_MASK(features) = { 0, };
1831 linkmode_set_bit_array(phy_basic_ports_array,
1832 ARRAY_SIZE(phy_basic_ports_array),
1834 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, features);
1835 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, features);
1837 /* Do we support autonegotiation? */
1838 val = phy_read(phydev, MII_BMSR);
1842 if (val & BMSR_ANEGCAPABLE)
1843 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, features);
1845 if (val & BMSR_100FULL)
1846 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, features);
1847 if (val & BMSR_100HALF)
1848 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, features);
1849 if (val & BMSR_10FULL)
1850 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, features);
1851 if (val & BMSR_10HALF)
1852 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, features);
1854 if (val & BMSR_ESTATEN) {
1855 val = phy_read(phydev, MII_ESTATUS);
1859 if (val & ESTATUS_1000_TFULL)
1860 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1862 if (val & ESTATUS_1000_THALF)
1863 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1867 linkmode_and(phydev->supported, phydev->supported, features);
1868 linkmode_and(phydev->advertising, phydev->advertising, features);
1872 EXPORT_SYMBOL(genphy_config_init);
1874 /* This is used for the phy device which doesn't support the MMD extended
1875 * register access, but it does have side effect when we are trying to access
1876 * the MMD register via indirect method.
1878 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
1882 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
1884 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1885 u16 regnum, u16 val)
1889 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
1891 int genphy_suspend(struct phy_device *phydev)
1893 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
1895 EXPORT_SYMBOL(genphy_suspend);
1897 int genphy_resume(struct phy_device *phydev)
1899 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
1901 EXPORT_SYMBOL(genphy_resume);
1903 int genphy_loopback(struct phy_device *phydev, bool enable)
1905 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
1906 enable ? BMCR_LOOPBACK : 0);
1908 EXPORT_SYMBOL(genphy_loopback);
1910 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1912 switch (max_speed) {
1914 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
1916 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1920 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1922 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1934 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1938 err = __set_phy_supported(phydev, max_speed);
1942 linkmode_copy(phydev->advertising, phydev->supported);
1946 EXPORT_SYMBOL(phy_set_max_speed);
1949 * phy_remove_link_mode - Remove a supported link mode
1950 * @phydev: phy_device structure to remove link mode from
1951 * @link_mode: Link mode to be removed
1953 * Description: Some MACs don't support all link modes which the PHY
1954 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
1955 * to remove a link mode.
1957 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
1959 linkmode_clear_bit(link_mode, phydev->supported);
1960 linkmode_copy(phydev->advertising, phydev->supported);
1962 EXPORT_SYMBOL(phy_remove_link_mode);
1965 * phy_support_sym_pause - Enable support of symmetrical pause
1966 * @phydev: target phy_device struct
1968 * Description: Called by the MAC to indicate is supports symmetrical
1969 * Pause, but not asym pause.
1971 void phy_support_sym_pause(struct phy_device *phydev)
1973 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
1974 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
1975 linkmode_copy(phydev->advertising, phydev->supported);
1977 EXPORT_SYMBOL(phy_support_sym_pause);
1980 * phy_support_asym_pause - Enable support of asym pause
1981 * @phydev: target phy_device struct
1983 * Description: Called by the MAC to indicate is supports Asym Pause.
1985 void phy_support_asym_pause(struct phy_device *phydev)
1987 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
1988 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
1989 linkmode_copy(phydev->advertising, phydev->supported);
1991 EXPORT_SYMBOL(phy_support_asym_pause);
1994 * phy_set_sym_pause - Configure symmetric Pause
1995 * @phydev: target phy_device struct
1996 * @rx: Receiver Pause is supported
1997 * @tx: Transmit Pause is supported
1998 * @autoneg: Auto neg should be used
2000 * Description: Configure advertised Pause support depending on if
2001 * receiver pause and pause auto neg is supported. Generally called
2002 * from the set_pauseparam .ndo.
2004 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2007 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2009 if (rx && tx && autoneg)
2010 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2013 linkmode_copy(phydev->advertising, phydev->supported);
2015 EXPORT_SYMBOL(phy_set_sym_pause);
2018 * phy_set_asym_pause - Configure Pause and Asym Pause
2019 * @phydev: target phy_device struct
2020 * @rx: Receiver Pause is supported
2021 * @tx: Transmit Pause is supported
2023 * Description: Configure advertised Pause support depending on if
2024 * transmit and receiver pause is supported. If there has been a
2025 * change in adverting, trigger a new autoneg. Generally called from
2026 * the set_pauseparam .ndo.
2028 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2030 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2032 linkmode_copy(oldadv, phydev->advertising);
2034 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2035 phydev->advertising);
2036 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2037 phydev->advertising);
2040 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2041 phydev->advertising);
2042 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2043 phydev->advertising);
2047 linkmode_change_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2048 phydev->advertising);
2050 if (!linkmode_equal(oldadv, phydev->advertising) &&
2052 phy_start_aneg(phydev);
2054 EXPORT_SYMBOL(phy_set_asym_pause);
2057 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2058 * @phydev: phy_device struct
2059 * @pp: requested pause configuration
2061 * Description: Test if the PHY/MAC combination supports the Pause
2062 * configuration the user is requesting. Returns True if it is
2063 * supported, false otherwise.
2065 bool phy_validate_pause(struct phy_device *phydev,
2066 struct ethtool_pauseparam *pp)
2068 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2069 phydev->supported) ||
2070 (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2071 phydev->supported) &&
2072 pp->rx_pause != pp->tx_pause))
2076 EXPORT_SYMBOL(phy_validate_pause);
2078 static void of_set_phy_supported(struct phy_device *phydev)
2080 struct device_node *node = phydev->mdio.dev.of_node;
2083 if (!IS_ENABLED(CONFIG_OF_MDIO))
2089 if (!of_property_read_u32(node, "max-speed", &max_speed))
2090 __set_phy_supported(phydev, max_speed);
2093 static void of_set_phy_eee_broken(struct phy_device *phydev)
2095 struct device_node *node = phydev->mdio.dev.of_node;
2098 if (!IS_ENABLED(CONFIG_OF_MDIO))
2104 if (of_property_read_bool(node, "eee-broken-100tx"))
2105 broken |= MDIO_EEE_100TX;
2106 if (of_property_read_bool(node, "eee-broken-1000t"))
2107 broken |= MDIO_EEE_1000T;
2108 if (of_property_read_bool(node, "eee-broken-10gt"))
2109 broken |= MDIO_EEE_10GT;
2110 if (of_property_read_bool(node, "eee-broken-1000kx"))
2111 broken |= MDIO_EEE_1000KX;
2112 if (of_property_read_bool(node, "eee-broken-10gkx4"))
2113 broken |= MDIO_EEE_10GKX4;
2114 if (of_property_read_bool(node, "eee-broken-10gkr"))
2115 broken |= MDIO_EEE_10GKR;
2117 phydev->eee_broken_modes = broken;
2120 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2122 return phydrv->config_intr && phydrv->ack_interrupt;
2126 * phy_probe - probe and init a PHY device
2127 * @dev: device to probe and init
2129 * Description: Take care of setting up the phy_device structure,
2130 * set the state to READY (the driver's init function should
2131 * set it to STARTING if needed).
2133 static int phy_probe(struct device *dev)
2135 struct phy_device *phydev = to_phy_device(dev);
2136 struct device_driver *drv = phydev->mdio.dev.driver;
2137 struct phy_driver *phydrv = to_phy_driver(drv);
2140 phydev->drv = phydrv;
2142 /* Disable the interrupt if the PHY doesn't support it
2143 * but the interrupt is still a valid one
2145 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2146 phydev->irq = PHY_POLL;
2148 if (phydrv->flags & PHY_IS_INTERNAL)
2149 phydev->is_internal = true;
2151 mutex_lock(&phydev->lock);
2153 /* Start out supporting everything. Eventually,
2154 * a controller will attach, and may modify one
2155 * or both of these values
2157 linkmode_copy(phydev->supported, phydrv->features);
2158 of_set_phy_supported(phydev);
2159 linkmode_copy(phydev->advertising, phydev->supported);
2161 /* Get the EEE modes we want to prohibit. We will ask
2162 * the PHY stop advertising these mode later on
2164 of_set_phy_eee_broken(phydev);
2166 /* The Pause Frame bits indicate that the PHY can support passing
2167 * pause frames. During autonegotiation, the PHYs will determine if
2168 * they should allow pause frames to pass. The MAC driver should then
2169 * use that result to determine whether to enable flow control via
2172 * Normally, PHY drivers should not set the Pause bits, and instead
2173 * allow phylib to do that. However, there may be some situations
2174 * (e.g. hardware erratum) where the driver wants to set only one
2177 if (test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydrv->features) ||
2178 test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydrv->features)) {
2179 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2181 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2183 if (test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydrv->features))
2184 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2186 if (test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2188 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2191 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2193 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2197 /* Set the state to READY by default */
2198 phydev->state = PHY_READY;
2200 if (phydev->drv->probe) {
2201 /* Deassert the reset signal */
2202 phy_device_reset(phydev, 0);
2204 err = phydev->drv->probe(phydev);
2206 /* Assert the reset signal */
2207 phy_device_reset(phydev, 1);
2211 mutex_unlock(&phydev->lock);
2216 static int phy_remove(struct device *dev)
2218 struct phy_device *phydev = to_phy_device(dev);
2220 cancel_delayed_work_sync(&phydev->state_queue);
2222 mutex_lock(&phydev->lock);
2223 phydev->state = PHY_DOWN;
2224 mutex_unlock(&phydev->lock);
2226 if (phydev->drv && phydev->drv->remove) {
2227 phydev->drv->remove(phydev);
2229 /* Assert the reset signal */
2230 phy_device_reset(phydev, 1);
2238 * phy_driver_register - register a phy_driver with the PHY layer
2239 * @new_driver: new phy_driver to register
2240 * @owner: module owning this PHY
2242 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2246 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2247 new_driver->mdiodrv.driver.name = new_driver->name;
2248 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2249 new_driver->mdiodrv.driver.probe = phy_probe;
2250 new_driver->mdiodrv.driver.remove = phy_remove;
2251 new_driver->mdiodrv.driver.owner = owner;
2253 /* The following works around an issue where the PHY driver doesn't bind
2254 * to the device, resulting in the genphy driver being used instead of
2255 * the dedicated driver. The root cause of the issue isn't known yet
2256 * and seems to be in the base driver core. Once this is fixed we may
2257 * remove this workaround.
2259 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2261 retval = driver_register(&new_driver->mdiodrv.driver);
2263 pr_err("%s: Error %d in registering driver\n",
2264 new_driver->name, retval);
2269 pr_debug("%s: Registered new driver\n", new_driver->name);
2273 EXPORT_SYMBOL(phy_driver_register);
2275 int phy_drivers_register(struct phy_driver *new_driver, int n,
2276 struct module *owner)
2280 for (i = 0; i < n; i++) {
2281 ret = phy_driver_register(new_driver + i, owner);
2284 phy_driver_unregister(new_driver + i);
2290 EXPORT_SYMBOL(phy_drivers_register);
2292 void phy_driver_unregister(struct phy_driver *drv)
2294 driver_unregister(&drv->mdiodrv.driver);
2296 EXPORT_SYMBOL(phy_driver_unregister);
2298 void phy_drivers_unregister(struct phy_driver *drv, int n)
2302 for (i = 0; i < n; i++)
2303 phy_driver_unregister(drv + i);
2305 EXPORT_SYMBOL(phy_drivers_unregister);
2307 static struct phy_driver genphy_driver = {
2308 .phy_id = 0xffffffff,
2309 .phy_id_mask = 0xffffffff,
2310 .name = "Generic PHY",
2311 .soft_reset = genphy_no_soft_reset,
2312 .config_init = genphy_config_init,
2313 .features = PHY_GBIT_ALL_PORTS_FEATURES,
2314 .aneg_done = genphy_aneg_done,
2315 .suspend = genphy_suspend,
2316 .resume = genphy_resume,
2317 .set_loopback = genphy_loopback,
2320 static int __init phy_init(void)
2324 rc = mdio_bus_init();
2330 rc = phy_driver_register(&genphy_10g_driver, THIS_MODULE);
2334 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2336 phy_driver_unregister(&genphy_10g_driver);
2344 static void __exit phy_exit(void)
2346 phy_driver_unregister(&genphy_10g_driver);
2347 phy_driver_unregister(&genphy_driver);
2351 subsys_initcall(phy_init);
2352 module_exit(phy_exit);