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)
74 return "Unsupported (update phy.c)";
78 #define PHY_STATE_STR(_state) \
80 return __stringify(_state); \
82 static const char *phy_state_to_str(enum phy_state st)
86 PHY_STATE_STR(STARTING)
88 PHY_STATE_STR(PENDING)
91 PHY_STATE_STR(RUNNING)
93 PHY_STATE_STR(FORCING)
94 PHY_STATE_STR(CHANGELINK)
96 PHY_STATE_STR(RESUMING)
104 * phy_print_status - Convenience function to print out the current phy status
105 * @phydev: the phy_device struct
107 void phy_print_status(struct phy_device *phydev)
110 netdev_info(phydev->attached_dev,
111 "Link is Up - %s/%s - flow control %s\n",
112 phy_speed_to_str(phydev->speed),
113 DUPLEX_FULL == phydev->duplex ? "Full" : "Half",
114 phydev->pause ? "rx/tx" : "off");
116 netdev_info(phydev->attached_dev, "Link is Down\n");
119 EXPORT_SYMBOL(phy_print_status);
122 * phy_clear_interrupt - Ack the phy device's interrupt
123 * @phydev: the phy_device struct
125 * If the @phydev driver has an ack_interrupt function, call it to
126 * ack and clear the phy device's interrupt.
128 * Returns 0 on success or < 0 on error.
130 static int phy_clear_interrupt(struct phy_device *phydev)
132 if (phydev->drv->ack_interrupt)
133 return phydev->drv->ack_interrupt(phydev);
139 * phy_config_interrupt - configure the PHY device for the requested interrupts
140 * @phydev: the phy_device struct
141 * @interrupts: interrupt flags to configure for this @phydev
143 * Returns 0 on success or < 0 on error.
145 static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
147 phydev->interrupts = interrupts;
148 if (phydev->drv->config_intr)
149 return phydev->drv->config_intr(phydev);
155 * phy_restart_aneg - restart auto-negotiation
156 * @phydev: target phy_device struct
158 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
159 * negative errno on error.
161 int phy_restart_aneg(struct phy_device *phydev)
165 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
166 ret = genphy_c45_restart_aneg(phydev);
168 ret = genphy_restart_aneg(phydev);
172 EXPORT_SYMBOL_GPL(phy_restart_aneg);
175 * phy_aneg_done - return auto-negotiation status
176 * @phydev: target phy_device struct
178 * Description: Return the auto-negotiation status from this @phydev
179 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
182 int phy_aneg_done(struct phy_device *phydev)
184 if (phydev->drv && phydev->drv->aneg_done)
185 return phydev->drv->aneg_done(phydev);
187 /* Avoid genphy_aneg_done() if the Clause 45 PHY does not
188 * implement Clause 22 registers
190 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
193 return genphy_aneg_done(phydev);
195 EXPORT_SYMBOL(phy_aneg_done);
197 /* A structure for mapping a particular speed and duplex
198 * combination to a particular SUPPORTED and ADVERTISED value
206 /* A mapping of all SUPPORTED settings to speed/duplex. This table
207 * must be grouped by speed and sorted in descending match priority
208 * - iow, descending speed. */
209 static const struct phy_setting settings[] = {
211 .speed = SPEED_10000,
212 .duplex = DUPLEX_FULL,
213 .setting = SUPPORTED_10000baseKR_Full,
216 .speed = SPEED_10000,
217 .duplex = DUPLEX_FULL,
218 .setting = SUPPORTED_10000baseKX4_Full,
221 .speed = SPEED_10000,
222 .duplex = DUPLEX_FULL,
223 .setting = SUPPORTED_10000baseT_Full,
227 .duplex = DUPLEX_FULL,
228 .setting = SUPPORTED_2500baseX_Full,
232 .duplex = DUPLEX_FULL,
233 .setting = SUPPORTED_1000baseKX_Full,
237 .duplex = DUPLEX_FULL,
238 .setting = SUPPORTED_1000baseT_Full,
242 .duplex = DUPLEX_HALF,
243 .setting = SUPPORTED_1000baseT_Half,
247 .duplex = DUPLEX_FULL,
248 .setting = SUPPORTED_100baseT_Full,
252 .duplex = DUPLEX_HALF,
253 .setting = SUPPORTED_100baseT_Half,
257 .duplex = DUPLEX_FULL,
258 .setting = SUPPORTED_10baseT_Full,
262 .duplex = DUPLEX_HALF,
263 .setting = SUPPORTED_10baseT_Half,
268 * phy_lookup_setting - lookup a PHY setting
269 * @speed: speed to match
270 * @duplex: duplex to match
271 * @features: allowed link modes
272 * @exact: an exact match is required
274 * Search the settings array for a setting that matches the speed and
275 * duplex, and which is supported.
277 * If @exact is unset, either an exact match or %NULL for no match will
280 * If @exact is set, an exact match, the fastest supported setting at
281 * or below the specified speed, the slowest supported setting, or if
282 * they all fail, %NULL will be returned.
284 static const struct phy_setting *
285 phy_lookup_setting(int speed, int duplex, u32 features, bool exact)
287 const struct phy_setting *p, *match = NULL, *last = NULL;
290 for (i = 0, p = settings; i < ARRAY_SIZE(settings); i++, p++) {
291 if (p->setting & features) {
293 if (p->speed == speed && p->duplex == duplex) {
294 /* Exact match for speed and duplex */
298 if (!match && p->speed <= speed)
302 if (p->speed < speed)
308 if (!match && !exact)
315 * phy_find_valid - find a PHY setting that matches the requested parameters
316 * @speed: desired speed
317 * @duplex: desired duplex
318 * @supported: mask of supported link modes
320 * Locate a supported phy setting that is, in priority order:
321 * - an exact match for the specified speed and duplex mode
322 * - a match for the specified speed, or slower speed
323 * - the slowest supported speed
324 * Returns the matched phy_setting entry, or %NULL if no supported phy
325 * settings were found.
327 static const struct phy_setting *
328 phy_find_valid(int speed, int duplex, u32 supported)
330 return phy_lookup_setting(speed, duplex, supported, false);
334 * phy_supported_speeds - return all speeds currently supported by a phy device
335 * @phy: The phy device to return supported speeds of.
336 * @speeds: buffer to store supported speeds in.
337 * @size: size of speeds buffer.
339 * Description: Returns the number of supported speeds, and fills the speeds
340 * buffer with the supported speeds. If speeds buffer is too small to contain
341 * all currently supported speeds, will return as many speeds as can fit.
343 unsigned int phy_supported_speeds(struct phy_device *phy,
344 unsigned int *speeds,
347 unsigned int count = 0;
348 unsigned int idx = 0;
350 for (idx = 0; idx < ARRAY_SIZE(settings) && count < size; idx++)
351 /* Assumes settings are grouped by speed */
352 if ((settings[idx].setting & phy->supported) &&
353 (count == 0 || speeds[count - 1] != settings[idx].speed))
354 speeds[count++] = settings[idx].speed;
360 * phy_check_valid - check if there is a valid PHY setting which matches
361 * speed, duplex, and feature mask
362 * @speed: speed to match
363 * @duplex: duplex to match
364 * @features: A mask of the valid settings
366 * Description: Returns true if there is a valid setting, false otherwise.
368 static inline bool phy_check_valid(int speed, int duplex, u32 features)
370 return !!phy_lookup_setting(speed, duplex, features, true);
374 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
375 * @phydev: the target phy_device struct
377 * Description: Make sure the PHY is set to supported speeds and
378 * duplexes. Drop down by one in this order: 1000/FULL,
379 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
381 static void phy_sanitize_settings(struct phy_device *phydev)
383 const struct phy_setting *setting;
384 u32 features = phydev->supported;
386 /* Sanitize settings based on PHY capabilities */
387 if ((features & SUPPORTED_Autoneg) == 0)
388 phydev->autoneg = AUTONEG_DISABLE;
390 setting = phy_find_valid(phydev->speed, phydev->duplex, features);
392 phydev->speed = setting->speed;
393 phydev->duplex = setting->duplex;
395 /* We failed to find anything (no supported speeds?) */
396 phydev->speed = SPEED_UNKNOWN;
397 phydev->duplex = DUPLEX_UNKNOWN;
402 * phy_ethtool_sset - generic ethtool sset function, handles all the details
403 * @phydev: target phy_device struct
406 * A few notes about parameter checking:
408 * - We don't set port or transceiver, so we don't care what they
410 * - phy_start_aneg() will make sure forced settings are sane, and
411 * choose the next best ones from the ones selected, so we don't
412 * care if ethtool tries to give us bad values.
414 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
416 u32 speed = ethtool_cmd_speed(cmd);
418 if (cmd->phy_address != phydev->mdio.addr)
421 /* We make sure that we don't pass unsupported values in to the PHY */
422 cmd->advertising &= phydev->supported;
424 /* Verify the settings we care about. */
425 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
428 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
431 if (cmd->autoneg == AUTONEG_DISABLE &&
432 ((speed != SPEED_1000 &&
433 speed != SPEED_100 &&
434 speed != SPEED_10) ||
435 (cmd->duplex != DUPLEX_HALF &&
436 cmd->duplex != DUPLEX_FULL)))
439 phydev->autoneg = cmd->autoneg;
441 phydev->speed = speed;
443 phydev->advertising = cmd->advertising;
445 if (AUTONEG_ENABLE == cmd->autoneg)
446 phydev->advertising |= ADVERTISED_Autoneg;
448 phydev->advertising &= ~ADVERTISED_Autoneg;
450 phydev->duplex = cmd->duplex;
452 phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
454 /* Restart the PHY */
455 phy_start_aneg(phydev);
459 EXPORT_SYMBOL(phy_ethtool_sset);
461 int phy_ethtool_ksettings_set(struct phy_device *phydev,
462 const struct ethtool_link_ksettings *cmd)
464 u8 autoneg = cmd->base.autoneg;
465 u8 duplex = cmd->base.duplex;
466 u32 speed = cmd->base.speed;
469 if (cmd->base.phy_address != phydev->mdio.addr)
472 ethtool_convert_link_mode_to_legacy_u32(&advertising,
473 cmd->link_modes.advertising);
475 /* We make sure that we don't pass unsupported values in to the PHY */
476 advertising &= phydev->supported;
478 /* Verify the settings we care about. */
479 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
482 if (autoneg == AUTONEG_ENABLE && advertising == 0)
485 if (autoneg == AUTONEG_DISABLE &&
486 ((speed != SPEED_1000 &&
487 speed != SPEED_100 &&
488 speed != SPEED_10) ||
489 (duplex != DUPLEX_HALF &&
490 duplex != DUPLEX_FULL)))
493 phydev->autoneg = autoneg;
495 phydev->speed = speed;
497 phydev->advertising = advertising;
499 if (autoneg == AUTONEG_ENABLE)
500 phydev->advertising |= ADVERTISED_Autoneg;
502 phydev->advertising &= ~ADVERTISED_Autoneg;
504 phydev->duplex = duplex;
506 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
508 /* Restart the PHY */
509 phy_start_aneg(phydev);
513 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
515 void phy_ethtool_ksettings_get(struct phy_device *phydev,
516 struct ethtool_link_ksettings *cmd)
518 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.supported,
521 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.advertising,
522 phydev->advertising);
524 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.lp_advertising,
525 phydev->lp_advertising);
527 cmd->base.speed = phydev->speed;
528 cmd->base.duplex = phydev->duplex;
529 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
530 cmd->base.port = PORT_BNC;
532 cmd->base.port = PORT_MII;
534 cmd->base.phy_address = phydev->mdio.addr;
535 cmd->base.autoneg = phydev->autoneg;
536 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
537 cmd->base.eth_tp_mdix = phydev->mdix;
539 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
542 * phy_mii_ioctl - generic PHY MII ioctl interface
543 * @phydev: the phy_device struct
544 * @ifr: &struct ifreq for socket ioctl's
545 * @cmd: ioctl cmd to execute
547 * Note that this function is currently incompatible with the
548 * PHYCONTROL layer. It changes registers without regard to
549 * current state. Use at own risk.
551 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
553 struct mii_ioctl_data *mii_data = if_mii(ifr);
554 u16 val = mii_data->val_in;
555 bool change_autoneg = false;
559 mii_data->phy_id = phydev->mdio.addr;
563 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
569 if (mii_data->phy_id == phydev->mdio.addr) {
570 switch (mii_data->reg_num) {
572 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
573 if (phydev->autoneg == AUTONEG_ENABLE)
574 change_autoneg = true;
575 phydev->autoneg = AUTONEG_DISABLE;
576 if (val & BMCR_FULLDPLX)
577 phydev->duplex = DUPLEX_FULL;
579 phydev->duplex = DUPLEX_HALF;
580 if (val & BMCR_SPEED1000)
581 phydev->speed = SPEED_1000;
582 else if (val & BMCR_SPEED100)
583 phydev->speed = SPEED_100;
584 else phydev->speed = SPEED_10;
587 if (phydev->autoneg == AUTONEG_DISABLE)
588 change_autoneg = true;
589 phydev->autoneg = AUTONEG_ENABLE;
593 phydev->advertising = mii_adv_to_ethtool_adv_t(val);
594 change_autoneg = true;
602 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
603 mii_data->reg_num, val);
605 if (mii_data->phy_id == phydev->mdio.addr &&
606 mii_data->reg_num == MII_BMCR &&
608 return phy_init_hw(phydev);
611 return phy_start_aneg(phydev);
616 if (phydev->drv && phydev->drv->hwtstamp)
617 return phydev->drv->hwtstamp(phydev, ifr);
624 EXPORT_SYMBOL(phy_mii_ioctl);
627 * phy_start_aneg_priv - start auto-negotiation for this PHY device
628 * @phydev: the phy_device struct
629 * @sync: indicate whether we should wait for the workqueue cancelation
631 * Description: Sanitizes the settings (if we're not autonegotiating
632 * them), and then calls the driver's config_aneg function.
633 * If the PHYCONTROL Layer is operating, we change the state to
634 * reflect the beginning of Auto-negotiation or forcing.
636 static int phy_start_aneg_priv(struct phy_device *phydev, bool sync)
644 mutex_lock(&phydev->lock);
646 if (AUTONEG_DISABLE == phydev->autoneg)
647 phy_sanitize_settings(phydev);
649 /* Invalidate LP advertising flags */
650 phydev->lp_advertising = 0;
652 err = phydev->drv->config_aneg(phydev);
656 if (phydev->state != PHY_HALTED) {
657 if (AUTONEG_ENABLE == phydev->autoneg) {
658 phydev->state = PHY_AN;
659 phydev->link_timeout = PHY_AN_TIMEOUT;
661 phydev->state = PHY_FORCING;
662 phydev->link_timeout = PHY_FORCE_TIMEOUT;
666 /* Re-schedule a PHY state machine to check PHY status because
667 * negotiation may already be done and aneg interrupt may not be
670 if (phy_interrupt_is_valid(phydev) && (phydev->state == PHY_AN)) {
671 err = phy_aneg_done(phydev);
679 mutex_unlock(&phydev->lock);
682 phy_trigger_machine(phydev, sync);
688 * phy_start_aneg - start auto-negotiation for this PHY device
689 * @phydev: the phy_device struct
691 * Description: Sanitizes the settings (if we're not autonegotiating
692 * them), and then calls the driver's config_aneg function.
693 * If the PHYCONTROL Layer is operating, we change the state to
694 * reflect the beginning of Auto-negotiation or forcing.
696 int phy_start_aneg(struct phy_device *phydev)
698 return phy_start_aneg_priv(phydev, true);
700 EXPORT_SYMBOL(phy_start_aneg);
703 * phy_start_machine - start PHY state machine tracking
704 * @phydev: the phy_device struct
706 * Description: The PHY infrastructure can run a state machine
707 * which tracks whether the PHY is starting up, negotiating,
708 * etc. This function starts the timer which tracks the state
709 * of the PHY. If you want to maintain your own state machine,
710 * do not call this function.
712 void phy_start_machine(struct phy_device *phydev)
714 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
718 * phy_trigger_machine - trigger the state machine to run
720 * @phydev: the phy_device struct
721 * @sync: indicate whether we should wait for the workqueue cancelation
723 * Description: There has been a change in state which requires that the
724 * state machine runs.
727 void phy_trigger_machine(struct phy_device *phydev, bool sync)
730 cancel_delayed_work_sync(&phydev->state_queue);
732 cancel_delayed_work(&phydev->state_queue);
733 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
737 * phy_stop_machine - stop the PHY state machine tracking
738 * @phydev: target phy_device struct
740 * Description: Stops the state machine timer, sets the state to UP
741 * (unless it wasn't up yet). This function must be called BEFORE
744 void phy_stop_machine(struct phy_device *phydev)
746 cancel_delayed_work_sync(&phydev->state_queue);
748 mutex_lock(&phydev->lock);
749 if (phydev->state > PHY_UP && phydev->state != PHY_HALTED)
750 phydev->state = PHY_UP;
751 mutex_unlock(&phydev->lock);
753 /* Now we can run the state machine synchronously */
754 phy_state_machine(&phydev->state_queue.work);
758 * phy_error - enter HALTED state for this PHY device
759 * @phydev: target phy_device struct
761 * Moves the PHY to the HALTED state in response to a read
762 * or write error, and tells the controller the link is down.
763 * Must not be called from interrupt context, or while the
764 * phydev->lock is held.
766 static void phy_error(struct phy_device *phydev)
768 mutex_lock(&phydev->lock);
769 phydev->state = PHY_HALTED;
770 mutex_unlock(&phydev->lock);
772 phy_trigger_machine(phydev, false);
776 * phy_interrupt - PHY interrupt handler
777 * @irq: interrupt line
778 * @phy_dat: phy_device pointer
780 * Description: When a PHY interrupt occurs, the handler disables
781 * interrupts, and uses phy_change to handle the interrupt.
783 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
785 struct phy_device *phydev = phy_dat;
787 if (PHY_HALTED == phydev->state)
788 return IRQ_NONE; /* It can't be ours. */
790 disable_irq_nosync(irq);
791 atomic_inc(&phydev->irq_disable);
799 * phy_enable_interrupts - Enable the interrupts from the PHY side
800 * @phydev: target phy_device struct
802 static int phy_enable_interrupts(struct phy_device *phydev)
804 int err = phy_clear_interrupt(phydev);
809 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
813 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
814 * @phydev: target phy_device struct
816 static int phy_disable_interrupts(struct phy_device *phydev)
820 /* Disable PHY interrupts */
821 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
825 /* Clear the interrupt */
826 err = phy_clear_interrupt(phydev);
839 * phy_start_interrupts - request and enable interrupts for a PHY device
840 * @phydev: target phy_device struct
842 * Description: Request the interrupt for the given PHY.
843 * If this fails, then we set irq to PHY_POLL.
844 * Otherwise, we enable the interrupts in the PHY.
845 * This should only be called with a valid IRQ number.
846 * Returns 0 on success or < 0 on error.
848 int phy_start_interrupts(struct phy_device *phydev)
850 atomic_set(&phydev->irq_disable, 0);
851 if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
852 IRQF_ONESHOT | IRQF_SHARED,
853 phydev_name(phydev), phydev) < 0) {
854 pr_warn("%s: Can't get IRQ %d (PHY)\n",
855 phydev->mdio.bus->name, phydev->irq);
856 phydev->irq = PHY_POLL;
860 return phy_enable_interrupts(phydev);
862 EXPORT_SYMBOL(phy_start_interrupts);
865 * phy_stop_interrupts - disable interrupts from a PHY device
866 * @phydev: target phy_device struct
868 int phy_stop_interrupts(struct phy_device *phydev)
870 int err = phy_disable_interrupts(phydev);
875 free_irq(phydev->irq, phydev);
877 /* If work indeed has been cancelled, disable_irq() will have
878 * been left unbalanced from phy_interrupt() and enable_irq()
879 * has to be called so that other devices on the line work.
881 while (atomic_dec_return(&phydev->irq_disable) >= 0)
882 enable_irq(phydev->irq);
886 EXPORT_SYMBOL(phy_stop_interrupts);
889 * phy_change - Called by the phy_interrupt to handle PHY changes
890 * @phydev: phy_device struct that interrupted
892 void phy_change(struct phy_device *phydev)
894 if (phy_interrupt_is_valid(phydev)) {
895 if (phydev->drv->did_interrupt &&
896 !phydev->drv->did_interrupt(phydev))
899 if (phy_disable_interrupts(phydev))
903 mutex_lock(&phydev->lock);
904 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
905 phydev->state = PHY_CHANGELINK;
906 mutex_unlock(&phydev->lock);
908 if (phy_interrupt_is_valid(phydev)) {
909 atomic_dec(&phydev->irq_disable);
910 enable_irq(phydev->irq);
912 /* Reenable interrupts */
913 if (PHY_HALTED != phydev->state &&
914 phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
918 /* reschedule state queue work to run as soon as possible */
919 phy_trigger_machine(phydev, true);
923 atomic_dec(&phydev->irq_disable);
924 enable_irq(phydev->irq);
928 disable_irq(phydev->irq);
929 atomic_inc(&phydev->irq_disable);
935 * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
936 * @work: work_struct that describes the work to be done
938 void phy_change_work(struct work_struct *work)
940 struct phy_device *phydev =
941 container_of(work, struct phy_device, phy_queue);
947 * phy_stop - Bring down the PHY link, and stop checking the status
948 * @phydev: target phy_device struct
950 void phy_stop(struct phy_device *phydev)
952 mutex_lock(&phydev->lock);
954 if (PHY_HALTED == phydev->state)
957 if (phy_interrupt_is_valid(phydev)) {
958 /* Disable PHY Interrupts */
959 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
961 /* Clear any pending interrupts */
962 phy_clear_interrupt(phydev);
965 phydev->state = PHY_HALTED;
968 mutex_unlock(&phydev->lock);
970 /* Cannot call flush_scheduled_work() here as desired because
971 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
972 * will not reenable interrupts.
975 EXPORT_SYMBOL(phy_stop);
978 * phy_start - start or restart a PHY device
979 * @phydev: target phy_device struct
981 * Description: Indicates the attached device's readiness to
982 * handle PHY-related work. Used during startup to start the
983 * PHY, and after a call to phy_stop() to resume operation.
984 * Also used to indicate the MDIO bus has cleared an error
987 void phy_start(struct phy_device *phydev)
989 bool do_resume = false;
992 mutex_lock(&phydev->lock);
994 switch (phydev->state) {
996 phydev->state = PHY_PENDING;
999 phydev->state = PHY_UP;
1002 /* make sure interrupts are re-enabled for the PHY */
1003 if (phydev->irq != PHY_POLL) {
1004 err = phy_enable_interrupts(phydev);
1009 phydev->state = PHY_RESUMING;
1015 mutex_unlock(&phydev->lock);
1017 /* if phy was suspended, bring the physical link up again */
1021 phy_trigger_machine(phydev, true);
1023 EXPORT_SYMBOL(phy_start);
1025 static void phy_adjust_link(struct phy_device *phydev)
1027 phydev->adjust_link(phydev->attached_dev);
1028 phy_led_trigger_change_speed(phydev);
1032 * phy_state_machine - Handle the state machine
1033 * @work: work_struct that describes the work to be done
1035 void phy_state_machine(struct work_struct *work)
1037 struct delayed_work *dwork = to_delayed_work(work);
1038 struct phy_device *phydev =
1039 container_of(dwork, struct phy_device, state_queue);
1040 bool needs_aneg = false, do_suspend = false;
1041 enum phy_state old_state;
1045 mutex_lock(&phydev->lock);
1047 old_state = phydev->state;
1049 if (phydev->drv && phydev->drv->link_change_notify)
1050 phydev->drv->link_change_notify(phydev);
1052 switch (phydev->state) {
1061 phydev->link_timeout = PHY_AN_TIMEOUT;
1065 err = phy_read_status(phydev);
1069 /* If the link is down, give up on negotiation for now */
1070 if (!phydev->link) {
1071 phydev->state = PHY_NOLINK;
1072 netif_carrier_off(phydev->attached_dev);
1073 phy_adjust_link(phydev);
1077 /* Check if negotiation is done. Break if there's an error */
1078 err = phy_aneg_done(phydev);
1082 /* If AN is done, we're running */
1084 phydev->state = PHY_RUNNING;
1085 netif_carrier_on(phydev->attached_dev);
1086 phy_adjust_link(phydev);
1088 } else if (0 == phydev->link_timeout--)
1092 if (phy_interrupt_is_valid(phydev))
1095 err = phy_read_status(phydev);
1100 if (AUTONEG_ENABLE == phydev->autoneg) {
1101 err = phy_aneg_done(phydev);
1106 phydev->state = PHY_AN;
1107 phydev->link_timeout = PHY_AN_TIMEOUT;
1111 phydev->state = PHY_RUNNING;
1112 netif_carrier_on(phydev->attached_dev);
1113 phy_adjust_link(phydev);
1117 err = genphy_update_link(phydev);
1122 phydev->state = PHY_RUNNING;
1123 netif_carrier_on(phydev->attached_dev);
1125 if (0 == phydev->link_timeout--)
1129 phy_adjust_link(phydev);
1132 /* Only register a CHANGE if we are polling and link changed
1133 * since latest checking.
1135 if (phydev->irq == PHY_POLL) {
1136 old_link = phydev->link;
1137 err = phy_read_status(phydev);
1141 if (old_link != phydev->link)
1142 phydev->state = PHY_CHANGELINK;
1145 * Failsafe: check that nobody set phydev->link=0 between two
1146 * poll cycles, otherwise we won't leave RUNNING state as long
1147 * as link remains down.
1149 if (!phydev->link && phydev->state == PHY_RUNNING) {
1150 phydev->state = PHY_CHANGELINK;
1151 phydev_err(phydev, "no link in PHY_RUNNING\n");
1154 case PHY_CHANGELINK:
1155 err = phy_read_status(phydev);
1160 phydev->state = PHY_RUNNING;
1161 netif_carrier_on(phydev->attached_dev);
1163 phydev->state = PHY_NOLINK;
1164 netif_carrier_off(phydev->attached_dev);
1167 phy_adjust_link(phydev);
1169 if (phy_interrupt_is_valid(phydev))
1170 err = phy_config_interrupt(phydev,
1171 PHY_INTERRUPT_ENABLED);
1176 netif_carrier_off(phydev->attached_dev);
1177 phy_adjust_link(phydev);
1182 if (AUTONEG_ENABLE == phydev->autoneg) {
1183 err = phy_aneg_done(phydev);
1187 /* err > 0 if AN is done.
1188 * Otherwise, it's 0, and we're still waiting for AN
1191 err = phy_read_status(phydev);
1196 phydev->state = PHY_RUNNING;
1197 netif_carrier_on(phydev->attached_dev);
1199 phydev->state = PHY_NOLINK;
1201 phy_adjust_link(phydev);
1203 phydev->state = PHY_AN;
1204 phydev->link_timeout = PHY_AN_TIMEOUT;
1207 err = phy_read_status(phydev);
1212 phydev->state = PHY_RUNNING;
1213 netif_carrier_on(phydev->attached_dev);
1215 phydev->state = PHY_NOLINK;
1217 phy_adjust_link(phydev);
1222 mutex_unlock(&phydev->lock);
1225 err = phy_start_aneg_priv(phydev, false);
1226 else if (do_suspend)
1227 phy_suspend(phydev);
1232 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1233 phy_state_to_str(old_state),
1234 phy_state_to_str(phydev->state));
1236 /* Only re-schedule a PHY state machine change if we are polling the
1237 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1238 * between states from phy_mac_interrupt()
1240 if (phydev->irq == PHY_POLL)
1241 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
1242 PHY_STATE_TIME * HZ);
1246 * phy_mac_interrupt - MAC says the link has changed
1247 * @phydev: phy_device struct with changed link
1248 * @new_link: Link is Up/Down.
1250 * Description: The MAC layer is able indicate there has been a change
1251 * in the PHY link status. Set the new link status, and trigger the
1252 * state machine, work a work queue.
1254 void phy_mac_interrupt(struct phy_device *phydev, int new_link)
1256 phydev->link = new_link;
1258 /* Trigger a state machine change */
1259 queue_work(system_power_efficient_wq, &phydev->phy_queue);
1261 EXPORT_SYMBOL(phy_mac_interrupt);
1264 * phy_init_eee - init and check the EEE feature
1265 * @phydev: target phy_device struct
1266 * @clk_stop_enable: PHY may stop the clock during LPI
1268 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1269 * is supported by looking at the MMD registers 3.20 and 7.60/61
1270 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1273 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1278 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1280 if (phydev->duplex == DUPLEX_FULL) {
1281 int eee_lp, eee_cap, eee_adv;
1285 /* Read phy status to properly get the right settings */
1286 status = phy_read_status(phydev);
1290 /* First check if the EEE ability is supported */
1291 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1295 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1299 /* Check which link settings negotiated and verify it in
1300 * the EEE advertising registers.
1302 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1306 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1310 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1311 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1312 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1315 if (clk_stop_enable) {
1316 /* Configure the PHY to stop receiving xMII
1317 * clock while it is signaling LPI.
1319 int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1323 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1324 phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1327 return 0; /* EEE supported */
1330 return -EPROTONOSUPPORT;
1332 EXPORT_SYMBOL(phy_init_eee);
1335 * phy_get_eee_err - report the EEE wake error count
1336 * @phydev: target phy_device struct
1338 * Description: it is to report the number of time where the PHY
1339 * failed to complete its normal wake sequence.
1341 int phy_get_eee_err(struct phy_device *phydev)
1346 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1348 EXPORT_SYMBOL(phy_get_eee_err);
1351 * phy_ethtool_get_eee - get EEE supported and status
1352 * @phydev: target phy_device struct
1353 * @data: ethtool_eee data
1355 * Description: it reportes the Supported/Advertisement/LP Advertisement
1358 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1365 /* Get Supported EEE */
1366 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1369 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1371 /* Get advertisement EEE */
1372 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1375 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1377 /* Get LP advertisement EEE */
1378 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1381 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1385 EXPORT_SYMBOL(phy_ethtool_get_eee);
1388 * phy_ethtool_set_eee - set EEE supported and status
1389 * @phydev: target phy_device struct
1390 * @data: ethtool_eee data
1392 * Description: it is to program the Advertisement EEE register.
1394 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1396 int cap, old_adv, adv, ret;
1401 /* Get Supported EEE */
1402 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1406 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1410 adv = ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1412 /* Mask prohibited EEE modes */
1413 adv &= ~phydev->eee_broken_modes;
1415 if (old_adv != adv) {
1416 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1420 /* Restart autonegotiation so the new modes get sent to the
1423 ret = phy_restart_aneg(phydev);
1430 EXPORT_SYMBOL(phy_ethtool_set_eee);
1432 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1434 if (phydev->drv && phydev->drv->set_wol)
1435 return phydev->drv->set_wol(phydev, wol);
1439 EXPORT_SYMBOL(phy_ethtool_set_wol);
1441 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1443 if (phydev->drv && phydev->drv->get_wol)
1444 phydev->drv->get_wol(phydev, wol);
1446 EXPORT_SYMBOL(phy_ethtool_get_wol);
1448 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1449 struct ethtool_link_ksettings *cmd)
1451 struct phy_device *phydev = ndev->phydev;
1456 phy_ethtool_ksettings_get(phydev, cmd);
1460 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1462 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1463 const struct ethtool_link_ksettings *cmd)
1465 struct phy_device *phydev = ndev->phydev;
1470 return phy_ethtool_ksettings_set(phydev, cmd);
1472 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1474 int phy_ethtool_nway_reset(struct net_device *ndev)
1476 struct phy_device *phydev = ndev->phydev;
1484 return phy_restart_aneg(phydev);
1486 EXPORT_SYMBOL(phy_ethtool_nway_reset);