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                 return NULL;
 107
 108         bus->state = MDIOBUS_ALLOCATED;
 109         if (size)
 110                 bus->priv = (void *)bus + aligned_size;
 111
 112         /* Initialise the interrupts to polling */
 113         for (i = 0; i < PHY_MAX_ADDR; i++)
 114                 bus->irq[i] = PHY_POLL;
 115
 116         return bus;
 117 }
 118 EXPORT_SYMBOL(mdiobus_alloc_size);
 119
 120 static void _devm_mdiobus_free(struct device *dev, void *res)
 121 {
 122         mdiobus_free(*(struct mii_bus **)res);
 123 }
 124
 125 static int devm_mdiobus_match(struct device *dev, void *res, void *data)
 126 {
 127         struct mii_bus **r = res;
 128
 129         if (WARN_ON(!r || !*r))
 130                 return 0;
 131
 132         return *r == data;
 133 }
 134
 135 /**
 136  * devm_mdiobus_alloc_size - Resource-managed mdiobus_alloc_size()
 137  * @dev:                Device to allocate mii_bus for
 138  * @sizeof_priv:        Space to allocate for private structure.
 139  *
 140  * Managed mdiobus_alloc_size. mii_bus allocated with this function is
 141  * automatically freed on driver detach.
 142  *
 143  * If an mii_bus allocated with this function needs to be freed separately,
 144  * devm_mdiobus_free() must be used.
 145  *
 146  * RETURNS:
 147  * Pointer to allocated mii_bus on success, NULL on failure.
 148  */
 149 struct mii_bus *devm_mdiobus_alloc_size(struct device *dev, int sizeof_priv)
 150 {
 151         struct mii_bus **ptr, *bus;
 152
 153         ptr = devres_alloc(_devm_mdiobus_free, sizeof(*ptr), GFP_KERNEL);
 154         if (!ptr)
 155                 return NULL;
 156
 157         /* use raw alloc_dr for kmalloc caller tracing */
 158         bus = mdiobus_alloc_size(sizeof_priv);
 159         if (bus) {
 160                 *ptr = bus;
 161                 devres_add(dev, ptr);
 162         } else {
 163                 devres_free(ptr);
 164         }
 165
 166         return bus;
 167 }
 168 EXPORT_SYMBOL_GPL(devm_mdiobus_alloc_size);
 169
 170 /**
 171  * devm_mdiobus_free - Resource-managed mdiobus_free()
 172  * @dev:                Device this mii_bus belongs to
 173  * @bus:                the mii_bus associated with the device
 174  *
 175  * Free mii_bus allocated with devm_mdiobus_alloc_size().
 176  */
 177 void devm_mdiobus_free(struct device *dev, struct mii_bus *bus)
 178 {
 179         int rc;
 180
 181         rc = devres_release(dev, _devm_mdiobus_free,
 182                             devm_mdiobus_match, bus);
 183         WARN_ON(rc);
 184 }
 185 EXPORT_SYMBOL_GPL(devm_mdiobus_free);
 186
 187 /**
 188  * mdiobus_release - mii_bus device release callback
 189  * @d: the target struct device that contains the mii_bus
 190  *
 191  * Description: called when the last reference to an mii_bus is
 192  * dropped, to free the underlying memory.
 193  */
 194 static void mdiobus_release(struct device *d)
 195 {
 196         struct mii_bus *bus = to_mii_bus(d);
 197         BUG_ON(bus->state != MDIOBUS_RELEASED &&
 198                /* for compatibility with error handling in drivers */
 199                bus->state != MDIOBUS_ALLOCATED);
 200         kfree(bus);
 201 }
 202
 203 static struct class mdio_bus_class = {
 204         .name           = "mdio_bus",
 205         .dev_release    = mdiobus_release,
 206 };
 207
 208 #if IS_ENABLED(CONFIG_OF_MDIO)
 209 /* Helper function for of_mdio_find_bus */
 210 static int of_mdio_bus_match(struct device *dev, const void *mdio_bus_np)
 211 {
 212         return dev->of_node == mdio_bus_np;
 213 }
 214 /**
 215  * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
 216  * @mdio_bus_np: Pointer to the mii_bus.
 217  *
 218  * Returns a reference to the mii_bus, or NULL if none found.  The
 219  * embedded struct device will have its reference count incremented,
 220  * and this must be put once the bus is finished with.
 221  *
 222  * Because the association of a device_node and mii_bus is made via
 223  * of_mdiobus_register(), the mii_bus cannot be found before it is
 224  * registered with of_mdiobus_register().
 225  *
 226  */
 227 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
 228 {
 229         struct device *d;
 230
 231         if (!mdio_bus_np)
 232                 return NULL;
 233
 234         d = class_find_device(&mdio_bus_class, NULL,  mdio_bus_np,
 235                               of_mdio_bus_match);
 236
 237         return d ? to_mii_bus(d) : NULL;
 238 }
 239 EXPORT_SYMBOL(of_mdio_find_bus);
 240
 241 /* Walk the list of subnodes of a mdio bus and look for a node that
 242  * matches the mdio device's address with its 'reg' property. If
 243  * found, set the of_node pointer for the mdio device. This allows
 244  * auto-probed phy devices to be supplied with information passed in
 245  * via DT.
 246  */
 247 static void of_mdiobus_link_mdiodev(struct mii_bus *bus,
 248                                     struct mdio_device *mdiodev)
 249 {
 250         struct device *dev = &mdiodev->dev;
 251         struct device_node *child;
 252
 253         if (dev->of_node || !bus->dev.of_node)
 254                 return;
 255
 256         for_each_available_child_of_node(bus->dev.of_node, child) {
 257                 int addr;
 258                 int ret;
 259
 260                 ret = of_property_read_u32(child, "reg", &addr);
 261                 if (ret < 0) {
 262                         dev_err(dev, "%s has invalid MDIO address\n",
 263                                 child->full_name);
 264                         continue;
 265                 }
 266
 267                 /* A MDIO device must have a reg property in the range [0-31] */
 268                 if (addr >= PHY_MAX_ADDR) {
 269                         dev_err(dev, "%s MDIO address %i is too large\n",
 270                                 child->full_name, addr);
 271                         continue;
 272                 }
 273
 274                 if (addr == mdiodev->addr) {
 275                         dev->of_node = child;
 276                         return;
 277                 }
 278         }
 279 }
 280 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
 281 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
 282                                            struct mdio_device *mdiodev)
 283 {
 284 }
 285 #endif
 286
 287 /**
 288  * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
 289  * @bus: target mii_bus
 290  * @owner: module containing bus accessor functions
 291  *
 292  * Description: Called by a bus driver to bring up all the PHYs
 293  *   on a given bus, and attach them to the bus. Drivers should use
 294  *   mdiobus_register() rather than __mdiobus_register() unless they
 295  *   need to pass a specific owner module. MDIO devices which are not
 296  *   PHYs will not be brought up by this function. They are expected to
 297  *   to be explicitly listed in DT and instantiated by of_mdiobus_register().
 298  *
 299  * Returns 0 on success or < 0 on error.
 300  */
 301 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
 302 {
 303         struct mdio_device *mdiodev;
 304         int i, err;
 305
 306         if (NULL == bus || NULL == bus->name ||
 307             NULL == bus->read || NULL == bus->write)
 308                 return -EINVAL;
 309
 310         BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
 311                bus->state != MDIOBUS_UNREGISTERED);
 312
 313         bus->owner = owner;
 314         bus->dev.parent = bus->parent;
 315         bus->dev.class = &mdio_bus_class;
 316         bus->dev.groups = NULL;
 317         dev_set_name(&bus->dev, "%s", bus->id);
 318
 319         /* We need to set state to MDIOBUS_UNREGISTERED to correctly release
 320          * the device in mdiobus_free()
 321          *
 322          * State will be updated later in this function in case of success
 323          */
 324         bus->state = MDIOBUS_UNREGISTERED;
 325
 326         err = device_register(&bus->dev);
 327         if (err) {
 328                 pr_err("mii_bus %s failed to register\n", bus->id);
 329                 return -EINVAL;
 330         }
 331
 332         mutex_init(&bus->mdio_lock);
 333
 334         if (bus->reset)
 335                 bus->reset(bus);
 336
 337         for (i = 0; i < PHY_MAX_ADDR; i++) {
 338                 if ((bus->phy_mask & (1 << i)) == 0) {
 339                         struct phy_device *phydev;
 340
 341                         phydev = mdiobus_scan(bus, i);
 342                         if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV)) {
 343                                 err = PTR_ERR(phydev);
 344                                 goto error;
 345                         }
 346                 }
 347         }
 348
 349         bus->state = MDIOBUS_REGISTERED;
 350         pr_info("%s: probed\n", bus->name);
 351         return 0;
 352
 353 error:
 354         while (--i >= 0) {
 355                 mdiodev = bus->mdio_map[i];
 356                 if (!mdiodev)
 357                         continue;
 358
 359                 mdiodev->device_remove(mdiodev);
 360                 mdiodev->device_free(mdiodev);
 361         }
 362         device_del(&bus->dev);
 363         return err;
 364 }
 365 EXPORT_SYMBOL(__mdiobus_register);
 366
 367 void mdiobus_unregister(struct mii_bus *bus)
 368 {
 369         struct mdio_device *mdiodev;
 370         int i;
 371
 372         if (WARN_ON_ONCE(bus->state != MDIOBUS_REGISTERED))
 373                 return;
 374         bus->state = MDIOBUS_UNREGISTERED;
 375
 376         for (i = 0; i < PHY_MAX_ADDR; i++) {
 377                 mdiodev = bus->mdio_map[i];
 378                 if (!mdiodev)
 379                         continue;
 380
 381                 mdiodev->device_remove(mdiodev);
 382                 mdiodev->device_free(mdiodev);
 383         }
 384         device_del(&bus->dev);
 385 }
 386 EXPORT_SYMBOL(mdiobus_unregister);
 387
 388 /**
 389  * mdiobus_free - free a struct mii_bus
 390  * @bus: mii_bus to free
 391  *
 392  * This function releases the reference to the underlying device
 393  * object in the mii_bus.  If this is the last reference, the mii_bus
 394  * will be freed.
 395  */
 396 void mdiobus_free(struct mii_bus *bus)
 397 {
 398         /* For compatibility with error handling in drivers. */
 399         if (bus->state == MDIOBUS_ALLOCATED) {
 400                 kfree(bus);
 401                 return;
 402         }
 403
 404         BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
 405         bus->state = MDIOBUS_RELEASED;
 406
 407         put_device(&bus->dev);
 408 }
 409 EXPORT_SYMBOL(mdiobus_free);
 410
 411 /**
 412  * mdiobus_scan - scan a bus for MDIO devices.
 413  * @bus: mii_bus to scan
 414  * @addr: address on bus to scan
 415  *
 416  * This function scans the MDIO bus, looking for devices which can be
 417  * identified using a vendor/product ID in registers 2 and 3. Not all
 418  * MDIO devices have such registers, but PHY devices typically
 419  * do. Hence this function assumes anything found is a PHY, or can be
 420  * treated as a PHY. Other MDIO devices, such as switches, will
 421  * probably not be found during the scan.
 422  */
 423 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
 424 {
 425         struct phy_device *phydev;
 426         int err;
 427
 428         phydev = get_phy_device(bus, addr, false);
 429         if (IS_ERR(phydev))
 430                 return phydev;
 431
 432         /*
 433          * For DT, see if the auto-probed phy has a correspoding child
 434          * in the bus node, and set the of_node pointer in this case.
 435          */
 436         of_mdiobus_link_mdiodev(bus, &phydev->mdio);
 437
 438         err = phy_device_register(phydev);
 439         if (err) {
 440                 phy_device_free(phydev);
 441                 return ERR_PTR(-ENODEV);
 442         }
 443
 444         return phydev;
 445 }
 446 EXPORT_SYMBOL(mdiobus_scan);
 447
 448 /**
 449  * mdiobus_read_nested - Nested version of the mdiobus_read function
 450  * @bus: the mii_bus struct
 451  * @addr: the phy address
 452  * @regnum: register number to read
 453  *
 454  * In case of nested MDIO bus access avoid lockdep false positives by
 455  * using mutex_lock_nested().
 456  *
 457  * NOTE: MUST NOT be called from interrupt context,
 458  * because the bus read/write functions may wait for an interrupt
 459  * to conclude the operation.
 460  */
 461 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
 462 {
 463         int retval;
 464
 465         BUG_ON(in_interrupt());
 466
 467         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
 468         retval = bus->read(bus, addr, regnum);
 469         mutex_unlock(&bus->mdio_lock);
 470
 471         return retval;
 472 }
 473 EXPORT_SYMBOL(mdiobus_read_nested);
 474
 475 /**
 476  * mdiobus_read - Convenience function for reading a given MII mgmt register
 477  * @bus: the mii_bus struct
 478  * @addr: the phy address
 479  * @regnum: register number to read
 480  *
 481  * NOTE: MUST NOT be called from interrupt context,
 482  * because the bus read/write functions may wait for an interrupt
 483  * to conclude the operation.
 484  */
 485 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
 486 {
 487         int retval;
 488
 489         BUG_ON(in_interrupt());
 490
 491         mutex_lock(&bus->mdio_lock);
 492         retval = bus->read(bus, addr, regnum);
 493         mutex_unlock(&bus->mdio_lock);
 494
 495         return retval;
 496 }
 497 EXPORT_SYMBOL(mdiobus_read);
 498
 499 /**
 500  * mdiobus_write_nested - Nested version of the mdiobus_write function
 501  * @bus: the mii_bus struct
 502  * @addr: the phy address
 503  * @regnum: register number to write
 504  * @val: value to write to @regnum
 505  *
 506  * In case of nested MDIO bus access avoid lockdep false positives by
 507  * using mutex_lock_nested().
 508  *
 509  * NOTE: MUST NOT be called from interrupt context,
 510  * because the bus read/write functions may wait for an interrupt
 511  * to conclude the operation.
 512  */
 513 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 514 {
 515         int err;
 516
 517         BUG_ON(in_interrupt());
 518
 519         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
 520         err = bus->write(bus, addr, regnum, val);
 521         mutex_unlock(&bus->mdio_lock);
 522
 523         return err;
 524 }
 525 EXPORT_SYMBOL(mdiobus_write_nested);
 526
 527 /**
 528  * mdiobus_write - Convenience function for writing a given MII mgmt register
 529  * @bus: the mii_bus struct
 530  * @addr: the phy address
 531  * @regnum: register number to write
 532  * @val: value to write to @regnum
 533  *
 534  * NOTE: MUST NOT be called from interrupt context,
 535  * because the bus read/write functions may wait for an interrupt
 536  * to conclude the operation.
 537  */
 538 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 539 {
 540         int err;
 541
 542         BUG_ON(in_interrupt());
 543
 544         mutex_lock(&bus->mdio_lock);
 545         err = bus->write(bus, addr, regnum, val);
 546         mutex_unlock(&bus->mdio_lock);
 547
 548         return err;
 549 }
 550 EXPORT_SYMBOL(mdiobus_write);
 551
 552 /**
 553  * mdio_bus_match - determine if given MDIO driver supports the given
 554  *                  MDIO device
 555  * @dev: target MDIO device
 556  * @drv: given MDIO driver
 557  *
 558  * Description: Given a MDIO device, and a MDIO driver, return 1 if
 559  *   the driver supports the device.  Otherwise, return 0. This may
 560  *   require calling the devices own match function, since different classes
 561  *   of MDIO devices have different match criteria.
 562  */
 563 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
 564 {
 565         struct mdio_device *mdio = to_mdio_device(dev);
 566
 567         if (of_driver_match_device(dev, drv))
 568                 return 1;
 569
 570         if (mdio->bus_match)
 571                 return mdio->bus_match(dev, drv);
 572
 573         return 0;
 574 }
 575
 576 #ifdef CONFIG_PM
 577 static int mdio_bus_suspend(struct device *dev)
 578 {
 579         struct mdio_device *mdio = to_mdio_device(dev);
 580
 581         if (mdio->pm_ops && mdio->pm_ops->suspend)
 582                 return mdio->pm_ops->suspend(dev);
 583
 584         return 0;
 585 }
 586
 587 static int mdio_bus_resume(struct device *dev)
 588 {
 589         struct mdio_device *mdio = to_mdio_device(dev);
 590
 591         if (mdio->pm_ops && mdio->pm_ops->resume)
 592                 return mdio->pm_ops->resume(dev);
 593
 594         return 0;
 595 }
 596
 597 static int mdio_bus_restore(struct device *dev)
 598 {
 599         struct mdio_device *mdio = to_mdio_device(dev);
 600
 601         if (mdio->pm_ops && mdio->pm_ops->restore)
 602                 return mdio->pm_ops->restore(dev);
 603
 604         return 0;
 605 }
 606
 607 static const struct dev_pm_ops mdio_bus_pm_ops = {
 608         .suspend = mdio_bus_suspend,
 609         .resume = mdio_bus_resume,
 610         .freeze = mdio_bus_suspend,
 611         .thaw = mdio_bus_resume,
 612         .restore = mdio_bus_restore,
 613 };
 614
 615 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
 616
 617 #else
 618
 619 #define MDIO_BUS_PM_OPS NULL
 620
 621 #endif /* CONFIG_PM */
 622
 623 struct bus_type mdio_bus_type = {
 624         .name           = "mdio_bus",
 625         .match          = mdio_bus_match,
 626         .pm             = MDIO_BUS_PM_OPS,
 627 };
 628 EXPORT_SYMBOL(mdio_bus_type);
 629
 630 int __init mdio_bus_init(void)
 631 {
 632         int ret;
 633
 634         ret = class_register(&mdio_bus_class);
 635         if (!ret) {
 636                 ret = bus_register(&mdio_bus_type);
 637                 if (ret)
 638                         class_unregister(&mdio_bus_class);
 639         }
 640
 641         return ret;
 642 }
 643
 644 void mdio_bus_exit(void)
 645 {
 646         class_unregister(&mdio_bus_class);
 647         bus_unregister(&mdio_bus_type);
 648 }