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
phy_state_to_str(enum phy_state st)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 */
phy_print_status(struct phy_device * phydev)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 */
phy_clear_interrupt(struct phy_device * phydev)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 */
phy_config_interrupt(struct phy_device * phydev,u32 interrupts)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 */
phy_restart_aneg(struct phy_device * phydev)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 */
phy_aneg_done(struct phy_device * phydev)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 *
phy_find_valid(int speed,int duplex,u32 supported)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 */
phy_supported_speeds(struct phy_device * phy,unsigned int * speeds,unsigned int size)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 */
phy_check_valid(int speed,int duplex,u32 features)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 */
phy_sanitize_settings(struct phy_device * phydev)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 */
phy_ethtool_sset(struct phy_device * phydev,struct ethtool_cmd * cmd)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
phy_ethtool_ksettings_set(struct phy_device * phydev,const struct ethtool_link_ksettings * cmd)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
phy_ethtool_ksettings_get(struct phy_device * phydev,struct ethtool_link_ksettings * cmd)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 */
phy_mii_ioctl(struct phy_device * phydev,struct ifreq * ifr,int cmd)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 /**
471 * phy_start_aneg_priv - start auto-negotiation for this PHY device
472 * @phydev: the phy_device struct
473 * @sync: indicate whether we should wait for the workqueue cancelation
474 *
475 * Description: Sanitizes the settings (if we're not autonegotiating
476 * them), and then calls the driver's config_aneg function.
477 * If the PHYCONTROL Layer is operating, we change the state to
478 * reflect the beginning of Auto-negotiation or forcing.
479 */
phy_start_aneg_priv(struct phy_device * phydev,bool sync)480 static int phy_start_aneg_priv(struct phy_device *phydev, bool sync)
481 {
482 bool trigger = 0;
483 int err;
484
485 if (!phydev->drv)
486 return -EIO;
487
488 mutex_lock(&phydev->lock);
489
490 if (AUTONEG_DISABLE == phydev->autoneg)
491 phy_sanitize_settings(phydev);
492
493 /* Invalidate LP advertising flags */
494 phydev->lp_advertising = 0;
495
496 err = phydev->drv->config_aneg(phydev);
497 if (err < 0)
498 goto out_unlock;
499
500 if (phydev->state != PHY_HALTED) {
501 if (AUTONEG_ENABLE == phydev->autoneg) {
502 phydev->state = PHY_AN;
503 phydev->link_timeout = PHY_AN_TIMEOUT;
504 } else {
505 phydev->state = PHY_FORCING;
506 phydev->link_timeout = PHY_FORCE_TIMEOUT;
507 }
508 }
509
510 /* Re-schedule a PHY state machine to check PHY status because
511 * negotiation may already be done and aneg interrupt may not be
512 * generated.
513 */
514 if (phydev->irq != PHY_POLL && phydev->state == PHY_AN) {
515 err = phy_aneg_done(phydev);
516 if (err > 0) {
517 trigger = true;
518 err = 0;
519 }
520 }
521
522 out_unlock:
523 mutex_unlock(&phydev->lock);
524
525 if (trigger)
526 phy_trigger_machine(phydev, sync);
527
528 return err;
529 }
530
531 /**
532 * phy_start_aneg - start auto-negotiation for this PHY device
533 * @phydev: the phy_device struct
534 *
535 * Description: Sanitizes the settings (if we're not autonegotiating
536 * them), and then calls the driver's config_aneg function.
537 * If the PHYCONTROL Layer is operating, we change the state to
538 * reflect the beginning of Auto-negotiation or forcing.
539 */
phy_start_aneg(struct phy_device * phydev)540 int phy_start_aneg(struct phy_device *phydev)
541 {
542 return phy_start_aneg_priv(phydev, true);
543 }
544 EXPORT_SYMBOL(phy_start_aneg);
545
546 /**
547 * phy_start_machine - start PHY state machine tracking
548 * @phydev: the phy_device struct
549 *
550 * Description: The PHY infrastructure can run a state machine
551 * which tracks whether the PHY is starting up, negotiating,
552 * etc. This function starts the delayed workqueue which tracks
553 * the state of the PHY. If you want to maintain your own state machine,
554 * do not call this function.
555 */
phy_start_machine(struct phy_device * phydev)556 void phy_start_machine(struct phy_device *phydev)
557 {
558 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
559 }
560 EXPORT_SYMBOL_GPL(phy_start_machine);
561
562 /**
563 * phy_trigger_machine - trigger the state machine to run
564 *
565 * @phydev: the phy_device struct
566 * @sync: indicate whether we should wait for the workqueue cancelation
567 *
568 * Description: There has been a change in state which requires that the
569 * state machine runs.
570 */
571
phy_trigger_machine(struct phy_device * phydev,bool sync)572 void phy_trigger_machine(struct phy_device *phydev, bool sync)
573 {
574 if (sync)
575 cancel_delayed_work_sync(&phydev->state_queue);
576 else
577 cancel_delayed_work(&phydev->state_queue);
578 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
579 }
580
581 /**
582 * phy_stop_machine - stop the PHY state machine tracking
583 * @phydev: target phy_device struct
584 *
585 * Description: Stops the state machine delayed workqueue, sets the
586 * state to UP (unless it wasn't up yet). This function must be
587 * called BEFORE phy_detach.
588 */
phy_stop_machine(struct phy_device * phydev)589 void phy_stop_machine(struct phy_device *phydev)
590 {
591 cancel_delayed_work_sync(&phydev->state_queue);
592
593 mutex_lock(&phydev->lock);
594 if (phydev->state > PHY_UP && phydev->state != PHY_HALTED)
595 phydev->state = PHY_UP;
596 mutex_unlock(&phydev->lock);
597 }
598
599 /**
600 * phy_error - enter HALTED state for this PHY device
601 * @phydev: target phy_device struct
602 *
603 * Moves the PHY to the HALTED state in response to a read
604 * or write error, and tells the controller the link is down.
605 * Must not be called from interrupt context, or while the
606 * phydev->lock is held.
607 */
phy_error(struct phy_device * phydev)608 static void phy_error(struct phy_device *phydev)
609 {
610 mutex_lock(&phydev->lock);
611 phydev->state = PHY_HALTED;
612 mutex_unlock(&phydev->lock);
613
614 phy_trigger_machine(phydev, false);
615 }
616
617 /**
618 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
619 * @phydev: target phy_device struct
620 */
phy_disable_interrupts(struct phy_device * phydev)621 static int phy_disable_interrupts(struct phy_device *phydev)
622 {
623 int err;
624
625 /* Disable PHY interrupts */
626 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
627 if (err)
628 goto phy_err;
629
630 /* Clear the interrupt */
631 err = phy_clear_interrupt(phydev);
632 if (err)
633 goto phy_err;
634
635 return 0;
636
637 phy_err:
638 phy_error(phydev);
639
640 return err;
641 }
642
643 /**
644 * phy_change - Called by the phy_interrupt to handle PHY changes
645 * @phydev: phy_device struct that interrupted
646 */
phy_change(struct phy_device * phydev)647 static irqreturn_t phy_change(struct phy_device *phydev)
648 {
649 if (phy_interrupt_is_valid(phydev)) {
650 if (phydev->drv->did_interrupt &&
651 !phydev->drv->did_interrupt(phydev))
652 goto ignore;
653
654 if (phy_disable_interrupts(phydev))
655 goto phy_err;
656 }
657
658 mutex_lock(&phydev->lock);
659 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
660 phydev->state = PHY_CHANGELINK;
661 mutex_unlock(&phydev->lock);
662
663 if (phy_interrupt_is_valid(phydev)) {
664 atomic_dec(&phydev->irq_disable);
665 enable_irq(phydev->irq);
666
667 /* Reenable interrupts */
668 if (PHY_HALTED != phydev->state &&
669 phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
670 goto irq_enable_err;
671 }
672
673 /* reschedule state queue work to run as soon as possible */
674 phy_trigger_machine(phydev, true);
675 return IRQ_HANDLED;
676
677 ignore:
678 atomic_dec(&phydev->irq_disable);
679 enable_irq(phydev->irq);
680 return IRQ_NONE;
681
682 irq_enable_err:
683 disable_irq(phydev->irq);
684 atomic_inc(&phydev->irq_disable);
685 phy_err:
686 phy_error(phydev);
687 return IRQ_NONE;
688 }
689
690 /**
691 * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
692 * @work: work_struct that describes the work to be done
693 */
phy_change_work(struct work_struct * work)694 void phy_change_work(struct work_struct *work)
695 {
696 struct phy_device *phydev =
697 container_of(work, struct phy_device, phy_queue);
698
699 phy_change(phydev);
700 }
701
702 /**
703 * phy_interrupt - PHY interrupt handler
704 * @irq: interrupt line
705 * @phy_dat: phy_device pointer
706 *
707 * Description: When a PHY interrupt occurs, the handler disables
708 * interrupts, and uses phy_change to handle the interrupt.
709 */
phy_interrupt(int irq,void * phy_dat)710 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
711 {
712 struct phy_device *phydev = phy_dat;
713
714 if (PHY_HALTED == phydev->state)
715 return IRQ_NONE; /* It can't be ours. */
716
717 disable_irq_nosync(irq);
718 atomic_inc(&phydev->irq_disable);
719
720 return phy_change(phydev);
721 }
722
723 /**
724 * phy_enable_interrupts - Enable the interrupts from the PHY side
725 * @phydev: target phy_device struct
726 */
phy_enable_interrupts(struct phy_device * phydev)727 static int phy_enable_interrupts(struct phy_device *phydev)
728 {
729 int err = phy_clear_interrupt(phydev);
730
731 if (err < 0)
732 return err;
733
734 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
735 }
736
737 /**
738 * phy_start_interrupts - request and enable interrupts for a PHY device
739 * @phydev: target phy_device struct
740 *
741 * Description: Request the interrupt for the given PHY.
742 * If this fails, then we set irq to PHY_POLL.
743 * Otherwise, we enable the interrupts in the PHY.
744 * This should only be called with a valid IRQ number.
745 * Returns 0 on success or < 0 on error.
746 */
phy_start_interrupts(struct phy_device * phydev)747 int phy_start_interrupts(struct phy_device *phydev)
748 {
749 atomic_set(&phydev->irq_disable, 0);
750 if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
751 IRQF_ONESHOT | IRQF_SHARED,
752 phydev_name(phydev), phydev) < 0) {
753 pr_warn("%s: Can't get IRQ %d (PHY)\n",
754 phydev->mdio.bus->name, phydev->irq);
755 phydev->irq = PHY_POLL;
756 return 0;
757 }
758
759 return phy_enable_interrupts(phydev);
760 }
761 EXPORT_SYMBOL(phy_start_interrupts);
762
763 /**
764 * phy_stop_interrupts - disable interrupts from a PHY device
765 * @phydev: target phy_device struct
766 */
phy_stop_interrupts(struct phy_device * phydev)767 int phy_stop_interrupts(struct phy_device *phydev)
768 {
769 int err = phy_disable_interrupts(phydev);
770
771 if (err)
772 phy_error(phydev);
773
774 free_irq(phydev->irq, phydev);
775
776 /* If work indeed has been cancelled, disable_irq() will have
777 * been left unbalanced from phy_interrupt() and enable_irq()
778 * has to be called so that other devices on the line work.
779 */
780 while (atomic_dec_return(&phydev->irq_disable) >= 0)
781 enable_irq(phydev->irq);
782
783 return err;
784 }
785 EXPORT_SYMBOL(phy_stop_interrupts);
786
787 /**
788 * phy_stop - Bring down the PHY link, and stop checking the status
789 * @phydev: target phy_device struct
790 */
phy_stop(struct phy_device * phydev)791 void phy_stop(struct phy_device *phydev)
792 {
793 mutex_lock(&phydev->lock);
794
795 if (PHY_HALTED == phydev->state)
796 goto out_unlock;
797
798 if (phy_interrupt_is_valid(phydev)) {
799 /* Disable PHY Interrupts */
800 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
801
802 /* Clear any pending interrupts */
803 phy_clear_interrupt(phydev);
804 }
805
806 phydev->state = PHY_HALTED;
807
808 out_unlock:
809 mutex_unlock(&phydev->lock);
810
811 /* Cannot call flush_scheduled_work() here as desired because
812 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
813 * will not reenable interrupts.
814 */
815 }
816 EXPORT_SYMBOL(phy_stop);
817
818 /**
819 * phy_start - start or restart a PHY device
820 * @phydev: target phy_device struct
821 *
822 * Description: Indicates the attached device's readiness to
823 * handle PHY-related work. Used during startup to start the
824 * PHY, and after a call to phy_stop() to resume operation.
825 * Also used to indicate the MDIO bus has cleared an error
826 * condition.
827 */
phy_start(struct phy_device * phydev)828 void phy_start(struct phy_device *phydev)
829 {
830 int err = 0;
831
832 mutex_lock(&phydev->lock);
833
834 switch (phydev->state) {
835 case PHY_STARTING:
836 phydev->state = PHY_PENDING;
837 break;
838 case PHY_READY:
839 phydev->state = PHY_UP;
840 break;
841 case PHY_HALTED:
842 /* if phy was suspended, bring the physical link up again */
843 __phy_resume(phydev);
844
845 /* make sure interrupts are re-enabled for the PHY */
846 if (phy_interrupt_is_valid(phydev)) {
847 err = phy_enable_interrupts(phydev);
848 if (err < 0)
849 break;
850 }
851
852 phydev->state = PHY_RESUMING;
853 break;
854 default:
855 break;
856 }
857 mutex_unlock(&phydev->lock);
858
859 phy_trigger_machine(phydev, true);
860 }
861 EXPORT_SYMBOL(phy_start);
862
phy_link_up(struct phy_device * phydev)863 static void phy_link_up(struct phy_device *phydev)
864 {
865 phydev->phy_link_change(phydev, true, true);
866 phy_led_trigger_change_speed(phydev);
867 }
868
phy_link_down(struct phy_device * phydev,bool do_carrier)869 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
870 {
871 phydev->phy_link_change(phydev, false, do_carrier);
872 phy_led_trigger_change_speed(phydev);
873 }
874
875 /**
876 * phy_state_machine - Handle the state machine
877 * @work: work_struct that describes the work to be done
878 */
phy_state_machine(struct work_struct * work)879 void phy_state_machine(struct work_struct *work)
880 {
881 struct delayed_work *dwork = to_delayed_work(work);
882 struct phy_device *phydev =
883 container_of(dwork, struct phy_device, state_queue);
884 bool needs_aneg = false, do_suspend = false;
885 enum phy_state old_state;
886 int err = 0;
887 int old_link;
888
889 mutex_lock(&phydev->lock);
890
891 old_state = phydev->state;
892
893 if (phydev->drv && phydev->drv->link_change_notify)
894 phydev->drv->link_change_notify(phydev);
895
896 switch (phydev->state) {
897 case PHY_DOWN:
898 case PHY_STARTING:
899 case PHY_READY:
900 case PHY_PENDING:
901 break;
902 case PHY_UP:
903 needs_aneg = true;
904
905 phydev->link_timeout = PHY_AN_TIMEOUT;
906
907 break;
908 case PHY_AN:
909 err = phy_read_status(phydev);
910 if (err < 0)
911 break;
912
913 /* If the link is down, give up on negotiation for now */
914 if (!phydev->link) {
915 phydev->state = PHY_NOLINK;
916 phy_link_down(phydev, true);
917 break;
918 }
919
920 /* Check if negotiation is done. Break if there's an error */
921 err = phy_aneg_done(phydev);
922 if (err < 0)
923 break;
924
925 /* If AN is done, we're running */
926 if (err > 0) {
927 phydev->state = PHY_RUNNING;
928 phy_link_up(phydev);
929 } else if (0 == phydev->link_timeout--)
930 needs_aneg = true;
931 break;
932 case PHY_NOLINK:
933 if (phy_interrupt_is_valid(phydev))
934 break;
935
936 err = phy_read_status(phydev);
937 if (err)
938 break;
939
940 if (phydev->link) {
941 if (AUTONEG_ENABLE == phydev->autoneg) {
942 err = phy_aneg_done(phydev);
943 if (err < 0)
944 break;
945
946 if (!err) {
947 phydev->state = PHY_AN;
948 phydev->link_timeout = PHY_AN_TIMEOUT;
949 break;
950 }
951 }
952 phydev->state = PHY_RUNNING;
953 phy_link_up(phydev);
954 }
955 break;
956 case PHY_FORCING:
957 err = genphy_update_link(phydev);
958 if (err)
959 break;
960
961 if (phydev->link) {
962 phydev->state = PHY_RUNNING;
963 phy_link_up(phydev);
964 } else {
965 if (0 == phydev->link_timeout--)
966 needs_aneg = true;
967 phy_link_down(phydev, false);
968 }
969 break;
970 case PHY_RUNNING:
971 /* Only register a CHANGE if we are polling and link changed
972 * since latest checking.
973 */
974 if (phydev->irq == PHY_POLL) {
975 old_link = phydev->link;
976 err = phy_read_status(phydev);
977 if (err)
978 break;
979
980 if (old_link != phydev->link)
981 phydev->state = PHY_CHANGELINK;
982 }
983 /*
984 * Failsafe: check that nobody set phydev->link=0 between two
985 * poll cycles, otherwise we won't leave RUNNING state as long
986 * as link remains down.
987 */
988 if (!phydev->link && phydev->state == PHY_RUNNING) {
989 phydev->state = PHY_CHANGELINK;
990 phydev_err(phydev, "no link in PHY_RUNNING\n");
991 }
992 break;
993 case PHY_CHANGELINK:
994 err = phy_read_status(phydev);
995 if (err)
996 break;
997
998 if (phydev->link) {
999 phydev->state = PHY_RUNNING;
1000 phy_link_up(phydev);
1001 } else {
1002 phydev->state = PHY_NOLINK;
1003 phy_link_down(phydev, true);
1004 }
1005
1006 if (phy_interrupt_is_valid(phydev))
1007 err = phy_config_interrupt(phydev,
1008 PHY_INTERRUPT_ENABLED);
1009 break;
1010 case PHY_HALTED:
1011 if (phydev->link) {
1012 phydev->link = 0;
1013 phy_link_down(phydev, true);
1014 do_suspend = true;
1015 }
1016 break;
1017 case PHY_RESUMING:
1018 if (AUTONEG_ENABLE == phydev->autoneg) {
1019 err = phy_aneg_done(phydev);
1020 if (err < 0)
1021 break;
1022
1023 /* err > 0 if AN is done.
1024 * Otherwise, it's 0, and we're still waiting for AN
1025 */
1026 if (err > 0) {
1027 err = phy_read_status(phydev);
1028 if (err)
1029 break;
1030
1031 if (phydev->link) {
1032 phydev->state = PHY_RUNNING;
1033 phy_link_up(phydev);
1034 } else {
1035 phydev->state = PHY_NOLINK;
1036 phy_link_down(phydev, false);
1037 }
1038 } else {
1039 phydev->state = PHY_AN;
1040 phydev->link_timeout = PHY_AN_TIMEOUT;
1041 }
1042 } else {
1043 err = phy_read_status(phydev);
1044 if (err)
1045 break;
1046
1047 if (phydev->link) {
1048 phydev->state = PHY_RUNNING;
1049 phy_link_up(phydev);
1050 } else {
1051 phydev->state = PHY_NOLINK;
1052 phy_link_down(phydev, false);
1053 }
1054 }
1055 break;
1056 }
1057
1058 mutex_unlock(&phydev->lock);
1059
1060 if (needs_aneg)
1061 err = phy_start_aneg_priv(phydev, false);
1062 else if (do_suspend)
1063 phy_suspend(phydev);
1064
1065 if (err < 0)
1066 phy_error(phydev);
1067
1068 if (old_state != phydev->state)
1069 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1070 phy_state_to_str(old_state),
1071 phy_state_to_str(phydev->state));
1072
1073 /* Only re-schedule a PHY state machine change if we are polling the
1074 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1075 * between states from phy_mac_interrupt()
1076 */
1077 if (phydev->irq == PHY_POLL)
1078 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
1079 PHY_STATE_TIME * HZ);
1080 }
1081
1082 /**
1083 * phy_mac_interrupt - MAC says the link has changed
1084 * @phydev: phy_device struct with changed link
1085 * @new_link: Link is Up/Down.
1086 *
1087 * Description: The MAC layer is able indicate there has been a change
1088 * in the PHY link status. Set the new link status, and trigger the
1089 * state machine, work a work queue.
1090 */
phy_mac_interrupt(struct phy_device * phydev,int new_link)1091 void phy_mac_interrupt(struct phy_device *phydev, int new_link)
1092 {
1093 phydev->link = new_link;
1094
1095 /* Trigger a state machine change */
1096 queue_work(system_power_efficient_wq, &phydev->phy_queue);
1097 }
1098 EXPORT_SYMBOL(phy_mac_interrupt);
1099
1100 /**
1101 * phy_init_eee - init and check the EEE feature
1102 * @phydev: target phy_device struct
1103 * @clk_stop_enable: PHY may stop the clock during LPI
1104 *
1105 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1106 * is supported by looking at the MMD registers 3.20 and 7.60/61
1107 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1108 * bit if required.
1109 */
phy_init_eee(struct phy_device * phydev,bool clk_stop_enable)1110 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1111 {
1112 if (!phydev->drv)
1113 return -EIO;
1114
1115 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1116 */
1117 if (phydev->duplex == DUPLEX_FULL) {
1118 int eee_lp, eee_cap, eee_adv;
1119 u32 lp, cap, adv;
1120 int status;
1121
1122 /* Read phy status to properly get the right settings */
1123 status = phy_read_status(phydev);
1124 if (status)
1125 return status;
1126
1127 /* First check if the EEE ability is supported */
1128 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1129 if (eee_cap <= 0)
1130 goto eee_exit_err;
1131
1132 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1133 if (!cap)
1134 goto eee_exit_err;
1135
1136 /* Check which link settings negotiated and verify it in
1137 * the EEE advertising registers.
1138 */
1139 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1140 if (eee_lp <= 0)
1141 goto eee_exit_err;
1142
1143 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1144 if (eee_adv <= 0)
1145 goto eee_exit_err;
1146
1147 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1148 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1149 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1150 goto eee_exit_err;
1151
1152 if (clk_stop_enable) {
1153 /* Configure the PHY to stop receiving xMII
1154 * clock while it is signaling LPI.
1155 */
1156 int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1157 if (val < 0)
1158 return val;
1159
1160 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1161 phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1162 }
1163
1164 return 0; /* EEE supported */
1165 }
1166 eee_exit_err:
1167 return -EPROTONOSUPPORT;
1168 }
1169 EXPORT_SYMBOL(phy_init_eee);
1170
1171 /**
1172 * phy_get_eee_err - report the EEE wake error count
1173 * @phydev: target phy_device struct
1174 *
1175 * Description: it is to report the number of time where the PHY
1176 * failed to complete its normal wake sequence.
1177 */
phy_get_eee_err(struct phy_device * phydev)1178 int phy_get_eee_err(struct phy_device *phydev)
1179 {
1180 if (!phydev->drv)
1181 return -EIO;
1182
1183 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1184 }
1185 EXPORT_SYMBOL(phy_get_eee_err);
1186
1187 /**
1188 * phy_ethtool_get_eee - get EEE supported and status
1189 * @phydev: target phy_device struct
1190 * @data: ethtool_eee data
1191 *
1192 * Description: it reportes the Supported/Advertisement/LP Advertisement
1193 * capabilities.
1194 */
phy_ethtool_get_eee(struct phy_device * phydev,struct ethtool_eee * data)1195 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1196 {
1197 int val;
1198
1199 if (!phydev->drv)
1200 return -EIO;
1201
1202 /* Get Supported EEE */
1203 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1204 if (val < 0)
1205 return val;
1206 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1207
1208 /* Get advertisement EEE */
1209 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1210 if (val < 0)
1211 return val;
1212 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1213
1214 /* Get LP advertisement EEE */
1215 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1216 if (val < 0)
1217 return val;
1218 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1219
1220 return 0;
1221 }
1222 EXPORT_SYMBOL(phy_ethtool_get_eee);
1223
1224 /**
1225 * phy_ethtool_set_eee - set EEE supported and status
1226 * @phydev: target phy_device struct
1227 * @data: ethtool_eee data
1228 *
1229 * Description: it is to program the Advertisement EEE register.
1230 */
phy_ethtool_set_eee(struct phy_device * phydev,struct ethtool_eee * data)1231 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1232 {
1233 int cap, old_adv, adv, ret;
1234
1235 if (!phydev->drv)
1236 return -EIO;
1237
1238 /* Get Supported EEE */
1239 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1240 if (cap < 0)
1241 return cap;
1242
1243 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1244 if (old_adv < 0)
1245 return old_adv;
1246
1247 adv = ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1248
1249 /* Mask prohibited EEE modes */
1250 adv &= ~phydev->eee_broken_modes;
1251
1252 if (old_adv != adv) {
1253 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1254 if (ret < 0)
1255 return ret;
1256
1257 /* Restart autonegotiation so the new modes get sent to the
1258 * link partner.
1259 */
1260 ret = phy_restart_aneg(phydev);
1261 if (ret < 0)
1262 return ret;
1263 }
1264
1265 return 0;
1266 }
1267 EXPORT_SYMBOL(phy_ethtool_set_eee);
1268
phy_ethtool_set_wol(struct phy_device * phydev,struct ethtool_wolinfo * wol)1269 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1270 {
1271 if (phydev->drv && phydev->drv->set_wol)
1272 return phydev->drv->set_wol(phydev, wol);
1273
1274 return -EOPNOTSUPP;
1275 }
1276 EXPORT_SYMBOL(phy_ethtool_set_wol);
1277
phy_ethtool_get_wol(struct phy_device * phydev,struct ethtool_wolinfo * wol)1278 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1279 {
1280 if (phydev->drv && phydev->drv->get_wol)
1281 phydev->drv->get_wol(phydev, wol);
1282 }
1283 EXPORT_SYMBOL(phy_ethtool_get_wol);
1284
phy_ethtool_get_link_ksettings(struct net_device * ndev,struct ethtool_link_ksettings * cmd)1285 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1286 struct ethtool_link_ksettings *cmd)
1287 {
1288 struct phy_device *phydev = ndev->phydev;
1289
1290 if (!phydev)
1291 return -ENODEV;
1292
1293 phy_ethtool_ksettings_get(phydev, cmd);
1294
1295 return 0;
1296 }
1297 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1298
phy_ethtool_set_link_ksettings(struct net_device * ndev,const struct ethtool_link_ksettings * cmd)1299 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1300 const struct ethtool_link_ksettings *cmd)
1301 {
1302 struct phy_device *phydev = ndev->phydev;
1303
1304 if (!phydev)
1305 return -ENODEV;
1306
1307 return phy_ethtool_ksettings_set(phydev, cmd);
1308 }
1309 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1310
phy_ethtool_nway_reset(struct net_device * ndev)1311 int phy_ethtool_nway_reset(struct net_device *ndev)
1312 {
1313 struct phy_device *phydev = ndev->phydev;
1314
1315 if (!phydev)
1316 return -ENODEV;
1317
1318 if (!phydev->drv)
1319 return -EIO;
1320
1321 return phy_restart_aneg(phydev);
1322 }
1323 EXPORT_SYMBOL(phy_ethtool_nway_reset);
1324