1 /* Framework for configuring and reading PHY devices
2 * Based on code in sungem_phy.c and gianfar_phy.c
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
7 * Copyright (c) 2006, 2007 Maciej W. Rozycki
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 #include <linux/kernel.h>
19 #include <linux/string.h>
20 #include <linux/errno.h>
21 #include <linux/unistd.h>
22 #include <linux/interrupt.h>
23 #include <linux/delay.h>
24 #include <linux/netdevice.h>
25 #include <linux/etherdevice.h>
26 #include <linux/skbuff.h>
28 #include <linux/module.h>
29 #include <linux/mii.h>
30 #include <linux/ethtool.h>
31 #include <linux/phy.h>
32 #include <linux/phy_led_triggers.h>
33 #include <linux/timer.h>
34 #include <linux/workqueue.h>
35 #include <linux/mdio.h>
37 #include <linux/uaccess.h>
38 #include <linux/atomic.h>
42 static const char *phy_speed_to_str(int speed)
58 return "Unsupported (update phy.c)";
62 #define PHY_STATE_STR(_state) \
64 return __stringify(_state); \
66 static const char *phy_state_to_str(enum phy_state st)
70 PHY_STATE_STR(STARTING)
72 PHY_STATE_STR(PENDING)
75 PHY_STATE_STR(RUNNING)
77 PHY_STATE_STR(FORCING)
78 PHY_STATE_STR(CHANGELINK)
80 PHY_STATE_STR(RESUMING)
88 * phy_print_status - Convenience function to print out the current phy status
89 * @phydev: the phy_device struct
91 void phy_print_status(struct phy_device *phydev)
94 netdev_info(phydev->attached_dev,
95 "Link is Up - %s/%s - flow control %s\n",
96 phy_speed_to_str(phydev->speed),
97 DUPLEX_FULL == phydev->duplex ? "Full" : "Half",
98 phydev->pause ? "rx/tx" : "off");
100 netdev_info(phydev->attached_dev, "Link is Down\n");
103 EXPORT_SYMBOL(phy_print_status);
106 * phy_clear_interrupt - Ack the phy device's interrupt
107 * @phydev: the phy_device struct
109 * If the @phydev driver has an ack_interrupt function, call it to
110 * ack and clear the phy device's interrupt.
112 * Returns 0 on success or < 0 on error.
114 static int phy_clear_interrupt(struct phy_device *phydev)
116 if (phydev->drv->ack_interrupt)
117 return phydev->drv->ack_interrupt(phydev);
123 * phy_config_interrupt - configure the PHY device for the requested interrupts
124 * @phydev: the phy_device struct
125 * @interrupts: interrupt flags to configure for this @phydev
127 * Returns 0 on success or < 0 on error.
129 static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
131 phydev->interrupts = interrupts;
132 if (phydev->drv->config_intr)
133 return phydev->drv->config_intr(phydev);
140 * phy_aneg_done - return auto-negotiation status
141 * @phydev: target phy_device struct
143 * Description: Return the auto-negotiation status from this @phydev
144 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
147 int phy_aneg_done(struct phy_device *phydev)
149 if (phydev->drv && phydev->drv->aneg_done)
150 return phydev->drv->aneg_done(phydev);
152 return genphy_aneg_done(phydev);
154 EXPORT_SYMBOL(phy_aneg_done);
156 /* A structure for mapping a particular speed and duplex
157 * combination to a particular SUPPORTED and ADVERTISED value
165 /* A mapping of all SUPPORTED settings to speed/duplex */
166 static const struct phy_setting settings[] = {
168 .speed = SPEED_10000,
169 .duplex = DUPLEX_FULL,
170 .setting = SUPPORTED_10000baseKR_Full,
173 .speed = SPEED_10000,
174 .duplex = DUPLEX_FULL,
175 .setting = SUPPORTED_10000baseKX4_Full,
178 .speed = SPEED_10000,
179 .duplex = DUPLEX_FULL,
180 .setting = SUPPORTED_10000baseT_Full,
184 .duplex = DUPLEX_FULL,
185 .setting = SUPPORTED_2500baseX_Full,
189 .duplex = DUPLEX_FULL,
190 .setting = SUPPORTED_1000baseKX_Full,
194 .duplex = DUPLEX_FULL,
195 .setting = SUPPORTED_1000baseT_Full,
199 .duplex = DUPLEX_HALF,
200 .setting = SUPPORTED_1000baseT_Half,
204 .duplex = DUPLEX_FULL,
205 .setting = SUPPORTED_100baseT_Full,
209 .duplex = DUPLEX_HALF,
210 .setting = SUPPORTED_100baseT_Half,
214 .duplex = DUPLEX_FULL,
215 .setting = SUPPORTED_10baseT_Full,
219 .duplex = DUPLEX_HALF,
220 .setting = SUPPORTED_10baseT_Half,
224 #define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
227 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
228 * @speed: speed to match
229 * @duplex: duplex to match
231 * Description: Searches the settings array for the setting which
232 * matches the desired speed and duplex, and returns the index
233 * of that setting. Returns the index of the last setting if
234 * none of the others match.
236 static inline unsigned int phy_find_setting(int speed, int duplex)
238 unsigned int idx = 0;
240 while (idx < ARRAY_SIZE(settings) &&
241 (settings[idx].speed != speed || settings[idx].duplex != duplex))
244 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
248 * phy_find_valid - find a PHY setting that matches the requested features mask
249 * @idx: The first index in settings[] to search
250 * @features: A mask of the valid settings
252 * Description: Returns the index of the first valid setting less
253 * than or equal to the one pointed to by idx, as determined by
254 * the mask in features. Returns the index of the last setting
255 * if nothing else matches.
257 static inline unsigned int phy_find_valid(unsigned int idx, u32 features)
259 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
262 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
266 * phy_supported_speeds - return all speeds currently supported by a phy device
267 * @phy: The phy device to return supported speeds of.
268 * @speeds: buffer to store supported speeds in.
269 * @size: size of speeds buffer.
271 * Description: Returns the number of supported speeds, and fills the speeds
272 * buffer with the supported speeds. If speeds buffer is too small to contain
273 * all currently supported speeds, will return as many speeds as can fit.
275 unsigned int phy_supported_speeds(struct phy_device *phy,
276 unsigned int *speeds,
279 unsigned int count = 0;
280 unsigned int idx = 0;
282 while (idx < MAX_NUM_SETTINGS && count < size) {
283 idx = phy_find_valid(idx, phy->supported);
285 if (!(settings[idx].setting & phy->supported))
288 /* Assumes settings are grouped by speed */
290 (speeds[count - 1] != settings[idx].speed)) {
291 speeds[count] = settings[idx].speed;
301 * phy_check_valid - check if there is a valid PHY setting which matches
302 * speed, duplex, and feature mask
303 * @speed: speed to match
304 * @duplex: duplex to match
305 * @features: A mask of the valid settings
307 * Description: Returns true if there is a valid setting, false otherwise.
309 static inline bool phy_check_valid(int speed, int duplex, u32 features)
313 idx = phy_find_valid(phy_find_setting(speed, duplex), features);
315 return settings[idx].speed == speed && settings[idx].duplex == duplex &&
316 (settings[idx].setting & features);
320 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
321 * @phydev: the target phy_device struct
323 * Description: Make sure the PHY is set to supported speeds and
324 * duplexes. Drop down by one in this order: 1000/FULL,
325 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
327 static void phy_sanitize_settings(struct phy_device *phydev)
329 u32 features = phydev->supported;
332 /* Sanitize settings based on PHY capabilities */
333 if ((features & SUPPORTED_Autoneg) == 0)
334 phydev->autoneg = AUTONEG_DISABLE;
336 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
339 phydev->speed = settings[idx].speed;
340 phydev->duplex = settings[idx].duplex;
344 * phy_ethtool_sset - generic ethtool sset function, handles all the details
345 * @phydev: target phy_device struct
348 * A few notes about parameter checking:
349 * - We don't set port or transceiver, so we don't care what they
351 * - phy_start_aneg() will make sure forced settings are sane, and
352 * choose the next best ones from the ones selected, so we don't
353 * care if ethtool tries to give us bad values.
355 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
357 u32 speed = ethtool_cmd_speed(cmd);
359 if (cmd->phy_address != phydev->mdio.addr)
362 /* We make sure that we don't pass unsupported values in to the PHY */
363 cmd->advertising &= phydev->supported;
365 /* Verify the settings we care about. */
366 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
369 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
372 if (cmd->autoneg == AUTONEG_DISABLE &&
373 ((speed != SPEED_1000 &&
374 speed != SPEED_100 &&
375 speed != SPEED_10) ||
376 (cmd->duplex != DUPLEX_HALF &&
377 cmd->duplex != DUPLEX_FULL)))
380 phydev->autoneg = cmd->autoneg;
382 phydev->speed = speed;
384 phydev->advertising = cmd->advertising;
386 if (AUTONEG_ENABLE == cmd->autoneg)
387 phydev->advertising |= ADVERTISED_Autoneg;
389 phydev->advertising &= ~ADVERTISED_Autoneg;
391 phydev->duplex = cmd->duplex;
393 phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
395 /* Restart the PHY */
396 phy_start_aneg(phydev);
400 EXPORT_SYMBOL(phy_ethtool_sset);
402 int phy_ethtool_ksettings_set(struct phy_device *phydev,
403 const struct ethtool_link_ksettings *cmd)
405 u8 autoneg = cmd->base.autoneg;
406 u8 duplex = cmd->base.duplex;
407 u32 speed = cmd->base.speed;
410 if (cmd->base.phy_address != phydev->mdio.addr)
413 ethtool_convert_link_mode_to_legacy_u32(&advertising,
414 cmd->link_modes.advertising);
416 /* We make sure that we don't pass unsupported values in to the PHY */
417 advertising &= phydev->supported;
419 /* Verify the settings we care about. */
420 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
423 if (autoneg == AUTONEG_ENABLE && advertising == 0)
426 if (autoneg == AUTONEG_DISABLE &&
427 ((speed != SPEED_1000 &&
428 speed != SPEED_100 &&
429 speed != SPEED_10) ||
430 (duplex != DUPLEX_HALF &&
431 duplex != DUPLEX_FULL)))
434 phydev->autoneg = autoneg;
436 phydev->speed = speed;
438 phydev->advertising = advertising;
440 if (autoneg == AUTONEG_ENABLE)
441 phydev->advertising |= ADVERTISED_Autoneg;
443 phydev->advertising &= ~ADVERTISED_Autoneg;
445 phydev->duplex = duplex;
447 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
449 /* Restart the PHY */
450 phy_start_aneg(phydev);
454 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
456 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
458 cmd->supported = phydev->supported;
460 cmd->advertising = phydev->advertising;
461 cmd->lp_advertising = phydev->lp_advertising;
463 ethtool_cmd_speed_set(cmd, phydev->speed);
464 cmd->duplex = phydev->duplex;
465 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
466 cmd->port = PORT_BNC;
468 cmd->port = PORT_MII;
469 cmd->phy_address = phydev->mdio.addr;
470 cmd->transceiver = phy_is_internal(phydev) ?
471 XCVR_INTERNAL : XCVR_EXTERNAL;
472 cmd->autoneg = phydev->autoneg;
473 cmd->eth_tp_mdix_ctrl = phydev->mdix_ctrl;
474 cmd->eth_tp_mdix = phydev->mdix;
478 EXPORT_SYMBOL(phy_ethtool_gset);
480 int phy_ethtool_ksettings_get(struct phy_device *phydev,
481 struct ethtool_link_ksettings *cmd)
483 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.supported,
486 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.advertising,
487 phydev->advertising);
489 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.lp_advertising,
490 phydev->lp_advertising);
492 cmd->base.speed = phydev->speed;
493 cmd->base.duplex = phydev->duplex;
494 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
495 cmd->base.port = PORT_BNC;
497 cmd->base.port = PORT_MII;
499 cmd->base.phy_address = phydev->mdio.addr;
500 cmd->base.autoneg = phydev->autoneg;
501 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
502 cmd->base.eth_tp_mdix = phydev->mdix;
506 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
509 * phy_mii_ioctl - generic PHY MII ioctl interface
510 * @phydev: the phy_device struct
511 * @ifr: &struct ifreq for socket ioctl's
512 * @cmd: ioctl cmd to execute
514 * Note that this function is currently incompatible with the
515 * PHYCONTROL layer. It changes registers without regard to
516 * current state. Use at own risk.
518 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
520 struct mii_ioctl_data *mii_data = if_mii(ifr);
521 u16 val = mii_data->val_in;
522 bool change_autoneg = false;
526 mii_data->phy_id = phydev->mdio.addr;
530 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
536 if (mii_data->phy_id == phydev->mdio.addr) {
537 switch (mii_data->reg_num) {
539 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
540 if (phydev->autoneg == AUTONEG_ENABLE)
541 change_autoneg = true;
542 phydev->autoneg = AUTONEG_DISABLE;
543 if (val & BMCR_FULLDPLX)
544 phydev->duplex = DUPLEX_FULL;
546 phydev->duplex = DUPLEX_HALF;
547 if (val & BMCR_SPEED1000)
548 phydev->speed = SPEED_1000;
549 else if (val & BMCR_SPEED100)
550 phydev->speed = SPEED_100;
551 else phydev->speed = SPEED_10;
554 if (phydev->autoneg == AUTONEG_DISABLE)
555 change_autoneg = true;
556 phydev->autoneg = AUTONEG_ENABLE;
560 phydev->advertising = mii_adv_to_ethtool_adv_t(val);
561 change_autoneg = true;
569 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
570 mii_data->reg_num, val);
572 if (mii_data->phy_id == phydev->mdio.addr &&
573 mii_data->reg_num == MII_BMCR &&
575 return phy_init_hw(phydev);
578 return phy_start_aneg(phydev);
583 if (phydev->drv && phydev->drv->hwtstamp)
584 return phydev->drv->hwtstamp(phydev, ifr);
591 EXPORT_SYMBOL(phy_mii_ioctl);
594 * phy_start_aneg - start auto-negotiation for this PHY device
595 * @phydev: the phy_device struct
597 * Description: Sanitizes the settings (if we're not autonegotiating
598 * them), and then calls the driver's config_aneg function.
599 * If the PHYCONTROL Layer is operating, we change the state to
600 * reflect the beginning of Auto-negotiation or forcing.
602 int phy_start_aneg(struct phy_device *phydev)
609 mutex_lock(&phydev->lock);
611 if (AUTONEG_DISABLE == phydev->autoneg)
612 phy_sanitize_settings(phydev);
614 /* Invalidate LP advertising flags */
615 phydev->lp_advertising = 0;
617 err = phydev->drv->config_aneg(phydev);
621 if (phydev->state != PHY_HALTED) {
622 if (AUTONEG_ENABLE == phydev->autoneg) {
623 phydev->state = PHY_AN;
624 phydev->link_timeout = PHY_AN_TIMEOUT;
626 phydev->state = PHY_FORCING;
627 phydev->link_timeout = PHY_FORCE_TIMEOUT;
632 mutex_unlock(&phydev->lock);
635 EXPORT_SYMBOL(phy_start_aneg);
638 * phy_start_machine - start PHY state machine tracking
639 * @phydev: the phy_device struct
641 * Description: The PHY infrastructure can run a state machine
642 * which tracks whether the PHY is starting up, negotiating,
643 * etc. This function starts the timer which tracks the state
644 * of the PHY. If you want to maintain your own state machine,
645 * do not call this function.
647 void phy_start_machine(struct phy_device *phydev)
649 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
653 * phy_trigger_machine - trigger the state machine to run
655 * @phydev: the phy_device struct
656 * @sync: indicate whether we should wait for the workqueue cancelation
658 * Description: There has been a change in state which requires that the
659 * state machine runs.
662 static void phy_trigger_machine(struct phy_device *phydev, bool sync)
665 cancel_delayed_work_sync(&phydev->state_queue);
667 cancel_delayed_work(&phydev->state_queue);
668 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
672 * phy_stop_machine - stop the PHY state machine tracking
673 * @phydev: target phy_device struct
675 * Description: Stops the state machine timer, sets the state to UP
676 * (unless it wasn't up yet). This function must be called BEFORE
679 void phy_stop_machine(struct phy_device *phydev)
681 cancel_delayed_work_sync(&phydev->state_queue);
683 mutex_lock(&phydev->lock);
684 if (phydev->state > PHY_UP)
685 phydev->state = PHY_UP;
686 mutex_unlock(&phydev->lock);
690 * phy_error - enter HALTED state for this PHY device
691 * @phydev: target phy_device struct
693 * Moves the PHY to the HALTED state in response to a read
694 * or write error, and tells the controller the link is down.
695 * Must not be called from interrupt context, or while the
696 * phydev->lock is held.
698 static void phy_error(struct phy_device *phydev)
700 mutex_lock(&phydev->lock);
701 phydev->state = PHY_HALTED;
702 mutex_unlock(&phydev->lock);
704 phy_trigger_machine(phydev, false);
708 * phy_interrupt - PHY interrupt handler
709 * @irq: interrupt line
710 * @phy_dat: phy_device pointer
712 * Description: When a PHY interrupt occurs, the handler disables
713 * interrupts, and uses phy_change to handle the interrupt.
715 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
717 struct phy_device *phydev = phy_dat;
719 if (PHY_HALTED == phydev->state)
720 return IRQ_NONE; /* It can't be ours. */
722 disable_irq_nosync(irq);
723 atomic_inc(&phydev->irq_disable);
731 * phy_enable_interrupts - Enable the interrupts from the PHY side
732 * @phydev: target phy_device struct
734 static int phy_enable_interrupts(struct phy_device *phydev)
736 int err = phy_clear_interrupt(phydev);
741 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
745 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
746 * @phydev: target phy_device struct
748 static int phy_disable_interrupts(struct phy_device *phydev)
752 /* Disable PHY interrupts */
753 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
757 /* Clear the interrupt */
758 err = phy_clear_interrupt(phydev);
771 * phy_start_interrupts - request and enable interrupts for a PHY device
772 * @phydev: target phy_device struct
774 * Description: Request the interrupt for the given PHY.
775 * If this fails, then we set irq to PHY_POLL.
776 * Otherwise, we enable the interrupts in the PHY.
777 * This should only be called with a valid IRQ number.
778 * Returns 0 on success or < 0 on error.
780 int phy_start_interrupts(struct phy_device *phydev)
782 atomic_set(&phydev->irq_disable, 0);
783 if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
784 IRQF_ONESHOT | IRQF_SHARED,
785 phydev_name(phydev), phydev) < 0) {
786 pr_warn("%s: Can't get IRQ %d (PHY)\n",
787 phydev->mdio.bus->name, phydev->irq);
788 phydev->irq = PHY_POLL;
792 return phy_enable_interrupts(phydev);
794 EXPORT_SYMBOL(phy_start_interrupts);
797 * phy_stop_interrupts - disable interrupts from a PHY device
798 * @phydev: target phy_device struct
800 int phy_stop_interrupts(struct phy_device *phydev)
802 int err = phy_disable_interrupts(phydev);
807 free_irq(phydev->irq, phydev);
809 /* If work indeed has been cancelled, disable_irq() will have
810 * been left unbalanced from phy_interrupt() and enable_irq()
811 * has to be called so that other devices on the line work.
813 while (atomic_dec_return(&phydev->irq_disable) >= 0)
814 enable_irq(phydev->irq);
818 EXPORT_SYMBOL(phy_stop_interrupts);
821 * phy_change - Called by the phy_interrupt to handle PHY changes
822 * @phydev: phy_device struct that interrupted
824 void phy_change(struct phy_device *phydev)
826 if (phy_interrupt_is_valid(phydev)) {
827 if (phydev->drv->did_interrupt &&
828 !phydev->drv->did_interrupt(phydev))
831 if (phy_disable_interrupts(phydev))
835 mutex_lock(&phydev->lock);
836 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
837 phydev->state = PHY_CHANGELINK;
838 mutex_unlock(&phydev->lock);
840 if (phy_interrupt_is_valid(phydev)) {
841 atomic_dec(&phydev->irq_disable);
842 enable_irq(phydev->irq);
844 /* Reenable interrupts */
845 if (PHY_HALTED != phydev->state &&
846 phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
850 /* reschedule state queue work to run as soon as possible */
851 phy_trigger_machine(phydev, true);
855 atomic_dec(&phydev->irq_disable);
856 enable_irq(phydev->irq);
860 disable_irq(phydev->irq);
861 atomic_inc(&phydev->irq_disable);
867 * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
868 * @work: work_struct that describes the work to be done
870 void phy_change_work(struct work_struct *work)
872 struct phy_device *phydev =
873 container_of(work, struct phy_device, phy_queue);
879 * phy_stop - Bring down the PHY link, and stop checking the status
880 * @phydev: target phy_device struct
882 void phy_stop(struct phy_device *phydev)
884 mutex_lock(&phydev->lock);
886 if (PHY_HALTED == phydev->state)
889 if (phy_interrupt_is_valid(phydev)) {
890 /* Disable PHY Interrupts */
891 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
893 /* Clear any pending interrupts */
894 phy_clear_interrupt(phydev);
897 phydev->state = PHY_HALTED;
900 mutex_unlock(&phydev->lock);
902 /* Cannot call flush_scheduled_work() here as desired because
903 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
904 * will not reenable interrupts.
907 EXPORT_SYMBOL(phy_stop);
910 * phy_start - start or restart a PHY device
911 * @phydev: target phy_device struct
913 * Description: Indicates the attached device's readiness to
914 * handle PHY-related work. Used during startup to start the
915 * PHY, and after a call to phy_stop() to resume operation.
916 * Also used to indicate the MDIO bus has cleared an error
919 void phy_start(struct phy_device *phydev)
921 bool do_resume = false;
924 mutex_lock(&phydev->lock);
926 switch (phydev->state) {
928 phydev->state = PHY_PENDING;
931 phydev->state = PHY_UP;
934 /* make sure interrupts are re-enabled for the PHY */
935 if (phydev->irq != PHY_POLL) {
936 err = phy_enable_interrupts(phydev);
941 phydev->state = PHY_RESUMING;
947 mutex_unlock(&phydev->lock);
949 /* if phy was suspended, bring the physical link up again */
953 phy_trigger_machine(phydev, true);
955 EXPORT_SYMBOL(phy_start);
957 static void phy_adjust_link(struct phy_device *phydev)
959 phydev->adjust_link(phydev->attached_dev);
960 phy_led_trigger_change_speed(phydev);
964 * phy_state_machine - Handle the state machine
965 * @work: work_struct that describes the work to be done
967 void phy_state_machine(struct work_struct *work)
969 struct delayed_work *dwork = to_delayed_work(work);
970 struct phy_device *phydev =
971 container_of(dwork, struct phy_device, state_queue);
972 bool needs_aneg = false, do_suspend = false;
973 enum phy_state old_state;
977 mutex_lock(&phydev->lock);
979 old_state = phydev->state;
981 if (phydev->drv && phydev->drv->link_change_notify)
982 phydev->drv->link_change_notify(phydev);
984 switch (phydev->state) {
993 phydev->link_timeout = PHY_AN_TIMEOUT;
997 err = phy_read_status(phydev);
1001 /* If the link is down, give up on negotiation for now */
1002 if (!phydev->link) {
1003 phydev->state = PHY_NOLINK;
1004 netif_carrier_off(phydev->attached_dev);
1005 phy_adjust_link(phydev);
1009 /* Check if negotiation is done. Break if there's an error */
1010 err = phy_aneg_done(phydev);
1014 /* If AN is done, we're running */
1016 phydev->state = PHY_RUNNING;
1017 netif_carrier_on(phydev->attached_dev);
1018 phy_adjust_link(phydev);
1020 } else if (0 == phydev->link_timeout--)
1024 if (phy_interrupt_is_valid(phydev))
1027 err = phy_read_status(phydev);
1032 if (AUTONEG_ENABLE == phydev->autoneg) {
1033 err = phy_aneg_done(phydev);
1038 phydev->state = PHY_AN;
1039 phydev->link_timeout = PHY_AN_TIMEOUT;
1043 phydev->state = PHY_RUNNING;
1044 netif_carrier_on(phydev->attached_dev);
1045 phy_adjust_link(phydev);
1049 err = genphy_update_link(phydev);
1054 phydev->state = PHY_RUNNING;
1055 netif_carrier_on(phydev->attached_dev);
1057 if (0 == phydev->link_timeout--)
1061 phy_adjust_link(phydev);
1064 /* Only register a CHANGE if we are polling and link changed
1065 * since latest checking.
1067 if (phydev->irq == PHY_POLL) {
1068 old_link = phydev->link;
1069 err = phy_read_status(phydev);
1073 if (old_link != phydev->link)
1074 phydev->state = PHY_CHANGELINK;
1077 * Failsafe: check that nobody set phydev->link=0 between two
1078 * poll cycles, otherwise we won't leave RUNNING state as long
1079 * as link remains down.
1081 if (!phydev->link && phydev->state == PHY_RUNNING) {
1082 phydev->state = PHY_CHANGELINK;
1083 phydev_err(phydev, "no link in PHY_RUNNING\n");
1086 case PHY_CHANGELINK:
1087 err = phy_read_status(phydev);
1092 phydev->state = PHY_RUNNING;
1093 netif_carrier_on(phydev->attached_dev);
1095 phydev->state = PHY_NOLINK;
1096 netif_carrier_off(phydev->attached_dev);
1099 phy_adjust_link(phydev);
1101 if (phy_interrupt_is_valid(phydev))
1102 err = phy_config_interrupt(phydev,
1103 PHY_INTERRUPT_ENABLED);
1108 netif_carrier_off(phydev->attached_dev);
1109 phy_adjust_link(phydev);
1114 if (AUTONEG_ENABLE == phydev->autoneg) {
1115 err = phy_aneg_done(phydev);
1119 /* err > 0 if AN is done.
1120 * Otherwise, it's 0, and we're still waiting for AN
1123 err = phy_read_status(phydev);
1128 phydev->state = PHY_RUNNING;
1129 netif_carrier_on(phydev->attached_dev);
1131 phydev->state = PHY_NOLINK;
1133 phy_adjust_link(phydev);
1135 phydev->state = PHY_AN;
1136 phydev->link_timeout = PHY_AN_TIMEOUT;
1139 err = phy_read_status(phydev);
1144 phydev->state = PHY_RUNNING;
1145 netif_carrier_on(phydev->attached_dev);
1147 phydev->state = PHY_NOLINK;
1149 phy_adjust_link(phydev);
1154 mutex_unlock(&phydev->lock);
1157 err = phy_start_aneg(phydev);
1158 else if (do_suspend)
1159 phy_suspend(phydev);
1164 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1165 phy_state_to_str(old_state),
1166 phy_state_to_str(phydev->state));
1168 /* Only re-schedule a PHY state machine change if we are polling the
1169 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1170 * between states from phy_mac_interrupt()
1172 if (phydev->irq == PHY_POLL)
1173 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
1174 PHY_STATE_TIME * HZ);
1178 * phy_mac_interrupt - MAC says the link has changed
1179 * @phydev: phy_device struct with changed link
1180 * @new_link: Link is Up/Down.
1182 * Description: The MAC layer is able indicate there has been a change
1183 * in the PHY link status. Set the new link status, and trigger the
1184 * state machine, work a work queue.
1186 void phy_mac_interrupt(struct phy_device *phydev, int new_link)
1188 phydev->link = new_link;
1190 /* Trigger a state machine change */
1191 queue_work(system_power_efficient_wq, &phydev->phy_queue);
1193 EXPORT_SYMBOL(phy_mac_interrupt);
1196 * phy_init_eee - init and check the EEE feature
1197 * @phydev: target phy_device struct
1198 * @clk_stop_enable: PHY may stop the clock during LPI
1200 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1201 * is supported by looking at the MMD registers 3.20 and 7.60/61
1202 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1205 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1210 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1211 * Also EEE feature is active when core is operating with MII, GMII
1212 * or RGMII (all kinds). Internal PHYs are also allowed to proceed and
1213 * should return an error if they do not support EEE.
1215 if ((phydev->duplex == DUPLEX_FULL) &&
1216 ((phydev->interface == PHY_INTERFACE_MODE_MII) ||
1217 (phydev->interface == PHY_INTERFACE_MODE_GMII) ||
1218 phy_interface_is_rgmii(phydev) ||
1219 phy_is_internal(phydev))) {
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 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1250 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1251 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1254 if (clk_stop_enable) {
1255 /* Configure the PHY to stop receiving xMII
1256 * clock while it is signaling LPI.
1258 int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1262 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1263 phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1266 return 0; /* EEE supported */
1269 return -EPROTONOSUPPORT;
1271 EXPORT_SYMBOL(phy_init_eee);
1274 * phy_get_eee_err - report the EEE wake error count
1275 * @phydev: target phy_device struct
1277 * Description: it is to report the number of time where the PHY
1278 * failed to complete its normal wake sequence.
1280 int phy_get_eee_err(struct phy_device *phydev)
1285 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1287 EXPORT_SYMBOL(phy_get_eee_err);
1290 * phy_ethtool_get_eee - get EEE supported and status
1291 * @phydev: target phy_device struct
1292 * @data: ethtool_eee data
1294 * Description: it reportes the Supported/Advertisement/LP Advertisement
1297 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1304 /* Get Supported EEE */
1305 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1308 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1310 /* Get advertisement EEE */
1311 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1314 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1316 /* Get LP advertisement EEE */
1317 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1320 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
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)
1340 /* Get Supported EEE */
1341 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1345 adv = ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1347 /* Mask prohibited EEE modes */
1348 adv &= ~phydev->eee_broken_modes;
1350 return phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1352 EXPORT_SYMBOL(phy_ethtool_set_eee);
1354 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1356 if (phydev->drv && phydev->drv->set_wol)
1357 return phydev->drv->set_wol(phydev, wol);
1361 EXPORT_SYMBOL(phy_ethtool_set_wol);
1363 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1365 if (phydev->drv && phydev->drv->get_wol)
1366 phydev->drv->get_wol(phydev, wol);
1368 EXPORT_SYMBOL(phy_ethtool_get_wol);
1370 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1371 struct ethtool_link_ksettings *cmd)
1373 struct phy_device *phydev = ndev->phydev;
1378 return phy_ethtool_ksettings_get(phydev, cmd);
1380 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1382 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1383 const struct ethtool_link_ksettings *cmd)
1385 struct phy_device *phydev = ndev->phydev;
1390 return phy_ethtool_ksettings_set(phydev, cmd);
1392 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1394 int phy_ethtool_nway_reset(struct net_device *ndev)
1396 struct phy_device *phydev = ndev->phydev;
1404 return genphy_restart_aneg(phydev);
1406 EXPORT_SYMBOL(phy_ethtool_nway_reset);