drivers/net/phy/mdio_bus.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /* MDIO Bus interface
   3  *
   4  * Author: Andy Fleming
   5  *
   6  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   7  */
   8
   9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  10
  11 #include <linux/delay.h>
  12 #include <linux/device.h>
  13 #include <linux/errno.h>
  14 #include <linux/etherdevice.h>
  15 #include <linux/ethtool.h>
  16 #include <linux/gpio.h>
  17 #include <linux/gpio/consumer.h>
  18 #include <linux/init.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/io.h>
  21 #include <linux/kernel.h>
  22 #include <linux/mii.h>
  23 #include <linux/mm.h>
  24 #include <linux/module.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/of_device.h>
  27 #include <linux/of_gpio.h>
  28 #include <linux/of_mdio.h>
  29 #include <linux/phy.h>
  30 #include <linux/reset.h>
  31 #include <linux/skbuff.h>
  32 #include <linux/slab.h>
  33 #include <linux/spinlock.h>
  34 #include <linux/string.h>
  35 #include <linux/uaccess.h>
  36 #include <linux/unistd.h>
  37
  38 #define CREATE_TRACE_POINTS
  39 #include <trace/events/mdio.h>
  40
  41 #include "mdio-boardinfo.h"
  42
  43 static int mdiobus_register_gpiod(struct mdio_device *mdiodev)
  44 {
  45         /* Deassert the optional reset signal */
  46         mdiodev->reset_gpio = gpiod_get_optional(&mdiodev->dev,
  47                                                  "reset", GPIOD_OUT_LOW);
  48         if (IS_ERR(mdiodev->reset_gpio))
  49                 return PTR_ERR(mdiodev->reset_gpio);
  50
  51         if (mdiodev->reset_gpio)
  52                 gpiod_set_consumer_name(mdiodev->reset_gpio, "PHY reset");
  53
  54         return 0;
  55 }
  56
  57 static int mdiobus_register_reset(struct mdio_device *mdiodev)
  58 {
  59         struct reset_control *reset;
  60
  61         reset = reset_control_get_optional_exclusive(&mdiodev->dev, "phy");
  62         if (IS_ERR(reset))
  63                 return PTR_ERR(reset);
  64
  65         mdiodev->reset_ctrl = reset;
  66
  67         return 0;
  68 }
  69
  70 int mdiobus_register_device(struct mdio_device *mdiodev)
  71 {
  72         int err;
  73
  74         if (mdiodev->bus->mdio_map[mdiodev->addr])
  75                 return -EBUSY;
  76
  77         if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY) {
  78                 err = mdiobus_register_gpiod(mdiodev);
  79                 if (err)
  80                         return err;
  81
  82                 err = mdiobus_register_reset(mdiodev);
  83                 if (err)
  84                         return err;
  85
  86                 /* Assert the reset signal */
  87                 mdio_device_reset(mdiodev, 1);
  88         }
  89
  90         mdiodev->bus->mdio_map[mdiodev->addr] = mdiodev;
  91
  92         return 0;
  93 }
  94 EXPORT_SYMBOL(mdiobus_register_device);
  95
  96 int mdiobus_unregister_device(struct mdio_device *mdiodev)
  97 {
  98         if (mdiodev->bus->mdio_map[mdiodev->addr] != mdiodev)
  99                 return -EINVAL;
 100
 101         reset_control_put(mdiodev->reset_ctrl);
 102
 103         mdiodev->bus->mdio_map[mdiodev->addr] = NULL;
 104
 105         return 0;
 106 }
 107 EXPORT_SYMBOL(mdiobus_unregister_device);
 108
 109 struct phy_device *mdiobus_get_phy(struct mii_bus *bus, int addr)
 110 {
 111         struct mdio_device *mdiodev = bus->mdio_map[addr];
 112
 113         if (!mdiodev)
 114                 return NULL;
 115
 116         if (!(mdiodev->flags & MDIO_DEVICE_FLAG_PHY))
 117                 return NULL;
 118
 119         return container_of(mdiodev, struct phy_device, mdio);
 120 }
 121 EXPORT_SYMBOL(mdiobus_get_phy);
 122
 123 bool mdiobus_is_registered_device(struct mii_bus *bus, int addr)
 124 {
 125         return bus->mdio_map[addr];
 126 }
 127 EXPORT_SYMBOL(mdiobus_is_registered_device);
 128
 129 /**
 130  * mdiobus_alloc_size - allocate a mii_bus structure
 131  * @size: extra amount of memory to allocate for private storage.
 132  * If non-zero, then bus->priv is points to that memory.
 133  *
 134  * Description: called by a bus driver to allocate an mii_bus
 135  * structure to fill in.
 136  */
 137 struct mii_bus *mdiobus_alloc_size(size_t size)
 138 {
 139         struct mii_bus *bus;
 140         size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
 141         size_t alloc_size;
 142         int i;
 143
 144         /* If we alloc extra space, it should be aligned */
 145         if (size)
 146                 alloc_size = aligned_size + size;
 147         else
 148                 alloc_size = sizeof(*bus);
 149
 150         bus = kzalloc(alloc_size, GFP_KERNEL);
 151         if (!bus)
 152                 return NULL;
 153
 154         bus->state = MDIOBUS_ALLOCATED;
 155         if (size)
 156                 bus->priv = (void *)bus + aligned_size;
 157
 158         /* Initialise the interrupts to polling and 64-bit seqcounts */
 159         for (i = 0; i < PHY_MAX_ADDR; i++) {
 160                 bus->irq[i] = PHY_POLL;
 161                 u64_stats_init(&bus->stats[i].syncp);
 162         }
 163
 164         return bus;
 165 }
 166 EXPORT_SYMBOL(mdiobus_alloc_size);
 167
 168 /**
 169  * mdiobus_release - mii_bus device release callback
 170  * @d: the target struct device that contains the mii_bus
 171  *
 172  * Description: called when the last reference to an mii_bus is
 173  * dropped, to free the underlying memory.
 174  */
 175 static void mdiobus_release(struct device *d)
 176 {
 177         struct mii_bus *bus = to_mii_bus(d);
 178         BUG_ON(bus->state != MDIOBUS_RELEASED &&
 179                /* for compatibility with error handling in drivers */
 180                bus->state != MDIOBUS_ALLOCATED);
 181         kfree(bus);
 182 }
 183
 184 struct mdio_bus_stat_attr {
 185         int addr;
 186         unsigned int field_offset;
 187 };
 188
 189 static u64 mdio_bus_get_stat(struct mdio_bus_stats *s, unsigned int offset)
 190 {
 191         const char *p = (const char *)s + offset;
 192         unsigned int start;
 193         u64 val = 0;
 194
 195         do {
 196                 start = u64_stats_fetch_begin(&s->syncp);
 197                 val = u64_stats_read((const u64_stats_t *)p);
 198         } while (u64_stats_fetch_retry(&s->syncp, start));
 199
 200         return val;
 201 }
 202
 203 static u64 mdio_bus_get_global_stat(struct mii_bus *bus, unsigned int offset)
 204 {
 205         unsigned int i;
 206         u64 val = 0;
 207
 208         for (i = 0; i < PHY_MAX_ADDR; i++)
 209                 val += mdio_bus_get_stat(&bus->stats[i], offset);
 210
 211         return val;
 212 }
 213
 214 static ssize_t mdio_bus_stat_field_show(struct device *dev,
 215                                         struct device_attribute *attr,
 216                                         char *buf)
 217 {
 218         struct mii_bus *bus = to_mii_bus(dev);
 219         struct mdio_bus_stat_attr *sattr;
 220         struct dev_ext_attribute *eattr;
 221         u64 val;
 222
 223         eattr = container_of(attr, struct dev_ext_attribute, attr);
 224         sattr = eattr->var;
 225
 226         if (sattr->addr < 0)
 227                 val = mdio_bus_get_global_stat(bus, sattr->field_offset);
 228         else
 229                 val = mdio_bus_get_stat(&bus->stats[sattr->addr],
 230                                         sattr->field_offset);
 231
 232         return sprintf(buf, "%llu\n", val);
 233 }
 234
 235 static ssize_t mdio_bus_device_stat_field_show(struct device *dev,
 236                                                struct device_attribute *attr,
 237                                                char *buf)
 238 {
 239         struct mdio_device *mdiodev = to_mdio_device(dev);
 240         struct mii_bus *bus = mdiodev->bus;
 241         struct mdio_bus_stat_attr *sattr;
 242         struct dev_ext_attribute *eattr;
 243         int addr = mdiodev->addr;
 244         u64 val;
 245
 246         eattr = container_of(attr, struct dev_ext_attribute, attr);
 247         sattr = eattr->var;
 248
 249         val = mdio_bus_get_stat(&bus->stats[addr], sattr->field_offset);
 250
 251         return sprintf(buf, "%llu\n", val);
 252 }
 253
 254 #define MDIO_BUS_STATS_ATTR_DECL(field, file)                           \
 255 static struct dev_ext_attribute dev_attr_mdio_bus_##field = {           \
 256         .attr = { .attr = { .name = file, .mode = 0444 },               \
 257                      .show = mdio_bus_stat_field_show,                  \
 258         },                                                              \
 259         .var = &((struct mdio_bus_stat_attr) {                          \
 260                 -1, offsetof(struct mdio_bus_stats, field)              \
 261         }),                                                             \
 262 };                                                                      \
 263 static struct dev_ext_attribute dev_attr_mdio_bus_device_##field = {    \
 264         .attr = { .attr = { .name = file, .mode = 0444 },               \
 265                      .show = mdio_bus_device_stat_field_show,           \
 266         },                                                              \
 267         .var = &((struct mdio_bus_stat_attr) {                          \
 268                 -1, offsetof(struct mdio_bus_stats, field)              \
 269         }),                                                             \
 270 };
 271
 272 #define MDIO_BUS_STATS_ATTR(field)                                      \
 273         MDIO_BUS_STATS_ATTR_DECL(field, __stringify(field))
 274
 275 MDIO_BUS_STATS_ATTR(transfers);
 276 MDIO_BUS_STATS_ATTR(errors);
 277 MDIO_BUS_STATS_ATTR(writes);
 278 MDIO_BUS_STATS_ATTR(reads);
 279
 280 #define MDIO_BUS_STATS_ADDR_ATTR_DECL(field, addr, file)                \
 281 static struct dev_ext_attribute dev_attr_mdio_bus_addr_##field##_##addr = { \
 282         .attr = { .attr = { .name = file, .mode = 0444 },               \
 283                      .show = mdio_bus_stat_field_show,                  \
 284         },                                                              \
 285         .var = &((struct mdio_bus_stat_attr) {                          \
 286                 addr, offsetof(struct mdio_bus_stats, field)            \
 287         }),                                                             \
 288 }
 289
 290 #define MDIO_BUS_STATS_ADDR_ATTR(field, addr)                           \
 291         MDIO_BUS_STATS_ADDR_ATTR_DECL(field, addr,                      \
 292                                  __stringify(field) "_" __stringify(addr))
 293
 294 #define MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(addr)                       \
 295         MDIO_BUS_STATS_ADDR_ATTR(transfers, addr);                      \
 296         MDIO_BUS_STATS_ADDR_ATTR(errors, addr);                         \
 297         MDIO_BUS_STATS_ADDR_ATTR(writes, addr);                         \
 298         MDIO_BUS_STATS_ADDR_ATTR(reads, addr)                           \
 299
 300 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(0);
 301 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(1);
 302 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(2);
 303 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(3);
 304 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(4);
 305 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(5);
 306 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(6);
 307 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(7);
 308 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(8);
 309 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(9);
 310 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(10);
 311 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(11);
 312 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(12);
 313 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(13);
 314 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(14);
 315 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(15);
 316 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(16);
 317 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(17);
 318 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(18);
 319 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(19);
 320 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(20);
 321 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(21);
 322 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(22);
 323 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(23);
 324 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(24);
 325 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(25);
 326 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(26);
 327 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(27);
 328 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(28);
 329 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(29);
 330 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(30);
 331 MDIO_BUS_STATS_ADDR_ATTR_GROUP_DECL(31);
 332
 333 #define MDIO_BUS_STATS_ADDR_ATTR_GROUP(addr)                            \
 334         &dev_attr_mdio_bus_addr_transfers_##addr.attr.attr,             \
 335         &dev_attr_mdio_bus_addr_errors_##addr.attr.attr,                \
 336         &dev_attr_mdio_bus_addr_writes_##addr.attr.attr,                \
 337         &dev_attr_mdio_bus_addr_reads_##addr.attr.attr                  \
 338
 339 static struct attribute *mdio_bus_statistics_attrs[] = {
 340         &dev_attr_mdio_bus_transfers.attr.attr,
 341         &dev_attr_mdio_bus_errors.attr.attr,
 342         &dev_attr_mdio_bus_writes.attr.attr,
 343         &dev_attr_mdio_bus_reads.attr.attr,
 344         MDIO_BUS_STATS_ADDR_ATTR_GROUP(0),
 345         MDIO_BUS_STATS_ADDR_ATTR_GROUP(1),
 346         MDIO_BUS_STATS_ADDR_ATTR_GROUP(2),
 347         MDIO_BUS_STATS_ADDR_ATTR_GROUP(3),
 348         MDIO_BUS_STATS_ADDR_ATTR_GROUP(4),
 349         MDIO_BUS_STATS_ADDR_ATTR_GROUP(5),
 350         MDIO_BUS_STATS_ADDR_ATTR_GROUP(6),
 351         MDIO_BUS_STATS_ADDR_ATTR_GROUP(7),
 352         MDIO_BUS_STATS_ADDR_ATTR_GROUP(8),
 353         MDIO_BUS_STATS_ADDR_ATTR_GROUP(9),
 354         MDIO_BUS_STATS_ADDR_ATTR_GROUP(10),
 355         MDIO_BUS_STATS_ADDR_ATTR_GROUP(11),
 356         MDIO_BUS_STATS_ADDR_ATTR_GROUP(12),
 357         MDIO_BUS_STATS_ADDR_ATTR_GROUP(13),
 358         MDIO_BUS_STATS_ADDR_ATTR_GROUP(14),
 359         MDIO_BUS_STATS_ADDR_ATTR_GROUP(15),
 360         MDIO_BUS_STATS_ADDR_ATTR_GROUP(16),
 361         MDIO_BUS_STATS_ADDR_ATTR_GROUP(17),
 362         MDIO_BUS_STATS_ADDR_ATTR_GROUP(18),
 363         MDIO_BUS_STATS_ADDR_ATTR_GROUP(19),
 364         MDIO_BUS_STATS_ADDR_ATTR_GROUP(20),
 365         MDIO_BUS_STATS_ADDR_ATTR_GROUP(21),
 366         MDIO_BUS_STATS_ADDR_ATTR_GROUP(22),
 367         MDIO_BUS_STATS_ADDR_ATTR_GROUP(23),
 368         MDIO_BUS_STATS_ADDR_ATTR_GROUP(24),
 369         MDIO_BUS_STATS_ADDR_ATTR_GROUP(25),
 370         MDIO_BUS_STATS_ADDR_ATTR_GROUP(26),
 371         MDIO_BUS_STATS_ADDR_ATTR_GROUP(27),
 372         MDIO_BUS_STATS_ADDR_ATTR_GROUP(28),
 373         MDIO_BUS_STATS_ADDR_ATTR_GROUP(29),
 374         MDIO_BUS_STATS_ADDR_ATTR_GROUP(30),
 375         MDIO_BUS_STATS_ADDR_ATTR_GROUP(31),
 376         NULL,
 377 };
 378
 379 static const struct attribute_group mdio_bus_statistics_group = {
 380         .name   = "statistics",
 381         .attrs  = mdio_bus_statistics_attrs,
 382 };
 383
 384 static const struct attribute_group *mdio_bus_groups[] = {
 385         &mdio_bus_statistics_group,
 386         NULL,
 387 };
 388
 389 static struct class mdio_bus_class = {
 390         .name           = "mdio_bus",
 391         .dev_release    = mdiobus_release,
 392         .dev_groups     = mdio_bus_groups,
 393 };
 394
 395 /**
 396  * mdio_find_bus - Given the name of a mdiobus, find the mii_bus.
 397  * @mdio_name: The name of a mdiobus.
 398  *
 399  * Returns a reference to the mii_bus, or NULL if none found.  The
 400  * embedded struct device will have its reference count incremented,
 401  * and this must be put_deviced'ed once the bus is finished with.
 402  */
 403 struct mii_bus *mdio_find_bus(const char *mdio_name)
 404 {
 405         struct device *d;
 406
 407         d = class_find_device_by_name(&mdio_bus_class, mdio_name);
 408         return d ? to_mii_bus(d) : NULL;
 409 }
 410 EXPORT_SYMBOL(mdio_find_bus);
 411
 412 #if IS_ENABLED(CONFIG_OF_MDIO)
 413 /**
 414  * of_mdio_find_bus - Given an mii_bus node, find the mii_bus.
 415  * @mdio_bus_np: Pointer to the mii_bus.
 416  *
 417  * Returns a reference to the mii_bus, or NULL if none found.  The
 418  * embedded struct device will have its reference count incremented,
 419  * and this must be put once the bus is finished with.
 420  *
 421  * Because the association of a device_node and mii_bus is made via
 422  * of_mdiobus_register(), the mii_bus cannot be found before it is
 423  * registered with of_mdiobus_register().
 424  *
 425  */
 426 struct mii_bus *of_mdio_find_bus(struct device_node *mdio_bus_np)
 427 {
 428         struct device *d;
 429
 430         if (!mdio_bus_np)
 431                 return NULL;
 432
 433         d = class_find_device_by_of_node(&mdio_bus_class, mdio_bus_np);
 434         return d ? to_mii_bus(d) : NULL;
 435 }
 436 EXPORT_SYMBOL(of_mdio_find_bus);
 437
 438 /* Walk the list of subnodes of a mdio bus and look for a node that
 439  * matches the mdio device's address with its 'reg' property. If
 440  * found, set the of_node pointer for the mdio device. This allows
 441  * auto-probed phy devices to be supplied with information passed in
 442  * via DT.
 443  */
 444 static void of_mdiobus_link_mdiodev(struct mii_bus *bus,
 445                                     struct mdio_device *mdiodev)
 446 {
 447         struct device *dev = &mdiodev->dev;
 448         struct device_node *child;
 449
 450         if (dev->of_node || !bus->dev.of_node)
 451                 return;
 452
 453         for_each_available_child_of_node(bus->dev.of_node, child) {
 454                 int addr;
 455
 456                 addr = of_mdio_parse_addr(dev, child);
 457                 if (addr < 0)
 458                         continue;
 459
 460                 if (addr == mdiodev->addr) {
 461                         dev->of_node = child;
 462                         dev->fwnode = of_fwnode_handle(child);
 463                         return;
 464                 }
 465         }
 466 }
 467 #else /* !IS_ENABLED(CONFIG_OF_MDIO) */
 468 static inline void of_mdiobus_link_mdiodev(struct mii_bus *mdio,
 469                                            struct mdio_device *mdiodev)
 470 {
 471 }
 472 #endif
 473
 474 /**
 475  * mdiobus_create_device_from_board_info - create a full MDIO device given
 476  * a mdio_board_info structure
 477  * @bus: MDIO bus to create the devices on
 478  * @bi: mdio_board_info structure describing the devices
 479  *
 480  * Returns 0 on success or < 0 on error.
 481  */
 482 static int mdiobus_create_device(struct mii_bus *bus,
 483                                  struct mdio_board_info *bi)
 484 {
 485         struct mdio_device *mdiodev;
 486         int ret = 0;
 487
 488         mdiodev = mdio_device_create(bus, bi->mdio_addr);
 489         if (IS_ERR(mdiodev))
 490                 return -ENODEV;
 491
 492         strncpy(mdiodev->modalias, bi->modalias,
 493                 sizeof(mdiodev->modalias));
 494         mdiodev->bus_match = mdio_device_bus_match;
 495         mdiodev->dev.platform_data = (void *)bi->platform_data;
 496
 497         ret = mdio_device_register(mdiodev);
 498         if (ret)
 499                 mdio_device_free(mdiodev);
 500
 501         return ret;
 502 }
 503
 504 /**
 505  * __mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
 506  * @bus: target mii_bus
 507  * @owner: module containing bus accessor functions
 508  *
 509  * Description: Called by a bus driver to bring up all the PHYs
 510  *   on a given bus, and attach them to the bus. Drivers should use
 511  *   mdiobus_register() rather than __mdiobus_register() unless they
 512  *   need to pass a specific owner module. MDIO devices which are not
 513  *   PHYs will not be brought up by this function. They are expected to
 514  *   to be explicitly listed in DT and instantiated by of_mdiobus_register().
 515  *
 516  * Returns 0 on success or < 0 on error.
 517  */
 518 int __mdiobus_register(struct mii_bus *bus, struct module *owner)
 519 {
 520         struct mdio_device *mdiodev;
 521         int i, err;
 522         struct gpio_desc *gpiod;
 523
 524         if (NULL == bus || NULL == bus->name ||
 525             NULL == bus->read || NULL == bus->write)
 526                 return -EINVAL;
 527
 528         BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
 529                bus->state != MDIOBUS_UNREGISTERED);
 530
 531         bus->owner = owner;
 532         bus->dev.parent = bus->parent;
 533         bus->dev.class = &mdio_bus_class;
 534         bus->dev.groups = NULL;
 535         dev_set_name(&bus->dev, "%s", bus->id);
 536
 537         /* We need to set state to MDIOBUS_UNREGISTERED to correctly release
 538          * the device in mdiobus_free()
 539          *
 540          * State will be updated later in this function in case of success
 541          */
 542         bus->state = MDIOBUS_UNREGISTERED;
 543
 544         err = device_register(&bus->dev);
 545         if (err) {
 546                 pr_err("mii_bus %s failed to register\n", bus->id);
 547                 return -EINVAL;
 548         }
 549
 550         mutex_init(&bus->mdio_lock);
 551         mutex_init(&bus->shared_lock);
 552
 553         /* de-assert bus level PHY GPIO reset */
 554         gpiod = devm_gpiod_get_optional(&bus->dev, "reset", GPIOD_OUT_LOW);
 555         if (IS_ERR(gpiod)) {
 556                 dev_err(&bus->dev, "mii_bus %s couldn't get reset GPIO\n",
 557                         bus->id);
 558                 device_del(&bus->dev);
 559                 return PTR_ERR(gpiod);
 560         } else  if (gpiod) {
 561                 bus->reset_gpiod = gpiod;
 562
 563                 gpiod_set_value_cansleep(gpiod, 1);
 564                 fsleep(bus->reset_delay_us);
 565                 gpiod_set_value_cansleep(gpiod, 0);
 566                 if (bus->reset_post_delay_us > 0)
 567                         fsleep(bus->reset_post_delay_us);
 568         }
 569
 570         if (bus->reset) {
 571                 err = bus->reset(bus);
 572                 if (err)
 573                         goto error_reset_gpiod;
 574         }
 575
 576         for (i = 0; i < PHY_MAX_ADDR; i++) {
 577                 if ((bus->phy_mask & (1 << i)) == 0) {
 578                         struct phy_device *phydev;
 579
 580                         phydev = mdiobus_scan(bus, i);
 581                         if (IS_ERR(phydev) && (PTR_ERR(phydev) != -ENODEV)) {
 582                                 err = PTR_ERR(phydev);
 583                                 goto error;
 584                         }
 585                 }
 586         }
 587
 588         mdiobus_setup_mdiodev_from_board_info(bus, mdiobus_create_device);
 589
 590         bus->state = MDIOBUS_REGISTERED;
 591         dev_dbg(&bus->dev, "probed\n");
 592         return 0;
 593
 594 error:
 595         while (--i >= 0) {
 596                 mdiodev = bus->mdio_map[i];
 597                 if (!mdiodev)
 598                         continue;
 599
 600                 mdiodev->device_remove(mdiodev);
 601                 mdiodev->device_free(mdiodev);
 602         }
 603 error_reset_gpiod:
 604         /* Put PHYs in RESET to save power */
 605         if (bus->reset_gpiod)
 606                 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
 607
 608         device_del(&bus->dev);
 609         return err;
 610 }
 611 EXPORT_SYMBOL(__mdiobus_register);
 612
 613 void mdiobus_unregister(struct mii_bus *bus)
 614 {
 615         struct mdio_device *mdiodev;
 616         int i;
 617
 618         if (WARN_ON_ONCE(bus->state != MDIOBUS_REGISTERED))
 619                 return;
 620         bus->state = MDIOBUS_UNREGISTERED;
 621
 622         for (i = 0; i < PHY_MAX_ADDR; i++) {
 623                 mdiodev = bus->mdio_map[i];
 624                 if (!mdiodev)
 625                         continue;
 626
 627                 if (mdiodev->reset_gpio)
 628                         gpiod_put(mdiodev->reset_gpio);
 629
 630                 mdiodev->device_remove(mdiodev);
 631                 mdiodev->device_free(mdiodev);
 632         }
 633
 634         /* Put PHYs in RESET to save power */
 635         if (bus->reset_gpiod)
 636                 gpiod_set_value_cansleep(bus->reset_gpiod, 1);
 637
 638         device_del(&bus->dev);
 639 }
 640 EXPORT_SYMBOL(mdiobus_unregister);
 641
 642 /**
 643  * mdiobus_free - free a struct mii_bus
 644  * @bus: mii_bus to free
 645  *
 646  * This function releases the reference to the underlying device
 647  * object in the mii_bus.  If this is the last reference, the mii_bus
 648  * will be freed.
 649  */
 650 void mdiobus_free(struct mii_bus *bus)
 651 {
 652         /* For compatibility with error handling in drivers. */
 653         if (bus->state == MDIOBUS_ALLOCATED) {
 654                 kfree(bus);
 655                 return;
 656         }
 657
 658         BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
 659         bus->state = MDIOBUS_RELEASED;
 660
 661         put_device(&bus->dev);
 662 }
 663 EXPORT_SYMBOL(mdiobus_free);
 664
 665 /**
 666  * mdiobus_scan - scan a bus for MDIO devices.
 667  * @bus: mii_bus to scan
 668  * @addr: address on bus to scan
 669  *
 670  * This function scans the MDIO bus, looking for devices which can be
 671  * identified using a vendor/product ID in registers 2 and 3. Not all
 672  * MDIO devices have such registers, but PHY devices typically
 673  * do. Hence this function assumes anything found is a PHY, or can be
 674  * treated as a PHY. Other MDIO devices, such as switches, will
 675  * probably not be found during the scan.
 676  */
 677 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
 678 {
 679         struct phy_device *phydev = ERR_PTR(-ENODEV);
 680         int err;
 681
 682         switch (bus->probe_capabilities) {
 683         case MDIOBUS_NO_CAP:
 684         case MDIOBUS_C22:
 685                 phydev = get_phy_device(bus, addr, false);
 686                 break;
 687         case MDIOBUS_C45:
 688                 phydev = get_phy_device(bus, addr, true);
 689                 break;
 690         case MDIOBUS_C22_C45:
 691                 phydev = get_phy_device(bus, addr, false);
 692                 if (IS_ERR(phydev))
 693                         phydev = get_phy_device(bus, addr, true);
 694                 break;
 695         }
 696
 697         if (IS_ERR(phydev))
 698                 return phydev;
 699
 700         /*
 701          * For DT, see if the auto-probed phy has a correspoding child
 702          * in the bus node, and set the of_node pointer in this case.
 703          */
 704         of_mdiobus_link_mdiodev(bus, &phydev->mdio);
 705
 706         err = phy_device_register(phydev);
 707         if (err) {
 708                 phy_device_free(phydev);
 709                 return ERR_PTR(-ENODEV);
 710         }
 711
 712         return phydev;
 713 }
 714 EXPORT_SYMBOL(mdiobus_scan);
 715
 716 static void mdiobus_stats_acct(struct mdio_bus_stats *stats, bool op, int ret)
 717 {
 718         preempt_disable();
 719         u64_stats_update_begin(&stats->syncp);
 720
 721         u64_stats_inc(&stats->transfers);
 722         if (ret < 0) {
 723                 u64_stats_inc(&stats->errors);
 724                 goto out;
 725         }
 726
 727         if (op)
 728                 u64_stats_inc(&stats->reads);
 729         else
 730                 u64_stats_inc(&stats->writes);
 731 out:
 732         u64_stats_update_end(&stats->syncp);
 733         preempt_enable();
 734 }
 735
 736 /**
 737  * __mdiobus_read - Unlocked version of the mdiobus_read function
 738  * @bus: the mii_bus struct
 739  * @addr: the phy address
 740  * @regnum: register number to read
 741  *
 742  * Read a MDIO bus register. Caller must hold the mdio bus lock.
 743  *
 744  * NOTE: MUST NOT be called from interrupt context.
 745  */
 746 int __mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
 747 {
 748         int retval;
 749
 750         WARN_ON_ONCE(!mutex_is_locked(&bus->mdio_lock));
 751
 752         retval = bus->read(bus, addr, regnum);
 753
 754         trace_mdio_access(bus, 1, addr, regnum, retval, retval);
 755         mdiobus_stats_acct(&bus->stats[addr], true, retval);
 756
 757         return retval;
 758 }
 759 EXPORT_SYMBOL(__mdiobus_read);
 760
 761 /**
 762  * __mdiobus_write - Unlocked version of the mdiobus_write function
 763  * @bus: the mii_bus struct
 764  * @addr: the phy address
 765  * @regnum: register number to write
 766  * @val: value to write to @regnum
 767  *
 768  * Write a MDIO bus register. Caller must hold the mdio bus lock.
 769  *
 770  * NOTE: MUST NOT be called from interrupt context.
 771  */
 772 int __mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 773 {
 774         int err;
 775
 776         WARN_ON_ONCE(!mutex_is_locked(&bus->mdio_lock));
 777
 778         err = bus->write(bus, addr, regnum, val);
 779
 780         trace_mdio_access(bus, 0, addr, regnum, val, err);
 781         mdiobus_stats_acct(&bus->stats[addr], false, err);
 782
 783         return err;
 784 }
 785 EXPORT_SYMBOL(__mdiobus_write);
 786
 787 /**
 788  * __mdiobus_modify_changed - Unlocked version of the mdiobus_modify function
 789  * @bus: the mii_bus struct
 790  * @addr: the phy address
 791  * @regnum: register number to modify
 792  * @mask: bit mask of bits to clear
 793  * @set: bit mask of bits to set
 794  *
 795  * Read, modify, and if any change, write the register value back to the
 796  * device. Any error returns a negative number.
 797  *
 798  * NOTE: MUST NOT be called from interrupt context.
 799  */
 800 int __mdiobus_modify_changed(struct mii_bus *bus, int addr, u32 regnum,
 801                              u16 mask, u16 set)
 802 {
 803         int new, ret;
 804
 805         ret = __mdiobus_read(bus, addr, regnum);
 806         if (ret < 0)
 807                 return ret;
 808
 809         new = (ret & ~mask) | set;
 810         if (new == ret)
 811                 return 0;
 812
 813         ret = __mdiobus_write(bus, addr, regnum, new);
 814
 815         return ret < 0 ? ret : 1;
 816 }
 817 EXPORT_SYMBOL_GPL(__mdiobus_modify_changed);
 818
 819 /**
 820  * mdiobus_read_nested - Nested version of the mdiobus_read function
 821  * @bus: the mii_bus struct
 822  * @addr: the phy address
 823  * @regnum: register number to read
 824  *
 825  * In case of nested MDIO bus access avoid lockdep false positives by
 826  * using mutex_lock_nested().
 827  *
 828  * NOTE: MUST NOT be called from interrupt context,
 829  * because the bus read/write functions may wait for an interrupt
 830  * to conclude the operation.
 831  */
 832 int mdiobus_read_nested(struct mii_bus *bus, int addr, u32 regnum)
 833 {
 834         int retval;
 835
 836         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
 837         retval = __mdiobus_read(bus, addr, regnum);
 838         mutex_unlock(&bus->mdio_lock);
 839
 840         return retval;
 841 }
 842 EXPORT_SYMBOL(mdiobus_read_nested);
 843
 844 /**
 845  * mdiobus_read - Convenience function for reading a given MII mgmt register
 846  * @bus: the mii_bus struct
 847  * @addr: the phy address
 848  * @regnum: register number to read
 849  *
 850  * NOTE: MUST NOT be called from interrupt context,
 851  * because the bus read/write functions may wait for an interrupt
 852  * to conclude the operation.
 853  */
 854 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
 855 {
 856         int retval;
 857
 858         mutex_lock(&bus->mdio_lock);
 859         retval = __mdiobus_read(bus, addr, regnum);
 860         mutex_unlock(&bus->mdio_lock);
 861
 862         return retval;
 863 }
 864 EXPORT_SYMBOL(mdiobus_read);
 865
 866 /**
 867  * mdiobus_write_nested - Nested version of the mdiobus_write function
 868  * @bus: the mii_bus struct
 869  * @addr: the phy address
 870  * @regnum: register number to write
 871  * @val: value to write to @regnum
 872  *
 873  * In case of nested MDIO bus access avoid lockdep false positives by
 874  * using mutex_lock_nested().
 875  *
 876  * NOTE: MUST NOT be called from interrupt context,
 877  * because the bus read/write functions may wait for an interrupt
 878  * to conclude the operation.
 879  */
 880 int mdiobus_write_nested(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 881 {
 882         int err;
 883
 884         mutex_lock_nested(&bus->mdio_lock, MDIO_MUTEX_NESTED);
 885         err = __mdiobus_write(bus, addr, regnum, val);
 886         mutex_unlock(&bus->mdio_lock);
 887
 888         return err;
 889 }
 890 EXPORT_SYMBOL(mdiobus_write_nested);
 891
 892 /**
 893  * mdiobus_write - Convenience function for writing a given MII mgmt register
 894  * @bus: the mii_bus struct
 895  * @addr: the phy address
 896  * @regnum: register number to write
 897  * @val: value to write to @regnum
 898  *
 899  * NOTE: MUST NOT be called from interrupt context,
 900  * because the bus read/write functions may wait for an interrupt
 901  * to conclude the operation.
 902  */
 903 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 904 {
 905         int err;
 906
 907         mutex_lock(&bus->mdio_lock);
 908         err = __mdiobus_write(bus, addr, regnum, val);
 909         mutex_unlock(&bus->mdio_lock);
 910
 911         return err;
 912 }
 913 EXPORT_SYMBOL(mdiobus_write);
 914
 915 /**
 916  * mdiobus_modify - Convenience function for modifying a given mdio device
 917  *      register
 918  * @bus: the mii_bus struct
 919  * @addr: the phy address
 920  * @regnum: register number to write
 921  * @mask: bit mask of bits to clear
 922  * @set: bit mask of bits to set
 923  */
 924 int mdiobus_modify(struct mii_bus *bus, int addr, u32 regnum, u16 mask, u16 set)
 925 {
 926         int err;
 927
 928         mutex_lock(&bus->mdio_lock);
 929         err = __mdiobus_modify_changed(bus, addr, regnum, mask, set);
 930         mutex_unlock(&bus->mdio_lock);
 931
 932         return err < 0 ? err : 0;
 933 }
 934 EXPORT_SYMBOL_GPL(mdiobus_modify);
 935
 936 /**
 937  * mdio_bus_match - determine if given MDIO driver supports the given
 938  *                  MDIO device
 939  * @dev: target MDIO device
 940  * @drv: given MDIO driver
 941  *
 942  * Description: Given a MDIO device, and a MDIO driver, return 1 if
 943  *   the driver supports the device.  Otherwise, return 0. This may
 944  *   require calling the devices own match function, since different classes
 945  *   of MDIO devices have different match criteria.
 946  */
 947 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
 948 {
 949         struct mdio_device *mdio = to_mdio_device(dev);
 950
 951         if (of_driver_match_device(dev, drv))
 952                 return 1;
 953
 954         if (mdio->bus_match)
 955                 return mdio->bus_match(dev, drv);
 956
 957         return 0;
 958 }
 959
 960 static int mdio_uevent(struct device *dev, struct kobj_uevent_env *env)
 961 {
 962         int rc;
 963
 964         /* Some devices have extra OF data and an OF-style MODALIAS */
 965         rc = of_device_uevent_modalias(dev, env);
 966         if (rc != -ENODEV)
 967                 return rc;
 968
 969         return 0;
 970 }
 971
 972 static struct attribute *mdio_bus_device_statistics_attrs[] = {
 973         &dev_attr_mdio_bus_device_transfers.attr.attr,
 974         &dev_attr_mdio_bus_device_errors.attr.attr,
 975         &dev_attr_mdio_bus_device_writes.attr.attr,
 976         &dev_attr_mdio_bus_device_reads.attr.attr,
 977         NULL,
 978 };
 979
 980 static const struct attribute_group mdio_bus_device_statistics_group = {
 981         .name   = "statistics",
 982         .attrs  = mdio_bus_device_statistics_attrs,
 983 };
 984
 985 static const struct attribute_group *mdio_bus_dev_groups[] = {
 986         &mdio_bus_device_statistics_group,
 987         NULL,
 988 };
 989
 990 struct bus_type mdio_bus_type = {
 991         .name           = "mdio_bus",
 992         .dev_groups     = mdio_bus_dev_groups,
 993         .match          = mdio_bus_match,
 994         .uevent         = mdio_uevent,
 995 };
 996 EXPORT_SYMBOL(mdio_bus_type);
 997
 998 int __init mdio_bus_init(void)
 999 {
1000         int ret;
1001
1002         ret = class_register(&mdio_bus_class);
1003         if (!ret) {
1004                 ret = bus_register(&mdio_bus_type);
1005                 if (ret)
1006                         class_unregister(&mdio_bus_class);
1007         }
1008
1009         return ret;
1010 }
1011
1012 #if IS_ENABLED(CONFIG_PHYLIB)
1013 void mdio_bus_exit(void)
1014 {
1015         class_unregister(&mdio_bus_class);
1016         bus_unregister(&mdio_bus_type);
1017 }
1018 EXPORT_SYMBOL_GPL(mdio_bus_exit);
1019 #else
1020 module_init(mdio_bus_init);
1021 /* no module_exit, intentional */
1022 MODULE_LICENSE("GPL");
1023 MODULE_DESCRIPTION("MDIO bus/device layer");
1024 #endif