xref: /linux/drivers/net/phy/phy_device.c (revision dfecb0c5af3b07ebfa84be63a7a21bfc9e29a872)
1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for finding and configuring PHYs.
3  * Also contains generic PHY driver
4  *
5  * Author: Andy Fleming
6  *
7  * Copyright (c) 2004 Freescale Semiconductor, Inc.
8  */
9 
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 
12 #include <linux/acpi.h>
13 #include <linux/bitmap.h>
14 #include <linux/delay.h>
15 #include <linux/errno.h>
16 #include <linux/etherdevice.h>
17 #include <linux/ethtool.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
20 #include <linux/io.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/mdio.h>
24 #include <linux/mii.h>
25 #include <linux/mm.h>
26 #include <linux/module.h>
27 #include <linux/of.h>
28 #include <linux/netdevice.h>
29 #include <linux/phy.h>
30 #include <linux/phylib_stubs.h>
31 #include <linux/phy_led_triggers.h>
32 #include <linux/phy_link_topology.h>
33 #include <linux/phy_port.h>
34 #include <linux/pse-pd/pse.h>
35 #include <linux/property.h>
36 #include <linux/ptp_clock_kernel.h>
37 #include <linux/rtnetlink.h>
38 #include <linux/sfp.h>
39 #include <linux/skbuff.h>
40 #include <linux/slab.h>
41 #include <linux/string.h>
42 #include <linux/uaccess.h>
43 #include <linux/unistd.h>
44 
45 #include "phylib-internal.h"
46 #include "phy-caps.h"
47 
48 MODULE_DESCRIPTION("PHY library");
49 MODULE_AUTHOR("Andy Fleming");
50 MODULE_LICENSE("GPL");
51 
52 struct phy_fixup {
53 	struct list_head list;
54 	char bus_id[MII_BUS_ID_SIZE + 3];
55 	u32 phy_uid;
56 	u32 phy_uid_mask;
57 	int (*run)(struct phy_device *phydev);
58 };
59 
60 static struct phy_driver genphy_c45_driver = {
61 	.phy_id         = 0xffffffff,
62 	.phy_id_mask    = 0xffffffff,
63 	.name           = "Generic Clause 45 PHY",
64 	.read_status    = genphy_c45_read_status,
65 };
66 
67 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
68 EXPORT_SYMBOL_GPL(phy_basic_features);
69 
70 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
71 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
72 
73 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1s_p2mp_features) __ro_after_init;
74 EXPORT_SYMBOL_GPL(phy_basic_t1s_p2mp_features);
75 
76 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
77 EXPORT_SYMBOL_GPL(phy_gbit_features);
78 
79 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
80 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
81 
82 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
83 EXPORT_SYMBOL_GPL(phy_10gbit_features);
84 
85 const int phy_basic_ports_array[3] = {
86 	ETHTOOL_LINK_MODE_Autoneg_BIT,
87 	ETHTOOL_LINK_MODE_TP_BIT,
88 	ETHTOOL_LINK_MODE_MII_BIT,
89 };
90 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
91 
92 static const int phy_all_ports_features_array[7] __initconst = {
93 	ETHTOOL_LINK_MODE_Autoneg_BIT,
94 	ETHTOOL_LINK_MODE_TP_BIT,
95 	ETHTOOL_LINK_MODE_MII_BIT,
96 	ETHTOOL_LINK_MODE_FIBRE_BIT,
97 	ETHTOOL_LINK_MODE_AUI_BIT,
98 	ETHTOOL_LINK_MODE_BNC_BIT,
99 	ETHTOOL_LINK_MODE_Backplane_BIT,
100 };
101 
102 static const int phy_10_100_features_array[4] __initconst = {
103 	ETHTOOL_LINK_MODE_10baseT_Half_BIT,
104 	ETHTOOL_LINK_MODE_10baseT_Full_BIT,
105 	ETHTOOL_LINK_MODE_100baseT_Half_BIT,
106 	ETHTOOL_LINK_MODE_100baseT_Full_BIT,
107 };
108 
109 static const int phy_basic_t1_features_array[3] __initconst = {
110 	ETHTOOL_LINK_MODE_TP_BIT,
111 	ETHTOOL_LINK_MODE_10baseT1L_Full_BIT,
112 	ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
113 };
114 
115 static const int phy_basic_t1s_p2mp_features_array[2] __initconst = {
116 	ETHTOOL_LINK_MODE_TP_BIT,
117 	ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT,
118 };
119 
120 static const int phy_gbit_features_array[2] __initconst = {
121 	ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
122 	ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
123 };
124 
125 static const int phy_eee_cap1_features_array[] __initconst = {
126 	ETHTOOL_LINK_MODE_100baseT_Full_BIT,
127 	ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
128 	ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
129 	ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
130 	ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
131 	ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
132 };
133 
134 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap1_features) __ro_after_init;
135 EXPORT_SYMBOL_GPL(phy_eee_cap1_features);
136 
137 static const int phy_eee_cap2_features_array[] __initconst = {
138 	ETHTOOL_LINK_MODE_2500baseT_Full_BIT,
139 	ETHTOOL_LINK_MODE_5000baseT_Full_BIT,
140 };
141 
142 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_eee_cap2_features) __ro_after_init;
143 EXPORT_SYMBOL_GPL(phy_eee_cap2_features);
144 
145 static void __init features_init(void)
146 {
147 	/* 10/100 half/full*/
148 	linkmode_set_bit_array(phy_basic_ports_array,
149 			       ARRAY_SIZE(phy_basic_ports_array),
150 			       phy_basic_features);
151 	linkmode_set_bit_array(phy_10_100_features_array,
152 			       ARRAY_SIZE(phy_10_100_features_array),
153 			       phy_basic_features);
154 
155 	/* 100 full, TP */
156 	linkmode_set_bit_array(phy_basic_t1_features_array,
157 			       ARRAY_SIZE(phy_basic_t1_features_array),
158 			       phy_basic_t1_features);
159 
160 	/* 10 half, P2MP, TP */
161 	linkmode_set_bit_array(phy_basic_t1s_p2mp_features_array,
162 			       ARRAY_SIZE(phy_basic_t1s_p2mp_features_array),
163 			       phy_basic_t1s_p2mp_features);
164 
165 	/* 10/100 half/full + 1000 half/full */
166 	linkmode_set_bit_array(phy_basic_ports_array,
167 			       ARRAY_SIZE(phy_basic_ports_array),
168 			       phy_gbit_features);
169 	linkmode_set_bit_array(phy_10_100_features_array,
170 			       ARRAY_SIZE(phy_10_100_features_array),
171 			       phy_gbit_features);
172 	linkmode_set_bit_array(phy_gbit_features_array,
173 			       ARRAY_SIZE(phy_gbit_features_array),
174 			       phy_gbit_features);
175 
176 	/* 10/100 half/full + 1000 half/full + fibre*/
177 	linkmode_set_bit_array(phy_basic_ports_array,
178 			       ARRAY_SIZE(phy_basic_ports_array),
179 			       phy_gbit_fibre_features);
180 	linkmode_set_bit_array(phy_10_100_features_array,
181 			       ARRAY_SIZE(phy_10_100_features_array),
182 			       phy_gbit_fibre_features);
183 	linkmode_set_bit_array(phy_gbit_features_array,
184 			       ARRAY_SIZE(phy_gbit_features_array),
185 			       phy_gbit_fibre_features);
186 	linkmode_set_bit(ETHTOOL_LINK_MODE_FIBRE_BIT, phy_gbit_fibre_features);
187 
188 	/* 10/100 half/full + 1000 half/full + 10G full*/
189 	linkmode_set_bit_array(phy_all_ports_features_array,
190 			       ARRAY_SIZE(phy_all_ports_features_array),
191 			       phy_10gbit_features);
192 	linkmode_set_bit_array(phy_10_100_features_array,
193 			       ARRAY_SIZE(phy_10_100_features_array),
194 			       phy_10gbit_features);
195 	linkmode_set_bit_array(phy_gbit_features_array,
196 			       ARRAY_SIZE(phy_gbit_features_array),
197 			       phy_10gbit_features);
198 	linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
199 			 phy_10gbit_features);
200 
201 	linkmode_set_bit_array(phy_eee_cap1_features_array,
202 			       ARRAY_SIZE(phy_eee_cap1_features_array),
203 			       phy_eee_cap1_features);
204 	linkmode_set_bit_array(phy_eee_cap2_features_array,
205 			       ARRAY_SIZE(phy_eee_cap2_features_array),
206 			       phy_eee_cap2_features);
207 
208 }
209 
210 void phy_device_free(struct phy_device *phydev)
211 {
212 	put_device(&phydev->mdio.dev);
213 }
214 EXPORT_SYMBOL(phy_device_free);
215 
216 static void phy_mdio_device_free(struct mdio_device *mdiodev)
217 {
218 	struct phy_device *phydev;
219 
220 	phydev = container_of(mdiodev, struct phy_device, mdio);
221 	phy_device_free(phydev);
222 }
223 
224 static void phy_device_release(struct device *dev)
225 {
226 	fwnode_handle_put(dev->fwnode);
227 	kfree(to_phy_device(dev));
228 }
229 
230 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
231 {
232 	struct phy_device *phydev;
233 
234 	phydev = container_of(mdiodev, struct phy_device, mdio);
235 	phy_device_remove(phydev);
236 }
237 
238 static struct phy_driver genphy_driver;
239 
240 static LIST_HEAD(phy_fixup_list);
241 static DEFINE_MUTEX(phy_fixup_lock);
242 
243 static bool phy_drv_wol_enabled(struct phy_device *phydev)
244 {
245 	struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
246 
247 	phy_ethtool_get_wol(phydev, &wol);
248 
249 	return wol.wolopts != 0;
250 }
251 
252 bool phy_may_wakeup(struct phy_device *phydev)
253 {
254 	/* If the PHY is using driver-model based wakeup, use that state. */
255 	if (phy_can_wakeup(phydev))
256 		return device_may_wakeup(&phydev->mdio.dev);
257 
258 	return phy_drv_wol_enabled(phydev);
259 }
260 EXPORT_SYMBOL_GPL(phy_may_wakeup);
261 
262 static void phy_link_change(struct phy_device *phydev, bool up)
263 {
264 	struct net_device *netdev = phydev->attached_dev;
265 
266 	if (up)
267 		netif_carrier_on(netdev);
268 	else
269 		netif_carrier_off(netdev);
270 	phydev->adjust_link(netdev);
271 	if (phydev->mii_ts && phydev->mii_ts->link_state)
272 		phydev->mii_ts->link_state(phydev->mii_ts, phydev);
273 }
274 
275 /**
276  * phy_uses_state_machine - test whether consumer driver uses PAL state machine
277  * @phydev: the target PHY device structure
278  *
279  * Ultimately, this aims to indirectly determine whether the PHY is attached
280  * to a consumer which uses the state machine by calling phy_start() and
281  * phy_stop().
282  *
283  * When the PHY driver consumer uses phylib, it must have previously called
284  * phy_connect_direct() or one of its derivatives, so that phy_prepare_link()
285  * has set up a hook for monitoring state changes.
286  *
287  * When the PHY driver is used by the MAC driver consumer through phylink (the
288  * only other provider of a phy_link_change() method), using the PHY state
289  * machine is not optional.
290  *
291  * Return: true if consumer calls phy_start() and phy_stop(), false otherwise.
292  */
293 static bool phy_uses_state_machine(struct phy_device *phydev)
294 {
295 	if (phydev->phy_link_change == phy_link_change)
296 		return phydev->attached_dev && phydev->adjust_link;
297 
298 	return !!phydev->phy_link_change;
299 }
300 
301 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
302 {
303 	struct device_driver *drv = phydev->mdio.dev.driver;
304 	struct phy_driver *phydrv = to_phy_driver(drv);
305 	struct net_device *netdev = phydev->attached_dev;
306 
307 	if (!drv || !phydrv->suspend)
308 		return false;
309 
310 	/* If the PHY on the mido bus is not attached but has WOL enabled
311 	 * we cannot suspend the PHY.
312 	 */
313 	if (!netdev && phy_may_wakeup(phydev))
314 		return false;
315 
316 	/* PHY not attached? May suspend if the PHY has not already been
317 	 * suspended as part of a prior call to phy_disconnect() ->
318 	 * phy_detach() -> phy_suspend() because the parent netdev might be the
319 	 * MDIO bus driver and clock gated at this point.
320 	 */
321 	if (!netdev)
322 		goto out;
323 
324 	if (netdev->ethtool->wol_enabled)
325 		return false;
326 
327 	/* As long as not all affected network drivers support the
328 	 * wol_enabled flag, let's check for hints that WoL is enabled.
329 	 * Don't suspend PHY if the attached netdev parent may wake up.
330 	 * The parent may point to a PCI device, as in tg3 driver.
331 	 */
332 	if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
333 		return false;
334 
335 	/* Also don't suspend PHY if the netdev itself may wakeup. This
336 	 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
337 	 * e.g. SoC devices.
338 	 */
339 	if (device_may_wakeup(&netdev->dev))
340 		return false;
341 
342 out:
343 	return !phydev->suspended;
344 }
345 
346 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
347 {
348 	struct phy_device *phydev = to_phy_device(dev);
349 
350 	if (phydev->mac_managed_pm)
351 		return 0;
352 
353 	/* Wakeup interrupts may occur during the system sleep transition when
354 	 * the PHY is inaccessible. Set flag to postpone handling until the PHY
355 	 * has resumed. Wait for concurrent interrupt handler to complete.
356 	 */
357 	if (phy_interrupt_is_valid(phydev)) {
358 		phydev->irq_suspended = 1;
359 		synchronize_irq(phydev->irq);
360 	}
361 
362 	/* We must stop the state machine manually, otherwise it stops out of
363 	 * control, possibly with the phydev->lock held. Upon resume, netdev
364 	 * may call phy routines that try to grab the same lock, and that may
365 	 * lead to a deadlock.
366 	 */
367 	if (phy_uses_state_machine(phydev))
368 		phy_stop_machine(phydev);
369 
370 	if (!mdio_bus_phy_may_suspend(phydev))
371 		return 0;
372 
373 	phydev->suspended_by_mdio_bus = 1;
374 
375 	return phy_suspend(phydev);
376 }
377 
378 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
379 {
380 	struct phy_device *phydev = to_phy_device(dev);
381 	int ret;
382 
383 	if (phydev->mac_managed_pm)
384 		return 0;
385 
386 	if (!phydev->suspended_by_mdio_bus)
387 		goto no_resume;
388 
389 	phydev->suspended_by_mdio_bus = 0;
390 
391 	/* If we managed to get here with the PHY state machine in a state
392 	 * neither PHY_HALTED, PHY_READY nor PHY_UP, this is an indication
393 	 * that something went wrong and we should most likely be using
394 	 * MAC managed PM, but we are not.
395 	 */
396 	WARN_ON(phydev->state != PHY_HALTED && phydev->state != PHY_READY &&
397 		phydev->state != PHY_UP);
398 
399 	ret = phy_init_hw(phydev);
400 	if (ret < 0)
401 		return ret;
402 
403 	ret = phy_resume(phydev);
404 	if (ret < 0)
405 		return ret;
406 no_resume:
407 	if (phy_interrupt_is_valid(phydev)) {
408 		phydev->irq_suspended = 0;
409 		synchronize_irq(phydev->irq);
410 
411 		/* Rerun interrupts which were postponed by phy_interrupt()
412 		 * because they occurred during the system sleep transition.
413 		 */
414 		if (phydev->irq_rerun) {
415 			phydev->irq_rerun = 0;
416 			enable_irq(phydev->irq);
417 			irq_wake_thread(phydev->irq, phydev);
418 		}
419 	}
420 
421 	if (phy_uses_state_machine(phydev))
422 		phy_start_machine(phydev);
423 
424 	return 0;
425 }
426 
427 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
428 			 mdio_bus_phy_resume);
429 
430 /**
431  * phy_register_fixup - creates a new phy_fixup and adds it to the list
432  * @bus_id: A string which matches phydev->mdio.dev.bus_id (or NULL)
433  * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
434  * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
435  *	comparison (or 0 to disable id-based matching)
436  * @run: The actual code to be run when a matching PHY is found
437  */
438 static int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
439 			      int (*run)(struct phy_device *))
440 {
441 	struct phy_fixup *fixup = kzalloc_obj(*fixup);
442 
443 	if (!fixup)
444 		return -ENOMEM;
445 
446 	if (bus_id)
447 		strscpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
448 	fixup->phy_uid = phy_uid;
449 	fixup->phy_uid_mask = phy_uid_mask;
450 	fixup->run = run;
451 
452 	mutex_lock(&phy_fixup_lock);
453 	list_add_tail(&fixup->list, &phy_fixup_list);
454 	mutex_unlock(&phy_fixup_lock);
455 
456 	return 0;
457 }
458 
459 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
460 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
461 			       int (*run)(struct phy_device *))
462 {
463 	return phy_register_fixup(NULL, phy_uid, phy_uid_mask, run);
464 }
465 EXPORT_SYMBOL(phy_register_fixup_for_uid);
466 
467 /* Registers a fixup to be run on the PHY with id string bus_id */
468 int phy_register_fixup_for_id(const char *bus_id,
469 			      int (*run)(struct phy_device *))
470 {
471 	return phy_register_fixup(bus_id, 0, 0, run);
472 }
473 EXPORT_SYMBOL(phy_register_fixup_for_id);
474 
475 static bool phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
476 {
477 	if (!strcmp(fixup->bus_id, phydev_name(phydev)))
478 		return true;
479 
480 	if (fixup->phy_uid_mask &&
481 	    phy_id_compare(phydev->phy_id, fixup->phy_uid, fixup->phy_uid_mask))
482 		return true;
483 
484 	return false;
485 }
486 
487 /* Runs any matching fixups for this phydev */
488 static int phy_scan_fixups(struct phy_device *phydev)
489 {
490 	struct phy_fixup *fixup;
491 
492 	mutex_lock(&phy_fixup_lock);
493 	list_for_each_entry(fixup, &phy_fixup_list, list) {
494 		if (phy_needs_fixup(phydev, fixup)) {
495 			int err = fixup->run(phydev);
496 
497 			if (err < 0) {
498 				mutex_unlock(&phy_fixup_lock);
499 				return err;
500 			}
501 			phydev->has_fixups = true;
502 		}
503 	}
504 	mutex_unlock(&phy_fixup_lock);
505 
506 	return 0;
507 }
508 
509 /**
510  * genphy_match_phy_device - match a PHY device with a PHY driver
511  * @phydev: target phy_device struct
512  * @phydrv: target phy_driver struct
513  *
514  * Description: Checks whether the given PHY device matches the specified
515  * PHY driver. For Clause 45 PHYs, iterates over the available device
516  * identifiers and compares them against the driver's expected PHY ID,
517  * applying the provided mask. For Clause 22 PHYs, a direct ID comparison
518  * is performed.
519  *
520  * Return: 1 if the PHY device matches the driver, 0 otherwise.
521  */
522 int genphy_match_phy_device(struct phy_device *phydev,
523 			    const struct phy_driver *phydrv)
524 {
525 	if (phydev->is_c45) {
526 		const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
527 		int i;
528 
529 		for (i = 1; i < num_ids; i++) {
530 			if (phydev->c45_ids.device_ids[i] == 0xffffffff)
531 				continue;
532 
533 			if (phy_id_compare(phydev->c45_ids.device_ids[i],
534 					   phydrv->phy_id, phydrv->phy_id_mask))
535 				return 1;
536 		}
537 
538 		return 0;
539 	}
540 
541 	return phy_id_compare(phydev->phy_id, phydrv->phy_id,
542 			      phydrv->phy_id_mask);
543 }
544 EXPORT_SYMBOL_GPL(genphy_match_phy_device);
545 
546 static int phy_bus_match(struct device *dev, const struct device_driver *drv)
547 {
548 	struct phy_device *phydev = to_phy_device(dev);
549 	const struct phy_driver *phydrv = to_phy_driver(drv);
550 
551 	if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
552 		return 0;
553 
554 	if (phydrv->match_phy_device)
555 		return phydrv->match_phy_device(phydev, phydrv);
556 
557 	return genphy_match_phy_device(phydev, phydrv);
558 }
559 
560 static ssize_t
561 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
562 {
563 	struct phy_device *phydev = to_phy_device(dev);
564 
565 	return sysfs_emit(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
566 }
567 static DEVICE_ATTR_RO(phy_id);
568 
569 static ssize_t
570 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
571 {
572 	struct phy_device *phydev = to_phy_device(dev);
573 	const char *mode = NULL;
574 
575 	if (phydev->is_internal)
576 		mode = "internal";
577 	else
578 		mode = phy_modes(phydev->interface);
579 
580 	return sysfs_emit(buf, "%s\n", mode);
581 }
582 static DEVICE_ATTR_RO(phy_interface);
583 
584 static ssize_t
585 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
586 		    char *buf)
587 {
588 	struct phy_device *phydev = to_phy_device(dev);
589 
590 	return sysfs_emit(buf, "%d\n", phydev->has_fixups);
591 }
592 static DEVICE_ATTR_RO(phy_has_fixups);
593 
594 static ssize_t phy_dev_flags_show(struct device *dev,
595 				  struct device_attribute *attr,
596 				  char *buf)
597 {
598 	struct phy_device *phydev = to_phy_device(dev);
599 
600 	return sysfs_emit(buf, "0x%08x\n", phydev->dev_flags);
601 }
602 static DEVICE_ATTR_RO(phy_dev_flags);
603 
604 static struct attribute *phy_dev_attrs[] = {
605 	&dev_attr_phy_id.attr,
606 	&dev_attr_phy_interface.attr,
607 	&dev_attr_phy_has_fixups.attr,
608 	&dev_attr_phy_dev_flags.attr,
609 	NULL,
610 };
611 
612 static const struct attribute_group phy_dev_group = {
613 	.attrs = phy_dev_attrs,
614 };
615 
616 #define MMD_DEVICE_ID_ATTR(n) \
617 static ssize_t mmd##n##_device_id_show(struct device *dev, \
618 				struct device_attribute *attr, char *buf) \
619 { \
620 	struct phy_device *phydev = to_phy_device(dev); \
621 	return sysfs_emit(buf, "0x%.8lx\n", \
622 			 (unsigned long)phydev->c45_ids.device_ids[n]); \
623 } \
624 static DEVICE_ATTR_RO(mmd##n##_device_id)
625 
626 MMD_DEVICE_ID_ATTR(1);
627 MMD_DEVICE_ID_ATTR(2);
628 MMD_DEVICE_ID_ATTR(3);
629 MMD_DEVICE_ID_ATTR(4);
630 MMD_DEVICE_ID_ATTR(5);
631 MMD_DEVICE_ID_ATTR(6);
632 MMD_DEVICE_ID_ATTR(7);
633 MMD_DEVICE_ID_ATTR(8);
634 MMD_DEVICE_ID_ATTR(9);
635 MMD_DEVICE_ID_ATTR(10);
636 MMD_DEVICE_ID_ATTR(11);
637 MMD_DEVICE_ID_ATTR(12);
638 MMD_DEVICE_ID_ATTR(13);
639 MMD_DEVICE_ID_ATTR(14);
640 MMD_DEVICE_ID_ATTR(15);
641 MMD_DEVICE_ID_ATTR(16);
642 MMD_DEVICE_ID_ATTR(17);
643 MMD_DEVICE_ID_ATTR(18);
644 MMD_DEVICE_ID_ATTR(19);
645 MMD_DEVICE_ID_ATTR(20);
646 MMD_DEVICE_ID_ATTR(21);
647 MMD_DEVICE_ID_ATTR(22);
648 MMD_DEVICE_ID_ATTR(23);
649 MMD_DEVICE_ID_ATTR(24);
650 MMD_DEVICE_ID_ATTR(25);
651 MMD_DEVICE_ID_ATTR(26);
652 MMD_DEVICE_ID_ATTR(27);
653 MMD_DEVICE_ID_ATTR(28);
654 MMD_DEVICE_ID_ATTR(29);
655 MMD_DEVICE_ID_ATTR(30);
656 MMD_DEVICE_ID_ATTR(31);
657 
658 static struct attribute *phy_mmd_attrs[] = {
659 	&dev_attr_mmd1_device_id.attr,
660 	&dev_attr_mmd2_device_id.attr,
661 	&dev_attr_mmd3_device_id.attr,
662 	&dev_attr_mmd4_device_id.attr,
663 	&dev_attr_mmd5_device_id.attr,
664 	&dev_attr_mmd6_device_id.attr,
665 	&dev_attr_mmd7_device_id.attr,
666 	&dev_attr_mmd8_device_id.attr,
667 	&dev_attr_mmd9_device_id.attr,
668 	&dev_attr_mmd10_device_id.attr,
669 	&dev_attr_mmd11_device_id.attr,
670 	&dev_attr_mmd12_device_id.attr,
671 	&dev_attr_mmd13_device_id.attr,
672 	&dev_attr_mmd14_device_id.attr,
673 	&dev_attr_mmd15_device_id.attr,
674 	&dev_attr_mmd16_device_id.attr,
675 	&dev_attr_mmd17_device_id.attr,
676 	&dev_attr_mmd18_device_id.attr,
677 	&dev_attr_mmd19_device_id.attr,
678 	&dev_attr_mmd20_device_id.attr,
679 	&dev_attr_mmd21_device_id.attr,
680 	&dev_attr_mmd22_device_id.attr,
681 	&dev_attr_mmd23_device_id.attr,
682 	&dev_attr_mmd24_device_id.attr,
683 	&dev_attr_mmd25_device_id.attr,
684 	&dev_attr_mmd26_device_id.attr,
685 	&dev_attr_mmd27_device_id.attr,
686 	&dev_attr_mmd28_device_id.attr,
687 	&dev_attr_mmd29_device_id.attr,
688 	&dev_attr_mmd30_device_id.attr,
689 	&dev_attr_mmd31_device_id.attr,
690 	NULL
691 };
692 
693 static umode_t phy_mmd_is_visible(struct kobject *kobj,
694 				  struct attribute *attr, int index)
695 {
696 	struct device *dev = kobj_to_dev(kobj);
697 	struct phy_device *phydev = to_phy_device(dev);
698 	const int i = index + 1;
699 
700 	if (!phydev->is_c45)
701 		return 0;
702 	if (i >= ARRAY_SIZE(phydev->c45_ids.device_ids) ||
703 	    phydev->c45_ids.device_ids[i] == 0xffffffff)
704 		return 0;
705 
706 	return attr->mode;
707 }
708 
709 static const struct attribute_group phy_mmd_group = {
710 	.name = "c45_phy_ids",
711 	.attrs = phy_mmd_attrs,
712 	.is_visible = phy_mmd_is_visible,
713 };
714 
715 static const struct attribute_group *phy_device_groups[] = {
716 	&phy_dev_group,
717 	&phy_mmd_group,
718 	NULL,
719 };
720 
721 static const struct device_type mdio_bus_phy_type = {
722 	.name = "PHY",
723 	.groups = phy_device_groups,
724 	.release = phy_device_release,
725 	.pm = pm_ptr(&mdio_bus_phy_pm_ops),
726 };
727 
728 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
729 {
730 	int ret;
731 
732 	ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
733 			     MDIO_ID_ARGS(phy_id));
734 	/* We only check for failures in executing the usermode binary,
735 	 * not whether a PHY driver module exists for the PHY ID.
736 	 * Accept -ENOENT because this may occur in case no initramfs exists,
737 	 * then modprobe isn't available.
738 	 */
739 	if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
740 		phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
741 			   ret, (unsigned long)phy_id);
742 		return ret;
743 	}
744 
745 	return 0;
746 }
747 
748 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
749 				     bool is_c45,
750 				     struct phy_c45_device_ids *c45_ids)
751 {
752 	struct phy_device *dev;
753 	struct mdio_device *mdiodev;
754 	int ret = 0;
755 
756 	/* We allocate the device, and initialize the default values */
757 	dev = kzalloc_obj(*dev);
758 	if (!dev)
759 		return ERR_PTR(-ENOMEM);
760 
761 	mdiodev = &dev->mdio;
762 	mdiodev->dev.parent = &bus->dev;
763 	mdiodev->dev.bus = &mdio_bus_type;
764 	mdiodev->dev.type = &mdio_bus_phy_type;
765 	mdiodev->bus = bus;
766 	mdiodev->bus_match = phy_bus_match;
767 	mdiodev->addr = addr;
768 	mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
769 	mdiodev->device_free = phy_mdio_device_free;
770 	mdiodev->device_remove = phy_mdio_device_remove;
771 	mdiodev->reset_state = -1;
772 
773 	dev->speed = SPEED_UNKNOWN;
774 	dev->duplex = DUPLEX_UNKNOWN;
775 	dev->pause = false;
776 	dev->asym_pause = false;
777 	dev->link = 0;
778 	dev->port = PORT_TP;
779 	dev->interface = PHY_INTERFACE_MODE_GMII;
780 
781 	dev->autoneg = AUTONEG_ENABLE;
782 
783 	dev->pma_extable = -ENODATA;
784 	dev->is_c45 = is_c45;
785 	dev->phy_id = phy_id;
786 	if (c45_ids)
787 		dev->c45_ids = *c45_ids;
788 	dev->irq = bus->irq[addr];
789 
790 	dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
791 	device_initialize(&mdiodev->dev);
792 
793 	dev->state = PHY_DOWN;
794 	INIT_LIST_HEAD(&dev->leds);
795 	INIT_LIST_HEAD(&dev->ports);
796 
797 	/* The driver's probe function must change that to the real number
798 	 * of ports possible on the PHY. We assume by default we are dealing
799 	 * with a single-port PHY
800 	 */
801 	dev->max_n_ports = 1;
802 
803 	mutex_init(&dev->lock);
804 	INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
805 
806 	/* Request the appropriate module unconditionally; don't
807 	 * bother trying to do so only if it isn't already loaded,
808 	 * because that gets complicated. A hotplug event would have
809 	 * done an unconditional modprobe anyway.
810 	 * We don't do normal hotplug because it won't work for MDIO
811 	 * -- because it relies on the device staying around for long
812 	 * enough for the driver to get loaded. With MDIO, the NIC
813 	 * driver will get bored and give up as soon as it finds that
814 	 * there's no driver _already_ loaded.
815 	 */
816 	if (is_c45 && c45_ids) {
817 		const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
818 		int i;
819 
820 		for (i = 1; i < num_ids; i++) {
821 			if (c45_ids->device_ids[i] == 0xffffffff)
822 				continue;
823 
824 			ret = phy_request_driver_module(dev,
825 						c45_ids->device_ids[i]);
826 			if (ret)
827 				break;
828 		}
829 	} else {
830 		ret = phy_request_driver_module(dev, phy_id);
831 	}
832 
833 	if (ret) {
834 		put_device(&mdiodev->dev);
835 		dev = ERR_PTR(ret);
836 	}
837 
838 	return dev;
839 }
840 EXPORT_SYMBOL(phy_device_create);
841 
842 /* phy_c45_probe_present - checks to see if a MMD is present in the package
843  * @bus: the target MII bus
844  * @prtad: PHY package address on the MII bus
845  * @devad: PHY device (MMD) address
846  *
847  * Read the MDIO_STAT2 register, and check whether a device is responding
848  * at this address.
849  *
850  * Returns: negative error number on bus access error, zero if no device
851  * is responding, or positive if a device is present.
852  */
853 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
854 {
855 	int stat2;
856 
857 	stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
858 	if (stat2 < 0)
859 		return stat2;
860 
861 	return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
862 }
863 
864 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
865  * @bus: the target MII bus
866  * @addr: PHY address on the MII bus
867  * @dev_addr: MMD address in the PHY.
868  * @devices_in_package: where to store the devices in package information.
869  *
870  * Description: reads devices in package registers of a MMD at @dev_addr
871  * from PHY at @addr on @bus.
872  *
873  * Returns: 0 on success, -EIO on failure.
874  */
875 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
876 				   u32 *devices_in_package)
877 {
878 	int phy_reg;
879 
880 	phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
881 	if (phy_reg < 0)
882 		return -EIO;
883 	*devices_in_package = phy_reg << 16;
884 
885 	phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
886 	if (phy_reg < 0)
887 		return -EIO;
888 	*devices_in_package |= phy_reg;
889 
890 	return 0;
891 }
892 
893 /**
894  * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
895  * @bus: the target MII bus
896  * @addr: PHY address on the MII bus
897  * @c45_ids: where to store the c45 ID information.
898  *
899  * Read the PHY "devices in package". If this appears to be valid, read
900  * the PHY identifiers for each device. Return the "devices in package"
901  * and identifiers in @c45_ids.
902  *
903  * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
904  * the "devices in package" is invalid or no device responds.
905  */
906 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
907 			   struct phy_c45_device_ids *c45_ids)
908 {
909 	const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
910 	u32 devs_in_pkg = 0;
911 	int i, ret, phy_reg;
912 
913 	/* Find first non-zero Devices In package. Device zero is reserved
914 	 * for 802.3 c45 complied PHYs, so don't probe it at first.
915 	 */
916 	for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
917 	     (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
918 		if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
919 			/* Check that there is a device present at this
920 			 * address before reading the devices-in-package
921 			 * register to avoid reading garbage from the PHY.
922 			 * Some PHYs (88x3310) vendor space is not IEEE802.3
923 			 * compliant.
924 			 */
925 			ret = phy_c45_probe_present(bus, addr, i);
926 			if (ret < 0)
927 				/* returning -ENODEV doesn't stop bus
928 				 * scanning
929 				 */
930 				return (phy_reg == -EIO ||
931 					phy_reg == -ENODEV) ? -ENODEV : -EIO;
932 
933 			if (!ret)
934 				continue;
935 		}
936 		phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
937 		if (phy_reg < 0)
938 			return -EIO;
939 	}
940 
941 	if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
942 		/* If mostly Fs, there is no device there, then let's probe
943 		 * MMD 0, as some 10G PHYs have zero Devices In package,
944 		 * e.g. Cortina CS4315/CS4340 PHY.
945 		 */
946 		phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
947 		if (phy_reg < 0)
948 			return -EIO;
949 
950 		/* no device there, let's get out of here */
951 		if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
952 			return -ENODEV;
953 	}
954 
955 	/* Now probe Device Identifiers for each device present. */
956 	for (i = 1; i < num_ids; i++) {
957 		if (!(devs_in_pkg & (1 << i)))
958 			continue;
959 
960 		if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
961 			/* Probe the "Device Present" bits for the vendor MMDs
962 			 * to ignore these if they do not contain IEEE 802.3
963 			 * registers.
964 			 */
965 			ret = phy_c45_probe_present(bus, addr, i);
966 			if (ret < 0)
967 				return ret;
968 
969 			if (!ret)
970 				continue;
971 		}
972 
973 		phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
974 		if (phy_reg < 0)
975 			return -EIO;
976 		c45_ids->device_ids[i] = phy_reg << 16;
977 
978 		phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
979 		if (phy_reg < 0)
980 			return -EIO;
981 		c45_ids->device_ids[i] |= phy_reg;
982 	}
983 
984 	c45_ids->devices_in_package = devs_in_pkg;
985 	/* Bit 0 doesn't represent a device, it indicates c22 regs presence */
986 	c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
987 
988 	return 0;
989 }
990 
991 /**
992  * get_phy_c22_id - reads the specified addr for its clause 22 ID.
993  * @bus: the target MII bus
994  * @addr: PHY address on the MII bus
995  * @phy_id: where to store the ID retrieved.
996  *
997  * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
998  * placing it in @phy_id. Return zero on successful read and the ID is
999  * valid, %-EIO on bus access error, or %-ENODEV if no device responds
1000  * or invalid ID.
1001  */
1002 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
1003 {
1004 	int phy_reg;
1005 
1006 	/* Grab the bits from PHYIR1, and put them in the upper half */
1007 	phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
1008 	if (phy_reg < 0) {
1009 		/* returning -ENODEV doesn't stop bus scanning */
1010 		return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
1011 	}
1012 
1013 	*phy_id = phy_reg << 16;
1014 
1015 	/* Grab the bits from PHYIR2, and put them in the lower half */
1016 	phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
1017 	if (phy_reg < 0) {
1018 		/* returning -ENODEV doesn't stop bus scanning */
1019 		return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
1020 	}
1021 
1022 	*phy_id |= phy_reg;
1023 
1024 	/* If the phy_id is mostly Fs, there is no device there */
1025 	if ((*phy_id & 0x1fffffff) == 0x1fffffff)
1026 		return -ENODEV;
1027 
1028 	return 0;
1029 }
1030 
1031 /* Extract the phy ID from the compatible string of the form
1032  * ethernet-phy-idAAAA.BBBB.
1033  */
1034 int fwnode_get_phy_id(struct fwnode_handle *fwnode, u32 *phy_id)
1035 {
1036 	unsigned int upper, lower;
1037 	const char *cp;
1038 	int ret;
1039 
1040 	ret = fwnode_property_read_string(fwnode, "compatible", &cp);
1041 	if (ret)
1042 		return ret;
1043 
1044 	if (sscanf(cp, "ethernet-phy-id%4x.%4x", &upper, &lower) != 2)
1045 		return -EINVAL;
1046 
1047 	*phy_id = ((upper & GENMASK(15, 0)) << 16) | (lower & GENMASK(15, 0));
1048 	return 0;
1049 }
1050 EXPORT_SYMBOL(fwnode_get_phy_id);
1051 
1052 /**
1053  * get_phy_device - reads the specified PHY device and returns its @phy_device
1054  *		    struct
1055  * @bus: the target MII bus
1056  * @addr: PHY address on the MII bus
1057  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
1058  *
1059  * Probe for a PHY at @addr on @bus.
1060  *
1061  * When probing for a clause 22 PHY, then read the ID registers. If we find
1062  * a valid ID, allocate and return a &struct phy_device.
1063  *
1064  * When probing for a clause 45 PHY, read the "devices in package" registers.
1065  * If the "devices in package" appears valid, read the ID registers for each
1066  * MMD, allocate and return a &struct phy_device.
1067  *
1068  * Returns an allocated &struct phy_device on success, %-ENODEV if there is
1069  * no PHY present, or %-EIO on bus access error.
1070  */
1071 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
1072 {
1073 	struct phy_c45_device_ids c45_ids;
1074 	u32 phy_id = 0;
1075 	int r;
1076 
1077 	c45_ids.devices_in_package = 0;
1078 	c45_ids.mmds_present = 0;
1079 	memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
1080 
1081 	if (is_c45)
1082 		r = get_phy_c45_ids(bus, addr, &c45_ids);
1083 	else
1084 		r = get_phy_c22_id(bus, addr, &phy_id);
1085 
1086 	if (r)
1087 		return ERR_PTR(r);
1088 
1089 	/* PHY device such as the Marvell Alaska 88E2110 will return a PHY ID
1090 	 * of 0 when probed using get_phy_c22_id() with no error. Proceed to
1091 	 * probe with C45 to see if we're able to get a valid PHY ID in the C45
1092 	 * space, if successful, create the C45 PHY device.
1093 	 */
1094 	if (!is_c45 && phy_id == 0 && bus->read_c45) {
1095 		r = get_phy_c45_ids(bus, addr, &c45_ids);
1096 		if (!r)
1097 			return phy_device_create(bus, addr, phy_id,
1098 						 true, &c45_ids);
1099 	}
1100 
1101 	return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
1102 }
1103 EXPORT_SYMBOL(get_phy_device);
1104 
1105 /**
1106  * phy_device_register - Register the phy device on the MDIO bus
1107  * @phydev: phy_device structure to be added to the MDIO bus
1108  */
1109 int phy_device_register(struct phy_device *phydev)
1110 {
1111 	int err;
1112 
1113 	err = mdiobus_register_device(&phydev->mdio);
1114 	if (err)
1115 		return err;
1116 
1117 	/* Deassert the reset signal */
1118 	phy_device_reset(phydev, 0);
1119 
1120 	/* Run all of the fixups for this PHY */
1121 	err = phy_scan_fixups(phydev);
1122 	if (err) {
1123 		phydev_err(phydev, "failed to initialize\n");
1124 		goto out;
1125 	}
1126 
1127 	err = device_add(&phydev->mdio.dev);
1128 	if (err) {
1129 		phydev_err(phydev, "failed to add\n");
1130 		goto out;
1131 	}
1132 
1133 	return 0;
1134 
1135  out:
1136 	/* Assert the reset signal */
1137 	phy_device_reset(phydev, 1);
1138 
1139 	mdiobus_unregister_device(&phydev->mdio);
1140 	return err;
1141 }
1142 EXPORT_SYMBOL(phy_device_register);
1143 
1144 /**
1145  * phy_device_remove - Remove a previously registered phy device from the MDIO bus
1146  * @phydev: phy_device structure to remove
1147  *
1148  * This doesn't free the phy_device itself, it merely reverses the effects
1149  * of phy_device_register(). Use phy_device_free() to free the device
1150  * after calling this function.
1151  */
1152 void phy_device_remove(struct phy_device *phydev)
1153 {
1154 	unregister_mii_timestamper(phydev->mii_ts);
1155 	pse_control_put(phydev->psec);
1156 
1157 	device_del(&phydev->mdio.dev);
1158 
1159 	/* Assert the reset signal */
1160 	phy_device_reset(phydev, 1);
1161 
1162 	mdiobus_unregister_device(&phydev->mdio);
1163 }
1164 EXPORT_SYMBOL(phy_device_remove);
1165 
1166 /**
1167  * phy_get_c45_ids - Read 802.3-c45 IDs for phy device.
1168  * @phydev: phy_device structure to read 802.3-c45 IDs
1169  *
1170  * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
1171  * the "devices in package" is invalid.
1172  */
1173 int phy_get_c45_ids(struct phy_device *phydev)
1174 {
1175 	return get_phy_c45_ids(phydev->mdio.bus, phydev->mdio.addr,
1176 			       &phydev->c45_ids);
1177 }
1178 EXPORT_SYMBOL(phy_get_c45_ids);
1179 
1180 /**
1181  * phy_find_next - finds the next PHY device on the bus
1182  * @bus: the target MII bus
1183  * @pos: cursor
1184  *
1185  * Return: next phy_device on the bus, or NULL
1186  */
1187 struct phy_device *phy_find_next(struct mii_bus *bus, struct phy_device *pos)
1188 {
1189 	for (int addr = pos ? pos->mdio.addr + 1 : 0;
1190 	     addr < PHY_MAX_ADDR; addr++) {
1191 		struct phy_device *phydev = mdiobus_get_phy(bus, addr);
1192 
1193 		if (phydev)
1194 			return phydev;
1195 	}
1196 	return NULL;
1197 }
1198 EXPORT_SYMBOL_GPL(phy_find_next);
1199 
1200 /**
1201  * phy_prepare_link - prepares the PHY layer to monitor link status
1202  * @phydev: target phy_device struct
1203  * @handler: callback function for link status change notifications
1204  *
1205  * Description: Tells the PHY infrastructure to handle the
1206  *   gory details on monitoring link status (whether through
1207  *   polling or an interrupt), and to call back to the
1208  *   connected device driver when the link status changes.
1209  *   If you want to monitor your own link state, don't call
1210  *   this function.
1211  */
1212 static void phy_prepare_link(struct phy_device *phydev,
1213 			     void (*handler)(struct net_device *))
1214 {
1215 	phydev->adjust_link = handler;
1216 }
1217 
1218 /**
1219  * phy_connect_direct - connect an ethernet device to a specific phy_device
1220  * @dev: the network device to connect
1221  * @phydev: the pointer to the phy device
1222  * @handler: callback function for state change notifications
1223  * @interface: PHY device's interface
1224  */
1225 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
1226 		       void (*handler)(struct net_device *),
1227 		       phy_interface_t interface)
1228 {
1229 	int rc;
1230 
1231 	if (!dev)
1232 		return -EINVAL;
1233 
1234 	rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1235 	if (rc)
1236 		return rc;
1237 
1238 	phy_prepare_link(phydev, handler);
1239 	if (phy_interrupt_is_valid(phydev))
1240 		phy_request_interrupt(phydev);
1241 
1242 	return 0;
1243 }
1244 EXPORT_SYMBOL(phy_connect_direct);
1245 
1246 /**
1247  * phy_connect - connect an ethernet device to a PHY device
1248  * @dev: the network device to connect
1249  * @bus_id: the id string of the PHY device to connect
1250  * @handler: callback function for state change notifications
1251  * @interface: PHY device's interface
1252  *
1253  * Description: Convenience function for connecting ethernet
1254  *   devices to PHY devices.  The default behavior is for
1255  *   the PHY infrastructure to handle everything, and only notify
1256  *   the connected driver when the link status changes.  If you
1257  *   don't want, or can't use the provided functionality, you may
1258  *   choose to call only the subset of functions which provide
1259  *   the desired functionality.
1260  */
1261 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1262 			       void (*handler)(struct net_device *),
1263 			       phy_interface_t interface)
1264 {
1265 	struct phy_device *phydev;
1266 	struct device *d;
1267 	int rc;
1268 
1269 	/* Search the list of PHY devices on the mdio bus for the
1270 	 * PHY with the requested name
1271 	 */
1272 	d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1273 	if (!d) {
1274 		pr_err("PHY %s not found\n", bus_id);
1275 		return ERR_PTR(-ENODEV);
1276 	}
1277 	phydev = to_phy_device(d);
1278 
1279 	rc = phy_connect_direct(dev, phydev, handler, interface);
1280 	put_device(d);
1281 	if (rc)
1282 		return ERR_PTR(rc);
1283 
1284 	return phydev;
1285 }
1286 EXPORT_SYMBOL(phy_connect);
1287 
1288 /**
1289  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1290  *		    device
1291  * @phydev: target phy_device struct
1292  */
1293 void phy_disconnect(struct phy_device *phydev)
1294 {
1295 	if (phy_is_started(phydev))
1296 		phy_stop(phydev);
1297 
1298 	if (phy_interrupt_is_valid(phydev))
1299 		phy_free_interrupt(phydev);
1300 
1301 	phydev->adjust_link = NULL;
1302 
1303 	phy_detach(phydev);
1304 }
1305 EXPORT_SYMBOL(phy_disconnect);
1306 
1307 /**
1308  * phy_poll_reset - Safely wait until a PHY reset has properly completed
1309  * @phydev: The PHY device to poll
1310  *
1311  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1312  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
1313  *   register must be polled until the BMCR_RESET bit clears.
1314  *
1315  *   Furthermore, any attempts to write to PHY registers may have no effect
1316  *   or even generate MDIO bus errors until this is complete.
1317  *
1318  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1319  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
1320  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
1321  *   effort to support such broken PHYs, this function is separate from the
1322  *   standard phy_init_hw() which will zero all the other bits in the BMCR
1323  *   and reapply all driver-specific and board-specific fixups.
1324  */
1325 static int phy_poll_reset(struct phy_device *phydev)
1326 {
1327 	/* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1328 	int ret, val;
1329 
1330 	ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1331 				    50000, 600000, true);
1332 	if (ret)
1333 		return ret;
1334 	/* Some chips (smsc911x) may still need up to another 1ms after the
1335 	 * BMCR_RESET bit is cleared before they are usable.
1336 	 */
1337 	msleep(1);
1338 	return 0;
1339 }
1340 
1341 int phy_init_hw(struct phy_device *phydev)
1342 {
1343 	int ret = 0;
1344 
1345 	/* Deassert the reset signal */
1346 	phy_device_reset(phydev, 0);
1347 
1348 	if (!phydev->drv)
1349 		return 0;
1350 
1351 	if (phydev->drv->soft_reset) {
1352 		ret = phydev->drv->soft_reset(phydev);
1353 		if (ret < 0)
1354 			return ret;
1355 
1356 		/* see comment in genphy_soft_reset for an explanation */
1357 		phydev->suspended = 0;
1358 	}
1359 
1360 	ret = phy_scan_fixups(phydev);
1361 	if (ret < 0)
1362 		return ret;
1363 
1364 	phy_interface_zero(phydev->possible_interfaces);
1365 
1366 	if (phydev->drv->config_init) {
1367 		ret = phydev->drv->config_init(phydev);
1368 		if (ret < 0)
1369 			return ret;
1370 	}
1371 
1372 	if (phydev->drv->config_intr) {
1373 		ret = phydev->drv->config_intr(phydev);
1374 		if (ret < 0)
1375 			return ret;
1376 	}
1377 
1378 	return 0;
1379 }
1380 EXPORT_SYMBOL(phy_init_hw);
1381 
1382 void phy_attached_info(struct phy_device *phydev)
1383 {
1384 	phy_attached_print(phydev, NULL);
1385 }
1386 EXPORT_SYMBOL(phy_attached_info);
1387 
1388 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1389 char *phy_attached_info_irq(struct phy_device *phydev)
1390 {
1391 	char *irq_str;
1392 	char irq_num[8];
1393 
1394 	switch(phydev->irq) {
1395 	case PHY_POLL:
1396 		irq_str = "POLL";
1397 		break;
1398 	case PHY_MAC_INTERRUPT:
1399 		irq_str = "MAC";
1400 		break;
1401 	default:
1402 		snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1403 		irq_str = irq_num;
1404 		break;
1405 	}
1406 
1407 	return kasprintf(GFP_KERNEL, "%s", irq_str);
1408 }
1409 EXPORT_SYMBOL(phy_attached_info_irq);
1410 
1411 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1412 {
1413 	const char *unbound = phydev->drv ? "" : "[unbound] ";
1414 	char *irq_str = phy_attached_info_irq(phydev);
1415 
1416 	if (!fmt) {
1417 		phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1418 			    phydev_name(phydev), irq_str);
1419 	} else {
1420 		va_list ap;
1421 
1422 		phydev_info(phydev, ATTACHED_FMT, unbound,
1423 			    phydev_name(phydev), irq_str);
1424 
1425 		va_start(ap, fmt);
1426 		vprintk(fmt, ap);
1427 		va_end(ap);
1428 	}
1429 	kfree(irq_str);
1430 }
1431 EXPORT_SYMBOL(phy_attached_print);
1432 
1433 static void phy_sysfs_create_links(struct phy_device *phydev)
1434 {
1435 	struct net_device *dev = phydev->attached_dev;
1436 	int err;
1437 
1438 	if (!dev)
1439 		return;
1440 
1441 	err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1442 				"attached_dev");
1443 	if (err)
1444 		return;
1445 
1446 	err = sysfs_create_link_nowarn(&dev->dev.kobj,
1447 				       &phydev->mdio.dev.kobj,
1448 				       "phydev");
1449 	if (err) {
1450 		dev_err(&dev->dev, "could not add device link to %s err %d\n",
1451 			kobject_name(&phydev->mdio.dev.kobj),
1452 			err);
1453 		/* non-fatal - some net drivers can use one netdevice
1454 		 * with more then one phy
1455 		 */
1456 	}
1457 
1458 	phydev->sysfs_links = true;
1459 }
1460 
1461 static ssize_t
1462 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1463 		    char *buf)
1464 {
1465 	struct phy_device *phydev = to_phy_device(dev);
1466 
1467 	return sysfs_emit(buf, "%d\n", !phydev->attached_dev);
1468 }
1469 static DEVICE_ATTR_RO(phy_standalone);
1470 
1471 /**
1472  * phy_sfp_connect_phy - Connect the SFP module's PHY to the upstream PHY
1473  * @upstream: pointer to the upstream phy device
1474  * @phy: pointer to the SFP module's phy device
1475  *
1476  * This helper allows keeping track of PHY devices on the link. It adds the
1477  * SFP module's phy to the phy namespace of the upstream phy
1478  *
1479  * Return: 0 on success, otherwise a negative error code.
1480  */
1481 static int phy_sfp_connect_phy(void *upstream, struct phy_device *phy)
1482 {
1483 	struct phy_device *phydev = upstream;
1484 	struct net_device *dev = phydev->attached_dev;
1485 
1486 	if (dev)
1487 		return phy_link_topo_add_phy(dev, phy, PHY_UPSTREAM_PHY, phydev);
1488 
1489 	return 0;
1490 }
1491 
1492 /**
1493  * phy_sfp_disconnect_phy - Disconnect the SFP module's PHY from the upstream PHY
1494  * @upstream: pointer to the upstream phy device
1495  * @phy: pointer to the SFP module's phy device
1496  *
1497  * This helper allows keeping track of PHY devices on the link. It removes the
1498  * SFP module's phy to the phy namespace of the upstream phy. As the module phy
1499  * will be destroyed, re-inserting the same module will add a new phy with a
1500  * new index.
1501  */
1502 static void phy_sfp_disconnect_phy(void *upstream, struct phy_device *phy)
1503 {
1504 	struct phy_device *phydev = upstream;
1505 	struct net_device *dev = phydev->attached_dev;
1506 
1507 	if (dev)
1508 		phy_link_topo_del_phy(dev, phy);
1509 }
1510 
1511 /**
1512  * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1513  * @upstream: pointer to the phy device
1514  * @bus: sfp bus representing cage being attached
1515  *
1516  * This is used to fill in the sfp_upstream_ops .attach member.
1517  */
1518 static void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1519 {
1520 	struct phy_device *phydev = upstream;
1521 
1522 	if (phydev->attached_dev)
1523 		phydev->attached_dev->sfp_bus = bus;
1524 	phydev->sfp_bus_attached = true;
1525 }
1526 
1527 /**
1528  * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1529  * @upstream: pointer to the phy device
1530  * @bus: sfp bus representing cage being attached
1531  *
1532  * This is used to fill in the sfp_upstream_ops .detach member.
1533  */
1534 static void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1535 {
1536 	struct phy_device *phydev = upstream;
1537 
1538 	if (phydev->attached_dev)
1539 		phydev->attached_dev->sfp_bus = NULL;
1540 	phydev->sfp_bus_attached = false;
1541 }
1542 
1543 static int phy_sfp_module_insert(void *upstream, const struct sfp_eeprom_id *id)
1544 {
1545 	__ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
1546 	struct phy_device *phydev = upstream;
1547 	const struct sfp_module_caps *caps;
1548 	struct phy_port *port;
1549 
1550 	phy_interface_t iface;
1551 
1552 	linkmode_zero(sfp_support);
1553 
1554 	port = phy_get_sfp_port(phydev);
1555 	if (!port)
1556 		return -EINVAL;
1557 
1558 	caps = sfp_get_module_caps(phydev->sfp_bus);
1559 
1560 	linkmode_and(sfp_support, port->supported, caps->link_modes);
1561 	if (linkmode_empty(sfp_support)) {
1562 		dev_err(&phydev->mdio.dev, "incompatible SFP module inserted, no common linkmode\n");
1563 		return -EINVAL;
1564 	}
1565 
1566 	iface = sfp_select_interface(phydev->sfp_bus, sfp_support);
1567 	if (iface == PHY_INTERFACE_MODE_NA) {
1568 		dev_err(&phydev->mdio.dev, "PHY %s does not support the SFP module's requested MII interfaces\n",
1569 			phydev_name(phydev));
1570 		return -EINVAL;
1571 	}
1572 
1573 	if (phydev->n_ports == 1)
1574 		phydev->port = caps->port;
1575 
1576 	if (port->ops && port->ops->configure_mii)
1577 		return port->ops->configure_mii(port, true, iface);
1578 
1579 	return 0;
1580 }
1581 
1582 static void phy_sfp_module_remove(void *upstream)
1583 {
1584 	struct phy_device *phydev = upstream;
1585 	struct phy_port *port = phy_get_sfp_port(phydev);
1586 
1587 	if (port && port->ops && port->ops->configure_mii)
1588 		port->ops->configure_mii(port, false, PHY_INTERFACE_MODE_NA);
1589 
1590 	if (phydev->n_ports == 1)
1591 		phydev->port = PORT_NONE;
1592 }
1593 
1594 static void phy_sfp_link_up(void *upstream)
1595 {
1596 	struct phy_device *phydev = upstream;
1597 	struct phy_port *port = phy_get_sfp_port(phydev);
1598 
1599 	if (port && port->ops && port->ops->link_up)
1600 		port->ops->link_up(port);
1601 }
1602 
1603 static void phy_sfp_link_down(void *upstream)
1604 {
1605 	struct phy_device *phydev = upstream;
1606 	struct phy_port *port = phy_get_sfp_port(phydev);
1607 
1608 	if (port && port->ops && port->ops->link_down)
1609 		port->ops->link_down(port);
1610 }
1611 
1612 static const struct sfp_upstream_ops sfp_phydev_ops = {
1613 	.attach = phy_sfp_attach,
1614 	.detach = phy_sfp_detach,
1615 	.module_insert = phy_sfp_module_insert,
1616 	.module_remove = phy_sfp_module_remove,
1617 	.link_up = phy_sfp_link_up,
1618 	.link_down = phy_sfp_link_down,
1619 	.connect_phy = phy_sfp_connect_phy,
1620 	.disconnect_phy = phy_sfp_disconnect_phy,
1621 };
1622 
1623 static int phy_add_port(struct phy_device *phydev, struct phy_port *port)
1624 {
1625 	int ret = 0;
1626 
1627 	if (phydev->n_ports == phydev->max_n_ports)
1628 		return -EBUSY;
1629 
1630 	/* We set all ports as active by default, PHY drivers may deactivate
1631 	 * them (when unused)
1632 	 */
1633 	port->active = true;
1634 
1635 	if (port->is_mii) {
1636 		if (phydev->drv && phydev->drv->attach_mii_port)
1637 			ret = phydev->drv->attach_mii_port(phydev, port);
1638 	} else {
1639 		if (phydev->drv && phydev->drv->attach_mdi_port)
1640 			ret = phydev->drv->attach_mdi_port(phydev, port);
1641 	}
1642 
1643 	if (ret)
1644 		return ret;
1645 
1646 	/* The PHY driver might have added, removed or set medium/pairs info,
1647 	 * so update the port supported accordingly.
1648 	 */
1649 	phy_port_update_supported(port);
1650 
1651 	list_add(&port->head, &phydev->ports);
1652 
1653 	phydev->n_ports++;
1654 
1655 	return 0;
1656 }
1657 
1658 static void phy_del_port(struct phy_device *phydev, struct phy_port *port)
1659 {
1660 	if (!phydev->n_ports)
1661 		return;
1662 
1663 	list_del(&port->head);
1664 
1665 	phydev->n_ports--;
1666 }
1667 
1668 static int phy_setup_sfp_port(struct phy_device *phydev)
1669 {
1670 	struct phy_port *port = phy_port_alloc();
1671 	int ret;
1672 
1673 	if (!port)
1674 		return -ENOMEM;
1675 
1676 	port->parent_type = PHY_PORT_PHY;
1677 	port->phy = phydev;
1678 
1679 	/* The PHY is a media converter, the port connected to the SFP cage
1680 	 * is a MII port.
1681 	 */
1682 	port->is_mii = true;
1683 	port->is_sfp = true;
1684 
1685 	/* The port->supported and port->interfaces list will be populated
1686 	 * when attaching the port to the phydev.
1687 	 */
1688 	ret = phy_add_port(phydev, port);
1689 	if (ret)
1690 		phy_port_destroy(port);
1691 
1692 	return ret;
1693 }
1694 
1695 /**
1696  * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1697  * @phydev: Pointer to phy_device
1698  */
1699 static int phy_sfp_probe(struct phy_device *phydev)
1700 {
1701 	struct sfp_bus *bus;
1702 	int ret = 0;
1703 
1704 	if (phydev->mdio.dev.fwnode) {
1705 		bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1706 		if (IS_ERR(bus))
1707 			return PTR_ERR(bus);
1708 
1709 		phydev->sfp_bus = bus;
1710 
1711 		ret = sfp_bus_add_upstream(bus, phydev, &sfp_phydev_ops);
1712 		sfp_bus_put(bus);
1713 	}
1714 
1715 	if (!ret && phydev->sfp_bus)
1716 		ret = phy_setup_sfp_port(phydev);
1717 
1718 	return ret;
1719 }
1720 
1721 static bool phy_drv_supports_irq(const struct phy_driver *phydrv)
1722 {
1723 	return phydrv->config_intr && phydrv->handle_interrupt;
1724 }
1725 
1726 /**
1727  * phy_attach_direct - attach a network device to a given PHY device pointer
1728  * @dev: network device to attach
1729  * @phydev: Pointer to phy_device to attach
1730  * @flags: PHY device's dev_flags
1731  * @interface: PHY device's interface
1732  *
1733  * Description: Called by drivers to attach to a particular PHY
1734  *     device. The phy_device is found, and properly hooked up
1735  *     to the phy_driver.  If no driver is attached, then a
1736  *     generic driver is used.  The phy_device is given a ptr to
1737  *     the attaching device, and given a callback for link status
1738  *     change.  The phy_device is returned to the attaching driver.
1739  *     This function takes a reference on the phy device.
1740  */
1741 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1742 		      u32 flags, phy_interface_t interface)
1743 {
1744 	struct mii_bus *bus = phydev->mdio.bus;
1745 	struct device *d = &phydev->mdio.dev;
1746 	struct module *ndev_owner = NULL;
1747 	int err;
1748 
1749 	/* For Ethernet device drivers that register their own MDIO bus, we
1750 	 * will have bus->owner match ndev_mod, so we do not want to increment
1751 	 * our own module->refcnt here, otherwise we would not be able to
1752 	 * unload later on.
1753 	 */
1754 	if (dev)
1755 		ndev_owner = dev->dev.parent->driver->owner;
1756 	if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1757 		phydev_err(phydev, "failed to get the bus module\n");
1758 		return -EIO;
1759 	}
1760 
1761 	get_device(d);
1762 
1763 	/* Assume that if there is no driver, that it doesn't
1764 	 * exist, and we should use the genphy driver.
1765 	 */
1766 	if (!d->driver) {
1767 		if (phydev->is_c45)
1768 			d->driver = &genphy_c45_driver.mdiodrv.driver;
1769 		else
1770 			d->driver = &genphy_driver.mdiodrv.driver;
1771 
1772 		phydev->is_genphy_driven = 1;
1773 	}
1774 
1775 	if (!try_module_get(d->driver->owner)) {
1776 		phydev_err(phydev, "failed to get the device driver module\n");
1777 		err = -EIO;
1778 		goto error_put_device;
1779 	}
1780 
1781 	if (phydev->is_genphy_driven) {
1782 		err = d->driver->probe(d);
1783 		if (err >= 0)
1784 			err = device_bind_driver(d);
1785 
1786 		if (err)
1787 			goto error_module_put;
1788 	}
1789 
1790 	if (phydev->attached_dev) {
1791 		dev_err(&dev->dev, "PHY already attached\n");
1792 		err = -EBUSY;
1793 		goto error;
1794 	}
1795 
1796 	phydev->phy_link_change = phy_link_change;
1797 	if (dev) {
1798 		phydev->attached_dev = dev;
1799 		dev->phydev = phydev;
1800 
1801 		if (phydev->sfp_bus_attached)
1802 			dev->sfp_bus = phydev->sfp_bus;
1803 
1804 		err = phy_link_topo_add_phy(dev, phydev, PHY_UPSTREAM_MAC, dev);
1805 		if (err)
1806 			goto error;
1807 	}
1808 
1809 	/* Some Ethernet drivers try to connect to a PHY device before
1810 	 * calling register_netdevice() -> netdev_register_kobject() and
1811 	 * does the dev->dev.kobj initialization. Here we only check for
1812 	 * success which indicates that the network device kobject is
1813 	 * ready. Once we do that we still need to keep track of whether
1814 	 * links were successfully set up or not for phy_detach() to
1815 	 * remove them accordingly.
1816 	 */
1817 	phydev->sysfs_links = false;
1818 
1819 	phy_sysfs_create_links(phydev);
1820 
1821 	if (!phydev->attached_dev) {
1822 		err = sysfs_create_file(&phydev->mdio.dev.kobj,
1823 					&dev_attr_phy_standalone.attr);
1824 		if (err)
1825 			phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1826 	}
1827 
1828 	phydev->dev_flags |= flags;
1829 
1830 	phydev->interface = interface;
1831 
1832 	phydev->state = PHY_READY;
1833 
1834 	phydev->interrupts = PHY_INTERRUPT_DISABLED;
1835 
1836 	/* PHYs can request to use poll mode even though they have an
1837 	 * associated interrupt line. This could be the case if they
1838 	 * detect a broken interrupt handling.
1839 	 */
1840 	if (phydev->dev_flags & PHY_F_NO_IRQ)
1841 		phydev->irq = PHY_POLL;
1842 
1843 	if (!phy_drv_supports_irq(phydev->drv) && phy_interrupt_is_valid(phydev))
1844 		phydev->irq = PHY_POLL;
1845 
1846 	/* Port is set to PORT_TP by default and the actual PHY driver will set
1847 	 * it to different value depending on the PHY configuration. If we have
1848 	 * the generic PHY driver we can't figure it out, thus set the old
1849 	 * legacy PORT_MII value.
1850 	 */
1851 	if (phydev->is_genphy_driven)
1852 		phydev->port = PORT_MII;
1853 
1854 	/* Initial carrier state is off as the phy is about to be
1855 	 * (re)initialized.
1856 	 */
1857 	if (dev)
1858 		netif_carrier_off(phydev->attached_dev);
1859 
1860 	/* Do initial configuration here, now that
1861 	 * we have certain key parameters
1862 	 * (dev_flags and interface)
1863 	 */
1864 	err = phy_init_hw(phydev);
1865 	if (err)
1866 		goto error;
1867 
1868 	phy_resume(phydev);
1869 
1870 	/**
1871 	 * If the external phy used by current mac interface is managed by
1872 	 * another mac interface, so we should create a device link between
1873 	 * phy dev and mac dev.
1874 	 */
1875 	if (dev && phydev->mdio.bus->parent && dev->dev.parent != phydev->mdio.bus->parent)
1876 		phydev->devlink = device_link_add(dev->dev.parent, &phydev->mdio.dev,
1877 						  DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS);
1878 
1879 	return err;
1880 
1881 error:
1882 	/* phy_detach() does all of the cleanup below */
1883 	phy_detach(phydev);
1884 	return err;
1885 
1886 error_module_put:
1887 	module_put(d->driver->owner);
1888 	phydev->is_genphy_driven = 0;
1889 	d->driver = NULL;
1890 error_put_device:
1891 	put_device(d);
1892 	if (ndev_owner != bus->owner)
1893 		module_put(bus->owner);
1894 	return err;
1895 }
1896 EXPORT_SYMBOL(phy_attach_direct);
1897 
1898 /**
1899  * phy_detach - detach a PHY device from its network device
1900  * @phydev: target phy_device struct
1901  *
1902  * This detaches the phy device from its network device and the phy
1903  * driver, and drops the reference count taken in phy_attach_direct().
1904  */
1905 void phy_detach(struct phy_device *phydev)
1906 {
1907 	struct net_device *dev = phydev->attached_dev;
1908 	struct module *ndev_owner = NULL;
1909 	struct mii_bus *bus;
1910 
1911 	if (phydev->devlink) {
1912 		device_link_del(phydev->devlink);
1913 		phydev->devlink = NULL;
1914 	}
1915 
1916 	if (phydev->sysfs_links) {
1917 		if (dev)
1918 			sysfs_remove_link(&dev->dev.kobj, "phydev");
1919 		sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1920 	}
1921 
1922 	if (!phydev->attached_dev)
1923 		sysfs_remove_file(&phydev->mdio.dev.kobj,
1924 				  &dev_attr_phy_standalone.attr);
1925 
1926 	phy_suspend(phydev);
1927 	if (dev) {
1928 		struct hwtstamp_provider *hwprov;
1929 
1930 		hwprov = rtnl_dereference(dev->hwprov);
1931 		/* Disable timestamp if it is the one selected */
1932 		if (hwprov && hwprov->phydev == phydev) {
1933 			rcu_assign_pointer(dev->hwprov, NULL);
1934 			kfree_rcu(hwprov, rcu_head);
1935 		}
1936 
1937 		phydev->attached_dev->phydev = NULL;
1938 		phydev->attached_dev = NULL;
1939 		phy_link_topo_del_phy(dev, phydev);
1940 	}
1941 
1942 	phydev->phy_link_change = NULL;
1943 	phydev->phylink = NULL;
1944 
1945 	if (phydev->mdio.dev.driver)
1946 		module_put(phydev->mdio.dev.driver->owner);
1947 
1948 	/* If the device had no specific driver before (i.e. - it
1949 	 * was using the generic driver), we unbind the device
1950 	 * from the generic driver so that there's a chance a
1951 	 * real driver could be loaded
1952 	 */
1953 	if (phydev->is_genphy_driven) {
1954 		device_release_driver(&phydev->mdio.dev);
1955 		phydev->is_genphy_driven = 0;
1956 	}
1957 
1958 	/* Assert the reset signal */
1959 	phy_device_reset(phydev, 1);
1960 
1961 	/*
1962 	 * The phydev might go away on the put_device() below, so avoid
1963 	 * a use-after-free bug by reading the underlying bus first.
1964 	 */
1965 	bus = phydev->mdio.bus;
1966 
1967 	put_device(&phydev->mdio.dev);
1968 	if (dev)
1969 		ndev_owner = dev->dev.parent->driver->owner;
1970 	if (ndev_owner != bus->owner)
1971 		module_put(bus->owner);
1972 }
1973 EXPORT_SYMBOL(phy_detach);
1974 
1975 int phy_suspend(struct phy_device *phydev)
1976 {
1977 	struct net_device *netdev = phydev->attached_dev;
1978 	const struct phy_driver *phydrv = phydev->drv;
1979 	int ret;
1980 
1981 	if (phydev->suspended || !phydrv)
1982 		return 0;
1983 
1984 	phydev->wol_enabled = phy_may_wakeup(phydev) ||
1985 			      (netdev && netdev->ethtool->wol_enabled);
1986 	/* If the device has WOL enabled, we cannot suspend the PHY */
1987 	if (phydev->wol_enabled && !(phydrv->flags & PHY_ALWAYS_CALL_SUSPEND))
1988 		return -EBUSY;
1989 
1990 	if (!phydrv->suspend)
1991 		return 0;
1992 
1993 	ret = phydrv->suspend(phydev);
1994 	if (!ret)
1995 		phydev->suspended = true;
1996 
1997 	return ret;
1998 }
1999 EXPORT_SYMBOL(phy_suspend);
2000 
2001 int __phy_resume(struct phy_device *phydev)
2002 {
2003 	const struct phy_driver *phydrv = phydev->drv;
2004 	int ret;
2005 
2006 	lockdep_assert_held(&phydev->lock);
2007 
2008 	if (!phydrv || !phydrv->resume)
2009 		return 0;
2010 
2011 	ret = phydrv->resume(phydev);
2012 	if (!ret)
2013 		phydev->suspended = false;
2014 
2015 	return ret;
2016 }
2017 EXPORT_SYMBOL(__phy_resume);
2018 
2019 int phy_resume(struct phy_device *phydev)
2020 {
2021 	int ret;
2022 
2023 	mutex_lock(&phydev->lock);
2024 	ret = __phy_resume(phydev);
2025 	mutex_unlock(&phydev->lock);
2026 
2027 	return ret;
2028 }
2029 EXPORT_SYMBOL(phy_resume);
2030 
2031 /**
2032  * phy_reset_after_clk_enable - perform a PHY reset if needed
2033  * @phydev: target phy_device struct
2034  *
2035  * Description: Some PHYs are known to need a reset after their refclk was
2036  *   enabled. This function evaluates the flags and perform the reset if it's
2037  *   needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
2038  *   was reset.
2039  */
2040 int phy_reset_after_clk_enable(struct phy_device *phydev)
2041 {
2042 	if (!phydev || !phydev->drv)
2043 		return -ENODEV;
2044 
2045 	if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
2046 		phy_device_reset(phydev, 1);
2047 		phy_device_reset(phydev, 0);
2048 		return 1;
2049 	}
2050 
2051 	return 0;
2052 }
2053 EXPORT_SYMBOL(phy_reset_after_clk_enable);
2054 
2055 /* Generic PHY support and helper functions */
2056 
2057 /**
2058  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
2059  * @phydev: target phy_device struct
2060  * @advert: auto-negotiation parameters to advertise
2061  *
2062  * Description: Writes MII_ADVERTISE with the appropriate values,
2063  *   after sanitizing the values to make sure we only advertise
2064  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
2065  *   hasn't changed, and > 0 if it has changed.
2066  */
2067 static int genphy_config_advert(struct phy_device *phydev,
2068 				const unsigned long *advert)
2069 {
2070 	int err, bmsr, changed = 0;
2071 	u32 adv;
2072 
2073 	adv = linkmode_adv_to_mii_adv_t(advert);
2074 
2075 	/* Setup standard advertisement */
2076 	err = phy_modify_changed(phydev, MII_ADVERTISE,
2077 				 ADVERTISE_ALL | ADVERTISE_100BASE4 |
2078 				 ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
2079 				 adv);
2080 	if (err < 0)
2081 		return err;
2082 	if (err > 0)
2083 		changed = 1;
2084 
2085 	bmsr = phy_read(phydev, MII_BMSR);
2086 	if (bmsr < 0)
2087 		return bmsr;
2088 
2089 	/* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
2090 	 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
2091 	 * logical 1.
2092 	 */
2093 	if (!(bmsr & BMSR_ESTATEN))
2094 		return changed;
2095 
2096 	adv = linkmode_adv_to_mii_ctrl1000_t(advert);
2097 
2098 	err = phy_modify_changed(phydev, MII_CTRL1000,
2099 				 ADVERTISE_1000FULL | ADVERTISE_1000HALF,
2100 				 adv);
2101 	if (err < 0)
2102 		return err;
2103 	if (err > 0)
2104 		changed = 1;
2105 
2106 	return changed;
2107 }
2108 
2109 /**
2110  * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
2111  * @phydev: target phy_device struct
2112  *
2113  * Description: Writes MII_ADVERTISE with the appropriate values,
2114  *   after sanitizing the values to make sure we only advertise
2115  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
2116  *   hasn't changed, and > 0 if it has changed. This function is intended
2117  *   for Clause 37 1000Base-X mode.
2118  */
2119 static int genphy_c37_config_advert(struct phy_device *phydev)
2120 {
2121 	u16 adv = 0;
2122 
2123 	/* Only allow advertising what this PHY supports */
2124 	linkmode_and(phydev->advertising, phydev->advertising,
2125 		     phydev->supported);
2126 
2127 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2128 			      phydev->advertising))
2129 		adv |= ADVERTISE_1000XFULL;
2130 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2131 			      phydev->advertising))
2132 		adv |= ADVERTISE_1000XPAUSE;
2133 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2134 			      phydev->advertising))
2135 		adv |= ADVERTISE_1000XPSE_ASYM;
2136 
2137 	return phy_modify_changed(phydev, MII_ADVERTISE,
2138 				  ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
2139 				  ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
2140 				  adv);
2141 }
2142 
2143 /**
2144  * genphy_setup_forced - configures/forces speed/duplex from @phydev
2145  * @phydev: target phy_device struct
2146  *
2147  * Description: Configures MII_BMCR to force speed/duplex
2148  *   to the values in phydev. Assumes that the values are valid.
2149  *   Please see phy_sanitize_settings().
2150  */
2151 int genphy_setup_forced(struct phy_device *phydev)
2152 {
2153 	u16 ctl;
2154 
2155 	phydev->pause = false;
2156 	phydev->asym_pause = false;
2157 
2158 	ctl = mii_bmcr_encode_fixed(phydev->speed, phydev->duplex);
2159 
2160 	return phy_modify(phydev, MII_BMCR,
2161 			  ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
2162 }
2163 EXPORT_SYMBOL(genphy_setup_forced);
2164 
2165 static int genphy_setup_master_slave(struct phy_device *phydev)
2166 {
2167 	u16 ctl = 0;
2168 
2169 	if (!phydev->is_gigabit_capable)
2170 		return 0;
2171 
2172 	switch (phydev->master_slave_set) {
2173 	case MASTER_SLAVE_CFG_MASTER_PREFERRED:
2174 		ctl |= CTL1000_PREFER_MASTER;
2175 		break;
2176 	case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
2177 		break;
2178 	case MASTER_SLAVE_CFG_MASTER_FORCE:
2179 		ctl |= CTL1000_AS_MASTER;
2180 		fallthrough;
2181 	case MASTER_SLAVE_CFG_SLAVE_FORCE:
2182 		ctl |= CTL1000_ENABLE_MASTER;
2183 		break;
2184 	case MASTER_SLAVE_CFG_UNKNOWN:
2185 	case MASTER_SLAVE_CFG_UNSUPPORTED:
2186 		return 0;
2187 	default:
2188 		phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2189 		return -EOPNOTSUPP;
2190 	}
2191 
2192 	return phy_modify_changed(phydev, MII_CTRL1000,
2193 				  (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2194 				   CTL1000_PREFER_MASTER), ctl);
2195 }
2196 
2197 int genphy_read_master_slave(struct phy_device *phydev)
2198 {
2199 	int cfg, state;
2200 	int val;
2201 
2202 	phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2203 	phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2204 
2205 	val = phy_read(phydev, MII_CTRL1000);
2206 	if (val < 0)
2207 		return val;
2208 
2209 	if (val & CTL1000_ENABLE_MASTER) {
2210 		if (val & CTL1000_AS_MASTER)
2211 			cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2212 		else
2213 			cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2214 	} else {
2215 		if (val & CTL1000_PREFER_MASTER)
2216 			cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2217 		else
2218 			cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2219 	}
2220 
2221 	val = phy_read(phydev, MII_STAT1000);
2222 	if (val < 0)
2223 		return val;
2224 
2225 	if (val & LPA_1000MSFAIL) {
2226 		state = MASTER_SLAVE_STATE_ERR;
2227 	} else if (phydev->link) {
2228 		/* this bits are valid only for active link */
2229 		if (val & LPA_1000MSRES)
2230 			state = MASTER_SLAVE_STATE_MASTER;
2231 		else
2232 			state = MASTER_SLAVE_STATE_SLAVE;
2233 	} else {
2234 		state = MASTER_SLAVE_STATE_UNKNOWN;
2235 	}
2236 
2237 	phydev->master_slave_get = cfg;
2238 	phydev->master_slave_state = state;
2239 
2240 	return 0;
2241 }
2242 EXPORT_SYMBOL(genphy_read_master_slave);
2243 
2244 /**
2245  * genphy_restart_aneg - Enable and Restart Autonegotiation
2246  * @phydev: target phy_device struct
2247  */
2248 int genphy_restart_aneg(struct phy_device *phydev)
2249 {
2250 	/* Don't isolate the PHY if we're negotiating */
2251 	return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2252 			  BMCR_ANENABLE | BMCR_ANRESTART);
2253 }
2254 EXPORT_SYMBOL(genphy_restart_aneg);
2255 
2256 /**
2257  * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2258  * @phydev: target phy_device struct
2259  * @restart: whether aneg restart is requested
2260  *
2261  * Check, and restart auto-negotiation if needed.
2262  */
2263 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2264 {
2265 	int ret;
2266 
2267 	if (!restart) {
2268 		/* Advertisement hasn't changed, but maybe aneg was never on to
2269 		 * begin with?  Or maybe phy was isolated?
2270 		 */
2271 		ret = phy_read(phydev, MII_BMCR);
2272 		if (ret < 0)
2273 			return ret;
2274 
2275 		if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2276 			restart = true;
2277 	}
2278 
2279 	if (restart)
2280 		return genphy_restart_aneg(phydev);
2281 
2282 	return 0;
2283 }
2284 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2285 
2286 /**
2287  * __genphy_config_aneg - restart auto-negotiation or write BMCR
2288  * @phydev: target phy_device struct
2289  * @changed: whether autoneg is requested
2290  *
2291  * Description: If auto-negotiation is enabled, we configure the
2292  *   advertising, and then restart auto-negotiation.  If it is not
2293  *   enabled, then we write the BMCR.
2294  */
2295 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2296 {
2297 	__ETHTOOL_DECLARE_LINK_MODE_MASK(fixed_advert);
2298 	const struct link_capabilities *c;
2299 	unsigned long *advert;
2300 	int err;
2301 
2302 	err = genphy_c45_an_config_eee_aneg(phydev);
2303 	if (err < 0)
2304 		return err;
2305 	else if (err)
2306 		changed = true;
2307 
2308 	err = genphy_setup_master_slave(phydev);
2309 	if (err < 0)
2310 		return err;
2311 	else if (err)
2312 		changed = true;
2313 
2314 	if (phydev->autoneg == AUTONEG_ENABLE) {
2315 		/* Only allow advertising what this PHY supports */
2316 		linkmode_and(phydev->advertising, phydev->advertising,
2317 			     phydev->supported);
2318 		advert = phydev->advertising;
2319 	} else if (phydev->speed < SPEED_1000) {
2320 		return genphy_setup_forced(phydev);
2321 	} else {
2322 		linkmode_zero(fixed_advert);
2323 
2324 		c = phy_caps_lookup(phydev->speed, phydev->duplex,
2325 				    phydev->supported, true);
2326 		if (c)
2327 			linkmode_and(fixed_advert, phydev->supported,
2328 				     c->linkmodes);
2329 
2330 		advert = fixed_advert;
2331 	}
2332 
2333 	err = genphy_config_advert(phydev, advert);
2334 	if (err < 0) /* error */
2335 		return err;
2336 	else if (err)
2337 		changed = true;
2338 
2339 	return genphy_check_and_restart_aneg(phydev, changed);
2340 }
2341 EXPORT_SYMBOL(__genphy_config_aneg);
2342 
2343 /**
2344  * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2345  * @phydev: target phy_device struct
2346  *
2347  * Description: If auto-negotiation is enabled, we configure the
2348  *   advertising, and then restart auto-negotiation.  If it is not
2349  *   enabled, then we write the BMCR. This function is intended
2350  *   for use with Clause 37 1000Base-X mode.
2351  */
2352 int genphy_c37_config_aneg(struct phy_device *phydev)
2353 {
2354 	int err, changed;
2355 
2356 	if (phydev->autoneg != AUTONEG_ENABLE)
2357 		return genphy_setup_forced(phydev);
2358 
2359 	err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2360 			 BMCR_SPEED1000);
2361 	if (err)
2362 		return err;
2363 
2364 	changed = genphy_c37_config_advert(phydev);
2365 	if (changed < 0) /* error */
2366 		return changed;
2367 
2368 	if (!changed) {
2369 		/* Advertisement hasn't changed, but maybe aneg was never on to
2370 		 * begin with?  Or maybe phy was isolated?
2371 		 */
2372 		int ctl = phy_read(phydev, MII_BMCR);
2373 
2374 		if (ctl < 0)
2375 			return ctl;
2376 
2377 		if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2378 			changed = 1; /* do restart aneg */
2379 	}
2380 
2381 	/* Only restart aneg if we are advertising something different
2382 	 * than we were before.
2383 	 */
2384 	if (changed > 0)
2385 		return genphy_restart_aneg(phydev);
2386 
2387 	return 0;
2388 }
2389 EXPORT_SYMBOL(genphy_c37_config_aneg);
2390 
2391 /**
2392  * genphy_aneg_done - return auto-negotiation status
2393  * @phydev: target phy_device struct
2394  *
2395  * Description: Reads the status register and returns 0 either if
2396  *   auto-negotiation is incomplete, or if there was an error.
2397  *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2398  */
2399 int genphy_aneg_done(struct phy_device *phydev)
2400 {
2401 	int retval = phy_read(phydev, MII_BMSR);
2402 
2403 	return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2404 }
2405 EXPORT_SYMBOL(genphy_aneg_done);
2406 
2407 /**
2408  * genphy_update_link - update link status in @phydev
2409  * @phydev: target phy_device struct
2410  *
2411  * Description: Update the value in phydev->link to reflect the
2412  *   current link value.  In order to do this, we need to read
2413  *   the status register twice, keeping the second value.
2414  */
2415 int genphy_update_link(struct phy_device *phydev)
2416 {
2417 	int status = 0, bmcr;
2418 
2419 	bmcr = phy_read(phydev, MII_BMCR);
2420 	if (bmcr < 0)
2421 		return bmcr;
2422 
2423 	/* Autoneg is being started, therefore disregard BMSR value and
2424 	 * report link as down.
2425 	 */
2426 	if (bmcr & BMCR_ANRESTART)
2427 		goto done;
2428 
2429 	/* The link state is latched low so that momentary link
2430 	 * drops can be detected. Do not double-read the status
2431 	 * in polling mode to detect such short link drops except
2432 	 * if the link was already down.
2433 	 */
2434 	if (!phy_polling_mode(phydev) || !phydev->link) {
2435 		status = phy_read(phydev, MII_BMSR);
2436 		if (status < 0)
2437 			return status;
2438 		else if (status & BMSR_LSTATUS)
2439 			goto done;
2440 	}
2441 
2442 	/* Read link and autonegotiation status */
2443 	status = phy_read(phydev, MII_BMSR);
2444 	if (status < 0)
2445 		return status;
2446 done:
2447 	phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2448 	phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2449 
2450 	/* Consider the case that autoneg was started and "aneg complete"
2451 	 * bit has been reset, but "link up" bit not yet.
2452 	 */
2453 	if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2454 		phydev->link = 0;
2455 
2456 	return 0;
2457 }
2458 EXPORT_SYMBOL(genphy_update_link);
2459 
2460 int genphy_read_lpa(struct phy_device *phydev)
2461 {
2462 	int lpa, lpagb;
2463 
2464 	if (phydev->autoneg == AUTONEG_ENABLE) {
2465 		if (!phydev->autoneg_complete) {
2466 			mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2467 							0);
2468 			mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2469 			return 0;
2470 		}
2471 
2472 		if (phydev->is_gigabit_capable) {
2473 			lpagb = phy_read(phydev, MII_STAT1000);
2474 			if (lpagb < 0)
2475 				return lpagb;
2476 
2477 			if (lpagb & LPA_1000MSFAIL) {
2478 				int adv = phy_read(phydev, MII_CTRL1000);
2479 
2480 				if (adv < 0)
2481 					return adv;
2482 
2483 				if (adv & CTL1000_ENABLE_MASTER)
2484 					phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2485 				else
2486 					phydev_err(phydev, "Master/Slave resolution failed\n");
2487 				return -ENOLINK;
2488 			}
2489 
2490 			mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2491 							lpagb);
2492 		}
2493 
2494 		lpa = phy_read(phydev, MII_LPA);
2495 		if (lpa < 0)
2496 			return lpa;
2497 
2498 		mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2499 	} else {
2500 		linkmode_zero(phydev->lp_advertising);
2501 	}
2502 
2503 	return 0;
2504 }
2505 EXPORT_SYMBOL(genphy_read_lpa);
2506 
2507 /**
2508  * genphy_read_status_fixed - read the link parameters for !aneg mode
2509  * @phydev: target phy_device struct
2510  *
2511  * Read the current duplex and speed state for a PHY operating with
2512  * autonegotiation disabled.
2513  */
2514 int genphy_read_status_fixed(struct phy_device *phydev)
2515 {
2516 	int bmcr = phy_read(phydev, MII_BMCR);
2517 
2518 	if (bmcr < 0)
2519 		return bmcr;
2520 
2521 	if (bmcr & BMCR_FULLDPLX)
2522 		phydev->duplex = DUPLEX_FULL;
2523 	else
2524 		phydev->duplex = DUPLEX_HALF;
2525 
2526 	if (bmcr & BMCR_SPEED1000)
2527 		phydev->speed = SPEED_1000;
2528 	else if (bmcr & BMCR_SPEED100)
2529 		phydev->speed = SPEED_100;
2530 	else
2531 		phydev->speed = SPEED_10;
2532 
2533 	return 0;
2534 }
2535 EXPORT_SYMBOL(genphy_read_status_fixed);
2536 
2537 /**
2538  * genphy_read_status - check the link status and update current link state
2539  * @phydev: target phy_device struct
2540  *
2541  * Description: Check the link, then figure out the current state
2542  *   by comparing what we advertise with what the link partner
2543  *   advertises.  Start by checking the gigabit possibilities,
2544  *   then move on to 10/100.
2545  */
2546 int genphy_read_status(struct phy_device *phydev)
2547 {
2548 	int err, old_link = phydev->link;
2549 
2550 	/* Update the link, but return if there was an error */
2551 	err = genphy_update_link(phydev);
2552 	if (err)
2553 		return err;
2554 
2555 	/* why bother the PHY if nothing can have changed */
2556 	if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2557 		return 0;
2558 
2559 	phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2560 	phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2561 	phydev->speed = SPEED_UNKNOWN;
2562 	phydev->duplex = DUPLEX_UNKNOWN;
2563 	phydev->pause = false;
2564 	phydev->asym_pause = false;
2565 
2566 	if (phydev->is_gigabit_capable) {
2567 		err = genphy_read_master_slave(phydev);
2568 		if (err < 0)
2569 			return err;
2570 	}
2571 
2572 	err = genphy_read_lpa(phydev);
2573 	if (err < 0)
2574 		return err;
2575 
2576 	if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2577 		phy_resolve_aneg_linkmode(phydev);
2578 	} else if (phydev->autoneg == AUTONEG_DISABLE) {
2579 		err = genphy_read_status_fixed(phydev);
2580 		if (err < 0)
2581 			return err;
2582 	}
2583 
2584 	return 0;
2585 }
2586 EXPORT_SYMBOL(genphy_read_status);
2587 
2588 /**
2589  * genphy_c37_read_status - check the link status and update current link state
2590  * @phydev: target phy_device struct
2591  * @changed: pointer where to store if link changed
2592  *
2593  * Description: Check the link, then figure out the current state
2594  *   by comparing what we advertise with what the link partner
2595  *   advertises. This function is for Clause 37 1000Base-X mode.
2596  *
2597  *   If link has changed, @changed is set to true, false otherwise.
2598  */
2599 int genphy_c37_read_status(struct phy_device *phydev, bool *changed)
2600 {
2601 	int lpa, err, old_link = phydev->link;
2602 
2603 	/* Update the link, but return if there was an error */
2604 	err = genphy_update_link(phydev);
2605 	if (err)
2606 		return err;
2607 
2608 	/* why bother the PHY if nothing can have changed */
2609 	if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link) {
2610 		*changed = false;
2611 		return 0;
2612 	}
2613 
2614 	/* Signal link has changed */
2615 	*changed = true;
2616 	phydev->duplex = DUPLEX_UNKNOWN;
2617 	phydev->pause = false;
2618 	phydev->asym_pause = false;
2619 
2620 	if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2621 		lpa = phy_read(phydev, MII_LPA);
2622 		if (lpa < 0)
2623 			return lpa;
2624 
2625 		linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2626 				 phydev->lp_advertising, lpa & LPA_LPACK);
2627 		linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2628 				 phydev->lp_advertising, lpa & LPA_1000XFULL);
2629 		linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2630 				 phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2631 		linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2632 				 phydev->lp_advertising,
2633 				 lpa & LPA_1000XPAUSE_ASYM);
2634 
2635 		phy_resolve_aneg_linkmode(phydev);
2636 	} else if (phydev->autoneg == AUTONEG_DISABLE) {
2637 		int bmcr = phy_read(phydev, MII_BMCR);
2638 
2639 		if (bmcr < 0)
2640 			return bmcr;
2641 
2642 		if (bmcr & BMCR_FULLDPLX)
2643 			phydev->duplex = DUPLEX_FULL;
2644 		else
2645 			phydev->duplex = DUPLEX_HALF;
2646 	}
2647 
2648 	return 0;
2649 }
2650 EXPORT_SYMBOL(genphy_c37_read_status);
2651 
2652 /**
2653  * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2654  * @phydev: target phy_device struct
2655  *
2656  * Description: Perform a software PHY reset using the standard
2657  * BMCR_RESET bit and poll for the reset bit to be cleared.
2658  *
2659  * Returns: 0 on success, < 0 on failure
2660  */
2661 int genphy_soft_reset(struct phy_device *phydev)
2662 {
2663 	u16 res = BMCR_RESET;
2664 	int ret;
2665 
2666 	if (phydev->autoneg == AUTONEG_ENABLE)
2667 		res |= BMCR_ANRESTART;
2668 
2669 	ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2670 	if (ret < 0)
2671 		return ret;
2672 
2673 	/* Clause 22 states that setting bit BMCR_RESET sets control registers
2674 	 * to their default value. Therefore the POWER DOWN bit is supposed to
2675 	 * be cleared after soft reset.
2676 	 */
2677 	phydev->suspended = 0;
2678 
2679 	ret = phy_poll_reset(phydev);
2680 	if (ret)
2681 		return ret;
2682 
2683 	/* BMCR may be reset to defaults */
2684 	if (phydev->autoneg == AUTONEG_DISABLE)
2685 		ret = genphy_setup_forced(phydev);
2686 
2687 	return ret;
2688 }
2689 EXPORT_SYMBOL(genphy_soft_reset);
2690 
2691 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2692 {
2693 	/* It seems there are cases where the interrupts are handled by another
2694 	 * entity (ie an IRQ controller embedded inside the PHY) and do not
2695 	 * need any other interraction from phylib. In this case, just trigger
2696 	 * the state machine directly.
2697 	 */
2698 	phy_trigger_machine(phydev);
2699 
2700 	return 0;
2701 }
2702 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2703 
2704 /**
2705  * genphy_read_abilities - read PHY abilities from Clause 22 registers
2706  * @phydev: target phy_device struct
2707  *
2708  * Description: Reads the PHY's abilities and populates
2709  * phydev->supported accordingly.
2710  *
2711  * Returns: 0 on success, < 0 on failure
2712  */
2713 int genphy_read_abilities(struct phy_device *phydev)
2714 {
2715 	int val;
2716 
2717 	linkmode_set_bit_array(phy_basic_ports_array,
2718 			       ARRAY_SIZE(phy_basic_ports_array),
2719 			       phydev->supported);
2720 
2721 	val = phy_read(phydev, MII_BMSR);
2722 	if (val < 0)
2723 		return val;
2724 
2725 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2726 			 val & BMSR_ANEGCAPABLE);
2727 
2728 	linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2729 			 val & BMSR_100FULL);
2730 	linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2731 			 val & BMSR_100HALF);
2732 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2733 			 val & BMSR_10FULL);
2734 	linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2735 			 val & BMSR_10HALF);
2736 
2737 	if (val & BMSR_ESTATEN) {
2738 		val = phy_read(phydev, MII_ESTATUS);
2739 		if (val < 0)
2740 			return val;
2741 
2742 		linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2743 				 phydev->supported, val & ESTATUS_1000_TFULL);
2744 		linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2745 				 phydev->supported, val & ESTATUS_1000_THALF);
2746 		linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2747 				 phydev->supported, val & ESTATUS_1000_XFULL);
2748 	}
2749 
2750 	/* This is optional functionality. If not supported, we may get an error
2751 	 * which should be ignored.
2752 	 */
2753 	genphy_c45_read_eee_abilities(phydev);
2754 
2755 	return 0;
2756 }
2757 EXPORT_SYMBOL(genphy_read_abilities);
2758 
2759 /* This is used for the phy device which doesn't support the MMD extended
2760  * register access, but it does have side effect when we are trying to access
2761  * the MMD register via indirect method.
2762  */
2763 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2764 {
2765 	return -EOPNOTSUPP;
2766 }
2767 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2768 
2769 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2770 				 u16 regnum, u16 val)
2771 {
2772 	return -EOPNOTSUPP;
2773 }
2774 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2775 
2776 int genphy_suspend(struct phy_device *phydev)
2777 {
2778 	return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2779 }
2780 EXPORT_SYMBOL(genphy_suspend);
2781 
2782 int genphy_resume(struct phy_device *phydev)
2783 {
2784 	return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2785 }
2786 EXPORT_SYMBOL(genphy_resume);
2787 
2788 int genphy_loopback(struct phy_device *phydev, bool enable, int speed)
2789 {
2790 	if (enable) {
2791 		u16 ctl = BMCR_LOOPBACK;
2792 		int ret, val;
2793 
2794 		if (speed == SPEED_10 || speed == SPEED_100 ||
2795 		    speed == SPEED_1000)
2796 			phydev->speed = speed;
2797 		else if (speed)
2798 			return -EINVAL;
2799 
2800 		ctl |= mii_bmcr_encode_fixed(phydev->speed, phydev->duplex);
2801 
2802 		phy_modify(phydev, MII_BMCR, ~0, ctl);
2803 
2804 		ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2805 					    val & BMSR_LSTATUS,
2806 				    5000, 500000, true);
2807 		if (ret)
2808 			return ret;
2809 	} else {
2810 		phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2811 
2812 		phy_config_aneg(phydev);
2813 	}
2814 
2815 	return 0;
2816 }
2817 EXPORT_SYMBOL(genphy_loopback);
2818 
2819 /**
2820  * phy_remove_link_mode - Remove a supported link mode
2821  * @phydev: phy_device structure to remove link mode from
2822  * @link_mode: Link mode to be removed
2823  *
2824  * Description: Some MACs don't support all link modes which the PHY
2825  * does.  e.g. a 1G MAC often does not support 1000Half. Add a helper
2826  * to remove a link mode.
2827  */
2828 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2829 {
2830 	linkmode_clear_bit(link_mode, phydev->supported);
2831 	phy_advertise_supported(phydev);
2832 }
2833 EXPORT_SYMBOL(phy_remove_link_mode);
2834 
2835 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2836 {
2837 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2838 		linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2839 	linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2840 		linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2841 }
2842 
2843 /**
2844  * phy_advertise_supported - Advertise all supported modes
2845  * @phydev: target phy_device struct
2846  *
2847  * Description: Called to advertise all supported modes, doesn't touch
2848  * pause mode advertising.
2849  */
2850 void phy_advertise_supported(struct phy_device *phydev)
2851 {
2852 	__ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2853 
2854 	linkmode_copy(new, phydev->supported);
2855 	phy_copy_pause_bits(new, phydev->advertising);
2856 	linkmode_copy(phydev->advertising, new);
2857 }
2858 EXPORT_SYMBOL(phy_advertise_supported);
2859 
2860 /**
2861  * phy_advertise_eee_all - Advertise all supported EEE modes
2862  * @phydev: target phy_device struct
2863  *
2864  * Description: Per default phylib preserves the EEE advertising at the time of
2865  * phy probing, which might be a subset of the supported EEE modes. Use this
2866  * function when all supported EEE modes should be advertised. This does not
2867  * trigger auto-negotiation, so must be called before phy_start()/
2868  * phylink_start() which will start auto-negotiation.
2869  */
2870 void phy_advertise_eee_all(struct phy_device *phydev)
2871 {
2872 	linkmode_copy(phydev->advertising_eee, phydev->supported_eee);
2873 }
2874 EXPORT_SYMBOL_GPL(phy_advertise_eee_all);
2875 
2876 /**
2877  * phy_support_eee - Set initial EEE policy configuration
2878  * @phydev: Target phy_device struct
2879  *
2880  * This function configures the initial policy for Energy Efficient Ethernet
2881  * (EEE) on the specified PHY device, influencing that EEE capabilities are
2882  * advertised before the link is established. It should be called during PHY
2883  * registration by the MAC driver and/or the PHY driver (for SmartEEE PHYs)
2884  * if MAC supports LPI or PHY is capable to compensate missing LPI functionality
2885  * of the MAC.
2886  *
2887  * The function sets default EEE policy parameters, including preparing the PHY
2888  * to advertise EEE capabilities based on hardware support.
2889  *
2890  * It also sets the expected configuration for Low Power Idle (LPI) in the MAC
2891  * driver. If the PHY framework determines that both local and remote
2892  * advertisements support EEE, and the negotiated link mode is compatible with
2893  * EEE, it will set enable_tx_lpi = true. The MAC driver is expected to act on
2894  * this setting by enabling the LPI timer if enable_tx_lpi is set.
2895  */
2896 void phy_support_eee(struct phy_device *phydev)
2897 {
2898 	linkmode_copy(phydev->advertising_eee, phydev->supported_eee);
2899 	phydev->eee_cfg.tx_lpi_enabled = true;
2900 	phydev->eee_cfg.eee_enabled = true;
2901 }
2902 EXPORT_SYMBOL(phy_support_eee);
2903 
2904 /**
2905  * phy_disable_eee - Disable EEE for the PHY
2906  * @phydev: Target phy_device struct
2907  *
2908  * This function is used by MAC drivers for MAC's which don't support EEE.
2909  * It disables EEE on the PHY layer.
2910  */
2911 void phy_disable_eee(struct phy_device *phydev)
2912 {
2913 	linkmode_zero(phydev->advertising_eee);
2914 	phydev->eee_cfg.tx_lpi_enabled = false;
2915 	phydev->eee_cfg.eee_enabled = false;
2916 	/* don't let userspace re-enable EEE advertisement */
2917 	linkmode_fill(phydev->eee_disabled_modes);
2918 }
2919 EXPORT_SYMBOL_GPL(phy_disable_eee);
2920 
2921 /**
2922  * phy_support_sym_pause - Enable support of symmetrical pause
2923  * @phydev: target phy_device struct
2924  *
2925  * Description: Called by the MAC to indicate is supports symmetrical
2926  * Pause, but not asym pause.
2927  */
2928 void phy_support_sym_pause(struct phy_device *phydev)
2929 {
2930 	linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2931 	phy_copy_pause_bits(phydev->advertising, phydev->supported);
2932 }
2933 EXPORT_SYMBOL(phy_support_sym_pause);
2934 
2935 /**
2936  * phy_support_asym_pause - Enable support of asym pause
2937  * @phydev: target phy_device struct
2938  *
2939  * Description: Called by the MAC to indicate is supports Asym Pause.
2940  */
2941 void phy_support_asym_pause(struct phy_device *phydev)
2942 {
2943 	phy_copy_pause_bits(phydev->advertising, phydev->supported);
2944 }
2945 EXPORT_SYMBOL(phy_support_asym_pause);
2946 
2947 /**
2948  * phy_set_sym_pause - Configure symmetric Pause
2949  * @phydev: target phy_device struct
2950  * @rx: Receiver Pause is supported
2951  * @tx: Transmit Pause is supported
2952  * @autoneg: Auto neg should be used
2953  *
2954  * Description: Configure advertised Pause support depending on if
2955  * receiver pause and pause auto neg is supported. Generally called
2956  * from the set_pauseparam .ndo.
2957  */
2958 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2959 		       bool autoneg)
2960 {
2961 	linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2962 
2963 	if (rx && tx && autoneg)
2964 		linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2965 				 phydev->supported);
2966 
2967 	linkmode_copy(phydev->advertising, phydev->supported);
2968 }
2969 EXPORT_SYMBOL(phy_set_sym_pause);
2970 
2971 /**
2972  * phy_set_asym_pause - Configure Pause and Asym Pause
2973  * @phydev: target phy_device struct
2974  * @rx: Receiver Pause is supported
2975  * @tx: Transmit Pause is supported
2976  *
2977  * Description: Configure advertised Pause support depending on if
2978  * transmit and receiver pause is supported. If there has been a
2979  * change in adverting, trigger a new autoneg. Generally called from
2980  * the set_pauseparam .ndo.
2981  */
2982 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2983 {
2984 	__ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2985 
2986 	linkmode_copy(oldadv, phydev->advertising);
2987 	linkmode_set_pause(phydev->advertising, tx, rx);
2988 
2989 	if (!linkmode_equal(oldadv, phydev->advertising) &&
2990 	    phydev->autoneg)
2991 		phy_start_aneg(phydev);
2992 }
2993 EXPORT_SYMBOL(phy_set_asym_pause);
2994 
2995 /**
2996  * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2997  * @phydev: phy_device struct
2998  * @pp: requested pause configuration
2999  *
3000  * Description: Test if the PHY/MAC combination supports the Pause
3001  * configuration the user is requesting. Returns True if it is
3002  * supported, false otherwise.
3003  */
3004 bool phy_validate_pause(struct phy_device *phydev,
3005 			struct ethtool_pauseparam *pp)
3006 {
3007 	if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3008 			       phydev->supported) && pp->rx_pause)
3009 		return false;
3010 
3011 	if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3012 			       phydev->supported) &&
3013 	    pp->rx_pause != pp->tx_pause)
3014 		return false;
3015 
3016 	return true;
3017 }
3018 EXPORT_SYMBOL(phy_validate_pause);
3019 
3020 /**
3021  * phy_get_pause - resolve negotiated pause modes
3022  * @phydev: phy_device struct
3023  * @tx_pause: pointer to bool to indicate whether transmit pause should be
3024  * enabled.
3025  * @rx_pause: pointer to bool to indicate whether receive pause should be
3026  * enabled.
3027  *
3028  * Resolve and return the flow control modes according to the negotiation
3029  * result. This includes checking that we are operating in full duplex mode.
3030  * See linkmode_resolve_pause() for further details.
3031  */
3032 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
3033 {
3034 	if (phydev->duplex != DUPLEX_FULL) {
3035 		*tx_pause = false;
3036 		*rx_pause = false;
3037 		return;
3038 	}
3039 
3040 	return linkmode_resolve_pause(phydev->advertising,
3041 				      phydev->lp_advertising,
3042 				      tx_pause, rx_pause);
3043 }
3044 EXPORT_SYMBOL(phy_get_pause);
3045 
3046 #if IS_ENABLED(CONFIG_OF_MDIO)
3047 static int phy_get_u32_property(struct device *dev, const char *name, u32 *val)
3048 {
3049 	return device_property_read_u32(dev, name, val);
3050 }
3051 #else
3052 static int phy_get_u32_property(struct device *dev, const char *name, u32 *val)
3053 {
3054 	return -EINVAL;
3055 }
3056 #endif
3057 
3058 /**
3059  * phy_get_internal_delay - returns the index of the internal delay
3060  * @phydev: phy_device struct
3061  * @delay_values: array of delays the PHY supports
3062  * @size: the size of the delay array
3063  * @is_rx: boolean to indicate to get the rx internal delay
3064  *
3065  * Returns the index within the array of internal delay passed in.
3066  * If the device property is not present then the interface type is checked
3067  * if the interface defines use of internal delay then a 1 is returned otherwise
3068  * a 0 is returned.
3069  * The array must be in ascending order. If PHY does not have an ascending order
3070  * array then size = 0 and the value of the delay property is returned.
3071  * Return -EINVAL if the delay is invalid or cannot be found.
3072  */
3073 s32 phy_get_internal_delay(struct phy_device *phydev, const int *delay_values,
3074 			   int size, bool is_rx)
3075 {
3076 	struct device *dev = &phydev->mdio.dev;
3077 	int i, ret;
3078 	u32 delay;
3079 
3080 	if (is_rx) {
3081 		ret = phy_get_u32_property(dev, "rx-internal-delay-ps", &delay);
3082 		if (ret < 0 && size == 0) {
3083 			if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
3084 			    phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
3085 				return 1;
3086 			else
3087 				return 0;
3088 		}
3089 
3090 	} else {
3091 		ret = phy_get_u32_property(dev, "tx-internal-delay-ps", &delay);
3092 		if (ret < 0 && size == 0) {
3093 			if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
3094 			    phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
3095 				return 1;
3096 			else
3097 				return 0;
3098 		}
3099 	}
3100 
3101 	if (ret < 0)
3102 		return ret;
3103 
3104 	if (size == 0)
3105 		return delay;
3106 
3107 	if (delay < delay_values[0] || delay > delay_values[size - 1]) {
3108 		phydev_err(phydev, "Delay %d is out of range\n", delay);
3109 		return -EINVAL;
3110 	}
3111 
3112 	if (delay == delay_values[0])
3113 		return 0;
3114 
3115 	for (i = 1; i < size; i++) {
3116 		if (delay == delay_values[i])
3117 			return i;
3118 
3119 		/* Find an approximate index by looking up the table */
3120 		if (delay > delay_values[i - 1] &&
3121 		    delay < delay_values[i]) {
3122 			if (delay - delay_values[i - 1] <
3123 			    delay_values[i] - delay)
3124 				return i - 1;
3125 			else
3126 				return i;
3127 		}
3128 	}
3129 
3130 	phydev_err(phydev, "error finding internal delay index for %d\n",
3131 		   delay);
3132 
3133 	return -EINVAL;
3134 }
3135 EXPORT_SYMBOL(phy_get_internal_delay);
3136 
3137 /**
3138  * phy_get_tx_amplitude_gain - stores tx amplitude gain in @val
3139  * @phydev: phy_device struct
3140  * @dev: pointer to the devices device struct
3141  * @linkmode: linkmode for which the tx amplitude gain should be retrieved
3142  * @val: tx amplitude gain
3143  *
3144  * Returns: 0 on success, < 0 on failure
3145  */
3146 int phy_get_tx_amplitude_gain(struct phy_device *phydev, struct device *dev,
3147 			      enum ethtool_link_mode_bit_indices linkmode,
3148 			      u32 *val)
3149 {
3150 	switch (linkmode) {
3151 	case ETHTOOL_LINK_MODE_100baseT_Full_BIT:
3152 		return phy_get_u32_property(dev,
3153 					    "tx-amplitude-100base-tx-percent",
3154 					    val);
3155 	default:
3156 		return -EINVAL;
3157 	}
3158 }
3159 EXPORT_SYMBOL_GPL(phy_get_tx_amplitude_gain);
3160 
3161 /**
3162  * phy_get_mac_termination - stores MAC termination in @val
3163  * @phydev: phy_device struct
3164  * @dev: pointer to the devices device struct
3165  * @val: MAC termination
3166  *
3167  * Returns: 0 on success, < 0 on failure
3168  */
3169 int phy_get_mac_termination(struct phy_device *phydev, struct device *dev,
3170 			    u32 *val)
3171 {
3172 	return phy_get_u32_property(dev, "mac-termination-ohms", val);
3173 }
3174 EXPORT_SYMBOL_GPL(phy_get_mac_termination);
3175 
3176 static int phy_led_set_brightness(struct led_classdev *led_cdev,
3177 				  enum led_brightness value)
3178 {
3179 	struct phy_led *phyled = to_phy_led(led_cdev);
3180 	struct phy_device *phydev = phyled->phydev;
3181 	int err;
3182 
3183 	mutex_lock(&phydev->lock);
3184 	err = phydev->drv->led_brightness_set(phydev, phyled->index, value);
3185 	mutex_unlock(&phydev->lock);
3186 
3187 	return err;
3188 }
3189 
3190 static int phy_led_blink_set(struct led_classdev *led_cdev,
3191 			     unsigned long *delay_on,
3192 			     unsigned long *delay_off)
3193 {
3194 	struct phy_led *phyled = to_phy_led(led_cdev);
3195 	struct phy_device *phydev = phyled->phydev;
3196 	int err;
3197 
3198 	mutex_lock(&phydev->lock);
3199 	err = phydev->drv->led_blink_set(phydev, phyled->index,
3200 					 delay_on, delay_off);
3201 	mutex_unlock(&phydev->lock);
3202 
3203 	return err;
3204 }
3205 
3206 static __maybe_unused struct device *
3207 phy_led_hw_control_get_device(struct led_classdev *led_cdev)
3208 {
3209 	struct phy_led *phyled = to_phy_led(led_cdev);
3210 	struct phy_device *phydev = phyled->phydev;
3211 
3212 	if (phydev->attached_dev)
3213 		return &phydev->attached_dev->dev;
3214 	return NULL;
3215 }
3216 
3217 static int __maybe_unused
3218 phy_led_hw_control_get(struct led_classdev *led_cdev,
3219 		       unsigned long *rules)
3220 {
3221 	struct phy_led *phyled = to_phy_led(led_cdev);
3222 	struct phy_device *phydev = phyled->phydev;
3223 	int err;
3224 
3225 	mutex_lock(&phydev->lock);
3226 	err = phydev->drv->led_hw_control_get(phydev, phyled->index, rules);
3227 	mutex_unlock(&phydev->lock);
3228 
3229 	return err;
3230 }
3231 
3232 static int __maybe_unused
3233 phy_led_hw_control_set(struct led_classdev *led_cdev,
3234 		       unsigned long rules)
3235 {
3236 	struct phy_led *phyled = to_phy_led(led_cdev);
3237 	struct phy_device *phydev = phyled->phydev;
3238 	int err;
3239 
3240 	mutex_lock(&phydev->lock);
3241 	err = phydev->drv->led_hw_control_set(phydev, phyled->index, rules);
3242 	mutex_unlock(&phydev->lock);
3243 
3244 	return err;
3245 }
3246 
3247 static __maybe_unused int phy_led_hw_is_supported(struct led_classdev *led_cdev,
3248 						  unsigned long rules)
3249 {
3250 	struct phy_led *phyled = to_phy_led(led_cdev);
3251 	struct phy_device *phydev = phyled->phydev;
3252 	int err;
3253 
3254 	mutex_lock(&phydev->lock);
3255 	err = phydev->drv->led_hw_is_supported(phydev, phyled->index, rules);
3256 	mutex_unlock(&phydev->lock);
3257 
3258 	return err;
3259 }
3260 
3261 static void phy_leds_unregister(struct phy_device *phydev)
3262 {
3263 	struct phy_led *phyled, *tmp;
3264 
3265 	list_for_each_entry_safe(phyled, tmp, &phydev->leds, list) {
3266 		led_classdev_unregister(&phyled->led_cdev);
3267 		list_del(&phyled->list);
3268 	}
3269 }
3270 
3271 static int of_phy_led(struct phy_device *phydev,
3272 		      struct device_node *led)
3273 {
3274 	struct device *dev = &phydev->mdio.dev;
3275 	struct led_init_data init_data = {};
3276 	struct led_classdev *cdev;
3277 	unsigned long modes = 0;
3278 	struct phy_led *phyled;
3279 	u32 index;
3280 	int err;
3281 
3282 	phyled = devm_kzalloc(dev, sizeof(*phyled), GFP_KERNEL);
3283 	if (!phyled)
3284 		return -ENOMEM;
3285 
3286 	cdev = &phyled->led_cdev;
3287 	phyled->phydev = phydev;
3288 
3289 	err = of_property_read_u32(led, "reg", &index);
3290 	if (err)
3291 		return err;
3292 	if (index > U8_MAX)
3293 		return -EINVAL;
3294 
3295 	if (of_property_read_bool(led, "active-high"))
3296 		set_bit(PHY_LED_ACTIVE_HIGH, &modes);
3297 	if (of_property_read_bool(led, "active-low"))
3298 		set_bit(PHY_LED_ACTIVE_LOW, &modes);
3299 	if (of_property_read_bool(led, "inactive-high-impedance"))
3300 		set_bit(PHY_LED_INACTIVE_HIGH_IMPEDANCE, &modes);
3301 
3302 	if (WARN_ON(modes & BIT(PHY_LED_ACTIVE_LOW) &&
3303 		    modes & BIT(PHY_LED_ACTIVE_HIGH)))
3304 		return -EINVAL;
3305 
3306 	if (modes) {
3307 		/* Return error if asked to set polarity modes but not supported */
3308 		if (!phydev->drv->led_polarity_set)
3309 			return -EINVAL;
3310 
3311 		err = phydev->drv->led_polarity_set(phydev, index, modes);
3312 		if (err)
3313 			return err;
3314 	}
3315 
3316 	phyled->index = index;
3317 	if (phydev->drv->led_brightness_set)
3318 		cdev->brightness_set_blocking = phy_led_set_brightness;
3319 	if (phydev->drv->led_blink_set)
3320 		cdev->blink_set = phy_led_blink_set;
3321 
3322 #ifdef CONFIG_LEDS_TRIGGERS
3323 	if (phydev->drv->led_hw_is_supported &&
3324 	    phydev->drv->led_hw_control_set &&
3325 	    phydev->drv->led_hw_control_get) {
3326 		cdev->hw_control_is_supported = phy_led_hw_is_supported;
3327 		cdev->hw_control_set = phy_led_hw_control_set;
3328 		cdev->hw_control_get = phy_led_hw_control_get;
3329 		cdev->hw_control_trigger = "netdev";
3330 	}
3331 
3332 	cdev->hw_control_get_device = phy_led_hw_control_get_device;
3333 #endif
3334 	cdev->max_brightness = 1;
3335 	init_data.devicename = dev_name(&phydev->mdio.dev);
3336 	init_data.fwnode = of_fwnode_handle(led);
3337 	init_data.devname_mandatory = true;
3338 
3339 	err = led_classdev_register_ext(dev, cdev, &init_data);
3340 	if (err)
3341 		return err;
3342 
3343 	list_add(&phyled->list, &phydev->leds);
3344 
3345 	return 0;
3346 }
3347 
3348 static int of_phy_leds(struct phy_device *phydev)
3349 {
3350 	struct device_node *node = phydev->mdio.dev.of_node;
3351 	struct device_node *leds;
3352 	int err;
3353 
3354 	if (!IS_ENABLED(CONFIG_OF_MDIO))
3355 		return 0;
3356 
3357 	if (!node)
3358 		return 0;
3359 
3360 	leds = of_get_child_by_name(node, "leds");
3361 	if (!leds)
3362 		return 0;
3363 
3364 	/* Check if the PHY driver have at least an OP to
3365 	 * set the LEDs.
3366 	 */
3367 	if (!(phydev->drv->led_brightness_set ||
3368 	      phydev->drv->led_blink_set ||
3369 	      phydev->drv->led_hw_control_set)) {
3370 		phydev_dbg(phydev, "ignoring leds node defined with no PHY driver support\n");
3371 		goto exit;
3372 	}
3373 
3374 	for_each_available_child_of_node_scoped(leds, led) {
3375 		err = of_phy_led(phydev, led);
3376 		if (err) {
3377 			of_node_put(leds);
3378 			phy_leds_unregister(phydev);
3379 			return err;
3380 		}
3381 	}
3382 
3383 exit:
3384 	of_node_put(leds);
3385 	return 0;
3386 }
3387 
3388 static void phy_cleanup_ports(struct phy_device *phydev)
3389 {
3390 	struct phy_port *tmp, *port;
3391 
3392 	list_for_each_entry_safe(port, tmp, &phydev->ports, head) {
3393 		phy_del_port(phydev, port);
3394 		phy_port_destroy(port);
3395 	}
3396 }
3397 
3398 static int phy_default_setup_single_port(struct phy_device *phydev)
3399 {
3400 	struct phy_port *port = phy_port_alloc();
3401 	unsigned long mode;
3402 
3403 	if (!port)
3404 		return -ENOMEM;
3405 
3406 	port->parent_type = PHY_PORT_PHY;
3407 	port->phy = phydev;
3408 
3409 	/* Let the PHY driver know that this port was never described anywhere.
3410 	 * This is the usual case, where we assume single-port PHY devices with
3411 	 * no SFP. In that case, the port supports exactly the same thing as
3412 	 * the PHY itself.
3413 	 *
3414 	 * However, this can also be because we have a combo-port PHY, with
3415 	 * only one port described in DT, through SFP for example.
3416 	 *
3417 	 * In that case, the PHY driver will be in charge of saying what we can
3418 	 * do on that non-represented port.
3419 	 */
3420 	port->not_described = true;
3421 	linkmode_copy(port->supported, phydev->supported);
3422 	port->mediums = phy_caps_mediums_from_linkmodes(port->supported);
3423 
3424 	for_each_set_bit(mode, port->supported, __ETHTOOL_LINK_MODE_MASK_NBITS)
3425 		port->pairs = max_t(int, port->pairs,
3426 				    ethtool_linkmode_n_pairs(mode));
3427 
3428 	phy_add_port(phydev, port);
3429 
3430 	return 0;
3431 }
3432 
3433 static int of_phy_ports(struct phy_device *phydev)
3434 {
3435 	struct device_node *node = phydev->mdio.dev.of_node;
3436 	struct device_node *mdi;
3437 	struct phy_port *port;
3438 	int err;
3439 
3440 	if (!IS_ENABLED(CONFIG_OF_MDIO))
3441 		return 0;
3442 
3443 	if (!node)
3444 		return 0;
3445 
3446 	mdi = of_get_child_by_name(node, "mdi");
3447 	if (!mdi)
3448 		return 0;
3449 
3450 	for_each_available_child_of_node_scoped(mdi, port_node) {
3451 		port = phy_of_parse_port(port_node);
3452 		if (IS_ERR(port)) {
3453 			err = PTR_ERR(port);
3454 			goto out_err;
3455 		}
3456 
3457 		port->parent_type = PHY_PORT_PHY;
3458 		port->phy = phydev;
3459 
3460 		linkmode_copy(port->supported, phydev->supported);
3461 
3462 		err = phy_add_port(phydev, port);
3463 		if (err) {
3464 			phy_port_destroy(port);
3465 			goto out_err;
3466 		}
3467 	}
3468 	of_node_put(mdi);
3469 
3470 	return 0;
3471 
3472 out_err:
3473 	phy_cleanup_ports(phydev);
3474 	of_node_put(mdi);
3475 	return err;
3476 }
3477 
3478 static int phy_setup_ports(struct phy_device *phydev)
3479 {
3480 	__ETHTOOL_DECLARE_LINK_MODE_MASK(ports_supported);
3481 	struct phy_port *port;
3482 	int ret;
3483 
3484 	ret = of_phy_ports(phydev);
3485 	if (ret)
3486 		return ret;
3487 
3488 	ret = phy_sfp_probe(phydev);
3489 	if (ret)
3490 		goto out;
3491 
3492 	if (phydev->n_ports < phydev->max_n_ports) {
3493 		ret = phy_default_setup_single_port(phydev);
3494 		if (ret)
3495 			goto out;
3496 	}
3497 
3498 	linkmode_zero(ports_supported);
3499 
3500 	/* Aggregate the supported modes, which are made-up of :
3501 	 *  - What the PHY itself supports
3502 	 *  - What the sum of all ports support
3503 	 */
3504 	list_for_each_entry(port, &phydev->ports, head)
3505 		if (port->active)
3506 			linkmode_or(ports_supported, ports_supported,
3507 				    port->supported);
3508 
3509 	if (!linkmode_empty(ports_supported))
3510 		linkmode_and(phydev->supported, phydev->supported,
3511 			     ports_supported);
3512 
3513 	/* For now, the phy->port field is set as the first active port's type */
3514 	list_for_each_entry(port, &phydev->ports, head)
3515 		if (port->active) {
3516 			phydev->port = phy_port_get_type(port);
3517 			break;
3518 		}
3519 
3520 	return 0;
3521 
3522 out:
3523 	phy_cleanup_ports(phydev);
3524 	return ret;
3525 }
3526 
3527 /**
3528  * phy_get_sfp_port() - Returns the first valid SFP port of a PHY
3529  * @phydev: pointer to the PHY device to get the SFP port from
3530  *
3531  * Returns: The first active SFP (serdes) port of a PHY device, NULL if none
3532  * exist.
3533  */
3534 struct phy_port *phy_get_sfp_port(struct phy_device *phydev)
3535 {
3536 	struct phy_port *port;
3537 
3538 	list_for_each_entry(port, &phydev->ports, head)
3539 		if (port->active && port->is_sfp)
3540 			return port;
3541 
3542 	return NULL;
3543 }
3544 EXPORT_SYMBOL_GPL(phy_get_sfp_port);
3545 
3546 /**
3547  * fwnode_mdio_find_device - Given a fwnode, find the mdio_device
3548  * @fwnode: pointer to the mdio_device's fwnode
3549  *
3550  * If successful, returns a pointer to the mdio_device with the embedded
3551  * struct device refcount incremented by one, or NULL on failure.
3552  * The caller should call put_device() on the mdio_device after its use.
3553  */
3554 struct mdio_device *fwnode_mdio_find_device(struct fwnode_handle *fwnode)
3555 {
3556 	struct device *d;
3557 
3558 	if (!fwnode)
3559 		return NULL;
3560 
3561 	d = bus_find_device_by_fwnode(&mdio_bus_type, fwnode);
3562 	if (!d)
3563 		return NULL;
3564 
3565 	return to_mdio_device(d);
3566 }
3567 EXPORT_SYMBOL(fwnode_mdio_find_device);
3568 
3569 /**
3570  * fwnode_phy_find_device - For provided phy_fwnode, find phy_device.
3571  *
3572  * @phy_fwnode: Pointer to the phy's fwnode.
3573  *
3574  * If successful, returns a pointer to the phy_device with the embedded
3575  * struct device refcount incremented by one, or NULL on failure.
3576  */
3577 struct phy_device *fwnode_phy_find_device(struct fwnode_handle *phy_fwnode)
3578 {
3579 	struct mdio_device *mdiodev;
3580 
3581 	mdiodev = fwnode_mdio_find_device(phy_fwnode);
3582 	if (!mdiodev)
3583 		return NULL;
3584 
3585 	if (mdiodev->flags & MDIO_DEVICE_FLAG_PHY)
3586 		return to_phy_device(&mdiodev->dev);
3587 
3588 	put_device(&mdiodev->dev);
3589 
3590 	return NULL;
3591 }
3592 EXPORT_SYMBOL(fwnode_phy_find_device);
3593 
3594 /**
3595  * fwnode_get_phy_node - Get the phy_node using the named reference.
3596  * @fwnode: Pointer to fwnode from which phy_node has to be obtained.
3597  *
3598  * Refer return conditions of fwnode_find_reference().
3599  * For ACPI, only "phy-handle" is supported. Legacy DT properties "phy"
3600  * and "phy-device" are not supported in ACPI. DT supports all the three
3601  * named references to the phy node.
3602  */
3603 struct fwnode_handle *fwnode_get_phy_node(const struct fwnode_handle *fwnode)
3604 {
3605 	struct fwnode_handle *phy_node;
3606 
3607 	/* Only phy-handle is used for ACPI */
3608 	phy_node = fwnode_find_reference(fwnode, "phy-handle", 0);
3609 	if (!IS_ERR(phy_node) || is_acpi_node(fwnode))
3610 		return phy_node;
3611 	phy_node = fwnode_find_reference(fwnode, "phy", 0);
3612 	if (!IS_ERR(phy_node))
3613 		return phy_node;
3614 	return fwnode_find_reference(fwnode, "phy-device", 0);
3615 }
3616 EXPORT_SYMBOL_GPL(fwnode_get_phy_node);
3617 
3618 /**
3619  * phy_probe - probe and init a PHY device
3620  * @dev: device to probe and init
3621  *
3622  * Take care of setting up the phy_device structure, set the state to READY.
3623  */
3624 static int phy_probe(struct device *dev)
3625 {
3626 	struct phy_device *phydev = to_phy_device(dev);
3627 	struct device_driver *drv = phydev->mdio.dev.driver;
3628 	struct phy_driver *phydrv = to_phy_driver(drv);
3629 	int err = 0;
3630 
3631 	phydev->drv = phydrv;
3632 
3633 	/* Disable the interrupt if the PHY doesn't support it
3634 	 * but the interrupt is still a valid one
3635 	 */
3636 	if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
3637 		phydev->irq = PHY_POLL;
3638 
3639 	if (phydrv->flags & PHY_IS_INTERNAL)
3640 		phydev->is_internal = true;
3641 
3642 	/* Deassert the reset signal */
3643 	phy_device_reset(phydev, 0);
3644 
3645 	if (phydev->drv->probe) {
3646 		err = phydev->drv->probe(phydev);
3647 		if (err)
3648 			goto out;
3649 	}
3650 
3651 	phy_disable_interrupts(phydev);
3652 
3653 	/* Start out supporting everything. Eventually,
3654 	 * a controller will attach, and may modify one
3655 	 * or both of these values
3656 	 */
3657 	if (phydrv->features) {
3658 		linkmode_copy(phydev->supported, phydrv->features);
3659 		genphy_c45_read_eee_abilities(phydev);
3660 	}
3661 	else if (phydrv->get_features)
3662 		err = phydrv->get_features(phydev);
3663 	else if (phydev->is_c45)
3664 		err = genphy_c45_pma_read_abilities(phydev);
3665 	else
3666 		err = genphy_read_abilities(phydev);
3667 
3668 	if (err)
3669 		goto out;
3670 
3671 	if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
3672 			       phydev->supported))
3673 		phydev->autoneg = 0;
3674 
3675 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
3676 			      phydev->supported))
3677 		phydev->is_gigabit_capable = 1;
3678 	if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
3679 			      phydev->supported))
3680 		phydev->is_gigabit_capable = 1;
3681 
3682 	of_set_phy_supported(phydev);
3683 
3684 	err = phy_setup_ports(phydev);
3685 	if (err)
3686 		goto out;
3687 
3688 	phy_advertise_supported(phydev);
3689 
3690 	/* Get PHY default EEE advertising modes and handle them as potentially
3691 	 * safe initial configuration.
3692 	 */
3693 	err = genphy_c45_read_eee_adv(phydev, phydev->advertising_eee);
3694 	if (err)
3695 		goto out;
3696 
3697 	/* Get the EEE modes we want to prohibit. */
3698 	of_set_phy_eee_broken(phydev);
3699 
3700 	/* Some PHYs may advertise, by default, not support EEE modes. So,
3701 	 * we need to clean them. In addition remove all disabled EEE modes.
3702 	 */
3703 	linkmode_and(phydev->advertising_eee, phydev->supported_eee,
3704 		     phydev->advertising_eee);
3705 	linkmode_andnot(phydev->advertising_eee, phydev->advertising_eee,
3706 			phydev->eee_disabled_modes);
3707 
3708 	/* There is no "enabled" flag. If PHY is advertising, assume it is
3709 	 * kind of enabled.
3710 	 */
3711 	phydev->eee_cfg.eee_enabled = !linkmode_empty(phydev->advertising_eee);
3712 
3713 	/* Get master/slave strap overrides */
3714 	of_set_phy_timing_role(phydev);
3715 
3716 	/* The Pause Frame bits indicate that the PHY can support passing
3717 	 * pause frames. During autonegotiation, the PHYs will determine if
3718 	 * they should allow pause frames to pass.  The MAC driver should then
3719 	 * use that result to determine whether to enable flow control via
3720 	 * pause frames.
3721 	 *
3722 	 * Normally, PHY drivers should not set the Pause bits, and instead
3723 	 * allow phylib to do that.  However, there may be some situations
3724 	 * (e.g. hardware erratum) where the driver wants to set only one
3725 	 * of these bits.
3726 	 */
3727 	if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
3728 	    !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
3729 		linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
3730 				 phydev->supported);
3731 		linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
3732 				 phydev->supported);
3733 	}
3734 
3735 	/* Set the state to READY by default */
3736 	phydev->state = PHY_READY;
3737 
3738 	/* Register the PHY LED triggers */
3739 	if (!phydev->is_on_sfp_module)
3740 		phy_led_triggers_register(phydev);
3741 
3742 	/* Get the LEDs from the device tree, and instantiate standard
3743 	 * LEDs for them.
3744 	 */
3745 	if (IS_ENABLED(CONFIG_PHYLIB_LEDS) && !phy_driver_is_genphy(phydev)) {
3746 		err = of_phy_leds(phydev);
3747 		if (err)
3748 			goto out;
3749 	}
3750 
3751 	return 0;
3752 
3753 out:
3754 	if (!phydev->is_on_sfp_module)
3755 		phy_led_triggers_unregister(phydev);
3756 
3757 	/* Re-assert the reset signal on error */
3758 	phy_device_reset(phydev, 1);
3759 
3760 	return err;
3761 }
3762 
3763 static int phy_remove(struct device *dev)
3764 {
3765 	struct phy_device *phydev = to_phy_device(dev);
3766 
3767 	cancel_delayed_work_sync(&phydev->state_queue);
3768 
3769 	if (IS_ENABLED(CONFIG_PHYLIB_LEDS) && !phy_driver_is_genphy(phydev))
3770 		phy_leds_unregister(phydev);
3771 
3772 	if (!phydev->is_on_sfp_module)
3773 		phy_led_triggers_unregister(phydev);
3774 
3775 	phydev->state = PHY_DOWN;
3776 
3777 	phy_cleanup_ports(phydev);
3778 
3779 	sfp_bus_del_upstream(phydev->sfp_bus);
3780 	phydev->sfp_bus = NULL;
3781 
3782 	if (phydev->drv && phydev->drv->remove)
3783 		phydev->drv->remove(phydev);
3784 
3785 	/* Assert the reset signal */
3786 	phy_device_reset(phydev, 1);
3787 
3788 	phydev->drv = NULL;
3789 
3790 	return 0;
3791 }
3792 
3793 /**
3794  * phy_driver_register - register a phy_driver with the PHY layer
3795  * @new_driver: new phy_driver to register
3796  * @owner: module owning this PHY
3797  */
3798 static int phy_driver_register(struct phy_driver *new_driver,
3799 			       struct module *owner)
3800 {
3801 	int retval;
3802 
3803 	/* Either the features are hard coded, or dynamically
3804 	 * determined. It cannot be both.
3805 	 */
3806 	if (WARN_ON(new_driver->features && new_driver->get_features)) {
3807 		pr_err("%s: features and get_features must not both be set\n",
3808 		       new_driver->name);
3809 		return -EINVAL;
3810 	}
3811 
3812 	/* PHYLIB device drivers must not match using a DT compatible table
3813 	 * as this bypasses our checks that the mdiodev that is being matched
3814 	 * is backed by a struct phy_device. If such a case happens, we will
3815 	 * make out-of-bounds accesses and lockup in phydev->lock.
3816 	 */
3817 	if (WARN(new_driver->mdiodrv.driver.of_match_table,
3818 		 "%s: driver must not provide a DT match table\n",
3819 		 new_driver->name))
3820 		return -EINVAL;
3821 
3822 	new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3823 	new_driver->mdiodrv.driver.name = new_driver->name;
3824 	new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3825 	new_driver->mdiodrv.driver.probe = phy_probe;
3826 	new_driver->mdiodrv.driver.remove = phy_remove;
3827 	new_driver->mdiodrv.driver.owner = owner;
3828 	new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3829 
3830 	retval = driver_register(&new_driver->mdiodrv.driver);
3831 	if (retval) {
3832 		pr_err("%s: Error %d in registering driver\n",
3833 		       new_driver->name, retval);
3834 
3835 		return retval;
3836 	}
3837 
3838 	pr_debug("%s: Registered new driver\n", new_driver->name);
3839 
3840 	return 0;
3841 }
3842 
3843 static void phy_driver_unregister(struct phy_driver *drv)
3844 {
3845 	driver_unregister(&drv->mdiodrv.driver);
3846 }
3847 
3848 int phy_drivers_register(struct phy_driver *new_driver, int n,
3849 			 struct module *owner)
3850 {
3851 	int i, ret = 0;
3852 
3853 	for (i = 0; i < n; i++) {
3854 		ret = phy_driver_register(new_driver + i, owner);
3855 		if (ret) {
3856 			while (i-- > 0)
3857 				phy_driver_unregister(new_driver + i);
3858 			break;
3859 		}
3860 	}
3861 	return ret;
3862 }
3863 EXPORT_SYMBOL(phy_drivers_register);
3864 
3865 void phy_drivers_unregister(struct phy_driver *drv, int n)
3866 {
3867 	int i;
3868 
3869 	for (i = 0; i < n; i++)
3870 		phy_driver_unregister(drv + i);
3871 }
3872 EXPORT_SYMBOL(phy_drivers_unregister);
3873 
3874 static struct phy_driver genphy_driver = {
3875 	.phy_id		= 0xffffffff,
3876 	.phy_id_mask	= 0xffffffff,
3877 	.name		= "Generic PHY",
3878 	.get_features	= genphy_read_abilities,
3879 	.suspend	= genphy_suspend,
3880 	.resume		= genphy_resume,
3881 	.set_loopback   = genphy_loopback,
3882 };
3883 
3884 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3885 	.get_sset_count		= phy_ethtool_get_sset_count,
3886 	.get_strings		= phy_ethtool_get_strings,
3887 	.get_stats		= phy_ethtool_get_stats,
3888 	.get_plca_cfg		= phy_ethtool_get_plca_cfg,
3889 	.set_plca_cfg		= phy_ethtool_set_plca_cfg,
3890 	.get_plca_status	= phy_ethtool_get_plca_status,
3891 	.start_cable_test	= phy_start_cable_test,
3892 	.start_cable_test_tdr	= phy_start_cable_test_tdr,
3893 };
3894 
3895 static const struct phylib_stubs __phylib_stubs = {
3896 	.hwtstamp_get = __phy_hwtstamp_get,
3897 	.hwtstamp_set = __phy_hwtstamp_set,
3898 	.get_phy_stats = __phy_ethtool_get_phy_stats,
3899 	.get_link_ext_stats = __phy_ethtool_get_link_ext_stats,
3900 };
3901 
3902 static void phylib_register_stubs(void)
3903 {
3904 	phylib_stubs = &__phylib_stubs;
3905 }
3906 
3907 static void phylib_unregister_stubs(void)
3908 {
3909 	phylib_stubs = NULL;
3910 }
3911 
3912 static int __init phy_init(void)
3913 {
3914 	int rc;
3915 
3916 	rc = class_register(&mdio_bus_class);
3917 	if (rc)
3918 		return rc;
3919 
3920 	rc = bus_register(&mdio_bus_type);
3921 	if (rc)
3922 		goto err_class;
3923 
3924 	rtnl_lock();
3925 	ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3926 	phylib_register_stubs();
3927 	rtnl_unlock();
3928 
3929 	rc = phy_caps_init();
3930 	if (rc)
3931 		goto err_ethtool_phy_ops;
3932 
3933 	features_init();
3934 
3935 	rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3936 	if (rc)
3937 		goto err_ethtool_phy_ops;
3938 
3939 	rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3940 	if (rc)
3941 		goto err_c45;
3942 
3943 	return 0;
3944 
3945 err_c45:
3946 	phy_driver_unregister(&genphy_c45_driver);
3947 err_ethtool_phy_ops:
3948 	rtnl_lock();
3949 	phylib_unregister_stubs();
3950 	ethtool_set_ethtool_phy_ops(NULL);
3951 	rtnl_unlock();
3952 	bus_unregister(&mdio_bus_type);
3953 err_class:
3954 	class_unregister(&mdio_bus_class);
3955 
3956 	return rc;
3957 }
3958 
3959 static void __exit phy_exit(void)
3960 {
3961 	phy_driver_unregister(&genphy_c45_driver);
3962 	phy_driver_unregister(&genphy_driver);
3963 	rtnl_lock();
3964 	phylib_unregister_stubs();
3965 	ethtool_set_ethtool_phy_ops(NULL);
3966 	rtnl_unlock();
3967 	bus_unregister(&mdio_bus_type);
3968 	class_unregister(&mdio_bus_class);
3969 }
3970 
3971 subsys_initcall(phy_init);
3972 module_exit(phy_exit);
3973