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 <linux/suspend.h>
35 #include <net/netlink.h>
36 #include <net/genetlink.h>
39 #define PHY_STATE_TIME HZ
41 #define PHY_STATE_STR(_state) \
43 return __stringify(_state); \
45 static const char *phy_state_to_str(enum phy_state st)
51 PHY_STATE_STR(RUNNING)
53 PHY_STATE_STR(CABLETEST)
61 static void phy_process_state_change(struct phy_device *phydev,
62 enum phy_state old_state)
64 if (old_state != phydev->state) {
65 phydev_dbg(phydev, "PHY state change %s -> %s\n",
66 phy_state_to_str(old_state),
67 phy_state_to_str(phydev->state));
68 if (phydev->drv && phydev->drv->link_change_notify)
69 phydev->drv->link_change_notify(phydev);
73 static void phy_link_up(struct phy_device *phydev)
75 phydev->phy_link_change(phydev, true);
76 phy_led_trigger_change_speed(phydev);
79 static void phy_link_down(struct phy_device *phydev)
81 phydev->phy_link_change(phydev, false);
82 phy_led_trigger_change_speed(phydev);
83 WRITE_ONCE(phydev->link_down_events, phydev->link_down_events + 1);
86 static const char *phy_pause_str(struct phy_device *phydev)
88 bool local_pause, local_asym_pause;
90 if (phydev->autoneg == AUTONEG_DISABLE)
93 local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
95 local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
98 if (local_pause && phydev->pause)
101 if (local_asym_pause && phydev->asym_pause) {
113 * phy_print_status - Convenience function to print out the current phy status
114 * @phydev: the phy_device struct
116 void phy_print_status(struct phy_device *phydev)
119 netdev_info(phydev->attached_dev,
120 "Link is Up - %s/%s %s- flow control %s\n",
121 phy_speed_to_str(phydev->speed),
122 phy_duplex_to_str(phydev->duplex),
123 phydev->downshifted_rate ? "(downshifted) " : "",
124 phy_pause_str(phydev));
126 netdev_info(phydev->attached_dev, "Link is Down\n");
129 EXPORT_SYMBOL(phy_print_status);
132 * phy_get_rate_matching - determine if rate matching is supported
133 * @phydev: The phy device to return rate matching for
134 * @iface: The interface mode to use
136 * This determines the type of rate matching (if any) that @phy supports
137 * using @iface. @iface may be %PHY_INTERFACE_MODE_NA to determine if any
138 * interface supports rate matching.
140 * Return: The type of rate matching @phy supports for @iface, or
143 int phy_get_rate_matching(struct phy_device *phydev,
144 phy_interface_t iface)
146 int ret = RATE_MATCH_NONE;
148 if (phydev->drv->get_rate_matching) {
149 mutex_lock(&phydev->lock);
150 ret = phydev->drv->get_rate_matching(phydev, iface);
151 mutex_unlock(&phydev->lock);
156 EXPORT_SYMBOL_GPL(phy_get_rate_matching);
159 * phy_config_interrupt - configure the PHY device for the requested interrupts
160 * @phydev: the phy_device struct
161 * @interrupts: interrupt flags to configure for this @phydev
163 * Returns 0 on success or < 0 on error.
165 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
167 phydev->interrupts = interrupts ? 1 : 0;
168 if (phydev->drv->config_intr)
169 return phydev->drv->config_intr(phydev);
175 * phy_restart_aneg - restart auto-negotiation
176 * @phydev: target phy_device struct
178 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
179 * negative errno on error.
181 int phy_restart_aneg(struct phy_device *phydev)
185 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
186 ret = genphy_c45_restart_aneg(phydev);
188 ret = genphy_restart_aneg(phydev);
192 EXPORT_SYMBOL_GPL(phy_restart_aneg);
195 * phy_aneg_done - return auto-negotiation status
196 * @phydev: target phy_device struct
198 * Description: Return the auto-negotiation status from this @phydev
199 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
202 int phy_aneg_done(struct phy_device *phydev)
204 if (phydev->drv && phydev->drv->aneg_done)
205 return phydev->drv->aneg_done(phydev);
206 else if (phydev->is_c45)
207 return genphy_c45_aneg_done(phydev);
209 return genphy_aneg_done(phydev);
211 EXPORT_SYMBOL(phy_aneg_done);
214 * phy_find_valid - find a PHY setting that matches the requested parameters
215 * @speed: desired speed
216 * @duplex: desired duplex
217 * @supported: mask of supported link modes
219 * Locate a supported phy setting that is, in priority order:
220 * - an exact match for the specified speed and duplex mode
221 * - a match for the specified speed, or slower speed
222 * - the slowest supported speed
223 * Returns the matched phy_setting entry, or %NULL if no supported phy
224 * settings were found.
226 static const struct phy_setting *
227 phy_find_valid(int speed, int duplex, unsigned long *supported)
229 return phy_lookup_setting(speed, duplex, supported, false);
233 * phy_supported_speeds - return all speeds currently supported by a phy device
234 * @phy: The phy device to return supported speeds of.
235 * @speeds: buffer to store supported speeds in.
236 * @size: size of speeds buffer.
238 * Description: Returns the number of supported speeds, and fills the speeds
239 * buffer with the supported speeds. If speeds buffer is too small to contain
240 * all currently supported speeds, will return as many speeds as can fit.
242 unsigned int phy_supported_speeds(struct phy_device *phy,
243 unsigned int *speeds,
246 return phy_speeds(speeds, size, phy->supported);
250 * phy_check_valid - check if there is a valid PHY setting which matches
251 * speed, duplex, and feature mask
252 * @speed: speed to match
253 * @duplex: duplex to match
254 * @features: A mask of the valid settings
256 * Description: Returns true if there is a valid setting, false otherwise.
258 bool phy_check_valid(int speed, int duplex, unsigned long *features)
260 return !!phy_lookup_setting(speed, duplex, features, true);
262 EXPORT_SYMBOL(phy_check_valid);
265 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
266 * @phydev: the target phy_device struct
268 * Description: Make sure the PHY is set to supported speeds and
269 * duplexes. Drop down by one in this order: 1000/FULL,
270 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
272 static void phy_sanitize_settings(struct phy_device *phydev)
274 const struct phy_setting *setting;
276 setting = phy_find_valid(phydev->speed, phydev->duplex,
279 phydev->speed = setting->speed;
280 phydev->duplex = setting->duplex;
282 /* We failed to find anything (no supported speeds?) */
283 phydev->speed = SPEED_UNKNOWN;
284 phydev->duplex = DUPLEX_UNKNOWN;
288 void phy_ethtool_ksettings_get(struct phy_device *phydev,
289 struct ethtool_link_ksettings *cmd)
291 mutex_lock(&phydev->lock);
292 linkmode_copy(cmd->link_modes.supported, phydev->supported);
293 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
294 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
296 cmd->base.speed = phydev->speed;
297 cmd->base.duplex = phydev->duplex;
298 cmd->base.master_slave_cfg = phydev->master_slave_get;
299 cmd->base.master_slave_state = phydev->master_slave_state;
300 cmd->base.rate_matching = phydev->rate_matching;
301 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
302 cmd->base.port = PORT_BNC;
304 cmd->base.port = phydev->port;
305 cmd->base.transceiver = phy_is_internal(phydev) ?
306 XCVR_INTERNAL : XCVR_EXTERNAL;
307 cmd->base.phy_address = phydev->mdio.addr;
308 cmd->base.autoneg = phydev->autoneg;
309 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
310 cmd->base.eth_tp_mdix = phydev->mdix;
311 mutex_unlock(&phydev->lock);
313 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
316 * phy_mii_ioctl - generic PHY MII ioctl interface
317 * @phydev: the phy_device struct
318 * @ifr: &struct ifreq for socket ioctl's
319 * @cmd: ioctl cmd to execute
321 * Note that this function is currently incompatible with the
322 * PHYCONTROL layer. It changes registers without regard to
323 * current state. Use at own risk.
325 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
327 struct mii_ioctl_data *mii_data = if_mii(ifr);
328 struct kernel_hwtstamp_config kernel_cfg;
329 struct netlink_ext_ack extack = {};
330 u16 val = mii_data->val_in;
331 bool change_autoneg = false;
332 struct hwtstamp_config cfg;
338 mii_data->phy_id = phydev->mdio.addr;
342 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
343 prtad = mdio_phy_id_prtad(mii_data->phy_id);
344 devad = mdio_phy_id_devad(mii_data->phy_id);
345 mii_data->val_out = mdiobus_c45_read(
346 phydev->mdio.bus, prtad, devad,
349 mii_data->val_out = mdiobus_read(
350 phydev->mdio.bus, mii_data->phy_id,
356 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
357 prtad = mdio_phy_id_prtad(mii_data->phy_id);
358 devad = mdio_phy_id_devad(mii_data->phy_id);
360 prtad = mii_data->phy_id;
361 devad = mii_data->reg_num;
363 if (prtad == phydev->mdio.addr) {
366 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
367 if (phydev->autoneg == AUTONEG_ENABLE)
368 change_autoneg = true;
369 phydev->autoneg = AUTONEG_DISABLE;
370 if (val & BMCR_FULLDPLX)
371 phydev->duplex = DUPLEX_FULL;
373 phydev->duplex = DUPLEX_HALF;
374 if (val & BMCR_SPEED1000)
375 phydev->speed = SPEED_1000;
376 else if (val & BMCR_SPEED100)
377 phydev->speed = SPEED_100;
378 else phydev->speed = SPEED_10;
380 if (phydev->autoneg == AUTONEG_DISABLE)
381 change_autoneg = true;
382 phydev->autoneg = AUTONEG_ENABLE;
386 mii_adv_mod_linkmode_adv_t(phydev->advertising,
388 change_autoneg = true;
391 mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
393 change_autoneg = true;
401 if (mdio_phy_id_is_c45(mii_data->phy_id))
402 mdiobus_c45_write(phydev->mdio.bus, prtad, devad,
403 mii_data->reg_num, val);
405 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
407 if (prtad == phydev->mdio.addr &&
410 return phy_init_hw(phydev);
413 return phy_start_aneg(phydev);
418 if (phydev->mii_ts && phydev->mii_ts->hwtstamp) {
419 if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
422 hwtstamp_config_to_kernel(&kernel_cfg, &cfg);
423 ret = phydev->mii_ts->hwtstamp(phydev->mii_ts, &kernel_cfg, &extack);
427 hwtstamp_config_from_kernel(&cfg, &kernel_cfg);
428 if (copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)))
439 EXPORT_SYMBOL(phy_mii_ioctl);
442 * phy_do_ioctl - generic ndo_eth_ioctl implementation
443 * @dev: the net_device struct
444 * @ifr: &struct ifreq for socket ioctl's
445 * @cmd: ioctl cmd to execute
447 int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
452 return phy_mii_ioctl(dev->phydev, ifr, cmd);
454 EXPORT_SYMBOL(phy_do_ioctl);
457 * phy_do_ioctl_running - generic ndo_eth_ioctl implementation but test first
459 * @dev: the net_device struct
460 * @ifr: &struct ifreq for socket ioctl's
461 * @cmd: ioctl cmd to execute
463 * Same as phy_do_ioctl, but ensures that net_device is running before
464 * handling the ioctl.
466 int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd)
468 if (!netif_running(dev))
471 return phy_do_ioctl(dev, ifr, cmd);
473 EXPORT_SYMBOL(phy_do_ioctl_running);
476 * __phy_hwtstamp_get - Get hardware timestamping configuration from PHY
478 * @phydev: the PHY device structure
479 * @config: structure holding the timestamping configuration
481 * Query the PHY device for its current hardware timestamping configuration.
483 int __phy_hwtstamp_get(struct phy_device *phydev,
484 struct kernel_hwtstamp_config *config)
493 * __phy_hwtstamp_set - Modify PHY hardware timestamping configuration
495 * @phydev: the PHY device structure
496 * @config: structure holding the timestamping configuration
497 * @extack: netlink extended ack structure, for error reporting
499 int __phy_hwtstamp_set(struct phy_device *phydev,
500 struct kernel_hwtstamp_config *config,
501 struct netlink_ext_ack *extack)
506 if (phydev->mii_ts && phydev->mii_ts->hwtstamp)
507 return phydev->mii_ts->hwtstamp(phydev->mii_ts, config, extack);
513 * phy_queue_state_machine - Trigger the state machine to run soon
515 * @phydev: the phy_device struct
516 * @jiffies: Run the state machine after these jiffies
518 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
520 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
523 EXPORT_SYMBOL(phy_queue_state_machine);
526 * phy_trigger_machine - Trigger the state machine to run now
528 * @phydev: the phy_device struct
530 void phy_trigger_machine(struct phy_device *phydev)
532 phy_queue_state_machine(phydev, 0);
534 EXPORT_SYMBOL(phy_trigger_machine);
536 static void phy_abort_cable_test(struct phy_device *phydev)
540 ethnl_cable_test_finished(phydev);
542 err = phy_init_hw(phydev);
544 phydev_err(phydev, "Error while aborting cable test");
548 * phy_ethtool_get_strings - Get the statistic counter names
550 * @phydev: the phy_device struct
551 * @data: Where to put the strings
553 int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
558 mutex_lock(&phydev->lock);
559 phydev->drv->get_strings(phydev, data);
560 mutex_unlock(&phydev->lock);
564 EXPORT_SYMBOL(phy_ethtool_get_strings);
567 * phy_ethtool_get_sset_count - Get the number of statistic counters
569 * @phydev: the phy_device struct
571 int phy_ethtool_get_sset_count(struct phy_device *phydev)
578 if (phydev->drv->get_sset_count &&
579 phydev->drv->get_strings &&
580 phydev->drv->get_stats) {
581 mutex_lock(&phydev->lock);
582 ret = phydev->drv->get_sset_count(phydev);
583 mutex_unlock(&phydev->lock);
590 EXPORT_SYMBOL(phy_ethtool_get_sset_count);
593 * phy_ethtool_get_stats - Get the statistic counters
595 * @phydev: the phy_device struct
596 * @stats: What counters to get
597 * @data: Where to store the counters
599 int phy_ethtool_get_stats(struct phy_device *phydev,
600 struct ethtool_stats *stats, u64 *data)
605 mutex_lock(&phydev->lock);
606 phydev->drv->get_stats(phydev, stats, data);
607 mutex_unlock(&phydev->lock);
611 EXPORT_SYMBOL(phy_ethtool_get_stats);
614 * phy_ethtool_get_plca_cfg - Get PLCA RS configuration
615 * @phydev: the phy_device struct
616 * @plca_cfg: where to store the retrieved configuration
618 * Retrieve the PLCA configuration from the PHY. Return 0 on success or a
619 * negative value if an error occurred.
621 int phy_ethtool_get_plca_cfg(struct phy_device *phydev,
622 struct phy_plca_cfg *plca_cfg)
631 if (!phydev->drv->get_plca_cfg) {
636 mutex_lock(&phydev->lock);
637 ret = phydev->drv->get_plca_cfg(phydev, plca_cfg);
639 mutex_unlock(&phydev->lock);
645 * plca_check_valid - Check PLCA configuration before enabling
646 * @phydev: the phy_device struct
647 * @plca_cfg: current PLCA configuration
648 * @extack: extack for reporting useful error messages
650 * Checks whether the PLCA and PHY configuration are consistent and it is safe
651 * to enable PLCA. Returns 0 on success or a negative value if the PLCA or PHY
652 * configuration is not consistent.
654 static int plca_check_valid(struct phy_device *phydev,
655 const struct phy_plca_cfg *plca_cfg,
656 struct netlink_ext_ack *extack)
660 if (!linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT,
661 phydev->advertising)) {
663 NL_SET_ERR_MSG(extack,
664 "Point to Multi-Point mode is not enabled");
665 } else if (plca_cfg->node_id >= 255) {
666 NL_SET_ERR_MSG(extack, "PLCA node ID is not set");
674 * phy_ethtool_set_plca_cfg - Set PLCA RS configuration
675 * @phydev: the phy_device struct
676 * @plca_cfg: new PLCA configuration to apply
677 * @extack: extack for reporting useful error messages
679 * Sets the PLCA configuration in the PHY. Return 0 on success or a
680 * negative value if an error occurred.
682 int phy_ethtool_set_plca_cfg(struct phy_device *phydev,
683 const struct phy_plca_cfg *plca_cfg,
684 struct netlink_ext_ack *extack)
686 struct phy_plca_cfg *curr_plca_cfg;
694 if (!phydev->drv->set_plca_cfg ||
695 !phydev->drv->get_plca_cfg) {
700 curr_plca_cfg = kmalloc(sizeof(*curr_plca_cfg), GFP_KERNEL);
701 if (!curr_plca_cfg) {
706 mutex_lock(&phydev->lock);
708 ret = phydev->drv->get_plca_cfg(phydev, curr_plca_cfg);
712 if (curr_plca_cfg->enabled < 0 && plca_cfg->enabled >= 0) {
713 NL_SET_ERR_MSG(extack,
714 "PHY does not support changing the PLCA 'enable' attribute");
719 if (curr_plca_cfg->node_id < 0 && plca_cfg->node_id >= 0) {
720 NL_SET_ERR_MSG(extack,
721 "PHY does not support changing the PLCA 'local node ID' attribute");
726 if (curr_plca_cfg->node_cnt < 0 && plca_cfg->node_cnt >= 0) {
727 NL_SET_ERR_MSG(extack,
728 "PHY does not support changing the PLCA 'node count' attribute");
733 if (curr_plca_cfg->to_tmr < 0 && plca_cfg->to_tmr >= 0) {
734 NL_SET_ERR_MSG(extack,
735 "PHY does not support changing the PLCA 'TO timer' attribute");
740 if (curr_plca_cfg->burst_cnt < 0 && plca_cfg->burst_cnt >= 0) {
741 NL_SET_ERR_MSG(extack,
742 "PHY does not support changing the PLCA 'burst count' attribute");
747 if (curr_plca_cfg->burst_tmr < 0 && plca_cfg->burst_tmr >= 0) {
748 NL_SET_ERR_MSG(extack,
749 "PHY does not support changing the PLCA 'burst timer' attribute");
754 // if enabling PLCA, perform a few sanity checks
755 if (plca_cfg->enabled > 0) {
756 // allow setting node_id concurrently with enabled
757 if (plca_cfg->node_id >= 0)
758 curr_plca_cfg->node_id = plca_cfg->node_id;
760 ret = plca_check_valid(phydev, curr_plca_cfg, extack);
765 ret = phydev->drv->set_plca_cfg(phydev, plca_cfg);
768 kfree(curr_plca_cfg);
769 mutex_unlock(&phydev->lock);
775 * phy_ethtool_get_plca_status - Get PLCA RS status information
776 * @phydev: the phy_device struct
777 * @plca_st: where to store the retrieved status information
779 * Retrieve the PLCA status information from the PHY. Return 0 on success or a
780 * negative value if an error occurred.
782 int phy_ethtool_get_plca_status(struct phy_device *phydev,
783 struct phy_plca_status *plca_st)
792 if (!phydev->drv->get_plca_status) {
797 mutex_lock(&phydev->lock);
798 ret = phydev->drv->get_plca_status(phydev, plca_st);
800 mutex_unlock(&phydev->lock);
806 * phy_start_cable_test - Start a cable test
808 * @phydev: the phy_device struct
809 * @extack: extack for reporting useful error messages
811 int phy_start_cable_test(struct phy_device *phydev,
812 struct netlink_ext_ack *extack)
814 struct net_device *dev = phydev->attached_dev;
818 phydev->drv->cable_test_start &&
819 phydev->drv->cable_test_get_status)) {
820 NL_SET_ERR_MSG(extack,
821 "PHY driver does not support cable testing");
825 mutex_lock(&phydev->lock);
826 if (phydev->state == PHY_CABLETEST) {
827 NL_SET_ERR_MSG(extack,
828 "PHY already performing a test");
833 if (phydev->state < PHY_UP ||
834 phydev->state > PHY_CABLETEST) {
835 NL_SET_ERR_MSG(extack,
836 "PHY not configured. Try setting interface up");
841 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_NTF);
845 /* Mark the carrier down until the test is complete */
846 phy_link_down(phydev);
848 netif_testing_on(dev);
849 err = phydev->drv->cable_test_start(phydev);
851 netif_testing_off(dev);
856 phydev->state = PHY_CABLETEST;
858 if (phy_polling_mode(phydev))
859 phy_trigger_machine(phydev);
861 mutex_unlock(&phydev->lock);
866 ethnl_cable_test_free(phydev);
868 mutex_unlock(&phydev->lock);
872 EXPORT_SYMBOL(phy_start_cable_test);
875 * phy_start_cable_test_tdr - Start a raw TDR cable test
877 * @phydev: the phy_device struct
878 * @extack: extack for reporting useful error messages
879 * @config: Configuration of the test to run
881 int phy_start_cable_test_tdr(struct phy_device *phydev,
882 struct netlink_ext_ack *extack,
883 const struct phy_tdr_config *config)
885 struct net_device *dev = phydev->attached_dev;
889 phydev->drv->cable_test_tdr_start &&
890 phydev->drv->cable_test_get_status)) {
891 NL_SET_ERR_MSG(extack,
892 "PHY driver does not support cable test TDR");
896 mutex_lock(&phydev->lock);
897 if (phydev->state == PHY_CABLETEST) {
898 NL_SET_ERR_MSG(extack,
899 "PHY already performing a test");
904 if (phydev->state < PHY_UP ||
905 phydev->state > PHY_CABLETEST) {
906 NL_SET_ERR_MSG(extack,
907 "PHY not configured. Try setting interface up");
912 err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_TDR_NTF);
916 /* Mark the carrier down until the test is complete */
917 phy_link_down(phydev);
919 netif_testing_on(dev);
920 err = phydev->drv->cable_test_tdr_start(phydev, config);
922 netif_testing_off(dev);
927 phydev->state = PHY_CABLETEST;
929 if (phy_polling_mode(phydev))
930 phy_trigger_machine(phydev);
932 mutex_unlock(&phydev->lock);
937 ethnl_cable_test_free(phydev);
939 mutex_unlock(&phydev->lock);
943 EXPORT_SYMBOL(phy_start_cable_test_tdr);
945 int phy_config_aneg(struct phy_device *phydev)
947 if (phydev->drv->config_aneg)
948 return phydev->drv->config_aneg(phydev);
950 /* Clause 45 PHYs that don't implement Clause 22 registers are not
951 * allowed to call genphy_config_aneg()
953 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
954 return genphy_c45_config_aneg(phydev);
956 return genphy_config_aneg(phydev);
958 EXPORT_SYMBOL(phy_config_aneg);
961 * phy_check_link_status - check link status and set state accordingly
962 * @phydev: the phy_device struct
964 * Description: Check for link and whether autoneg was triggered / is running
965 * and set state accordingly
967 static int phy_check_link_status(struct phy_device *phydev)
971 lockdep_assert_held(&phydev->lock);
973 /* Keep previous state if loopback is enabled because some PHYs
974 * report that Link is Down when loopback is enabled.
976 if (phydev->loopback_enabled)
979 err = phy_read_status(phydev);
983 if (phydev->link && phydev->state != PHY_RUNNING) {
984 phy_check_downshift(phydev);
985 phydev->state = PHY_RUNNING;
987 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
988 phydev->state = PHY_NOLINK;
989 phy_link_down(phydev);
996 * _phy_start_aneg - start auto-negotiation for this PHY device
997 * @phydev: the phy_device struct
999 * Description: Sanitizes the settings (if we're not autonegotiating
1000 * them), and then calls the driver's config_aneg function.
1001 * If the PHYCONTROL Layer is operating, we change the state to
1002 * reflect the beginning of Auto-negotiation or forcing.
1004 int _phy_start_aneg(struct phy_device *phydev)
1008 lockdep_assert_held(&phydev->lock);
1013 if (AUTONEG_DISABLE == phydev->autoneg)
1014 phy_sanitize_settings(phydev);
1016 err = phy_config_aneg(phydev);
1020 if (phy_is_started(phydev))
1021 err = phy_check_link_status(phydev);
1025 EXPORT_SYMBOL(_phy_start_aneg);
1028 * phy_start_aneg - start auto-negotiation for this PHY device
1029 * @phydev: the phy_device struct
1031 * Description: Sanitizes the settings (if we're not autonegotiating
1032 * them), and then calls the driver's config_aneg function.
1033 * If the PHYCONTROL Layer is operating, we change the state to
1034 * reflect the beginning of Auto-negotiation or forcing.
1036 int phy_start_aneg(struct phy_device *phydev)
1040 mutex_lock(&phydev->lock);
1041 err = _phy_start_aneg(phydev);
1042 mutex_unlock(&phydev->lock);
1046 EXPORT_SYMBOL(phy_start_aneg);
1048 static int phy_poll_aneg_done(struct phy_device *phydev)
1050 unsigned int retries = 100;
1055 ret = phy_aneg_done(phydev);
1056 } while (!ret && --retries);
1061 return ret < 0 ? ret : 0;
1064 int phy_ethtool_ksettings_set(struct phy_device *phydev,
1065 const struct ethtool_link_ksettings *cmd)
1067 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
1068 u8 autoneg = cmd->base.autoneg;
1069 u8 duplex = cmd->base.duplex;
1070 u32 speed = cmd->base.speed;
1072 if (cmd->base.phy_address != phydev->mdio.addr)
1075 linkmode_copy(advertising, cmd->link_modes.advertising);
1077 /* We make sure that we don't pass unsupported values in to the PHY */
1078 linkmode_and(advertising, advertising, phydev->supported);
1080 /* Verify the settings we care about. */
1081 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
1084 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
1087 if (autoneg == AUTONEG_DISABLE &&
1088 ((speed != SPEED_1000 &&
1089 speed != SPEED_100 &&
1090 speed != SPEED_10) ||
1091 (duplex != DUPLEX_HALF &&
1092 duplex != DUPLEX_FULL)))
1095 mutex_lock(&phydev->lock);
1096 phydev->autoneg = autoneg;
1098 if (autoneg == AUTONEG_DISABLE) {
1099 phydev->speed = speed;
1100 phydev->duplex = duplex;
1103 linkmode_copy(phydev->advertising, advertising);
1105 linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
1106 phydev->advertising, autoneg == AUTONEG_ENABLE);
1108 phydev->master_slave_set = cmd->base.master_slave_cfg;
1109 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
1111 /* Restart the PHY */
1112 if (phy_is_started(phydev)) {
1113 phydev->state = PHY_UP;
1114 phy_trigger_machine(phydev);
1116 _phy_start_aneg(phydev);
1119 mutex_unlock(&phydev->lock);
1122 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
1125 * phy_speed_down - set speed to lowest speed supported by both link partners
1126 * @phydev: the phy_device struct
1127 * @sync: perform action synchronously
1129 * Description: Typically used to save energy when waiting for a WoL packet
1131 * WARNING: Setting sync to false may cause the system being unable to suspend
1132 * in case the PHY generates an interrupt when finishing the autonegotiation.
1133 * This interrupt may wake up the system immediately after suspend.
1134 * Therefore use sync = false only if you're sure it's safe with the respective
1137 int phy_speed_down(struct phy_device *phydev, bool sync)
1139 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
1142 mutex_lock(&phydev->lock);
1144 if (phydev->autoneg != AUTONEG_ENABLE)
1147 linkmode_copy(adv_tmp, phydev->advertising);
1149 ret = phy_speed_down_core(phydev);
1153 linkmode_copy(phydev->adv_old, adv_tmp);
1155 if (linkmode_equal(phydev->advertising, adv_tmp)) {
1160 ret = phy_config_aneg(phydev);
1164 ret = sync ? phy_poll_aneg_done(phydev) : 0;
1166 mutex_unlock(&phydev->lock);
1170 EXPORT_SYMBOL_GPL(phy_speed_down);
1173 * phy_speed_up - (re)set advertised speeds to all supported speeds
1174 * @phydev: the phy_device struct
1176 * Description: Used to revert the effect of phy_speed_down
1178 int phy_speed_up(struct phy_device *phydev)
1180 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
1183 mutex_lock(&phydev->lock);
1185 if (phydev->autoneg != AUTONEG_ENABLE)
1188 if (linkmode_empty(phydev->adv_old))
1191 linkmode_copy(adv_tmp, phydev->advertising);
1192 linkmode_copy(phydev->advertising, phydev->adv_old);
1193 linkmode_zero(phydev->adv_old);
1195 if (linkmode_equal(phydev->advertising, adv_tmp))
1198 ret = phy_config_aneg(phydev);
1200 mutex_unlock(&phydev->lock);
1204 EXPORT_SYMBOL_GPL(phy_speed_up);
1207 * phy_start_machine - start PHY state machine tracking
1208 * @phydev: the phy_device struct
1210 * Description: The PHY infrastructure can run a state machine
1211 * which tracks whether the PHY is starting up, negotiating,
1212 * etc. This function starts the delayed workqueue which tracks
1213 * the state of the PHY. If you want to maintain your own state machine,
1214 * do not call this function.
1216 void phy_start_machine(struct phy_device *phydev)
1218 phy_trigger_machine(phydev);
1220 EXPORT_SYMBOL_GPL(phy_start_machine);
1223 * phy_stop_machine - stop the PHY state machine tracking
1224 * @phydev: target phy_device struct
1226 * Description: Stops the state machine delayed workqueue, sets the
1227 * state to UP (unless it wasn't up yet). This function must be
1228 * called BEFORE phy_detach.
1230 void phy_stop_machine(struct phy_device *phydev)
1232 cancel_delayed_work_sync(&phydev->state_queue);
1234 mutex_lock(&phydev->lock);
1235 if (phy_is_started(phydev))
1236 phydev->state = PHY_UP;
1237 mutex_unlock(&phydev->lock);
1240 static void phy_process_error(struct phy_device *phydev)
1242 /* phydev->lock must be held for the state change to be safe */
1243 if (!mutex_is_locked(&phydev->lock))
1244 phydev_err(phydev, "PHY-device data unsafe context\n");
1246 phydev->state = PHY_ERROR;
1248 phy_trigger_machine(phydev);
1251 static void phy_error_precise(struct phy_device *phydev,
1252 const void *func, int err)
1254 WARN(1, "%pS: returned: %d\n", func, err);
1255 phy_process_error(phydev);
1259 * phy_error - enter ERROR state for this PHY device
1260 * @phydev: target phy_device struct
1262 * Moves the PHY to the ERROR state in response to a read
1263 * or write error, and tells the controller the link is down.
1264 * Must be called with phydev->lock held.
1266 void phy_error(struct phy_device *phydev)
1269 phy_process_error(phydev);
1271 EXPORT_SYMBOL(phy_error);
1274 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
1275 * @phydev: target phy_device struct
1277 int phy_disable_interrupts(struct phy_device *phydev)
1279 /* Disable PHY interrupts */
1280 return phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
1284 * phy_interrupt - PHY interrupt handler
1285 * @irq: interrupt line
1286 * @phy_dat: phy_device pointer
1288 * Description: Handle PHY interrupt
1290 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
1292 struct phy_device *phydev = phy_dat;
1293 struct phy_driver *drv = phydev->drv;
1296 /* Wakeup interrupts may occur during a system sleep transition.
1297 * Postpone handling until the PHY has resumed.
1299 if (IS_ENABLED(CONFIG_PM_SLEEP) && phydev->irq_suspended) {
1300 struct net_device *netdev = phydev->attached_dev;
1303 struct device *parent = netdev->dev.parent;
1305 if (netdev->wol_enabled)
1307 else if (device_may_wakeup(&netdev->dev))
1308 pm_wakeup_dev_event(&netdev->dev, 0, true);
1309 else if (parent && device_may_wakeup(parent))
1310 pm_wakeup_dev_event(parent, 0, true);
1313 phydev->irq_rerun = 1;
1314 disable_irq_nosync(irq);
1318 mutex_lock(&phydev->lock);
1319 ret = drv->handle_interrupt(phydev);
1320 mutex_unlock(&phydev->lock);
1326 * phy_enable_interrupts - Enable the interrupts from the PHY side
1327 * @phydev: target phy_device struct
1329 static int phy_enable_interrupts(struct phy_device *phydev)
1331 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
1335 * phy_request_interrupt - request and enable interrupt for a PHY device
1336 * @phydev: target phy_device struct
1338 * Description: Request and enable the interrupt for the given PHY.
1339 * If this fails, then we set irq to PHY_POLL.
1340 * This should only be called with a valid IRQ number.
1342 void phy_request_interrupt(struct phy_device *phydev)
1346 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
1347 IRQF_ONESHOT | IRQF_SHARED,
1348 phydev_name(phydev), phydev);
1350 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
1352 phydev->irq = PHY_POLL;
1354 if (phy_enable_interrupts(phydev)) {
1355 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
1356 phy_free_interrupt(phydev);
1357 phydev->irq = PHY_POLL;
1361 EXPORT_SYMBOL(phy_request_interrupt);
1364 * phy_free_interrupt - disable and free interrupt for a PHY device
1365 * @phydev: target phy_device struct
1367 * Description: Disable and free the interrupt for the given PHY.
1368 * This should only be called with a valid IRQ number.
1370 void phy_free_interrupt(struct phy_device *phydev)
1372 phy_disable_interrupts(phydev);
1373 free_irq(phydev->irq, phydev);
1375 EXPORT_SYMBOL(phy_free_interrupt);
1377 enum phy_state_work {
1378 PHY_STATE_WORK_NONE,
1379 PHY_STATE_WORK_ANEG,
1380 PHY_STATE_WORK_SUSPEND,
1383 static enum phy_state_work _phy_state_machine(struct phy_device *phydev)
1385 enum phy_state_work state_work = PHY_STATE_WORK_NONE;
1386 struct net_device *dev = phydev->attached_dev;
1387 enum phy_state old_state = phydev->state;
1388 const void *func = NULL;
1389 bool finished = false;
1392 switch (phydev->state) {
1397 state_work = PHY_STATE_WORK_ANEG;
1401 err = phy_check_link_status(phydev);
1402 func = &phy_check_link_status;
1405 err = phydev->drv->cable_test_get_status(phydev, &finished);
1407 phy_abort_cable_test(phydev);
1408 netif_testing_off(dev);
1409 state_work = PHY_STATE_WORK_ANEG;
1410 phydev->state = PHY_UP;
1415 ethnl_cable_test_finished(phydev);
1416 netif_testing_off(dev);
1417 state_work = PHY_STATE_WORK_ANEG;
1418 phydev->state = PHY_UP;
1425 phy_link_down(phydev);
1427 state_work = PHY_STATE_WORK_SUSPEND;
1431 if (state_work == PHY_STATE_WORK_ANEG) {
1432 err = _phy_start_aneg(phydev);
1433 func = &_phy_start_aneg;
1440 phy_error_precise(phydev, func, err);
1442 phy_process_state_change(phydev, old_state);
1444 /* Only re-schedule a PHY state machine change if we are polling the
1445 * PHY, if PHY_MAC_INTERRUPT is set, then we will be moving
1446 * between states from phy_mac_interrupt().
1448 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1449 * state machine would be pointless and possibly error prone when
1450 * called from phy_disconnect() synchronously.
1452 if (phy_polling_mode(phydev) && phy_is_started(phydev))
1453 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1458 /* unlocked part of the PHY state machine */
1459 static void _phy_state_machine_post_work(struct phy_device *phydev,
1460 enum phy_state_work state_work)
1462 if (state_work == PHY_STATE_WORK_SUSPEND)
1463 phy_suspend(phydev);
1467 * phy_state_machine - Handle the state machine
1468 * @work: work_struct that describes the work to be done
1470 void phy_state_machine(struct work_struct *work)
1472 struct delayed_work *dwork = to_delayed_work(work);
1473 struct phy_device *phydev =
1474 container_of(dwork, struct phy_device, state_queue);
1475 enum phy_state_work state_work;
1477 mutex_lock(&phydev->lock);
1478 state_work = _phy_state_machine(phydev);
1479 mutex_unlock(&phydev->lock);
1481 _phy_state_machine_post_work(phydev, state_work);
1485 * phy_stop - Bring down the PHY link, and stop checking the status
1486 * @phydev: target phy_device struct
1488 void phy_stop(struct phy_device *phydev)
1490 struct net_device *dev = phydev->attached_dev;
1491 enum phy_state_work state_work;
1492 enum phy_state old_state;
1494 if (!phy_is_started(phydev) && phydev->state != PHY_DOWN &&
1495 phydev->state != PHY_ERROR) {
1496 WARN(1, "called from state %s\n",
1497 phy_state_to_str(phydev->state));
1501 mutex_lock(&phydev->lock);
1502 old_state = phydev->state;
1504 if (phydev->state == PHY_CABLETEST) {
1505 phy_abort_cable_test(phydev);
1506 netif_testing_off(dev);
1509 if (phydev->sfp_bus)
1510 sfp_upstream_stop(phydev->sfp_bus);
1512 phydev->state = PHY_HALTED;
1513 phy_process_state_change(phydev, old_state);
1515 state_work = _phy_state_machine(phydev);
1516 mutex_unlock(&phydev->lock);
1518 _phy_state_machine_post_work(phydev, state_work);
1519 phy_stop_machine(phydev);
1521 /* Cannot call flush_scheduled_work() here as desired because
1522 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
1523 * will not reenable interrupts.
1526 EXPORT_SYMBOL(phy_stop);
1529 * phy_start - start or restart a PHY device
1530 * @phydev: target phy_device struct
1532 * Description: Indicates the attached device's readiness to
1533 * handle PHY-related work. Used during startup to start the
1534 * PHY, and after a call to phy_stop() to resume operation.
1535 * Also used to indicate the MDIO bus has cleared an error
1538 void phy_start(struct phy_device *phydev)
1540 mutex_lock(&phydev->lock);
1542 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
1543 WARN(1, "called from state %s\n",
1544 phy_state_to_str(phydev->state));
1548 if (phydev->sfp_bus)
1549 sfp_upstream_start(phydev->sfp_bus);
1551 /* if phy was suspended, bring the physical link up again */
1552 __phy_resume(phydev);
1554 phydev->state = PHY_UP;
1556 phy_start_machine(phydev);
1558 mutex_unlock(&phydev->lock);
1560 EXPORT_SYMBOL(phy_start);
1563 * phy_mac_interrupt - MAC says the link has changed
1564 * @phydev: phy_device struct with changed link
1566 * The MAC layer is able to indicate there has been a change in the PHY link
1567 * status. Trigger the state machine and work a work queue.
1569 void phy_mac_interrupt(struct phy_device *phydev)
1571 /* Trigger a state machine change */
1572 phy_trigger_machine(phydev);
1574 EXPORT_SYMBOL(phy_mac_interrupt);
1577 * phy_init_eee - init and check the EEE feature
1578 * @phydev: target phy_device struct
1579 * @clk_stop_enable: PHY may stop the clock during LPI
1581 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1582 * is supported by looking at the MMD registers 3.20 and 7.60/61
1583 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1586 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1593 ret = genphy_c45_eee_is_active(phydev, NULL, NULL, NULL);
1597 return -EPROTONOSUPPORT;
1599 if (clk_stop_enable)
1600 /* Configure the PHY to stop receiving xMII
1601 * clock while it is signaling LPI.
1603 ret = phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1604 MDIO_PCS_CTRL1_CLKSTOP_EN);
1606 return ret < 0 ? ret : 0;
1608 EXPORT_SYMBOL(phy_init_eee);
1611 * phy_get_eee_err - report the EEE wake error count
1612 * @phydev: target phy_device struct
1614 * Description: it is to report the number of time where the PHY
1615 * failed to complete its normal wake sequence.
1617 int phy_get_eee_err(struct phy_device *phydev)
1624 mutex_lock(&phydev->lock);
1625 ret = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1626 mutex_unlock(&phydev->lock);
1630 EXPORT_SYMBOL(phy_get_eee_err);
1633 * phy_ethtool_get_eee - get EEE supported and status
1634 * @phydev: target phy_device struct
1635 * @data: ethtool_eee data
1637 * Description: it reportes the Supported/Advertisement/LP Advertisement
1640 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1647 mutex_lock(&phydev->lock);
1648 ret = genphy_c45_ethtool_get_eee(phydev, data);
1649 mutex_unlock(&phydev->lock);
1653 EXPORT_SYMBOL(phy_ethtool_get_eee);
1656 * phy_ethtool_set_eee - set EEE supported and status
1657 * @phydev: target phy_device struct
1658 * @data: ethtool_eee data
1660 * Description: it is to program the Advertisement EEE register.
1662 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1669 mutex_lock(&phydev->lock);
1670 ret = genphy_c45_ethtool_set_eee(phydev, data);
1671 mutex_unlock(&phydev->lock);
1675 EXPORT_SYMBOL(phy_ethtool_set_eee);
1678 * phy_ethtool_set_wol - Configure Wake On LAN
1680 * @phydev: target phy_device struct
1681 * @wol: Configuration requested
1683 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1687 if (phydev->drv && phydev->drv->set_wol) {
1688 mutex_lock(&phydev->lock);
1689 ret = phydev->drv->set_wol(phydev, wol);
1690 mutex_unlock(&phydev->lock);
1697 EXPORT_SYMBOL(phy_ethtool_set_wol);
1700 * phy_ethtool_get_wol - Get the current Wake On LAN configuration
1702 * @phydev: target phy_device struct
1703 * @wol: Store the current configuration here
1705 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1707 if (phydev->drv && phydev->drv->get_wol) {
1708 mutex_lock(&phydev->lock);
1709 phydev->drv->get_wol(phydev, wol);
1710 mutex_unlock(&phydev->lock);
1713 EXPORT_SYMBOL(phy_ethtool_get_wol);
1715 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1716 struct ethtool_link_ksettings *cmd)
1718 struct phy_device *phydev = ndev->phydev;
1723 phy_ethtool_ksettings_get(phydev, cmd);
1727 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1729 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1730 const struct ethtool_link_ksettings *cmd)
1732 struct phy_device *phydev = ndev->phydev;
1737 return phy_ethtool_ksettings_set(phydev, cmd);
1739 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1742 * phy_ethtool_nway_reset - Restart auto negotiation
1743 * @ndev: Network device to restart autoneg for
1745 int phy_ethtool_nway_reset(struct net_device *ndev)
1747 struct phy_device *phydev = ndev->phydev;
1756 mutex_lock(&phydev->lock);
1757 ret = phy_restart_aneg(phydev);
1758 mutex_unlock(&phydev->lock);
1762 EXPORT_SYMBOL(phy_ethtool_nway_reset);