2 * drivers/net/phy/phy.c
4 * Framework for configuring and reading PHY devices
5 * Based on code in sungem_phy.c and gianfar_phy.c
9 * Copyright (c) 2004 Freescale Semiconductor, Inc.
10 * Copyright (c) 2006, 2007 Maciej W. Rozycki
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version.
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/init.h>
24 #include <linux/delay.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/skbuff.h>
29 #include <linux/module.h>
30 #include <linux/mii.h>
31 #include <linux/ethtool.h>
32 #include <linux/phy.h>
33 #include <linux/timer.h>
34 #include <linux/workqueue.h>
36 #include <asm/atomic.h>
39 #include <asm/uaccess.h>
42 * phy_print_status - Convenience function to print out the current phy status
43 * @phydev: the phy_device struct
45 void phy_print_status(struct phy_device *phydev)
47 pr_info("PHY: %s - Link is %s", dev_name(&phydev->dev),
48 phydev->link ? "Up" : "Down");
50 printk(" - %d/%s", phydev->speed,
51 DUPLEX_FULL == phydev->duplex ?
56 EXPORT_SYMBOL(phy_print_status);
60 * phy_clear_interrupt - Ack the phy device's interrupt
61 * @phydev: the phy_device struct
63 * If the @phydev driver has an ack_interrupt function, call it to
64 * ack and clear the phy device's interrupt.
66 * Returns 0 on success on < 0 on error.
68 int phy_clear_interrupt(struct phy_device *phydev)
72 if (phydev->drv->ack_interrupt)
73 err = phydev->drv->ack_interrupt(phydev);
79 * phy_config_interrupt - configure the PHY device for the requested interrupts
80 * @phydev: the phy_device struct
81 * @interrupts: interrupt flags to configure for this @phydev
83 * Returns 0 on success on < 0 on error.
85 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
89 phydev->interrupts = interrupts;
90 if (phydev->drv->config_intr)
91 err = phydev->drv->config_intr(phydev);
98 * phy_aneg_done - return auto-negotiation status
99 * @phydev: target phy_device struct
101 * Description: Reads the status register and returns 0 either if
102 * auto-negotiation is incomplete, or if there was an error.
103 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
105 static inline int phy_aneg_done(struct phy_device *phydev)
109 retval = phy_read(phydev, MII_BMSR);
111 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
114 /* A structure for mapping a particular speed and duplex
115 * combination to a particular SUPPORTED and ADVERTISED value */
122 /* A mapping of all SUPPORTED settings to speed/duplex */
123 static const struct phy_setting settings[] = {
126 .duplex = DUPLEX_FULL,
127 .setting = SUPPORTED_10000baseT_Full,
131 .duplex = DUPLEX_FULL,
132 .setting = SUPPORTED_1000baseT_Full,
136 .duplex = DUPLEX_HALF,
137 .setting = SUPPORTED_1000baseT_Half,
141 .duplex = DUPLEX_FULL,
142 .setting = SUPPORTED_100baseT_Full,
146 .duplex = DUPLEX_HALF,
147 .setting = SUPPORTED_100baseT_Half,
151 .duplex = DUPLEX_FULL,
152 .setting = SUPPORTED_10baseT_Full,
156 .duplex = DUPLEX_HALF,
157 .setting = SUPPORTED_10baseT_Half,
161 #define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
164 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
165 * @speed: speed to match
166 * @duplex: duplex to match
168 * Description: Searches the settings array for the setting which
169 * matches the desired speed and duplex, and returns the index
170 * of that setting. Returns the index of the last setting if
171 * none of the others match.
173 static inline int phy_find_setting(int speed, int duplex)
177 while (idx < ARRAY_SIZE(settings) &&
178 (settings[idx].speed != speed ||
179 settings[idx].duplex != duplex))
182 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
186 * phy_find_valid - find a PHY setting that matches the requested features mask
187 * @idx: The first index in settings[] to search
188 * @features: A mask of the valid settings
190 * Description: Returns the index of the first valid setting less
191 * than or equal to the one pointed to by idx, as determined by
192 * the mask in features. Returns the index of the last setting
193 * if nothing else matches.
195 static inline int phy_find_valid(int idx, u32 features)
197 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
200 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
204 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
205 * @phydev: the target phy_device struct
207 * Description: Make sure the PHY is set to supported speeds and
208 * duplexes. Drop down by one in this order: 1000/FULL,
209 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
211 void phy_sanitize_settings(struct phy_device *phydev)
213 u32 features = phydev->supported;
216 /* Sanitize settings based on PHY capabilities */
217 if ((features & SUPPORTED_Autoneg) == 0)
218 phydev->autoneg = AUTONEG_DISABLE;
220 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
223 phydev->speed = settings[idx].speed;
224 phydev->duplex = settings[idx].duplex;
226 EXPORT_SYMBOL(phy_sanitize_settings);
229 * phy_ethtool_sset - generic ethtool sset function, handles all the details
230 * @phydev: target phy_device struct
233 * A few notes about parameter checking:
234 * - We don't set port or transceiver, so we don't care what they
236 * - phy_start_aneg() will make sure forced settings are sane, and
237 * choose the next best ones from the ones selected, so we don't
238 * care if ethtool tries to give us bad values.
240 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
242 if (cmd->phy_address != phydev->addr)
245 /* We make sure that we don't pass unsupported
246 * values in to the PHY */
247 cmd->advertising &= phydev->supported;
249 /* Verify the settings we care about. */
250 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
253 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
256 if (cmd->autoneg == AUTONEG_DISABLE &&
257 ((cmd->speed != SPEED_1000 &&
258 cmd->speed != SPEED_100 &&
259 cmd->speed != SPEED_10) ||
260 (cmd->duplex != DUPLEX_HALF &&
261 cmd->duplex != DUPLEX_FULL)))
264 phydev->autoneg = cmd->autoneg;
266 phydev->speed = cmd->speed;
268 phydev->advertising = cmd->advertising;
270 if (AUTONEG_ENABLE == cmd->autoneg)
271 phydev->advertising |= ADVERTISED_Autoneg;
273 phydev->advertising &= ~ADVERTISED_Autoneg;
275 phydev->duplex = cmd->duplex;
277 /* Restart the PHY */
278 phy_start_aneg(phydev);
282 EXPORT_SYMBOL(phy_ethtool_sset);
284 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
286 cmd->supported = phydev->supported;
288 cmd->advertising = phydev->advertising;
290 cmd->speed = phydev->speed;
291 cmd->duplex = phydev->duplex;
292 cmd->port = PORT_MII;
293 cmd->phy_address = phydev->addr;
294 cmd->transceiver = XCVR_EXTERNAL;
295 cmd->autoneg = phydev->autoneg;
299 EXPORT_SYMBOL(phy_ethtool_gset);
302 * phy_mii_ioctl - generic PHY MII ioctl interface
303 * @phydev: the phy_device struct
304 * @ifr: &struct ifreq for socket ioctl's
305 * @cmd: ioctl cmd to execute
307 * Note that this function is currently incompatible with the
308 * PHYCONTROL layer. It changes registers without regard to
309 * current state. Use at own risk.
311 int phy_mii_ioctl(struct phy_device *phydev,
312 struct ifreq *ifr, int cmd)
314 struct mii_ioctl_data *mii_data = if_mii(ifr);
315 u16 val = mii_data->val_in;
319 mii_data->phy_id = phydev->addr;
323 mii_data->val_out = phy_read(phydev, mii_data->reg_num);
327 if (mii_data->phy_id == phydev->addr) {
328 switch(mii_data->reg_num) {
330 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
331 phydev->autoneg = AUTONEG_DISABLE;
333 phydev->autoneg = AUTONEG_ENABLE;
334 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
335 phydev->duplex = DUPLEX_FULL;
337 phydev->duplex = DUPLEX_HALF;
338 if ((!phydev->autoneg) &&
339 (val & BMCR_SPEED1000))
340 phydev->speed = SPEED_1000;
341 else if ((!phydev->autoneg) &&
342 (val & BMCR_SPEED100))
343 phydev->speed = SPEED_100;
346 phydev->advertising = val;
354 phy_write(phydev, mii_data->reg_num, val);
356 if (mii_data->reg_num == MII_BMCR &&
358 phydev->drv->config_init) {
359 phy_scan_fixups(phydev);
360 phydev->drv->config_init(phydev);
365 if (phydev->drv->hwtstamp)
366 return phydev->drv->hwtstamp(phydev, ifr);
375 EXPORT_SYMBOL(phy_mii_ioctl);
378 * phy_start_aneg - start auto-negotiation for this PHY device
379 * @phydev: the phy_device struct
381 * Description: Sanitizes the settings (if we're not autonegotiating
382 * them), and then calls the driver's config_aneg function.
383 * If the PHYCONTROL Layer is operating, we change the state to
384 * reflect the beginning of Auto-negotiation or forcing.
386 int phy_start_aneg(struct phy_device *phydev)
390 mutex_lock(&phydev->lock);
392 if (AUTONEG_DISABLE == phydev->autoneg)
393 phy_sanitize_settings(phydev);
395 err = phydev->drv->config_aneg(phydev);
400 if (phydev->state != PHY_HALTED) {
401 if (AUTONEG_ENABLE == phydev->autoneg) {
402 phydev->state = PHY_AN;
403 phydev->link_timeout = PHY_AN_TIMEOUT;
405 phydev->state = PHY_FORCING;
406 phydev->link_timeout = PHY_FORCE_TIMEOUT;
411 mutex_unlock(&phydev->lock);
414 EXPORT_SYMBOL(phy_start_aneg);
417 static void phy_change(struct work_struct *work);
420 * phy_start_machine - start PHY state machine tracking
421 * @phydev: the phy_device struct
422 * @handler: callback function for state change notifications
424 * Description: The PHY infrastructure can run a state machine
425 * which tracks whether the PHY is starting up, negotiating,
426 * etc. This function starts the timer which tracks the state
427 * of the PHY. If you want to be notified when the state changes,
428 * pass in the callback @handler, otherwise, pass NULL. If you
429 * want to maintain your own state machine, do not call this
432 void phy_start_machine(struct phy_device *phydev,
433 void (*handler)(struct net_device *))
435 phydev->adjust_state = handler;
437 schedule_delayed_work(&phydev->state_queue, HZ);
441 * phy_stop_machine - stop the PHY state machine tracking
442 * @phydev: target phy_device struct
444 * Description: Stops the state machine timer, sets the state to UP
445 * (unless it wasn't up yet). This function must be called BEFORE
448 void phy_stop_machine(struct phy_device *phydev)
450 cancel_delayed_work_sync(&phydev->state_queue);
452 mutex_lock(&phydev->lock);
453 if (phydev->state > PHY_UP)
454 phydev->state = PHY_UP;
455 mutex_unlock(&phydev->lock);
457 phydev->adjust_state = NULL;
461 * phy_force_reduction - reduce PHY speed/duplex settings by one step
462 * @phydev: target phy_device struct
464 * Description: Reduces the speed/duplex settings by one notch,
466 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
467 * The function bottoms out at 10/HALF.
469 static void phy_force_reduction(struct phy_device *phydev)
473 idx = phy_find_setting(phydev->speed, phydev->duplex);
477 idx = phy_find_valid(idx, phydev->supported);
479 phydev->speed = settings[idx].speed;
480 phydev->duplex = settings[idx].duplex;
482 pr_info("Trying %d/%s\n", phydev->speed,
483 DUPLEX_FULL == phydev->duplex ?
489 * phy_error - enter HALTED state for this PHY device
490 * @phydev: target phy_device struct
492 * Moves the PHY to the HALTED state in response to a read
493 * or write error, and tells the controller the link is down.
494 * Must not be called from interrupt context, or while the
495 * phydev->lock is held.
497 static void phy_error(struct phy_device *phydev)
499 mutex_lock(&phydev->lock);
500 phydev->state = PHY_HALTED;
501 mutex_unlock(&phydev->lock);
505 * phy_interrupt - PHY interrupt handler
506 * @irq: interrupt line
507 * @phy_dat: phy_device pointer
509 * Description: When a PHY interrupt occurs, the handler disables
510 * interrupts, and schedules a work task to clear the interrupt.
512 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
514 struct phy_device *phydev = phy_dat;
516 if (PHY_HALTED == phydev->state)
517 return IRQ_NONE; /* It can't be ours. */
519 /* The MDIO bus is not allowed to be written in interrupt
520 * context, so we need to disable the irq here. A work
521 * queue will write the PHY to disable and clear the
522 * interrupt, and then reenable the irq line. */
523 disable_irq_nosync(irq);
524 atomic_inc(&phydev->irq_disable);
526 schedule_work(&phydev->phy_queue);
532 * phy_enable_interrupts - Enable the interrupts from the PHY side
533 * @phydev: target phy_device struct
535 int phy_enable_interrupts(struct phy_device *phydev)
539 err = phy_clear_interrupt(phydev);
544 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
548 EXPORT_SYMBOL(phy_enable_interrupts);
551 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
552 * @phydev: target phy_device struct
554 int phy_disable_interrupts(struct phy_device *phydev)
558 /* Disable PHY interrupts */
559 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
564 /* Clear the interrupt */
565 err = phy_clear_interrupt(phydev);
577 EXPORT_SYMBOL(phy_disable_interrupts);
580 * phy_start_interrupts - request and enable interrupts for a PHY device
581 * @phydev: target phy_device struct
583 * Description: Request the interrupt for the given PHY.
584 * If this fails, then we set irq to PHY_POLL.
585 * Otherwise, we enable the interrupts in the PHY.
586 * This should only be called with a valid IRQ number.
587 * Returns 0 on success or < 0 on error.
589 int phy_start_interrupts(struct phy_device *phydev)
593 INIT_WORK(&phydev->phy_queue, phy_change);
595 atomic_set(&phydev->irq_disable, 0);
596 if (request_irq(phydev->irq, phy_interrupt,
600 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
603 phydev->irq = PHY_POLL;
607 err = phy_enable_interrupts(phydev);
611 EXPORT_SYMBOL(phy_start_interrupts);
614 * phy_stop_interrupts - disable interrupts from a PHY device
615 * @phydev: target phy_device struct
617 int phy_stop_interrupts(struct phy_device *phydev)
621 err = phy_disable_interrupts(phydev);
626 free_irq(phydev->irq, phydev);
629 * Cannot call flush_scheduled_work() here as desired because
630 * of rtnl_lock(), but we do not really care about what would
631 * be done, except from enable_irq(), so cancel any work
632 * possibly pending and take care of the matter below.
634 cancel_work_sync(&phydev->phy_queue);
636 * If work indeed has been cancelled, disable_irq() will have
637 * been left unbalanced from phy_interrupt() and enable_irq()
638 * has to be called so that other devices on the line work.
640 while (atomic_dec_return(&phydev->irq_disable) >= 0)
641 enable_irq(phydev->irq);
645 EXPORT_SYMBOL(phy_stop_interrupts);
649 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
650 * @work: work_struct that describes the work to be done
652 static void phy_change(struct work_struct *work)
655 struct phy_device *phydev =
656 container_of(work, struct phy_device, phy_queue);
658 if (phydev->drv->did_interrupt &&
659 !phydev->drv->did_interrupt(phydev))
662 err = phy_disable_interrupts(phydev);
667 mutex_lock(&phydev->lock);
668 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
669 phydev->state = PHY_CHANGELINK;
670 mutex_unlock(&phydev->lock);
672 atomic_dec(&phydev->irq_disable);
673 enable_irq(phydev->irq);
675 /* Reenable interrupts */
676 if (PHY_HALTED != phydev->state)
677 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
682 /* reschedule state queue work to run as soon as possible */
683 cancel_delayed_work_sync(&phydev->state_queue);
684 schedule_delayed_work(&phydev->state_queue, 0);
689 atomic_dec(&phydev->irq_disable);
690 enable_irq(phydev->irq);
694 disable_irq(phydev->irq);
695 atomic_inc(&phydev->irq_disable);
701 * phy_stop - Bring down the PHY link, and stop checking the status
702 * @phydev: target phy_device struct
704 void phy_stop(struct phy_device *phydev)
706 mutex_lock(&phydev->lock);
708 if (PHY_HALTED == phydev->state)
711 if (phydev->irq != PHY_POLL) {
712 /* Disable PHY Interrupts */
713 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
715 /* Clear any pending interrupts */
716 phy_clear_interrupt(phydev);
719 phydev->state = PHY_HALTED;
722 mutex_unlock(&phydev->lock);
725 * Cannot call flush_scheduled_work() here as desired because
726 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
727 * will not reenable interrupts.
733 * phy_start - start or restart a PHY device
734 * @phydev: target phy_device struct
736 * Description: Indicates the attached device's readiness to
737 * handle PHY-related work. Used during startup to start the
738 * PHY, and after a call to phy_stop() to resume operation.
739 * Also used to indicate the MDIO bus has cleared an error
742 void phy_start(struct phy_device *phydev)
744 mutex_lock(&phydev->lock);
746 switch (phydev->state) {
748 phydev->state = PHY_PENDING;
751 phydev->state = PHY_UP;
754 phydev->state = PHY_RESUMING;
758 mutex_unlock(&phydev->lock);
760 EXPORT_SYMBOL(phy_stop);
761 EXPORT_SYMBOL(phy_start);
764 * phy_state_machine - Handle the state machine
765 * @work: work_struct that describes the work to be done
767 void phy_state_machine(struct work_struct *work)
769 struct delayed_work *dwork = to_delayed_work(work);
770 struct phy_device *phydev =
771 container_of(dwork, struct phy_device, state_queue);
775 mutex_lock(&phydev->lock);
777 if (phydev->adjust_state)
778 phydev->adjust_state(phydev->attached_dev);
780 switch(phydev->state) {
789 phydev->link_timeout = PHY_AN_TIMEOUT;
793 err = phy_read_status(phydev);
798 /* If the link is down, give up on
799 * negotiation for now */
801 phydev->state = PHY_NOLINK;
802 netif_carrier_off(phydev->attached_dev);
803 phydev->adjust_link(phydev->attached_dev);
807 /* Check if negotiation is done. Break
808 * if there's an error */
809 err = phy_aneg_done(phydev);
813 /* If AN is done, we're running */
815 phydev->state = PHY_RUNNING;
816 netif_carrier_on(phydev->attached_dev);
817 phydev->adjust_link(phydev->attached_dev);
819 } else if (0 == phydev->link_timeout--) {
823 /* If we have the magic_aneg bit,
825 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
828 /* The timer expired, and we still
829 * don't have a setting, so we try
830 * forcing it until we find one that
831 * works, starting from the fastest speed,
832 * and working our way down */
833 idx = phy_find_valid(0, phydev->supported);
835 phydev->speed = settings[idx].speed;
836 phydev->duplex = settings[idx].duplex;
838 phydev->autoneg = AUTONEG_DISABLE;
840 pr_info("Trying %d/%s\n", phydev->speed,
847 err = phy_read_status(phydev);
853 phydev->state = PHY_RUNNING;
854 netif_carrier_on(phydev->attached_dev);
855 phydev->adjust_link(phydev->attached_dev);
859 err = genphy_update_link(phydev);
865 phydev->state = PHY_RUNNING;
866 netif_carrier_on(phydev->attached_dev);
868 if (0 == phydev->link_timeout--) {
869 phy_force_reduction(phydev);
874 phydev->adjust_link(phydev->attached_dev);
877 /* Only register a CHANGE if we are
879 if (PHY_POLL == phydev->irq)
880 phydev->state = PHY_CHANGELINK;
883 err = phy_read_status(phydev);
889 phydev->state = PHY_RUNNING;
890 netif_carrier_on(phydev->attached_dev);
892 phydev->state = PHY_NOLINK;
893 netif_carrier_off(phydev->attached_dev);
896 phydev->adjust_link(phydev->attached_dev);
898 if (PHY_POLL != phydev->irq)
899 err = phy_config_interrupt(phydev,
900 PHY_INTERRUPT_ENABLED);
905 netif_carrier_off(phydev->attached_dev);
906 phydev->adjust_link(phydev->attached_dev);
911 err = phy_clear_interrupt(phydev);
916 err = phy_config_interrupt(phydev,
917 PHY_INTERRUPT_ENABLED);
922 if (AUTONEG_ENABLE == phydev->autoneg) {
923 err = phy_aneg_done(phydev);
927 /* err > 0 if AN is done.
928 * Otherwise, it's 0, and we're
929 * still waiting for AN */
931 err = phy_read_status(phydev);
936 phydev->state = PHY_RUNNING;
937 netif_carrier_on(phydev->attached_dev);
939 phydev->state = PHY_NOLINK;
940 phydev->adjust_link(phydev->attached_dev);
942 phydev->state = PHY_AN;
943 phydev->link_timeout = PHY_AN_TIMEOUT;
946 err = phy_read_status(phydev);
951 phydev->state = PHY_RUNNING;
952 netif_carrier_on(phydev->attached_dev);
954 phydev->state = PHY_NOLINK;
955 phydev->adjust_link(phydev->attached_dev);
960 mutex_unlock(&phydev->lock);
963 err = phy_start_aneg(phydev);
968 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);