Merge remote-tracking branches 'asoc/fix/adsp', 'asoc/fix/amd', 'asoc/fix/atmel'...
[linux-2.6-microblaze.git] / drivers / net / phy / mdio_bus.c
1 /* MDIO Bus interface
2  *
3  * Author: Andy Fleming
4  *
5  * Copyright (c) 2004 Freescale Semiconductor, Inc.
6  *
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.
11  *
12  */
13
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15
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/gpio.h>
26 #include <linux/gpio/consumer.h>
27 #include <linux/of_device.h>
28 #include <linux/of_mdio.h>
29 #include <linux/of_gpio.h>
30 #include <linux/netdevice.h>
31 #include <linux/etherdevice.h>
32 #include <linux/skbuff.h>
33 #include <linux/spinlock.h>
34 #include <linux/mm.h>
35 #include <linux/module.h>
36 #include <linux/mii.h>
37 #include <linux/ethtool.h>
38 #include <linux/phy.h>
39 #include <linux/io.h>
40 #include <linux/uaccess.h>
41
42 #include <asm/irq.h>
43
44 #define CREATE_TRACE_POINTS
45 #include <trace/events/mdio.h>
46
47 #include "mdio-boardinfo.h"
48
49 int mdiobus_register_device(struct mdio_device *mdiodev)
50 {
51         if (mdiodev->bus->mdio_map[mdiodev->addr])
52                 return -EBUSY;
53
54         mdiodev->bus->mdio_map[mdiodev->addr] = mdiodev;
55
56         return 0;
57 }
58 EXPORT_SYMBOL(mdiobus_register_device);
59
60 int mdiobus_unregister_device(struct mdio_device *mdiodev)
61 {
62         if (mdiodev->bus->mdio_map[mdiodev->addr] != mdiodev)
63                 return -EINVAL;
64
65         mdiodev->bus->mdio_map[mdiodev->addr] = NULL;
66
67         return 0;
68 }
69 EXPORT_SYMBOL(mdiobus_unregister_device);
70
71 struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr)
72 {
73         struct mdio_device *mdiodev = bus->mdio_map[addr];
74
75         if (!mdiodev)
76                 return NULL;
77
78         if (!(mdiodev->flags & MDIO_DEVICE_FLAG_PHY))
79                 return NULL;
80
81         return container_of(mdiodev, struct phy_device, mdio);
82 }
83 EXPORT_SYMBOL(mdiobus_get_phy);
84
85 bool mdiobus_is_registered_device(struct mii_bus *bus, int addr)
86 {
87         return bus->mdio_map[addr];
88 }
89 EXPORT_SYMBOL(mdiobus_is_registered_device);
90
91 /**
92  * mdiobus_alloc_size - allocate a mii_bus structure
93  * @size: extra amount of memory to allocate for private storage.
94  * If non-zero, then bus->priv is points to that memory.
95  *
96  * Description: called by a bus driver to allocate an mii_bus
97  * structure to fill in.
98  */
99 struct mii_bus *mdiobus_alloc_size(size_t size)
100 {
101         struct mii_bus *bus;
102         size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
103         size_t alloc_size;
104         int i;
105
106         /* If we alloc extra space, it should be aligned */
107         if (size)
108                 alloc_size = aligned_size + size;
109         else
110                 alloc_size = sizeof(*bus);
111
112         bus = kzalloc(alloc_size, GFP_KERNEL);
113         if (!bus)
114                 return NULL;
115
116         bus->state = MDIOBUS_ALLOCATED;
117         if (size)
118                 bus->priv = (void *)bus + aligned_size;
119
120         /* Initialise the interrupts to polling */
121         for (i = 0; i < PHY_MAX_ADDR; i++)
122                 bus->irq[i] = PHY_POLL;
123
124         return bus;
125 }
126 EXPORT_SYMBOL(mdiobus_alloc_size);
127
128 static void _devm_mdiobus_free(struct device *dev, void *res)
129 {
130         mdiobus_free(*(struct mii_bus **)res);
131 }
132
133 static int devm_mdiobus_match(struct device *dev, void *res, void *data)
134 {
135         struct mii_bus **r = res;
136
137         if (WARN_ON(!r || !*r))
138                 return 0;
139
140         return *r == data;
141 }
142
143 /**
144  * devm_mdiobus_alloc_size - Resource-managed mdiobus_alloc_size()
145  * @dev:                Device to allocate mii_bus for
146  * @sizeof_priv:        Space to allocate for private structure.
147  *
148  * Managed mdiobus_alloc_size. mii_bus allocated with this function is
149  * automatically freed on driver detach.
150  *
151  * If an mii_bus allocated with this function needs to be freed separately,
152  * devm_mdiobus_free() must be used.
153  *
154  * RETURNS:
155  * Pointer to allocated mii_bus on success, NULL on failure.
156  */
157 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv)
158 {
159         struct mii_bus **ptr, *bus;
160
161         ptr = devres_alloc(_devm_mdiobus_free, sizeof(*ptr), GFP_KERNEL);
162         if (!ptr)
163                 return NULL;
164
165         /* use raw alloc_dr for kmalloc caller tracing */
166         bus = mdiobus_alloc_size(sizeof_priv);
167         if (bus) {
168                 *ptr = bus;
169                 devres_add(dev, ptr);
170         } else {
171                 devres_free(ptr);
172         }
173
174         return bus;
175 }
176 EXPORT_SYMBOL_GPL(devm_mdiobus_alloc_size);
177
178 /**
179  * devm_mdiobus_free - Resource-managed mdiobus_free()
180  * @dev:                Device this mii_bus belongs to
181  * @bus:                the mii_bus associated with the device
182  *
183  * Free mii_bus allocated with devm_mdiobus_alloc_size().
184  */
185 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus)
186 {
187         int rc;
188
189         rc = devres_release(dev, _devm_mdiobus_free,
190                             devm_mdiobus_match, bus);
191         WARN_ON(rc);
192 }
193 EXPORT_SYMBOL_GPL(devm_mdiobus_free);
194
195 /**
196  * mdiobus_release - mii_bus device release callback
197  * @d: the target struct device that contains the mii_bus
198  *
199  * Description: called when the last reference to an mii_bus is
200  * dropped, to free the underlying memory.
201  */
202 static void mdiobus_release(struct device *d)
203 {
204         struct mii_bus *bus = to_mii_bus(d);
205         BUG_ON(bus->state != MDIOBUS_RELEASED &&
206                /* for compatibility with error handling in drivers */
207                bus->state != MDIOBUS_ALLOCATED);
208         kfree(bus);
209 }
210
211 static struct class mdio_bus_class = {
212         .name           = "mdio_bus",
213         .dev_release    = mdiobus_release,
214 };
215
216 #if IS_ENABLED(CONFIG_OF_MDIO)
217 /* Helper function for of_mdio_find_bus */
218 static int of_mdio_bus_match(struct device *dev, const void *mdio_bus_np)
219 {
220         return dev->of_node == mdio_bus_np;
221 }
222 /**
223  * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
224  * @mdio_bus_np: Pointer to the mii_bus.
225  *
226  * Returns a reference to the mii_bus, or NULL if none found.  The
227  * embedded struct device will have its reference count incremented,
228  * and this must be put once the bus is finished with.
229  *
230  * Because the association of a device_node and mii_bus is made via
231  * of_mdiobus_register(), the mii_bus cannot be found before it is
232  * registered with of_mdiobus_register().
233  *
234  */
235 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
236 {
237         struct device *d;
238
239         if (!mdio_bus_np)
240                 return NULL;
241
242         d = class_find_device(&mdio_bus_class, NULL,  mdio_bus_np,
243                               of_mdio_bus_match);
244
245         return d ? to_mii_bus(d) : NULL;
246 }
247 EXPORT_SYMBOL(of_mdio_find_bus);
248
249 /* Walk the list of subnodes of a mdio bus and look for a node that
250  * matches the mdio device's address with its 'reg' property. If
251  * found, set the of_node pointer for the mdio device. This allows
252  * auto-probed phy devices to be supplied with information passed in
253  * via DT.
254  */
255 static void of_mdiobus_link_mdiodev(struct mii_bus *bus,
256                                     struct mdio_device *mdiodev)
257 {
258         struct device *dev = &mdiodev->dev;
259         struct device_node *child;
260
261         if (dev->of_node || !bus->dev.of_node)
262                 return;
263
264         for_each_available_child_of_node(bus->dev.of_node, child) {
265                 int addr;
266
267                 addr = of_mdio_parse_addr(dev, child);
268                 if (addr < 0)
269                         continue;
270
271                 if (addr == mdiodev->addr) {
272                         dev->of_node = child;
273                         dev->fwnode = of_fwnode_handle(child);
274                         return;
275                 }
276         }
277 }
278 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
279 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
280                                            struct mdio_device *mdiodev)
281 {
282 }
283 #endif
284
285 /**
286  * mdiobus_create_device_from_board_info - create a full MDIO device given
287  * a mdio_board_info structure
288  * @bus: MDIO bus to create the devices on
289  * @bi: mdio_board_info structure describing the devices
290  *
291  * Returns 0 on success or < 0 on error.
292  */
293 static int mdiobus_create_device(struct mii_bus *bus,
294                                  struct mdio_board_info *bi)
295 {
296         struct mdio_device *mdiodev;
297         int ret = 0;
298
299         mdiodev = mdio_device_create(bus, bi->mdio_addr);
300         if (IS_ERR(mdiodev))
301                 return -ENODEV;
302
303         strncpy(mdiodev->modalias, bi->modalias,
304                 sizeof(mdiodev->modalias));
305         mdiodev->bus_match = mdio_device_bus_match;
306         mdiodev->dev.platform_data = (void *)bi->platform_data;
307
308         ret = mdio_device_register(mdiodev);
309         if (ret)
310                 mdio_device_free(mdiodev);
311
312         return ret;
313 }
314
315 /**
316  * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
317  * @bus: target mii_bus
318  * @owner: module containing bus accessor functions
319  *
320  * Description: Called by a bus driver to bring up all the PHYs
321  *   on a given bus, and attach them to the bus. Drivers should use
322  *   mdiobus_register() rather than __mdiobus_register() unless they
323  *   need to pass a specific owner module. MDIO devices which are not
324  *   PHYs will not be brought up by this function. They are expected to
325  *   to be explicitly listed in DT and instantiated by of_mdiobus_register().
326  *
327  * Returns 0 on success or < 0 on error.
328  */
329 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
330 {
331         struct mdio_device *mdiodev;
332         int i, err;
333         struct gpio_desc *gpiod;
334
335         if (NULL == bus || NULL == bus->name ||
336             NULL == bus->read || NULL == bus->write)
337                 return -EINVAL;
338
339         BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
340                bus->state != MDIOBUS_UNREGISTERED);
341
342         bus->owner = owner;
343         bus->dev.parent = bus->parent;
344         bus->dev.class = &mdio_bus_class;
345         bus->dev.groups = NULL;
346         dev_set_name(&bus->dev, "%s", bus->id);
347
348         err = device_register(&bus->dev);
349         if (err) {
350                 pr_err("mii_bus %s failed to register\n", bus->id);
351                 put_device(&bus->dev);
352                 return -EINVAL;
353         }
354
355         mutex_init(&bus->mdio_lock);
356
357         /* de-assert bus level PHY GPIO reset */
358         gpiod = devm_gpiod_get_optional(&bus->dev, "reset", GPIOD_OUT_LOW);
359         if (IS_ERR(gpiod)) {
360                 dev_err(&bus->dev, "mii_bus %s couldn't get reset GPIO\n",
361                         bus->id);
362                 return PTR_ERR(gpiod);
363         } else  if (gpiod) {
364                 bus->reset_gpiod = gpiod;
365
366                 gpiod_set_value_cansleep(gpiod, 1);
367                 udelay(bus->reset_delay_us);
368                 gpiod_set_value_cansleep(gpiod, 0);
369         }
370
371         if (bus->reset)
372                 bus->reset(bus);
373
374         for (i = 0; i < PHY_MAX_ADDR; i++) {
375                 if ((bus->phy_mask & (1 << i)) == 0) {
376                         struct phy_device *phydev;
377
378                         phydev = mdiobus_scan(bus, i);
379                         if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV)) {
380                                 err = PTR_ERR(phydev);
381                                 goto error;
382                         }
383                 }
384         }
385
386         mdiobus_setup_mdiodev_from_board_info(bus, mdiobus_create_device);
387
388         bus->state = MDIOBUS_REGISTERED;
389         pr_info("%s: probed\n", bus->name);
390         return 0;
391
392 error:
393         while (--i >= 0) {
394                 mdiodev = bus->mdio_map[i];
395                 if (!mdiodev)
396                         continue;
397
398                 mdiodev->device_remove(mdiodev);
399                 mdiodev->device_free(mdiodev);
400         }
401
402         /* Put PHYs in RESET to save power */
403         if (bus->reset_gpiod)
404                 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
405
406         device_del(&bus->dev);
407         return err;
408 }
409 EXPORT_SYMBOL(__mdiobus_register);
410
411 void mdiobus_unregister(struct mii_bus *bus)
412 {
413         struct mdio_device *mdiodev;
414         int i;
415
416         BUG_ON(bus->state != MDIOBUS_REGISTERED);
417         bus->state = MDIOBUS_UNREGISTERED;
418
419         for (i = 0; i < PHY_MAX_ADDR; i++) {
420                 mdiodev = bus->mdio_map[i];
421                 if (!mdiodev)
422                         continue;
423
424                 mdiodev->device_remove(mdiodev);
425                 mdiodev->device_free(mdiodev);
426         }
427
428         /* Put PHYs in RESET to save power */
429         if (bus->reset_gpiod)
430                 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
431
432         device_del(&bus->dev);
433 }
434 EXPORT_SYMBOL(mdiobus_unregister);
435
436 /**
437  * mdiobus_free - free a struct mii_bus
438  * @bus: mii_bus to free
439  *
440  * This function releases the reference to the underlying device
441  * object in the mii_bus.  If this is the last reference, the mii_bus
442  * will be freed.
443  */
444 void mdiobus_free(struct mii_bus *bus)
445 {
446         /* For compatibility with error handling in drivers. */
447         if (bus->state == MDIOBUS_ALLOCATED) {
448                 kfree(bus);
449                 return;
450         }
451
452         BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
453         bus->state = MDIOBUS_RELEASED;
454
455         put_device(&bus->dev);
456 }
457 EXPORT_SYMBOL(mdiobus_free);
458
459 /**
460  * mdiobus_scan - scan a bus for MDIO devices.
461  * @bus: mii_bus to scan
462  * @addr: address on bus to scan
463  *
464  * This function scans the MDIO bus, looking for devices which can be
465  * identified using a vendor/product ID in registers 2 and 3. Not all
466  * MDIO devices have such registers, but PHY devices typically
467  * do. Hence this function assumes anything found is a PHY, or can be
468  * treated as a PHY. Other MDIO devices, such as switches, will
469  * probably not be found during the scan.
470  */
471 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
472 {
473         struct phy_device *phydev;
474         int err;
475
476         phydev = get_phy_device(bus, addr, false);
477         if (IS_ERR(phydev))
478                 return phydev;
479
480         /*
481          * For DT, see if the auto-probed phy has a correspoding child
482          * in the bus node, and set the of_node pointer in this case.
483          */
484         of_mdiobus_link_mdiodev(bus, &phydev->mdio);
485
486         err = phy_device_register(phydev);
487         if (err) {
488                 phy_device_free(phydev);
489                 return ERR_PTR(-ENODEV);
490         }
491
492         return phydev;
493 }
494 EXPORT_SYMBOL(mdiobus_scan);
495
496 /**
497  * mdiobus_read_nested - Nested version of the mdiobus_read function
498  * @bus: the mii_bus struct
499  * @addr: the phy address
500  * @regnum: register number to read
501  *
502  * In case of nested MDIO bus access avoid lockdep false positives by
503  * using mutex_lock_nested().
504  *
505  * NOTE: MUST NOT be called from interrupt context,
506  * because the bus read/write functions may wait for an interrupt
507  * to conclude the operation.
508  */
509 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
510 {
511         int retval;
512
513         BUG_ON(in_interrupt());
514
515         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
516         retval = bus->read(bus, addr, regnum);
517         mutex_unlock(&bus->mdio_lock);
518
519         trace_mdio_access(bus, 1, addr, regnum, retval, retval);
520
521         return retval;
522 }
523 EXPORT_SYMBOL(mdiobus_read_nested);
524
525 /**
526  * mdiobus_read - Convenience function for reading a given MII mgmt register
527  * @bus: the mii_bus struct
528  * @addr: the phy address
529  * @regnum: register number to read
530  *
531  * NOTE: MUST NOT be called from interrupt context,
532  * because the bus read/write functions may wait for an interrupt
533  * to conclude the operation.
534  */
535 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
536 {
537         int retval;
538
539         BUG_ON(in_interrupt());
540
541         mutex_lock(&bus->mdio_lock);
542         retval = bus->read(bus, addr, regnum);
543         mutex_unlock(&bus->mdio_lock);
544
545         trace_mdio_access(bus, 1, addr, regnum, retval, retval);
546
547         return retval;
548 }
549 EXPORT_SYMBOL(mdiobus_read);
550
551 /**
552  * mdiobus_write_nested - Nested version of the mdiobus_write function
553  * @bus: the mii_bus struct
554  * @addr: the phy address
555  * @regnum: register number to write
556  * @val: value to write to @regnum
557  *
558  * In case of nested MDIO bus access avoid lockdep false positives by
559  * using mutex_lock_nested().
560  *
561  * NOTE: MUST NOT be called from interrupt context,
562  * because the bus read/write functions may wait for an interrupt
563  * to conclude the operation.
564  */
565 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
566 {
567         int err;
568
569         BUG_ON(in_interrupt());
570
571         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
572         err = bus->write(bus, addr, regnum, val);
573         mutex_unlock(&bus->mdio_lock);
574
575         trace_mdio_access(bus, 0, addr, regnum, val, err);
576
577         return err;
578 }
579 EXPORT_SYMBOL(mdiobus_write_nested);
580
581 /**
582  * mdiobus_write - Convenience function for writing a given MII mgmt register
583  * @bus: the mii_bus struct
584  * @addr: the phy address
585  * @regnum: register number to write
586  * @val: value to write to @regnum
587  *
588  * NOTE: MUST NOT be called from interrupt context,
589  * because the bus read/write functions may wait for an interrupt
590  * to conclude the operation.
591  */
592 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
593 {
594         int err;
595
596         BUG_ON(in_interrupt());
597
598         mutex_lock(&bus->mdio_lock);
599         err = bus->write(bus, addr, regnum, val);
600         mutex_unlock(&bus->mdio_lock);
601
602         trace_mdio_access(bus, 0, addr, regnum, val, err);
603
604         return err;
605 }
606 EXPORT_SYMBOL(mdiobus_write);
607
608 /**
609  * mdio_bus_match - determine if given MDIO driver supports the given
610  *                  MDIO device
611  * @dev: target MDIO device
612  * @drv: given MDIO driver
613  *
614  * Description: Given a MDIO device, and a MDIO driver, return 1 if
615  *   the driver supports the device.  Otherwise, return 0. This may
616  *   require calling the devices own match function, since different classes
617  *   of MDIO devices have different match criteria.
618  */
619 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
620 {
621         struct mdio_device *mdio = to_mdio_device(dev);
622
623         if (of_driver_match_device(dev, drv))
624                 return 1;
625
626         if (mdio->bus_match)
627                 return mdio->bus_match(dev, drv);
628
629         return 0;
630 }
631
632 static int mdio_uevent(struct device *dev, struct kobj_uevent_env *env)
633 {
634         int rc;
635
636         /* Some devices have extra OF data and an OF-style MODALIAS */
637         rc = of_device_uevent_modalias(dev, env);
638         if (rc != -ENODEV)
639                 return rc;
640
641         return 0;
642 }
643
644 #ifdef CONFIG_PM
645 static int mdio_bus_suspend(struct device *dev)
646 {
647         struct mdio_device *mdio = to_mdio_device(dev);
648
649         if (mdio->pm_ops && mdio->pm_ops->suspend)
650                 return mdio->pm_ops->suspend(dev);
651
652         return 0;
653 }
654
655 static int mdio_bus_resume(struct device *dev)
656 {
657         struct mdio_device *mdio = to_mdio_device(dev);
658
659         if (mdio->pm_ops && mdio->pm_ops->resume)
660                 return mdio->pm_ops->resume(dev);
661
662         return 0;
663 }
664
665 static int mdio_bus_restore(struct device *dev)
666 {
667         struct mdio_device *mdio = to_mdio_device(dev);
668
669         if (mdio->pm_ops && mdio->pm_ops->restore)
670                 return mdio->pm_ops->restore(dev);
671
672         return 0;
673 }
674
675 static const struct dev_pm_ops mdio_bus_pm_ops = {
676         .suspend = mdio_bus_suspend,
677         .resume = mdio_bus_resume,
678         .freeze = mdio_bus_suspend,
679         .thaw = mdio_bus_resume,
680         .restore = mdio_bus_restore,
681 };
682
683 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
684
685 #else
686
687 #define MDIO_BUS_PM_OPS NULL
688
689 #endif /* CONFIG_PM */
690
691 struct bus_type mdio_bus_type = {
692         .name           = "mdio_bus",
693         .match          = mdio_bus_match,
694         .uevent         = mdio_uevent,
695         .pm             = MDIO_BUS_PM_OPS,
696 };
697 EXPORT_SYMBOL(mdio_bus_type);
698
699 int __init mdio_bus_init(void)
700 {
701         int ret;
702
703         ret = class_register(&mdio_bus_class);
704         if (!ret) {
705                 ret = bus_register(&mdio_bus_type);
706                 if (ret)
707                         class_unregister(&mdio_bus_class);
708         }
709
710         return ret;
711 }
712 EXPORT_SYMBOL_GPL(mdio_bus_init);
713
714 #if IS_ENABLED(CONFIG_PHYLIB)
715 void mdio_bus_exit(void)
716 {
717         class_unregister(&mdio_bus_class);
718         bus_unregister(&mdio_bus_type);
719 }
720 EXPORT_SYMBOL_GPL(mdio_bus_exit);
721 #else
722 module_init(mdio_bus_init);
723 /* no module_exit, intentional */
724 MODULE_LICENSE("GPL");
725 MODULE_DESCRIPTION("MDIO bus/device layer");
726 #endif