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