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