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 | 21 | #include <linux/of_mdio.h> |
b7862412 | 22 | #include <linux/of_net.h> |
8bc487d1 GL |
23 | #include <linux/module.h> |
24 | ||
69226896 RQ |
25 | #define DEFAULT_GPIO_RESET_DELAY 10 /* in microseconds */ |
26 | ||
8bc487d1 GL |
27 | MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>"); |
28 | MODULE_LICENSE("GPL"); | |
29 | ||
3c6f5592 JG |
30 | /* Extract the clause 22 phy ID from the compatible string of the form |
31 | * ethernet-phy-idAAAA.BBBB */ | |
32 | static int of_get_phy_id(struct device_node *device, u32 *phy_id) | |
33 | { | |
34 | struct property *prop; | |
35 | const char *cp; | |
36 | unsigned int upper, lower; | |
37 | ||
38 | of_property_for_each_string(device, "compatible", prop, cp) { | |
39 | if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) == 2) { | |
40 | *phy_id = ((upper & 0xFFFF) << 16) | (lower & 0xFFFF); | |
41 | return 0; | |
42 | } | |
43 | } | |
44 | return -EINVAL; | |
45 | } | |
46 | ||
66bdede4 | 47 | static int of_mdiobus_register_phy(struct mii_bus *mdio, |
b520bd07 | 48 | struct device_node *child, u32 addr) |
2e79cb30 FF |
49 | { |
50 | struct phy_device *phy; | |
51 | bool is_c45; | |
f15c586d | 52 | int rc; |
3c6f5592 | 53 | u32 phy_id; |
2e79cb30 FF |
54 | |
55 | is_c45 = of_device_is_compatible(child, | |
56 | "ethernet-phy-ieee802.3-c45"); | |
57 | ||
3c6f5592 JG |
58 | if (!is_c45 && !of_get_phy_id(child, &phy_id)) |
59 | phy = phy_device_create(mdio, addr, phy_id, 0, NULL); | |
60 | else | |
61 | phy = get_phy_device(mdio, addr, is_c45); | |
af5840a9 | 62 | if (IS_ERR(phy)) |
66bdede4 | 63 | return PTR_ERR(phy); |
2e79cb30 | 64 | |
66bdede4 GU |
65 | rc = of_irq_get(child, 0); |
66 | if (rc == -EPROBE_DEFER) { | |
67 | phy_device_free(phy); | |
68 | return rc; | |
69 | } | |
f15c586d BD |
70 | if (rc > 0) { |
71 | phy->irq = rc; | |
1bc16add | 72 | mdio->irq[addr] = rc; |
f15c586d | 73 | } else { |
1bc16add | 74 | phy->irq = mdio->irq[addr]; |
2e79cb30 FF |
75 | } |
76 | ||
ab6016e0 FF |
77 | if (of_property_read_bool(child, "broken-turn-around")) |
78 | mdio->phy_ignore_ta_mask |= 1 << addr; | |
79 | ||
2e79cb30 FF |
80 | /* Associate the OF node with the device structure so it |
81 | * can be looked up later */ | |
82 | of_node_get(child); | |
e5a03bfd | 83 | phy->mdio.dev.of_node = child; |
2e79cb30 FF |
84 | |
85 | /* All data is now stored in the phy struct; | |
86 | * register it */ | |
87 | rc = phy_device_register(phy); | |
88 | if (rc) { | |
89 | phy_device_free(phy); | |
90 | of_node_put(child); | |
66bdede4 | 91 | return rc; |
2e79cb30 FF |
92 | } |
93 | ||
94 | dev_dbg(&mdio->dev, "registered phy %s at address %i\n", | |
8fdade4b | 95 | child->name, addr); |
66bdede4 | 96 | return 0; |
2e79cb30 FF |
97 | } |
98 | ||
66bdede4 GU |
99 | static int of_mdiobus_register_device(struct mii_bus *mdio, |
100 | struct device_node *child, u32 addr) | |
a9049e0c AL |
101 | { |
102 | struct mdio_device *mdiodev; | |
103 | int rc; | |
104 | ||
105 | mdiodev = mdio_device_create(mdio, addr); | |
a3478bae | 106 | if (IS_ERR(mdiodev)) |
66bdede4 | 107 | return PTR_ERR(mdiodev); |
a9049e0c AL |
108 | |
109 | /* Associate the OF node with the device structure so it | |
110 | * can be looked up later. | |
111 | */ | |
112 | of_node_get(child); | |
113 | mdiodev->dev.of_node = child; | |
114 | ||
115 | /* All data is now stored in the mdiodev struct; register it. */ | |
116 | rc = mdio_device_register(mdiodev); | |
117 | if (rc) { | |
118 | mdio_device_free(mdiodev); | |
119 | of_node_put(child); | |
66bdede4 | 120 | return rc; |
a9049e0c AL |
121 | } |
122 | ||
123 | dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n", | |
124 | child->name, addr); | |
66bdede4 | 125 | return 0; |
a9049e0c AL |
126 | } |
127 | ||
ae461131 AL |
128 | /* The following is a list of PHY compatible strings which appear in |
129 | * some DTBs. The compatible string is never matched against a PHY | |
130 | * driver, so is pointless. We only expect devices which are not PHYs | |
131 | * to have a compatible string, so they can be matched to an MDIO | |
132 | * driver. Encourage users to upgrade their DT blobs to remove these. | |
133 | */ | |
134 | static const struct of_device_id whitelist_phys[] = { | |
135 | { .compatible = "brcm,40nm-ephy" }, | |
7e1392fb | 136 | { .compatible = "broadcom,bcm5241" }, |
ae461131 AL |
137 | { .compatible = "marvell,88E1111", }, |
138 | { .compatible = "marvell,88e1116", }, | |
139 | { .compatible = "marvell,88e1118", }, | |
f5a952c0 | 140 | { .compatible = "marvell,88e1145", }, |
ae461131 AL |
141 | { .compatible = "marvell,88e1149r", }, |
142 | { .compatible = "marvell,88e1310", }, | |
143 | { .compatible = "marvell,88E1510", }, | |
144 | { .compatible = "marvell,88E1514", }, | |
145 | { .compatible = "moxa,moxart-rtl8201cp", }, | |
146 | {} | |
147 | }; | |
148 | ||
801a8ef5 AL |
149 | /* |
150 | * Return true if the child node is for a phy. It must either: | |
151 | * o Compatible string of "ethernet-phy-idX.X" | |
152 | * o Compatible string of "ethernet-phy-ieee802.3-c45" | |
153 | * o Compatible string of "ethernet-phy-ieee802.3-c22" | |
ae461131 | 154 | * o In the white list above (and issue a warning) |
801a8ef5 AL |
155 | * o No compatibility string |
156 | * | |
157 | * A device which is not a phy is expected to have a compatible string | |
158 | * indicating what sort of device it is. | |
159 | */ | |
160 | static bool of_mdiobus_child_is_phy(struct device_node *child) | |
161 | { | |
162 | u32 phy_id; | |
163 | ||
164 | if (of_get_phy_id(child, &phy_id) != -EINVAL) | |
165 | return true; | |
166 | ||
167 | if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c45")) | |
168 | return true; | |
169 | ||
170 | if (of_device_is_compatible(child, "ethernet-phy-ieee802.3-c22")) | |
171 | return true; | |
172 | ||
ae461131 AL |
173 | if (of_match_node(whitelist_phys, child)) { |
174 | pr_warn(FW_WARN | |
0d638a07 RH |
175 | "%pOF: Whitelisted compatible string. Please remove\n", |
176 | child); | |
ae461131 AL |
177 | return true; |
178 | } | |
179 | ||
801a8ef5 AL |
180 | if (!of_find_property(child, "compatible", NULL)) |
181 | return true; | |
182 | ||
183 | return false; | |
184 | } | |
185 | ||
8bc487d1 GL |
186 | /** |
187 | * of_mdiobus_register - Register mii_bus and create PHYs from the device tree | |
188 | * @mdio: pointer to mii_bus structure | |
189 | * @np: pointer to device_node of MDIO bus. | |
190 | * | |
191 | * This function registers the mii_bus structure and registers a phy_device | |
192 | * for each child node of @np. | |
193 | */ | |
194 | int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np) | |
195 | { | |
8bc487d1 | 196 | struct device_node *child; |
2e79cb30 | 197 | bool scanphys = false; |
e7f4dc35 | 198 | int addr, rc; |
8bc487d1 | 199 | |
a77f4f70 FF |
200 | /* Do not continue if the node is disabled */ |
201 | if (!of_device_is_available(np)) | |
202 | return -ENODEV; | |
203 | ||
8bc487d1 GL |
204 | /* Mask out all PHYs from auto probing. Instead the PHYs listed in |
205 | * the device tree are populated after the bus has been registered */ | |
206 | mdio->phy_mask = ~0; | |
207 | ||
25106022 DD |
208 | mdio->dev.of_node = np; |
209 | ||
69226896 RQ |
210 | /* Get bus level PHY reset GPIO details */ |
211 | mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY; | |
212 | of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us); | |
69226896 | 213 | |
8bc487d1 GL |
214 | /* Register the MDIO bus */ |
215 | rc = mdiobus_register(mdio); | |
216 | if (rc) | |
217 | return rc; | |
218 | ||
801a8ef5 | 219 | /* Loop over the child nodes and register a phy_device for each phy */ |
e207e761 | 220 | for_each_available_child_of_node(np, child) { |
8f838288 DM |
221 | addr = of_mdio_parse_addr(&mdio->dev, child); |
222 | if (addr < 0) { | |
779d835e | 223 | scanphys = true; |
19458860 DD |
224 | continue; |
225 | } | |
226 | ||
801a8ef5 | 227 | if (of_mdiobus_child_is_phy(child)) |
66bdede4 | 228 | rc = of_mdiobus_register_phy(mdio, child, addr); |
a9049e0c | 229 | else |
66bdede4 GU |
230 | rc = of_mdiobus_register_device(mdio, child, addr); |
231 | if (rc) | |
232 | goto unregister; | |
8bc487d1 GL |
233 | } |
234 | ||
779d835e SH |
235 | if (!scanphys) |
236 | return 0; | |
237 | ||
238 | /* auto scan for PHYs with empty reg property */ | |
239 | for_each_available_child_of_node(np, child) { | |
240 | /* Skip PHYs with reg property set */ | |
2fca6d28 | 241 | if (of_find_property(child, "reg", NULL)) |
779d835e SH |
242 | continue; |
243 | ||
779d835e SH |
244 | for (addr = 0; addr < PHY_MAX_ADDR; addr++) { |
245 | /* skip already registered PHYs */ | |
7f854420 | 246 | if (mdiobus_is_registered_device(mdio, addr)) |
779d835e SH |
247 | continue; |
248 | ||
249 | /* be noisy to encourage people to set reg property */ | |
250 | dev_info(&mdio->dev, "scan phy %s at address %i\n", | |
251 | child->name, addr); | |
252 | ||
66bdede4 GU |
253 | if (of_mdiobus_child_is_phy(child)) { |
254 | rc = of_mdiobus_register_phy(mdio, child, addr); | |
255 | if (rc) | |
256 | goto unregister; | |
257 | } | |
779d835e SH |
258 | } |
259 | } | |
260 | ||
8bc487d1 | 261 | return 0; |
66bdede4 GU |
262 | |
263 | unregister: | |
264 | mdiobus_unregister(mdio); | |
265 | return rc; | |
8bc487d1 GL |
266 | } |
267 | EXPORT_SYMBOL(of_mdiobus_register); | |
268 | ||
08a7963a JP |
269 | /* Helper function for of_phy_find_device */ |
270 | static int of_phy_match(struct device *dev, void *phy_np) | |
271 | { | |
61c7a080 | 272 | return dev->of_node == phy_np; |
08a7963a JP |
273 | } |
274 | ||
8bc487d1 GL |
275 | /** |
276 | * of_phy_find_device - Give a PHY node, find the phy_device | |
277 | * @phy_np: Pointer to the phy's device tree node | |
278 | * | |
f018ae7a RK |
279 | * If successful, returns a pointer to the phy_device with the embedded |
280 | * struct device refcount incremented by one, or NULL on failure. | |
8bc487d1 GL |
281 | */ |
282 | struct phy_device *of_phy_find_device(struct device_node *phy_np) | |
283 | { | |
284 | struct device *d; | |
6ed74236 AL |
285 | struct mdio_device *mdiodev; |
286 | ||
8bc487d1 GL |
287 | if (!phy_np) |
288 | return NULL; | |
289 | ||
08a7963a | 290 | d = bus_find_device(&mdio_bus_type, NULL, phy_np, of_phy_match); |
6ed74236 AL |
291 | if (d) { |
292 | mdiodev = to_mdio_device(d); | |
293 | if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY) | |
294 | return to_phy_device(d); | |
3ae30f4c | 295 | put_device(d); |
6ed74236 AL |
296 | } |
297 | ||
298 | return NULL; | |
8bc487d1 GL |
299 | } |
300 | EXPORT_SYMBOL(of_phy_find_device); | |
301 | ||
302 | /** | |
303 | * of_phy_connect - Connect to the phy described in the device tree | |
304 | * @dev: pointer to net_device claiming the phy | |
305 | * @phy_np: Pointer to device tree node for the PHY | |
306 | * @hndlr: Link state callback for the network device | |
735c1e25 | 307 | * @flags: flags to pass to the PHY |
8bc487d1 GL |
308 | * @iface: PHY data interface type |
309 | * | |
f018ae7a RK |
310 | * If successful, returns a pointer to the phy_device with the embedded |
311 | * struct device refcount incremented by one, or NULL on failure. The | |
312 | * refcount must be dropped by calling phy_disconnect() or phy_detach(). | |
8bc487d1 GL |
313 | */ |
314 | struct phy_device *of_phy_connect(struct net_device *dev, | |
315 | struct device_node *phy_np, | |
316 | void (*hndlr)(struct net_device *), u32 flags, | |
317 | phy_interface_t iface) | |
318 | { | |
319 | struct phy_device *phy = of_phy_find_device(phy_np); | |
f018ae7a | 320 | int ret; |
8bc487d1 GL |
321 | |
322 | if (!phy) | |
323 | return NULL; | |
324 | ||
2f637151 FF |
325 | phy->dev_flags = flags; |
326 | ||
f018ae7a RK |
327 | ret = phy_connect_direct(dev, phy, hndlr, iface); |
328 | ||
329 | /* refcount is held by phy_connect_direct() on success */ | |
e5a03bfd | 330 | put_device(&phy->mdio.dev); |
f018ae7a RK |
331 | |
332 | return ret ? NULL : phy; | |
8bc487d1 GL |
333 | } |
334 | EXPORT_SYMBOL(of_phy_connect); | |
24c30dbb | 335 | |
b7862412 DL |
336 | /** |
337 | * of_phy_get_and_connect | |
338 | * - Get phy node and connect to the phy described in the device tree | |
339 | * @dev: pointer to net_device claiming the phy | |
340 | * @np: Pointer to device tree node for the net_device claiming the phy | |
341 | * @hndlr: Link state callback for the network device | |
342 | * | |
343 | * If successful, returns a pointer to the phy_device with the embedded | |
344 | * struct device refcount incremented by one, or NULL on failure. The | |
345 | * refcount must be dropped by calling phy_disconnect() or phy_detach(). | |
346 | */ | |
347 | struct phy_device *of_phy_get_and_connect(struct net_device *dev, | |
348 | struct device_node *np, | |
349 | void (*hndlr)(struct net_device *)) | |
350 | { | |
351 | phy_interface_t iface; | |
352 | struct device_node *phy_np; | |
353 | struct phy_device *phy; | |
354 | ||
355 | iface = of_get_phy_mode(np); | |
356 | if (iface < 0) | |
357 | return NULL; | |
358 | ||
359 | phy_np = of_parse_phandle(np, "phy-handle", 0); | |
360 | if (!phy_np) | |
361 | return NULL; | |
362 | ||
363 | phy = of_phy_connect(dev, phy_np, hndlr, 0, iface); | |
364 | ||
365 | of_node_put(phy_np); | |
366 | ||
367 | return phy; | |
368 | } | |
369 | EXPORT_SYMBOL(of_phy_get_and_connect); | |
370 | ||
7614aba6 AF |
371 | /** |
372 | * of_phy_attach - Attach to a PHY without starting the state machine | |
373 | * @dev: pointer to net_device claiming the phy | |
374 | * @phy_np: Node pointer for the PHY | |
375 | * @flags: flags to pass to the PHY | |
376 | * @iface: PHY data interface type | |
f018ae7a RK |
377 | * |
378 | * If successful, returns a pointer to the phy_device with the embedded | |
379 | * struct device refcount incremented by one, or NULL on failure. The | |
380 | * refcount must be dropped by calling phy_disconnect() or phy_detach(). | |
7614aba6 AF |
381 | */ |
382 | struct phy_device *of_phy_attach(struct net_device *dev, | |
383 | struct device_node *phy_np, u32 flags, | |
384 | phy_interface_t iface) | |
385 | { | |
386 | struct phy_device *phy = of_phy_find_device(phy_np); | |
f018ae7a | 387 | int ret; |
7614aba6 AF |
388 | |
389 | if (!phy) | |
390 | return NULL; | |
391 | ||
f018ae7a RK |
392 | ret = phy_attach_direct(dev, phy, flags, iface); |
393 | ||
394 | /* refcount is held by phy_attach_direct() on success */ | |
e5a03bfd | 395 | put_device(&phy->mdio.dev); |
f018ae7a RK |
396 | |
397 | return ret ? NULL : phy; | |
7614aba6 AF |
398 | } |
399 | EXPORT_SYMBOL(of_phy_attach); | |
3be2a49e | 400 | |
3be2a49e TP |
401 | /* |
402 | * of_phy_is_fixed_link() and of_phy_register_fixed_link() must | |
403 | * support two DT bindings: | |
404 | * - the old DT binding, where 'fixed-link' was a property with 5 | |
405 | * cells encoding various informations about the fixed PHY | |
406 | * - the new DT binding, where 'fixed-link' is a sub-node of the | |
407 | * Ethernet device. | |
408 | */ | |
409 | bool of_phy_is_fixed_link(struct device_node *np) | |
410 | { | |
411 | struct device_node *dn; | |
4cba5c21 SS |
412 | int len, err; |
413 | const char *managed; | |
3be2a49e TP |
414 | |
415 | /* New binding */ | |
416 | dn = of_get_child_by_name(np, "fixed-link"); | |
417 | if (dn) { | |
418 | of_node_put(dn); | |
419 | return true; | |
420 | } | |
421 | ||
4cba5c21 SS |
422 | err = of_property_read_string(np, "managed", &managed); |
423 | if (err == 0 && strcmp(managed, "auto") != 0) | |
424 | return true; | |
425 | ||
3be2a49e TP |
426 | /* Old binding */ |
427 | if (of_get_property(np, "fixed-link", &len) && | |
428 | len == (5 * sizeof(__be32))) | |
429 | return true; | |
430 | ||
431 | return false; | |
432 | } | |
433 | EXPORT_SYMBOL(of_phy_is_fixed_link); | |
434 | ||
435 | int of_phy_register_fixed_link(struct device_node *np) | |
436 | { | |
437 | struct fixed_phy_status status = {}; | |
438 | struct device_node *fixed_link_node; | |
d226a2b8 | 439 | u32 fixed_link_prop[5]; |
4cba5c21 | 440 | const char *managed; |
5a7a8346 | 441 | int link_gpio = -1; |
4cba5c21 | 442 | |
5a7a8346 SS |
443 | if (of_property_read_string(np, "managed", &managed) == 0 && |
444 | strcmp(managed, "in-band-status") == 0) { | |
445 | /* status is zeroed, namely its .link member */ | |
446 | goto register_phy; | |
4cba5c21 | 447 | } |
3be2a49e TP |
448 | |
449 | /* New binding */ | |
450 | fixed_link_node = of_get_child_by_name(np, "fixed-link"); | |
451 | if (fixed_link_node) { | |
452 | status.link = 1; | |
a72e1541 RR |
453 | status.duplex = of_property_read_bool(fixed_link_node, |
454 | "full-duplex"); | |
48c1699d JH |
455 | if (of_property_read_u32(fixed_link_node, "speed", |
456 | &status.speed)) { | |
457 | of_node_put(fixed_link_node); | |
3be2a49e | 458 | return -EINVAL; |
48c1699d | 459 | } |
a72e1541 RR |
460 | status.pause = of_property_read_bool(fixed_link_node, "pause"); |
461 | status.asym_pause = of_property_read_bool(fixed_link_node, | |
462 | "asym-pause"); | |
a5597008 AL |
463 | link_gpio = of_get_named_gpio_flags(fixed_link_node, |
464 | "link-gpios", 0, NULL); | |
3be2a49e | 465 | of_node_put(fixed_link_node); |
a5597008 AL |
466 | if (link_gpio == -EPROBE_DEFER) |
467 | return -EPROBE_DEFER; | |
468 | ||
5a7a8346 | 469 | goto register_phy; |
3be2a49e TP |
470 | } |
471 | ||
472 | /* Old binding */ | |
d226a2b8 SS |
473 | if (of_property_read_u32_array(np, "fixed-link", fixed_link_prop, |
474 | ARRAY_SIZE(fixed_link_prop)) == 0) { | |
3be2a49e | 475 | status.link = 1; |
d226a2b8 SS |
476 | status.duplex = fixed_link_prop[1]; |
477 | status.speed = fixed_link_prop[2]; | |
478 | status.pause = fixed_link_prop[3]; | |
479 | status.asym_pause = fixed_link_prop[4]; | |
5a7a8346 | 480 | goto register_phy; |
3be2a49e TP |
481 | } |
482 | ||
483 | return -ENODEV; | |
5a7a8346 SS |
484 | |
485 | register_phy: | |
486 | return PTR_ERR_OR_ZERO(fixed_phy_register(PHY_POLL, &status, link_gpio, | |
487 | np)); | |
3be2a49e TP |
488 | } |
489 | EXPORT_SYMBOL(of_phy_register_fixed_link); | |
3f65047c JH |
490 | |
491 | void of_phy_deregister_fixed_link(struct device_node *np) | |
492 | { | |
493 | struct phy_device *phydev; | |
494 | ||
495 | phydev = of_phy_find_device(np); | |
496 | if (!phydev) | |
497 | return; | |
498 | ||
499 | fixed_phy_unregister(phydev); | |
500 | ||
501 | put_device(&phydev->mdio.dev); /* of_phy_find_device() */ | |
502 | phy_device_free(phydev); /* fixed_phy_register() */ | |
503 | } | |
504 | EXPORT_SYMBOL(of_phy_deregister_fixed_link); |