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