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/of_net.h>
23 #include <linux/module.h>
25 #define DEFAULT_GPIO_RESET_DELAY 10 /* in microseconds */
27 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
28 MODULE_LICENSE("GPL");
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)
34 struct property *prop;
36 unsigned int upper, lower;
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);
47 static int of_mdiobus_register_phy(struct mii_bus *mdio,
48 struct device_node *child, u32 addr)
50 struct phy_device *phy;
55 is_c45 = of_device_is_compatible(child,
56 "ethernet-phy-ieee802.3-c45");
58 if (!is_c45 && !of_get_phy_id(child, &phy_id))
59 phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
61 phy = get_phy_device(mdio, addr, is_c45);
65 rc = of_irq_get(child, 0);
66 if (rc == -EPROBE_DEFER) {
74 phy->irq = mdio->irq[addr];
77 if (of_property_read_bool(child, "broken-turn-around"))
78 mdio->phy_ignore_ta_mask |= 1 << addr;
80 /* Associate the OF node with the device structure so it
81 * can be looked up later */
83 phy->mdio.dev.of_node = child;
85 /* All data is now stored in the phy struct;
87 rc = phy_device_register(phy);
94 dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
99 static int of_mdiobus_register_device(struct mii_bus *mdio,
100 struct device_node *child, u32 addr)
102 struct mdio_device *mdiodev;
105 mdiodev = mdio_device_create(mdio, addr);
107 return PTR_ERR(mdiodev);
109 /* Associate the OF node with the device structure so it
110 * can be looked up later.
113 mdiodev->dev.of_node = child;
115 /* All data is now stored in the mdiodev struct; register it. */
116 rc = mdio_device_register(mdiodev);
118 mdio_device_free(mdiodev);
123 dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n",
128 /* The following is a list of PHY compatible strings which appear in
129 * some DTBs. The compatible string is never matched against a PHY
130 * driver, so is pointless. We only expect devices which are not PHYs
131 * to have a compatible string, so they can be matched to an MDIO
132 * driver. Encourage users to upgrade their DT blobs to remove these.
134 static const struct of_device_id whitelist_phys[] = {
135 { .compatible = "brcm,40nm-ephy" },
136 { .compatible = "broadcom,bcm5241" },
137 { .compatible = "marvell,88E1111", },
138 { .compatible = "marvell,88e1116", },
139 { .compatible = "marvell,88e1118", },
140 { .compatible = "marvell,88e1145", },
141 { .compatible = "marvell,88e1149r", },
142 { .compatible = "marvell,88e1310", },
143 { .compatible = "marvell,88E1510", },
144 { .compatible = "marvell,88E1514", },
145 { .compatible = "moxa,moxart-rtl8201cp", },
150 * Return true if the child node is for a phy. It must either:
151 * o Compatible string of "ethernet-phy-idX.X"
152 * o Compatible string of "ethernet-phy-ieee802.3-c45"
153 * o Compatible string of "ethernet-phy-ieee802.3-c22"
154 * o In the white list above (and issue a warning)
155 * o No compatibility string
157 * A device which is not a phy is expected to have a compatible string
158 * indicating what sort of device it is.
160 static bool of_mdiobus_child_is_phy(struct device_node *child)
164 if (of_get_phy_id(child, &phy_id) != -EINVAL)
167 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
170 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
173 if (of_match_node(whitelist_phys, child)) {
175 "%pOF: Whitelisted compatible string. Please remove\n",
180 if (!of_find_property(child, "compatible", NULL))
187 * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
188 * @mdio: pointer to mii_bus structure
189 * @np: pointer to device_node of MDIO bus.
191 * This function registers the mii_bus structure and registers a phy_device
192 * for each child node of @np.
194 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
196 struct device_node *child;
197 bool scanphys = false;
200 /* Do not continue if the node is disabled */
201 if (!of_device_is_available(np))
204 /* Mask out all PHYs from auto probing. Instead the PHYs listed in
205 * the device tree are populated after the bus has been registered */
208 mdio->dev.of_node = np;
210 /* Get bus level PHY reset GPIO details */
211 mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;
212 of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);
214 /* Register the MDIO bus */
215 rc = mdiobus_register(mdio);
219 /* Loop over the child nodes and register a phy_device for each phy */
220 for_each_available_child_of_node(np, child) {
221 addr = of_mdio_parse_addr(&mdio->dev, child);
227 if (of_mdiobus_child_is_phy(child))
228 rc = of_mdiobus_register_phy(mdio, child, addr);
230 rc = of_mdiobus_register_device(mdio, child, addr);
234 "MDIO device at address %d is missing.\n",
243 /* auto scan for PHYs with empty reg property */
244 for_each_available_child_of_node(np, child) {
245 /* Skip PHYs with reg property set */
246 if (of_find_property(child, "reg", NULL))
249 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
250 /* skip already registered PHYs */
251 if (mdiobus_is_registered_device(mdio, addr))
254 /* be noisy to encourage people to set reg property */
255 dev_info(&mdio->dev, "scan phy %s at address %i\n",
258 if (of_mdiobus_child_is_phy(child)) {
259 /* -ENODEV is the return code that PHYLIB has
260 * standardized on to indicate that bus
261 * scanning should continue.
263 rc = of_mdiobus_register_phy(mdio, child, addr);
275 mdiobus_unregister(mdio);
278 EXPORT_SYMBOL(of_mdiobus_register);
280 /* Helper function for of_phy_find_device */
281 static int of_phy_match(struct device *dev, void *phy_np)
283 return dev->of_node == phy_np;
287 * of_phy_find_device - Give a PHY node, find the phy_device
288 * @phy_np: Pointer to the phy's device tree node
290 * If successful, returns a pointer to the phy_device with the embedded
291 * struct device refcount incremented by one, or NULL on failure.
293 struct phy_device *of_phy_find_device(struct device_node *phy_np)
296 struct mdio_device *mdiodev;
301 d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match);
303 mdiodev = to_mdio_device(d);
304 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
305 return to_phy_device(d);
311 EXPORT_SYMBOL(of_phy_find_device);
314 * of_phy_connect - Connect to the phy described in the device tree
315 * @dev: pointer to net_device claiming the phy
316 * @phy_np: Pointer to device tree node for the PHY
317 * @hndlr: Link state callback for the network device
318 * @flags: flags to pass to the PHY
319 * @iface: PHY data interface type
321 * If successful, returns a pointer to the phy_device with the embedded
322 * struct device refcount incremented by one, or NULL on failure. The
323 * refcount must be dropped by calling phy_disconnect() or phy_detach().
325 struct phy_device *of_phy_connect(struct net_device *dev,
326 struct device_node *phy_np,
327 void (*hndlr)(struct net_device *), u32 flags,
328 phy_interface_t iface)
330 struct phy_device *phy = of_phy_find_device(phy_np);
336 phy->dev_flags = flags;
338 ret = phy_connect_direct(dev, phy, hndlr, iface);
340 /* refcount is held by phy_connect_direct() on success */
341 put_device(&phy->mdio.dev);
343 return ret ? NULL : phy;
345 EXPORT_SYMBOL(of_phy_connect);
348 * of_phy_get_and_connect
349 * - Get phy node and connect to the phy described in the device tree
350 * @dev: pointer to net_device claiming the phy
351 * @np: Pointer to device tree node for the net_device claiming the phy
352 * @hndlr: Link state callback for the network device
354 * If successful, returns a pointer to the phy_device with the embedded
355 * struct device refcount incremented by one, or NULL on failure. The
356 * refcount must be dropped by calling phy_disconnect() or phy_detach().
358 struct phy_device *of_phy_get_and_connect(struct net_device *dev,
359 struct device_node *np,
360 void (*hndlr)(struct net_device *))
362 phy_interface_t iface;
363 struct device_node *phy_np;
364 struct phy_device *phy;
366 iface = of_get_phy_mode(np);
370 phy_np = of_parse_phandle(np, "phy-handle", 0);
374 phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);
380 EXPORT_SYMBOL(of_phy_get_and_connect);
383 * of_phy_attach - Attach to a PHY without starting the state machine
384 * @dev: pointer to net_device claiming the phy
385 * @phy_np: Node pointer for the PHY
386 * @flags: flags to pass to the PHY
387 * @iface: PHY data interface type
389 * If successful, returns a pointer to the phy_device with the embedded
390 * struct device refcount incremented by one, or NULL on failure. The
391 * refcount must be dropped by calling phy_disconnect() or phy_detach().
393 struct phy_device *of_phy_attach(struct net_device *dev,
394 struct device_node *phy_np, u32 flags,
395 phy_interface_t iface)
397 struct phy_device *phy = of_phy_find_device(phy_np);
403 ret = phy_attach_direct(dev, phy, flags, iface);
405 /* refcount is held by phy_attach_direct() on success */
406 put_device(&phy->mdio.dev);
408 return ret ? NULL : phy;
410 EXPORT_SYMBOL(of_phy_attach);
413 * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
414 * support two DT bindings:
415 * - the old DT binding, where 'fixed-link' was a property with 5
416 * cells encoding various informations about the fixed PHY
417 * - the new DT binding, where 'fixed-link' is a sub-node of the
420 bool of_phy_is_fixed_link(struct device_node *np)
422 struct device_node *dn;
427 dn = of_get_child_by_name(np, "fixed-link");
433 err = of_property_read_string(np, "managed", &managed);
434 if (err == 0 && strcmp(managed, "auto") != 0)
438 if (of_get_property(np, "fixed-link", &len) &&
439 len == (5 * sizeof(__be32)))
444 EXPORT_SYMBOL(of_phy_is_fixed_link);
446 int of_phy_register_fixed_link(struct device_node *np)
448 struct fixed_phy_status status = {};
449 struct device_node *fixed_link_node;
450 u32 fixed_link_prop[5];
454 if (of_property_read_string(np, "managed", &managed) == 0 &&
455 strcmp(managed, "in-band-status") == 0) {
456 /* status is zeroed, namely its .link member */
461 fixed_link_node = of_get_child_by_name(np, "fixed-link");
462 if (fixed_link_node) {
464 status.duplex = of_property_read_bool(fixed_link_node,
466 if (of_property_read_u32(fixed_link_node, "speed",
468 of_node_put(fixed_link_node);
471 status.pause = of_property_read_bool(fixed_link_node, "pause");
472 status.asym_pause = of_property_read_bool(fixed_link_node,
474 link_gpio = of_get_named_gpio_flags(fixed_link_node,
475 "link-gpios", 0, NULL);
476 of_node_put(fixed_link_node);
477 if (link_gpio == -EPROBE_DEFER)
478 return -EPROBE_DEFER;
484 if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,
485 ARRAY_SIZE(fixed_link_prop)) == 0) {
487 status.duplex = fixed_link_prop[1];
488 status.speed = fixed_link_prop[2];
489 status.pause = fixed_link_prop[3];
490 status.asym_pause = fixed_link_prop[4];
497 return PTR_ERR_OR_ZERO(fixed_phy_register(PHY_POLL, &status, link_gpio,
500 EXPORT_SYMBOL(of_phy_register_fixed_link);
502 void of_phy_deregister_fixed_link(struct device_node *np)
504 struct phy_device *phydev;
506 phydev = of_phy_find_device(np);
510 fixed_phy_unregister(phydev);
512 put_device(&phydev->mdio.dev); /* of_phy_find_device() */
513 phy_device_free(phydev); /* fixed_phy_register() */
515 EXPORT_SYMBOL(of_phy_deregister_fixed_link);