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/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>
  31 #include <linux/mm.h>
  32 #include <linux/module.h>
  33 #include <linux/mii.h>
  34 #include <linux/ethtool.h>
  35 #include <linux/phy.h>
  36 #include <linux/io.h>
  37 #include <linux/uaccess.h>
  38
  39 #include <asm/irq.h>
  40
  41 int mdiobus_register_device(struct mdio_device *mdiodev)
  42 {
  43         if (mdiodev->bus->mdio_map[mdiodev->addr])
  44                 return -EBUSY;
  45
  46         mdiodev->bus->mdio_map[mdiodev->addr] = mdiodev;
  47
  48         return 0;
  49 }
  50 EXPORT_SYMBOL(mdiobus_register_device);
  51
  52 int mdiobus_unregister_device(struct mdio_device *mdiodev)
  53 {
  54         if (mdiodev->bus->mdio_map[mdiodev->addr] != mdiodev)
  55                 return -EINVAL;
  56
  57         mdiodev->bus->mdio_map[mdiodev->addr] = NULL;
  58
  59         return 0;
  60 }
  61 EXPORT_SYMBOL(mdiobus_unregister_device);
  62
  63 struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr)
  64 {
  65         struct mdio_device *mdiodev = bus->mdio_map[addr];
  66
  67         if (!mdiodev)
  68                 return NULL;
  69
  70         if (!(mdiodev->flags & MDIO_DEVICE_FLAG_PHY))
  71                 return NULL;
  72
  73         return container_of(mdiodev, struct phy_device, mdio);
  74 }
  75 EXPORT_SYMBOL(mdiobus_get_phy);
  76
  77 bool mdiobus_is_registered_device(struct mii_bus *bus, int addr)
  78 {
  79         return bus->mdio_map[addr];
  80 }
  81 EXPORT_SYMBOL(mdiobus_is_registered_device);
  82
  83 /**
  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.
  87  *
  88  * Description: called by a bus driver to allocate an mii_bus
  89  * structure to fill in.
  90  */
  91 struct mii_bus *mdiobus_alloc_size(size_t size)
  92 {
  93         struct mii_bus *bus;
  94         size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
  95         size_t alloc_size;
  96         int i;
  97
  98         /* If we alloc extra space, it should be aligned */
  99         if (size)
 100                 alloc_size = aligned_size + size;
 101         else
 102                 alloc_size = sizeof(*bus);
 103
 104         bus = kzalloc(alloc_size, GFP_KERNEL);
 105         if (bus) {
 106                 bus->state = MDIOBUS_ALLOCATED;
 107                 if (size)
 108                         bus->priv = (void *)bus + aligned_size;
 109         }
 110
 111         /* Initialise the interrupts to polling */
 112         for (i = 0; i < PHY_MAX_ADDR; i++)
 113                 bus->irq[i] = PHY_POLL;
 114
 115         return bus;
 116 }
 117 EXPORT_SYMBOL(mdiobus_alloc_size);
 118
 119 static void _devm_mdiobus_free(struct device *dev, void *res)
 120 {
 121         mdiobus_free(*(struct mii_bus **)res);
 122 }
 123
 124 static int devm_mdiobus_match(struct device *dev, void *res, void *data)
 125 {
 126         struct mii_bus **r = res;
 127
 128         if (WARN_ON(!r || !*r))
 129                 return 0;
 130
 131         return *r == data;
 132 }
 133
 134 /**
 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.
 138  *
 139  * Managed mdiobus_alloc_size. mii_bus allocated with this function is
 140  * automatically freed on driver detach.
 141  *
 142  * If an mii_bus allocated with this function needs to be freed separately,
 143  * devm_mdiobus_free() must be used.
 144  *
 145  * RETURNS:
 146  * Pointer to allocated mii_bus on success, NULL on failure.
 147  */
 148 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv)
 149 {
 150         struct mii_bus **ptr, *bus;
 151
 152         ptr = devres_alloc(_devm_mdiobus_free, sizeof(*ptr), GFP_KERNEL);
 153         if (!ptr)
 154                 return NULL;
 155
 156         /* use raw alloc_dr for kmalloc caller tracing */
 157         bus = mdiobus_alloc_size(sizeof_priv);
 158         if (bus) {
 159                 *ptr = bus;
 160                 devres_add(dev, ptr);
 161         } else {
 162                 devres_free(ptr);
 163         }
 164
 165         return bus;
 166 }
 167 EXPORT_SYMBOL_GPL(devm_mdiobus_alloc_size);
 168
 169 /**
 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
 173  *
 174  * Free mii_bus allocated with devm_mdiobus_alloc_size().
 175  */
 176 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus)
 177 {
 178         int rc;
 179
 180         rc = devres_release(dev, _devm_mdiobus_free,
 181                             devm_mdiobus_match, bus);
 182         WARN_ON(rc);
 183 }
 184 EXPORT_SYMBOL_GPL(devm_mdiobus_free);
 185
 186 /**
 187  * mdiobus_release - mii_bus device release callback
 188  * @d: the target struct device that contains the mii_bus
 189  *
 190  * Description: called when the last reference to an mii_bus is
 191  * dropped, to free the underlying memory.
 192  */
 193 static void mdiobus_release(struct device *d)
 194 {
 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);
 199         kfree(bus);
 200 }
 201
 202 static struct class mdio_bus_class = {
 203         .name           = "mdio_bus",
 204         .dev_release    = mdiobus_release,
 205 };
 206
 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)
 210 {
 211         return dev->of_node == mdio_bus_np;
 212 }
 213 /**
 214  * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
 215  * @mdio_bus_np: Pointer to the mii_bus.
 216  *
 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.
 220  *
 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().
 224  *
 225  */
 226 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
 227 {
 228         struct device *d;
 229
 230         if (!mdio_bus_np)
 231                 return NULL;
 232
 233         d = class_find_device(&mdio_bus_class, NULL,  mdio_bus_np,
 234                               of_mdio_bus_match);
 235
 236         return d ? to_mii_bus(d) : NULL;
 237 }
 238 EXPORT_SYMBOL(of_mdio_find_bus);
 239
 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
 244  * via DT.
 245  */
 246 static void of_mdiobus_link_mdiodev(struct mii_bus *bus,
 247                                     struct mdio_device *mdiodev)
 248 {
 249         struct device *dev = &mdiodev->dev;
 250         struct device_node *child;
 251
 252         if (dev->of_node || !bus->dev.of_node)
 253                 return;
 254
 255         for_each_available_child_of_node(bus->dev.of_node, child) {
 256                 int addr;
 257                 int ret;
 258
 259                 ret = of_property_read_u32(child, "reg", &addr);
 260                 if (ret < 0) {
 261                         dev_err(dev, "%s has invalid MDIO address\n",
 262                                 child->full_name);
 263                         continue;
 264                 }
 265
 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);
 270                         continue;
 271                 }
 272
 273                 if (addr == mdiodev->addr) {
 274                         dev->of_node = child;
 275                         return;
 276                 }
 277         }
 278 }
 279 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
 280 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
 281                                            struct mdio_device *mdiodev)
 282 {
 283 }
 284 #endif
 285
 286 /**
 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
 290  *
 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().
 297  *
 298  * Returns 0 on success or < 0 on error.
 299  */
 300 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
 301 {
 302         int i, err;
 303
 304         if (NULL == bus || NULL == bus->name ||
 305             NULL == bus->read || NULL == bus->write)
 306                 return -EINVAL;
 307
 308         BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
 309                bus->state != MDIOBUS_UNREGISTERED);
 310
 311         bus->owner = owner;
 312         bus->dev.parent = bus->parent;
 313         bus->dev.class = &mdio_bus_class;
 314         bus->dev.groups = NULL;
 315         dev_set_name(&bus->dev, "%s", bus->id);
 316
 317         err = device_register(&bus->dev);
 318         if (err) {
 319                 pr_err("mii_bus %s failed to register\n", bus->id);
 320                 put_device(&bus->dev);
 321                 return -EINVAL;
 322         }
 323
 324         mutex_init(&bus->mdio_lock);
 325
 326         if (bus->reset)
 327                 bus->reset(bus);
 328
 329         for (i = 0; i < PHY_MAX_ADDR; i++) {
 330                 if ((bus->phy_mask & (1 << i)) == 0) {
 331                         struct phy_device *phydev;
 332
 333                         phydev = mdiobus_scan(bus, i);
 334                         if (IS_ERR(phydev)) {
 335                                 err = PTR_ERR(phydev);
 336                                 goto error;
 337                         }
 338                 }
 339         }
 340
 341         bus->state = MDIOBUS_REGISTERED;
 342         pr_info("%s: probed\n", bus->name);
 343         return 0;
 344
 345 error:
 346         while (--i >= 0) {
 347                 struct phy_device *phydev = mdiobus_get_phy(bus, i);
 348                 if (phydev) {
 349                         phy_device_remove(phydev);
 350                         phy_device_free(phydev);
 351                 }
 352         }
 353         device_del(&bus->dev);
 354         return err;
 355 }
 356 EXPORT_SYMBOL(__mdiobus_register);
 357
 358 void mdiobus_unregister(struct mii_bus *bus)
 359 {
 360         int i;
 361
 362         BUG_ON(bus->state != MDIOBUS_REGISTERED);
 363         bus->state = MDIOBUS_UNREGISTERED;
 364
 365         for (i = 0; i < PHY_MAX_ADDR; i++) {
 366                 struct phy_device *phydev = mdiobus_get_phy(bus, i);
 367                 if (phydev) {
 368                         phy_device_remove(phydev);
 369                         phy_device_free(phydev);
 370                 }
 371         }
 372         device_del(&bus->dev);
 373 }
 374 EXPORT_SYMBOL(mdiobus_unregister);
 375
 376 /**
 377  * mdiobus_free - free a struct mii_bus
 378  * @bus: mii_bus to free
 379  *
 380  * This function releases the reference to the underlying device
 381  * object in the mii_bus.  If this is the last reference, the mii_bus
 382  * will be freed.
 383  */
 384 void mdiobus_free(struct mii_bus *bus)
 385 {
 386         /* For compatibility with error handling in drivers. */
 387         if (bus->state == MDIOBUS_ALLOCATED) {
 388                 kfree(bus);
 389                 return;
 390         }
 391
 392         BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
 393         bus->state = MDIOBUS_RELEASED;
 394
 395         put_device(&bus->dev);
 396 }
 397 EXPORT_SYMBOL(mdiobus_free);
 398
 399 /**
 400  * mdiobus_scan - scan a bus for MDIO devices.
 401  * @bus: mii_bus to scan
 402  * @addr: address on bus to scan
 403  *
 404  * This function scans the MDIO bus, looking for devices which can be
 405  * identified using a vendor/product ID in registers 2 and 3. Not all
 406  * MDIO devices have such registers, but PHY devices typically
 407  * do. Hence this function assumes anything found is a PHY, or can be
 408  * treated as a PHY. Other MDIO devices, such as switches, will
 409  * probably not be found during the scan.
 410  */
 411 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
 412 {
 413         struct phy_device *phydev;
 414         int err;
 415
 416         phydev = get_phy_device(bus, addr, false);
 417         if (IS_ERR(phydev) || phydev == NULL)
 418                 return phydev;
 419
 420         /*
 421          * For DT, see if the auto-probed phy has a correspoding child
 422          * in the bus node, and set the of_node pointer in this case.
 423          */
 424         of_mdiobus_link_mdiodev(bus, &phydev->mdio);
 425
 426         err = phy_device_register(phydev);
 427         if (err) {
 428                 phy_device_free(phydev);
 429                 return NULL;
 430         }
 431
 432         return phydev;
 433 }
 434 EXPORT_SYMBOL(mdiobus_scan);
 435
 436 /**
 437  * mdiobus_read_nested - Nested version of the mdiobus_read function
 438  * @bus: the mii_bus struct
 439  * @addr: the phy address
 440  * @regnum: register number to read
 441  *
 442  * In case of nested MDIO bus access avoid lockdep false positives by
 443  * using mutex_lock_nested().
 444  *
 445  * NOTE: MUST NOT be called from interrupt context,
 446  * because the bus read/write functions may wait for an interrupt
 447  * to conclude the operation.
 448  */
 449 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
 450 {
 451         int retval;
 452
 453         BUG_ON(in_interrupt());
 454
 455         mutex_lock_nested(&bus->mdio_lock, SINGLE_DEPTH_NESTING);
 456         retval = bus->read(bus, addr, regnum);
 457         mutex_unlock(&bus->mdio_lock);
 458
 459         return retval;
 460 }
 461 EXPORT_SYMBOL(mdiobus_read_nested);
 462
 463 /**
 464  * mdiobus_read - Convenience function for reading a given MII mgmt register
 465  * @bus: the mii_bus struct
 466  * @addr: the phy address
 467  * @regnum: register number to read
 468  *
 469  * NOTE: MUST NOT be called from interrupt context,
 470  * because the bus read/write functions may wait for an interrupt
 471  * to conclude the operation.
 472  */
 473 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
 474 {
 475         int retval;
 476
 477         BUG_ON(in_interrupt());
 478
 479         mutex_lock(&bus->mdio_lock);
 480         retval = bus->read(bus, addr, regnum);
 481         mutex_unlock(&bus->mdio_lock);
 482
 483         return retval;
 484 }
 485 EXPORT_SYMBOL(mdiobus_read);
 486
 487 /**
 488  * mdiobus_write_nested - Nested version of the mdiobus_write function
 489  * @bus: the mii_bus struct
 490  * @addr: the phy address
 491  * @regnum: register number to write
 492  * @val: value to write to @regnum
 493  *
 494  * In case of nested MDIO bus access avoid lockdep false positives by
 495  * using mutex_lock_nested().
 496  *
 497  * NOTE: MUST NOT be called from interrupt context,
 498  * because the bus read/write functions may wait for an interrupt
 499  * to conclude the operation.
 500  */
 501 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 502 {
 503         int err;
 504
 505         BUG_ON(in_interrupt());
 506
 507         mutex_lock_nested(&bus->mdio_lock, SINGLE_DEPTH_NESTING);
 508         err = bus->write(bus, addr, regnum, val);
 509         mutex_unlock(&bus->mdio_lock);
 510
 511         return err;
 512 }
 513 EXPORT_SYMBOL(mdiobus_write_nested);
 514
 515 /**
 516  * mdiobus_write - Convenience function for writing a given MII mgmt register
 517  * @bus: the mii_bus struct
 518  * @addr: the phy address
 519  * @regnum: register number to write
 520  * @val: value to write to @regnum
 521  *
 522  * NOTE: MUST NOT be called from interrupt context,
 523  * because the bus read/write functions may wait for an interrupt
 524  * to conclude the operation.
 525  */
 526 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 527 {
 528         int err;
 529
 530         BUG_ON(in_interrupt());
 531
 532         mutex_lock(&bus->mdio_lock);
 533         err = bus->write(bus, addr, regnum, val);
 534         mutex_unlock(&bus->mdio_lock);
 535
 536         return err;
 537 }
 538 EXPORT_SYMBOL(mdiobus_write);
 539
 540 /**
 541  * mdio_bus_match - determine if given MDIO driver supports the given
 542  *                  MDIO device
 543  * @dev: target MDIO device
 544  * @drv: given MDIO driver
 545  *
 546  * Description: Given a MDIO device, and a MDIO driver, return 1 if
 547  *   the driver supports the device.  Otherwise, return 0. This may
 548  *   require calling the devices own match function, since different classes
 549  *   of MDIO devices have different match criteria.
 550  */
 551 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
 552 {
 553         struct mdio_device *mdio = to_mdio_device(dev);
 554
 555         if (of_driver_match_device(dev, drv))
 556                 return 1;
 557
 558         if (mdio->bus_match)
 559                 return mdio->bus_match(dev, drv);
 560
 561         return 0;
 562 }
 563
 564 #ifdef CONFIG_PM
 565 static int mdio_bus_suspend(struct device *dev)
 566 {
 567         struct mdio_device *mdio = to_mdio_device(dev);
 568
 569         if (mdio->pm_ops && mdio->pm_ops->suspend)
 570                 return mdio->pm_ops->suspend(dev);
 571
 572         return 0;
 573 }
 574
 575 static int mdio_bus_resume(struct device *dev)
 576 {
 577         struct mdio_device *mdio = to_mdio_device(dev);
 578
 579         if (mdio->pm_ops && mdio->pm_ops->resume)
 580                 return mdio->pm_ops->resume(dev);
 581
 582         return 0;
 583 }
 584
 585 static int mdio_bus_restore(struct device *dev)
 586 {
 587         struct mdio_device *mdio = to_mdio_device(dev);
 588
 589         if (mdio->pm_ops && mdio->pm_ops->restore)
 590                 return mdio->pm_ops->restore(dev);
 591
 592         return 0;
 593 }
 594
 595 static const struct dev_pm_ops mdio_bus_pm_ops = {
 596         .suspend = mdio_bus_suspend,
 597         .resume = mdio_bus_resume,
 598         .freeze = mdio_bus_suspend,
 599         .thaw = mdio_bus_resume,
 600         .restore = mdio_bus_restore,
 601 };
 602
 603 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
 604
 605 #else
 606
 607 #define MDIO_BUS_PM_OPS NULL
 608
 609 #endif /* CONFIG_PM */
 610
 611 struct bus_type mdio_bus_type = {
 612         .name           = "mdio_bus",
 613         .match          = mdio_bus_match,
 614         .pm             = MDIO_BUS_PM_OPS,
 615 };
 616 EXPORT_SYMBOL(mdio_bus_type);
 617
 618 int __init mdio_bus_init(void)
 619 {
 620         int ret;
 621
 622         ret = class_register(&mdio_bus_class);
 623         if (!ret) {
 624                 ret = bus_register(&mdio_bus_type);
 625                 if (ret)
 626                         class_unregister(&mdio_bus_class);
 627         }
 628
 629         return ret;
 630 }
 631
 632 void mdio_bus_exit(void)
 633 {
 634         class_unregister(&mdio_bus_class);
 635         bus_unregister(&mdio_bus_type);
 636 }