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 <linux/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(KERN_CONT " - %d/%s", phydev->speed,
51 DUPLEX_FULL == phydev->duplex ?
54 printk(KERN_CONT "\n");
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 static 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 static 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 static 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;
228 * phy_ethtool_sset - generic ethtool sset function, handles all the details
229 * @phydev: target phy_device struct
232 * A few notes about parameter checking:
233 * - We don't set port or transceiver, so we don't care what they
235 * - phy_start_aneg() will make sure forced settings are sane, and
236 * choose the next best ones from the ones selected, so we don't
237 * care if ethtool tries to give us bad values.
239 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
241 u32 speed = ethtool_cmd_speed(cmd);
243 if (cmd->phy_address != phydev->addr)
246 /* We make sure that we don't pass unsupported
247 * values in to the PHY */
248 cmd->advertising &= phydev->supported;
250 /* Verify the settings we care about. */
251 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
254 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
257 if (cmd->autoneg == AUTONEG_DISABLE &&
258 ((speed != SPEED_1000 &&
259 speed != SPEED_100 &&
260 speed != SPEED_10) ||
261 (cmd->duplex != DUPLEX_HALF &&
262 cmd->duplex != DUPLEX_FULL)))
265 phydev->autoneg = cmd->autoneg;
267 phydev->speed = speed;
269 phydev->advertising = cmd->advertising;
271 if (AUTONEG_ENABLE == cmd->autoneg)
272 phydev->advertising |= ADVERTISED_Autoneg;
274 phydev->advertising &= ~ADVERTISED_Autoneg;
276 phydev->duplex = cmd->duplex;
278 /* Restart the PHY */
279 phy_start_aneg(phydev);
283 EXPORT_SYMBOL(phy_ethtool_sset);
285 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
287 cmd->supported = phydev->supported;
289 cmd->advertising = phydev->advertising;
291 ethtool_cmd_speed_set(cmd, phydev->speed);
292 cmd->duplex = phydev->duplex;
293 cmd->port = PORT_MII;
294 cmd->phy_address = phydev->addr;
295 cmd->transceiver = XCVR_EXTERNAL;
296 cmd->autoneg = phydev->autoneg;
300 EXPORT_SYMBOL(phy_ethtool_gset);
303 * phy_mii_ioctl - generic PHY MII ioctl interface
304 * @phydev: the phy_device struct
305 * @ifr: &struct ifreq for socket ioctl's
306 * @cmd: ioctl cmd to execute
308 * Note that this function is currently incompatible with the
309 * PHYCONTROL layer. It changes registers without regard to
310 * current state. Use at own risk.
312 int phy_mii_ioctl(struct phy_device *phydev,
313 struct ifreq *ifr, int cmd)
315 struct mii_ioctl_data *mii_data = if_mii(ifr);
316 u16 val = mii_data->val_in;
320 mii_data->phy_id = phydev->addr;
324 mii_data->val_out = mdiobus_read(phydev->bus, mii_data->phy_id,
329 if (mii_data->phy_id == phydev->addr) {
330 switch(mii_data->reg_num) {
332 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
333 phydev->autoneg = AUTONEG_DISABLE;
335 phydev->autoneg = AUTONEG_ENABLE;
336 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
337 phydev->duplex = DUPLEX_FULL;
339 phydev->duplex = DUPLEX_HALF;
340 if ((!phydev->autoneg) &&
341 (val & BMCR_SPEED1000))
342 phydev->speed = SPEED_1000;
343 else if ((!phydev->autoneg) &&
344 (val & BMCR_SPEED100))
345 phydev->speed = SPEED_100;
348 phydev->advertising = val;
356 mdiobus_write(phydev->bus, mii_data->phy_id,
357 mii_data->reg_num, val);
359 if (mii_data->reg_num == MII_BMCR &&
361 phydev->drv->config_init) {
362 phy_scan_fixups(phydev);
363 phydev->drv->config_init(phydev);
368 if (phydev->drv->hwtstamp)
369 return phydev->drv->hwtstamp(phydev, ifr);
378 EXPORT_SYMBOL(phy_mii_ioctl);
381 * phy_start_aneg - start auto-negotiation for this PHY device
382 * @phydev: the phy_device struct
384 * Description: Sanitizes the settings (if we're not autonegotiating
385 * them), and then calls the driver's config_aneg function.
386 * If the PHYCONTROL Layer is operating, we change the state to
387 * reflect the beginning of Auto-negotiation or forcing.
389 int phy_start_aneg(struct phy_device *phydev)
393 mutex_lock(&phydev->lock);
395 if (AUTONEG_DISABLE == phydev->autoneg)
396 phy_sanitize_settings(phydev);
398 err = phydev->drv->config_aneg(phydev);
403 if (phydev->state != PHY_HALTED) {
404 if (AUTONEG_ENABLE == phydev->autoneg) {
405 phydev->state = PHY_AN;
406 phydev->link_timeout = PHY_AN_TIMEOUT;
408 phydev->state = PHY_FORCING;
409 phydev->link_timeout = PHY_FORCE_TIMEOUT;
414 mutex_unlock(&phydev->lock);
417 EXPORT_SYMBOL(phy_start_aneg);
420 static void phy_change(struct work_struct *work);
423 * phy_start_machine - start PHY state machine tracking
424 * @phydev: the phy_device struct
425 * @handler: callback function for state change notifications
427 * Description: The PHY infrastructure can run a state machine
428 * which tracks whether the PHY is starting up, negotiating,
429 * etc. This function starts the timer which tracks the state
430 * of the PHY. If you want to be notified when the state changes,
431 * pass in the callback @handler, otherwise, pass NULL. If you
432 * want to maintain your own state machine, do not call this
435 void phy_start_machine(struct phy_device *phydev,
436 void (*handler)(struct net_device *))
438 phydev->adjust_state = handler;
440 schedule_delayed_work(&phydev->state_queue, HZ);
444 * phy_stop_machine - stop the PHY state machine tracking
445 * @phydev: target phy_device struct
447 * Description: Stops the state machine timer, sets the state to UP
448 * (unless it wasn't up yet). This function must be called BEFORE
451 void phy_stop_machine(struct phy_device *phydev)
453 cancel_delayed_work_sync(&phydev->state_queue);
455 mutex_lock(&phydev->lock);
456 if (phydev->state > PHY_UP)
457 phydev->state = PHY_UP;
458 mutex_unlock(&phydev->lock);
460 phydev->adjust_state = NULL;
464 * phy_force_reduction - reduce PHY speed/duplex settings by one step
465 * @phydev: target phy_device struct
467 * Description: Reduces the speed/duplex settings by one notch,
469 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
470 * The function bottoms out at 10/HALF.
472 static void phy_force_reduction(struct phy_device *phydev)
476 idx = phy_find_setting(phydev->speed, phydev->duplex);
480 idx = phy_find_valid(idx, phydev->supported);
482 phydev->speed = settings[idx].speed;
483 phydev->duplex = settings[idx].duplex;
485 pr_info("Trying %d/%s\n", phydev->speed,
486 DUPLEX_FULL == phydev->duplex ?
492 * phy_error - enter HALTED state for this PHY device
493 * @phydev: target phy_device struct
495 * Moves the PHY to the HALTED state in response to a read
496 * or write error, and tells the controller the link is down.
497 * Must not be called from interrupt context, or while the
498 * phydev->lock is held.
500 static void phy_error(struct phy_device *phydev)
502 mutex_lock(&phydev->lock);
503 phydev->state = PHY_HALTED;
504 mutex_unlock(&phydev->lock);
508 * phy_interrupt - PHY interrupt handler
509 * @irq: interrupt line
510 * @phy_dat: phy_device pointer
512 * Description: When a PHY interrupt occurs, the handler disables
513 * interrupts, and schedules a work task to clear the interrupt.
515 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
517 struct phy_device *phydev = phy_dat;
519 if (PHY_HALTED == phydev->state)
520 return IRQ_NONE; /* It can't be ours. */
522 /* The MDIO bus is not allowed to be written in interrupt
523 * context, so we need to disable the irq here. A work
524 * queue will write the PHY to disable and clear the
525 * interrupt, and then reenable the irq line. */
526 disable_irq_nosync(irq);
527 atomic_inc(&phydev->irq_disable);
529 schedule_work(&phydev->phy_queue);
535 * phy_enable_interrupts - Enable the interrupts from the PHY side
536 * @phydev: target phy_device struct
538 static int phy_enable_interrupts(struct phy_device *phydev)
542 err = phy_clear_interrupt(phydev);
547 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
553 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
554 * @phydev: target phy_device struct
556 static int phy_disable_interrupts(struct phy_device *phydev)
560 /* Disable PHY interrupts */
561 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
566 /* Clear the interrupt */
567 err = phy_clear_interrupt(phydev);
581 * phy_start_interrupts - request and enable interrupts for a PHY device
582 * @phydev: target phy_device struct
584 * Description: Request the interrupt for the given PHY.
585 * If this fails, then we set irq to PHY_POLL.
586 * Otherwise, we enable the interrupts in the PHY.
587 * This should only be called with a valid IRQ number.
588 * Returns 0 on success or < 0 on error.
590 int phy_start_interrupts(struct phy_device *phydev)
594 INIT_WORK(&phydev->phy_queue, phy_change);
596 atomic_set(&phydev->irq_disable, 0);
597 if (request_irq(phydev->irq, phy_interrupt,
601 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
604 phydev->irq = PHY_POLL;
608 err = phy_enable_interrupts(phydev);
612 EXPORT_SYMBOL(phy_start_interrupts);
615 * phy_stop_interrupts - disable interrupts from a PHY device
616 * @phydev: target phy_device struct
618 int phy_stop_interrupts(struct phy_device *phydev)
622 err = phy_disable_interrupts(phydev);
627 free_irq(phydev->irq, phydev);
630 * Cannot call flush_scheduled_work() here as desired because
631 * of rtnl_lock(), but we do not really care about what would
632 * be done, except from enable_irq(), so cancel any work
633 * possibly pending and take care of the matter below.
635 cancel_work_sync(&phydev->phy_queue);
637 * If work indeed has been cancelled, disable_irq() will have
638 * been left unbalanced from phy_interrupt() and enable_irq()
639 * has to be called so that other devices on the line work.
641 while (atomic_dec_return(&phydev->irq_disable) >= 0)
642 enable_irq(phydev->irq);
646 EXPORT_SYMBOL(phy_stop_interrupts);
650 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
651 * @work: work_struct that describes the work to be done
653 static void phy_change(struct work_struct *work)
656 struct phy_device *phydev =
657 container_of(work, struct phy_device, phy_queue);
659 if (phydev->drv->did_interrupt &&
660 !phydev->drv->did_interrupt(phydev))
663 err = phy_disable_interrupts(phydev);
668 mutex_lock(&phydev->lock);
669 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
670 phydev->state = PHY_CHANGELINK;
671 mutex_unlock(&phydev->lock);
673 atomic_dec(&phydev->irq_disable);
674 enable_irq(phydev->irq);
676 /* Reenable interrupts */
677 if (PHY_HALTED != phydev->state)
678 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
683 /* reschedule state queue work to run as soon as possible */
684 cancel_delayed_work_sync(&phydev->state_queue);
685 schedule_delayed_work(&phydev->state_queue, 0);
690 atomic_dec(&phydev->irq_disable);
691 enable_irq(phydev->irq);
695 disable_irq(phydev->irq);
696 atomic_inc(&phydev->irq_disable);
702 * phy_stop - Bring down the PHY link, and stop checking the status
703 * @phydev: target phy_device struct
705 void phy_stop(struct phy_device *phydev)
707 mutex_lock(&phydev->lock);
709 if (PHY_HALTED == phydev->state)
712 if (phydev->irq != PHY_POLL) {
713 /* Disable PHY Interrupts */
714 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
716 /* Clear any pending interrupts */
717 phy_clear_interrupt(phydev);
720 phydev->state = PHY_HALTED;
723 mutex_unlock(&phydev->lock);
726 * Cannot call flush_scheduled_work() here as desired because
727 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
728 * will not reenable interrupts.
734 * phy_start - start or restart a PHY device
735 * @phydev: target phy_device struct
737 * Description: Indicates the attached device's readiness to
738 * handle PHY-related work. Used during startup to start the
739 * PHY, and after a call to phy_stop() to resume operation.
740 * Also used to indicate the MDIO bus has cleared an error
743 void phy_start(struct phy_device *phydev)
745 mutex_lock(&phydev->lock);
747 switch (phydev->state) {
749 phydev->state = PHY_PENDING;
752 phydev->state = PHY_UP;
755 phydev->state = PHY_RESUMING;
759 mutex_unlock(&phydev->lock);
761 EXPORT_SYMBOL(phy_stop);
762 EXPORT_SYMBOL(phy_start);
765 * phy_state_machine - Handle the state machine
766 * @work: work_struct that describes the work to be done
768 void phy_state_machine(struct work_struct *work)
770 struct delayed_work *dwork = to_delayed_work(work);
771 struct phy_device *phydev =
772 container_of(dwork, struct phy_device, state_queue);
776 mutex_lock(&phydev->lock);
778 if (phydev->adjust_state)
779 phydev->adjust_state(phydev->attached_dev);
781 switch(phydev->state) {
790 phydev->link_timeout = PHY_AN_TIMEOUT;
794 err = phy_read_status(phydev);
799 /* If the link is down, give up on
800 * negotiation for now */
802 phydev->state = PHY_NOLINK;
803 netif_carrier_off(phydev->attached_dev);
804 phydev->adjust_link(phydev->attached_dev);
808 /* Check if negotiation is done. Break
809 * if there's an error */
810 err = phy_aneg_done(phydev);
814 /* If AN is done, we're running */
816 phydev->state = PHY_RUNNING;
817 netif_carrier_on(phydev->attached_dev);
818 phydev->adjust_link(phydev->attached_dev);
820 } else if (0 == phydev->link_timeout--) {
824 /* If we have the magic_aneg bit,
826 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
829 /* The timer expired, and we still
830 * don't have a setting, so we try
831 * forcing it until we find one that
832 * works, starting from the fastest speed,
833 * and working our way down */
834 idx = phy_find_valid(0, phydev->supported);
836 phydev->speed = settings[idx].speed;
837 phydev->duplex = settings[idx].duplex;
839 phydev->autoneg = AUTONEG_DISABLE;
841 pr_info("Trying %d/%s\n", phydev->speed,
848 err = phy_read_status(phydev);
854 phydev->state = PHY_RUNNING;
855 netif_carrier_on(phydev->attached_dev);
856 phydev->adjust_link(phydev->attached_dev);
860 err = genphy_update_link(phydev);
866 phydev->state = PHY_RUNNING;
867 netif_carrier_on(phydev->attached_dev);
869 if (0 == phydev->link_timeout--) {
870 phy_force_reduction(phydev);
875 phydev->adjust_link(phydev->attached_dev);
878 /* Only register a CHANGE if we are
880 if (PHY_POLL == phydev->irq)
881 phydev->state = PHY_CHANGELINK;
884 err = phy_read_status(phydev);
890 phydev->state = PHY_RUNNING;
891 netif_carrier_on(phydev->attached_dev);
893 phydev->state = PHY_NOLINK;
894 netif_carrier_off(phydev->attached_dev);
897 phydev->adjust_link(phydev->attached_dev);
899 if (PHY_POLL != phydev->irq)
900 err = phy_config_interrupt(phydev,
901 PHY_INTERRUPT_ENABLED);
906 netif_carrier_off(phydev->attached_dev);
907 phydev->adjust_link(phydev->attached_dev);
912 err = phy_clear_interrupt(phydev);
917 err = phy_config_interrupt(phydev,
918 PHY_INTERRUPT_ENABLED);
923 if (AUTONEG_ENABLE == phydev->autoneg) {
924 err = phy_aneg_done(phydev);
928 /* err > 0 if AN is done.
929 * Otherwise, it's 0, and we're
930 * still waiting for AN */
932 err = phy_read_status(phydev);
937 phydev->state = PHY_RUNNING;
938 netif_carrier_on(phydev->attached_dev);
940 phydev->state = PHY_NOLINK;
941 phydev->adjust_link(phydev->attached_dev);
943 phydev->state = PHY_AN;
944 phydev->link_timeout = PHY_AN_TIMEOUT;
947 err = phy_read_status(phydev);
952 phydev->state = PHY_RUNNING;
953 netif_carrier_on(phydev->attached_dev);
955 phydev->state = PHY_NOLINK;
956 phydev->adjust_link(phydev->attached_dev);
961 mutex_unlock(&phydev->lock);
964 err = phy_start_aneg(phydev);
969 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);