1 // SPDX-License-Identifier: GPL-2.0+
2 /* Framework for configuring and reading PHY devices
3 * Based on code in sungem_phy.c and gianfar_phy.c
7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 * Copyright (c) 2006, 2007 Maciej W. Rozycki
11 #include <linux/kernel.h>
12 #include <linux/string.h>
13 #include <linux/errno.h>
14 #include <linux/unistd.h>
15 #include <linux/interrupt.h>
16 #include <linux/delay.h>
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/skbuff.h>
21 #include <linux/module.h>
22 #include <linux/mii.h>
23 #include <linux/ethtool.h>
24 #include <linux/phy.h>
25 #include <linux/phy_led_triggers.h>
26 #include <linux/workqueue.h>
27 #include <linux/mdio.h>
29 #include <linux/uaccess.h>
30 #include <linux/atomic.h>
32 #define PHY_STATE_TIME HZ
34 #define PHY_STATE_STR(_state) \
36 return __stringify(_state); \
38 static const char *phy_state_to_str(enum phy_state st)
44 PHY_STATE_STR(RUNNING)
46 PHY_STATE_STR(FORCING)
53 static void phy_link_up(struct phy_device *phydev)
55 phydev->phy_link_change(phydev, true, true);
56 phy_led_trigger_change_speed(phydev);
59 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
61 phydev->phy_link_change(phydev, false, do_carrier);
62 phy_led_trigger_change_speed(phydev);
65 static const char *phy_pause_str(struct phy_device *phydev)
67 bool local_pause, local_asym_pause;
69 if (phydev->autoneg == AUTONEG_DISABLE)
72 local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
74 local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
77 if (local_pause && phydev->pause)
80 if (local_asym_pause && phydev->asym_pause) {
92 * phy_print_status - Convenience function to print out the current phy status
93 * @phydev: the phy_device struct
95 void phy_print_status(struct phy_device *phydev)
98 netdev_info(phydev->attached_dev,
99 "Link is Up - %s/%s - flow control %s\n",
100 phy_speed_to_str(phydev->speed),
101 phy_duplex_to_str(phydev->duplex),
102 phy_pause_str(phydev));
104 netdev_info(phydev->attached_dev, "Link is Down\n");
107 EXPORT_SYMBOL(phy_print_status);
110 * phy_clear_interrupt - Ack the phy device's interrupt
111 * @phydev: the phy_device struct
113 * If the @phydev driver has an ack_interrupt function, call it to
114 * ack and clear the phy device's interrupt.
116 * Returns 0 on success or < 0 on error.
118 static int phy_clear_interrupt(struct phy_device *phydev)
120 if (phydev->drv->ack_interrupt)
121 return phydev->drv->ack_interrupt(phydev);
127 * phy_config_interrupt - configure the PHY device for the requested interrupts
128 * @phydev: the phy_device struct
129 * @interrupts: interrupt flags to configure for this @phydev
131 * Returns 0 on success or < 0 on error.
133 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
135 phydev->interrupts = interrupts ? 1 : 0;
136 if (phydev->drv->config_intr)
137 return phydev->drv->config_intr(phydev);
143 * phy_restart_aneg - restart auto-negotiation
144 * @phydev: target phy_device struct
146 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
147 * negative errno on error.
149 int phy_restart_aneg(struct phy_device *phydev)
153 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
154 ret = genphy_c45_restart_aneg(phydev);
156 ret = genphy_restart_aneg(phydev);
160 EXPORT_SYMBOL_GPL(phy_restart_aneg);
163 * phy_aneg_done - return auto-negotiation status
164 * @phydev: target phy_device struct
166 * Description: Return the auto-negotiation status from this @phydev
167 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
170 int phy_aneg_done(struct phy_device *phydev)
172 if (phydev->drv && phydev->drv->aneg_done)
173 return phydev->drv->aneg_done(phydev);
174 else if (phydev->is_c45)
175 return genphy_c45_aneg_done(phydev);
177 return genphy_aneg_done(phydev);
179 EXPORT_SYMBOL(phy_aneg_done);
182 * phy_find_valid - find a PHY setting that matches the requested parameters
183 * @speed: desired speed
184 * @duplex: desired duplex
185 * @supported: mask of supported link modes
187 * Locate a supported phy setting that is, in priority order:
188 * - an exact match for the specified speed and duplex mode
189 * - a match for the specified speed, or slower speed
190 * - the slowest supported speed
191 * Returns the matched phy_setting entry, or %NULL if no supported phy
192 * settings were found.
194 static const struct phy_setting *
195 phy_find_valid(int speed, int duplex, unsigned long *supported)
197 return phy_lookup_setting(speed, duplex, supported, false);
201 * phy_supported_speeds - return all speeds currently supported by a phy device
202 * @phy: The phy device to return supported speeds of.
203 * @speeds: buffer to store supported speeds in.
204 * @size: size of speeds buffer.
206 * Description: Returns the number of supported speeds, and fills the speeds
207 * buffer with the supported speeds. If speeds buffer is too small to contain
208 * all currently supported speeds, will return as many speeds as can fit.
210 unsigned int phy_supported_speeds(struct phy_device *phy,
211 unsigned int *speeds,
214 return phy_speeds(speeds, size, phy->supported);
218 * phy_check_valid - check if there is a valid PHY setting which matches
219 * speed, duplex, and feature mask
220 * @speed: speed to match
221 * @duplex: duplex to match
222 * @features: A mask of the valid settings
224 * Description: Returns true if there is a valid setting, false otherwise.
226 static inline bool phy_check_valid(int speed, int duplex,
227 unsigned long *features)
229 return !!phy_lookup_setting(speed, duplex, features, true);
233 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
234 * @phydev: the target phy_device struct
236 * Description: Make sure the PHY is set to supported speeds and
237 * duplexes. Drop down by one in this order: 1000/FULL,
238 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
240 static void phy_sanitize_settings(struct phy_device *phydev)
242 const struct phy_setting *setting;
244 setting = phy_find_valid(phydev->speed, phydev->duplex,
247 phydev->speed = setting->speed;
248 phydev->duplex = setting->duplex;
250 /* We failed to find anything (no supported speeds?) */
251 phydev->speed = SPEED_UNKNOWN;
252 phydev->duplex = DUPLEX_UNKNOWN;
257 * phy_ethtool_sset - generic ethtool sset function, handles all the details
258 * @phydev: target phy_device struct
261 * A few notes about parameter checking:
263 * - We don't set port or transceiver, so we don't care what they
265 * - phy_start_aneg() will make sure forced settings are sane, and
266 * choose the next best ones from the ones selected, so we don't
267 * care if ethtool tries to give us bad values.
269 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
271 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
272 u32 speed = ethtool_cmd_speed(cmd);
274 if (cmd->phy_address != phydev->mdio.addr)
277 /* We make sure that we don't pass unsupported values in to the PHY */
278 ethtool_convert_legacy_u32_to_link_mode(advertising, cmd->advertising);
279 linkmode_and(advertising, advertising, phydev->supported);
281 /* Verify the settings we care about. */
282 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
285 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
288 if (cmd->autoneg == AUTONEG_DISABLE &&
289 ((speed != SPEED_1000 &&
290 speed != SPEED_100 &&
291 speed != SPEED_10) ||
292 (cmd->duplex != DUPLEX_HALF &&
293 cmd->duplex != DUPLEX_FULL)))
296 phydev->autoneg = cmd->autoneg;
298 phydev->speed = speed;
300 linkmode_copy(phydev->advertising, advertising);
302 if (AUTONEG_ENABLE == cmd->autoneg)
303 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
304 phydev->advertising);
306 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
307 phydev->advertising);
309 phydev->duplex = cmd->duplex;
311 phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
313 /* Restart the PHY */
314 phy_start_aneg(phydev);
318 EXPORT_SYMBOL(phy_ethtool_sset);
320 int phy_ethtool_ksettings_set(struct phy_device *phydev,
321 const struct ethtool_link_ksettings *cmd)
323 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
324 u8 autoneg = cmd->base.autoneg;
325 u8 duplex = cmd->base.duplex;
326 u32 speed = cmd->base.speed;
328 if (cmd->base.phy_address != phydev->mdio.addr)
331 linkmode_copy(advertising, cmd->link_modes.advertising);
333 /* We make sure that we don't pass unsupported values in to the PHY */
334 linkmode_and(advertising, advertising, phydev->supported);
336 /* Verify the settings we care about. */
337 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
340 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
343 if (autoneg == AUTONEG_DISABLE &&
344 ((speed != SPEED_1000 &&
345 speed != SPEED_100 &&
346 speed != SPEED_10) ||
347 (duplex != DUPLEX_HALF &&
348 duplex != DUPLEX_FULL)))
351 phydev->autoneg = autoneg;
353 phydev->speed = speed;
355 linkmode_copy(phydev->advertising, advertising);
357 if (autoneg == AUTONEG_ENABLE)
358 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
359 phydev->advertising);
361 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
362 phydev->advertising);
364 phydev->duplex = duplex;
366 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
368 /* Restart the PHY */
369 phy_start_aneg(phydev);
373 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
375 void phy_ethtool_ksettings_get(struct phy_device *phydev,
376 struct ethtool_link_ksettings *cmd)
378 linkmode_copy(cmd->link_modes.supported, phydev->supported);
379 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
380 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
382 cmd->base.speed = phydev->speed;
383 cmd->base.duplex = phydev->duplex;
384 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
385 cmd->base.port = PORT_BNC;
387 cmd->base.port = PORT_MII;
388 cmd->base.transceiver = phy_is_internal(phydev) ?
389 XCVR_INTERNAL : XCVR_EXTERNAL;
390 cmd->base.phy_address = phydev->mdio.addr;
391 cmd->base.autoneg = phydev->autoneg;
392 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
393 cmd->base.eth_tp_mdix = phydev->mdix;
395 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
398 * phy_mii_ioctl - generic PHY MII ioctl interface
399 * @phydev: the phy_device struct
400 * @ifr: &struct ifreq for socket ioctl's
401 * @cmd: ioctl cmd to execute
403 * Note that this function is currently incompatible with the
404 * PHYCONTROL layer. It changes registers without regard to
405 * current state. Use at own risk.
407 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
409 struct mii_ioctl_data *mii_data = if_mii(ifr);
410 u16 val = mii_data->val_in;
411 bool change_autoneg = false;
416 mii_data->phy_id = phydev->mdio.addr;
420 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
421 prtad = mdio_phy_id_prtad(mii_data->phy_id);
422 devad = mdio_phy_id_devad(mii_data->phy_id);
423 devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
425 prtad = mii_data->phy_id;
426 devad = mii_data->reg_num;
428 mii_data->val_out = mdiobus_read(phydev->mdio.bus, prtad,
433 if (mdio_phy_id_is_c45(mii_data->phy_id)) {
434 prtad = mdio_phy_id_prtad(mii_data->phy_id);
435 devad = mdio_phy_id_devad(mii_data->phy_id);
436 devad = MII_ADDR_C45 | devad << 16 | mii_data->reg_num;
438 prtad = mii_data->phy_id;
439 devad = mii_data->reg_num;
441 if (prtad == phydev->mdio.addr) {
444 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
445 if (phydev->autoneg == AUTONEG_ENABLE)
446 change_autoneg = true;
447 phydev->autoneg = AUTONEG_DISABLE;
448 if (val & BMCR_FULLDPLX)
449 phydev->duplex = DUPLEX_FULL;
451 phydev->duplex = DUPLEX_HALF;
452 if (val & BMCR_SPEED1000)
453 phydev->speed = SPEED_1000;
454 else if (val & BMCR_SPEED100)
455 phydev->speed = SPEED_100;
456 else phydev->speed = SPEED_10;
459 if (phydev->autoneg == AUTONEG_DISABLE)
460 change_autoneg = true;
461 phydev->autoneg = AUTONEG_ENABLE;
465 mii_adv_mod_linkmode_adv_t(phydev->advertising,
467 change_autoneg = true;
475 mdiobus_write(phydev->mdio.bus, prtad, devad, val);
477 if (prtad == phydev->mdio.addr &&
480 return phy_init_hw(phydev);
483 return phy_start_aneg(phydev);
488 if (phydev->drv && phydev->drv->hwtstamp)
489 return phydev->drv->hwtstamp(phydev, ifr);
496 EXPORT_SYMBOL(phy_mii_ioctl);
498 void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
500 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
503 EXPORT_SYMBOL(phy_queue_state_machine);
505 static void phy_trigger_machine(struct phy_device *phydev)
507 phy_queue_state_machine(phydev, 0);
510 static int phy_config_aneg(struct phy_device *phydev)
512 if (phydev->drv->config_aneg)
513 return phydev->drv->config_aneg(phydev);
515 /* Clause 45 PHYs that don't implement Clause 22 registers are not
516 * allowed to call genphy_config_aneg()
518 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
521 return genphy_config_aneg(phydev);
525 * phy_check_link_status - check link status and set state accordingly
526 * @phydev: the phy_device struct
528 * Description: Check for link and whether autoneg was triggered / is running
529 * and set state accordingly
531 static int phy_check_link_status(struct phy_device *phydev)
535 WARN_ON(!mutex_is_locked(&phydev->lock));
537 err = phy_read_status(phydev);
541 if (phydev->link && phydev->state != PHY_RUNNING) {
542 phydev->state = PHY_RUNNING;
544 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
545 phydev->state = PHY_NOLINK;
546 phy_link_down(phydev, true);
553 * phy_start_aneg - start auto-negotiation for this PHY device
554 * @phydev: the phy_device struct
556 * Description: Sanitizes the settings (if we're not autonegotiating
557 * them), and then calls the driver's config_aneg function.
558 * If the PHYCONTROL Layer is operating, we change the state to
559 * reflect the beginning of Auto-negotiation or forcing.
561 int phy_start_aneg(struct phy_device *phydev)
568 mutex_lock(&phydev->lock);
570 if (AUTONEG_DISABLE == phydev->autoneg)
571 phy_sanitize_settings(phydev);
573 /* Invalidate LP advertising flags */
574 linkmode_zero(phydev->lp_advertising);
576 err = phy_config_aneg(phydev);
580 if (phy_is_started(phydev)) {
581 if (phydev->autoneg == AUTONEG_ENABLE) {
582 err = phy_check_link_status(phydev);
584 phydev->state = PHY_FORCING;
585 phydev->link_timeout = PHY_FORCE_TIMEOUT;
590 mutex_unlock(&phydev->lock);
594 EXPORT_SYMBOL(phy_start_aneg);
596 static int phy_poll_aneg_done(struct phy_device *phydev)
598 unsigned int retries = 100;
603 ret = phy_aneg_done(phydev);
604 } while (!ret && --retries);
609 return ret < 0 ? ret : 0;
613 * phy_speed_down - set speed to lowest speed supported by both link partners
614 * @phydev: the phy_device struct
615 * @sync: perform action synchronously
617 * Description: Typically used to save energy when waiting for a WoL packet
619 * WARNING: Setting sync to false may cause the system being unable to suspend
620 * in case the PHY generates an interrupt when finishing the autonegotiation.
621 * This interrupt may wake up the system immediately after suspend.
622 * Therefore use sync = false only if you're sure it's safe with the respective
625 int phy_speed_down(struct phy_device *phydev, bool sync)
627 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
628 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
631 if (phydev->autoneg != AUTONEG_ENABLE)
634 linkmode_copy(adv_old, phydev->advertising);
635 linkmode_copy(adv, phydev->lp_advertising);
636 linkmode_and(adv, adv, phydev->supported);
638 if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, adv) ||
639 linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, adv)) {
640 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
641 phydev->advertising);
642 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
643 phydev->advertising);
644 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
645 phydev->advertising);
646 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
647 phydev->advertising);
648 } else if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
650 linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
652 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
653 phydev->advertising);
654 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
655 phydev->advertising);
658 if (linkmode_equal(phydev->advertising, adv_old))
661 ret = phy_config_aneg(phydev);
665 return sync ? phy_poll_aneg_done(phydev) : 0;
667 EXPORT_SYMBOL_GPL(phy_speed_down);
670 * phy_speed_up - (re)set advertised speeds to all supported speeds
671 * @phydev: the phy_device struct
673 * Description: Used to revert the effect of phy_speed_down
675 int phy_speed_up(struct phy_device *phydev)
677 __ETHTOOL_DECLARE_LINK_MODE_MASK(all_speeds) = { 0, };
678 __ETHTOOL_DECLARE_LINK_MODE_MASK(not_speeds);
679 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
680 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
681 __ETHTOOL_DECLARE_LINK_MODE_MASK(speeds);
683 linkmode_copy(adv_old, phydev->advertising);
685 if (phydev->autoneg != AUTONEG_ENABLE)
688 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, all_speeds);
689 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, all_speeds);
690 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, all_speeds);
691 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, all_speeds);
692 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, all_speeds);
693 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, all_speeds);
695 linkmode_andnot(not_speeds, adv_old, all_speeds);
696 linkmode_copy(supported, phydev->supported);
697 linkmode_and(speeds, supported, all_speeds);
698 linkmode_or(phydev->advertising, not_speeds, speeds);
700 if (linkmode_equal(phydev->advertising, adv_old))
703 return phy_config_aneg(phydev);
705 EXPORT_SYMBOL_GPL(phy_speed_up);
708 * phy_start_machine - start PHY state machine tracking
709 * @phydev: the phy_device struct
711 * Description: The PHY infrastructure can run a state machine
712 * which tracks whether the PHY is starting up, negotiating,
713 * etc. This function starts the delayed workqueue which tracks
714 * the state of the PHY. If you want to maintain your own state machine,
715 * do not call this function.
717 void phy_start_machine(struct phy_device *phydev)
719 phy_trigger_machine(phydev);
721 EXPORT_SYMBOL_GPL(phy_start_machine);
724 * phy_stop_machine - stop the PHY state machine tracking
725 * @phydev: target phy_device struct
727 * Description: Stops the state machine delayed workqueue, sets the
728 * state to UP (unless it wasn't up yet). This function must be
729 * called BEFORE phy_detach.
731 void phy_stop_machine(struct phy_device *phydev)
733 cancel_delayed_work_sync(&phydev->state_queue);
735 mutex_lock(&phydev->lock);
736 if (phy_is_started(phydev))
737 phydev->state = PHY_UP;
738 mutex_unlock(&phydev->lock);
742 * phy_error - enter HALTED state for this PHY device
743 * @phydev: target phy_device struct
745 * Moves the PHY to the HALTED state in response to a read
746 * or write error, and tells the controller the link is down.
747 * Must not be called from interrupt context, or while the
748 * phydev->lock is held.
750 static void phy_error(struct phy_device *phydev)
754 mutex_lock(&phydev->lock);
755 phydev->state = PHY_HALTED;
756 mutex_unlock(&phydev->lock);
758 phy_trigger_machine(phydev);
762 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
763 * @phydev: target phy_device struct
765 static int phy_disable_interrupts(struct phy_device *phydev)
769 /* Disable PHY interrupts */
770 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
774 /* Clear the interrupt */
775 return phy_clear_interrupt(phydev);
779 * phy_interrupt - PHY interrupt handler
780 * @irq: interrupt line
781 * @phy_dat: phy_device pointer
783 * Description: Handle PHY interrupt
785 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
787 struct phy_device *phydev = phy_dat;
789 if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
792 if (phydev->drv->handle_interrupt) {
793 if (phydev->drv->handle_interrupt(phydev))
796 /* reschedule state queue work to run as soon as possible */
797 phy_trigger_machine(phydev);
800 if (phy_clear_interrupt(phydev))
810 * phy_enable_interrupts - Enable the interrupts from the PHY side
811 * @phydev: target phy_device struct
813 static int phy_enable_interrupts(struct phy_device *phydev)
815 int err = phy_clear_interrupt(phydev);
820 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
824 * phy_request_interrupt - request and enable interrupt for a PHY device
825 * @phydev: target phy_device struct
827 * Description: Request and enable the interrupt for the given PHY.
828 * If this fails, then we set irq to PHY_POLL.
829 * This should only be called with a valid IRQ number.
831 void phy_request_interrupt(struct phy_device *phydev)
835 err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
836 IRQF_ONESHOT | IRQF_SHARED,
837 phydev_name(phydev), phydev);
839 phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
841 phydev->irq = PHY_POLL;
843 if (phy_enable_interrupts(phydev)) {
844 phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
845 phy_free_interrupt(phydev);
846 phydev->irq = PHY_POLL;
850 EXPORT_SYMBOL(phy_request_interrupt);
853 * phy_free_interrupt - disable and free interrupt for a PHY device
854 * @phydev: target phy_device struct
856 * Description: Disable and free the interrupt for the given PHY.
857 * This should only be called with a valid IRQ number.
859 void phy_free_interrupt(struct phy_device *phydev)
861 phy_disable_interrupts(phydev);
862 free_irq(phydev->irq, phydev);
864 EXPORT_SYMBOL(phy_free_interrupt);
867 * phy_stop - Bring down the PHY link, and stop checking the status
868 * @phydev: target phy_device struct
870 void phy_stop(struct phy_device *phydev)
872 if (!phy_is_started(phydev)) {
873 WARN(1, "called from state %s\n",
874 phy_state_to_str(phydev->state));
878 mutex_lock(&phydev->lock);
880 phydev->state = PHY_HALTED;
882 mutex_unlock(&phydev->lock);
884 phy_state_machine(&phydev->state_queue.work);
885 phy_stop_machine(phydev);
887 /* Cannot call flush_scheduled_work() here as desired because
888 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
889 * will not reenable interrupts.
892 EXPORT_SYMBOL(phy_stop);
895 * phy_start - start or restart a PHY device
896 * @phydev: target phy_device struct
898 * Description: Indicates the attached device's readiness to
899 * handle PHY-related work. Used during startup to start the
900 * PHY, and after a call to phy_stop() to resume operation.
901 * Also used to indicate the MDIO bus has cleared an error
904 void phy_start(struct phy_device *phydev)
906 mutex_lock(&phydev->lock);
908 if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
909 WARN(1, "called from state %s\n",
910 phy_state_to_str(phydev->state));
914 /* if phy was suspended, bring the physical link up again */
915 __phy_resume(phydev);
917 phydev->state = PHY_UP;
919 phy_start_machine(phydev);
921 mutex_unlock(&phydev->lock);
923 EXPORT_SYMBOL(phy_start);
926 * phy_state_machine - Handle the state machine
927 * @work: work_struct that describes the work to be done
929 void phy_state_machine(struct work_struct *work)
931 struct delayed_work *dwork = to_delayed_work(work);
932 struct phy_device *phydev =
933 container_of(dwork, struct phy_device, state_queue);
934 bool needs_aneg = false, do_suspend = false;
935 enum phy_state old_state;
938 mutex_lock(&phydev->lock);
940 old_state = phydev->state;
942 switch (phydev->state) {
952 err = phy_check_link_status(phydev);
955 err = genphy_update_link(phydev);
960 phydev->state = PHY_RUNNING;
963 if (0 == phydev->link_timeout--)
965 phy_link_down(phydev, false);
971 phy_link_down(phydev, true);
977 mutex_unlock(&phydev->lock);
980 err = phy_start_aneg(phydev);
987 if (old_state != phydev->state) {
988 phydev_dbg(phydev, "PHY state change %s -> %s\n",
989 phy_state_to_str(old_state),
990 phy_state_to_str(phydev->state));
991 if (phydev->drv && phydev->drv->link_change_notify)
992 phydev->drv->link_change_notify(phydev);
995 /* Only re-schedule a PHY state machine change if we are polling the
996 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
997 * between states from phy_mac_interrupt().
999 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1000 * state machine would be pointless and possibly error prone when
1001 * called from phy_disconnect() synchronously.
1003 mutex_lock(&phydev->lock);
1004 if (phy_polling_mode(phydev) && phy_is_started(phydev))
1005 phy_queue_state_machine(phydev, PHY_STATE_TIME);
1006 mutex_unlock(&phydev->lock);
1010 * phy_mac_interrupt - MAC says the link has changed
1011 * @phydev: phy_device struct with changed link
1013 * The MAC layer is able to indicate there has been a change in the PHY link
1014 * status. Trigger the state machine and work a work queue.
1016 void phy_mac_interrupt(struct phy_device *phydev)
1018 /* Trigger a state machine change */
1019 phy_trigger_machine(phydev);
1021 EXPORT_SYMBOL(phy_mac_interrupt);
1023 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
1025 linkmode_zero(advertising);
1027 if (eee_adv & MDIO_EEE_100TX)
1028 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1030 if (eee_adv & MDIO_EEE_1000T)
1031 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1033 if (eee_adv & MDIO_EEE_10GT)
1034 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
1036 if (eee_adv & MDIO_EEE_1000KX)
1037 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
1039 if (eee_adv & MDIO_EEE_10GKX4)
1040 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
1042 if (eee_adv & MDIO_EEE_10GKR)
1043 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
1048 * phy_init_eee - init and check the EEE feature
1049 * @phydev: target phy_device struct
1050 * @clk_stop_enable: PHY may stop the clock during LPI
1052 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1053 * is supported by looking at the MMD registers 3.20 and 7.60/61
1054 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1057 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1062 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1064 if (phydev->duplex == DUPLEX_FULL) {
1065 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1066 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1067 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1068 int eee_lp, eee_cap, eee_adv;
1072 /* Read phy status to properly get the right settings */
1073 status = phy_read_status(phydev);
1077 /* First check if the EEE ability is supported */
1078 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1082 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1086 /* Check which link settings negotiated and verify it in
1087 * the EEE advertising registers.
1089 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1093 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1097 mmd_eee_adv_to_linkmode(adv, eee_adv);
1098 mmd_eee_adv_to_linkmode(lp, eee_lp);
1099 linkmode_and(common, adv, lp);
1101 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1104 if (clk_stop_enable)
1105 /* Configure the PHY to stop receiving xMII
1106 * clock while it is signaling LPI.
1108 phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1109 MDIO_PCS_CTRL1_CLKSTOP_EN);
1111 return 0; /* EEE supported */
1114 return -EPROTONOSUPPORT;
1116 EXPORT_SYMBOL(phy_init_eee);
1119 * phy_get_eee_err - report the EEE wake error count
1120 * @phydev: target phy_device struct
1122 * Description: it is to report the number of time where the PHY
1123 * failed to complete its normal wake sequence.
1125 int phy_get_eee_err(struct phy_device *phydev)
1130 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1132 EXPORT_SYMBOL(phy_get_eee_err);
1135 * phy_ethtool_get_eee - get EEE supported and status
1136 * @phydev: target phy_device struct
1137 * @data: ethtool_eee data
1139 * Description: it reportes the Supported/Advertisement/LP Advertisement
1142 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1149 /* Get Supported EEE */
1150 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1153 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1155 /* Get advertisement EEE */
1156 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1159 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1160 data->eee_enabled = !!data->advertised;
1162 /* Get LP advertisement EEE */
1163 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1166 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1168 data->eee_active = !!(data->advertised & data->lp_advertised);
1172 EXPORT_SYMBOL(phy_ethtool_get_eee);
1175 * phy_ethtool_set_eee - set EEE supported and status
1176 * @phydev: target phy_device struct
1177 * @data: ethtool_eee data
1179 * Description: it is to program the Advertisement EEE register.
1181 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1183 int cap, old_adv, adv = 0, ret;
1188 /* Get Supported EEE */
1189 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1193 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1197 if (data->eee_enabled) {
1198 adv = !data->advertised ? cap :
1199 ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1200 /* Mask prohibited EEE modes */
1201 adv &= ~phydev->eee_broken_modes;
1204 if (old_adv != adv) {
1205 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1209 /* Restart autonegotiation so the new modes get sent to the
1212 ret = phy_restart_aneg(phydev);
1219 EXPORT_SYMBOL(phy_ethtool_set_eee);
1221 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1223 if (phydev->drv && phydev->drv->set_wol)
1224 return phydev->drv->set_wol(phydev, wol);
1228 EXPORT_SYMBOL(phy_ethtool_set_wol);
1230 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1232 if (phydev->drv && phydev->drv->get_wol)
1233 phydev->drv->get_wol(phydev, wol);
1235 EXPORT_SYMBOL(phy_ethtool_get_wol);
1237 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1238 struct ethtool_link_ksettings *cmd)
1240 struct phy_device *phydev = ndev->phydev;
1245 phy_ethtool_ksettings_get(phydev, cmd);
1249 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1251 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1252 const struct ethtool_link_ksettings *cmd)
1254 struct phy_device *phydev = ndev->phydev;
1259 return phy_ethtool_ksettings_set(phydev, cmd);
1261 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1263 int phy_ethtool_nway_reset(struct net_device *ndev)
1265 struct phy_device *phydev = ndev->phydev;
1273 return phy_restart_aneg(phydev);
1275 EXPORT_SYMBOL(phy_ethtool_nway_reset);