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