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