1 // SPDX-License-Identifier: GPL-2.0-only
3  * OF helpers for the MDIO (Ethernet PHY) API
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/device.h>
20 #include <linux/phy.h>
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)  in of_get_phy_id()  argument
36 	of_property_for_each_string(device, "compatible", prop, cp) {  in of_get_phy_id()
37 		if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) {  in of_get_phy_id()
42 	return -EINVAL;  in of_get_phy_id()
52 	if (err == -ENOENT)  in of_find_mii_timestamper()
58 		return ERR_PTR(-EINVAL);  in of_find_mii_timestamper()
63 int of_mdiobus_phy_device_register(struct mii_bus *mdio, struct phy_device *phy,  in of_mdiobus_phy_device_register()  argument
69 	if (rc == -EPROBE_DEFER)  in of_mdiobus_phy_device_register()
73 		phy->irq = rc;  in of_mdiobus_phy_device_register()
74 		mdio->irq[addr] = rc;  in of_mdiobus_phy_device_register()
76 		phy->irq = mdio->irq[addr];  in of_mdiobus_phy_device_register()
79 	if (of_property_read_bool(child, "broken-turn-around"))  in of_mdiobus_phy_device_register()
80 		mdio->phy_ignore_ta_mask |= 1 << addr;  in of_mdiobus_phy_device_register()
82 	of_property_read_u32(child, "reset-assert-us",  in of_mdiobus_phy_device_register()
83 			     &phy->mdio.reset_assert_delay);  in of_mdiobus_phy_device_register()
84 	of_property_read_u32(child, "reset-deassert-us",  in of_mdiobus_phy_device_register()
85 			     &phy->mdio.reset_deassert_delay);  in of_mdiobus_phy_device_register()
87 	/* Associate the OF node with the device structure so it  in of_mdiobus_phy_device_register()
90 	phy->mdio.dev.of_node = child;  in of_mdiobus_phy_device_register()
91 	phy->mdio.dev.fwnode = of_fwnode_handle(child);  in of_mdiobus_phy_device_register()
93 	/* All data is now stored in the phy struct;  in of_mdiobus_phy_device_register()
95 	rc = phy_device_register(phy);  in of_mdiobus_phy_device_register()
101 	dev_dbg(&mdio->dev, "registered phy %pOFn at address %i\n",  in of_mdiobus_phy_device_register()
111 	struct phy_device *phy;  in of_mdiobus_register_phy()  local
121 					 "ethernet-phy-ieee802.3-c45");  in of_mdiobus_register_phy()
124 		phy = phy_device_create(mdio, addr, phy_id, 0, NULL);  in of_mdiobus_register_phy()
126 		phy = get_phy_device(mdio, addr, is_c45);  in of_mdiobus_register_phy()
127 	if (IS_ERR(phy)) {  in of_mdiobus_register_phy()
130 		return PTR_ERR(phy);  in of_mdiobus_register_phy()
133 	rc = of_mdiobus_phy_device_register(mdio, phy, child, addr);  in of_mdiobus_register_phy()
137 		phy_device_free(phy);  in of_mdiobus_register_phy()
141 	/* phy->mii_ts may already be defined by the PHY driver. A  in of_mdiobus_register_phy()
142 	 * mii_timestamper probed via the device tree will still have  in of_mdiobus_register_phy()
146 		phy->mii_ts = mii_ts;  in of_mdiobus_register_phy()
162 	/* Associate the OF node with the device structure so it  in of_mdiobus_register_device()
166 	device_set_node(&mdiodev->dev, fwnode);  in of_mdiobus_register_device()
171 		device_set_node(&mdiodev->dev, NULL);  in of_mdiobus_register_device()
177 	dev_dbg(&mdio->dev, "registered mdio device %pOFn at address %i\n",  in of_mdiobus_register_device()
182 /* The following is a list of PHY compatible strings which appear in
183  * some DTBs. The compatible string is never matched against a PHY
189 	{ .compatible = "brcm,40nm-ephy" },
199 	{ .compatible = "moxa,moxart-rtl8201cp", },
204  * Return true if the child node is for a phy. It must either:
205  * o Compatible string of "ethernet-phy-idX.X"
206  * o Compatible string of "ethernet-phy-ieee802.3-c45"
207  * o Compatible string of "ethernet-phy-ieee802.3-c22"
211  * A device which is not a phy is expected to have a compatible string
212  * indicating what sort of device it is.
218 	if (of_get_phy_id(child, &phy_id) != -EINVAL)  in of_mdiobus_child_is_phy()
221 	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))  in of_mdiobus_child_is_phy()
224 	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))  in of_mdiobus_child_is_phy()
242  * __of_mdiobus_register - Register mii_bus and create PHYs from the device tree
262 		return -ENODEV;  in __of_mdiobus_register()
265 	 * the device tree are populated after the bus has been registered */  in __of_mdiobus_register()
266 	mdio->phy_mask = ~0;  in __of_mdiobus_register()
268 	device_set_node(&mdio->dev, of_fwnode_handle(np));  in __of_mdiobus_register()
270 	/* Get bus level PHY reset GPIO details */  in __of_mdiobus_register()
271 	mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;  in __of_mdiobus_register()
272 	of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);  in __of_mdiobus_register()
273 	mdio->reset_post_delay_us = 0;  in __of_mdiobus_register()
274 	of_property_read_u32(np, "reset-post-delay-us", &mdio->reset_post_delay_us);  in __of_mdiobus_register()
281 	/* Loop over the child nodes and register a phy_device for each phy */  in __of_mdiobus_register()
283 		addr = of_mdio_parse_addr(&mdio->dev, child);  in __of_mdiobus_register()
294 		if (rc == -ENODEV)  in __of_mdiobus_register()
295 			dev_err(&mdio->dev,  in __of_mdiobus_register()
296 				"MDIO device at address %d is missing.\n",  in __of_mdiobus_register()
317 			dev_info(&mdio->dev, "scan phy %pOFn at address %i\n",  in __of_mdiobus_register()
321 				/* -ENODEV is the return code that PHYLIB has  in __of_mdiobus_register()
328 				if (rc != -ENODEV)  in __of_mdiobus_register()
344  * of_mdio_find_device - Given a device tree node, find the mdio_device
345  * @np: pointer to the mdio_device's device tree node
348  * struct device refcount incremented by one, or NULL on failure.
353 	struct device *d;  in of_mdio_find_device()
367  * of_phy_find_device - Give a PHY node, find the phy_device
368  * @phy_np: Pointer to the phy's device tree node
371  * struct device refcount incremented by one, or NULL on failure.
381 	if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)  in of_phy_find_device()
382 		return to_phy_device(&mdiodev->dev);  in of_phy_find_device()
384 	put_device(&mdiodev->dev);  in of_phy_find_device()
391  * of_phy_connect - Connect to the phy described in the device tree
392  * @dev: pointer to net_device claiming the phy
393  * @phy_np: Pointer to device tree node for the PHY
394  * @hndlr: Link state callback for the network device
395  * @flags: flags to pass to the PHY
396  * @iface: PHY data interface type
399  * struct device refcount incremented by one, or NULL on failure. The
407 	struct phy_device *phy = of_phy_find_device(phy_np);  in of_phy_connect()  local
410 	if (!phy)  in of_phy_connect()
413 	phy->dev_flags |= flags;  in of_phy_connect()
415 	ret = phy_connect_direct(dev, phy, hndlr, iface);  in of_phy_connect()
418 	put_device(&phy->mdio.dev);  in of_phy_connect()
420 	return ret ? NULL : phy;  in of_phy_connect()
426  * - Get phy node and connect to the phy described in the device tree
427  * @dev: pointer to net_device claiming the phy
428  * @np: Pointer to device tree node for the net_device claiming the phy
429  * @hndlr: Link state callback for the network device
432  * struct device refcount incremented by one, or NULL on failure. The
441 	struct phy_device *phy;  in of_phy_get_and_connect()  local
450 			netdev_err(dev, "broken fixed-link specification\n");  in of_phy_get_and_connect()
455 		phy_np = of_parse_phandle(np, "phy-handle", 0);  in of_phy_get_and_connect()
460 	phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);  in of_phy_get_and_connect()
464 	return phy;  in of_phy_get_and_connect()
469  * of_phy_attach - Attach to a PHY without starting the state machine
470  * @dev: pointer to net_device claiming the phy
471  * @phy_np: Node pointer for the PHY
472  * @flags: flags to pass to the PHY
473  * @iface: PHY data interface type
476  * struct device refcount incremented by one, or NULL on failure. The
483 	struct phy_device *phy = of_phy_find_device(phy_np);  in of_phy_attach()  local
486 	if (!phy)  in of_phy_attach()
489 	ret = phy_attach_direct(dev, phy, flags, iface);  in of_phy_attach()
492 	put_device(&phy->mdio.dev);  in of_phy_attach()
494 	return ret ? NULL : phy;  in of_phy_attach()
501  * - the old DT binding, where 'fixed-link' was a property with 5
502  *   cells encoding various informations about the fixed PHY
503  * - the new DT binding, where 'fixed-link' is a sub-node of the
504  *   Ethernet device.
513 	dn = of_get_child_by_name(np, "fixed-link");  in of_phy_is_fixed_link()
524 	if (of_get_property(np, "fixed-link", &len) &&  in of_phy_is_fixed_link()
540 	    strcmp(managed, "in-band-status") == 0) {  in of_phy_register_fixed_link()
546 	fixed_link_node = of_get_child_by_name(np, "fixed-link");  in of_phy_register_fixed_link()
550 						      "full-duplex");  in of_phy_register_fixed_link()
554 			return -EINVAL;  in of_phy_register_fixed_link()
558 							  "asym-pause");  in of_phy_register_fixed_link()
565 	if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,  in of_phy_register_fixed_link()
575 	return -ENODEV;  in of_phy_register_fixed_link()
592 	put_device(&phydev->mdio.dev);	/* of_phy_find_device() */  in of_phy_deregister_fixed_link()