1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * fwnode helpers for the MDIO (Ethernet PHY) API
4 *
5 * This file provides helper functions for extracting PHY device information
6 * out of the fwnode and using it to populate an mii_bus.
7 */
8
9#include <linux/acpi.h>
10#include <linux/fwnode_mdio.h>
11#include <linux/of.h>
12#include <linux/phy.h>
13#include <linux/pse-pd/pse.h>
14
15MODULE_AUTHOR("Calvin Johnson <calvin.johnson@oss.nxp.com>");
16MODULE_LICENSE("GPL");
17MODULE_DESCRIPTION("FWNODE MDIO bus (Ethernet PHY) accessors");
18
19static struct pse_control *
20fwnode_find_pse_control(struct fwnode_handle *fwnode)
21{
22 struct pse_control *psec;
23 struct device_node *np;
24
25 if (!IS_ENABLED(CONFIG_PSE_CONTROLLER))
26 return NULL;
27
28 np = to_of_node(fwnode);
29 if (!np)
30 return NULL;
31
32 psec = of_pse_control_get(node: np);
33 if (PTR_ERR(ptr: psec) == -ENOENT)
34 return NULL;
35
36 return psec;
37}
38
39static struct mii_timestamper *
40fwnode_find_mii_timestamper(struct fwnode_handle *fwnode)
41{
42 struct of_phandle_args arg;
43 int err;
44
45 if (is_acpi_node(fwnode))
46 return NULL;
47
48 err = of_parse_phandle_with_fixed_args(to_of_node(fwnode),
49 list_name: "timestamper", cell_count: 1, index: 0, out_args: &arg);
50 if (err == -ENOENT)
51 return NULL;
52 else if (err)
53 return ERR_PTR(error: err);
54
55 if (arg.args_count != 1)
56 return ERR_PTR(error: -EINVAL);
57
58 return register_mii_timestamper(node: arg.np, port: arg.args[0]);
59}
60
61int fwnode_mdiobus_phy_device_register(struct mii_bus *mdio,
62 struct phy_device *phy,
63 struct fwnode_handle *child, u32 addr)
64{
65 int rc;
66
67 rc = fwnode_irq_get(fwnode: child, index: 0);
68 /* Don't wait forever if the IRQ provider doesn't become available,
69 * just fall back to poll mode
70 */
71 if (rc == -EPROBE_DEFER)
72 rc = driver_deferred_probe_check_state(dev: &phy->mdio.dev);
73 if (rc == -EPROBE_DEFER)
74 return rc;
75
76 if (rc > 0) {
77 phy->irq = rc;
78 mdio->irq[addr] = rc;
79 } else {
80 phy->irq = mdio->irq[addr];
81 }
82
83 if (fwnode_property_read_bool(fwnode: child, propname: "broken-turn-around"))
84 mdio->phy_ignore_ta_mask |= 1 << addr;
85
86 fwnode_property_read_u32(fwnode: child, propname: "reset-assert-us",
87 val: &phy->mdio.reset_assert_delay);
88 fwnode_property_read_u32(fwnode: child, propname: "reset-deassert-us",
89 val: &phy->mdio.reset_deassert_delay);
90
91 /* Associate the fwnode with the device structure so it
92 * can be looked up later
93 */
94 fwnode_handle_get(fwnode: child);
95 device_set_node(dev: &phy->mdio.dev, fwnode: child);
96
97 /* All data is now stored in the phy struct;
98 * register it
99 */
100 rc = phy_device_register(phy);
101 if (rc) {
102 device_set_node(dev: &phy->mdio.dev, NULL);
103 fwnode_handle_put(fwnode: child);
104 return rc;
105 }
106
107 dev_dbg(&mdio->dev, "registered phy %p fwnode at address %i\n",
108 child, addr);
109 return 0;
110}
111EXPORT_SYMBOL(fwnode_mdiobus_phy_device_register);
112
113int fwnode_mdiobus_register_phy(struct mii_bus *bus,
114 struct fwnode_handle *child, u32 addr)
115{
116 struct mii_timestamper *mii_ts = NULL;
117 struct pse_control *psec = NULL;
118 struct phy_device *phy;
119 bool is_c45;
120 u32 phy_id;
121 int rc;
122
123 psec = fwnode_find_pse_control(fwnode: child);
124 if (IS_ERR(ptr: psec))
125 return PTR_ERR(ptr: psec);
126
127 mii_ts = fwnode_find_mii_timestamper(fwnode: child);
128 if (IS_ERR(ptr: mii_ts)) {
129 rc = PTR_ERR(ptr: mii_ts);
130 goto clean_pse;
131 }
132
133 is_c45 = fwnode_device_is_compatible(fwnode: child, compat: "ethernet-phy-ieee802.3-c45");
134 if (is_c45 || fwnode_get_phy_id(fwnode: child, phy_id: &phy_id))
135 phy = get_phy_device(bus, addr, is_c45);
136 else
137 phy = phy_device_create(bus, addr, phy_id, is_c45: 0, NULL);
138 if (IS_ERR(ptr: phy)) {
139 rc = PTR_ERR(ptr: phy);
140 goto clean_mii_ts;
141 }
142
143 if (is_acpi_node(fwnode: child)) {
144 phy->irq = bus->irq[addr];
145
146 /* Associate the fwnode with the device structure so it
147 * can be looked up later.
148 */
149 phy->mdio.dev.fwnode = fwnode_handle_get(fwnode: child);
150
151 /* All data is now stored in the phy struct, so register it */
152 rc = phy_device_register(phy);
153 if (rc) {
154 phy->mdio.dev.fwnode = NULL;
155 fwnode_handle_put(fwnode: child);
156 goto clean_phy;
157 }
158 } else if (is_of_node(fwnode: child)) {
159 rc = fwnode_mdiobus_phy_device_register(bus, phy, child, addr);
160 if (rc)
161 goto clean_phy;
162 }
163
164 phy->psec = psec;
165
166 /* phy->mii_ts may already be defined by the PHY driver. A
167 * mii_timestamper probed via the device tree will still have
168 * precedence.
169 */
170 if (mii_ts)
171 phy->mii_ts = mii_ts;
172
173 return 0;
174
175clean_phy:
176 phy_device_free(phydev: phy);
177clean_mii_ts:
178 unregister_mii_timestamper(mii_ts);
179clean_pse:
180 pse_control_put(psec);
181
182 return rc;
183}
184EXPORT_SYMBOL(fwnode_mdiobus_register_phy);
185

source code of linux/drivers/net/mdio/fwnode_mdio.c