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