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_irq.h>
  20 #include <linux/of_mdio.h>
  21 #include <linux/module.h>
  22
  23 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
  24 MODULE_LICENSE("GPL");
  25
  26 /* Extract the clause 22 phy ID from the compatible string of the form
  27  * ethernet-phy-idAAAA.BBBB */
  28 static int of_get_phy_id(struct device_node *device, u32 *phy_id)
  29 {
  30         struct property *prop;
  31         const char *cp;
  32         unsigned int upper, lower;
  33
  34         of_property_for_each_string(device, "compatible", prop, cp) {
  35                 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
  36                         *phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF);
  37                         return 0;
  38                 }
  39         }
  40         return -EINVAL;
  41 }
  42
  43 static int of_mdiobus_register_phy(struct mii_bus *mdio, struct device_node *child,
  44                                    u32 addr)
  45 {
  46         struct phy_device *phy;
  47         bool is_c45;
  48         int rc;
  49         u32 phy_id;
  50
  51         is_c45 = of_device_is_compatible(child,
  52                                          "ethernet-phy-ieee802.3-c45");
  53
  54         if (!is_c45 && !of_get_phy_id(child, &phy_id))
  55                 phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
  56         else
  57                 phy = get_phy_device(mdio, addr, is_c45);
  58         if (!phy || IS_ERR(phy))
  59                 return 1;
  60
  61         rc = irq_of_parse_and_map(child, 0);
  62         if (rc > 0) {
  63                 phy->irq = rc;
  64                 if (mdio->irq)
  65                         mdio->irq[addr] = rc;
  66         } else {
  67                 if (mdio->irq)
  68                         phy->irq = mdio->irq[addr];
  69         }
  70
  71         /* Associate the OF node with the device structure so it
  72          * can be looked up later */
  73         of_node_get(child);
  74         phy->dev.of_node = child;
  75
  76         /* All data is now stored in the phy struct;
  77          * register it */
  78         rc = phy_device_register(phy);
  79         if (rc) {
  80                 phy_device_free(phy);
  81                 of_node_put(child);
  82                 return 1;
  83         }
  84
  85         dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
  86                 child->name, addr);
  87
  88         return 0;
  89 }
  90
  91 /**
  92  * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
  93  * @mdio: pointer to mii_bus structure
  94  * @np: pointer to device_node of MDIO bus.
  95  *
  96  * This function registers the mii_bus structure and registers a phy_device
  97  * for each child node of @np.
  98  */
  99 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
 100 {
 101         struct device_node *child;
 102         const __be32 *paddr;
 103         u32 addr;
 104         bool scanphys = false;
 105         int rc, i, len;
 106
 107         /* Mask out all PHYs from auto probing.  Instead the PHYs listed in
 108          * the device tree are populated after the bus has been registered */
 109         mdio->phy_mask = ~0;
 110
 111         /* Clear all the IRQ properties */
 112         if (mdio->irq)
 113                 for (i=0; i<PHY_MAX_ADDR; i++)
 114                         mdio->irq[i] = PHY_POLL;
 115
 116         mdio->dev.of_node = np;
 117
 118         /* Register the MDIO bus */
 119         rc = mdiobus_register(mdio);
 120         if (rc)
 121                 return rc;
 122
 123         /* Loop over the child nodes and register a phy_device for each one */
 124         for_each_available_child_of_node(np, child) {
 125                 /* A PHY must have a reg property in the range [0-31] */
 126                 paddr = of_get_property(child, "reg", &len);
 127                 if (!paddr || len < sizeof(*paddr)) {
 128                         scanphys = true;
 129                         dev_err(&mdio->dev, "%s has invalid PHY address\n",
 130                                 child->full_name);
 131                         continue;
 132                 }
 133
 134                 addr = be32_to_cpup(paddr);
 135                 if (addr >= PHY_MAX_ADDR) {
 136                         dev_err(&mdio->dev, "%s PHY address %i is too large\n",
 137                                 child->full_name, addr);
 138                         continue;
 139                 }
 140
 141                 rc = of_mdiobus_register_phy(mdio, child, addr);
 142                 if (rc)
 143                         continue;
 144         }
 145
 146         if (!scanphys)
 147                 return 0;
 148
 149         /* auto scan for PHYs with empty reg property */
 150         for_each_available_child_of_node(np, child) {
 151                 /* Skip PHYs with reg property set */
 152                 paddr = of_get_property(child, "reg", &len);
 153                 if (paddr)
 154                         continue;
 155
 156                 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
 157                         /* skip already registered PHYs */
 158                         if (mdio->phy_map[addr])
 159                                 continue;
 160
 161                         /* be noisy to encourage people to set reg property */
 162                         dev_info(&mdio->dev, "scan phy %s at address %i\n",
 163                                  child->name, addr);
 164
 165                         rc = of_mdiobus_register_phy(mdio, child, addr);
 166                         if (rc)
 167                                 continue;
 168                 }
 169         }
 170
 171         return 0;
 172 }
 173 EXPORT_SYMBOL(of_mdiobus_register);
 174
 175 /* Helper function for of_phy_find_device */
 176 static int of_phy_match(struct device *dev, void *phy_np)
 177 {
 178         return dev->of_node == phy_np;
 179 }
 180
 181 /**
 182  * of_phy_find_device - Give a PHY node, find the phy_device
 183  * @phy_np: Pointer to the phy's device tree node
 184  *
 185  * Returns a pointer to the phy_device.
 186  */
 187 struct phy_device *of_phy_find_device(struct device_node *phy_np)
 188 {
 189         struct device *d;
 190         if (!phy_np)
 191                 return NULL;
 192
 193         d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
 194         return d ? to_phy_device(d) : NULL;
 195 }
 196 EXPORT_SYMBOL(of_phy_find_device);
 197
 198 /**
 199  * of_phy_connect - Connect to the phy described in the device tree
 200  * @dev: pointer to net_device claiming the phy
 201  * @phy_np: Pointer to device tree node for the PHY
 202  * @hndlr: Link state callback for the network device
 203  * @iface: PHY data interface type
 204  *
 205  * Returns a pointer to the phy_device if successful.  NULL otherwise
 206  */
 207 struct phy_device *of_phy_connect(struct net_device *dev,
 208                                   struct device_node *phy_np,
 209                                   void (*hndlr)(struct net_device *), u32 flags,
 210                                   phy_interface_t iface)
 211 {
 212         struct phy_device *phy = of_phy_find_device(phy_np);
 213
 214         if (!phy)
 215                 return NULL;
 216
 217         return phy_connect_direct(dev, phy, hndlr, iface) ? NULL : phy;
 218 }
 219 EXPORT_SYMBOL(of_phy_connect);
 220
 221 /**
 222  * of_phy_attach - Attach to a PHY without starting the state machine
 223  * @dev: pointer to net_device claiming the phy
 224  * @phy_np: Node pointer for the PHY
 225  * @flags: flags to pass to the PHY
 226  * @iface: PHY data interface type
 227  */
 228 struct phy_device *of_phy_attach(struct net_device *dev,
 229                                  struct device_node *phy_np, u32 flags,
 230                                  phy_interface_t iface)
 231 {
 232         struct phy_device *phy = of_phy_find_device(phy_np);
 233
 234         if (!phy)
 235                 return NULL;
 236
 237         return phy_attach_direct(dev, phy, flags, iface) ? NULL : phy;
 238 }
 239 EXPORT_SYMBOL(of_phy_attach);
 240
 241 #if defined(CONFIG_FIXED_PHY)
 242 /*
 243  * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
 244  * support two DT bindings:
 245  * - the old DT binding, where 'fixed-link' was a property with 5
 246  *   cells encoding various informations about the fixed PHY
 247  * - the new DT binding, where 'fixed-link' is a sub-node of the
 248  *   Ethernet device.
 249  */
 250 bool of_phy_is_fixed_link(struct device_node *np)
 251 {
 252         struct device_node *dn;
 253         int len;
 254
 255         /* New binding */
 256         dn = of_get_child_by_name(np, "fixed-link");
 257         if (dn) {
 258                 of_node_put(dn);
 259                 return true;
 260         }
 261
 262         /* Old binding */
 263         if (of_get_property(np, "fixed-link", &len) &&
 264             len == (5 * sizeof(__be32)))
 265                 return true;
 266
 267         return false;
 268 }
 269 EXPORT_SYMBOL(of_phy_is_fixed_link);
 270
 271 int of_phy_register_fixed_link(struct device_node *np)
 272 {
 273         struct fixed_phy_status status = {};
 274         struct device_node *fixed_link_node;
 275         const __be32 *fixed_link_prop;
 276         int len;
 277
 278         /* New binding */
 279         fixed_link_node = of_get_child_by_name(np, "fixed-link");
 280         if (fixed_link_node) {
 281                 status.link = 1;
 282                 status.duplex = of_property_read_bool(np, "full-duplex");
 283                 if (of_property_read_u32(fixed_link_node, "speed", &status.speed))
 284                         return -EINVAL;
 285                 status.pause = of_property_read_bool(np, "pause");
 286                 status.asym_pause = of_property_read_bool(np, "asym-pause");
 287                 of_node_put(fixed_link_node);
 288                 return fixed_phy_register(PHY_POLL, &status, np);
 289         }
 290
 291         /* Old binding */
 292         fixed_link_prop = of_get_property(np, "fixed-link", &len);
 293         if (fixed_link_prop && len == (5 * sizeof(__be32))) {
 294                 status.link = 1;
 295                 status.duplex = be32_to_cpu(fixed_link_prop[1]);
 296                 status.speed = be32_to_cpu(fixed_link_prop[2]);
 297                 status.pause = be32_to_cpu(fixed_link_prop[3]);
 298                 status.asym_pause = be32_to_cpu(fixed_link_prop[4]);
 299                 return fixed_phy_register(PHY_POLL, &status, np);
 300         }
 301
 302         return -ENODEV;
 303 }
 304 EXPORT_SYMBOL(of_phy_register_fixed_link);
 305 #endif