2 * OF helpers for the MDIO (Ethernet PHY) API
4 * Copyright (c) 2009 Secret Lab Technologies, Ltd.
6 * This file is released under the GPLv2
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.
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>
19 #include <linux/of_gpio.h>
20 #include <linux/of_irq.h>
21 #include <linux/of_mdio.h>
22 #include <linux/module.h>
24 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
25 MODULE_LICENSE("GPL");
27 /* Extract the clause 22 phy ID from the compatible string of the form
28 * ethernet-phy-idAAAA.BBBB */
29 static int of_get_phy_id(struct device_node *device, u32 *phy_id)
31 struct property *prop;
33 unsigned int upper, lower;
35 of_property_for_each_string(device, "compatible", prop, cp) {
36 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
37 *phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF);
44 static int of_mdiobus_register_phy(struct mii_bus *mdio, struct device_node *child,
47 struct phy_device *phy;
52 is_c45 = of_device_is_compatible(child,
53 "ethernet-phy-ieee802.3-c45");
55 if (!is_c45 && !of_get_phy_id(child, &phy_id))
56 phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
58 phy = get_phy_device(mdio, addr, is_c45);
59 if (!phy || IS_ERR(phy))
62 rc = irq_of_parse_and_map(child, 0);
69 phy->irq = mdio->irq[addr];
72 if (of_property_read_bool(child, "broken-turn-around"))
73 mdio->phy_ignore_ta_mask |= 1 << addr;
75 /* Associate the OF node with the device structure so it
76 * can be looked up later */
78 phy->mdio.dev.of_node = child;
80 /* All data is now stored in the phy struct;
82 rc = phy_device_register(phy);
89 dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
95 static int of_mdiobus_register_device(struct mii_bus *mdio,
96 struct device_node *child,
99 struct mdio_device *mdiodev;
102 mdiodev = mdio_device_create(mdio, addr);
103 if (!mdiodev || IS_ERR(mdiodev))
106 /* Associate the OF node with the device structure so it
107 * can be looked up later.
110 mdiodev->dev.of_node = child;
112 /* All data is now stored in the mdiodev struct; register it. */
113 rc = mdio_device_register(mdiodev);
115 mdio_device_free(mdiodev);
120 dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n",
126 int of_mdio_parse_addr(struct device *dev, const struct device_node *np)
131 ret = of_property_read_u32(np, "reg", &addr);
133 dev_err(dev, "%s has invalid PHY address\n", np->full_name);
137 /* A PHY must have a reg property in the range [0-31] */
138 if (addr >= PHY_MAX_ADDR) {
139 dev_err(dev, "%s PHY address %i is too large\n",
140 np->full_name, addr);
146 EXPORT_SYMBOL(of_mdio_parse_addr);
149 * Return true if the child node is for a phy. It must either:
150 * o Compatible string of "ethernet-phy-idX.X"
151 * o Compatible string of "ethernet-phy-ieee802.3-c45"
152 * o Compatible string of "ethernet-phy-ieee802.3-c22"
153 * o No compatibility string
155 * A device which is not a phy is expected to have a compatible string
156 * indicating what sort of device it is.
158 static bool of_mdiobus_child_is_phy(struct device_node *child)
162 if (of_get_phy_id(child, &phy_id) != -EINVAL)
165 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
168 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
171 if (!of_find_property(child, "compatible", NULL))
178 * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
179 * @mdio: pointer to mii_bus structure
180 * @np: pointer to device_node of MDIO bus.
182 * This function registers the mii_bus structure and registers a phy_device
183 * for each child node of @np.
185 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
187 struct device_node *child;
189 bool scanphys = false;
192 /* Mask out all PHYs from auto probing. Instead the PHYs listed in
193 * the device tree are populated after the bus has been registered */
196 mdio->dev.of_node = np;
198 /* Register the MDIO bus */
199 rc = mdiobus_register(mdio);
203 /* Loop over the child nodes and register a phy_device for each phy */
204 for_each_available_child_of_node(np, child) {
205 addr = of_mdio_parse_addr(&mdio->dev, child);
211 if (of_mdiobus_child_is_phy(child))
212 of_mdiobus_register_phy(mdio, child, addr);
214 of_mdiobus_register_device(mdio, child, addr);
220 /* auto scan for PHYs with empty reg property */
221 for_each_available_child_of_node(np, child) {
222 /* Skip PHYs with reg property set */
223 paddr = of_get_property(child, "reg", NULL);
227 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
228 /* skip already registered PHYs */
229 if (mdiobus_is_registered_device(mdio, addr))
232 /* be noisy to encourage people to set reg property */
233 dev_info(&mdio->dev, "scan phy %s at address %i\n",
236 if (of_mdiobus_child_is_phy(child))
237 of_mdiobus_register_phy(mdio, child, addr);
243 EXPORT_SYMBOL(of_mdiobus_register);
245 /* Helper function for of_phy_find_device */
246 static int of_phy_match(struct device *dev, void *phy_np)
248 return dev->of_node == phy_np;
252 * of_phy_find_device - Give a PHY node, find the phy_device
253 * @phy_np: Pointer to the phy's device tree node
255 * If successful, returns a pointer to the phy_device with the embedded
256 * struct device refcount incremented by one, or NULL on failure.
258 struct phy_device *of_phy_find_device(struct device_node *phy_np)
264 d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
265 return d ? to_phy_device(d) : NULL;
267 EXPORT_SYMBOL(of_phy_find_device);
270 * of_phy_connect - Connect to the phy described in the device tree
271 * @dev: pointer to net_device claiming the phy
272 * @phy_np: Pointer to device tree node for the PHY
273 * @hndlr: Link state callback for the network device
274 * @iface: PHY data interface type
276 * If successful, returns a pointer to the phy_device with the embedded
277 * struct device refcount incremented by one, or NULL on failure. The
278 * refcount must be dropped by calling phy_disconnect() or phy_detach().
280 struct phy_device *of_phy_connect(struct net_device *dev,
281 struct device_node *phy_np,
282 void (*hndlr)(struct net_device *), u32 flags,
283 phy_interface_t iface)
285 struct phy_device *phy = of_phy_find_device(phy_np);
291 phy->dev_flags = flags;
293 ret = phy_connect_direct(dev, phy, hndlr, iface);
295 /* refcount is held by phy_connect_direct() on success */
296 put_device(&phy->mdio.dev);
298 return ret ? NULL : phy;
300 EXPORT_SYMBOL(of_phy_connect);
303 * of_phy_attach - Attach to a PHY without starting the state machine
304 * @dev: pointer to net_device claiming the phy
305 * @phy_np: Node pointer for the PHY
306 * @flags: flags to pass to the PHY
307 * @iface: PHY data interface type
309 * If successful, returns a pointer to the phy_device with the embedded
310 * struct device refcount incremented by one, or NULL on failure. The
311 * refcount must be dropped by calling phy_disconnect() or phy_detach().
313 struct phy_device *of_phy_attach(struct net_device *dev,
314 struct device_node *phy_np, u32 flags,
315 phy_interface_t iface)
317 struct phy_device *phy = of_phy_find_device(phy_np);
323 ret = phy_attach_direct(dev, phy, flags, iface);
325 /* refcount is held by phy_attach_direct() on success */
326 put_device(&phy->mdio.dev);
328 return ret ? NULL : phy;
330 EXPORT_SYMBOL(of_phy_attach);
332 #if defined(CONFIG_FIXED_PHY)
334 * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
335 * support two DT bindings:
336 * - the old DT binding, where 'fixed-link' was a property with 5
337 * cells encoding various informations about the fixed PHY
338 * - the new DT binding, where 'fixed-link' is a sub-node of the
341 bool of_phy_is_fixed_link(struct device_node *np)
343 struct device_node *dn;
348 dn = of_get_child_by_name(np, "fixed-link");
354 err = of_property_read_string(np, "managed", &managed);
355 if (err == 0 && strcmp(managed, "auto") != 0)
359 if (of_get_property(np, "fixed-link", &len) &&
360 len == (5 * sizeof(__be32)))
365 EXPORT_SYMBOL(of_phy_is_fixed_link);
367 int of_phy_register_fixed_link(struct device_node *np)
369 struct fixed_phy_status status = {};
370 struct device_node *fixed_link_node;
371 const __be32 *fixed_link_prop;
374 struct phy_device *phy;
377 err = of_property_read_string(np, "managed", &managed);
379 if (strcmp(managed, "in-band-status") == 0) {
380 /* status is zeroed, namely its .link member */
381 phy = fixed_phy_register(PHY_POLL, &status, -1, np);
382 return IS_ERR(phy) ? PTR_ERR(phy) : 0;
387 fixed_link_node = of_get_child_by_name(np, "fixed-link");
388 if (fixed_link_node) {
390 status.duplex = of_property_read_bool(fixed_link_node,
392 if (of_property_read_u32(fixed_link_node, "speed", &status.speed))
394 status.pause = of_property_read_bool(fixed_link_node, "pause");
395 status.asym_pause = of_property_read_bool(fixed_link_node,
397 link_gpio = of_get_named_gpio_flags(fixed_link_node,
398 "link-gpios", 0, NULL);
399 of_node_put(fixed_link_node);
400 if (link_gpio == -EPROBE_DEFER)
401 return -EPROBE_DEFER;
403 phy = fixed_phy_register(PHY_POLL, &status, link_gpio, np);
404 return IS_ERR(phy) ? PTR_ERR(phy) : 0;
408 fixed_link_prop = of_get_property(np, "fixed-link", &len);
409 if (fixed_link_prop && len == (5 * sizeof(__be32))) {
411 status.duplex = be32_to_cpu(fixed_link_prop[1]);
412 status.speed = be32_to_cpu(fixed_link_prop[2]);
413 status.pause = be32_to_cpu(fixed_link_prop[3]);
414 status.asym_pause = be32_to_cpu(fixed_link_prop[4]);
415 phy = fixed_phy_register(PHY_POLL, &status, -1, np);
416 return IS_ERR(phy) ? PTR_ERR(phy) : 0;
421 EXPORT_SYMBOL(of_phy_register_fixed_link);