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>
30 #include <linux/module.h>
31 #include <linux/mii.h>
32 #include <linux/ethtool.h>
33 #include <linux/phy.h>
34 #include <linux/timer.h>
35 #include <linux/workqueue.h>
37 #include <asm/atomic.h>
40 #include <asm/uaccess.h>
43 * phy_print_status - Convenience function to print out the current phy status
44 * @phydev: the phy_device struct
46 void phy_print_status(struct phy_device *phydev)
48 pr_info("PHY: %s - Link is %s", dev_name(&phydev->dev),
49 phydev->link ? "Up" : "Down");
51 printk(" - %d/%s", phydev->speed,
52 DUPLEX_FULL == phydev->duplex ?
57 EXPORT_SYMBOL(phy_print_status);
61 * phy_clear_interrupt - Ack the phy device's interrupt
62 * @phydev: the phy_device struct
64 * If the @phydev driver has an ack_interrupt function, call it to
65 * ack and clear the phy device's interrupt.
67 * Returns 0 on success on < 0 on error.
69 int phy_clear_interrupt(struct phy_device *phydev)
73 if (phydev->drv->ack_interrupt)
74 err = phydev->drv->ack_interrupt(phydev);
80 * phy_config_interrupt - configure the PHY device for the requested interrupts
81 * @phydev: the phy_device struct
82 * @interrupts: interrupt flags to configure for this @phydev
84 * Returns 0 on success on < 0 on error.
86 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
90 phydev->interrupts = interrupts;
91 if (phydev->drv->config_intr)
92 err = phydev->drv->config_intr(phydev);
99 * phy_aneg_done - return auto-negotiation status
100 * @phydev: target phy_device struct
102 * Description: Reads the status register and returns 0 either if
103 * auto-negotiation is incomplete, or if there was an error.
104 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
106 static inline int phy_aneg_done(struct phy_device *phydev)
110 retval = phy_read(phydev, MII_BMSR);
112 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
115 /* A structure for mapping a particular speed and duplex
116 * combination to a particular SUPPORTED and ADVERTISED value */
123 /* A mapping of all SUPPORTED settings to speed/duplex */
124 static const struct phy_setting settings[] = {
127 .duplex = DUPLEX_FULL,
128 .setting = SUPPORTED_10000baseT_Full,
132 .duplex = DUPLEX_FULL,
133 .setting = SUPPORTED_1000baseT_Full,
137 .duplex = DUPLEX_HALF,
138 .setting = SUPPORTED_1000baseT_Half,
142 .duplex = DUPLEX_FULL,
143 .setting = SUPPORTED_100baseT_Full,
147 .duplex = DUPLEX_HALF,
148 .setting = SUPPORTED_100baseT_Half,
152 .duplex = DUPLEX_FULL,
153 .setting = SUPPORTED_10baseT_Full,
157 .duplex = DUPLEX_HALF,
158 .setting = SUPPORTED_10baseT_Half,
162 #define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
165 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
166 * @speed: speed to match
167 * @duplex: duplex to match
169 * Description: Searches the settings array for the setting which
170 * matches the desired speed and duplex, and returns the index
171 * of that setting. Returns the index of the last setting if
172 * none of the others match.
174 static inline int phy_find_setting(int speed, int duplex)
178 while (idx < ARRAY_SIZE(settings) &&
179 (settings[idx].speed != speed ||
180 settings[idx].duplex != duplex))
183 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
187 * phy_find_valid - find a PHY setting that matches the requested features mask
188 * @idx: The first index in settings[] to search
189 * @features: A mask of the valid settings
191 * Description: Returns the index of the first valid setting less
192 * than or equal to the one pointed to by idx, as determined by
193 * the mask in features. Returns the index of the last setting
194 * if nothing else matches.
196 static inline int phy_find_valid(int idx, u32 features)
198 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
201 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
205 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
206 * @phydev: the target phy_device struct
208 * Description: Make sure the PHY is set to supported speeds and
209 * duplexes. Drop down by one in this order: 1000/FULL,
210 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
212 void phy_sanitize_settings(struct phy_device *phydev)
214 u32 features = phydev->supported;
217 /* Sanitize settings based on PHY capabilities */
218 if ((features & SUPPORTED_Autoneg) == 0)
219 phydev->autoneg = AUTONEG_DISABLE;
221 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
224 phydev->speed = settings[idx].speed;
225 phydev->duplex = settings[idx].duplex;
227 EXPORT_SYMBOL(phy_sanitize_settings);
230 * phy_ethtool_sset - generic ethtool sset function, handles all the details
231 * @phydev: target phy_device struct
234 * A few notes about parameter checking:
235 * - We don't set port or transceiver, so we don't care what they
237 * - phy_start_aneg() will make sure forced settings are sane, and
238 * choose the next best ones from the ones selected, so we don't
239 * care if ethtool tries to give us bad values.
241 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *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 && ((cmd->speed != SPEED_1000
259 && cmd->speed != SPEED_100
260 && cmd->speed != SPEED_10)
261 || (cmd->duplex != DUPLEX_HALF
262 && cmd->duplex != DUPLEX_FULL)))
265 phydev->autoneg = cmd->autoneg;
267 phydev->speed = cmd->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 cmd->speed = 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 * @mii_data: MII ioctl data
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 mii_ioctl_data *mii_data, int cmd)
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 (!capable(CAP_NET_ADMIN))
330 if (mii_data->phy_id == phydev->addr) {
331 switch(mii_data->reg_num) {
333 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
334 phydev->autoneg = AUTONEG_DISABLE;
336 phydev->autoneg = AUTONEG_ENABLE;
337 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
338 phydev->duplex = DUPLEX_FULL;
340 phydev->duplex = DUPLEX_HALF;
341 if ((!phydev->autoneg) &&
342 (val & BMCR_SPEED1000))
343 phydev->speed = SPEED_1000;
344 else if ((!phydev->autoneg) &&
345 (val & BMCR_SPEED100))
346 phydev->speed = SPEED_100;
349 phydev->advertising = val;
357 phy_write(phydev, 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);
373 EXPORT_SYMBOL(phy_mii_ioctl);
376 * phy_start_aneg - start auto-negotiation for this PHY device
377 * @phydev: the phy_device struct
379 * Description: Sanitizes the settings (if we're not autonegotiating
380 * them), and then calls the driver's config_aneg function.
381 * If the PHYCONTROL Layer is operating, we change the state to
382 * reflect the beginning of Auto-negotiation or forcing.
384 int phy_start_aneg(struct phy_device *phydev)
388 mutex_lock(&phydev->lock);
390 if (AUTONEG_DISABLE == phydev->autoneg)
391 phy_sanitize_settings(phydev);
393 err = phydev->drv->config_aneg(phydev);
398 if (phydev->state != PHY_HALTED) {
399 if (AUTONEG_ENABLE == phydev->autoneg) {
400 phydev->state = PHY_AN;
401 phydev->link_timeout = PHY_AN_TIMEOUT;
403 phydev->state = PHY_FORCING;
404 phydev->link_timeout = PHY_FORCE_TIMEOUT;
409 mutex_unlock(&phydev->lock);
412 EXPORT_SYMBOL(phy_start_aneg);
415 static void phy_change(struct work_struct *work);
416 static void phy_state_machine(struct work_struct *work);
417 static void phy_timer(unsigned long data);
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 INIT_WORK(&phydev->state_queue, phy_state_machine);
438 init_timer(&phydev->phy_timer);
439 phydev->phy_timer.function = &phy_timer;
440 phydev->phy_timer.data = (unsigned long) phydev;
441 mod_timer(&phydev->phy_timer, jiffies + HZ);
445 * phy_stop_machine - stop the PHY state machine tracking
446 * @phydev: target phy_device struct
448 * Description: Stops the state machine timer, sets the state to UP
449 * (unless it wasn't up yet). This function must be called BEFORE
452 void phy_stop_machine(struct phy_device *phydev)
454 del_timer_sync(&phydev->phy_timer);
455 cancel_work_sync(&phydev->state_queue);
457 mutex_lock(&phydev->lock);
458 if (phydev->state > PHY_UP)
459 phydev->state = PHY_UP;
460 mutex_unlock(&phydev->lock);
462 phydev->adjust_state = NULL;
466 * phy_force_reduction - reduce PHY speed/duplex settings by one step
467 * @phydev: target phy_device struct
469 * Description: Reduces the speed/duplex settings by one notch,
471 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
472 * The function bottoms out at 10/HALF.
474 static void phy_force_reduction(struct phy_device *phydev)
478 idx = phy_find_setting(phydev->speed, phydev->duplex);
482 idx = phy_find_valid(idx, phydev->supported);
484 phydev->speed = settings[idx].speed;
485 phydev->duplex = settings[idx].duplex;
487 pr_info("Trying %d/%s\n", phydev->speed,
488 DUPLEX_FULL == phydev->duplex ?
494 * phy_error - enter HALTED state for this PHY device
495 * @phydev: target phy_device struct
497 * Moves the PHY to the HALTED state in response to a read
498 * or write error, and tells the controller the link is down.
499 * Must not be called from interrupt context, or while the
500 * phydev->lock is held.
502 static void phy_error(struct phy_device *phydev)
504 mutex_lock(&phydev->lock);
505 phydev->state = PHY_HALTED;
506 mutex_unlock(&phydev->lock);
510 * phy_interrupt - PHY interrupt handler
511 * @irq: interrupt line
512 * @phy_dat: phy_device pointer
514 * Description: When a PHY interrupt occurs, the handler disables
515 * interrupts, and schedules a work task to clear the interrupt.
517 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
519 struct phy_device *phydev = phy_dat;
521 if (PHY_HALTED == phydev->state)
522 return IRQ_NONE; /* It can't be ours. */
524 /* The MDIO bus is not allowed to be written in interrupt
525 * context, so we need to disable the irq here. A work
526 * queue will write the PHY to disable and clear the
527 * interrupt, and then reenable the irq line. */
528 disable_irq_nosync(irq);
529 atomic_inc(&phydev->irq_disable);
531 schedule_work(&phydev->phy_queue);
537 * phy_enable_interrupts - Enable the interrupts from the PHY side
538 * @phydev: target phy_device struct
540 int phy_enable_interrupts(struct phy_device *phydev)
544 err = phy_clear_interrupt(phydev);
549 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
553 EXPORT_SYMBOL(phy_enable_interrupts);
556 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
557 * @phydev: target phy_device struct
559 int phy_disable_interrupts(struct phy_device *phydev)
563 /* Disable PHY interrupts */
564 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
569 /* Clear the interrupt */
570 err = phy_clear_interrupt(phydev);
582 EXPORT_SYMBOL(phy_disable_interrupts);
585 * phy_start_interrupts - request and enable interrupts for a PHY device
586 * @phydev: target phy_device struct
588 * Description: Request the interrupt for the given PHY.
589 * If this fails, then we set irq to PHY_POLL.
590 * Otherwise, we enable the interrupts in the PHY.
591 * This should only be called with a valid IRQ number.
592 * Returns 0 on success or < 0 on error.
594 int phy_start_interrupts(struct phy_device *phydev)
598 INIT_WORK(&phydev->phy_queue, phy_change);
600 atomic_set(&phydev->irq_disable, 0);
601 if (request_irq(phydev->irq, phy_interrupt,
605 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
608 phydev->irq = PHY_POLL;
612 err = phy_enable_interrupts(phydev);
616 EXPORT_SYMBOL(phy_start_interrupts);
619 * phy_stop_interrupts - disable interrupts from a PHY device
620 * @phydev: target phy_device struct
622 int phy_stop_interrupts(struct phy_device *phydev)
626 err = phy_disable_interrupts(phydev);
631 free_irq(phydev->irq, phydev);
634 * Cannot call flush_scheduled_work() here as desired because
635 * of rtnl_lock(), but we do not really care about what would
636 * be done, except from enable_irq(), so cancel any work
637 * possibly pending and take care of the matter below.
639 cancel_work_sync(&phydev->phy_queue);
641 * If work indeed has been cancelled, disable_irq() will have
642 * been left unbalanced from phy_interrupt() and enable_irq()
643 * has to be called so that other devices on the line work.
645 while (atomic_dec_return(&phydev->irq_disable) >= 0)
646 enable_irq(phydev->irq);
650 EXPORT_SYMBOL(phy_stop_interrupts);
654 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
655 * @work: work_struct that describes the work to be done
657 static void phy_change(struct work_struct *work)
660 struct phy_device *phydev =
661 container_of(work, struct phy_device, phy_queue);
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 /* Stop timer and run the state queue now. The work function for
684 * state_queue will start the timer up again.
686 del_timer(&phydev->phy_timer);
687 schedule_work(&phydev->state_queue);
692 disable_irq(phydev->irq);
693 atomic_inc(&phydev->irq_disable);
699 * phy_stop - Bring down the PHY link, and stop checking the status
700 * @phydev: target phy_device struct
702 void phy_stop(struct phy_device *phydev)
704 mutex_lock(&phydev->lock);
706 if (PHY_HALTED == phydev->state)
709 if (phydev->irq != PHY_POLL) {
710 /* Disable PHY Interrupts */
711 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
713 /* Clear any pending interrupts */
714 phy_clear_interrupt(phydev);
717 phydev->state = PHY_HALTED;
720 mutex_unlock(&phydev->lock);
723 * Cannot call flush_scheduled_work() here as desired because
724 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
725 * will not reenable interrupts.
731 * phy_start - start or restart a PHY device
732 * @phydev: target phy_device struct
734 * Description: Indicates the attached device's readiness to
735 * handle PHY-related work. Used during startup to start the
736 * PHY, and after a call to phy_stop() to resume operation.
737 * Also used to indicate the MDIO bus has cleared an error
740 void phy_start(struct phy_device *phydev)
742 mutex_lock(&phydev->lock);
744 switch (phydev->state) {
746 phydev->state = PHY_PENDING;
749 phydev->state = PHY_UP;
752 phydev->state = PHY_RESUMING;
756 mutex_unlock(&phydev->lock);
758 EXPORT_SYMBOL(phy_stop);
759 EXPORT_SYMBOL(phy_start);
762 * phy_state_machine - Handle the state machine
763 * @work: work_struct that describes the work to be done
765 * Description: Scheduled by the state_queue workqueue each time
766 * phy_timer is triggered.
768 static void phy_state_machine(struct work_struct *work)
770 struct phy_device *phydev =
771 container_of(work, 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 phydev->state = PHY_RUNNING;
933 phydev->state = PHY_AN;
934 phydev->link_timeout = PHY_AN_TIMEOUT;
937 phydev->state = PHY_RUNNING;
941 mutex_unlock(&phydev->lock);
944 err = phy_start_aneg(phydev);
949 mod_timer(&phydev->phy_timer, jiffies + PHY_STATE_TIME * HZ);
952 /* PHY timer which schedules the state machine work */
953 static void phy_timer(unsigned long data)
955 struct phy_device *phydev = (struct phy_device *)data;
958 * PHY I/O operations can potentially sleep so we ensure that
959 * it's done from a process context
961 schedule_work(&phydev->state_queue);