1 /* Framework for configuring and reading PHY devices
2 * Based on code in sungem_phy.c and gianfar_phy.c
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
7 * Copyright (c) 2006, 2007 Maciej W. Rozycki
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.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
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>
36 #include <linux/uaccess.h>
37 #include <linux/atomic.h>
41 #define PHY_STATE_STR(_state) \
43 return __stringify(_state); \
45 static const char *phy_state_to_str(enum phy_state st)
49 PHY_STATE_STR(STARTING
)
51 PHY_STATE_STR(PENDING
)
54 PHY_STATE_STR(RUNNING
)
56 PHY_STATE_STR(FORCING
)
57 PHY_STATE_STR(CHANGELINK
)
59 PHY_STATE_STR(RESUMING
)
67 * phy_print_status - Convenience function to print out the current phy status
68 * @phydev: the phy_device struct
70 void phy_print_status(struct phy_device
*phydev
)
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");
79 netdev_info(phydev
->attached_dev
, "Link is Down\n");
82 EXPORT_SYMBOL(phy_print_status
);
85 * phy_clear_interrupt - Ack the phy device's interrupt
86 * @phydev: the phy_device struct
88 * If the @phydev driver has an ack_interrupt function, call it to
89 * ack and clear the phy device's interrupt.
91 * Returns 0 on success or < 0 on error.
93 static int phy_clear_interrupt(struct phy_device
*phydev
)
95 if (phydev
->drv
->ack_interrupt
)
96 return phydev
->drv
->ack_interrupt(phydev
);
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
106 * Returns 0 on success or < 0 on error.
108 static int phy_config_interrupt(struct phy_device
*phydev
, u32 interrupts
)
110 phydev
->interrupts
= interrupts
;
111 if (phydev
->drv
->config_intr
)
112 return phydev
->drv
->config_intr(phydev
);
118 * phy_restart_aneg - restart auto-negotiation
119 * @phydev: target phy_device struct
121 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
122 * negative errno on error.
124 int phy_restart_aneg(struct phy_device
*phydev
)
128 if (phydev
->is_c45
&& !(phydev
->c45_ids
.devices_in_package
& BIT(0)))
129 ret
= genphy_c45_restart_aneg(phydev
);
131 ret
= genphy_restart_aneg(phydev
);
135 EXPORT_SYMBOL_GPL(phy_restart_aneg
);
138 * phy_aneg_done - return auto-negotiation status
139 * @phydev: target phy_device struct
141 * Description: Return the auto-negotiation status from this @phydev
142 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
145 int phy_aneg_done(struct phy_device
*phydev
)
147 if (phydev
->drv
&& phydev
->drv
->aneg_done
)
148 return phydev
->drv
->aneg_done(phydev
);
150 /* Avoid genphy_aneg_done() if the Clause 45 PHY does not
151 * implement Clause 22 registers
153 if (phydev
->is_c45
&& !(phydev
->c45_ids
.devices_in_package
& BIT(0)))
156 return genphy_aneg_done(phydev
);
158 EXPORT_SYMBOL(phy_aneg_done
);
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
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.
173 static const struct phy_setting
*
174 phy_find_valid(int speed
, int duplex
, u32 supported
)
176 unsigned long mask
= supported
;
178 return phy_lookup_setting(speed
, duplex
, &mask
, BITS_PER_LONG
, false);
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.
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.
191 unsigned int phy_supported_speeds(struct phy_device
*phy
,
192 unsigned int *speeds
,
195 unsigned long supported
= phy
->supported
;
197 return phy_speeds(speeds
, size
, &supported
, BITS_PER_LONG
);
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
207 * Description: Returns true if there is a valid setting, false otherwise.
209 static inline bool phy_check_valid(int speed
, int duplex
, u32 features
)
211 unsigned long mask
= features
;
213 return !!phy_lookup_setting(speed
, duplex
, &mask
, BITS_PER_LONG
, true);
217 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
218 * @phydev: the target phy_device struct
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.
224 static void phy_sanitize_settings(struct phy_device
*phydev
)
226 const struct phy_setting
*setting
;
227 u32 features
= phydev
->supported
;
229 /* Sanitize settings based on PHY capabilities */
230 if ((features
& SUPPORTED_Autoneg
) == 0)
231 phydev
->autoneg
= AUTONEG_DISABLE
;
233 setting
= phy_find_valid(phydev
->speed
, phydev
->duplex
, features
);
235 phydev
->speed
= setting
->speed
;
236 phydev
->duplex
= setting
->duplex
;
238 /* We failed to find anything (no supported speeds?) */
239 phydev
->speed
= SPEED_UNKNOWN
;
240 phydev
->duplex
= DUPLEX_UNKNOWN
;
245 * phy_ethtool_sset - generic ethtool sset function, handles all the details
246 * @phydev: target phy_device struct
249 * A few notes about parameter checking:
251 * - We don't set port or transceiver, so we don't care what they
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.
257 int phy_ethtool_sset(struct phy_device
*phydev
, struct ethtool_cmd
*cmd
)
259 u32 speed
= ethtool_cmd_speed(cmd
);
261 if (cmd
->phy_address
!= phydev
->mdio
.addr
)
264 /* We make sure that we don't pass unsupported values in to the PHY */
265 cmd
->advertising
&= phydev
->supported
;
267 /* Verify the settings we care about. */
268 if (cmd
->autoneg
!= AUTONEG_ENABLE
&& cmd
->autoneg
!= AUTONEG_DISABLE
)
271 if (cmd
->autoneg
== AUTONEG_ENABLE
&& cmd
->advertising
== 0)
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
)))
282 phydev
->autoneg
= cmd
->autoneg
;
284 phydev
->speed
= speed
;
286 phydev
->advertising
= cmd
->advertising
;
288 if (AUTONEG_ENABLE
== cmd
->autoneg
)
289 phydev
->advertising
|= ADVERTISED_Autoneg
;
291 phydev
->advertising
&= ~ADVERTISED_Autoneg
;
293 phydev
->duplex
= cmd
->duplex
;
295 phydev
->mdix_ctrl
= cmd
->eth_tp_mdix_ctrl
;
297 /* Restart the PHY */
298 phy_start_aneg(phydev
);
302 EXPORT_SYMBOL(phy_ethtool_sset
);
304 int phy_ethtool_ksettings_set(struct phy_device
*phydev
,
305 const struct ethtool_link_ksettings
*cmd
)
307 u8 autoneg
= cmd
->base
.autoneg
;
308 u8 duplex
= cmd
->base
.duplex
;
309 u32 speed
= cmd
->base
.speed
;
312 if (cmd
->base
.phy_address
!= phydev
->mdio
.addr
)
315 ethtool_convert_link_mode_to_legacy_u32(&advertising
,
316 cmd
->link_modes
.advertising
);
318 /* We make sure that we don't pass unsupported values in to the PHY */
319 advertising
&= phydev
->supported
;
321 /* Verify the settings we care about. */
322 if (autoneg
!= AUTONEG_ENABLE
&& autoneg
!= AUTONEG_DISABLE
)
325 if (autoneg
== AUTONEG_ENABLE
&& advertising
== 0)
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
)))
336 phydev
->autoneg
= autoneg
;
338 phydev
->speed
= speed
;
340 phydev
->advertising
= advertising
;
342 if (autoneg
== AUTONEG_ENABLE
)
343 phydev
->advertising
|= ADVERTISED_Autoneg
;
345 phydev
->advertising
&= ~ADVERTISED_Autoneg
;
347 phydev
->duplex
= duplex
;
349 phydev
->mdix_ctrl
= cmd
->base
.eth_tp_mdix_ctrl
;
351 /* Restart the PHY */
352 phy_start_aneg(phydev
);
356 EXPORT_SYMBOL(phy_ethtool_ksettings_set
);
358 void phy_ethtool_ksettings_get(struct phy_device
*phydev
,
359 struct ethtool_link_ksettings
*cmd
)
361 ethtool_convert_legacy_u32_to_link_mode(cmd
->link_modes
.supported
,
364 ethtool_convert_legacy_u32_to_link_mode(cmd
->link_modes
.advertising
,
365 phydev
->advertising
);
367 ethtool_convert_legacy_u32_to_link_mode(cmd
->link_modes
.lp_advertising
,
368 phydev
->lp_advertising
);
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
;
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
;
383 EXPORT_SYMBOL(phy_ethtool_ksettings_get
);
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
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.
395 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
)
397 struct mii_ioctl_data
*mii_data
= if_mii(ifr
);
398 u16 val
= mii_data
->val_in
;
399 bool change_autoneg
= false;
403 mii_data
->phy_id
= phydev
->mdio
.addr
;
407 mii_data
->val_out
= mdiobus_read(phydev
->mdio
.bus
,
413 if (mii_data
->phy_id
== phydev
->mdio
.addr
) {
414 switch (mii_data
->reg_num
) {
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
;
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
;
431 if (phydev
->autoneg
== AUTONEG_DISABLE
)
432 change_autoneg
= true;
433 phydev
->autoneg
= AUTONEG_ENABLE
;
437 phydev
->advertising
= mii_adv_to_ethtool_adv_t(val
);
438 change_autoneg
= true;
446 mdiobus_write(phydev
->mdio
.bus
, mii_data
->phy_id
,
447 mii_data
->reg_num
, val
);
449 if (mii_data
->phy_id
== phydev
->mdio
.addr
&&
450 mii_data
->reg_num
== MII_BMCR
&&
452 return phy_init_hw(phydev
);
455 return phy_start_aneg(phydev
);
460 if (phydev
->drv
&& phydev
->drv
->hwtstamp
)
461 return phydev
->drv
->hwtstamp(phydev
, ifr
);
468 EXPORT_SYMBOL(phy_mii_ioctl
);
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
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.
480 static int phy_start_aneg_priv(struct phy_device
*phydev
, bool sync
)
488 mutex_lock(&phydev
->lock
);
490 if (AUTONEG_DISABLE
== phydev
->autoneg
)
491 phy_sanitize_settings(phydev
);
493 /* Invalidate LP advertising flags */
494 phydev
->lp_advertising
= 0;
496 err
= phydev
->drv
->config_aneg(phydev
);
500 if (phydev
->state
!= PHY_HALTED
) {
501 if (AUTONEG_ENABLE
== phydev
->autoneg
) {
502 phydev
->state
= PHY_AN
;
503 phydev
->link_timeout
= PHY_AN_TIMEOUT
;
505 phydev
->state
= PHY_FORCING
;
506 phydev
->link_timeout
= PHY_FORCE_TIMEOUT
;
510 /* Re-schedule a PHY state machine to check PHY status because
511 * negotiation may already be done and aneg interrupt may not be
514 if (phy_interrupt_is_valid(phydev
) && (phydev
->state
== PHY_AN
)) {
515 err
= phy_aneg_done(phydev
);
523 mutex_unlock(&phydev
->lock
);
526 phy_trigger_machine(phydev
, sync
);
532 * phy_start_aneg - start auto-negotiation for this PHY device
533 * @phydev: the phy_device struct
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.
540 int phy_start_aneg(struct phy_device
*phydev
)
542 return phy_start_aneg_priv(phydev
, true);
544 EXPORT_SYMBOL(phy_start_aneg
);
547 * phy_start_machine - start PHY state machine tracking
548 * @phydev: the phy_device struct
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.
556 void phy_start_machine(struct phy_device
*phydev
)
558 queue_delayed_work(system_power_efficient_wq
, &phydev
->state_queue
, HZ
);
560 EXPORT_SYMBOL_GPL(phy_start_machine
);
563 * phy_trigger_machine - trigger the state machine to run
565 * @phydev: the phy_device struct
566 * @sync: indicate whether we should wait for the workqueue cancelation
568 * Description: There has been a change in state which requires that the
569 * state machine runs.
572 void phy_trigger_machine(struct phy_device
*phydev
, bool sync
)
575 cancel_delayed_work_sync(&phydev
->state_queue
);
577 cancel_delayed_work(&phydev
->state_queue
);
578 queue_delayed_work(system_power_efficient_wq
, &phydev
->state_queue
, 0);
582 * phy_stop_machine - stop the PHY state machine tracking
583 * @phydev: target phy_device struct
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.
589 void phy_stop_machine(struct phy_device
*phydev
)
591 cancel_delayed_work_sync(&phydev
->state_queue
);
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
);
600 * phy_error - enter HALTED state for this PHY device
601 * @phydev: target phy_device struct
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.
608 static void phy_error(struct phy_device
*phydev
)
610 mutex_lock(&phydev
->lock
);
611 phydev
->state
= PHY_HALTED
;
612 mutex_unlock(&phydev
->lock
);
614 phy_trigger_machine(phydev
, false);
618 * phy_interrupt - PHY interrupt handler
619 * @irq: interrupt line
620 * @phy_dat: phy_device pointer
622 * Description: When a PHY interrupt occurs, the handler disables
623 * interrupts, and uses phy_change to handle the interrupt.
625 static irqreturn_t
phy_interrupt(int irq
, void *phy_dat
)
627 struct phy_device
*phydev
= phy_dat
;
629 if (PHY_HALTED
== phydev
->state
)
630 return IRQ_NONE
; /* It can't be ours. */
632 disable_irq_nosync(irq
);
633 atomic_inc(&phydev
->irq_disable
);
641 * phy_enable_interrupts - Enable the interrupts from the PHY side
642 * @phydev: target phy_device struct
644 static int phy_enable_interrupts(struct phy_device
*phydev
)
646 int err
= phy_clear_interrupt(phydev
);
651 return phy_config_interrupt(phydev
, PHY_INTERRUPT_ENABLED
);
655 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
656 * @phydev: target phy_device struct
658 static int phy_disable_interrupts(struct phy_device
*phydev
)
662 /* Disable PHY interrupts */
663 err
= phy_config_interrupt(phydev
, PHY_INTERRUPT_DISABLED
);
667 /* Clear the interrupt */
668 err
= phy_clear_interrupt(phydev
);
681 * phy_start_interrupts - request and enable interrupts for a PHY device
682 * @phydev: target phy_device struct
684 * Description: Request the interrupt for the given PHY.
685 * If this fails, then we set irq to PHY_POLL.
686 * Otherwise, we enable the interrupts in the PHY.
687 * This should only be called with a valid IRQ number.
688 * Returns 0 on success or < 0 on error.
690 int phy_start_interrupts(struct phy_device
*phydev
)
692 atomic_set(&phydev
->irq_disable
, 0);
693 if (request_threaded_irq(phydev
->irq
, NULL
, phy_interrupt
,
694 IRQF_ONESHOT
| IRQF_SHARED
,
695 phydev_name(phydev
), phydev
) < 0) {
696 pr_warn("%s: Can't get IRQ %d (PHY)\n",
697 phydev
->mdio
.bus
->name
, phydev
->irq
);
698 phydev
->irq
= PHY_POLL
;
702 return phy_enable_interrupts(phydev
);
704 EXPORT_SYMBOL(phy_start_interrupts
);
707 * phy_stop_interrupts - disable interrupts from a PHY device
708 * @phydev: target phy_device struct
710 int phy_stop_interrupts(struct phy_device
*phydev
)
712 int err
= phy_disable_interrupts(phydev
);
717 free_irq(phydev
->irq
, phydev
);
719 /* If work indeed has been cancelled, disable_irq() will have
720 * been left unbalanced from phy_interrupt() and enable_irq()
721 * has to be called so that other devices on the line work.
723 while (atomic_dec_return(&phydev
->irq_disable
) >= 0)
724 enable_irq(phydev
->irq
);
728 EXPORT_SYMBOL(phy_stop_interrupts
);
731 * phy_change - Called by the phy_interrupt to handle PHY changes
732 * @phydev: phy_device struct that interrupted
734 void phy_change(struct phy_device
*phydev
)
736 if (phy_interrupt_is_valid(phydev
)) {
737 if (phydev
->drv
->did_interrupt
&&
738 !phydev
->drv
->did_interrupt(phydev
))
741 if (phy_disable_interrupts(phydev
))
745 mutex_lock(&phydev
->lock
);
746 if ((PHY_RUNNING
== phydev
->state
) || (PHY_NOLINK
== phydev
->state
))
747 phydev
->state
= PHY_CHANGELINK
;
748 mutex_unlock(&phydev
->lock
);
750 if (phy_interrupt_is_valid(phydev
)) {
751 atomic_dec(&phydev
->irq_disable
);
752 enable_irq(phydev
->irq
);
754 /* Reenable interrupts */
755 if (PHY_HALTED
!= phydev
->state
&&
756 phy_config_interrupt(phydev
, PHY_INTERRUPT_ENABLED
))
760 /* reschedule state queue work to run as soon as possible */
761 phy_trigger_machine(phydev
, true);
765 atomic_dec(&phydev
->irq_disable
);
766 enable_irq(phydev
->irq
);
770 disable_irq(phydev
->irq
);
771 atomic_inc(&phydev
->irq_disable
);
777 * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
778 * @work: work_struct that describes the work to be done
780 void phy_change_work(struct work_struct
*work
)
782 struct phy_device
*phydev
=
783 container_of(work
, struct phy_device
, phy_queue
);
789 * phy_stop - Bring down the PHY link, and stop checking the status
790 * @phydev: target phy_device struct
792 void phy_stop(struct phy_device
*phydev
)
794 mutex_lock(&phydev
->lock
);
796 if (PHY_HALTED
== phydev
->state
)
799 if (phy_interrupt_is_valid(phydev
)) {
800 /* Disable PHY Interrupts */
801 phy_config_interrupt(phydev
, PHY_INTERRUPT_DISABLED
);
803 /* Clear any pending interrupts */
804 phy_clear_interrupt(phydev
);
807 phydev
->state
= PHY_HALTED
;
810 mutex_unlock(&phydev
->lock
);
812 /* Cannot call flush_scheduled_work() here as desired because
813 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
814 * will not reenable interrupts.
817 EXPORT_SYMBOL(phy_stop
);
820 * phy_start - start or restart a PHY device
821 * @phydev: target phy_device struct
823 * Description: Indicates the attached device's readiness to
824 * handle PHY-related work. Used during startup to start the
825 * PHY, and after a call to phy_stop() to resume operation.
826 * Also used to indicate the MDIO bus has cleared an error
829 void phy_start(struct phy_device
*phydev
)
831 bool do_resume
= false;
834 mutex_lock(&phydev
->lock
);
836 switch (phydev
->state
) {
838 phydev
->state
= PHY_PENDING
;
841 phydev
->state
= PHY_UP
;
844 /* make sure interrupts are re-enabled for the PHY */
845 if (phydev
->irq
!= PHY_POLL
) {
846 err
= phy_enable_interrupts(phydev
);
851 phydev
->state
= PHY_RESUMING
;
857 mutex_unlock(&phydev
->lock
);
859 /* if phy was suspended, bring the physical link up again */
863 phy_trigger_machine(phydev
, true);
865 EXPORT_SYMBOL(phy_start
);
867 static void phy_link_up(struct phy_device
*phydev
)
869 phydev
->phy_link_change(phydev
, true, true);
870 phy_led_trigger_change_speed(phydev
);
873 static void phy_link_down(struct phy_device
*phydev
, bool do_carrier
)
875 phydev
->phy_link_change(phydev
, false, do_carrier
);
876 phy_led_trigger_change_speed(phydev
);
880 * phy_state_machine - Handle the state machine
881 * @work: work_struct that describes the work to be done
883 void phy_state_machine(struct work_struct
*work
)
885 struct delayed_work
*dwork
= to_delayed_work(work
);
886 struct phy_device
*phydev
=
887 container_of(dwork
, struct phy_device
, state_queue
);
888 bool needs_aneg
= false, do_suspend
= false;
889 enum phy_state old_state
;
893 mutex_lock(&phydev
->lock
);
895 old_state
= phydev
->state
;
897 if (phydev
->drv
&& phydev
->drv
->link_change_notify
)
898 phydev
->drv
->link_change_notify(phydev
);
900 switch (phydev
->state
) {
909 phydev
->link_timeout
= PHY_AN_TIMEOUT
;
913 err
= phy_read_status(phydev
);
917 /* If the link is down, give up on negotiation for now */
919 phydev
->state
= PHY_NOLINK
;
920 phy_link_down(phydev
, true);
924 /* Check if negotiation is done. Break if there's an error */
925 err
= phy_aneg_done(phydev
);
929 /* If AN is done, we're running */
931 phydev
->state
= PHY_RUNNING
;
933 } else if (0 == phydev
->link_timeout
--)
937 if (phy_interrupt_is_valid(phydev
))
940 err
= phy_read_status(phydev
);
945 if (AUTONEG_ENABLE
== phydev
->autoneg
) {
946 err
= phy_aneg_done(phydev
);
951 phydev
->state
= PHY_AN
;
952 phydev
->link_timeout
= PHY_AN_TIMEOUT
;
956 phydev
->state
= PHY_RUNNING
;
961 err
= genphy_update_link(phydev
);
966 phydev
->state
= PHY_RUNNING
;
969 if (0 == phydev
->link_timeout
--)
971 phy_link_down(phydev
, false);
975 /* Only register a CHANGE if we are polling and link changed
976 * since latest checking.
978 if (phydev
->irq
== PHY_POLL
) {
979 old_link
= phydev
->link
;
980 err
= phy_read_status(phydev
);
984 if (old_link
!= phydev
->link
)
985 phydev
->state
= PHY_CHANGELINK
;
988 * Failsafe: check that nobody set phydev->link=0 between two
989 * poll cycles, otherwise we won't leave RUNNING state as long
990 * as link remains down.
992 if (!phydev
->link
&& phydev
->state
== PHY_RUNNING
) {
993 phydev
->state
= PHY_CHANGELINK
;
994 phydev_err(phydev
, "no link in PHY_RUNNING\n");
998 err
= phy_read_status(phydev
);
1003 phydev
->state
= PHY_RUNNING
;
1004 phy_link_up(phydev
);
1006 phydev
->state
= PHY_NOLINK
;
1007 phy_link_down(phydev
, true);
1010 if (phy_interrupt_is_valid(phydev
))
1011 err
= phy_config_interrupt(phydev
,
1012 PHY_INTERRUPT_ENABLED
);
1017 phy_link_down(phydev
, true);
1022 if (AUTONEG_ENABLE
== phydev
->autoneg
) {
1023 err
= phy_aneg_done(phydev
);
1027 /* err > 0 if AN is done.
1028 * Otherwise, it's 0, and we're still waiting for AN
1031 err
= phy_read_status(phydev
);
1036 phydev
->state
= PHY_RUNNING
;
1037 phy_link_up(phydev
);
1039 phydev
->state
= PHY_NOLINK
;
1040 phy_link_down(phydev
, false);
1043 phydev
->state
= PHY_AN
;
1044 phydev
->link_timeout
= PHY_AN_TIMEOUT
;
1047 err
= phy_read_status(phydev
);
1052 phydev
->state
= PHY_RUNNING
;
1053 phy_link_up(phydev
);
1055 phydev
->state
= PHY_NOLINK
;
1056 phy_link_down(phydev
, false);
1062 mutex_unlock(&phydev
->lock
);
1065 err
= phy_start_aneg_priv(phydev
, false);
1066 else if (do_suspend
)
1067 phy_suspend(phydev
);
1072 if (old_state
!= phydev
->state
)
1073 phydev_dbg(phydev
, "PHY state change %s -> %s\n",
1074 phy_state_to_str(old_state
),
1075 phy_state_to_str(phydev
->state
));
1077 /* Only re-schedule a PHY state machine change if we are polling the
1078 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1079 * between states from phy_mac_interrupt()
1081 if (phydev
->irq
== PHY_POLL
)
1082 queue_delayed_work(system_power_efficient_wq
, &phydev
->state_queue
,
1083 PHY_STATE_TIME
* HZ
);
1087 * phy_mac_interrupt - MAC says the link has changed
1088 * @phydev: phy_device struct with changed link
1089 * @new_link: Link is Up/Down.
1091 * Description: The MAC layer is able indicate there has been a change
1092 * in the PHY link status. Set the new link status, and trigger the
1093 * state machine, work a work queue.
1095 void phy_mac_interrupt(struct phy_device
*phydev
, int new_link
)
1097 phydev
->link
= new_link
;
1099 /* Trigger a state machine change */
1100 queue_work(system_power_efficient_wq
, &phydev
->phy_queue
);
1102 EXPORT_SYMBOL(phy_mac_interrupt
);
1105 * phy_init_eee - init and check the EEE feature
1106 * @phydev: target phy_device struct
1107 * @clk_stop_enable: PHY may stop the clock during LPI
1109 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1110 * is supported by looking at the MMD registers 3.20 and 7.60/61
1111 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1114 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
)
1119 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1121 if (phydev
->duplex
== DUPLEX_FULL
) {
1122 int eee_lp
, eee_cap
, eee_adv
;
1126 /* Read phy status to properly get the right settings */
1127 status
= phy_read_status(phydev
);
1131 /* First check if the EEE ability is supported */
1132 eee_cap
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_ABLE
);
1136 cap
= mmd_eee_cap_to_ethtool_sup_t(eee_cap
);
1140 /* Check which link settings negotiated and verify it in
1141 * the EEE advertising registers.
1143 eee_lp
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_LPABLE
);
1147 eee_adv
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
);
1151 adv
= mmd_eee_adv_to_ethtool_adv_t(eee_adv
);
1152 lp
= mmd_eee_adv_to_ethtool_adv_t(eee_lp
);
1153 if (!phy_check_valid(phydev
->speed
, phydev
->duplex
, lp
& adv
))
1156 if (clk_stop_enable
) {
1157 /* Configure the PHY to stop receiving xMII
1158 * clock while it is signaling LPI.
1160 int val
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_CTRL1
);
1164 val
|= MDIO_PCS_CTRL1_CLKSTOP_EN
;
1165 phy_write_mmd(phydev
, MDIO_MMD_PCS
, MDIO_CTRL1
, val
);
1168 return 0; /* EEE supported */
1171 return -EPROTONOSUPPORT
;
1173 EXPORT_SYMBOL(phy_init_eee
);
1176 * phy_get_eee_err - report the EEE wake error count
1177 * @phydev: target phy_device struct
1179 * Description: it is to report the number of time where the PHY
1180 * failed to complete its normal wake sequence.
1182 int phy_get_eee_err(struct phy_device
*phydev
)
1187 return phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_WK_ERR
);
1189 EXPORT_SYMBOL(phy_get_eee_err
);
1192 * phy_ethtool_get_eee - get EEE supported and status
1193 * @phydev: target phy_device struct
1194 * @data: ethtool_eee data
1196 * Description: it reportes the Supported/Advertisement/LP Advertisement
1199 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
)
1206 /* Get Supported EEE */
1207 val
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_ABLE
);
1210 data
->supported
= mmd_eee_cap_to_ethtool_sup_t(val
);
1212 /* Get advertisement EEE */
1213 val
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
);
1216 data
->advertised
= mmd_eee_adv_to_ethtool_adv_t(val
);
1218 /* Get LP advertisement EEE */
1219 val
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_LPABLE
);
1222 data
->lp_advertised
= mmd_eee_adv_to_ethtool_adv_t(val
);
1226 EXPORT_SYMBOL(phy_ethtool_get_eee
);
1229 * phy_ethtool_set_eee - set EEE supported and status
1230 * @phydev: target phy_device struct
1231 * @data: ethtool_eee data
1233 * Description: it is to program the Advertisement EEE register.
1235 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
)
1237 int cap
, old_adv
, adv
, ret
;
1242 /* Get Supported EEE */
1243 cap
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_ABLE
);
1247 old_adv
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
);
1251 adv
= ethtool_adv_to_mmd_eee_adv_t(data
->advertised
) & cap
;
1253 /* Mask prohibited EEE modes */
1254 adv
&= ~phydev
->eee_broken_modes
;
1256 if (old_adv
!= adv
) {
1257 ret
= phy_write_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
, adv
);
1261 /* Restart autonegotiation so the new modes get sent to the
1264 ret
= phy_restart_aneg(phydev
);
1271 EXPORT_SYMBOL(phy_ethtool_set_eee
);
1273 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
)
1275 if (phydev
->drv
&& phydev
->drv
->set_wol
)
1276 return phydev
->drv
->set_wol(phydev
, wol
);
1280 EXPORT_SYMBOL(phy_ethtool_set_wol
);
1282 void phy_ethtool_get_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
)
1284 if (phydev
->drv
&& phydev
->drv
->get_wol
)
1285 phydev
->drv
->get_wol(phydev
, wol
);
1287 EXPORT_SYMBOL(phy_ethtool_get_wol
);
1289 int phy_ethtool_get_link_ksettings(struct net_device
*ndev
,
1290 struct ethtool_link_ksettings
*cmd
)
1292 struct phy_device
*phydev
= ndev
->phydev
;
1297 phy_ethtool_ksettings_get(phydev
, cmd
);
1301 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings
);
1303 int phy_ethtool_set_link_ksettings(struct net_device
*ndev
,
1304 const struct ethtool_link_ksettings
*cmd
)
1306 struct phy_device
*phydev
= ndev
->phydev
;
1311 return phy_ethtool_ksettings_set(phydev
, cmd
);
1313 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings
);
1315 int phy_ethtool_nway_reset(struct net_device
*ndev
)
1317 struct phy_device
*phydev
= ndev
->phydev
;
1325 return phy_restart_aneg(phydev
);
1327 EXPORT_SYMBOL(phy_ethtool_nway_reset
);