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/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/init.h>
25 #include <linux/delay.h>
26 #include <linux/netdevice.h>
27 #include <linux/etherdevice.h>
28 #include <linux/skbuff.h>
29 #include <linux/spinlock.h>
31 #include <linux/module.h>
32 #include <linux/mii.h>
33 #include <linux/ethtool.h>
34 #include <linux/phy.h>
35 #include <linux/timer.h>
36 #include <linux/workqueue.h>
38 #include <asm/atomic.h>
41 #include <asm/uaccess.h>
44 * phy_print_status - Convenience function to print out the current phy status
45 * @phydev: the phy_device struct
47 void phy_print_status(struct phy_device *phydev)
49 pr_info("PHY: %s - Link is %s", phydev->dev.bus_id,
50 phydev->link ? "Up" : "Down");
52 printk(" - %d/%s", phydev->speed,
53 DUPLEX_FULL == phydev->duplex ?
58 EXPORT_SYMBOL(phy_print_status);
62 * phy_read - Convenience function for reading a given PHY register
63 * @phydev: the phy_device struct
64 * @regnum: register number to read
66 * NOTE: MUST NOT be called from interrupt context,
67 * because the bus read/write functions may wait for an interrupt
68 * to conclude the operation.
70 int phy_read(struct phy_device *phydev, u16 regnum)
73 struct mii_bus *bus = phydev->bus;
75 spin_lock_bh(&bus->mdio_lock);
76 retval = bus->read(bus, phydev->addr, regnum);
77 spin_unlock_bh(&bus->mdio_lock);
81 EXPORT_SYMBOL(phy_read);
84 * phy_write - Convenience function for writing a given PHY register
85 * @phydev: the phy_device struct
86 * @regnum: register number to write
87 * @val: value to write to @regnum
89 * NOTE: MUST NOT be called from interrupt context,
90 * because the bus read/write functions may wait for an interrupt
91 * to conclude the operation.
93 int phy_write(struct phy_device *phydev, u16 regnum, u16 val)
96 struct mii_bus *bus = phydev->bus;
98 spin_lock_bh(&bus->mdio_lock);
99 err = bus->write(bus, phydev->addr, regnum, val);
100 spin_unlock_bh(&bus->mdio_lock);
104 EXPORT_SYMBOL(phy_write);
107 * phy_clear_interrupt - Ack the phy device's interrupt
108 * @phydev: the phy_device struct
110 * If the @phydev driver has an ack_interrupt function, call it to
111 * ack and clear the phy device's interrupt.
113 * Returns 0 on success on < 0 on error.
115 int phy_clear_interrupt(struct phy_device *phydev)
119 if (phydev->drv->ack_interrupt)
120 err = phydev->drv->ack_interrupt(phydev);
126 * phy_config_interrupt - configure the PHY device for the requested interrupts
127 * @phydev: the phy_device struct
128 * @interrupts: interrupt flags to configure for this @phydev
130 * Returns 0 on success on < 0 on error.
132 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
136 phydev->interrupts = interrupts;
137 if (phydev->drv->config_intr)
138 err = phydev->drv->config_intr(phydev);
145 * phy_aneg_done - return auto-negotiation status
146 * @phydev: target phy_device struct
148 * Description: Reads the status register and returns 0 either if
149 * auto-negotiation is incomplete, or if there was an error.
150 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
152 static inline int phy_aneg_done(struct phy_device *phydev)
156 retval = phy_read(phydev, MII_BMSR);
158 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
161 /* A structure for mapping a particular speed and duplex
162 * combination to a particular SUPPORTED and ADVERTISED value */
169 /* A mapping of all SUPPORTED settings to speed/duplex */
170 static const struct phy_setting settings[] = {
173 .duplex = DUPLEX_FULL,
174 .setting = SUPPORTED_10000baseT_Full,
178 .duplex = DUPLEX_FULL,
179 .setting = SUPPORTED_1000baseT_Full,
183 .duplex = DUPLEX_HALF,
184 .setting = SUPPORTED_1000baseT_Half,
188 .duplex = DUPLEX_FULL,
189 .setting = SUPPORTED_100baseT_Full,
193 .duplex = DUPLEX_HALF,
194 .setting = SUPPORTED_100baseT_Half,
198 .duplex = DUPLEX_FULL,
199 .setting = SUPPORTED_10baseT_Full,
203 .duplex = DUPLEX_HALF,
204 .setting = SUPPORTED_10baseT_Half,
208 #define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
211 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
212 * @speed: speed to match
213 * @duplex: duplex to match
215 * Description: Searches the settings array for the setting which
216 * matches the desired speed and duplex, and returns the index
217 * of that setting. Returns the index of the last setting if
218 * none of the others match.
220 static inline int phy_find_setting(int speed, int duplex)
224 while (idx < ARRAY_SIZE(settings) &&
225 (settings[idx].speed != speed ||
226 settings[idx].duplex != duplex))
229 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
233 * phy_find_valid - find a PHY setting that matches the requested features mask
234 * @idx: The first index in settings[] to search
235 * @features: A mask of the valid settings
237 * Description: Returns the index of the first valid setting less
238 * than or equal to the one pointed to by idx, as determined by
239 * the mask in features. Returns the index of the last setting
240 * if nothing else matches.
242 static inline int phy_find_valid(int idx, u32 features)
244 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
247 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
251 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
252 * @phydev: the target phy_device struct
254 * Description: Make sure the PHY is set to supported speeds and
255 * duplexes. Drop down by one in this order: 1000/FULL,
256 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
258 void phy_sanitize_settings(struct phy_device *phydev)
260 u32 features = phydev->supported;
263 /* Sanitize settings based on PHY capabilities */
264 if ((features & SUPPORTED_Autoneg) == 0)
265 phydev->autoneg = AUTONEG_DISABLE;
267 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
270 phydev->speed = settings[idx].speed;
271 phydev->duplex = settings[idx].duplex;
273 EXPORT_SYMBOL(phy_sanitize_settings);
276 * phy_ethtool_sset - generic ethtool sset function, handles all the details
277 * @phydev: target phy_device struct
280 * A few notes about parameter checking:
281 * - We don't set port or transceiver, so we don't care what they
283 * - phy_start_aneg() will make sure forced settings are sane, and
284 * choose the next best ones from the ones selected, so we don't
285 * care if ethtool tries to give us bad values.
287 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
289 if (cmd->phy_address != phydev->addr)
292 /* We make sure that we don't pass unsupported
293 * values in to the PHY */
294 cmd->advertising &= phydev->supported;
296 /* Verify the settings we care about. */
297 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
300 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
303 if (cmd->autoneg == AUTONEG_DISABLE
304 && ((cmd->speed != SPEED_1000
305 && cmd->speed != SPEED_100
306 && cmd->speed != SPEED_10)
307 || (cmd->duplex != DUPLEX_HALF
308 && cmd->duplex != DUPLEX_FULL)))
311 phydev->autoneg = cmd->autoneg;
313 phydev->speed = cmd->speed;
315 phydev->advertising = cmd->advertising;
317 if (AUTONEG_ENABLE == cmd->autoneg)
318 phydev->advertising |= ADVERTISED_Autoneg;
320 phydev->advertising &= ~ADVERTISED_Autoneg;
322 phydev->duplex = cmd->duplex;
324 /* Restart the PHY */
325 phy_start_aneg(phydev);
329 EXPORT_SYMBOL(phy_ethtool_sset);
331 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
333 cmd->supported = phydev->supported;
335 cmd->advertising = phydev->advertising;
337 cmd->speed = phydev->speed;
338 cmd->duplex = phydev->duplex;
339 cmd->port = PORT_MII;
340 cmd->phy_address = phydev->addr;
341 cmd->transceiver = XCVR_EXTERNAL;
342 cmd->autoneg = phydev->autoneg;
346 EXPORT_SYMBOL(phy_ethtool_gset);
349 * phy_mii_ioctl - generic PHY MII ioctl interface
350 * @phydev: the phy_device struct
351 * @mii_data: MII ioctl data
352 * @cmd: ioctl cmd to execute
354 * Note that this function is currently incompatible with the
355 * PHYCONTROL layer. It changes registers without regard to
356 * current state. Use at own risk.
358 int phy_mii_ioctl(struct phy_device *phydev,
359 struct mii_ioctl_data *mii_data, int cmd)
361 u16 val = mii_data->val_in;
365 mii_data->phy_id = phydev->addr;
368 mii_data->val_out = phy_read(phydev, mii_data->reg_num);
372 if (!capable(CAP_NET_ADMIN))
375 if (mii_data->phy_id == phydev->addr) {
376 switch(mii_data->reg_num) {
378 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
379 phydev->autoneg = AUTONEG_DISABLE;
381 phydev->autoneg = AUTONEG_ENABLE;
382 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
383 phydev->duplex = DUPLEX_FULL;
385 phydev->duplex = DUPLEX_HALF;
386 if ((!phydev->autoneg) &&
387 (val & BMCR_SPEED1000))
388 phydev->speed = SPEED_1000;
389 else if ((!phydev->autoneg) &&
390 (val & BMCR_SPEED100))
391 phydev->speed = SPEED_100;
394 phydev->advertising = val;
402 phy_write(phydev, mii_data->reg_num, val);
404 if (mii_data->reg_num == MII_BMCR
406 && phydev->drv->config_init)
407 phydev->drv->config_init(phydev);
416 EXPORT_SYMBOL(phy_mii_ioctl);
419 * phy_start_aneg - start auto-negotiation for this PHY device
420 * @phydev: the phy_device struct
422 * Description: Sanitizes the settings (if we're not autonegotiating
423 * them), and then calls the driver's config_aneg function.
424 * If the PHYCONTROL Layer is operating, we change the state to
425 * reflect the beginning of Auto-negotiation or forcing.
427 int phy_start_aneg(struct phy_device *phydev)
431 spin_lock_bh(&phydev->lock);
433 if (AUTONEG_DISABLE == phydev->autoneg)
434 phy_sanitize_settings(phydev);
436 err = phydev->drv->config_aneg(phydev);
441 if (phydev->state != PHY_HALTED) {
442 if (AUTONEG_ENABLE == phydev->autoneg) {
443 phydev->state = PHY_AN;
444 phydev->link_timeout = PHY_AN_TIMEOUT;
446 phydev->state = PHY_FORCING;
447 phydev->link_timeout = PHY_FORCE_TIMEOUT;
452 spin_unlock_bh(&phydev->lock);
455 EXPORT_SYMBOL(phy_start_aneg);
458 static void phy_change(struct work_struct *work);
459 static void phy_timer(unsigned long data);
462 * phy_start_machine - start PHY state machine tracking
463 * @phydev: the phy_device struct
464 * @handler: callback function for state change notifications
466 * Description: The PHY infrastructure can run a state machine
467 * which tracks whether the PHY is starting up, negotiating,
468 * etc. This function starts the timer which tracks the state
469 * of the PHY. If you want to be notified when the state changes,
470 * pass in the callback @handler, otherwise, pass NULL. If you
471 * want to maintain your own state machine, do not call this
474 void phy_start_machine(struct phy_device *phydev,
475 void (*handler)(struct net_device *))
477 phydev->adjust_state = handler;
479 init_timer(&phydev->phy_timer);
480 phydev->phy_timer.function = &phy_timer;
481 phydev->phy_timer.data = (unsigned long) phydev;
482 mod_timer(&phydev->phy_timer, jiffies + HZ);
486 * phy_stop_machine - stop the PHY state machine tracking
487 * @phydev: target phy_device struct
489 * Description: Stops the state machine timer, sets the state to UP
490 * (unless it wasn't up yet). This function must be called BEFORE
493 void phy_stop_machine(struct phy_device *phydev)
495 del_timer_sync(&phydev->phy_timer);
497 spin_lock_bh(&phydev->lock);
498 if (phydev->state > PHY_UP)
499 phydev->state = PHY_UP;
500 spin_unlock_bh(&phydev->lock);
502 phydev->adjust_state = NULL;
506 * phy_force_reduction - reduce PHY speed/duplex settings by one step
507 * @phydev: target phy_device struct
509 * Description: Reduces the speed/duplex settings by one notch,
511 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
512 * The function bottoms out at 10/HALF.
514 static void phy_force_reduction(struct phy_device *phydev)
518 idx = phy_find_setting(phydev->speed, phydev->duplex);
522 idx = phy_find_valid(idx, phydev->supported);
524 phydev->speed = settings[idx].speed;
525 phydev->duplex = settings[idx].duplex;
527 pr_info("Trying %d/%s\n", phydev->speed,
528 DUPLEX_FULL == phydev->duplex ?
534 * phy_error - enter HALTED state for this PHY device
535 * @phydev: target phy_device struct
537 * Moves the PHY to the HALTED state in response to a read
538 * or write error, and tells the controller the link is down.
539 * Must not be called from interrupt context, or while the
540 * phydev->lock is held.
542 void phy_error(struct phy_device *phydev)
544 spin_lock_bh(&phydev->lock);
545 phydev->state = PHY_HALTED;
546 spin_unlock_bh(&phydev->lock);
550 * phy_interrupt - PHY interrupt handler
551 * @irq: interrupt line
552 * @phy_dat: phy_device pointer
554 * Description: When a PHY interrupt occurs, the handler disables
555 * interrupts, and schedules a work task to clear the interrupt.
557 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
559 struct phy_device *phydev = phy_dat;
561 if (PHY_HALTED == phydev->state)
562 return IRQ_NONE; /* It can't be ours. */
564 /* The MDIO bus is not allowed to be written in interrupt
565 * context, so we need to disable the irq here. A work
566 * queue will write the PHY to disable and clear the
567 * interrupt, and then reenable the irq line. */
568 disable_irq_nosync(irq);
569 atomic_inc(&phydev->irq_disable);
571 schedule_work(&phydev->phy_queue);
577 * phy_enable_interrupts - Enable the interrupts from the PHY side
578 * @phydev: target phy_device struct
580 int phy_enable_interrupts(struct phy_device *phydev)
584 err = phy_clear_interrupt(phydev);
589 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
593 EXPORT_SYMBOL(phy_enable_interrupts);
596 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
597 * @phydev: target phy_device struct
599 int phy_disable_interrupts(struct phy_device *phydev)
603 /* Disable PHY interrupts */
604 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
609 /* Clear the interrupt */
610 err = phy_clear_interrupt(phydev);
622 EXPORT_SYMBOL(phy_disable_interrupts);
625 * phy_start_interrupts - request and enable interrupts for a PHY device
626 * @phydev: target phy_device struct
628 * Description: Request the interrupt for the given PHY.
629 * If this fails, then we set irq to PHY_POLL.
630 * Otherwise, we enable the interrupts in the PHY.
631 * This should only be called with a valid IRQ number.
632 * Returns 0 on success or < 0 on error.
634 int phy_start_interrupts(struct phy_device *phydev)
638 INIT_WORK(&phydev->phy_queue, phy_change);
640 atomic_set(&phydev->irq_disable, 0);
641 if (request_irq(phydev->irq, phy_interrupt,
645 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
648 phydev->irq = PHY_POLL;
652 err = phy_enable_interrupts(phydev);
656 EXPORT_SYMBOL(phy_start_interrupts);
659 * phy_stop_interrupts - disable interrupts from a PHY device
660 * @phydev: target phy_device struct
662 int phy_stop_interrupts(struct phy_device *phydev)
666 err = phy_disable_interrupts(phydev);
671 free_irq(phydev->irq, phydev);
674 * Cannot call flush_scheduled_work() here as desired because
675 * of rtnl_lock(), but we do not really care about what would
676 * be done, except from enable_irq(), so cancel any work
677 * possibly pending and take care of the matter below.
679 cancel_work_sync(&phydev->phy_queue);
681 * If work indeed has been cancelled, disable_irq() will have
682 * been left unbalanced from phy_interrupt() and enable_irq()
683 * has to be called so that other devices on the line work.
685 while (atomic_dec_return(&phydev->irq_disable) >= 0)
686 enable_irq(phydev->irq);
690 EXPORT_SYMBOL(phy_stop_interrupts);
694 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
695 * @work: work_struct that describes the work to be done
697 static void phy_change(struct work_struct *work)
700 struct phy_device *phydev =
701 container_of(work, struct phy_device, phy_queue);
703 err = phy_disable_interrupts(phydev);
708 spin_lock_bh(&phydev->lock);
709 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
710 phydev->state = PHY_CHANGELINK;
711 spin_unlock_bh(&phydev->lock);
713 atomic_dec(&phydev->irq_disable);
714 enable_irq(phydev->irq);
716 /* Reenable interrupts */
717 if (PHY_HALTED != phydev->state)
718 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
726 disable_irq(phydev->irq);
727 atomic_inc(&phydev->irq_disable);
733 * phy_stop - Bring down the PHY link, and stop checking the status
734 * @phydev: target phy_device struct
736 void phy_stop(struct phy_device *phydev)
738 spin_lock_bh(&phydev->lock);
740 if (PHY_HALTED == phydev->state)
743 if (phydev->irq != PHY_POLL) {
744 /* Disable PHY Interrupts */
745 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
747 /* Clear any pending interrupts */
748 phy_clear_interrupt(phydev);
751 phydev->state = PHY_HALTED;
754 spin_unlock_bh(&phydev->lock);
757 * Cannot call flush_scheduled_work() here as desired because
758 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
759 * will not reenable interrupts.
765 * phy_start - start or restart a PHY device
766 * @phydev: target phy_device struct
768 * Description: Indicates the attached device's readiness to
769 * handle PHY-related work. Used during startup to start the
770 * PHY, and after a call to phy_stop() to resume operation.
771 * Also used to indicate the MDIO bus has cleared an error
774 void phy_start(struct phy_device *phydev)
776 spin_lock_bh(&phydev->lock);
778 switch (phydev->state) {
780 phydev->state = PHY_PENDING;
783 phydev->state = PHY_UP;
786 phydev->state = PHY_RESUMING;
790 spin_unlock_bh(&phydev->lock);
792 EXPORT_SYMBOL(phy_stop);
793 EXPORT_SYMBOL(phy_start);
795 /* PHY timer which handles the state machine */
796 static void phy_timer(unsigned long data)
798 struct phy_device *phydev = (struct phy_device *)data;
802 spin_lock_bh(&phydev->lock);
804 if (phydev->adjust_state)
805 phydev->adjust_state(phydev->attached_dev);
807 switch(phydev->state) {
816 phydev->link_timeout = PHY_AN_TIMEOUT;
820 err = phy_read_status(phydev);
825 /* If the link is down, give up on
826 * negotiation for now */
828 phydev->state = PHY_NOLINK;
829 netif_carrier_off(phydev->attached_dev);
830 phydev->adjust_link(phydev->attached_dev);
834 /* Check if negotiation is done. Break
835 * if there's an error */
836 err = phy_aneg_done(phydev);
840 /* If AN is done, we're running */
842 phydev->state = PHY_RUNNING;
843 netif_carrier_on(phydev->attached_dev);
844 phydev->adjust_link(phydev->attached_dev);
846 } else if (0 == phydev->link_timeout--) {
850 /* If we have the magic_aneg bit,
852 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
855 /* The timer expired, and we still
856 * don't have a setting, so we try
857 * forcing it until we find one that
858 * works, starting from the fastest speed,
859 * and working our way down */
860 idx = phy_find_valid(0, phydev->supported);
862 phydev->speed = settings[idx].speed;
863 phydev->duplex = settings[idx].duplex;
865 phydev->autoneg = AUTONEG_DISABLE;
867 pr_info("Trying %d/%s\n", phydev->speed,
874 err = phy_read_status(phydev);
880 phydev->state = PHY_RUNNING;
881 netif_carrier_on(phydev->attached_dev);
882 phydev->adjust_link(phydev->attached_dev);
886 err = genphy_update_link(phydev);
892 phydev->state = PHY_RUNNING;
893 netif_carrier_on(phydev->attached_dev);
895 if (0 == phydev->link_timeout--) {
896 phy_force_reduction(phydev);
901 phydev->adjust_link(phydev->attached_dev);
904 /* Only register a CHANGE if we are
906 if (PHY_POLL == phydev->irq)
907 phydev->state = PHY_CHANGELINK;
910 err = phy_read_status(phydev);
916 phydev->state = PHY_RUNNING;
917 netif_carrier_on(phydev->attached_dev);
919 phydev->state = PHY_NOLINK;
920 netif_carrier_off(phydev->attached_dev);
923 phydev->adjust_link(phydev->attached_dev);
925 if (PHY_POLL != phydev->irq)
926 err = phy_config_interrupt(phydev,
927 PHY_INTERRUPT_ENABLED);
932 netif_carrier_off(phydev->attached_dev);
933 phydev->adjust_link(phydev->attached_dev);
938 err = phy_clear_interrupt(phydev);
943 err = phy_config_interrupt(phydev,
944 PHY_INTERRUPT_ENABLED);
949 if (AUTONEG_ENABLE == phydev->autoneg) {
950 err = phy_aneg_done(phydev);
954 /* err > 0 if AN is done.
955 * Otherwise, it's 0, and we're
956 * still waiting for AN */
958 phydev->state = PHY_RUNNING;
960 phydev->state = PHY_AN;
961 phydev->link_timeout = PHY_AN_TIMEOUT;
964 phydev->state = PHY_RUNNING;
968 spin_unlock_bh(&phydev->lock);
971 err = phy_start_aneg(phydev);
976 mod_timer(&phydev->phy_timer, jiffies + PHY_STATE_TIME * HZ);