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>
21 #include <linux/phy.h>
29 /* Extract the clause 22 phy ID from the compatible string of the form
30  * ethernet-phy-idAAAA.BBBB */
31 static int of_get_phy_id(struct device_node *device, u32 *phy_id)  in of_get_phy_id()  argument
33 	return fwnode_get_phy_id(of_fwnode_handle(device), phy_id);  in of_get_phy_id()
36 int of_mdiobus_phy_device_register(struct mii_bus *mdio, struct phy_device *phy,  in of_mdiobus_phy_device_register()  argument
39 	return fwnode_mdiobus_phy_device_register(mdio, phy,  in of_mdiobus_phy_device_register()
62 	/* Associate the OF node with the device structure so it  in of_mdiobus_register_device()
66 	device_set_node(&mdiodev->dev, fwnode);  in of_mdiobus_register_device()
71 		device_set_node(&mdiodev->dev, NULL);  in of_mdiobus_register_device()
77 	dev_dbg(&mdio->dev, "registered mdio device %pOFn at address %i\n",  in of_mdiobus_register_device()
82 /* The following is a list of PHY compatible strings which appear in
83  * some DTBs. The compatible string is never matched against a PHY
89 	{ .compatible = "brcm,40nm-ephy" },
99 	{ .compatible = "moxa,moxart-rtl8201cp", },
104  * Return true if the child node is for a phy. It must either:
105  * o Compatible string of "ethernet-phy-idX.X"
106  * o Compatible string of "ethernet-phy-ieee802.3-c45"
107  * o Compatible string of "ethernet-phy-ieee802.3-c22"
111  * A device which is not a phy is expected to have a compatible string
112  * indicating what sort of device it is.
118 	if (of_get_phy_id(child, &phy_id) != -EINVAL)  in of_mdiobus_child_is_phy()
121 	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))  in of_mdiobus_child_is_phy()
124 	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))  in of_mdiobus_child_is_phy()
142  * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
160 		return -ENODEV;  in of_mdiobus_register()
163 	 * the device tree are populated after the bus has been registered */  in of_mdiobus_register()
164 	mdio->phy_mask = ~0;  in of_mdiobus_register()
166 	device_set_node(&mdio->dev, of_fwnode_handle(np));  in of_mdiobus_register()
168 	/* Get bus level PHY reset GPIO details */  in of_mdiobus_register()
169 	mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;  in of_mdiobus_register()
170 	of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);  in of_mdiobus_register()
171 	mdio->reset_post_delay_us = 0;  in of_mdiobus_register()
172 	of_property_read_u32(np, "reset-post-delay-us", &mdio->reset_post_delay_us);  in of_mdiobus_register()
179 	/* Loop over the child nodes and register a phy_device for each phy */  in of_mdiobus_register()
181 		addr = of_mdio_parse_addr(&mdio->dev, child);  in of_mdiobus_register()
192 		if (rc == -ENODEV)  in of_mdiobus_register()
193 			dev_err(&mdio->dev,  in of_mdiobus_register()
194 				"MDIO device at address %d is missing.\n",  in of_mdiobus_register()
215 			dev_info(&mdio->dev, "scan phy %pOFn at address %i\n",  in of_mdiobus_register()
219 				/* -ENODEV is the return code that PHYLIB has  in of_mdiobus_register()
226 				if (rc != -ENODEV)  in of_mdiobus_register()
242  * of_mdio_find_device - Given a device tree node, find the mdio_device
243  * @np: pointer to the mdio_device's device tree node
246  * struct device refcount incremented by one, or NULL on failure.
256  * of_phy_find_device - Give a PHY node, find the phy_device
257  * @phy_np: Pointer to the phy's device tree node
260  * struct device refcount incremented by one, or NULL on failure.
269  * of_phy_connect - Connect to the phy described in the device tree
270  * @dev: pointer to net_device claiming the phy
271  * @phy_np: Pointer to device tree node for the PHY
272  * @hndlr: Link state callback for the network device
273  * @flags: flags to pass to the PHY
274  * @iface: PHY data interface type
277  * struct device refcount incremented by one, or NULL on failure. The
285 	struct phy_device *phy = of_phy_find_device(phy_np);  in of_phy_connect()  local
288 	if (!phy)  in of_phy_connect()
291 	phy->dev_flags |= flags;  in of_phy_connect()
293 	ret = phy_connect_direct(dev, phy, hndlr, iface);  in of_phy_connect()
296 	put_device(&phy->mdio.dev);  in of_phy_connect()
298 	return ret ? NULL : phy;  in of_phy_connect()
304  * - Get phy node and connect to the phy described in the device tree
305  * @dev: pointer to net_device claiming the phy
306  * @np: Pointer to device tree node for the net_device claiming the phy
307  * @hndlr: Link state callback for the network device
310  * struct device refcount incremented by one, or NULL on failure. The
319 	struct phy_device *phy;  in of_phy_get_and_connect()  local
328 			netdev_err(dev, "broken fixed-link specification\n");  in of_phy_get_and_connect()
333 		phy_np = of_parse_phandle(np, "phy-handle", 0);  in of_phy_get_and_connect()
338 	phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);  in of_phy_get_and_connect()
342 	return phy;  in of_phy_get_and_connect()
349  * - the old DT binding, where 'fixed-link' was a property with 5
350  *   cells encoding various information about the fixed PHY
351  * - the new DT binding, where 'fixed-link' is a sub-node of the
352  *   Ethernet device.
361 	dn = of_get_child_by_name(np, "fixed-link");  in of_phy_is_fixed_link()
372 	if (of_get_property(np, "fixed-link", &len) &&  in of_phy_is_fixed_link()
388 	    strcmp(managed, "in-band-status") == 0) {  in of_phy_register_fixed_link()
394 	fixed_link_node = of_get_child_by_name(np, "fixed-link");  in of_phy_register_fixed_link()
398 						      "full-duplex");  in of_phy_register_fixed_link()
402 			return -EINVAL;  in of_phy_register_fixed_link()
406 							  "asym-pause");  in of_phy_register_fixed_link()
413 	if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,  in of_phy_register_fixed_link()
423 	return -ENODEV;  in of_phy_register_fixed_link()
440 	put_device(&phydev->mdio.dev);	/* of_phy_find_device() */  in of_phy_deregister_fixed_link()