drivers/of/of_mdio.c

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