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/workqueue.h>
34 #include <linux/mdio.h>
36 #include <linux/uaccess.h>
37 #include <linux/atomic.h>
41 #define PHY_STATE_STR(_state) \
43 return __stringify(_state); \
45 static const char *phy_state_to_str(enum phy_state st)
49 PHY_STATE_STR(STARTING)
51 PHY_STATE_STR(PENDING)
54 PHY_STATE_STR(RUNNING)
56 PHY_STATE_STR(FORCING)
57 PHY_STATE_STR(CHANGELINK)
59 PHY_STATE_STR(RESUMING)
67 * phy_print_status - Convenience function to print out the current phy status
68 * @phydev: the phy_device struct
70 void phy_print_status(struct phy_device *phydev)
73 netdev_info(phydev->attached_dev,
74 "Link is Up - %s/%s - flow control %s\n",
75 phy_speed_to_str(phydev->speed),
76 phy_duplex_to_str(phydev->duplex),
77 phydev->pause ? "rx/tx" : "off");
79 netdev_info(phydev->attached_dev, "Link is Down\n");
82 EXPORT_SYMBOL(phy_print_status);
85 * phy_clear_interrupt - Ack the phy device's interrupt
86 * @phydev: the phy_device struct
88 * If the @phydev driver has an ack_interrupt function, call it to
89 * ack and clear the phy device's interrupt.
91 * Returns 0 on success or < 0 on error.
93 static int phy_clear_interrupt(struct phy_device *phydev)
95 if (phydev->drv->ack_interrupt)
96 return phydev->drv->ack_interrupt(phydev);
102 * phy_config_interrupt - configure the PHY device for the requested interrupts
103 * @phydev: the phy_device struct
104 * @interrupts: interrupt flags to configure for this @phydev
106 * Returns 0 on success or < 0 on error.
108 static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
110 phydev->interrupts = interrupts;
111 if (phydev->drv->config_intr)
112 return phydev->drv->config_intr(phydev);
118 * phy_restart_aneg - restart auto-negotiation
119 * @phydev: target phy_device struct
121 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
122 * negative errno on error.
124 int phy_restart_aneg(struct phy_device *phydev)
128 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
129 ret = genphy_c45_restart_aneg(phydev);
131 ret = genphy_restart_aneg(phydev);
135 EXPORT_SYMBOL_GPL(phy_restart_aneg);
138 * phy_aneg_done - return auto-negotiation status
139 * @phydev: target phy_device struct
141 * Description: Return the auto-negotiation status from this @phydev
142 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
145 int phy_aneg_done(struct phy_device *phydev)
147 if (phydev->drv && phydev->drv->aneg_done)
148 return phydev->drv->aneg_done(phydev);
150 /* Avoid genphy_aneg_done() if the Clause 45 PHY does not
151 * implement Clause 22 registers
153 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
156 return genphy_aneg_done(phydev);
158 EXPORT_SYMBOL(phy_aneg_done);
161 * phy_find_valid - find a PHY setting that matches the requested parameters
162 * @speed: desired speed
163 * @duplex: desired duplex
164 * @supported: mask of supported link modes
166 * Locate a supported phy setting that is, in priority order:
167 * - an exact match for the specified speed and duplex mode
168 * - a match for the specified speed, or slower speed
169 * - the slowest supported speed
170 * Returns the matched phy_setting entry, or %NULL if no supported phy
171 * settings were found.
173 static const struct phy_setting *
174 phy_find_valid(int speed, int duplex, u32 supported)
176 unsigned long mask = supported;
178 return phy_lookup_setting(speed, duplex, &mask, BITS_PER_LONG, false);
182 * phy_supported_speeds - return all speeds currently supported by a phy device
183 * @phy: The phy device to return supported speeds of.
184 * @speeds: buffer to store supported speeds in.
185 * @size: size of speeds buffer.
187 * Description: Returns the number of supported speeds, and fills the speeds
188 * buffer with the supported speeds. If speeds buffer is too small to contain
189 * all currently supported speeds, will return as many speeds as can fit.
191 unsigned int phy_supported_speeds(struct phy_device *phy,
192 unsigned int *speeds,
195 unsigned long supported = phy->supported;
197 return phy_speeds(speeds, size, &supported, BITS_PER_LONG);
201 * phy_check_valid - check if there is a valid PHY setting which matches
202 * speed, duplex, and feature mask
203 * @speed: speed to match
204 * @duplex: duplex to match
205 * @features: A mask of the valid settings
207 * Description: Returns true if there is a valid setting, false otherwise.
209 static inline bool phy_check_valid(int speed, int duplex, u32 features)
211 unsigned long mask = features;
213 return !!phy_lookup_setting(speed, duplex, &mask, BITS_PER_LONG, true);
217 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
218 * @phydev: the target phy_device struct
220 * Description: Make sure the PHY is set to supported speeds and
221 * duplexes. Drop down by one in this order: 1000/FULL,
222 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
224 static void phy_sanitize_settings(struct phy_device *phydev)
226 const struct phy_setting *setting;
227 u32 features = phydev->supported;
229 /* Sanitize settings based on PHY capabilities */
230 if ((features & SUPPORTED_Autoneg) == 0)
231 phydev->autoneg = AUTONEG_DISABLE;
233 setting = phy_find_valid(phydev->speed, phydev->duplex, features);
235 phydev->speed = setting->speed;
236 phydev->duplex = setting->duplex;
238 /* We failed to find anything (no supported speeds?) */
239 phydev->speed = SPEED_UNKNOWN;
240 phydev->duplex = DUPLEX_UNKNOWN;
245 * phy_ethtool_sset - generic ethtool sset function, handles all the details
246 * @phydev: target phy_device struct
249 * A few notes about parameter checking:
251 * - We don't set port or transceiver, so we don't care what they
253 * - phy_start_aneg() will make sure forced settings are sane, and
254 * choose the next best ones from the ones selected, so we don't
255 * care if ethtool tries to give us bad values.
257 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
259 u32 speed = ethtool_cmd_speed(cmd);
261 if (cmd->phy_address != phydev->mdio.addr)
264 /* We make sure that we don't pass unsupported values in to the PHY */
265 cmd->advertising &= phydev->supported;
267 /* Verify the settings we care about. */
268 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
271 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
274 if (cmd->autoneg == AUTONEG_DISABLE &&
275 ((speed != SPEED_1000 &&
276 speed != SPEED_100 &&
277 speed != SPEED_10) ||
278 (cmd->duplex != DUPLEX_HALF &&
279 cmd->duplex != DUPLEX_FULL)))
282 phydev->autoneg = cmd->autoneg;
284 phydev->speed = speed;
286 phydev->advertising = cmd->advertising;
288 if (AUTONEG_ENABLE == cmd->autoneg)
289 phydev->advertising |= ADVERTISED_Autoneg;
291 phydev->advertising &= ~ADVERTISED_Autoneg;
293 phydev->duplex = cmd->duplex;
295 phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
297 /* Restart the PHY */
298 phy_start_aneg(phydev);
302 EXPORT_SYMBOL(phy_ethtool_sset);
304 int phy_ethtool_ksettings_set(struct phy_device *phydev,
305 const struct ethtool_link_ksettings *cmd)
307 u8 autoneg = cmd->base.autoneg;
308 u8 duplex = cmd->base.duplex;
309 u32 speed = cmd->base.speed;
312 if (cmd->base.phy_address != phydev->mdio.addr)
315 ethtool_convert_link_mode_to_legacy_u32(&advertising,
316 cmd->link_modes.advertising);
318 /* We make sure that we don't pass unsupported values in to the PHY */
319 advertising &= phydev->supported;
321 /* Verify the settings we care about. */
322 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
325 if (autoneg == AUTONEG_ENABLE && advertising == 0)
328 if (autoneg == AUTONEG_DISABLE &&
329 ((speed != SPEED_1000 &&
330 speed != SPEED_100 &&
331 speed != SPEED_10) ||
332 (duplex != DUPLEX_HALF &&
333 duplex != DUPLEX_FULL)))
336 phydev->autoneg = autoneg;
338 if (autoneg == AUTONEG_DISABLE) {
339 phydev->speed = speed;
340 phydev->duplex = duplex;
343 phydev->advertising = advertising;
345 if (autoneg == AUTONEG_ENABLE)
346 phydev->advertising |= ADVERTISED_Autoneg;
348 phydev->advertising &= ~ADVERTISED_Autoneg;
350 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
352 /* Restart the PHY */
353 phy_start_aneg(phydev);
357 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
359 void phy_ethtool_ksettings_get(struct phy_device *phydev,
360 struct ethtool_link_ksettings *cmd)
362 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.supported,
365 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.advertising,
366 phydev->advertising);
368 ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.lp_advertising,
369 phydev->lp_advertising);
371 cmd->base.speed = phydev->speed;
372 cmd->base.duplex = phydev->duplex;
373 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
374 cmd->base.port = PORT_BNC;
376 cmd->base.port = PORT_MII;
377 cmd->base.transceiver = phy_is_internal(phydev) ?
378 XCVR_INTERNAL : XCVR_EXTERNAL;
379 cmd->base.phy_address = phydev->mdio.addr;
380 cmd->base.autoneg = phydev->autoneg;
381 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
382 cmd->base.eth_tp_mdix = phydev->mdix;
384 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
387 * phy_mii_ioctl - generic PHY MII ioctl interface
388 * @phydev: the phy_device struct
389 * @ifr: &struct ifreq for socket ioctl's
390 * @cmd: ioctl cmd to execute
392 * Note that this function is currently incompatible with the
393 * PHYCONTROL layer. It changes registers without regard to
394 * current state. Use at own risk.
396 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
398 struct mii_ioctl_data *mii_data = if_mii(ifr);
399 u16 val = mii_data->val_in;
400 bool change_autoneg = false;
404 mii_data->phy_id = phydev->mdio.addr;
408 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
414 if (mii_data->phy_id == phydev->mdio.addr) {
415 switch (mii_data->reg_num) {
417 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
418 if (phydev->autoneg == AUTONEG_ENABLE)
419 change_autoneg = true;
420 phydev->autoneg = AUTONEG_DISABLE;
421 if (val & BMCR_FULLDPLX)
422 phydev->duplex = DUPLEX_FULL;
424 phydev->duplex = DUPLEX_HALF;
425 if (val & BMCR_SPEED1000)
426 phydev->speed = SPEED_1000;
427 else if (val & BMCR_SPEED100)
428 phydev->speed = SPEED_100;
429 else phydev->speed = SPEED_10;
432 if (phydev->autoneg == AUTONEG_DISABLE)
433 change_autoneg = true;
434 phydev->autoneg = AUTONEG_ENABLE;
438 phydev->advertising = mii_adv_to_ethtool_adv_t(val);
439 change_autoneg = true;
447 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
448 mii_data->reg_num, val);
450 if (mii_data->phy_id == phydev->mdio.addr &&
451 mii_data->reg_num == MII_BMCR &&
453 return phy_init_hw(phydev);
456 return phy_start_aneg(phydev);
461 if (phydev->drv && phydev->drv->hwtstamp)
462 return phydev->drv->hwtstamp(phydev, ifr);
469 EXPORT_SYMBOL(phy_mii_ioctl);
472 * phy_start_aneg_priv - start auto-negotiation for this PHY device
473 * @phydev: the phy_device struct
474 * @sync: indicate whether we should wait for the workqueue cancelation
476 * Description: Sanitizes the settings (if we're not autonegotiating
477 * them), and then calls the driver's config_aneg function.
478 * If the PHYCONTROL Layer is operating, we change the state to
479 * reflect the beginning of Auto-negotiation or forcing.
481 static int phy_start_aneg_priv(struct phy_device *phydev, bool sync)
489 mutex_lock(&phydev->lock);
491 if (AUTONEG_DISABLE == phydev->autoneg)
492 phy_sanitize_settings(phydev);
494 /* Invalidate LP advertising flags */
495 phydev->lp_advertising = 0;
497 err = phydev->drv->config_aneg(phydev);
501 if (phydev->state != PHY_HALTED) {
502 if (AUTONEG_ENABLE == phydev->autoneg) {
503 phydev->state = PHY_AN;
504 phydev->link_timeout = PHY_AN_TIMEOUT;
506 phydev->state = PHY_FORCING;
507 phydev->link_timeout = PHY_FORCE_TIMEOUT;
511 /* Re-schedule a PHY state machine to check PHY status because
512 * negotiation may already be done and aneg interrupt may not be
515 if (phydev->irq != PHY_POLL && phydev->state == PHY_AN) {
516 err = phy_aneg_done(phydev);
524 mutex_unlock(&phydev->lock);
527 phy_trigger_machine(phydev, sync);
533 * phy_start_aneg - start auto-negotiation for this PHY device
534 * @phydev: the phy_device struct
536 * Description: Sanitizes the settings (if we're not autonegotiating
537 * them), and then calls the driver's config_aneg function.
538 * If the PHYCONTROL Layer is operating, we change the state to
539 * reflect the beginning of Auto-negotiation or forcing.
541 int phy_start_aneg(struct phy_device *phydev)
543 return phy_start_aneg_priv(phydev, true);
545 EXPORT_SYMBOL(phy_start_aneg);
548 * phy_start_machine - start PHY state machine tracking
549 * @phydev: the phy_device struct
551 * Description: The PHY infrastructure can run a state machine
552 * which tracks whether the PHY is starting up, negotiating,
553 * etc. This function starts the delayed workqueue which tracks
554 * the state of the PHY. If you want to maintain your own state machine,
555 * do not call this function.
557 void phy_start_machine(struct phy_device *phydev)
559 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
561 EXPORT_SYMBOL_GPL(phy_start_machine);
564 * phy_trigger_machine - trigger the state machine to run
566 * @phydev: the phy_device struct
567 * @sync: indicate whether we should wait for the workqueue cancelation
569 * Description: There has been a change in state which requires that the
570 * state machine runs.
573 void phy_trigger_machine(struct phy_device *phydev, bool sync)
576 cancel_delayed_work_sync(&phydev->state_queue);
578 cancel_delayed_work(&phydev->state_queue);
579 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
583 * phy_stop_machine - stop the PHY state machine tracking
584 * @phydev: target phy_device struct
586 * Description: Stops the state machine delayed workqueue, sets the
587 * state to UP (unless it wasn't up yet). This function must be
588 * called BEFORE phy_detach.
590 void phy_stop_machine(struct phy_device *phydev)
592 cancel_delayed_work_sync(&phydev->state_queue);
594 mutex_lock(&phydev->lock);
595 if (phydev->state > PHY_UP && phydev->state != PHY_HALTED)
596 phydev->state = PHY_UP;
597 mutex_unlock(&phydev->lock);
601 * phy_error - enter HALTED state for this PHY device
602 * @phydev: target phy_device struct
604 * Moves the PHY to the HALTED state in response to a read
605 * or write error, and tells the controller the link is down.
606 * Must not be called from interrupt context, or while the
607 * phydev->lock is held.
609 static void phy_error(struct phy_device *phydev)
611 mutex_lock(&phydev->lock);
612 phydev->state = PHY_HALTED;
613 mutex_unlock(&phydev->lock);
615 phy_trigger_machine(phydev, false);
619 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
620 * @phydev: target phy_device struct
622 static int phy_disable_interrupts(struct phy_device *phydev)
626 /* Disable PHY interrupts */
627 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
631 /* Clear the interrupt */
632 err = phy_clear_interrupt(phydev);
645 * phy_change - Called by the phy_interrupt to handle PHY changes
646 * @phydev: phy_device struct that interrupted
648 static irqreturn_t phy_change(struct phy_device *phydev)
650 if (phy_interrupt_is_valid(phydev)) {
651 if (phydev->drv->did_interrupt &&
652 !phydev->drv->did_interrupt(phydev))
655 if (phy_disable_interrupts(phydev))
659 mutex_lock(&phydev->lock);
660 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
661 phydev->state = PHY_CHANGELINK;
662 mutex_unlock(&phydev->lock);
664 if (phy_interrupt_is_valid(phydev)) {
665 atomic_dec(&phydev->irq_disable);
666 enable_irq(phydev->irq);
668 /* Reenable interrupts */
669 if (PHY_HALTED != phydev->state &&
670 phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
674 /* reschedule state queue work to run as soon as possible */
675 phy_trigger_machine(phydev, true);
679 atomic_dec(&phydev->irq_disable);
680 enable_irq(phydev->irq);
684 disable_irq(phydev->irq);
685 atomic_inc(&phydev->irq_disable);
692 * phy_change_work - Scheduled by the phy_mac_interrupt to handle PHY changes
693 * @work: work_struct that describes the work to be done
695 void phy_change_work(struct work_struct *work)
697 struct phy_device *phydev =
698 container_of(work, struct phy_device, phy_queue);
704 * phy_interrupt - PHY interrupt handler
705 * @irq: interrupt line
706 * @phy_dat: phy_device pointer
708 * Description: When a PHY interrupt occurs, the handler disables
709 * interrupts, and uses phy_change to handle the interrupt.
711 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
713 struct phy_device *phydev = phy_dat;
715 if (PHY_HALTED == phydev->state)
716 return IRQ_NONE; /* It can't be ours. */
718 disable_irq_nosync(irq);
719 atomic_inc(&phydev->irq_disable);
721 return phy_change(phydev);
725 * phy_enable_interrupts - Enable the interrupts from the PHY side
726 * @phydev: target phy_device struct
728 static int phy_enable_interrupts(struct phy_device *phydev)
730 int err = phy_clear_interrupt(phydev);
735 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
739 * phy_start_interrupts - request and enable interrupts for a PHY device
740 * @phydev: target phy_device struct
742 * Description: Request the interrupt for the given PHY.
743 * If this fails, then we set irq to PHY_POLL.
744 * Otherwise, we enable the interrupts in the PHY.
745 * This should only be called with a valid IRQ number.
746 * Returns 0 on success or < 0 on error.
748 int phy_start_interrupts(struct phy_device *phydev)
750 atomic_set(&phydev->irq_disable, 0);
751 if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
752 IRQF_ONESHOT | IRQF_SHARED,
753 phydev_name(phydev), phydev) < 0) {
754 pr_warn("%s: Can't get IRQ %d (PHY)\n",
755 phydev->mdio.bus->name, phydev->irq);
756 phydev->irq = PHY_POLL;
760 return phy_enable_interrupts(phydev);
762 EXPORT_SYMBOL(phy_start_interrupts);
765 * phy_stop_interrupts - disable interrupts from a PHY device
766 * @phydev: target phy_device struct
768 int phy_stop_interrupts(struct phy_device *phydev)
770 int err = phy_disable_interrupts(phydev);
775 free_irq(phydev->irq, phydev);
777 /* If work indeed has been cancelled, disable_irq() will have
778 * been left unbalanced from phy_interrupt() and enable_irq()
779 * has to be called so that other devices on the line work.
781 while (atomic_dec_return(&phydev->irq_disable) >= 0)
782 enable_irq(phydev->irq);
786 EXPORT_SYMBOL(phy_stop_interrupts);
789 * phy_stop - Bring down the PHY link, and stop checking the status
790 * @phydev: target phy_device struct
792 void phy_stop(struct phy_device *phydev)
794 mutex_lock(&phydev->lock);
796 if (PHY_HALTED == phydev->state)
799 if (phy_interrupt_is_valid(phydev)) {
800 /* Disable PHY Interrupts */
801 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
803 /* Clear any pending interrupts */
804 phy_clear_interrupt(phydev);
807 phydev->state = PHY_HALTED;
810 mutex_unlock(&phydev->lock);
812 /* Cannot call flush_scheduled_work() here as desired because
813 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
814 * will not reenable interrupts.
817 EXPORT_SYMBOL(phy_stop);
820 * phy_start - start or restart a PHY device
821 * @phydev: target phy_device struct
823 * Description: Indicates the attached device's readiness to
824 * handle PHY-related work. Used during startup to start the
825 * PHY, and after a call to phy_stop() to resume operation.
826 * Also used to indicate the MDIO bus has cleared an error
829 void phy_start(struct phy_device *phydev)
833 mutex_lock(&phydev->lock);
835 switch (phydev->state) {
837 phydev->state = PHY_PENDING;
840 phydev->state = PHY_UP;
843 /* if phy was suspended, bring the physical link up again */
844 __phy_resume(phydev);
846 /* make sure interrupts are re-enabled for the PHY */
847 if (phy_interrupt_is_valid(phydev)) {
848 err = phy_enable_interrupts(phydev);
853 phydev->state = PHY_RESUMING;
858 mutex_unlock(&phydev->lock);
860 phy_trigger_machine(phydev, true);
862 EXPORT_SYMBOL(phy_start);
864 static void phy_link_up(struct phy_device *phydev)
866 phydev->phy_link_change(phydev, true, true);
867 phy_led_trigger_change_speed(phydev);
870 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
872 phydev->phy_link_change(phydev, false, do_carrier);
873 phy_led_trigger_change_speed(phydev);
877 * phy_state_machine - Handle the state machine
878 * @work: work_struct that describes the work to be done
880 void phy_state_machine(struct work_struct *work)
882 struct delayed_work *dwork = to_delayed_work(work);
883 struct phy_device *phydev =
884 container_of(dwork, struct phy_device, state_queue);
885 bool needs_aneg = false, do_suspend = false;
886 enum phy_state old_state;
890 mutex_lock(&phydev->lock);
892 old_state = phydev->state;
894 if (phydev->drv && phydev->drv->link_change_notify)
895 phydev->drv->link_change_notify(phydev);
897 switch (phydev->state) {
906 phydev->link_timeout = PHY_AN_TIMEOUT;
910 err = phy_read_status(phydev);
914 /* If the link is down, give up on negotiation for now */
916 phydev->state = PHY_NOLINK;
917 phy_link_down(phydev, true);
921 /* Check if negotiation is done. Break if there's an error */
922 err = phy_aneg_done(phydev);
926 /* If AN is done, we're running */
928 phydev->state = PHY_RUNNING;
930 } else if (0 == phydev->link_timeout--)
934 if (phy_interrupt_is_valid(phydev))
937 err = phy_read_status(phydev);
942 if (AUTONEG_ENABLE == phydev->autoneg) {
943 err = phy_aneg_done(phydev);
948 phydev->state = PHY_AN;
949 phydev->link_timeout = PHY_AN_TIMEOUT;
953 phydev->state = PHY_RUNNING;
958 err = genphy_update_link(phydev);
963 phydev->state = PHY_RUNNING;
966 if (0 == phydev->link_timeout--)
968 phy_link_down(phydev, false);
972 /* Only register a CHANGE if we are polling and link changed
973 * since latest checking.
975 if (phydev->irq == PHY_POLL) {
976 old_link = phydev->link;
977 err = phy_read_status(phydev);
981 if (old_link != phydev->link)
982 phydev->state = PHY_CHANGELINK;
985 * Failsafe: check that nobody set phydev->link=0 between two
986 * poll cycles, otherwise we won't leave RUNNING state as long
987 * as link remains down.
989 if (!phydev->link && phydev->state == PHY_RUNNING) {
990 phydev->state = PHY_CHANGELINK;
991 phydev_err(phydev, "no link in PHY_RUNNING\n");
995 err = phy_read_status(phydev);
1000 phydev->state = PHY_RUNNING;
1001 phy_link_up(phydev);
1003 phydev->state = PHY_NOLINK;
1004 phy_link_down(phydev, true);
1007 if (phy_interrupt_is_valid(phydev))
1008 err = phy_config_interrupt(phydev,
1009 PHY_INTERRUPT_ENABLED);
1014 phy_link_down(phydev, true);
1019 if (AUTONEG_ENABLE == phydev->autoneg) {
1020 err = phy_aneg_done(phydev);
1024 /* err > 0 if AN is done.
1025 * Otherwise, it's 0, and we're still waiting for AN
1028 err = phy_read_status(phydev);
1033 phydev->state = PHY_RUNNING;
1034 phy_link_up(phydev);
1036 phydev->state = PHY_NOLINK;
1037 phy_link_down(phydev, false);
1040 phydev->state = PHY_AN;
1041 phydev->link_timeout = PHY_AN_TIMEOUT;
1044 err = phy_read_status(phydev);
1049 phydev->state = PHY_RUNNING;
1050 phy_link_up(phydev);
1052 phydev->state = PHY_NOLINK;
1053 phy_link_down(phydev, false);
1059 mutex_unlock(&phydev->lock);
1062 err = phy_start_aneg_priv(phydev, false);
1063 else if (do_suspend)
1064 phy_suspend(phydev);
1069 if (old_state != phydev->state)
1070 phydev_dbg(phydev, "PHY state change %s -> %s\n",
1071 phy_state_to_str(old_state),
1072 phy_state_to_str(phydev->state));
1074 /* Only re-schedule a PHY state machine change if we are polling the
1075 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
1076 * between states from phy_mac_interrupt()
1078 if (phydev->irq == PHY_POLL)
1079 queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
1080 PHY_STATE_TIME * HZ);
1084 * phy_mac_interrupt - MAC says the link has changed
1085 * @phydev: phy_device struct with changed link
1086 * @new_link: Link is Up/Down.
1088 * Description: The MAC layer is able indicate there has been a change
1089 * in the PHY link status. Set the new link status, and trigger the
1090 * state machine, work a work queue.
1092 void phy_mac_interrupt(struct phy_device *phydev, int new_link)
1094 phydev->link = new_link;
1096 /* Trigger a state machine change */
1097 queue_work(system_power_efficient_wq, &phydev->phy_queue);
1099 EXPORT_SYMBOL(phy_mac_interrupt);
1102 * phy_init_eee - init and check the EEE feature
1103 * @phydev: target phy_device struct
1104 * @clk_stop_enable: PHY may stop the clock during LPI
1106 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1107 * is supported by looking at the MMD registers 3.20 and 7.60/61
1108 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1111 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1116 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1118 if (phydev->duplex == DUPLEX_FULL) {
1119 int eee_lp, eee_cap, eee_adv;
1123 /* Read phy status to properly get the right settings */
1124 status = phy_read_status(phydev);
1128 /* First check if the EEE ability is supported */
1129 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1133 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1137 /* Check which link settings negotiated and verify it in
1138 * the EEE advertising registers.
1140 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1144 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1148 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1149 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1150 if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1153 if (clk_stop_enable) {
1154 /* Configure the PHY to stop receiving xMII
1155 * clock while it is signaling LPI.
1157 int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1161 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1162 phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1165 return 0; /* EEE supported */
1168 return -EPROTONOSUPPORT;
1170 EXPORT_SYMBOL(phy_init_eee);
1173 * phy_get_eee_err - report the EEE wake error count
1174 * @phydev: target phy_device struct
1176 * Description: it is to report the number of time where the PHY
1177 * failed to complete its normal wake sequence.
1179 int phy_get_eee_err(struct phy_device *phydev)
1184 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1186 EXPORT_SYMBOL(phy_get_eee_err);
1189 * phy_ethtool_get_eee - get EEE supported and status
1190 * @phydev: target phy_device struct
1191 * @data: ethtool_eee data
1193 * Description: it reportes the Supported/Advertisement/LP Advertisement
1196 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1203 /* Get Supported EEE */
1204 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1207 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1209 /* Get advertisement EEE */
1210 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1213 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1215 /* Get LP advertisement EEE */
1216 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1219 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1223 EXPORT_SYMBOL(phy_ethtool_get_eee);
1226 * phy_ethtool_set_eee - set EEE supported and status
1227 * @phydev: target phy_device struct
1228 * @data: ethtool_eee data
1230 * Description: it is to program the Advertisement EEE register.
1232 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1234 int cap, old_adv, adv, ret;
1239 /* Get Supported EEE */
1240 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1244 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1248 adv = ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1250 /* Mask prohibited EEE modes */
1251 adv &= ~phydev->eee_broken_modes;
1253 if (old_adv != adv) {
1254 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1258 /* Restart autonegotiation so the new modes get sent to the
1261 if (phydev->autoneg == AUTONEG_ENABLE) {
1262 ret = phy_restart_aneg(phydev);
1270 EXPORT_SYMBOL(phy_ethtool_set_eee);
1272 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1274 if (phydev->drv && phydev->drv->set_wol)
1275 return phydev->drv->set_wol(phydev, wol);
1279 EXPORT_SYMBOL(phy_ethtool_set_wol);
1281 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1283 if (phydev->drv && phydev->drv->get_wol)
1284 phydev->drv->get_wol(phydev, wol);
1286 EXPORT_SYMBOL(phy_ethtool_get_wol);
1288 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1289 struct ethtool_link_ksettings *cmd)
1291 struct phy_device *phydev = ndev->phydev;
1296 phy_ethtool_ksettings_get(phydev, cmd);
1300 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1302 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1303 const struct ethtool_link_ksettings *cmd)
1305 struct phy_device *phydev = ndev->phydev;
1310 return phy_ethtool_ksettings_set(phydev, cmd);
1312 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1314 int phy_ethtool_nway_reset(struct net_device *ndev)
1316 struct phy_device *phydev = ndev->phydev;
1324 return phy_restart_aneg(phydev);
1326 EXPORT_SYMBOL(phy_ethtool_nway_reset);