drivers/of/of_mdio.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * OF helpers for the MDIO (Ethernet PHY) API
   4  *
   5  * Copyright (c) 2009 Secret Lab Technologies, Ltd.
   6  *
   7  * This file provides helper functions for extracting PHY device information
   8  * out of the OpenFirmware device tree and using it to populate an mii_bus.
   9  */
  10
  11 #include <linux/kernel.h>
  12 #include <linux/device.h>
  13 #include <linux/netdevice.h>
  14 #include <linux/err.h>
  15 #include <linux/phy.h>
  16 #include <linux/phy_fixed.h>
  17 #include <linux/of.h>
  18 #include <linux/of_irq.h>
  19 #include <linux/of_mdio.h>
  20 #include <linux/of_net.h>
  21 #include <linux/module.h>
  22
  23 #define DEFAULT_GPIO_RESET_DELAY        10      /* in microseconds */
  24
  25 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
  26 MODULE_LICENSE("GPL");
  27
  28 /* Extract the clause 22 phy ID from the compatible string of the form
  29  * ethernet-phy-idAAAA.BBBB */
  30 static int of_get_phy_id(struct device_node *device, u32 *phy_id)
  31 {
  32         struct property *prop;
  33         const char *cp;
  34         unsigned int upper, lower;
  35
  36         of_property_for_each_string(device, "compatible", prop, cp) {
  37                 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
  38                         *phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF);
  39                         return 0;
  40                 }
  41         }
  42         return -EINVAL;
  43 }
  44
  45 static struct mii_timestamper *of_find_mii_timestamper(struct device_node *node)
  46 {
  47         struct of_phandle_args arg;
  48         int err;
  49
  50         err = of_parse_phandle_with_fixed_args(node, "timestamper", 1, 0, &arg);
  51
  52         if (err == -ENOENT)
  53                 return NULL;
  54         else if (err)
  55                 return ERR_PTR(err);
  56
  57         if (arg.args_count != 1)
  58                 return ERR_PTR(-EINVAL);
  59
  60         return register_mii_timestamper(arg.np, arg.args[0]);
  61 }
  62
  63 static int of_mdiobus_register_phy(struct mii_bus *mdio,
  64                                     struct device_node *child, u32 addr)
  65 {
  66         struct mii_timestamper *mii_ts;
  67         struct phy_device *phy;
  68         bool is_c45;
  69         int rc;
  70         u32 phy_id;
  71
  72         mii_ts = of_find_mii_timestamper(child);
  73         if (IS_ERR(mii_ts))
  74                 return PTR_ERR(mii_ts);
  75
  76         is_c45 = of_device_is_compatible(child,
  77                                          "ethernet-phy-ieee802.3-c45");
  78
  79         if (!is_c45 && !of_get_phy_id(child, &phy_id))
  80                 phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
  81         else
  82                 phy = get_phy_device(mdio, addr, is_c45);
  83         if (IS_ERR(phy)) {
  84                 if (mii_ts)
  85                         unregister_mii_timestamper(mii_ts);
  86                 return PTR_ERR(phy);
  87         }
  88
  89         rc = of_irq_get(child, 0);
  90         if (rc == -EPROBE_DEFER) {
  91                 if (mii_ts)
  92                         unregister_mii_timestamper(mii_ts);
  93                 phy_device_free(phy);
  94                 return rc;
  95         }
  96         if (rc > 0) {
  97                 phy->irq = rc;
  98                 mdio->irq[addr] = rc;
  99         } else {
 100                 phy->irq = mdio->irq[addr];
 101         }
 102
 103         if (of_property_read_bool(child, "broken-turn-around"))
 104                 mdio->phy_ignore_ta_mask |= 1 << addr;
 105
 106         of_property_read_u32(child, "reset-assert-us",
 107                              &phy->mdio.reset_assert_delay);
 108         of_property_read_u32(child, "reset-deassert-us",
 109                              &phy->mdio.reset_deassert_delay);
 110
 111         /* Associate the OF node with the device structure so it
 112          * can be looked up later */
 113         of_node_get(child);
 114         phy->mdio.dev.of_node = child;
 115         phy->mdio.dev.fwnode = of_fwnode_handle(child);
 116
 117         /* All data is now stored in the phy struct;
 118          * register it */
 119         rc = phy_device_register(phy);
 120         if (rc) {
 121                 if (mii_ts)
 122                         unregister_mii_timestamper(mii_ts);
 123                 phy_device_free(phy);
 124                 of_node_put(child);
 125                 return rc;
 126         }
 127
 128         /* phy->mii_ts may already be defined by the PHY driver. A
 129          * mii_timestamper probed via the device tree will still have
 130          * precedence.
 131          */
 132         if (mii_ts)
 133                 phy->mii_ts = mii_ts;
 134
 135         dev_dbg(&mdio->dev, "registered phy %pOFn at address %i\n",
 136                 child, addr);
 137         return 0;
 138 }
 139
 140 static int of_mdiobus_register_device(struct mii_bus *mdio,
 141                                       struct device_node *child, u32 addr)
 142 {
 143         struct mdio_device *mdiodev;
 144         int rc;
 145
 146         mdiodev = mdio_device_create(mdio, addr);
 147         if (IS_ERR(mdiodev))
 148                 return PTR_ERR(mdiodev);
 149
 150         /* Associate the OF node with the device structure so it
 151          * can be looked up later.
 152          */
 153         of_node_get(child);
 154         mdiodev->dev.of_node = child;
 155         mdiodev->dev.fwnode = of_fwnode_handle(child);
 156
 157         /* All data is now stored in the mdiodev struct; register it. */
 158         rc = mdio_device_register(mdiodev);
 159         if (rc) {
 160                 mdio_device_free(mdiodev);
 161                 of_node_put(child);
 162                 return rc;
 163         }
 164
 165         dev_dbg(&mdio->dev, "registered mdio device %pOFn at address %i\n",
 166                 child, addr);
 167         return 0;
 168 }
 169
 170 /* The following is a list of PHY compatible strings which appear in
 171  * some DTBs. The compatible string is never matched against a PHY
 172  * driver, so is pointless. We only expect devices which are not PHYs
 173  * to have a compatible string, so they can be matched to an MDIO
 174  * driver.  Encourage users to upgrade their DT blobs to remove these.
 175  */
 176 static const struct of_device_id whitelist_phys[] = {
 177         { .compatible = "brcm,40nm-ephy" },
 178         { .compatible = "broadcom,bcm5241" },
 179         { .compatible = "marvell,88E1111", },
 180         { .compatible = "marvell,88e1116", },
 181         { .compatible = "marvell,88e1118", },
 182         { .compatible = "marvell,88e1145", },
 183         { .compatible = "marvell,88e1149r", },
 184         { .compatible = "marvell,88e1310", },
 185         { .compatible = "marvell,88E1510", },
 186         { .compatible = "marvell,88E1514", },
 187         { .compatible = "moxa,moxart-rtl8201cp", },
 188         {}
 189 };
 190
 191 /*
 192  * Return true if the child node is for a phy. It must either:
 193  * o Compatible string of "ethernet-phy-idX.X"
 194  * o Compatible string of "ethernet-phy-ieee802.3-c45"
 195  * o Compatible string of "ethernet-phy-ieee802.3-c22"
 196  * o In the white list above (and issue a warning)
 197  * o No compatibility string
 198  *
 199  * A device which is not a phy is expected to have a compatible string
 200  * indicating what sort of device it is.
 201  */
 202 bool of_mdiobus_child_is_phy(struct device_node *child)
 203 {
 204         u32 phy_id;
 205
 206         if (of_get_phy_id(child, &phy_id) != -EINVAL)
 207                 return true;
 208
 209         if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
 210                 return true;
 211
 212         if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
 213                 return true;
 214
 215         if (of_match_node(whitelist_phys, child)) {
 216                 pr_warn(FW_WARN
 217                         "%pOF: Whitelisted compatible string. Please remove\n",
 218                         child);
 219                 return true;
 220         }
 221
 222         if (!of_find_property(child, "compatible", NULL))
 223                 return true;
 224
 225         return false;
 226 }
 227 EXPORT_SYMBOL(of_mdiobus_child_is_phy);
 228
 229 /**
 230  * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
 231  * @mdio: pointer to mii_bus structure
 232  * @np: pointer to device_node of MDIO bus.
 233  *
 234  * This function registers the mii_bus structure and registers a phy_device
 235  * for each child node of @np.
 236  */
 237 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
 238 {
 239         struct device_node *child;
 240         bool scanphys = false;
 241         int addr, rc;
 242
 243         if (!np)
 244                 return mdiobus_register(mdio);
 245
 246         /* Do not continue if the node is disabled */
 247         if (!of_device_is_available(np))
 248                 return -ENODEV;
 249
 250         /* Mask out all PHYs from auto probing.  Instead the PHYs listed in
 251          * the device tree are populated after the bus has been registered */
 252         mdio->phy_mask = ~0;
 253
 254         mdio->dev.of_node = np;
 255         mdio->dev.fwnode = of_fwnode_handle(np);
 256
 257         /* Get bus level PHY reset GPIO details */
 258         mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;
 259         of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);
 260
 261         /* Register the MDIO bus */
 262         rc = mdiobus_register(mdio);
 263         if (rc)
 264                 return rc;
 265
 266         /* Loop over the child nodes and register a phy_device for each phy */
 267         for_each_available_child_of_node(np, child) {
 268                 addr = of_mdio_parse_addr(&mdio->dev, child);
 269                 if (addr < 0) {
 270                         scanphys = true;
 271                         continue;
 272                 }
 273
 274                 if (of_mdiobus_child_is_phy(child))
 275                         rc = of_mdiobus_register_phy(mdio, child, addr);
 276                 else
 277                         rc = of_mdiobus_register_device(mdio, child, addr);
 278
 279                 if (rc == -ENODEV)
 280                         dev_err(&mdio->dev,
 281                                 "MDIO device at address %d is missing.\n",
 282                                 addr);
 283                 else if (rc)
 284                         goto unregister;
 285         }
 286
 287         if (!scanphys)
 288                 return 0;
 289
 290         /* auto scan for PHYs with empty reg property */
 291         for_each_available_child_of_node(np, child) {
 292                 /* Skip PHYs with reg property set */
 293                 if (of_find_property(child, "reg", NULL))
 294                         continue;
 295
 296                 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
 297                         /* skip already registered PHYs */
 298                         if (mdiobus_is_registered_device(mdio, addr))
 299                                 continue;
 300
 301                         /* be noisy to encourage people to set reg property */
 302                         dev_info(&mdio->dev, "scan phy %pOFn at address %i\n",
 303                                  child, addr);
 304
 305                         if (of_mdiobus_child_is_phy(child)) {
 306                                 rc = of_mdiobus_register_phy(mdio, child, addr);
 307                                 if (rc && rc != -ENODEV)
 308                                         goto unregister;
 309                                 break;
 310                         }
 311                 }
 312         }
 313
 314         return 0;
 315
 316 unregister:
 317         mdiobus_unregister(mdio);
 318         return rc;
 319 }
 320 EXPORT_SYMBOL(of_mdiobus_register);
 321
 322 /**
 323  * of_phy_find_device - Give a PHY node, find the phy_device
 324  * @phy_np: Pointer to the phy's device tree node
 325  *
 326  * If successful, returns a pointer to the phy_device with the embedded
 327  * struct device refcount incremented by one, or NULL on failure.
 328  */
 329 struct phy_device *of_phy_find_device(struct device_node *phy_np)
 330 {
 331         struct device *d;
 332         struct mdio_device *mdiodev;
 333
 334         if (!phy_np)
 335                 return NULL;
 336
 337         d = bus_find_device_by_of_node(&mdio_bus_type, phy_np);
 338         if (d) {
 339                 mdiodev = to_mdio_device(d);
 340                 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
 341                         return to_phy_device(d);
 342                 put_device(d);
 343         }
 344
 345         return NULL;
 346 }
 347 EXPORT_SYMBOL(of_phy_find_device);
 348
 349 /**
 350  * of_phy_connect - Connect to the phy described in the device tree
 351  * @dev: pointer to net_device claiming the phy
 352  * @phy_np: Pointer to device tree node for the PHY
 353  * @hndlr: Link state callback for the network device
 354  * @flags: flags to pass to the PHY
 355  * @iface: PHY data interface type
 356  *
 357  * If successful, returns a pointer to the phy_device with the embedded
 358  * struct device refcount incremented by one, or NULL on failure. The
 359  * refcount must be dropped by calling phy_disconnect() or phy_detach().
 360  */
 361 struct phy_device *of_phy_connect(struct net_device *dev,
 362                                   struct device_node *phy_np,
 363                                   void (*hndlr)(struct net_device *), u32 flags,
 364                                   phy_interface_t iface)
 365 {
 366         struct phy_device *phy = of_phy_find_device(phy_np);
 367         int ret;
 368
 369         if (!phy)
 370                 return NULL;
 371
 372         phy->dev_flags = flags;
 373
 374         ret = phy_connect_direct(dev, phy, hndlr, iface);
 375
 376         /* refcount is held by phy_connect_direct() on success */
 377         put_device(&phy->mdio.dev);
 378
 379         return ret ? NULL : phy;
 380 }
 381 EXPORT_SYMBOL(of_phy_connect);
 382
 383 /**
 384  * of_phy_get_and_connect
 385  * - Get phy node and connect to the phy described in the device tree
 386  * @dev: pointer to net_device claiming the phy
 387  * @np: Pointer to device tree node for the net_device claiming the phy
 388  * @hndlr: Link state callback for the network device
 389  *
 390  * If successful, returns a pointer to the phy_device with the embedded
 391  * struct device refcount incremented by one, or NULL on failure. The
 392  * refcount must be dropped by calling phy_disconnect() or phy_detach().
 393  */
 394 struct phy_device *of_phy_get_and_connect(struct net_device *dev,
 395                                           struct device_node *np,
 396                                           void (*hndlr)(struct net_device *))
 397 {
 398         phy_interface_t iface;
 399         struct device_node *phy_np;
 400         struct phy_device *phy;
 401         int ret;
 402
 403         ret = of_get_phy_mode(np, &iface);
 404         if (ret)
 405                 return NULL;
 406         if (of_phy_is_fixed_link(np)) {
 407                 ret = of_phy_register_fixed_link(np);
 408                 if (ret < 0) {
 409                         netdev_err(dev, "broken fixed-link specification\n");
 410                         return NULL;
 411                 }
 412                 phy_np = of_node_get(np);
 413         } else {
 414                 phy_np = of_parse_phandle(np, "phy-handle", 0);
 415                 if (!phy_np)
 416                         return NULL;
 417         }
 418
 419         phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);
 420
 421         of_node_put(phy_np);
 422
 423         return phy;
 424 }
 425 EXPORT_SYMBOL(of_phy_get_and_connect);
 426
 427 /**
 428  * of_phy_attach - Attach to a PHY without starting the state machine
 429  * @dev: pointer to net_device claiming the phy
 430  * @phy_np: Node pointer for the PHY
 431  * @flags: flags to pass to the PHY
 432  * @iface: PHY data interface type
 433  *
 434  * If successful, returns a pointer to the phy_device with the embedded
 435  * struct device refcount incremented by one, or NULL on failure. The
 436  * refcount must be dropped by calling phy_disconnect() or phy_detach().
 437  */
 438 struct phy_device *of_phy_attach(struct net_device *dev,
 439                                  struct device_node *phy_np, u32 flags,
 440                                  phy_interface_t iface)
 441 {
 442         struct phy_device *phy = of_phy_find_device(phy_np);
 443         int ret;
 444
 445         if (!phy)
 446                 return NULL;
 447
 448         ret = phy_attach_direct(dev, phy, flags, iface);
 449
 450         /* refcount is held by phy_attach_direct() on success */
 451         put_device(&phy->mdio.dev);
 452
 453         return ret ? NULL : phy;
 454 }
 455 EXPORT_SYMBOL(of_phy_attach);
 456
 457 /*
 458  * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
 459  * support two DT bindings:
 460  * - the old DT binding, where 'fixed-link' was a property with 5
 461  *   cells encoding various informations about the fixed PHY
 462  * - the new DT binding, where 'fixed-link' is a sub-node of the
 463  *   Ethernet device.
 464  */
 465 bool of_phy_is_fixed_link(struct device_node *np)
 466 {
 467         struct device_node *dn;
 468         int len, err;
 469         const char *managed;
 470
 471         /* New binding */
 472         dn = of_get_child_by_name(np, "fixed-link");
 473         if (dn) {
 474                 of_node_put(dn);
 475                 return true;
 476         }
 477
 478         err = of_property_read_string(np, "managed", &managed);
 479         if (err == 0 && strcmp(managed, "auto") != 0)
 480                 return true;
 481
 482         /* Old binding */
 483         if (of_get_property(np, "fixed-link", &len) &&
 484             len == (5 * sizeof(__be32)))
 485                 return true;
 486
 487         return false;
 488 }
 489 EXPORT_SYMBOL(of_phy_is_fixed_link);
 490
 491 int of_phy_register_fixed_link(struct device_node *np)
 492 {
 493         struct fixed_phy_status status = {};
 494         struct device_node *fixed_link_node;
 495         u32 fixed_link_prop[5];
 496         const char *managed;
 497
 498         if (of_property_read_string(np, "managed", &managed) == 0 &&
 499             strcmp(managed, "in-band-status") == 0) {
 500                 /* status is zeroed, namely its .link member */
 501                 goto register_phy;
 502         }
 503
 504         /* New binding */
 505         fixed_link_node = of_get_child_by_name(np, "fixed-link");
 506         if (fixed_link_node) {
 507                 status.link = 1;
 508                 status.duplex = of_property_read_bool(fixed_link_node,
 509                                                       "full-duplex");
 510                 if (of_property_read_u32(fixed_link_node, "speed",
 511                                          &status.speed)) {
 512                         of_node_put(fixed_link_node);
 513                         return -EINVAL;
 514                 }
 515                 status.pause = of_property_read_bool(fixed_link_node, "pause");
 516                 status.asym_pause = of_property_read_bool(fixed_link_node,
 517                                                           "asym-pause");
 518                 of_node_put(fixed_link_node);
 519
 520                 goto register_phy;
 521         }
 522
 523         /* Old binding */
 524         if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,
 525                                        ARRAY_SIZE(fixed_link_prop)) == 0) {
 526                 status.link = 1;
 527                 status.duplex = fixed_link_prop[1];
 528                 status.speed  = fixed_link_prop[2];
 529                 status.pause  = fixed_link_prop[3];
 530                 status.asym_pause = fixed_link_prop[4];
 531                 goto register_phy;
 532         }
 533
 534         return -ENODEV;
 535
 536 register_phy:
 537         return PTR_ERR_OR_ZERO(fixed_phy_register(PHY_POLL, &status, np));
 538 }
 539 EXPORT_SYMBOL(of_phy_register_fixed_link);
 540
 541 void of_phy_deregister_fixed_link(struct device_node *np)
 542 {
 543         struct phy_device *phydev;
 544
 545         phydev = of_phy_find_device(np);
 546         if (!phydev)
 547                 return;
 548
 549         fixed_phy_unregister(phydev);
 550
 551         put_device(&phydev->mdio.dev);  /* of_phy_find_device() */
 552         phy_device_free(phydev);        /* fixed_phy_register() */
 553 }
 554 EXPORT_SYMBOL(of_phy_deregister_fixed_link);