5 * Copyright (c) 2004 Freescale Semiconductor, Inc.
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/kernel.h>
17 #include <linux/string.h>
18 #include <linux/errno.h>
19 #include <linux/unistd.h>
20 #include <linux/slab.h>
21 #include <linux/interrupt.h>
22 #include <linux/init.h>
23 #include <linux/delay.h>
24 #include <linux/device.h>
25 #include <linux/of_device.h>
26 #include <linux/of_mdio.h>
27 #include <linux/netdevice.h>
28 #include <linux/etherdevice.h>
29 #include <linux/skbuff.h>
30 #include <linux/spinlock.h>
32 #include <linux/module.h>
33 #include <linux/mii.h>
34 #include <linux/ethtool.h>
35 #include <linux/phy.h>
37 #include <linux/uaccess.h>
42 * mdiobus_alloc_size - allocate a mii_bus structure
43 * @size: extra amount of memory to allocate for private storage.
44 * If non-zero, then bus->priv is points to that memory.
46 * Description: called by a bus driver to allocate an mii_bus
47 * structure to fill in.
49 struct mii_bus *mdiobus_alloc_size(size_t size)
52 size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
55 /* If we alloc extra space, it should be aligned */
57 alloc_size = aligned_size + size;
59 alloc_size = sizeof(*bus);
61 bus = kzalloc(alloc_size, GFP_KERNEL);
63 bus->state = MDIOBUS_ALLOCATED;
65 bus->priv = (void *)bus + aligned_size;
70 EXPORT_SYMBOL(mdiobus_alloc_size);
72 static void _devm_mdiobus_free(struct device *dev, void *res)
74 mdiobus_free(*(struct mii_bus **)res);
77 static int devm_mdiobus_match(struct device *dev, void *res, void *data)
79 struct mii_bus **r = res;
81 if (WARN_ON(!r || !*r))
88 * devm_mdiobus_alloc_size - Resource-managed mdiobus_alloc_size()
89 * @dev: Device to allocate mii_bus for
90 * @sizeof_priv: Space to allocate for private structure.
92 * Managed mdiobus_alloc_size. mii_bus allocated with this function is
93 * automatically freed on driver detach.
95 * If an mii_bus allocated with this function needs to be freed separately,
96 * devm_mdiobus_free() must be used.
99 * Pointer to allocated mii_bus on success, NULL on failure.
101 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv)
103 struct mii_bus **ptr, *bus;
105 ptr = devres_alloc(_devm_mdiobus_free, sizeof(*ptr), GFP_KERNEL);
109 /* use raw alloc_dr for kmalloc caller tracing */
110 bus = mdiobus_alloc_size(sizeof_priv);
113 devres_add(dev, ptr);
120 EXPORT_SYMBOL_GPL(devm_mdiobus_alloc_size);
123 * devm_mdiobus_free - Resource-managed mdiobus_free()
124 * @dev: Device this mii_bus belongs to
125 * @bus: the mii_bus associated with the device
127 * Free mii_bus allocated with devm_mdiobus_alloc_size().
129 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus)
133 rc = devres_release(dev, _devm_mdiobus_free,
134 devm_mdiobus_match, bus);
137 EXPORT_SYMBOL_GPL(devm_mdiobus_free);
140 * mdiobus_release - mii_bus device release callback
141 * @d: the target struct device that contains the mii_bus
143 * Description: called when the last reference to an mii_bus is
144 * dropped, to free the underlying memory.
146 static void mdiobus_release(struct device *d)
148 struct mii_bus *bus = to_mii_bus(d);
149 BUG_ON(bus->state != MDIOBUS_RELEASED &&
150 /* for compatibility with error handling in drivers */
151 bus->state != MDIOBUS_ALLOCATED);
155 static struct class mdio_bus_class = {
157 .dev_release = mdiobus_release,
160 #if IS_ENABLED(CONFIG_OF_MDIO)
161 /* Helper function for of_mdio_find_bus */
162 static int of_mdio_bus_match(struct device *dev, const void *mdio_bus_np)
164 return dev->of_node == mdio_bus_np;
167 * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
168 * @mdio_bus_np: Pointer to the mii_bus.
170 * Returns a reference to the mii_bus, or NULL if none found. The
171 * embedded struct device will have its reference count incremented,
172 * and this must be put once the bus is finished with.
174 * Because the association of a device_node and mii_bus is made via
175 * of_mdiobus_register(), the mii_bus cannot be found before it is
176 * registered with of_mdiobus_register().
179 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
186 d = class_find_device(&mdio_bus_class, NULL, mdio_bus_np,
189 return d ? to_mii_bus(d) : NULL;
191 EXPORT_SYMBOL(of_mdio_find_bus);
193 /* Walk the list of subnodes of a mdio bus and look for a node that matches the
194 * phy's address with its 'reg' property. If found, set the of_node pointer for
195 * the phy. This allows auto-probed pyh devices to be supplied with information
198 static void of_mdiobus_link_phydev(struct mii_bus *mdio,
199 struct phy_device *phydev)
201 struct device *dev = &phydev->dev;
202 struct device_node *child;
204 if (dev->of_node || !mdio->dev.of_node)
207 for_each_available_child_of_node(mdio->dev.of_node, child) {
211 ret = of_property_read_u32(child, "reg", &addr);
213 dev_err(dev, "%s has invalid PHY address\n",
218 /* A PHY must have a reg property in the range [0-31] */
219 if (addr >= PHY_MAX_ADDR) {
220 dev_err(dev, "%s PHY address %i is too large\n",
221 child->full_name, addr);
225 if (addr == phydev->addr) {
226 dev->of_node = child;
231 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
232 static inline void of_mdiobus_link_phydev(struct mii_bus *mdio,
233 struct phy_device *phydev)
239 * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
240 * @bus: target mii_bus
241 * @owner: module containing bus accessor functions
243 * Description: Called by a bus driver to bring up all the PHYs
244 * on a given bus, and attach them to the bus. Drivers should use
245 * mdiobus_register() rather than __mdiobus_register() unless they
246 * need to pass a specific owner module.
248 * Returns 0 on success or < 0 on error.
250 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
254 if (NULL == bus || NULL == bus->name ||
255 NULL == bus->read || NULL == bus->write)
258 BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
259 bus->state != MDIOBUS_UNREGISTERED);
262 bus->dev.parent = bus->parent;
263 bus->dev.class = &mdio_bus_class;
264 bus->dev.groups = NULL;
265 dev_set_name(&bus->dev, "%s", bus->id);
267 err = device_register(&bus->dev);
269 pr_err("mii_bus %s failed to register\n", bus->id);
270 put_device(&bus->dev);
274 mutex_init(&bus->mdio_lock);
279 for (i = 0; i < PHY_MAX_ADDR; i++) {
280 if ((bus->phy_mask & (1 << i)) == 0) {
281 struct phy_device *phydev;
283 phydev = mdiobus_scan(bus, i);
284 if (IS_ERR(phydev)) {
285 err = PTR_ERR(phydev);
291 bus->state = MDIOBUS_REGISTERED;
292 pr_info("%s: probed\n", bus->name);
297 struct phy_device *phydev = bus->phy_map[i];
299 phy_device_remove(phydev);
300 phy_device_free(phydev);
303 device_del(&bus->dev);
306 EXPORT_SYMBOL(__mdiobus_register);
308 void mdiobus_unregister(struct mii_bus *bus)
312 BUG_ON(bus->state != MDIOBUS_REGISTERED);
313 bus->state = MDIOBUS_UNREGISTERED;
315 for (i = 0; i < PHY_MAX_ADDR; i++) {
316 struct phy_device *phydev = bus->phy_map[i];
318 phy_device_remove(phydev);
319 phy_device_free(phydev);
322 device_del(&bus->dev);
324 EXPORT_SYMBOL(mdiobus_unregister);
327 * mdiobus_free - free a struct mii_bus
328 * @bus: mii_bus to free
330 * This function releases the reference to the underlying device
331 * object in the mii_bus. If this is the last reference, the mii_bus
334 void mdiobus_free(struct mii_bus *bus)
336 /* For compatibility with error handling in drivers. */
337 if (bus->state == MDIOBUS_ALLOCATED) {
342 BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
343 bus->state = MDIOBUS_RELEASED;
345 put_device(&bus->dev);
347 EXPORT_SYMBOL(mdiobus_free);
349 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
351 struct phy_device *phydev;
354 phydev = get_phy_device(bus, addr, false);
355 if (IS_ERR(phydev) || phydev == NULL)
359 * For DT, see if the auto-probed phy has a correspoding child
360 * in the bus node, and set the of_node pointer in this case.
362 of_mdiobus_link_phydev(bus, phydev);
364 err = phy_device_register(phydev);
366 phy_device_free(phydev);
372 EXPORT_SYMBOL(mdiobus_scan);
375 * mdiobus_read_nested - Nested version of the mdiobus_read function
376 * @bus: the mii_bus struct
377 * @addr: the phy address
378 * @regnum: register number to read
380 * In case of nested MDIO bus access avoid lockdep false positives by
381 * using mutex_lock_nested().
383 * NOTE: MUST NOT be called from interrupt context,
384 * because the bus read/write functions may wait for an interrupt
385 * to conclude the operation.
387 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
391 BUG_ON(in_interrupt());
393 mutex_lock_nested(&bus->mdio_lock, SINGLE_DEPTH_NESTING);
394 retval = bus->read(bus, addr, regnum);
395 mutex_unlock(&bus->mdio_lock);
399 EXPORT_SYMBOL(mdiobus_read_nested);
402 * mdiobus_read - Convenience function for reading a given MII mgmt register
403 * @bus: the mii_bus struct
404 * @addr: the phy address
405 * @regnum: register number to read
407 * NOTE: MUST NOT be called from interrupt context,
408 * because the bus read/write functions may wait for an interrupt
409 * to conclude the operation.
411 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
415 BUG_ON(in_interrupt());
417 mutex_lock(&bus->mdio_lock);
418 retval = bus->read(bus, addr, regnum);
419 mutex_unlock(&bus->mdio_lock);
423 EXPORT_SYMBOL(mdiobus_read);
426 * mdiobus_write_nested - Nested version of the mdiobus_write function
427 * @bus: the mii_bus struct
428 * @addr: the phy address
429 * @regnum: register number to write
430 * @val: value to write to @regnum
432 * In case of nested MDIO bus access avoid lockdep false positives by
433 * using mutex_lock_nested().
435 * NOTE: MUST NOT be called from interrupt context,
436 * because the bus read/write functions may wait for an interrupt
437 * to conclude the operation.
439 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
443 BUG_ON(in_interrupt());
445 mutex_lock_nested(&bus->mdio_lock, SINGLE_DEPTH_NESTING);
446 err = bus->write(bus, addr, regnum, val);
447 mutex_unlock(&bus->mdio_lock);
451 EXPORT_SYMBOL(mdiobus_write_nested);
454 * mdiobus_write - Convenience function for writing a given MII mgmt register
455 * @bus: the mii_bus struct
456 * @addr: the phy address
457 * @regnum: register number to write
458 * @val: value to write to @regnum
460 * NOTE: MUST NOT be called from interrupt context,
461 * because the bus read/write functions may wait for an interrupt
462 * to conclude the operation.
464 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
468 BUG_ON(in_interrupt());
470 mutex_lock(&bus->mdio_lock);
471 err = bus->write(bus, addr, regnum, val);
472 mutex_unlock(&bus->mdio_lock);
476 EXPORT_SYMBOL(mdiobus_write);
479 * mdio_bus_match - determine if given PHY driver supports the given PHY device
480 * @dev: target PHY device
481 * @drv: given PHY driver
483 * Description: Given a PHY device, and a PHY driver, return 1 if
484 * the driver supports the device. Otherwise, return 0.
486 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
488 struct phy_device *phydev = to_phy_device(dev);
489 struct phy_driver *phydrv = to_phy_driver(drv);
490 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
493 if (of_driver_match_device(dev, drv))
496 if (phydrv->match_phy_device)
497 return phydrv->match_phy_device(phydev);
499 if (phydev->is_c45) {
500 for (i = 1; i < num_ids; i++) {
501 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
504 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
505 (phydev->c45_ids.device_ids[i] &
506 phydrv->phy_id_mask))
511 return (phydrv->phy_id & phydrv->phy_id_mask) ==
512 (phydev->phy_id & phydrv->phy_id_mask);
518 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
520 struct device_driver *drv = phydev->dev.driver;
521 struct phy_driver *phydrv = to_phy_driver(drv);
522 struct net_device *netdev = phydev->attached_dev;
524 if (!drv || !phydrv->suspend)
527 /* PHY not attached? May suspend if the PHY has not already been
528 * suspended as part of a prior call to phy_disconnect() ->
529 * phy_detach() -> phy_suspend() because the parent netdev might be the
530 * MDIO bus driver and clock gated at this point.
533 return !phydev->suspended;
535 /* Don't suspend PHY if the attched netdev parent may wakeup.
536 * The parent may point to a PCI device, as in tg3 driver.
538 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
541 /* Also don't suspend PHY if the netdev itself may wakeup. This
542 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
545 if (device_may_wakeup(&netdev->dev))
551 static int mdio_bus_suspend(struct device *dev)
553 struct phy_device *phydev = to_phy_device(dev);
555 /* We must stop the state machine manually, otherwise it stops out of
556 * control, possibly with the phydev->lock held. Upon resume, netdev
557 * may call phy routines that try to grab the same lock, and that may
558 * lead to a deadlock.
560 if (phydev->attached_dev && phydev->adjust_link)
561 phy_stop_machine(phydev);
563 if (!mdio_bus_phy_may_suspend(phydev))
566 return phy_suspend(phydev);
569 static int mdio_bus_resume(struct device *dev)
571 struct phy_device *phydev = to_phy_device(dev);
574 if (!mdio_bus_phy_may_suspend(phydev))
577 ret = phy_resume(phydev);
582 if (phydev->attached_dev && phydev->adjust_link)
583 phy_start_machine(phydev);
588 static int mdio_bus_restore(struct device *dev)
590 struct phy_device *phydev = to_phy_device(dev);
591 struct net_device *netdev = phydev->attached_dev;
597 ret = phy_init_hw(phydev);
601 /* The PHY needs to renegotiate. */
603 phydev->state = PHY_UP;
605 phy_start_machine(phydev);
610 static const struct dev_pm_ops mdio_bus_pm_ops = {
611 .suspend = mdio_bus_suspend,
612 .resume = mdio_bus_resume,
613 .freeze = mdio_bus_suspend,
614 .thaw = mdio_bus_resume,
615 .restore = mdio_bus_restore,
618 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
622 #define MDIO_BUS_PM_OPS NULL
624 #endif /* CONFIG_PM */
627 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
629 struct phy_device *phydev = to_phy_device(dev);
631 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
633 static DEVICE_ATTR_RO(phy_id);
636 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
638 struct phy_device *phydev = to_phy_device(dev);
639 const char *mode = NULL;
641 if (phy_is_internal(phydev))
644 mode = phy_modes(phydev->interface);
646 return sprintf(buf, "%s\n", mode);
648 static DEVICE_ATTR_RO(phy_interface);
651 phy_has_fixups_show(struct device *dev, struct device_attribute *attr, char *buf)
653 struct phy_device *phydev = to_phy_device(dev);
655 return sprintf(buf, "%d\n", phydev->has_fixups);
657 static DEVICE_ATTR_RO(phy_has_fixups);
660 phy_registers_show(struct device *dev, struct device_attribute *attr, char *buf)
662 struct phy_device *phydev = to_phy_device(dev);
665 for (index = 0; index < 32; index++)
666 sprintf(buf, "%s%2d: 0x%x\n", buf, index,
667 phy_read(phydev, index));
673 phy_registers_store(struct device *dev,
674 struct device_attribute *attr,
675 const char *buf, size_t count)
677 struct phy_device *phydev = to_phy_device(dev);
682 for (i = 0; i < count; i++) {
683 if (*(buf + i) == ' ')
687 memset(tmp, 0, sizeof(tmp));
688 strncpy(tmp, buf, i);
689 if (kstrtoint(tmp, 0, &index)) {
690 pr_err("wrong register index input\n");
691 pr_err("usage: <reg index> <value>\n");
695 memset(tmp, 0, sizeof(tmp));
696 strncpy(tmp, buf + i + 1, strlen(buf) - i - 1);
697 if (kstrtoint(tmp, 0, &val)) {
698 pr_err("wrong register value input\n");
699 pr_err("usage: <reg index> <value>\n");
703 pr_info("Set Ethernet PHY register %d to 0x%x\n", (int)index, (int)val);
705 phy_write(phydev, index, val);
710 static DEVICE_ATTR_RW(phy_registers);
712 static struct attribute *mdio_dev_attrs[] = {
713 &dev_attr_phy_id.attr,
714 &dev_attr_phy_interface.attr,
715 &dev_attr_phy_has_fixups.attr,
716 &dev_attr_phy_registers.attr,
719 ATTRIBUTE_GROUPS(mdio_dev);
721 struct bus_type mdio_bus_type = {
723 .match = mdio_bus_match,
724 .pm = MDIO_BUS_PM_OPS,
725 .dev_groups = mdio_dev_groups,
727 EXPORT_SYMBOL(mdio_bus_type);
729 int __init mdio_bus_init(void)
733 ret = class_register(&mdio_bus_class);
735 ret = bus_register(&mdio_bus_type);
737 class_unregister(&mdio_bus_class);
743 void mdio_bus_exit(void)
745 class_unregister(&mdio_bus_class);
746 bus_unregister(&mdio_bus_type);