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_clear_interrupt - Ack the phy device's interrupt
118 * @phydev: the phy_device struct
120 * If the @phydev driver has an ack_interrupt function, call it to
121 * ack and clear the phy device's interrupt.
123 * Returns 0 on success or < 0 on error.
125 static int phy_clear_interrupt(struct phy_device *phydev)
127 if (phydev->drv->ack_interrupt)
128 return phydev->drv->ack_interrupt(phydev);
134 * phy_config_interrupt - configure the PHY device for the requested interrupts
135 * @phydev: the phy_device struct
136 * @interrupts: interrupt flags to configure for this @phydev
138 * Returns 0 on success or < 0 on error.
140 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
142 phydev->interrupts = interrupts ? 1 : 0;
143 if (phydev->drv->config_intr)
144 return phydev->drv->config_intr(phydev);
150 * phy_restart_aneg - restart auto-negotiation
151 * @phydev: target phy_device struct
153 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
154 * negative errno on error.
156 int phy_restart_aneg(struct phy_device *phydev)
160 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
161 ret = genphy_c45_restart_aneg(phydev);
163 ret = genphy_restart_aneg(phydev);
167 EXPORT_SYMBOL_GPL(phy_restart_aneg);
170 * phy_aneg_done - return auto-negotiation status
171 * @phydev: target phy_device struct
173 * Description: Return the auto-negotiation status from this @phydev
174 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
177 int phy_aneg_done(struct phy_device *phydev)
179 if (phydev->drv && phydev->drv->aneg_done)
180 return phydev->drv->aneg_done(phydev);
181 else if (phydev->is_c45)
182 return genphy_c45_aneg_done(phydev);
184 return genphy_aneg_done(phydev);
186 EXPORT_SYMBOL(phy_aneg_done);
189 * phy_find_valid - find a PHY setting that matches the requested parameters
190 * @speed: desired speed
191 * @duplex: desired duplex
192 * @supported: mask of supported link modes
194 * Locate a supported phy setting that is, in priority order:
195 * - an exact match for the specified speed and duplex mode
196 * - a match for the specified speed, or slower speed
197 * - the slowest supported speed
198 * Returns the matched phy_setting entry, or %NULL if no supported phy
199 * settings were found.
201 static const struct phy_setting *
202 phy_find_valid(int speed, int duplex, unsigned long *supported)
204 return phy_lookup_setting(speed, duplex, supported, false);
208 * phy_supported_speeds - return all speeds currently supported by a phy device
209 * @phy: The phy device to return supported speeds of.
210 * @speeds: buffer to store supported speeds in.
211 * @size: size of speeds buffer.
213 * Description: Returns the number of supported speeds, and fills the speeds
214 * buffer with the supported speeds. If speeds buffer is too small to contain
215 * all currently supported speeds, will return as many speeds as can fit.
217 unsigned int phy_supported_speeds(struct phy_device *phy,
218 unsigned int *speeds,
221 return phy_speeds(speeds, size, phy->supported);
225 * phy_check_valid - check if there is a valid PHY setting which matches
226 * speed, duplex, and feature mask
227 * @speed: speed to match
228 * @duplex: duplex to match
229 * @features: A mask of the valid settings
231 * Description: Returns true if there is a valid setting, false otherwise.
233 static inline bool phy_check_valid(int speed, int duplex,
234 unsigned long *features)
236 return !!phy_lookup_setting(speed, duplex, features, true);
240 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
241 * @phydev: the target phy_device struct
243 * Description: Make sure the PHY is set to supported speeds and
244 * duplexes. Drop down by one in this order: 1000/FULL,
245 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
247 static void phy_sanitize_settings(struct phy_device *phydev)
249 const struct phy_setting *setting;
251 setting = phy_find_valid(phydev->speed, phydev->duplex,
254 phydev->speed = setting->speed;
255 phydev->duplex = setting->duplex;
257 /* We failed to find anything (no supported speeds?) */
258 phydev->speed = SPEED_UNKNOWN;
259 phydev->duplex = DUPLEX_UNKNOWN;
263 int phy_ethtool_ksettings_set(struct phy_device *phydev,
264 const struct ethtool_link_ksettings *cmd)
266 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
267 u8 autoneg = cmd->base.autoneg;
268 u8 duplex = cmd->base.duplex;
269 u32 speed = cmd->base.speed;
271 if (cmd->base.phy_address != phydev->mdio.addr)
274 linkmode_copy(advertising, cmd->link_modes.advertising);
276 /* We make sure that we don't pass unsupported values in to the PHY */
277 linkmode_and(advertising, advertising, phydev->supported);
279 /* Verify the settings we care about. */
280 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
283 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
286 if (autoneg == AUTONEG_DISABLE &&
287 ((speed != SPEED_1000 &&
288 speed != SPEED_100 &&
289 speed != SPEED_10) ||
290 (duplex != DUPLEX_HALF &&
291 duplex != DUPLEX_FULL)))
294 phydev->autoneg = autoneg;
296 phydev->speed = speed;
298 linkmode_copy(phydev->advertising, advertising);
300 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
301 phydev->advertising, autoneg == AUTONEG_ENABLE);
303 phydev->duplex = duplex;
304 phydev->master_slave_set = cmd->base.master_slave_cfg;
305 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
307 /* Restart the PHY */
308 phy_start_aneg(phydev);
312 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
314 void phy_ethtool_ksettings_get(struct phy_device *phydev,
315 struct ethtool_link_ksettings *cmd)
317 linkmode_copy(cmd->link_modes.supported, phydev->supported);
318 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
319 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
321 cmd->base.speed = phydev->speed;
322 cmd->base.duplex = phydev->duplex;
323 cmd->base.master_slave_cfg = phydev->master_slave_get;
324 cmd->base.master_slave_state = phydev->master_slave_state;
325 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
326 cmd->base.port = PORT_BNC;
328 cmd->base.port = PORT_MII;
329 cmd->base.transceiver = phy_is_internal(phydev) ?
330 XCVR_INTERNAL : XCVR_EXTERNAL;
331 cmd->base.phy_address = phydev->mdio.addr;
332 cmd->base.autoneg = phydev->autoneg;
333 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
334 cmd->base.eth_tp_mdix = phydev->mdix;
336 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
339 * phy_mii_ioctl - generic PHY MII ioctl interface
340 * @phydev: the phy_device struct
341 * @ifr: &struct ifreq for socket ioctl's
342 * @cmd: ioctl cmd to execute
344 * Note that this function is currently incompatible with the
345 * PHYCONTROL layer. It changes registers without regard to
346 * current state. Use at own risk.
348 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
350 struct mii_ioctl_data *mii_data = if_mii(ifr);
351 u16 val = mii_data->val_in;
352 bool change_autoneg = false;
357 mii_data->phy_id = phydev->mdio.addr;
361 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
362 prtad = mdio_phy_id_prtad(mii_data->phy_id);
363 devad = mdio_phy_id_devad(mii_data->phy_id);
364 devad = mdiobus_c45_addr(devad, mii_data->reg_num);
366 prtad = mii_data->phy_id;
367 devad = mii_data->reg_num;
369 mii_data->val_out = mdiobus_read(phydev->mdio.bus, prtad,
374 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
375 prtad = mdio_phy_id_prtad(mii_data->phy_id);
376 devad = mdio_phy_id_devad(mii_data->phy_id);
377 devad = mdiobus_c45_addr(devad, mii_data->reg_num);
379 prtad = mii_data->phy_id;
380 devad = mii_data->reg_num;
382 if (prtad == phydev->mdio.addr) {
385 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
386 if (phydev->autoneg == AUTONEG_ENABLE)
387 change_autoneg = true;
388 phydev->autoneg = AUTONEG_DISABLE;
389 if (val & BMCR_FULLDPLX)
390 phydev->duplex = DUPLEX_FULL;
392 phydev->duplex = DUPLEX_HALF;
393 if (val & BMCR_SPEED1000)
394 phydev->speed = SPEED_1000;
395 else if (val & BMCR_SPEED100)
396 phydev->speed = SPEED_100;
397 else phydev->speed = SPEED_10;
400 if (phydev->autoneg == AUTONEG_DISABLE)
401 change_autoneg = true;
402 phydev->autoneg = AUTONEG_ENABLE;
406 mii_adv_mod_linkmode_adv_t(phydev->advertising,
408 change_autoneg = true;
411 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
413 change_autoneg = true;
421 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
423 if (prtad == phydev->mdio.addr &&
426 return phy_init_hw(phydev);
429 return phy_start_aneg(phydev);
434 if (phydev->mii_ts && phydev->mii_ts->hwtstamp)
435 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
442 EXPORT_SYMBOL(phy_mii_ioctl);
445 * phy_do_ioctl - generic ndo_do_ioctl implementation
446 * @dev: the net_device struct
447 * @ifr: &struct ifreq for socket ioctl's
448 * @cmd: ioctl cmd to execute
450 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
455 return phy_mii_ioctl(dev->phydev, ifr, cmd);
457 EXPORT_SYMBOL(phy_do_ioctl);
460 * phy_do_ioctl_running - generic ndo_do_ioctl implementation but test first
462 * @dev: the net_device struct
463 * @ifr: &struct ifreq for socket ioctl's
464 * @cmd: ioctl cmd to execute
466 * Same as phy_do_ioctl, but ensures that net_device is running before
467 * handling the ioctl.
469 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd)
471 if (!netif_running(dev))
474 return phy_do_ioctl(dev, ifr, cmd);
476 EXPORT_SYMBOL(phy_do_ioctl_running);
479 * phy_queue_state_machine - Trigger the state machine to run soon
481 * @phydev: the phy_device struct
482 * @jiffies: Run the state machine after these jiffies
484 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
486 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
489 EXPORT_SYMBOL(phy_queue_state_machine);
492 * phy_trigger_machine - Trigger the state machine to run now
494 * @phydev: the phy_device struct
496 void phy_trigger_machine(struct phy_device *phydev)
498 phy_queue_state_machine(phydev, 0);
500 EXPORT_SYMBOL(phy_trigger_machine);
502 static void phy_abort_cable_test(struct phy_device *phydev)
506 ethnl_cable_test_finished(phydev);
508 err = phy_init_hw(phydev);
510 phydev_err(phydev, "Error while aborting cable test");
514 * phy_ethtool_get_strings - Get the statistic counter names
516 * @phydev: the phy_device struct
517 * @data: Where to put the strings
519 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
524 mutex_lock(&phydev->lock);
525 phydev->drv->get_strings(phydev, data);
526 mutex_unlock(&phydev->lock);
530 EXPORT_SYMBOL(phy_ethtool_get_strings);
533 * phy_ethtool_get_sset_count - Get the number of statistic counters
535 * @phydev: the phy_device struct
537 int phy_ethtool_get_sset_count(struct phy_device *phydev)
544 if (phydev->drv->get_sset_count &&
545 phydev->drv->get_strings &&
546 phydev->drv->get_stats) {
547 mutex_lock(&phydev->lock);
548 ret = phydev->drv->get_sset_count(phydev);
549 mutex_unlock(&phydev->lock);
556 EXPORT_SYMBOL(phy_ethtool_get_sset_count);
559 * phy_ethtool_get_stats - Get the statistic counters
561 * @phydev: the phy_device struct
562 * @stats: What counters to get
563 * @data: Where to store the counters
565 int phy_ethtool_get_stats(struct phy_device *phydev,
566 struct ethtool_stats *stats, u64 *data)
571 mutex_lock(&phydev->lock);
572 phydev->drv->get_stats(phydev, stats, data);
573 mutex_unlock(&phydev->lock);
577 EXPORT_SYMBOL(phy_ethtool_get_stats);
580 * phy_start_cable_test - Start a cable test
582 * @phydev: the phy_device struct
583 * @extack: extack for reporting useful error messages
585 int phy_start_cable_test(struct phy_device *phydev,
586 struct netlink_ext_ack *extack)
588 struct net_device *dev = phydev->attached_dev;
592 phydev->drv->cable_test_start &&
593 phydev->drv->cable_test_get_status)) {
594 NL_SET_ERR_MSG(extack,
595 "PHY driver does not support cable testing");
599 mutex_lock(&phydev->lock);
600 if (phydev->state == PHY_CABLETEST) {
601 NL_SET_ERR_MSG(extack,
602 "PHY already performing a test");
607 if (phydev->state < PHY_UP ||
608 phydev->state > PHY_CABLETEST) {
609 NL_SET_ERR_MSG(extack,
610 "PHY not configured. Try setting interface up");
615 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_NTF);
619 /* Mark the carrier down until the test is complete */
620 phy_link_down(phydev);
622 netif_testing_on(dev);
623 err = phydev->drv->cable_test_start(phydev);
625 netif_testing_off(dev);
630 phydev->state = PHY_CABLETEST;
632 if (phy_polling_mode(phydev))
633 phy_trigger_machine(phydev);
635 mutex_unlock(&phydev->lock);
640 ethnl_cable_test_free(phydev);
642 mutex_unlock(&phydev->lock);
646 EXPORT_SYMBOL(phy_start_cable_test);
649 * phy_start_cable_test_tdr - Start a raw TDR cable test
651 * @phydev: the phy_device struct
652 * @extack: extack for reporting useful error messages
653 * @config: Configuration of the test to run
655 int phy_start_cable_test_tdr(struct phy_device *phydev,
656 struct netlink_ext_ack *extack,
657 const struct phy_tdr_config *config)
659 struct net_device *dev = phydev->attached_dev;
663 phydev->drv->cable_test_tdr_start &&
664 phydev->drv->cable_test_get_status)) {
665 NL_SET_ERR_MSG(extack,
666 "PHY driver does not support cable test TDR");
670 mutex_lock(&phydev->lock);
671 if (phydev->state == PHY_CABLETEST) {
672 NL_SET_ERR_MSG(extack,
673 "PHY already performing a test");
678 if (phydev->state < PHY_UP ||
679 phydev->state > PHY_CABLETEST) {
680 NL_SET_ERR_MSG(extack,
681 "PHY not configured. Try setting interface up");
686 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_TDR_NTF);
690 /* Mark the carrier down until the test is complete */
691 phy_link_down(phydev);
693 netif_testing_on(dev);
694 err = phydev->drv->cable_test_tdr_start(phydev, config);
696 netif_testing_off(dev);
701 phydev->state = PHY_CABLETEST;
703 if (phy_polling_mode(phydev))
704 phy_trigger_machine(phydev);
706 mutex_unlock(&phydev->lock);
711 ethnl_cable_test_free(phydev);
713 mutex_unlock(&phydev->lock);
717 EXPORT_SYMBOL(phy_start_cable_test_tdr);
719 static int phy_config_aneg(struct phy_device *phydev)
721 if (phydev->drv->config_aneg)
722 return phydev->drv->config_aneg(phydev);
724 /* Clause 45 PHYs that don't implement Clause 22 registers are not
725 * allowed to call genphy_config_aneg()
727 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
728 return genphy_c45_config_aneg(phydev);
730 return genphy_config_aneg(phydev);
734 * phy_check_link_status - check link status and set state accordingly
735 * @phydev: the phy_device struct
737 * Description: Check for link and whether autoneg was triggered / is running
738 * and set state accordingly
740 static int phy_check_link_status(struct phy_device *phydev)
744 WARN_ON(!mutex_is_locked(&phydev->lock));
746 /* Keep previous state if loopback is enabled because some PHYs
747 * report that Link is Down when loopback is enabled.
749 if (phydev->loopback_enabled)
752 err = phy_read_status(phydev);
756 if (phydev->link && phydev->state != PHY_RUNNING) {
757 phy_check_downshift(phydev);
758 phydev->state = PHY_RUNNING;
760 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
761 phydev->state = PHY_NOLINK;
762 phy_link_down(phydev);
769 * phy_start_aneg - start auto-negotiation for this PHY device
770 * @phydev: the phy_device struct
772 * Description: Sanitizes the settings (if we're not autonegotiating
773 * them), and then calls the driver's config_aneg function.
774 * If the PHYCONTROL Layer is operating, we change the state to
775 * reflect the beginning of Auto-negotiation or forcing.
777 int phy_start_aneg(struct phy_device *phydev)
784 mutex_lock(&phydev->lock);
786 if (AUTONEG_DISABLE == phydev->autoneg)
787 phy_sanitize_settings(phydev);
789 err = phy_config_aneg(phydev);
793 if (phy_is_started(phydev))
794 err = phy_check_link_status(phydev);
796 mutex_unlock(&phydev->lock);
800 EXPORT_SYMBOL(phy_start_aneg);
802 static int phy_poll_aneg_done(struct phy_device *phydev)
804 unsigned int retries = 100;
809 ret = phy_aneg_done(phydev);
810 } while (!ret && --retries);
815 return ret < 0 ? ret : 0;
819 * phy_speed_down - set speed to lowest speed supported by both link partners
820 * @phydev: the phy_device struct
821 * @sync: perform action synchronously
823 * Description: Typically used to save energy when waiting for a WoL packet
825 * WARNING: Setting sync to false may cause the system being unable to suspend
826 * in case the PHY generates an interrupt when finishing the autonegotiation.
827 * This interrupt may wake up the system immediately after suspend.
828 * Therefore use sync = false only if you're sure it's safe with the respective
831 int phy_speed_down(struct phy_device *phydev, bool sync)
833 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
836 if (phydev->autoneg != AUTONEG_ENABLE)
839 linkmode_copy(adv_tmp, phydev->advertising);
841 ret = phy_speed_down_core(phydev);
845 linkmode_copy(phydev->adv_old, adv_tmp);
847 if (linkmode_equal(phydev->advertising, adv_tmp))
850 ret = phy_config_aneg(phydev);
854 return sync ? phy_poll_aneg_done(phydev) : 0;
856 EXPORT_SYMBOL_GPL(phy_speed_down);
859 * phy_speed_up - (re)set advertised speeds to all supported speeds
860 * @phydev: the phy_device struct
862 * Description: Used to revert the effect of phy_speed_down
864 int phy_speed_up(struct phy_device *phydev)
866 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
868 if (phydev->autoneg != AUTONEG_ENABLE)
871 if (linkmode_empty(phydev->adv_old))
874 linkmode_copy(adv_tmp, phydev->advertising);
875 linkmode_copy(phydev->advertising, phydev->adv_old);
876 linkmode_zero(phydev->adv_old);
878 if (linkmode_equal(phydev->advertising, adv_tmp))
881 return phy_config_aneg(phydev);
883 EXPORT_SYMBOL_GPL(phy_speed_up);
886 * phy_start_machine - start PHY state machine tracking
887 * @phydev: the phy_device struct
889 * Description: The PHY infrastructure can run a state machine
890 * which tracks whether the PHY is starting up, negotiating,
891 * etc. This function starts the delayed workqueue which tracks
892 * the state of the PHY. If you want to maintain your own state machine,
893 * do not call this function.
895 void phy_start_machine(struct phy_device *phydev)
897 phy_trigger_machine(phydev);
899 EXPORT_SYMBOL_GPL(phy_start_machine);
902 * phy_stop_machine - stop the PHY state machine tracking
903 * @phydev: target phy_device struct
905 * Description: Stops the state machine delayed workqueue, sets the
906 * state to UP (unless it wasn't up yet). This function must be
907 * called BEFORE phy_detach.
909 void phy_stop_machine(struct phy_device *phydev)
911 cancel_delayed_work_sync(&phydev->state_queue);
913 mutex_lock(&phydev->lock);
914 if (phy_is_started(phydev))
915 phydev->state = PHY_UP;
916 mutex_unlock(&phydev->lock);
920 * phy_error - enter HALTED state for this PHY device
921 * @phydev: target phy_device struct
923 * Moves the PHY to the HALTED state in response to a read
924 * or write error, and tells the controller the link is down.
925 * Must not be called from interrupt context, or while the
926 * phydev->lock is held.
928 void phy_error(struct phy_device *phydev)
932 mutex_lock(&phydev->lock);
933 phydev->state = PHY_HALTED;
934 mutex_unlock(&phydev->lock);
936 phy_trigger_machine(phydev);
938 EXPORT_SYMBOL(phy_error);
941 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
942 * @phydev: target phy_device struct
944 int phy_disable_interrupts(struct phy_device *phydev)
948 /* Disable PHY interrupts */
949 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
953 /* Clear the interrupt */
954 return phy_clear_interrupt(phydev);
958 * phy_interrupt - PHY interrupt handler
959 * @irq: interrupt line
960 * @phy_dat: phy_device pointer
962 * Description: Handle PHY interrupt
964 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
966 struct phy_device *phydev = phy_dat;
967 struct phy_driver *drv = phydev->drv;
969 if (drv->handle_interrupt)
970 return drv->handle_interrupt(phydev);
972 if (drv->did_interrupt && !drv->did_interrupt(phydev))
975 /* reschedule state queue work to run as soon as possible */
976 phy_trigger_machine(phydev);
978 /* did_interrupt() may have cleared the interrupt already */
979 if (!drv->did_interrupt && phy_clear_interrupt(phydev)) {
988 * phy_enable_interrupts - Enable the interrupts from the PHY side
989 * @phydev: target phy_device struct
991 static int phy_enable_interrupts(struct phy_device *phydev)
993 int err = phy_clear_interrupt(phydev);
998 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
1002 * phy_request_interrupt - request and enable interrupt for a PHY device
1003 * @phydev: target phy_device struct
1005 * Description: Request and enable the interrupt for the given PHY.
1006 * If this fails, then we set irq to PHY_POLL.
1007 * This should only be called with a valid IRQ number.
1009 void phy_request_interrupt(struct phy_device *phydev)
1013 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
1014 IRQF_ONESHOT | IRQF_SHARED,
1015 phydev_name(phydev), phydev);
1017 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
1019 phydev->irq = PHY_POLL;
1021 if (phy_enable_interrupts(phydev)) {
1022 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
1023 phy_free_interrupt(phydev);
1024 phydev->irq = PHY_POLL;
1028 EXPORT_SYMBOL(phy_request_interrupt);
1031 * phy_free_interrupt - disable and free interrupt for a PHY device
1032 * @phydev: target phy_device struct
1034 * Description: Disable and free the interrupt for the given PHY.
1035 * This should only be called with a valid IRQ number.
1037 void phy_free_interrupt(struct phy_device *phydev)
1039 phy_disable_interrupts(phydev);
1040 free_irq(phydev->irq, phydev);
1042 EXPORT_SYMBOL(phy_free_interrupt);
1045 * phy_stop - Bring down the PHY link, and stop checking the status
1046 * @phydev: target phy_device struct
1048 void phy_stop(struct phy_device *phydev)
1050 struct net_device *dev = phydev->attached_dev;
1052 if (!phy_is_started(phydev) && phydev->state != PHY_DOWN) {
1053 WARN(1, "called from state %s\n",
1054 phy_state_to_str(phydev->state));
1058 mutex_lock(&phydev->lock);
1060 if (phydev->state == PHY_CABLETEST) {
1061 phy_abort_cable_test(phydev);
1062 netif_testing_off(dev);
1065 if (phydev->sfp_bus)
1066 sfp_upstream_stop(phydev->sfp_bus);
1068 phydev->state = PHY_HALTED;
1070 mutex_unlock(&phydev->lock);
1072 phy_state_machine(&phydev->state_queue.work);
1073 phy_stop_machine(phydev);
1075 /* Cannot call flush_scheduled_work() here as desired because
1076 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
1077 * will not reenable interrupts.
1080 EXPORT_SYMBOL(phy_stop);
1083 * phy_start - start or restart a PHY device
1084 * @phydev: target phy_device struct
1086 * Description: Indicates the attached device's readiness to
1087 * handle PHY-related work. Used during startup to start the
1088 * PHY, and after a call to phy_stop() to resume operation.
1089 * Also used to indicate the MDIO bus has cleared an error
1092 void phy_start(struct phy_device *phydev)
1094 mutex_lock(&phydev->lock);
1096 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
1097 WARN(1, "called from state %s\n",
1098 phy_state_to_str(phydev->state));
1102 if (phydev->sfp_bus)
1103 sfp_upstream_start(phydev->sfp_bus);
1105 /* if phy was suspended, bring the physical link up again */
1106 __phy_resume(phydev);
1108 phydev->state = PHY_UP;
1110 phy_start_machine(phydev);
1112 mutex_unlock(&phydev->lock);
1114 EXPORT_SYMBOL(phy_start);
1117 * phy_state_machine - Handle the state machine
1118 * @work: work_struct that describes the work to be done
1120 void phy_state_machine(struct work_struct *work)
1122 struct delayed_work *dwork = to_delayed_work(work);
1123 struct phy_device *phydev =
1124 container_of(dwork, struct phy_device, state_queue);
1125 struct net_device *dev = phydev->attached_dev;
1126 bool needs_aneg = false, do_suspend = false;
1127 enum phy_state old_state;
1128 bool finished = false;
1131 mutex_lock(&phydev->lock);
1133 old_state = phydev->state;
1135 switch (phydev->state) {
1145 err = phy_check_link_status(phydev);
1148 err = phydev->drv->cable_test_get_status(phydev, &finished);
1150 phy_abort_cable_test(phydev);
1151 netif_testing_off(dev);
1153 phydev->state = PHY_UP;
1158 ethnl_cable_test_finished(phydev);
1159 netif_testing_off(dev);
1161 phydev->state = PHY_UP;
1167 phy_link_down(phydev);
1173 mutex_unlock(&phydev->lock);
1176 err = phy_start_aneg(phydev);
1177 else if (do_suspend)
1178 phy_suspend(phydev);
1183 if (old_state != phydev->state) {
1184 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1185 phy_state_to_str(old_state),
1186 phy_state_to_str(phydev->state));
1187 if (phydev->drv && phydev->drv->link_change_notify)
1188 phydev->drv->link_change_notify(phydev);
1191 /* Only re-schedule a PHY state machine change if we are polling the
1192 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1193 * between states from phy_mac_interrupt().
1195 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1196 * state machine would be pointless and possibly error prone when
1197 * called from phy_disconnect() synchronously.
1199 mutex_lock(&phydev->lock);
1200 if (phy_polling_mode(phydev) && phy_is_started(phydev))
1201 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1202 mutex_unlock(&phydev->lock);
1206 * phy_mac_interrupt - MAC says the link has changed
1207 * @phydev: phy_device struct with changed link
1209 * The MAC layer is able to indicate there has been a change in the PHY link
1210 * status. Trigger the state machine and work a work queue.
1212 void phy_mac_interrupt(struct phy_device *phydev)
1214 /* Trigger a state machine change */
1215 phy_trigger_machine(phydev);
1217 EXPORT_SYMBOL(phy_mac_interrupt);
1219 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
1221 linkmode_zero(advertising);
1223 if (eee_adv & MDIO_EEE_100TX)
1224 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1226 if (eee_adv & MDIO_EEE_1000T)
1227 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1229 if (eee_adv & MDIO_EEE_10GT)
1230 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
1232 if (eee_adv & MDIO_EEE_1000KX)
1233 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
1235 if (eee_adv & MDIO_EEE_10GKX4)
1236 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
1238 if (eee_adv & MDIO_EEE_10GKR)
1239 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
1244 * phy_init_eee - init and check the EEE feature
1245 * @phydev: target phy_device struct
1246 * @clk_stop_enable: PHY may stop the clock during LPI
1248 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1249 * is supported by looking at the MMD registers 3.20 and 7.60/61
1250 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1253 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1258 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1260 if (phydev->duplex == DUPLEX_FULL) {
1261 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1262 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1263 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1264 int eee_lp, eee_cap, eee_adv;
1268 /* Read phy status to properly get the right settings */
1269 status = phy_read_status(phydev);
1273 /* First check if the EEE ability is supported */
1274 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1278 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1282 /* Check which link settings negotiated and verify it in
1283 * the EEE advertising registers.
1285 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1289 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1293 mmd_eee_adv_to_linkmode(adv, eee_adv);
1294 mmd_eee_adv_to_linkmode(lp, eee_lp);
1295 linkmode_and(common, adv, lp);
1297 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1300 if (clk_stop_enable)
1301 /* Configure the PHY to stop receiving xMII
1302 * clock while it is signaling LPI.
1304 phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1305 MDIO_PCS_CTRL1_CLKSTOP_EN);
1307 return 0; /* EEE supported */
1310 return -EPROTONOSUPPORT;
1312 EXPORT_SYMBOL(phy_init_eee);
1315 * phy_get_eee_err - report the EEE wake error count
1316 * @phydev: target phy_device struct
1318 * Description: it is to report the number of time where the PHY
1319 * failed to complete its normal wake sequence.
1321 int phy_get_eee_err(struct phy_device *phydev)
1326 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1328 EXPORT_SYMBOL(phy_get_eee_err);
1331 * phy_ethtool_get_eee - get EEE supported and status
1332 * @phydev: target phy_device struct
1333 * @data: ethtool_eee data
1335 * Description: it reportes the Supported/Advertisement/LP Advertisement
1338 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1345 /* Get Supported EEE */
1346 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1349 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1351 /* Get advertisement EEE */
1352 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1355 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1356 data->eee_enabled = !!data->advertised;
1358 /* Get LP advertisement EEE */
1359 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1362 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1364 data->eee_active = !!(data->advertised & data->lp_advertised);
1368 EXPORT_SYMBOL(phy_ethtool_get_eee);
1371 * phy_ethtool_set_eee - set EEE supported and status
1372 * @phydev: target phy_device struct
1373 * @data: ethtool_eee data
1375 * Description: it is to program the Advertisement EEE register.
1377 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1379 int cap, old_adv, adv = 0, ret;
1384 /* Get Supported EEE */
1385 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1389 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1393 if (data->eee_enabled) {
1394 adv = !data->advertised ? cap :
1395 ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1396 /* Mask prohibited EEE modes */
1397 adv &= ~phydev->eee_broken_modes;
1400 if (old_adv != adv) {
1401 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1405 /* Restart autonegotiation so the new modes get sent to the
1408 if (phydev->autoneg == AUTONEG_ENABLE) {
1409 ret = phy_restart_aneg(phydev);
1417 EXPORT_SYMBOL(phy_ethtool_set_eee);
1420 * phy_ethtool_set_wol - Configure Wake On LAN
1422 * @phydev: target phy_device struct
1423 * @wol: Configuration requested
1425 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1427 if (phydev->drv && phydev->drv->set_wol)
1428 return phydev->drv->set_wol(phydev, wol);
1432 EXPORT_SYMBOL(phy_ethtool_set_wol);
1435 * phy_ethtool_get_wol - Get the current Wake On LAN configuration
1437 * @phydev: target phy_device struct
1438 * @wol: Store the current configuration here
1440 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1442 if (phydev->drv && phydev->drv->get_wol)
1443 phydev->drv->get_wol(phydev, wol);
1445 EXPORT_SYMBOL(phy_ethtool_get_wol);
1447 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1448 struct ethtool_link_ksettings *cmd)
1450 struct phy_device *phydev = ndev->phydev;
1455 phy_ethtool_ksettings_get(phydev, cmd);
1459 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1461 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1462 const struct ethtool_link_ksettings *cmd)
1464 struct phy_device *phydev = ndev->phydev;
1469 return phy_ethtool_ksettings_set(phydev, cmd);
1471 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1474 * phy_ethtool_nway_reset - Restart auto negotiation
1475 * @ndev: Network device to restart autoneg for
1477 int phy_ethtool_nway_reset(struct net_device *ndev)
1479 struct phy_device *phydev = ndev->phydev;
1487 return phy_restart_aneg(phydev);
1489 EXPORT_SYMBOL(phy_ethtool_nway_reset);