]>
Commit | Line | Data |
---|---|---|
8bc487d1 GL |
1 | /* |
2 | * OF helpers for the MDIO (Ethernet PHY) API | |
3 | * | |
4 | * Copyright (c) 2009 Secret Lab Technologies, Ltd. | |
5 | * | |
6 | * This file is released under the GPLv2 | |
7 | * | |
8 | * This file provides helper functions for extracting PHY device information | |
9 | * out of the OpenFirmware device tree and using it to populate an mii_bus. | |
10 | */ | |
11 | ||
24c30dbb AV |
12 | #include <linux/kernel.h> |
13 | #include <linux/device.h> | |
14 | #include <linux/netdevice.h> | |
15 | #include <linux/err.h> | |
8bc487d1 | 16 | #include <linux/phy.h> |
3be2a49e | 17 | #include <linux/phy_fixed.h> |
8bc487d1 | 18 | #include <linux/of.h> |
a5597008 | 19 | #include <linux/of_gpio.h> |
e3873444 | 20 | #include <linux/of_irq.h> |
8bc487d1 GL |
21 | #include <linux/of_mdio.h> |
22 | #include <linux/module.h> | |
23 | ||
24 | MODULE_AUTHOR("Grant Likely <[email protected]>"); | |
25 | MODULE_LICENSE("GPL"); | |
26 | ||
3c6f5592 JG |
27 | /* Extract the clause 22 phy ID from the compatible string of the form |
28 | * ethernet-phy-idAAAA.BBBB */ | |
29 | static int of_get_phy_id(struct device_node *device, u32 *phy_id) | |
30 | { | |
31 | struct property *prop; | |
32 | const char *cp; | |
33 | unsigned int upper, lower; | |
34 | ||
35 | of_property_for_each_string(device, "compatible", prop, cp) { | |
36 | if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) { | |
37 | *phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF); | |
38 | return 0; | |
39 | } | |
40 | } | |
41 | return -EINVAL; | |
42 | } | |
43 | ||
2e79cb30 FF |
44 | static int of_mdiobus_register_phy(struct mii_bus *mdio, struct device_node *child, |
45 | u32 addr) | |
46 | { | |
47 | struct phy_device *phy; | |
48 | bool is_c45; | |
f15c586d | 49 | int rc; |
3c6f5592 | 50 | u32 phy_id; |
2e79cb30 FF |
51 | |
52 | is_c45 = of_device_is_compatible(child, | |
53 | "ethernet-phy-ieee802.3-c45"); | |
54 | ||
3c6f5592 JG |
55 | if (!is_c45 && !of_get_phy_id(child, &phy_id)) |
56 | phy = phy_device_create(mdio, addr, phy_id, 0, NULL); | |
57 | else | |
58 | phy = get_phy_device(mdio, addr, is_c45); | |
2e79cb30 FF |
59 | if (!phy || IS_ERR(phy)) |
60 | return 1; | |
61 | ||
f15c586d BD |
62 | rc = irq_of_parse_and_map(child, 0); |
63 | if (rc > 0) { | |
64 | phy->irq = rc; | |
1bc16add | 65 | mdio->irq[addr] = rc; |
f15c586d | 66 | } else { |
1bc16add | 67 | phy->irq = mdio->irq[addr]; |
2e79cb30 FF |
68 | } |
69 | ||
ab6016e0 FF |
70 | if (of_property_read_bool(child, "broken-turn-around")) |
71 | mdio->phy_ignore_ta_mask |= 1 << addr; | |
72 | ||
2e79cb30 FF |
73 | /* Associate the OF node with the device structure so it |
74 | * can be looked up later */ | |
75 | of_node_get(child); | |
e5a03bfd | 76 | phy->mdio.dev.of_node = child; |
2e79cb30 FF |
77 | |
78 | /* All data is now stored in the phy struct; | |
79 | * register it */ | |
80 | rc = phy_device_register(phy); | |
81 | if (rc) { | |
82 | phy_device_free(phy); | |
83 | of_node_put(child); | |
84 | return 1; | |
85 | } | |
86 | ||
87 | dev_dbg(&mdio->dev, "registered phy %s at address %i\n", | |
8fdade4b | 88 | child->name, addr); |
2e79cb30 FF |
89 | |
90 | return 0; | |
91 | } | |
92 | ||
a9049e0c AL |
93 | static int of_mdiobus_register_device(struct mii_bus *mdio, |
94 | struct device_node *child, | |
95 | u32 addr) | |
96 | { | |
97 | struct mdio_device *mdiodev; | |
98 | int rc; | |
99 | ||
100 | mdiodev = mdio_device_create(mdio, addr); | |
101 | if (!mdiodev || IS_ERR(mdiodev)) | |
102 | return 1; | |
103 | ||
104 | /* Associate the OF node with the device structure so it | |
105 | * can be looked up later. | |
106 | */ | |
107 | of_node_get(child); | |
108 | mdiodev->dev.of_node = child; | |
109 | ||
110 | /* All data is now stored in the mdiodev struct; register it. */ | |
111 | rc = mdio_device_register(mdiodev); | |
112 | if (rc) { | |
113 | mdio_device_free(mdiodev); | |
114 | of_node_put(child); | |
115 | return 1; | |
116 | } | |
117 | ||
118 | dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n", | |
119 | child->name, addr); | |
120 | ||
121 | return 0; | |
122 | } | |
123 | ||
33d67377 | 124 | int of_mdio_parse_addr(struct device *dev, const struct device_node *np) |
8f838288 DM |
125 | { |
126 | u32 addr; | |
127 | int ret; | |
128 | ||
129 | ret = of_property_read_u32(np, "reg", &addr); | |
130 | if (ret < 0) { | |
131 | dev_err(dev, "%s has invalid PHY address\n", np->full_name); | |
132 | return ret; | |
133 | } | |
134 | ||
135 | /* A PHY must have a reg property in the range [0-31] */ | |
136 | if (addr >= PHY_MAX_ADDR) { | |
137 | dev_err(dev, "%s PHY address %i is too large\n", | |
138 | np->full_name, addr); | |
139 | return -EINVAL; | |
140 | } | |
141 | ||
142 | return addr; | |
143 | } | |
33d67377 | 144 | EXPORT_SYMBOL(of_mdio_parse_addr); |
8f838288 | 145 | |
801a8ef5 AL |
146 | /* |
147 | * Return true if the child node is for a phy. It must either: | |
148 | * o Compatible string of "ethernet-phy-idX.X" | |
149 | * o Compatible string of "ethernet-phy-ieee802.3-c45" | |
150 | * o Compatible string of "ethernet-phy-ieee802.3-c22" | |
151 | * o No compatibility string | |
152 | * | |
153 | * A device which is not a phy is expected to have a compatible string | |
154 | * indicating what sort of device it is. | |
155 | */ | |
156 | static bool of_mdiobus_child_is_phy(struct device_node *child) | |
157 | { | |
158 | u32 phy_id; | |
159 | ||
160 | if (of_get_phy_id(child, &phy_id) != -EINVAL) | |
161 | return true; | |
162 | ||
163 | if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45")) | |
164 | return true; | |
165 | ||
166 | if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22")) | |
167 | return true; | |
168 | ||
169 | if (!of_find_property(child, "compatible", NULL)) | |
170 | return true; | |
171 | ||
172 | return false; | |
173 | } | |
174 | ||
8bc487d1 GL |
175 | /** |
176 | * of_mdiobus_register - Register mii_bus and create PHYs from the device tree | |
177 | * @mdio: pointer to mii_bus structure | |
178 | * @np: pointer to device_node of MDIO bus. | |
179 | * | |
180 | * This function registers the mii_bus structure and registers a phy_device | |
181 | * for each child node of @np. | |
182 | */ | |
183 | int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np) | |
184 | { | |
8bc487d1 | 185 | struct device_node *child; |
779d835e | 186 | const __be32 *paddr; |
2e79cb30 | 187 | bool scanphys = false; |
e7f4dc35 | 188 | int addr, rc; |
8bc487d1 GL |
189 | |
190 | /* Mask out all PHYs from auto probing. Instead the PHYs listed in | |
191 | * the device tree are populated after the bus has been registered */ | |
192 | mdio->phy_mask = ~0; | |
193 | ||
25106022 DD |
194 | mdio->dev.of_node = np; |
195 | ||
8bc487d1 GL |
196 | /* Register the MDIO bus */ |
197 | rc = mdiobus_register(mdio); | |
198 | if (rc) | |
199 | return rc; | |
200 | ||
801a8ef5 | 201 | /* Loop over the child nodes and register a phy_device for each phy */ |
e207e761 | 202 | for_each_available_child_of_node(np, child) { |
8f838288 DM |
203 | addr = of_mdio_parse_addr(&mdio->dev, child); |
204 | if (addr < 0) { | |
779d835e | 205 | scanphys = true; |
19458860 DD |
206 | continue; |
207 | } | |
208 | ||
801a8ef5 AL |
209 | if (of_mdiobus_child_is_phy(child)) |
210 | of_mdiobus_register_phy(mdio, child, addr); | |
a9049e0c AL |
211 | else |
212 | of_mdiobus_register_device(mdio, child, addr); | |
8bc487d1 GL |
213 | } |
214 | ||
779d835e SH |
215 | if (!scanphys) |
216 | return 0; | |
217 | ||
218 | /* auto scan for PHYs with empty reg property */ | |
219 | for_each_available_child_of_node(np, child) { | |
220 | /* Skip PHYs with reg property set */ | |
24f28dde | 221 | paddr = of_get_property(child, "reg", NULL); |
779d835e SH |
222 | if (paddr) |
223 | continue; | |
224 | ||
779d835e SH |
225 | for (addr = 0; addr < PHY_MAX_ADDR; addr++) { |
226 | /* skip already registered PHYs */ | |
7f854420 | 227 | if (mdiobus_is_registered_device(mdio, addr)) |
779d835e SH |
228 | continue; |
229 | ||
230 | /* be noisy to encourage people to set reg property */ | |
231 | dev_info(&mdio->dev, "scan phy %s at address %i\n", | |
232 | child->name, addr); | |
233 | ||
801a8ef5 AL |
234 | if (of_mdiobus_child_is_phy(child)) |
235 | of_mdiobus_register_phy(mdio, child, addr); | |
779d835e SH |
236 | } |
237 | } | |
238 | ||
8bc487d1 GL |
239 | return 0; |
240 | } | |
241 | EXPORT_SYMBOL(of_mdiobus_register); | |
242 | ||
08a7963a JP |
243 | /* Helper function for of_phy_find_device */ |
244 | static int of_phy_match(struct device *dev, void *phy_np) | |
245 | { | |
61c7a080 | 246 | return dev->of_node == phy_np; |
08a7963a JP |
247 | } |
248 | ||
8bc487d1 GL |
249 | /** |
250 | * of_phy_find_device - Give a PHY node, find the phy_device | |
251 | * @phy_np: Pointer to the phy's device tree node | |
252 | * | |
f018ae7a RK |
253 | * If successful, returns a pointer to the phy_device with the embedded |
254 | * struct device refcount incremented by one, or NULL on failure. | |
8bc487d1 GL |
255 | */ |
256 | struct phy_device *of_phy_find_device(struct device_node *phy_np) | |
257 | { | |
258 | struct device *d; | |
6ed74236 AL |
259 | struct mdio_device *mdiodev; |
260 | ||
8bc487d1 GL |
261 | if (!phy_np) |
262 | return NULL; | |
263 | ||
08a7963a | 264 | d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match); |
6ed74236 AL |
265 | if (d) { |
266 | mdiodev = to_mdio_device(d); | |
267 | if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY) | |
268 | return to_phy_device(d); | |
269 | } | |
270 | ||
271 | return NULL; | |
8bc487d1 GL |
272 | } |
273 | EXPORT_SYMBOL(of_phy_find_device); | |
274 | ||
275 | /** | |
276 | * of_phy_connect - Connect to the phy described in the device tree | |
277 | * @dev: pointer to net_device claiming the phy | |
278 | * @phy_np: Pointer to device tree node for the PHY | |
279 | * @hndlr: Link state callback for the network device | |
280 | * @iface: PHY data interface type | |
281 | * | |
f018ae7a RK |
282 | * If successful, returns a pointer to the phy_device with the embedded |
283 | * struct device refcount incremented by one, or NULL on failure. The | |
284 | * refcount must be dropped by calling phy_disconnect() or phy_detach(). | |
8bc487d1 GL |
285 | */ |
286 | struct phy_device *of_phy_connect(struct net_device *dev, | |
287 | struct device_node *phy_np, | |
288 | void (*hndlr)(struct net_device *), u32 flags, | |
289 | phy_interface_t iface) | |
290 | { | |
291 | struct phy_device *phy = of_phy_find_device(phy_np); | |
f018ae7a | 292 | int ret; |
8bc487d1 GL |
293 | |
294 | if (!phy) | |
295 | return NULL; | |
296 | ||
2f637151 FF |
297 | phy->dev_flags = flags; |
298 | ||
f018ae7a RK |
299 | ret = phy_connect_direct(dev, phy, hndlr, iface); |
300 | ||
301 | /* refcount is held by phy_connect_direct() on success */ | |
e5a03bfd | 302 | put_device(&phy->mdio.dev); |
f018ae7a RK |
303 | |
304 | return ret ? NULL : phy; | |
8bc487d1 GL |
305 | } |
306 | EXPORT_SYMBOL(of_phy_connect); | |
24c30dbb | 307 | |
7614aba6 AF |
308 | /** |
309 | * of_phy_attach - Attach to a PHY without starting the state machine | |
310 | * @dev: pointer to net_device claiming the phy | |
311 | * @phy_np: Node pointer for the PHY | |
312 | * @flags: flags to pass to the PHY | |
313 | * @iface: PHY data interface type | |
f018ae7a RK |
314 | * |
315 | * If successful, returns a pointer to the phy_device with the embedded | |
316 | * struct device refcount incremented by one, or NULL on failure. The | |
317 | * refcount must be dropped by calling phy_disconnect() or phy_detach(). | |
7614aba6 AF |
318 | */ |
319 | struct phy_device *of_phy_attach(struct net_device *dev, | |
320 | struct device_node *phy_np, u32 flags, | |
321 | phy_interface_t iface) | |
322 | { | |
323 | struct phy_device *phy = of_phy_find_device(phy_np); | |
f018ae7a | 324 | int ret; |
7614aba6 AF |
325 | |
326 | if (!phy) | |
327 | return NULL; | |
328 | ||
f018ae7a RK |
329 | ret = phy_attach_direct(dev, phy, flags, iface); |
330 | ||
331 | /* refcount is held by phy_attach_direct() on success */ | |
e5a03bfd | 332 | put_device(&phy->mdio.dev); |
f018ae7a RK |
333 | |
334 | return ret ? NULL : phy; | |
7614aba6 AF |
335 | } |
336 | EXPORT_SYMBOL(of_phy_attach); | |
3be2a49e TP |
337 | |
338 | #if defined(CONFIG_FIXED_PHY) | |
339 | /* | |
340 | * of_phy_is_fixed_link() and of_phy_register_fixed_link() must | |
341 | * support two DT bindings: | |
342 | * - the old DT binding, where 'fixed-link' was a property with 5 | |
343 | * cells encoding various informations about the fixed PHY | |
344 | * - the new DT binding, where 'fixed-link' is a sub-node of the | |
345 | * Ethernet device. | |
346 | */ | |
347 | bool of_phy_is_fixed_link(struct device_node *np) | |
348 | { | |
349 | struct device_node *dn; | |
4cba5c21 SS |
350 | int len, err; |
351 | const char *managed; | |
3be2a49e TP |
352 | |
353 | /* New binding */ | |
354 | dn = of_get_child_by_name(np, "fixed-link"); | |
355 | if (dn) { | |
356 | of_node_put(dn); | |
357 | return true; | |
358 | } | |
359 | ||
4cba5c21 SS |
360 | err = of_property_read_string(np, "managed", &managed); |
361 | if (err == 0 && strcmp(managed, "auto") != 0) | |
362 | return true; | |
363 | ||
3be2a49e TP |
364 | /* Old binding */ |
365 | if (of_get_property(np, "fixed-link", &len) && | |
366 | len == (5 * sizeof(__be32))) | |
367 | return true; | |
368 | ||
369 | return false; | |
370 | } | |
371 | EXPORT_SYMBOL(of_phy_is_fixed_link); | |
372 | ||
373 | int of_phy_register_fixed_link(struct device_node *np) | |
374 | { | |
375 | struct fixed_phy_status status = {}; | |
376 | struct device_node *fixed_link_node; | |
377 | const __be32 *fixed_link_prop; | |
a5597008 | 378 | int link_gpio; |
4cba5c21 | 379 | int len, err; |
fd2ef0ba | 380 | struct phy_device *phy; |
4cba5c21 SS |
381 | const char *managed; |
382 | ||
383 | err = of_property_read_string(np, "managed", &managed); | |
384 | if (err == 0) { | |
385 | if (strcmp(managed, "in-band-status") == 0) { | |
386 | /* status is zeroed, namely its .link member */ | |
a5597008 | 387 | phy = fixed_phy_register(PHY_POLL, &status, -1, np); |
4cba5c21 SS |
388 | return IS_ERR(phy) ? PTR_ERR(phy) : 0; |
389 | } | |
390 | } | |
3be2a49e TP |
391 | |
392 | /* New binding */ | |
393 | fixed_link_node = of_get_child_by_name(np, "fixed-link"); | |
394 | if (fixed_link_node) { | |
395 | status.link = 1; | |
a72e1541 RR |
396 | status.duplex = of_property_read_bool(fixed_link_node, |
397 | "full-duplex"); | |
3be2a49e TP |
398 | if (of_property_read_u32(fixed_link_node, "speed", &status.speed)) |
399 | return -EINVAL; | |
a72e1541 RR |
400 | status.pause = of_property_read_bool(fixed_link_node, "pause"); |
401 | status.asym_pause = of_property_read_bool(fixed_link_node, | |
402 | "asym-pause"); | |
a5597008 AL |
403 | link_gpio = of_get_named_gpio_flags(fixed_link_node, |
404 | "link-gpios", 0, NULL); | |
3be2a49e | 405 | of_node_put(fixed_link_node); |
a5597008 AL |
406 | if (link_gpio == -EPROBE_DEFER) |
407 | return -EPROBE_DEFER; | |
408 | ||
409 | phy = fixed_phy_register(PHY_POLL, &status, link_gpio, np); | |
fd2ef0ba | 410 | return IS_ERR(phy) ? PTR_ERR(phy) : 0; |
3be2a49e TP |
411 | } |
412 | ||
413 | /* Old binding */ | |
414 | fixed_link_prop = of_get_property(np, "fixed-link", &len); | |
415 | if (fixed_link_prop && len == (5 * sizeof(__be32))) { | |
416 | status.link = 1; | |
417 | status.duplex = be32_to_cpu(fixed_link_prop[1]); | |
418 | status.speed = be32_to_cpu(fixed_link_prop[2]); | |
419 | status.pause = be32_to_cpu(fixed_link_prop[3]); | |
420 | status.asym_pause = be32_to_cpu(fixed_link_prop[4]); | |
a5597008 | 421 | phy = fixed_phy_register(PHY_POLL, &status, -1, np); |
fd2ef0ba | 422 | return IS_ERR(phy) ? PTR_ERR(phy) : 0; |
3be2a49e TP |
423 | } |
424 | ||
425 | return -ENODEV; | |
426 | } | |
427 | EXPORT_SYMBOL(of_phy_register_fixed_link); | |
428 | #endif |