phylib: remove unused adjust_state() callback
[linux-2.6-block.git] / drivers / net / phy / phy_device.c
CommitLineData
2f53e904 1/* Framework for finding and configuring PHYs.
00db8189
AF
2 * Also contains generic PHY driver
3 *
4 * Author: Andy Fleming
5 *
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
12 *
13 */
8d242488
JP
14
15#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16
00db8189 17#include <linux/kernel.h>
00db8189
AF
18#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>
00db8189
AF
28#include <linux/mm.h>
29#include <linux/module.h>
00db8189
AF
30#include <linux/mii.h>
31#include <linux/ethtool.h>
32#include <linux/phy.h>
2f53e904
SS
33#include <linux/io.h>
34#include <linux/uaccess.h>
00db8189 35
00db8189 36#include <asm/irq.h>
00db8189 37
afcceaa3
OH
38MODULE_DESCRIPTION("PHY library");
39MODULE_AUTHOR("Andy Fleming");
40MODULE_LICENSE("GPL");
41
6f4a7f41
AV
42void phy_device_free(struct phy_device *phydev)
43{
b2a43191 44 put_device(&phydev->dev);
6f4a7f41 45}
4dea547f 46EXPORT_SYMBOL(phy_device_free);
6f4a7f41
AV
47
48static void phy_device_release(struct device *dev)
49{
b2a43191 50 kfree(to_phy_device(dev));
6f4a7f41
AV
51}
52
4dea547f 53static struct phy_driver genphy_driver;
4dea547f 54
f62220d3
AF
55static LIST_HEAD(phy_fixup_list);
56static DEFINE_MUTEX(phy_fixup_lock);
57
89ff05ec 58static int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
59 u32 flags, phy_interface_t interface);
60
2f53e904
SS
61/**
62 * phy_register_fixup - creates a new phy_fixup and adds it to the list
f62220d3
AF
63 * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
64 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
2f53e904 65 * It can also be PHY_ANY_UID
f62220d3 66 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
2f53e904 67 * comparison
f62220d3
AF
68 * @run: The actual code to be run when a matching PHY is found
69 */
70int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
2f53e904 71 int (*run)(struct phy_device *))
f62220d3 72{
553fe92b 73 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
f62220d3 74
f62220d3
AF
75 if (!fixup)
76 return -ENOMEM;
77
fb28ad35 78 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
f62220d3
AF
79 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,
2f53e904 93 int (*run)(struct phy_device *))
f62220d3
AF
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,
2f53e904 101 int (*run)(struct phy_device *))
f62220d3
AF
102{
103 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
104}
105EXPORT_SYMBOL(phy_register_fixup_for_id);
106
2f53e904 107/* Returns 1 if fixup matches phydev in bus_id and phy_uid.
f62220d3
AF
108 * Fixups can be set to match any in one or more fields.
109 */
110static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
111{
fb28ad35 112 if (strcmp(fixup->bus_id, dev_name(&phydev->dev)) != 0)
f62220d3
AF
113 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
114 return 0;
115
116 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
2f53e904 117 (phydev->phy_id & fixup->phy_uid_mask))
f62220d3
AF
118 if (fixup->phy_uid != PHY_ANY_UID)
119 return 0;
120
121 return 1;
122}
123
124/* Runs any matching fixups for this phydev */
125int phy_scan_fixups(struct phy_device *phydev)
126{
127 struct phy_fixup *fixup;
128
129 mutex_lock(&phy_fixup_lock);
130 list_for_each_entry(fixup, &phy_fixup_list, list) {
131 if (phy_needs_fixup(phydev, fixup)) {
553fe92b 132 int err = fixup->run(phydev);
f62220d3 133
bc23283c
JS
134 if (err < 0) {
135 mutex_unlock(&phy_fixup_lock);
f62220d3 136 return err;
bc23283c 137 }
f62220d3
AF
138 }
139 }
140 mutex_unlock(&phy_fixup_lock);
141
142 return 0;
143}
144EXPORT_SYMBOL(phy_scan_fixups);
145
ac28b9f8 146struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
2f53e904
SS
147 bool is_c45,
148 struct phy_c45_device_ids *c45_ids)
11b0bacd
VB
149{
150 struct phy_device *dev;
8626d3b4 151
2f53e904 152 /* We allocate the device, and initialize the default values */
cd861280 153 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
11b0bacd 154 if (NULL == dev)
e109374f 155 return (struct phy_device *)PTR_ERR((void *)-ENOMEM);
11b0bacd 156
6f4a7f41
AV
157 dev->dev.release = phy_device_release;
158
11b0bacd
VB
159 dev->speed = 0;
160 dev->duplex = -1;
2f53e904
SS
161 dev->pause = 0;
162 dev->asym_pause = 0;
11b0bacd 163 dev->link = 1;
e8a2b6a4 164 dev->interface = PHY_INTERFACE_MODE_GMII;
11b0bacd
VB
165
166 dev->autoneg = AUTONEG_ENABLE;
167
ac28b9f8 168 dev->is_c45 = is_c45;
11b0bacd
VB
169 dev->addr = addr;
170 dev->phy_id = phy_id;
ac28b9f8
DD
171 if (c45_ids)
172 dev->c45_ids = *c45_ids;
11b0bacd 173 dev->bus = bus;
4dea547f
GL
174 dev->dev.parent = bus->parent;
175 dev->dev.bus = &mdio_bus_type;
176 dev->irq = bus->irq != NULL ? bus->irq[addr] : PHY_POLL;
177 dev_set_name(&dev->dev, PHY_ID_FMT, bus->id, addr);
11b0bacd
VB
178
179 dev->state = PHY_DOWN;
180
35b5f6b1 181 mutex_init(&dev->lock);
4f9c85a1 182 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
5ea94e76 183 INIT_WORK(&dev->phy_queue, phy_change);
11b0bacd 184
8626d3b4 185 /* Request the appropriate module unconditionally; don't
2f53e904
SS
186 * bother trying to do so only if it isn't already loaded,
187 * because that gets complicated. A hotplug event would have
188 * done an unconditional modprobe anyway.
189 * We don't do normal hotplug because it won't work for MDIO
190 * -- because it relies on the device staying around for long
191 * enough for the driver to get loaded. With MDIO, the NIC
192 * driver will get bored and give up as soon as it finds that
193 * there's no driver _already_ loaded.
194 */
8626d3b4
DW
195 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
196
b2a43191
PM
197 device_initialize(&dev->dev);
198
11b0bacd
VB
199 return dev;
200}
ac28b9f8
DD
201EXPORT_SYMBOL(phy_device_create);
202
203/**
204 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
205 * @bus: the target MII bus
206 * @addr: PHY address on the MII bus
207 * @phy_id: where to store the ID retrieved.
208 * @c45_ids: where to store the c45 ID information.
209 *
210 * If the PHY devices-in-package appears to be valid, it and the
211 * corresponding identifiers are stored in @c45_ids, zero is stored
212 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
213 * zero on success.
214 *
215 */
216static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
217 struct phy_c45_device_ids *c45_ids) {
218 int phy_reg;
219 int i, reg_addr;
220 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
221
222 /* Find first non-zero Devices In package. Device
223 * zero is reserved, so don't probe it.
224 */
225 for (i = 1;
226 i < num_ids && c45_ids->devices_in_package == 0;
227 i++) {
228 reg_addr = MII_ADDR_C45 | i << 16 | 6;
229 phy_reg = mdiobus_read(bus, addr, reg_addr);
230 if (phy_reg < 0)
231 return -EIO;
232 c45_ids->devices_in_package = (phy_reg & 0xffff) << 16;
233
234 reg_addr = MII_ADDR_C45 | i << 16 | 5;
235 phy_reg = mdiobus_read(bus, addr, reg_addr);
236 if (phy_reg < 0)
237 return -EIO;
238 c45_ids->devices_in_package |= (phy_reg & 0xffff);
239
240 /* If mostly Fs, there is no device there,
241 * let's get out of here.
242 */
243 if ((c45_ids->devices_in_package & 0x1fffffff) == 0x1fffffff) {
244 *phy_id = 0xffffffff;
245 return 0;
246 }
247 }
248
249 /* Now probe Device Identifiers for each device present. */
250 for (i = 1; i < num_ids; i++) {
251 if (!(c45_ids->devices_in_package & (1 << i)))
252 continue;
253
254 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
255 phy_reg = mdiobus_read(bus, addr, reg_addr);
256 if (phy_reg < 0)
257 return -EIO;
258 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
259
260 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
261 phy_reg = mdiobus_read(bus, addr, reg_addr);
262 if (phy_reg < 0)
263 return -EIO;
264 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
265 }
266 *phy_id = 0;
267 return 0;
268}
11b0bacd 269
b3df0da8 270/**
cac1f3c8 271 * get_phy_id - reads the specified addr for its ID.
b3df0da8
RD
272 * @bus: the target MII bus
273 * @addr: PHY address on the MII bus
cac1f3c8 274 * @phy_id: where to store the ID retrieved.
ac28b9f8
DD
275 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
276 * @c45_ids: where to store the c45 ID information.
277 *
278 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
279 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
280 * zero on success.
281 *
282 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
283 * its return value is in turn returned.
00db8189 284 *
00db8189 285 */
ac28b9f8
DD
286static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
287 bool is_c45, struct phy_c45_device_ids *c45_ids)
00db8189
AF
288{
289 int phy_reg;
00db8189 290
ac28b9f8
DD
291 if (is_c45)
292 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
293
2f53e904 294 /* Grab the bits from PHYIR1, and put them in the upper half */
6fe32649 295 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
00db8189 296 if (phy_reg < 0)
cac1f3c8 297 return -EIO;
00db8189 298
cac1f3c8 299 *phy_id = (phy_reg & 0xffff) << 16;
00db8189
AF
300
301 /* Grab the bits from PHYIR2, and put them in the lower half */
6fe32649 302 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
00db8189 303 if (phy_reg < 0)
cac1f3c8
PG
304 return -EIO;
305
306 *phy_id |= (phy_reg & 0xffff);
307
308 return 0;
309}
310
311/**
2f53e904
SS
312 * get_phy_device - reads the specified PHY device and returns its @phy_device
313 * struct
cac1f3c8
PG
314 * @bus: the target MII bus
315 * @addr: PHY address on the MII bus
ac28b9f8 316 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
cac1f3c8
PG
317 *
318 * Description: Reads the ID registers of the PHY at @addr on the
319 * @bus, then allocates and returns the phy_device to represent it.
320 */
ac28b9f8 321struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
cac1f3c8 322{
ac28b9f8 323 struct phy_c45_device_ids c45_ids = {0};
160c85f0 324 u32 phy_id = 0;
cac1f3c8 325 int r;
00db8189 326
ac28b9f8 327 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
cac1f3c8
PG
328 if (r)
329 return ERR_PTR(r);
00db8189 330
6436cbcd
GC
331 /* If the phy_id is mostly Fs, there is no device there */
332 if ((phy_id & 0x1fffffff) == 0x1fffffff)
333 return NULL;
334
e62a768f 335 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
00db8189 336}
4dea547f
GL
337EXPORT_SYMBOL(get_phy_device);
338
339/**
340 * phy_device_register - Register the phy device on the MDIO bus
1d4ac5d5 341 * @phydev: phy_device structure to be added to the MDIO bus
4dea547f
GL
342 */
343int phy_device_register(struct phy_device *phydev)
344{
345 int err;
346
2f53e904 347 /* Don't register a phy if one is already registered at this address */
4dea547f
GL
348 if (phydev->bus->phy_map[phydev->addr])
349 return -EINVAL;
350 phydev->bus->phy_map[phydev->addr] = phydev;
351
352 /* Run all of the fixups for this PHY */
87aa9f9c
FF
353 err = phy_init_hw(phydev);
354 if (err) {
355 pr_err("PHY %d failed to initialize\n", phydev->addr);
356 goto out;
357 }
4dea547f 358
b2a43191 359 err = device_add(&phydev->dev);
4dea547f 360 if (err) {
b2a43191 361 pr_err("PHY %d failed to add\n", phydev->addr);
4dea547f
GL
362 goto out;
363 }
364
365 return 0;
366
367 out:
368 phydev->bus->phy_map[phydev->addr] = NULL;
369 return err;
370}
371EXPORT_SYMBOL(phy_device_register);
00db8189 372
f8f76db1
JP
373/**
374 * phy_find_first - finds the first PHY device on the bus
375 * @bus: the target MII bus
376 */
377struct phy_device *phy_find_first(struct mii_bus *bus)
378{
379 int addr;
380
381 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
382 if (bus->phy_map[addr])
383 return bus->phy_map[addr];
384 }
385 return NULL;
386}
387EXPORT_SYMBOL(phy_find_first);
388
b3df0da8
RD
389/**
390 * phy_prepare_link - prepares the PHY layer to monitor link status
391 * @phydev: target phy_device struct
392 * @handler: callback function for link status change notifications
00db8189 393 *
b3df0da8 394 * Description: Tells the PHY infrastructure to handle the
00db8189
AF
395 * gory details on monitoring link status (whether through
396 * polling or an interrupt), and to call back to the
397 * connected device driver when the link status changes.
398 * If you want to monitor your own link state, don't call
b3df0da8
RD
399 * this function.
400 */
89ff05ec 401static void phy_prepare_link(struct phy_device *phydev,
2f53e904 402 void (*handler)(struct net_device *))
00db8189
AF
403{
404 phydev->adjust_link = handler;
405}
406
fa94f6d9
GL
407/**
408 * phy_connect_direct - connect an ethernet device to a specific phy_device
409 * @dev: the network device to connect
410 * @phydev: the pointer to the phy device
411 * @handler: callback function for state change notifications
fa94f6d9
GL
412 * @interface: PHY device's interface
413 */
414int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
f9a8f83b 415 void (*handler)(struct net_device *),
fa94f6d9
GL
416 phy_interface_t interface)
417{
418 int rc;
419
f9a8f83b 420 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
fa94f6d9
GL
421 if (rc)
422 return rc;
423
424 phy_prepare_link(phydev, handler);
29935aeb 425 phy_start_machine(phydev);
fa94f6d9
GL
426 if (phydev->irq > 0)
427 phy_start_interrupts(phydev);
428
429 return 0;
430}
431EXPORT_SYMBOL(phy_connect_direct);
432
b3df0da8
RD
433/**
434 * phy_connect - connect an ethernet device to a PHY device
435 * @dev: the network device to connect
5d12b132 436 * @bus_id: the id string of the PHY device to connect
b3df0da8 437 * @handler: callback function for state change notifications
b3df0da8 438 * @interface: PHY device's interface
e1393456 439 *
b3df0da8 440 * Description: Convenience function for connecting ethernet
e1393456
AF
441 * devices to PHY devices. The default behavior is for
442 * the PHY infrastructure to handle everything, and only notify
443 * the connected driver when the link status changes. If you
444 * don't want, or can't use the provided functionality, you may
445 * choose to call only the subset of functions which provide
446 * the desired functionality.
447 */
e109374f 448struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
2f53e904
SS
449 void (*handler)(struct net_device *),
450 phy_interface_t interface)
e1393456
AF
451{
452 struct phy_device *phydev;
fa94f6d9
GL
453 struct device *d;
454 int rc;
e1393456 455
fa94f6d9 456 /* Search the list of PHY devices on the mdio bus for the
2f53e904
SS
457 * PHY with the requested name
458 */
fa94f6d9
GL
459 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
460 if (!d) {
461 pr_err("PHY %s not found\n", bus_id);
462 return ERR_PTR(-ENODEV);
463 }
464 phydev = to_phy_device(d);
e1393456 465
f9a8f83b 466 rc = phy_connect_direct(dev, phydev, handler, interface);
fa94f6d9
GL
467 if (rc)
468 return ERR_PTR(rc);
e1393456
AF
469
470 return phydev;
471}
472EXPORT_SYMBOL(phy_connect);
473
b3df0da8 474/**
2f53e904
SS
475 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
476 * device
b3df0da8
RD
477 * @phydev: target phy_device struct
478 */
e1393456
AF
479void phy_disconnect(struct phy_device *phydev)
480{
481 if (phydev->irq > 0)
482 phy_stop_interrupts(phydev);
483
484 phy_stop_machine(phydev);
e109374f 485
e1393456
AF
486 phydev->adjust_link = NULL;
487
488 phy_detach(phydev);
489}
490EXPORT_SYMBOL(phy_disconnect);
491
87aa9f9c
FF
492/**
493 * phy_poll_reset - Safely wait until a PHY reset has properly completed
494 * @phydev: The PHY device to poll
495 *
496 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
497 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
498 * register must be polled until the BMCR_RESET bit clears.
499 *
500 * Furthermore, any attempts to write to PHY registers may have no effect
501 * or even generate MDIO bus errors until this is complete.
502 *
503 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
504 * standard and do not fully reset after the BMCR_RESET bit is set, and may
505 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
506 * effort to support such broken PHYs, this function is separate from the
507 * standard phy_init_hw() which will zero all the other bits in the BMCR
508 * and reapply all driver-specific and board-specific fixups.
509 */
510static int phy_poll_reset(struct phy_device *phydev)
511{
512 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
513 unsigned int retries = 12;
514 int ret;
515
516 do {
517 msleep(50);
518 ret = phy_read(phydev, MII_BMCR);
519 if (ret < 0)
520 return ret;
521 } while (ret & BMCR_RESET && --retries);
522 if (ret & BMCR_RESET)
523 return -ETIMEDOUT;
524
2f53e904 525 /* Some chips (smsc911x) may still need up to another 1ms after the
87aa9f9c
FF
526 * BMCR_RESET bit is cleared before they are usable.
527 */
528 msleep(1);
529 return 0;
530}
531
2f5cb434
AV
532int phy_init_hw(struct phy_device *phydev)
533{
534 int ret;
535
536 if (!phydev->drv || !phydev->drv->config_init)
537 return 0;
538
87aa9f9c
FF
539 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
540 if (ret < 0)
541 return ret;
542
543 ret = phy_poll_reset(phydev);
544 if (ret < 0)
545 return ret;
546
2f5cb434
AV
547 ret = phy_scan_fixups(phydev);
548 if (ret < 0)
549 return ret;
550
551 return phydev->drv->config_init(phydev);
552}
87aa9f9c 553EXPORT_SYMBOL(phy_init_hw);
2f5cb434 554
b3df0da8 555/**
fa94f6d9 556 * phy_attach_direct - attach a network device to a given PHY device pointer
b3df0da8 557 * @dev: network device to attach
fa94f6d9 558 * @phydev: Pointer to phy_device to attach
b3df0da8
RD
559 * @flags: PHY device's dev_flags
560 * @interface: PHY device's interface
e1393456 561 *
b3df0da8 562 * Description: Called by drivers to attach to a particular PHY
e1393456
AF
563 * device. The phy_device is found, and properly hooked up
564 * to the phy_driver. If no driver is attached, then the
565 * genphy_driver is used. The phy_device is given a ptr to
566 * the attaching device, and given a callback for link status
b3df0da8 567 * change. The phy_device is returned to the attaching driver.
e1393456 568 */
89ff05ec 569static int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
570 u32 flags, phy_interface_t interface)
e1393456 571{
fa94f6d9 572 struct device *d = &phydev->dev;
d005a09e 573 int err;
e1393456
AF
574
575 /* Assume that if there is no driver, that it doesn't
2f53e904
SS
576 * exist, and we should use the genphy driver.
577 */
e1393456 578 if (NULL == d->driver) {
ac28b9f8
DD
579 if (phydev->is_c45) {
580 pr_err("No driver for phy %x\n", phydev->phy_id);
581 return -ENODEV;
582 }
583
e1393456
AF
584 d->driver = &genphy_driver.driver;
585
586 err = d->driver->probe(d);
b7a00ecd
JG
587 if (err >= 0)
588 err = device_bind_driver(d);
e1393456 589
b7a00ecd 590 if (err)
fa94f6d9 591 return err;
e1393456
AF
592 }
593
594 if (phydev->attached_dev) {
fa94f6d9
GL
595 dev_err(&dev->dev, "PHY already attached\n");
596 return -EBUSY;
e1393456
AF
597 }
598
599 phydev->attached_dev = dev;
c1f19b51 600 dev->phydev = phydev;
e1393456
AF
601
602 phydev->dev_flags = flags;
603
e8a2b6a4
AF
604 phydev->interface = interface;
605
ef24b16b
AV
606 phydev->state = PHY_READY;
607
e8a2b6a4
AF
608 /* Do initial configuration here, now that
609 * we have certain key parameters
2f53e904
SS
610 * (dev_flags and interface)
611 */
d005a09e
MKB
612 err = phy_init_hw(phydev);
613 if (err)
614 phy_detach(phydev);
615
1211ce53
SH
616 phy_resume(phydev);
617
d005a09e 618 return err;
fa94f6d9 619}
fa94f6d9
GL
620
621/**
622 * phy_attach - attach a network device to a particular PHY device
623 * @dev: network device to attach
624 * @bus_id: Bus ID of PHY device to attach
fa94f6d9
GL
625 * @interface: PHY device's interface
626 *
627 * Description: Same as phy_attach_direct() except that a PHY bus_id
628 * string is passed instead of a pointer to a struct phy_device.
629 */
2f53e904
SS
630struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
631 phy_interface_t interface)
fa94f6d9
GL
632{
633 struct bus_type *bus = &mdio_bus_type;
634 struct phy_device *phydev;
635 struct device *d;
636 int rc;
637
638 /* Search the list of PHY devices on the mdio bus for the
2f53e904
SS
639 * PHY with the requested name
640 */
fa94f6d9
GL
641 d = bus_find_device_by_name(bus, NULL, bus_id);
642 if (!d) {
643 pr_err("PHY %s not found\n", bus_id);
644 return ERR_PTR(-ENODEV);
e8a2b6a4 645 }
fa94f6d9
GL
646 phydev = to_phy_device(d);
647
f9a8f83b 648 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
fa94f6d9
GL
649 if (rc)
650 return ERR_PTR(rc);
e8a2b6a4 651
e1393456
AF
652 return phydev;
653}
654EXPORT_SYMBOL(phy_attach);
655
b3df0da8
RD
656/**
657 * phy_detach - detach a PHY device from its network device
658 * @phydev: target phy_device struct
659 */
e1393456
AF
660void phy_detach(struct phy_device *phydev)
661{
c1f19b51 662 phydev->attached_dev->phydev = NULL;
e1393456 663 phydev->attached_dev = NULL;
1211ce53 664 phy_suspend(phydev);
e1393456
AF
665
666 /* If the device had no specific driver before (i.e. - it
667 * was using the generic driver), we unbind the device
668 * from the generic driver so that there's a chance a
2f53e904
SS
669 * real driver could be loaded
670 */
87aebe07 671 if (phydev->dev.driver == &genphy_driver.driver)
e1393456 672 device_release_driver(&phydev->dev);
e1393456
AF
673}
674EXPORT_SYMBOL(phy_detach);
675
481b5d93
SH
676int phy_suspend(struct phy_device *phydev)
677{
678 struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
679 struct ethtool_wolinfo wol;
680
681 /* If the device has WOL enabled, we cannot suspend the PHY */
682 wol.cmd = ETHTOOL_GWOL;
683 phy_ethtool_get_wol(phydev, &wol);
684 if (wol.wolopts)
685 return -EBUSY;
686
687 if (phydrv->suspend)
688 return phydrv->suspend(phydev);
689 return 0;
690}
691
692int phy_resume(struct phy_device *phydev)
693{
694 struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
695
696 if (phydrv->resume)
697 return phydrv->resume(phydev);
698 return 0;
699}
e1393456 700
00db8189
AF
701/* Generic PHY support and helper functions */
702
b3df0da8 703/**
25985edc 704 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
b3df0da8 705 * @phydev: target phy_device struct
00db8189 706 *
b3df0da8 707 * Description: Writes MII_ADVERTISE with the appropriate values,
00db8189 708 * after sanitizing the values to make sure we only advertise
51e2a384
TP
709 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
710 * hasn't changed, and > 0 if it has changed.
00db8189 711 */
89ff05ec 712static int genphy_config_advert(struct phy_device *phydev)
00db8189
AF
713{
714 u32 advertise;
51e2a384
TP
715 int oldadv, adv;
716 int err, changed = 0;
00db8189 717
2f53e904 718 /* Only allow advertising what this PHY supports */
00db8189
AF
719 phydev->advertising &= phydev->supported;
720 advertise = phydev->advertising;
721
722 /* Setup standard advertisement */
2f53e904 723 adv = phy_read(phydev, MII_ADVERTISE);
00db8189
AF
724 if (adv < 0)
725 return adv;
726
2f53e904 727 oldadv = adv;
28011cf1 728 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
00db8189 729 ADVERTISE_PAUSE_ASYM);
37f07023 730 adv |= ethtool_adv_to_mii_adv_t(advertise);
00db8189 731
51e2a384
TP
732 if (adv != oldadv) {
733 err = phy_write(phydev, MII_ADVERTISE, adv);
00db8189 734
51e2a384
TP
735 if (err < 0)
736 return err;
737 changed = 1;
738 }
00db8189
AF
739
740 /* Configure gigabit if it's supported */
741 if (phydev->supported & (SUPPORTED_1000baseT_Half |
2f53e904
SS
742 SUPPORTED_1000baseT_Full)) {
743 adv = phy_read(phydev, MII_CTRL1000);
00db8189
AF
744 if (adv < 0)
745 return adv;
746
2f53e904 747 oldadv = adv;
00db8189 748 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
37f07023 749 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
00db8189 750
51e2a384
TP
751 if (adv != oldadv) {
752 err = phy_write(phydev, MII_CTRL1000, adv);
753
754 if (err < 0)
755 return err;
756 changed = 1;
757 }
00db8189
AF
758 }
759
51e2a384 760 return changed;
00db8189 761}
00db8189 762
b3df0da8
RD
763/**
764 * genphy_setup_forced - configures/forces speed/duplex from @phydev
765 * @phydev: target phy_device struct
00db8189 766 *
b3df0da8 767 * Description: Configures MII_BMCR to force speed/duplex
00db8189 768 * to the values in phydev. Assumes that the values are valid.
b3df0da8
RD
769 * Please see phy_sanitize_settings().
770 */
3fb69bca 771int genphy_setup_forced(struct phy_device *phydev)
00db8189 772{
bc1e0a09 773 int ctl = 0;
00db8189 774
2f53e904
SS
775 phydev->pause = 0;
776 phydev->asym_pause = 0;
00db8189
AF
777
778 if (SPEED_1000 == phydev->speed)
779 ctl |= BMCR_SPEED1000;
780 else if (SPEED_100 == phydev->speed)
781 ctl |= BMCR_SPEED100;
782
783 if (DUPLEX_FULL == phydev->duplex)
784 ctl |= BMCR_FULLDPLX;
e109374f 785
e62a768f 786 return phy_write(phydev, MII_BMCR, ctl);
00db8189 787}
3fb69bca 788EXPORT_SYMBOL(genphy_setup_forced);
00db8189 789
b3df0da8
RD
790/**
791 * genphy_restart_aneg - Enable and Restart Autonegotiation
792 * @phydev: target phy_device struct
793 */
00db8189
AF
794int genphy_restart_aneg(struct phy_device *phydev)
795{
553fe92b 796 int ctl = phy_read(phydev, MII_BMCR);
00db8189
AF
797
798 if (ctl < 0)
799 return ctl;
800
2f53e904 801 ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
00db8189
AF
802
803 /* Don't isolate the PHY if we're negotiating */
2f53e904 804 ctl &= ~BMCR_ISOLATE;
00db8189 805
553fe92b 806 return phy_write(phydev, MII_BMCR, ctl);
00db8189 807}
892871dc 808EXPORT_SYMBOL(genphy_restart_aneg);
00db8189 809
b3df0da8
RD
810/**
811 * genphy_config_aneg - restart auto-negotiation or write BMCR
812 * @phydev: target phy_device struct
00db8189 813 *
b3df0da8 814 * Description: If auto-negotiation is enabled, we configure the
00db8189 815 * advertising, and then restart auto-negotiation. If it is not
b3df0da8 816 * enabled, then we write the BMCR.
00db8189
AF
817 */
818int genphy_config_aneg(struct phy_device *phydev)
819{
de339c2a 820 int result;
00db8189 821
de339c2a
TP
822 if (AUTONEG_ENABLE != phydev->autoneg)
823 return genphy_setup_forced(phydev);
00db8189 824
de339c2a 825 result = genphy_config_advert(phydev);
de339c2a
TP
826 if (result < 0) /* error */
827 return result;
de339c2a 828 if (result == 0) {
25985edc 829 /* Advertisement hasn't changed, but maybe aneg was never on to
2f53e904
SS
830 * begin with? Or maybe phy was isolated?
831 */
de339c2a
TP
832 int ctl = phy_read(phydev, MII_BMCR);
833
834 if (ctl < 0)
835 return ctl;
836
837 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
838 result = 1; /* do restart aneg */
839 }
840
841 /* Only restart aneg if we are advertising something different
2f53e904
SS
842 * than we were before.
843 */
de339c2a
TP
844 if (result > 0)
845 result = genphy_restart_aneg(phydev);
00db8189 846
51e2a384 847 return result;
00db8189
AF
848}
849EXPORT_SYMBOL(genphy_config_aneg);
850
b3df0da8
RD
851/**
852 * genphy_update_link - update link status in @phydev
853 * @phydev: target phy_device struct
00db8189 854 *
b3df0da8 855 * Description: Update the value in phydev->link to reflect the
00db8189 856 * current link value. In order to do this, we need to read
b3df0da8 857 * the status register twice, keeping the second value.
00db8189
AF
858 */
859int genphy_update_link(struct phy_device *phydev)
860{
861 int status;
862
863 /* Do a fake read */
864 status = phy_read(phydev, MII_BMSR);
00db8189
AF
865 if (status < 0)
866 return status;
867
868 /* Read link and autonegotiation status */
869 status = phy_read(phydev, MII_BMSR);
00db8189
AF
870 if (status < 0)
871 return status;
872
873 if ((status & BMSR_LSTATUS) == 0)
874 phydev->link = 0;
875 else
876 phydev->link = 1;
877
878 return 0;
879}
6b655529 880EXPORT_SYMBOL(genphy_update_link);
00db8189 881
b3df0da8
RD
882/**
883 * genphy_read_status - check the link status and update current link state
884 * @phydev: target phy_device struct
00db8189 885 *
b3df0da8 886 * Description: Check the link, then figure out the current state
00db8189
AF
887 * by comparing what we advertise with what the link partner
888 * advertises. Start by checking the gigabit possibilities,
889 * then move on to 10/100.
890 */
891int genphy_read_status(struct phy_device *phydev)
892{
893 int adv;
894 int err;
895 int lpa;
896 int lpagb = 0;
897
2f53e904 898 /* Update the link, but return if there was an error */
00db8189
AF
899 err = genphy_update_link(phydev);
900 if (err)
901 return err;
902
114002bc
FF
903 phydev->lp_advertising = 0;
904
00db8189
AF
905 if (AUTONEG_ENABLE == phydev->autoneg) {
906 if (phydev->supported & (SUPPORTED_1000baseT_Half
907 | SUPPORTED_1000baseT_Full)) {
908 lpagb = phy_read(phydev, MII_STAT1000);
00db8189
AF
909 if (lpagb < 0)
910 return lpagb;
911
912 adv = phy_read(phydev, MII_CTRL1000);
00db8189
AF
913 if (adv < 0)
914 return adv;
915
114002bc
FF
916 phydev->lp_advertising =
917 mii_stat1000_to_ethtool_lpa_t(lpagb);
00db8189
AF
918 lpagb &= adv << 2;
919 }
920
921 lpa = phy_read(phydev, MII_LPA);
00db8189
AF
922 if (lpa < 0)
923 return lpa;
924
114002bc
FF
925 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
926
00db8189 927 adv = phy_read(phydev, MII_ADVERTISE);
00db8189
AF
928 if (adv < 0)
929 return adv;
930
931 lpa &= adv;
932
933 phydev->speed = SPEED_10;
934 phydev->duplex = DUPLEX_HALF;
2f53e904
SS
935 phydev->pause = 0;
936 phydev->asym_pause = 0;
00db8189
AF
937
938 if (lpagb & (LPA_1000FULL | LPA_1000HALF)) {
939 phydev->speed = SPEED_1000;
940
941 if (lpagb & LPA_1000FULL)
942 phydev->duplex = DUPLEX_FULL;
943 } else if (lpa & (LPA_100FULL | LPA_100HALF)) {
944 phydev->speed = SPEED_100;
e109374f 945
00db8189
AF
946 if (lpa & LPA_100FULL)
947 phydev->duplex = DUPLEX_FULL;
948 } else
949 if (lpa & LPA_10FULL)
950 phydev->duplex = DUPLEX_FULL;
951
e109374f 952 if (phydev->duplex == DUPLEX_FULL) {
00db8189
AF
953 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
954 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
955 }
956 } else {
957 int bmcr = phy_read(phydev, MII_BMCR);
2f53e904 958
00db8189
AF
959 if (bmcr < 0)
960 return bmcr;
961
962 if (bmcr & BMCR_FULLDPLX)
963 phydev->duplex = DUPLEX_FULL;
964 else
965 phydev->duplex = DUPLEX_HALF;
966
967 if (bmcr & BMCR_SPEED1000)
968 phydev->speed = SPEED_1000;
969 else if (bmcr & BMCR_SPEED100)
970 phydev->speed = SPEED_100;
971 else
972 phydev->speed = SPEED_10;
973
2f53e904
SS
974 phydev->pause = 0;
975 phydev->asym_pause = 0;
00db8189
AF
976 }
977
978 return 0;
979}
980EXPORT_SYMBOL(genphy_read_status);
981
982static int genphy_config_init(struct phy_device *phydev)
983{
84c22d79 984 int val;
00db8189
AF
985 u32 features;
986
987 /* For now, I'll claim that the generic driver supports
2f53e904
SS
988 * all possible port types
989 */
00db8189
AF
990 features = (SUPPORTED_TP | SUPPORTED_MII
991 | SUPPORTED_AUI | SUPPORTED_FIBRE |
992 SUPPORTED_BNC);
993
994 /* Do we support autonegotiation? */
995 val = phy_read(phydev, MII_BMSR);
00db8189
AF
996 if (val < 0)
997 return val;
998
999 if (val & BMSR_ANEGCAPABLE)
1000 features |= SUPPORTED_Autoneg;
1001
1002 if (val & BMSR_100FULL)
1003 features |= SUPPORTED_100baseT_Full;
1004 if (val & BMSR_100HALF)
1005 features |= SUPPORTED_100baseT_Half;
1006 if (val & BMSR_10FULL)
1007 features |= SUPPORTED_10baseT_Full;
1008 if (val & BMSR_10HALF)
1009 features |= SUPPORTED_10baseT_Half;
1010
1011 if (val & BMSR_ESTATEN) {
1012 val = phy_read(phydev, MII_ESTATUS);
00db8189
AF
1013 if (val < 0)
1014 return val;
1015
1016 if (val & ESTATUS_1000_TFULL)
1017 features |= SUPPORTED_1000baseT_Full;
1018 if (val & ESTATUS_1000_THALF)
1019 features |= SUPPORTED_1000baseT_Half;
1020 }
1021
1022 phydev->supported = features;
1023 phydev->advertising = features;
1024
1025 return 0;
1026}
0f0ca340
GC
1027int genphy_suspend(struct phy_device *phydev)
1028{
1029 int value;
1030
1031 mutex_lock(&phydev->lock);
1032
1033 value = phy_read(phydev, MII_BMCR);
2f53e904 1034 phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
0f0ca340
GC
1035
1036 mutex_unlock(&phydev->lock);
1037
1038 return 0;
1039}
1040EXPORT_SYMBOL(genphy_suspend);
00db8189 1041
0f0ca340
GC
1042int genphy_resume(struct phy_device *phydev)
1043{
1044 int value;
1045
1046 mutex_lock(&phydev->lock);
1047
1048 value = phy_read(phydev, MII_BMCR);
2f53e904 1049 phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
0f0ca340
GC
1050
1051 mutex_unlock(&phydev->lock);
1052
1053 return 0;
1054}
1055EXPORT_SYMBOL(genphy_resume);
00db8189 1056
b3df0da8
RD
1057/**
1058 * phy_probe - probe and init a PHY device
1059 * @dev: device to probe and init
00db8189 1060 *
b3df0da8 1061 * Description: Take care of setting up the phy_device structure,
00db8189
AF
1062 * set the state to READY (the driver's init function should
1063 * set it to STARTING if needed).
1064 */
1065static int phy_probe(struct device *dev)
1066{
553fe92b
SS
1067 struct phy_device *phydev = to_phy_device(dev);
1068 struct device_driver *drv = phydev->dev.driver;
1069 struct phy_driver *phydrv = to_phy_driver(drv);
00db8189
AF
1070 int err = 0;
1071
00db8189
AF
1072 phydev->drv = phydrv;
1073
2c7b4921
FF
1074 /* Disable the interrupt if the PHY doesn't support it
1075 * but the interrupt is still a valid one
1076 */
1077 if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
2f53e904 1078 phy_interrupt_is_valid(phydev))
00db8189
AF
1079 phydev->irq = PHY_POLL;
1080
4284b6a5
FF
1081 if (phydrv->flags & PHY_IS_INTERNAL)
1082 phydev->is_internal = true;
1083
35b5f6b1 1084 mutex_lock(&phydev->lock);
00db8189
AF
1085
1086 /* Start out supporting everything. Eventually,
1087 * a controller will attach, and may modify one
2f53e904
SS
1088 * or both of these values
1089 */
00db8189
AF
1090 phydev->supported = phydrv->features;
1091 phydev->advertising = phydrv->features;
1092
1093 /* Set the state to READY by default */
1094 phydev->state = PHY_READY;
1095
1096 if (phydev->drv->probe)
1097 err = phydev->drv->probe(phydev);
1098
35b5f6b1 1099 mutex_unlock(&phydev->lock);
00db8189 1100
00db8189
AF
1101 return err;
1102}
1103
1104static int phy_remove(struct device *dev)
1105{
553fe92b 1106 struct phy_device *phydev = to_phy_device(dev);
00db8189 1107
35b5f6b1 1108 mutex_lock(&phydev->lock);
00db8189 1109 phydev->state = PHY_DOWN;
35b5f6b1 1110 mutex_unlock(&phydev->lock);
00db8189
AF
1111
1112 if (phydev->drv->remove)
1113 phydev->drv->remove(phydev);
00db8189
AF
1114 phydev->drv = NULL;
1115
1116 return 0;
1117}
1118
b3df0da8
RD
1119/**
1120 * phy_driver_register - register a phy_driver with the PHY layer
1121 * @new_driver: new phy_driver to register
1122 */
00db8189
AF
1123int phy_driver_register(struct phy_driver *new_driver)
1124{
1125 int retval;
1126
00db8189
AF
1127 new_driver->driver.name = new_driver->name;
1128 new_driver->driver.bus = &mdio_bus_type;
1129 new_driver->driver.probe = phy_probe;
1130 new_driver->driver.remove = phy_remove;
1131
1132 retval = driver_register(&new_driver->driver);
00db8189 1133 if (retval) {
8d242488
JP
1134 pr_err("%s: Error %d in registering driver\n",
1135 new_driver->name, retval);
00db8189
AF
1136
1137 return retval;
1138 }
1139
f2511f13 1140 pr_debug("%s: Registered new driver\n", new_driver->name);
00db8189
AF
1141
1142 return 0;
1143}
1144EXPORT_SYMBOL(phy_driver_register);
1145
d5bf9071
CH
1146int phy_drivers_register(struct phy_driver *new_driver, int n)
1147{
1148 int i, ret = 0;
1149
1150 for (i = 0; i < n; i++) {
1151 ret = phy_driver_register(new_driver + i);
1152 if (ret) {
1153 while (i-- > 0)
1154 phy_driver_unregister(new_driver + i);
1155 break;
1156 }
1157 }
1158 return ret;
1159}
1160EXPORT_SYMBOL(phy_drivers_register);
1161
00db8189
AF
1162void phy_driver_unregister(struct phy_driver *drv)
1163{
1164 driver_unregister(&drv->driver);
1165}
1166EXPORT_SYMBOL(phy_driver_unregister);
1167
d5bf9071
CH
1168void phy_drivers_unregister(struct phy_driver *drv, int n)
1169{
1170 int i;
2f53e904
SS
1171
1172 for (i = 0; i < n; i++)
d5bf9071 1173 phy_driver_unregister(drv + i);
d5bf9071
CH
1174}
1175EXPORT_SYMBOL(phy_drivers_unregister);
1176
e1393456
AF
1177static struct phy_driver genphy_driver = {
1178 .phy_id = 0xffffffff,
1179 .phy_id_mask = 0xffffffff,
1180 .name = "Generic PHY",
1181 .config_init = genphy_config_init,
1182 .features = 0,
1183 .config_aneg = genphy_config_aneg,
1184 .read_status = genphy_read_status,
0f0ca340
GC
1185 .suspend = genphy_suspend,
1186 .resume = genphy_resume,
e109374f 1187 .driver = { .owner = THIS_MODULE, },
e1393456 1188};
00db8189 1189
67c4f3fa 1190static int __init phy_init(void)
00db8189 1191{
67c4f3fa 1192 int rc;
67c4f3fa
JG
1193
1194 rc = mdio_bus_init();
1195 if (rc)
e1393456 1196 return rc;
00db8189 1197
e1393456
AF
1198 rc = phy_driver_register(&genphy_driver);
1199 if (rc)
1200 mdio_bus_exit();
67c4f3fa 1201
67c4f3fa 1202 return rc;
00db8189
AF
1203}
1204
67c4f3fa 1205static void __exit phy_exit(void)
00db8189
AF
1206{
1207 phy_driver_unregister(&genphy_driver);
e1393456 1208 mdio_bus_exit();
00db8189
AF
1209}
1210
e1393456 1211subsys_initcall(phy_init);
67c4f3fa 1212module_exit(phy_exit);