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