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 matches the
241 * phy's address with its 'reg' property. If found, set the of_node pointer for
242 * the phy. This allows auto-probed pyh devices to be supplied with information
245 static void of_mdiobus_link_phydev(struct mii_bus
*bus
,
246 struct phy_device
*phydev
)
248 struct device
*dev
= &phydev
->mdio
.dev
;
249 struct device_node
*child
;
251 if (dev
->of_node
|| !bus
->dev
.of_node
)
254 for_each_available_child_of_node(bus
->dev
.of_node
, child
) {
258 ret
= of_property_read_u32(child
, "reg", &addr
);
260 dev_err(dev
, "%s has invalid PHY address\n",
265 /* A PHY must have a reg property in the range [0-31] */
266 if (addr
>= PHY_MAX_ADDR
) {
267 dev_err(dev
, "%s PHY address %i is too large\n",
268 child
->full_name
, addr
);
272 if (addr
== phydev
->mdio
.addr
) {
273 dev
->of_node
= child
;
278 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
279 static inline void of_mdiobus_link_phydev(struct mii_bus
*mdio
,
280 struct phy_device
*phydev
)
286 * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
287 * @bus: target mii_bus
288 * @owner: module containing bus accessor functions
290 * Description: Called by a bus driver to bring up all the PHYs
291 * on a given bus, and attach them to the bus. Drivers should use
292 * mdiobus_register() rather than __mdiobus_register() unless they
293 * need to pass a specific owner module.
295 * Returns 0 on success or < 0 on error.
297 int __mdiobus_register(struct mii_bus
*bus
, struct module
*owner
)
301 if (NULL
== bus
|| NULL
== bus
->name
||
302 NULL
== bus
->read
|| NULL
== bus
->write
)
305 BUG_ON(bus
->state
!= MDIOBUS_ALLOCATED
&&
306 bus
->state
!= MDIOBUS_UNREGISTERED
);
309 bus
->dev
.parent
= bus
->parent
;
310 bus
->dev
.class = &mdio_bus_class
;
311 bus
->dev
.groups
= NULL
;
312 dev_set_name(&bus
->dev
, "%s", bus
->id
);
314 err
= device_register(&bus
->dev
);
316 pr_err("mii_bus %s failed to register\n", bus
->id
);
317 put_device(&bus
->dev
);
321 mutex_init(&bus
->mdio_lock
);
326 for (i
= 0; i
< PHY_MAX_ADDR
; i
++) {
327 if ((bus
->phy_mask
& (1 << i
)) == 0) {
328 struct phy_device
*phydev
;
330 phydev
= mdiobus_scan(bus
, i
);
331 if (IS_ERR(phydev
)) {
332 err
= PTR_ERR(phydev
);
338 bus
->state
= MDIOBUS_REGISTERED
;
339 pr_info("%s: probed\n", bus
->name
);
344 struct phy_device
*phydev
= mdiobus_get_phy(bus
, i
);
346 phy_device_remove(phydev
);
347 phy_device_free(phydev
);
350 device_del(&bus
->dev
);
353 EXPORT_SYMBOL(__mdiobus_register
);
355 void mdiobus_unregister(struct mii_bus
*bus
)
359 BUG_ON(bus
->state
!= MDIOBUS_REGISTERED
);
360 bus
->state
= MDIOBUS_UNREGISTERED
;
362 for (i
= 0; i
< PHY_MAX_ADDR
; i
++) {
363 struct phy_device
*phydev
= mdiobus_get_phy(bus
, i
);
365 phy_device_remove(phydev
);
366 phy_device_free(phydev
);
369 device_del(&bus
->dev
);
371 EXPORT_SYMBOL(mdiobus_unregister
);
374 * mdiobus_free - free a struct mii_bus
375 * @bus: mii_bus to free
377 * This function releases the reference to the underlying device
378 * object in the mii_bus. If this is the last reference, the mii_bus
381 void mdiobus_free(struct mii_bus
*bus
)
383 /* For compatibility with error handling in drivers. */
384 if (bus
->state
== MDIOBUS_ALLOCATED
) {
389 BUG_ON(bus
->state
!= MDIOBUS_UNREGISTERED
);
390 bus
->state
= MDIOBUS_RELEASED
;
392 put_device(&bus
->dev
);
394 EXPORT_SYMBOL(mdiobus_free
);
396 struct phy_device
*mdiobus_scan(struct mii_bus
*bus
, int addr
)
398 struct phy_device
*phydev
;
401 phydev
= get_phy_device(bus
, addr
, false);
402 if (IS_ERR(phydev
) || phydev
== NULL
)
406 * For DT, see if the auto-probed phy has a correspoding child
407 * in the bus node, and set the of_node pointer in this case.
409 of_mdiobus_link_phydev(bus
, phydev
);
411 err
= phy_device_register(phydev
);
413 phy_device_free(phydev
);
419 EXPORT_SYMBOL(mdiobus_scan
);
422 * mdiobus_read_nested - Nested version of the mdiobus_read function
423 * @bus: the mii_bus struct
424 * @addr: the phy address
425 * @regnum: register number to read
427 * In case of nested MDIO bus access avoid lockdep false positives by
428 * using mutex_lock_nested().
430 * NOTE: MUST NOT be called from interrupt context,
431 * because the bus read/write functions may wait for an interrupt
432 * to conclude the operation.
434 int mdiobus_read_nested(struct mii_bus
*bus
, int addr
, u32 regnum
)
438 BUG_ON(in_interrupt());
440 mutex_lock_nested(&bus
->mdio_lock
, SINGLE_DEPTH_NESTING
);
441 retval
= bus
->read(bus
, addr
, regnum
);
442 mutex_unlock(&bus
->mdio_lock
);
446 EXPORT_SYMBOL(mdiobus_read_nested
);
449 * mdiobus_read - Convenience function for reading a given MII mgmt register
450 * @bus: the mii_bus struct
451 * @addr: the phy address
452 * @regnum: register number to read
454 * NOTE: MUST NOT be called from interrupt context,
455 * because the bus read/write functions may wait for an interrupt
456 * to conclude the operation.
458 int mdiobus_read(struct mii_bus
*bus
, int addr
, u32 regnum
)
462 BUG_ON(in_interrupt());
464 mutex_lock(&bus
->mdio_lock
);
465 retval
= bus
->read(bus
, addr
, regnum
);
466 mutex_unlock(&bus
->mdio_lock
);
470 EXPORT_SYMBOL(mdiobus_read
);
473 * mdiobus_write_nested - Nested version of the mdiobus_write function
474 * @bus: the mii_bus struct
475 * @addr: the phy address
476 * @regnum: register number to write
477 * @val: value to write to @regnum
479 * In case of nested MDIO bus access avoid lockdep false positives by
480 * using mutex_lock_nested().
482 * NOTE: MUST NOT be called from interrupt context,
483 * because the bus read/write functions may wait for an interrupt
484 * to conclude the operation.
486 int mdiobus_write_nested(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
)
490 BUG_ON(in_interrupt());
492 mutex_lock_nested(&bus
->mdio_lock
, SINGLE_DEPTH_NESTING
);
493 err
= bus
->write(bus
, addr
, regnum
, val
);
494 mutex_unlock(&bus
->mdio_lock
);
498 EXPORT_SYMBOL(mdiobus_write_nested
);
501 * mdiobus_write - Convenience function for writing a given MII mgmt register
502 * @bus: the mii_bus struct
503 * @addr: the phy address
504 * @regnum: register number to write
505 * @val: value to write to @regnum
507 * NOTE: MUST NOT be called from interrupt context,
508 * because the bus read/write functions may wait for an interrupt
509 * to conclude the operation.
511 int mdiobus_write(struct mii_bus
*bus
, int addr
, u32 regnum
, u16 val
)
515 BUG_ON(in_interrupt());
517 mutex_lock(&bus
->mdio_lock
);
518 err
= bus
->write(bus
, addr
, regnum
, val
);
519 mutex_unlock(&bus
->mdio_lock
);
523 EXPORT_SYMBOL(mdiobus_write
);
526 * mdio_bus_match - determine if given PHY driver supports the given PHY device
527 * @dev: target PHY device
528 * @drv: given PHY driver
530 * Description: Given a PHY device, and a PHY driver, return 1 if
531 * the driver supports the device. Otherwise, return 0.
533 static int mdio_bus_match(struct device
*dev
, struct device_driver
*drv
)
535 struct phy_device
*phydev
= to_phy_device(dev
);
536 struct phy_driver
*phydrv
= to_phy_driver(drv
);
537 const int num_ids
= ARRAY_SIZE(phydev
->c45_ids
.device_ids
);
540 if (of_driver_match_device(dev
, drv
))
543 if (phydrv
->match_phy_device
)
544 return phydrv
->match_phy_device(phydev
);
546 if (phydev
->is_c45
) {
547 for (i
= 1; i
< num_ids
; i
++) {
548 if (!(phydev
->c45_ids
.devices_in_package
& (1 << i
)))
551 if ((phydrv
->phy_id
& phydrv
->phy_id_mask
) ==
552 (phydev
->c45_ids
.device_ids
[i
] &
553 phydrv
->phy_id_mask
))
558 return (phydrv
->phy_id
& phydrv
->phy_id_mask
) ==
559 (phydev
->phy_id
& phydrv
->phy_id_mask
);
564 static int mdio_bus_suspend(struct device
*dev
)
566 struct mdio_device
*mdio
= to_mdio_device(dev
);
568 if (mdio
->pm_ops
&& mdio
->pm_ops
->suspend
)
569 return mdio
->pm_ops
->suspend(dev
);
574 static int mdio_bus_resume(struct device
*dev
)
576 struct mdio_device
*mdio
= to_mdio_device(dev
);
578 if (mdio
->pm_ops
&& mdio
->pm_ops
->resume
)
579 return mdio
->pm_ops
->resume(dev
);
584 static int mdio_bus_restore(struct device
*dev
)
586 struct mdio_device
*mdio
= to_mdio_device(dev
);
588 if (mdio
->pm_ops
&& mdio
->pm_ops
->restore
)
589 return mdio
->pm_ops
->restore(dev
);
594 static const struct dev_pm_ops mdio_bus_pm_ops
= {
595 .suspend
= mdio_bus_suspend
,
596 .resume
= mdio_bus_resume
,
597 .freeze
= mdio_bus_suspend
,
598 .thaw
= mdio_bus_resume
,
599 .restore
= mdio_bus_restore
,
602 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
606 #define MDIO_BUS_PM_OPS NULL
608 #endif /* CONFIG_PM */
610 struct bus_type mdio_bus_type
= {
612 .match
= mdio_bus_match
,
613 .pm
= MDIO_BUS_PM_OPS
,
615 EXPORT_SYMBOL(mdio_bus_type
);
617 int __init
mdio_bus_init(void)
621 ret
= class_register(&mdio_bus_class
);
623 ret
= bus_register(&mdio_bus_type
);
625 class_unregister(&mdio_bus_class
);
631 void mdio_bus_exit(void)
633 class_unregister(&mdio_bus_class
);
634 bus_unregister(&mdio_bus_type
);