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