1 // SPDX-License-Identifier: GPL-2.0-only
3 * OF helpers for the MDIO (Ethernet PHY) API
5 * Copyright (c) 2009 Secret Lab Technologies, Ltd.
7 * This file provides helper functions for extracting PHY device information
8 * out of the OpenFirmware device tree and using it to populate an mii_bus.
11 #include <linux/kernel.h>
12 #include <linux/device.h>
13 #include <linux/netdevice.h>
14 #include <linux/err.h>
15 #include <linux/phy.h>
16 #include <linux/phy_fixed.h>
18 #include <linux/of_irq.h>
19 #include <linux/of_mdio.h>
20 #include <linux/of_net.h>
21 #include <linux/module.h>
23 #define DEFAULT_GPIO_RESET_DELAY 10 /* in microseconds */
25 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
26 MODULE_LICENSE("GPL");
28 /* Extract the clause 22 phy ID from the compatible string of the form
29 * ethernet-phy-idAAAA.BBBB */
30 static int of_get_phy_id(struct device_node *device, u32 *phy_id)
32 struct property *prop;
34 unsigned int upper, lower;
36 of_property_for_each_string(device, "compatible", prop, cp) {
37 if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {
38 *phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF);
45 static struct mii_timestamper *of_find_mii_timestamper(struct device_node *node)
47 struct of_phandle_args arg;
50 err = of_parse_phandle_with_fixed_args(node, "timestamper", 1, 0, &arg);
57 if (arg.args_count != 1)
58 return ERR_PTR(-EINVAL);
60 return register_mii_timestamper(arg.np, arg.args[0]);
63 static int of_mdiobus_register_phy(struct mii_bus *mdio,
64 struct device_node *child, u32 addr)
66 struct mii_timestamper *mii_ts;
67 struct phy_device *phy;
72 mii_ts = of_find_mii_timestamper(child);
74 return PTR_ERR(mii_ts);
76 is_c45 = of_device_is_compatible(child,
77 "ethernet-phy-ieee802.3-c45");
79 if (!is_c45 && !of_get_phy_id(child, &phy_id))
80 phy = phy_device_create(mdio, addr, phy_id, 0, NULL);
82 phy = get_phy_device(mdio, addr, is_c45);
85 unregister_mii_timestamper(mii_ts);
89 rc = of_irq_get(child, 0);
90 if (rc == -EPROBE_DEFER) {
92 unregister_mii_timestamper(mii_ts);
100 phy->irq = mdio->irq[addr];
103 if (of_property_read_bool(child, "broken-turn-around"))
104 mdio->phy_ignore_ta_mask |= 1 << addr;
106 of_property_read_u32(child, "reset-assert-us",
107 &phy->mdio.reset_assert_delay);
108 of_property_read_u32(child, "reset-deassert-us",
109 &phy->mdio.reset_deassert_delay);
111 /* Associate the OF node with the device structure so it
112 * can be looked up later */
114 phy->mdio.dev.of_node = child;
115 phy->mdio.dev.fwnode = of_fwnode_handle(child);
117 /* All data is now stored in the phy struct;
119 rc = phy_device_register(phy);
122 unregister_mii_timestamper(mii_ts);
123 phy_device_free(phy);
128 /* phy->mii_ts may already be defined by the PHY driver. A
129 * mii_timestamper probed via the device tree will still have
133 phy->mii_ts = mii_ts;
135 dev_dbg(&mdio->dev, "registered phy %pOFn at address %i\n",
140 static int of_mdiobus_register_device(struct mii_bus *mdio,
141 struct device_node *child, u32 addr)
143 struct mdio_device *mdiodev;
146 mdiodev = mdio_device_create(mdio, addr);
148 return PTR_ERR(mdiodev);
150 /* Associate the OF node with the device structure so it
151 * can be looked up later.
154 mdiodev->dev.of_node = child;
155 mdiodev->dev.fwnode = of_fwnode_handle(child);
157 /* All data is now stored in the mdiodev struct; register it. */
158 rc = mdio_device_register(mdiodev);
160 mdio_device_free(mdiodev);
165 dev_dbg(&mdio->dev, "registered mdio device %pOFn at address %i\n",
170 /* The following is a list of PHY compatible strings which appear in
171 * some DTBs. The compatible string is never matched against a PHY
172 * driver, so is pointless. We only expect devices which are not PHYs
173 * to have a compatible string, so they can be matched to an MDIO
174 * driver. Encourage users to upgrade their DT blobs to remove these.
176 static const struct of_device_id whitelist_phys[] = {
177 { .compatible = "brcm,40nm-ephy" },
178 { .compatible = "broadcom,bcm5241" },
179 { .compatible = "marvell,88E1111", },
180 { .compatible = "marvell,88e1116", },
181 { .compatible = "marvell,88e1118", },
182 { .compatible = "marvell,88e1145", },
183 { .compatible = "marvell,88e1149r", },
184 { .compatible = "marvell,88e1310", },
185 { .compatible = "marvell,88E1510", },
186 { .compatible = "marvell,88E1514", },
187 { .compatible = "moxa,moxart-rtl8201cp", },
192 * Return true if the child node is for a phy. It must either:
193 * o Compatible string of "ethernet-phy-idX.X"
194 * o Compatible string of "ethernet-phy-ieee802.3-c45"
195 * o Compatible string of "ethernet-phy-ieee802.3-c22"
196 * o In the white list above (and issue a warning)
197 * o No compatibility string
199 * A device which is not a phy is expected to have a compatible string
200 * indicating what sort of device it is.
202 bool of_mdiobus_child_is_phy(struct device_node *child)
206 if (of_get_phy_id(child, &phy_id) != -EINVAL)
209 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))
212 if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))
215 if (of_match_node(whitelist_phys, child)) {
217 "%pOF: Whitelisted compatible string. Please remove\n",
222 if (!of_find_property(child, "compatible", NULL))
227 EXPORT_SYMBOL(of_mdiobus_child_is_phy);
230 * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
231 * @mdio: pointer to mii_bus structure
232 * @np: pointer to device_node of MDIO bus.
234 * This function registers the mii_bus structure and registers a phy_device
235 * for each child node of @np.
237 int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
239 struct device_node *child;
240 bool scanphys = false;
244 return mdiobus_register(mdio);
246 /* Do not continue if the node is disabled */
247 if (!of_device_is_available(np))
250 /* Mask out all PHYs from auto probing. Instead the PHYs listed in
251 * the device tree are populated after the bus has been registered */
254 mdio->dev.of_node = np;
255 mdio->dev.fwnode = of_fwnode_handle(np);
257 /* Get bus level PHY reset GPIO details */
258 mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;
259 of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);
261 /* Register the MDIO bus */
262 rc = mdiobus_register(mdio);
266 /* Loop over the child nodes and register a phy_device for each phy */
267 for_each_available_child_of_node(np, child) {
268 addr = of_mdio_parse_addr(&mdio->dev, child);
274 if (of_mdiobus_child_is_phy(child))
275 rc = of_mdiobus_register_phy(mdio, child, addr);
277 rc = of_mdiobus_register_device(mdio, child, addr);
281 "MDIO device at address %d is missing.\n",
290 /* auto scan for PHYs with empty reg property */
291 for_each_available_child_of_node(np, child) {
292 /* Skip PHYs with reg property set */
293 if (of_find_property(child, "reg", NULL))
296 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
297 /* skip already registered PHYs */
298 if (mdiobus_is_registered_device(mdio, addr))
301 /* be noisy to encourage people to set reg property */
302 dev_info(&mdio->dev, "scan phy %pOFn at address %i\n",
305 if (of_mdiobus_child_is_phy(child)) {
306 rc = of_mdiobus_register_phy(mdio, child, addr);
307 if (rc && rc != -ENODEV)
316 mdiobus_unregister(mdio);
319 EXPORT_SYMBOL(of_mdiobus_register);
322 * of_phy_find_device - Give a PHY node, find the phy_device
323 * @phy_np: Pointer to the phy's device tree node
325 * If successful, returns a pointer to the phy_device with the embedded
326 * struct device refcount incremented by one, or NULL on failure.
328 struct phy_device *of_phy_find_device(struct device_node *phy_np)
331 struct mdio_device *mdiodev;
336 d = bus_find_device_by_of_node(&mdio_bus_type, phy_np);
338 mdiodev = to_mdio_device(d);
339 if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
340 return to_phy_device(d);
346 EXPORT_SYMBOL(of_phy_find_device);
349 * of_phy_connect - Connect to the phy described in the device tree
350 * @dev: pointer to net_device claiming the phy
351 * @phy_np: Pointer to device tree node for the PHY
352 * @hndlr: Link state callback for the network device
353 * @flags: flags to pass to the PHY
354 * @iface: PHY data interface type
356 * If successful, returns a pointer to the phy_device with the embedded
357 * struct device refcount incremented by one, or NULL on failure. The
358 * refcount must be dropped by calling phy_disconnect() or phy_detach().
360 struct phy_device *of_phy_connect(struct net_device *dev,
361 struct device_node *phy_np,
362 void (*hndlr)(struct net_device *), u32 flags,
363 phy_interface_t iface)
365 struct phy_device *phy = of_phy_find_device(phy_np);
371 phy->dev_flags = flags;
373 ret = phy_connect_direct(dev, phy, hndlr, iface);
375 /* refcount is held by phy_connect_direct() on success */
376 put_device(&phy->mdio.dev);
378 return ret ? NULL : phy;
380 EXPORT_SYMBOL(of_phy_connect);
383 * of_phy_get_and_connect
384 * - Get phy node and connect to the phy described in the device tree
385 * @dev: pointer to net_device claiming the phy
386 * @np: Pointer to device tree node for the net_device claiming the phy
387 * @hndlr: Link state callback for the network device
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_get_and_connect(struct net_device *dev,
394 struct device_node *np,
395 void (*hndlr)(struct net_device *))
397 phy_interface_t iface;
398 struct device_node *phy_np;
399 struct phy_device *phy;
402 ret = of_get_phy_mode(np, &iface);
405 if (of_phy_is_fixed_link(np)) {
406 ret = of_phy_register_fixed_link(np);
408 netdev_err(dev, "broken fixed-link specification\n");
411 phy_np = of_node_get(np);
413 phy_np = of_parse_phandle(np, "phy-handle", 0);
418 phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);
424 EXPORT_SYMBOL(of_phy_get_and_connect);
427 * of_phy_attach - Attach to a PHY without starting the state machine
428 * @dev: pointer to net_device claiming the phy
429 * @phy_np: Node pointer for the PHY
430 * @flags: flags to pass to the PHY
431 * @iface: PHY data interface type
433 * If successful, returns a pointer to the phy_device with the embedded
434 * struct device refcount incremented by one, or NULL on failure. The
435 * refcount must be dropped by calling phy_disconnect() or phy_detach().
437 struct phy_device *of_phy_attach(struct net_device *dev,
438 struct device_node *phy_np, u32 flags,
439 phy_interface_t iface)
441 struct phy_device *phy = of_phy_find_device(phy_np);
447 ret = phy_attach_direct(dev, phy, flags, iface);
449 /* refcount is held by phy_attach_direct() on success */
450 put_device(&phy->mdio.dev);
452 return ret ? NULL : phy;
454 EXPORT_SYMBOL(of_phy_attach);
457 * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
458 * support two DT bindings:
459 * - the old DT binding, where 'fixed-link' was a property with 5
460 * cells encoding various informations about the fixed PHY
461 * - the new DT binding, where 'fixed-link' is a sub-node of the
464 bool of_phy_is_fixed_link(struct device_node *np)
466 struct device_node *dn;
471 dn = of_get_child_by_name(np, "fixed-link");
477 err = of_property_read_string(np, "managed", &managed);
478 if (err == 0 && strcmp(managed, "auto") != 0)
482 if (of_get_property(np, "fixed-link", &len) &&
483 len == (5 * sizeof(__be32)))
488 EXPORT_SYMBOL(of_phy_is_fixed_link);
490 int of_phy_register_fixed_link(struct device_node *np)
492 struct fixed_phy_status status = {};
493 struct device_node *fixed_link_node;
494 u32 fixed_link_prop[5];
497 if (of_property_read_string(np, "managed", &managed) == 0 &&
498 strcmp(managed, "in-band-status") == 0) {
499 /* status is zeroed, namely its .link member */
504 fixed_link_node = of_get_child_by_name(np, "fixed-link");
505 if (fixed_link_node) {
507 status.duplex = of_property_read_bool(fixed_link_node,
509 if (of_property_read_u32(fixed_link_node, "speed",
511 of_node_put(fixed_link_node);
514 status.pause = of_property_read_bool(fixed_link_node, "pause");
515 status.asym_pause = of_property_read_bool(fixed_link_node,
517 of_node_put(fixed_link_node);
523 if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,
524 ARRAY_SIZE(fixed_link_prop)) == 0) {
526 status.duplex = fixed_link_prop[1];
527 status.speed = fixed_link_prop[2];
528 status.pause = fixed_link_prop[3];
529 status.asym_pause = fixed_link_prop[4];
536 return PTR_ERR_OR_ZERO(fixed_phy_register(PHY_POLL, &status, np));
538 EXPORT_SYMBOL(of_phy_register_fixed_link);
540 void of_phy_deregister_fixed_link(struct device_node *np)
542 struct phy_device *phydev;
544 phydev = of_phy_find_device(np);
548 fixed_phy_unregister(phydev);
550 put_device(&phydev->mdio.dev); /* of_phy_find_device() */
551 phy_device_free(phydev); /* fixed_phy_register() */
553 EXPORT_SYMBOL(of_phy_deregister_fixed_link);