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