blob: 6c58da2b882c845e453ddd7b6bb0b544f4705b83 [file] [log] [blame]
Andy Fleming00db8182005-07-30 19:31:23 -04001/*
2 * drivers/net/phy/mdio_bus.c
3 *
4 * MDIO Bus interface
5 *
6 * Author: Andy Fleming
7 *
8 * Copyright (c) 2004 Freescale Semiconductor, Inc.
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 *
15 */
Andy Fleming00db8182005-07-30 19:31:23 -040016#include <linux/kernel.h>
Andy Fleming00db8182005-07-30 19:31:23 -040017#include <linux/string.h>
18#include <linux/errno.h>
19#include <linux/unistd.h>
20#include <linux/slab.h>
21#include <linux/interrupt.h>
22#include <linux/init.h>
23#include <linux/delay.h>
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -080024#include <linux/device.h>
Andy Fleming00db8182005-07-30 19:31:23 -040025#include <linux/netdevice.h>
26#include <linux/etherdevice.h>
27#include <linux/skbuff.h>
28#include <linux/spinlock.h>
29#include <linux/mm.h>
30#include <linux/module.h>
Andy Fleming00db8182005-07-30 19:31:23 -040031#include <linux/mii.h>
32#include <linux/ethtool.h>
33#include <linux/phy.h>
34
35#include <asm/io.h>
36#include <asm/irq.h>
37#include <asm/uaccess.h>
38
Randy Dunlapb3df0da2007-03-06 02:41:48 -080039/**
Lennert Buytenhek298cf9be2008-10-08 16:29:57 -070040 * mdiobus_alloc - allocate a mii_bus structure
41 *
42 * Description: called by a bus driver to allocate an mii_bus
43 * structure to fill in.
44 */
45struct mii_bus *mdiobus_alloc(void)
46{
Lennert Buytenhek46abc022008-10-08 16:33:40 -070047 struct mii_bus *bus;
48
49 bus = kzalloc(sizeof(*bus), GFP_KERNEL);
50 if (bus != NULL)
51 bus->state = MDIOBUS_ALLOCATED;
52
53 return bus;
Lennert Buytenhek298cf9be2008-10-08 16:29:57 -070054}
55EXPORT_SYMBOL(mdiobus_alloc);
56
57/**
Lennert Buytenhek46abc022008-10-08 16:33:40 -070058 * mdiobus_release - mii_bus device release callback
Randy Dunlap78c36b12008-10-13 18:46:22 -070059 * @d: the target struct device that contains the mii_bus
Lennert Buytenhek46abc022008-10-08 16:33:40 -070060 *
61 * Description: called when the last reference to an mii_bus is
62 * dropped, to free the underlying memory.
63 */
64static void mdiobus_release(struct device *d)
65{
66 struct mii_bus *bus = to_mii_bus(d);
Krzysztof Halasa161c8d22008-12-25 16:50:41 -080067 BUG_ON(bus->state != MDIOBUS_RELEASED &&
68 /* for compatibility with error handling in drivers */
69 bus->state != MDIOBUS_ALLOCATED);
Lennert Buytenhek46abc022008-10-08 16:33:40 -070070 kfree(bus);
71}
72
73static struct class mdio_bus_class = {
74 .name = "mdio_bus",
75 .dev_release = mdiobus_release,
76};
77
78/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -080079 * mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
80 * @bus: target mii_bus
Andy Fleminge1393452005-08-24 18:46:21 -050081 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -080082 * Description: Called by a bus driver to bring up all the PHYs
83 * on a given bus, and attach them to the bus.
84 *
85 * Returns 0 on success or < 0 on error.
Andy Fleminge1393452005-08-24 18:46:21 -050086 */
87int mdiobus_register(struct mii_bus *bus)
88{
Krzysztof Halasa161c8d22008-12-25 16:50:41 -080089 int i, err;
Andy Fleminge1393452005-08-24 18:46:21 -050090
Andy Fleminge1393452005-08-24 18:46:21 -050091 if (NULL == bus || NULL == bus->name ||
92 NULL == bus->read ||
93 NULL == bus->write)
94 return -EINVAL;
95
Lennert Buytenhek46abc022008-10-08 16:33:40 -070096 BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
97 bus->state != MDIOBUS_UNREGISTERED);
98
99 bus->dev.parent = bus->parent;
100 bus->dev.class = &mdio_bus_class;
101 bus->dev.groups = NULL;
Stephen Hemminger036b6682009-02-26 10:19:36 +0000102 dev_set_name(&bus->dev, "%s", bus->id);
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700103
104 err = device_register(&bus->dev);
105 if (err) {
106 printk(KERN_ERR "mii_bus %s failed to register\n", bus->id);
107 return -EINVAL;
108 }
109
Adrian Bunkd1e7fe42008-02-20 02:13:53 +0200110 mutex_init(&bus->mdio_lock);
111
Andy Fleminge1393452005-08-24 18:46:21 -0500112 if (bus->reset)
113 bus->reset(bus);
114
115 for (i = 0; i < PHY_MAX_ADDR; i++) {
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200116 if ((bus->phy_mask & (1 << i)) == 0) {
117 struct phy_device *phydev;
Andy Fleminge1393452005-08-24 18:46:21 -0500118
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200119 phydev = mdiobus_scan(bus, i);
Krzysztof Halasa161c8d22008-12-25 16:50:41 -0800120 if (IS_ERR(phydev)) {
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200121 err = PTR_ERR(phydev);
Krzysztof Halasa161c8d22008-12-25 16:50:41 -0800122 goto error;
123 }
Herbert Valerio Riedel64b1c2b2006-05-10 12:12:57 -0400124 }
Andy Fleminge1393452005-08-24 18:46:21 -0500125 }
126
Krzysztof Halasa161c8d22008-12-25 16:50:41 -0800127 bus->state = MDIOBUS_REGISTERED;
Andy Fleminge1393452005-08-24 18:46:21 -0500128 pr_info("%s: probed\n", bus->name);
Krzysztof Halasa161c8d22008-12-25 16:50:41 -0800129 return 0;
Andy Fleminge1393452005-08-24 18:46:21 -0500130
Krzysztof Halasa161c8d22008-12-25 16:50:41 -0800131error:
132 while (--i >= 0) {
133 if (bus->phy_map[i])
134 device_unregister(&bus->phy_map[i]->dev);
135 }
136 device_del(&bus->dev);
Andy Fleminge1393452005-08-24 18:46:21 -0500137 return err;
138}
139EXPORT_SYMBOL(mdiobus_register);
140
141void mdiobus_unregister(struct mii_bus *bus)
142{
143 int i;
144
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700145 BUG_ON(bus->state != MDIOBUS_REGISTERED);
146 bus->state = MDIOBUS_UNREGISTERED;
147
Lennert Buytenhek3e440172008-11-09 05:34:47 +0100148 device_del(&bus->dev);
Andy Fleminge1393452005-08-24 18:46:21 -0500149 for (i = 0; i < PHY_MAX_ADDR; i++) {
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300150 if (bus->phy_map[i])
Andy Fleminge1393452005-08-24 18:46:21 -0500151 device_unregister(&bus->phy_map[i]->dev);
Grant Likely4dea5472009-04-25 12:52:46 +0000152 bus->phy_map[i] = NULL;
Andy Fleminge1393452005-08-24 18:46:21 -0500153 }
154}
155EXPORT_SYMBOL(mdiobus_unregister);
156
Lennert Buytenhek298cf9be2008-10-08 16:29:57 -0700157/**
158 * mdiobus_free - free a struct mii_bus
159 * @bus: mii_bus to free
160 *
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700161 * This function releases the reference to the underlying device
162 * object in the mii_bus. If this is the last reference, the mii_bus
163 * will be freed.
Lennert Buytenhek298cf9be2008-10-08 16:29:57 -0700164 */
165void mdiobus_free(struct mii_bus *bus)
166{
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700167 /*
168 * For compatibility with error handling in drivers.
169 */
170 if (bus->state == MDIOBUS_ALLOCATED) {
171 kfree(bus);
172 return;
173 }
174
175 BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
176 bus->state = MDIOBUS_RELEASED;
177
178 put_device(&bus->dev);
Lennert Buytenhek298cf9be2008-10-08 16:29:57 -0700179}
180EXPORT_SYMBOL(mdiobus_free);
181
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200182struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
183{
184 struct phy_device *phydev;
185 int err;
186
187 phydev = get_phy_device(bus, addr);
188 if (IS_ERR(phydev) || phydev == NULL)
189 return phydev;
190
Grant Likely4dea5472009-04-25 12:52:46 +0000191 err = phy_device_register(phydev);
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200192 if (err) {
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200193 phy_device_free(phydev);
Grant Likely4dea5472009-04-25 12:52:46 +0000194 return NULL;
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200195 }
196
Lennert Buytenhek4fd5f812008-08-26 13:08:46 +0200197 return phydev;
198}
199EXPORT_SYMBOL(mdiobus_scan);
200
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800201/**
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000202 * mdiobus_read - Convenience function for reading a given MII mgmt register
203 * @bus: the mii_bus struct
204 * @addr: the phy address
205 * @regnum: register number to read
206 *
207 * NOTE: MUST NOT be called from interrupt context,
208 * because the bus read/write functions may wait for an interrupt
209 * to conclude the operation.
210 */
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000211int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000212{
213 int retval;
214
215 BUG_ON(in_interrupt());
216
217 mutex_lock(&bus->mdio_lock);
218 retval = bus->read(bus, addr, regnum);
219 mutex_unlock(&bus->mdio_lock);
220
221 return retval;
222}
223EXPORT_SYMBOL(mdiobus_read);
224
225/**
226 * mdiobus_write - Convenience function for writing a given MII mgmt register
227 * @bus: the mii_bus struct
228 * @addr: the phy address
229 * @regnum: register number to write
230 * @val: value to write to @regnum
231 *
232 * NOTE: MUST NOT be called from interrupt context,
233 * because the bus read/write functions may wait for an interrupt
234 * to conclude the operation.
235 */
Jason Gunthorpeabf35df2010-03-09 09:17:42 +0000236int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
Lennert Buytenhek2e888102008-09-29 17:12:35 +0000237{
238 int err;
239
240 BUG_ON(in_interrupt());
241
242 mutex_lock(&bus->mdio_lock);
243 err = bus->write(bus, addr, regnum, val);
244 mutex_unlock(&bus->mdio_lock);
245
246 return err;
247}
248EXPORT_SYMBOL(mdiobus_write);
249
250/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800251 * mdio_bus_match - determine if given PHY driver supports the given PHY device
252 * @dev: target PHY device
253 * @drv: given PHY driver
Andy Fleming00db8182005-07-30 19:31:23 -0400254 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800255 * Description: Given a PHY device, and a PHY driver, return 1 if
256 * the driver supports the device. Otherwise, return 0.
Andy Fleming00db8182005-07-30 19:31:23 -0400257 */
258static int mdio_bus_match(struct device *dev, struct device_driver *drv)
259{
260 struct phy_device *phydev = to_phy_device(dev);
261 struct phy_driver *phydrv = to_phy_driver(drv);
262
Kumar Gala5f708dd2007-06-28 13:26:06 -0500263 return ((phydrv->phy_id & phydrv->phy_id_mask) ==
264 (phydev->phy_id & phydrv->phy_id_mask));
Andy Fleming00db8182005-07-30 19:31:23 -0400265}
266
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000267#ifdef CONFIG_PM
268
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -0800269static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
270{
271 struct device_driver *drv = phydev->dev.driver;
272 struct phy_driver *phydrv = to_phy_driver(drv);
273 struct net_device *netdev = phydev->attached_dev;
274
275 if (!drv || !phydrv->suspend)
276 return false;
277
278 /* PHY not attached? May suspend. */
279 if (!netdev)
280 return true;
281
282 /*
283 * Don't suspend PHY if the attched netdev parent may wakeup.
284 * The parent may point to a PCI device, as in tg3 driver.
285 */
286 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
287 return false;
288
289 /*
290 * Also don't suspend PHY if the netdev itself may wakeup. This
291 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
292 * e.g. SoC devices.
293 */
294 if (device_may_wakeup(&netdev->dev))
295 return false;
296
297 return true;
298}
299
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000300static int mdio_bus_suspend(struct device *dev)
Andy Fleming00db8182005-07-30 19:31:23 -0400301{
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -0800302 struct phy_driver *phydrv = to_phy_driver(dev->driver);
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -0800303 struct phy_device *phydev = to_phy_device(dev);
Andy Fleming00db8182005-07-30 19:31:23 -0400304
Anton Vorontsov541cd3e2009-12-30 08:23:28 +0000305 /*
306 * We must stop the state machine manually, otherwise it stops out of
307 * control, possibly with the phydev->lock held. Upon resume, netdev
308 * may call phy routines that try to grab the same lock, and that may
309 * lead to a deadlock.
310 */
Simon Guinotfddd9102010-09-13 22:12:01 +0000311 if (phydev->attached_dev && phydev->adjust_link)
Anton Vorontsov541cd3e2009-12-30 08:23:28 +0000312 phy_stop_machine(phydev);
313
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -0800314 if (!mdio_bus_phy_may_suspend(phydev))
315 return 0;
Anton Vorontsov541cd3e2009-12-30 08:23:28 +0000316
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -0800317 return phydrv->suspend(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400318}
319
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000320static int mdio_bus_resume(struct device *dev)
Andy Fleming00db8182005-07-30 19:31:23 -0400321{
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -0800322 struct phy_driver *phydrv = to_phy_driver(dev->driver);
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -0800323 struct phy_device *phydev = to_phy_device(dev);
Anton Vorontsov541cd3e2009-12-30 08:23:28 +0000324 int ret;
Andy Fleming00db8182005-07-30 19:31:23 -0400325
Anton Vorontsov3d1e4db2009-02-01 00:53:34 -0800326 if (!mdio_bus_phy_may_suspend(phydev))
Anton Vorontsov541cd3e2009-12-30 08:23:28 +0000327 goto no_resume;
328
329 ret = phydrv->resume(phydev);
330 if (ret < 0)
331 return ret;
332
333no_resume:
Simon Guinotfddd9102010-09-13 22:12:01 +0000334 if (phydev->attached_dev && phydev->adjust_link)
Anton Vorontsov541cd3e2009-12-30 08:23:28 +0000335 phy_start_machine(phydev, NULL);
336
337 return 0;
Andy Fleming00db8182005-07-30 19:31:23 -0400338}
339
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000340static int mdio_bus_restore(struct device *dev)
341{
342 struct phy_device *phydev = to_phy_device(dev);
343 struct net_device *netdev = phydev->attached_dev;
344 int ret;
345
346 if (!netdev)
347 return 0;
348
349 ret = phy_init_hw(phydev);
350 if (ret < 0)
351 return ret;
352
353 /* The PHY needs to renegotiate. */
354 phydev->link = 0;
355 phydev->state = PHY_UP;
356
357 phy_start_machine(phydev, NULL);
358
359 return 0;
360}
361
362static struct dev_pm_ops mdio_bus_pm_ops = {
363 .suspend = mdio_bus_suspend,
364 .resume = mdio_bus_resume,
365 .freeze = mdio_bus_suspend,
366 .thaw = mdio_bus_resume,
367 .restore = mdio_bus_restore,
368};
369
370#define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
371
372#else
373
374#define MDIO_BUS_PM_OPS NULL
375
376#endif /* CONFIG_PM */
377
Andy Fleming00db8182005-07-30 19:31:23 -0400378struct bus_type mdio_bus_type = {
379 .name = "mdio_bus",
380 .match = mdio_bus_match,
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000381 .pm = MDIO_BUS_PM_OPS,
Andy Fleming00db8182005-07-30 19:31:23 -0400382};
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700383EXPORT_SYMBOL(mdio_bus_type);
Andy Fleming00db8182005-07-30 19:31:23 -0400384
Jeff Garzik67c4f3f2005-08-11 02:07:25 -0400385int __init mdio_bus_init(void)
Andy Fleming00db8182005-07-30 19:31:23 -0400386{
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700387 int ret;
388
389 ret = class_register(&mdio_bus_class);
390 if (!ret) {
391 ret = bus_register(&mdio_bus_type);
392 if (ret)
393 class_unregister(&mdio_bus_class);
394 }
395
396 return ret;
Andy Fleming00db8182005-07-30 19:31:23 -0400397}
398
Peter Chubbdc85dec2005-09-03 14:05:06 -0700399void mdio_bus_exit(void)
Andy Fleminge1393452005-08-24 18:46:21 -0500400{
Lennert Buytenhek46abc022008-10-08 16:33:40 -0700401 class_unregister(&mdio_bus_class);
Andy Fleminge1393452005-08-24 18:46:21 -0500402 bus_unregister(&mdio_bus_type);
403}