crash in md-raid1 and md-raid10 due to incorrect list manipulation
[linux-drm-fsl-dcu.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/mdio.h>
34 #include <linux/io.h>
35 #include <linux/uaccess.h>
36 #include <linux/of.h>
37
38 #include <asm/irq.h>
39
40 MODULE_DESCRIPTION("PHY library");
41 MODULE_AUTHOR("Andy Fleming");
42 MODULE_LICENSE("GPL");
43
44 void phy_device_free(struct phy_device *phydev)
45 {
46         put_device(&phydev->dev);
47 }
48 EXPORT_SYMBOL(phy_device_free);
49
50 static void phy_device_release(struct device *dev)
51 {
52         kfree(to_phy_device(dev));
53 }
54
55 enum genphy_driver {
56         GENPHY_DRV_1G,
57         GENPHY_DRV_10G,
58         GENPHY_DRV_MAX
59 };
60
61 static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
62
63 static LIST_HEAD(phy_fixup_list);
64 static DEFINE_MUTEX(phy_fixup_lock);
65
66 /**
67  * phy_register_fixup - creates a new phy_fixup and adds it to the list
68  * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
69  * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
70  *      It can also be PHY_ANY_UID
71  * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
72  *      comparison
73  * @run: The actual code to be run when a matching PHY is found
74  */
75 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
76                        int (*run)(struct phy_device *))
77 {
78         struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
79
80         if (!fixup)
81                 return -ENOMEM;
82
83         strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
84         fixup->phy_uid = phy_uid;
85         fixup->phy_uid_mask = phy_uid_mask;
86         fixup->run = run;
87
88         mutex_lock(&phy_fixup_lock);
89         list_add_tail(&fixup->list, &phy_fixup_list);
90         mutex_unlock(&phy_fixup_lock);
91
92         return 0;
93 }
94 EXPORT_SYMBOL(phy_register_fixup);
95
96 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
97 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
98                                int (*run)(struct phy_device *))
99 {
100         return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
101 }
102 EXPORT_SYMBOL(phy_register_fixup_for_uid);
103
104 /* Registers a fixup to be run on the PHY with id string bus_id */
105 int phy_register_fixup_for_id(const char *bus_id,
106                               int (*run)(struct phy_device *))
107 {
108         return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
109 }
110 EXPORT_SYMBOL(phy_register_fixup_for_id);
111
112 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
113  * Fixups can be set to match any in one or more fields.
114  */
115 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
116 {
117         if (strcmp(fixup->bus_id, dev_name(&phydev->dev)) != 0)
118                 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
119                         return 0;
120
121         if ((fixup->phy_uid & fixup->phy_uid_mask) !=
122             (phydev->phy_id & fixup->phy_uid_mask))
123                 if (fixup->phy_uid != PHY_ANY_UID)
124                         return 0;
125
126         return 1;
127 }
128
129 /* Runs any matching fixups for this phydev */
130 static int phy_scan_fixups(struct phy_device *phydev)
131 {
132         struct phy_fixup *fixup;
133
134         mutex_lock(&phy_fixup_lock);
135         list_for_each_entry(fixup, &phy_fixup_list, list) {
136                 if (phy_needs_fixup(phydev, fixup)) {
137                         int err = fixup->run(phydev);
138
139                         if (err < 0) {
140                                 mutex_unlock(&phy_fixup_lock);
141                                 return err;
142                         }
143                         phydev->has_fixups = true;
144                 }
145         }
146         mutex_unlock(&phy_fixup_lock);
147
148         return 0;
149 }
150
151 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
152                                      bool is_c45,
153                                      struct phy_c45_device_ids *c45_ids)
154 {
155         struct phy_device *dev;
156
157         /* We allocate the device, and initialize the default values */
158         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
159         if (!dev)
160                 return ERR_PTR(-ENOMEM);
161
162         dev->dev.release = phy_device_release;
163
164         dev->speed = 0;
165         dev->duplex = -1;
166         dev->pause = 0;
167         dev->asym_pause = 0;
168         dev->link = 1;
169         dev->interface = PHY_INTERFACE_MODE_GMII;
170
171         dev->autoneg = AUTONEG_ENABLE;
172
173         dev->is_c45 = is_c45;
174         dev->addr = addr;
175         dev->phy_id = phy_id;
176         if (c45_ids)
177                 dev->c45_ids = *c45_ids;
178         dev->bus = bus;
179         dev->dev.parent = &bus->dev;
180         dev->dev.bus = &mdio_bus_type;
181         dev->irq = bus->irq ? bus->irq[addr] : PHY_POLL;
182         dev_set_name(&dev->dev, PHY_ID_FMT, bus->id, addr);
183
184         dev->state = PHY_DOWN;
185
186         mutex_init(&dev->lock);
187         INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
188         INIT_WORK(&dev->phy_queue, phy_change);
189
190         /* Request the appropriate module unconditionally; don't
191          * bother trying to do so only if it isn't already loaded,
192          * because that gets complicated. A hotplug event would have
193          * done an unconditional modprobe anyway.
194          * We don't do normal hotplug because it won't work for MDIO
195          * -- because it relies on the device staying around for long
196          * enough for the driver to get loaded. With MDIO, the NIC
197          * driver will get bored and give up as soon as it finds that
198          * there's no driver _already_ loaded.
199          */
200         request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
201
202         device_initialize(&dev->dev);
203
204         return dev;
205 }
206 EXPORT_SYMBOL(phy_device_create);
207
208 /**
209  * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
210  * @bus: the target MII bus
211  * @addr: PHY address on the MII bus
212  * @phy_id: where to store the ID retrieved.
213  * @c45_ids: where to store the c45 ID information.
214  *
215  *   If the PHY devices-in-package appears to be valid, it and the
216  *   corresponding identifiers are stored in @c45_ids, zero is stored
217  *   in @phy_id.  Otherwise 0xffffffff is stored in @phy_id.  Returns
218  *   zero on success.
219  *
220  */
221 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
222                            struct phy_c45_device_ids *c45_ids) {
223         int phy_reg;
224         int i, reg_addr;
225         const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
226
227         /* Find first non-zero Devices In package.  Device
228          * zero is reserved, so don't probe it.
229          */
230         for (i = 1;
231              i < num_ids && c45_ids->devices_in_package == 0;
232              i++) {
233 retry:          reg_addr = MII_ADDR_C45 | i << 16 | MDIO_DEVS2;
234                 phy_reg = mdiobus_read(bus, addr, reg_addr);
235                 if (phy_reg < 0)
236                         return -EIO;
237                 c45_ids->devices_in_package = (phy_reg & 0xffff) << 16;
238
239                 reg_addr = MII_ADDR_C45 | i << 16 | MDIO_DEVS1;
240                 phy_reg = mdiobus_read(bus, addr, reg_addr);
241                 if (phy_reg < 0)
242                         return -EIO;
243                 c45_ids->devices_in_package |= (phy_reg & 0xffff);
244
245                 if ((c45_ids->devices_in_package & 0x1fffffff) == 0x1fffffff) {
246                         if (i) {
247                                 /*  If mostly Fs, there is no device there,
248                                  *  then let's continue to probe more, as some
249                                  *  10G PHYs have zero Devices In package,
250                                  *  e.g. Cortina CS4315/CS4340 PHY.
251                                  */
252                                 i = 0;
253                                 goto retry;
254                         } else {
255                                 /* no device there, let's get out of here */
256                                 *phy_id = 0xffffffff;
257                                 return 0;
258                         }
259                 }
260         }
261
262         /* Now probe Device Identifiers for each device present. */
263         for (i = 1; i < num_ids; i++) {
264                 if (!(c45_ids->devices_in_package & (1 << i)))
265                         continue;
266
267                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
268                 phy_reg = mdiobus_read(bus, addr, reg_addr);
269                 if (phy_reg < 0)
270                         return -EIO;
271                 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
272
273                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
274                 phy_reg = mdiobus_read(bus, addr, reg_addr);
275                 if (phy_reg < 0)
276                         return -EIO;
277                 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
278         }
279         *phy_id = 0;
280         return 0;
281 }
282
283 /**
284  * get_phy_id - reads the specified addr for its ID.
285  * @bus: the target MII bus
286  * @addr: PHY address on the MII bus
287  * @phy_id: where to store the ID retrieved.
288  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
289  * @c45_ids: where to store the c45 ID information.
290  *
291  * Description: In the case of a 802.3-c22 PHY, reads the ID registers
292  *   of the PHY at @addr on the @bus, stores it in @phy_id and returns
293  *   zero on success.
294  *
295  *   In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
296  *   its return value is in turn returned.
297  *
298  */
299 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
300                       bool is_c45, struct phy_c45_device_ids *c45_ids)
301 {
302         int phy_reg;
303
304         if (is_c45)
305                 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
306
307         /* Grab the bits from PHYIR1, and put them in the upper half */
308         phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
309         if (phy_reg < 0)
310                 return -EIO;
311
312         *phy_id = (phy_reg & 0xffff) << 16;
313
314         /* Grab the bits from PHYIR2, and put them in the lower half */
315         phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
316         if (phy_reg < 0)
317                 return -EIO;
318
319         *phy_id |= (phy_reg & 0xffff);
320
321         return 0;
322 }
323
324 /**
325  * get_phy_device - reads the specified PHY device and returns its @phy_device
326  *                  struct
327  * @bus: the target MII bus
328  * @addr: PHY address on the MII bus
329  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
330  *
331  * Description: Reads the ID registers of the PHY at @addr on the
332  *   @bus, then allocates and returns the phy_device to represent it.
333  */
334 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
335 {
336         struct phy_c45_device_ids c45_ids = {0};
337         u32 phy_id = 0;
338         int r;
339
340         r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
341         if (r)
342                 return ERR_PTR(r);
343
344         /* If the phy_id is mostly Fs, there is no device there */
345         if ((phy_id & 0x1fffffff) == 0x1fffffff)
346                 return NULL;
347
348         return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
349 }
350 EXPORT_SYMBOL(get_phy_device);
351
352 /**
353  * phy_device_register - Register the phy device on the MDIO bus
354  * @phydev: phy_device structure to be added to the MDIO bus
355  */
356 int phy_device_register(struct phy_device *phydev)
357 {
358         int err;
359
360         /* Don't register a phy if one is already registered at this address */
361         if (phydev->bus->phy_map[phydev->addr])
362                 return -EINVAL;
363         phydev->bus->phy_map[phydev->addr] = phydev;
364
365         /* Run all of the fixups for this PHY */
366         err = phy_scan_fixups(phydev);
367         if (err) {
368                 pr_err("PHY %d failed to initialize\n", phydev->addr);
369                 goto out;
370         }
371
372         err = device_add(&phydev->dev);
373         if (err) {
374                 pr_err("PHY %d failed to add\n", phydev->addr);
375                 goto out;
376         }
377
378         return 0;
379
380  out:
381         phydev->bus->phy_map[phydev->addr] = NULL;
382         return err;
383 }
384 EXPORT_SYMBOL(phy_device_register);
385
386 /**
387  * phy_find_first - finds the first PHY device on the bus
388  * @bus: the target MII bus
389  */
390 struct phy_device *phy_find_first(struct mii_bus *bus)
391 {
392         int addr;
393
394         for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
395                 if (bus->phy_map[addr])
396                         return bus->phy_map[addr];
397         }
398         return NULL;
399 }
400 EXPORT_SYMBOL(phy_find_first);
401
402 /**
403  * phy_prepare_link - prepares the PHY layer to monitor link status
404  * @phydev: target phy_device struct
405  * @handler: callback function for link status change notifications
406  *
407  * Description: Tells the PHY infrastructure to handle the
408  *   gory details on monitoring link status (whether through
409  *   polling or an interrupt), and to call back to the
410  *   connected device driver when the link status changes.
411  *   If you want to monitor your own link state, don't call
412  *   this function.
413  */
414 static void phy_prepare_link(struct phy_device *phydev,
415                              void (*handler)(struct net_device *))
416 {
417         phydev->adjust_link = handler;
418 }
419
420 /**
421  * phy_connect_direct - connect an ethernet device to a specific phy_device
422  * @dev: the network device to connect
423  * @phydev: the pointer to the phy device
424  * @handler: callback function for state change notifications
425  * @interface: PHY device's interface
426  */
427 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
428                        void (*handler)(struct net_device *),
429                        phy_interface_t interface)
430 {
431         int rc;
432
433         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
434         if (rc)
435                 return rc;
436
437         phy_prepare_link(phydev, handler);
438         phy_start_machine(phydev);
439         if (phydev->irq > 0)
440                 phy_start_interrupts(phydev);
441
442         return 0;
443 }
444 EXPORT_SYMBOL(phy_connect_direct);
445
446 /**
447  * phy_connect - connect an ethernet device to a PHY device
448  * @dev: the network device to connect
449  * @bus_id: the id string of the PHY device to connect
450  * @handler: callback function for state change notifications
451  * @interface: PHY device's interface
452  *
453  * Description: Convenience function for connecting ethernet
454  *   devices to PHY devices.  The default behavior is for
455  *   the PHY infrastructure to handle everything, and only notify
456  *   the connected driver when the link status changes.  If you
457  *   don't want, or can't use the provided functionality, you may
458  *   choose to call only the subset of functions which provide
459  *   the desired functionality.
460  */
461 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
462                                void (*handler)(struct net_device *),
463                                phy_interface_t interface)
464 {
465         struct phy_device *phydev;
466         struct device *d;
467         int rc;
468
469         /* Search the list of PHY devices on the mdio bus for the
470          * PHY with the requested name
471          */
472         d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
473         if (!d) {
474                 pr_err("PHY %s not found\n", bus_id);
475                 return ERR_PTR(-ENODEV);
476         }
477         phydev = to_phy_device(d);
478
479         rc = phy_connect_direct(dev, phydev, handler, interface);
480         if (rc)
481                 return ERR_PTR(rc);
482
483         return phydev;
484 }
485 EXPORT_SYMBOL(phy_connect);
486
487 /**
488  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
489  *                  device
490  * @phydev: target phy_device struct
491  */
492 void phy_disconnect(struct phy_device *phydev)
493 {
494         if (phydev->irq > 0)
495                 phy_stop_interrupts(phydev);
496
497         phy_stop_machine(phydev);
498
499         phydev->adjust_link = NULL;
500
501         phy_detach(phydev);
502 }
503 EXPORT_SYMBOL(phy_disconnect);
504
505 /**
506  * phy_poll_reset - Safely wait until a PHY reset has properly completed
507  * @phydev: The PHY device to poll
508  *
509  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
510  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
511  *   register must be polled until the BMCR_RESET bit clears.
512  *
513  *   Furthermore, any attempts to write to PHY registers may have no effect
514  *   or even generate MDIO bus errors until this is complete.
515  *
516  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
517  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
518  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
519  *   effort to support such broken PHYs, this function is separate from the
520  *   standard phy_init_hw() which will zero all the other bits in the BMCR
521  *   and reapply all driver-specific and board-specific fixups.
522  */
523 static int phy_poll_reset(struct phy_device *phydev)
524 {
525         /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
526         unsigned int retries = 12;
527         int ret;
528
529         do {
530                 msleep(50);
531                 ret = phy_read(phydev, MII_BMCR);
532                 if (ret < 0)
533                         return ret;
534         } while (ret & BMCR_RESET && --retries);
535         if (ret & BMCR_RESET)
536                 return -ETIMEDOUT;
537
538         /* Some chips (smsc911x) may still need up to another 1ms after the
539          * BMCR_RESET bit is cleared before they are usable.
540          */
541         msleep(1);
542         return 0;
543 }
544
545 int phy_init_hw(struct phy_device *phydev)
546 {
547         int ret = 0;
548
549         if (!phydev->drv || !phydev->drv->config_init)
550                 return 0;
551
552         if (phydev->drv->soft_reset)
553                 ret = phydev->drv->soft_reset(phydev);
554         else
555                 ret = genphy_soft_reset(phydev);
556
557         if (ret < 0)
558                 return ret;
559
560         ret = phy_scan_fixups(phydev);
561         if (ret < 0)
562                 return ret;
563
564         return phydev->drv->config_init(phydev);
565 }
566 EXPORT_SYMBOL(phy_init_hw);
567
568 /**
569  * phy_attach_direct - attach a network device to a given PHY device pointer
570  * @dev: network device to attach
571  * @phydev: Pointer to phy_device to attach
572  * @flags: PHY device's dev_flags
573  * @interface: PHY device's interface
574  *
575  * Description: Called by drivers to attach to a particular PHY
576  *     device. The phy_device is found, and properly hooked up
577  *     to the phy_driver.  If no driver is attached, then a
578  *     generic driver is used.  The phy_device is given a ptr to
579  *     the attaching device, and given a callback for link status
580  *     change.  The phy_device is returned to the attaching driver.
581  */
582 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
583                       u32 flags, phy_interface_t interface)
584 {
585         struct device *d = &phydev->dev;
586         struct module *bus_module;
587         int err;
588
589         /* Assume that if there is no driver, that it doesn't
590          * exist, and we should use the genphy driver.
591          */
592         if (!d->driver) {
593                 if (phydev->is_c45)
594                         d->driver = &genphy_driver[GENPHY_DRV_10G].driver;
595                 else
596                         d->driver = &genphy_driver[GENPHY_DRV_1G].driver;
597
598                 err = d->driver->probe(d);
599                 if (err >= 0)
600                         err = device_bind_driver(d);
601
602                 if (err)
603                         return err;
604         }
605
606         if (phydev->attached_dev) {
607                 dev_err(&dev->dev, "PHY already attached\n");
608                 return -EBUSY;
609         }
610
611         /* Increment the bus module reference count */
612         bus_module = phydev->bus->dev.driver ?
613                      phydev->bus->dev.driver->owner : NULL;
614         if (!try_module_get(bus_module)) {
615                 dev_err(&dev->dev, "failed to get the bus module\n");
616                 return -EIO;
617         }
618
619         phydev->attached_dev = dev;
620         dev->phydev = phydev;
621
622         phydev->dev_flags = flags;
623
624         phydev->interface = interface;
625
626         phydev->state = PHY_READY;
627
628         /* Do initial configuration here, now that
629          * we have certain key parameters
630          * (dev_flags and interface)
631          */
632         err = phy_init_hw(phydev);
633         if (err)
634                 phy_detach(phydev);
635         else
636                 phy_resume(phydev);
637
638         return err;
639 }
640 EXPORT_SYMBOL(phy_attach_direct);
641
642 /**
643  * phy_attach - attach a network device to a particular PHY device
644  * @dev: network device to attach
645  * @bus_id: Bus ID of PHY device to attach
646  * @interface: PHY device's interface
647  *
648  * Description: Same as phy_attach_direct() except that a PHY bus_id
649  *     string is passed instead of a pointer to a struct phy_device.
650  */
651 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
652                               phy_interface_t interface)
653 {
654         struct bus_type *bus = &mdio_bus_type;
655         struct phy_device *phydev;
656         struct device *d;
657         int rc;
658
659         /* Search the list of PHY devices on the mdio bus for the
660          * PHY with the requested name
661          */
662         d = bus_find_device_by_name(bus, NULL, bus_id);
663         if (!d) {
664                 pr_err("PHY %s not found\n", bus_id);
665                 return ERR_PTR(-ENODEV);
666         }
667         phydev = to_phy_device(d);
668
669         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
670         if (rc)
671                 return ERR_PTR(rc);
672
673         return phydev;
674 }
675 EXPORT_SYMBOL(phy_attach);
676
677 /**
678  * phy_detach - detach a PHY device from its network device
679  * @phydev: target phy_device struct
680  */
681 void phy_detach(struct phy_device *phydev)
682 {
683         int i;
684
685         if (phydev->bus->dev.driver)
686                 module_put(phydev->bus->dev.driver->owner);
687
688         phydev->attached_dev->phydev = NULL;
689         phydev->attached_dev = NULL;
690         phy_suspend(phydev);
691
692         /* If the device had no specific driver before (i.e. - it
693          * was using the generic driver), we unbind the device
694          * from the generic driver so that there's a chance a
695          * real driver could be loaded
696          */
697         for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
698                 if (phydev->dev.driver == &genphy_driver[i].driver) {
699                         device_release_driver(&phydev->dev);
700                         break;
701                 }
702         }
703 }
704 EXPORT_SYMBOL(phy_detach);
705
706 int phy_suspend(struct phy_device *phydev)
707 {
708         struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
709         struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
710         int ret = 0;
711
712         /* If the device has WOL enabled, we cannot suspend the PHY */
713         phy_ethtool_get_wol(phydev, &wol);
714         if (wol.wolopts)
715                 return -EBUSY;
716
717         if (phydrv->suspend)
718                 ret = phydrv->suspend(phydev);
719
720         if (ret)
721                 return ret;
722
723         phydev->suspended = true;
724
725         return ret;
726 }
727 EXPORT_SYMBOL(phy_suspend);
728
729 int phy_resume(struct phy_device *phydev)
730 {
731         struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
732         int ret = 0;
733
734         if (phydrv->resume)
735                 ret = phydrv->resume(phydev);
736
737         if (ret)
738                 return ret;
739
740         phydev->suspended = false;
741
742         return ret;
743 }
744 EXPORT_SYMBOL(phy_resume);
745
746 /* Generic PHY support and helper functions */
747
748 /**
749  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
750  * @phydev: target phy_device struct
751  *
752  * Description: Writes MII_ADVERTISE with the appropriate values,
753  *   after sanitizing the values to make sure we only advertise
754  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
755  *   hasn't changed, and > 0 if it has changed.
756  */
757 static int genphy_config_advert(struct phy_device *phydev)
758 {
759         u32 advertise;
760         int oldadv, adv, bmsr;
761         int err, changed = 0;
762
763         /* Only allow advertising what this PHY supports */
764         phydev->advertising &= phydev->supported;
765         advertise = phydev->advertising;
766
767         /* Setup standard advertisement */
768         adv = phy_read(phydev, MII_ADVERTISE);
769         if (adv < 0)
770                 return adv;
771
772         oldadv = adv;
773         adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
774                  ADVERTISE_PAUSE_ASYM);
775         adv |= ethtool_adv_to_mii_adv_t(advertise);
776
777         if (adv != oldadv) {
778                 err = phy_write(phydev, MII_ADVERTISE, adv);
779
780                 if (err < 0)
781                         return err;
782                 changed = 1;
783         }
784
785         bmsr = phy_read(phydev, MII_BMSR);
786         if (bmsr < 0)
787                 return bmsr;
788
789         /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
790          * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
791          * logical 1.
792          */
793         if (!(bmsr & BMSR_ESTATEN))
794                 return changed;
795
796         /* Configure gigabit if it's supported */
797         adv = phy_read(phydev, MII_CTRL1000);
798         if (adv < 0)
799                 return adv;
800
801         oldadv = adv;
802         adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
803
804         if (phydev->supported & (SUPPORTED_1000baseT_Half |
805                                  SUPPORTED_1000baseT_Full)) {
806                 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
807         }
808
809         if (adv != oldadv)
810                 changed = 1;
811
812         err = phy_write(phydev, MII_CTRL1000, adv);
813         if (err < 0)
814                 return err;
815
816         return changed;
817 }
818
819 /**
820  * genphy_setup_forced - configures/forces speed/duplex from @phydev
821  * @phydev: target phy_device struct
822  *
823  * Description: Configures MII_BMCR to force speed/duplex
824  *   to the values in phydev. Assumes that the values are valid.
825  *   Please see phy_sanitize_settings().
826  */
827 int genphy_setup_forced(struct phy_device *phydev)
828 {
829         int ctl = 0;
830
831         phydev->pause = 0;
832         phydev->asym_pause = 0;
833
834         if (SPEED_1000 == phydev->speed)
835                 ctl |= BMCR_SPEED1000;
836         else if (SPEED_100 == phydev->speed)
837                 ctl |= BMCR_SPEED100;
838
839         if (DUPLEX_FULL == phydev->duplex)
840                 ctl |= BMCR_FULLDPLX;
841
842         return phy_write(phydev, MII_BMCR, ctl);
843 }
844 EXPORT_SYMBOL(genphy_setup_forced);
845
846 /**
847  * genphy_restart_aneg - Enable and Restart Autonegotiation
848  * @phydev: target phy_device struct
849  */
850 int genphy_restart_aneg(struct phy_device *phydev)
851 {
852         int ctl = phy_read(phydev, MII_BMCR);
853
854         if (ctl < 0)
855                 return ctl;
856
857         ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
858
859         /* Don't isolate the PHY if we're negotiating */
860         ctl &= ~BMCR_ISOLATE;
861
862         return phy_write(phydev, MII_BMCR, ctl);
863 }
864 EXPORT_SYMBOL(genphy_restart_aneg);
865
866 /**
867  * genphy_config_aneg - restart auto-negotiation or write BMCR
868  * @phydev: target phy_device struct
869  *
870  * Description: If auto-negotiation is enabled, we configure the
871  *   advertising, and then restart auto-negotiation.  If it is not
872  *   enabled, then we write the BMCR.
873  */
874 int genphy_config_aneg(struct phy_device *phydev)
875 {
876         int result;
877
878         if (AUTONEG_ENABLE != phydev->autoneg)
879                 return genphy_setup_forced(phydev);
880
881         result = genphy_config_advert(phydev);
882         if (result < 0) /* error */
883                 return result;
884         if (result == 0) {
885                 /* Advertisement hasn't changed, but maybe aneg was never on to
886                  * begin with?  Or maybe phy was isolated?
887                  */
888                 int ctl = phy_read(phydev, MII_BMCR);
889
890                 if (ctl < 0)
891                         return ctl;
892
893                 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
894                         result = 1; /* do restart aneg */
895         }
896
897         /* Only restart aneg if we are advertising something different
898          * than we were before.
899          */
900         if (result > 0)
901                 result = genphy_restart_aneg(phydev);
902
903         return result;
904 }
905 EXPORT_SYMBOL(genphy_config_aneg);
906
907 /**
908  * genphy_aneg_done - return auto-negotiation status
909  * @phydev: target phy_device struct
910  *
911  * Description: Reads the status register and returns 0 either if
912  *   auto-negotiation is incomplete, or if there was an error.
913  *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
914  */
915 int genphy_aneg_done(struct phy_device *phydev)
916 {
917         int retval = phy_read(phydev, MII_BMSR);
918
919         return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
920 }
921 EXPORT_SYMBOL(genphy_aneg_done);
922
923 static int gen10g_config_aneg(struct phy_device *phydev)
924 {
925         return 0;
926 }
927
928 /**
929  * genphy_update_link - update link status in @phydev
930  * @phydev: target phy_device struct
931  *
932  * Description: Update the value in phydev->link to reflect the
933  *   current link value.  In order to do this, we need to read
934  *   the status register twice, keeping the second value.
935  */
936 int genphy_update_link(struct phy_device *phydev)
937 {
938         int status;
939
940         /* Do a fake read */
941         status = phy_read(phydev, MII_BMSR);
942         if (status < 0)
943                 return status;
944
945         /* Read link and autonegotiation status */
946         status = phy_read(phydev, MII_BMSR);
947         if (status < 0)
948                 return status;
949
950         if ((status & BMSR_LSTATUS) == 0)
951                 phydev->link = 0;
952         else
953                 phydev->link = 1;
954
955         return 0;
956 }
957 EXPORT_SYMBOL(genphy_update_link);
958
959 /**
960  * genphy_read_status - check the link status and update current link state
961  * @phydev: target phy_device struct
962  *
963  * Description: Check the link, then figure out the current state
964  *   by comparing what we advertise with what the link partner
965  *   advertises.  Start by checking the gigabit possibilities,
966  *   then move on to 10/100.
967  */
968 int genphy_read_status(struct phy_device *phydev)
969 {
970         int adv;
971         int err;
972         int lpa;
973         int lpagb = 0;
974         int common_adv;
975         int common_adv_gb = 0;
976
977         /* Update the link, but return if there was an error */
978         err = genphy_update_link(phydev);
979         if (err)
980                 return err;
981
982         phydev->lp_advertising = 0;
983
984         if (AUTONEG_ENABLE == phydev->autoneg) {
985                 if (phydev->supported & (SUPPORTED_1000baseT_Half
986                                         | SUPPORTED_1000baseT_Full)) {
987                         lpagb = phy_read(phydev, MII_STAT1000);
988                         if (lpagb < 0)
989                                 return lpagb;
990
991                         adv = phy_read(phydev, MII_CTRL1000);
992                         if (adv < 0)
993                                 return adv;
994
995                         phydev->lp_advertising =
996                                 mii_stat1000_to_ethtool_lpa_t(lpagb);
997                         common_adv_gb = lpagb & adv << 2;
998                 }
999
1000                 lpa = phy_read(phydev, MII_LPA);
1001                 if (lpa < 0)
1002                         return lpa;
1003
1004                 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1005
1006                 adv = phy_read(phydev, MII_ADVERTISE);
1007                 if (adv < 0)
1008                         return adv;
1009
1010                 common_adv = lpa & adv;
1011
1012                 phydev->speed = SPEED_10;
1013                 phydev->duplex = DUPLEX_HALF;
1014                 phydev->pause = 0;
1015                 phydev->asym_pause = 0;
1016
1017                 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1018                         phydev->speed = SPEED_1000;
1019
1020                         if (common_adv_gb & LPA_1000FULL)
1021                                 phydev->duplex = DUPLEX_FULL;
1022                 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1023                         phydev->speed = SPEED_100;
1024
1025                         if (common_adv & LPA_100FULL)
1026                                 phydev->duplex = DUPLEX_FULL;
1027                 } else
1028                         if (common_adv & LPA_10FULL)
1029                                 phydev->duplex = DUPLEX_FULL;
1030
1031                 if (phydev->duplex == DUPLEX_FULL) {
1032                         phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1033                         phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1034                 }
1035         } else {
1036                 int bmcr = phy_read(phydev, MII_BMCR);
1037
1038                 if (bmcr < 0)
1039                         return bmcr;
1040
1041                 if (bmcr & BMCR_FULLDPLX)
1042                         phydev->duplex = DUPLEX_FULL;
1043                 else
1044                         phydev->duplex = DUPLEX_HALF;
1045
1046                 if (bmcr & BMCR_SPEED1000)
1047                         phydev->speed = SPEED_1000;
1048                 else if (bmcr & BMCR_SPEED100)
1049                         phydev->speed = SPEED_100;
1050                 else
1051                         phydev->speed = SPEED_10;
1052
1053                 phydev->pause = 0;
1054                 phydev->asym_pause = 0;
1055         }
1056
1057         return 0;
1058 }
1059 EXPORT_SYMBOL(genphy_read_status);
1060
1061 static int gen10g_read_status(struct phy_device *phydev)
1062 {
1063         int devad, reg;
1064         u32 mmd_mask = phydev->c45_ids.devices_in_package;
1065
1066         phydev->link = 1;
1067
1068         /* For now just lie and say it's 10G all the time */
1069         phydev->speed = SPEED_10000;
1070         phydev->duplex = DUPLEX_FULL;
1071
1072         for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1073                 if (!(mmd_mask & 1))
1074                         continue;
1075
1076                 /* Read twice because link state is latched and a
1077                  * read moves the current state into the register
1078                  */
1079                 phy_read_mmd(phydev, devad, MDIO_STAT1);
1080                 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1081                 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1082                         phydev->link = 0;
1083         }
1084
1085         return 0;
1086 }
1087
1088 /**
1089  * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1090  * @phydev: target phy_device struct
1091  *
1092  * Description: Perform a software PHY reset using the standard
1093  * BMCR_RESET bit and poll for the reset bit to be cleared.
1094  *
1095  * Returns: 0 on success, < 0 on failure
1096  */
1097 int genphy_soft_reset(struct phy_device *phydev)
1098 {
1099         int ret;
1100
1101         ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1102         if (ret < 0)
1103                 return ret;
1104
1105         return phy_poll_reset(phydev);
1106 }
1107 EXPORT_SYMBOL(genphy_soft_reset);
1108
1109 int genphy_config_init(struct phy_device *phydev)
1110 {
1111         int val;
1112         u32 features;
1113
1114         features = (SUPPORTED_TP | SUPPORTED_MII
1115                         | SUPPORTED_AUI | SUPPORTED_FIBRE |
1116                         SUPPORTED_BNC);
1117
1118         /* Do we support autonegotiation? */
1119         val = phy_read(phydev, MII_BMSR);
1120         if (val < 0)
1121                 return val;
1122
1123         if (val & BMSR_ANEGCAPABLE)
1124                 features |= SUPPORTED_Autoneg;
1125
1126         if (val & BMSR_100FULL)
1127                 features |= SUPPORTED_100baseT_Full;
1128         if (val & BMSR_100HALF)
1129                 features |= SUPPORTED_100baseT_Half;
1130         if (val & BMSR_10FULL)
1131                 features |= SUPPORTED_10baseT_Full;
1132         if (val & BMSR_10HALF)
1133                 features |= SUPPORTED_10baseT_Half;
1134
1135         if (val & BMSR_ESTATEN) {
1136                 val = phy_read(phydev, MII_ESTATUS);
1137                 if (val < 0)
1138                         return val;
1139
1140                 if (val & ESTATUS_1000_TFULL)
1141                         features |= SUPPORTED_1000baseT_Full;
1142                 if (val & ESTATUS_1000_THALF)
1143                         features |= SUPPORTED_1000baseT_Half;
1144         }
1145
1146         phydev->supported &= features;
1147         phydev->advertising &= features;
1148
1149         return 0;
1150 }
1151
1152 static int gen10g_soft_reset(struct phy_device *phydev)
1153 {
1154         /* Do nothing for now */
1155         return 0;
1156 }
1157 EXPORT_SYMBOL(genphy_config_init);
1158
1159 static int gen10g_config_init(struct phy_device *phydev)
1160 {
1161         /* Temporarily just say we support everything */
1162         phydev->supported = SUPPORTED_10000baseT_Full;
1163         phydev->advertising = SUPPORTED_10000baseT_Full;
1164
1165         return 0;
1166 }
1167
1168 int genphy_suspend(struct phy_device *phydev)
1169 {
1170         int value;
1171
1172         mutex_lock(&phydev->lock);
1173
1174         value = phy_read(phydev, MII_BMCR);
1175         phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1176
1177         mutex_unlock(&phydev->lock);
1178
1179         return 0;
1180 }
1181 EXPORT_SYMBOL(genphy_suspend);
1182
1183 static int gen10g_suspend(struct phy_device *phydev)
1184 {
1185         return 0;
1186 }
1187
1188 int genphy_resume(struct phy_device *phydev)
1189 {
1190         int value;
1191
1192         mutex_lock(&phydev->lock);
1193
1194         value = phy_read(phydev, MII_BMCR);
1195         phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1196
1197         mutex_unlock(&phydev->lock);
1198
1199         return 0;
1200 }
1201 EXPORT_SYMBOL(genphy_resume);
1202
1203 static int gen10g_resume(struct phy_device *phydev)
1204 {
1205         return 0;
1206 }
1207
1208 static void of_set_phy_supported(struct phy_device *phydev)
1209 {
1210         struct device_node *node = phydev->dev.of_node;
1211         u32 max_speed;
1212
1213         if (!IS_ENABLED(CONFIG_OF_MDIO))
1214                 return;
1215
1216         if (!node)
1217                 return;
1218
1219         if (!of_property_read_u32(node, "max-speed", &max_speed)) {
1220                 /* The default values for phydev->supported are provided by the PHY
1221                  * driver "features" member, we want to reset to sane defaults fist
1222                  * before supporting higher speeds.
1223                  */
1224                 phydev->supported &= PHY_DEFAULT_FEATURES;
1225
1226                 switch (max_speed) {
1227                 default:
1228                         return;
1229
1230                 case SPEED_1000:
1231                         phydev->supported |= PHY_1000BT_FEATURES;
1232                 case SPEED_100:
1233                         phydev->supported |= PHY_100BT_FEATURES;
1234                 case SPEED_10:
1235                         phydev->supported |= PHY_10BT_FEATURES;
1236                 }
1237         }
1238 }
1239
1240 /**
1241  * phy_probe - probe and init a PHY device
1242  * @dev: device to probe and init
1243  *
1244  * Description: Take care of setting up the phy_device structure,
1245  *   set the state to READY (the driver's init function should
1246  *   set it to STARTING if needed).
1247  */
1248 static int phy_probe(struct device *dev)
1249 {
1250         struct phy_device *phydev = to_phy_device(dev);
1251         struct device_driver *drv = phydev->dev.driver;
1252         struct phy_driver *phydrv = to_phy_driver(drv);
1253         int err = 0;
1254
1255         phydev->drv = phydrv;
1256
1257         /* Disable the interrupt if the PHY doesn't support it
1258          * but the interrupt is still a valid one
1259          */
1260         if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1261             phy_interrupt_is_valid(phydev))
1262                 phydev->irq = PHY_POLL;
1263
1264         if (phydrv->flags & PHY_IS_INTERNAL)
1265                 phydev->is_internal = true;
1266
1267         mutex_lock(&phydev->lock);
1268
1269         /* Start out supporting everything. Eventually,
1270          * a controller will attach, and may modify one
1271          * or both of these values
1272          */
1273         phydev->supported = phydrv->features;
1274         of_set_phy_supported(phydev);
1275         phydev->advertising = phydev->supported;
1276
1277         /* Set the state to READY by default */
1278         phydev->state = PHY_READY;
1279
1280         if (phydev->drv->probe)
1281                 err = phydev->drv->probe(phydev);
1282
1283         mutex_unlock(&phydev->lock);
1284
1285         return err;
1286 }
1287
1288 static int phy_remove(struct device *dev)
1289 {
1290         struct phy_device *phydev = to_phy_device(dev);
1291
1292         mutex_lock(&phydev->lock);
1293         phydev->state = PHY_DOWN;
1294         mutex_unlock(&phydev->lock);
1295
1296         if (phydev->drv->remove)
1297                 phydev->drv->remove(phydev);
1298         phydev->drv = NULL;
1299
1300         return 0;
1301 }
1302
1303 /**
1304  * phy_driver_register - register a phy_driver with the PHY layer
1305  * @new_driver: new phy_driver to register
1306  */
1307 int phy_driver_register(struct phy_driver *new_driver)
1308 {
1309         int retval;
1310
1311         new_driver->driver.name = new_driver->name;
1312         new_driver->driver.bus = &mdio_bus_type;
1313         new_driver->driver.probe = phy_probe;
1314         new_driver->driver.remove = phy_remove;
1315
1316         retval = driver_register(&new_driver->driver);
1317         if (retval) {
1318                 pr_err("%s: Error %d in registering driver\n",
1319                        new_driver->name, retval);
1320
1321                 return retval;
1322         }
1323
1324         pr_debug("%s: Registered new driver\n", new_driver->name);
1325
1326         return 0;
1327 }
1328 EXPORT_SYMBOL(phy_driver_register);
1329
1330 int phy_drivers_register(struct phy_driver *new_driver, int n)
1331 {
1332         int i, ret = 0;
1333
1334         for (i = 0; i < n; i++) {
1335                 ret = phy_driver_register(new_driver + i);
1336                 if (ret) {
1337                         while (i-- > 0)
1338                                 phy_driver_unregister(new_driver + i);
1339                         break;
1340                 }
1341         }
1342         return ret;
1343 }
1344 EXPORT_SYMBOL(phy_drivers_register);
1345
1346 void phy_driver_unregister(struct phy_driver *drv)
1347 {
1348         driver_unregister(&drv->driver);
1349 }
1350 EXPORT_SYMBOL(phy_driver_unregister);
1351
1352 void phy_drivers_unregister(struct phy_driver *drv, int n)
1353 {
1354         int i;
1355
1356         for (i = 0; i < n; i++)
1357                 phy_driver_unregister(drv + i);
1358 }
1359 EXPORT_SYMBOL(phy_drivers_unregister);
1360
1361 static struct phy_driver genphy_driver[] = {
1362 {
1363         .phy_id         = 0xffffffff,
1364         .phy_id_mask    = 0xffffffff,
1365         .name           = "Generic PHY",
1366         .soft_reset     = genphy_soft_reset,
1367         .config_init    = genphy_config_init,
1368         .features       = PHY_GBIT_FEATURES | SUPPORTED_MII |
1369                           SUPPORTED_AUI | SUPPORTED_FIBRE |
1370                           SUPPORTED_BNC,
1371         .config_aneg    = genphy_config_aneg,
1372         .aneg_done      = genphy_aneg_done,
1373         .read_status    = genphy_read_status,
1374         .suspend        = genphy_suspend,
1375         .resume         = genphy_resume,
1376         .driver         = { .owner = THIS_MODULE, },
1377 }, {
1378         .phy_id         = 0xffffffff,
1379         .phy_id_mask    = 0xffffffff,
1380         .name           = "Generic 10G PHY",
1381         .soft_reset     = gen10g_soft_reset,
1382         .config_init    = gen10g_config_init,
1383         .features       = 0,
1384         .config_aneg    = gen10g_config_aneg,
1385         .read_status    = gen10g_read_status,
1386         .suspend        = gen10g_suspend,
1387         .resume         = gen10g_resume,
1388         .driver         = {.owner = THIS_MODULE, },
1389 } };
1390
1391 static int __init phy_init(void)
1392 {
1393         int rc;
1394
1395         rc = mdio_bus_init();
1396         if (rc)
1397                 return rc;
1398
1399         rc = phy_drivers_register(genphy_driver,
1400                                   ARRAY_SIZE(genphy_driver));
1401         if (rc)
1402                 mdio_bus_exit();
1403
1404         return rc;
1405 }
1406
1407 static void __exit phy_exit(void)
1408 {
1409         phy_drivers_unregister(genphy_driver,
1410                                ARRAY_SIZE(genphy_driver));
1411         mdio_bus_exit();
1412 }
1413
1414 subsys_initcall(phy_init);
1415 module_exit(phy_exit);