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