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/of.h>
  18 #include <linux/of_irq.h>
  19 #include <linux/of_mdio.h>
  20 #include <linux/module.h>
  21
  22 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
  23 MODULE_LICENSE("GPL");
  24
  25 static void of_set_phy_supported(struct phy_device *phydev, u32 max_speed)
  26 {
  27         /* The default values for phydev->supported are provided by the PHY
  28          * driver "features" member, we want to reset to sane defaults fist
  29          * before supporting higher speeds.
  30          */
  31         phydev->supported &= PHY_DEFAULT_FEATURES;
  32
  33         switch (max_speed) {
  34         default:
  35                 return;
  36
  37         case SPEED_1000:
  38                 phydev->supported |= PHY_1000BT_FEATURES;
  39         case SPEED_100:
  40                 phydev->supported |= PHY_100BT_FEATURES;
  41         case SPEED_10:
  42                 phydev->supported |= PHY_10BT_FEATURES;
  43         }
  44 }
  45
  46 static int of_mdiobus_register_phy(struct mii_bus *mdio, struct device_node *child,
  47                                    u32 addr)
  48 {
  49         struct phy_device *phy;
  50         bool is_c45;
  51         int rc;
  52         u32 max_speed = 0;
  53
  54         is_c45 = of_device_is_compatible(child,
  55                                          "ethernet-phy-ieee802.3-c45");
  56
  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         /* Set phydev->supported based on the "max-speed" property
  86          * if present */
  87         if (!of_property_read_u32(child, "max-speed", &max_speed))
  88                 of_set_phy_supported(phy, max_speed);
  89
  90         dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
  91                 child->name, addr);
  92
  93         return 0;
  94 }
  95
  96 /**
  97  * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
  98  * @mdio: pointer to mii_bus structure
  99  * @np: pointer to device_node of MDIO bus.
 100  *
 101  * This function registers the mii_bus structure and registers a phy_device
 102  * for each child node of @np.
 103  */
 104 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
 105 {
 106         struct device_node *child;
 107         const __be32 *paddr;
 108         u32 addr;
 109         bool scanphys = false;
 110         int rc, i, len;
 111
 112         /* Mask out all PHYs from auto probing.  Instead the PHYs listed in
 113          * the device tree are populated after the bus has been registered */
 114         mdio->phy_mask = ~0;
 115
 116         /* Clear all the IRQ properties */
 117         if (mdio->irq)
 118                 for (i=0; i<PHY_MAX_ADDR; i++)
 119                         mdio->irq[i] = PHY_POLL;
 120
 121         mdio->dev.of_node = np;
 122
 123         /* Register the MDIO bus */
 124         rc = mdiobus_register(mdio);
 125         if (rc)
 126                 return rc;
 127
 128         /* Loop over the child nodes and register a phy_device for each one */
 129         for_each_available_child_of_node(np, child) {
 130                 /* A PHY must have a reg property in the range [0-31] */
 131                 paddr = of_get_property(child, "reg", &len);
 132                 if (!paddr || len < sizeof(*paddr)) {
 133                         scanphys = true;
 134                         dev_err(&mdio->dev, "%s has invalid PHY address\n",
 135                                 child->full_name);
 136                         continue;
 137                 }
 138
 139                 addr = be32_to_cpup(paddr);
 140                 if (addr >= PHY_MAX_ADDR) {
 141                         dev_err(&mdio->dev, "%s PHY address %i is too large\n",
 142                                 child->full_name, addr);
 143                         continue;
 144                 }
 145
 146                 rc = of_mdiobus_register_phy(mdio, child, addr);
 147                 if (rc)
 148                         continue;
 149         }
 150
 151         if (!scanphys)
 152                 return 0;
 153
 154         /* auto scan for PHYs with empty reg property */
 155         for_each_available_child_of_node(np, child) {
 156                 /* Skip PHYs with reg property set */
 157                 paddr = of_get_property(child, "reg", &len);
 158                 if (paddr)
 159                         continue;
 160
 161                 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
 162                         /* skip already registered PHYs */
 163                         if (mdio->phy_map[addr])
 164                                 continue;
 165
 166                         /* be noisy to encourage people to set reg property */
 167                         dev_info(&mdio->dev, "scan phy %s at address %i\n",
 168                                  child->name, addr);
 169
 170                         rc = of_mdiobus_register_phy(mdio, child, addr);
 171                         if (rc)
 172                                 continue;
 173                 }
 174         }
 175
 176         return 0;
 177 }
 178 EXPORT_SYMBOL(of_mdiobus_register);
 179
 180 /* Helper function for of_phy_find_device */
 181 static int of_phy_match(struct device *dev, void *phy_np)
 182 {
 183         return dev->of_node == phy_np;
 184 }
 185
 186 /**
 187  * of_phy_find_device - Give a PHY node, find the phy_device
 188  * @phy_np: Pointer to the phy's device tree node
 189  *
 190  * Returns a pointer to the phy_device.
 191  */
 192 struct phy_device *of_phy_find_device(struct device_node *phy_np)
 193 {
 194         struct device *d;
 195         if (!phy_np)
 196                 return NULL;
 197
 198         d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
 199         return d ? to_phy_device(d) : NULL;
 200 }
 201 EXPORT_SYMBOL(of_phy_find_device);
 202
 203 /**
 204  * of_phy_connect - Connect to the phy described in the device tree
 205  * @dev: pointer to net_device claiming the phy
 206  * @phy_np: Pointer to device tree node for the PHY
 207  * @hndlr: Link state callback for the network device
 208  * @iface: PHY data interface type
 209  *
 210  * Returns a pointer to the phy_device if successful.  NULL otherwise
 211  */
 212 struct phy_device *of_phy_connect(struct net_device *dev,
 213                                   struct device_node *phy_np,
 214                                   void (*hndlr)(struct net_device *), u32 flags,
 215                                   phy_interface_t iface)
 216 {
 217         struct phy_device *phy = of_phy_find_device(phy_np);
 218
 219         if (!phy)
 220                 return NULL;
 221
 222         return phy_connect_direct(dev, phy, hndlr, iface) ? NULL : phy;
 223 }
 224 EXPORT_SYMBOL(of_phy_connect);
 225
 226 /**
 227  * of_phy_connect_fixed_link - Parse fixed-link property and return a dummy phy
 228  * @dev: pointer to net_device claiming the phy
 229  * @hndlr: Link state callback for the network device
 230  * @iface: PHY data interface type
 231  *
 232  * This function is a temporary stop-gap and will be removed soon.  It is
 233  * only to support the fs_enet, ucc_geth and gianfar Ethernet drivers.  Do
 234  * not call this function from new drivers.
 235  */
 236 struct phy_device *of_phy_connect_fixed_link(struct net_device *dev,
 237                                              void (*hndlr)(struct net_device *),
 238                                              phy_interface_t iface)
 239 {
 240         struct device_node *net_np;
 241         char bus_id[MII_BUS_ID_SIZE + 3];
 242         struct phy_device *phy;
 243         const __be32 *phy_id;
 244         int sz;
 245
 246         if (!dev->dev.parent)
 247                 return NULL;
 248
 249         net_np = dev->dev.parent->of_node;
 250         if (!net_np)
 251                 return NULL;
 252
 253         phy_id = of_get_property(net_np, "fixed-link", &sz);
 254         if (!phy_id || sz < sizeof(*phy_id))
 255                 return NULL;
 256
 257         sprintf(bus_id, PHY_ID_FMT, "fixed-0", be32_to_cpu(phy_id[0]));
 258
 259         phy = phy_connect(dev, bus_id, hndlr, iface);
 260         return IS_ERR(phy) ? NULL : phy;
 261 }
 262 EXPORT_SYMBOL(of_phy_connect_fixed_link);
 263
 264 /**
 265  * of_phy_attach - Attach to a PHY without starting the state machine
 266  * @dev: pointer to net_device claiming the phy
 267  * @phy_np: Node pointer for the PHY
 268  * @flags: flags to pass to the PHY
 269  * @iface: PHY data interface type
 270  */
 271 struct phy_device *of_phy_attach(struct net_device *dev,
 272                                  struct device_node *phy_np, u32 flags,
 273                                  phy_interface_t iface)
 274 {
 275         struct phy_device *phy = of_phy_find_device(phy_np);
 276
 277         if (!phy)
 278                 return NULL;
 279
 280         return phy_attach_direct(dev, phy, flags, iface) ? NULL : phy;
 281 }
 282 EXPORT_SYMBOL(of_phy_attach);