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