blob: c0761197c07e6a94e67e3d0d4f417d888e2ec68f [file] [log] [blame]
Andy Fleming00db8182005-07-30 19:31:23 -04001/*
2 * drivers/net/phy/phy_device.c
3 *
4 * Framework for finding and configuring PHYs.
5 * Also contains generic PHY driver
6 *
7 * Author: Andy Fleming
8 *
9 * Copyright (c) 2004 Freescale Semiconductor, Inc.
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
15 *
16 */
Andy Fleming00db8182005-07-30 19:31:23 -040017#include <linux/kernel.h>
Andy Fleming00db8182005-07-30 19:31:23 -040018#include <linux/string.h>
19#include <linux/errno.h>
20#include <linux/unistd.h>
21#include <linux/slab.h>
22#include <linux/interrupt.h>
23#include <linux/init.h>
24#include <linux/delay.h>
25#include <linux/netdevice.h>
26#include <linux/etherdevice.h>
27#include <linux/skbuff.h>
Andy Fleming00db8182005-07-30 19:31:23 -040028#include <linux/mm.h>
29#include <linux/module.h>
Andy Fleming00db8182005-07-30 19:31:23 -040030#include <linux/mii.h>
31#include <linux/ethtool.h>
32#include <linux/phy.h>
33
34#include <asm/io.h>
35#include <asm/irq.h>
36#include <asm/uaccess.h>
37
Olaf Heringafcceaa2005-12-14 00:33:49 +010038MODULE_DESCRIPTION("PHY library");
39MODULE_AUTHOR("Andy Fleming");
40MODULE_LICENSE("GPL");
41
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +030042void phy_device_free(struct phy_device *phydev)
43{
44 kfree(phydev);
45}
Grant Likely4dea5472009-04-25 12:52:46 +000046EXPORT_SYMBOL(phy_device_free);
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +030047
48static void phy_device_release(struct device *dev)
49{
50 phy_device_free(to_phy_device(dev));
51}
52
Grant Likely4dea5472009-04-25 12:52:46 +000053static struct phy_driver genphy_driver;
54extern int mdio_bus_init(void);
55extern void mdio_bus_exit(void);
56
Andy Flemingf62220d2008-04-18 17:29:54 -050057static LIST_HEAD(phy_fixup_list);
58static DEFINE_MUTEX(phy_fixup_lock);
59
60/*
61 * Creates a new phy_fixup and adds it to the list
62 * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
63 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
64 * It can also be PHY_ANY_UID
65 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
66 * comparison
67 * @run: The actual code to be run when a matching PHY is found
68 */
69int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
70 int (*run)(struct phy_device *))
71{
72 struct phy_fixup *fixup;
73
74 fixup = kzalloc(sizeof(struct phy_fixup), GFP_KERNEL);
75 if (!fixup)
76 return -ENOMEM;
77
Kay Sieversfb28ad352008-11-10 13:55:14 -080078 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
Andy Flemingf62220d2008-04-18 17:29:54 -050079 fixup->phy_uid = phy_uid;
80 fixup->phy_uid_mask = phy_uid_mask;
81 fixup->run = run;
82
83 mutex_lock(&phy_fixup_lock);
84 list_add_tail(&fixup->list, &phy_fixup_list);
85 mutex_unlock(&phy_fixup_lock);
86
87 return 0;
88}
89EXPORT_SYMBOL(phy_register_fixup);
90
91/* Registers a fixup to be run on any PHY with the UID in phy_uid */
92int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
93 int (*run)(struct phy_device *))
94{
95 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
96}
97EXPORT_SYMBOL(phy_register_fixup_for_uid);
98
99/* Registers a fixup to be run on the PHY with id string bus_id */
100int phy_register_fixup_for_id(const char *bus_id,
101 int (*run)(struct phy_device *))
102{
103 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
104}
105EXPORT_SYMBOL(phy_register_fixup_for_id);
106
107/*
108 * Returns 1 if fixup matches phydev in bus_id and phy_uid.
109 * Fixups can be set to match any in one or more fields.
110 */
111static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
112{
Kay Sieversfb28ad352008-11-10 13:55:14 -0800113 if (strcmp(fixup->bus_id, dev_name(&phydev->dev)) != 0)
Andy Flemingf62220d2008-04-18 17:29:54 -0500114 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
115 return 0;
116
117 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
118 (phydev->phy_id & fixup->phy_uid_mask))
119 if (fixup->phy_uid != PHY_ANY_UID)
120 return 0;
121
122 return 1;
123}
124
125/* Runs any matching fixups for this phydev */
126int phy_scan_fixups(struct phy_device *phydev)
127{
128 struct phy_fixup *fixup;
129
130 mutex_lock(&phy_fixup_lock);
131 list_for_each_entry(fixup, &phy_fixup_list, list) {
132 if (phy_needs_fixup(phydev, fixup)) {
133 int err;
134
135 err = fixup->run(phydev);
136
Jiri Slabybc232832009-07-13 11:23:39 +0000137 if (err < 0) {
138 mutex_unlock(&phy_fixup_lock);
Andy Flemingf62220d2008-04-18 17:29:54 -0500139 return err;
Jiri Slabybc232832009-07-13 11:23:39 +0000140 }
Andy Flemingf62220d2008-04-18 17:29:54 -0500141 }
142 }
143 mutex_unlock(&phy_fixup_lock);
144
145 return 0;
146}
147EXPORT_SYMBOL(phy_scan_fixups);
148
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700149struct phy_device* phy_device_create(struct mii_bus *bus, int addr, int phy_id)
150{
151 struct phy_device *dev;
David Woodhouse8626d3b2010-04-02 01:05:27 +0000152
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700153 /* We allocate the device, and initialize the
154 * default values */
Robert P. J. Daycd861282006-12-13 00:34:52 -0800155 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700156
157 if (NULL == dev)
158 return (struct phy_device*) PTR_ERR((void*)-ENOMEM);
159
Anton Vorontsov6f4a7f42007-12-04 16:17:33 +0300160 dev->dev.release = phy_device_release;
161
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700162 dev->speed = 0;
163 dev->duplex = -1;
164 dev->pause = dev->asym_pause = 0;
165 dev->link = 1;
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600166 dev->interface = PHY_INTERFACE_MODE_GMII;
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700167
168 dev->autoneg = AUTONEG_ENABLE;
169
170 dev->addr = addr;
171 dev->phy_id = phy_id;
172 dev->bus = bus;
Grant Likely4dea5472009-04-25 12:52:46 +0000173 dev->dev.parent = bus->parent;
174 dev->dev.bus = &mdio_bus_type;
175 dev->irq = bus->irq != NULL ? bus->irq[addr] : PHY_POLL;
176 dev_set_name(&dev->dev, PHY_ID_FMT, bus->id, addr);
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700177
178 dev->state = PHY_DOWN;
179
Nate Case35b5f6b2008-01-29 10:05:09 -0600180 mutex_init(&dev->lock);
Anton Vorontsov4f9c85a2010-01-18 05:37:16 +0000181 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700182
David Woodhouse8626d3b2010-04-02 01:05:27 +0000183 /* Request the appropriate module unconditionally; don't
184 bother trying to do so only if it isn't already loaded,
185 because that gets complicated. A hotplug event would have
186 done an unconditional modprobe anyway.
187 We don't do normal hotplug because it won't work for MDIO
188 -- because it relies on the device staying around for long
189 enough for the driver to get loaded. With MDIO, the NIC
190 driver will get bored and give up as soon as it finds that
191 there's no driver _already_ loaded. */
192 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
193
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700194 return dev;
195}
196EXPORT_SYMBOL(phy_device_create);
197
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800198/**
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400199 * get_phy_id - reads the specified addr for its ID.
200 * @bus: the target MII bus
201 * @addr: PHY address on the MII bus
202 * @phy_id: where to store the ID retrieved.
203 *
204 * Description: Reads the ID registers of the PHY at @addr on the
205 * @bus, stores it in @phy_id and returns zero on success.
206 */
207int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id)
208{
209 int phy_reg;
210
211 /* Grab the bits from PHYIR1, and put them
212 * in the upper half */
213 phy_reg = bus->read(bus, addr, MII_PHYSID1);
214
215 if (phy_reg < 0)
216 return -EIO;
217
218 *phy_id = (phy_reg & 0xffff) << 16;
219
220 /* Grab the bits from PHYIR2, and put them in the lower half */
221 phy_reg = bus->read(bus, addr, MII_PHYSID2);
222
223 if (phy_reg < 0)
224 return -EIO;
225
226 *phy_id |= (phy_reg & 0xffff);
227
228 return 0;
229}
Paul Gortmakera01b3d72008-05-22 12:43:50 -0400230EXPORT_SYMBOL(get_phy_id);
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400231
232/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800233 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
234 * @bus: the target MII bus
235 * @addr: PHY address on the MII bus
Andy Fleming00db8182005-07-30 19:31:23 -0400236 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800237 * Description: Reads the ID registers of the PHY at @addr on the
238 * @bus, then allocates and returns the phy_device to represent it.
Andy Fleming00db8182005-07-30 19:31:23 -0400239 */
240struct phy_device * get_phy_device(struct mii_bus *bus, int addr)
241{
Andy Fleming00db8182005-07-30 19:31:23 -0400242 struct phy_device *dev = NULL;
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400243 u32 phy_id;
244 int r;
Andy Fleming00db8182005-07-30 19:31:23 -0400245
Paul Gortmakercac1f3c2008-04-15 12:49:21 -0400246 r = get_phy_id(bus, addr, &phy_id);
247 if (r)
248 return ERR_PTR(r);
Andy Fleming00db8182005-07-30 19:31:23 -0400249
Giuseppe Cavallaro6436cbc2008-11-20 20:43:18 -0800250 /* If the phy_id is mostly Fs, there is no device there */
251 if ((phy_id & 0x1fffffff) == 0x1fffffff)
252 return NULL;
253
Vitaly Bordug11b0bac2006-08-14 23:00:29 -0700254 dev = phy_device_create(bus, addr, phy_id);
Andy Fleming00db8182005-07-30 19:31:23 -0400255
256 return dev;
257}
Grant Likely4dea5472009-04-25 12:52:46 +0000258EXPORT_SYMBOL(get_phy_device);
259
260/**
261 * phy_device_register - Register the phy device on the MDIO bus
Randy Dunlap1d4ac5d2009-06-16 16:56:33 +0000262 * @phydev: phy_device structure to be added to the MDIO bus
Grant Likely4dea5472009-04-25 12:52:46 +0000263 */
264int phy_device_register(struct phy_device *phydev)
265{
266 int err;
267
268 /* Don't register a phy if one is already registered at this
269 * address */
270 if (phydev->bus->phy_map[phydev->addr])
271 return -EINVAL;
272 phydev->bus->phy_map[phydev->addr] = phydev;
273
274 /* Run all of the fixups for this PHY */
275 phy_scan_fixups(phydev);
276
277 err = device_register(&phydev->dev);
278 if (err) {
279 pr_err("phy %d failed to register\n", phydev->addr);
280 goto out;
281 }
282
283 return 0;
284
285 out:
286 phydev->bus->phy_map[phydev->addr] = NULL;
287 return err;
288}
289EXPORT_SYMBOL(phy_device_register);
Andy Fleming00db8182005-07-30 19:31:23 -0400290
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800291/**
Jiri Pirkof8f76db2010-02-04 10:23:02 -0800292 * phy_find_first - finds the first PHY device on the bus
293 * @bus: the target MII bus
294 */
295struct phy_device *phy_find_first(struct mii_bus *bus)
296{
297 int addr;
298
299 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
300 if (bus->phy_map[addr])
301 return bus->phy_map[addr];
302 }
303 return NULL;
304}
305EXPORT_SYMBOL(phy_find_first);
306
307/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800308 * phy_prepare_link - prepares the PHY layer to monitor link status
309 * @phydev: target phy_device struct
310 * @handler: callback function for link status change notifications
Andy Fleming00db8182005-07-30 19:31:23 -0400311 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800312 * Description: Tells the PHY infrastructure to handle the
Andy Fleming00db8182005-07-30 19:31:23 -0400313 * gory details on monitoring link status (whether through
314 * polling or an interrupt), and to call back to the
315 * connected device driver when the link status changes.
316 * If you want to monitor your own link state, don't call
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800317 * this function.
318 */
Andy Fleming00db8182005-07-30 19:31:23 -0400319void phy_prepare_link(struct phy_device *phydev,
320 void (*handler)(struct net_device *))
321{
322 phydev->adjust_link = handler;
323}
324
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800325/**
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000326 * phy_connect_direct - connect an ethernet device to a specific phy_device
327 * @dev: the network device to connect
328 * @phydev: the pointer to the phy device
329 * @handler: callback function for state change notifications
330 * @flags: PHY device's dev_flags
331 * @interface: PHY device's interface
332 */
333int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
334 void (*handler)(struct net_device *), u32 flags,
335 phy_interface_t interface)
336{
337 int rc;
338
339 rc = phy_attach_direct(dev, phydev, flags, interface);
340 if (rc)
341 return rc;
342
343 phy_prepare_link(phydev, handler);
344 phy_start_machine(phydev, NULL);
345 if (phydev->irq > 0)
346 phy_start_interrupts(phydev);
347
348 return 0;
349}
350EXPORT_SYMBOL(phy_connect_direct);
351
352/**
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800353 * phy_connect - connect an ethernet device to a PHY device
354 * @dev: the network device to connect
Randy Dunlap5d12b132008-04-28 10:58:22 -0700355 * @bus_id: the id string of the PHY device to connect
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800356 * @handler: callback function for state change notifications
357 * @flags: PHY device's dev_flags
358 * @interface: PHY device's interface
Andy Fleminge1393452005-08-24 18:46:21 -0500359 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800360 * Description: Convenience function for connecting ethernet
Andy Fleminge1393452005-08-24 18:46:21 -0500361 * devices to PHY devices. The default behavior is for
362 * the PHY infrastructure to handle everything, and only notify
363 * the connected driver when the link status changes. If you
364 * don't want, or can't use the provided functionality, you may
365 * choose to call only the subset of functions which provide
366 * the desired functionality.
367 */
Andy Flemingf62220d2008-04-18 17:29:54 -0500368struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600369 void (*handler)(struct net_device *), u32 flags,
Randy Dunlap1a168932007-02-05 10:44:20 -0800370 phy_interface_t interface)
Andy Fleminge1393452005-08-24 18:46:21 -0500371{
372 struct phy_device *phydev;
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000373 struct device *d;
374 int rc;
Andy Fleminge1393452005-08-24 18:46:21 -0500375
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000376 /* Search the list of PHY devices on the mdio bus for the
377 * PHY with the requested name */
378 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
379 if (!d) {
380 pr_err("PHY %s not found\n", bus_id);
381 return ERR_PTR(-ENODEV);
382 }
383 phydev = to_phy_device(d);
Andy Fleminge1393452005-08-24 18:46:21 -0500384
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000385 rc = phy_connect_direct(dev, phydev, handler, flags, interface);
386 if (rc)
387 return ERR_PTR(rc);
Andy Fleminge1393452005-08-24 18:46:21 -0500388
389 return phydev;
390}
391EXPORT_SYMBOL(phy_connect);
392
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800393/**
394 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY device
395 * @phydev: target phy_device struct
396 */
Andy Fleminge1393452005-08-24 18:46:21 -0500397void phy_disconnect(struct phy_device *phydev)
398{
399 if (phydev->irq > 0)
400 phy_stop_interrupts(phydev);
401
402 phy_stop_machine(phydev);
403
404 phydev->adjust_link = NULL;
405
406 phy_detach(phydev);
407}
408EXPORT_SYMBOL(phy_disconnect);
409
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000410int phy_init_hw(struct phy_device *phydev)
411{
412 int ret;
413
414 if (!phydev->drv || !phydev->drv->config_init)
415 return 0;
416
417 ret = phy_scan_fixups(phydev);
418 if (ret < 0)
419 return ret;
420
421 return phydev->drv->config_init(phydev);
422}
423
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800424/**
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000425 * phy_attach_direct - attach a network device to a given PHY device pointer
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800426 * @dev: network device to attach
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000427 * @phydev: Pointer to phy_device to attach
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800428 * @flags: PHY device's dev_flags
429 * @interface: PHY device's interface
430 *
431 * Description: Called by drivers to attach to a particular PHY
432 * device. The phy_device is found, and properly hooked up
433 * to the phy_driver. If no driver is attached, then the
434 * genphy_driver is used. The phy_device is given a ptr to
435 * the attaching device, and given a callback for link status
436 * change. The phy_device is returned to the attaching driver.
437 */
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000438int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
439 u32 flags, phy_interface_t interface)
Andy Fleminge1393452005-08-24 18:46:21 -0500440{
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000441 struct device *d = &phydev->dev;
Andy Fleminge1393452005-08-24 18:46:21 -0500442
443 /* Assume that if there is no driver, that it doesn't
444 * exist, and we should use the genphy driver. */
445 if (NULL == d->driver) {
446 int err;
Andy Fleminge1393452005-08-24 18:46:21 -0500447 d->driver = &genphy_driver.driver;
448
449 err = d->driver->probe(d);
Jeff Garzikb7a00ec2006-10-01 07:27:46 -0400450 if (err >= 0)
451 err = device_bind_driver(d);
Andy Fleminge1393452005-08-24 18:46:21 -0500452
Jeff Garzikb7a00ec2006-10-01 07:27:46 -0400453 if (err)
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000454 return err;
Andy Fleminge1393452005-08-24 18:46:21 -0500455 }
456
457 if (phydev->attached_dev) {
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000458 dev_err(&dev->dev, "PHY already attached\n");
459 return -EBUSY;
Andy Fleminge1393452005-08-24 18:46:21 -0500460 }
461
462 phydev->attached_dev = dev;
Richard Cochranc1f19b52010-07-17 08:49:36 +0000463 dev->phydev = phydev;
Andy Fleminge1393452005-08-24 18:46:21 -0500464
465 phydev->dev_flags = flags;
466
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600467 phydev->interface = interface;
468
469 /* Do initial configuration here, now that
470 * we have certain key parameters
471 * (dev_flags and interface) */
Anton Vorontsov2f5cb432009-12-30 08:23:30 +0000472 return phy_init_hw(phydev);
Grant Likelyfa94f6d2009-04-25 12:52:51 +0000473}
474EXPORT_SYMBOL(phy_attach_direct);
475
476/**
477 * phy_attach - attach a network device to a particular PHY device
478 * @dev: network device to attach
479 * @bus_id: Bus ID of PHY device to attach
480 * @flags: PHY device's dev_flags
481 * @interface: PHY device's interface
482 *
483 * Description: Same as phy_attach_direct() except that a PHY bus_id
484 * string is passed instead of a pointer to a struct phy_device.
485 */
486struct phy_device *phy_attach(struct net_device *dev,
487 const char *bus_id, u32 flags, phy_interface_t interface)
488{
489 struct bus_type *bus = &mdio_bus_type;
490 struct phy_device *phydev;
491 struct device *d;
492 int rc;
493
494 /* Search the list of PHY devices on the mdio bus for the
495 * PHY with the requested name */
496 d = bus_find_device_by_name(bus, NULL, bus_id);
497 if (!d) {
498 pr_err("PHY %s not found\n", bus_id);
499 return ERR_PTR(-ENODEV);
500 }
501 phydev = to_phy_device(d);
502
503 rc = phy_attach_direct(dev, phydev, flags, interface);
504 if (rc)
505 return ERR_PTR(rc);
506
Andy Fleminge1393452005-08-24 18:46:21 -0500507 return phydev;
508}
509EXPORT_SYMBOL(phy_attach);
510
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800511/**
512 * phy_detach - detach a PHY device from its network device
513 * @phydev: target phy_device struct
514 */
Andy Fleminge1393452005-08-24 18:46:21 -0500515void phy_detach(struct phy_device *phydev)
516{
Richard Cochranc1f19b52010-07-17 08:49:36 +0000517 phydev->attached_dev->phydev = NULL;
Andy Fleminge1393452005-08-24 18:46:21 -0500518 phydev->attached_dev = NULL;
519
520 /* If the device had no specific driver before (i.e. - it
521 * was using the generic driver), we unbind the device
522 * from the generic driver so that there's a chance a
523 * real driver could be loaded */
Greg Kroah-Hartman87aebe02007-04-09 11:52:31 -0400524 if (phydev->dev.driver == &genphy_driver.driver)
Andy Fleminge1393452005-08-24 18:46:21 -0500525 device_release_driver(&phydev->dev);
Andy Fleminge1393452005-08-24 18:46:21 -0500526}
527EXPORT_SYMBOL(phy_detach);
528
529
Andy Fleming00db8182005-07-30 19:31:23 -0400530/* Generic PHY support and helper functions */
531
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800532/**
533 * genphy_config_advert - sanitize and advertise auto-negotation parameters
534 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400535 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800536 * Description: Writes MII_ADVERTISE with the appropriate values,
Andy Fleming00db8182005-07-30 19:31:23 -0400537 * after sanitizing the values to make sure we only advertise
Trent Piepho51e2a382008-09-24 10:55:46 +0000538 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
539 * hasn't changed, and > 0 if it has changed.
Andy Fleming00db8182005-07-30 19:31:23 -0400540 */
Andy Fleminge1393452005-08-24 18:46:21 -0500541int genphy_config_advert(struct phy_device *phydev)
Andy Fleming00db8182005-07-30 19:31:23 -0400542{
543 u32 advertise;
Trent Piepho51e2a382008-09-24 10:55:46 +0000544 int oldadv, adv;
545 int err, changed = 0;
Andy Fleming00db8182005-07-30 19:31:23 -0400546
547 /* Only allow advertising what
548 * this PHY supports */
549 phydev->advertising &= phydev->supported;
550 advertise = phydev->advertising;
551
552 /* Setup standard advertisement */
Trent Piepho51e2a382008-09-24 10:55:46 +0000553 oldadv = adv = phy_read(phydev, MII_ADVERTISE);
Andy Fleming00db8182005-07-30 19:31:23 -0400554
555 if (adv < 0)
556 return adv;
557
558 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
559 ADVERTISE_PAUSE_ASYM);
560 if (advertise & ADVERTISED_10baseT_Half)
561 adv |= ADVERTISE_10HALF;
562 if (advertise & ADVERTISED_10baseT_Full)
563 adv |= ADVERTISE_10FULL;
564 if (advertise & ADVERTISED_100baseT_Half)
565 adv |= ADVERTISE_100HALF;
566 if (advertise & ADVERTISED_100baseT_Full)
567 adv |= ADVERTISE_100FULL;
568 if (advertise & ADVERTISED_Pause)
569 adv |= ADVERTISE_PAUSE_CAP;
570 if (advertise & ADVERTISED_Asym_Pause)
571 adv |= ADVERTISE_PAUSE_ASYM;
572
Trent Piepho51e2a382008-09-24 10:55:46 +0000573 if (adv != oldadv) {
574 err = phy_write(phydev, MII_ADVERTISE, adv);
Andy Fleming00db8182005-07-30 19:31:23 -0400575
Trent Piepho51e2a382008-09-24 10:55:46 +0000576 if (err < 0)
577 return err;
578 changed = 1;
579 }
Andy Fleming00db8182005-07-30 19:31:23 -0400580
581 /* Configure gigabit if it's supported */
582 if (phydev->supported & (SUPPORTED_1000baseT_Half |
583 SUPPORTED_1000baseT_Full)) {
Trent Piepho51e2a382008-09-24 10:55:46 +0000584 oldadv = adv = phy_read(phydev, MII_CTRL1000);
Andy Fleming00db8182005-07-30 19:31:23 -0400585
586 if (adv < 0)
587 return adv;
588
589 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
590 if (advertise & SUPPORTED_1000baseT_Half)
591 adv |= ADVERTISE_1000HALF;
592 if (advertise & SUPPORTED_1000baseT_Full)
593 adv |= ADVERTISE_1000FULL;
Andy Fleming00db8182005-07-30 19:31:23 -0400594
Trent Piepho51e2a382008-09-24 10:55:46 +0000595 if (adv != oldadv) {
596 err = phy_write(phydev, MII_CTRL1000, adv);
597
598 if (err < 0)
599 return err;
600 changed = 1;
601 }
Andy Fleming00db8182005-07-30 19:31:23 -0400602 }
603
Trent Piepho51e2a382008-09-24 10:55:46 +0000604 return changed;
Andy Fleming00db8182005-07-30 19:31:23 -0400605}
Andy Fleminge1393452005-08-24 18:46:21 -0500606EXPORT_SYMBOL(genphy_config_advert);
Andy Fleming00db8182005-07-30 19:31:23 -0400607
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800608/**
609 * genphy_setup_forced - configures/forces speed/duplex from @phydev
610 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400611 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800612 * Description: Configures MII_BMCR to force speed/duplex
Andy Fleming00db8182005-07-30 19:31:23 -0400613 * to the values in phydev. Assumes that the values are valid.
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800614 * Please see phy_sanitize_settings().
615 */
Andy Fleming00db8182005-07-30 19:31:23 -0400616int genphy_setup_forced(struct phy_device *phydev)
617{
Andy Flemingf62220d2008-04-18 17:29:54 -0500618 int err;
Domen Puncerbc1e0a02007-08-17 08:54:45 +0200619 int ctl = 0;
Andy Fleming00db8182005-07-30 19:31:23 -0400620
621 phydev->pause = phydev->asym_pause = 0;
622
623 if (SPEED_1000 == phydev->speed)
624 ctl |= BMCR_SPEED1000;
625 else if (SPEED_100 == phydev->speed)
626 ctl |= BMCR_SPEED100;
627
628 if (DUPLEX_FULL == phydev->duplex)
629 ctl |= BMCR_FULLDPLX;
630
Andy Flemingf62220d2008-04-18 17:29:54 -0500631 err = phy_write(phydev, MII_BMCR, ctl);
Andy Fleming00db8182005-07-30 19:31:23 -0400632
Andy Flemingf62220d2008-04-18 17:29:54 -0500633 return err;
Andy Fleming00db8182005-07-30 19:31:23 -0400634}
635
636
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800637/**
638 * genphy_restart_aneg - Enable and Restart Autonegotiation
639 * @phydev: target phy_device struct
640 */
Andy Fleming00db8182005-07-30 19:31:23 -0400641int genphy_restart_aneg(struct phy_device *phydev)
642{
643 int ctl;
644
645 ctl = phy_read(phydev, MII_BMCR);
646
647 if (ctl < 0)
648 return ctl;
649
650 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
651
652 /* Don't isolate the PHY if we're negotiating */
653 ctl &= ~(BMCR_ISOLATE);
654
655 ctl = phy_write(phydev, MII_BMCR, ctl);
656
657 return ctl;
658}
Adrian Bunk892871d2008-10-13 18:48:09 -0700659EXPORT_SYMBOL(genphy_restart_aneg);
Andy Fleming00db8182005-07-30 19:31:23 -0400660
661
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800662/**
663 * genphy_config_aneg - restart auto-negotiation or write BMCR
664 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400665 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800666 * Description: If auto-negotiation is enabled, we configure the
Andy Fleming00db8182005-07-30 19:31:23 -0400667 * advertising, and then restart auto-negotiation. If it is not
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800668 * enabled, then we write the BMCR.
Andy Fleming00db8182005-07-30 19:31:23 -0400669 */
670int genphy_config_aneg(struct phy_device *phydev)
671{
Trent Piephode339c22008-11-19 15:52:41 -0800672 int result;
Andy Fleming00db8182005-07-30 19:31:23 -0400673
Trent Piephode339c22008-11-19 15:52:41 -0800674 if (AUTONEG_ENABLE != phydev->autoneg)
675 return genphy_setup_forced(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400676
Trent Piephode339c22008-11-19 15:52:41 -0800677 result = genphy_config_advert(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400678
Trent Piephode339c22008-11-19 15:52:41 -0800679 if (result < 0) /* error */
680 return result;
681
682 if (result == 0) {
683 /* Advertisment hasn't changed, but maybe aneg was never on to
684 * begin with? Or maybe phy was isolated? */
685 int ctl = phy_read(phydev, MII_BMCR);
686
687 if (ctl < 0)
688 return ctl;
689
690 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
691 result = 1; /* do restart aneg */
692 }
693
694 /* Only restart aneg if we are advertising something different
695 * than we were before. */
696 if (result > 0)
697 result = genphy_restart_aneg(phydev);
Andy Fleming00db8182005-07-30 19:31:23 -0400698
Trent Piepho51e2a382008-09-24 10:55:46 +0000699 return result;
Andy Fleming00db8182005-07-30 19:31:23 -0400700}
701EXPORT_SYMBOL(genphy_config_aneg);
702
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800703/**
704 * genphy_update_link - update link status in @phydev
705 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400706 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800707 * Description: Update the value in phydev->link to reflect the
Andy Fleming00db8182005-07-30 19:31:23 -0400708 * current link value. In order to do this, we need to read
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800709 * the status register twice, keeping the second value.
Andy Fleming00db8182005-07-30 19:31:23 -0400710 */
711int genphy_update_link(struct phy_device *phydev)
712{
713 int status;
714
715 /* Do a fake read */
716 status = phy_read(phydev, MII_BMSR);
717
718 if (status < 0)
719 return status;
720
721 /* Read link and autonegotiation status */
722 status = phy_read(phydev, MII_BMSR);
723
724 if (status < 0)
725 return status;
726
727 if ((status & BMSR_LSTATUS) == 0)
728 phydev->link = 0;
729 else
730 phydev->link = 1;
731
732 return 0;
733}
Andy Fleming6b655522006-10-16 16:19:17 -0500734EXPORT_SYMBOL(genphy_update_link);
Andy Fleming00db8182005-07-30 19:31:23 -0400735
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800736/**
737 * genphy_read_status - check the link status and update current link state
738 * @phydev: target phy_device struct
Andy Fleming00db8182005-07-30 19:31:23 -0400739 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800740 * Description: Check the link, then figure out the current state
Andy Fleming00db8182005-07-30 19:31:23 -0400741 * by comparing what we advertise with what the link partner
742 * advertises. Start by checking the gigabit possibilities,
743 * then move on to 10/100.
744 */
745int genphy_read_status(struct phy_device *phydev)
746{
747 int adv;
748 int err;
749 int lpa;
750 int lpagb = 0;
751
752 /* Update the link, but return if there
753 * was an error */
754 err = genphy_update_link(phydev);
755 if (err)
756 return err;
757
758 if (AUTONEG_ENABLE == phydev->autoneg) {
759 if (phydev->supported & (SUPPORTED_1000baseT_Half
760 | SUPPORTED_1000baseT_Full)) {
761 lpagb = phy_read(phydev, MII_STAT1000);
762
763 if (lpagb < 0)
764 return lpagb;
765
766 adv = phy_read(phydev, MII_CTRL1000);
767
768 if (adv < 0)
769 return adv;
770
771 lpagb &= adv << 2;
772 }
773
774 lpa = phy_read(phydev, MII_LPA);
775
776 if (lpa < 0)
777 return lpa;
778
779 adv = phy_read(phydev, MII_ADVERTISE);
780
781 if (adv < 0)
782 return adv;
783
784 lpa &= adv;
785
786 phydev->speed = SPEED_10;
787 phydev->duplex = DUPLEX_HALF;
788 phydev->pause = phydev->asym_pause = 0;
789
790 if (lpagb & (LPA_1000FULL | LPA_1000HALF)) {
791 phydev->speed = SPEED_1000;
792
793 if (lpagb & LPA_1000FULL)
794 phydev->duplex = DUPLEX_FULL;
795 } else if (lpa & (LPA_100FULL | LPA_100HALF)) {
796 phydev->speed = SPEED_100;
797
798 if (lpa & LPA_100FULL)
799 phydev->duplex = DUPLEX_FULL;
800 } else
801 if (lpa & LPA_10FULL)
802 phydev->duplex = DUPLEX_FULL;
803
804 if (phydev->duplex == DUPLEX_FULL){
805 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
806 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
807 }
808 } else {
809 int bmcr = phy_read(phydev, MII_BMCR);
810 if (bmcr < 0)
811 return bmcr;
812
813 if (bmcr & BMCR_FULLDPLX)
814 phydev->duplex = DUPLEX_FULL;
815 else
816 phydev->duplex = DUPLEX_HALF;
817
818 if (bmcr & BMCR_SPEED1000)
819 phydev->speed = SPEED_1000;
820 else if (bmcr & BMCR_SPEED100)
821 phydev->speed = SPEED_100;
822 else
823 phydev->speed = SPEED_10;
824
825 phydev->pause = phydev->asym_pause = 0;
826 }
827
828 return 0;
829}
830EXPORT_SYMBOL(genphy_read_status);
831
832static int genphy_config_init(struct phy_device *phydev)
833{
Eric Sesterhenn84c22d72006-09-25 16:39:22 -0700834 int val;
Andy Fleming00db8182005-07-30 19:31:23 -0400835 u32 features;
836
837 /* For now, I'll claim that the generic driver supports
838 * all possible port types */
839 features = (SUPPORTED_TP | SUPPORTED_MII
840 | SUPPORTED_AUI | SUPPORTED_FIBRE |
841 SUPPORTED_BNC);
842
843 /* Do we support autonegotiation? */
844 val = phy_read(phydev, MII_BMSR);
845
846 if (val < 0)
847 return val;
848
849 if (val & BMSR_ANEGCAPABLE)
850 features |= SUPPORTED_Autoneg;
851
852 if (val & BMSR_100FULL)
853 features |= SUPPORTED_100baseT_Full;
854 if (val & BMSR_100HALF)
855 features |= SUPPORTED_100baseT_Half;
856 if (val & BMSR_10FULL)
857 features |= SUPPORTED_10baseT_Full;
858 if (val & BMSR_10HALF)
859 features |= SUPPORTED_10baseT_Half;
860
861 if (val & BMSR_ESTATEN) {
862 val = phy_read(phydev, MII_ESTATUS);
863
864 if (val < 0)
865 return val;
866
867 if (val & ESTATUS_1000_TFULL)
868 features |= SUPPORTED_1000baseT_Full;
869 if (val & ESTATUS_1000_THALF)
870 features |= SUPPORTED_1000baseT_Half;
871 }
872
873 phydev->supported = features;
874 phydev->advertising = features;
875
876 return 0;
877}
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -0800878int genphy_suspend(struct phy_device *phydev)
879{
880 int value;
Andy Fleming00db8182005-07-30 19:31:23 -0400881
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -0800882 mutex_lock(&phydev->lock);
883
884 value = phy_read(phydev, MII_BMCR);
885 phy_write(phydev, MII_BMCR, (value | BMCR_PDOWN));
886
887 mutex_unlock(&phydev->lock);
888
889 return 0;
890}
891EXPORT_SYMBOL(genphy_suspend);
892
893int genphy_resume(struct phy_device *phydev)
894{
895 int value;
896
897 mutex_lock(&phydev->lock);
898
899 value = phy_read(phydev, MII_BMCR);
900 phy_write(phydev, MII_BMCR, (value & ~BMCR_PDOWN));
901
902 mutex_unlock(&phydev->lock);
903
904 return 0;
905}
906EXPORT_SYMBOL(genphy_resume);
Andy Fleming00db8182005-07-30 19:31:23 -0400907
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800908/**
909 * phy_probe - probe and init a PHY device
910 * @dev: device to probe and init
Andy Fleming00db8182005-07-30 19:31:23 -0400911 *
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800912 * Description: Take care of setting up the phy_device structure,
Andy Fleming00db8182005-07-30 19:31:23 -0400913 * set the state to READY (the driver's init function should
914 * set it to STARTING if needed).
915 */
916static int phy_probe(struct device *dev)
917{
918 struct phy_device *phydev;
919 struct phy_driver *phydrv;
920 struct device_driver *drv;
921 int err = 0;
922
923 phydev = to_phy_device(dev);
924
925 /* Make sure the driver is held.
926 * XXX -- Is this correct? */
927 drv = get_driver(phydev->dev.driver);
928 phydrv = to_phy_driver(drv);
929 phydev->drv = phydrv;
930
931 /* Disable the interrupt if the PHY doesn't support it */
932 if (!(phydrv->flags & PHY_HAS_INTERRUPT))
933 phydev->irq = PHY_POLL;
934
Nate Case35b5f6b2008-01-29 10:05:09 -0600935 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400936
937 /* Start out supporting everything. Eventually,
938 * a controller will attach, and may modify one
939 * or both of these values */
940 phydev->supported = phydrv->features;
941 phydev->advertising = phydrv->features;
942
943 /* Set the state to READY by default */
944 phydev->state = PHY_READY;
945
946 if (phydev->drv->probe)
947 err = phydev->drv->probe(phydev);
948
Nate Case35b5f6b2008-01-29 10:05:09 -0600949 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400950
Andy Fleming00db8182005-07-30 19:31:23 -0400951 return err;
Andy Fleminge8a2b6a2006-12-01 12:01:06 -0600952
Andy Fleming00db8182005-07-30 19:31:23 -0400953}
954
955static int phy_remove(struct device *dev)
956{
957 struct phy_device *phydev;
958
959 phydev = to_phy_device(dev);
960
Nate Case35b5f6b2008-01-29 10:05:09 -0600961 mutex_lock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400962 phydev->state = PHY_DOWN;
Nate Case35b5f6b2008-01-29 10:05:09 -0600963 mutex_unlock(&phydev->lock);
Andy Fleming00db8182005-07-30 19:31:23 -0400964
965 if (phydev->drv->remove)
966 phydev->drv->remove(phydev);
967
968 put_driver(dev->driver);
969 phydev->drv = NULL;
970
971 return 0;
972}
973
Randy Dunlapb3df0da2007-03-06 02:41:48 -0800974/**
975 * phy_driver_register - register a phy_driver with the PHY layer
976 * @new_driver: new phy_driver to register
977 */
Andy Fleming00db8182005-07-30 19:31:23 -0400978int phy_driver_register(struct phy_driver *new_driver)
979{
980 int retval;
981
Andy Fleming00db8182005-07-30 19:31:23 -0400982 new_driver->driver.name = new_driver->name;
983 new_driver->driver.bus = &mdio_bus_type;
984 new_driver->driver.probe = phy_probe;
985 new_driver->driver.remove = phy_remove;
986
987 retval = driver_register(&new_driver->driver);
988
989 if (retval) {
990 printk(KERN_ERR "%s: Error %d in registering driver\n",
991 new_driver->name, retval);
992
993 return retval;
994 }
995
Olof Johanssonf2511f12007-11-04 16:09:23 -0600996 pr_debug("%s: Registered new driver\n", new_driver->name);
Andy Fleming00db8182005-07-30 19:31:23 -0400997
998 return 0;
999}
1000EXPORT_SYMBOL(phy_driver_register);
1001
1002void phy_driver_unregister(struct phy_driver *drv)
1003{
1004 driver_unregister(&drv->driver);
1005}
1006EXPORT_SYMBOL(phy_driver_unregister);
1007
Andy Fleminge1393452005-08-24 18:46:21 -05001008static struct phy_driver genphy_driver = {
1009 .phy_id = 0xffffffff,
1010 .phy_id_mask = 0xffffffff,
1011 .name = "Generic PHY",
1012 .config_init = genphy_config_init,
1013 .features = 0,
1014 .config_aneg = genphy_config_aneg,
1015 .read_status = genphy_read_status,
Giuseppe Cavallaro0f0ca342008-11-28 16:24:56 -08001016 .suspend = genphy_suspend,
1017 .resume = genphy_resume,
Andy Fleminge1393452005-08-24 18:46:21 -05001018 .driver = {.owner= THIS_MODULE, },
1019};
Andy Fleming00db8182005-07-30 19:31:23 -04001020
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001021static int __init phy_init(void)
Andy Fleming00db8182005-07-30 19:31:23 -04001022{
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001023 int rc;
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001024
1025 rc = mdio_bus_init();
1026 if (rc)
Andy Fleminge1393452005-08-24 18:46:21 -05001027 return rc;
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001028
Andy Fleminge1393452005-08-24 18:46:21 -05001029 rc = phy_driver_register(&genphy_driver);
1030 if (rc)
1031 mdio_bus_exit();
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001032
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001033 return rc;
Andy Fleming00db8182005-07-30 19:31:23 -04001034}
1035
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001036static void __exit phy_exit(void)
Andy Fleming00db8182005-07-30 19:31:23 -04001037{
1038 phy_driver_unregister(&genphy_driver);
Andy Fleminge1393452005-08-24 18:46:21 -05001039 mdio_bus_exit();
Andy Fleming00db8182005-07-30 19:31:23 -04001040}
1041
Andy Fleminge1393452005-08-24 18:46:21 -05001042subsys_initcall(phy_init);
Jeff Garzik67c4f3f2005-08-11 02:07:25 -04001043module_exit(phy_exit);