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 - flow control %s\n",
100 phy_speed_to_str(phydev->speed),
101 phy_duplex_to_str(phydev->duplex),
102 phy_pause_str(phydev));
104 netdev_info(phydev->attached_dev, "Link is Down\n");
107 EXPORT_SYMBOL(phy_print_status);
110 * phy_clear_interrupt - Ack the phy device's interrupt
111 * @phydev: the phy_device struct
113 * If the @phydev driver has an ack_interrupt function, call it to
114 * ack and clear the phy device's interrupt.
116 * Returns 0 on success or < 0 on error.
118 static int phy_clear_interrupt(struct phy_device *phydev)
120 if (phydev->drv->ack_interrupt)
121 return phydev->drv->ack_interrupt(phydev);
127 * phy_config_interrupt - configure the PHY device for the requested interrupts
128 * @phydev: the phy_device struct
129 * @interrupts: interrupt flags to configure for this @phydev
131 * Returns 0 on success or < 0 on error.
133 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
135 phydev->interrupts = interrupts ? 1 : 0;
136 if (phydev->drv->config_intr)
137 return phydev->drv->config_intr(phydev);
143 * phy_restart_aneg - restart auto-negotiation
144 * @phydev: target phy_device struct
146 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
147 * negative errno on error.
149 int phy_restart_aneg(struct phy_device *phydev)
153 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
154 ret = genphy_c45_restart_aneg(phydev);
156 ret = genphy_restart_aneg(phydev);
160 EXPORT_SYMBOL_GPL(phy_restart_aneg);
163 * phy_aneg_done - return auto-negotiation status
164 * @phydev: target phy_device struct
166 * Description: Return the auto-negotiation status from this @phydev
167 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
170 int phy_aneg_done(struct phy_device *phydev)
172 if (phydev->drv && phydev->drv->aneg_done)
173 return phydev->drv->aneg_done(phydev);
174 else if (phydev->is_c45)
175 return genphy_c45_aneg_done(phydev);
177 return genphy_aneg_done(phydev);
179 EXPORT_SYMBOL(phy_aneg_done);
182 * phy_find_valid - find a PHY setting that matches the requested parameters
183 * @speed: desired speed
184 * @duplex: desired duplex
185 * @supported: mask of supported link modes
187 * Locate a supported phy setting that is, in priority order:
188 * - an exact match for the specified speed and duplex mode
189 * - a match for the specified speed, or slower speed
190 * - the slowest supported speed
191 * Returns the matched phy_setting entry, or %NULL if no supported phy
192 * settings were found.
194 static const struct phy_setting *
195 phy_find_valid(int speed, int duplex, unsigned long *supported)
197 return phy_lookup_setting(speed, duplex, supported, false);
201 * phy_supported_speeds - return all speeds currently supported by a phy device
202 * @phy: The phy device to return supported speeds of.
203 * @speeds: buffer to store supported speeds in.
204 * @size: size of speeds buffer.
206 * Description: Returns the number of supported speeds, and fills the speeds
207 * buffer with the supported speeds. If speeds buffer is too small to contain
208 * all currently supported speeds, will return as many speeds as can fit.
210 unsigned int phy_supported_speeds(struct phy_device *phy,
211 unsigned int *speeds,
214 return phy_speeds(speeds, size, phy->supported);
218 * phy_check_valid - check if there is a valid PHY setting which matches
219 * speed, duplex, and feature mask
220 * @speed: speed to match
221 * @duplex: duplex to match
222 * @features: A mask of the valid settings
224 * Description: Returns true if there is a valid setting, false otherwise.
226 static inline bool phy_check_valid(int speed, int duplex,
227 unsigned long *features)
229 return !!phy_lookup_setting(speed, duplex, features, true);
233 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
234 * @phydev: the target phy_device struct
236 * Description: Make sure the PHY is set to supported speeds and
237 * duplexes. Drop down by one in this order: 1000/FULL,
238 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
240 static void phy_sanitize_settings(struct phy_device *phydev)
242 const struct phy_setting *setting;
244 setting = phy_find_valid(phydev->speed, phydev->duplex,
247 phydev->speed = setting->speed;
248 phydev->duplex = setting->duplex;
250 /* We failed to find anything (no supported speeds?) */
251 phydev->speed = SPEED_UNKNOWN;
252 phydev->duplex = DUPLEX_UNKNOWN;
256 int phy_ethtool_ksettings_set(struct phy_device *phydev,
257 const struct ethtool_link_ksettings *cmd)
259 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
260 u8 autoneg = cmd->base.autoneg;
261 u8 duplex = cmd->base.duplex;
262 u32 speed = cmd->base.speed;
264 if (cmd->base.phy_address != phydev->mdio.addr)
267 linkmode_copy(advertising, cmd->link_modes.advertising);
269 /* We make sure that we don't pass unsupported values in to the PHY */
270 linkmode_and(advertising, advertising, phydev->supported);
272 /* Verify the settings we care about. */
273 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
276 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
279 if (autoneg == AUTONEG_DISABLE &&
280 ((speed != SPEED_1000 &&
281 speed != SPEED_100 &&
282 speed != SPEED_10) ||
283 (duplex != DUPLEX_HALF &&
284 duplex != DUPLEX_FULL)))
287 phydev->autoneg = autoneg;
289 phydev->speed = speed;
291 linkmode_copy(phydev->advertising, advertising);
293 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
294 phydev->advertising, autoneg == AUTONEG_ENABLE);
296 phydev->duplex = duplex;
298 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
300 /* Restart the PHY */
301 phy_start_aneg(phydev);
305 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
307 void phy_ethtool_ksettings_get(struct phy_device *phydev,
308 struct ethtool_link_ksettings *cmd)
310 linkmode_copy(cmd->link_modes.supported, phydev->supported);
311 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
312 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
314 cmd->base.speed = phydev->speed;
315 cmd->base.duplex = phydev->duplex;
316 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
317 cmd->base.port = PORT_BNC;
319 cmd->base.port = PORT_MII;
320 cmd->base.transceiver = phy_is_internal(phydev) ?
321 XCVR_INTERNAL : XCVR_EXTERNAL;
322 cmd->base.phy_address = phydev->mdio.addr;
323 cmd->base.autoneg = phydev->autoneg;
324 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
325 cmd->base.eth_tp_mdix = phydev->mdix;
327 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
330 * phy_mii_ioctl - generic PHY MII ioctl interface
331 * @phydev: the phy_device struct
332 * @ifr: &struct ifreq for socket ioctl's
333 * @cmd: ioctl cmd to execute
335 * Note that this function is currently incompatible with the
336 * PHYCONTROL layer. It changes registers without regard to
337 * current state. Use at own risk.
339 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
341 struct mii_ioctl_data *mii_data = if_mii(ifr);
342 u16 val = mii_data->val_in;
343 bool change_autoneg = false;
348 mii_data->phy_id = phydev->mdio.addr;
352 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
353 prtad = mdio_phy_id_prtad(mii_data->phy_id);
354 devad = mdio_phy_id_devad(mii_data->phy_id);
355 devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
357 prtad = mii_data->phy_id;
358 devad = mii_data->reg_num;
360 mii_data->val_out = mdiobus_read(phydev->mdio.bus, prtad,
365 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
366 prtad = mdio_phy_id_prtad(mii_data->phy_id);
367 devad = mdio_phy_id_devad(mii_data->phy_id);
368 devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
370 prtad = mii_data->phy_id;
371 devad = mii_data->reg_num;
373 if (prtad == phydev->mdio.addr) {
376 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
377 if (phydev->autoneg == AUTONEG_ENABLE)
378 change_autoneg = true;
379 phydev->autoneg = AUTONEG_DISABLE;
380 if (val & BMCR_FULLDPLX)
381 phydev->duplex = DUPLEX_FULL;
383 phydev->duplex = DUPLEX_HALF;
384 if (val & BMCR_SPEED1000)
385 phydev->speed = SPEED_1000;
386 else if (val & BMCR_SPEED100)
387 phydev->speed = SPEED_100;
388 else phydev->speed = SPEED_10;
391 if (phydev->autoneg == AUTONEG_DISABLE)
392 change_autoneg = true;
393 phydev->autoneg = AUTONEG_ENABLE;
397 mii_adv_mod_linkmode_adv_t(phydev->advertising,
399 change_autoneg = true;
402 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
404 change_autoneg = true;
412 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
414 if (prtad == phydev->mdio.addr &&
417 return phy_init_hw(phydev);
420 return phy_start_aneg(phydev);
425 if (phydev->drv && phydev->drv->hwtstamp)
426 return phydev->drv->hwtstamp(phydev, ifr);
433 EXPORT_SYMBOL(phy_mii_ioctl);
435 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
437 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
440 EXPORT_SYMBOL(phy_queue_state_machine);
442 static void phy_trigger_machine(struct phy_device *phydev)
444 phy_queue_state_machine(phydev, 0);
447 static int phy_config_aneg(struct phy_device *phydev)
449 if (phydev->drv->config_aneg)
450 return phydev->drv->config_aneg(phydev);
452 /* Clause 45 PHYs that don't implement Clause 22 registers are not
453 * allowed to call genphy_config_aneg()
455 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
456 return genphy_c45_config_aneg(phydev);
458 return genphy_config_aneg(phydev);
462 * phy_check_link_status - check link status and set state accordingly
463 * @phydev: the phy_device struct
465 * Description: Check for link and whether autoneg was triggered / is running
466 * and set state accordingly
468 static int phy_check_link_status(struct phy_device *phydev)
472 WARN_ON(!mutex_is_locked(&phydev->lock));
474 /* Keep previous state if loopback is enabled because some PHYs
475 * report that Link is Down when loopback is enabled.
477 if (phydev->loopback_enabled)
480 err = phy_read_status(phydev);
484 if (phydev->link && phydev->state != PHY_RUNNING) {
485 phydev->state = PHY_RUNNING;
487 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
488 phydev->state = PHY_NOLINK;
489 phy_link_down(phydev, true);
496 * phy_start_aneg - start auto-negotiation for this PHY device
497 * @phydev: the phy_device struct
499 * Description: Sanitizes the settings (if we're not autonegotiating
500 * them), and then calls the driver's config_aneg function.
501 * If the PHYCONTROL Layer is operating, we change the state to
502 * reflect the beginning of Auto-negotiation or forcing.
504 int phy_start_aneg(struct phy_device *phydev)
511 mutex_lock(&phydev->lock);
513 if (AUTONEG_DISABLE == phydev->autoneg)
514 phy_sanitize_settings(phydev);
516 err = phy_config_aneg(phydev);
520 if (phy_is_started(phydev))
521 err = phy_check_link_status(phydev);
523 mutex_unlock(&phydev->lock);
527 EXPORT_SYMBOL(phy_start_aneg);
529 static int phy_poll_aneg_done(struct phy_device *phydev)
531 unsigned int retries = 100;
536 ret = phy_aneg_done(phydev);
537 } while (!ret && --retries);
542 return ret < 0 ? ret : 0;
546 * phy_speed_down - set speed to lowest speed supported by both link partners
547 * @phydev: the phy_device struct
548 * @sync: perform action synchronously
550 * Description: Typically used to save energy when waiting for a WoL packet
552 * WARNING: Setting sync to false may cause the system being unable to suspend
553 * in case the PHY generates an interrupt when finishing the autonegotiation.
554 * This interrupt may wake up the system immediately after suspend.
555 * Therefore use sync = false only if you're sure it's safe with the respective
558 int phy_speed_down(struct phy_device *phydev, bool sync)
560 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
563 if (phydev->autoneg != AUTONEG_ENABLE)
566 linkmode_copy(adv_tmp, phydev->advertising);
568 ret = phy_speed_down_core(phydev);
572 linkmode_copy(phydev->adv_old, adv_tmp);
574 if (linkmode_equal(phydev->advertising, adv_tmp))
577 ret = phy_config_aneg(phydev);
581 return sync ? phy_poll_aneg_done(phydev) : 0;
583 EXPORT_SYMBOL_GPL(phy_speed_down);
586 * phy_speed_up - (re)set advertised speeds to all supported speeds
587 * @phydev: the phy_device struct
589 * Description: Used to revert the effect of phy_speed_down
591 int phy_speed_up(struct phy_device *phydev)
593 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
595 if (phydev->autoneg != AUTONEG_ENABLE)
598 if (linkmode_empty(phydev->adv_old))
601 linkmode_copy(adv_tmp, phydev->advertising);
602 linkmode_copy(phydev->advertising, phydev->adv_old);
603 linkmode_zero(phydev->adv_old);
605 if (linkmode_equal(phydev->advertising, adv_tmp))
608 return phy_config_aneg(phydev);
610 EXPORT_SYMBOL_GPL(phy_speed_up);
613 * phy_start_machine - start PHY state machine tracking
614 * @phydev: the phy_device struct
616 * Description: The PHY infrastructure can run a state machine
617 * which tracks whether the PHY is starting up, negotiating,
618 * etc. This function starts the delayed workqueue which tracks
619 * the state of the PHY. If you want to maintain your own state machine,
620 * do not call this function.
622 void phy_start_machine(struct phy_device *phydev)
624 phy_trigger_machine(phydev);
626 EXPORT_SYMBOL_GPL(phy_start_machine);
629 * phy_stop_machine - stop the PHY state machine tracking
630 * @phydev: target phy_device struct
632 * Description: Stops the state machine delayed workqueue, sets the
633 * state to UP (unless it wasn't up yet). This function must be
634 * called BEFORE phy_detach.
636 void phy_stop_machine(struct phy_device *phydev)
638 cancel_delayed_work_sync(&phydev->state_queue);
640 mutex_lock(&phydev->lock);
641 if (phy_is_started(phydev))
642 phydev->state = PHY_UP;
643 mutex_unlock(&phydev->lock);
647 * phy_error - enter HALTED state for this PHY device
648 * @phydev: target phy_device struct
650 * Moves the PHY to the HALTED state in response to a read
651 * or write error, and tells the controller the link is down.
652 * Must not be called from interrupt context, or while the
653 * phydev->lock is held.
655 static void phy_error(struct phy_device *phydev)
659 mutex_lock(&phydev->lock);
660 phydev->state = PHY_HALTED;
661 mutex_unlock(&phydev->lock);
663 phy_trigger_machine(phydev);
667 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
668 * @phydev: target phy_device struct
670 static int phy_disable_interrupts(struct phy_device *phydev)
674 /* Disable PHY interrupts */
675 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
679 /* Clear the interrupt */
680 return phy_clear_interrupt(phydev);
684 * phy_interrupt - PHY interrupt handler
685 * @irq: interrupt line
686 * @phy_dat: phy_device pointer
688 * Description: Handle PHY interrupt
690 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
692 struct phy_device *phydev = phy_dat;
694 if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
697 if (phydev->drv->handle_interrupt) {
698 if (phydev->drv->handle_interrupt(phydev))
701 /* reschedule state queue work to run as soon as possible */
702 phy_trigger_machine(phydev);
705 if (phy_clear_interrupt(phydev))
715 * phy_enable_interrupts - Enable the interrupts from the PHY side
716 * @phydev: target phy_device struct
718 static int phy_enable_interrupts(struct phy_device *phydev)
720 int err = phy_clear_interrupt(phydev);
725 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
729 * phy_request_interrupt - request and enable interrupt for a PHY device
730 * @phydev: target phy_device struct
732 * Description: Request and enable the interrupt for the given PHY.
733 * If this fails, then we set irq to PHY_POLL.
734 * This should only be called with a valid IRQ number.
736 void phy_request_interrupt(struct phy_device *phydev)
740 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
741 IRQF_ONESHOT | IRQF_SHARED,
742 phydev_name(phydev), phydev);
744 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
746 phydev->irq = PHY_POLL;
748 if (phy_enable_interrupts(phydev)) {
749 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
750 phy_free_interrupt(phydev);
751 phydev->irq = PHY_POLL;
755 EXPORT_SYMBOL(phy_request_interrupt);
758 * phy_free_interrupt - disable and free interrupt for a PHY device
759 * @phydev: target phy_device struct
761 * Description: Disable and free the interrupt for the given PHY.
762 * This should only be called with a valid IRQ number.
764 void phy_free_interrupt(struct phy_device *phydev)
766 phy_disable_interrupts(phydev);
767 free_irq(phydev->irq, phydev);
769 EXPORT_SYMBOL(phy_free_interrupt);
772 * phy_stop - Bring down the PHY link, and stop checking the status
773 * @phydev: target phy_device struct
775 void phy_stop(struct phy_device *phydev)
777 if (!phy_is_started(phydev)) {
778 WARN(1, "called from state %s\n",
779 phy_state_to_str(phydev->state));
783 mutex_lock(&phydev->lock);
786 sfp_upstream_stop(phydev->sfp_bus);
788 phydev->state = PHY_HALTED;
790 mutex_unlock(&phydev->lock);
792 phy_state_machine(&phydev->state_queue.work);
793 phy_stop_machine(phydev);
795 /* Cannot call flush_scheduled_work() here as desired because
796 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
797 * will not reenable interrupts.
800 EXPORT_SYMBOL(phy_stop);
803 * phy_start - start or restart a PHY device
804 * @phydev: target phy_device struct
806 * Description: Indicates the attached device's readiness to
807 * handle PHY-related work. Used during startup to start the
808 * PHY, and after a call to phy_stop() to resume operation.
809 * Also used to indicate the MDIO bus has cleared an error
812 void phy_start(struct phy_device *phydev)
814 mutex_lock(&phydev->lock);
816 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
817 WARN(1, "called from state %s\n",
818 phy_state_to_str(phydev->state));
823 sfp_upstream_start(phydev->sfp_bus);
825 /* if phy was suspended, bring the physical link up again */
826 __phy_resume(phydev);
828 phydev->state = PHY_UP;
830 phy_start_machine(phydev);
832 mutex_unlock(&phydev->lock);
834 EXPORT_SYMBOL(phy_start);
837 * phy_state_machine - Handle the state machine
838 * @work: work_struct that describes the work to be done
840 void phy_state_machine(struct work_struct *work)
842 struct delayed_work *dwork = to_delayed_work(work);
843 struct phy_device *phydev =
844 container_of(dwork, struct phy_device, state_queue);
845 bool needs_aneg = false, do_suspend = false;
846 enum phy_state old_state;
849 mutex_lock(&phydev->lock);
851 old_state = phydev->state;
853 switch (phydev->state) {
863 err = phy_check_link_status(phydev);
868 phy_link_down(phydev, true);
874 mutex_unlock(&phydev->lock);
877 err = phy_start_aneg(phydev);
884 if (old_state != phydev->state) {
885 phydev_dbg(phydev, "PHY state change %s -> %s\n",
886 phy_state_to_str(old_state),
887 phy_state_to_str(phydev->state));
888 if (phydev->drv && phydev->drv->link_change_notify)
889 phydev->drv->link_change_notify(phydev);
892 /* Only re-schedule a PHY state machine change if we are polling the
893 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
894 * between states from phy_mac_interrupt().
896 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
897 * state machine would be pointless and possibly error prone when
898 * called from phy_disconnect() synchronously.
900 mutex_lock(&phydev->lock);
901 if (phy_polling_mode(phydev) && phy_is_started(phydev))
902 phy_queue_state_machine(phydev, PHY_STATE_TIME);
903 mutex_unlock(&phydev->lock);
907 * phy_mac_interrupt - MAC says the link has changed
908 * @phydev: phy_device struct with changed link
910 * The MAC layer is able to indicate there has been a change in the PHY link
911 * status. Trigger the state machine and work a work queue.
913 void phy_mac_interrupt(struct phy_device *phydev)
915 /* Trigger a state machine change */
916 phy_trigger_machine(phydev);
918 EXPORT_SYMBOL(phy_mac_interrupt);
920 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
922 linkmode_zero(advertising);
924 if (eee_adv & MDIO_EEE_100TX)
925 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
927 if (eee_adv & MDIO_EEE_1000T)
928 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
930 if (eee_adv & MDIO_EEE_10GT)
931 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
933 if (eee_adv & MDIO_EEE_1000KX)
934 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
936 if (eee_adv & MDIO_EEE_10GKX4)
937 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
939 if (eee_adv & MDIO_EEE_10GKR)
940 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
945 * phy_init_eee - init and check the EEE feature
946 * @phydev: target phy_device struct
947 * @clk_stop_enable: PHY may stop the clock during LPI
949 * Description: it checks if the Energy-Efficient Ethernet (EEE)
950 * is supported by looking at the MMD registers 3.20 and 7.60/61
951 * and it programs the MMD register 3.0 setting the "Clock stop enable"
954 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
959 /* According to 802.3az,the EEE is supported only in full duplex-mode.
961 if (phydev->duplex == DUPLEX_FULL) {
962 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
963 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
964 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
965 int eee_lp, eee_cap, eee_adv;
969 /* Read phy status to properly get the right settings */
970 status = phy_read_status(phydev);
974 /* First check if the EEE ability is supported */
975 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
979 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
983 /* Check which link settings negotiated and verify it in
984 * the EEE advertising registers.
986 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
990 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
994 mmd_eee_adv_to_linkmode(adv, eee_adv);
995 mmd_eee_adv_to_linkmode(lp, eee_lp);
996 linkmode_and(common, adv, lp);
998 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1001 if (clk_stop_enable)
1002 /* Configure the PHY to stop receiving xMII
1003 * clock while it is signaling LPI.
1005 phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1006 MDIO_PCS_CTRL1_CLKSTOP_EN);
1008 return 0; /* EEE supported */
1011 return -EPROTONOSUPPORT;
1013 EXPORT_SYMBOL(phy_init_eee);
1016 * phy_get_eee_err - report the EEE wake error count
1017 * @phydev: target phy_device struct
1019 * Description: it is to report the number of time where the PHY
1020 * failed to complete its normal wake sequence.
1022 int phy_get_eee_err(struct phy_device *phydev)
1027 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1029 EXPORT_SYMBOL(phy_get_eee_err);
1032 * phy_ethtool_get_eee - get EEE supported and status
1033 * @phydev: target phy_device struct
1034 * @data: ethtool_eee data
1036 * Description: it reportes the Supported/Advertisement/LP Advertisement
1039 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1046 /* Get Supported EEE */
1047 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1050 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1052 /* Get advertisement EEE */
1053 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1056 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1057 data->eee_enabled = !!data->advertised;
1059 /* Get LP advertisement EEE */
1060 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1063 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1065 data->eee_active = !!(data->advertised & data->lp_advertised);
1069 EXPORT_SYMBOL(phy_ethtool_get_eee);
1072 * phy_ethtool_set_eee - set EEE supported and status
1073 * @phydev: target phy_device struct
1074 * @data: ethtool_eee data
1076 * Description: it is to program the Advertisement EEE register.
1078 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1080 int cap, old_adv, adv = 0, ret;
1085 /* Get Supported EEE */
1086 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1090 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1094 if (data->eee_enabled) {
1095 adv = !data->advertised ? cap :
1096 ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1097 /* Mask prohibited EEE modes */
1098 adv &= ~phydev->eee_broken_modes;
1101 if (old_adv != adv) {
1102 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1106 /* Restart autonegotiation so the new modes get sent to the
1109 ret = phy_restart_aneg(phydev);
1116 EXPORT_SYMBOL(phy_ethtool_set_eee);
1118 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1120 if (phydev->drv && phydev->drv->set_wol)
1121 return phydev->drv->set_wol(phydev, wol);
1125 EXPORT_SYMBOL(phy_ethtool_set_wol);
1127 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1129 if (phydev->drv && phydev->drv->get_wol)
1130 phydev->drv->get_wol(phydev, wol);
1132 EXPORT_SYMBOL(phy_ethtool_get_wol);
1134 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1135 struct ethtool_link_ksettings *cmd)
1137 struct phy_device *phydev = ndev->phydev;
1142 phy_ethtool_ksettings_get(phydev, cmd);
1146 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1148 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1149 const struct ethtool_link_ksettings *cmd)
1151 struct phy_device *phydev = ndev->phydev;
1156 return phy_ethtool_ksettings_set(phydev, cmd);
1158 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1160 int phy_ethtool_nway_reset(struct net_device *ndev)
1162 struct phy_device *phydev = ndev->phydev;
1170 return phy_restart_aneg(phydev);
1172 EXPORT_SYMBOL(phy_ethtool_nway_reset);