]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/net/phy/phy.c
14509a8903c6c625838f89a5c3183ec362589999
[linux.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         phydev->speed = speed;
339
340         phydev->advertising = advertising;
341
342         if (autoneg == AUTONEG_ENABLE)
343                 phydev->advertising |= ADVERTISED_Autoneg;
344         else
345                 phydev->advertising &= ~ADVERTISED_Autoneg;
346
347         phydev->duplex = duplex;
348
349         phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
350
351         /* Restart the PHY */
352         phy_start_aneg(phydev);
353
354         return 0;
355 }
356 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
357
358 void phy_ethtool_ksettings_get(struct phy_device *phydev,
359                                struct ethtool_link_ksettings *cmd)
360 {
361         ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.supported,
362                                                 phydev->supported);
363
364         ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.advertising,
365                                                 phydev->advertising);
366
367         ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.lp_advertising,
368                                                 phydev->lp_advertising);
369
370         cmd->base.speed = phydev->speed;
371         cmd->base.duplex = phydev->duplex;
372         if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
373                 cmd->base.port = PORT_BNC;
374         else
375                 cmd->base.port = PORT_MII;
376         cmd->base.transceiver = phy_is_internal(phydev) ?
377                                 XCVR_INTERNAL : XCVR_EXTERNAL;
378         cmd->base.phy_address = phydev->mdio.addr;
379         cmd->base.autoneg = phydev->autoneg;
380         cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
381         cmd->base.eth_tp_mdix = phydev->mdix;
382 }
383 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
384
385 /**
386  * phy_mii_ioctl - generic PHY MII ioctl interface
387  * @phydev: the phy_device struct
388  * @ifr: &struct ifreq for socket ioctl's
389  * @cmd: ioctl cmd to execute
390  *
391  * Note that this function is currently incompatible with the
392  * PHYCONTROL layer.  It changes registers without regard to
393  * current state.  Use at own risk.
394  */
395 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
396 {
397         struct mii_ioctl_data *mii_data = if_mii(ifr);
398         u16 val = mii_data->val_in;
399         bool change_autoneg = false;
400
401         switch (cmd) {
402         case SIOCGMIIPHY:
403                 mii_data->phy_id = phydev->mdio.addr;
404                 /* fall through */
405
406         case SIOCGMIIREG:
407                 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
408                                                  mii_data->phy_id,
409                                                  mii_data->reg_num);
410                 return 0;
411
412         case SIOCSMIIREG:
413                 if (mii_data->phy_id == phydev->mdio.addr) {
414                         switch (mii_data->reg_num) {
415                         case MII_BMCR:
416                                 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
417                                         if (phydev->autoneg == AUTONEG_ENABLE)
418                                                 change_autoneg = true;
419                                         phydev->autoneg = AUTONEG_DISABLE;
420                                         if (val & BMCR_FULLDPLX)
421                                                 phydev->duplex = DUPLEX_FULL;
422                                         else
423                                                 phydev->duplex = DUPLEX_HALF;
424                                         if (val & BMCR_SPEED1000)
425                                                 phydev->speed = SPEED_1000;
426                                         else if (val & BMCR_SPEED100)
427                                                 phydev->speed = SPEED_100;
428                                         else phydev->speed = SPEED_10;
429                                 }
430                                 else {
431                                         if (phydev->autoneg == AUTONEG_DISABLE)
432                                                 change_autoneg = true;
433                                         phydev->autoneg = AUTONEG_ENABLE;
434                                 }
435                                 break;
436                         case MII_ADVERTISE:
437                                 phydev->advertising = mii_adv_to_ethtool_adv_t(val);
438                                 change_autoneg = true;
439                                 break;
440                         default:
441                                 /* do nothing */
442                                 break;
443                         }
444                 }
445
446                 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
447                               mii_data->reg_num, val);
448
449                 if (mii_data->phy_id == phydev->mdio.addr &&
450                     mii_data->reg_num == MII_BMCR &&
451                     val & BMCR_RESET)
452                         return phy_init_hw(phydev);
453
454                 if (change_autoneg)
455                         return phy_start_aneg(phydev);
456
457                 return 0;
458
459         case SIOCSHWTSTAMP:
460                 if (phydev->drv && phydev->drv->hwtstamp)
461                         return phydev->drv->hwtstamp(phydev, ifr);
462                 /* fall through */
463
464         default:
465                 return -EOPNOTSUPP;
466         }
467 }
468 EXPORT_SYMBOL(phy_mii_ioctl);
469
470 static int phy_config_aneg(struct phy_device *phydev)
471 {
472         if (phydev->drv->config_aneg)
473                 return phydev->drv->config_aneg(phydev);
474
475         /* Clause 45 PHYs that don't implement Clause 22 registers are not
476          * allowed to call genphy_config_aneg()
477          */
478         if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
479                 return -EOPNOTSUPP;
480
481         return genphy_config_aneg(phydev);
482 }
483
484 /**
485  * phy_start_aneg_priv - start auto-negotiation for this PHY device
486  * @phydev: the phy_device struct
487  * @sync: indicate whether we should wait for the workqueue cancelation
488  *
489  * Description: Sanitizes the settings (if we're not autonegotiating
490  *   them), and then calls the driver's config_aneg function.
491  *   If the PHYCONTROL Layer is operating, we change the state to
492  *   reflect the beginning of Auto-negotiation or forcing.
493  */
494 static int phy_start_aneg_priv(struct phy_device *phydev, bool sync)
495 {
496         bool trigger = 0;
497         int err;
498
499         if (!phydev->drv)
500                 return -EIO;
501
502         mutex_lock(&phydev->lock);
503
504         if (AUTONEG_DISABLE == phydev->autoneg)
505                 phy_sanitize_settings(phydev);
506
507         /* Invalidate LP advertising flags */
508         phydev->lp_advertising = 0;
509
510         err = phy_config_aneg(phydev);
511         if (err < 0)
512                 goto out_unlock;
513
514         if (phydev->state != PHY_HALTED) {
515                 if (AUTONEG_ENABLE == phydev->autoneg) {
516                         phydev->state = PHY_AN;
517                         phydev->link_timeout = PHY_AN_TIMEOUT;
518                 } else {
519                         phydev->state = PHY_FORCING;
520                         phydev->link_timeout = PHY_FORCE_TIMEOUT;
521                 }
522         }
523
524         /* Re-schedule a PHY state machine to check PHY status because
525          * negotiation may already be done and aneg interrupt may not be
526          * generated.
527          */
528         if (!phy_polling_mode(phydev) && phydev->state == PHY_AN) {
529                 err = phy_aneg_done(phydev);
530                 if (err > 0) {
531                         trigger = true;
532                         err = 0;
533                 }
534         }
535
536 out_unlock:
537         mutex_unlock(&phydev->lock);
538
539         if (trigger)
540                 phy_trigger_machine(phydev);
541
542         return err;
543 }
544
545 /**
546  * phy_start_aneg - start auto-negotiation for this PHY device
547  * @phydev: the phy_device struct
548  *
549  * Description: Sanitizes the settings (if we're not autonegotiating
550  *   them), and then calls the driver's config_aneg function.
551  *   If the PHYCONTROL Layer is operating, we change the state to
552  *   reflect the beginning of Auto-negotiation or forcing.
553  */
554 int phy_start_aneg(struct phy_device *phydev)
555 {
556         return phy_start_aneg_priv(phydev, true);
557 }
558 EXPORT_SYMBOL(phy_start_aneg);
559
560 static int phy_poll_aneg_done(struct phy_device *phydev)
561 {
562         unsigned int retries = 100;
563         int ret;
564
565         do {
566                 msleep(100);
567                 ret = phy_aneg_done(phydev);
568         } while (!ret && --retries);
569
570         if (!ret)
571                 return -ETIMEDOUT;
572
573         return ret < 0 ? ret : 0;
574 }
575
576 /**
577  * phy_speed_down - set speed to lowest speed supported by both link partners
578  * @phydev: the phy_device struct
579  * @sync: perform action synchronously
580  *
581  * Description: Typically used to save energy when waiting for a WoL packet
582  *
583  * WARNING: Setting sync to false may cause the system being unable to suspend
584  * in case the PHY generates an interrupt when finishing the autonegotiation.
585  * This interrupt may wake up the system immediately after suspend.
586  * Therefore use sync = false only if you're sure it's safe with the respective
587  * network chip.
588  */
589 int phy_speed_down(struct phy_device *phydev, bool sync)
590 {
591         u32 adv = phydev->lp_advertising & phydev->supported;
592         u32 adv_old = phydev->advertising;
593         int ret;
594
595         if (phydev->autoneg != AUTONEG_ENABLE)
596                 return 0;
597
598         if (adv & PHY_10BT_FEATURES)
599                 phydev->advertising &= ~(PHY_100BT_FEATURES |
600                                          PHY_1000BT_FEATURES);
601         else if (adv & PHY_100BT_FEATURES)
602                 phydev->advertising &= ~PHY_1000BT_FEATURES;
603
604         if (phydev->advertising == adv_old)
605                 return 0;
606
607         ret = phy_config_aneg(phydev);
608         if (ret)
609                 return ret;
610
611         return sync ? phy_poll_aneg_done(phydev) : 0;
612 }
613 EXPORT_SYMBOL_GPL(phy_speed_down);
614
615 /**
616  * phy_speed_up - (re)set advertised speeds to all supported speeds
617  * @phydev: the phy_device struct
618  *
619  * Description: Used to revert the effect of phy_speed_down
620  */
621 int phy_speed_up(struct phy_device *phydev)
622 {
623         u32 mask = PHY_10BT_FEATURES | PHY_100BT_FEATURES | PHY_1000BT_FEATURES;
624         u32 adv_old = phydev->advertising;
625
626         if (phydev->autoneg != AUTONEG_ENABLE)
627                 return 0;
628
629         phydev->advertising = (adv_old & ~mask) | (phydev->supported & mask);
630
631         if (phydev->advertising == adv_old)
632                 return 0;
633
634         return phy_config_aneg(phydev);
635 }
636 EXPORT_SYMBOL_GPL(phy_speed_up);
637
638 static void phy_queue_state_machine(struct phy_device *phydev,
639                                     unsigned int secs)
640 {
641         mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
642                          secs * HZ);
643 }
644
645 /**
646  * phy_start_machine - start PHY state machine tracking
647  * @phydev: the phy_device struct
648  *
649  * Description: The PHY infrastructure can run a state machine
650  *   which tracks whether the PHY is starting up, negotiating,
651  *   etc.  This function starts the delayed workqueue which tracks
652  *   the state of the PHY. If you want to maintain your own state machine,
653  *   do not call this function.
654  */
655 void phy_start_machine(struct phy_device *phydev)
656 {
657         phy_queue_state_machine(phydev, 1);
658 }
659 EXPORT_SYMBOL_GPL(phy_start_machine);
660
661 /**
662  * phy_trigger_machine - trigger the state machine to run
663  *
664  * @phydev: the phy_device struct
665  *
666  * Description: There has been a change in state which requires that the
667  *   state machine runs.
668  */
669
670 void phy_trigger_machine(struct phy_device *phydev)
671 {
672         phy_queue_state_machine(phydev, 0);
673 }
674
675 /**
676  * phy_stop_machine - stop the PHY state machine tracking
677  * @phydev: target phy_device struct
678  *
679  * Description: Stops the state machine delayed workqueue, sets the
680  *   state to UP (unless it wasn't up yet). This function must be
681  *   called BEFORE phy_detach.
682  */
683 void phy_stop_machine(struct phy_device *phydev)
684 {
685         cancel_delayed_work_sync(&phydev->state_queue);
686
687         mutex_lock(&phydev->lock);
688         if (phydev->state > PHY_UP && phydev->state != PHY_HALTED)
689                 phydev->state = PHY_UP;
690         mutex_unlock(&phydev->lock);
691 }
692
693 /**
694  * phy_error - enter HALTED state for this PHY device
695  * @phydev: target phy_device struct
696  *
697  * Moves the PHY to the HALTED state in response to a read
698  * or write error, and tells the controller the link is down.
699  * Must not be called from interrupt context, or while the
700  * phydev->lock is held.
701  */
702 static void phy_error(struct phy_device *phydev)
703 {
704         mutex_lock(&phydev->lock);
705         phydev->state = PHY_HALTED;
706         mutex_unlock(&phydev->lock);
707
708         phy_trigger_machine(phydev);
709 }
710
711 /**
712  * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
713  * @phydev: target phy_device struct
714  */
715 static int phy_disable_interrupts(struct phy_device *phydev)
716 {
717         int err;
718
719         /* Disable PHY interrupts */
720         err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
721         if (err)
722                 return err;
723
724         /* Clear the interrupt */
725         return phy_clear_interrupt(phydev);
726 }
727
728 /**
729  * phy_change - Called by the phy_interrupt to handle PHY changes
730  * @phydev: phy_device struct that interrupted
731  */
732 static irqreturn_t phy_change(struct phy_device *phydev)
733 {
734         if (phy_interrupt_is_valid(phydev)) {
735                 if (phydev->drv->did_interrupt &&
736                     !phydev->drv->did_interrupt(phydev))
737                         return IRQ_NONE;
738
739                 if (phydev->state == PHY_HALTED)
740                         if (phy_disable_interrupts(phydev))
741                                 goto phy_err;
742         }
743
744         mutex_lock(&phydev->lock);
745         if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
746                 phydev->state = PHY_CHANGELINK;
747         mutex_unlock(&phydev->lock);
748
749         /* reschedule state queue work to run as soon as possible */
750         phy_trigger_machine(phydev);
751
752         if (phy_interrupt_is_valid(phydev) && phy_clear_interrupt(phydev))
753                 goto phy_err;
754         return IRQ_HANDLED;
755
756 phy_err:
757         phy_error(phydev);
758         return IRQ_NONE;
759 }
760
761 /**
762  * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
763  * @work: work_struct that describes the work to be done
764  */
765 void phy_change_work(struct work_struct *work)
766 {
767         struct phy_device *phydev =
768                 container_of(work, struct phy_device, phy_queue);
769
770         phy_change(phydev);
771 }
772
773 /**
774  * phy_interrupt - PHY interrupt handler
775  * @irq: interrupt line
776  * @phy_dat: phy_device pointer
777  *
778  * Description: When a PHY interrupt occurs, the handler disables
779  * interrupts, and uses phy_change to handle the interrupt.
780  */
781 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
782 {
783         struct phy_device *phydev = phy_dat;
784
785         if (PHY_HALTED == phydev->state)
786                 return IRQ_NONE;                /* It can't be ours.  */
787
788         return phy_change(phydev);
789 }
790
791 /**
792  * phy_enable_interrupts - Enable the interrupts from the PHY side
793  * @phydev: target phy_device struct
794  */
795 static int phy_enable_interrupts(struct phy_device *phydev)
796 {
797         int err = phy_clear_interrupt(phydev);
798
799         if (err < 0)
800                 return err;
801
802         return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
803 }
804
805 /**
806  * phy_start_interrupts - request and enable interrupts for a PHY device
807  * @phydev: target phy_device struct
808  *
809  * Description: Request the interrupt for the given PHY.
810  *   If this fails, then we set irq to PHY_POLL.
811  *   Otherwise, we enable the interrupts in the PHY.
812  *   This should only be called with a valid IRQ number.
813  *   Returns 0 on success or < 0 on error.
814  */
815 int phy_start_interrupts(struct phy_device *phydev)
816 {
817         if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
818                                  IRQF_ONESHOT | IRQF_SHARED,
819                                  phydev_name(phydev), phydev) < 0) {
820                 pr_warn("%s: Can't get IRQ %d (PHY)\n",
821                         phydev->mdio.bus->name, phydev->irq);
822                 phydev->irq = PHY_POLL;
823                 return 0;
824         }
825
826         return phy_enable_interrupts(phydev);
827 }
828 EXPORT_SYMBOL(phy_start_interrupts);
829
830 /**
831  * phy_stop_interrupts - disable interrupts from a PHY device
832  * @phydev: target phy_device struct
833  */
834 int phy_stop_interrupts(struct phy_device *phydev)
835 {
836         int err = phy_disable_interrupts(phydev);
837
838         if (err)
839                 phy_error(phydev);
840
841         free_irq(phydev->irq, phydev);
842
843         return err;
844 }
845 EXPORT_SYMBOL(phy_stop_interrupts);
846
847 /**
848  * phy_stop - Bring down the PHY link, and stop checking the status
849  * @phydev: target phy_device struct
850  */
851 void phy_stop(struct phy_device *phydev)
852 {
853         mutex_lock(&phydev->lock);
854
855         if (PHY_HALTED == phydev->state)
856                 goto out_unlock;
857
858         if (phy_interrupt_is_valid(phydev))
859                 phy_disable_interrupts(phydev);
860
861         phydev->state = PHY_HALTED;
862
863 out_unlock:
864         mutex_unlock(&phydev->lock);
865
866         phy_state_machine(&phydev->state_queue.work);
867
868         /* Cannot call flush_scheduled_work() here as desired because
869          * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
870          * will not reenable interrupts.
871          */
872 }
873 EXPORT_SYMBOL(phy_stop);
874
875 /**
876  * phy_start - start or restart a PHY device
877  * @phydev: target phy_device struct
878  *
879  * Description: Indicates the attached device's readiness to
880  *   handle PHY-related work.  Used during startup to start the
881  *   PHY, and after a call to phy_stop() to resume operation.
882  *   Also used to indicate the MDIO bus has cleared an error
883  *   condition.
884  */
885 void phy_start(struct phy_device *phydev)
886 {
887         int err = 0;
888
889         mutex_lock(&phydev->lock);
890
891         switch (phydev->state) {
892         case PHY_STARTING:
893                 phydev->state = PHY_PENDING;
894                 break;
895         case PHY_READY:
896                 phydev->state = PHY_UP;
897                 break;
898         case PHY_HALTED:
899                 /* if phy was suspended, bring the physical link up again */
900                 __phy_resume(phydev);
901
902                 /* make sure interrupts are re-enabled for the PHY */
903                 if (phy_interrupt_is_valid(phydev)) {
904                         err = phy_enable_interrupts(phydev);
905                         if (err < 0)
906                                 break;
907                 }
908
909                 phydev->state = PHY_RESUMING;
910                 break;
911         default:
912                 break;
913         }
914         mutex_unlock(&phydev->lock);
915
916         phy_trigger_machine(phydev);
917 }
918 EXPORT_SYMBOL(phy_start);
919
920 static void phy_link_up(struct phy_device *phydev)
921 {
922         phydev->phy_link_change(phydev, true, true);
923         phy_led_trigger_change_speed(phydev);
924 }
925
926 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
927 {
928         phydev->phy_link_change(phydev, false, do_carrier);
929         phy_led_trigger_change_speed(phydev);
930 }
931
932 /**
933  * phy_state_machine - Handle the state machine
934  * @work: work_struct that describes the work to be done
935  */
936 void phy_state_machine(struct work_struct *work)
937 {
938         struct delayed_work *dwork = to_delayed_work(work);
939         struct phy_device *phydev =
940                         container_of(dwork, struct phy_device, state_queue);
941         bool needs_aneg = false, do_suspend = false;
942         enum phy_state old_state;
943         int err = 0;
944         int old_link;
945
946         mutex_lock(&phydev->lock);
947
948         old_state = phydev->state;
949
950         if (phydev->drv && phydev->drv->link_change_notify)
951                 phydev->drv->link_change_notify(phydev);
952
953         switch (phydev->state) {
954         case PHY_DOWN:
955         case PHY_STARTING:
956         case PHY_READY:
957         case PHY_PENDING:
958                 break;
959         case PHY_UP:
960                 needs_aneg = true;
961
962                 phydev->link_timeout = PHY_AN_TIMEOUT;
963
964                 break;
965         case PHY_AN:
966                 err = phy_read_status(phydev);
967                 if (err < 0)
968                         break;
969
970                 /* If the link is down, give up on negotiation for now */
971                 if (!phydev->link) {
972                         phydev->state = PHY_NOLINK;
973                         phy_link_down(phydev, true);
974                         break;
975                 }
976
977                 /* Check if negotiation is done.  Break if there's an error */
978                 err = phy_aneg_done(phydev);
979                 if (err < 0)
980                         break;
981
982                 /* If AN is done, we're running */
983                 if (err > 0) {
984                         phydev->state = PHY_RUNNING;
985                         phy_link_up(phydev);
986                 } else if (0 == phydev->link_timeout--)
987                         needs_aneg = true;
988                 break;
989         case PHY_NOLINK:
990                 if (!phy_polling_mode(phydev))
991                         break;
992
993                 err = phy_read_status(phydev);
994                 if (err)
995                         break;
996
997                 if (phydev->link) {
998                         if (AUTONEG_ENABLE == phydev->autoneg) {
999                                 err = phy_aneg_done(phydev);
1000                                 if (err < 0)
1001                                         break;
1002
1003                                 if (!err) {
1004                                         phydev->state = PHY_AN;
1005                                         phydev->link_timeout = PHY_AN_TIMEOUT;
1006                                         break;
1007                                 }
1008                         }
1009                         phydev->state = PHY_RUNNING;
1010                         phy_link_up(phydev);
1011                 }
1012                 break;
1013         case PHY_FORCING:
1014                 err = genphy_update_link(phydev);
1015                 if (err)
1016                         break;
1017
1018                 if (phydev->link) {
1019                         phydev->state = PHY_RUNNING;
1020                         phy_link_up(phydev);
1021                 } else {
1022                         if (0 == phydev->link_timeout--)
1023                                 needs_aneg = true;
1024                         phy_link_down(phydev, false);
1025                 }
1026                 break;
1027         case PHY_RUNNING:
1028                 /* Only register a CHANGE if we are polling and link changed
1029                  * since latest checking.
1030                  */
1031                 if (phy_polling_mode(phydev)) {
1032                         old_link = phydev->link;
1033                         err = phy_read_status(phydev);
1034                         if (err)
1035                                 break;
1036
1037                         if (old_link != phydev->link)
1038                                 phydev->state = PHY_CHANGELINK;
1039                 }
1040                 /*
1041                  * Failsafe: check that nobody set phydev->link=0 between two
1042                  * poll cycles, otherwise we won't leave RUNNING state as long
1043                  * as link remains down.
1044                  */
1045                 if (!phydev->link && phydev->state == PHY_RUNNING) {
1046                         phydev->state = PHY_CHANGELINK;
1047                         phydev_err(phydev, "no link in PHY_RUNNING\n");
1048                 }
1049                 break;
1050         case PHY_CHANGELINK:
1051                 err = phy_read_status(phydev);
1052                 if (err)
1053                         break;
1054
1055                 if (phydev->link) {
1056                         phydev->state = PHY_RUNNING;
1057                         phy_link_up(phydev);
1058                 } else {
1059                         phydev->state = PHY_NOLINK;
1060                         phy_link_down(phydev, true);
1061                 }
1062                 break;
1063         case PHY_HALTED:
1064                 if (phydev->link) {
1065                         phydev->link = 0;
1066                         phy_link_down(phydev, true);
1067                         do_suspend = true;
1068                 }
1069                 break;
1070         case PHY_RESUMING:
1071                 if (AUTONEG_ENABLE == phydev->autoneg) {
1072                         err = phy_aneg_done(phydev);
1073                         if (err < 0)
1074                                 break;
1075
1076                         /* err > 0 if AN is done.
1077                          * Otherwise, it's 0, and we're  still waiting for AN
1078                          */
1079                         if (err > 0) {
1080                                 err = phy_read_status(phydev);
1081                                 if (err)
1082                                         break;
1083
1084                                 if (phydev->link) {
1085                                         phydev->state = PHY_RUNNING;
1086                                         phy_link_up(phydev);
1087                                 } else  {
1088                                         phydev->state = PHY_NOLINK;
1089                                         phy_link_down(phydev, false);
1090                                 }
1091                         } else {
1092                                 phydev->state = PHY_AN;
1093                                 phydev->link_timeout = PHY_AN_TIMEOUT;
1094                         }
1095                 } else {
1096                         err = phy_read_status(phydev);
1097                         if (err)
1098                                 break;
1099
1100                         if (phydev->link) {
1101                                 phydev->state = PHY_RUNNING;
1102                                 phy_link_up(phydev);
1103                         } else  {
1104                                 phydev->state = PHY_NOLINK;
1105                                 phy_link_down(phydev, false);
1106                         }
1107                 }
1108                 break;
1109         }
1110
1111         mutex_unlock(&phydev->lock);
1112
1113         if (needs_aneg)
1114                 err = phy_start_aneg_priv(phydev, false);
1115         else if (do_suspend)
1116                 phy_suspend(phydev);
1117
1118         if (err < 0)
1119                 phy_error(phydev);
1120
1121         if (old_state != phydev->state)
1122                 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1123                            phy_state_to_str(old_state),
1124                            phy_state_to_str(phydev->state));
1125
1126         /* Only re-schedule a PHY state machine change if we are polling the
1127          * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1128          * between states from phy_mac_interrupt().
1129          *
1130          * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1131          * state machine would be pointless and possibly error prone when
1132          * called from phy_disconnect() synchronously.
1133          */
1134         if (phy_polling_mode(phydev) && old_state != PHY_HALTED)
1135                 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1136 }
1137
1138 /**
1139  * phy_mac_interrupt - MAC says the link has changed
1140  * @phydev: phy_device struct with changed link
1141  *
1142  * The MAC layer is able to indicate there has been a change in the PHY link
1143  * status. Trigger the state machine and work a work queue.
1144  */
1145 void phy_mac_interrupt(struct phy_device *phydev)
1146 {
1147         /* Trigger a state machine change */
1148         queue_work(system_power_efficient_wq, &phydev->phy_queue);
1149 }
1150 EXPORT_SYMBOL(phy_mac_interrupt);
1151
1152 /**
1153  * phy_init_eee - init and check the EEE feature
1154  * @phydev: target phy_device struct
1155  * @clk_stop_enable: PHY may stop the clock during LPI
1156  *
1157  * Description: it checks if the Energy-Efficient Ethernet (EEE)
1158  * is supported by looking at the MMD registers 3.20 and 7.60/61
1159  * and it programs the MMD register 3.0 setting the "Clock stop enable"
1160  * bit if required.
1161  */
1162 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1163 {
1164         if (!phydev->drv)
1165                 return -EIO;
1166
1167         /* According to 802.3az,the EEE is supported only in full duplex-mode.
1168          */
1169         if (phydev->duplex == DUPLEX_FULL) {
1170                 int eee_lp, eee_cap, eee_adv;
1171                 u32 lp, cap, adv;
1172                 int status;
1173
1174                 /* Read phy status to properly get the right settings */
1175                 status = phy_read_status(phydev);
1176                 if (status)
1177                         return status;
1178
1179                 /* First check if the EEE ability is supported */
1180                 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1181                 if (eee_cap <= 0)
1182                         goto eee_exit_err;
1183
1184                 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1185                 if (!cap)
1186                         goto eee_exit_err;
1187
1188                 /* Check which link settings negotiated and verify it in
1189                  * the EEE advertising registers.
1190                  */
1191                 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1192                 if (eee_lp <= 0)
1193                         goto eee_exit_err;
1194
1195                 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1196                 if (eee_adv <= 0)
1197                         goto eee_exit_err;
1198
1199                 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1200                 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1201                 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1202                         goto eee_exit_err;
1203
1204                 if (clk_stop_enable) {
1205                         /* Configure the PHY to stop receiving xMII
1206                          * clock while it is signaling LPI.
1207                          */
1208                         int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1209                         if (val < 0)
1210                                 return val;
1211
1212                         val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1213                         phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1214                 }
1215
1216                 return 0; /* EEE supported */
1217         }
1218 eee_exit_err:
1219         return -EPROTONOSUPPORT;
1220 }
1221 EXPORT_SYMBOL(phy_init_eee);
1222
1223 /**
1224  * phy_get_eee_err - report the EEE wake error count
1225  * @phydev: target phy_device struct
1226  *
1227  * Description: it is to report the number of time where the PHY
1228  * failed to complete its normal wake sequence.
1229  */
1230 int phy_get_eee_err(struct phy_device *phydev)
1231 {
1232         if (!phydev->drv)
1233                 return -EIO;
1234
1235         return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1236 }
1237 EXPORT_SYMBOL(phy_get_eee_err);
1238
1239 /**
1240  * phy_ethtool_get_eee - get EEE supported and status
1241  * @phydev: target phy_device struct
1242  * @data: ethtool_eee data
1243  *
1244  * Description: it reportes the Supported/Advertisement/LP Advertisement
1245  * capabilities.
1246  */
1247 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1248 {
1249         int val;
1250
1251         if (!phydev->drv)
1252                 return -EIO;
1253
1254         /* Get Supported EEE */
1255         val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1256         if (val < 0)
1257                 return val;
1258         data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1259
1260         /* Get advertisement EEE */
1261         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1262         if (val < 0)
1263                 return val;
1264         data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1265
1266         /* Get LP advertisement EEE */
1267         val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1268         if (val < 0)
1269                 return val;
1270         data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1271
1272         return 0;
1273 }
1274 EXPORT_SYMBOL(phy_ethtool_get_eee);
1275
1276 /**
1277  * phy_ethtool_set_eee - set EEE supported and status
1278  * @phydev: target phy_device struct
1279  * @data: ethtool_eee data
1280  *
1281  * Description: it is to program the Advertisement EEE register.
1282  */
1283 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1284 {
1285         int cap, old_adv, adv, ret;
1286
1287         if (!phydev->drv)
1288                 return -EIO;
1289
1290         /* Get Supported EEE */
1291         cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1292         if (cap < 0)
1293                 return cap;
1294
1295         old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1296         if (old_adv < 0)
1297                 return old_adv;
1298
1299         adv = ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1300
1301         /* Mask prohibited EEE modes */
1302         adv &= ~phydev->eee_broken_modes;
1303
1304         if (old_adv != adv) {
1305                 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1306                 if (ret < 0)
1307                         return ret;
1308
1309                 /* Restart autonegotiation so the new modes get sent to the
1310                  * link partner.
1311                  */
1312                 ret = phy_restart_aneg(phydev);
1313                 if (ret < 0)
1314                         return ret;
1315         }
1316
1317         return 0;
1318 }
1319 EXPORT_SYMBOL(phy_ethtool_set_eee);
1320
1321 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1322 {
1323         if (phydev->drv && phydev->drv->set_wol)
1324                 return phydev->drv->set_wol(phydev, wol);
1325
1326         return -EOPNOTSUPP;
1327 }
1328 EXPORT_SYMBOL(phy_ethtool_set_wol);
1329
1330 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1331 {
1332         if (phydev->drv && phydev->drv->get_wol)
1333                 phydev->drv->get_wol(phydev, wol);
1334 }
1335 EXPORT_SYMBOL(phy_ethtool_get_wol);
1336
1337 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1338                                    struct ethtool_link_ksettings *cmd)
1339 {
1340         struct phy_device *phydev = ndev->phydev;
1341
1342         if (!phydev)
1343                 return -ENODEV;
1344
1345         phy_ethtool_ksettings_get(phydev, cmd);
1346
1347         return 0;
1348 }
1349 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1350
1351 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1352                                    const struct ethtool_link_ksettings *cmd)
1353 {
1354         struct phy_device *phydev = ndev->phydev;
1355
1356         if (!phydev)
1357                 return -ENODEV;
1358
1359         return phy_ethtool_ksettings_set(phydev, cmd);
1360 }
1361 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1362
1363 int phy_ethtool_nway_reset(struct net_device *ndev)
1364 {
1365         struct phy_device *phydev = ndev->phydev;
1366
1367         if (!phydev)
1368                 return -ENODEV;
1369
1370         if (!phydev->drv)
1371                 return -EIO;
1372
1373         return phy_restart_aneg(phydev);
1374 }
1375 EXPORT_SYMBOL(phy_ethtool_nway_reset);