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)
51 PHY_STATE_STR(RUNNING)
53 PHY_STATE_STR(FORCING)
54 PHY_STATE_STR(CHANGELINK)
56 PHY_STATE_STR(RESUMING)
62 static void phy_link_up(struct phy_device *phydev)
64 phydev->phy_link_change(phydev, true, true);
65 phy_led_trigger_change_speed(phydev);
68 static void phy_link_down(struct phy_device *phydev, bool do_carrier)
70 phydev->phy_link_change(phydev, false, do_carrier);
71 phy_led_trigger_change_speed(phydev);
75 * phy_print_status - Convenience function to print out the current phy status
76 * @phydev: the phy_device struct
78 void phy_print_status(struct phy_device *phydev)
81 netdev_info(phydev->attached_dev,
82 "Link is Up - %s/%s - flow control %s\n",
83 phy_speed_to_str(phydev->speed),
84 phy_duplex_to_str(phydev->duplex),
85 phydev->pause ? "rx/tx" : "off");
87 netdev_info(phydev->attached_dev, "Link is Down\n");
90 EXPORT_SYMBOL(phy_print_status);
93 * phy_clear_interrupt - Ack the phy device's interrupt
94 * @phydev: the phy_device struct
96 * If the @phydev driver has an ack_interrupt function, call it to
97 * ack and clear the phy device's interrupt.
99 * Returns 0 on success or < 0 on error.
101 static int phy_clear_interrupt(struct phy_device *phydev)
103 if (phydev->drv->ack_interrupt)
104 return phydev->drv->ack_interrupt(phydev);
110 * phy_config_interrupt - configure the PHY device for the requested interrupts
111 * @phydev: the phy_device struct
112 * @interrupts: interrupt flags to configure for this @phydev
114 * Returns 0 on success or < 0 on error.
116 static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
118 phydev->interrupts = interrupts ? 1 : 0;
119 if (phydev->drv->config_intr)
120 return phydev->drv->config_intr(phydev);
126 * phy_restart_aneg - restart auto-negotiation
127 * @phydev: target phy_device struct
129 * Restart the autonegotiation on @phydev. Returns >= 0 on success or
130 * negative errno on error.
132 int phy_restart_aneg(struct phy_device *phydev)
136 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
137 ret = genphy_c45_restart_aneg(phydev);
139 ret = genphy_restart_aneg(phydev);
143 EXPORT_SYMBOL_GPL(phy_restart_aneg);
146 * phy_aneg_done - return auto-negotiation status
147 * @phydev: target phy_device struct
149 * Description: Return the auto-negotiation status from this @phydev
150 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
153 int phy_aneg_done(struct phy_device *phydev)
155 if (phydev->drv && phydev->drv->aneg_done)
156 return phydev->drv->aneg_done(phydev);
158 /* Avoid genphy_aneg_done() if the Clause 45 PHY does not
159 * implement Clause 22 registers
161 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
164 return genphy_aneg_done(phydev);
166 EXPORT_SYMBOL(phy_aneg_done);
169 * phy_find_valid - find a PHY setting that matches the requested parameters
170 * @speed: desired speed
171 * @duplex: desired duplex
172 * @supported: mask of supported link modes
174 * Locate a supported phy setting that is, in priority order:
175 * - an exact match for the specified speed and duplex mode
176 * - a match for the specified speed, or slower speed
177 * - the slowest supported speed
178 * Returns the matched phy_setting entry, or %NULL if no supported phy
179 * settings were found.
181 static const struct phy_setting *
182 phy_find_valid(int speed, int duplex, unsigned long *supported)
184 return phy_lookup_setting(speed, duplex, supported, false);
188 * phy_supported_speeds - return all speeds currently supported by a phy device
189 * @phy: The phy device to return supported speeds of.
190 * @speeds: buffer to store supported speeds in.
191 * @size: size of speeds buffer.
193 * Description: Returns the number of supported speeds, and fills the speeds
194 * buffer with the supported speeds. If speeds buffer is too small to contain
195 * all currently supported speeds, will return as many speeds as can fit.
197 unsigned int phy_supported_speeds(struct phy_device *phy,
198 unsigned int *speeds,
201 return phy_speeds(speeds, size, phy->supported);
205 * phy_check_valid - check if there is a valid PHY setting which matches
206 * speed, duplex, and feature mask
207 * @speed: speed to match
208 * @duplex: duplex to match
209 * @features: A mask of the valid settings
211 * Description: Returns true if there is a valid setting, false otherwise.
213 static inline bool phy_check_valid(int speed, int duplex,
214 unsigned long *features)
216 return !!phy_lookup_setting(speed, duplex, features, true);
220 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
221 * @phydev: the target phy_device struct
223 * Description: Make sure the PHY is set to supported speeds and
224 * duplexes. Drop down by one in this order: 1000/FULL,
225 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
227 static void phy_sanitize_settings(struct phy_device *phydev)
229 const struct phy_setting *setting;
231 /* Sanitize settings based on PHY capabilities */
232 if (linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported))
233 phydev->autoneg = AUTONEG_DISABLE;
235 setting = phy_find_valid(phydev->speed, phydev->duplex,
238 phydev->speed = setting->speed;
239 phydev->duplex = setting->duplex;
241 /* We failed to find anything (no supported speeds?) */
242 phydev->speed = SPEED_UNKNOWN;
243 phydev->duplex = DUPLEX_UNKNOWN;
248 * phy_ethtool_sset - generic ethtool sset function, handles all the details
249 * @phydev: target phy_device struct
252 * A few notes about parameter checking:
254 * - We don't set port or transceiver, so we don't care what they
256 * - phy_start_aneg() will make sure forced settings are sane, and
257 * choose the next best ones from the ones selected, so we don't
258 * care if ethtool tries to give us bad values.
260 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
262 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
263 u32 speed = ethtool_cmd_speed(cmd);
265 if (cmd->phy_address != phydev->mdio.addr)
268 /* We make sure that we don't pass unsupported values in to the PHY */
269 ethtool_convert_legacy_u32_to_link_mode(advertising, cmd->advertising);
270 linkmode_and(advertising, advertising, phydev->supported);
272 /* Verify the settings we care about. */
273 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
276 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
279 if (cmd->autoneg == AUTONEG_DISABLE &&
280 ((speed != SPEED_1000 &&
281 speed != SPEED_100 &&
282 speed != SPEED_10) ||
283 (cmd->duplex != DUPLEX_HALF &&
284 cmd->duplex != DUPLEX_FULL)))
287 phydev->autoneg = cmd->autoneg;
289 phydev->speed = speed;
291 linkmode_copy(phydev->advertising, advertising);
293 if (AUTONEG_ENABLE == cmd->autoneg)
294 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
295 phydev->advertising);
297 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
298 phydev->advertising);
300 phydev->duplex = cmd->duplex;
302 phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
304 /* Restart the PHY */
305 phy_start_aneg(phydev);
309 EXPORT_SYMBOL(phy_ethtool_sset);
311 int phy_ethtool_ksettings_set(struct phy_device *phydev,
312 const struct ethtool_link_ksettings *cmd)
314 __ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
315 u8 autoneg = cmd->base.autoneg;
316 u8 duplex = cmd->base.duplex;
317 u32 speed = cmd->base.speed;
319 if (cmd->base.phy_address != phydev->mdio.addr)
322 linkmode_copy(advertising, cmd->link_modes.advertising);
324 /* We make sure that we don't pass unsupported values in to the PHY */
325 linkmode_and(advertising, advertising, phydev->supported);
327 /* Verify the settings we care about. */
328 if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
331 if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
334 if (autoneg == AUTONEG_DISABLE &&
335 ((speed != SPEED_1000 &&
336 speed != SPEED_100 &&
337 speed != SPEED_10) ||
338 (duplex != DUPLEX_HALF &&
339 duplex != DUPLEX_FULL)))
342 phydev->autoneg = autoneg;
344 phydev->speed = speed;
346 linkmode_copy(phydev->advertising, advertising);
348 if (autoneg == AUTONEG_ENABLE)
349 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
350 phydev->advertising);
352 linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
353 phydev->advertising);
355 phydev->duplex = duplex;
357 phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
359 /* Restart the PHY */
360 phy_start_aneg(phydev);
364 EXPORT_SYMBOL(phy_ethtool_ksettings_set);
366 void phy_ethtool_ksettings_get(struct phy_device *phydev,
367 struct ethtool_link_ksettings *cmd)
369 linkmode_copy(cmd->link_modes.supported, phydev->supported);
370 linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
371 linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
373 cmd->base.speed = phydev->speed;
374 cmd->base.duplex = phydev->duplex;
375 if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
376 cmd->base.port = PORT_BNC;
378 cmd->base.port = PORT_MII;
379 cmd->base.transceiver = phy_is_internal(phydev) ?
380 XCVR_INTERNAL : XCVR_EXTERNAL;
381 cmd->base.phy_address = phydev->mdio.addr;
382 cmd->base.autoneg = phydev->autoneg;
383 cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
384 cmd->base.eth_tp_mdix = phydev->mdix;
386 EXPORT_SYMBOL(phy_ethtool_ksettings_get);
389 * phy_mii_ioctl - generic PHY MII ioctl interface
390 * @phydev: the phy_device struct
391 * @ifr: &struct ifreq for socket ioctl's
392 * @cmd: ioctl cmd to execute
394 * Note that this function is currently incompatible with the
395 * PHYCONTROL layer. It changes registers without regard to
396 * current state. Use at own risk.
398 int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
400 struct mii_ioctl_data *mii_data = if_mii(ifr);
401 u16 val = mii_data->val_in;
402 bool change_autoneg = false;
406 mii_data->phy_id = phydev->mdio.addr;
410 mii_data->val_out = mdiobus_read(phydev->mdio.bus,
416 if (mii_data->phy_id == phydev->mdio.addr) {
417 switch (mii_data->reg_num) {
419 if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
420 if (phydev->autoneg == AUTONEG_ENABLE)
421 change_autoneg = true;
422 phydev->autoneg = AUTONEG_DISABLE;
423 if (val & BMCR_FULLDPLX)
424 phydev->duplex = DUPLEX_FULL;
426 phydev->duplex = DUPLEX_HALF;
427 if (val & BMCR_SPEED1000)
428 phydev->speed = SPEED_1000;
429 else if (val & BMCR_SPEED100)
430 phydev->speed = SPEED_100;
431 else phydev->speed = SPEED_10;
434 if (phydev->autoneg == AUTONEG_DISABLE)
435 change_autoneg = true;
436 phydev->autoneg = AUTONEG_ENABLE;
440 mii_adv_mod_linkmode_adv_t(phydev->advertising,
442 change_autoneg = true;
450 mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
451 mii_data->reg_num, val);
453 if (mii_data->phy_id == phydev->mdio.addr &&
454 mii_data->reg_num == MII_BMCR &&
456 return phy_init_hw(phydev);
459 return phy_start_aneg(phydev);
464 if (phydev->drv && phydev->drv->hwtstamp)
465 return phydev->drv->hwtstamp(phydev, ifr);
472 EXPORT_SYMBOL(phy_mii_ioctl);
474 static void phy_queue_state_machine(struct phy_device *phydev,
477 mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
481 static void phy_trigger_machine(struct phy_device *phydev)
483 phy_queue_state_machine(phydev, 0);
486 static int phy_config_aneg(struct phy_device *phydev)
488 if (phydev->drv->config_aneg)
489 return phydev->drv->config_aneg(phydev);
491 /* Clause 45 PHYs that don't implement Clause 22 registers are not
492 * allowed to call genphy_config_aneg()
494 if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
497 return genphy_config_aneg(phydev);
501 * phy_check_link_status - check link status and set state accordingly
502 * @phydev: the phy_device struct
504 * Description: Check for link and whether autoneg was triggered / is running
505 * and set state accordingly
507 static int phy_check_link_status(struct phy_device *phydev)
511 WARN_ON(!mutex_is_locked(&phydev->lock));
513 err = phy_read_status(phydev);
517 if (phydev->link && phydev->state != PHY_RUNNING) {
518 phydev->state = PHY_RUNNING;
520 } else if (!phydev->link && phydev->state != PHY_NOLINK) {
521 phydev->state = PHY_NOLINK;
522 phy_link_down(phydev, true);
529 * phy_start_aneg - start auto-negotiation for this PHY device
530 * @phydev: the phy_device struct
532 * Description: Sanitizes the settings (if we're not autonegotiating
533 * them), and then calls the driver's config_aneg function.
534 * If the PHYCONTROL Layer is operating, we change the state to
535 * reflect the beginning of Auto-negotiation or forcing.
537 int phy_start_aneg(struct phy_device *phydev)
544 mutex_lock(&phydev->lock);
546 if (AUTONEG_DISABLE == phydev->autoneg)
547 phy_sanitize_settings(phydev);
549 /* Invalidate LP advertising flags */
550 linkmode_zero(phydev->lp_advertising);
552 err = phy_config_aneg(phydev);
556 if (__phy_is_started(phydev)) {
557 if (phydev->autoneg == AUTONEG_ENABLE) {
558 err = phy_check_link_status(phydev);
560 phydev->state = PHY_FORCING;
561 phydev->link_timeout = PHY_FORCE_TIMEOUT;
566 mutex_unlock(&phydev->lock);
570 EXPORT_SYMBOL(phy_start_aneg);
572 static int phy_poll_aneg_done(struct phy_device *phydev)
574 unsigned int retries = 100;
579 ret = phy_aneg_done(phydev);
580 } while (!ret && --retries);
585 return ret < 0 ? ret : 0;
589 * phy_speed_down - set speed to lowest speed supported by both link partners
590 * @phydev: the phy_device struct
591 * @sync: perform action synchronously
593 * Description: Typically used to save energy when waiting for a WoL packet
595 * WARNING: Setting sync to false may cause the system being unable to suspend
596 * in case the PHY generates an interrupt when finishing the autonegotiation.
597 * This interrupt may wake up the system immediately after suspend.
598 * Therefore use sync = false only if you're sure it's safe with the respective
601 int phy_speed_down(struct phy_device *phydev, bool sync)
603 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
604 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
607 if (phydev->autoneg != AUTONEG_ENABLE)
610 linkmode_copy(adv_old, phydev->advertising);
611 linkmode_copy(adv, phydev->lp_advertising);
612 linkmode_and(adv, adv, phydev->supported);
614 if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, adv) ||
615 linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, adv)) {
616 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
617 phydev->advertising);
618 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
619 phydev->advertising);
620 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
621 phydev->advertising);
622 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
623 phydev->advertising);
624 } else if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
626 linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
628 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
629 phydev->advertising);
630 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
631 phydev->advertising);
634 if (linkmode_equal(phydev->advertising, adv_old))
637 ret = phy_config_aneg(phydev);
641 return sync ? phy_poll_aneg_done(phydev) : 0;
643 EXPORT_SYMBOL_GPL(phy_speed_down);
646 * phy_speed_up - (re)set advertised speeds to all supported speeds
647 * @phydev: the phy_device struct
649 * Description: Used to revert the effect of phy_speed_down
651 int phy_speed_up(struct phy_device *phydev)
653 __ETHTOOL_DECLARE_LINK_MODE_MASK(all_speeds) = { 0, };
654 __ETHTOOL_DECLARE_LINK_MODE_MASK(not_speeds);
655 __ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
656 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
657 __ETHTOOL_DECLARE_LINK_MODE_MASK(speeds);
659 linkmode_copy(adv_old, phydev->advertising);
661 if (phydev->autoneg != AUTONEG_ENABLE)
664 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, all_speeds);
665 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, all_speeds);
666 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, all_speeds);
667 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, all_speeds);
668 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, all_speeds);
669 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, all_speeds);
671 linkmode_andnot(not_speeds, adv_old, all_speeds);
672 linkmode_copy(supported, phydev->supported);
673 linkmode_and(speeds, supported, all_speeds);
674 linkmode_or(phydev->advertising, not_speeds, speeds);
676 if (linkmode_equal(phydev->advertising, adv_old))
679 return phy_config_aneg(phydev);
681 EXPORT_SYMBOL_GPL(phy_speed_up);
684 * phy_start_machine - start PHY state machine tracking
685 * @phydev: the phy_device struct
687 * Description: The PHY infrastructure can run a state machine
688 * which tracks whether the PHY is starting up, negotiating,
689 * etc. This function starts the delayed workqueue which tracks
690 * the state of the PHY. If you want to maintain your own state machine,
691 * do not call this function.
693 void phy_start_machine(struct phy_device *phydev)
695 phy_trigger_machine(phydev);
697 EXPORT_SYMBOL_GPL(phy_start_machine);
700 * phy_stop_machine - stop the PHY state machine tracking
701 * @phydev: target phy_device struct
703 * Description: Stops the state machine delayed workqueue, sets the
704 * state to UP (unless it wasn't up yet). This function must be
705 * called BEFORE phy_detach.
707 void phy_stop_machine(struct phy_device *phydev)
709 cancel_delayed_work_sync(&phydev->state_queue);
711 mutex_lock(&phydev->lock);
712 if (__phy_is_started(phydev))
713 phydev->state = PHY_UP;
714 mutex_unlock(&phydev->lock);
718 * phy_error - enter HALTED state for this PHY device
719 * @phydev: target phy_device struct
721 * Moves the PHY to the HALTED state in response to a read
722 * or write error, and tells the controller the link is down.
723 * Must not be called from interrupt context, or while the
724 * phydev->lock is held.
726 static void phy_error(struct phy_device *phydev)
730 mutex_lock(&phydev->lock);
731 phydev->state = PHY_HALTED;
732 mutex_unlock(&phydev->lock);
734 phy_trigger_machine(phydev);
738 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
739 * @phydev: target phy_device struct
741 static int phy_disable_interrupts(struct phy_device *phydev)
745 /* Disable PHY interrupts */
746 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
750 /* Clear the interrupt */
751 return phy_clear_interrupt(phydev);
755 * phy_interrupt - PHY interrupt handler
756 * @irq: interrupt line
757 * @phy_dat: phy_device pointer
759 * Description: Handle PHY interrupt
761 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
763 struct phy_device *phydev = phy_dat;
765 if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
768 /* reschedule state queue work to run as soon as possible */
769 phy_trigger_machine(phydev);
771 if (phy_clear_interrupt(phydev))
781 * phy_enable_interrupts - Enable the interrupts from the PHY side
782 * @phydev: target phy_device struct
784 static int phy_enable_interrupts(struct phy_device *phydev)
786 int err = phy_clear_interrupt(phydev);
791 return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
795 * phy_start_interrupts - request and enable interrupts for a PHY device
796 * @phydev: target phy_device struct
798 * Description: Request the interrupt for the given PHY.
799 * If this fails, then we set irq to PHY_POLL.
800 * Otherwise, we enable the interrupts in the PHY.
801 * This should only be called with a valid IRQ number.
802 * Returns 0 on success or < 0 on error.
804 int phy_start_interrupts(struct phy_device *phydev)
806 if (request_threaded_irq(phydev->irq, NULL, phy_interrupt,
807 IRQF_ONESHOT | IRQF_SHARED,
808 phydev_name(phydev), phydev) < 0) {
809 pr_warn("%s: Can't get IRQ %d (PHY)\n",
810 phydev->mdio.bus->name, phydev->irq);
811 phydev->irq = PHY_POLL;
815 return phy_enable_interrupts(phydev);
817 EXPORT_SYMBOL(phy_start_interrupts);
820 * phy_stop_interrupts - disable interrupts from a PHY device
821 * @phydev: target phy_device struct
823 int phy_stop_interrupts(struct phy_device *phydev)
825 int err = phy_disable_interrupts(phydev);
830 free_irq(phydev->irq, phydev);
834 EXPORT_SYMBOL(phy_stop_interrupts);
837 * phy_stop - Bring down the PHY link, and stop checking the status
838 * @phydev: target phy_device struct
840 void phy_stop(struct phy_device *phydev)
842 mutex_lock(&phydev->lock);
844 if (!__phy_is_started(phydev)) {
845 WARN(1, "called from state %s\n",
846 phy_state_to_str(phydev->state));
847 mutex_unlock(&phydev->lock);
851 if (phy_interrupt_is_valid(phydev))
852 phy_disable_interrupts(phydev);
854 phydev->state = PHY_HALTED;
856 mutex_unlock(&phydev->lock);
858 phy_state_machine(&phydev->state_queue.work);
860 /* Cannot call flush_scheduled_work() here as desired because
861 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
862 * will not reenable interrupts.
865 EXPORT_SYMBOL(phy_stop);
868 * phy_start - start or restart a PHY device
869 * @phydev: target phy_device struct
871 * Description: Indicates the attached device's readiness to
872 * handle PHY-related work. Used during startup to start the
873 * PHY, and after a call to phy_stop() to resume operation.
874 * Also used to indicate the MDIO bus has cleared an error
877 void phy_start(struct phy_device *phydev)
881 mutex_lock(&phydev->lock);
883 switch (phydev->state) {
885 phydev->state = PHY_UP;
888 /* if phy was suspended, bring the physical link up again */
889 __phy_resume(phydev);
891 /* make sure interrupts are re-enabled for the PHY */
892 if (phy_interrupt_is_valid(phydev)) {
893 err = phy_enable_interrupts(phydev);
898 phydev->state = PHY_RESUMING;
903 mutex_unlock(&phydev->lock);
905 phy_trigger_machine(phydev);
907 EXPORT_SYMBOL(phy_start);
910 * phy_state_machine - Handle the state machine
911 * @work: work_struct that describes the work to be done
913 void phy_state_machine(struct work_struct *work)
915 struct delayed_work *dwork = to_delayed_work(work);
916 struct phy_device *phydev =
917 container_of(dwork, struct phy_device, state_queue);
918 bool needs_aneg = false, do_suspend = false;
919 enum phy_state old_state;
922 mutex_lock(&phydev->lock);
924 old_state = phydev->state;
926 if (phydev->drv && phydev->drv->link_change_notify)
927 phydev->drv->link_change_notify(phydev);
929 switch (phydev->state) {
941 err = phy_check_link_status(phydev);
944 err = genphy_update_link(phydev);
949 phydev->state = PHY_RUNNING;
952 if (0 == phydev->link_timeout--)
954 phy_link_down(phydev, false);
960 phy_link_down(phydev, true);
966 mutex_unlock(&phydev->lock);
969 err = phy_start_aneg(phydev);
976 if (old_state != phydev->state)
977 phydev_dbg(phydev, "PHY state change %s -> %s\n",
978 phy_state_to_str(old_state),
979 phy_state_to_str(phydev->state));
981 /* Only re-schedule a PHY state machine change if we are polling the
982 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
983 * between states from phy_mac_interrupt().
985 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
986 * state machine would be pointless and possibly error prone when
987 * called from phy_disconnect() synchronously.
989 if (phy_polling_mode(phydev) && phy_is_started(phydev))
990 phy_queue_state_machine(phydev, PHY_STATE_TIME);
994 * phy_mac_interrupt - MAC says the link has changed
995 * @phydev: phy_device struct with changed link
997 * The MAC layer is able to indicate there has been a change in the PHY link
998 * status. Trigger the state machine and work a work queue.
1000 void phy_mac_interrupt(struct phy_device *phydev)
1002 /* Trigger a state machine change */
1003 phy_trigger_machine(phydev);
1005 EXPORT_SYMBOL(phy_mac_interrupt);
1007 static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
1009 linkmode_zero(advertising);
1011 if (eee_adv & MDIO_EEE_100TX)
1012 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1014 if (eee_adv & MDIO_EEE_1000T)
1015 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1017 if (eee_adv & MDIO_EEE_10GT)
1018 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
1020 if (eee_adv & MDIO_EEE_1000KX)
1021 linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
1023 if (eee_adv & MDIO_EEE_10GKX4)
1024 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
1026 if (eee_adv & MDIO_EEE_10GKR)
1027 linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
1032 * phy_init_eee - init and check the EEE feature
1033 * @phydev: target phy_device struct
1034 * @clk_stop_enable: PHY may stop the clock during LPI
1036 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1037 * is supported by looking at the MMD registers 3.20 and 7.60/61
1038 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1041 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1046 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1048 if (phydev->duplex == DUPLEX_FULL) {
1049 __ETHTOOL_DECLARE_LINK_MODE_MASK(common);
1050 __ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
1051 __ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1052 int eee_lp, eee_cap, eee_adv;
1056 /* Read phy status to properly get the right settings */
1057 status = phy_read_status(phydev);
1061 /* First check if the EEE ability is supported */
1062 eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1066 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1070 /* Check which link settings negotiated and verify it in
1071 * the EEE advertising registers.
1073 eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1077 eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1081 mmd_eee_adv_to_linkmode(adv, eee_adv);
1082 mmd_eee_adv_to_linkmode(lp, eee_lp);
1083 linkmode_and(common, adv, lp);
1085 if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1088 if (clk_stop_enable) {
1089 /* Configure the PHY to stop receiving xMII
1090 * clock while it is signaling LPI.
1092 int val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1);
1096 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1097 phy_write_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1, val);
1100 return 0; /* EEE supported */
1103 return -EPROTONOSUPPORT;
1105 EXPORT_SYMBOL(phy_init_eee);
1108 * phy_get_eee_err - report the EEE wake error count
1109 * @phydev: target phy_device struct
1111 * Description: it is to report the number of time where the PHY
1112 * failed to complete its normal wake sequence.
1114 int phy_get_eee_err(struct phy_device *phydev)
1119 return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1121 EXPORT_SYMBOL(phy_get_eee_err);
1124 * phy_ethtool_get_eee - get EEE supported and status
1125 * @phydev: target phy_device struct
1126 * @data: ethtool_eee data
1128 * Description: it reportes the Supported/Advertisement/LP Advertisement
1131 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1138 /* Get Supported EEE */
1139 val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1142 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1144 /* Get advertisement EEE */
1145 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1148 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1149 data->eee_enabled = !!data->advertised;
1151 /* Get LP advertisement EEE */
1152 val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1155 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1157 data->eee_active = !!(data->advertised & data->lp_advertised);
1161 EXPORT_SYMBOL(phy_ethtool_get_eee);
1164 * phy_ethtool_set_eee - set EEE supported and status
1165 * @phydev: target phy_device struct
1166 * @data: ethtool_eee data
1168 * Description: it is to program the Advertisement EEE register.
1170 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1172 int cap, old_adv, adv = 0, ret;
1177 /* Get Supported EEE */
1178 cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1182 old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1186 if (data->eee_enabled) {
1187 adv = !data->advertised ? cap :
1188 ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
1189 /* Mask prohibited EEE modes */
1190 adv &= ~phydev->eee_broken_modes;
1193 if (old_adv != adv) {
1194 ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1198 /* Restart autonegotiation so the new modes get sent to the
1201 ret = phy_restart_aneg(phydev);
1208 EXPORT_SYMBOL(phy_ethtool_set_eee);
1210 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1212 if (phydev->drv && phydev->drv->set_wol)
1213 return phydev->drv->set_wol(phydev, wol);
1217 EXPORT_SYMBOL(phy_ethtool_set_wol);
1219 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1221 if (phydev->drv && phydev->drv->get_wol)
1222 phydev->drv->get_wol(phydev, wol);
1224 EXPORT_SYMBOL(phy_ethtool_get_wol);
1226 int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1227 struct ethtool_link_ksettings *cmd)
1229 struct phy_device *phydev = ndev->phydev;
1234 phy_ethtool_ksettings_get(phydev, cmd);
1238 EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1240 int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1241 const struct ethtool_link_ksettings *cmd)
1243 struct phy_device *phydev = ndev->phydev;
1248 return phy_ethtool_ksettings_set(phydev, cmd);
1250 EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1252 int phy_ethtool_nway_reset(struct net_device *ndev)
1254 struct phy_device *phydev = ndev->phydev;
1262 return phy_restart_aneg(phydev);
1264 EXPORT_SYMBOL(phy_ethtool_nway_reset);