1 // SPDX-License-Identifier: GPL-2.0+
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 #include <linux/kernel.h>
12 #include <linux/string.h>
13 #include <linux/errno.h>
14 #include <linux/unistd.h>
15 #include <linux/slab.h>
16 #include <linux/interrupt.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
19 #include <linux/device.h>
20 #include <linux/gpio.h>
21 #include <linux/gpio/consumer.h>
22 #include <linux/of_device.h>
23 #include <linux/of_mdio.h>
24 #include <linux/of_gpio.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/skbuff.h>
28 #include <linux/spinlock.h>
30 #include <linux/module.h>
31 #include <linux/mii.h>
32 #include <linux/ethtool.h>
33 #include <linux/phy.h>
35 #include <linux/uaccess.h>
37 #define CREATE_TRACE_POINTS
38 #include <trace/events/mdio.h>
40 #include "mdio-boardinfo.h"
42 static int mdiobus_register_gpiod(struct mdio_device *mdiodev)
44 struct gpio_desc *gpiod = NULL;
46 /* Deassert the optional reset signal */
47 if (mdiodev->dev.of_node)
48 gpiod = fwnode_get_named_gpiod(&mdiodev->dev.of_node->fwnode,
49 "reset-gpios", 0, GPIOD_OUT_LOW,
52 if (PTR_ERR(gpiod) == -ENOENT || PTR_ERR(gpiod) == -ENOSYS)
55 return PTR_ERR(gpiod);
58 mdiodev->reset = gpiod;
60 /* Assert the reset signal again */
61 mdio_device_reset(mdiodev, 1);
66 int mdiobus_register_device(struct mdio_device *mdiodev)
70 if (mdiodev->bus->mdio_map[mdiodev->addr])
73 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY) {
74 err = mdiobus_register_gpiod(mdiodev);
79 mdiodev->bus->mdio_map[mdiodev->addr] = mdiodev;
83 EXPORT_SYMBOL(mdiobus_register_device);
85 int mdiobus_unregister_device(struct mdio_device *mdiodev)
87 if (mdiodev->bus->mdio_map[mdiodev->addr] != mdiodev)
90 mdiodev->bus->mdio_map[mdiodev->addr] = NULL;
94 EXPORT_SYMBOL(mdiobus_unregister_device);
96 struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr)
98 struct mdio_device *mdiodev = bus->mdio_map[addr];
103 if (!(mdiodev->flags & MDIO_DEVICE_FLAG_PHY))
106 return container_of(mdiodev, struct phy_device, mdio);
108 EXPORT_SYMBOL(mdiobus_get_phy);
110 bool mdiobus_is_registered_device(struct mii_bus *bus, int addr)
112 return bus->mdio_map[addr];
114 EXPORT_SYMBOL(mdiobus_is_registered_device);
117 * mdiobus_alloc_size - allocate a mii_bus structure
118 * @size: extra amount of memory to allocate for private storage.
119 * If non-zero, then bus->priv is points to that memory.
121 * Description: called by a bus driver to allocate an mii_bus
122 * structure to fill in.
124 struct mii_bus *mdiobus_alloc_size(size_t size)
127 size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
131 /* If we alloc extra space, it should be aligned */
133 alloc_size = aligned_size + size;
135 alloc_size = sizeof(*bus);
137 bus = kzalloc(alloc_size, GFP_KERNEL);
141 bus->state = MDIOBUS_ALLOCATED;
143 bus->priv = (void *)bus + aligned_size;
145 /* Initialise the interrupts to polling */
146 for (i = 0; i < PHY_MAX_ADDR; i++)
147 bus->irq[i] = PHY_POLL;
151 EXPORT_SYMBOL(mdiobus_alloc_size);
153 static void _devm_mdiobus_free(struct device *dev, void *res)
155 mdiobus_free(*(struct mii_bus **)res);
158 static int devm_mdiobus_match(struct device *dev, void *res, void *data)
160 struct mii_bus **r = res;
162 if (WARN_ON(!r || !*r))
169 * devm_mdiobus_alloc_size - Resource-managed mdiobus_alloc_size()
170 * @dev: Device to allocate mii_bus for
171 * @sizeof_priv: Space to allocate for private structure.
173 * Managed mdiobus_alloc_size. mii_bus allocated with this function is
174 * automatically freed on driver detach.
176 * If an mii_bus allocated with this function needs to be freed separately,
177 * devm_mdiobus_free() must be used.
180 * Pointer to allocated mii_bus on success, NULL on failure.
182 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv)
184 struct mii_bus **ptr, *bus;
186 ptr = devres_alloc(_devm_mdiobus_free, sizeof(*ptr), GFP_KERNEL);
190 /* use raw alloc_dr for kmalloc caller tracing */
191 bus = mdiobus_alloc_size(sizeof_priv);
194 devres_add(dev, ptr);
201 EXPORT_SYMBOL_GPL(devm_mdiobus_alloc_size);
204 * devm_mdiobus_free - Resource-managed mdiobus_free()
205 * @dev: Device this mii_bus belongs to
206 * @bus: the mii_bus associated with the device
208 * Free mii_bus allocated with devm_mdiobus_alloc_size().
210 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus)
214 rc = devres_release(dev, _devm_mdiobus_free,
215 devm_mdiobus_match, bus);
218 EXPORT_SYMBOL_GPL(devm_mdiobus_free);
221 * mdiobus_release - mii_bus device release callback
222 * @d: the target struct device that contains the mii_bus
224 * Description: called when the last reference to an mii_bus is
225 * dropped, to free the underlying memory.
227 static void mdiobus_release(struct device *d)
229 struct mii_bus *bus = to_mii_bus(d);
230 BUG_ON(bus->state != MDIOBUS_RELEASED &&
231 /* for compatibility with error handling in drivers */
232 bus->state != MDIOBUS_ALLOCATED);
236 static struct class mdio_bus_class = {
238 .dev_release = mdiobus_release,
241 #if IS_ENABLED(CONFIG_OF_MDIO)
242 /* Helper function for of_mdio_find_bus */
243 static int of_mdio_bus_match(struct device *dev, const void *mdio_bus_np)
245 return dev->of_node == mdio_bus_np;
248 * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
249 * @mdio_bus_np: Pointer to the mii_bus.
251 * Returns a reference to the mii_bus, or NULL if none found. The
252 * embedded struct device will have its reference count incremented,
253 * and this must be put once the bus is finished with.
255 * Because the association of a device_node and mii_bus is made via
256 * of_mdiobus_register(), the mii_bus cannot be found before it is
257 * registered with of_mdiobus_register().
260 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
267 d = class_find_device(&mdio_bus_class, NULL, mdio_bus_np,
270 return d ? to_mii_bus(d) : NULL;
272 EXPORT_SYMBOL(of_mdio_find_bus);
274 /* Walk the list of subnodes of a mdio bus and look for a node that
275 * matches the mdio device's address with its 'reg' property. If
276 * found, set the of_node pointer for the mdio device. This allows
277 * auto-probed phy devices to be supplied with information passed in
280 static void of_mdiobus_link_mdiodev(struct mii_bus *bus,
281 struct mdio_device *mdiodev)
283 struct device *dev = &mdiodev->dev;
284 struct device_node *child;
286 if (dev->of_node || !bus->dev.of_node)
289 for_each_available_child_of_node(bus->dev.of_node, child) {
292 addr = of_mdio_parse_addr(dev, child);
296 if (addr == mdiodev->addr) {
297 dev->of_node = child;
298 dev->fwnode = of_fwnode_handle(child);
303 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
304 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
305 struct mdio_device *mdiodev)
311 * mdiobus_create_device_from_board_info - create a full MDIO device given
312 * a mdio_board_info structure
313 * @bus: MDIO bus to create the devices on
314 * @bi: mdio_board_info structure describing the devices
316 * Returns 0 on success or < 0 on error.
318 static int mdiobus_create_device(struct mii_bus *bus,
319 struct mdio_board_info *bi)
321 struct mdio_device *mdiodev;
324 mdiodev = mdio_device_create(bus, bi->mdio_addr);
328 strncpy(mdiodev->modalias, bi->modalias,
329 sizeof(mdiodev->modalias));
330 mdiodev->bus_match = mdio_device_bus_match;
331 mdiodev->dev.platform_data = (void *)bi->platform_data;
333 ret = mdio_device_register(mdiodev);
335 mdio_device_free(mdiodev);
341 * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
342 * @bus: target mii_bus
343 * @owner: module containing bus accessor functions
345 * Description: Called by a bus driver to bring up all the PHYs
346 * on a given bus, and attach them to the bus. Drivers should use
347 * mdiobus_register() rather than __mdiobus_register() unless they
348 * need to pass a specific owner module. MDIO devices which are not
349 * PHYs will not be brought up by this function. They are expected to
350 * to be explicitly listed in DT and instantiated by of_mdiobus_register().
352 * Returns 0 on success or < 0 on error.
354 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
356 struct mdio_device *mdiodev;
358 struct gpio_desc *gpiod;
360 if (NULL == bus || NULL == bus->name ||
361 NULL == bus->read || NULL == bus->write)
364 BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
365 bus->state != MDIOBUS_UNREGISTERED);
368 bus->dev.parent = bus->parent;
369 bus->dev.class = &mdio_bus_class;
370 bus->dev.groups = NULL;
371 dev_set_name(&bus->dev, "%s", bus->id);
373 err = device_register(&bus->dev);
375 pr_err("mii_bus %s failed to register\n", bus->id);
379 mutex_init(&bus->mdio_lock);
381 /* de-assert bus level PHY GPIO reset */
382 gpiod = devm_gpiod_get_optional(&bus->dev, "reset", GPIOD_OUT_LOW);
384 dev_err(&bus->dev, "mii_bus %s couldn't get reset GPIO\n",
386 device_del(&bus->dev);
387 return PTR_ERR(gpiod);
389 bus->reset_gpiod = gpiod;
391 gpiod_set_value_cansleep(gpiod, 1);
392 udelay(bus->reset_delay_us);
393 gpiod_set_value_cansleep(gpiod, 0);
399 for (i = 0; i < PHY_MAX_ADDR; i++) {
400 if ((bus->phy_mask & (1 << i)) == 0) {
401 struct phy_device *phydev;
403 phydev = mdiobus_scan(bus, i);
404 if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV)) {
405 err = PTR_ERR(phydev);
411 mdiobus_setup_mdiodev_from_board_info(bus, mdiobus_create_device);
413 bus->state = MDIOBUS_REGISTERED;
414 pr_info("%s: probed\n", bus->name);
419 mdiodev = bus->mdio_map[i];
423 mdiodev->device_remove(mdiodev);
424 mdiodev->device_free(mdiodev);
427 /* Put PHYs in RESET to save power */
428 if (bus->reset_gpiod)
429 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
431 device_del(&bus->dev);
434 EXPORT_SYMBOL(__mdiobus_register);
436 void mdiobus_unregister(struct mii_bus *bus)
438 struct mdio_device *mdiodev;
441 BUG_ON(bus->state != MDIOBUS_REGISTERED);
442 bus->state = MDIOBUS_UNREGISTERED;
444 for (i = 0; i < PHY_MAX_ADDR; i++) {
445 mdiodev = bus->mdio_map[i];
450 gpiod_put(mdiodev->reset);
452 mdiodev->device_remove(mdiodev);
453 mdiodev->device_free(mdiodev);
456 /* Put PHYs in RESET to save power */
457 if (bus->reset_gpiod)
458 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
460 device_del(&bus->dev);
462 EXPORT_SYMBOL(mdiobus_unregister);
465 * mdiobus_free - free a struct mii_bus
466 * @bus: mii_bus to free
468 * This function releases the reference to the underlying device
469 * object in the mii_bus. If this is the last reference, the mii_bus
472 void mdiobus_free(struct mii_bus *bus)
474 /* For compatibility with error handling in drivers. */
475 if (bus->state == MDIOBUS_ALLOCATED) {
480 BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
481 bus->state = MDIOBUS_RELEASED;
483 put_device(&bus->dev);
485 EXPORT_SYMBOL(mdiobus_free);
488 * mdiobus_scan - scan a bus for MDIO devices.
489 * @bus: mii_bus to scan
490 * @addr: address on bus to scan
492 * This function scans the MDIO bus, looking for devices which can be
493 * identified using a vendor/product ID in registers 2 and 3. Not all
494 * MDIO devices have such registers, but PHY devices typically
495 * do. Hence this function assumes anything found is a PHY, or can be
496 * treated as a PHY. Other MDIO devices, such as switches, will
497 * probably not be found during the scan.
499 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
501 struct phy_device *phydev;
504 phydev = get_phy_device(bus, addr, false);
509 * For DT, see if the auto-probed phy has a correspoding child
510 * in the bus node, and set the of_node pointer in this case.
512 of_mdiobus_link_mdiodev(bus, &phydev->mdio);
514 err = phy_device_register(phydev);
516 phy_device_free(phydev);
517 return ERR_PTR(-ENODEV);
522 EXPORT_SYMBOL(mdiobus_scan);
525 * __mdiobus_read - Unlocked version of the mdiobus_read function
526 * @bus: the mii_bus struct
527 * @addr: the phy address
528 * @regnum: register number to read
530 * Read a MDIO bus register. Caller must hold the mdio bus lock.
532 * NOTE: MUST NOT be called from interrupt context.
534 int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
538 WARN_ON_ONCE(!mutex_is_locked(&bus->mdio_lock));
540 retval = bus->read(bus, addr, regnum);
542 trace_mdio_access(bus, 1, addr, regnum, retval, retval);
546 EXPORT_SYMBOL(__mdiobus_read);
549 * __mdiobus_write - Unlocked version of the mdiobus_write function
550 * @bus: the mii_bus struct
551 * @addr: the phy address
552 * @regnum: register number to write
553 * @val: value to write to @regnum
555 * Write a MDIO bus register. Caller must hold the mdio bus lock.
557 * NOTE: MUST NOT be called from interrupt context.
559 int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
563 WARN_ON_ONCE(!mutex_is_locked(&bus->mdio_lock));
565 err = bus->write(bus, addr, regnum, val);
567 trace_mdio_access(bus, 0, addr, regnum, val, err);
571 EXPORT_SYMBOL(__mdiobus_write);
574 * mdiobus_read_nested - Nested version of the mdiobus_read function
575 * @bus: the mii_bus struct
576 * @addr: the phy address
577 * @regnum: register number to read
579 * In case of nested MDIO bus access avoid lockdep false positives by
580 * using mutex_lock_nested().
582 * NOTE: MUST NOT be called from interrupt context,
583 * because the bus read/write functions may wait for an interrupt
584 * to conclude the operation.
586 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
590 BUG_ON(in_interrupt());
592 mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
593 retval = __mdiobus_read(bus, addr, regnum);
594 mutex_unlock(&bus->mdio_lock);
598 EXPORT_SYMBOL(mdiobus_read_nested);
601 * mdiobus_read - Convenience function for reading a given MII mgmt register
602 * @bus: the mii_bus struct
603 * @addr: the phy address
604 * @regnum: register number to read
606 * NOTE: MUST NOT be called from interrupt context,
607 * because the bus read/write functions may wait for an interrupt
608 * to conclude the operation.
610 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
614 BUG_ON(in_interrupt());
616 mutex_lock(&bus->mdio_lock);
617 retval = __mdiobus_read(bus, addr, regnum);
618 mutex_unlock(&bus->mdio_lock);
622 EXPORT_SYMBOL(mdiobus_read);
625 * mdiobus_write_nested - Nested version of the mdiobus_write function
626 * @bus: the mii_bus struct
627 * @addr: the phy address
628 * @regnum: register number to write
629 * @val: value to write to @regnum
631 * In case of nested MDIO bus access avoid lockdep false positives by
632 * using mutex_lock_nested().
634 * NOTE: MUST NOT be called from interrupt context,
635 * because the bus read/write functions may wait for an interrupt
636 * to conclude the operation.
638 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
642 BUG_ON(in_interrupt());
644 mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
645 err = __mdiobus_write(bus, addr, regnum, val);
646 mutex_unlock(&bus->mdio_lock);
650 EXPORT_SYMBOL(mdiobus_write_nested);
653 * mdiobus_write - Convenience function for writing a given MII mgmt register
654 * @bus: the mii_bus struct
655 * @addr: the phy address
656 * @regnum: register number to write
657 * @val: value to write to @regnum
659 * NOTE: MUST NOT be called from interrupt context,
660 * because the bus read/write functions may wait for an interrupt
661 * to conclude the operation.
663 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
667 BUG_ON(in_interrupt());
669 mutex_lock(&bus->mdio_lock);
670 err = __mdiobus_write(bus, addr, regnum, val);
671 mutex_unlock(&bus->mdio_lock);
675 EXPORT_SYMBOL(mdiobus_write);
678 * mdio_bus_match - determine if given MDIO driver supports the given
680 * @dev: target MDIO device
681 * @drv: given MDIO driver
683 * Description: Given a MDIO device, and a MDIO driver, return 1 if
684 * the driver supports the device. Otherwise, return 0. This may
685 * require calling the devices own match function, since different classes
686 * of MDIO devices have different match criteria.
688 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
690 struct mdio_device *mdio = to_mdio_device(dev);
692 if (of_driver_match_device(dev, drv))
696 return mdio->bus_match(dev, drv);
701 static int mdio_uevent(struct device *dev, struct kobj_uevent_env *env)
705 /* Some devices have extra OF data and an OF-style MODALIAS */
706 rc = of_device_uevent_modalias(dev, env);
713 struct bus_type mdio_bus_type = {
715 .match = mdio_bus_match,
716 .uevent = mdio_uevent,
718 EXPORT_SYMBOL(mdio_bus_type);
720 int __init mdio_bus_init(void)
724 ret = class_register(&mdio_bus_class);
726 ret = bus_register(&mdio_bus_type);
728 class_unregister(&mdio_bus_class);
733 EXPORT_SYMBOL_GPL(mdio_bus_init);
735 #if IS_ENABLED(CONFIG_PHYLIB)
736 void mdio_bus_exit(void)
738 class_unregister(&mdio_bus_class);
739 bus_unregister(&mdio_bus_type);
741 EXPORT_SYMBOL_GPL(mdio_bus_exit);
743 module_init(mdio_bus_init);
744 /* no module_exit, intentional */
745 MODULE_LICENSE("GPL");
746 MODULE_DESCRIPTION("MDIO bus/device layer");