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);
67 phy->irq = mdio->irq[addr];
70 if (of_property_read_bool(child, "broken-turn-around"))
71 mdio->phy_ignore_ta_mask |= 1 << addr;
73 /* Associate the OF node with the device structure so it
74 * can be looked up later */
76 phy->mdio.dev.of_node = child;
78 /* All data is now stored in the phy struct;
80 rc = phy_device_register(phy);
87 dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
93 static int of_mdiobus_register_device(struct mii_bus *mdio,
94 struct device_node *child,
97 struct mdio_device *mdiodev;
100 mdiodev = mdio_device_create(mdio, addr);
101 if (!mdiodev || IS_ERR(mdiodev))
104 /* Associate the OF node with the device structure so it
105 * can be looked up later.
108 mdiodev->dev.of_node = child;
110 /* All data is now stored in the mdiodev struct; register it. */
111 rc = mdio_device_register(mdiodev);
113 mdio_device_free(mdiodev);
118 dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n",
124 int of_mdio_parse_addr(struct device *dev, const struct device_node *np)
129 ret = of_property_read_u32(np, "reg", &addr);
131 dev_err(dev, "%s has invalid PHY address\n", np->full_name);
135 /* A PHY must have a reg property in the range [0-31] */
136 if (addr >= PHY_MAX_ADDR) {
137 dev_err(dev, "%s PHY address %i is too large\n",
138 np->full_name, addr);
144 EXPORT_SYMBOL(of_mdio_parse_addr);
146 /* The following is a list of PHY compatible strings which appear in
147 * some DTBs. The compatible string is never matched against a PHY
148 * driver, so is pointless. We only expect devices which are not PHYs
149 * to have a compatible string, so they can be matched to an MDIO
150 * driver. Encourage users to upgrade their DT blobs to remove these.
152 static const struct of_device_id whitelist_phys[] = {
153 { .compatible = "brcm,40nm-ephy" },
154 { .compatible = "marvell,88E1111", },
155 { .compatible = "marvell,88e1116", },
156 { .compatible = "marvell,88e1118", },
157 { .compatible = "marvell,88e1149r", },
158 { .compatible = "marvell,88e1310", },
159 { .compatible = "marvell,88E1510", },
160 { .compatible = "marvell,88E1514", },
161 { .compatible = "moxa,moxart-rtl8201cp", },
166 * Return true if the child node is for a phy. It must either:
167 * o Compatible string of "ethernet-phy-idX.X"
168 * o Compatible string of "ethernet-phy-ieee802.3-c45"
169 * o Compatible string of "ethernet-phy-ieee802.3-c22"
170 * o In the white list above (and issue a warning)
171 * o No compatibility string
173 * A device which is not a phy is expected to have a compatible string
174 * indicating what sort of device it is.
176 static bool of_mdiobus_child_is_phy(struct device_node *child)
180 if (of_get_phy_id(child, &phy_id) != -EINVAL)
183 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
186 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
189 if (of_match_node(whitelist_phys, child)) {
191 "%s: Whitelisted compatible string. Please remove\n",
196 if (!of_find_property(child, "compatible", NULL))
203 * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
204 * @mdio: pointer to mii_bus structure
205 * @np: pointer to device_node of MDIO bus.
207 * This function registers the mii_bus structure and registers a phy_device
208 * for each child node of @np.
210 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
212 struct device_node *child;
214 bool scanphys = false;
217 /* Mask out all PHYs from auto probing. Instead the PHYs listed in
218 * the device tree are populated after the bus has been registered */
221 mdio->dev.of_node = np;
223 /* Register the MDIO bus */
224 rc = mdiobus_register(mdio);
228 /* Loop over the child nodes and register a phy_device for each phy */
229 for_each_available_child_of_node(np, child) {
230 addr = of_mdio_parse_addr(&mdio->dev, child);
236 if (of_mdiobus_child_is_phy(child))
237 of_mdiobus_register_phy(mdio, child, addr);
239 of_mdiobus_register_device(mdio, child, addr);
245 /* auto scan for PHYs with empty reg property */
246 for_each_available_child_of_node(np, child) {
247 /* Skip PHYs with reg property set */
248 paddr = of_get_property(child, "reg", NULL);
252 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
253 /* skip already registered PHYs */
254 if (mdiobus_is_registered_device(mdio, addr))
257 /* be noisy to encourage people to set reg property */
258 dev_info(&mdio->dev, "scan phy %s at address %i\n",
261 if (of_mdiobus_child_is_phy(child))
262 of_mdiobus_register_phy(mdio, child, addr);
268 EXPORT_SYMBOL(of_mdiobus_register);
270 /* Helper function for of_phy_find_device */
271 static int of_phy_match(struct device *dev, void *phy_np)
273 return dev->of_node == phy_np;
277 * of_phy_find_device - Give a PHY node, find the phy_device
278 * @phy_np: Pointer to the phy's device tree node
280 * If successful, returns a pointer to the phy_device with the embedded
281 * struct device refcount incremented by one, or NULL on failure.
283 struct phy_device *of_phy_find_device(struct device_node *phy_np)
286 struct mdio_device *mdiodev;
291 d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
293 mdiodev = to_mdio_device(d);
294 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
295 return to_phy_device(d);
300 EXPORT_SYMBOL(of_phy_find_device);
303 * of_phy_connect - Connect to the phy described in the device tree
304 * @dev: pointer to net_device claiming the phy
305 * @phy_np: Pointer to device tree node for the PHY
306 * @hndlr: Link state callback for the network device
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_connect(struct net_device *dev,
314 struct device_node *phy_np,
315 void (*hndlr)(struct net_device *), u32 flags,
316 phy_interface_t iface)
318 struct phy_device *phy = of_phy_find_device(phy_np);
324 phy->dev_flags = flags;
326 ret = phy_connect_direct(dev, phy, hndlr, iface);
328 /* refcount is held by phy_connect_direct() on success */
329 put_device(&phy->mdio.dev);
331 return ret ? NULL : phy;
333 EXPORT_SYMBOL(of_phy_connect);
336 * of_phy_attach - Attach to a PHY without starting the state machine
337 * @dev: pointer to net_device claiming the phy
338 * @phy_np: Node pointer for the PHY
339 * @flags: flags to pass to the PHY
340 * @iface: PHY data interface type
342 * If successful, returns a pointer to the phy_device with the embedded
343 * struct device refcount incremented by one, or NULL on failure. The
344 * refcount must be dropped by calling phy_disconnect() or phy_detach().
346 struct phy_device *of_phy_attach(struct net_device *dev,
347 struct device_node *phy_np, u32 flags,
348 phy_interface_t iface)
350 struct phy_device *phy = of_phy_find_device(phy_np);
356 ret = phy_attach_direct(dev, phy, flags, iface);
358 /* refcount is held by phy_attach_direct() on success */
359 put_device(&phy->mdio.dev);
361 return ret ? NULL : phy;
363 EXPORT_SYMBOL(of_phy_attach);
365 #if defined(CONFIG_FIXED_PHY)
367 * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
368 * support two DT bindings:
369 * - the old DT binding, where 'fixed-link' was a property with 5
370 * cells encoding various informations about the fixed PHY
371 * - the new DT binding, where 'fixed-link' is a sub-node of the
374 bool of_phy_is_fixed_link(struct device_node *np)
376 struct device_node *dn;
381 dn = of_get_child_by_name(np, "fixed-link");
387 err = of_property_read_string(np, "managed", &managed);
388 if (err == 0 && strcmp(managed, "auto") != 0)
392 if (of_get_property(np, "fixed-link", &len) &&
393 len == (5 * sizeof(__be32)))
398 EXPORT_SYMBOL(of_phy_is_fixed_link);
400 int of_phy_register_fixed_link(struct device_node *np)
402 struct fixed_phy_status status = {};
403 struct device_node *fixed_link_node;
404 const __be32 *fixed_link_prop;
407 struct phy_device *phy;
410 err = of_property_read_string(np, "managed", &managed);
412 if (strcmp(managed, "in-band-status") == 0) {
413 /* status is zeroed, namely its .link member */
414 phy = fixed_phy_register(PHY_POLL, &status, -1, np);
415 return IS_ERR(phy) ? PTR_ERR(phy) : 0;
420 fixed_link_node = of_get_child_by_name(np, "fixed-link");
421 if (fixed_link_node) {
423 status.duplex = of_property_read_bool(fixed_link_node,
425 if (of_property_read_u32(fixed_link_node, "speed", &status.speed))
427 status.pause = of_property_read_bool(fixed_link_node, "pause");
428 status.asym_pause = of_property_read_bool(fixed_link_node,
430 link_gpio = of_get_named_gpio_flags(fixed_link_node,
431 "link-gpios", 0, NULL);
432 of_node_put(fixed_link_node);
433 if (link_gpio == -EPROBE_DEFER)
434 return -EPROBE_DEFER;
436 phy = fixed_phy_register(PHY_POLL, &status, link_gpio, np);
437 return IS_ERR(phy) ? PTR_ERR(phy) : 0;
441 fixed_link_prop = of_get_property(np, "fixed-link", &len);
442 if (fixed_link_prop && len == (5 * sizeof(__be32))) {
444 status.duplex = be32_to_cpu(fixed_link_prop[1]);
445 status.speed = be32_to_cpu(fixed_link_prop[2]);
446 status.pause = be32_to_cpu(fixed_link_prop[3]);
447 status.asym_pause = be32_to_cpu(fixed_link_prop[4]);
448 phy = fixed_phy_register(PHY_POLL, &status, -1, np);
449 return IS_ERR(phy) ? PTR_ERR(phy) : 0;
454 EXPORT_SYMBOL(of_phy_register_fixed_link);