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