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