GNU Linux-libre 4.19.314-gnu1
[releases.git] / drivers / net / phy / phy.c
1 /* Framework for configuring and reading PHY devices
2  * Based on code in sungem_phy.c and gianfar_phy.c
3  *
4  * Author: Andy Fleming
5  *
6  * Copyright (c) 2004 Freescale Semiconductor, Inc.
7  * Copyright (c) 2006, 2007  Maciej W. Rozycki
8  *
9  * This program is free software; you can redistribute  it and/or modify it
10  * under  the terms of  the GNU General  Public License as published by the
11  * Free Software Foundation;  either version 2 of the  License, or (at your
12  * option) any later version.
13  *
14  */
15
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17
18 #include <linux/kernel.h>
19 #include <linux/string.h>
20 #include <linux/errno.h>
21 #include <linux/unistd.h>
22 #include <linux/interrupt.h>
23 #include <linux/delay.h>
24 #include <linux/netdevice.h>
25 #include <linux/etherdevice.h>
26 #include <linux/skbuff.h>
27 #include <linux/mm.h>
28 #include <linux/module.h>
29 #include <linux/mii.h>
30 #include <linux/ethtool.h>
31 #include <linux/phy.h>
32 #include <linux/phy_led_triggers.h>
33 #include <linux/workqueue.h>
34 #include <linux/mdio.h>
35 #include <linux/io.h>
36 #include <linux/uaccess.h>
37 #include <linux/atomic.h>
38
39 #include <asm/irq.h>
40
41 #define PHY_STATE_STR(_state)                   \
42         case PHY_##_state:                      \
43                 return __stringify(_state);     \
44
45 static const char *phy_state_to_str(enum phy_state st)
46 {
47         switch (st) {
48         PHY_STATE_STR(DOWN)
49         PHY_STATE_STR(STARTING)
50         PHY_STATE_STR(READY)
51         PHY_STATE_STR(PENDING)
52         PHY_STATE_STR(UP)
53         PHY_STATE_STR(AN)
54         PHY_STATE_STR(RUNNING)
55         PHY_STATE_STR(NOLINK)
56         PHY_STATE_STR(FORCING)
57         PHY_STATE_STR(CHANGELINK)
58         PHY_STATE_STR(HALTED)
59         PHY_STATE_STR(RESUMING)
60         }
61
62         return NULL;
63 }
64
65
66 /**
67  * phy_print_status - Convenience function to print out the current phy status
68  * @phydev: the phy_device struct
69  */
70 void phy_print_status(struct phy_device *phydev)
71 {
72         if (phydev->link) {
73                 netdev_info(phydev->attached_dev,
74                         "Link is Up - %s/%s - flow control %s\n",
75                         phy_speed_to_str(phydev->speed),
76                         phy_duplex_to_str(phydev->duplex),
77                         phydev->pause ? "rx/tx" : "off");
78         } else  {
79                 netdev_info(phydev->attached_dev, "Link is Down\n");
80         }
81 }
82 EXPORT_SYMBOL(phy_print_status);
83
84 /**
85  * phy_clear_interrupt - Ack the phy device's interrupt
86  * @phydev: the phy_device struct
87  *
88  * If the @phydev driver has an ack_interrupt function, call it to
89  * ack and clear the phy device's interrupt.
90  *
91  * Returns 0 on success or < 0 on error.
92  */
93 static int phy_clear_interrupt(struct phy_device *phydev)
94 {
95         if (phydev->drv->ack_interrupt)
96                 return phydev->drv->ack_interrupt(phydev);
97
98         return 0;
99 }
100
101 /**
102  * phy_config_interrupt - configure the PHY device for the requested interrupts
103  * @phydev: the phy_device struct
104  * @interrupts: interrupt flags to configure for this @phydev
105  *
106  * Returns 0 on success or < 0 on error.
107  */
108 static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
109 {
110         phydev->interrupts = interrupts;
111         if (phydev->drv->config_intr)
112                 return phydev->drv->config_intr(phydev);
113
114         return 0;
115 }
116
117 /**
118  * phy_restart_aneg - restart auto-negotiation
119  * @phydev: target phy_device struct
120  *
121  * Restart the autonegotiation on @phydev.  Returns >= 0 on success or
122  * negative errno on error.
123  */
124 int phy_restart_aneg(struct phy_device *phydev)
125 {
126         int ret;
127
128         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
129                 ret = genphy_c45_restart_aneg(phydev);
130         else
131                 ret = genphy_restart_aneg(phydev);
132
133         return ret;
134 }
135 EXPORT_SYMBOL_GPL(phy_restart_aneg);
136
137 /**
138  * phy_aneg_done - return auto-negotiation status
139  * @phydev: target phy_device struct
140  *
141  * Description: Return the auto-negotiation status from this @phydev
142  * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
143  * is still pending.
144  */
145 int phy_aneg_done(struct phy_device *phydev)
146 {
147         if (phydev->drv && phydev->drv->aneg_done)
148                 return phydev->drv->aneg_done(phydev);
149
150         /* Avoid genphy_aneg_done() if the Clause 45 PHY does not
151          * implement Clause 22 registers
152          */
153         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
154                 return -EINVAL;
155
156         return genphy_aneg_done(phydev);
157 }
158 EXPORT_SYMBOL(phy_aneg_done);
159
160 /**
161  * phy_find_valid - find a PHY setting that matches the requested parameters
162  * @speed: desired speed
163  * @duplex: desired duplex
164  * @supported: mask of supported link modes
165  *
166  * Locate a supported phy setting that is, in priority order:
167  * - an exact match for the specified speed and duplex mode
168  * - a match for the specified speed, or slower speed
169  * - the slowest supported speed
170  * Returns the matched phy_setting entry, or %NULL if no supported phy
171  * settings were found.
172  */
173 static const struct phy_setting *
174 phy_find_valid(int speed, int duplex, u32 supported)
175 {
176         unsigned long mask = supported;
177
178         return phy_lookup_setting(speed, duplex, &mask, BITS_PER_LONG, false);
179 }
180
181 /**
182  * phy_supported_speeds - return all speeds currently supported by a phy device
183  * @phy: The phy device to return supported speeds of.
184  * @speeds: buffer to store supported speeds in.
185  * @size:   size of speeds buffer.
186  *
187  * Description: Returns the number of supported speeds, and fills the speeds
188  * buffer with the supported speeds. If speeds buffer is too small to contain
189  * all currently supported speeds, will return as many speeds as can fit.
190  */
191 unsigned int phy_supported_speeds(struct phy_device *phy,
192                                   unsigned int *speeds,
193                                   unsigned int size)
194 {
195         unsigned long supported = phy->supported;
196
197         return phy_speeds(speeds, size, &supported, BITS_PER_LONG);
198 }
199
200 /**
201  * phy_check_valid - check if there is a valid PHY setting which matches
202  *                   speed, duplex, and feature mask
203  * @speed: speed to match
204  * @duplex: duplex to match
205  * @features: A mask of the valid settings
206  *
207  * Description: Returns true if there is a valid setting, false otherwise.
208  */
209 static inline bool phy_check_valid(int speed, int duplex, u32 features)
210 {
211         unsigned long mask = features;
212
213         return !!phy_lookup_setting(speed, duplex, &mask, BITS_PER_LONG, true);
214 }
215
216 /**
217  * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
218  * @phydev: the target phy_device struct
219  *
220  * Description: Make sure the PHY is set to supported speeds and
221  *   duplexes.  Drop down by one in this order:  1000/FULL,
222  *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
223  */
224 static void phy_sanitize_settings(struct phy_device *phydev)
225 {
226         const struct phy_setting *setting;
227         u32 features = phydev->supported;
228
229         /* Sanitize settings based on PHY capabilities */
230         if ((features & SUPPORTED_Autoneg) == 0)
231                 phydev->autoneg = AUTONEG_DISABLE;
232
233         setting = phy_find_valid(phydev->speed, phydev->duplex, features);
234         if (setting) {
235                 phydev->speed = setting->speed;
236                 phydev->duplex = setting->duplex;
237         } else {
238                 /* We failed to find anything (no supported speeds?) */
239                 phydev->speed = SPEED_UNKNOWN;
240                 phydev->duplex = DUPLEX_UNKNOWN;
241         }
242 }
243
244 /**
245  * phy_ethtool_sset - generic ethtool sset function, handles all the details
246  * @phydev: target phy_device struct
247  * @cmd: ethtool_cmd
248  *
249  * A few notes about parameter checking:
250  *
251  * - We don't set port or transceiver, so we don't care what they
252  *   were set to.
253  * - phy_start_aneg() will make sure forced settings are sane, and
254  *   choose the next best ones from the ones selected, so we don't
255  *   care if ethtool tries to give us bad values.
256  */
257 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
258 {
259         u32 speed = ethtool_cmd_speed(cmd);
260
261         if (cmd->phy_address != phydev->mdio.addr)
262                 return -EINVAL;
263
264         /* We make sure that we don't pass unsupported values in to the PHY */
265         cmd->advertising &= phydev->supported;
266
267         /* Verify the settings we care about. */
268         if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
269                 return -EINVAL;
270
271         if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
272                 return -EINVAL;
273
274         if (cmd->autoneg == AUTONEG_DISABLE &&
275             ((speed != SPEED_1000 &&
276               speed != SPEED_100 &&
277               speed != SPEED_10) ||
278              (cmd->duplex != DUPLEX_HALF &&
279               cmd->duplex != DUPLEX_FULL)))
280                 return -EINVAL;
281
282         phydev->autoneg = cmd->autoneg;
283
284         phydev->speed = speed;
285
286         phydev->advertising = cmd->advertising;
287
288         if (AUTONEG_ENABLE == cmd->autoneg)
289                 phydev->advertising |= ADVERTISED_Autoneg;
290         else
291                 phydev->advertising &= ~ADVERTISED_Autoneg;
292
293         phydev->duplex = cmd->duplex;
294
295         phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
296
297         /* Restart the PHY */
298         phy_start_aneg(phydev);
299
300         return 0;
301 }
302 EXPORT_SYMBOL(phy_ethtool_sset);
303
304 int phy_ethtool_ksettings_set(struct phy_device *phydev,
305                               const struct ethtool_link_ksettings *cmd)
306 {
307         u8 autoneg = cmd->base.autoneg;
308         u8 duplex = cmd->base.duplex;
309         u32 speed = cmd->base.speed;
310         u32 advertising;
311
312         if (cmd->base.phy_address != phydev->mdio.addr)
313                 return -EINVAL;
314
315         ethtool_convert_link_mode_to_legacy_u32(&advertising,
316                                                 cmd->link_modes.advertising);
317
318         /* We make sure that we don't pass unsupported values in to the PHY */
319         advertising &= phydev->supported;
320
321         /* Verify the settings we care about. */
322         if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
323                 return -EINVAL;
324
325         if (autoneg == AUTONEG_ENABLE && advertising == 0)
326                 return -EINVAL;
327
328         if (autoneg == AUTONEG_DISABLE &&
329             ((speed != SPEED_1000 &&
330               speed != SPEED_100 &&
331               speed != SPEED_10) ||
332              (duplex != DUPLEX_HALF &&
333               duplex != DUPLEX_FULL)))
334                 return -EINVAL;
335
336         phydev->autoneg = autoneg;
337
338         if (autoneg == AUTONEG_DISABLE) {
339                 phydev->speed = speed;
340                 phydev->duplex = duplex;
341         }
342
343         phydev->advertising = advertising;
344
345         if (autoneg == AUTONEG_ENABLE)
346                 phydev->advertising |= ADVERTISED_Autoneg;
347         else
348                 phydev->advertising &= ~ADVERTISED_Autoneg;
349
350         phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
351
352         /* Restart the PHY */
353         phy_start_aneg(phydev);
354
355         return 0;
356 }
357 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
358
359 void phy_ethtool_ksettings_get(struct phy_device *phydev,
360                                struct ethtool_link_ksettings *cmd)
361 {
362         ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.supported,
363                                                 phydev->supported);
364
365         ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.advertising,
366                                                 phydev->advertising);
367
368         ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.lp_advertising,
369                                                 phydev->lp_advertising);
370
371         cmd->base.speed = phydev->speed;
372         cmd->base.duplex = phydev->duplex;
373         if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
374                 cmd->base.port = PORT_BNC;
375         else
376                 cmd->base.port = PORT_MII;
377         cmd->base.transceiver = phy_is_internal(phydev) ?
378                                 XCVR_INTERNAL : XCVR_EXTERNAL;
379         cmd->base.phy_address = phydev->mdio.addr;
380         cmd->base.autoneg = phydev->autoneg;
381         cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
382         cmd->base.eth_tp_mdix = phydev->mdix;
383 }
384 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
385
386 /**
387  * phy_mii_ioctl - generic PHY MII ioctl interface
388  * @phydev: the phy_device struct
389  * @ifr: &struct ifreq for socket ioctl's
390  * @cmd: ioctl cmd to execute
391  *
392  * Note that this function is currently incompatible with the
393  * PHYCONTROL layer.  It changes registers without regard to
394  * current state.  Use at own risk.
395  */
396 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
397 {
398         struct mii_ioctl_data *mii_data = if_mii(ifr);
399         u16 val = mii_data->val_in;
400         bool change_autoneg = false;
401
402         switch (cmd) {
403         case SIOCGMIIPHY:
404                 mii_data->phy_id = phydev->mdio.addr;
405                 /* fall through */
406
407         case SIOCGMIIREG:
408                 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
409                                                  mii_data->phy_id,
410                                                  mii_data->reg_num);
411                 return 0;
412
413         case SIOCSMIIREG:
414                 if (mii_data->phy_id == phydev->mdio.addr) {
415                         switch (mii_data->reg_num) {
416                         case MII_BMCR:
417                                 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
418                                         if (phydev->autoneg == AUTONEG_ENABLE)
419                                                 change_autoneg = true;
420                                         phydev->autoneg = AUTONEG_DISABLE;
421                                         if (val & BMCR_FULLDPLX)
422                                                 phydev->duplex = DUPLEX_FULL;
423                                         else
424                                                 phydev->duplex = DUPLEX_HALF;
425                                         if (val & BMCR_SPEED1000)
426                                                 phydev->speed = SPEED_1000;
427                                         else if (val & BMCR_SPEED100)
428                                                 phydev->speed = SPEED_100;
429                                         else phydev->speed = SPEED_10;
430                                 }
431                                 else {
432                                         if (phydev->autoneg == AUTONEG_DISABLE)
433                                                 change_autoneg = true;
434                                         phydev->autoneg = AUTONEG_ENABLE;
435                                 }
436                                 break;
437                         case MII_ADVERTISE:
438                                 phydev->advertising = mii_adv_to_ethtool_adv_t(val);
439                                 change_autoneg = true;
440                                 break;
441                         default:
442                                 /* do nothing */
443                                 break;
444                         }
445                 }
446
447                 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
448                               mii_data->reg_num, val);
449
450                 if (mii_data->phy_id == phydev->mdio.addr &&
451                     mii_data->reg_num == MII_BMCR &&
452                     val & BMCR_RESET)
453                         return phy_init_hw(phydev);
454
455                 if (change_autoneg)
456                         return phy_start_aneg(phydev);
457
458                 return 0;
459
460         case SIOCSHWTSTAMP:
461                 if (phydev->drv && phydev->drv->hwtstamp)
462                         return phydev->drv->hwtstamp(phydev, ifr);
463                 /* fall through */
464
465         default:
466                 return -EOPNOTSUPP;
467         }
468 }
469 EXPORT_SYMBOL(phy_mii_ioctl);
470
471 static int phy_config_aneg(struct phy_device *phydev)
472 {
473         if (phydev->drv->config_aneg)
474                 return phydev->drv->config_aneg(phydev);
475
476         /* Clause 45 PHYs that don't implement Clause 22 registers are not
477          * allowed to call genphy_config_aneg()
478          */
479         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
480                 return -EOPNOTSUPP;
481
482         return genphy_config_aneg(phydev);
483 }
484
485 /**
486  * phy_start_aneg_priv - start auto-negotiation for this PHY device
487  * @phydev: the phy_device struct
488  * @sync: indicate whether we should wait for the workqueue cancelation
489  *
490  * Description: Sanitizes the settings (if we're not autonegotiating
491  *   them), and then calls the driver's config_aneg function.
492  *   If the PHYCONTROL Layer is operating, we change the state to
493  *   reflect the beginning of Auto-negotiation or forcing.
494  */
495 static int phy_start_aneg_priv(struct phy_device *phydev, bool sync)
496 {
497         bool trigger = 0;
498         int err;
499
500         if (!phydev->drv)
501                 return -EIO;
502
503         mutex_lock(&phydev->lock);
504
505         if (AUTONEG_DISABLE == phydev->autoneg)
506                 phy_sanitize_settings(phydev);
507
508         /* Invalidate LP advertising flags */
509         phydev->lp_advertising = 0;
510
511         err = phy_config_aneg(phydev);
512         if (err < 0)
513                 goto out_unlock;
514
515         if (phydev->state != PHY_HALTED) {
516                 if (AUTONEG_ENABLE == phydev->autoneg) {
517                         phydev->state = PHY_AN;
518                         phydev->link_timeout = PHY_AN_TIMEOUT;
519                 } else {
520                         phydev->state = PHY_FORCING;
521                         phydev->link_timeout = PHY_FORCE_TIMEOUT;
522                 }
523         }
524
525         /* Re-schedule a PHY state machine to check PHY status because
526          * negotiation may already be done and aneg interrupt may not be
527          * generated.
528          */
529         if (!phy_polling_mode(phydev) && phydev->state == PHY_AN) {
530                 err = phy_aneg_done(phydev);
531                 if (err > 0) {
532                         trigger = true;
533                         err = 0;
534                 }
535         }
536
537 out_unlock:
538         mutex_unlock(&phydev->lock);
539
540         if (trigger)
541                 phy_trigger_machine(phydev, sync);
542
543         return err;
544 }
545
546 /**
547  * phy_start_aneg - start auto-negotiation for this PHY device
548  * @phydev: the phy_device struct
549  *
550  * Description: Sanitizes the settings (if we're not autonegotiating
551  *   them), and then calls the driver's config_aneg function.
552  *   If the PHYCONTROL Layer is operating, we change the state to
553  *   reflect the beginning of Auto-negotiation or forcing.
554  */
555 int phy_start_aneg(struct phy_device *phydev)
556 {
557         return phy_start_aneg_priv(phydev, true);
558 }
559 EXPORT_SYMBOL(phy_start_aneg);
560
561 static int phy_poll_aneg_done(struct phy_device *phydev)
562 {
563         unsigned int retries = 100;
564         int ret;
565
566         do {
567                 msleep(100);
568                 ret = phy_aneg_done(phydev);
569         } while (!ret && --retries);
570
571         if (!ret)
572                 return -ETIMEDOUT;
573
574         return ret < 0 ? ret : 0;
575 }
576
577 /**
578  * phy_speed_down - set speed to lowest speed supported by both link partners
579  * @phydev: the phy_device struct
580  * @sync: perform action synchronously
581  *
582  * Description: Typically used to save energy when waiting for a WoL packet
583  *
584  * WARNING: Setting sync to false may cause the system being unable to suspend
585  * in case the PHY generates an interrupt when finishing the autonegotiation.
586  * This interrupt may wake up the system immediately after suspend.
587  * Therefore use sync = false only if you're sure it's safe with the respective
588  * network chip.
589  */
590 int phy_speed_down(struct phy_device *phydev, bool sync)
591 {
592         u32 adv = phydev->lp_advertising & phydev->supported;
593         u32 adv_old = phydev->advertising;
594         int ret;
595
596         if (phydev->autoneg != AUTONEG_ENABLE)
597                 return 0;
598
599         if (adv & PHY_10BT_FEATURES)
600                 phydev->advertising &= ~(PHY_100BT_FEATURES |
601                                          PHY_1000BT_FEATURES);
602         else if (adv & PHY_100BT_FEATURES)
603                 phydev->advertising &= ~PHY_1000BT_FEATURES;
604
605         if (phydev->advertising == adv_old)
606                 return 0;
607
608         ret = phy_config_aneg(phydev);
609         if (ret)
610                 return ret;
611
612         return sync ? phy_poll_aneg_done(phydev) : 0;
613 }
614 EXPORT_SYMBOL_GPL(phy_speed_down);
615
616 /**
617  * phy_speed_up - (re)set advertised speeds to all supported speeds
618  * @phydev: the phy_device struct
619  *
620  * Description: Used to revert the effect of phy_speed_down
621  */
622 int phy_speed_up(struct phy_device *phydev)
623 {
624         u32 mask = PHY_10BT_FEATURES | PHY_100BT_FEATURES | PHY_1000BT_FEATURES;
625         u32 adv_old = phydev->advertising;
626
627         if (phydev->autoneg != AUTONEG_ENABLE)
628                 return 0;
629
630         phydev->advertising = (adv_old & ~mask) | (phydev->supported & mask);
631
632         if (phydev->advertising == adv_old)
633                 return 0;
634
635         return phy_config_aneg(phydev);
636 }
637 EXPORT_SYMBOL_GPL(phy_speed_up);
638
639 /**
640  * phy_start_machine - start PHY state machine tracking
641  * @phydev: the phy_device struct
642  *
643  * Description: The PHY infrastructure can run a state machine
644  *   which tracks whether the PHY is starting up, negotiating,
645  *   etc.  This function starts the delayed workqueue which tracks
646  *   the state of the PHY. If you want to maintain your own state machine,
647  *   do not call this function.
648  */
649 void phy_start_machine(struct phy_device *phydev)
650 {
651         queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
652 }
653 EXPORT_SYMBOL_GPL(phy_start_machine);
654
655 /**
656  * phy_trigger_machine - trigger the state machine to run
657  *
658  * @phydev: the phy_device struct
659  * @sync: indicate whether we should wait for the workqueue cancelation
660  *
661  * Description: There has been a change in state which requires that the
662  *   state machine runs.
663  */
664
665 void phy_trigger_machine(struct phy_device *phydev, bool sync)
666 {
667         if (sync)
668                 cancel_delayed_work_sync(&phydev->state_queue);
669         else
670                 cancel_delayed_work(&phydev->state_queue);
671         queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
672 }
673
674 /**
675  * phy_stop_machine - stop the PHY state machine tracking
676  * @phydev: target phy_device struct
677  *
678  * Description: Stops the state machine delayed workqueue, sets the
679  *   state to UP (unless it wasn't up yet). This function must be
680  *   called BEFORE phy_detach.
681  */
682 void phy_stop_machine(struct phy_device *phydev)
683 {
684         cancel_delayed_work_sync(&phydev->state_queue);
685
686         mutex_lock(&phydev->lock);
687         if (phydev->state > PHY_UP && phydev->state != PHY_HALTED)
688                 phydev->state = PHY_UP;
689         mutex_unlock(&phydev->lock);
690 }
691
692 /**
693  * phy_error - enter HALTED state for this PHY device
694  * @phydev: target phy_device struct
695  *
696  * Moves the PHY to the HALTED state in response to a read
697  * or write error, and tells the controller the link is down.
698  * Must not be called from interrupt context, or while the
699  * phydev->lock is held.
700  */
701 static void phy_error(struct phy_device *phydev)
702 {
703         mutex_lock(&phydev->lock);
704         phydev->state = PHY_HALTED;
705         mutex_unlock(&phydev->lock);
706
707         phy_trigger_machine(phydev, false);
708 }
709
710 /**
711  * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
712  * @phydev: target phy_device struct
713  */
714 static int phy_disable_interrupts(struct phy_device *phydev)
715 {
716         int err;
717
718         /* Disable PHY interrupts */
719         err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
720         if (err)
721                 return err;
722
723         /* Clear the interrupt */
724         return phy_clear_interrupt(phydev);
725 }
726
727 /**
728  * phy_change - Called by the phy_interrupt to handle PHY changes
729  * @phydev: phy_device struct that interrupted
730  */
731 static irqreturn_t phy_change(struct phy_device *phydev)
732 {
733         if (phy_interrupt_is_valid(phydev)) {
734                 if (phydev->drv->did_interrupt &&
735                     !phydev->drv->did_interrupt(phydev))
736                         return IRQ_NONE;
737
738                 if (phydev->state == PHY_HALTED)
739                         if (phy_disable_interrupts(phydev))
740                                 goto phy_err;
741         }
742
743         mutex_lock(&phydev->lock);
744         if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
745                 phydev->state = PHY_CHANGELINK;
746         mutex_unlock(&phydev->lock);
747
748         /* reschedule state queue work to run as soon as possible */
749         phy_trigger_machine(phydev, true);
750
751         if (phy_interrupt_is_valid(phydev) && phy_clear_interrupt(phydev))
752                 goto phy_err;
753         return IRQ_HANDLED;
754
755 phy_err:
756         phy_error(phydev);
757         return IRQ_NONE;
758 }
759
760 /**
761  * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
762  * @work: work_struct that describes the work to be done
763  */
764 void phy_change_work(struct work_struct *work)
765 {
766         struct phy_device *phydev =
767                 container_of(work, struct phy_device, phy_queue);
768
769         phy_change(phydev);
770 }
771
772 /**
773  * phy_interrupt - PHY interrupt handler
774  * @irq: interrupt line
775  * @phy_dat: phy_device pointer
776  *
777  * Description: When a PHY interrupt occurs, the handler disables
778  * interrupts, and uses phy_change to handle the interrupt.
779  */
780 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
781 {
782         struct phy_device *phydev = phy_dat;
783
784         if (PHY_HALTED == phydev->state)
785                 return IRQ_NONE;                /* It can't be ours.  */
786
787         return phy_change(phydev);
788 }
789
790 /**
791  * phy_enable_interrupts - Enable the interrupts from the PHY side
792  * @phydev: target phy_device struct
793  */
794 static int phy_enable_interrupts(struct phy_device *phydev)
795 {
796         int err = phy_clear_interrupt(phydev);
797
798         if (err < 0)
799                 return err;
800
801         return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
802 }
803
804 /**
805  * phy_start_interrupts - request and enable interrupts for a PHY device
806  * @phydev: target phy_device struct
807  *
808  * Description: Request the interrupt for the given PHY.
809  *   If this fails, then we set irq to PHY_POLL.
810  *   Otherwise, we enable the interrupts in the PHY.
811  *   This should only be called with a valid IRQ number.
812  *   Returns 0 on success or < 0 on error.
813  */
814 int phy_start_interrupts(struct phy_device *phydev)
815 {
816         if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
817                                  IRQF_ONESHOT | IRQF_SHARED,
818                                  phydev_name(phydev), phydev) < 0) {
819                 pr_warn("%s: Can't get IRQ %d (PHY)\n",
820                         phydev->mdio.bus->name, phydev->irq);
821                 phydev->irq = PHY_POLL;
822                 return 0;
823         }
824
825         return phy_enable_interrupts(phydev);
826 }
827 EXPORT_SYMBOL(phy_start_interrupts);
828
829 /**
830  * phy_stop_interrupts - disable interrupts from a PHY device
831  * @phydev: target phy_device struct
832  */
833 int phy_stop_interrupts(struct phy_device *phydev)
834 {
835         int err = phy_disable_interrupts(phydev);
836
837         if (err)
838                 phy_error(phydev);
839
840         free_irq(phydev->irq, phydev);
841
842         return err;
843 }
844 EXPORT_SYMBOL(phy_stop_interrupts);
845
846 /**
847  * phy_stop - Bring down the PHY link, and stop checking the status
848  * @phydev: target phy_device struct
849  */
850 void phy_stop(struct phy_device *phydev)
851 {
852         mutex_lock(&phydev->lock);
853
854         if (PHY_HALTED == phydev->state)
855                 goto out_unlock;
856
857         if (phy_interrupt_is_valid(phydev))
858                 phy_disable_interrupts(phydev);
859
860         phydev->state = PHY_HALTED;
861
862 out_unlock:
863         mutex_unlock(&phydev->lock);
864
865         /* Cannot call flush_scheduled_work() here as desired because
866          * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
867          * will not reenable interrupts.
868          */
869 }
870 EXPORT_SYMBOL(phy_stop);
871
872 /**
873  * phy_start - start or restart a PHY device
874  * @phydev: target phy_device struct
875  *
876  * Description: Indicates the attached device's readiness to
877  *   handle PHY-related work.  Used during startup to start the
878  *   PHY, and after a call to phy_stop() to resume operation.
879  *   Also used to indicate the MDIO bus has cleared an error
880  *   condition.
881  */
882 void phy_start(struct phy_device *phydev)
883 {
884         int err = 0;
885
886         mutex_lock(&phydev->lock);
887
888         switch (phydev->state) {
889         case PHY_STARTING:
890                 phydev->state = PHY_PENDING;
891                 break;
892         case PHY_READY:
893                 phydev->state = PHY_UP;
894                 break;
895         case PHY_HALTED:
896                 /* if phy was suspended, bring the physical link up again */
897                 __phy_resume(phydev);
898
899                 /* make sure interrupts are re-enabled for the PHY */
900                 if (phy_interrupt_is_valid(phydev)) {
901                         err = phy_enable_interrupts(phydev);
902                         if (err < 0)
903                                 break;
904                 }
905
906                 phydev->state = PHY_RESUMING;
907                 break;
908         default:
909                 break;
910         }
911         mutex_unlock(&phydev->lock);
912
913         phy_trigger_machine(phydev, true);
914 }
915 EXPORT_SYMBOL(phy_start);
916
917 static void phy_link_up(struct phy_device *phydev)
918 {
919         phydev->phy_link_change(phydev, true, true);
920         phy_led_trigger_change_speed(phydev);
921 }
922
923 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
924 {
925         phydev->phy_link_change(phydev, false, do_carrier);
926         phy_led_trigger_change_speed(phydev);
927 }
928
929 /**
930  * phy_state_machine - Handle the state machine
931  * @work: work_struct that describes the work to be done
932  */
933 void phy_state_machine(struct work_struct *work)
934 {
935         struct delayed_work *dwork = to_delayed_work(work);
936         struct phy_device *phydev =
937                         container_of(dwork, struct phy_device, state_queue);
938         bool needs_aneg = false, do_suspend = false;
939         enum phy_state old_state;
940         int err = 0;
941         int old_link;
942
943         mutex_lock(&phydev->lock);
944
945         old_state = phydev->state;
946
947         if (phydev->drv && phydev->drv->link_change_notify)
948                 phydev->drv->link_change_notify(phydev);
949
950         switch (phydev->state) {
951         case PHY_DOWN:
952         case PHY_STARTING:
953         case PHY_READY:
954         case PHY_PENDING:
955                 break;
956         case PHY_UP:
957                 needs_aneg = true;
958
959                 phydev->link_timeout = PHY_AN_TIMEOUT;
960
961                 break;
962         case PHY_AN:
963                 err = phy_read_status(phydev);
964                 if (err < 0)
965                         break;
966
967                 /* If the link is down, give up on negotiation for now */
968                 if (!phydev->link) {
969                         phydev->state = PHY_NOLINK;
970                         phy_link_down(phydev, true);
971                         break;
972                 }
973
974                 /* Check if negotiation is done.  Break if there's an error */
975                 err = phy_aneg_done(phydev);
976                 if (err < 0)
977                         break;
978
979                 /* If AN is done, we're running */
980                 if (err > 0) {
981                         phydev->state = PHY_RUNNING;
982                         phy_link_up(phydev);
983                 } else if (0 == phydev->link_timeout--)
984                         needs_aneg = true;
985                 break;
986         case PHY_NOLINK:
987                 if (!phy_polling_mode(phydev))
988                         break;
989
990                 err = phy_read_status(phydev);
991                 if (err)
992                         break;
993
994                 if (phydev->link) {
995                         if (AUTONEG_ENABLE == phydev->autoneg) {
996                                 err = phy_aneg_done(phydev);
997                                 if (err < 0)
998                                         break;
999
1000                                 if (!err) {
1001                                         phydev->state = PHY_AN;
1002                                         phydev->link_timeout = PHY_AN_TIMEOUT;
1003                                         break;
1004                                 }
1005                         }
1006                         phydev->state = PHY_RUNNING;
1007                         phy_link_up(phydev);
1008                 }
1009                 break;
1010         case PHY_FORCING:
1011                 err = genphy_update_link(phydev);
1012                 if (err)
1013                         break;
1014
1015                 if (phydev->link) {
1016                         phydev->state = PHY_RUNNING;
1017                         phy_link_up(phydev);
1018                 } else {
1019                         if (0 == phydev->link_timeout--)
1020                                 needs_aneg = true;
1021                         phy_link_down(phydev, false);
1022                 }
1023                 break;
1024         case PHY_RUNNING:
1025                 /* Only register a CHANGE if we are polling and link changed
1026                  * since latest checking.
1027                  */
1028                 if (phy_polling_mode(phydev)) {
1029                         old_link = phydev->link;
1030                         err = phy_read_status(phydev);
1031                         if (err)
1032                                 break;
1033
1034                         if (old_link != phydev->link)
1035                                 phydev->state = PHY_CHANGELINK;
1036                 }
1037                 /*
1038                  * Failsafe: check that nobody set phydev->link=0 between two
1039                  * poll cycles, otherwise we won't leave RUNNING state as long
1040                  * as link remains down.
1041                  */
1042                 if (!phydev->link && phydev->state == PHY_RUNNING) {
1043                         phydev->state = PHY_CHANGELINK;
1044                         phydev_err(phydev, "no link in PHY_RUNNING\n");
1045                 }
1046                 break;
1047         case PHY_CHANGELINK:
1048                 err = phy_read_status(phydev);
1049                 if (err)
1050                         break;
1051
1052                 if (phydev->link) {
1053                         phydev->state = PHY_RUNNING;
1054                         phy_link_up(phydev);
1055                 } else {
1056                         phydev->state = PHY_NOLINK;
1057                         phy_link_down(phydev, true);
1058                 }
1059                 break;
1060         case PHY_HALTED:
1061                 if (phydev->link) {
1062                         phydev->link = 0;
1063                         phy_link_down(phydev, true);
1064                         do_suspend = true;
1065                 }
1066                 break;
1067         case PHY_RESUMING:
1068                 if (AUTONEG_ENABLE == phydev->autoneg) {
1069                         err = phy_aneg_done(phydev);
1070                         if (err < 0)
1071                                 break;
1072
1073                         /* err > 0 if AN is done.
1074                          * Otherwise, it's 0, and we're  still waiting for AN
1075                          */
1076                         if (err > 0) {
1077                                 err = phy_read_status(phydev);
1078                                 if (err)
1079                                         break;
1080
1081                                 if (phydev->link) {
1082                                         phydev->state = PHY_RUNNING;
1083                                         phy_link_up(phydev);
1084                                 } else  {
1085                                         phydev->state = PHY_NOLINK;
1086                                         phy_link_down(phydev, false);
1087                                 }
1088                         } else {
1089                                 phydev->state = PHY_AN;
1090                                 phydev->link_timeout = PHY_AN_TIMEOUT;
1091                         }
1092                 } else {
1093                         err = phy_read_status(phydev);
1094                         if (err)
1095                                 break;
1096
1097                         if (phydev->link) {
1098                                 phydev->state = PHY_RUNNING;
1099                                 phy_link_up(phydev);
1100                         } else  {
1101                                 phydev->state = PHY_NOLINK;
1102                                 phy_link_down(phydev, false);
1103                         }
1104                 }
1105                 break;
1106         }
1107
1108         mutex_unlock(&phydev->lock);
1109
1110         if (needs_aneg)
1111                 err = phy_start_aneg_priv(phydev, false);
1112         else if (do_suspend)
1113                 phy_suspend(phydev);
1114
1115         if (err < 0)
1116                 phy_error(phydev);
1117
1118         if (old_state != phydev->state)
1119                 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1120                            phy_state_to_str(old_state),
1121                            phy_state_to_str(phydev->state));
1122
1123         /* Only re-schedule a PHY state machine change if we are polling the
1124          * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1125          * between states from phy_mac_interrupt()
1126          */
1127         if (phy_polling_mode(phydev))
1128                 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
1129                                    PHY_STATE_TIME * HZ);
1130 }
1131
1132 /**
1133  * phy_mac_interrupt - MAC says the link has changed
1134  * @phydev: phy_device struct with changed link
1135  *
1136  * The MAC layer is able to indicate there has been a change in the PHY link
1137  * status. Trigger the state machine and work a work queue.
1138  */
1139 void phy_mac_interrupt(struct phy_device *phydev)
1140 {
1141         /* Trigger a state machine change */
1142         queue_work(system_power_efficient_wq, &phydev->phy_queue);
1143 }
1144 EXPORT_SYMBOL(phy_mac_interrupt);
1145
1146 /**
1147  * phy_init_eee - init and check the EEE feature
1148  * @phydev: target phy_device struct
1149  * @clk_stop_enable: PHY may stop the clock during LPI
1150  *
1151  * Description: it checks if the Energy-Efficient Ethernet (EEE)
1152  * is supported by looking at the MMD registers 3.20 and 7.60/61
1153  * and it programs the MMD register 3.0 setting the "Clock stop enable"
1154  * bit if required.
1155  */
1156 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1157 {
1158         if (!phydev->drv)
1159                 return -EIO;
1160
1161         /* According to 802.3az,the EEE is supported only in full duplex-mode.
1162          */
1163         if (phydev->duplex == DUPLEX_FULL) {
1164                 int eee_lp, eee_cap, eee_adv;
1165                 u32 lp, cap, adv;
1166                 int status;
1167
1168                 /* Read phy status to properly get the right settings */
1169                 status = phy_read_status(phydev);
1170                 if (status)
1171                         return status;
1172
1173                 /* First check if the EEE ability is supported */
1174                 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1175                 if (eee_cap <= 0)
1176                         goto eee_exit_err;
1177
1178                 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1179                 if (!cap)
1180                         goto eee_exit_err;
1181
1182                 /* Check which link settings negotiated and verify it in
1183                  * the EEE advertising registers.
1184                  */
1185                 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1186                 if (eee_lp <= 0)
1187                         goto eee_exit_err;
1188
1189                 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1190                 if (eee_adv <= 0)
1191                         goto eee_exit_err;
1192
1193                 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1194                 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1195                 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1196                         goto eee_exit_err;
1197
1198                 if (clk_stop_enable) {
1199                         /* Configure the PHY to stop receiving xMII
1200                          * clock while it is signaling LPI.
1201                          */
1202                         int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1203                         if (val < 0)
1204                                 return val;
1205
1206                         val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1207                         phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1208                 }
1209
1210                 return 0; /* EEE supported */
1211         }
1212 eee_exit_err:
1213         return -EPROTONOSUPPORT;
1214 }
1215 EXPORT_SYMBOL(phy_init_eee);
1216
1217 /**
1218  * phy_get_eee_err - report the EEE wake error count
1219  * @phydev: target phy_device struct
1220  *
1221  * Description: it is to report the number of time where the PHY
1222  * failed to complete its normal wake sequence.
1223  */
1224 int phy_get_eee_err(struct phy_device *phydev)
1225 {
1226         if (!phydev->drv)
1227                 return -EIO;
1228
1229         return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1230 }
1231 EXPORT_SYMBOL(phy_get_eee_err);
1232
1233 /**
1234  * phy_ethtool_get_eee - get EEE supported and status
1235  * @phydev: target phy_device struct
1236  * @data: ethtool_eee data
1237  *
1238  * Description: it reportes the Supported/Advertisement/LP Advertisement
1239  * capabilities.
1240  */
1241 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1242 {
1243         int val;
1244
1245         if (!phydev->drv)
1246                 return -EIO;
1247
1248         /* Get Supported EEE */
1249         val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1250         if (val < 0)
1251                 return val;
1252         data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1253
1254         /* Get advertisement EEE */
1255         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1256         if (val < 0)
1257                 return val;
1258         data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1259
1260         /* Get LP advertisement EEE */
1261         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1262         if (val < 0)
1263                 return val;
1264         data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1265
1266         return 0;
1267 }
1268 EXPORT_SYMBOL(phy_ethtool_get_eee);
1269
1270 /**
1271  * phy_ethtool_set_eee - set EEE supported and status
1272  * @phydev: target phy_device struct
1273  * @data: ethtool_eee data
1274  *
1275  * Description: it is to program the Advertisement EEE register.
1276  */
1277 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1278 {
1279         int cap, old_adv, adv, ret;
1280
1281         if (!phydev->drv)
1282                 return -EIO;
1283
1284         /* Get Supported EEE */
1285         cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1286         if (cap < 0)
1287                 return cap;
1288
1289         old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1290         if (old_adv < 0)
1291                 return old_adv;
1292
1293         adv = ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1294
1295         /* Mask prohibited EEE modes */
1296         adv &= ~phydev->eee_broken_modes;
1297
1298         if (old_adv != adv) {
1299                 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1300                 if (ret < 0)
1301                         return ret;
1302
1303                 /* Restart autonegotiation so the new modes get sent to the
1304                  * link partner.
1305                  */
1306                 if (phydev->autoneg == AUTONEG_ENABLE) {
1307                         ret = phy_restart_aneg(phydev);
1308                         if (ret < 0)
1309                                 return ret;
1310                 }
1311         }
1312
1313         return 0;
1314 }
1315 EXPORT_SYMBOL(phy_ethtool_set_eee);
1316
1317 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1318 {
1319         if (phydev->drv && phydev->drv->set_wol)
1320                 return phydev->drv->set_wol(phydev, wol);
1321
1322         return -EOPNOTSUPP;
1323 }
1324 EXPORT_SYMBOL(phy_ethtool_set_wol);
1325
1326 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1327 {
1328         if (phydev->drv && phydev->drv->get_wol)
1329                 phydev->drv->get_wol(phydev, wol);
1330 }
1331 EXPORT_SYMBOL(phy_ethtool_get_wol);
1332
1333 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1334                                    struct ethtool_link_ksettings *cmd)
1335 {
1336         struct phy_device *phydev = ndev->phydev;
1337
1338         if (!phydev)
1339                 return -ENODEV;
1340
1341         phy_ethtool_ksettings_get(phydev, cmd);
1342
1343         return 0;
1344 }
1345 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1346
1347 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1348                                    const struct ethtool_link_ksettings *cmd)
1349 {
1350         struct phy_device *phydev = ndev->phydev;
1351
1352         if (!phydev)
1353                 return -ENODEV;
1354
1355         return phy_ethtool_ksettings_set(phydev, cmd);
1356 }
1357 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1358
1359 int phy_ethtool_nway_reset(struct net_device *ndev)
1360 {
1361         struct phy_device *phydev = ndev->phydev;
1362
1363         if (!phydev)
1364                 return -ENODEV;
1365
1366         if (!phydev->drv)
1367                 return -EIO;
1368
1369         return phy_restart_aneg(phydev);
1370 }
1371 EXPORT_SYMBOL(phy_ethtool_nway_reset);