Merge tag 'pci-v5.13-fixes-1' of git://git.kernel.org/pub/scm/linux/kernel/git/helgaa...
[linux-2.6-microblaze.git] / drivers / net / phy / phy_device.c
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/bitmap.h>
13 #include <linux/delay.h>
14 #include <linux/errno.h>
15 #include <linux/etherdevice.h>
16 #include <linux/ethtool.h>
17 #include <linux/init.h>
18 #include <linux/interrupt.h>
19 #include <linux/io.h>
20 #include <linux/kernel.h>
21 #include <linux/mdio.h>
22 #include <linux/mii.h>
23 #include <linux/mm.h>
24 #include <linux/module.h>
25 #include <linux/netdevice.h>
26 #include <linux/phy.h>
27 #include <linux/phy_led_triggers.h>
28 #include <linux/property.h>
29 #include <linux/sfp.h>
30 #include <linux/skbuff.h>
31 #include <linux/slab.h>
32 #include <linux/string.h>
33 #include <linux/uaccess.h>
34 #include <linux/unistd.h>
35
36 MODULE_DESCRIPTION("PHY library");
37 MODULE_AUTHOR("Andy Fleming");
38 MODULE_LICENSE("GPL");
39
40 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
41 EXPORT_SYMBOL_GPL(phy_basic_features);
42
43 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
44 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
45
46 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
47 EXPORT_SYMBOL_GPL(phy_gbit_features);
48
49 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
50 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
51
52 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
53 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
54
55 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
56 EXPORT_SYMBOL_GPL(phy_10gbit_features);
57
58 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_fec_features) __ro_after_init;
59 EXPORT_SYMBOL_GPL(phy_10gbit_fec_features);
60
61 const int phy_basic_ports_array[3] = {
62         ETHTOOL_LINK_MODE_Autoneg_BIT,
63         ETHTOOL_LINK_MODE_TP_BIT,
64         ETHTOOL_LINK_MODE_MII_BIT,
65 };
66 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
67
68 const int phy_fibre_port_array[1] = {
69         ETHTOOL_LINK_MODE_FIBRE_BIT,
70 };
71 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
72
73 const int phy_all_ports_features_array[7] = {
74         ETHTOOL_LINK_MODE_Autoneg_BIT,
75         ETHTOOL_LINK_MODE_TP_BIT,
76         ETHTOOL_LINK_MODE_MII_BIT,
77         ETHTOOL_LINK_MODE_FIBRE_BIT,
78         ETHTOOL_LINK_MODE_AUI_BIT,
79         ETHTOOL_LINK_MODE_BNC_BIT,
80         ETHTOOL_LINK_MODE_Backplane_BIT,
81 };
82 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
83
84 const int phy_10_100_features_array[4] = {
85         ETHTOOL_LINK_MODE_10baseT_Half_BIT,
86         ETHTOOL_LINK_MODE_10baseT_Full_BIT,
87         ETHTOOL_LINK_MODE_100baseT_Half_BIT,
88         ETHTOOL_LINK_MODE_100baseT_Full_BIT,
89 };
90 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
91
92 const int phy_basic_t1_features_array[2] = {
93         ETHTOOL_LINK_MODE_TP_BIT,
94         ETHTOOL_LINK_MODE_100baseT1_Full_BIT,
95 };
96 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
97
98 const int phy_gbit_features_array[2] = {
99         ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
100         ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
101 };
102 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
103
104 const int phy_10gbit_features_array[1] = {
105         ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
106 };
107 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
108
109 static const int phy_10gbit_fec_features_array[1] = {
110         ETHTOOL_LINK_MODE_10000baseR_FEC_BIT,
111 };
112
113 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
114 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
115
116 static const int phy_10gbit_full_features_array[] = {
117         ETHTOOL_LINK_MODE_10baseT_Full_BIT,
118         ETHTOOL_LINK_MODE_100baseT_Full_BIT,
119         ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
120         ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
121 };
122
123 static void features_init(void)
124 {
125         /* 10/100 half/full*/
126         linkmode_set_bit_array(phy_basic_ports_array,
127                                ARRAY_SIZE(phy_basic_ports_array),
128                                phy_basic_features);
129         linkmode_set_bit_array(phy_10_100_features_array,
130                                ARRAY_SIZE(phy_10_100_features_array),
131                                phy_basic_features);
132
133         /* 100 full, TP */
134         linkmode_set_bit_array(phy_basic_t1_features_array,
135                                ARRAY_SIZE(phy_basic_t1_features_array),
136                                phy_basic_t1_features);
137
138         /* 10/100 half/full + 1000 half/full */
139         linkmode_set_bit_array(phy_basic_ports_array,
140                                ARRAY_SIZE(phy_basic_ports_array),
141                                phy_gbit_features);
142         linkmode_set_bit_array(phy_10_100_features_array,
143                                ARRAY_SIZE(phy_10_100_features_array),
144                                phy_gbit_features);
145         linkmode_set_bit_array(phy_gbit_features_array,
146                                ARRAY_SIZE(phy_gbit_features_array),
147                                phy_gbit_features);
148
149         /* 10/100 half/full + 1000 half/full + fibre*/
150         linkmode_set_bit_array(phy_basic_ports_array,
151                                ARRAY_SIZE(phy_basic_ports_array),
152                                phy_gbit_fibre_features);
153         linkmode_set_bit_array(phy_10_100_features_array,
154                                ARRAY_SIZE(phy_10_100_features_array),
155                                phy_gbit_fibre_features);
156         linkmode_set_bit_array(phy_gbit_features_array,
157                                ARRAY_SIZE(phy_gbit_features_array),
158                                phy_gbit_fibre_features);
159         linkmode_set_bit_array(phy_fibre_port_array,
160                                ARRAY_SIZE(phy_fibre_port_array),
161                                phy_gbit_fibre_features);
162
163         /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
164         linkmode_set_bit_array(phy_all_ports_features_array,
165                                ARRAY_SIZE(phy_all_ports_features_array),
166                                phy_gbit_all_ports_features);
167         linkmode_set_bit_array(phy_10_100_features_array,
168                                ARRAY_SIZE(phy_10_100_features_array),
169                                phy_gbit_all_ports_features);
170         linkmode_set_bit_array(phy_gbit_features_array,
171                                ARRAY_SIZE(phy_gbit_features_array),
172                                phy_gbit_all_ports_features);
173
174         /* 10/100 half/full + 1000 half/full + 10G full*/
175         linkmode_set_bit_array(phy_all_ports_features_array,
176                                ARRAY_SIZE(phy_all_ports_features_array),
177                                phy_10gbit_features);
178         linkmode_set_bit_array(phy_10_100_features_array,
179                                ARRAY_SIZE(phy_10_100_features_array),
180                                phy_10gbit_features);
181         linkmode_set_bit_array(phy_gbit_features_array,
182                                ARRAY_SIZE(phy_gbit_features_array),
183                                phy_10gbit_features);
184         linkmode_set_bit_array(phy_10gbit_features_array,
185                                ARRAY_SIZE(phy_10gbit_features_array),
186                                phy_10gbit_features);
187
188         /* 10/100/1000/10G full */
189         linkmode_set_bit_array(phy_all_ports_features_array,
190                                ARRAY_SIZE(phy_all_ports_features_array),
191                                phy_10gbit_full_features);
192         linkmode_set_bit_array(phy_10gbit_full_features_array,
193                                ARRAY_SIZE(phy_10gbit_full_features_array),
194                                phy_10gbit_full_features);
195         /* 10G FEC only */
196         linkmode_set_bit_array(phy_10gbit_fec_features_array,
197                                ARRAY_SIZE(phy_10gbit_fec_features_array),
198                                phy_10gbit_fec_features);
199 }
200
201 void phy_device_free(struct phy_device *phydev)
202 {
203         put_device(&phydev->mdio.dev);
204 }
205 EXPORT_SYMBOL(phy_device_free);
206
207 static void phy_mdio_device_free(struct mdio_device *mdiodev)
208 {
209         struct phy_device *phydev;
210
211         phydev = container_of(mdiodev, struct phy_device, mdio);
212         phy_device_free(phydev);
213 }
214
215 static void phy_device_release(struct device *dev)
216 {
217         kfree(to_phy_device(dev));
218 }
219
220 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
221 {
222         struct phy_device *phydev;
223
224         phydev = container_of(mdiodev, struct phy_device, mdio);
225         phy_device_remove(phydev);
226 }
227
228 static struct phy_driver genphy_driver;
229
230 static LIST_HEAD(phy_fixup_list);
231 static DEFINE_MUTEX(phy_fixup_lock);
232
233 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
234 {
235         struct device_driver *drv = phydev->mdio.dev.driver;
236         struct phy_driver *phydrv = to_phy_driver(drv);
237         struct net_device *netdev = phydev->attached_dev;
238
239         if (!drv || !phydrv->suspend)
240                 return false;
241
242         /* PHY not attached? May suspend if the PHY has not already been
243          * suspended as part of a prior call to phy_disconnect() ->
244          * phy_detach() -> phy_suspend() because the parent netdev might be the
245          * MDIO bus driver and clock gated at this point.
246          */
247         if (!netdev)
248                 goto out;
249
250         if (netdev->wol_enabled)
251                 return false;
252
253         /* As long as not all affected network drivers support the
254          * wol_enabled flag, let's check for hints that WoL is enabled.
255          * Don't suspend PHY if the attached netdev parent may wake up.
256          * The parent may point to a PCI device, as in tg3 driver.
257          */
258         if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
259                 return false;
260
261         /* Also don't suspend PHY if the netdev itself may wakeup. This
262          * is the case for devices w/o underlaying pwr. mgmt. aware bus,
263          * e.g. SoC devices.
264          */
265         if (device_may_wakeup(&netdev->dev))
266                 return false;
267
268 out:
269         return !phydev->suspended;
270 }
271
272 static __maybe_unused int mdio_bus_phy_suspend(struct device *dev)
273 {
274         struct phy_device *phydev = to_phy_device(dev);
275
276         if (phydev->mac_managed_pm)
277                 return 0;
278
279         /* We must stop the state machine manually, otherwise it stops out of
280          * control, possibly with the phydev->lock held. Upon resume, netdev
281          * may call phy routines that try to grab the same lock, and that may
282          * lead to a deadlock.
283          */
284         if (phydev->attached_dev && phydev->adjust_link)
285                 phy_stop_machine(phydev);
286
287         if (!mdio_bus_phy_may_suspend(phydev))
288                 return 0;
289
290         phydev->suspended_by_mdio_bus = 1;
291
292         return phy_suspend(phydev);
293 }
294
295 static __maybe_unused int mdio_bus_phy_resume(struct device *dev)
296 {
297         struct phy_device *phydev = to_phy_device(dev);
298         int ret;
299
300         if (phydev->mac_managed_pm)
301                 return 0;
302
303         if (!phydev->suspended_by_mdio_bus)
304                 goto no_resume;
305
306         phydev->suspended_by_mdio_bus = 0;
307
308         ret = phy_init_hw(phydev);
309         if (ret < 0)
310                 return ret;
311
312         ret = phy_resume(phydev);
313         if (ret < 0)
314                 return ret;
315 no_resume:
316         if (phydev->attached_dev && phydev->adjust_link)
317                 phy_start_machine(phydev);
318
319         return 0;
320 }
321
322 static SIMPLE_DEV_PM_OPS(mdio_bus_phy_pm_ops, mdio_bus_phy_suspend,
323                          mdio_bus_phy_resume);
324
325 /**
326  * phy_register_fixup - creates a new phy_fixup and adds it to the list
327  * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
328  * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
329  *      It can also be PHY_ANY_UID
330  * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
331  *      comparison
332  * @run: The actual code to be run when a matching PHY is found
333  */
334 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
335                        int (*run)(struct phy_device *))
336 {
337         struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
338
339         if (!fixup)
340                 return -ENOMEM;
341
342         strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
343         fixup->phy_uid = phy_uid;
344         fixup->phy_uid_mask = phy_uid_mask;
345         fixup->run = run;
346
347         mutex_lock(&phy_fixup_lock);
348         list_add_tail(&fixup->list, &phy_fixup_list);
349         mutex_unlock(&phy_fixup_lock);
350
351         return 0;
352 }
353 EXPORT_SYMBOL(phy_register_fixup);
354
355 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
356 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
357                                int (*run)(struct phy_device *))
358 {
359         return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
360 }
361 EXPORT_SYMBOL(phy_register_fixup_for_uid);
362
363 /* Registers a fixup to be run on the PHY with id string bus_id */
364 int phy_register_fixup_for_id(const char *bus_id,
365                               int (*run)(struct phy_device *))
366 {
367         return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
368 }
369 EXPORT_SYMBOL(phy_register_fixup_for_id);
370
371 /**
372  * phy_unregister_fixup - remove a phy_fixup from the list
373  * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
374  * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
375  * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
376  */
377 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
378 {
379         struct list_head *pos, *n;
380         struct phy_fixup *fixup;
381         int ret;
382
383         ret = -ENODEV;
384
385         mutex_lock(&phy_fixup_lock);
386         list_for_each_safe(pos, n, &phy_fixup_list) {
387                 fixup = list_entry(pos, struct phy_fixup, list);
388
389                 if ((!strcmp(fixup->bus_id, bus_id)) &&
390                     ((fixup->phy_uid & phy_uid_mask) ==
391                      (phy_uid & phy_uid_mask))) {
392                         list_del(&fixup->list);
393                         kfree(fixup);
394                         ret = 0;
395                         break;
396                 }
397         }
398         mutex_unlock(&phy_fixup_lock);
399
400         return ret;
401 }
402 EXPORT_SYMBOL(phy_unregister_fixup);
403
404 /* Unregisters a fixup of any PHY with the UID in phy_uid */
405 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
406 {
407         return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
408 }
409 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
410
411 /* Unregisters a fixup of the PHY with id string bus_id */
412 int phy_unregister_fixup_for_id(const char *bus_id)
413 {
414         return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
415 }
416 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
417
418 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
419  * Fixups can be set to match any in one or more fields.
420  */
421 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
422 {
423         if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
424                 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
425                         return 0;
426
427         if ((fixup->phy_uid & fixup->phy_uid_mask) !=
428             (phydev->phy_id & fixup->phy_uid_mask))
429                 if (fixup->phy_uid != PHY_ANY_UID)
430                         return 0;
431
432         return 1;
433 }
434
435 /* Runs any matching fixups for this phydev */
436 static int phy_scan_fixups(struct phy_device *phydev)
437 {
438         struct phy_fixup *fixup;
439
440         mutex_lock(&phy_fixup_lock);
441         list_for_each_entry(fixup, &phy_fixup_list, list) {
442                 if (phy_needs_fixup(phydev, fixup)) {
443                         int err = fixup->run(phydev);
444
445                         if (err < 0) {
446                                 mutex_unlock(&phy_fixup_lock);
447                                 return err;
448                         }
449                         phydev->has_fixups = true;
450                 }
451         }
452         mutex_unlock(&phy_fixup_lock);
453
454         return 0;
455 }
456
457 static int phy_bus_match(struct device *dev, struct device_driver *drv)
458 {
459         struct phy_device *phydev = to_phy_device(dev);
460         struct phy_driver *phydrv = to_phy_driver(drv);
461         const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
462         int i;
463
464         if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
465                 return 0;
466
467         if (phydrv->match_phy_device)
468                 return phydrv->match_phy_device(phydev);
469
470         if (phydev->is_c45) {
471                 for (i = 1; i < num_ids; i++) {
472                         if (phydev->c45_ids.device_ids[i] == 0xffffffff)
473                                 continue;
474
475                         if ((phydrv->phy_id & phydrv->phy_id_mask) ==
476                             (phydev->c45_ids.device_ids[i] &
477                              phydrv->phy_id_mask))
478                                 return 1;
479                 }
480                 return 0;
481         } else {
482                 return (phydrv->phy_id & phydrv->phy_id_mask) ==
483                         (phydev->phy_id & phydrv->phy_id_mask);
484         }
485 }
486
487 static ssize_t
488 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
489 {
490         struct phy_device *phydev = to_phy_device(dev);
491
492         return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
493 }
494 static DEVICE_ATTR_RO(phy_id);
495
496 static ssize_t
497 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
498 {
499         struct phy_device *phydev = to_phy_device(dev);
500         const char *mode = NULL;
501
502         if (phy_is_internal(phydev))
503                 mode = "internal";
504         else
505                 mode = phy_modes(phydev->interface);
506
507         return sprintf(buf, "%s\n", mode);
508 }
509 static DEVICE_ATTR_RO(phy_interface);
510
511 static ssize_t
512 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
513                     char *buf)
514 {
515         struct phy_device *phydev = to_phy_device(dev);
516
517         return sprintf(buf, "%d\n", phydev->has_fixups);
518 }
519 static DEVICE_ATTR_RO(phy_has_fixups);
520
521 static ssize_t phy_dev_flags_show(struct device *dev,
522                                   struct device_attribute *attr,
523                                   char *buf)
524 {
525         struct phy_device *phydev = to_phy_device(dev);
526
527         return sprintf(buf, "0x%08x\n", phydev->dev_flags);
528 }
529 static DEVICE_ATTR_RO(phy_dev_flags);
530
531 static struct attribute *phy_dev_attrs[] = {
532         &dev_attr_phy_id.attr,
533         &dev_attr_phy_interface.attr,
534         &dev_attr_phy_has_fixups.attr,
535         &dev_attr_phy_dev_flags.attr,
536         NULL,
537 };
538 ATTRIBUTE_GROUPS(phy_dev);
539
540 static const struct device_type mdio_bus_phy_type = {
541         .name = "PHY",
542         .groups = phy_dev_groups,
543         .release = phy_device_release,
544         .pm = pm_ptr(&mdio_bus_phy_pm_ops),
545 };
546
547 static int phy_request_driver_module(struct phy_device *dev, u32 phy_id)
548 {
549         int ret;
550
551         ret = request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
552                              MDIO_ID_ARGS(phy_id));
553         /* We only check for failures in executing the usermode binary,
554          * not whether a PHY driver module exists for the PHY ID.
555          * Accept -ENOENT because this may occur in case no initramfs exists,
556          * then modprobe isn't available.
557          */
558         if (IS_ENABLED(CONFIG_MODULES) && ret < 0 && ret != -ENOENT) {
559                 phydev_err(dev, "error %d loading PHY driver module for ID 0x%08lx\n",
560                            ret, (unsigned long)phy_id);
561                 return ret;
562         }
563
564         return 0;
565 }
566
567 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, u32 phy_id,
568                                      bool is_c45,
569                                      struct phy_c45_device_ids *c45_ids)
570 {
571         struct phy_device *dev;
572         struct mdio_device *mdiodev;
573         int ret = 0;
574
575         /* We allocate the device, and initialize the default values */
576         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
577         if (!dev)
578                 return ERR_PTR(-ENOMEM);
579
580         mdiodev = &dev->mdio;
581         mdiodev->dev.parent = &bus->dev;
582         mdiodev->dev.bus = &mdio_bus_type;
583         mdiodev->dev.type = &mdio_bus_phy_type;
584         mdiodev->bus = bus;
585         mdiodev->bus_match = phy_bus_match;
586         mdiodev->addr = addr;
587         mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
588         mdiodev->device_free = phy_mdio_device_free;
589         mdiodev->device_remove = phy_mdio_device_remove;
590
591         dev->speed = SPEED_UNKNOWN;
592         dev->duplex = DUPLEX_UNKNOWN;
593         dev->pause = 0;
594         dev->asym_pause = 0;
595         dev->link = 0;
596         dev->port = PORT_TP;
597         dev->interface = PHY_INTERFACE_MODE_GMII;
598
599         dev->autoneg = AUTONEG_ENABLE;
600
601         dev->is_c45 = is_c45;
602         dev->phy_id = phy_id;
603         if (c45_ids)
604                 dev->c45_ids = *c45_ids;
605         dev->irq = bus->irq[addr];
606
607         dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
608         device_initialize(&mdiodev->dev);
609
610         dev->state = PHY_DOWN;
611
612         mutex_init(&dev->lock);
613         INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
614
615         /* Request the appropriate module unconditionally; don't
616          * bother trying to do so only if it isn't already loaded,
617          * because that gets complicated. A hotplug event would have
618          * done an unconditional modprobe anyway.
619          * We don't do normal hotplug because it won't work for MDIO
620          * -- because it relies on the device staying around for long
621          * enough for the driver to get loaded. With MDIO, the NIC
622          * driver will get bored and give up as soon as it finds that
623          * there's no driver _already_ loaded.
624          */
625         if (is_c45 && c45_ids) {
626                 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
627                 int i;
628
629                 for (i = 1; i < num_ids; i++) {
630                         if (c45_ids->device_ids[i] == 0xffffffff)
631                                 continue;
632
633                         ret = phy_request_driver_module(dev,
634                                                 c45_ids->device_ids[i]);
635                         if (ret)
636                                 break;
637                 }
638         } else {
639                 ret = phy_request_driver_module(dev, phy_id);
640         }
641
642         if (ret) {
643                 put_device(&mdiodev->dev);
644                 dev = ERR_PTR(ret);
645         }
646
647         return dev;
648 }
649 EXPORT_SYMBOL(phy_device_create);
650
651 /* phy_c45_probe_present - checks to see if a MMD is present in the package
652  * @bus: the target MII bus
653  * @prtad: PHY package address on the MII bus
654  * @devad: PHY device (MMD) address
655  *
656  * Read the MDIO_STAT2 register, and check whether a device is responding
657  * at this address.
658  *
659  * Returns: negative error number on bus access error, zero if no device
660  * is responding, or positive if a device is present.
661  */
662 static int phy_c45_probe_present(struct mii_bus *bus, int prtad, int devad)
663 {
664         int stat2;
665
666         stat2 = mdiobus_c45_read(bus, prtad, devad, MDIO_STAT2);
667         if (stat2 < 0)
668                 return stat2;
669
670         return (stat2 & MDIO_STAT2_DEVPRST) == MDIO_STAT2_DEVPRST_VAL;
671 }
672
673 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
674  * @bus: the target MII bus
675  * @addr: PHY address on the MII bus
676  * @dev_addr: MMD address in the PHY.
677  * @devices_in_package: where to store the devices in package information.
678  *
679  * Description: reads devices in package registers of a MMD at @dev_addr
680  * from PHY at @addr on @bus.
681  *
682  * Returns: 0 on success, -EIO on failure.
683  */
684 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
685                                    u32 *devices_in_package)
686 {
687         int phy_reg;
688
689         phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS2);
690         if (phy_reg < 0)
691                 return -EIO;
692         *devices_in_package = phy_reg << 16;
693
694         phy_reg = mdiobus_c45_read(bus, addr, dev_addr, MDIO_DEVS1);
695         if (phy_reg < 0)
696                 return -EIO;
697         *devices_in_package |= phy_reg;
698
699         return 0;
700 }
701
702 /**
703  * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
704  * @bus: the target MII bus
705  * @addr: PHY address on the MII bus
706  * @c45_ids: where to store the c45 ID information.
707  *
708  * Read the PHY "devices in package". If this appears to be valid, read
709  * the PHY identifiers for each device. Return the "devices in package"
710  * and identifiers in @c45_ids.
711  *
712  * Returns zero on success, %-EIO on bus access error, or %-ENODEV if
713  * the "devices in package" is invalid.
714  */
715 static int get_phy_c45_ids(struct mii_bus *bus, int addr,
716                            struct phy_c45_device_ids *c45_ids)
717 {
718         const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
719         u32 devs_in_pkg = 0;
720         int i, ret, phy_reg;
721
722         /* Find first non-zero Devices In package. Device zero is reserved
723          * for 802.3 c45 complied PHYs, so don't probe it at first.
724          */
725         for (i = 1; i < MDIO_MMD_NUM && (devs_in_pkg == 0 ||
726              (devs_in_pkg & 0x1fffffff) == 0x1fffffff); i++) {
727                 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
728                         /* Check that there is a device present at this
729                          * address before reading the devices-in-package
730                          * register to avoid reading garbage from the PHY.
731                          * Some PHYs (88x3310) vendor space is not IEEE802.3
732                          * compliant.
733                          */
734                         ret = phy_c45_probe_present(bus, addr, i);
735                         if (ret < 0)
736                                 return -EIO;
737
738                         if (!ret)
739                                 continue;
740                 }
741                 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, &devs_in_pkg);
742                 if (phy_reg < 0)
743                         return -EIO;
744         }
745
746         if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff) {
747                 /* If mostly Fs, there is no device there, then let's probe
748                  * MMD 0, as some 10G PHYs have zero Devices In package,
749                  * e.g. Cortina CS4315/CS4340 PHY.
750                  */
751                 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, &devs_in_pkg);
752                 if (phy_reg < 0)
753                         return -EIO;
754
755                 /* no device there, let's get out of here */
756                 if ((devs_in_pkg & 0x1fffffff) == 0x1fffffff)
757                         return -ENODEV;
758         }
759
760         /* Now probe Device Identifiers for each device present. */
761         for (i = 1; i < num_ids; i++) {
762                 if (!(devs_in_pkg & (1 << i)))
763                         continue;
764
765                 if (i == MDIO_MMD_VEND1 || i == MDIO_MMD_VEND2) {
766                         /* Probe the "Device Present" bits for the vendor MMDs
767                          * to ignore these if they do not contain IEEE 802.3
768                          * registers.
769                          */
770                         ret = phy_c45_probe_present(bus, addr, i);
771                         if (ret < 0)
772                                 return ret;
773
774                         if (!ret)
775                                 continue;
776                 }
777
778                 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID1);
779                 if (phy_reg < 0)
780                         return -EIO;
781                 c45_ids->device_ids[i] = phy_reg << 16;
782
783                 phy_reg = mdiobus_c45_read(bus, addr, i, MII_PHYSID2);
784                 if (phy_reg < 0)
785                         return -EIO;
786                 c45_ids->device_ids[i] |= phy_reg;
787         }
788
789         c45_ids->devices_in_package = devs_in_pkg;
790         /* Bit 0 doesn't represent a device, it indicates c22 regs presence */
791         c45_ids->mmds_present = devs_in_pkg & ~BIT(0);
792
793         return 0;
794 }
795
796 /**
797  * get_phy_c22_id - reads the specified addr for its clause 22 ID.
798  * @bus: the target MII bus
799  * @addr: PHY address on the MII bus
800  * @phy_id: where to store the ID retrieved.
801  *
802  * Read the 802.3 clause 22 PHY ID from the PHY at @addr on the @bus,
803  * placing it in @phy_id. Return zero on successful read and the ID is
804  * valid, %-EIO on bus access error, or %-ENODEV if no device responds
805  * or invalid ID.
806  */
807 static int get_phy_c22_id(struct mii_bus *bus, int addr, u32 *phy_id)
808 {
809         int phy_reg;
810
811         /* Grab the bits from PHYIR1, and put them in the upper half */
812         phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
813         if (phy_reg < 0) {
814                 /* returning -ENODEV doesn't stop bus scanning */
815                 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
816         }
817
818         *phy_id = phy_reg << 16;
819
820         /* Grab the bits from PHYIR2, and put them in the lower half */
821         phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
822         if (phy_reg < 0) {
823                 /* returning -ENODEV doesn't stop bus scanning */
824                 return (phy_reg == -EIO || phy_reg == -ENODEV) ? -ENODEV : -EIO;
825         }
826
827         *phy_id |= phy_reg;
828
829         /* If the phy_id is mostly Fs, there is no device there */
830         if ((*phy_id & 0x1fffffff) == 0x1fffffff)
831                 return -ENODEV;
832
833         return 0;
834 }
835
836 /**
837  * get_phy_device - reads the specified PHY device and returns its @phy_device
838  *                  struct
839  * @bus: the target MII bus
840  * @addr: PHY address on the MII bus
841  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
842  *
843  * Probe for a PHY at @addr on @bus.
844  *
845  * When probing for a clause 22 PHY, then read the ID registers. If we find
846  * a valid ID, allocate and return a &struct phy_device.
847  *
848  * When probing for a clause 45 PHY, read the "devices in package" registers.
849  * If the "devices in package" appears valid, read the ID registers for each
850  * MMD, allocate and return a &struct phy_device.
851  *
852  * Returns an allocated &struct phy_device on success, %-ENODEV if there is
853  * no PHY present, or %-EIO on bus access error.
854  */
855 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
856 {
857         struct phy_c45_device_ids c45_ids;
858         u32 phy_id = 0;
859         int r;
860
861         c45_ids.devices_in_package = 0;
862         c45_ids.mmds_present = 0;
863         memset(c45_ids.device_ids, 0xff, sizeof(c45_ids.device_ids));
864
865         if (is_c45)
866                 r = get_phy_c45_ids(bus, addr, &c45_ids);
867         else
868                 r = get_phy_c22_id(bus, addr, &phy_id);
869
870         if (r)
871                 return ERR_PTR(r);
872
873         return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
874 }
875 EXPORT_SYMBOL(get_phy_device);
876
877 /**
878  * phy_device_register - Register the phy device on the MDIO bus
879  * @phydev: phy_device structure to be added to the MDIO bus
880  */
881 int phy_device_register(struct phy_device *phydev)
882 {
883         int err;
884
885         err = mdiobus_register_device(&phydev->mdio);
886         if (err)
887                 return err;
888
889         /* Deassert the reset signal */
890         phy_device_reset(phydev, 0);
891
892         /* Run all of the fixups for this PHY */
893         err = phy_scan_fixups(phydev);
894         if (err) {
895                 phydev_err(phydev, "failed to initialize\n");
896                 goto out;
897         }
898
899         err = device_add(&phydev->mdio.dev);
900         if (err) {
901                 phydev_err(phydev, "failed to add\n");
902                 goto out;
903         }
904
905         return 0;
906
907  out:
908         /* Assert the reset signal */
909         phy_device_reset(phydev, 1);
910
911         mdiobus_unregister_device(&phydev->mdio);
912         return err;
913 }
914 EXPORT_SYMBOL(phy_device_register);
915
916 /**
917  * phy_device_remove - Remove a previously registered phy device from the MDIO bus
918  * @phydev: phy_device structure to remove
919  *
920  * This doesn't free the phy_device itself, it merely reverses the effects
921  * of phy_device_register(). Use phy_device_free() to free the device
922  * after calling this function.
923  */
924 void phy_device_remove(struct phy_device *phydev)
925 {
926         if (phydev->mii_ts)
927                 unregister_mii_timestamper(phydev->mii_ts);
928
929         device_del(&phydev->mdio.dev);
930
931         /* Assert the reset signal */
932         phy_device_reset(phydev, 1);
933
934         mdiobus_unregister_device(&phydev->mdio);
935 }
936 EXPORT_SYMBOL(phy_device_remove);
937
938 /**
939  * phy_find_first - finds the first PHY device on the bus
940  * @bus: the target MII bus
941  */
942 struct phy_device *phy_find_first(struct mii_bus *bus)
943 {
944         struct phy_device *phydev;
945         int addr;
946
947         for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
948                 phydev = mdiobus_get_phy(bus, addr);
949                 if (phydev)
950                         return phydev;
951         }
952         return NULL;
953 }
954 EXPORT_SYMBOL(phy_find_first);
955
956 static void phy_link_change(struct phy_device *phydev, bool up)
957 {
958         struct net_device *netdev = phydev->attached_dev;
959
960         if (up)
961                 netif_carrier_on(netdev);
962         else
963                 netif_carrier_off(netdev);
964         phydev->adjust_link(netdev);
965         if (phydev->mii_ts && phydev->mii_ts->link_state)
966                 phydev->mii_ts->link_state(phydev->mii_ts, phydev);
967 }
968
969 /**
970  * phy_prepare_link - prepares the PHY layer to monitor link status
971  * @phydev: target phy_device struct
972  * @handler: callback function for link status change notifications
973  *
974  * Description: Tells the PHY infrastructure to handle the
975  *   gory details on monitoring link status (whether through
976  *   polling or an interrupt), and to call back to the
977  *   connected device driver when the link status changes.
978  *   If you want to monitor your own link state, don't call
979  *   this function.
980  */
981 static void phy_prepare_link(struct phy_device *phydev,
982                              void (*handler)(struct net_device *))
983 {
984         phydev->adjust_link = handler;
985 }
986
987 /**
988  * phy_connect_direct - connect an ethernet device to a specific phy_device
989  * @dev: the network device to connect
990  * @phydev: the pointer to the phy device
991  * @handler: callback function for state change notifications
992  * @interface: PHY device's interface
993  */
994 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
995                        void (*handler)(struct net_device *),
996                        phy_interface_t interface)
997 {
998         int rc;
999
1000         if (!dev)
1001                 return -EINVAL;
1002
1003         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1004         if (rc)
1005                 return rc;
1006
1007         phy_prepare_link(phydev, handler);
1008         if (phy_interrupt_is_valid(phydev))
1009                 phy_request_interrupt(phydev);
1010
1011         return 0;
1012 }
1013 EXPORT_SYMBOL(phy_connect_direct);
1014
1015 /**
1016  * phy_connect - connect an ethernet device to a PHY device
1017  * @dev: the network device to connect
1018  * @bus_id: the id string of the PHY device to connect
1019  * @handler: callback function for state change notifications
1020  * @interface: PHY device's interface
1021  *
1022  * Description: Convenience function for connecting ethernet
1023  *   devices to PHY devices.  The default behavior is for
1024  *   the PHY infrastructure to handle everything, and only notify
1025  *   the connected driver when the link status changes.  If you
1026  *   don't want, or can't use the provided functionality, you may
1027  *   choose to call only the subset of functions which provide
1028  *   the desired functionality.
1029  */
1030 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
1031                                void (*handler)(struct net_device *),
1032                                phy_interface_t interface)
1033 {
1034         struct phy_device *phydev;
1035         struct device *d;
1036         int rc;
1037
1038         /* Search the list of PHY devices on the mdio bus for the
1039          * PHY with the requested name
1040          */
1041         d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
1042         if (!d) {
1043                 pr_err("PHY %s not found\n", bus_id);
1044                 return ERR_PTR(-ENODEV);
1045         }
1046         phydev = to_phy_device(d);
1047
1048         rc = phy_connect_direct(dev, phydev, handler, interface);
1049         put_device(d);
1050         if (rc)
1051                 return ERR_PTR(rc);
1052
1053         return phydev;
1054 }
1055 EXPORT_SYMBOL(phy_connect);
1056
1057 /**
1058  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
1059  *                  device
1060  * @phydev: target phy_device struct
1061  */
1062 void phy_disconnect(struct phy_device *phydev)
1063 {
1064         if (phy_is_started(phydev))
1065                 phy_stop(phydev);
1066
1067         if (phy_interrupt_is_valid(phydev))
1068                 phy_free_interrupt(phydev);
1069
1070         phydev->adjust_link = NULL;
1071
1072         phy_detach(phydev);
1073 }
1074 EXPORT_SYMBOL(phy_disconnect);
1075
1076 /**
1077  * phy_poll_reset - Safely wait until a PHY reset has properly completed
1078  * @phydev: The PHY device to poll
1079  *
1080  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1081  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
1082  *   register must be polled until the BMCR_RESET bit clears.
1083  *
1084  *   Furthermore, any attempts to write to PHY registers may have no effect
1085  *   or even generate MDIO bus errors until this is complete.
1086  *
1087  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1088  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
1089  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
1090  *   effort to support such broken PHYs, this function is separate from the
1091  *   standard phy_init_hw() which will zero all the other bits in the BMCR
1092  *   and reapply all driver-specific and board-specific fixups.
1093  */
1094 static int phy_poll_reset(struct phy_device *phydev)
1095 {
1096         /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1097         int ret, val;
1098
1099         ret = phy_read_poll_timeout(phydev, MII_BMCR, val, !(val & BMCR_RESET),
1100                                     50000, 600000, true);
1101         if (ret)
1102                 return ret;
1103         /* Some chips (smsc911x) may still need up to another 1ms after the
1104          * BMCR_RESET bit is cleared before they are usable.
1105          */
1106         msleep(1);
1107         return 0;
1108 }
1109
1110 int phy_init_hw(struct phy_device *phydev)
1111 {
1112         int ret = 0;
1113
1114         /* Deassert the reset signal */
1115         phy_device_reset(phydev, 0);
1116
1117         if (!phydev->drv)
1118                 return 0;
1119
1120         if (phydev->drv->soft_reset) {
1121                 ret = phydev->drv->soft_reset(phydev);
1122                 /* see comment in genphy_soft_reset for an explanation */
1123                 if (!ret)
1124                         phydev->suspended = 0;
1125         }
1126
1127         if (ret < 0)
1128                 return ret;
1129
1130         ret = phy_scan_fixups(phydev);
1131         if (ret < 0)
1132                 return ret;
1133
1134         if (phydev->drv->config_init) {
1135                 ret = phydev->drv->config_init(phydev);
1136                 if (ret < 0)
1137                         return ret;
1138         }
1139
1140         if (phydev->drv->config_intr) {
1141                 ret = phydev->drv->config_intr(phydev);
1142                 if (ret < 0)
1143                         return ret;
1144         }
1145
1146         return 0;
1147 }
1148 EXPORT_SYMBOL(phy_init_hw);
1149
1150 void phy_attached_info(struct phy_device *phydev)
1151 {
1152         phy_attached_print(phydev, NULL);
1153 }
1154 EXPORT_SYMBOL(phy_attached_info);
1155
1156 #define ATTACHED_FMT "attached PHY driver %s(mii_bus:phy_addr=%s, irq=%s)"
1157 char *phy_attached_info_irq(struct phy_device *phydev)
1158 {
1159         char *irq_str;
1160         char irq_num[8];
1161
1162         switch(phydev->irq) {
1163         case PHY_POLL:
1164                 irq_str = "POLL";
1165                 break;
1166         case PHY_MAC_INTERRUPT:
1167                 irq_str = "MAC";
1168                 break;
1169         default:
1170                 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1171                 irq_str = irq_num;
1172                 break;
1173         }
1174
1175         return kasprintf(GFP_KERNEL, "%s", irq_str);
1176 }
1177 EXPORT_SYMBOL(phy_attached_info_irq);
1178
1179 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1180 {
1181         const char *unbound = phydev->drv ? "" : "[unbound] ";
1182         char *irq_str = phy_attached_info_irq(phydev);
1183
1184         if (!fmt) {
1185                 phydev_info(phydev, ATTACHED_FMT "\n", unbound,
1186                             phydev_name(phydev), irq_str);
1187         } else {
1188                 va_list ap;
1189
1190                 phydev_info(phydev, ATTACHED_FMT, unbound,
1191                             phydev_name(phydev), irq_str);
1192
1193                 va_start(ap, fmt);
1194                 vprintk(fmt, ap);
1195                 va_end(ap);
1196         }
1197         kfree(irq_str);
1198 }
1199 EXPORT_SYMBOL(phy_attached_print);
1200
1201 static void phy_sysfs_create_links(struct phy_device *phydev)
1202 {
1203         struct net_device *dev = phydev->attached_dev;
1204         int err;
1205
1206         if (!dev)
1207                 return;
1208
1209         err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1210                                 "attached_dev");
1211         if (err)
1212                 return;
1213
1214         err = sysfs_create_link_nowarn(&dev->dev.kobj,
1215                                        &phydev->mdio.dev.kobj,
1216                                        "phydev");
1217         if (err) {
1218                 dev_err(&dev->dev, "could not add device link to %s err %d\n",
1219                         kobject_name(&phydev->mdio.dev.kobj),
1220                         err);
1221                 /* non-fatal - some net drivers can use one netdevice
1222                  * with more then one phy
1223                  */
1224         }
1225
1226         phydev->sysfs_links = true;
1227 }
1228
1229 static ssize_t
1230 phy_standalone_show(struct device *dev, struct device_attribute *attr,
1231                     char *buf)
1232 {
1233         struct phy_device *phydev = to_phy_device(dev);
1234
1235         return sprintf(buf, "%d\n", !phydev->attached_dev);
1236 }
1237 static DEVICE_ATTR_RO(phy_standalone);
1238
1239 /**
1240  * phy_sfp_attach - attach the SFP bus to the PHY upstream network device
1241  * @upstream: pointer to the phy device
1242  * @bus: sfp bus representing cage being attached
1243  *
1244  * This is used to fill in the sfp_upstream_ops .attach member.
1245  */
1246 void phy_sfp_attach(void *upstream, struct sfp_bus *bus)
1247 {
1248         struct phy_device *phydev = upstream;
1249
1250         if (phydev->attached_dev)
1251                 phydev->attached_dev->sfp_bus = bus;
1252         phydev->sfp_bus_attached = true;
1253 }
1254 EXPORT_SYMBOL(phy_sfp_attach);
1255
1256 /**
1257  * phy_sfp_detach - detach the SFP bus from the PHY upstream network device
1258  * @upstream: pointer to the phy device
1259  * @bus: sfp bus representing cage being attached
1260  *
1261  * This is used to fill in the sfp_upstream_ops .detach member.
1262  */
1263 void phy_sfp_detach(void *upstream, struct sfp_bus *bus)
1264 {
1265         struct phy_device *phydev = upstream;
1266
1267         if (phydev->attached_dev)
1268                 phydev->attached_dev->sfp_bus = NULL;
1269         phydev->sfp_bus_attached = false;
1270 }
1271 EXPORT_SYMBOL(phy_sfp_detach);
1272
1273 /**
1274  * phy_sfp_probe - probe for a SFP cage attached to this PHY device
1275  * @phydev: Pointer to phy_device
1276  * @ops: SFP's upstream operations
1277  */
1278 int phy_sfp_probe(struct phy_device *phydev,
1279                   const struct sfp_upstream_ops *ops)
1280 {
1281         struct sfp_bus *bus;
1282         int ret = 0;
1283
1284         if (phydev->mdio.dev.fwnode) {
1285                 bus = sfp_bus_find_fwnode(phydev->mdio.dev.fwnode);
1286                 if (IS_ERR(bus))
1287                         return PTR_ERR(bus);
1288
1289                 phydev->sfp_bus = bus;
1290
1291                 ret = sfp_bus_add_upstream(bus, phydev, ops);
1292                 sfp_bus_put(bus);
1293         }
1294         return ret;
1295 }
1296 EXPORT_SYMBOL(phy_sfp_probe);
1297
1298 /**
1299  * phy_attach_direct - attach a network device to a given PHY device pointer
1300  * @dev: network device to attach
1301  * @phydev: Pointer to phy_device to attach
1302  * @flags: PHY device's dev_flags
1303  * @interface: PHY device's interface
1304  *
1305  * Description: Called by drivers to attach to a particular PHY
1306  *     device. The phy_device is found, and properly hooked up
1307  *     to the phy_driver.  If no driver is attached, then a
1308  *     generic driver is used.  The phy_device is given a ptr to
1309  *     the attaching device, and given a callback for link status
1310  *     change.  The phy_device is returned to the attaching driver.
1311  *     This function takes a reference on the phy device.
1312  */
1313 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1314                       u32 flags, phy_interface_t interface)
1315 {
1316         struct mii_bus *bus = phydev->mdio.bus;
1317         struct device *d = &phydev->mdio.dev;
1318         struct module *ndev_owner = NULL;
1319         bool using_genphy = false;
1320         int err;
1321
1322         /* For Ethernet device drivers that register their own MDIO bus, we
1323          * will have bus->owner match ndev_mod, so we do not want to increment
1324          * our own module->refcnt here, otherwise we would not be able to
1325          * unload later on.
1326          */
1327         if (dev)
1328                 ndev_owner = dev->dev.parent->driver->owner;
1329         if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1330                 phydev_err(phydev, "failed to get the bus module\n");
1331                 return -EIO;
1332         }
1333
1334         get_device(d);
1335
1336         /* Assume that if there is no driver, that it doesn't
1337          * exist, and we should use the genphy driver.
1338          */
1339         if (!d->driver) {
1340                 if (phydev->is_c45)
1341                         d->driver = &genphy_c45_driver.mdiodrv.driver;
1342                 else
1343                         d->driver = &genphy_driver.mdiodrv.driver;
1344
1345                 using_genphy = true;
1346         }
1347
1348         if (!try_module_get(d->driver->owner)) {
1349                 phydev_err(phydev, "failed to get the device driver module\n");
1350                 err = -EIO;
1351                 goto error_put_device;
1352         }
1353
1354         if (using_genphy) {
1355                 err = d->driver->probe(d);
1356                 if (err >= 0)
1357                         err = device_bind_driver(d);
1358
1359                 if (err)
1360                         goto error_module_put;
1361         }
1362
1363         if (phydev->attached_dev) {
1364                 dev_err(&dev->dev, "PHY already attached\n");
1365                 err = -EBUSY;
1366                 goto error;
1367         }
1368
1369         phydev->phy_link_change = phy_link_change;
1370         if (dev) {
1371                 phydev->attached_dev = dev;
1372                 dev->phydev = phydev;
1373
1374                 if (phydev->sfp_bus_attached)
1375                         dev->sfp_bus = phydev->sfp_bus;
1376                 else if (dev->sfp_bus)
1377                         phydev->is_on_sfp_module = true;
1378         }
1379
1380         /* Some Ethernet drivers try to connect to a PHY device before
1381          * calling register_netdevice() -> netdev_register_kobject() and
1382          * does the dev->dev.kobj initialization. Here we only check for
1383          * success which indicates that the network device kobject is
1384          * ready. Once we do that we still need to keep track of whether
1385          * links were successfully set up or not for phy_detach() to
1386          * remove them accordingly.
1387          */
1388         phydev->sysfs_links = false;
1389
1390         phy_sysfs_create_links(phydev);
1391
1392         if (!phydev->attached_dev) {
1393                 err = sysfs_create_file(&phydev->mdio.dev.kobj,
1394                                         &dev_attr_phy_standalone.attr);
1395                 if (err)
1396                         phydev_err(phydev, "error creating 'phy_standalone' sysfs entry\n");
1397         }
1398
1399         phydev->dev_flags |= flags;
1400
1401         phydev->interface = interface;
1402
1403         phydev->state = PHY_READY;
1404
1405         /* Port is set to PORT_TP by default and the actual PHY driver will set
1406          * it to different value depending on the PHY configuration. If we have
1407          * the generic PHY driver we can't figure it out, thus set the old
1408          * legacy PORT_MII value.
1409          */
1410         if (using_genphy)
1411                 phydev->port = PORT_MII;
1412
1413         /* Initial carrier state is off as the phy is about to be
1414          * (re)initialized.
1415          */
1416         if (dev)
1417                 netif_carrier_off(phydev->attached_dev);
1418
1419         /* Do initial configuration here, now that
1420          * we have certain key parameters
1421          * (dev_flags and interface)
1422          */
1423         err = phy_init_hw(phydev);
1424         if (err)
1425                 goto error;
1426
1427         err = phy_disable_interrupts(phydev);
1428         if (err)
1429                 return err;
1430
1431         phy_resume(phydev);
1432         phy_led_triggers_register(phydev);
1433
1434         return err;
1435
1436 error:
1437         /* phy_detach() does all of the cleanup below */
1438         phy_detach(phydev);
1439         return err;
1440
1441 error_module_put:
1442         module_put(d->driver->owner);
1443 error_put_device:
1444         put_device(d);
1445         if (ndev_owner != bus->owner)
1446                 module_put(bus->owner);
1447         return err;
1448 }
1449 EXPORT_SYMBOL(phy_attach_direct);
1450
1451 /**
1452  * phy_attach - attach a network device to a particular PHY device
1453  * @dev: network device to attach
1454  * @bus_id: Bus ID of PHY device to attach
1455  * @interface: PHY device's interface
1456  *
1457  * Description: Same as phy_attach_direct() except that a PHY bus_id
1458  *     string is passed instead of a pointer to a struct phy_device.
1459  */
1460 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1461                               phy_interface_t interface)
1462 {
1463         struct bus_type *bus = &mdio_bus_type;
1464         struct phy_device *phydev;
1465         struct device *d;
1466         int rc;
1467
1468         if (!dev)
1469                 return ERR_PTR(-EINVAL);
1470
1471         /* Search the list of PHY devices on the mdio bus for the
1472          * PHY with the requested name
1473          */
1474         d = bus_find_device_by_name(bus, NULL, bus_id);
1475         if (!d) {
1476                 pr_err("PHY %s not found\n", bus_id);
1477                 return ERR_PTR(-ENODEV);
1478         }
1479         phydev = to_phy_device(d);
1480
1481         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1482         put_device(d);
1483         if (rc)
1484                 return ERR_PTR(rc);
1485
1486         return phydev;
1487 }
1488 EXPORT_SYMBOL(phy_attach);
1489
1490 static bool phy_driver_is_genphy_kind(struct phy_device *phydev,
1491                                       struct device_driver *driver)
1492 {
1493         struct device *d = &phydev->mdio.dev;
1494         bool ret = false;
1495
1496         if (!phydev->drv)
1497                 return ret;
1498
1499         get_device(d);
1500         ret = d->driver == driver;
1501         put_device(d);
1502
1503         return ret;
1504 }
1505
1506 bool phy_driver_is_genphy(struct phy_device *phydev)
1507 {
1508         return phy_driver_is_genphy_kind(phydev,
1509                                          &genphy_driver.mdiodrv.driver);
1510 }
1511 EXPORT_SYMBOL_GPL(phy_driver_is_genphy);
1512
1513 bool phy_driver_is_genphy_10g(struct phy_device *phydev)
1514 {
1515         return phy_driver_is_genphy_kind(phydev,
1516                                          &genphy_c45_driver.mdiodrv.driver);
1517 }
1518 EXPORT_SYMBOL_GPL(phy_driver_is_genphy_10g);
1519
1520 /**
1521  * phy_package_join - join a common PHY group
1522  * @phydev: target phy_device struct
1523  * @addr: cookie and PHY address for global register access
1524  * @priv_size: if non-zero allocate this amount of bytes for private data
1525  *
1526  * This joins a PHY group and provides a shared storage for all phydevs in
1527  * this group. This is intended to be used for packages which contain
1528  * more than one PHY, for example a quad PHY transceiver.
1529  *
1530  * The addr parameter serves as a cookie which has to have the same value
1531  * for all members of one group and as a PHY address to access generic
1532  * registers of a PHY package. Usually, one of the PHY addresses of the
1533  * different PHYs in the package provides access to these global registers.
1534  * The address which is given here, will be used in the phy_package_read()
1535  * and phy_package_write() convenience functions. If your PHY doesn't have
1536  * global registers you can just pick any of the PHY addresses.
1537  *
1538  * This will set the shared pointer of the phydev to the shared storage.
1539  * If this is the first call for a this cookie the shared storage will be
1540  * allocated. If priv_size is non-zero, the given amount of bytes are
1541  * allocated for the priv member.
1542  *
1543  * Returns < 1 on error, 0 on success. Esp. calling phy_package_join()
1544  * with the same cookie but a different priv_size is an error.
1545  */
1546 int phy_package_join(struct phy_device *phydev, int addr, size_t priv_size)
1547 {
1548         struct mii_bus *bus = phydev->mdio.bus;
1549         struct phy_package_shared *shared;
1550         int ret;
1551
1552         if (addr < 0 || addr >= PHY_MAX_ADDR)
1553                 return -EINVAL;
1554
1555         mutex_lock(&bus->shared_lock);
1556         shared = bus->shared[addr];
1557         if (!shared) {
1558                 ret = -ENOMEM;
1559                 shared = kzalloc(sizeof(*shared), GFP_KERNEL);
1560                 if (!shared)
1561                         goto err_unlock;
1562                 if (priv_size) {
1563                         shared->priv = kzalloc(priv_size, GFP_KERNEL);
1564                         if (!shared->priv)
1565                                 goto err_free;
1566                         shared->priv_size = priv_size;
1567                 }
1568                 shared->addr = addr;
1569                 refcount_set(&shared->refcnt, 1);
1570                 bus->shared[addr] = shared;
1571         } else {
1572                 ret = -EINVAL;
1573                 if (priv_size && priv_size != shared->priv_size)
1574                         goto err_unlock;
1575                 refcount_inc(&shared->refcnt);
1576         }
1577         mutex_unlock(&bus->shared_lock);
1578
1579         phydev->shared = shared;
1580
1581         return 0;
1582
1583 err_free:
1584         kfree(shared);
1585 err_unlock:
1586         mutex_unlock(&bus->shared_lock);
1587         return ret;
1588 }
1589 EXPORT_SYMBOL_GPL(phy_package_join);
1590
1591 /**
1592  * phy_package_leave - leave a common PHY group
1593  * @phydev: target phy_device struct
1594  *
1595  * This leaves a PHY group created by phy_package_join(). If this phydev
1596  * was the last user of the shared data between the group, this data is
1597  * freed. Resets the phydev->shared pointer to NULL.
1598  */
1599 void phy_package_leave(struct phy_device *phydev)
1600 {
1601         struct phy_package_shared *shared = phydev->shared;
1602         struct mii_bus *bus = phydev->mdio.bus;
1603
1604         if (!shared)
1605                 return;
1606
1607         if (refcount_dec_and_mutex_lock(&shared->refcnt, &bus->shared_lock)) {
1608                 bus->shared[shared->addr] = NULL;
1609                 mutex_unlock(&bus->shared_lock);
1610                 kfree(shared->priv);
1611                 kfree(shared);
1612         }
1613
1614         phydev->shared = NULL;
1615 }
1616 EXPORT_SYMBOL_GPL(phy_package_leave);
1617
1618 static void devm_phy_package_leave(struct device *dev, void *res)
1619 {
1620         phy_package_leave(*(struct phy_device **)res);
1621 }
1622
1623 /**
1624  * devm_phy_package_join - resource managed phy_package_join()
1625  * @dev: device that is registering this PHY package
1626  * @phydev: target phy_device struct
1627  * @addr: cookie and PHY address for global register access
1628  * @priv_size: if non-zero allocate this amount of bytes for private data
1629  *
1630  * Managed phy_package_join(). Shared storage fetched by this function,
1631  * phy_package_leave() is automatically called on driver detach. See
1632  * phy_package_join() for more information.
1633  */
1634 int devm_phy_package_join(struct device *dev, struct phy_device *phydev,
1635                           int addr, size_t priv_size)
1636 {
1637         struct phy_device **ptr;
1638         int ret;
1639
1640         ptr = devres_alloc(devm_phy_package_leave, sizeof(*ptr),
1641                            GFP_KERNEL);
1642         if (!ptr)
1643                 return -ENOMEM;
1644
1645         ret = phy_package_join(phydev, addr, priv_size);
1646
1647         if (!ret) {
1648                 *ptr = phydev;
1649                 devres_add(dev, ptr);
1650         } else {
1651                 devres_free(ptr);
1652         }
1653
1654         return ret;
1655 }
1656 EXPORT_SYMBOL_GPL(devm_phy_package_join);
1657
1658 /**
1659  * phy_detach - detach a PHY device from its network device
1660  * @phydev: target phy_device struct
1661  *
1662  * This detaches the phy device from its network device and the phy
1663  * driver, and drops the reference count taken in phy_attach_direct().
1664  */
1665 void phy_detach(struct phy_device *phydev)
1666 {
1667         struct net_device *dev = phydev->attached_dev;
1668         struct module *ndev_owner = NULL;
1669         struct mii_bus *bus;
1670
1671         if (phydev->sysfs_links) {
1672                 if (dev)
1673                         sysfs_remove_link(&dev->dev.kobj, "phydev");
1674                 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1675         }
1676
1677         if (!phydev->attached_dev)
1678                 sysfs_remove_file(&phydev->mdio.dev.kobj,
1679                                   &dev_attr_phy_standalone.attr);
1680
1681         phy_suspend(phydev);
1682         if (dev) {
1683                 phydev->attached_dev->phydev = NULL;
1684                 phydev->attached_dev = NULL;
1685         }
1686         phydev->phylink = NULL;
1687
1688         phy_led_triggers_unregister(phydev);
1689
1690         if (phydev->mdio.dev.driver)
1691                 module_put(phydev->mdio.dev.driver->owner);
1692
1693         /* If the device had no specific driver before (i.e. - it
1694          * was using the generic driver), we unbind the device
1695          * from the generic driver so that there's a chance a
1696          * real driver could be loaded
1697          */
1698         if (phy_driver_is_genphy(phydev) ||
1699             phy_driver_is_genphy_10g(phydev))
1700                 device_release_driver(&phydev->mdio.dev);
1701
1702         /*
1703          * The phydev might go away on the put_device() below, so avoid
1704          * a use-after-free bug by reading the underlying bus first.
1705          */
1706         bus = phydev->mdio.bus;
1707
1708         put_device(&phydev->mdio.dev);
1709         if (dev)
1710                 ndev_owner = dev->dev.parent->driver->owner;
1711         if (ndev_owner != bus->owner)
1712                 module_put(bus->owner);
1713
1714         /* Assert the reset signal */
1715         phy_device_reset(phydev, 1);
1716 }
1717 EXPORT_SYMBOL(phy_detach);
1718
1719 int phy_suspend(struct phy_device *phydev)
1720 {
1721         struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1722         struct net_device *netdev = phydev->attached_dev;
1723         struct phy_driver *phydrv = phydev->drv;
1724         int ret;
1725
1726         if (phydev->suspended)
1727                 return 0;
1728
1729         /* If the device has WOL enabled, we cannot suspend the PHY */
1730         phy_ethtool_get_wol(phydev, &wol);
1731         if (wol.wolopts || (netdev && netdev->wol_enabled))
1732                 return -EBUSY;
1733
1734         if (!phydrv || !phydrv->suspend)
1735                 return 0;
1736
1737         ret = phydrv->suspend(phydev);
1738         if (!ret)
1739                 phydev->suspended = true;
1740
1741         return ret;
1742 }
1743 EXPORT_SYMBOL(phy_suspend);
1744
1745 int __phy_resume(struct phy_device *phydev)
1746 {
1747         struct phy_driver *phydrv = phydev->drv;
1748         int ret;
1749
1750         lockdep_assert_held(&phydev->lock);
1751
1752         if (!phydrv || !phydrv->resume)
1753                 return 0;
1754
1755         ret = phydrv->resume(phydev);
1756         if (!ret)
1757                 phydev->suspended = false;
1758
1759         return ret;
1760 }
1761 EXPORT_SYMBOL(__phy_resume);
1762
1763 int phy_resume(struct phy_device *phydev)
1764 {
1765         int ret;
1766
1767         mutex_lock(&phydev->lock);
1768         ret = __phy_resume(phydev);
1769         mutex_unlock(&phydev->lock);
1770
1771         return ret;
1772 }
1773 EXPORT_SYMBOL(phy_resume);
1774
1775 int phy_loopback(struct phy_device *phydev, bool enable)
1776 {
1777         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1778         int ret = 0;
1779
1780         if (!phydrv)
1781                 return -ENODEV;
1782
1783         mutex_lock(&phydev->lock);
1784
1785         if (enable && phydev->loopback_enabled) {
1786                 ret = -EBUSY;
1787                 goto out;
1788         }
1789
1790         if (!enable && !phydev->loopback_enabled) {
1791                 ret = -EINVAL;
1792                 goto out;
1793         }
1794
1795         if (phydrv->set_loopback)
1796                 ret = phydrv->set_loopback(phydev, enable);
1797         else
1798                 ret = genphy_loopback(phydev, enable);
1799
1800         if (ret)
1801                 goto out;
1802
1803         phydev->loopback_enabled = enable;
1804
1805 out:
1806         mutex_unlock(&phydev->lock);
1807         return ret;
1808 }
1809 EXPORT_SYMBOL(phy_loopback);
1810
1811 /**
1812  * phy_reset_after_clk_enable - perform a PHY reset if needed
1813  * @phydev: target phy_device struct
1814  *
1815  * Description: Some PHYs are known to need a reset after their refclk was
1816  *   enabled. This function evaluates the flags and perform the reset if it's
1817  *   needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1818  *   was reset.
1819  */
1820 int phy_reset_after_clk_enable(struct phy_device *phydev)
1821 {
1822         if (!phydev || !phydev->drv)
1823                 return -ENODEV;
1824
1825         if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1826                 phy_device_reset(phydev, 1);
1827                 phy_device_reset(phydev, 0);
1828                 return 1;
1829         }
1830
1831         return 0;
1832 }
1833 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1834
1835 /* Generic PHY support and helper functions */
1836
1837 /**
1838  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1839  * @phydev: target phy_device struct
1840  *
1841  * Description: Writes MII_ADVERTISE with the appropriate values,
1842  *   after sanitizing the values to make sure we only advertise
1843  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
1844  *   hasn't changed, and > 0 if it has changed.
1845  */
1846 static int genphy_config_advert(struct phy_device *phydev)
1847 {
1848         int err, bmsr, changed = 0;
1849         u32 adv;
1850
1851         /* Only allow advertising what this PHY supports */
1852         linkmode_and(phydev->advertising, phydev->advertising,
1853                      phydev->supported);
1854
1855         adv = linkmode_adv_to_mii_adv_t(phydev->advertising);
1856
1857         /* Setup standard advertisement */
1858         err = phy_modify_changed(phydev, MII_ADVERTISE,
1859                                  ADVERTISE_ALL | ADVERTISE_100BASE4 |
1860                                  ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM,
1861                                  adv);
1862         if (err < 0)
1863                 return err;
1864         if (err > 0)
1865                 changed = 1;
1866
1867         bmsr = phy_read(phydev, MII_BMSR);
1868         if (bmsr < 0)
1869                 return bmsr;
1870
1871         /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1872          * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1873          * logical 1.
1874          */
1875         if (!(bmsr & BMSR_ESTATEN))
1876                 return changed;
1877
1878         adv = linkmode_adv_to_mii_ctrl1000_t(phydev->advertising);
1879
1880         err = phy_modify_changed(phydev, MII_CTRL1000,
1881                                  ADVERTISE_1000FULL | ADVERTISE_1000HALF,
1882                                  adv);
1883         if (err < 0)
1884                 return err;
1885         if (err > 0)
1886                 changed = 1;
1887
1888         return changed;
1889 }
1890
1891 /**
1892  * genphy_c37_config_advert - sanitize and advertise auto-negotiation parameters
1893  * @phydev: target phy_device struct
1894  *
1895  * Description: Writes MII_ADVERTISE with the appropriate values,
1896  *   after sanitizing the values to make sure we only advertise
1897  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
1898  *   hasn't changed, and > 0 if it has changed. This function is intended
1899  *   for Clause 37 1000Base-X mode.
1900  */
1901 static int genphy_c37_config_advert(struct phy_device *phydev)
1902 {
1903         u16 adv = 0;
1904
1905         /* Only allow advertising what this PHY supports */
1906         linkmode_and(phydev->advertising, phydev->advertising,
1907                      phydev->supported);
1908
1909         if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
1910                               phydev->advertising))
1911                 adv |= ADVERTISE_1000XFULL;
1912         if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
1913                               phydev->advertising))
1914                 adv |= ADVERTISE_1000XPAUSE;
1915         if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
1916                               phydev->advertising))
1917                 adv |= ADVERTISE_1000XPSE_ASYM;
1918
1919         return phy_modify_changed(phydev, MII_ADVERTISE,
1920                                   ADVERTISE_1000XFULL | ADVERTISE_1000XPAUSE |
1921                                   ADVERTISE_1000XHALF | ADVERTISE_1000XPSE_ASYM,
1922                                   adv);
1923 }
1924
1925 /**
1926  * genphy_config_eee_advert - disable unwanted eee mode advertisement
1927  * @phydev: target phy_device struct
1928  *
1929  * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1930  *   efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1931  *   changed, and 1 if it has changed.
1932  */
1933 int genphy_config_eee_advert(struct phy_device *phydev)
1934 {
1935         int err;
1936
1937         /* Nothing to disable */
1938         if (!phydev->eee_broken_modes)
1939                 return 0;
1940
1941         err = phy_modify_mmd_changed(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV,
1942                                      phydev->eee_broken_modes, 0);
1943         /* If the call failed, we assume that EEE is not supported */
1944         return err < 0 ? 0 : err;
1945 }
1946 EXPORT_SYMBOL(genphy_config_eee_advert);
1947
1948 /**
1949  * genphy_setup_forced - configures/forces speed/duplex from @phydev
1950  * @phydev: target phy_device struct
1951  *
1952  * Description: Configures MII_BMCR to force speed/duplex
1953  *   to the values in phydev. Assumes that the values are valid.
1954  *   Please see phy_sanitize_settings().
1955  */
1956 int genphy_setup_forced(struct phy_device *phydev)
1957 {
1958         u16 ctl = 0;
1959
1960         phydev->pause = 0;
1961         phydev->asym_pause = 0;
1962
1963         if (SPEED_1000 == phydev->speed)
1964                 ctl |= BMCR_SPEED1000;
1965         else if (SPEED_100 == phydev->speed)
1966                 ctl |= BMCR_SPEED100;
1967
1968         if (DUPLEX_FULL == phydev->duplex)
1969                 ctl |= BMCR_FULLDPLX;
1970
1971         return phy_modify(phydev, MII_BMCR,
1972                           ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1973 }
1974 EXPORT_SYMBOL(genphy_setup_forced);
1975
1976 static int genphy_setup_master_slave(struct phy_device *phydev)
1977 {
1978         u16 ctl = 0;
1979
1980         if (!phydev->is_gigabit_capable)
1981                 return 0;
1982
1983         switch (phydev->master_slave_set) {
1984         case MASTER_SLAVE_CFG_MASTER_PREFERRED:
1985                 ctl |= CTL1000_PREFER_MASTER;
1986                 break;
1987         case MASTER_SLAVE_CFG_SLAVE_PREFERRED:
1988                 break;
1989         case MASTER_SLAVE_CFG_MASTER_FORCE:
1990                 ctl |= CTL1000_AS_MASTER;
1991                 fallthrough;
1992         case MASTER_SLAVE_CFG_SLAVE_FORCE:
1993                 ctl |= CTL1000_ENABLE_MASTER;
1994                 break;
1995         case MASTER_SLAVE_CFG_UNKNOWN:
1996         case MASTER_SLAVE_CFG_UNSUPPORTED:
1997                 return 0;
1998         default:
1999                 phydev_warn(phydev, "Unsupported Master/Slave mode\n");
2000                 return -EOPNOTSUPP;
2001         }
2002
2003         return phy_modify_changed(phydev, MII_CTRL1000,
2004                                   (CTL1000_ENABLE_MASTER | CTL1000_AS_MASTER |
2005                                    CTL1000_PREFER_MASTER), ctl);
2006 }
2007
2008 static int genphy_read_master_slave(struct phy_device *phydev)
2009 {
2010         int cfg, state;
2011         int val;
2012
2013         if (!phydev->is_gigabit_capable) {
2014                 phydev->master_slave_get = MASTER_SLAVE_CFG_UNSUPPORTED;
2015                 phydev->master_slave_state = MASTER_SLAVE_STATE_UNSUPPORTED;
2016                 return 0;
2017         }
2018
2019         phydev->master_slave_get = MASTER_SLAVE_CFG_UNKNOWN;
2020         phydev->master_slave_state = MASTER_SLAVE_STATE_UNKNOWN;
2021
2022         val = phy_read(phydev, MII_CTRL1000);
2023         if (val < 0)
2024                 return val;
2025
2026         if (val & CTL1000_ENABLE_MASTER) {
2027                 if (val & CTL1000_AS_MASTER)
2028                         cfg = MASTER_SLAVE_CFG_MASTER_FORCE;
2029                 else
2030                         cfg = MASTER_SLAVE_CFG_SLAVE_FORCE;
2031         } else {
2032                 if (val & CTL1000_PREFER_MASTER)
2033                         cfg = MASTER_SLAVE_CFG_MASTER_PREFERRED;
2034                 else
2035                         cfg = MASTER_SLAVE_CFG_SLAVE_PREFERRED;
2036         }
2037
2038         val = phy_read(phydev, MII_STAT1000);
2039         if (val < 0)
2040                 return val;
2041
2042         if (val & LPA_1000MSFAIL) {
2043                 state = MASTER_SLAVE_STATE_ERR;
2044         } else if (phydev->link) {
2045                 /* this bits are valid only for active link */
2046                 if (val & LPA_1000MSRES)
2047                         state = MASTER_SLAVE_STATE_MASTER;
2048                 else
2049                         state = MASTER_SLAVE_STATE_SLAVE;
2050         } else {
2051                 state = MASTER_SLAVE_STATE_UNKNOWN;
2052         }
2053
2054         phydev->master_slave_get = cfg;
2055         phydev->master_slave_state = state;
2056
2057         return 0;
2058 }
2059
2060 /**
2061  * genphy_restart_aneg - Enable and Restart Autonegotiation
2062  * @phydev: target phy_device struct
2063  */
2064 int genphy_restart_aneg(struct phy_device *phydev)
2065 {
2066         /* Don't isolate the PHY if we're negotiating */
2067         return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
2068                           BMCR_ANENABLE | BMCR_ANRESTART);
2069 }
2070 EXPORT_SYMBOL(genphy_restart_aneg);
2071
2072 /**
2073  * genphy_check_and_restart_aneg - Enable and restart auto-negotiation
2074  * @phydev: target phy_device struct
2075  * @restart: whether aneg restart is requested
2076  *
2077  * Check, and restart auto-negotiation if needed.
2078  */
2079 int genphy_check_and_restart_aneg(struct phy_device *phydev, bool restart)
2080 {
2081         int ret;
2082
2083         if (!restart) {
2084                 /* Advertisement hasn't changed, but maybe aneg was never on to
2085                  * begin with?  Or maybe phy was isolated?
2086                  */
2087                 ret = phy_read(phydev, MII_BMCR);
2088                 if (ret < 0)
2089                         return ret;
2090
2091                 if (!(ret & BMCR_ANENABLE) || (ret & BMCR_ISOLATE))
2092                         restart = true;
2093         }
2094
2095         if (restart)
2096                 return genphy_restart_aneg(phydev);
2097
2098         return 0;
2099 }
2100 EXPORT_SYMBOL(genphy_check_and_restart_aneg);
2101
2102 /**
2103  * __genphy_config_aneg - restart auto-negotiation or write BMCR
2104  * @phydev: target phy_device struct
2105  * @changed: whether autoneg is requested
2106  *
2107  * Description: If auto-negotiation is enabled, we configure the
2108  *   advertising, and then restart auto-negotiation.  If it is not
2109  *   enabled, then we write the BMCR.
2110  */
2111 int __genphy_config_aneg(struct phy_device *phydev, bool changed)
2112 {
2113         int err;
2114
2115         if (genphy_config_eee_advert(phydev))
2116                 changed = true;
2117
2118         err = genphy_setup_master_slave(phydev);
2119         if (err < 0)
2120                 return err;
2121         else if (err)
2122                 changed = true;
2123
2124         if (AUTONEG_ENABLE != phydev->autoneg)
2125                 return genphy_setup_forced(phydev);
2126
2127         err = genphy_config_advert(phydev);
2128         if (err < 0) /* error */
2129                 return err;
2130         else if (err)
2131                 changed = true;
2132
2133         return genphy_check_and_restart_aneg(phydev, changed);
2134 }
2135 EXPORT_SYMBOL(__genphy_config_aneg);
2136
2137 /**
2138  * genphy_c37_config_aneg - restart auto-negotiation or write BMCR
2139  * @phydev: target phy_device struct
2140  *
2141  * Description: If auto-negotiation is enabled, we configure the
2142  *   advertising, and then restart auto-negotiation.  If it is not
2143  *   enabled, then we write the BMCR. This function is intended
2144  *   for use with Clause 37 1000Base-X mode.
2145  */
2146 int genphy_c37_config_aneg(struct phy_device *phydev)
2147 {
2148         int err, changed;
2149
2150         if (phydev->autoneg != AUTONEG_ENABLE)
2151                 return genphy_setup_forced(phydev);
2152
2153         err = phy_modify(phydev, MII_BMCR, BMCR_SPEED1000 | BMCR_SPEED100,
2154                          BMCR_SPEED1000);
2155         if (err)
2156                 return err;
2157
2158         changed = genphy_c37_config_advert(phydev);
2159         if (changed < 0) /* error */
2160                 return changed;
2161
2162         if (!changed) {
2163                 /* Advertisement hasn't changed, but maybe aneg was never on to
2164                  * begin with?  Or maybe phy was isolated?
2165                  */
2166                 int ctl = phy_read(phydev, MII_BMCR);
2167
2168                 if (ctl < 0)
2169                         return ctl;
2170
2171                 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
2172                         changed = 1; /* do restart aneg */
2173         }
2174
2175         /* Only restart aneg if we are advertising something different
2176          * than we were before.
2177          */
2178         if (changed > 0)
2179                 return genphy_restart_aneg(phydev);
2180
2181         return 0;
2182 }
2183 EXPORT_SYMBOL(genphy_c37_config_aneg);
2184
2185 /**
2186  * genphy_aneg_done - return auto-negotiation status
2187  * @phydev: target phy_device struct
2188  *
2189  * Description: Reads the status register and returns 0 either if
2190  *   auto-negotiation is incomplete, or if there was an error.
2191  *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
2192  */
2193 int genphy_aneg_done(struct phy_device *phydev)
2194 {
2195         int retval = phy_read(phydev, MII_BMSR);
2196
2197         return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
2198 }
2199 EXPORT_SYMBOL(genphy_aneg_done);
2200
2201 /**
2202  * genphy_update_link - update link status in @phydev
2203  * @phydev: target phy_device struct
2204  *
2205  * Description: Update the value in phydev->link to reflect the
2206  *   current link value.  In order to do this, we need to read
2207  *   the status register twice, keeping the second value.
2208  */
2209 int genphy_update_link(struct phy_device *phydev)
2210 {
2211         int status = 0, bmcr;
2212
2213         bmcr = phy_read(phydev, MII_BMCR);
2214         if (bmcr < 0)
2215                 return bmcr;
2216
2217         /* Autoneg is being started, therefore disregard BMSR value and
2218          * report link as down.
2219          */
2220         if (bmcr & BMCR_ANRESTART)
2221                 goto done;
2222
2223         /* The link state is latched low so that momentary link
2224          * drops can be detected. Do not double-read the status
2225          * in polling mode to detect such short link drops except
2226          * the link was already down.
2227          */
2228         if (!phy_polling_mode(phydev) || !phydev->link) {
2229                 status = phy_read(phydev, MII_BMSR);
2230                 if (status < 0)
2231                         return status;
2232                 else if (status & BMSR_LSTATUS)
2233                         goto done;
2234         }
2235
2236         /* Read link and autonegotiation status */
2237         status = phy_read(phydev, MII_BMSR);
2238         if (status < 0)
2239                 return status;
2240 done:
2241         phydev->link = status & BMSR_LSTATUS ? 1 : 0;
2242         phydev->autoneg_complete = status & BMSR_ANEGCOMPLETE ? 1 : 0;
2243
2244         /* Consider the case that autoneg was started and "aneg complete"
2245          * bit has been reset, but "link up" bit not yet.
2246          */
2247         if (phydev->autoneg == AUTONEG_ENABLE && !phydev->autoneg_complete)
2248                 phydev->link = 0;
2249
2250         return 0;
2251 }
2252 EXPORT_SYMBOL(genphy_update_link);
2253
2254 int genphy_read_lpa(struct phy_device *phydev)
2255 {
2256         int lpa, lpagb;
2257
2258         if (phydev->autoneg == AUTONEG_ENABLE) {
2259                 if (!phydev->autoneg_complete) {
2260                         mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2261                                                         0);
2262                         mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, 0);
2263                         return 0;
2264                 }
2265
2266                 if (phydev->is_gigabit_capable) {
2267                         lpagb = phy_read(phydev, MII_STAT1000);
2268                         if (lpagb < 0)
2269                                 return lpagb;
2270
2271                         if (lpagb & LPA_1000MSFAIL) {
2272                                 int adv = phy_read(phydev, MII_CTRL1000);
2273
2274                                 if (adv < 0)
2275                                         return adv;
2276
2277                                 if (adv & CTL1000_ENABLE_MASTER)
2278                                         phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
2279                                 else
2280                                         phydev_err(phydev, "Master/Slave resolution failed\n");
2281                                 return -ENOLINK;
2282                         }
2283
2284                         mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
2285                                                         lpagb);
2286                 }
2287
2288                 lpa = phy_read(phydev, MII_LPA);
2289                 if (lpa < 0)
2290                         return lpa;
2291
2292                 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
2293         } else {
2294                 linkmode_zero(phydev->lp_advertising);
2295         }
2296
2297         return 0;
2298 }
2299 EXPORT_SYMBOL(genphy_read_lpa);
2300
2301 /**
2302  * genphy_read_status_fixed - read the link parameters for !aneg mode
2303  * @phydev: target phy_device struct
2304  *
2305  * Read the current duplex and speed state for a PHY operating with
2306  * autonegotiation disabled.
2307  */
2308 int genphy_read_status_fixed(struct phy_device *phydev)
2309 {
2310         int bmcr = phy_read(phydev, MII_BMCR);
2311
2312         if (bmcr < 0)
2313                 return bmcr;
2314
2315         if (bmcr & BMCR_FULLDPLX)
2316                 phydev->duplex = DUPLEX_FULL;
2317         else
2318                 phydev->duplex = DUPLEX_HALF;
2319
2320         if (bmcr & BMCR_SPEED1000)
2321                 phydev->speed = SPEED_1000;
2322         else if (bmcr & BMCR_SPEED100)
2323                 phydev->speed = SPEED_100;
2324         else
2325                 phydev->speed = SPEED_10;
2326
2327         return 0;
2328 }
2329 EXPORT_SYMBOL(genphy_read_status_fixed);
2330
2331 /**
2332  * genphy_read_status - check the link status and update current link state
2333  * @phydev: target phy_device struct
2334  *
2335  * Description: Check the link, then figure out the current state
2336  *   by comparing what we advertise with what the link partner
2337  *   advertises.  Start by checking the gigabit possibilities,
2338  *   then move on to 10/100.
2339  */
2340 int genphy_read_status(struct phy_device *phydev)
2341 {
2342         int err, old_link = phydev->link;
2343
2344         /* Update the link, but return if there was an error */
2345         err = genphy_update_link(phydev);
2346         if (err)
2347                 return err;
2348
2349         /* why bother the PHY if nothing can have changed */
2350         if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2351                 return 0;
2352
2353         phydev->speed = SPEED_UNKNOWN;
2354         phydev->duplex = DUPLEX_UNKNOWN;
2355         phydev->pause = 0;
2356         phydev->asym_pause = 0;
2357
2358         err = genphy_read_master_slave(phydev);
2359         if (err < 0)
2360                 return err;
2361
2362         err = genphy_read_lpa(phydev);
2363         if (err < 0)
2364                 return err;
2365
2366         if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2367                 phy_resolve_aneg_linkmode(phydev);
2368         } else if (phydev->autoneg == AUTONEG_DISABLE) {
2369                 err = genphy_read_status_fixed(phydev);
2370                 if (err < 0)
2371                         return err;
2372         }
2373
2374         return 0;
2375 }
2376 EXPORT_SYMBOL(genphy_read_status);
2377
2378 /**
2379  * genphy_c37_read_status - check the link status and update current link state
2380  * @phydev: target phy_device struct
2381  *
2382  * Description: Check the link, then figure out the current state
2383  *   by comparing what we advertise with what the link partner
2384  *   advertises. This function is for Clause 37 1000Base-X mode.
2385  */
2386 int genphy_c37_read_status(struct phy_device *phydev)
2387 {
2388         int lpa, err, old_link = phydev->link;
2389
2390         /* Update the link, but return if there was an error */
2391         err = genphy_update_link(phydev);
2392         if (err)
2393                 return err;
2394
2395         /* why bother the PHY if nothing can have changed */
2396         if (phydev->autoneg == AUTONEG_ENABLE && old_link && phydev->link)
2397                 return 0;
2398
2399         phydev->duplex = DUPLEX_UNKNOWN;
2400         phydev->pause = 0;
2401         phydev->asym_pause = 0;
2402
2403         if (phydev->autoneg == AUTONEG_ENABLE && phydev->autoneg_complete) {
2404                 lpa = phy_read(phydev, MII_LPA);
2405                 if (lpa < 0)
2406                         return lpa;
2407
2408                 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2409                                  phydev->lp_advertising, lpa & LPA_LPACK);
2410                 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2411                                  phydev->lp_advertising, lpa & LPA_1000XFULL);
2412                 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2413                                  phydev->lp_advertising, lpa & LPA_1000XPAUSE);
2414                 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2415                                  phydev->lp_advertising,
2416                                  lpa & LPA_1000XPAUSE_ASYM);
2417
2418                 phy_resolve_aneg_linkmode(phydev);
2419         } else if (phydev->autoneg == AUTONEG_DISABLE) {
2420                 int bmcr = phy_read(phydev, MII_BMCR);
2421
2422                 if (bmcr < 0)
2423                         return bmcr;
2424
2425                 if (bmcr & BMCR_FULLDPLX)
2426                         phydev->duplex = DUPLEX_FULL;
2427                 else
2428                         phydev->duplex = DUPLEX_HALF;
2429         }
2430
2431         return 0;
2432 }
2433 EXPORT_SYMBOL(genphy_c37_read_status);
2434
2435 /**
2436  * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
2437  * @phydev: target phy_device struct
2438  *
2439  * Description: Perform a software PHY reset using the standard
2440  * BMCR_RESET bit and poll for the reset bit to be cleared.
2441  *
2442  * Returns: 0 on success, < 0 on failure
2443  */
2444 int genphy_soft_reset(struct phy_device *phydev)
2445 {
2446         u16 res = BMCR_RESET;
2447         int ret;
2448
2449         if (phydev->autoneg == AUTONEG_ENABLE)
2450                 res |= BMCR_ANRESTART;
2451
2452         ret = phy_modify(phydev, MII_BMCR, BMCR_ISOLATE, res);
2453         if (ret < 0)
2454                 return ret;
2455
2456         /* Clause 22 states that setting bit BMCR_RESET sets control registers
2457          * to their default value. Therefore the POWER DOWN bit is supposed to
2458          * be cleared after soft reset.
2459          */
2460         phydev->suspended = 0;
2461
2462         ret = phy_poll_reset(phydev);
2463         if (ret)
2464                 return ret;
2465
2466         /* BMCR may be reset to defaults */
2467         if (phydev->autoneg == AUTONEG_DISABLE)
2468                 ret = genphy_setup_forced(phydev);
2469
2470         return ret;
2471 }
2472 EXPORT_SYMBOL(genphy_soft_reset);
2473
2474 irqreturn_t genphy_handle_interrupt_no_ack(struct phy_device *phydev)
2475 {
2476         /* It seems there are cases where the interrupts are handled by another
2477          * entity (ie an IRQ controller embedded inside the PHY) and do not
2478          * need any other interraction from phylib. In this case, just trigger
2479          * the state machine directly.
2480          */
2481         phy_trigger_machine(phydev);
2482
2483         return 0;
2484 }
2485 EXPORT_SYMBOL(genphy_handle_interrupt_no_ack);
2486
2487 /**
2488  * genphy_read_abilities - read PHY abilities from Clause 22 registers
2489  * @phydev: target phy_device struct
2490  *
2491  * Description: Reads the PHY's abilities and populates
2492  * phydev->supported accordingly.
2493  *
2494  * Returns: 0 on success, < 0 on failure
2495  */
2496 int genphy_read_abilities(struct phy_device *phydev)
2497 {
2498         int val;
2499
2500         linkmode_set_bit_array(phy_basic_ports_array,
2501                                ARRAY_SIZE(phy_basic_ports_array),
2502                                phydev->supported);
2503
2504         val = phy_read(phydev, MII_BMSR);
2505         if (val < 0)
2506                 return val;
2507
2508         linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported,
2509                          val & BMSR_ANEGCAPABLE);
2510
2511         linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, phydev->supported,
2512                          val & BMSR_100FULL);
2513         linkmode_mod_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, phydev->supported,
2514                          val & BMSR_100HALF);
2515         linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, phydev->supported,
2516                          val & BMSR_10FULL);
2517         linkmode_mod_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, phydev->supported,
2518                          val & BMSR_10HALF);
2519
2520         if (val & BMSR_ESTATEN) {
2521                 val = phy_read(phydev, MII_ESTATUS);
2522                 if (val < 0)
2523                         return val;
2524
2525                 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2526                                  phydev->supported, val & ESTATUS_1000_TFULL);
2527                 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2528                                  phydev->supported, val & ESTATUS_1000_THALF);
2529                 linkmode_mod_bit(ETHTOOL_LINK_MODE_1000baseX_Full_BIT,
2530                                  phydev->supported, val & ESTATUS_1000_XFULL);
2531         }
2532
2533         return 0;
2534 }
2535 EXPORT_SYMBOL(genphy_read_abilities);
2536
2537 /* This is used for the phy device which doesn't support the MMD extended
2538  * register access, but it does have side effect when we are trying to access
2539  * the MMD register via indirect method.
2540  */
2541 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
2542 {
2543         return -EOPNOTSUPP;
2544 }
2545 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
2546
2547 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
2548                                  u16 regnum, u16 val)
2549 {
2550         return -EOPNOTSUPP;
2551 }
2552 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
2553
2554 int genphy_suspend(struct phy_device *phydev)
2555 {
2556         return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
2557 }
2558 EXPORT_SYMBOL(genphy_suspend);
2559
2560 int genphy_resume(struct phy_device *phydev)
2561 {
2562         return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
2563 }
2564 EXPORT_SYMBOL(genphy_resume);
2565
2566 int genphy_loopback(struct phy_device *phydev, bool enable)
2567 {
2568         if (enable) {
2569                 u16 val, ctl = BMCR_LOOPBACK;
2570                 int ret;
2571
2572                 if (phydev->speed == SPEED_1000)
2573                         ctl |= BMCR_SPEED1000;
2574                 else if (phydev->speed == SPEED_100)
2575                         ctl |= BMCR_SPEED100;
2576
2577                 if (phydev->duplex == DUPLEX_FULL)
2578                         ctl |= BMCR_FULLDPLX;
2579
2580                 phy_modify(phydev, MII_BMCR, ~0, ctl);
2581
2582                 ret = phy_read_poll_timeout(phydev, MII_BMSR, val,
2583                                             val & BMSR_LSTATUS,
2584                                     5000, 500000, true);
2585                 if (ret)
2586                         return ret;
2587         } else {
2588                 phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK, 0);
2589
2590                 phy_config_aneg(phydev);
2591         }
2592
2593         return 0;
2594 }
2595 EXPORT_SYMBOL(genphy_loopback);
2596
2597 /**
2598  * phy_remove_link_mode - Remove a supported link mode
2599  * @phydev: phy_device structure to remove link mode from
2600  * @link_mode: Link mode to be removed
2601  *
2602  * Description: Some MACs don't support all link modes which the PHY
2603  * does.  e.g. a 1G MAC often does not support 1000Half. Add a helper
2604  * to remove a link mode.
2605  */
2606 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
2607 {
2608         linkmode_clear_bit(link_mode, phydev->supported);
2609         phy_advertise_supported(phydev);
2610 }
2611 EXPORT_SYMBOL(phy_remove_link_mode);
2612
2613 static void phy_copy_pause_bits(unsigned long *dst, unsigned long *src)
2614 {
2615         linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, dst,
2616                 linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, src));
2617         linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, dst,
2618                 linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT, src));
2619 }
2620
2621 /**
2622  * phy_advertise_supported - Advertise all supported modes
2623  * @phydev: target phy_device struct
2624  *
2625  * Description: Called to advertise all supported modes, doesn't touch
2626  * pause mode advertising.
2627  */
2628 void phy_advertise_supported(struct phy_device *phydev)
2629 {
2630         __ETHTOOL_DECLARE_LINK_MODE_MASK(new);
2631
2632         linkmode_copy(new, phydev->supported);
2633         phy_copy_pause_bits(new, phydev->advertising);
2634         linkmode_copy(phydev->advertising, new);
2635 }
2636 EXPORT_SYMBOL(phy_advertise_supported);
2637
2638 /**
2639  * phy_support_sym_pause - Enable support of symmetrical pause
2640  * @phydev: target phy_device struct
2641  *
2642  * Description: Called by the MAC to indicate is supports symmetrical
2643  * Pause, but not asym pause.
2644  */
2645 void phy_support_sym_pause(struct phy_device *phydev)
2646 {
2647         linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
2648         phy_copy_pause_bits(phydev->advertising, phydev->supported);
2649 }
2650 EXPORT_SYMBOL(phy_support_sym_pause);
2651
2652 /**
2653  * phy_support_asym_pause - Enable support of asym pause
2654  * @phydev: target phy_device struct
2655  *
2656  * Description: Called by the MAC to indicate is supports Asym Pause.
2657  */
2658 void phy_support_asym_pause(struct phy_device *phydev)
2659 {
2660         phy_copy_pause_bits(phydev->advertising, phydev->supported);
2661 }
2662 EXPORT_SYMBOL(phy_support_asym_pause);
2663
2664 /**
2665  * phy_set_sym_pause - Configure symmetric Pause
2666  * @phydev: target phy_device struct
2667  * @rx: Receiver Pause is supported
2668  * @tx: Transmit Pause is supported
2669  * @autoneg: Auto neg should be used
2670  *
2671  * Description: Configure advertised Pause support depending on if
2672  * receiver pause and pause auto neg is supported. Generally called
2673  * from the set_pauseparam .ndo.
2674  */
2675 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2676                        bool autoneg)
2677 {
2678         linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2679
2680         if (rx && tx && autoneg)
2681                 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2682                                  phydev->supported);
2683
2684         linkmode_copy(phydev->advertising, phydev->supported);
2685 }
2686 EXPORT_SYMBOL(phy_set_sym_pause);
2687
2688 /**
2689  * phy_set_asym_pause - Configure Pause and Asym Pause
2690  * @phydev: target phy_device struct
2691  * @rx: Receiver Pause is supported
2692  * @tx: Transmit Pause is supported
2693  *
2694  * Description: Configure advertised Pause support depending on if
2695  * transmit and receiver pause is supported. If there has been a
2696  * change in adverting, trigger a new autoneg. Generally called from
2697  * the set_pauseparam .ndo.
2698  */
2699 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2700 {
2701         __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2702
2703         linkmode_copy(oldadv, phydev->advertising);
2704         linkmode_set_pause(phydev->advertising, tx, rx);
2705
2706         if (!linkmode_equal(oldadv, phydev->advertising) &&
2707             phydev->autoneg)
2708                 phy_start_aneg(phydev);
2709 }
2710 EXPORT_SYMBOL(phy_set_asym_pause);
2711
2712 /**
2713  * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2714  * @phydev: phy_device struct
2715  * @pp: requested pause configuration
2716  *
2717  * Description: Test if the PHY/MAC combination supports the Pause
2718  * configuration the user is requesting. Returns True if it is
2719  * supported, false otherwise.
2720  */
2721 bool phy_validate_pause(struct phy_device *phydev,
2722                         struct ethtool_pauseparam *pp)
2723 {
2724         if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2725                                phydev->supported) && pp->rx_pause)
2726                 return false;
2727
2728         if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2729                                phydev->supported) &&
2730             pp->rx_pause != pp->tx_pause)
2731                 return false;
2732
2733         return true;
2734 }
2735 EXPORT_SYMBOL(phy_validate_pause);
2736
2737 /**
2738  * phy_get_pause - resolve negotiated pause modes
2739  * @phydev: phy_device struct
2740  * @tx_pause: pointer to bool to indicate whether transmit pause should be
2741  * enabled.
2742  * @rx_pause: pointer to bool to indicate whether receive pause should be
2743  * enabled.
2744  *
2745  * Resolve and return the flow control modes according to the negotiation
2746  * result. This includes checking that we are operating in full duplex mode.
2747  * See linkmode_resolve_pause() for further details.
2748  */
2749 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
2750 {
2751         if (phydev->duplex != DUPLEX_FULL) {
2752                 *tx_pause = false;
2753                 *rx_pause = false;
2754                 return;
2755         }
2756
2757         return linkmode_resolve_pause(phydev->advertising,
2758                                       phydev->lp_advertising,
2759                                       tx_pause, rx_pause);
2760 }
2761 EXPORT_SYMBOL(phy_get_pause);
2762
2763 #if IS_ENABLED(CONFIG_OF_MDIO)
2764 static int phy_get_int_delay_property(struct device *dev, const char *name)
2765 {
2766         s32 int_delay;
2767         int ret;
2768
2769         ret = device_property_read_u32(dev, name, &int_delay);
2770         if (ret)
2771                 return ret;
2772
2773         return int_delay;
2774 }
2775 #else
2776 static int phy_get_int_delay_property(struct device *dev, const char *name)
2777 {
2778         return -EINVAL;
2779 }
2780 #endif
2781
2782 /**
2783  * phy_get_internal_delay - returns the index of the internal delay
2784  * @phydev: phy_device struct
2785  * @dev: pointer to the devices device struct
2786  * @delay_values: array of delays the PHY supports
2787  * @size: the size of the delay array
2788  * @is_rx: boolean to indicate to get the rx internal delay
2789  *
2790  * Returns the index within the array of internal delay passed in.
2791  * If the device property is not present then the interface type is checked
2792  * if the interface defines use of internal delay then a 1 is returned otherwise
2793  * a 0 is returned.
2794  * The array must be in ascending order. If PHY does not have an ascending order
2795  * array then size = 0 and the value of the delay property is returned.
2796  * Return -EINVAL if the delay is invalid or cannot be found.
2797  */
2798 s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
2799                            const int *delay_values, int size, bool is_rx)
2800 {
2801         s32 delay;
2802         int i;
2803
2804         if (is_rx) {
2805                 delay = phy_get_int_delay_property(dev, "rx-internal-delay-ps");
2806                 if (delay < 0 && size == 0) {
2807                         if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2808                             phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
2809                                 return 1;
2810                         else
2811                                 return 0;
2812                 }
2813
2814         } else {
2815                 delay = phy_get_int_delay_property(dev, "tx-internal-delay-ps");
2816                 if (delay < 0 && size == 0) {
2817                         if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
2818                             phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
2819                                 return 1;
2820                         else
2821                                 return 0;
2822                 }
2823         }
2824
2825         if (delay < 0)
2826                 return delay;
2827
2828         if (delay && size == 0)
2829                 return delay;
2830
2831         if (delay < delay_values[0] || delay > delay_values[size - 1]) {
2832                 phydev_err(phydev, "Delay %d is out of range\n", delay);
2833                 return -EINVAL;
2834         }
2835
2836         if (delay == delay_values[0])
2837                 return 0;
2838
2839         for (i = 1; i < size; i++) {
2840                 if (delay == delay_values[i])
2841                         return i;
2842
2843                 /* Find an approximate index by looking up the table */
2844                 if (delay > delay_values[i - 1] &&
2845                     delay < delay_values[i]) {
2846                         if (delay - delay_values[i - 1] <
2847                             delay_values[i] - delay)
2848                                 return i - 1;
2849                         else
2850                                 return i;
2851                 }
2852         }
2853
2854         phydev_err(phydev, "error finding internal delay index for %d\n",
2855                    delay);
2856
2857         return -EINVAL;
2858 }
2859 EXPORT_SYMBOL(phy_get_internal_delay);
2860
2861 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2862 {
2863         return phydrv->config_intr && phydrv->handle_interrupt;
2864 }
2865
2866 /**
2867  * phy_probe - probe and init a PHY device
2868  * @dev: device to probe and init
2869  *
2870  * Description: Take care of setting up the phy_device structure,
2871  *   set the state to READY (the driver's init function should
2872  *   set it to STARTING if needed).
2873  */
2874 static int phy_probe(struct device *dev)
2875 {
2876         struct phy_device *phydev = to_phy_device(dev);
2877         struct device_driver *drv = phydev->mdio.dev.driver;
2878         struct phy_driver *phydrv = to_phy_driver(drv);
2879         int err = 0;
2880
2881         phydev->drv = phydrv;
2882
2883         /* Disable the interrupt if the PHY doesn't support it
2884          * but the interrupt is still a valid one
2885          */
2886          if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2887                 phydev->irq = PHY_POLL;
2888
2889         if (phydrv->flags & PHY_IS_INTERNAL)
2890                 phydev->is_internal = true;
2891
2892         mutex_lock(&phydev->lock);
2893
2894         /* Deassert the reset signal */
2895         phy_device_reset(phydev, 0);
2896
2897         if (phydev->drv->probe) {
2898                 err = phydev->drv->probe(phydev);
2899                 if (err)
2900                         goto out;
2901         }
2902
2903         /* Start out supporting everything. Eventually,
2904          * a controller will attach, and may modify one
2905          * or both of these values
2906          */
2907         if (phydrv->features) {
2908                 linkmode_copy(phydev->supported, phydrv->features);
2909         } else if (phydrv->get_features) {
2910                 err = phydrv->get_features(phydev);
2911         } else if (phydev->is_c45) {
2912                 err = genphy_c45_pma_read_abilities(phydev);
2913         } else {
2914                 err = genphy_read_abilities(phydev);
2915         }
2916
2917         if (err)
2918                 goto out;
2919
2920         if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
2921                                phydev->supported))
2922                 phydev->autoneg = 0;
2923
2924         if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
2925                               phydev->supported))
2926                 phydev->is_gigabit_capable = 1;
2927         if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
2928                               phydev->supported))
2929                 phydev->is_gigabit_capable = 1;
2930
2931         of_set_phy_supported(phydev);
2932         phy_advertise_supported(phydev);
2933
2934         /* Get the EEE modes we want to prohibit. We will ask
2935          * the PHY stop advertising these mode later on
2936          */
2937         of_set_phy_eee_broken(phydev);
2938
2939         /* The Pause Frame bits indicate that the PHY can support passing
2940          * pause frames. During autonegotiation, the PHYs will determine if
2941          * they should allow pause frames to pass.  The MAC driver should then
2942          * use that result to determine whether to enable flow control via
2943          * pause frames.
2944          *
2945          * Normally, PHY drivers should not set the Pause bits, and instead
2946          * allow phylib to do that.  However, there may be some situations
2947          * (e.g. hardware erratum) where the driver wants to set only one
2948          * of these bits.
2949          */
2950         if (!test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported) &&
2951             !test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported)) {
2952                 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2953                                  phydev->supported);
2954                 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2955                                  phydev->supported);
2956         }
2957
2958         /* Set the state to READY by default */
2959         phydev->state = PHY_READY;
2960
2961 out:
2962         /* Assert the reset signal */
2963         if (err)
2964                 phy_device_reset(phydev, 1);
2965
2966         mutex_unlock(&phydev->lock);
2967
2968         return err;
2969 }
2970
2971 static int phy_remove(struct device *dev)
2972 {
2973         struct phy_device *phydev = to_phy_device(dev);
2974
2975         cancel_delayed_work_sync(&phydev->state_queue);
2976
2977         mutex_lock(&phydev->lock);
2978         phydev->state = PHY_DOWN;
2979         mutex_unlock(&phydev->lock);
2980
2981         sfp_bus_del_upstream(phydev->sfp_bus);
2982         phydev->sfp_bus = NULL;
2983
2984         if (phydev->drv && phydev->drv->remove)
2985                 phydev->drv->remove(phydev);
2986
2987         /* Assert the reset signal */
2988         phy_device_reset(phydev, 1);
2989
2990         phydev->drv = NULL;
2991
2992         return 0;
2993 }
2994
2995 static void phy_shutdown(struct device *dev)
2996 {
2997         struct phy_device *phydev = to_phy_device(dev);
2998
2999         phy_disable_interrupts(phydev);
3000 }
3001
3002 /**
3003  * phy_driver_register - register a phy_driver with the PHY layer
3004  * @new_driver: new phy_driver to register
3005  * @owner: module owning this PHY
3006  */
3007 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
3008 {
3009         int retval;
3010
3011         /* Either the features are hard coded, or dynamically
3012          * determined. It cannot be both.
3013          */
3014         if (WARN_ON(new_driver->features && new_driver->get_features)) {
3015                 pr_err("%s: features and get_features must not both be set\n",
3016                        new_driver->name);
3017                 return -EINVAL;
3018         }
3019
3020         new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
3021         new_driver->mdiodrv.driver.name = new_driver->name;
3022         new_driver->mdiodrv.driver.bus = &mdio_bus_type;
3023         new_driver->mdiodrv.driver.probe = phy_probe;
3024         new_driver->mdiodrv.driver.remove = phy_remove;
3025         new_driver->mdiodrv.driver.shutdown = phy_shutdown;
3026         new_driver->mdiodrv.driver.owner = owner;
3027         new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
3028
3029         retval = driver_register(&new_driver->mdiodrv.driver);
3030         if (retval) {
3031                 pr_err("%s: Error %d in registering driver\n",
3032                        new_driver->name, retval);
3033
3034                 return retval;
3035         }
3036
3037         pr_debug("%s: Registered new driver\n", new_driver->name);
3038
3039         return 0;
3040 }
3041 EXPORT_SYMBOL(phy_driver_register);
3042
3043 int phy_drivers_register(struct phy_driver *new_driver, int n,
3044                          struct module *owner)
3045 {
3046         int i, ret = 0;
3047
3048         for (i = 0; i < n; i++) {
3049                 ret = phy_driver_register(new_driver + i, owner);
3050                 if (ret) {
3051                         while (i-- > 0)
3052                                 phy_driver_unregister(new_driver + i);
3053                         break;
3054                 }
3055         }
3056         return ret;
3057 }
3058 EXPORT_SYMBOL(phy_drivers_register);
3059
3060 void phy_driver_unregister(struct phy_driver *drv)
3061 {
3062         driver_unregister(&drv->mdiodrv.driver);
3063 }
3064 EXPORT_SYMBOL(phy_driver_unregister);
3065
3066 void phy_drivers_unregister(struct phy_driver *drv, int n)
3067 {
3068         int i;
3069
3070         for (i = 0; i < n; i++)
3071                 phy_driver_unregister(drv + i);
3072 }
3073 EXPORT_SYMBOL(phy_drivers_unregister);
3074
3075 static struct phy_driver genphy_driver = {
3076         .phy_id         = 0xffffffff,
3077         .phy_id_mask    = 0xffffffff,
3078         .name           = "Generic PHY",
3079         .get_features   = genphy_read_abilities,
3080         .suspend        = genphy_suspend,
3081         .resume         = genphy_resume,
3082         .set_loopback   = genphy_loopback,
3083 };
3084
3085 static const struct ethtool_phy_ops phy_ethtool_phy_ops = {
3086         .get_sset_count         = phy_ethtool_get_sset_count,
3087         .get_strings            = phy_ethtool_get_strings,
3088         .get_stats              = phy_ethtool_get_stats,
3089         .start_cable_test       = phy_start_cable_test,
3090         .start_cable_test_tdr   = phy_start_cable_test_tdr,
3091 };
3092
3093 static int __init phy_init(void)
3094 {
3095         int rc;
3096
3097         rc = mdio_bus_init();
3098         if (rc)
3099                 return rc;
3100
3101         ethtool_set_ethtool_phy_ops(&phy_ethtool_phy_ops);
3102         features_init();
3103
3104         rc = phy_driver_register(&genphy_c45_driver, THIS_MODULE);
3105         if (rc)
3106                 goto err_c45;
3107
3108         rc = phy_driver_register(&genphy_driver, THIS_MODULE);
3109         if (rc) {
3110                 phy_driver_unregister(&genphy_c45_driver);
3111 err_c45:
3112                 mdio_bus_exit();
3113         }
3114
3115         return rc;
3116 }
3117
3118 static void __exit phy_exit(void)
3119 {
3120         phy_driver_unregister(&genphy_c45_driver);
3121         phy_driver_unregister(&genphy_driver);
3122         mdio_bus_exit();
3123         ethtool_set_ethtool_phy_ops(NULL);
3124 }
3125
3126 subsys_initcall(phy_init);
3127 module_exit(phy_exit);