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/netlink.h>
19 #include <linux/etherdevice.h>
20 #include <linux/skbuff.h>
22 #include <linux/module.h>
23 #include <linux/mii.h>
24 #include <linux/ethtool.h>
25 #include <linux/ethtool_netlink.h>
26 #include <linux/phy.h>
27 #include <linux/phy_led_triggers.h>
28 #include <linux/sfp.h>
29 #include <linux/workqueue.h>
30 #include <linux/mdio.h>
32 #include <linux/uaccess.h>
33 #include <linux/atomic.h>
34 #include <net/netlink.h>
35 #include <net/genetlink.h>
38 #define PHY_STATE_TIME HZ
40 #define PHY_STATE_STR(_state) \
42 return __stringify(_state); \
44 static const char *phy_state_to_str(enum phy_state st)
50 PHY_STATE_STR(RUNNING)
52 PHY_STATE_STR(CABLETEST)
59 static void phy_link_up(struct phy_device *phydev)
61 phydev->phy_link_change(phydev, true);
62 phy_led_trigger_change_speed(phydev);
65 static void phy_link_down(struct phy_device *phydev)
67 phydev->phy_link_change(phydev, false);
68 phy_led_trigger_change_speed(phydev);
71 static const char *phy_pause_str(struct phy_device *phydev)
73 bool local_pause, local_asym_pause;
75 if (phydev->autoneg == AUTONEG_DISABLE)
78 local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
80 local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
83 if (local_pause && phydev->pause)
86 if (local_asym_pause && phydev->asym_pause) {
98 * phy_print_status - Convenience function to print out the current phy status
99 * @phydev: the phy_device struct
101 void phy_print_status(struct phy_device *phydev)
104 netdev_info(phydev->attached_dev,
105 "Link is Up - %s/%s %s- flow control %s\n",
106 phy_speed_to_str(phydev->speed),
107 phy_duplex_to_str(phydev->duplex),
108 phydev->downshifted_rate ? "(downshifted) " : "",
109 phy_pause_str(phydev));
111 netdev_info(phydev->attached_dev, "Link is Down\n");
114 EXPORT_SYMBOL(phy_print_status);
117 * phy_config_interrupt - configure the PHY device for the requested interrupts
118 * @phydev: the phy_device struct
119 * @interrupts: interrupt flags to configure for this @phydev
121 * Returns 0 on success or < 0 on error.
123 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
125 phydev->interrupts = interrupts ? 1 : 0;
126 if (phydev->drv->config_intr)
127 return phydev->drv->config_intr(phydev);
133 * phy_restart_aneg - restart auto-negotiation
134 * @phydev: target phy_device struct
136 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
137 * negative errno on error.
139 int phy_restart_aneg(struct phy_device *phydev)
143 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
144 ret = genphy_c45_restart_aneg(phydev);
146 ret = genphy_restart_aneg(phydev);
150 EXPORT_SYMBOL_GPL(phy_restart_aneg);
153 * phy_aneg_done - return auto-negotiation status
154 * @phydev: target phy_device struct
156 * Description: Return the auto-negotiation status from this @phydev
157 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
160 int phy_aneg_done(struct phy_device *phydev)
162 if (phydev->drv && phydev->drv->aneg_done)
163 return phydev->drv->aneg_done(phydev);
164 else if (phydev->is_c45)
165 return genphy_c45_aneg_done(phydev);
167 return genphy_aneg_done(phydev);
169 EXPORT_SYMBOL(phy_aneg_done);
172 * phy_find_valid - find a PHY setting that matches the requested parameters
173 * @speed: desired speed
174 * @duplex: desired duplex
175 * @supported: mask of supported link modes
177 * Locate a supported phy setting that is, in priority order:
178 * - an exact match for the specified speed and duplex mode
179 * - a match for the specified speed, or slower speed
180 * - the slowest supported speed
181 * Returns the matched phy_setting entry, or %NULL if no supported phy
182 * settings were found.
184 static const struct phy_setting *
185 phy_find_valid(int speed, int duplex, unsigned long *supported)
187 return phy_lookup_setting(speed, duplex, supported, false);
191 * phy_supported_speeds - return all speeds currently supported by a phy device
192 * @phy: The phy device to return supported speeds of.
193 * @speeds: buffer to store supported speeds in.
194 * @size: size of speeds buffer.
196 * Description: Returns the number of supported speeds, and fills the speeds
197 * buffer with the supported speeds. If speeds buffer is too small to contain
198 * all currently supported speeds, will return as many speeds as can fit.
200 unsigned int phy_supported_speeds(struct phy_device *phy,
201 unsigned int *speeds,
204 return phy_speeds(speeds, size, phy->supported);
208 * phy_check_valid - check if there is a valid PHY setting which matches
209 * speed, duplex, and feature mask
210 * @speed: speed to match
211 * @duplex: duplex to match
212 * @features: A mask of the valid settings
214 * Description: Returns true if there is a valid setting, false otherwise.
216 static inline bool phy_check_valid(int speed, int duplex,
217 unsigned long *features)
219 return !!phy_lookup_setting(speed, duplex, features, true);
223 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
224 * @phydev: the target phy_device struct
226 * Description: Make sure the PHY is set to supported speeds and
227 * duplexes. Drop down by one in this order: 1000/FULL,
228 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
230 static void phy_sanitize_settings(struct phy_device *phydev)
232 const struct phy_setting *setting;
234 setting = phy_find_valid(phydev->speed, phydev->duplex,
237 phydev->speed = setting->speed;
238 phydev->duplex = setting->duplex;
240 /* We failed to find anything (no supported speeds?) */
241 phydev->speed = SPEED_UNKNOWN;
242 phydev->duplex = DUPLEX_UNKNOWN;
246 void phy_ethtool_ksettings_get(struct phy_device *phydev,
247 struct ethtool_link_ksettings *cmd)
249 mutex_lock(&phydev->lock);
250 linkmode_copy(cmd->link_modes.supported, phydev->supported);
251 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
252 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
254 cmd->base.speed = phydev->speed;
255 cmd->base.duplex = phydev->duplex;
256 cmd->base.master_slave_cfg = phydev->master_slave_get;
257 cmd->base.master_slave_state = phydev->master_slave_state;
258 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
259 cmd->base.port = PORT_BNC;
261 cmd->base.port = phydev->port;
262 cmd->base.transceiver = phy_is_internal(phydev) ?
263 XCVR_INTERNAL : XCVR_EXTERNAL;
264 cmd->base.phy_address = phydev->mdio.addr;
265 cmd->base.autoneg = phydev->autoneg;
266 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
267 cmd->base.eth_tp_mdix = phydev->mdix;
268 mutex_unlock(&phydev->lock);
270 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
273 * phy_mii_ioctl - generic PHY MII ioctl interface
274 * @phydev: the phy_device struct
275 * @ifr: &struct ifreq for socket ioctl's
276 * @cmd: ioctl cmd to execute
278 * Note that this function is currently incompatible with the
279 * PHYCONTROL layer. It changes registers without regard to
280 * current state. Use at own risk.
282 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
284 struct mii_ioctl_data *mii_data = if_mii(ifr);
285 u16 val = mii_data->val_in;
286 bool change_autoneg = false;
291 mii_data->phy_id = phydev->mdio.addr;
295 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
296 prtad = mdio_phy_id_prtad(mii_data->phy_id);
297 devad = mdio_phy_id_devad(mii_data->phy_id);
298 mii_data->val_out = mdiobus_c45_read(
299 phydev->mdio.bus, prtad, devad,
302 mii_data->val_out = mdiobus_read(
303 phydev->mdio.bus, mii_data->phy_id,
309 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
310 prtad = mdio_phy_id_prtad(mii_data->phy_id);
311 devad = mdio_phy_id_devad(mii_data->phy_id);
313 prtad = mii_data->phy_id;
314 devad = mii_data->reg_num;
316 if (prtad == phydev->mdio.addr) {
319 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
320 if (phydev->autoneg == AUTONEG_ENABLE)
321 change_autoneg = true;
322 phydev->autoneg = AUTONEG_DISABLE;
323 if (val & BMCR_FULLDPLX)
324 phydev->duplex = DUPLEX_FULL;
326 phydev->duplex = DUPLEX_HALF;
327 if (val & BMCR_SPEED1000)
328 phydev->speed = SPEED_1000;
329 else if (val & BMCR_SPEED100)
330 phydev->speed = SPEED_100;
331 else phydev->speed = SPEED_10;
333 if (phydev->autoneg == AUTONEG_DISABLE)
334 change_autoneg = true;
335 phydev->autoneg = AUTONEG_ENABLE;
339 mii_adv_mod_linkmode_adv_t(phydev->advertising,
341 change_autoneg = true;
344 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
346 change_autoneg = true;
354 if (mdio_phy_id_is_c45(mii_data->phy_id))
355 mdiobus_c45_write(phydev->mdio.bus, prtad, devad,
356 mii_data->reg_num, val);
358 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
360 if (prtad == phydev->mdio.addr &&
363 return phy_init_hw(phydev);
366 return phy_start_aneg(phydev);
371 if (phydev->mii_ts && phydev->mii_ts->hwtstamp)
372 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
379 EXPORT_SYMBOL(phy_mii_ioctl);
382 * phy_do_ioctl - generic ndo_eth_ioctl implementation
383 * @dev: the net_device struct
384 * @ifr: &struct ifreq for socket ioctl's
385 * @cmd: ioctl cmd to execute
387 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
392 return phy_mii_ioctl(dev->phydev, ifr, cmd);
394 EXPORT_SYMBOL(phy_do_ioctl);
397 * phy_do_ioctl_running - generic ndo_eth_ioctl implementation but test first
399 * @dev: the net_device struct
400 * @ifr: &struct ifreq for socket ioctl's
401 * @cmd: ioctl cmd to execute
403 * Same as phy_do_ioctl, but ensures that net_device is running before
404 * handling the ioctl.
406 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd)
408 if (!netif_running(dev))
411 return phy_do_ioctl(dev, ifr, cmd);
413 EXPORT_SYMBOL(phy_do_ioctl_running);
416 * phy_queue_state_machine - Trigger the state machine to run soon
418 * @phydev: the phy_device struct
419 * @jiffies: Run the state machine after these jiffies
421 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
423 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
426 EXPORT_SYMBOL(phy_queue_state_machine);
429 * phy_trigger_machine - Trigger the state machine to run now
431 * @phydev: the phy_device struct
433 void phy_trigger_machine(struct phy_device *phydev)
435 phy_queue_state_machine(phydev, 0);
437 EXPORT_SYMBOL(phy_trigger_machine);
439 static void phy_abort_cable_test(struct phy_device *phydev)
443 ethnl_cable_test_finished(phydev);
445 err = phy_init_hw(phydev);
447 phydev_err(phydev, "Error while aborting cable test");
451 * phy_ethtool_get_strings - Get the statistic counter names
453 * @phydev: the phy_device struct
454 * @data: Where to put the strings
456 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
461 mutex_lock(&phydev->lock);
462 phydev->drv->get_strings(phydev, data);
463 mutex_unlock(&phydev->lock);
467 EXPORT_SYMBOL(phy_ethtool_get_strings);
470 * phy_ethtool_get_sset_count - Get the number of statistic counters
472 * @phydev: the phy_device struct
474 int phy_ethtool_get_sset_count(struct phy_device *phydev)
481 if (phydev->drv->get_sset_count &&
482 phydev->drv->get_strings &&
483 phydev->drv->get_stats) {
484 mutex_lock(&phydev->lock);
485 ret = phydev->drv->get_sset_count(phydev);
486 mutex_unlock(&phydev->lock);
493 EXPORT_SYMBOL(phy_ethtool_get_sset_count);
496 * phy_ethtool_get_stats - Get the statistic counters
498 * @phydev: the phy_device struct
499 * @stats: What counters to get
500 * @data: Where to store the counters
502 int phy_ethtool_get_stats(struct phy_device *phydev,
503 struct ethtool_stats *stats, u64 *data)
508 mutex_lock(&phydev->lock);
509 phydev->drv->get_stats(phydev, stats, data);
510 mutex_unlock(&phydev->lock);
514 EXPORT_SYMBOL(phy_ethtool_get_stats);
517 * phy_start_cable_test - Start a cable test
519 * @phydev: the phy_device struct
520 * @extack: extack for reporting useful error messages
522 int phy_start_cable_test(struct phy_device *phydev,
523 struct netlink_ext_ack *extack)
525 struct net_device *dev = phydev->attached_dev;
529 phydev->drv->cable_test_start &&
530 phydev->drv->cable_test_get_status)) {
531 NL_SET_ERR_MSG(extack,
532 "PHY driver does not support cable testing");
536 mutex_lock(&phydev->lock);
537 if (phydev->state == PHY_CABLETEST) {
538 NL_SET_ERR_MSG(extack,
539 "PHY already performing a test");
544 if (phydev->state < PHY_UP ||
545 phydev->state > PHY_CABLETEST) {
546 NL_SET_ERR_MSG(extack,
547 "PHY not configured. Try setting interface up");
552 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_NTF);
556 /* Mark the carrier down until the test is complete */
557 phy_link_down(phydev);
559 netif_testing_on(dev);
560 err = phydev->drv->cable_test_start(phydev);
562 netif_testing_off(dev);
567 phydev->state = PHY_CABLETEST;
569 if (phy_polling_mode(phydev))
570 phy_trigger_machine(phydev);
572 mutex_unlock(&phydev->lock);
577 ethnl_cable_test_free(phydev);
579 mutex_unlock(&phydev->lock);
583 EXPORT_SYMBOL(phy_start_cable_test);
586 * phy_start_cable_test_tdr - Start a raw TDR cable test
588 * @phydev: the phy_device struct
589 * @extack: extack for reporting useful error messages
590 * @config: Configuration of the test to run
592 int phy_start_cable_test_tdr(struct phy_device *phydev,
593 struct netlink_ext_ack *extack,
594 const struct phy_tdr_config *config)
596 struct net_device *dev = phydev->attached_dev;
600 phydev->drv->cable_test_tdr_start &&
601 phydev->drv->cable_test_get_status)) {
602 NL_SET_ERR_MSG(extack,
603 "PHY driver does not support cable test TDR");
607 mutex_lock(&phydev->lock);
608 if (phydev->state == PHY_CABLETEST) {
609 NL_SET_ERR_MSG(extack,
610 "PHY already performing a test");
615 if (phydev->state < PHY_UP ||
616 phydev->state > PHY_CABLETEST) {
617 NL_SET_ERR_MSG(extack,
618 "PHY not configured. Try setting interface up");
623 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_TDR_NTF);
627 /* Mark the carrier down until the test is complete */
628 phy_link_down(phydev);
630 netif_testing_on(dev);
631 err = phydev->drv->cable_test_tdr_start(phydev, config);
633 netif_testing_off(dev);
638 phydev->state = PHY_CABLETEST;
640 if (phy_polling_mode(phydev))
641 phy_trigger_machine(phydev);
643 mutex_unlock(&phydev->lock);
648 ethnl_cable_test_free(phydev);
650 mutex_unlock(&phydev->lock);
654 EXPORT_SYMBOL(phy_start_cable_test_tdr);
656 int phy_config_aneg(struct phy_device *phydev)
658 if (phydev->drv->config_aneg)
659 return phydev->drv->config_aneg(phydev);
661 /* Clause 45 PHYs that don't implement Clause 22 registers are not
662 * allowed to call genphy_config_aneg()
664 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
665 return genphy_c45_config_aneg(phydev);
667 return genphy_config_aneg(phydev);
669 EXPORT_SYMBOL(phy_config_aneg);
672 * phy_check_link_status - check link status and set state accordingly
673 * @phydev: the phy_device struct
675 * Description: Check for link and whether autoneg was triggered / is running
676 * and set state accordingly
678 static int phy_check_link_status(struct phy_device *phydev)
682 lockdep_assert_held(&phydev->lock);
684 /* Keep previous state if loopback is enabled because some PHYs
685 * report that Link is Down when loopback is enabled.
687 if (phydev->loopback_enabled)
690 err = phy_read_status(phydev);
694 if (phydev->link && phydev->state != PHY_RUNNING) {
695 phy_check_downshift(phydev);
696 phydev->state = PHY_RUNNING;
698 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
699 phydev->state = PHY_NOLINK;
700 phy_link_down(phydev);
707 * _phy_start_aneg - start auto-negotiation for this PHY device
708 * @phydev: the phy_device struct
710 * Description: Sanitizes the settings (if we're not autonegotiating
711 * them), and then calls the driver's config_aneg function.
712 * If the PHYCONTROL Layer is operating, we change the state to
713 * reflect the beginning of Auto-negotiation or forcing.
715 static int _phy_start_aneg(struct phy_device *phydev)
719 lockdep_assert_held(&phydev->lock);
724 if (AUTONEG_DISABLE == phydev->autoneg)
725 phy_sanitize_settings(phydev);
727 err = phy_config_aneg(phydev);
731 if (phy_is_started(phydev))
732 err = phy_check_link_status(phydev);
738 * phy_start_aneg - start auto-negotiation for this PHY device
739 * @phydev: the phy_device struct
741 * Description: Sanitizes the settings (if we're not autonegotiating
742 * them), and then calls the driver's config_aneg function.
743 * If the PHYCONTROL Layer is operating, we change the state to
744 * reflect the beginning of Auto-negotiation or forcing.
746 int phy_start_aneg(struct phy_device *phydev)
750 mutex_lock(&phydev->lock);
751 err = _phy_start_aneg(phydev);
752 mutex_unlock(&phydev->lock);
756 EXPORT_SYMBOL(phy_start_aneg);
758 static int phy_poll_aneg_done(struct phy_device *phydev)
760 unsigned int retries = 100;
765 ret = phy_aneg_done(phydev);
766 } while (!ret && --retries);
771 return ret < 0 ? ret : 0;
774 int phy_ethtool_ksettings_set(struct phy_device *phydev,
775 const struct ethtool_link_ksettings *cmd)
777 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
778 u8 autoneg = cmd->base.autoneg;
779 u8 duplex = cmd->base.duplex;
780 u32 speed = cmd->base.speed;
782 if (cmd->base.phy_address != phydev->mdio.addr)
785 linkmode_copy(advertising, cmd->link_modes.advertising);
787 /* We make sure that we don't pass unsupported values in to the PHY */
788 linkmode_and(advertising, advertising, phydev->supported);
790 /* Verify the settings we care about. */
791 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
794 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
797 if (autoneg == AUTONEG_DISABLE &&
798 ((speed != SPEED_1000 &&
799 speed != SPEED_100 &&
800 speed != SPEED_10) ||
801 (duplex != DUPLEX_HALF &&
802 duplex != DUPLEX_FULL)))
805 mutex_lock(&phydev->lock);
806 phydev->autoneg = autoneg;
808 if (autoneg == AUTONEG_DISABLE) {
809 phydev->speed = speed;
810 phydev->duplex = duplex;
813 linkmode_copy(phydev->advertising, advertising);
815 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
816 phydev->advertising, autoneg == AUTONEG_ENABLE);
818 phydev->master_slave_set = cmd->base.master_slave_cfg;
819 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
821 /* Restart the PHY */
822 if (phy_is_started(phydev)) {
823 phydev->state = PHY_UP;
824 phy_trigger_machine(phydev);
826 _phy_start_aneg(phydev);
829 mutex_unlock(&phydev->lock);
832 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
835 * phy_speed_down - set speed to lowest speed supported by both link partners
836 * @phydev: the phy_device struct
837 * @sync: perform action synchronously
839 * Description: Typically used to save energy when waiting for a WoL packet
841 * WARNING: Setting sync to false may cause the system being unable to suspend
842 * in case the PHY generates an interrupt when finishing the autonegotiation.
843 * This interrupt may wake up the system immediately after suspend.
844 * Therefore use sync = false only if you're sure it's safe with the respective
847 int phy_speed_down(struct phy_device *phydev, bool sync)
849 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
852 if (phydev->autoneg != AUTONEG_ENABLE)
855 linkmode_copy(adv_tmp, phydev->advertising);
857 ret = phy_speed_down_core(phydev);
861 linkmode_copy(phydev->adv_old, adv_tmp);
863 if (linkmode_equal(phydev->advertising, adv_tmp))
866 ret = phy_config_aneg(phydev);
870 return sync ? phy_poll_aneg_done(phydev) : 0;
872 EXPORT_SYMBOL_GPL(phy_speed_down);
875 * phy_speed_up - (re)set advertised speeds to all supported speeds
876 * @phydev: the phy_device struct
878 * Description: Used to revert the effect of phy_speed_down
880 int phy_speed_up(struct phy_device *phydev)
882 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
884 if (phydev->autoneg != AUTONEG_ENABLE)
887 if (linkmode_empty(phydev->adv_old))
890 linkmode_copy(adv_tmp, phydev->advertising);
891 linkmode_copy(phydev->advertising, phydev->adv_old);
892 linkmode_zero(phydev->adv_old);
894 if (linkmode_equal(phydev->advertising, adv_tmp))
897 return phy_config_aneg(phydev);
899 EXPORT_SYMBOL_GPL(phy_speed_up);
902 * phy_start_machine - start PHY state machine tracking
903 * @phydev: the phy_device struct
905 * Description: The PHY infrastructure can run a state machine
906 * which tracks whether the PHY is starting up, negotiating,
907 * etc. This function starts the delayed workqueue which tracks
908 * the state of the PHY. If you want to maintain your own state machine,
909 * do not call this function.
911 void phy_start_machine(struct phy_device *phydev)
913 phy_trigger_machine(phydev);
915 EXPORT_SYMBOL_GPL(phy_start_machine);
918 * phy_stop_machine - stop the PHY state machine tracking
919 * @phydev: target phy_device struct
921 * Description: Stops the state machine delayed workqueue, sets the
922 * state to UP (unless it wasn't up yet). This function must be
923 * called BEFORE phy_detach.
925 void phy_stop_machine(struct phy_device *phydev)
927 cancel_delayed_work_sync(&phydev->state_queue);
929 mutex_lock(&phydev->lock);
930 if (phy_is_started(phydev))
931 phydev->state = PHY_UP;
932 mutex_unlock(&phydev->lock);
936 * phy_error - enter HALTED state for this PHY device
937 * @phydev: target phy_device struct
939 * Moves the PHY to the HALTED state in response to a read
940 * or write error, and tells the controller the link is down.
941 * Must not be called from interrupt context, or while the
942 * phydev->lock is held.
944 void phy_error(struct phy_device *phydev)
948 mutex_lock(&phydev->lock);
949 phydev->state = PHY_HALTED;
950 mutex_unlock(&phydev->lock);
952 phy_trigger_machine(phydev);
954 EXPORT_SYMBOL(phy_error);
957 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
958 * @phydev: target phy_device struct
960 int phy_disable_interrupts(struct phy_device *phydev)
962 /* Disable PHY interrupts */
963 return phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
967 * phy_interrupt - PHY interrupt handler
968 * @irq: interrupt line
969 * @phy_dat: phy_device pointer
971 * Description: Handle PHY interrupt
973 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
975 struct phy_device *phydev = phy_dat;
976 struct phy_driver *drv = phydev->drv;
979 mutex_lock(&phydev->lock);
980 ret = drv->handle_interrupt(phydev);
981 mutex_unlock(&phydev->lock);
987 * phy_enable_interrupts - Enable the interrupts from the PHY side
988 * @phydev: target phy_device struct
990 static int phy_enable_interrupts(struct phy_device *phydev)
992 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
996 * phy_request_interrupt - request and enable interrupt for a PHY device
997 * @phydev: target phy_device struct
999 * Description: Request and enable the interrupt for the given PHY.
1000 * If this fails, then we set irq to PHY_POLL.
1001 * This should only be called with a valid IRQ number.
1003 void phy_request_interrupt(struct phy_device *phydev)
1007 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
1008 IRQF_ONESHOT | IRQF_SHARED,
1009 phydev_name(phydev), phydev);
1011 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
1013 phydev->irq = PHY_POLL;
1015 if (phy_enable_interrupts(phydev)) {
1016 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
1017 phy_free_interrupt(phydev);
1018 phydev->irq = PHY_POLL;
1022 EXPORT_SYMBOL(phy_request_interrupt);
1025 * phy_free_interrupt - disable and free interrupt for a PHY device
1026 * @phydev: target phy_device struct
1028 * Description: Disable and free the interrupt for the given PHY.
1029 * This should only be called with a valid IRQ number.
1031 void phy_free_interrupt(struct phy_device *phydev)
1033 phy_disable_interrupts(phydev);
1034 free_irq(phydev->irq, phydev);
1036 EXPORT_SYMBOL(phy_free_interrupt);
1039 * phy_stop - Bring down the PHY link, and stop checking the status
1040 * @phydev: target phy_device struct
1042 void phy_stop(struct phy_device *phydev)
1044 struct net_device *dev = phydev->attached_dev;
1046 if (!phy_is_started(phydev) && phydev->state != PHY_DOWN) {
1047 WARN(1, "called from state %s\n",
1048 phy_state_to_str(phydev->state));
1052 mutex_lock(&phydev->lock);
1054 if (phydev->state == PHY_CABLETEST) {
1055 phy_abort_cable_test(phydev);
1056 netif_testing_off(dev);
1059 if (phydev->sfp_bus)
1060 sfp_upstream_stop(phydev->sfp_bus);
1062 phydev->state = PHY_HALTED;
1064 mutex_unlock(&phydev->lock);
1066 phy_state_machine(&phydev->state_queue.work);
1067 phy_stop_machine(phydev);
1069 /* Cannot call flush_scheduled_work() here as desired because
1070 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
1071 * will not reenable interrupts.
1074 EXPORT_SYMBOL(phy_stop);
1077 * phy_start - start or restart a PHY device
1078 * @phydev: target phy_device struct
1080 * Description: Indicates the attached device's readiness to
1081 * handle PHY-related work. Used during startup to start the
1082 * PHY, and after a call to phy_stop() to resume operation.
1083 * Also used to indicate the MDIO bus has cleared an error
1086 void phy_start(struct phy_device *phydev)
1088 mutex_lock(&phydev->lock);
1090 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
1091 WARN(1, "called from state %s\n",
1092 phy_state_to_str(phydev->state));
1096 if (phydev->sfp_bus)
1097 sfp_upstream_start(phydev->sfp_bus);
1099 /* if phy was suspended, bring the physical link up again */
1100 __phy_resume(phydev);
1102 phydev->state = PHY_UP;
1104 phy_start_machine(phydev);
1106 mutex_unlock(&phydev->lock);
1108 EXPORT_SYMBOL(phy_start);
1111 * phy_state_machine - Handle the state machine
1112 * @work: work_struct that describes the work to be done
1114 void phy_state_machine(struct work_struct *work)
1116 struct delayed_work *dwork = to_delayed_work(work);
1117 struct phy_device *phydev =
1118 container_of(dwork, struct phy_device, state_queue);
1119 struct net_device *dev = phydev->attached_dev;
1120 bool needs_aneg = false, do_suspend = false;
1121 enum phy_state old_state;
1122 bool finished = false;
1125 mutex_lock(&phydev->lock);
1127 old_state = phydev->state;
1129 switch (phydev->state) {
1139 err = phy_check_link_status(phydev);
1142 err = phydev->drv->cable_test_get_status(phydev, &finished);
1144 phy_abort_cable_test(phydev);
1145 netif_testing_off(dev);
1147 phydev->state = PHY_UP;
1152 ethnl_cable_test_finished(phydev);
1153 netif_testing_off(dev);
1155 phydev->state = PHY_UP;
1161 phy_link_down(phydev);
1167 mutex_unlock(&phydev->lock);
1170 err = phy_start_aneg(phydev);
1171 else if (do_suspend)
1172 phy_suspend(phydev);
1180 if (old_state != phydev->state) {
1181 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1182 phy_state_to_str(old_state),
1183 phy_state_to_str(phydev->state));
1184 if (phydev->drv && phydev->drv->link_change_notify)
1185 phydev->drv->link_change_notify(phydev);
1188 /* Only re-schedule a PHY state machine change if we are polling the
1189 * PHY, if PHY_MAC_INTERRUPT is set, then we will be moving
1190 * between states from phy_mac_interrupt().
1192 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1193 * state machine would be pointless and possibly error prone when
1194 * called from phy_disconnect() synchronously.
1196 mutex_lock(&phydev->lock);
1197 if (phy_polling_mode(phydev) && phy_is_started(phydev))
1198 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1199 mutex_unlock(&phydev->lock);
1203 * phy_mac_interrupt - MAC says the link has changed
1204 * @phydev: phy_device struct with changed link
1206 * The MAC layer is able to indicate there has been a change in the PHY link
1207 * status. Trigger the state machine and work a work queue.
1209 void phy_mac_interrupt(struct phy_device *phydev)
1211 /* Trigger a state machine change */
1212 phy_trigger_machine(phydev);
1214 EXPORT_SYMBOL(phy_mac_interrupt);
1216 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
1218 linkmode_zero(advertising);
1220 if (eee_adv & MDIO_EEE_100TX)
1221 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1223 if (eee_adv & MDIO_EEE_1000T)
1224 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1226 if (eee_adv & MDIO_EEE_10GT)
1227 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
1229 if (eee_adv & MDIO_EEE_1000KX)
1230 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
1232 if (eee_adv & MDIO_EEE_10GKX4)
1233 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
1235 if (eee_adv & MDIO_EEE_10GKR)
1236 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
1241 * phy_init_eee - init and check the EEE feature
1242 * @phydev: target phy_device struct
1243 * @clk_stop_enable: PHY may stop the clock during LPI
1245 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1246 * is supported by looking at the MMD registers 3.20 and 7.60/61
1247 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1250 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1255 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1257 if (phydev->duplex == DUPLEX_FULL) {
1258 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1259 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1260 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1261 int eee_lp, eee_cap, eee_adv;
1265 /* Read phy status to properly get the right settings */
1266 status = phy_read_status(phydev);
1270 /* First check if the EEE ability is supported */
1271 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1275 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1279 /* Check which link settings negotiated and verify it in
1280 * the EEE advertising registers.
1282 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1286 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1290 mmd_eee_adv_to_linkmode(adv, eee_adv);
1291 mmd_eee_adv_to_linkmode(lp, eee_lp);
1292 linkmode_and(common, adv, lp);
1294 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1297 if (clk_stop_enable)
1298 /* Configure the PHY to stop receiving xMII
1299 * clock while it is signaling LPI.
1301 phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1302 MDIO_PCS_CTRL1_CLKSTOP_EN);
1304 return 0; /* EEE supported */
1307 return -EPROTONOSUPPORT;
1309 EXPORT_SYMBOL(phy_init_eee);
1312 * phy_get_eee_err - report the EEE wake error count
1313 * @phydev: target phy_device struct
1315 * Description: it is to report the number of time where the PHY
1316 * failed to complete its normal wake sequence.
1318 int phy_get_eee_err(struct phy_device *phydev)
1323 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1325 EXPORT_SYMBOL(phy_get_eee_err);
1328 * phy_ethtool_get_eee - get EEE supported and status
1329 * @phydev: target phy_device struct
1330 * @data: ethtool_eee data
1332 * Description: it reportes the Supported/Advertisement/LP Advertisement
1335 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1342 /* Get Supported EEE */
1343 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1346 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1348 /* Get advertisement EEE */
1349 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1352 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1353 data->eee_enabled = !!data->advertised;
1355 /* Get LP advertisement EEE */
1356 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1359 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1361 data->eee_active = !!(data->advertised & data->lp_advertised);
1365 EXPORT_SYMBOL(phy_ethtool_get_eee);
1368 * phy_ethtool_set_eee - set EEE supported and status
1369 * @phydev: target phy_device struct
1370 * @data: ethtool_eee data
1372 * Description: it is to program the Advertisement EEE register.
1374 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1376 int cap, old_adv, adv = 0, ret;
1381 /* Get Supported EEE */
1382 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1386 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1390 if (data->eee_enabled) {
1391 adv = !data->advertised ? cap :
1392 ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1393 /* Mask prohibited EEE modes */
1394 adv &= ~phydev->eee_broken_modes;
1397 if (old_adv != adv) {
1398 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1402 /* Restart autonegotiation so the new modes get sent to the
1405 if (phydev->autoneg == AUTONEG_ENABLE) {
1406 ret = phy_restart_aneg(phydev);
1414 EXPORT_SYMBOL(phy_ethtool_set_eee);
1417 * phy_ethtool_set_wol - Configure Wake On LAN
1419 * @phydev: target phy_device struct
1420 * @wol: Configuration requested
1422 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1424 if (phydev->drv && phydev->drv->set_wol)
1425 return phydev->drv->set_wol(phydev, wol);
1429 EXPORT_SYMBOL(phy_ethtool_set_wol);
1432 * phy_ethtool_get_wol - Get the current Wake On LAN configuration
1434 * @phydev: target phy_device struct
1435 * @wol: Store the current configuration here
1437 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1439 if (phydev->drv && phydev->drv->get_wol)
1440 phydev->drv->get_wol(phydev, wol);
1442 EXPORT_SYMBOL(phy_ethtool_get_wol);
1444 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1445 struct ethtool_link_ksettings *cmd)
1447 struct phy_device *phydev = ndev->phydev;
1452 phy_ethtool_ksettings_get(phydev, cmd);
1456 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1458 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1459 const struct ethtool_link_ksettings *cmd)
1461 struct phy_device *phydev = ndev->phydev;
1466 return phy_ethtool_ksettings_set(phydev, cmd);
1468 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1471 * phy_ethtool_nway_reset - Restart auto negotiation
1472 * @ndev: Network device to restart autoneg for
1474 int phy_ethtool_nway_reset(struct net_device *ndev)
1476 struct phy_device *phydev = ndev->phydev;
1484 return phy_restart_aneg(phydev);
1486 EXPORT_SYMBOL(phy_ethtool_nway_reset);