GNU Linux-libre 4.14.259-gnu1
[releases.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                         return;
274                 }
275         }
276 }
277 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
278 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
279                                            struct mdio_device *mdiodev)
280 {
281 }
282 #endif
283
284 /**
285  * mdiobus_create_device_from_board_info - create a full MDIO device given
286  * a mdio_board_info structure
287  * @bus: MDIO bus to create the devices on
288  * @bi: mdio_board_info structure describing the devices
289  *
290  * Returns 0 on success or < 0 on error.
291  */
292 static int mdiobus_create_device(struct mii_bus *bus,
293                                  struct mdio_board_info *bi)
294 {
295         struct mdio_device *mdiodev;
296         int ret = 0;
297
298         mdiodev = mdio_device_create(bus, bi->mdio_addr);
299         if (IS_ERR(mdiodev))
300                 return -ENODEV;
301
302         strncpy(mdiodev->modalias, bi->modalias,
303                 sizeof(mdiodev->modalias));
304         mdiodev->bus_match = mdio_device_bus_match;
305         mdiodev->dev.platform_data = (void *)bi->platform_data;
306
307         ret = mdio_device_register(mdiodev);
308         if (ret)
309                 mdio_device_free(mdiodev);
310
311         return ret;
312 }
313
314 /**
315  * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
316  * @bus: target mii_bus
317  * @owner: module containing bus accessor functions
318  *
319  * Description: Called by a bus driver to bring up all the PHYs
320  *   on a given bus, and attach them to the bus. Drivers should use
321  *   mdiobus_register() rather than __mdiobus_register() unless they
322  *   need to pass a specific owner module. MDIO devices which are not
323  *   PHYs will not be brought up by this function. They are expected to
324  *   to be explicitly listed in DT and instantiated by of_mdiobus_register().
325  *
326  * Returns 0 on success or < 0 on error.
327  */
328 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
329 {
330         struct mdio_device *mdiodev;
331         int i, err;
332         struct gpio_desc *gpiod;
333
334         if (NULL == bus || NULL == bus->name ||
335             NULL == bus->read || NULL == bus->write)
336                 return -EINVAL;
337
338         BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
339                bus->state != MDIOBUS_UNREGISTERED);
340
341         bus->owner = owner;
342         bus->dev.parent = bus->parent;
343         bus->dev.class = &mdio_bus_class;
344         bus->dev.groups = NULL;
345         dev_set_name(&bus->dev, "%s", bus->id);
346
347         /* We need to set state to MDIOBUS_UNREGISTERED to correctly release
348          * the device in mdiobus_free()
349          *
350          * State will be updated later in this function in case of success
351          */
352         bus->state = MDIOBUS_UNREGISTERED;
353
354         err = device_register(&bus->dev);
355         if (err) {
356                 pr_err("mii_bus %s failed to register\n", bus->id);
357                 return -EINVAL;
358         }
359
360         mutex_init(&bus->mdio_lock);
361
362         /* de-assert bus level PHY GPIO reset */
363         gpiod = devm_gpiod_get_optional(&bus->dev, "reset", GPIOD_OUT_LOW);
364         if (IS_ERR(gpiod)) {
365                 dev_err(&bus->dev, "mii_bus %s couldn't get reset GPIO\n",
366                         bus->id);
367                 device_del(&bus->dev);
368                 return PTR_ERR(gpiod);
369         } else  if (gpiod) {
370                 bus->reset_gpiod = gpiod;
371
372                 gpiod_set_value_cansleep(gpiod, 1);
373                 udelay(bus->reset_delay_us);
374                 gpiod_set_value_cansleep(gpiod, 0);
375         }
376
377         if (bus->reset)
378                 bus->reset(bus);
379
380         for (i = 0; i < PHY_MAX_ADDR; i++) {
381                 if ((bus->phy_mask & (1 << i)) == 0) {
382                         struct phy_device *phydev;
383
384                         phydev = mdiobus_scan(bus, i);
385                         if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV)) {
386                                 err = PTR_ERR(phydev);
387                                 goto error;
388                         }
389                 }
390         }
391
392         mdiobus_setup_mdiodev_from_board_info(bus, mdiobus_create_device);
393
394         bus->state = MDIOBUS_REGISTERED;
395         pr_info("%s: probed\n", bus->name);
396         return 0;
397
398 error:
399         while (--i >= 0) {
400                 mdiodev = bus->mdio_map[i];
401                 if (!mdiodev)
402                         continue;
403
404                 mdiodev->device_remove(mdiodev);
405                 mdiodev->device_free(mdiodev);
406         }
407
408         /* Put PHYs in RESET to save power */
409         if (bus->reset_gpiod)
410                 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
411
412         device_del(&bus->dev);
413         return err;
414 }
415 EXPORT_SYMBOL(__mdiobus_register);
416
417 void mdiobus_unregister(struct mii_bus *bus)
418 {
419         struct mdio_device *mdiodev;
420         int i;
421
422         if (WARN_ON_ONCE(bus->state != MDIOBUS_REGISTERED))
423                 return;
424         bus->state = MDIOBUS_UNREGISTERED;
425
426         for (i = 0; i < PHY_MAX_ADDR; i++) {
427                 mdiodev = bus->mdio_map[i];
428                 if (!mdiodev)
429                         continue;
430
431                 mdiodev->device_remove(mdiodev);
432                 mdiodev->device_free(mdiodev);
433         }
434
435         /* Put PHYs in RESET to save power */
436         if (bus->reset_gpiod)
437                 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
438
439         device_del(&bus->dev);
440 }
441 EXPORT_SYMBOL(mdiobus_unregister);
442
443 /**
444  * mdiobus_free - free a struct mii_bus
445  * @bus: mii_bus to free
446  *
447  * This function releases the reference to the underlying device
448  * object in the mii_bus.  If this is the last reference, the mii_bus
449  * will be freed.
450  */
451 void mdiobus_free(struct mii_bus *bus)
452 {
453         /* For compatibility with error handling in drivers. */
454         if (bus->state == MDIOBUS_ALLOCATED) {
455                 kfree(bus);
456                 return;
457         }
458
459         BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
460         bus->state = MDIOBUS_RELEASED;
461
462         put_device(&bus->dev);
463 }
464 EXPORT_SYMBOL(mdiobus_free);
465
466 /**
467  * mdiobus_scan - scan a bus for MDIO devices.
468  * @bus: mii_bus to scan
469  * @addr: address on bus to scan
470  *
471  * This function scans the MDIO bus, looking for devices which can be
472  * identified using a vendor/product ID in registers 2 and 3. Not all
473  * MDIO devices have such registers, but PHY devices typically
474  * do. Hence this function assumes anything found is a PHY, or can be
475  * treated as a PHY. Other MDIO devices, such as switches, will
476  * probably not be found during the scan.
477  */
478 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
479 {
480         struct phy_device *phydev;
481         int err;
482
483         phydev = get_phy_device(bus, addr, false);
484         if (IS_ERR(phydev))
485                 return phydev;
486
487         /*
488          * For DT, see if the auto-probed phy has a correspoding child
489          * in the bus node, and set the of_node pointer in this case.
490          */
491         of_mdiobus_link_mdiodev(bus, &phydev->mdio);
492
493         err = phy_device_register(phydev);
494         if (err) {
495                 phy_device_free(phydev);
496                 return ERR_PTR(-ENODEV);
497         }
498
499         return phydev;
500 }
501 EXPORT_SYMBOL(mdiobus_scan);
502
503 /**
504  * mdiobus_read_nested - Nested version of the mdiobus_read function
505  * @bus: the mii_bus struct
506  * @addr: the phy address
507  * @regnum: register number to read
508  *
509  * In case of nested MDIO bus access avoid lockdep false positives by
510  * using mutex_lock_nested().
511  *
512  * NOTE: MUST NOT be called from interrupt context,
513  * because the bus read/write functions may wait for an interrupt
514  * to conclude the operation.
515  */
516 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
517 {
518         int retval;
519
520         BUG_ON(in_interrupt());
521
522         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
523         retval = bus->read(bus, addr, regnum);
524         mutex_unlock(&bus->mdio_lock);
525
526         trace_mdio_access(bus, 1, addr, regnum, retval, retval);
527
528         return retval;
529 }
530 EXPORT_SYMBOL(mdiobus_read_nested);
531
532 /**
533  * mdiobus_read - Convenience function for reading a given MII mgmt register
534  * @bus: the mii_bus struct
535  * @addr: the phy address
536  * @regnum: register number to read
537  *
538  * NOTE: MUST NOT be called from interrupt context,
539  * because the bus read/write functions may wait for an interrupt
540  * to conclude the operation.
541  */
542 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
543 {
544         int retval;
545
546         BUG_ON(in_interrupt());
547
548         mutex_lock(&bus->mdio_lock);
549         retval = bus->read(bus, addr, regnum);
550         mutex_unlock(&bus->mdio_lock);
551
552         trace_mdio_access(bus, 1, addr, regnum, retval, retval);
553
554         return retval;
555 }
556 EXPORT_SYMBOL(mdiobus_read);
557
558 /**
559  * mdiobus_write_nested - Nested version of the mdiobus_write function
560  * @bus: the mii_bus struct
561  * @addr: the phy address
562  * @regnum: register number to write
563  * @val: value to write to @regnum
564  *
565  * In case of nested MDIO bus access avoid lockdep false positives by
566  * using mutex_lock_nested().
567  *
568  * NOTE: MUST NOT be called from interrupt context,
569  * because the bus read/write functions may wait for an interrupt
570  * to conclude the operation.
571  */
572 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
573 {
574         int err;
575
576         BUG_ON(in_interrupt());
577
578         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
579         err = bus->write(bus, addr, regnum, val);
580         mutex_unlock(&bus->mdio_lock);
581
582         trace_mdio_access(bus, 0, addr, regnum, val, err);
583
584         return err;
585 }
586 EXPORT_SYMBOL(mdiobus_write_nested);
587
588 /**
589  * mdiobus_write - Convenience function for writing a given MII mgmt register
590  * @bus: the mii_bus struct
591  * @addr: the phy address
592  * @regnum: register number to write
593  * @val: value to write to @regnum
594  *
595  * NOTE: MUST NOT be called from interrupt context,
596  * because the bus read/write functions may wait for an interrupt
597  * to conclude the operation.
598  */
599 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
600 {
601         int err;
602
603         BUG_ON(in_interrupt());
604
605         mutex_lock(&bus->mdio_lock);
606         err = bus->write(bus, addr, regnum, val);
607         mutex_unlock(&bus->mdio_lock);
608
609         trace_mdio_access(bus, 0, addr, regnum, val, err);
610
611         return err;
612 }
613 EXPORT_SYMBOL(mdiobus_write);
614
615 /**
616  * mdio_bus_match - determine if given MDIO driver supports the given
617  *                  MDIO device
618  * @dev: target MDIO device
619  * @drv: given MDIO driver
620  *
621  * Description: Given a MDIO device, and a MDIO driver, return 1 if
622  *   the driver supports the device.  Otherwise, return 0. This may
623  *   require calling the devices own match function, since different classes
624  *   of MDIO devices have different match criteria.
625  */
626 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
627 {
628         struct mdio_device *mdio = to_mdio_device(dev);
629
630         if (of_driver_match_device(dev, drv))
631                 return 1;
632
633         if (mdio->bus_match)
634                 return mdio->bus_match(dev, drv);
635
636         return 0;
637 }
638
639 static int mdio_uevent(struct device *dev, struct kobj_uevent_env *env)
640 {
641         int rc;
642
643         /* Some devices have extra OF data and an OF-style MODALIAS */
644         rc = of_device_uevent_modalias(dev, env);
645         if (rc != -ENODEV)
646                 return rc;
647
648         return 0;
649 }
650
651 #ifdef CONFIG_PM
652 static int mdio_bus_suspend(struct device *dev)
653 {
654         struct mdio_device *mdio = to_mdio_device(dev);
655
656         if (mdio->pm_ops && mdio->pm_ops->suspend)
657                 return mdio->pm_ops->suspend(dev);
658
659         return 0;
660 }
661
662 static int mdio_bus_resume(struct device *dev)
663 {
664         struct mdio_device *mdio = to_mdio_device(dev);
665
666         if (mdio->pm_ops && mdio->pm_ops->resume)
667                 return mdio->pm_ops->resume(dev);
668
669         return 0;
670 }
671
672 static int mdio_bus_restore(struct device *dev)
673 {
674         struct mdio_device *mdio = to_mdio_device(dev);
675
676         if (mdio->pm_ops && mdio->pm_ops->restore)
677                 return mdio->pm_ops->restore(dev);
678
679         return 0;
680 }
681
682 static const struct dev_pm_ops mdio_bus_pm_ops = {
683         .suspend = mdio_bus_suspend,
684         .resume = mdio_bus_resume,
685         .freeze = mdio_bus_suspend,
686         .thaw = mdio_bus_resume,
687         .restore = mdio_bus_restore,
688 };
689
690 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
691
692 #else
693
694 #define MDIO_BUS_PM_OPS NULL
695
696 #endif /* CONFIG_PM */
697
698 struct bus_type mdio_bus_type = {
699         .name           = "mdio_bus",
700         .match          = mdio_bus_match,
701         .uevent         = mdio_uevent,
702         .pm             = MDIO_BUS_PM_OPS,
703 };
704 EXPORT_SYMBOL(mdio_bus_type);
705
706 int __init mdio_bus_init(void)
707 {
708         int ret;
709
710         ret = class_register(&mdio_bus_class);
711         if (!ret) {
712                 ret = bus_register(&mdio_bus_type);
713                 if (ret)
714                         class_unregister(&mdio_bus_class);
715         }
716
717         return ret;
718 }
719 EXPORT_SYMBOL_GPL(mdio_bus_init);
720
721 #if IS_ENABLED(CONFIG_PHYLIB)
722 void mdio_bus_exit(void)
723 {
724         class_unregister(&mdio_bus_class);
725         bus_unregister(&mdio_bus_type);
726 }
727 EXPORT_SYMBOL_GPL(mdio_bus_exit);
728 #else
729 module_init(mdio_bus_init);
730 /* no module_exit, intentional */
731 MODULE_LICENSE("GPL");
732 MODULE_DESCRIPTION("MDIO bus/device layer");
733 #endif