dm writecache: add cond_resched to loop in persistent_memory_claim()
[linux/fpc-iii.git] / drivers / net / phy / phy_device.c
blob0881b4b923632adb20c76083d77f0ba800ad54f5
1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for finding and configuring PHYs.
3 * Also contains generic PHY driver
5 * Author: Andy Fleming
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 */
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>
23 #include <linux/mm.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/sfp.h>
31 #include <linux/mdio.h>
32 #include <linux/io.h>
33 #include <linux/uaccess.h>
35 MODULE_DESCRIPTION("PHY library");
36 MODULE_AUTHOR("Andy Fleming");
37 MODULE_LICENSE("GPL");
39 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
40 EXPORT_SYMBOL_GPL(phy_basic_features);
42 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
43 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
45 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
46 EXPORT_SYMBOL_GPL(phy_gbit_features);
48 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
49 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
51 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
52 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
54 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
55 EXPORT_SYMBOL_GPL(phy_10gbit_features);
57 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
58 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
60 const int phy_basic_ports_array[3] = {
61 ETHTOOL_LINK_MODE_Autoneg_BIT,
62 ETHTOOL_LINK_MODE_TP_BIT,
63 ETHTOOL_LINK_MODE_MII_BIT,
65 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
67 const int phy_fibre_port_array[1] = {
68 ETHTOOL_LINK_MODE_FIBRE_BIT,
70 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
72 const int phy_all_ports_features_array[7] = {
73 ETHTOOL_LINK_MODE_Autoneg_BIT,
74 ETHTOOL_LINK_MODE_TP_BIT,
75 ETHTOOL_LINK_MODE_MII_BIT,
76 ETHTOOL_LINK_MODE_FIBRE_BIT,
77 ETHTOOL_LINK_MODE_AUI_BIT,
78 ETHTOOL_LINK_MODE_BNC_BIT,
79 ETHTOOL_LINK_MODE_Backplane_BIT,
81 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
83 const int phy_10_100_features_array[4] = {
84 ETHTOOL_LINK_MODE_10baseT_Half_BIT,
85 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
86 ETHTOOL_LINK_MODE_100baseT_Half_BIT,
87 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
89 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
91 const int phy_basic_t1_features_array[2] = {
92 ETHTOOL_LINK_MODE_TP_BIT,
93 ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
95 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
97 const int phy_gbit_features_array[2] = {
98 ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
99 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
101 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
103 const int phy_10gbit_features_array[1] = {
104 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
106 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
108 const int phy_10gbit_fec_features_array[1] = {
109 ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
111 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features_array);
113 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
114 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
116 static const int phy_10gbit_full_features_array[] = {
117 ETHTOOL_LINK_MODE_10baseT_Full_BIT,
118 ETHTOOL_LINK_MODE_100baseT_Full_BIT,
119 ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
120 ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
123 static void features_init(void)
125 /* 10/100 half/full*/
126 linkmode_set_bit_array(phy_basic_ports_array,
127 ARRAY_SIZE(phy_basic_ports_array),
128 phy_basic_features);
129 linkmode_set_bit_array(phy_10_100_features_array,
130 ARRAY_SIZE(phy_10_100_features_array),
131 phy_basic_features);
133 /* 100 full, TP */
134 linkmode_set_bit_array(phy_basic_t1_features_array,
135 ARRAY_SIZE(phy_basic_t1_features_array),
136 phy_basic_t1_features);
138 /* 10/100 half/full + 1000 half/full */
139 linkmode_set_bit_array(phy_basic_ports_array,
140 ARRAY_SIZE(phy_basic_ports_array),
141 phy_gbit_features);
142 linkmode_set_bit_array(phy_10_100_features_array,
143 ARRAY_SIZE(phy_10_100_features_array),
144 phy_gbit_features);
145 linkmode_set_bit_array(phy_gbit_features_array,
146 ARRAY_SIZE(phy_gbit_features_array),
147 phy_gbit_features);
149 /* 10/100 half/full + 1000 half/full + fibre*/
150 linkmode_set_bit_array(phy_basic_ports_array,
151 ARRAY_SIZE(phy_basic_ports_array),
152 phy_gbit_fibre_features);
153 linkmode_set_bit_array(phy_10_100_features_array,
154 ARRAY_SIZE(phy_10_100_features_array),
155 phy_gbit_fibre_features);
156 linkmode_set_bit_array(phy_gbit_features_array,
157 ARRAY_SIZE(phy_gbit_features_array),
158 phy_gbit_fibre_features);
159 linkmode_set_bit_array(phy_fibre_port_array,
160 ARRAY_SIZE(phy_fibre_port_array),
161 phy_gbit_fibre_features);
163 /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
164 linkmode_set_bit_array(phy_all_ports_features_array,
165 ARRAY_SIZE(phy_all_ports_features_array),
166 phy_gbit_all_ports_features);
167 linkmode_set_bit_array(phy_10_100_features_array,
168 ARRAY_SIZE(phy_10_100_features_array),
169 phy_gbit_all_ports_features);
170 linkmode_set_bit_array(phy_gbit_features_array,
171 ARRAY_SIZE(phy_gbit_features_array),
172 phy_gbit_all_ports_features);
174 /* 10/100 half/full + 1000 half/full + 10G full*/
175 linkmode_set_bit_array(phy_all_ports_features_array,
176 ARRAY_SIZE(phy_all_ports_features_array),
177 phy_10gbit_features);
178 linkmode_set_bit_array(phy_10_100_features_array,
179 ARRAY_SIZE(phy_10_100_features_array),
180 phy_10gbit_features);
181 linkmode_set_bit_array(phy_gbit_features_array,
182 ARRAY_SIZE(phy_gbit_features_array),
183 phy_10gbit_features);
184 linkmode_set_bit_array(phy_10gbit_features_array,
185 ARRAY_SIZE(phy_10gbit_features_array),
186 phy_10gbit_features);
188 /* 10/100/1000/10G full */
189 linkmode_set_bit_array(phy_all_ports_features_array,
190 ARRAY_SIZE(phy_all_ports_features_array),
191 phy_10gbit_full_features);
192 linkmode_set_bit_array(phy_10gbit_full_features_array,
193 ARRAY_SIZE(phy_10gbit_full_features_array),
194 phy_10gbit_full_features);
195 /* 10G FEC only */
196 linkmode_set_bit_array(phy_10gbit_fec_features_array,
197 ARRAY_SIZE(phy_10gbit_fec_features_array),
198 phy_10gbit_fec_features);
201 void phy_device_free(struct phy_device *phydev)
203 put_device(&phydev->mdio.dev);
205 EXPORT_SYMBOL(phy_device_free);
207 static void phy_mdio_device_free(struct mdio_device *mdiodev)
209 struct phy_device *phydev;
211 phydev = container_of(mdiodev, struct phy_device, mdio);
212 phy_device_free(phydev);
215 static void phy_device_release(struct device *dev)
217 kfree(to_phy_device(dev));
220 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
222 struct phy_device *phydev;
224 phydev = container_of(mdiodev, struct phy_device, mdio);
225 phy_device_remove(phydev);
228 static struct phy_driver genphy_driver;
229 extern struct phy_driver genphy_c45_driver;
231 static LIST_HEAD(phy_fixup_list);
232 static DEFINE_MUTEX(phy_fixup_lock);
234 #ifdef CONFIG_PM
235 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
237 struct device_driver *drv = phydev->mdio.dev.driver;
238 struct phy_driver *phydrv = to_phy_driver(drv);
239 struct net_device *netdev = phydev->attached_dev;
241 if (!drv || !phydrv->suspend)
242 return false;
244 /* PHY not attached? May suspend if the PHY has not already been
245 * suspended as part of a prior call to phy_disconnect() ->
246 * phy_detach() -> phy_suspend() because the parent netdev might be the
247 * MDIO bus driver and clock gated at this point.
249 if (!netdev)
250 goto out;
252 if (netdev->wol_enabled)
253 return false;
255 /* As long as not all affected network drivers support the
256 * wol_enabled flag, let's check for hints that WoL is enabled.
257 * Don't suspend PHY if the attached netdev parent may wake up.
258 * The parent may point to a PCI device, as in tg3 driver.
260 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
261 return false;
263 /* Also don't suspend PHY if the netdev itself may wakeup. This
264 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
265 * e.g. SoC devices.
267 if (device_may_wakeup(&netdev->dev))
268 return false;
270 out:
271 return !phydev->suspended;
274 static int mdio_bus_phy_suspend(struct device *dev)
276 struct phy_device *phydev = to_phy_device(dev);
278 /* We must stop the state machine manually, otherwise it stops out of
279 * control, possibly with the phydev->lock held. Upon resume, netdev
280 * may call phy routines that try to grab the same lock, and that may
281 * lead to a deadlock.
283 if (phydev->attached_dev && phydev->adjust_link)
284 phy_stop_machine(phydev);
286 if (!mdio_bus_phy_may_suspend(phydev))
287 return 0;
289 phydev->suspended_by_mdio_bus = 1;
291 return phy_suspend(phydev);
294 static int mdio_bus_phy_resume(struct device *dev)
296 struct phy_device *phydev = to_phy_device(dev);
297 int ret;
299 if (!phydev->suspended_by_mdio_bus)
300 goto no_resume;
302 phydev->suspended_by_mdio_bus = 0;
304 ret = phy_resume(phydev);
305 if (ret < 0)
306 return ret;
308 no_resume:
309 if (phydev->attached_dev && phydev->adjust_link)
310 phy_start_machine(phydev);
312 return 0;
315 static int mdio_bus_phy_restore(struct device *dev)
317 struct phy_device *phydev = to_phy_device(dev);
318 struct net_device *netdev = phydev->attached_dev;
319 int ret;
321 if (!netdev)
322 return 0;
324 ret = phy_init_hw(phydev);
325 if (ret < 0)
326 return ret;
328 if (phydev->attached_dev && phydev->adjust_link)
329 phy_start_machine(phydev);
331 return 0;
334 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
335 .suspend = mdio_bus_phy_suspend,
336 .resume = mdio_bus_phy_resume,
337 .freeze = mdio_bus_phy_suspend,
338 .thaw = mdio_bus_phy_resume,
339 .restore = mdio_bus_phy_restore,
342 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
344 #else
346 #define MDIO_BUS_PHY_PM_OPS NULL
348 #endif /* CONFIG_PM */
351 * phy_register_fixup - creates a new phy_fixup and adds it to the list
352 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
353 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
354 * It can also be PHY_ANY_UID
355 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
356 * comparison
357 * @run: The actual code to be run when a matching PHY is found
359 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
360 int (*run)(struct phy_device *))
362 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
364 if (!fixup)
365 return -ENOMEM;
367 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
368 fixup->phy_uid = phy_uid;
369 fixup->phy_uid_mask = phy_uid_mask;
370 fixup->run = run;
372 mutex_lock(&phy_fixup_lock);
373 list_add_tail(&fixup->list, &phy_fixup_list);
374 mutex_unlock(&phy_fixup_lock);
376 return 0;
378 EXPORT_SYMBOL(phy_register_fixup);
380 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
381 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
382 int (*run)(struct phy_device *))
384 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
386 EXPORT_SYMBOL(phy_register_fixup_for_uid);
388 /* Registers a fixup to be run on the PHY with id string bus_id */
389 int phy_register_fixup_for_id(const char *bus_id,
390 int (*run)(struct phy_device *))
392 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
394 EXPORT_SYMBOL(phy_register_fixup_for_id);
397 * phy_unregister_fixup - remove a phy_fixup from the list
398 * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
399 * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
400 * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
402 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
404 struct list_head *pos, *n;
405 struct phy_fixup *fixup;
406 int ret;
408 ret = -ENODEV;
410 mutex_lock(&phy_fixup_lock);
411 list_for_each_safe(pos, n, &phy_fixup_list) {
412 fixup = list_entry(pos, struct phy_fixup, list);
414 if ((!strcmp(fixup->bus_id, bus_id)) &&
415 ((fixup->phy_uid & phy_uid_mask) ==
416 (phy_uid & phy_uid_mask))) {
417 list_del(&fixup->list);
418 kfree(fixup);
419 ret = 0;
420 break;
423 mutex_unlock(&phy_fixup_lock);
425 return ret;
427 EXPORT_SYMBOL(phy_unregister_fixup);
429 /* Unregisters a fixup of any PHY with the UID in phy_uid */
430 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
432 return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
434 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
436 /* Unregisters a fixup of the PHY with id string bus_id */
437 int phy_unregister_fixup_for_id(const char *bus_id)
439 return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
441 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
443 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
444 * Fixups can be set to match any in one or more fields.
446 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
448 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
449 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
450 return 0;
452 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
453 (phydev->phy_id & fixup->phy_uid_mask))
454 if (fixup->phy_uid != PHY_ANY_UID)
455 return 0;
457 return 1;
460 /* Runs any matching fixups for this phydev */
461 static int phy_scan_fixups(struct phy_device *phydev)
463 struct phy_fixup *fixup;
465 mutex_lock(&phy_fixup_lock);
466 list_for_each_entry(fixup, &phy_fixup_list, list) {
467 if (phy_needs_fixup(phydev, fixup)) {
468 int err = fixup->run(phydev);
470 if (err < 0) {
471 mutex_unlock(&phy_fixup_lock);
472 return err;
474 phydev->has_fixups = true;
477 mutex_unlock(&phy_fixup_lock);
479 return 0;
482 static int phy_bus_match(struct device *dev, struct device_driver *drv)
484 struct phy_device *phydev = to_phy_device(dev);
485 struct phy_driver *phydrv = to_phy_driver(drv);
486 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
487 int i;
489 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
490 return 0;
492 if (phydrv->match_phy_device)
493 return phydrv->match_phy_device(phydev);
495 if (phydev->is_c45) {
496 for (i = 1; i < num_ids; i++) {
497 if (phydev->c45_ids.device_ids[i] == 0xffffffff)
498 continue;
500 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
501 (phydev->c45_ids.device_ids[i] &
502 phydrv->phy_id_mask))
503 return 1;
505 return 0;
506 } else {
507 return (phydrv->phy_id & phydrv->phy_id_mask) ==
508 (phydev->phy_id & phydrv->phy_id_mask);
512 static ssize_t
513 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
515 struct phy_device *phydev = to_phy_device(dev);
517 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
519 static DEVICE_ATTR_RO(phy_id);
521 static ssize_t
522 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
524 struct phy_device *phydev = to_phy_device(dev);
525 const char *mode = NULL;
527 if (phy_is_internal(phydev))
528 mode = "internal";
529 else
530 mode = phy_modes(phydev->interface);
532 return sprintf(buf, "%s\n", mode);
534 static DEVICE_ATTR_RO(phy_interface);
536 static ssize_t
537 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
538 char *buf)
540 struct phy_device *phydev = to_phy_device(dev);
542 return sprintf(buf, "%d\n", phydev->has_fixups);
544 static DEVICE_ATTR_RO(phy_has_fixups);
546 static struct attribute *phy_dev_attrs[] = {
547 &dev_attr_phy_id.attr,
548 &dev_attr_phy_interface.attr,
549 &dev_attr_phy_has_fixups.attr,
550 NULL,
552 ATTRIBUTE_GROUPS(phy_dev);
554 static const struct device_type mdio_bus_phy_type = {
555 .name = "PHY",
556 .groups = phy_dev_groups,
557 .release = phy_device_release,
558 .pm = MDIO_BUS_PHY_PM_OPS,
561 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
563 int ret;
565 ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
566 MDIO_ID_ARGS(phy_id));
567 /* We only check for failures in executing the usermode binary,
568 * not whether a PHY driver module exists for the PHY ID.
569 * Accept -ENOENT because this may occur in case no initramfs exists,
570 * then modprobe isn't available.
572 if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
573 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
574 ret, (unsigned long)phy_id);
575 return ret;
578 return 0;
581 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
582 bool is_c45,
583 struct phy_c45_device_ids *c45_ids)
585 struct phy_device *dev;
586 struct mdio_device *mdiodev;
587 int ret = 0;
589 /* We allocate the device, and initialize the default values */
590 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
591 if (!dev)
592 return ERR_PTR(-ENOMEM);
594 mdiodev = &dev->mdio;
595 mdiodev->dev.parent = &bus->dev;
596 mdiodev->dev.bus = &mdio_bus_type;
597 mdiodev->dev.type = &mdio_bus_phy_type;
598 mdiodev->bus = bus;
599 mdiodev->bus_match = phy_bus_match;
600 mdiodev->addr = addr;
601 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
602 mdiodev->device_free = phy_mdio_device_free;
603 mdiodev->device_remove = phy_mdio_device_remove;
605 dev->speed = SPEED_UNKNOWN;
606 dev->duplex = DUPLEX_UNKNOWN;
607 dev->pause = 0;
608 dev->asym_pause = 0;
609 dev->link = 0;
610 dev->interface = PHY_INTERFACE_MODE_GMII;
612 dev->autoneg = AUTONEG_ENABLE;
614 dev->is_c45 = is_c45;
615 dev->phy_id = phy_id;
616 if (c45_ids)
617 dev->c45_ids = *c45_ids;
618 dev->irq = bus->irq[addr];
619 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
621 dev->state = PHY_DOWN;
623 mutex_init(&dev->lock);
624 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
626 /* Request the appropriate module unconditionally; don't
627 * bother trying to do so only if it isn't already loaded,
628 * because that gets complicated. A hotplug event would have
629 * done an unconditional modprobe anyway.
630 * We don't do normal hotplug because it won't work for MDIO
631 * -- because it relies on the device staying around for long
632 * enough for the driver to get loaded. With MDIO, the NIC
633 * driver will get bored and give up as soon as it finds that
634 * there's no driver _already_ loaded.
636 if (is_c45 && c45_ids) {
637 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
638 int i;
640 for (i = 1; i < num_ids; i++) {
641 if (c45_ids->device_ids[i] == 0xffffffff)
642 continue;
644 ret = phy_request_driver_module(dev,
645 c45_ids->device_ids[i]);
646 if (ret)
647 break;
649 } else {
650 ret = phy_request_driver_module(dev, phy_id);
653 if (!ret) {
654 device_initialize(&mdiodev->dev);
655 } else {
656 kfree(dev);
657 dev = ERR_PTR(ret);
660 return dev;
662 EXPORT_SYMBOL(phy_device_create);
664 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
665 * @bus: the target MII bus
666 * @addr: PHY address on the MII bus
667 * @dev_addr: MMD address in the PHY.
668 * @devices_in_package: where to store the devices in package information.
670 * Description: reads devices in package registers of a MMD at @dev_addr
671 * from PHY at @addr on @bus.
673 * Returns: 0 on success, -EIO on failure.
675 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
676 u32 *devices_in_package)
678 int phy_reg, reg_addr;
680 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
681 phy_reg = mdiobus_read(bus, addr, reg_addr);
682 if (phy_reg < 0)
683 return -EIO;
684 *devices_in_package = phy_reg << 16;
686 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
687 phy_reg = mdiobus_read(bus, addr, reg_addr);
688 if (phy_reg < 0)
689 return -EIO;
690 *devices_in_package |= phy_reg;
692 /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
693 *devices_in_package &= ~BIT(0);
695 return 0;
699 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
700 * @bus: the target MII bus
701 * @addr: PHY address on the MII bus
702 * @phy_id: where to store the ID retrieved.
703 * @c45_ids: where to store the c45 ID information.
705 * If the PHY devices-in-package appears to be valid, it and the
706 * corresponding identifiers are stored in @c45_ids, zero is stored
707 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
708 * zero on success.
711 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
712 struct phy_c45_device_ids *c45_ids) {
713 int phy_reg;
714 int i, reg_addr;
715 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
716 u32 *devs = &c45_ids->devices_in_package;
718 /* Find first non-zero Devices In package. Device zero is reserved
719 * for 802.3 c45 complied PHYs, so don't probe it at first.
721 for (i = 1; i < num_ids && *devs == 0; i++) {
722 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
723 if (phy_reg < 0)
724 return -EIO;
726 if ((*devs & 0x1fffffff) == 0x1fffffff) {
727 /* If mostly Fs, there is no device there,
728 * then let's continue to probe more, as some
729 * 10G PHYs have zero Devices In package,
730 * e.g. Cortina CS4315/CS4340 PHY.
732 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
733 if (phy_reg < 0)
734 return -EIO;
735 /* no device there, let's get out of here */
736 if ((*devs & 0x1fffffff) == 0x1fffffff) {
737 *phy_id = 0xffffffff;
738 return 0;
739 } else {
740 break;
745 /* Now probe Device Identifiers for each device present. */
746 for (i = 1; i < num_ids; i++) {
747 if (!(c45_ids->devices_in_package & (1 << i)))
748 continue;
750 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
751 phy_reg = mdiobus_read(bus, addr, reg_addr);
752 if (phy_reg < 0)
753 return -EIO;
754 c45_ids->device_ids[i] = phy_reg << 16;
756 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
757 phy_reg = mdiobus_read(bus, addr, reg_addr);
758 if (phy_reg < 0)
759 return -EIO;
760 c45_ids->device_ids[i] |= phy_reg;
762 *phy_id = 0;
763 return 0;
767 * get_phy_id - reads the specified addr for its ID.
768 * @bus: the target MII bus
769 * @addr: PHY address on the MII bus
770 * @phy_id: where to store the ID retrieved.
771 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
772 * @c45_ids: where to store the c45 ID information.
774 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
775 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
776 * zero on success.
778 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
779 * its return value is in turn returned.
782 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
783 bool is_c45, struct phy_c45_device_ids *c45_ids)
785 int phy_reg;
787 if (is_c45)
788 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
790 /* Grab the bits from PHYIR1, and put them in the upper half */
791 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
792 if (phy_reg < 0) {
793 /* returning -ENODEV doesn't stop bus scanning */
794 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
797 *phy_id = phy_reg << 16;
799 /* Grab the bits from PHYIR2, and put them in the lower half */
800 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
801 if (phy_reg < 0) {
802 /* returning -ENODEV doesn't stop bus scanning */
803 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
806 *phy_id |= phy_reg;
808 return 0;
812 * get_phy_device - reads the specified PHY device and returns its @phy_device
813 * struct
814 * @bus: the target MII bus
815 * @addr: PHY address on the MII bus
816 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
818 * Description: Reads the ID registers of the PHY at @addr on the
819 * @bus, then allocates and returns the phy_device to represent it.
821 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
823 struct phy_c45_device_ids c45_ids;
824 u32 phy_id = 0;
825 int r;
827 c45_ids.devices_in_package = 0;
828 memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
830 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
831 if (r)
832 return ERR_PTR(r);
834 /* If the phy_id is mostly Fs, there is no device there */
835 if ((phy_id & 0x1fffffff) == 0x1fffffff)
836 return ERR_PTR(-ENODEV);
838 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
840 EXPORT_SYMBOL(get_phy_device);
843 * phy_device_register - Register the phy device on the MDIO bus
844 * @phydev: phy_device structure to be added to the MDIO bus
846 int phy_device_register(struct phy_device *phydev)
848 int err;
850 err = mdiobus_register_device(&phydev->mdio);
851 if (err)
852 return err;
854 /* Deassert the reset signal */
855 phy_device_reset(phydev, 0);
857 /* Run all of the fixups for this PHY */
858 err = phy_scan_fixups(phydev);
859 if (err) {
860 phydev_err(phydev, "failed to initialize\n");
861 goto out;
864 err = device_add(&phydev->mdio.dev);
865 if (err) {
866 phydev_err(phydev, "failed to add\n");
867 goto out;
870 return 0;
872 out:
873 /* Assert the reset signal */
874 phy_device_reset(phydev, 1);
876 mdiobus_unregister_device(&phydev->mdio);
877 return err;
879 EXPORT_SYMBOL(phy_device_register);
882 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
883 * @phydev: phy_device structure to remove
885 * This doesn't free the phy_device itself, it merely reverses the effects
886 * of phy_device_register(). Use phy_device_free() to free the device
887 * after calling this function.
889 void phy_device_remove(struct phy_device *phydev)
891 if (phydev->mii_ts)
892 unregister_mii_timestamper(phydev->mii_ts);
894 device_del(&phydev->mdio.dev);
896 /* Assert the reset signal */
897 phy_device_reset(phydev, 1);
899 mdiobus_unregister_device(&phydev->mdio);
901 EXPORT_SYMBOL(phy_device_remove);
904 * phy_find_first - finds the first PHY device on the bus
905 * @bus: the target MII bus
907 struct phy_device *phy_find_first(struct mii_bus *bus)
909 struct phy_device *phydev;
910 int addr;
912 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
913 phydev = mdiobus_get_phy(bus, addr);
914 if (phydev)
915 return phydev;
917 return NULL;
919 EXPORT_SYMBOL(phy_find_first);
921 static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
923 struct net_device *netdev = phydev->attached_dev;
925 if (do_carrier) {
926 if (up)
927 netif_carrier_on(netdev);
928 else
929 netif_carrier_off(netdev);
931 phydev->adjust_link(netdev);
932 if (phydev->mii_ts && phydev->mii_ts->link_state)
933 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
937 * phy_prepare_link - prepares the PHY layer to monitor link status
938 * @phydev: target phy_device struct
939 * @handler: callback function for link status change notifications
941 * Description: Tells the PHY infrastructure to handle the
942 * gory details on monitoring link status (whether through
943 * polling or an interrupt), and to call back to the
944 * connected device driver when the link status changes.
945 * If you want to monitor your own link state, don't call
946 * this function.
948 static void phy_prepare_link(struct phy_device *phydev,
949 void (*handler)(struct net_device *))
951 phydev->adjust_link = handler;
955 * phy_connect_direct - connect an ethernet device to a specific phy_device
956 * @dev: the network device to connect
957 * @phydev: the pointer to the phy device
958 * @handler: callback function for state change notifications
959 * @interface: PHY device's interface
961 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
962 void (*handler)(struct net_device *),
963 phy_interface_t interface)
965 int rc;
967 if (!dev)
968 return -EINVAL;
970 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
971 if (rc)
972 return rc;
974 phy_prepare_link(phydev, handler);
975 if (phy_interrupt_is_valid(phydev))
976 phy_request_interrupt(phydev);
978 return 0;
980 EXPORT_SYMBOL(phy_connect_direct);
983 * phy_connect - connect an ethernet device to a PHY device
984 * @dev: the network device to connect
985 * @bus_id: the id string of the PHY device to connect
986 * @handler: callback function for state change notifications
987 * @interface: PHY device's interface
989 * Description: Convenience function for connecting ethernet
990 * devices to PHY devices. The default behavior is for
991 * the PHY infrastructure to handle everything, and only notify
992 * the connected driver when the link status changes. If you
993 * don't want, or can't use the provided functionality, you may
994 * choose to call only the subset of functions which provide
995 * the desired functionality.
997 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
998 void (*handler)(struct net_device *),
999 phy_interface_t interface)
1001 struct phy_device *phydev;
1002 struct device *d;
1003 int rc;
1005 /* Search the list of PHY devices on the mdio bus for the
1006 * PHY with the requested name
1008 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1009 if (!d) {
1010 pr_err("PHY %s not found\n", bus_id);
1011 return ERR_PTR(-ENODEV);
1013 phydev = to_phy_device(d);
1015 rc = phy_connect_direct(dev, phydev, handler, interface);
1016 put_device(d);
1017 if (rc)
1018 return ERR_PTR(rc);
1020 return phydev;
1022 EXPORT_SYMBOL(phy_connect);
1025 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1026 * device
1027 * @phydev: target phy_device struct
1029 void phy_disconnect(struct phy_device *phydev)
1031 if (phy_is_started(phydev))
1032 phy_stop(phydev);
1034 if (phy_interrupt_is_valid(phydev))
1035 phy_free_interrupt(phydev);
1037 phydev->adjust_link = NULL;
1039 phy_detach(phydev);
1041 EXPORT_SYMBOL(phy_disconnect);
1044 * phy_poll_reset - Safely wait until a PHY reset has properly completed
1045 * @phydev: The PHY device to poll
1047 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1048 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
1049 * register must be polled until the BMCR_RESET bit clears.
1051 * Furthermore, any attempts to write to PHY registers may have no effect
1052 * or even generate MDIO bus errors until this is complete.
1054 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1055 * standard and do not fully reset after the BMCR_RESET bit is set, and may
1056 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
1057 * effort to support such broken PHYs, this function is separate from the
1058 * standard phy_init_hw() which will zero all the other bits in the BMCR
1059 * and reapply all driver-specific and board-specific fixups.
1061 static int phy_poll_reset(struct phy_device *phydev)
1063 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1064 int ret, val;
1066 ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1067 50000, 600000, true);
1068 if (ret)
1069 return ret;
1070 /* Some chips (smsc911x) may still need up to another 1ms after the
1071 * BMCR_RESET bit is cleared before they are usable.
1073 msleep(1);
1074 return 0;
1077 int phy_init_hw(struct phy_device *phydev)
1079 int ret = 0;
1081 /* Deassert the reset signal */
1082 phy_device_reset(phydev, 0);
1084 if (!phydev->drv)
1085 return 0;
1087 if (phydev->drv->soft_reset)
1088 ret = phydev->drv->soft_reset(phydev);
1090 if (ret < 0)
1091 return ret;
1093 ret = phy_scan_fixups(phydev);
1094 if (ret < 0)
1095 return ret;
1097 if (phydev->drv->config_init)
1098 ret = phydev->drv->config_init(phydev);
1100 return ret;
1102 EXPORT_SYMBOL(phy_init_hw);
1104 void phy_attached_info(struct phy_device *phydev)
1106 phy_attached_print(phydev, NULL);
1108 EXPORT_SYMBOL(phy_attached_info);
1110 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1111 char *phy_attached_info_irq(struct phy_device *phydev)
1113 char *irq_str;
1114 char irq_num[8];
1116 switch(phydev->irq) {
1117 case PHY_POLL:
1118 irq_str = "POLL";
1119 break;
1120 case PHY_IGNORE_INTERRUPT:
1121 irq_str = "IGNORE";
1122 break;
1123 default:
1124 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1125 irq_str = irq_num;
1126 break;
1129 return kasprintf(GFP_KERNEL, "%s", irq_str);
1131 EXPORT_SYMBOL(phy_attached_info_irq);
1133 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1135 const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1136 char *irq_str = phy_attached_info_irq(phydev);
1138 if (!fmt) {
1139 phydev_info(phydev, ATTACHED_FMT "\n",
1140 drv_name, phydev_name(phydev),
1141 irq_str);
1142 } else {
1143 va_list ap;
1145 phydev_info(phydev, ATTACHED_FMT,
1146 drv_name, phydev_name(phydev),
1147 irq_str);
1149 va_start(ap, fmt);
1150 vprintk(fmt, ap);
1151 va_end(ap);
1153 kfree(irq_str);
1155 EXPORT_SYMBOL(phy_attached_print);
1157 static void phy_sysfs_create_links(struct phy_device *phydev)
1159 struct net_device *dev = phydev->attached_dev;
1160 int err;
1162 if (!dev)
1163 return;
1165 err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1166 "attached_dev");
1167 if (err)
1168 return;
1170 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1171 &phydev->mdio.dev.kobj,
1172 "phydev");
1173 if (err) {
1174 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1175 kobject_name(&phydev->mdio.dev.kobj),
1176 err);
1177 /* non-fatal - some net drivers can use one netdevice
1178 * with more then one phy
1182 phydev->sysfs_links = true;
1185 static ssize_t
1186 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1187 char *buf)
1189 struct phy_device *phydev = to_phy_device(dev);
1191 return sprintf(buf, "%d\n", !phydev->attached_dev);
1193 static DEVICE_ATTR_RO(phy_standalone);
1196 * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1197 * @upstream: pointer to the phy device
1198 * @bus: sfp bus representing cage being attached
1200 * This is used to fill in the sfp_upstream_ops .attach member.
1202 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1204 struct phy_device *phydev = upstream;
1206 if (phydev->attached_dev)
1207 phydev->attached_dev->sfp_bus = bus;
1208 phydev->sfp_bus_attached = true;
1210 EXPORT_SYMBOL(phy_sfp_attach);
1213 * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1214 * @upstream: pointer to the phy device
1215 * @bus: sfp bus representing cage being attached
1217 * This is used to fill in the sfp_upstream_ops .detach member.
1219 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1221 struct phy_device *phydev = upstream;
1223 if (phydev->attached_dev)
1224 phydev->attached_dev->sfp_bus = NULL;
1225 phydev->sfp_bus_attached = false;
1227 EXPORT_SYMBOL(phy_sfp_detach);
1230 * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1231 * @phydev: Pointer to phy_device
1232 * @ops: SFP's upstream operations
1234 int phy_sfp_probe(struct phy_device *phydev,
1235 const struct sfp_upstream_ops *ops)
1237 struct sfp_bus *bus;
1238 int ret = 0;
1240 if (phydev->mdio.dev.fwnode) {
1241 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1242 if (IS_ERR(bus))
1243 return PTR_ERR(bus);
1245 phydev->sfp_bus = bus;
1247 ret = sfp_bus_add_upstream(bus, phydev, ops);
1248 sfp_bus_put(bus);
1250 return ret;
1252 EXPORT_SYMBOL(phy_sfp_probe);
1255 * phy_attach_direct - attach a network device to a given PHY device pointer
1256 * @dev: network device to attach
1257 * @phydev: Pointer to phy_device to attach
1258 * @flags: PHY device's dev_flags
1259 * @interface: PHY device's interface
1261 * Description: Called by drivers to attach to a particular PHY
1262 * device. The phy_device is found, and properly hooked up
1263 * to the phy_driver. If no driver is attached, then a
1264 * generic driver is used. The phy_device is given a ptr to
1265 * the attaching device, and given a callback for link status
1266 * change. The phy_device is returned to the attaching driver.
1267 * This function takes a reference on the phy device.
1269 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1270 u32 flags, phy_interface_t interface)
1272 struct mii_bus *bus = phydev->mdio.bus;
1273 struct device *d = &phydev->mdio.dev;
1274 struct module *ndev_owner = NULL;
1275 bool using_genphy = false;
1276 int err;
1278 /* For Ethernet device drivers that register their own MDIO bus, we
1279 * will have bus->owner match ndev_mod, so we do not want to increment
1280 * our own module->refcnt here, otherwise we would not be able to
1281 * unload later on.
1283 if (dev)
1284 ndev_owner = dev->dev.parent->driver->owner;
1285 if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1286 phydev_err(phydev, "failed to get the bus module\n");
1287 return -EIO;
1290 get_device(d);
1292 /* Assume that if there is no driver, that it doesn't
1293 * exist, and we should use the genphy driver.
1295 if (!d->driver) {
1296 if (phydev->is_c45)
1297 d->driver = &genphy_c45_driver.mdiodrv.driver;
1298 else
1299 d->driver = &genphy_driver.mdiodrv.driver;
1301 using_genphy = true;
1304 if (!try_module_get(d->driver->owner)) {
1305 phydev_err(phydev, "failed to get the device driver module\n");
1306 err = -EIO;
1307 goto error_put_device;
1310 if (using_genphy) {
1311 err = d->driver->probe(d);
1312 if (err >= 0)
1313 err = device_bind_driver(d);
1315 if (err)
1316 goto error_module_put;
1319 if (phydev->attached_dev) {
1320 dev_err(&dev->dev, "PHY already attached\n");
1321 err = -EBUSY;
1322 goto error;
1325 phydev->phy_link_change = phy_link_change;
1326 if (dev) {
1327 phydev->attached_dev = dev;
1328 dev->phydev = phydev;
1330 if (phydev->sfp_bus_attached)
1331 dev->sfp_bus = phydev->sfp_bus;
1334 /* Some Ethernet drivers try to connect to a PHY device before
1335 * calling register_netdevice() -> netdev_register_kobject() and
1336 * does the dev->dev.kobj initialization. Here we only check for
1337 * success which indicates that the network device kobject is
1338 * ready. Once we do that we still need to keep track of whether
1339 * links were successfully set up or not for phy_detach() to
1340 * remove them accordingly.
1342 phydev->sysfs_links = false;
1344 phy_sysfs_create_links(phydev);
1346 if (!phydev->attached_dev) {
1347 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1348 &dev_attr_phy_standalone.attr);
1349 if (err)
1350 phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1353 phydev->dev_flags |= flags;
1355 phydev->interface = interface;
1357 phydev->state = PHY_READY;
1359 /* Initial carrier state is off as the phy is about to be
1360 * (re)initialized.
1362 if (dev)
1363 netif_carrier_off(phydev->attached_dev);
1365 /* Do initial configuration here, now that
1366 * we have certain key parameters
1367 * (dev_flags and interface)
1369 err = phy_init_hw(phydev);
1370 if (err)
1371 goto error;
1373 phy_resume(phydev);
1374 phy_led_triggers_register(phydev);
1376 return err;
1378 error:
1379 /* phy_detach() does all of the cleanup below */
1380 phy_detach(phydev);
1381 return err;
1383 error_module_put:
1384 module_put(d->driver->owner);
1385 error_put_device:
1386 put_device(d);
1387 if (ndev_owner != bus->owner)
1388 module_put(bus->owner);
1389 return err;
1391 EXPORT_SYMBOL(phy_attach_direct);
1394 * phy_attach - attach a network device to a particular PHY device
1395 * @dev: network device to attach
1396 * @bus_id: Bus ID of PHY device to attach
1397 * @interface: PHY device's interface
1399 * Description: Same as phy_attach_direct() except that a PHY bus_id
1400 * string is passed instead of a pointer to a struct phy_device.
1402 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1403 phy_interface_t interface)
1405 struct bus_type *bus = &mdio_bus_type;
1406 struct phy_device *phydev;
1407 struct device *d;
1408 int rc;
1410 if (!dev)
1411 return ERR_PTR(-EINVAL);
1413 /* Search the list of PHY devices on the mdio bus for the
1414 * PHY with the requested name
1416 d = bus_find_device_by_name(bus, NULL, bus_id);
1417 if (!d) {
1418 pr_err("PHY %s not found\n", bus_id);
1419 return ERR_PTR(-ENODEV);
1421 phydev = to_phy_device(d);
1423 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1424 put_device(d);
1425 if (rc)
1426 return ERR_PTR(rc);
1428 return phydev;
1430 EXPORT_SYMBOL(phy_attach);
1432 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1433 struct device_driver *driver)
1435 struct device *d = &phydev->mdio.dev;
1436 bool ret = false;
1438 if (!phydev->drv)
1439 return ret;
1441 get_device(d);
1442 ret = d->driver == driver;
1443 put_device(d);
1445 return ret;
1448 bool phy_driver_is_genphy(struct phy_device *phydev)
1450 return phy_driver_is_genphy_kind(phydev,
1451 &genphy_driver.mdiodrv.driver);
1453 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1455 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1457 return phy_driver_is_genphy_kind(phydev,
1458 &genphy_c45_driver.mdiodrv.driver);
1460 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1463 * phy_detach - detach a PHY device from its network device
1464 * @phydev: target phy_device struct
1466 * This detaches the phy device from its network device and the phy
1467 * driver, and drops the reference count taken in phy_attach_direct().
1469 void phy_detach(struct phy_device *phydev)
1471 struct net_device *dev = phydev->attached_dev;
1472 struct module *ndev_owner = NULL;
1473 struct mii_bus *bus;
1475 if (phydev->sysfs_links) {
1476 if (dev)
1477 sysfs_remove_link(&dev->dev.kobj, "phydev");
1478 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1481 if (!phydev->attached_dev)
1482 sysfs_remove_file(&phydev->mdio.dev.kobj,
1483 &dev_attr_phy_standalone.attr);
1485 phy_suspend(phydev);
1486 if (dev) {
1487 phydev->attached_dev->phydev = NULL;
1488 phydev->attached_dev = NULL;
1490 phydev->phylink = NULL;
1492 phy_led_triggers_unregister(phydev);
1494 module_put(phydev->mdio.dev.driver->owner);
1496 /* If the device had no specific driver before (i.e. - it
1497 * was using the generic driver), we unbind the device
1498 * from the generic driver so that there's a chance a
1499 * real driver could be loaded
1501 if (phy_driver_is_genphy(phydev) ||
1502 phy_driver_is_genphy_10g(phydev))
1503 device_release_driver(&phydev->mdio.dev);
1506 * The phydev might go away on the put_device() below, so avoid
1507 * a use-after-free bug by reading the underlying bus first.
1509 bus = phydev->mdio.bus;
1511 put_device(&phydev->mdio.dev);
1512 if (dev)
1513 ndev_owner = dev->dev.parent->driver->owner;
1514 if (ndev_owner != bus->owner)
1515 module_put(bus->owner);
1517 /* Assert the reset signal */
1518 phy_device_reset(phydev, 1);
1520 EXPORT_SYMBOL(phy_detach);
1522 int phy_suspend(struct phy_device *phydev)
1524 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1525 struct net_device *netdev = phydev->attached_dev;
1526 struct phy_driver *phydrv = phydev->drv;
1527 int ret;
1529 /* If the device has WOL enabled, we cannot suspend the PHY */
1530 phy_ethtool_get_wol(phydev, &wol);
1531 if (wol.wolopts || (netdev && netdev->wol_enabled))
1532 return -EBUSY;
1534 if (!phydrv || !phydrv->suspend)
1535 return 0;
1537 ret = phydrv->suspend(phydev);
1538 if (!ret)
1539 phydev->suspended = true;
1541 return ret;
1543 EXPORT_SYMBOL(phy_suspend);
1545 int __phy_resume(struct phy_device *phydev)
1547 struct phy_driver *phydrv = phydev->drv;
1548 int ret;
1550 WARN_ON(!mutex_is_locked(&phydev->lock));
1552 if (!phydrv || !phydrv->resume)
1553 return 0;
1555 ret = phydrv->resume(phydev);
1556 if (!ret)
1557 phydev->suspended = false;
1559 return ret;
1561 EXPORT_SYMBOL(__phy_resume);
1563 int phy_resume(struct phy_device *phydev)
1565 int ret;
1567 mutex_lock(&phydev->lock);
1568 ret = __phy_resume(phydev);
1569 mutex_unlock(&phydev->lock);
1571 return ret;
1573 EXPORT_SYMBOL(phy_resume);
1575 int phy_loopback(struct phy_device *phydev, bool enable)
1577 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1578 int ret = 0;
1580 mutex_lock(&phydev->lock);
1582 if (enable && phydev->loopback_enabled) {
1583 ret = -EBUSY;
1584 goto out;
1587 if (!enable && !phydev->loopback_enabled) {
1588 ret = -EINVAL;
1589 goto out;
1592 if (phydev->drv && phydrv->set_loopback)
1593 ret = phydrv->set_loopback(phydev, enable);
1594 else
1595 ret = -EOPNOTSUPP;
1597 if (ret)
1598 goto out;
1600 phydev->loopback_enabled = enable;
1602 out:
1603 mutex_unlock(&phydev->lock);
1604 return ret;
1606 EXPORT_SYMBOL(phy_loopback);
1609 * phy_reset_after_clk_enable - perform a PHY reset if needed
1610 * @phydev: target phy_device struct
1612 * Description: Some PHYs are known to need a reset after their refclk was
1613 * enabled. This function evaluates the flags and perform the reset if it's
1614 * needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1615 * was reset.
1617 int phy_reset_after_clk_enable(struct phy_device *phydev)
1619 if (!phydev || !phydev->drv)
1620 return -ENODEV;
1622 if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1623 phy_device_reset(phydev, 1);
1624 phy_device_reset(phydev, 0);
1625 return 1;
1628 return 0;
1630 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1632 /* Generic PHY support and helper functions */
1635 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1636 * @phydev: target phy_device struct
1638 * Description: Writes MII_ADVERTISE with the appropriate values,
1639 * after sanitizing the values to make sure we only advertise
1640 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1641 * hasn't changed, and > 0 if it has changed.
1643 static int genphy_config_advert(struct phy_device *phydev)
1645 int err, bmsr, changed = 0;
1646 u32 adv;
1648 /* Only allow advertising what this PHY supports */
1649 linkmode_and(phydev->advertising, phydev->advertising,
1650 phydev->supported);
1652 adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1654 /* Setup standard advertisement */
1655 err = phy_modify_changed(phydev, MII_ADVERTISE,
1656 ADVERTISE_ALL | ADVERTISE_100BASE4 |
1657 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1658 adv);
1659 if (err < 0)
1660 return err;
1661 if (err > 0)
1662 changed = 1;
1664 bmsr = phy_read(phydev, MII_BMSR);
1665 if (bmsr < 0)
1666 return bmsr;
1668 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1669 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1670 * logical 1.
1672 if (!(bmsr & BMSR_ESTATEN))
1673 return changed;
1675 adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1677 err = phy_modify_changed(phydev, MII_CTRL1000,
1678 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1679 adv);
1680 if (err < 0)
1681 return err;
1682 if (err > 0)
1683 changed = 1;
1685 return changed;
1689 * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1690 * @phydev: target phy_device struct
1692 * Description: Writes MII_ADVERTISE with the appropriate values,
1693 * after sanitizing the values to make sure we only advertise
1694 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1695 * hasn't changed, and > 0 if it has changed. This function is intended
1696 * for Clause 37 1000Base-X mode.
1698 static int genphy_c37_config_advert(struct phy_device *phydev)
1700 u16 adv = 0;
1702 /* Only allow advertising what this PHY supports */
1703 linkmode_and(phydev->advertising, phydev->advertising,
1704 phydev->supported);
1706 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1707 phydev->advertising))
1708 adv |= ADVERTISE_1000XFULL;
1709 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1710 phydev->advertising))
1711 adv |= ADVERTISE_1000XPAUSE;
1712 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1713 phydev->advertising))
1714 adv |= ADVERTISE_1000XPSE_ASYM;
1716 return phy_modify_changed(phydev, MII_ADVERTISE,
1717 ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1718 ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1719 adv);
1723 * genphy_config_eee_advert - disable unwanted eee mode advertisement
1724 * @phydev: target phy_device struct
1726 * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1727 * efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1728 * changed, and 1 if it has changed.
1730 int genphy_config_eee_advert(struct phy_device *phydev)
1732 int err;
1734 /* Nothing to disable */
1735 if (!phydev->eee_broken_modes)
1736 return 0;
1738 err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1739 phydev->eee_broken_modes, 0);
1740 /* If the call failed, we assume that EEE is not supported */
1741 return err < 0 ? 0 : err;
1743 EXPORT_SYMBOL(genphy_config_eee_advert);
1746 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1747 * @phydev: target phy_device struct
1749 * Description: Configures MII_BMCR to force speed/duplex
1750 * to the values in phydev. Assumes that the values are valid.
1751 * Please see phy_sanitize_settings().
1753 int genphy_setup_forced(struct phy_device *phydev)
1755 u16 ctl = 0;
1757 phydev->pause = 0;
1758 phydev->asym_pause = 0;
1760 if (SPEED_1000 == phydev->speed)
1761 ctl |= BMCR_SPEED1000;
1762 else if (SPEED_100 == phydev->speed)
1763 ctl |= BMCR_SPEED100;
1765 if (DUPLEX_FULL == phydev->duplex)
1766 ctl |= BMCR_FULLDPLX;
1768 return phy_modify(phydev, MII_BMCR,
1769 ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1771 EXPORT_SYMBOL(genphy_setup_forced);
1774 * genphy_restart_aneg - Enable and Restart Autonegotiation
1775 * @phydev: target phy_device struct
1777 int genphy_restart_aneg(struct phy_device *phydev)
1779 /* Don't isolate the PHY if we're negotiating */
1780 return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1781 BMCR_ANENABLE | BMCR_ANRESTART);
1783 EXPORT_SYMBOL(genphy_restart_aneg);
1786 * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
1787 * @phydev: target phy_device struct
1788 * @restart: whether aneg restart is requested
1790 * Check, and restart auto-negotiation if needed.
1792 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
1794 int ret;
1796 if (!restart) {
1797 /* Advertisement hasn't changed, but maybe aneg was never on to
1798 * begin with? Or maybe phy was isolated?
1800 ret = phy_read(phydev, MII_BMCR);
1801 if (ret < 0)
1802 return ret;
1804 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
1805 restart = true;
1808 if (restart)
1809 return genphy_restart_aneg(phydev);
1811 return 0;
1813 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
1816 * __genphy_config_aneg - restart auto-negotiation or write BMCR
1817 * @phydev: target phy_device struct
1818 * @changed: whether autoneg is requested
1820 * Description: If auto-negotiation is enabled, we configure the
1821 * advertising, and then restart auto-negotiation. If it is not
1822 * enabled, then we write the BMCR.
1824 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
1826 int err;
1828 if (genphy_config_eee_advert(phydev))
1829 changed = true;
1831 if (AUTONEG_ENABLE != phydev->autoneg)
1832 return genphy_setup_forced(phydev);
1834 err = genphy_config_advert(phydev);
1835 if (err < 0) /* error */
1836 return err;
1837 else if (err)
1838 changed = true;
1840 return genphy_check_and_restart_aneg(phydev, changed);
1842 EXPORT_SYMBOL(__genphy_config_aneg);
1845 * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
1846 * @phydev: target phy_device struct
1848 * Description: If auto-negotiation is enabled, we configure the
1849 * advertising, and then restart auto-negotiation. If it is not
1850 * enabled, then we write the BMCR. This function is intended
1851 * for use with Clause 37 1000Base-X mode.
1853 int genphy_c37_config_aneg(struct phy_device *phydev)
1855 int err, changed;
1857 if (phydev->autoneg != AUTONEG_ENABLE)
1858 return genphy_setup_forced(phydev);
1860 err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
1861 BMCR_SPEED1000);
1862 if (err)
1863 return err;
1865 changed = genphy_c37_config_advert(phydev);
1866 if (changed < 0) /* error */
1867 return changed;
1869 if (!changed) {
1870 /* Advertisement hasn't changed, but maybe aneg was never on to
1871 * begin with? Or maybe phy was isolated?
1873 int ctl = phy_read(phydev, MII_BMCR);
1875 if (ctl < 0)
1876 return ctl;
1878 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1879 changed = 1; /* do restart aneg */
1882 /* Only restart aneg if we are advertising something different
1883 * than we were before.
1885 if (changed > 0)
1886 return genphy_restart_aneg(phydev);
1888 return 0;
1890 EXPORT_SYMBOL(genphy_c37_config_aneg);
1893 * genphy_aneg_done - return auto-negotiation status
1894 * @phydev: target phy_device struct
1896 * Description: Reads the status register and returns 0 either if
1897 * auto-negotiation is incomplete, or if there was an error.
1898 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1900 int genphy_aneg_done(struct phy_device *phydev)
1902 int retval = phy_read(phydev, MII_BMSR);
1904 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1906 EXPORT_SYMBOL(genphy_aneg_done);
1909 * genphy_update_link - update link status in @phydev
1910 * @phydev: target phy_device struct
1912 * Description: Update the value in phydev->link to reflect the
1913 * current link value. In order to do this, we need to read
1914 * the status register twice, keeping the second value.
1916 int genphy_update_link(struct phy_device *phydev)
1918 int status = 0, bmcr;
1920 bmcr = phy_read(phydev, MII_BMCR);
1921 if (bmcr < 0)
1922 return bmcr;
1924 /* Autoneg is being started, therefore disregard BMSR value and
1925 * report link as down.
1927 if (bmcr & BMCR_ANRESTART)
1928 goto done;
1930 /* The link state is latched low so that momentary link
1931 * drops can be detected. Do not double-read the status
1932 * in polling mode to detect such short link drops except
1933 * the link was already down.
1935 if (!phy_polling_mode(phydev) || !phydev->link) {
1936 status = phy_read(phydev, MII_BMSR);
1937 if (status < 0)
1938 return status;
1939 else if (status & BMSR_LSTATUS)
1940 goto done;
1943 /* Read link and autonegotiation status */
1944 status = phy_read(phydev, MII_BMSR);
1945 if (status < 0)
1946 return status;
1947 done:
1948 phydev->link = status & BMSR_LSTATUS ? 1 : 0;
1949 phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
1951 /* Consider the case that autoneg was started and "aneg complete"
1952 * bit has been reset, but "link up" bit not yet.
1954 if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
1955 phydev->link = 0;
1957 return 0;
1959 EXPORT_SYMBOL(genphy_update_link);
1961 int genphy_read_lpa(struct phy_device *phydev)
1963 int lpa, lpagb;
1965 if (phydev->autoneg == AUTONEG_ENABLE) {
1966 if (!phydev->autoneg_complete) {
1967 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1969 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
1970 return 0;
1973 if (phydev->is_gigabit_capable) {
1974 lpagb = phy_read(phydev, MII_STAT1000);
1975 if (lpagb < 0)
1976 return lpagb;
1978 if (lpagb & LPA_1000MSFAIL) {
1979 int adv = phy_read(phydev, MII_CTRL1000);
1981 if (adv < 0)
1982 return adv;
1984 if (adv & CTL1000_ENABLE_MASTER)
1985 phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1986 else
1987 phydev_err(phydev, "Master/Slave resolution failed\n");
1988 return -ENOLINK;
1991 mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1992 lpagb);
1995 lpa = phy_read(phydev, MII_LPA);
1996 if (lpa < 0)
1997 return lpa;
1999 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2000 } else {
2001 linkmode_zero(phydev->lp_advertising);
2004 return 0;
2006 EXPORT_SYMBOL(genphy_read_lpa);
2009 * genphy_read_status_fixed - read the link parameters for !aneg mode
2010 * @phydev: target phy_device struct
2012 * Read the current duplex and speed state for a PHY operating with
2013 * autonegotiation disabled.
2015 int genphy_read_status_fixed(struct phy_device *phydev)
2017 int bmcr = phy_read(phydev, MII_BMCR);
2019 if (bmcr < 0)
2020 return bmcr;
2022 if (bmcr & BMCR_FULLDPLX)
2023 phydev->duplex = DUPLEX_FULL;
2024 else
2025 phydev->duplex = DUPLEX_HALF;
2027 if (bmcr & BMCR_SPEED1000)
2028 phydev->speed = SPEED_1000;
2029 else if (bmcr & BMCR_SPEED100)
2030 phydev->speed = SPEED_100;
2031 else
2032 phydev->speed = SPEED_10;
2034 return 0;
2036 EXPORT_SYMBOL(genphy_read_status_fixed);
2039 * genphy_read_status - check the link status and update current link state
2040 * @phydev: target phy_device struct
2042 * Description: Check the link, then figure out the current state
2043 * by comparing what we advertise with what the link partner
2044 * advertises. Start by checking the gigabit possibilities,
2045 * then move on to 10/100.
2047 int genphy_read_status(struct phy_device *phydev)
2049 int err, old_link = phydev->link;
2051 /* Update the link, but return if there was an error */
2052 err = genphy_update_link(phydev);
2053 if (err)
2054 return err;
2056 /* why bother the PHY if nothing can have changed */
2057 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2058 return 0;
2060 phydev->speed = SPEED_UNKNOWN;
2061 phydev->duplex = DUPLEX_UNKNOWN;
2062 phydev->pause = 0;
2063 phydev->asym_pause = 0;
2065 err = genphy_read_lpa(phydev);
2066 if (err < 0)
2067 return err;
2069 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2070 phy_resolve_aneg_linkmode(phydev);
2071 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2072 err = genphy_read_status_fixed(phydev);
2073 if (err < 0)
2074 return err;
2077 return 0;
2079 EXPORT_SYMBOL(genphy_read_status);
2082 * genphy_c37_read_status - check the link status and update current link state
2083 * @phydev: target phy_device struct
2085 * Description: Check the link, then figure out the current state
2086 * by comparing what we advertise with what the link partner
2087 * advertises. This function is for Clause 37 1000Base-X mode.
2089 int genphy_c37_read_status(struct phy_device *phydev)
2091 int lpa, err, old_link = phydev->link;
2093 /* Update the link, but return if there was an error */
2094 err = genphy_update_link(phydev);
2095 if (err)
2096 return err;
2098 /* why bother the PHY if nothing can have changed */
2099 if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2100 return 0;
2102 phydev->duplex = DUPLEX_UNKNOWN;
2103 phydev->pause = 0;
2104 phydev->asym_pause = 0;
2106 if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2107 lpa = phy_read(phydev, MII_LPA);
2108 if (lpa < 0)
2109 return lpa;
2111 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2112 phydev->lp_advertising, lpa & LPA_LPACK);
2113 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2114 phydev->lp_advertising, lpa & LPA_1000XFULL);
2115 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2116 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2117 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2118 phydev->lp_advertising,
2119 lpa & LPA_1000XPAUSE_ASYM);
2121 phy_resolve_aneg_linkmode(phydev);
2122 } else if (phydev->autoneg == AUTONEG_DISABLE) {
2123 int bmcr = phy_read(phydev, MII_BMCR);
2125 if (bmcr < 0)
2126 return bmcr;
2128 if (bmcr & BMCR_FULLDPLX)
2129 phydev->duplex = DUPLEX_FULL;
2130 else
2131 phydev->duplex = DUPLEX_HALF;
2134 return 0;
2136 EXPORT_SYMBOL(genphy_c37_read_status);
2139 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2140 * @phydev: target phy_device struct
2142 * Description: Perform a software PHY reset using the standard
2143 * BMCR_RESET bit and poll for the reset bit to be cleared.
2145 * Returns: 0 on success, < 0 on failure
2147 int genphy_soft_reset(struct phy_device *phydev)
2149 u16 res = BMCR_RESET;
2150 int ret;
2152 if (phydev->autoneg == AUTONEG_ENABLE)
2153 res |= BMCR_ANRESTART;
2155 ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2156 if (ret < 0)
2157 return ret;
2159 ret = phy_poll_reset(phydev);
2160 if (ret)
2161 return ret;
2163 /* BMCR may be reset to defaults */
2164 if (phydev->autoneg == AUTONEG_DISABLE)
2165 ret = genphy_setup_forced(phydev);
2167 return ret;
2169 EXPORT_SYMBOL(genphy_soft_reset);
2172 * genphy_read_abilities - read PHY abilities from Clause 22 registers
2173 * @phydev: target phy_device struct
2175 * Description: Reads the PHY's abilities and populates
2176 * phydev->supported accordingly.
2178 * Returns: 0 on success, < 0 on failure
2180 int genphy_read_abilities(struct phy_device *phydev)
2182 int val;
2184 linkmode_set_bit_array(phy_basic_ports_array,
2185 ARRAY_SIZE(phy_basic_ports_array),
2186 phydev->supported);
2188 val = phy_read(phydev, MII_BMSR);
2189 if (val < 0)
2190 return val;
2192 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2193 val & BMSR_ANEGCAPABLE);
2195 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2196 val & BMSR_100FULL);
2197 linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2198 val & BMSR_100HALF);
2199 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2200 val & BMSR_10FULL);
2201 linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2202 val & BMSR_10HALF);
2204 if (val & BMSR_ESTATEN) {
2205 val = phy_read(phydev, MII_ESTATUS);
2206 if (val < 0)
2207 return val;
2209 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2210 phydev->supported, val & ESTATUS_1000_TFULL);
2211 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2212 phydev->supported, val & ESTATUS_1000_THALF);
2213 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2214 phydev->supported, val & ESTATUS_1000_XFULL);
2217 return 0;
2219 EXPORT_SYMBOL(genphy_read_abilities);
2221 /* This is used for the phy device which doesn't support the MMD extended
2222 * register access, but it does have side effect when we are trying to access
2223 * the MMD register via indirect method.
2225 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2227 return -EOPNOTSUPP;
2229 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2231 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2232 u16 regnum, u16 val)
2234 return -EOPNOTSUPP;
2236 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2238 int genphy_suspend(struct phy_device *phydev)
2240 return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2242 EXPORT_SYMBOL(genphy_suspend);
2244 int genphy_resume(struct phy_device *phydev)
2246 return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2248 EXPORT_SYMBOL(genphy_resume);
2250 int genphy_loopback(struct phy_device *phydev, bool enable)
2252 return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
2253 enable ? BMCR_LOOPBACK : 0);
2255 EXPORT_SYMBOL(genphy_loopback);
2258 * phy_remove_link_mode - Remove a supported link mode
2259 * @phydev: phy_device structure to remove link mode from
2260 * @link_mode: Link mode to be removed
2262 * Description: Some MACs don't support all link modes which the PHY
2263 * does. e.g. a 1G MAC often does not support 1000Half. Add a helper
2264 * to remove a link mode.
2266 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2268 linkmode_clear_bit(link_mode, phydev->supported);
2269 phy_advertise_supported(phydev);
2271 EXPORT_SYMBOL(phy_remove_link_mode);
2273 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2275 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2276 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2277 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2278 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2282 * phy_advertise_supported - Advertise all supported modes
2283 * @phydev: target phy_device struct
2285 * Description: Called to advertise all supported modes, doesn't touch
2286 * pause mode advertising.
2288 void phy_advertise_supported(struct phy_device *phydev)
2290 __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2292 linkmode_copy(new, phydev->supported);
2293 phy_copy_pause_bits(new, phydev->advertising);
2294 linkmode_copy(phydev->advertising, new);
2296 EXPORT_SYMBOL(phy_advertise_supported);
2299 * phy_support_sym_pause - Enable support of symmetrical pause
2300 * @phydev: target phy_device struct
2302 * Description: Called by the MAC to indicate is supports symmetrical
2303 * Pause, but not asym pause.
2305 void phy_support_sym_pause(struct phy_device *phydev)
2307 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2308 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2310 EXPORT_SYMBOL(phy_support_sym_pause);
2313 * phy_support_asym_pause - Enable support of asym pause
2314 * @phydev: target phy_device struct
2316 * Description: Called by the MAC to indicate is supports Asym Pause.
2318 void phy_support_asym_pause(struct phy_device *phydev)
2320 phy_copy_pause_bits(phydev->advertising, phydev->supported);
2322 EXPORT_SYMBOL(phy_support_asym_pause);
2325 * phy_set_sym_pause - Configure symmetric Pause
2326 * @phydev: target phy_device struct
2327 * @rx: Receiver Pause is supported
2328 * @tx: Transmit Pause is supported
2329 * @autoneg: Auto neg should be used
2331 * Description: Configure advertised Pause support depending on if
2332 * receiver pause and pause auto neg is supported. Generally called
2333 * from the set_pauseparam .ndo.
2335 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2336 bool autoneg)
2338 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2340 if (rx && tx && autoneg)
2341 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2342 phydev->supported);
2344 linkmode_copy(phydev->advertising, phydev->supported);
2346 EXPORT_SYMBOL(phy_set_sym_pause);
2349 * phy_set_asym_pause - Configure Pause and Asym Pause
2350 * @phydev: target phy_device struct
2351 * @rx: Receiver Pause is supported
2352 * @tx: Transmit Pause is supported
2354 * Description: Configure advertised Pause support depending on if
2355 * transmit and receiver pause is supported. If there has been a
2356 * change in adverting, trigger a new autoneg. Generally called from
2357 * the set_pauseparam .ndo.
2359 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2361 __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2363 linkmode_copy(oldadv, phydev->advertising);
2364 linkmode_set_pause(phydev->advertising, tx, rx);
2366 if (!linkmode_equal(oldadv, phydev->advertising) &&
2367 phydev->autoneg)
2368 phy_start_aneg(phydev);
2370 EXPORT_SYMBOL(phy_set_asym_pause);
2373 * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2374 * @phydev: phy_device struct
2375 * @pp: requested pause configuration
2377 * Description: Test if the PHY/MAC combination supports the Pause
2378 * configuration the user is requesting. Returns True if it is
2379 * supported, false otherwise.
2381 bool phy_validate_pause(struct phy_device *phydev,
2382 struct ethtool_pauseparam *pp)
2384 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2385 phydev->supported) && pp->rx_pause)
2386 return false;
2388 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2389 phydev->supported) &&
2390 pp->rx_pause != pp->tx_pause)
2391 return false;
2393 return true;
2395 EXPORT_SYMBOL(phy_validate_pause);
2398 * phy_get_pause - resolve negotiated pause modes
2399 * @phydev: phy_device struct
2400 * @tx_pause: pointer to bool to indicate whether transmit pause should be
2401 * enabled.
2402 * @rx_pause: pointer to bool to indicate whether receive pause should be
2403 * enabled.
2405 * Resolve and return the flow control modes according to the negotiation
2406 * result. This includes checking that we are operating in full duplex mode.
2407 * See linkmode_resolve_pause() for further details.
2409 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2411 if (phydev->duplex != DUPLEX_FULL) {
2412 *tx_pause = false;
2413 *rx_pause = false;
2414 return;
2417 return linkmode_resolve_pause(phydev->advertising,
2418 phydev->lp_advertising,
2419 tx_pause, rx_pause);
2421 EXPORT_SYMBOL(phy_get_pause);
2423 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2425 return phydrv->config_intr && phydrv->ack_interrupt;
2429 * phy_probe - probe and init a PHY device
2430 * @dev: device to probe and init
2432 * Description: Take care of setting up the phy_device structure,
2433 * set the state to READY (the driver's init function should
2434 * set it to STARTING if needed).
2436 static int phy_probe(struct device *dev)
2438 struct phy_device *phydev = to_phy_device(dev);
2439 struct device_driver *drv = phydev->mdio.dev.driver;
2440 struct phy_driver *phydrv = to_phy_driver(drv);
2441 int err = 0;
2443 phydev->drv = phydrv;
2445 /* Disable the interrupt if the PHY doesn't support it
2446 * but the interrupt is still a valid one
2448 if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2449 phydev->irq = PHY_POLL;
2451 if (phydrv->flags & PHY_IS_INTERNAL)
2452 phydev->is_internal = true;
2454 mutex_lock(&phydev->lock);
2456 if (phydev->drv->probe) {
2457 /* Deassert the reset signal */
2458 phy_device_reset(phydev, 0);
2460 err = phydev->drv->probe(phydev);
2461 if (err) {
2462 /* Assert the reset signal */
2463 phy_device_reset(phydev, 1);
2464 goto out;
2468 /* Start out supporting everything. Eventually,
2469 * a controller will attach, and may modify one
2470 * or both of these values
2472 if (phydrv->features) {
2473 linkmode_copy(phydev->supported, phydrv->features);
2474 } else if (phydrv->get_features) {
2475 err = phydrv->get_features(phydev);
2476 } else if (phydev->is_c45) {
2477 err = genphy_c45_pma_read_abilities(phydev);
2478 } else {
2479 err = genphy_read_abilities(phydev);
2482 if (err)
2483 goto out;
2485 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2486 phydev->supported))
2487 phydev->autoneg = 0;
2489 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2490 phydev->supported))
2491 phydev->is_gigabit_capable = 1;
2492 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2493 phydev->supported))
2494 phydev->is_gigabit_capable = 1;
2496 of_set_phy_supported(phydev);
2497 phy_advertise_supported(phydev);
2499 /* Get the EEE modes we want to prohibit. We will ask
2500 * the PHY stop advertising these mode later on
2502 of_set_phy_eee_broken(phydev);
2504 /* The Pause Frame bits indicate that the PHY can support passing
2505 * pause frames. During autonegotiation, the PHYs will determine if
2506 * they should allow pause frames to pass. The MAC driver should then
2507 * use that result to determine whether to enable flow control via
2508 * pause frames.
2510 * Normally, PHY drivers should not set the Pause bits, and instead
2511 * allow phylib to do that. However, there may be some situations
2512 * (e.g. hardware erratum) where the driver wants to set only one
2513 * of these bits.
2515 if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2516 !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2517 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2518 phydev->supported);
2519 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2520 phydev->supported);
2523 /* Set the state to READY by default */
2524 phydev->state = PHY_READY;
2526 out:
2527 mutex_unlock(&phydev->lock);
2529 return err;
2532 static int phy_remove(struct device *dev)
2534 struct phy_device *phydev = to_phy_device(dev);
2536 cancel_delayed_work_sync(&phydev->state_queue);
2538 mutex_lock(&phydev->lock);
2539 phydev->state = PHY_DOWN;
2540 mutex_unlock(&phydev->lock);
2542 sfp_bus_del_upstream(phydev->sfp_bus);
2543 phydev->sfp_bus = NULL;
2545 if (phydev->drv && phydev->drv->remove) {
2546 phydev->drv->remove(phydev);
2548 /* Assert the reset signal */
2549 phy_device_reset(phydev, 1);
2551 phydev->drv = NULL;
2553 return 0;
2557 * phy_driver_register - register a phy_driver with the PHY layer
2558 * @new_driver: new phy_driver to register
2559 * @owner: module owning this PHY
2561 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2563 int retval;
2565 /* Either the features are hard coded, or dynamically
2566 * determined. It cannot be both.
2568 if (WARN_ON(new_driver->features && new_driver->get_features)) {
2569 pr_err("%s: features and get_features must not both be set\n",
2570 new_driver->name);
2571 return -EINVAL;
2574 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2575 new_driver->mdiodrv.driver.name = new_driver->name;
2576 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2577 new_driver->mdiodrv.driver.probe = phy_probe;
2578 new_driver->mdiodrv.driver.remove = phy_remove;
2579 new_driver->mdiodrv.driver.owner = owner;
2580 new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2582 retval = driver_register(&new_driver->mdiodrv.driver);
2583 if (retval) {
2584 pr_err("%s: Error %d in registering driver\n",
2585 new_driver->name, retval);
2587 return retval;
2590 pr_debug("%s: Registered new driver\n", new_driver->name);
2592 return 0;
2594 EXPORT_SYMBOL(phy_driver_register);
2596 int phy_drivers_register(struct phy_driver *new_driver, int n,
2597 struct module *owner)
2599 int i, ret = 0;
2601 for (i = 0; i < n; i++) {
2602 ret = phy_driver_register(new_driver + i, owner);
2603 if (ret) {
2604 while (i-- > 0)
2605 phy_driver_unregister(new_driver + i);
2606 break;
2609 return ret;
2611 EXPORT_SYMBOL(phy_drivers_register);
2613 void phy_driver_unregister(struct phy_driver *drv)
2615 driver_unregister(&drv->mdiodrv.driver);
2617 EXPORT_SYMBOL(phy_driver_unregister);
2619 void phy_drivers_unregister(struct phy_driver *drv, int n)
2621 int i;
2623 for (i = 0; i < n; i++)
2624 phy_driver_unregister(drv + i);
2626 EXPORT_SYMBOL(phy_drivers_unregister);
2628 static struct phy_driver genphy_driver = {
2629 .phy_id = 0xffffffff,
2630 .phy_id_mask = 0xffffffff,
2631 .name = "Generic PHY",
2632 .soft_reset = genphy_no_soft_reset,
2633 .get_features = genphy_read_abilities,
2634 .suspend = genphy_suspend,
2635 .resume = genphy_resume,
2636 .set_loopback = genphy_loopback,
2639 static int __init phy_init(void)
2641 int rc;
2643 rc = mdio_bus_init();
2644 if (rc)
2645 return rc;
2647 features_init();
2649 rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
2650 if (rc)
2651 goto err_c45;
2653 rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2654 if (rc) {
2655 phy_driver_unregister(&genphy_c45_driver);
2656 err_c45:
2657 mdio_bus_exit();
2660 return rc;
2663 static void __exit phy_exit(void)
2665 phy_driver_unregister(&genphy_c45_driver);
2666 phy_driver_unregister(&genphy_driver);
2667 mdio_bus_exit();
2670 subsys_initcall(phy_init);
2671 module_exit(phy_exit);