2 * OF helpers for the MDIO (Ethernet PHY) API
4 * Copyright (c) 2009 Secret Lab Technologies, Ltd.
6 * This file is released under the GPLv2
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.
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>
19 #include <linux/of_irq.h>
20 #include <linux/of_mdio.h>
21 #include <linux/module.h>
23 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
24 MODULE_LICENSE("GPL");
26 /* Extract the clause 22 phy ID from the compatible string of the form
27 * ethernet-phy-idAAAA.BBBB */
28 static int of_get_phy_id(struct device_node
*device
, u32
*phy_id
)
30 struct property
*prop
;
32 unsigned int upper
, lower
;
34 of_property_for_each_string(device
, "compatible", prop
, cp
) {
35 if (sscanf(cp
, "ethernet-phy-id%4x.%4x", &upper
, &lower
) == 2) {
36 *phy_id
= ((upper
& 0xFFFF) << 16) | (lower
& 0xFFFF);
43 static int of_mdiobus_register_phy(struct mii_bus
*mdio
, struct device_node
*child
,
46 struct phy_device
*phy
;
51 is_c45
= of_device_is_compatible(child
,
52 "ethernet-phy-ieee802.3-c45");
54 if (!is_c45
&& !of_get_phy_id(child
, &phy_id
))
55 phy
= phy_device_create(mdio
, addr
, phy_id
, 0, NULL
);
57 phy
= get_phy_device(mdio
, addr
, is_c45
);
58 if (!phy
|| IS_ERR(phy
))
61 rc
= irq_of_parse_and_map(child
, 0);
68 phy
->irq
= mdio
->irq
[addr
];
71 /* Associate the OF node with the device structure so it
72 * can be looked up later */
74 phy
->dev
.of_node
= child
;
76 /* All data is now stored in the phy struct;
78 rc
= phy_device_register(phy
);
85 dev_dbg(&mdio
->dev
, "registered phy %s at address %i\n",
91 static int of_mdio_parse_addr(struct device
*dev
, const struct device_node
*np
)
96 ret
= of_property_read_u32(np
, "reg", &addr
);
98 dev_err(dev
, "%s has invalid PHY address\n", np
->full_name
);
102 /* A PHY must have a reg property in the range [0-31] */
103 if (addr
>= PHY_MAX_ADDR
) {
104 dev_err(dev
, "%s PHY address %i is too large\n",
105 np
->full_name
, addr
);
113 * of_mdiobus_register - Register mii_bus and create PHYs from the device tree
114 * @mdio: pointer to mii_bus structure
115 * @np: pointer to device_node of MDIO bus.
117 * This function registers the mii_bus structure and registers a phy_device
118 * for each child node of @np.
120 int of_mdiobus_register(struct mii_bus
*mdio
, struct device_node
*np
)
122 struct device_node
*child
;
124 bool scanphys
= false;
127 /* Mask out all PHYs from auto probing. Instead the PHYs listed in
128 * the device tree are populated after the bus has been registered */
131 /* Clear all the IRQ properties */
133 for (i
=0; i
<PHY_MAX_ADDR
; i
++)
134 mdio
->irq
[i
] = PHY_POLL
;
136 mdio
->dev
.of_node
= np
;
138 /* Register the MDIO bus */
139 rc
= mdiobus_register(mdio
);
143 /* Loop over the child nodes and register a phy_device for each one */
144 for_each_available_child_of_node(np
, child
) {
145 addr
= of_mdio_parse_addr(&mdio
->dev
, child
);
151 rc
= of_mdiobus_register_phy(mdio
, child
, addr
);
159 /* auto scan for PHYs with empty reg property */
160 for_each_available_child_of_node(np
, child
) {
161 /* Skip PHYs with reg property set */
162 paddr
= of_get_property(child
, "reg", NULL
);
166 for (addr
= 0; addr
< PHY_MAX_ADDR
; addr
++) {
167 /* skip already registered PHYs */
168 if (mdio
->phy_map
[addr
])
171 /* be noisy to encourage people to set reg property */
172 dev_info(&mdio
->dev
, "scan phy %s at address %i\n",
175 rc
= of_mdiobus_register_phy(mdio
, child
, addr
);
183 EXPORT_SYMBOL(of_mdiobus_register
);
185 /* Helper function for of_phy_find_device */
186 static int of_phy_match(struct device
*dev
, void *phy_np
)
188 return dev
->of_node
== phy_np
;
192 * of_phy_find_device - Give a PHY node, find the phy_device
193 * @phy_np: Pointer to the phy's device tree node
195 * Returns a pointer to the phy_device.
197 struct phy_device
*of_phy_find_device(struct device_node
*phy_np
)
203 d
= bus_find_device(&mdio_bus_type
, NULL
, phy_np
, of_phy_match
);
204 return d
? to_phy_device(d
) : NULL
;
206 EXPORT_SYMBOL(of_phy_find_device
);
209 * of_phy_connect - Connect to the phy described in the device tree
210 * @dev: pointer to net_device claiming the phy
211 * @phy_np: Pointer to device tree node for the PHY
212 * @hndlr: Link state callback for the network device
213 * @iface: PHY data interface type
215 * Returns a pointer to the phy_device if successful. NULL otherwise
217 struct phy_device
*of_phy_connect(struct net_device
*dev
,
218 struct device_node
*phy_np
,
219 void (*hndlr
)(struct net_device
*), u32 flags
,
220 phy_interface_t iface
)
222 struct phy_device
*phy
= of_phy_find_device(phy_np
);
227 return phy_connect_direct(dev
, phy
, hndlr
, iface
) ? NULL
: phy
;
229 EXPORT_SYMBOL(of_phy_connect
);
232 * of_phy_attach - Attach to a PHY without starting the state machine
233 * @dev: pointer to net_device claiming the phy
234 * @phy_np: Node pointer for the PHY
235 * @flags: flags to pass to the PHY
236 * @iface: PHY data interface type
238 struct phy_device
*of_phy_attach(struct net_device
*dev
,
239 struct device_node
*phy_np
, u32 flags
,
240 phy_interface_t iface
)
242 struct phy_device
*phy
= of_phy_find_device(phy_np
);
247 return phy_attach_direct(dev
, phy
, flags
, iface
) ? NULL
: phy
;
249 EXPORT_SYMBOL(of_phy_attach
);
251 #if defined(CONFIG_FIXED_PHY)
253 * of_phy_is_fixed_link() and of_phy_register_fixed_link() must
254 * support two DT bindings:
255 * - the old DT binding, where 'fixed-link' was a property with 5
256 * cells encoding various informations about the fixed PHY
257 * - the new DT binding, where 'fixed-link' is a sub-node of the
260 bool of_phy_is_fixed_link(struct device_node
*np
)
262 struct device_node
*dn
;
266 dn
= of_get_child_by_name(np
, "fixed-link");
273 if (of_get_property(np
, "fixed-link", &len
) &&
274 len
== (5 * sizeof(__be32
)))
279 EXPORT_SYMBOL(of_phy_is_fixed_link
);
281 int of_phy_register_fixed_link(struct device_node
*np
)
283 struct fixed_phy_status status
= {};
284 struct device_node
*fixed_link_node
;
285 const __be32
*fixed_link_prop
;
289 fixed_link_node
= of_get_child_by_name(np
, "fixed-link");
290 if (fixed_link_node
) {
292 status
.duplex
= of_property_read_bool(fixed_link_node
,
294 if (of_property_read_u32(fixed_link_node
, "speed", &status
.speed
))
296 status
.pause
= of_property_read_bool(fixed_link_node
, "pause");
297 status
.asym_pause
= of_property_read_bool(fixed_link_node
,
299 of_node_put(fixed_link_node
);
300 return fixed_phy_register(PHY_POLL
, &status
, np
);
304 fixed_link_prop
= of_get_property(np
, "fixed-link", &len
);
305 if (fixed_link_prop
&& len
== (5 * sizeof(__be32
))) {
307 status
.duplex
= be32_to_cpu(fixed_link_prop
[1]);
308 status
.speed
= be32_to_cpu(fixed_link_prop
[2]);
309 status
.pause
= be32_to_cpu(fixed_link_prop
[3]);
310 status
.asym_pause
= be32_to_cpu(fixed_link_prop
[4]);
311 return fixed_phy_register(PHY_POLL
, &status
, np
);
316 EXPORT_SYMBOL(of_phy_register_fixed_link
);