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 int phy_ethtool_ksettings_set(struct phy_device *phydev,
247 const struct ethtool_link_ksettings *cmd)
249 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
250 u8 autoneg = cmd->base.autoneg;
251 u8 duplex = cmd->base.duplex;
252 u32 speed = cmd->base.speed;
254 if (cmd->base.phy_address != phydev->mdio.addr)
257 linkmode_copy(advertising, cmd->link_modes.advertising);
259 /* We make sure that we don't pass unsupported values in to the PHY */
260 linkmode_and(advertising, advertising, phydev->supported);
262 /* Verify the settings we care about. */
263 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
266 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
269 if (autoneg == AUTONEG_DISABLE &&
270 ((speed != SPEED_1000 &&
271 speed != SPEED_100 &&
272 speed != SPEED_10) ||
273 (duplex != DUPLEX_HALF &&
274 duplex != DUPLEX_FULL)))
277 phydev->autoneg = autoneg;
279 phydev->speed = speed;
281 linkmode_copy(phydev->advertising, advertising);
283 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
284 phydev->advertising, autoneg == AUTONEG_ENABLE);
286 phydev->duplex = duplex;
287 phydev->master_slave_set = cmd->base.master_slave_cfg;
288 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
290 /* Restart the PHY */
291 phy_start_aneg(phydev);
295 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
297 void phy_ethtool_ksettings_get(struct phy_device *phydev,
298 struct ethtool_link_ksettings *cmd)
300 linkmode_copy(cmd->link_modes.supported, phydev->supported);
301 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
302 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
304 cmd->base.speed = phydev->speed;
305 cmd->base.duplex = phydev->duplex;
306 cmd->base.master_slave_cfg = phydev->master_slave_get;
307 cmd->base.master_slave_state = phydev->master_slave_state;
308 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
309 cmd->base.port = PORT_BNC;
311 cmd->base.port = phydev->port;
312 cmd->base.transceiver = phy_is_internal(phydev) ?
313 XCVR_INTERNAL : XCVR_EXTERNAL;
314 cmd->base.phy_address = phydev->mdio.addr;
315 cmd->base.autoneg = phydev->autoneg;
316 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
317 cmd->base.eth_tp_mdix = phydev->mdix;
319 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
322 * phy_mii_ioctl - generic PHY MII ioctl interface
323 * @phydev: the phy_device struct
324 * @ifr: &struct ifreq for socket ioctl's
325 * @cmd: ioctl cmd to execute
327 * Note that this function is currently incompatible with the
328 * PHYCONTROL layer. It changes registers without regard to
329 * current state. Use at own risk.
331 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
333 struct mii_ioctl_data *mii_data = if_mii(ifr);
334 u16 val = mii_data->val_in;
335 bool change_autoneg = false;
340 mii_data->phy_id = phydev->mdio.addr;
344 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
345 prtad = mdio_phy_id_prtad(mii_data->phy_id);
346 devad = mdio_phy_id_devad(mii_data->phy_id);
347 devad = mdiobus_c45_addr(devad, mii_data->reg_num);
349 prtad = mii_data->phy_id;
350 devad = mii_data->reg_num;
352 mii_data->val_out = mdiobus_read(phydev->mdio.bus, prtad,
357 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
358 prtad = mdio_phy_id_prtad(mii_data->phy_id);
359 devad = mdio_phy_id_devad(mii_data->phy_id);
360 devad = mdiobus_c45_addr(devad, mii_data->reg_num);
362 prtad = mii_data->phy_id;
363 devad = mii_data->reg_num;
365 if (prtad == phydev->mdio.addr) {
368 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
369 if (phydev->autoneg == AUTONEG_ENABLE)
370 change_autoneg = true;
371 phydev->autoneg = AUTONEG_DISABLE;
372 if (val & BMCR_FULLDPLX)
373 phydev->duplex = DUPLEX_FULL;
375 phydev->duplex = DUPLEX_HALF;
376 if (val & BMCR_SPEED1000)
377 phydev->speed = SPEED_1000;
378 else if (val & BMCR_SPEED100)
379 phydev->speed = SPEED_100;
380 else phydev->speed = SPEED_10;
383 if (phydev->autoneg == AUTONEG_DISABLE)
384 change_autoneg = true;
385 phydev->autoneg = AUTONEG_ENABLE;
389 mii_adv_mod_linkmode_adv_t(phydev->advertising,
391 change_autoneg = true;
394 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
396 change_autoneg = true;
404 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
406 if (prtad == phydev->mdio.addr &&
409 return phy_init_hw(phydev);
412 return phy_start_aneg(phydev);
417 if (phydev->mii_ts && phydev->mii_ts->hwtstamp)
418 return phydev->mii_ts->hwtstamp(phydev->mii_ts, ifr);
425 EXPORT_SYMBOL(phy_mii_ioctl);
428 * phy_do_ioctl - generic ndo_do_ioctl implementation
429 * @dev: the net_device struct
430 * @ifr: &struct ifreq for socket ioctl's
431 * @cmd: ioctl cmd to execute
433 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
438 return phy_mii_ioctl(dev->phydev, ifr, cmd);
440 EXPORT_SYMBOL(phy_do_ioctl);
443 * phy_do_ioctl_running - generic ndo_do_ioctl implementation but test first
445 * @dev: the net_device struct
446 * @ifr: &struct ifreq for socket ioctl's
447 * @cmd: ioctl cmd to execute
449 * Same as phy_do_ioctl, but ensures that net_device is running before
450 * handling the ioctl.
452 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd)
454 if (!netif_running(dev))
457 return phy_do_ioctl(dev, ifr, cmd);
459 EXPORT_SYMBOL(phy_do_ioctl_running);
462 * phy_queue_state_machine - Trigger the state machine to run soon
464 * @phydev: the phy_device struct
465 * @jiffies: Run the state machine after these jiffies
467 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
469 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
472 EXPORT_SYMBOL(phy_queue_state_machine);
475 * phy_trigger_machine - Trigger the state machine to run now
477 * @phydev: the phy_device struct
479 void phy_trigger_machine(struct phy_device *phydev)
481 phy_queue_state_machine(phydev, 0);
483 EXPORT_SYMBOL(phy_trigger_machine);
485 static void phy_abort_cable_test(struct phy_device *phydev)
489 ethnl_cable_test_finished(phydev);
491 err = phy_init_hw(phydev);
493 phydev_err(phydev, "Error while aborting cable test");
497 * phy_ethtool_get_strings - Get the statistic counter names
499 * @phydev: the phy_device struct
500 * @data: Where to put the strings
502 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
507 mutex_lock(&phydev->lock);
508 phydev->drv->get_strings(phydev, data);
509 mutex_unlock(&phydev->lock);
513 EXPORT_SYMBOL(phy_ethtool_get_strings);
516 * phy_ethtool_get_sset_count - Get the number of statistic counters
518 * @phydev: the phy_device struct
520 int phy_ethtool_get_sset_count(struct phy_device *phydev)
527 if (phydev->drv->get_sset_count &&
528 phydev->drv->get_strings &&
529 phydev->drv->get_stats) {
530 mutex_lock(&phydev->lock);
531 ret = phydev->drv->get_sset_count(phydev);
532 mutex_unlock(&phydev->lock);
539 EXPORT_SYMBOL(phy_ethtool_get_sset_count);
542 * phy_ethtool_get_stats - Get the statistic counters
544 * @phydev: the phy_device struct
545 * @stats: What counters to get
546 * @data: Where to store the counters
548 int phy_ethtool_get_stats(struct phy_device *phydev,
549 struct ethtool_stats *stats, u64 *data)
554 mutex_lock(&phydev->lock);
555 phydev->drv->get_stats(phydev, stats, data);
556 mutex_unlock(&phydev->lock);
560 EXPORT_SYMBOL(phy_ethtool_get_stats);
563 * phy_start_cable_test - Start a cable test
565 * @phydev: the phy_device struct
566 * @extack: extack for reporting useful error messages
568 int phy_start_cable_test(struct phy_device *phydev,
569 struct netlink_ext_ack *extack)
571 struct net_device *dev = phydev->attached_dev;
575 phydev->drv->cable_test_start &&
576 phydev->drv->cable_test_get_status)) {
577 NL_SET_ERR_MSG(extack,
578 "PHY driver does not support cable testing");
582 mutex_lock(&phydev->lock);
583 if (phydev->state == PHY_CABLETEST) {
584 NL_SET_ERR_MSG(extack,
585 "PHY already performing a test");
590 if (phydev->state < PHY_UP ||
591 phydev->state > PHY_CABLETEST) {
592 NL_SET_ERR_MSG(extack,
593 "PHY not configured. Try setting interface up");
598 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_NTF);
602 /* Mark the carrier down until the test is complete */
603 phy_link_down(phydev);
605 netif_testing_on(dev);
606 err = phydev->drv->cable_test_start(phydev);
608 netif_testing_off(dev);
613 phydev->state = PHY_CABLETEST;
615 if (phy_polling_mode(phydev))
616 phy_trigger_machine(phydev);
618 mutex_unlock(&phydev->lock);
623 ethnl_cable_test_free(phydev);
625 mutex_unlock(&phydev->lock);
629 EXPORT_SYMBOL(phy_start_cable_test);
632 * phy_start_cable_test_tdr - Start a raw TDR cable test
634 * @phydev: the phy_device struct
635 * @extack: extack for reporting useful error messages
636 * @config: Configuration of the test to run
638 int phy_start_cable_test_tdr(struct phy_device *phydev,
639 struct netlink_ext_ack *extack,
640 const struct phy_tdr_config *config)
642 struct net_device *dev = phydev->attached_dev;
646 phydev->drv->cable_test_tdr_start &&
647 phydev->drv->cable_test_get_status)) {
648 NL_SET_ERR_MSG(extack,
649 "PHY driver does not support cable test TDR");
653 mutex_lock(&phydev->lock);
654 if (phydev->state == PHY_CABLETEST) {
655 NL_SET_ERR_MSG(extack,
656 "PHY already performing a test");
661 if (phydev->state < PHY_UP ||
662 phydev->state > PHY_CABLETEST) {
663 NL_SET_ERR_MSG(extack,
664 "PHY not configured. Try setting interface up");
669 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_TDR_NTF);
673 /* Mark the carrier down until the test is complete */
674 phy_link_down(phydev);
676 netif_testing_on(dev);
677 err = phydev->drv->cable_test_tdr_start(phydev, config);
679 netif_testing_off(dev);
684 phydev->state = PHY_CABLETEST;
686 if (phy_polling_mode(phydev))
687 phy_trigger_machine(phydev);
689 mutex_unlock(&phydev->lock);
694 ethnl_cable_test_free(phydev);
696 mutex_unlock(&phydev->lock);
700 EXPORT_SYMBOL(phy_start_cable_test_tdr);
702 static int phy_config_aneg(struct phy_device *phydev)
704 if (phydev->drv->config_aneg)
705 return phydev->drv->config_aneg(phydev);
707 /* Clause 45 PHYs that don't implement Clause 22 registers are not
708 * allowed to call genphy_config_aneg()
710 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
711 return genphy_c45_config_aneg(phydev);
713 return genphy_config_aneg(phydev);
717 * phy_check_link_status - check link status and set state accordingly
718 * @phydev: the phy_device struct
720 * Description: Check for link and whether autoneg was triggered / is running
721 * and set state accordingly
723 static int phy_check_link_status(struct phy_device *phydev)
727 lockdep_assert_held(&phydev->lock);
729 /* Keep previous state if loopback is enabled because some PHYs
730 * report that Link is Down when loopback is enabled.
732 if (phydev->loopback_enabled)
735 err = phy_read_status(phydev);
739 if (phydev->link && phydev->state != PHY_RUNNING) {
740 phy_check_downshift(phydev);
741 phydev->state = PHY_RUNNING;
743 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
744 phydev->state = PHY_NOLINK;
745 phy_link_down(phydev);
752 * phy_start_aneg - start auto-negotiation for this PHY device
753 * @phydev: the phy_device struct
755 * Description: Sanitizes the settings (if we're not autonegotiating
756 * them), and then calls the driver's config_aneg function.
757 * If the PHYCONTROL Layer is operating, we change the state to
758 * reflect the beginning of Auto-negotiation or forcing.
760 int phy_start_aneg(struct phy_device *phydev)
767 mutex_lock(&phydev->lock);
769 if (AUTONEG_DISABLE == phydev->autoneg)
770 phy_sanitize_settings(phydev);
772 err = phy_config_aneg(phydev);
776 if (phy_is_started(phydev))
777 err = phy_check_link_status(phydev);
779 mutex_unlock(&phydev->lock);
783 EXPORT_SYMBOL(phy_start_aneg);
785 static int phy_poll_aneg_done(struct phy_device *phydev)
787 unsigned int retries = 100;
792 ret = phy_aneg_done(phydev);
793 } while (!ret && --retries);
798 return ret < 0 ? ret : 0;
802 * phy_speed_down - set speed to lowest speed supported by both link partners
803 * @phydev: the phy_device struct
804 * @sync: perform action synchronously
806 * Description: Typically used to save energy when waiting for a WoL packet
808 * WARNING: Setting sync to false may cause the system being unable to suspend
809 * in case the PHY generates an interrupt when finishing the autonegotiation.
810 * This interrupt may wake up the system immediately after suspend.
811 * Therefore use sync = false only if you're sure it's safe with the respective
814 int phy_speed_down(struct phy_device *phydev, bool sync)
816 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
819 if (phydev->autoneg != AUTONEG_ENABLE)
822 linkmode_copy(adv_tmp, phydev->advertising);
824 ret = phy_speed_down_core(phydev);
828 linkmode_copy(phydev->adv_old, adv_tmp);
830 if (linkmode_equal(phydev->advertising, adv_tmp))
833 ret = phy_config_aneg(phydev);
837 return sync ? phy_poll_aneg_done(phydev) : 0;
839 EXPORT_SYMBOL_GPL(phy_speed_down);
842 * phy_speed_up - (re)set advertised speeds to all supported speeds
843 * @phydev: the phy_device struct
845 * Description: Used to revert the effect of phy_speed_down
847 int phy_speed_up(struct phy_device *phydev)
849 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
851 if (phydev->autoneg != AUTONEG_ENABLE)
854 if (linkmode_empty(phydev->adv_old))
857 linkmode_copy(adv_tmp, phydev->advertising);
858 linkmode_copy(phydev->advertising, phydev->adv_old);
859 linkmode_zero(phydev->adv_old);
861 if (linkmode_equal(phydev->advertising, adv_tmp))
864 return phy_config_aneg(phydev);
866 EXPORT_SYMBOL_GPL(phy_speed_up);
869 * phy_start_machine - start PHY state machine tracking
870 * @phydev: the phy_device struct
872 * Description: The PHY infrastructure can run a state machine
873 * which tracks whether the PHY is starting up, negotiating,
874 * etc. This function starts the delayed workqueue which tracks
875 * the state of the PHY. If you want to maintain your own state machine,
876 * do not call this function.
878 void phy_start_machine(struct phy_device *phydev)
880 phy_trigger_machine(phydev);
882 EXPORT_SYMBOL_GPL(phy_start_machine);
885 * phy_stop_machine - stop the PHY state machine tracking
886 * @phydev: target phy_device struct
888 * Description: Stops the state machine delayed workqueue, sets the
889 * state to UP (unless it wasn't up yet). This function must be
890 * called BEFORE phy_detach.
892 void phy_stop_machine(struct phy_device *phydev)
894 cancel_delayed_work_sync(&phydev->state_queue);
896 mutex_lock(&phydev->lock);
897 if (phy_is_started(phydev))
898 phydev->state = PHY_UP;
899 mutex_unlock(&phydev->lock);
903 * phy_error - enter HALTED state for this PHY device
904 * @phydev: target phy_device struct
906 * Moves the PHY to the HALTED state in response to a read
907 * or write error, and tells the controller the link is down.
908 * Must not be called from interrupt context, or while the
909 * phydev->lock is held.
911 void phy_error(struct phy_device *phydev)
915 mutex_lock(&phydev->lock);
916 phydev->state = PHY_HALTED;
917 mutex_unlock(&phydev->lock);
919 phy_trigger_machine(phydev);
921 EXPORT_SYMBOL(phy_error);
924 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
925 * @phydev: target phy_device struct
927 int phy_disable_interrupts(struct phy_device *phydev)
929 /* Disable PHY interrupts */
930 return phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
934 * phy_interrupt - PHY interrupt handler
935 * @irq: interrupt line
936 * @phy_dat: phy_device pointer
938 * Description: Handle PHY interrupt
940 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
942 struct phy_device *phydev = phy_dat;
943 struct phy_driver *drv = phydev->drv;
945 return drv->handle_interrupt(phydev);
949 * phy_enable_interrupts - Enable the interrupts from the PHY side
950 * @phydev: target phy_device struct
952 static int phy_enable_interrupts(struct phy_device *phydev)
954 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
958 * phy_request_interrupt - request and enable interrupt for a PHY device
959 * @phydev: target phy_device struct
961 * Description: Request and enable the interrupt for the given PHY.
962 * If this fails, then we set irq to PHY_POLL.
963 * This should only be called with a valid IRQ number.
965 void phy_request_interrupt(struct phy_device *phydev)
969 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
970 IRQF_ONESHOT | IRQF_SHARED,
971 phydev_name(phydev), phydev);
973 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
975 phydev->irq = PHY_POLL;
977 if (phy_enable_interrupts(phydev)) {
978 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
979 phy_free_interrupt(phydev);
980 phydev->irq = PHY_POLL;
984 EXPORT_SYMBOL(phy_request_interrupt);
987 * phy_free_interrupt - disable and free interrupt for a PHY device
988 * @phydev: target phy_device struct
990 * Description: Disable and free the interrupt for the given PHY.
991 * This should only be called with a valid IRQ number.
993 void phy_free_interrupt(struct phy_device *phydev)
995 phy_disable_interrupts(phydev);
996 free_irq(phydev->irq, phydev);
998 EXPORT_SYMBOL(phy_free_interrupt);
1001 * phy_stop - Bring down the PHY link, and stop checking the status
1002 * @phydev: target phy_device struct
1004 void phy_stop(struct phy_device *phydev)
1006 struct net_device *dev = phydev->attached_dev;
1008 if (!phy_is_started(phydev) && phydev->state != PHY_DOWN) {
1009 WARN(1, "called from state %s\n",
1010 phy_state_to_str(phydev->state));
1014 mutex_lock(&phydev->lock);
1016 if (phydev->state == PHY_CABLETEST) {
1017 phy_abort_cable_test(phydev);
1018 netif_testing_off(dev);
1021 if (phydev->sfp_bus)
1022 sfp_upstream_stop(phydev->sfp_bus);
1024 phydev->state = PHY_HALTED;
1026 mutex_unlock(&phydev->lock);
1028 phy_state_machine(&phydev->state_queue.work);
1029 phy_stop_machine(phydev);
1031 /* Cannot call flush_scheduled_work() here as desired because
1032 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
1033 * will not reenable interrupts.
1036 EXPORT_SYMBOL(phy_stop);
1039 * phy_start - start or restart a PHY device
1040 * @phydev: target phy_device struct
1042 * Description: Indicates the attached device's readiness to
1043 * handle PHY-related work. Used during startup to start the
1044 * PHY, and after a call to phy_stop() to resume operation.
1045 * Also used to indicate the MDIO bus has cleared an error
1048 void phy_start(struct phy_device *phydev)
1050 mutex_lock(&phydev->lock);
1052 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
1053 WARN(1, "called from state %s\n",
1054 phy_state_to_str(phydev->state));
1058 if (phydev->sfp_bus)
1059 sfp_upstream_start(phydev->sfp_bus);
1061 /* if phy was suspended, bring the physical link up again */
1062 __phy_resume(phydev);
1064 phydev->state = PHY_UP;
1066 phy_start_machine(phydev);
1068 mutex_unlock(&phydev->lock);
1070 EXPORT_SYMBOL(phy_start);
1073 * phy_state_machine - Handle the state machine
1074 * @work: work_struct that describes the work to be done
1076 void phy_state_machine(struct work_struct *work)
1078 struct delayed_work *dwork = to_delayed_work(work);
1079 struct phy_device *phydev =
1080 container_of(dwork, struct phy_device, state_queue);
1081 struct net_device *dev = phydev->attached_dev;
1082 bool needs_aneg = false, do_suspend = false;
1083 enum phy_state old_state;
1084 bool finished = false;
1087 mutex_lock(&phydev->lock);
1089 old_state = phydev->state;
1091 switch (phydev->state) {
1101 err = phy_check_link_status(phydev);
1104 err = phydev->drv->cable_test_get_status(phydev, &finished);
1106 phy_abort_cable_test(phydev);
1107 netif_testing_off(dev);
1109 phydev->state = PHY_UP;
1114 ethnl_cable_test_finished(phydev);
1115 netif_testing_off(dev);
1117 phydev->state = PHY_UP;
1123 phy_link_down(phydev);
1129 mutex_unlock(&phydev->lock);
1132 err = phy_start_aneg(phydev);
1133 else if (do_suspend)
1134 phy_suspend(phydev);
1139 if (old_state != phydev->state) {
1140 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1141 phy_state_to_str(old_state),
1142 phy_state_to_str(phydev->state));
1143 if (phydev->drv && phydev->drv->link_change_notify)
1144 phydev->drv->link_change_notify(phydev);
1147 /* Only re-schedule a PHY state machine change if we are polling the
1148 * PHY, if PHY_MAC_INTERRUPT is set, then we will be moving
1149 * between states from phy_mac_interrupt().
1151 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1152 * state machine would be pointless and possibly error prone when
1153 * called from phy_disconnect() synchronously.
1155 mutex_lock(&phydev->lock);
1156 if (phy_polling_mode(phydev) && phy_is_started(phydev))
1157 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1158 mutex_unlock(&phydev->lock);
1162 * phy_mac_interrupt - MAC says the link has changed
1163 * @phydev: phy_device struct with changed link
1165 * The MAC layer is able to indicate there has been a change in the PHY link
1166 * status. Trigger the state machine and work a work queue.
1168 void phy_mac_interrupt(struct phy_device *phydev)
1170 /* Trigger a state machine change */
1171 phy_trigger_machine(phydev);
1173 EXPORT_SYMBOL(phy_mac_interrupt);
1175 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
1177 linkmode_zero(advertising);
1179 if (eee_adv & MDIO_EEE_100TX)
1180 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1182 if (eee_adv & MDIO_EEE_1000T)
1183 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1185 if (eee_adv & MDIO_EEE_10GT)
1186 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
1188 if (eee_adv & MDIO_EEE_1000KX)
1189 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
1191 if (eee_adv & MDIO_EEE_10GKX4)
1192 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
1194 if (eee_adv & MDIO_EEE_10GKR)
1195 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
1200 * phy_init_eee - init and check the EEE feature
1201 * @phydev: target phy_device struct
1202 * @clk_stop_enable: PHY may stop the clock during LPI
1204 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1205 * is supported by looking at the MMD registers 3.20 and 7.60/61
1206 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1209 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1214 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1216 if (phydev->duplex == DUPLEX_FULL) {
1217 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1218 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1219 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1220 int eee_lp, eee_cap, eee_adv;
1224 /* Read phy status to properly get the right settings */
1225 status = phy_read_status(phydev);
1229 /* First check if the EEE ability is supported */
1230 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1234 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1238 /* Check which link settings negotiated and verify it in
1239 * the EEE advertising registers.
1241 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1245 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1249 mmd_eee_adv_to_linkmode(adv, eee_adv);
1250 mmd_eee_adv_to_linkmode(lp, eee_lp);
1251 linkmode_and(common, adv, lp);
1253 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1256 if (clk_stop_enable)
1257 /* Configure the PHY to stop receiving xMII
1258 * clock while it is signaling LPI.
1260 phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1261 MDIO_PCS_CTRL1_CLKSTOP_EN);
1263 return 0; /* EEE supported */
1266 return -EPROTONOSUPPORT;
1268 EXPORT_SYMBOL(phy_init_eee);
1271 * phy_get_eee_err - report the EEE wake error count
1272 * @phydev: target phy_device struct
1274 * Description: it is to report the number of time where the PHY
1275 * failed to complete its normal wake sequence.
1277 int phy_get_eee_err(struct phy_device *phydev)
1282 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1284 EXPORT_SYMBOL(phy_get_eee_err);
1287 * phy_ethtool_get_eee - get EEE supported and status
1288 * @phydev: target phy_device struct
1289 * @data: ethtool_eee data
1291 * Description: it reportes the Supported/Advertisement/LP Advertisement
1294 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1301 /* Get Supported EEE */
1302 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1305 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1307 /* Get advertisement EEE */
1308 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1311 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1312 data->eee_enabled = !!data->advertised;
1314 /* Get LP advertisement EEE */
1315 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1318 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1320 data->eee_active = !!(data->advertised & data->lp_advertised);
1324 EXPORT_SYMBOL(phy_ethtool_get_eee);
1327 * phy_ethtool_set_eee - set EEE supported and status
1328 * @phydev: target phy_device struct
1329 * @data: ethtool_eee data
1331 * Description: it is to program the Advertisement EEE register.
1333 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1335 int cap, old_adv, adv = 0, ret;
1340 /* Get Supported EEE */
1341 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1345 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1349 if (data->eee_enabled) {
1350 adv = !data->advertised ? cap :
1351 ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1352 /* Mask prohibited EEE modes */
1353 adv &= ~phydev->eee_broken_modes;
1356 if (old_adv != adv) {
1357 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1361 /* Restart autonegotiation so the new modes get sent to the
1364 if (phydev->autoneg == AUTONEG_ENABLE) {
1365 ret = phy_restart_aneg(phydev);
1373 EXPORT_SYMBOL(phy_ethtool_set_eee);
1376 * phy_ethtool_set_wol - Configure Wake On LAN
1378 * @phydev: target phy_device struct
1379 * @wol: Configuration requested
1381 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1383 if (phydev->drv && phydev->drv->set_wol)
1384 return phydev->drv->set_wol(phydev, wol);
1388 EXPORT_SYMBOL(phy_ethtool_set_wol);
1391 * phy_ethtool_get_wol - Get the current Wake On LAN configuration
1393 * @phydev: target phy_device struct
1394 * @wol: Store the current configuration here
1396 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1398 if (phydev->drv && phydev->drv->get_wol)
1399 phydev->drv->get_wol(phydev, wol);
1401 EXPORT_SYMBOL(phy_ethtool_get_wol);
1403 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1404 struct ethtool_link_ksettings *cmd)
1406 struct phy_device *phydev = ndev->phydev;
1411 phy_ethtool_ksettings_get(phydev, cmd);
1415 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1417 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1418 const struct ethtool_link_ksettings *cmd)
1420 struct phy_device *phydev = ndev->phydev;
1425 return phy_ethtool_ksettings_set(phydev, cmd);
1427 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1430 * phy_ethtool_nway_reset - Restart auto negotiation
1431 * @ndev: Network device to restart autoneg for
1433 int phy_ethtool_nway_reset(struct net_device *ndev)
1435 struct phy_device *phydev = ndev->phydev;
1443 return phy_restart_aneg(phydev);
1445 EXPORT_SYMBOL(phy_ethtool_nway_reset);