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.
12 #include <linux/device.h>
15 #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()
48 	struct phy_device *phy;  in of_mdiobus_register_phy()  local
54 					 "ethernet-phy-ieee802.3-c45");  in of_mdiobus_register_phy()
57 		phy = phy_device_create(mdio, addr, phy_id, 0, NULL);  in of_mdiobus_register_phy()
59 		phy = get_phy_device(mdio, addr, is_c45);  in of_mdiobus_register_phy()
60 	if (IS_ERR(phy))  in of_mdiobus_register_phy()
61 		return PTR_ERR(phy);  in of_mdiobus_register_phy()
64 	if (rc == -EPROBE_DEFER) {  in of_mdiobus_register_phy()
65 		phy_device_free(phy);  in of_mdiobus_register_phy()
69 		phy->irq = rc;  in of_mdiobus_register_phy()
70 		mdio->irq[addr] = rc;  in of_mdiobus_register_phy()
72 		phy->irq = mdio->irq[addr];  in of_mdiobus_register_phy()
75 	if (of_property_read_bool(child, "broken-turn-around"))  in of_mdiobus_register_phy()
76 		mdio->phy_ignore_ta_mask |= 1 << addr;  in of_mdiobus_register_phy()
78 	of_property_read_u32(child, "reset-assert-us",  in of_mdiobus_register_phy()
79 			     &phy->mdio.reset_assert_delay);  in of_mdiobus_register_phy()
80 	of_property_read_u32(child, "reset-deassert-us",  in of_mdiobus_register_phy()
81 			     &phy->mdio.reset_deassert_delay);  in of_mdiobus_register_phy()
83 	/* Associate the OF node with the device structure so it  in of_mdiobus_register_phy()
86 	phy->mdio.dev.of_node = child;  in of_mdiobus_register_phy()
87 	phy->mdio.dev.fwnode = of_fwnode_handle(child);  in of_mdiobus_register_phy()
89 	/* All data is now stored in the phy struct;  in of_mdiobus_register_phy()
91 	rc = phy_device_register(phy);  in of_mdiobus_register_phy()
93 		phy_device_free(phy);  in of_mdiobus_register_phy()
98 	dev_dbg(&mdio->dev, "registered phy %pOFn at address %i\n",  in of_mdiobus_register_phy()
113 	/* Associate the OF node with the device structure so it  in of_mdiobus_register_device()
117 	mdiodev->dev.of_node = child;  in of_mdiobus_register_device()
118 	mdiodev->dev.fwnode = of_fwnode_handle(child);  in of_mdiobus_register_device()
128 	dev_dbg(&mdio->dev, "registered mdio device %pOFn at address %i\n",  in of_mdiobus_register_device()
133 /* The following is a list of PHY compatible strings which appear in
134  * some DTBs. The compatible string is never matched against a PHY
140 	{ .compatible = "brcm,40nm-ephy" },
150 	{ .compatible = "moxa,moxart-rtl8201cp", },
155  * Return true if the child node is for a phy. It must either:
156  * o Compatible string of "ethernet-phy-idX.X"
157  * o Compatible string of "ethernet-phy-ieee802.3-c45"
158  * o Compatible string of "ethernet-phy-ieee802.3-c22"
162  * A device which is not a phy is expected to have a compatible string
163  * indicating what sort of device it is.
169 	if (of_get_phy_id(child, &phy_id) != -EINVAL)  in of_mdiobus_child_is_phy()
172 	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45"))  in of_mdiobus_child_is_phy()
175 	if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22"))  in of_mdiobus_child_is_phy()
192  * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
210 		return -ENODEV;  in of_mdiobus_register()
213 	 * the device tree are populated after the bus has been registered */  in of_mdiobus_register()
214 	mdio->phy_mask = ~0;  in of_mdiobus_register()
216 	mdio->dev.of_node = np;  in of_mdiobus_register()
217 	mdio->dev.fwnode = of_fwnode_handle(np);  in of_mdiobus_register()
219 	/* Get bus level PHY reset GPIO details */  in of_mdiobus_register()
220 	mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;  in of_mdiobus_register()
221 	of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);  in of_mdiobus_register()
228 	/* Loop over the child nodes and register a phy_device for each phy */  in of_mdiobus_register()
230 		addr = of_mdio_parse_addr(&mdio->dev, child);  in of_mdiobus_register()
241 		if (rc == -ENODEV)  in of_mdiobus_register()
242 			dev_err(&mdio->dev,  in of_mdiobus_register()
243 				"MDIO device at address %d is missing.\n",  in of_mdiobus_register()
264 			dev_info(&mdio->dev, "scan phy %pOFn at address %i\n",  in of_mdiobus_register()
269 				if (rc && rc != -ENODEV)  in of_mdiobus_register()
284  * of_phy_find_device - Give a PHY node, find the phy_device
285  * @phy_np: Pointer to the phy's device tree node
288  * struct device refcount incremented by one, or NULL on failure.
292 	struct device *d;  in of_phy_find_device()
301 		if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)  in of_phy_find_device()
311  * of_phy_connect - Connect to the phy described in the device tree
312  * @dev: pointer to net_device claiming the phy
313  * @phy_np: Pointer to device tree node for the PHY
314  * @hndlr: Link state callback for the network device
315  * @flags: flags to pass to the PHY
316  * @iface: PHY data interface type
319  * struct device refcount incremented by one, or NULL on failure. The
327 	struct phy_device *phy = of_phy_find_device(phy_np);  in of_phy_connect()  local
330 	if (!phy)  in of_phy_connect()
333 	phy->dev_flags = flags;  in of_phy_connect()
335 	ret = phy_connect_direct(dev, phy, hndlr, iface);  in of_phy_connect()
338 	put_device(&phy->mdio.dev);  in of_phy_connect()
340 	return ret ? NULL : phy;  in of_phy_connect()
346  * - Get phy node and connect to the phy described in the device tree
347  * @dev: pointer to net_device claiming the phy
348  * @np: Pointer to device tree node for the net_device claiming the phy
349  * @hndlr: Link state callback for the network device
352  * struct device refcount incremented by one, or NULL on failure. The
361 	struct phy_device *phy;  in of_phy_get_and_connect()  local
370 			netdev_err(dev, "broken fixed-link specification\n");  in of_phy_get_and_connect()
375 		phy_np = of_parse_phandle(np, "phy-handle", 0);  in of_phy_get_and_connect()
380 	phy = of_phy_connect(dev, phy_np, hndlr, 0, iface);  in of_phy_get_and_connect()
384 	return phy;  in of_phy_get_and_connect()
389  * of_phy_attach - Attach to a PHY without starting the state machine
390  * @dev: pointer to net_device claiming the phy
391  * @phy_np: Node pointer for the PHY
392  * @flags: flags to pass to the PHY
393  * @iface: PHY data interface type
396  * struct device refcount incremented by one, or NULL on failure. The
403 	struct phy_device *phy = of_phy_find_device(phy_np);  in of_phy_attach()  local
406 	if (!phy)  in of_phy_attach()
409 	ret = phy_attach_direct(dev, phy, flags, iface);  in of_phy_attach()
412 	put_device(&phy->mdio.dev);  in of_phy_attach()
414 	return ret ? NULL : phy;  in of_phy_attach()
421  * - the old DT binding, where 'fixed-link' was a property with 5
422  *   cells encoding various informations about the fixed PHY
423  * - the new DT binding, where 'fixed-link' is a sub-node of the
424  *   Ethernet device.
433 	dn = of_get_child_by_name(np, "fixed-link");  in of_phy_is_fixed_link()
444 	if (of_get_property(np, "fixed-link", &len) &&  in of_phy_is_fixed_link()
460 	    strcmp(managed, "in-band-status") == 0) {  in of_phy_register_fixed_link()
466 	fixed_link_node = of_get_child_by_name(np, "fixed-link");  in of_phy_register_fixed_link()
470 						      "full-duplex");  in of_phy_register_fixed_link()
474 			return -EINVAL;  in of_phy_register_fixed_link()
478 							  "asym-pause");  in of_phy_register_fixed_link()
485 	if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop,  in of_phy_register_fixed_link()
495 	return -ENODEV;  in of_phy_register_fixed_link()
512 	put_device(&phydev->mdio.dev);	/* of_phy_find_device() */  in of_phy_deregister_fixed_link()