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