]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/net/phy/phy_device.c
char/genrtc: remove parisc support
[mirror_ubuntu-artful-kernel.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>
124059fd 33#include <linux/mdio.h>
2f53e904
SS
34#include <linux/io.h>
35#include <linux/uaccess.h>
de906af1 36#include <linux/of.h>
00db8189 37
00db8189 38#include <asm/irq.h>
00db8189 39
afcceaa3
OH
40MODULE_DESCRIPTION("PHY library");
41MODULE_AUTHOR("Andy Fleming");
42MODULE_LICENSE("GPL");
43
6f4a7f41
AV
44void phy_device_free(struct phy_device *phydev)
45{
e5a03bfd 46 put_device(&phydev->mdio.dev);
6f4a7f41 47}
4dea547f 48EXPORT_SYMBOL(phy_device_free);
6f4a7f41 49
711fdba3
AL
50static void phy_mdio_device_free(struct mdio_device *mdiodev)
51{
52 struct phy_device *phydev;
53
54 phydev = container_of(mdiodev, struct phy_device, mdio);
55 phy_device_free(phydev);
56}
57
6f4a7f41
AV
58static void phy_device_release(struct device *dev)
59{
b2a43191 60 kfree(to_phy_device(dev));
6f4a7f41
AV
61}
62
711fdba3
AL
63static void phy_mdio_device_remove(struct mdio_device *mdiodev)
64{
65 struct phy_device *phydev;
66
67 phydev = container_of(mdiodev, struct phy_device, mdio);
68 phy_device_remove(phydev);
69}
70
ab2145ed
SX
71enum genphy_driver {
72 GENPHY_DRV_1G,
124059fd 73 GENPHY_DRV_10G,
ab2145ed
SX
74 GENPHY_DRV_MAX
75};
76
77static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
4dea547f 78
f62220d3
AF
79static LIST_HEAD(phy_fixup_list);
80static DEFINE_MUTEX(phy_fixup_lock);
81
bc87922f
AL
82#ifdef CONFIG_PM
83static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
84{
85 struct device_driver *drv = phydev->mdio.dev.driver;
86 struct phy_driver *phydrv = to_phy_driver(drv);
87 struct net_device *netdev = phydev->attached_dev;
88
89 if (!drv || !phydrv->suspend)
90 return false;
91
92 /* PHY not attached? May suspend if the PHY has not already been
93 * suspended as part of a prior call to phy_disconnect() ->
94 * phy_detach() -> phy_suspend() because the parent netdev might be the
95 * MDIO bus driver and clock gated at this point.
96 */
97 if (!netdev)
98 return !phydev->suspended;
99
100 /* Don't suspend PHY if the attached netdev parent may wakeup.
101 * The parent may point to a PCI device, as in tg3 driver.
102 */
103 if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
104 return false;
105
106 /* Also don't suspend PHY if the netdev itself may wakeup. This
107 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
108 * e.g. SoC devices.
109 */
110 if (device_may_wakeup(&netdev->dev))
111 return false;
112
113 return true;
114}
115
116static int mdio_bus_phy_suspend(struct device *dev)
117{
118 struct phy_device *phydev = to_phy_device(dev);
119
120 /* We must stop the state machine manually, otherwise it stops out of
121 * control, possibly with the phydev->lock held. Upon resume, netdev
122 * may call phy routines that try to grab the same lock, and that may
123 * lead to a deadlock.
124 */
125 if (phydev->attached_dev && phydev->adjust_link)
126 phy_stop_machine(phydev);
127
128 if (!mdio_bus_phy_may_suspend(phydev))
129 return 0;
130
131 return phy_suspend(phydev);
132}
133
134static int mdio_bus_phy_resume(struct device *dev)
135{
136 struct phy_device *phydev = to_phy_device(dev);
137 int ret;
138
139 if (!mdio_bus_phy_may_suspend(phydev))
140 goto no_resume;
141
142 ret = phy_resume(phydev);
143 if (ret < 0)
144 return ret;
145
146no_resume:
147 if (phydev->attached_dev && phydev->adjust_link)
148 phy_start_machine(phydev);
149
150 return 0;
151}
152
153static int mdio_bus_phy_restore(struct device *dev)
154{
155 struct phy_device *phydev = to_phy_device(dev);
156 struct net_device *netdev = phydev->attached_dev;
157 int ret;
158
159 if (!netdev)
160 return 0;
161
162 ret = phy_init_hw(phydev);
163 if (ret < 0)
164 return ret;
165
166 /* The PHY needs to renegotiate. */
167 phydev->link = 0;
168 phydev->state = PHY_UP;
169
170 phy_start_machine(phydev);
171
172 return 0;
173}
174
175static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
176 .suspend = mdio_bus_phy_suspend,
177 .resume = mdio_bus_phy_resume,
178 .freeze = mdio_bus_phy_suspend,
179 .thaw = mdio_bus_phy_resume,
180 .restore = mdio_bus_phy_restore,
181};
182
183#define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
184
185#else
186
187#define MDIO_BUS_PHY_PM_OPS NULL
188
189#endif /* CONFIG_PM */
190
2f53e904
SS
191/**
192 * phy_register_fixup - creates a new phy_fixup and adds it to the list
e5a03bfd 193 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
f62220d3 194 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
2f53e904 195 * It can also be PHY_ANY_UID
f62220d3 196 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
2f53e904 197 * comparison
f62220d3
AF
198 * @run: The actual code to be run when a matching PHY is found
199 */
200int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
2f53e904 201 int (*run)(struct phy_device *))
f62220d3 202{
553fe92b 203 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
f62220d3 204
f62220d3
AF
205 if (!fixup)
206 return -ENOMEM;
207
fb28ad35 208 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
f62220d3
AF
209 fixup->phy_uid = phy_uid;
210 fixup->phy_uid_mask = phy_uid_mask;
211 fixup->run = run;
212
213 mutex_lock(&phy_fixup_lock);
214 list_add_tail(&fixup->list, &phy_fixup_list);
215 mutex_unlock(&phy_fixup_lock);
216
217 return 0;
218}
219EXPORT_SYMBOL(phy_register_fixup);
220
221/* Registers a fixup to be run on any PHY with the UID in phy_uid */
222int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
2f53e904 223 int (*run)(struct phy_device *))
f62220d3
AF
224{
225 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
226}
227EXPORT_SYMBOL(phy_register_fixup_for_uid);
228
229/* Registers a fixup to be run on the PHY with id string bus_id */
230int phy_register_fixup_for_id(const char *bus_id,
2f53e904 231 int (*run)(struct phy_device *))
f62220d3
AF
232{
233 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
234}
235EXPORT_SYMBOL(phy_register_fixup_for_id);
236
2f53e904 237/* Returns 1 if fixup matches phydev in bus_id and phy_uid.
f62220d3
AF
238 * Fixups can be set to match any in one or more fields.
239 */
240static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
241{
84eff6d1 242 if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
f62220d3
AF
243 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
244 return 0;
245
246 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
2f53e904 247 (phydev->phy_id & fixup->phy_uid_mask))
f62220d3
AF
248 if (fixup->phy_uid != PHY_ANY_UID)
249 return 0;
250
251 return 1;
252}
253
254/* Runs any matching fixups for this phydev */
fbfcec63 255static int phy_scan_fixups(struct phy_device *phydev)
f62220d3
AF
256{
257 struct phy_fixup *fixup;
258
259 mutex_lock(&phy_fixup_lock);
260 list_for_each_entry(fixup, &phy_fixup_list, list) {
261 if (phy_needs_fixup(phydev, fixup)) {
553fe92b 262 int err = fixup->run(phydev);
f62220d3 263
bc23283c
JS
264 if (err < 0) {
265 mutex_unlock(&phy_fixup_lock);
f62220d3 266 return err;
bc23283c 267 }
b0ae009f 268 phydev->has_fixups = true;
f62220d3
AF
269 }
270 }
271 mutex_unlock(&phy_fixup_lock);
272
273 return 0;
274}
f62220d3 275
e76a4957
AL
276static int phy_bus_match(struct device *dev, struct device_driver *drv)
277{
278 struct phy_device *phydev = to_phy_device(dev);
279 struct phy_driver *phydrv = to_phy_driver(drv);
280 const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
281 int i;
282
a9049e0c
AL
283 if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
284 return 0;
285
e76a4957
AL
286 if (phydrv->match_phy_device)
287 return phydrv->match_phy_device(phydev);
288
289 if (phydev->is_c45) {
290 for (i = 1; i < num_ids; i++) {
291 if (!(phydev->c45_ids.devices_in_package & (1 << i)))
292 continue;
293
294 if ((phydrv->phy_id & phydrv->phy_id_mask) ==
295 (phydev->c45_ids.device_ids[i] &
296 phydrv->phy_id_mask))
297 return 1;
298 }
299 return 0;
300 } else {
301 return (phydrv->phy_id & phydrv->phy_id_mask) ==
302 (phydev->phy_id & phydrv->phy_id_mask);
303 }
304}
305
ac28b9f8 306struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
2f53e904
SS
307 bool is_c45,
308 struct phy_c45_device_ids *c45_ids)
11b0bacd
VB
309{
310 struct phy_device *dev;
e5a03bfd 311 struct mdio_device *mdiodev;
8626d3b4 312
2f53e904 313 /* We allocate the device, and initialize the default values */
cd861280 314 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
ef899c07 315 if (!dev)
d3765f08 316 return ERR_PTR(-ENOMEM);
11b0bacd 317
e5a03bfd
AL
318 mdiodev = &dev->mdio;
319 mdiodev->dev.release = phy_device_release;
320 mdiodev->dev.parent = &bus->dev;
321 mdiodev->dev.bus = &mdio_bus_type;
322 mdiodev->bus = bus;
bc87922f 323 mdiodev->pm_ops = MDIO_BUS_PHY_PM_OPS;
e76a4957 324 mdiodev->bus_match = phy_bus_match;
e5a03bfd 325 mdiodev->addr = addr;
7f854420 326 mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
711fdba3
AL
327 mdiodev->device_free = phy_mdio_device_free;
328 mdiodev->device_remove = phy_mdio_device_remove;
6f4a7f41 329
11b0bacd
VB
330 dev->speed = 0;
331 dev->duplex = -1;
2f53e904
SS
332 dev->pause = 0;
333 dev->asym_pause = 0;
11b0bacd 334 dev->link = 1;
e8a2b6a4 335 dev->interface = PHY_INTERFACE_MODE_GMII;
11b0bacd
VB
336
337 dev->autoneg = AUTONEG_ENABLE;
338
ac28b9f8 339 dev->is_c45 = is_c45;
11b0bacd 340 dev->phy_id = phy_id;
ac28b9f8
DD
341 if (c45_ids)
342 dev->c45_ids = *c45_ids;
47b356e4 343 dev->irq = bus->irq[addr];
e5a03bfd 344 dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
11b0bacd
VB
345
346 dev->state = PHY_DOWN;
347
35b5f6b1 348 mutex_init(&dev->lock);
4f9c85a1 349 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
5ea94e76 350 INIT_WORK(&dev->phy_queue, phy_change);
11b0bacd 351
8626d3b4 352 /* Request the appropriate module unconditionally; don't
2f53e904
SS
353 * bother trying to do so only if it isn't already loaded,
354 * because that gets complicated. A hotplug event would have
355 * done an unconditional modprobe anyway.
356 * We don't do normal hotplug because it won't work for MDIO
357 * -- because it relies on the device staying around for long
358 * enough for the driver to get loaded. With MDIO, the NIC
359 * driver will get bored and give up as soon as it finds that
360 * there's no driver _already_ loaded.
361 */
8626d3b4
DW
362 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
363
e5a03bfd 364 device_initialize(&mdiodev->dev);
b2a43191 365
11b0bacd
VB
366 return dev;
367}
ac28b9f8
DD
368EXPORT_SYMBOL(phy_device_create);
369
5f6c99e0
SX
370/* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
371 * @bus: the target MII bus
372 * @addr: PHY address on the MII bus
373 * @dev_addr: MMD address in the PHY.
374 * @devices_in_package: where to store the devices in package information.
375 *
376 * Description: reads devices in package registers of a MMD at @dev_addr
377 * from PHY at @addr on @bus.
378 *
379 * Returns: 0 on success, -EIO on failure.
380 */
381static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
382 u32 *devices_in_package)
383{
384 int phy_reg, reg_addr;
385
386 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
387 phy_reg = mdiobus_read(bus, addr, reg_addr);
388 if (phy_reg < 0)
389 return -EIO;
390 *devices_in_package = (phy_reg & 0xffff) << 16;
391
392 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
393 phy_reg = mdiobus_read(bus, addr, reg_addr);
394 if (phy_reg < 0)
395 return -EIO;
396 *devices_in_package |= (phy_reg & 0xffff);
397
398 return 0;
399}
400
ac28b9f8
DD
401/**
402 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
403 * @bus: the target MII bus
404 * @addr: PHY address on the MII bus
405 * @phy_id: where to store the ID retrieved.
406 * @c45_ids: where to store the c45 ID information.
407 *
408 * If the PHY devices-in-package appears to be valid, it and the
409 * corresponding identifiers are stored in @c45_ids, zero is stored
410 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
411 * zero on success.
412 *
413 */
414static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
415 struct phy_c45_device_ids *c45_ids) {
416 int phy_reg;
417 int i, reg_addr;
418 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
5f6c99e0 419 u32 *devs = &c45_ids->devices_in_package;
ac28b9f8 420
5f6c99e0
SX
421 /* Find first non-zero Devices In package. Device zero is reserved
422 * for 802.3 c45 complied PHYs, so don't probe it at first.
ac28b9f8 423 */
5f6c99e0
SX
424 for (i = 1; i < num_ids && *devs == 0; i++) {
425 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
ac28b9f8
DD
426 if (phy_reg < 0)
427 return -EIO;
ac28b9f8 428
5f6c99e0
SX
429 if ((*devs & 0x1fffffff) == 0x1fffffff) {
430 /* If mostly Fs, there is no device there,
431 * then let's continue to probe more, as some
432 * 10G PHYs have zero Devices In package,
433 * e.g. Cortina CS4315/CS4340 PHY.
434 */
435 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
436 if (phy_reg < 0)
437 return -EIO;
438 /* no device there, let's get out of here */
439 if ((*devs & 0x1fffffff) == 0x1fffffff) {
da1da284
SL
440 *phy_id = 0xffffffff;
441 return 0;
5f6c99e0
SX
442 } else {
443 break;
da1da284 444 }
ac28b9f8
DD
445 }
446 }
447
448 /* Now probe Device Identifiers for each device present. */
449 for (i = 1; i < num_ids; i++) {
450 if (!(c45_ids->devices_in_package & (1 << i)))
451 continue;
452
453 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
454 phy_reg = mdiobus_read(bus, addr, reg_addr);
455 if (phy_reg < 0)
456 return -EIO;
457 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
458
459 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
460 phy_reg = mdiobus_read(bus, addr, reg_addr);
461 if (phy_reg < 0)
462 return -EIO;
463 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
464 }
465 *phy_id = 0;
466 return 0;
467}
11b0bacd 468
b3df0da8 469/**
cac1f3c8 470 * get_phy_id - reads the specified addr for its ID.
b3df0da8
RD
471 * @bus: the target MII bus
472 * @addr: PHY address on the MII bus
cac1f3c8 473 * @phy_id: where to store the ID retrieved.
ac28b9f8
DD
474 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
475 * @c45_ids: where to store the c45 ID information.
476 *
477 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
478 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
479 * zero on success.
480 *
481 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
482 * its return value is in turn returned.
00db8189 483 *
00db8189 484 */
ac28b9f8
DD
485static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
486 bool is_c45, struct phy_c45_device_ids *c45_ids)
00db8189
AF
487{
488 int phy_reg;
00db8189 489
ac28b9f8
DD
490 if (is_c45)
491 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
492
2f53e904 493 /* Grab the bits from PHYIR1, and put them in the upper half */
6fe32649 494 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
00db8189 495 if (phy_reg < 0)
cac1f3c8 496 return -EIO;
00db8189 497
cac1f3c8 498 *phy_id = (phy_reg & 0xffff) << 16;
00db8189
AF
499
500 /* Grab the bits from PHYIR2, and put them in the lower half */
6fe32649 501 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
00db8189 502 if (phy_reg < 0)
cac1f3c8
PG
503 return -EIO;
504
505 *phy_id |= (phy_reg & 0xffff);
506
507 return 0;
508}
509
510/**
2f53e904
SS
511 * get_phy_device - reads the specified PHY device and returns its @phy_device
512 * struct
cac1f3c8
PG
513 * @bus: the target MII bus
514 * @addr: PHY address on the MII bus
ac28b9f8 515 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
cac1f3c8
PG
516 *
517 * Description: Reads the ID registers of the PHY at @addr on the
518 * @bus, then allocates and returns the phy_device to represent it.
519 */
ac28b9f8 520struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
cac1f3c8 521{
ac28b9f8 522 struct phy_c45_device_ids c45_ids = {0};
160c85f0 523 u32 phy_id = 0;
cac1f3c8 524 int r;
00db8189 525
ac28b9f8 526 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
cac1f3c8
PG
527 if (r)
528 return ERR_PTR(r);
00db8189 529
6436cbcd
GC
530 /* If the phy_id is mostly Fs, there is no device there */
531 if ((phy_id & 0x1fffffff) == 0x1fffffff)
b74766a0 532 return ERR_PTR(-ENODEV);
6436cbcd 533
e62a768f 534 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
00db8189 535}
4dea547f
GL
536EXPORT_SYMBOL(get_phy_device);
537
5cf11bee
AL
538static ssize_t
539phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
540{
541 struct phy_device *phydev = to_phy_device(dev);
542
543 return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
544}
545static DEVICE_ATTR_RO(phy_id);
546
547static ssize_t
548phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
549{
550 struct phy_device *phydev = to_phy_device(dev);
551 const char *mode = NULL;
552
553 if (phy_is_internal(phydev))
554 mode = "internal";
555 else
556 mode = phy_modes(phydev->interface);
557
558 return sprintf(buf, "%s\n", mode);
559}
560static DEVICE_ATTR_RO(phy_interface);
561
562static ssize_t
563phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
564 char *buf)
565{
566 struct phy_device *phydev = to_phy_device(dev);
567
568 return sprintf(buf, "%d\n", phydev->has_fixups);
569}
570static DEVICE_ATTR_RO(phy_has_fixups);
571
572static struct attribute *phy_dev_attrs[] = {
573 &dev_attr_phy_id.attr,
574 &dev_attr_phy_interface.attr,
575 &dev_attr_phy_has_fixups.attr,
576 NULL,
577};
578ATTRIBUTE_GROUPS(phy_dev);
579
4dea547f
GL
580/**
581 * phy_device_register - Register the phy device on the MDIO bus
1d4ac5d5 582 * @phydev: phy_device structure to be added to the MDIO bus
4dea547f
GL
583 */
584int phy_device_register(struct phy_device *phydev)
585{
586 int err;
587
7f854420
AL
588 err = mdiobus_register_device(&phydev->mdio);
589 if (err)
590 return err;
4dea547f
GL
591
592 /* Run all of the fixups for this PHY */
d92f5dec 593 err = phy_scan_fixups(phydev);
87aa9f9c 594 if (err) {
e5a03bfd 595 pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
87aa9f9c
FF
596 goto out;
597 }
4dea547f 598
5cf11bee
AL
599 phydev->mdio.dev.groups = phy_dev_groups;
600
e5a03bfd 601 err = device_add(&phydev->mdio.dev);
4dea547f 602 if (err) {
e5a03bfd 603 pr_err("PHY %d failed to add\n", phydev->mdio.addr);
4dea547f
GL
604 goto out;
605 }
606
607 return 0;
608
609 out:
7f854420 610 mdiobus_unregister_device(&phydev->mdio);
4dea547f
GL
611 return err;
612}
613EXPORT_SYMBOL(phy_device_register);
00db8189 614
38737e49
RK
615/**
616 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
617 * @phydev: phy_device structure to remove
618 *
619 * This doesn't free the phy_device itself, it merely reverses the effects
620 * of phy_device_register(). Use phy_device_free() to free the device
621 * after calling this function.
622 */
623void phy_device_remove(struct phy_device *phydev)
624{
e5a03bfd 625 device_del(&phydev->mdio.dev);
7f854420 626 mdiobus_unregister_device(&phydev->mdio);
38737e49
RK
627}
628EXPORT_SYMBOL(phy_device_remove);
629
f8f76db1
JP
630/**
631 * phy_find_first - finds the first PHY device on the bus
632 * @bus: the target MII bus
633 */
634struct phy_device *phy_find_first(struct mii_bus *bus)
635{
7f854420 636 struct phy_device *phydev;
f8f76db1
JP
637 int addr;
638
639 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
7f854420
AL
640 phydev = mdiobus_get_phy(bus, addr);
641 if (phydev)
642 return phydev;
f8f76db1
JP
643 }
644 return NULL;
645}
646EXPORT_SYMBOL(phy_find_first);
647
b3df0da8
RD
648/**
649 * phy_prepare_link - prepares the PHY layer to monitor link status
650 * @phydev: target phy_device struct
651 * @handler: callback function for link status change notifications
00db8189 652 *
b3df0da8 653 * Description: Tells the PHY infrastructure to handle the
00db8189
AF
654 * gory details on monitoring link status (whether through
655 * polling or an interrupt), and to call back to the
656 * connected device driver when the link status changes.
657 * If you want to monitor your own link state, don't call
b3df0da8
RD
658 * this function.
659 */
89ff05ec 660static void phy_prepare_link(struct phy_device *phydev,
2f53e904 661 void (*handler)(struct net_device *))
00db8189
AF
662{
663 phydev->adjust_link = handler;
664}
665
fa94f6d9
GL
666/**
667 * phy_connect_direct - connect an ethernet device to a specific phy_device
668 * @dev: the network device to connect
669 * @phydev: the pointer to the phy device
670 * @handler: callback function for state change notifications
fa94f6d9
GL
671 * @interface: PHY device's interface
672 */
673int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
f9a8f83b 674 void (*handler)(struct net_device *),
fa94f6d9
GL
675 phy_interface_t interface)
676{
677 int rc;
678
f9a8f83b 679 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
fa94f6d9
GL
680 if (rc)
681 return rc;
682
683 phy_prepare_link(phydev, handler);
29935aeb 684 phy_start_machine(phydev);
fa94f6d9
GL
685 if (phydev->irq > 0)
686 phy_start_interrupts(phydev);
687
688 return 0;
689}
690EXPORT_SYMBOL(phy_connect_direct);
691
b3df0da8
RD
692/**
693 * phy_connect - connect an ethernet device to a PHY device
694 * @dev: the network device to connect
5d12b132 695 * @bus_id: the id string of the PHY device to connect
b3df0da8 696 * @handler: callback function for state change notifications
b3df0da8 697 * @interface: PHY device's interface
e1393456 698 *
b3df0da8 699 * Description: Convenience function for connecting ethernet
e1393456
AF
700 * devices to PHY devices. The default behavior is for
701 * the PHY infrastructure to handle everything, and only notify
702 * the connected driver when the link status changes. If you
703 * don't want, or can't use the provided functionality, you may
704 * choose to call only the subset of functions which provide
705 * the desired functionality.
706 */
e109374f 707struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
2f53e904
SS
708 void (*handler)(struct net_device *),
709 phy_interface_t interface)
e1393456
AF
710{
711 struct phy_device *phydev;
fa94f6d9
GL
712 struct device *d;
713 int rc;
e1393456 714
fa94f6d9 715 /* Search the list of PHY devices on the mdio bus for the
2f53e904
SS
716 * PHY with the requested name
717 */
fa94f6d9
GL
718 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
719 if (!d) {
720 pr_err("PHY %s not found\n", bus_id);
721 return ERR_PTR(-ENODEV);
722 }
723 phydev = to_phy_device(d);
e1393456 724
f9a8f83b 725 rc = phy_connect_direct(dev, phydev, handler, interface);
fa94f6d9
GL
726 if (rc)
727 return ERR_PTR(rc);
e1393456
AF
728
729 return phydev;
730}
731EXPORT_SYMBOL(phy_connect);
732
b3df0da8 733/**
2f53e904
SS
734 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
735 * device
b3df0da8
RD
736 * @phydev: target phy_device struct
737 */
e1393456
AF
738void phy_disconnect(struct phy_device *phydev)
739{
740 if (phydev->irq > 0)
741 phy_stop_interrupts(phydev);
742
743 phy_stop_machine(phydev);
e109374f 744
e1393456
AF
745 phydev->adjust_link = NULL;
746
747 phy_detach(phydev);
748}
749EXPORT_SYMBOL(phy_disconnect);
750
87aa9f9c
FF
751/**
752 * phy_poll_reset - Safely wait until a PHY reset has properly completed
753 * @phydev: The PHY device to poll
754 *
755 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
756 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
757 * register must be polled until the BMCR_RESET bit clears.
758 *
759 * Furthermore, any attempts to write to PHY registers may have no effect
760 * or even generate MDIO bus errors until this is complete.
761 *
762 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
763 * standard and do not fully reset after the BMCR_RESET bit is set, and may
764 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
765 * effort to support such broken PHYs, this function is separate from the
766 * standard phy_init_hw() which will zero all the other bits in the BMCR
767 * and reapply all driver-specific and board-specific fixups.
768 */
769static int phy_poll_reset(struct phy_device *phydev)
770{
771 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
772 unsigned int retries = 12;
773 int ret;
774
775 do {
776 msleep(50);
777 ret = phy_read(phydev, MII_BMCR);
778 if (ret < 0)
779 return ret;
780 } while (ret & BMCR_RESET && --retries);
781 if (ret & BMCR_RESET)
782 return -ETIMEDOUT;
783
2f53e904 784 /* Some chips (smsc911x) may still need up to another 1ms after the
87aa9f9c
FF
785 * BMCR_RESET bit is cleared before they are usable.
786 */
787 msleep(1);
788 return 0;
789}
790
2f5cb434
AV
791int phy_init_hw(struct phy_device *phydev)
792{
9df81dd7 793 int ret = 0;
2f5cb434
AV
794
795 if (!phydev->drv || !phydev->drv->config_init)
796 return 0;
797
9df81dd7
FF
798 if (phydev->drv->soft_reset)
799 ret = phydev->drv->soft_reset(phydev);
800 else
801 ret = genphy_soft_reset(phydev);
802
87aa9f9c
FF
803 if (ret < 0)
804 return ret;
805
2f5cb434
AV
806 ret = phy_scan_fixups(phydev);
807 if (ret < 0)
808 return ret;
809
810 return phydev->drv->config_init(phydev);
811}
87aa9f9c 812EXPORT_SYMBOL(phy_init_hw);
2f5cb434 813
2220943a
AL
814void phy_attached_info(struct phy_device *phydev)
815{
816 phy_attached_print(phydev, NULL);
817}
818EXPORT_SYMBOL(phy_attached_info);
819
820#define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)"
821void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
822{
823 if (!fmt) {
e5a03bfd 824 dev_info(&phydev->mdio.dev, ATTACHED_FMT "\n",
2220943a
AL
825 phydev->drv->name, phydev_name(phydev),
826 phydev->irq);
827 } else {
828 va_list ap;
829
e5a03bfd 830 dev_info(&phydev->mdio.dev, ATTACHED_FMT,
2220943a
AL
831 phydev->drv->name, phydev_name(phydev),
832 phydev->irq);
833
834 va_start(ap, fmt);
835 vprintk(fmt, ap);
836 va_end(ap);
837 }
838}
839EXPORT_SYMBOL(phy_attached_print);
840
b3df0da8 841/**
fa94f6d9 842 * phy_attach_direct - attach a network device to a given PHY device pointer
b3df0da8 843 * @dev: network device to attach
fa94f6d9 844 * @phydev: Pointer to phy_device to attach
b3df0da8
RD
845 * @flags: PHY device's dev_flags
846 * @interface: PHY device's interface
e1393456 847 *
b3df0da8 848 * Description: Called by drivers to attach to a particular PHY
e1393456 849 * device. The phy_device is found, and properly hooked up
257184d7
AF
850 * to the phy_driver. If no driver is attached, then a
851 * generic driver is used. The phy_device is given a ptr to
e1393456 852 * the attaching device, and given a callback for link status
b3df0da8 853 * change. The phy_device is returned to the attaching driver.
7322967b 854 * This function takes a reference on the phy device.
e1393456 855 */
257184d7
AF
856int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
857 u32 flags, phy_interface_t interface)
e1393456 858{
e5a03bfd
AL
859 struct mii_bus *bus = phydev->mdio.bus;
860 struct device *d = &phydev->mdio.dev;
d005a09e 861 int err;
e1393456 862
3e3aaf64
RK
863 if (!try_module_get(bus->owner)) {
864 dev_err(&dev->dev, "failed to get the bus module\n");
865 return -EIO;
866 }
867
7322967b
RK
868 get_device(d);
869
e1393456 870 /* Assume that if there is no driver, that it doesn't
2f53e904
SS
871 * exist, and we should use the genphy driver.
872 */
ef899c07 873 if (!d->driver) {
257184d7 874 if (phydev->is_c45)
a9049e0c
AL
875 d->driver =
876 &genphy_driver[GENPHY_DRV_10G].mdiodrv.driver;
257184d7 877 else
a9049e0c
AL
878 d->driver =
879 &genphy_driver[GENPHY_DRV_1G].mdiodrv.driver;
e1393456
AF
880
881 err = d->driver->probe(d);
b7a00ecd
JG
882 if (err >= 0)
883 err = device_bind_driver(d);
e1393456 884
b7a00ecd 885 if (err)
3e3aaf64 886 goto error;
e1393456
AF
887 }
888
889 if (phydev->attached_dev) {
fa94f6d9 890 dev_err(&dev->dev, "PHY already attached\n");
3e3aaf64
RK
891 err = -EBUSY;
892 goto error;
b3565f27
EG
893 }
894
e1393456 895 phydev->attached_dev = dev;
c1f19b51 896 dev->phydev = phydev;
e1393456
AF
897
898 phydev->dev_flags = flags;
899
e8a2b6a4
AF
900 phydev->interface = interface;
901
ef24b16b
AV
902 phydev->state = PHY_READY;
903
113c74d8
SS
904 /* Initial carrier state is off as the phy is about to be
905 * (re)initialized.
906 */
907 netif_carrier_off(phydev->attached_dev);
908
e8a2b6a4
AF
909 /* Do initial configuration here, now that
910 * we have certain key parameters
2f53e904
SS
911 * (dev_flags and interface)
912 */
d005a09e
MKB
913 err = phy_init_hw(phydev);
914 if (err)
915 phy_detach(phydev);
b394745d
GR
916 else
917 phy_resume(phydev);
1211ce53 918
d005a09e 919 return err;
3e3aaf64
RK
920
921error:
7322967b 922 put_device(d);
3e3aaf64
RK
923 module_put(bus->owner);
924 return err;
fa94f6d9 925}
257184d7 926EXPORT_SYMBOL(phy_attach_direct);
fa94f6d9
GL
927
928/**
929 * phy_attach - attach a network device to a particular PHY device
930 * @dev: network device to attach
931 * @bus_id: Bus ID of PHY device to attach
fa94f6d9
GL
932 * @interface: PHY device's interface
933 *
934 * Description: Same as phy_attach_direct() except that a PHY bus_id
935 * string is passed instead of a pointer to a struct phy_device.
936 */
2f53e904
SS
937struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
938 phy_interface_t interface)
fa94f6d9
GL
939{
940 struct bus_type *bus = &mdio_bus_type;
941 struct phy_device *phydev;
942 struct device *d;
943 int rc;
944
945 /* Search the list of PHY devices on the mdio bus for the
2f53e904
SS
946 * PHY with the requested name
947 */
fa94f6d9
GL
948 d = bus_find_device_by_name(bus, NULL, bus_id);
949 if (!d) {
950 pr_err("PHY %s not found\n", bus_id);
951 return ERR_PTR(-ENODEV);
e8a2b6a4 952 }
fa94f6d9
GL
953 phydev = to_phy_device(d);
954
f9a8f83b 955 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
fa94f6d9
GL
956 if (rc)
957 return ERR_PTR(rc);
e8a2b6a4 958
e1393456
AF
959 return phydev;
960}
961EXPORT_SYMBOL(phy_attach);
962
b3df0da8
RD
963/**
964 * phy_detach - detach a PHY device from its network device
965 * @phydev: target phy_device struct
7322967b
RK
966 *
967 * This detaches the phy device from its network device and the phy
968 * driver, and drops the reference count taken in phy_attach_direct().
b3df0da8 969 */
e1393456
AF
970void phy_detach(struct phy_device *phydev)
971{
3e3aaf64 972 struct mii_bus *bus;
ab2145ed 973 int i;
b3565f27 974
c1f19b51 975 phydev->attached_dev->phydev = NULL;
e1393456 976 phydev->attached_dev = NULL;
1211ce53 977 phy_suspend(phydev);
e1393456
AF
978
979 /* If the device had no specific driver before (i.e. - it
980 * was using the generic driver), we unbind the device
981 * from the generic driver so that there's a chance a
2f53e904
SS
982 * real driver could be loaded
983 */
ab2145ed 984 for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
a9049e0c
AL
985 if (phydev->mdio.dev.driver ==
986 &genphy_driver[i].mdiodrv.driver) {
e5a03bfd 987 device_release_driver(&phydev->mdio.dev);
ab2145ed
SX
988 break;
989 }
990 }
3e3aaf64 991
7322967b
RK
992 /*
993 * The phydev might go away on the put_device() below, so avoid
994 * a use-after-free bug by reading the underlying bus first.
995 */
e5a03bfd 996 bus = phydev->mdio.bus;
3e3aaf64 997
e5a03bfd 998 put_device(&phydev->mdio.dev);
3e3aaf64 999 module_put(bus->owner);
e1393456
AF
1000}
1001EXPORT_SYMBOL(phy_detach);
1002
481b5d93
SH
1003int phy_suspend(struct phy_device *phydev)
1004{
e5a03bfd 1005 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
32fc3fd4 1006 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
8a477a6f 1007 int ret = 0;
481b5d93
SH
1008
1009 /* If the device has WOL enabled, we cannot suspend the PHY */
481b5d93
SH
1010 phy_ethtool_get_wol(phydev, &wol);
1011 if (wol.wolopts)
1012 return -EBUSY;
1013
1014 if (phydrv->suspend)
8a477a6f
FF
1015 ret = phydrv->suspend(phydev);
1016
1017 if (ret)
1018 return ret;
1019
1020 phydev->suspended = true;
1021
1022 return ret;
481b5d93 1023}
ca127697 1024EXPORT_SYMBOL(phy_suspend);
481b5d93
SH
1025
1026int phy_resume(struct phy_device *phydev)
1027{
e5a03bfd 1028 struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
8a477a6f 1029 int ret = 0;
481b5d93
SH
1030
1031 if (phydrv->resume)
8a477a6f
FF
1032 ret = phydrv->resume(phydev);
1033
1034 if (ret)
1035 return ret;
1036
1037 phydev->suspended = false;
1038
1039 return ret;
481b5d93 1040}
ca127697 1041EXPORT_SYMBOL(phy_resume);
e1393456 1042
00db8189
AF
1043/* Generic PHY support and helper functions */
1044
b3df0da8 1045/**
25985edc 1046 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
b3df0da8 1047 * @phydev: target phy_device struct
00db8189 1048 *
b3df0da8 1049 * Description: Writes MII_ADVERTISE with the appropriate values,
00db8189 1050 * after sanitizing the values to make sure we only advertise
51e2a384
TP
1051 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
1052 * hasn't changed, and > 0 if it has changed.
00db8189 1053 */
89ff05ec 1054static int genphy_config_advert(struct phy_device *phydev)
00db8189
AF
1055{
1056 u32 advertise;
5273e3a5 1057 int oldadv, adv, bmsr;
51e2a384 1058 int err, changed = 0;
00db8189 1059
2f53e904 1060 /* Only allow advertising what this PHY supports */
00db8189
AF
1061 phydev->advertising &= phydev->supported;
1062 advertise = phydev->advertising;
1063
1064 /* Setup standard advertisement */
2f53e904 1065 adv = phy_read(phydev, MII_ADVERTISE);
00db8189
AF
1066 if (adv < 0)
1067 return adv;
1068
2f53e904 1069 oldadv = adv;
28011cf1 1070 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
00db8189 1071 ADVERTISE_PAUSE_ASYM);
37f07023 1072 adv |= ethtool_adv_to_mii_adv_t(advertise);
00db8189 1073
51e2a384
TP
1074 if (adv != oldadv) {
1075 err = phy_write(phydev, MII_ADVERTISE, adv);
00db8189 1076
51e2a384
TP
1077 if (err < 0)
1078 return err;
1079 changed = 1;
1080 }
00db8189 1081
5273e3a5
FF
1082 bmsr = phy_read(phydev, MII_BMSR);
1083 if (bmsr < 0)
1084 return bmsr;
1085
1086 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1087 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1088 * logical 1.
1089 */
1090 if (!(bmsr & BMSR_ESTATEN))
1091 return changed;
1092
00db8189 1093 /* Configure gigabit if it's supported */
5273e3a5
FF
1094 adv = phy_read(phydev, MII_CTRL1000);
1095 if (adv < 0)
1096 return adv;
1097
1098 oldadv = adv;
1099 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1100
00db8189 1101 if (phydev->supported & (SUPPORTED_1000baseT_Half |
2f53e904 1102 SUPPORTED_1000baseT_Full)) {
37f07023 1103 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
00db8189
AF
1104 }
1105
eb686231
M
1106 if (adv != oldadv)
1107 changed = 1;
1108
5273e3a5
FF
1109 err = phy_write(phydev, MII_CTRL1000, adv);
1110 if (err < 0)
1111 return err;
1112
51e2a384 1113 return changed;
00db8189 1114}
00db8189 1115
b3df0da8
RD
1116/**
1117 * genphy_setup_forced - configures/forces speed/duplex from @phydev
1118 * @phydev: target phy_device struct
00db8189 1119 *
b3df0da8 1120 * Description: Configures MII_BMCR to force speed/duplex
00db8189 1121 * to the values in phydev. Assumes that the values are valid.
b3df0da8
RD
1122 * Please see phy_sanitize_settings().
1123 */
3fb69bca 1124int genphy_setup_forced(struct phy_device *phydev)
00db8189 1125{
f48256ef 1126 int ctl = phy_read(phydev, MII_BMCR);
00db8189 1127
f48256ef 1128 ctl &= BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN;
2f53e904
SS
1129 phydev->pause = 0;
1130 phydev->asym_pause = 0;
00db8189
AF
1131
1132 if (SPEED_1000 == phydev->speed)
1133 ctl |= BMCR_SPEED1000;
1134 else if (SPEED_100 == phydev->speed)
1135 ctl |= BMCR_SPEED100;
1136
1137 if (DUPLEX_FULL == phydev->duplex)
1138 ctl |= BMCR_FULLDPLX;
e109374f 1139
e62a768f 1140 return phy_write(phydev, MII_BMCR, ctl);
00db8189 1141}
3fb69bca 1142EXPORT_SYMBOL(genphy_setup_forced);
00db8189 1143
b3df0da8
RD
1144/**
1145 * genphy_restart_aneg - Enable and Restart Autonegotiation
1146 * @phydev: target phy_device struct
1147 */
00db8189
AF
1148int genphy_restart_aneg(struct phy_device *phydev)
1149{
553fe92b 1150 int ctl = phy_read(phydev, MII_BMCR);
00db8189
AF
1151
1152 if (ctl < 0)
1153 return ctl;
1154
2f53e904 1155 ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
00db8189
AF
1156
1157 /* Don't isolate the PHY if we're negotiating */
2f53e904 1158 ctl &= ~BMCR_ISOLATE;
00db8189 1159
553fe92b 1160 return phy_write(phydev, MII_BMCR, ctl);
00db8189 1161}
892871dc 1162EXPORT_SYMBOL(genphy_restart_aneg);
00db8189 1163
b3df0da8
RD
1164/**
1165 * genphy_config_aneg - restart auto-negotiation or write BMCR
1166 * @phydev: target phy_device struct
00db8189 1167 *
b3df0da8 1168 * Description: If auto-negotiation is enabled, we configure the
00db8189 1169 * advertising, and then restart auto-negotiation. If it is not
b3df0da8 1170 * enabled, then we write the BMCR.
00db8189
AF
1171 */
1172int genphy_config_aneg(struct phy_device *phydev)
1173{
de339c2a 1174 int result;
00db8189 1175
de339c2a
TP
1176 if (AUTONEG_ENABLE != phydev->autoneg)
1177 return genphy_setup_forced(phydev);
00db8189 1178
de339c2a 1179 result = genphy_config_advert(phydev);
de339c2a
TP
1180 if (result < 0) /* error */
1181 return result;
de339c2a 1182 if (result == 0) {
25985edc 1183 /* Advertisement hasn't changed, but maybe aneg was never on to
2f53e904
SS
1184 * begin with? Or maybe phy was isolated?
1185 */
de339c2a
TP
1186 int ctl = phy_read(phydev, MII_BMCR);
1187
1188 if (ctl < 0)
1189 return ctl;
1190
1191 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1192 result = 1; /* do restart aneg */
1193 }
1194
1195 /* Only restart aneg if we are advertising something different
2f53e904
SS
1196 * than we were before.
1197 */
de339c2a
TP
1198 if (result > 0)
1199 result = genphy_restart_aneg(phydev);
00db8189 1200
51e2a384 1201 return result;
00db8189
AF
1202}
1203EXPORT_SYMBOL(genphy_config_aneg);
1204
a9fa6e6a
FF
1205/**
1206 * genphy_aneg_done - return auto-negotiation status
1207 * @phydev: target phy_device struct
1208 *
1209 * Description: Reads the status register and returns 0 either if
1210 * auto-negotiation is incomplete, or if there was an error.
1211 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1212 */
1213int genphy_aneg_done(struct phy_device *phydev)
1214{
1215 int retval = phy_read(phydev, MII_BMSR);
1216
1217 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1218}
1219EXPORT_SYMBOL(genphy_aneg_done);
1220
395056ed 1221static int gen10g_config_aneg(struct phy_device *phydev)
124059fd
AF
1222{
1223 return 0;
1224}
124059fd 1225
b3df0da8
RD
1226/**
1227 * genphy_update_link - update link status in @phydev
1228 * @phydev: target phy_device struct
00db8189 1229 *
b3df0da8 1230 * Description: Update the value in phydev->link to reflect the
00db8189 1231 * current link value. In order to do this, we need to read
b3df0da8 1232 * the status register twice, keeping the second value.
00db8189
AF
1233 */
1234int genphy_update_link(struct phy_device *phydev)
1235{
1236 int status;
1237
1238 /* Do a fake read */
1239 status = phy_read(phydev, MII_BMSR);
00db8189
AF
1240 if (status < 0)
1241 return status;
1242
1243 /* Read link and autonegotiation status */
1244 status = phy_read(phydev, MII_BMSR);
00db8189
AF
1245 if (status < 0)
1246 return status;
1247
1248 if ((status & BMSR_LSTATUS) == 0)
1249 phydev->link = 0;
1250 else
1251 phydev->link = 1;
1252
1253 return 0;
1254}
6b655529 1255EXPORT_SYMBOL(genphy_update_link);
00db8189 1256
b3df0da8
RD
1257/**
1258 * genphy_read_status - check the link status and update current link state
1259 * @phydev: target phy_device struct
00db8189 1260 *
b3df0da8 1261 * Description: Check the link, then figure out the current state
00db8189
AF
1262 * by comparing what we advertise with what the link partner
1263 * advertises. Start by checking the gigabit possibilities,
1264 * then move on to 10/100.
1265 */
1266int genphy_read_status(struct phy_device *phydev)
1267{
1268 int adv;
1269 int err;
1270 int lpa;
1271 int lpagb = 0;
a4572e0c
CB
1272 int common_adv;
1273 int common_adv_gb = 0;
00db8189 1274
2f53e904 1275 /* Update the link, but return if there was an error */
00db8189
AF
1276 err = genphy_update_link(phydev);
1277 if (err)
1278 return err;
1279
114002bc
FF
1280 phydev->lp_advertising = 0;
1281
00db8189
AF
1282 if (AUTONEG_ENABLE == phydev->autoneg) {
1283 if (phydev->supported & (SUPPORTED_1000baseT_Half
1284 | SUPPORTED_1000baseT_Full)) {
1285 lpagb = phy_read(phydev, MII_STAT1000);
00db8189
AF
1286 if (lpagb < 0)
1287 return lpagb;
1288
1289 adv = phy_read(phydev, MII_CTRL1000);
00db8189
AF
1290 if (adv < 0)
1291 return adv;
1292
114002bc
FF
1293 phydev->lp_advertising =
1294 mii_stat1000_to_ethtool_lpa_t(lpagb);
a4572e0c 1295 common_adv_gb = lpagb & adv << 2;
00db8189
AF
1296 }
1297
1298 lpa = phy_read(phydev, MII_LPA);
00db8189
AF
1299 if (lpa < 0)
1300 return lpa;
1301
114002bc
FF
1302 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1303
00db8189 1304 adv = phy_read(phydev, MII_ADVERTISE);
00db8189
AF
1305 if (adv < 0)
1306 return adv;
1307
a4572e0c 1308 common_adv = lpa & adv;
00db8189
AF
1309
1310 phydev->speed = SPEED_10;
1311 phydev->duplex = DUPLEX_HALF;
2f53e904
SS
1312 phydev->pause = 0;
1313 phydev->asym_pause = 0;
00db8189 1314
a4572e0c 1315 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
00db8189
AF
1316 phydev->speed = SPEED_1000;
1317
a4572e0c 1318 if (common_adv_gb & LPA_1000FULL)
00db8189 1319 phydev->duplex = DUPLEX_FULL;
a4572e0c 1320 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
00db8189 1321 phydev->speed = SPEED_100;
e109374f 1322
a4572e0c 1323 if (common_adv & LPA_100FULL)
00db8189
AF
1324 phydev->duplex = DUPLEX_FULL;
1325 } else
a4572e0c 1326 if (common_adv & LPA_10FULL)
00db8189
AF
1327 phydev->duplex = DUPLEX_FULL;
1328
e109374f 1329 if (phydev->duplex == DUPLEX_FULL) {
00db8189
AF
1330 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1331 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1332 }
1333 } else {
1334 int bmcr = phy_read(phydev, MII_BMCR);
2f53e904 1335
00db8189
AF
1336 if (bmcr < 0)
1337 return bmcr;
1338
1339 if (bmcr & BMCR_FULLDPLX)
1340 phydev->duplex = DUPLEX_FULL;
1341 else
1342 phydev->duplex = DUPLEX_HALF;
1343
1344 if (bmcr & BMCR_SPEED1000)
1345 phydev->speed = SPEED_1000;
1346 else if (bmcr & BMCR_SPEED100)
1347 phydev->speed = SPEED_100;
1348 else
1349 phydev->speed = SPEED_10;
1350
2f53e904
SS
1351 phydev->pause = 0;
1352 phydev->asym_pause = 0;
00db8189
AF
1353 }
1354
1355 return 0;
1356}
1357EXPORT_SYMBOL(genphy_read_status);
1358
395056ed 1359static int gen10g_read_status(struct phy_device *phydev)
124059fd
AF
1360{
1361 int devad, reg;
1362 u32 mmd_mask = phydev->c45_ids.devices_in_package;
1363
1364 phydev->link = 1;
1365
1366 /* For now just lie and say it's 10G all the time */
1367 phydev->speed = SPEED_10000;
1368 phydev->duplex = DUPLEX_FULL;
1369
1370 for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1371 if (!(mmd_mask & 1))
1372 continue;
1373
1374 /* Read twice because link state is latched and a
1375 * read moves the current state into the register
1376 */
1377 phy_read_mmd(phydev, devad, MDIO_STAT1);
1378 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1379 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1380 phydev->link = 0;
1381 }
1382
1383 return 0;
1384}
124059fd 1385
797ac071
FF
1386/**
1387 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1388 * @phydev: target phy_device struct
1389 *
1390 * Description: Perform a software PHY reset using the standard
1391 * BMCR_RESET bit and poll for the reset bit to be cleared.
1392 *
1393 * Returns: 0 on success, < 0 on failure
1394 */
1395int genphy_soft_reset(struct phy_device *phydev)
1396{
1397 int ret;
1398
1399 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1400 if (ret < 0)
1401 return ret;
1402
1403 return phy_poll_reset(phydev);
1404}
1405EXPORT_SYMBOL(genphy_soft_reset);
1406
af6b6967 1407int genphy_config_init(struct phy_device *phydev)
00db8189 1408{
84c22d79 1409 int val;
00db8189
AF
1410 u32 features;
1411
00db8189
AF
1412 features = (SUPPORTED_TP | SUPPORTED_MII
1413 | SUPPORTED_AUI | SUPPORTED_FIBRE |
cd772de3 1414 SUPPORTED_BNC | SUPPORTED_Pause | SUPPORTED_Asym_Pause);
00db8189
AF
1415
1416 /* Do we support autonegotiation? */
1417 val = phy_read(phydev, MII_BMSR);
00db8189
AF
1418 if (val < 0)
1419 return val;
1420
1421 if (val & BMSR_ANEGCAPABLE)
1422 features |= SUPPORTED_Autoneg;
1423
1424 if (val & BMSR_100FULL)
1425 features |= SUPPORTED_100baseT_Full;
1426 if (val & BMSR_100HALF)
1427 features |= SUPPORTED_100baseT_Half;
1428 if (val & BMSR_10FULL)
1429 features |= SUPPORTED_10baseT_Full;
1430 if (val & BMSR_10HALF)
1431 features |= SUPPORTED_10baseT_Half;
1432
1433 if (val & BMSR_ESTATEN) {
1434 val = phy_read(phydev, MII_ESTATUS);
00db8189
AF
1435 if (val < 0)
1436 return val;
1437
1438 if (val & ESTATUS_1000_TFULL)
1439 features |= SUPPORTED_1000baseT_Full;
1440 if (val & ESTATUS_1000_THALF)
1441 features |= SUPPORTED_1000baseT_Half;
1442 }
1443
c242a472
SH
1444 phydev->supported &= features;
1445 phydev->advertising &= features;
00db8189
AF
1446
1447 return 0;
1448}
124059fd 1449
9df81dd7
FF
1450static int gen10g_soft_reset(struct phy_device *phydev)
1451{
1452 /* Do nothing for now */
1453 return 0;
1454}
af6b6967 1455EXPORT_SYMBOL(genphy_config_init);
9df81dd7 1456
124059fd
AF
1457static int gen10g_config_init(struct phy_device *phydev)
1458{
1459 /* Temporarily just say we support everything */
1460 phydev->supported = SUPPORTED_10000baseT_Full;
1461 phydev->advertising = SUPPORTED_10000baseT_Full;
1462
1463 return 0;
1464}
1465
0f0ca340
GC
1466int genphy_suspend(struct phy_device *phydev)
1467{
1468 int value;
1469
1470 mutex_lock(&phydev->lock);
1471
1472 value = phy_read(phydev, MII_BMCR);
2f53e904 1473 phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
0f0ca340
GC
1474
1475 mutex_unlock(&phydev->lock);
1476
1477 return 0;
1478}
1479EXPORT_SYMBOL(genphy_suspend);
00db8189 1480
395056ed 1481static int gen10g_suspend(struct phy_device *phydev)
124059fd
AF
1482{
1483 return 0;
1484}
124059fd 1485
0f0ca340
GC
1486int genphy_resume(struct phy_device *phydev)
1487{
1488 int value;
1489
1490 mutex_lock(&phydev->lock);
1491
1492 value = phy_read(phydev, MII_BMCR);
2f53e904 1493 phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
0f0ca340
GC
1494
1495 mutex_unlock(&phydev->lock);
1496
1497 return 0;
1498}
1499EXPORT_SYMBOL(genphy_resume);
00db8189 1500
395056ed 1501static int gen10g_resume(struct phy_device *phydev)
124059fd
AF
1502{
1503 return 0;
1504}
124059fd 1505
f3a6bd39
SH
1506static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1507{
1508 /* The default values for phydev->supported are provided by the PHY
1509 * driver "features" member, we want to reset to sane defaults first
1510 * before supporting higher speeds.
1511 */
1512 phydev->supported &= PHY_DEFAULT_FEATURES;
1513
1514 switch (max_speed) {
1515 default:
1516 return -ENOTSUPP;
1517 case SPEED_1000:
1518 phydev->supported |= PHY_1000BT_FEATURES;
1519 /* fall through */
1520 case SPEED_100:
1521 phydev->supported |= PHY_100BT_FEATURES;
1522 /* fall through */
1523 case SPEED_10:
1524 phydev->supported |= PHY_10BT_FEATURES;
1525 }
1526
1527 return 0;
1528}
1529
1530int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1531{
1532 int err;
1533
1534 err = __set_phy_supported(phydev, max_speed);
1535 if (err)
1536 return err;
1537
1538 phydev->advertising = phydev->supported;
1539
1540 return 0;
1541}
1542EXPORT_SYMBOL(phy_set_max_speed);
1543
de906af1
SH
1544static void of_set_phy_supported(struct phy_device *phydev)
1545{
e5a03bfd 1546 struct device_node *node = phydev->mdio.dev.of_node;
de906af1
SH
1547 u32 max_speed;
1548
1549 if (!IS_ENABLED(CONFIG_OF_MDIO))
1550 return;
1551
1552 if (!node)
1553 return;
1554
f3a6bd39
SH
1555 if (!of_property_read_u32(node, "max-speed", &max_speed))
1556 __set_phy_supported(phydev, max_speed);
de906af1
SH
1557}
1558
b3df0da8
RD
1559/**
1560 * phy_probe - probe and init a PHY device
1561 * @dev: device to probe and init
00db8189 1562 *
b3df0da8 1563 * Description: Take care of setting up the phy_device structure,
00db8189
AF
1564 * set the state to READY (the driver's init function should
1565 * set it to STARTING if needed).
1566 */
1567static int phy_probe(struct device *dev)
1568{
553fe92b 1569 struct phy_device *phydev = to_phy_device(dev);
e5a03bfd 1570 struct device_driver *drv = phydev->mdio.dev.driver;
553fe92b 1571 struct phy_driver *phydrv = to_phy_driver(drv);
00db8189
AF
1572 int err = 0;
1573
00db8189
AF
1574 phydev->drv = phydrv;
1575
2c7b4921
FF
1576 /* Disable the interrupt if the PHY doesn't support it
1577 * but the interrupt is still a valid one
1578 */
1579 if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
2f53e904 1580 phy_interrupt_is_valid(phydev))
00db8189
AF
1581 phydev->irq = PHY_POLL;
1582
4284b6a5
FF
1583 if (phydrv->flags & PHY_IS_INTERNAL)
1584 phydev->is_internal = true;
1585
35b5f6b1 1586 mutex_lock(&phydev->lock);
00db8189
AF
1587
1588 /* Start out supporting everything. Eventually,
1589 * a controller will attach, and may modify one
2f53e904
SS
1590 * or both of these values
1591 */
00db8189 1592 phydev->supported = phydrv->features;
de906af1
SH
1593 of_set_phy_supported(phydev);
1594 phydev->advertising = phydev->supported;
00db8189
AF
1595
1596 /* Set the state to READY by default */
1597 phydev->state = PHY_READY;
1598
1599 if (phydev->drv->probe)
1600 err = phydev->drv->probe(phydev);
1601
35b5f6b1 1602 mutex_unlock(&phydev->lock);
00db8189 1603
00db8189
AF
1604 return err;
1605}
1606
1607static int phy_remove(struct device *dev)
1608{
553fe92b 1609 struct phy_device *phydev = to_phy_device(dev);
00db8189 1610
35b5f6b1 1611 mutex_lock(&phydev->lock);
00db8189 1612 phydev->state = PHY_DOWN;
35b5f6b1 1613 mutex_unlock(&phydev->lock);
00db8189
AF
1614
1615 if (phydev->drv->remove)
1616 phydev->drv->remove(phydev);
00db8189
AF
1617 phydev->drv = NULL;
1618
1619 return 0;
1620}
1621
b3df0da8
RD
1622/**
1623 * phy_driver_register - register a phy_driver with the PHY layer
1624 * @new_driver: new phy_driver to register
be01da72 1625 * @owner: module owning this PHY
b3df0da8 1626 */
be01da72 1627int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
00db8189
AF
1628{
1629 int retval;
1630
a9049e0c
AL
1631 new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
1632 new_driver->mdiodrv.driver.name = new_driver->name;
1633 new_driver->mdiodrv.driver.bus = &mdio_bus_type;
1634 new_driver->mdiodrv.driver.probe = phy_probe;
1635 new_driver->mdiodrv.driver.remove = phy_remove;
1636 new_driver->mdiodrv.driver.owner = owner;
00db8189 1637
a9049e0c 1638 retval = driver_register(&new_driver->mdiodrv.driver);
00db8189 1639 if (retval) {
8d242488
JP
1640 pr_err("%s: Error %d in registering driver\n",
1641 new_driver->name, retval);
00db8189
AF
1642
1643 return retval;
1644 }
1645
f2511f13 1646 pr_debug("%s: Registered new driver\n", new_driver->name);
00db8189
AF
1647
1648 return 0;
1649}
1650EXPORT_SYMBOL(phy_driver_register);
1651
be01da72
AL
1652int phy_drivers_register(struct phy_driver *new_driver, int n,
1653 struct module *owner)
d5bf9071
CH
1654{
1655 int i, ret = 0;
1656
1657 for (i = 0; i < n; i++) {
be01da72 1658 ret = phy_driver_register(new_driver + i, owner);
d5bf9071
CH
1659 if (ret) {
1660 while (i-- > 0)
1661 phy_driver_unregister(new_driver + i);
1662 break;
1663 }
1664 }
1665 return ret;
1666}
1667EXPORT_SYMBOL(phy_drivers_register);
1668
00db8189
AF
1669void phy_driver_unregister(struct phy_driver *drv)
1670{
a9049e0c 1671 driver_unregister(&drv->mdiodrv.driver);
00db8189
AF
1672}
1673EXPORT_SYMBOL(phy_driver_unregister);
1674
d5bf9071
CH
1675void phy_drivers_unregister(struct phy_driver *drv, int n)
1676{
1677 int i;
2f53e904
SS
1678
1679 for (i = 0; i < n; i++)
d5bf9071 1680 phy_driver_unregister(drv + i);
d5bf9071
CH
1681}
1682EXPORT_SYMBOL(phy_drivers_unregister);
1683
ab2145ed
SX
1684static struct phy_driver genphy_driver[] = {
1685{
e1393456
AF
1686 .phy_id = 0xffffffff,
1687 .phy_id_mask = 0xffffffff,
1688 .name = "Generic PHY",
9df81dd7 1689 .soft_reset = genphy_soft_reset,
e1393456 1690 .config_init = genphy_config_init,
c242a472
SH
1691 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
1692 SUPPORTED_AUI | SUPPORTED_FIBRE |
1693 SUPPORTED_BNC,
e1393456 1694 .config_aneg = genphy_config_aneg,
76a423a3 1695 .aneg_done = genphy_aneg_done,
e1393456 1696 .read_status = genphy_read_status,
0f0ca340
GC
1697 .suspend = genphy_suspend,
1698 .resume = genphy_resume,
124059fd
AF
1699}, {
1700 .phy_id = 0xffffffff,
1701 .phy_id_mask = 0xffffffff,
1702 .name = "Generic 10G PHY",
9df81dd7 1703 .soft_reset = gen10g_soft_reset,
124059fd
AF
1704 .config_init = gen10g_config_init,
1705 .features = 0,
1706 .config_aneg = gen10g_config_aneg,
1707 .read_status = gen10g_read_status,
1708 .suspend = gen10g_suspend,
1709 .resume = gen10g_resume,
ab2145ed 1710} };
00db8189 1711
67c4f3fa 1712static int __init phy_init(void)
00db8189 1713{
67c4f3fa 1714 int rc;
67c4f3fa
JG
1715
1716 rc = mdio_bus_init();
1717 if (rc)
e1393456 1718 return rc;
00db8189 1719
ab2145ed 1720 rc = phy_drivers_register(genphy_driver,
be01da72 1721 ARRAY_SIZE(genphy_driver), THIS_MODULE);
e1393456
AF
1722 if (rc)
1723 mdio_bus_exit();
67c4f3fa 1724
67c4f3fa 1725 return rc;
00db8189
AF
1726}
1727
67c4f3fa 1728static void __exit phy_exit(void)
00db8189 1729{
ab2145ed
SX
1730 phy_drivers_unregister(genphy_driver,
1731 ARRAY_SIZE(genphy_driver));
e1393456 1732 mdio_bus_exit();
00db8189
AF
1733}
1734
e1393456 1735subsys_initcall(phy_init);
67c4f3fa 1736module_exit(phy_exit);