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 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/sched.h>
20 #include <linux/string.h>
21 #include <linux/errno.h>
22 #include <linux/unistd.h>
23 #include <linux/slab.h>
24 #include <linux/interrupt.h>
25 #include <linux/init.h>
26 #include <linux/delay.h>
27 #include <linux/netdevice.h>
28 #include <linux/etherdevice.h>
29 #include <linux/skbuff.h>
30 #include <linux/spinlock.h>
32 #include <linux/module.h>
33 #include <linux/mii.h>
34 #include <linux/ethtool.h>
35 #include <linux/phy.h>
36 #include <linux/timer.h>
37 #include <linux/workqueue.h>
41 #include <asm/uaccess.h>
43 /* Convenience function to print out the current phy status
45 void phy_print_status(struct phy_device *phydev)
47 pr_info("PHY: %s - Link is %s", phydev->dev.bus_id,
48 phydev->link ? "Up" : "Down");
50 printk(" - %d/%s", phydev->speed,
51 DUPLEX_FULL == phydev->duplex ?
56 EXPORT_SYMBOL(phy_print_status);
59 /* Convenience functions for reading/writing a given PHY
60 * register. They MUST NOT be called from interrupt context,
61 * because the bus read/write functions may wait for an interrupt
62 * to conclude the operation. */
63 int phy_read(struct phy_device *phydev, u16 regnum)
66 struct mii_bus *bus = phydev->bus;
68 spin_lock_bh(&bus->mdio_lock);
69 retval = bus->read(bus, phydev->addr, regnum);
70 spin_unlock_bh(&bus->mdio_lock);
74 EXPORT_SYMBOL(phy_read);
76 int phy_write(struct phy_device *phydev, u16 regnum, u16 val)
79 struct mii_bus *bus = phydev->bus;
81 spin_lock_bh(&bus->mdio_lock);
82 err = bus->write(bus, phydev->addr, regnum, val);
83 spin_unlock_bh(&bus->mdio_lock);
87 EXPORT_SYMBOL(phy_write);
90 int phy_clear_interrupt(struct phy_device *phydev)
94 if (phydev->drv->ack_interrupt)
95 err = phydev->drv->ack_interrupt(phydev);
101 int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
105 phydev->interrupts = interrupts;
106 if (phydev->drv->config_intr)
107 err = phydev->drv->config_intr(phydev);
115 * description: Reads the status register and returns 0 either if
116 * auto-negotiation is incomplete, or if there was an error.
117 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
119 static inline int phy_aneg_done(struct phy_device *phydev)
123 retval = phy_read(phydev, MII_BMSR);
125 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
128 /* A structure for mapping a particular speed and duplex
129 * combination to a particular SUPPORTED and ADVERTISED value */
136 /* A mapping of all SUPPORTED settings to speed/duplex */
137 static const struct phy_setting settings[] = {
140 .duplex = DUPLEX_FULL,
141 .setting = SUPPORTED_10000baseT_Full,
145 .duplex = DUPLEX_FULL,
146 .setting = SUPPORTED_1000baseT_Full,
150 .duplex = DUPLEX_HALF,
151 .setting = SUPPORTED_1000baseT_Half,
155 .duplex = DUPLEX_FULL,
156 .setting = SUPPORTED_100baseT_Full,
160 .duplex = DUPLEX_HALF,
161 .setting = SUPPORTED_100baseT_Half,
165 .duplex = DUPLEX_FULL,
166 .setting = SUPPORTED_10baseT_Full,
170 .duplex = DUPLEX_HALF,
171 .setting = SUPPORTED_10baseT_Half,
175 #define MAX_NUM_SETTINGS (sizeof(settings)/sizeof(struct phy_setting))
179 * description: Searches the settings array for the setting which
180 * matches the desired speed and duplex, and returns the index
181 * of that setting. Returns the index of the last setting if
182 * none of the others match.
184 static inline int phy_find_setting(int speed, int duplex)
188 while (idx < ARRAY_SIZE(settings) &&
189 (settings[idx].speed != speed ||
190 settings[idx].duplex != duplex))
193 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
197 * idx: The first index in settings[] to search
198 * features: A mask of the valid settings
200 * description: Returns the index of the first valid setting less
201 * than or equal to the one pointed to by idx, as determined by
202 * the mask in features. Returns the index of the last setting
203 * if nothing else matches.
205 static inline int phy_find_valid(int idx, u32 features)
207 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
210 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
213 /* phy_sanitize_settings
215 * description: Make sure the PHY is set to supported speeds and
216 * duplexes. Drop down by one in this order: 1000/FULL,
217 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF
219 void phy_sanitize_settings(struct phy_device *phydev)
221 u32 features = phydev->supported;
224 /* Sanitize settings based on PHY capabilities */
225 if ((features & SUPPORTED_Autoneg) == 0)
228 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
231 phydev->speed = settings[idx].speed;
232 phydev->duplex = settings[idx].duplex;
234 EXPORT_SYMBOL(phy_sanitize_settings);
237 * A generic ethtool sset function. Handles all the details
239 * A few notes about parameter checking:
240 * - We don't set port or transceiver, so we don't care what they
242 * - phy_start_aneg() will make sure forced settings are sane, and
243 * choose the next best ones from the ones selected, so we don't
244 * care if ethtool tries to give us bad values
247 int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
249 if (cmd->phy_address != phydev->addr)
252 /* We make sure that we don't pass unsupported
253 * values in to the PHY */
254 cmd->advertising &= phydev->supported;
256 /* Verify the settings we care about. */
257 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
260 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
263 if (cmd->autoneg == AUTONEG_DISABLE
264 && ((cmd->speed != SPEED_1000
265 && cmd->speed != SPEED_100
266 && cmd->speed != SPEED_10)
267 || (cmd->duplex != DUPLEX_HALF
268 && cmd->duplex != DUPLEX_FULL)))
271 phydev->autoneg = cmd->autoneg;
273 phydev->speed = cmd->speed;
275 phydev->advertising = cmd->advertising;
277 if (AUTONEG_ENABLE == cmd->autoneg)
278 phydev->advertising |= ADVERTISED_Autoneg;
280 phydev->advertising &= ~ADVERTISED_Autoneg;
282 phydev->duplex = cmd->duplex;
284 /* Restart the PHY */
285 phy_start_aneg(phydev);
289 EXPORT_SYMBOL(phy_ethtool_sset);
291 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
293 cmd->supported = phydev->supported;
295 cmd->advertising = phydev->advertising;
297 cmd->speed = phydev->speed;
298 cmd->duplex = phydev->duplex;
299 cmd->port = PORT_MII;
300 cmd->phy_address = phydev->addr;
301 cmd->transceiver = XCVR_EXTERNAL;
302 cmd->autoneg = phydev->autoneg;
306 EXPORT_SYMBOL(phy_ethtool_gset);
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;
322 mii_data->val_out = phy_read(phydev, mii_data->reg_num);
326 if (!capable(CAP_NET_ADMIN))
329 if (mii_data->phy_id == phydev->addr) {
330 switch(mii_data->reg_num) {
332 if (val & (BMCR_RESET|BMCR_ANENABLE))
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;
342 phydev->advertising = val;
350 phy_write(phydev, mii_data->reg_num, val);
352 if (mii_data->reg_num == MII_BMCR
354 && phydev->drv->config_init)
355 phydev->drv->config_init(phydev);
364 * description: Sanitizes the settings (if we're not
365 * autonegotiating them), and then calls the driver's
366 * config_aneg function. If the PHYCONTROL Layer is operating,
367 * we change the state to reflect the beginning of
368 * Auto-negotiation or forcing.
370 int phy_start_aneg(struct phy_device *phydev)
374 spin_lock(&phydev->lock);
376 if (AUTONEG_DISABLE == phydev->autoneg)
377 phy_sanitize_settings(phydev);
379 err = phydev->drv->config_aneg(phydev);
384 if (phydev->state != PHY_HALTED) {
385 if (AUTONEG_ENABLE == phydev->autoneg) {
386 phydev->state = PHY_AN;
387 phydev->link_timeout = PHY_AN_TIMEOUT;
389 phydev->state = PHY_FORCING;
390 phydev->link_timeout = PHY_FORCE_TIMEOUT;
395 spin_unlock(&phydev->lock);
398 EXPORT_SYMBOL(phy_start_aneg);
401 static void phy_change(struct work_struct *work);
402 static void phy_timer(unsigned long data);
404 /* phy_start_machine:
406 * description: The PHY infrastructure can run a state machine
407 * which tracks whether the PHY is starting up, negotiating,
408 * etc. This function starts the timer which tracks the state
409 * of the PHY. If you want to be notified when the state
410 * changes, pass in the callback, otherwise, pass NULL. If you
411 * want to maintain your own state machine, do not call this
413 void phy_start_machine(struct phy_device *phydev,
414 void (*handler)(struct net_device *))
416 phydev->adjust_state = handler;
418 init_timer(&phydev->phy_timer);
419 phydev->phy_timer.function = &phy_timer;
420 phydev->phy_timer.data = (unsigned long) phydev;
421 mod_timer(&phydev->phy_timer, jiffies + HZ);
426 * description: Stops the state machine timer, sets the state to UP
427 * (unless it wasn't up yet). This function must be called BEFORE
430 void phy_stop_machine(struct phy_device *phydev)
432 del_timer_sync(&phydev->phy_timer);
434 spin_lock(&phydev->lock);
435 if (phydev->state > PHY_UP)
436 phydev->state = PHY_UP;
437 spin_unlock(&phydev->lock);
439 phydev->adjust_state = NULL;
442 /* phy_force_reduction
444 * description: Reduces the speed/duplex settings by
445 * one notch. The order is so:
446 * 1000/FULL, 1000/HALF, 100/FULL, 100/HALF,
447 * 10/FULL, 10/HALF. The function bottoms out at 10/HALF.
449 static void phy_force_reduction(struct phy_device *phydev)
453 idx = phy_find_setting(phydev->speed, phydev->duplex);
457 idx = phy_find_valid(idx, phydev->supported);
459 phydev->speed = settings[idx].speed;
460 phydev->duplex = settings[idx].duplex;
462 pr_info("Trying %d/%s\n", phydev->speed,
463 DUPLEX_FULL == phydev->duplex ?
470 * Moves the PHY to the HALTED state in response to a read
471 * or write error, and tells the controller the link is down.
472 * Must not be called from interrupt context, or while the
473 * phydev->lock is held.
475 void phy_error(struct phy_device *phydev)
477 spin_lock(&phydev->lock);
478 phydev->state = PHY_HALTED;
479 spin_unlock(&phydev->lock);
484 * description: When a PHY interrupt occurs, the handler disables
485 * interrupts, and schedules a work task to clear the interrupt.
487 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
489 struct phy_device *phydev = phy_dat;
491 if (PHY_HALTED == phydev->state)
492 return IRQ_NONE; /* It can't be ours. */
494 /* The MDIO bus is not allowed to be written in interrupt
495 * context, so we need to disable the irq here. A work
496 * queue will write the PHY to disable and clear the
497 * interrupt, and then reenable the irq line. */
498 disable_irq_nosync(irq);
500 schedule_work(&phydev->phy_queue);
505 /* Enable the interrupts from the PHY side */
506 int phy_enable_interrupts(struct phy_device *phydev)
510 err = phy_clear_interrupt(phydev);
515 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
519 EXPORT_SYMBOL(phy_enable_interrupts);
521 /* Disable the PHY interrupts from the PHY side */
522 int phy_disable_interrupts(struct phy_device *phydev)
526 /* Disable PHY interrupts */
527 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
532 /* Clear the interrupt */
533 err = phy_clear_interrupt(phydev);
545 EXPORT_SYMBOL(phy_disable_interrupts);
547 /* phy_start_interrupts
549 * description: Request the interrupt for the given PHY. If
550 * this fails, then we set irq to PHY_POLL.
551 * Otherwise, we enable the interrupts in the PHY.
552 * Returns 0 on success.
553 * This should only be called with a valid IRQ number.
555 int phy_start_interrupts(struct phy_device *phydev)
559 INIT_WORK(&phydev->phy_queue, phy_change);
561 if (request_irq(phydev->irq, phy_interrupt,
565 printk(KERN_WARNING "%s: Can't get IRQ %d (PHY)\n",
568 phydev->irq = PHY_POLL;
572 err = phy_enable_interrupts(phydev);
576 EXPORT_SYMBOL(phy_start_interrupts);
578 int phy_stop_interrupts(struct phy_device *phydev)
582 err = phy_disable_interrupts(phydev);
588 * Finish any pending work; we might have been scheduled
589 * to be called from keventd ourselves, though.
591 run_scheduled_work(&phydev->phy_queue);
593 free_irq(phydev->irq, phydev);
597 EXPORT_SYMBOL(phy_stop_interrupts);
600 /* Scheduled by the phy_interrupt/timer to handle PHY changes */
601 static void phy_change(struct work_struct *work)
604 struct phy_device *phydev =
605 container_of(work, struct phy_device, phy_queue);
607 err = phy_disable_interrupts(phydev);
612 spin_lock(&phydev->lock);
613 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
614 phydev->state = PHY_CHANGELINK;
615 spin_unlock(&phydev->lock);
617 enable_irq(phydev->irq);
619 /* Reenable interrupts */
620 if (PHY_HALTED != phydev->state)
621 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
629 disable_irq(phydev->irq);
634 /* Bring down the PHY link, and stop checking the status. */
635 void phy_stop(struct phy_device *phydev)
637 spin_lock(&phydev->lock);
639 if (PHY_HALTED == phydev->state)
642 phydev->state = PHY_HALTED;
644 if (phydev->irq != PHY_POLL) {
645 /* Disable PHY Interrupts */
646 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
648 /* Clear any pending interrupts */
649 phy_clear_interrupt(phydev);
653 spin_unlock(&phydev->lock);
656 * Cannot call flush_scheduled_work() here as desired because
657 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
658 * will not reenable interrupts.
665 * description: Indicates the attached device's readiness to
666 * handle PHY-related work. Used during startup to start the
667 * PHY, and after a call to phy_stop() to resume operation.
668 * Also used to indicate the MDIO bus has cleared an error
671 void phy_start(struct phy_device *phydev)
673 spin_lock(&phydev->lock);
675 switch (phydev->state) {
677 phydev->state = PHY_PENDING;
680 phydev->state = PHY_UP;
683 phydev->state = PHY_RESUMING;
687 spin_unlock(&phydev->lock);
689 EXPORT_SYMBOL(phy_stop);
690 EXPORT_SYMBOL(phy_start);
692 /* PHY timer which handles the state machine */
693 static void phy_timer(unsigned long data)
695 struct phy_device *phydev = (struct phy_device *)data;
699 spin_lock(&phydev->lock);
701 if (phydev->adjust_state)
702 phydev->adjust_state(phydev->attached_dev);
704 switch(phydev->state) {
713 phydev->link_timeout = PHY_AN_TIMEOUT;
717 err = phy_read_status(phydev);
722 /* If the link is down, give up on
723 * negotiation for now */
725 phydev->state = PHY_NOLINK;
726 netif_carrier_off(phydev->attached_dev);
727 phydev->adjust_link(phydev->attached_dev);
731 /* Check if negotiation is done. Break
732 * if there's an error */
733 err = phy_aneg_done(phydev);
737 /* If AN is done, we're running */
739 phydev->state = PHY_RUNNING;
740 netif_carrier_on(phydev->attached_dev);
741 phydev->adjust_link(phydev->attached_dev);
743 } else if (0 == phydev->link_timeout--) {
747 /* If we have the magic_aneg bit,
749 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
752 /* The timer expired, and we still
753 * don't have a setting, so we try
754 * forcing it until we find one that
755 * works, starting from the fastest speed,
756 * and working our way down */
757 idx = phy_find_valid(0, phydev->supported);
759 phydev->speed = settings[idx].speed;
760 phydev->duplex = settings[idx].duplex;
762 phydev->autoneg = AUTONEG_DISABLE;
764 pr_info("Trying %d/%s\n", phydev->speed,
771 err = phy_read_status(phydev);
777 phydev->state = PHY_RUNNING;
778 netif_carrier_on(phydev->attached_dev);
779 phydev->adjust_link(phydev->attached_dev);
783 err = genphy_update_link(phydev);
789 phydev->state = PHY_RUNNING;
790 netif_carrier_on(phydev->attached_dev);
792 if (0 == phydev->link_timeout--) {
793 phy_force_reduction(phydev);
798 phydev->adjust_link(phydev->attached_dev);
801 /* Only register a CHANGE if we are
803 if (PHY_POLL == phydev->irq)
804 phydev->state = PHY_CHANGELINK;
807 err = phy_read_status(phydev);
813 phydev->state = PHY_RUNNING;
814 netif_carrier_on(phydev->attached_dev);
816 phydev->state = PHY_NOLINK;
817 netif_carrier_off(phydev->attached_dev);
820 phydev->adjust_link(phydev->attached_dev);
822 if (PHY_POLL != phydev->irq)
823 err = phy_config_interrupt(phydev,
824 PHY_INTERRUPT_ENABLED);
829 netif_carrier_off(phydev->attached_dev);
830 phydev->adjust_link(phydev->attached_dev);
835 err = phy_clear_interrupt(phydev);
840 err = phy_config_interrupt(phydev,
841 PHY_INTERRUPT_ENABLED);
846 if (AUTONEG_ENABLE == phydev->autoneg) {
847 err = phy_aneg_done(phydev);
851 /* err > 0 if AN is done.
852 * Otherwise, it's 0, and we're
853 * still waiting for AN */
855 phydev->state = PHY_RUNNING;
857 phydev->state = PHY_AN;
858 phydev->link_timeout = PHY_AN_TIMEOUT;
861 phydev->state = PHY_RUNNING;
865 spin_unlock(&phydev->lock);
868 err = phy_start_aneg(phydev);
873 mod_timer(&phydev->phy_timer, jiffies + PHY_STATE_TIME * HZ);