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>
41 int mdiobus_register_device(struct mdio_device
*mdiodev
)
43 if (mdiodev
->bus
->mdio_map
[mdiodev
->addr
])
46 mdiodev
->bus
->mdio_map
[mdiodev
->addr
] = mdiodev
;
50 EXPORT_SYMBOL(mdiobus_register_device
);
52 int mdiobus_unregister_device(struct mdio_device
*mdiodev
)
54 if (mdiodev
->bus
->mdio_map
[mdiodev
->addr
] != mdiodev
)
57 mdiodev
->bus
->mdio_map
[mdiodev
->addr
] = NULL
;
61 EXPORT_SYMBOL(mdiobus_unregister_device
);
63 struct phy_device
*mdiobus_get_phy(struct mii_bus
*bus
, int addr
)
65 struct mdio_device
*mdiodev
= bus
->mdio_map
[addr
];
70 if (!(mdiodev
->flags
& MDIO_DEVICE_FLAG_PHY
))
73 return container_of(mdiodev
, struct phy_device
, mdio
);
75 EXPORT_SYMBOL(mdiobus_get_phy
);
77 bool mdiobus_is_registered_device(struct mii_bus
*bus
, int addr
)
79 return bus
->mdio_map
[addr
];
81 EXPORT_SYMBOL(mdiobus_is_registered_device
);
84 * mdiobus_alloc_size - allocate a mii_bus structure
85 * @size: extra amount of memory to allocate for private storage.
86 * If non-zero, then bus->priv is points to that memory.
88 * Description: called by a bus driver to allocate an mii_bus
89 * structure to fill in.
91 struct mii_bus
*mdiobus_alloc_size(size_t size
)
94 size_t aligned_size
= ALIGN(sizeof(*bus
), NETDEV_ALIGN
);
98 /* If we alloc extra space, it should be aligned */
100 alloc_size
= aligned_size
+ size
;
102 alloc_size
= sizeof(*bus
);
104 bus
= kzalloc(alloc_size
, GFP_KERNEL
);
106 bus
->state
= MDIOBUS_ALLOCATED
;
108 bus
->priv
= (void *)bus
+ aligned_size
;
111 /* Initialise the interrupts to polling */
112 for (i
= 0; i
< PHY_MAX_ADDR
; i
++)
113 bus
->irq
[i
] = PHY_POLL
;
117 EXPORT_SYMBOL(mdiobus_alloc_size
);
119 static void _devm_mdiobus_free(struct device
*dev
, void *res
)
121 mdiobus_free(*(struct mii_bus
**)res
);
124 static int devm_mdiobus_match(struct device
*dev
, void *res
, void *data
)
126 struct mii_bus
**r
= res
;
128 if (WARN_ON(!r
|| !*r
))
135 * devm_mdiobus_alloc_size - Resource-managed mdiobus_alloc_size()
136 * @dev: Device to allocate mii_bus for
137 * @sizeof_priv: Space to allocate for private structure.
139 * Managed mdiobus_alloc_size. mii_bus allocated with this function is
140 * automatically freed on driver detach.
142 * If an mii_bus allocated with this function needs to be freed separately,
143 * devm_mdiobus_free() must be used.
146 * Pointer to allocated mii_bus on success, NULL on failure.
148 struct mii_bus
*devm_mdiobus_alloc_size(struct device
*dev
, int sizeof_priv
)
150 struct mii_bus
**ptr
, *bus
;
152 ptr
= devres_alloc(_devm_mdiobus_free
, sizeof(*ptr
), GFP_KERNEL
);
156 /* use raw alloc_dr for kmalloc caller tracing */
157 bus
= mdiobus_alloc_size(sizeof_priv
);
160 devres_add(dev
, ptr
);
167 EXPORT_SYMBOL_GPL(devm_mdiobus_alloc_size
);
170 * devm_mdiobus_free - Resource-managed mdiobus_free()
171 * @dev: Device this mii_bus belongs to
172 * @bus: the mii_bus associated with the device
174 * Free mii_bus allocated with devm_mdiobus_alloc_size().
176 void devm_mdiobus_free(struct device
*dev
, struct mii_bus
*bus
)
180 rc
= devres_release(dev
, _devm_mdiobus_free
,
181 devm_mdiobus_match
, bus
);
184 EXPORT_SYMBOL_GPL(devm_mdiobus_free
);
187 * mdiobus_release - mii_bus device release callback
188 * @d: the target struct device that contains the mii_bus
190 * Description: called when the last reference to an mii_bus is
191 * dropped, to free the underlying memory.
193 static void mdiobus_release(struct device
*d
)
195 struct mii_bus
*bus
= to_mii_bus(d
);
196 BUG_ON(bus
->state
!= MDIOBUS_RELEASED
&&
197 /* for compatibility with error handling in drivers */
198 bus
->state
!= MDIOBUS_ALLOCATED
);
202 static struct class mdio_bus_class
= {
204 .dev_release
= mdiobus_release
,
207 #if IS_ENABLED(CONFIG_OF_MDIO)
208 /* Helper function for of_mdio_find_bus */
209 static int of_mdio_bus_match(struct device
*dev
, const void *mdio_bus_np
)
211 return dev
->of_node
== mdio_bus_np
;
214 * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
215 * @mdio_bus_np: Pointer to the mii_bus.
217 * Returns a reference to the mii_bus, or NULL if none found. The
218 * embedded struct device will have its reference count incremented,
219 * and this must be put once the bus is finished with.
221 * Because the association of a device_node and mii_bus is made via
222 * of_mdiobus_register(), the mii_bus cannot be found before it is
223 * registered with of_mdiobus_register().
226 struct mii_bus
*of_mdio_find_bus(struct device_node
*mdio_bus_np
)
233 d
= class_find_device(&mdio_bus_class
, NULL
, mdio_bus_np
,
236 return d
? to_mii_bus(d
) : NULL
;
238 EXPORT_SYMBOL(of_mdio_find_bus
);
240 /* Walk the list of subnodes of a mdio bus and look for a node that
241 * matches the mdio device's address with its 'reg' property. If
242 * found, set the of_node pointer for the mdio device. This allows
243 * auto-probed phy devices to be supplied with information passed in
246 static void of_mdiobus_link_mdiodev(struct mii_bus
*bus
,
247 struct mdio_device
*mdiodev
)
249 struct device
*dev
= &mdiodev
->dev
;
250 struct device_node
*child
;
252 if (dev
->of_node
|| !bus
->dev
.of_node
)
255 for_each_available_child_of_node(bus
->dev
.of_node
, child
) {
259 ret
= of_property_read_u32(child
, "reg", &addr
);
261 dev_err(dev
, "%s has invalid MDIO address\n",
266 /* A MDIO device must have a reg property in the range [0-31] */
267 if (addr
>= PHY_MAX_ADDR
) {
268 dev_err(dev
, "%s MDIO address %i is too large\n",
269 child
->full_name
, addr
);
273 if (addr
== mdiodev
->addr
) {
274 dev
->of_node
= child
;
279 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
280 static inline void of_mdiobus_link_mdiodev(struct mii_bus
*mdio
,
281 struct mdio_device
*mdiodev
)
287 * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
288 * @bus: target mii_bus
289 * @owner: module containing bus accessor functions
291 * Description: Called by a bus driver to bring up all the PHYs
292 * on a given bus, and attach them to the bus. Drivers should use
293 * mdiobus_register() rather than __mdiobus_register() unless they
294 * need to pass a specific owner module. MDIO devices which are not
295 * PHYs will not be brought up by this function. They are expected to
296 * to be explicitly listed in DT and instantiated by of_mdiobus_register().
298 * Returns 0 on success or < 0 on error.
300 int __mdiobus_register(struct mii_bus
*bus
, struct module
*owner
)
302 struct mdio_device
*mdiodev
;
305 if (NULL
== bus
|| NULL
== bus
->name
||
306 NULL
== bus
->read
|| NULL
== bus
->write
)
309 BUG_ON(bus
->state
!= MDIOBUS_ALLOCATED
&&
310 bus
->state
!= MDIOBUS_UNREGISTERED
);
313 bus
->dev
.parent
= bus
->parent
;
314 bus
->dev
.class = &mdio_bus_class
;
315 bus
->dev
.groups
= NULL
;
316 dev_set_name(&bus
->dev
, "%s", bus
->id
);
318 err
= device_register(&bus
->dev
);
320 pr_err("mii_bus %s failed to register\n", bus
->id
);
321 put_device(&bus
->dev
);
325 mutex_init(&bus
->mdio_lock
);
330 for (i
= 0; i
< PHY_MAX_ADDR
; i
++) {
331 if ((bus
->phy_mask
& (1 << i
)) == 0) {
332 struct phy_device
*phydev
;
334 phydev
= mdiobus_scan(bus
, i
);
335 if (IS_ERR(phydev
)) {
336 err
= PTR_ERR(phydev
);
342 bus
->state
= MDIOBUS_REGISTERED
;
343 pr_info("%s: probed\n", bus
->name
);
348 mdiodev
= bus
->mdio_map
[i
];
352 mdiodev
->device_remove(mdiodev
);
353 mdiodev
->device_free(mdiodev
);
355 device_del(&bus
->dev
);
358 EXPORT_SYMBOL(__mdiobus_register
);
360 void mdiobus_unregister(struct mii_bus
*bus
)
362 struct mdio_device
*mdiodev
;
365 BUG_ON(bus
->state
!= MDIOBUS_REGISTERED
);
366 bus
->state
= MDIOBUS_UNREGISTERED
;
368 for (i
= 0; i
< PHY_MAX_ADDR
; i
++) {
369 mdiodev
= bus
->mdio_map
[i
];
373 mdiodev
->device_remove(mdiodev
);
374 mdiodev
->device_free(mdiodev
);
376 device_del(&bus
->dev
);
378 EXPORT_SYMBOL(mdiobus_unregister
);
381 * mdiobus_free - free a struct mii_bus
382 * @bus: mii_bus to free
384 * This function releases the reference to the underlying device
385 * object in the mii_bus. If this is the last reference, the mii_bus
388 void mdiobus_free(struct mii_bus
*bus
)
390 /* For compatibility with error handling in drivers. */
391 if (bus
->state
== MDIOBUS_ALLOCATED
) {
396 BUG_ON(bus
->state
!= MDIOBUS_UNREGISTERED
);
397 bus
->state
= MDIOBUS_RELEASED
;
399 put_device(&bus
->dev
);
401 EXPORT_SYMBOL(mdiobus_free
);
404 * mdiobus_scan - scan a bus for MDIO devices.
405 * @bus: mii_bus to scan
406 * @addr: address on bus to scan
408 * This function scans the MDIO bus, looking for devices which can be
409 * identified using a vendor/product ID in registers 2 and 3. Not all
410 * MDIO devices have such registers, but PHY devices typically
411 * do. Hence this function assumes anything found is a PHY, or can be
412 * treated as a PHY. Other MDIO devices, such as switches, will
413 * probably not be found during the scan.
415 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
)
417 struct phy_device
*phydev
;
420 phydev
= get_phy_device(bus
, addr
, false);
421 if (IS_ERR(phydev
) || phydev
== NULL
)
425 * For DT, see if the auto-probed phy has a correspoding child
426 * in the bus node, and set the of_node pointer in this case.
428 of_mdiobus_link_mdiodev(bus
, &phydev
->mdio
);
430 err
= phy_device_register(phydev
);
432 phy_device_free(phydev
);
438 EXPORT_SYMBOL(mdiobus_scan
);
441 * mdiobus_read_nested - Nested version of the mdiobus_read function
442 * @bus: the mii_bus struct
443 * @addr: the phy address
444 * @regnum: register number to read
446 * In case of nested MDIO bus access avoid lockdep false positives by
447 * using mutex_lock_nested().
449 * NOTE: MUST NOT be called from interrupt context,
450 * because the bus read/write functions may wait for an interrupt
451 * to conclude the operation.
453 int mdiobus_read_nested(struct mii_bus
*bus
, int addr
, u32 regnum
)
457 BUG_ON(in_interrupt());
459 mutex_lock_nested(&bus
->mdio_lock
, SINGLE_DEPTH_NESTING
);
460 retval
= bus
->read(bus
, addr
, regnum
);
461 mutex_unlock(&bus
->mdio_lock
);
465 EXPORT_SYMBOL(mdiobus_read_nested
);
468 * mdiobus_read - Convenience function for reading a given MII mgmt register
469 * @bus: the mii_bus struct
470 * @addr: the phy address
471 * @regnum: register number to read
473 * NOTE: MUST NOT be called from interrupt context,
474 * because the bus read/write functions may wait for an interrupt
475 * to conclude the operation.
477 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
)
481 BUG_ON(in_interrupt());
483 mutex_lock(&bus
->mdio_lock
);
484 retval
= bus
->read(bus
, addr
, regnum
);
485 mutex_unlock(&bus
->mdio_lock
);
489 EXPORT_SYMBOL(mdiobus_read
);
492 * mdiobus_write_nested - Nested version of the mdiobus_write function
493 * @bus: the mii_bus struct
494 * @addr: the phy address
495 * @regnum: register number to write
496 * @val: value to write to @regnum
498 * In case of nested MDIO bus access avoid lockdep false positives by
499 * using mutex_lock_nested().
501 * NOTE: MUST NOT be called from interrupt context,
502 * because the bus read/write functions may wait for an interrupt
503 * to conclude the operation.
505 int mdiobus_write_nested(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
)
509 BUG_ON(in_interrupt());
511 mutex_lock_nested(&bus
->mdio_lock
, SINGLE_DEPTH_NESTING
);
512 err
= bus
->write(bus
, addr
, regnum
, val
);
513 mutex_unlock(&bus
->mdio_lock
);
517 EXPORT_SYMBOL(mdiobus_write_nested
);
520 * mdiobus_write - Convenience function for writing a given MII mgmt register
521 * @bus: the mii_bus struct
522 * @addr: the phy address
523 * @regnum: register number to write
524 * @val: value to write to @regnum
526 * NOTE: MUST NOT be called from interrupt context,
527 * because the bus read/write functions may wait for an interrupt
528 * to conclude the operation.
530 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
)
534 BUG_ON(in_interrupt());
536 mutex_lock(&bus
->mdio_lock
);
537 err
= bus
->write(bus
, addr
, regnum
, val
);
538 mutex_unlock(&bus
->mdio_lock
);
542 EXPORT_SYMBOL(mdiobus_write
);
545 * mdio_bus_match - determine if given MDIO driver supports the given
547 * @dev: target MDIO device
548 * @drv: given MDIO driver
550 * Description: Given a MDIO device, and a MDIO driver, return 1 if
551 * the driver supports the device. Otherwise, return 0. This may
552 * require calling the devices own match function, since different classes
553 * of MDIO devices have different match criteria.
555 static int mdio_bus_match(struct device
*dev
, struct device_driver
*drv
)
557 struct mdio_device
*mdio
= to_mdio_device(dev
);
559 if (of_driver_match_device(dev
, drv
))
563 return mdio
->bus_match(dev
, drv
);
569 static int mdio_bus_suspend(struct device
*dev
)
571 struct mdio_device
*mdio
= to_mdio_device(dev
);
573 if (mdio
->pm_ops
&& mdio
->pm_ops
->suspend
)
574 return mdio
->pm_ops
->suspend(dev
);
579 static int mdio_bus_resume(struct device
*dev
)
581 struct mdio_device
*mdio
= to_mdio_device(dev
);
583 if (mdio
->pm_ops
&& mdio
->pm_ops
->resume
)
584 return mdio
->pm_ops
->resume(dev
);
589 static int mdio_bus_restore(struct device
*dev
)
591 struct mdio_device
*mdio
= to_mdio_device(dev
);
593 if (mdio
->pm_ops
&& mdio
->pm_ops
->restore
)
594 return mdio
->pm_ops
->restore(dev
);
599 static const struct dev_pm_ops mdio_bus_pm_ops
= {
600 .suspend
= mdio_bus_suspend
,
601 .resume
= mdio_bus_resume
,
602 .freeze
= mdio_bus_suspend
,
603 .thaw
= mdio_bus_resume
,
604 .restore
= mdio_bus_restore
,
607 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
611 #define MDIO_BUS_PM_OPS NULL
613 #endif /* CONFIG_PM */
615 struct bus_type mdio_bus_type
= {
617 .match
= mdio_bus_match
,
618 .pm
= MDIO_BUS_PM_OPS
,
620 EXPORT_SYMBOL(mdio_bus_type
);
622 int __init
mdio_bus_init(void)
626 ret
= class_register(&mdio_bus_class
);
628 ret
= bus_register(&mdio_bus_type
);
630 class_unregister(&mdio_bus_class
);
636 void mdio_bus_exit(void)
638 class_unregister(&mdio_bus_class
);
639 bus_unregister(&mdio_bus_type
);