1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for configuring and reading PHY devices
3 * Based on code in sungem_phy.c and gianfar_phy.c
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 * Copyright (c) 2006, 2007 Maciej W. Rozycki
11 #include <linux/kernel.h>
12 #include <linux/string.h>
13 #include <linux/errno.h>
14 #include <linux/unistd.h>
15 #include <linux/interrupt.h>
16 #include <linux/delay.h>
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/skbuff.h>
21 #include <linux/module.h>
22 #include <linux/mii.h>
23 #include <linux/ethtool.h>
24 #include <linux/phy.h>
25 #include <linux/phy_led_triggers.h>
26 #include <linux/sfp.h>
27 #include <linux/workqueue.h>
28 #include <linux/mdio.h>
30 #include <linux/uaccess.h>
31 #include <linux/atomic.h>
33 #define PHY_STATE_TIME HZ
35 #define PHY_STATE_STR(_state) \
37 return __stringify(_state); \
39 static const char *phy_state_to_str(enum phy_state st)
45 PHY_STATE_STR(RUNNING
)
53 static void phy_link_up(struct phy_device
*phydev
)
55 phydev
->phy_link_change(phydev
, true, true);
56 phy_led_trigger_change_speed(phydev
);
59 static void phy_link_down(struct phy_device
*phydev
, bool do_carrier
)
61 phydev
->phy_link_change(phydev
, false, do_carrier
);
62 phy_led_trigger_change_speed(phydev
);
65 static const char *phy_pause_str(struct phy_device
*phydev
)
67 bool local_pause
, local_asym_pause
;
69 if (phydev
->autoneg
== AUTONEG_DISABLE
)
72 local_pause
= linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT
,
74 local_asym_pause
= linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT
,
77 if (local_pause
&& phydev
->pause
)
80 if (local_asym_pause
&& phydev
->asym_pause
) {
92 * phy_print_status - Convenience function to print out the current phy status
93 * @phydev: the phy_device struct
95 void phy_print_status(struct phy_device
*phydev
)
98 netdev_info(phydev
->attached_dev
,
99 "Link is Up - %s/%s %s- flow control %s\n",
100 phy_speed_to_str(phydev
->speed
),
101 phy_duplex_to_str(phydev
->duplex
),
102 phydev
->downshifted_rate
? "(downshifted) " : "",
103 phy_pause_str(phydev
));
105 netdev_info(phydev
->attached_dev
, "Link is Down\n");
108 EXPORT_SYMBOL(phy_print_status
);
111 * phy_clear_interrupt - Ack the phy device's interrupt
112 * @phydev: the phy_device struct
114 * If the @phydev driver has an ack_interrupt function, call it to
115 * ack and clear the phy device's interrupt.
117 * Returns 0 on success or < 0 on error.
119 static int phy_clear_interrupt(struct phy_device
*phydev
)
121 if (phydev
->drv
->ack_interrupt
)
122 return phydev
->drv
->ack_interrupt(phydev
);
128 * phy_config_interrupt - configure the PHY device for the requested interrupts
129 * @phydev: the phy_device struct
130 * @interrupts: interrupt flags to configure for this @phydev
132 * Returns 0 on success or < 0 on error.
134 static int phy_config_interrupt(struct phy_device
*phydev
, bool interrupts
)
136 phydev
->interrupts
= interrupts
? 1 : 0;
137 if (phydev
->drv
->config_intr
)
138 return phydev
->drv
->config_intr(phydev
);
144 * phy_restart_aneg - restart auto-negotiation
145 * @phydev: target phy_device struct
147 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
148 * negative errno on error.
150 int phy_restart_aneg(struct phy_device
*phydev
)
154 if (phydev
->is_c45
&& !(phydev
->c45_ids
.devices_in_package
& BIT(0)))
155 ret
= genphy_c45_restart_aneg(phydev
);
157 ret
= genphy_restart_aneg(phydev
);
161 EXPORT_SYMBOL_GPL(phy_restart_aneg
);
164 * phy_aneg_done - return auto-negotiation status
165 * @phydev: target phy_device struct
167 * Description: Return the auto-negotiation status from this @phydev
168 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
171 int phy_aneg_done(struct phy_device
*phydev
)
173 if (phydev
->drv
&& phydev
->drv
->aneg_done
)
174 return phydev
->drv
->aneg_done(phydev
);
175 else if (phydev
->is_c45
)
176 return genphy_c45_aneg_done(phydev
);
178 return genphy_aneg_done(phydev
);
180 EXPORT_SYMBOL(phy_aneg_done
);
183 * phy_find_valid - find a PHY setting that matches the requested parameters
184 * @speed: desired speed
185 * @duplex: desired duplex
186 * @supported: mask of supported link modes
188 * Locate a supported phy setting that is, in priority order:
189 * - an exact match for the specified speed and duplex mode
190 * - a match for the specified speed, or slower speed
191 * - the slowest supported speed
192 * Returns the matched phy_setting entry, or %NULL if no supported phy
193 * settings were found.
195 static const struct phy_setting
*
196 phy_find_valid(int speed
, int duplex
, unsigned long *supported
)
198 return phy_lookup_setting(speed
, duplex
, supported
, false);
202 * phy_supported_speeds - return all speeds currently supported by a phy device
203 * @phy: The phy device to return supported speeds of.
204 * @speeds: buffer to store supported speeds in.
205 * @size: size of speeds buffer.
207 * Description: Returns the number of supported speeds, and fills the speeds
208 * buffer with the supported speeds. If speeds buffer is too small to contain
209 * all currently supported speeds, will return as many speeds as can fit.
211 unsigned int phy_supported_speeds(struct phy_device
*phy
,
212 unsigned int *speeds
,
215 return phy_speeds(speeds
, size
, phy
->supported
);
219 * phy_check_valid - check if there is a valid PHY setting which matches
220 * speed, duplex, and feature mask
221 * @speed: speed to match
222 * @duplex: duplex to match
223 * @features: A mask of the valid settings
225 * Description: Returns true if there is a valid setting, false otherwise.
227 static inline bool phy_check_valid(int speed
, int duplex
,
228 unsigned long *features
)
230 return !!phy_lookup_setting(speed
, duplex
, features
, true);
234 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
235 * @phydev: the target phy_device struct
237 * Description: Make sure the PHY is set to supported speeds and
238 * duplexes. Drop down by one in this order: 1000/FULL,
239 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
241 static void phy_sanitize_settings(struct phy_device
*phydev
)
243 const struct phy_setting
*setting
;
245 setting
= phy_find_valid(phydev
->speed
, phydev
->duplex
,
248 phydev
->speed
= setting
->speed
;
249 phydev
->duplex
= setting
->duplex
;
251 /* We failed to find anything (no supported speeds?) */
252 phydev
->speed
= SPEED_UNKNOWN
;
253 phydev
->duplex
= DUPLEX_UNKNOWN
;
257 int phy_ethtool_ksettings_set(struct phy_device
*phydev
,
258 const struct ethtool_link_ksettings
*cmd
)
260 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising
);
261 u8 autoneg
= cmd
->base
.autoneg
;
262 u8 duplex
= cmd
->base
.duplex
;
263 u32 speed
= cmd
->base
.speed
;
265 if (cmd
->base
.phy_address
!= phydev
->mdio
.addr
)
268 linkmode_copy(advertising
, cmd
->link_modes
.advertising
);
270 /* We make sure that we don't pass unsupported values in to the PHY */
271 linkmode_and(advertising
, advertising
, phydev
->supported
);
273 /* Verify the settings we care about. */
274 if (autoneg
!= AUTONEG_ENABLE
&& autoneg
!= AUTONEG_DISABLE
)
277 if (autoneg
== AUTONEG_ENABLE
&& linkmode_empty(advertising
))
280 if (autoneg
== AUTONEG_DISABLE
&&
281 ((speed
!= SPEED_1000
&&
282 speed
!= SPEED_100
&&
283 speed
!= SPEED_10
) ||
284 (duplex
!= DUPLEX_HALF
&&
285 duplex
!= DUPLEX_FULL
)))
288 phydev
->autoneg
= autoneg
;
290 phydev
->speed
= speed
;
292 linkmode_copy(phydev
->advertising
, advertising
);
294 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT
,
295 phydev
->advertising
, autoneg
== AUTONEG_ENABLE
);
297 phydev
->duplex
= duplex
;
299 phydev
->mdix_ctrl
= cmd
->base
.eth_tp_mdix_ctrl
;
301 /* Restart the PHY */
302 phy_start_aneg(phydev
);
306 EXPORT_SYMBOL(phy_ethtool_ksettings_set
);
308 void phy_ethtool_ksettings_get(struct phy_device
*phydev
,
309 struct ethtool_link_ksettings
*cmd
)
311 linkmode_copy(cmd
->link_modes
.supported
, phydev
->supported
);
312 linkmode_copy(cmd
->link_modes
.advertising
, phydev
->advertising
);
313 linkmode_copy(cmd
->link_modes
.lp_advertising
, phydev
->lp_advertising
);
315 cmd
->base
.speed
= phydev
->speed
;
316 cmd
->base
.duplex
= phydev
->duplex
;
317 if (phydev
->interface
== PHY_INTERFACE_MODE_MOCA
)
318 cmd
->base
.port
= PORT_BNC
;
320 cmd
->base
.port
= PORT_MII
;
321 cmd
->base
.transceiver
= phy_is_internal(phydev
) ?
322 XCVR_INTERNAL
: XCVR_EXTERNAL
;
323 cmd
->base
.phy_address
= phydev
->mdio
.addr
;
324 cmd
->base
.autoneg
= phydev
->autoneg
;
325 cmd
->base
.eth_tp_mdix_ctrl
= phydev
->mdix_ctrl
;
326 cmd
->base
.eth_tp_mdix
= phydev
->mdix
;
328 EXPORT_SYMBOL(phy_ethtool_ksettings_get
);
331 * phy_mii_ioctl - generic PHY MII ioctl interface
332 * @phydev: the phy_device struct
333 * @ifr: &struct ifreq for socket ioctl's
334 * @cmd: ioctl cmd to execute
336 * Note that this function is currently incompatible with the
337 * PHYCONTROL layer. It changes registers without regard to
338 * current state. Use at own risk.
340 int phy_mii_ioctl(struct phy_device
*phydev
, struct ifreq
*ifr
, int cmd
)
342 struct mii_ioctl_data
*mii_data
= if_mii(ifr
);
343 u16 val
= mii_data
->val_in
;
344 bool change_autoneg
= false;
349 mii_data
->phy_id
= phydev
->mdio
.addr
;
353 if (mdio_phy_id_is_c45(mii_data
->phy_id
)) {
354 prtad
= mdio_phy_id_prtad(mii_data
->phy_id
);
355 devad
= mdio_phy_id_devad(mii_data
->phy_id
);
356 devad
= MII_ADDR_C45
| devad
<< 16 | mii_data
->reg_num
;
358 prtad
= mii_data
->phy_id
;
359 devad
= mii_data
->reg_num
;
361 mii_data
->val_out
= mdiobus_read(phydev
->mdio
.bus
, prtad
,
366 if (mdio_phy_id_is_c45(mii_data
->phy_id
)) {
367 prtad
= mdio_phy_id_prtad(mii_data
->phy_id
);
368 devad
= mdio_phy_id_devad(mii_data
->phy_id
);
369 devad
= MII_ADDR_C45
| devad
<< 16 | mii_data
->reg_num
;
371 prtad
= mii_data
->phy_id
;
372 devad
= mii_data
->reg_num
;
374 if (prtad
== phydev
->mdio
.addr
) {
377 if ((val
& (BMCR_RESET
| BMCR_ANENABLE
)) == 0) {
378 if (phydev
->autoneg
== AUTONEG_ENABLE
)
379 change_autoneg
= true;
380 phydev
->autoneg
= AUTONEG_DISABLE
;
381 if (val
& BMCR_FULLDPLX
)
382 phydev
->duplex
= DUPLEX_FULL
;
384 phydev
->duplex
= DUPLEX_HALF
;
385 if (val
& BMCR_SPEED1000
)
386 phydev
->speed
= SPEED_1000
;
387 else if (val
& BMCR_SPEED100
)
388 phydev
->speed
= SPEED_100
;
389 else phydev
->speed
= SPEED_10
;
392 if (phydev
->autoneg
== AUTONEG_DISABLE
)
393 change_autoneg
= true;
394 phydev
->autoneg
= AUTONEG_ENABLE
;
398 mii_adv_mod_linkmode_adv_t(phydev
->advertising
,
400 change_autoneg
= true;
403 mii_ctrl1000_mod_linkmode_adv_t(phydev
->advertising
,
405 change_autoneg
= true;
413 mdiobus_write(phydev
->mdio
.bus
, prtad
, devad
, val
);
415 if (prtad
== phydev
->mdio
.addr
&&
418 return phy_init_hw(phydev
);
421 return phy_start_aneg(phydev
);
426 if (phydev
->mii_ts
&& phydev
->mii_ts
->hwtstamp
)
427 return phydev
->mii_ts
->hwtstamp(phydev
->mii_ts
, ifr
);
434 EXPORT_SYMBOL(phy_mii_ioctl
);
437 * phy_do_ioctl - generic ndo_do_ioctl implementation
438 * @dev: the net_device struct
439 * @ifr: &struct ifreq for socket ioctl's
440 * @cmd: ioctl cmd to execute
442 int phy_do_ioctl(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
447 return phy_mii_ioctl(dev
->phydev
, ifr
, cmd
);
449 EXPORT_SYMBOL(phy_do_ioctl
);
451 /* same as phy_do_ioctl, but ensures that net_device is running */
452 int phy_do_ioctl_running(struct net_device
*dev
, struct ifreq
*ifr
, int cmd
)
454 if (!netif_running(dev
))
457 return phy_do_ioctl(dev
, ifr
, cmd
);
459 EXPORT_SYMBOL(phy_do_ioctl_running
);
461 void phy_queue_state_machine(struct phy_device
*phydev
, unsigned long jiffies
)
463 mod_delayed_work(system_power_efficient_wq
, &phydev
->state_queue
,
466 EXPORT_SYMBOL(phy_queue_state_machine
);
468 static void phy_trigger_machine(struct phy_device
*phydev
)
470 phy_queue_state_machine(phydev
, 0);
473 static int phy_config_aneg(struct phy_device
*phydev
)
475 if (phydev
->drv
->config_aneg
)
476 return phydev
->drv
->config_aneg(phydev
);
478 /* Clause 45 PHYs that don't implement Clause 22 registers are not
479 * allowed to call genphy_config_aneg()
481 if (phydev
->is_c45
&& !(phydev
->c45_ids
.devices_in_package
& BIT(0)))
482 return genphy_c45_config_aneg(phydev
);
484 return genphy_config_aneg(phydev
);
488 * phy_check_link_status - check link status and set state accordingly
489 * @phydev: the phy_device struct
491 * Description: Check for link and whether autoneg was triggered / is running
492 * and set state accordingly
494 static int phy_check_link_status(struct phy_device
*phydev
)
498 WARN_ON(!mutex_is_locked(&phydev
->lock
));
500 /* Keep previous state if loopback is enabled because some PHYs
501 * report that Link is Down when loopback is enabled.
503 if (phydev
->loopback_enabled
)
506 err
= phy_read_status(phydev
);
510 if (phydev
->link
&& phydev
->state
!= PHY_RUNNING
) {
511 phy_check_downshift(phydev
);
512 phydev
->state
= PHY_RUNNING
;
514 } else if (!phydev
->link
&& phydev
->state
!= PHY_NOLINK
) {
515 phydev
->state
= PHY_NOLINK
;
516 phy_link_down(phydev
, true);
523 * phy_start_aneg - start auto-negotiation for this PHY device
524 * @phydev: the phy_device struct
526 * Description: Sanitizes the settings (if we're not autonegotiating
527 * them), and then calls the driver's config_aneg function.
528 * If the PHYCONTROL Layer is operating, we change the state to
529 * reflect the beginning of Auto-negotiation or forcing.
531 int phy_start_aneg(struct phy_device
*phydev
)
538 mutex_lock(&phydev
->lock
);
540 if (AUTONEG_DISABLE
== phydev
->autoneg
)
541 phy_sanitize_settings(phydev
);
543 err
= phy_config_aneg(phydev
);
547 if (phy_is_started(phydev
))
548 err
= phy_check_link_status(phydev
);
550 mutex_unlock(&phydev
->lock
);
554 EXPORT_SYMBOL(phy_start_aneg
);
556 static int phy_poll_aneg_done(struct phy_device
*phydev
)
558 unsigned int retries
= 100;
563 ret
= phy_aneg_done(phydev
);
564 } while (!ret
&& --retries
);
569 return ret
< 0 ? ret
: 0;
573 * phy_speed_down - set speed to lowest speed supported by both link partners
574 * @phydev: the phy_device struct
575 * @sync: perform action synchronously
577 * Description: Typically used to save energy when waiting for a WoL packet
579 * WARNING: Setting sync to false may cause the system being unable to suspend
580 * in case the PHY generates an interrupt when finishing the autonegotiation.
581 * This interrupt may wake up the system immediately after suspend.
582 * Therefore use sync = false only if you're sure it's safe with the respective
585 int phy_speed_down(struct phy_device
*phydev
, bool sync
)
587 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp
);
590 if (phydev
->autoneg
!= AUTONEG_ENABLE
)
593 linkmode_copy(adv_tmp
, phydev
->advertising
);
595 ret
= phy_speed_down_core(phydev
);
599 linkmode_copy(phydev
->adv_old
, adv_tmp
);
601 if (linkmode_equal(phydev
->advertising
, adv_tmp
))
604 ret
= phy_config_aneg(phydev
);
608 return sync
? phy_poll_aneg_done(phydev
) : 0;
610 EXPORT_SYMBOL_GPL(phy_speed_down
);
613 * phy_speed_up - (re)set advertised speeds to all supported speeds
614 * @phydev: the phy_device struct
616 * Description: Used to revert the effect of phy_speed_down
618 int phy_speed_up(struct phy_device
*phydev
)
620 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp
);
622 if (phydev
->autoneg
!= AUTONEG_ENABLE
)
625 if (linkmode_empty(phydev
->adv_old
))
628 linkmode_copy(adv_tmp
, phydev
->advertising
);
629 linkmode_copy(phydev
->advertising
, phydev
->adv_old
);
630 linkmode_zero(phydev
->adv_old
);
632 if (linkmode_equal(phydev
->advertising
, adv_tmp
))
635 return phy_config_aneg(phydev
);
637 EXPORT_SYMBOL_GPL(phy_speed_up
);
640 * phy_start_machine - start PHY state machine tracking
641 * @phydev: the phy_device struct
643 * Description: The PHY infrastructure can run a state machine
644 * which tracks whether the PHY is starting up, negotiating,
645 * etc. This function starts the delayed workqueue which tracks
646 * the state of the PHY. If you want to maintain your own state machine,
647 * do not call this function.
649 void phy_start_machine(struct phy_device
*phydev
)
651 phy_trigger_machine(phydev
);
653 EXPORT_SYMBOL_GPL(phy_start_machine
);
656 * phy_stop_machine - stop the PHY state machine tracking
657 * @phydev: target phy_device struct
659 * Description: Stops the state machine delayed workqueue, sets the
660 * state to UP (unless it wasn't up yet). This function must be
661 * called BEFORE phy_detach.
663 void phy_stop_machine(struct phy_device
*phydev
)
665 cancel_delayed_work_sync(&phydev
->state_queue
);
667 mutex_lock(&phydev
->lock
);
668 if (phy_is_started(phydev
))
669 phydev
->state
= PHY_UP
;
670 mutex_unlock(&phydev
->lock
);
674 * phy_error - enter HALTED state for this PHY device
675 * @phydev: target phy_device struct
677 * Moves the PHY to the HALTED state in response to a read
678 * or write error, and tells the controller the link is down.
679 * Must not be called from interrupt context, or while the
680 * phydev->lock is held.
682 static void phy_error(struct phy_device
*phydev
)
686 mutex_lock(&phydev
->lock
);
687 phydev
->state
= PHY_HALTED
;
688 mutex_unlock(&phydev
->lock
);
690 phy_trigger_machine(phydev
);
694 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
695 * @phydev: target phy_device struct
697 static int phy_disable_interrupts(struct phy_device
*phydev
)
701 /* Disable PHY interrupts */
702 err
= phy_config_interrupt(phydev
, PHY_INTERRUPT_DISABLED
);
706 /* Clear the interrupt */
707 return phy_clear_interrupt(phydev
);
711 * phy_interrupt - PHY interrupt handler
712 * @irq: interrupt line
713 * @phy_dat: phy_device pointer
715 * Description: Handle PHY interrupt
717 static irqreturn_t
phy_interrupt(int irq
, void *phy_dat
)
719 struct phy_device
*phydev
= phy_dat
;
720 struct phy_driver
*drv
= phydev
->drv
;
722 if (drv
->handle_interrupt
)
723 return drv
->handle_interrupt(phydev
);
725 if (drv
->did_interrupt
&& !drv
->did_interrupt(phydev
))
728 /* reschedule state queue work to run as soon as possible */
729 phy_trigger_machine(phydev
);
731 /* did_interrupt() may have cleared the interrupt already */
732 if (!drv
->did_interrupt
&& phy_clear_interrupt(phydev
)) {
741 * phy_enable_interrupts - Enable the interrupts from the PHY side
742 * @phydev: target phy_device struct
744 static int phy_enable_interrupts(struct phy_device
*phydev
)
746 int err
= phy_clear_interrupt(phydev
);
751 return phy_config_interrupt(phydev
, PHY_INTERRUPT_ENABLED
);
755 * phy_request_interrupt - request and enable interrupt for a PHY device
756 * @phydev: target phy_device struct
758 * Description: Request and enable the interrupt for the given PHY.
759 * If this fails, then we set irq to PHY_POLL.
760 * This should only be called with a valid IRQ number.
762 void phy_request_interrupt(struct phy_device
*phydev
)
766 err
= request_threaded_irq(phydev
->irq
, NULL
, phy_interrupt
,
767 IRQF_ONESHOT
| IRQF_SHARED
,
768 phydev_name(phydev
), phydev
);
770 phydev_warn(phydev
, "Error %d requesting IRQ %d, falling back to polling\n",
772 phydev
->irq
= PHY_POLL
;
774 if (phy_enable_interrupts(phydev
)) {
775 phydev_warn(phydev
, "Can't enable interrupt, falling back to polling\n");
776 phy_free_interrupt(phydev
);
777 phydev
->irq
= PHY_POLL
;
781 EXPORT_SYMBOL(phy_request_interrupt
);
784 * phy_free_interrupt - disable and free interrupt for a PHY device
785 * @phydev: target phy_device struct
787 * Description: Disable and free the interrupt for the given PHY.
788 * This should only be called with a valid IRQ number.
790 void phy_free_interrupt(struct phy_device
*phydev
)
792 phy_disable_interrupts(phydev
);
793 free_irq(phydev
->irq
, phydev
);
795 EXPORT_SYMBOL(phy_free_interrupt
);
798 * phy_stop - Bring down the PHY link, and stop checking the status
799 * @phydev: target phy_device struct
801 void phy_stop(struct phy_device
*phydev
)
803 if (!phy_is_started(phydev
)) {
804 WARN(1, "called from state %s\n",
805 phy_state_to_str(phydev
->state
));
809 mutex_lock(&phydev
->lock
);
812 sfp_upstream_stop(phydev
->sfp_bus
);
814 phydev
->state
= PHY_HALTED
;
816 mutex_unlock(&phydev
->lock
);
818 phy_state_machine(&phydev
->state_queue
.work
);
819 phy_stop_machine(phydev
);
821 /* Cannot call flush_scheduled_work() here as desired because
822 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
823 * will not reenable interrupts.
826 EXPORT_SYMBOL(phy_stop
);
829 * phy_start - start or restart a PHY device
830 * @phydev: target phy_device struct
832 * Description: Indicates the attached device's readiness to
833 * handle PHY-related work. Used during startup to start the
834 * PHY, and after a call to phy_stop() to resume operation.
835 * Also used to indicate the MDIO bus has cleared an error
838 void phy_start(struct phy_device
*phydev
)
840 mutex_lock(&phydev
->lock
);
842 if (phydev
->state
!= PHY_READY
&& phydev
->state
!= PHY_HALTED
) {
843 WARN(1, "called from state %s\n",
844 phy_state_to_str(phydev
->state
));
849 sfp_upstream_start(phydev
->sfp_bus
);
851 /* if phy was suspended, bring the physical link up again */
852 __phy_resume(phydev
);
854 phydev
->state
= PHY_UP
;
856 phy_start_machine(phydev
);
858 mutex_unlock(&phydev
->lock
);
860 EXPORT_SYMBOL(phy_start
);
863 * phy_state_machine - Handle the state machine
864 * @work: work_struct that describes the work to be done
866 void phy_state_machine(struct work_struct
*work
)
868 struct delayed_work
*dwork
= to_delayed_work(work
);
869 struct phy_device
*phydev
=
870 container_of(dwork
, struct phy_device
, state_queue
);
871 bool needs_aneg
= false, do_suspend
= false;
872 enum phy_state old_state
;
875 mutex_lock(&phydev
->lock
);
877 old_state
= phydev
->state
;
879 switch (phydev
->state
) {
889 err
= phy_check_link_status(phydev
);
894 phy_link_down(phydev
, true);
900 mutex_unlock(&phydev
->lock
);
903 err
= phy_start_aneg(phydev
);
910 if (old_state
!= phydev
->state
) {
911 phydev_dbg(phydev
, "PHY state change %s -> %s\n",
912 phy_state_to_str(old_state
),
913 phy_state_to_str(phydev
->state
));
914 if (phydev
->drv
&& phydev
->drv
->link_change_notify
)
915 phydev
->drv
->link_change_notify(phydev
);
918 /* Only re-schedule a PHY state machine change if we are polling the
919 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
920 * between states from phy_mac_interrupt().
922 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
923 * state machine would be pointless and possibly error prone when
924 * called from phy_disconnect() synchronously.
926 mutex_lock(&phydev
->lock
);
927 if (phy_polling_mode(phydev
) && phy_is_started(phydev
))
928 phy_queue_state_machine(phydev
, PHY_STATE_TIME
);
929 mutex_unlock(&phydev
->lock
);
933 * phy_mac_interrupt - MAC says the link has changed
934 * @phydev: phy_device struct with changed link
936 * The MAC layer is able to indicate there has been a change in the PHY link
937 * status. Trigger the state machine and work a work queue.
939 void phy_mac_interrupt(struct phy_device
*phydev
)
941 /* Trigger a state machine change */
942 phy_trigger_machine(phydev
);
944 EXPORT_SYMBOL(phy_mac_interrupt
);
946 static void mmd_eee_adv_to_linkmode(unsigned long *advertising
, u16 eee_adv
)
948 linkmode_zero(advertising
);
950 if (eee_adv
& MDIO_EEE_100TX
)
951 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT
,
953 if (eee_adv
& MDIO_EEE_1000T
)
954 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT
,
956 if (eee_adv
& MDIO_EEE_10GT
)
957 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT
,
959 if (eee_adv
& MDIO_EEE_1000KX
)
960 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT
,
962 if (eee_adv
& MDIO_EEE_10GKX4
)
963 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT
,
965 if (eee_adv
& MDIO_EEE_10GKR
)
966 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT
,
971 * phy_init_eee - init and check the EEE feature
972 * @phydev: target phy_device struct
973 * @clk_stop_enable: PHY may stop the clock during LPI
975 * Description: it checks if the Energy-Efficient Ethernet (EEE)
976 * is supported by looking at the MMD registers 3.20 and 7.60/61
977 * and it programs the MMD register 3.0 setting the "Clock stop enable"
980 int phy_init_eee(struct phy_device
*phydev
, bool clk_stop_enable
)
985 /* According to 802.3az,the EEE is supported only in full duplex-mode.
987 if (phydev
->duplex
== DUPLEX_FULL
) {
988 __ETHTOOL_DECLARE_LINK_MODE_MASK(common
);
989 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp
);
990 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv
);
991 int eee_lp
, eee_cap
, eee_adv
;
995 /* Read phy status to properly get the right settings */
996 status
= phy_read_status(phydev
);
1000 /* First check if the EEE ability is supported */
1001 eee_cap
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_ABLE
);
1005 cap
= mmd_eee_cap_to_ethtool_sup_t(eee_cap
);
1009 /* Check which link settings negotiated and verify it in
1010 * the EEE advertising registers.
1012 eee_lp
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_LPABLE
);
1016 eee_adv
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
);
1020 mmd_eee_adv_to_linkmode(adv
, eee_adv
);
1021 mmd_eee_adv_to_linkmode(lp
, eee_lp
);
1022 linkmode_and(common
, adv
, lp
);
1024 if (!phy_check_valid(phydev
->speed
, phydev
->duplex
, common
))
1027 if (clk_stop_enable
)
1028 /* Configure the PHY to stop receiving xMII
1029 * clock while it is signaling LPI.
1031 phy_set_bits_mmd(phydev
, MDIO_MMD_PCS
, MDIO_CTRL1
,
1032 MDIO_PCS_CTRL1_CLKSTOP_EN
);
1034 return 0; /* EEE supported */
1037 return -EPROTONOSUPPORT
;
1039 EXPORT_SYMBOL(phy_init_eee
);
1042 * phy_get_eee_err - report the EEE wake error count
1043 * @phydev: target phy_device struct
1045 * Description: it is to report the number of time where the PHY
1046 * failed to complete its normal wake sequence.
1048 int phy_get_eee_err(struct phy_device
*phydev
)
1053 return phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_WK_ERR
);
1055 EXPORT_SYMBOL(phy_get_eee_err
);
1058 * phy_ethtool_get_eee - get EEE supported and status
1059 * @phydev: target phy_device struct
1060 * @data: ethtool_eee data
1062 * Description: it reportes the Supported/Advertisement/LP Advertisement
1065 int phy_ethtool_get_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
)
1072 /* Get Supported EEE */
1073 val
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_ABLE
);
1076 data
->supported
= mmd_eee_cap_to_ethtool_sup_t(val
);
1078 /* Get advertisement EEE */
1079 val
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
);
1082 data
->advertised
= mmd_eee_adv_to_ethtool_adv_t(val
);
1083 data
->eee_enabled
= !!data
->advertised
;
1085 /* Get LP advertisement EEE */
1086 val
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_LPABLE
);
1089 data
->lp_advertised
= mmd_eee_adv_to_ethtool_adv_t(val
);
1091 data
->eee_active
= !!(data
->advertised
& data
->lp_advertised
);
1095 EXPORT_SYMBOL(phy_ethtool_get_eee
);
1098 * phy_ethtool_set_eee - set EEE supported and status
1099 * @phydev: target phy_device struct
1100 * @data: ethtool_eee data
1102 * Description: it is to program the Advertisement EEE register.
1104 int phy_ethtool_set_eee(struct phy_device
*phydev
, struct ethtool_eee
*data
)
1106 int cap
, old_adv
, adv
= 0, ret
;
1111 /* Get Supported EEE */
1112 cap
= phy_read_mmd(phydev
, MDIO_MMD_PCS
, MDIO_PCS_EEE_ABLE
);
1116 old_adv
= phy_read_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
);
1120 if (data
->eee_enabled
) {
1121 adv
= !data
->advertised
? cap
:
1122 ethtool_adv_to_mmd_eee_adv_t(data
->advertised
) & cap
;
1123 /* Mask prohibited EEE modes */
1124 adv
&= ~phydev
->eee_broken_modes
;
1127 if (old_adv
!= adv
) {
1128 ret
= phy_write_mmd(phydev
, MDIO_MMD_AN
, MDIO_AN_EEE_ADV
, adv
);
1132 /* Restart autonegotiation so the new modes get sent to the
1135 if (phydev
->autoneg
== AUTONEG_ENABLE
) {
1136 ret
= phy_restart_aneg(phydev
);
1144 EXPORT_SYMBOL(phy_ethtool_set_eee
);
1146 int phy_ethtool_set_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
)
1148 if (phydev
->drv
&& phydev
->drv
->set_wol
)
1149 return phydev
->drv
->set_wol(phydev
, wol
);
1153 EXPORT_SYMBOL(phy_ethtool_set_wol
);
1155 void phy_ethtool_get_wol(struct phy_device
*phydev
, struct ethtool_wolinfo
*wol
)
1157 if (phydev
->drv
&& phydev
->drv
->get_wol
)
1158 phydev
->drv
->get_wol(phydev
, wol
);
1160 EXPORT_SYMBOL(phy_ethtool_get_wol
);
1162 int phy_ethtool_get_link_ksettings(struct net_device
*ndev
,
1163 struct ethtool_link_ksettings
*cmd
)
1165 struct phy_device
*phydev
= ndev
->phydev
;
1170 phy_ethtool_ksettings_get(phydev
, cmd
);
1174 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings
);
1176 int phy_ethtool_set_link_ksettings(struct net_device
*ndev
,
1177 const struct ethtool_link_ksettings
*cmd
)
1179 struct phy_device
*phydev
= ndev
->phydev
;
1184 return phy_ethtool_ksettings_set(phydev
, cmd
);
1186 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings
);
1188 int phy_ethtool_nway_reset(struct net_device
*ndev
)
1190 struct phy_device
*phydev
= ndev
->phydev
;
1198 return phy_restart_aneg(phydev
);
1200 EXPORT_SYMBOL(phy_ethtool_nway_reset
);