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.
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include <linux/kernel.h>
22 #include <linux/string.h>
23 #include <linux/errno.h>
24 #include <linux/unistd.h>
25 #include <linux/interrupt.h>
26 #include <linux/init.h>
27 #include <linux/delay.h>
28 #include <linux/netdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/skbuff.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>
38 #include <linux/mdio.h>
40 #include <linux/atomic.h>
43 #include <asm/uaccess.h>
46 * phy_print_status - Convenience function to print out the current phy status
47 * @phydev: the phy_device struct
49 void phy_print_status(struct phy_device *phydev)
52 pr_info("%s - Link is Up - %d/%s\n",
53 dev_name(&phydev->dev),
55 DUPLEX_FULL == phydev->duplex ? "Full" : "Half");
57 pr_info("%s - Link is Down\n", dev_name(&phydev->dev));
59 EXPORT_SYMBOL(phy_print_status);
62 * phy_clear_interrupt - Ack the phy device's interrupt
63 * @phydev: the phy_device struct
65 * If the @phydev driver has an ack_interrupt function, call it to
66 * ack and clear the phy device's interrupt.
68 * Returns 0 on success on < 0 on error.
70 static int phy_clear_interrupt(struct phy_device *phydev)
74 if (phydev->drv->ack_interrupt)
75 err = phydev->drv->ack_interrupt(phydev);
81 * phy_config_interrupt - configure the PHY device for the requested interrupts
82 * @phydev: the phy_device struct
83 * @interrupts: interrupt flags to configure for this @phydev
85 * Returns 0 on success on < 0 on error.
87 static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
91 phydev->interrupts = interrupts;
92 if (phydev->drv->config_intr)
93 err = phydev->drv->config_intr(phydev);
100 * phy_aneg_done - return auto-negotiation status
101 * @phydev: target phy_device struct
103 * Description: Reads the status register and returns 0 either if
104 * auto-negotiation is incomplete, or if there was an error.
105 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
107 static inline int phy_aneg_done(struct phy_device *phydev)
111 retval = phy_read(phydev, MII_BMSR);
113 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
116 /* A structure for mapping a particular speed and duplex
117 * combination to a particular SUPPORTED and ADVERTISED value */
124 /* A mapping of all SUPPORTED settings to speed/duplex */
125 static const struct phy_setting settings[] = {
128 .duplex = DUPLEX_FULL,
129 .setting = SUPPORTED_10000baseT_Full,
133 .duplex = DUPLEX_FULL,
134 .setting = SUPPORTED_1000baseT_Full,
138 .duplex = DUPLEX_HALF,
139 .setting = SUPPORTED_1000baseT_Half,
143 .duplex = DUPLEX_FULL,
144 .setting = SUPPORTED_100baseT_Full,
148 .duplex = DUPLEX_HALF,
149 .setting = SUPPORTED_100baseT_Half,
153 .duplex = DUPLEX_FULL,
154 .setting = SUPPORTED_10baseT_Full,
158 .duplex = DUPLEX_HALF,
159 .setting = SUPPORTED_10baseT_Half,
163 #define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
166 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
167 * @speed: speed to match
168 * @duplex: duplex to match
170 * Description: Searches the settings array for the setting which
171 * matches the desired speed and duplex, and returns the index
172 * of that setting. Returns the index of the last setting if
173 * none of the others match.
175 static inline int phy_find_setting(int speed, int duplex)
179 while (idx < ARRAY_SIZE(settings) &&
180 (settings[idx].speed != speed ||
181 settings[idx].duplex != duplex))
184 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
188 * phy_find_valid - find a PHY setting that matches the requested features mask
189 * @idx: The first index in settings[] to search
190 * @features: A mask of the valid settings
192 * Description: Returns the index of the first valid setting less
193 * than or equal to the one pointed to by idx, as determined by
194 * the mask in features. Returns the index of the last setting
195 * if nothing else matches.
197 static inline int phy_find_valid(int idx, u32 features)
199 while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
202 return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
206 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
207 * @phydev: the target phy_device struct
209 * Description: Make sure the PHY is set to supported speeds and
210 * duplexes. Drop down by one in this order: 1000/FULL,
211 * 1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
213 static void phy_sanitize_settings(struct phy_device *phydev)
215 u32 features = phydev->supported;
218 /* Sanitize settings based on PHY capabilities */
219 if ((features & SUPPORTED_Autoneg) == 0)
220 phydev->autoneg = AUTONEG_DISABLE;
222 idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
225 phydev->speed = settings[idx].speed;
226 phydev->duplex = settings[idx].duplex;
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 u32 speed = ethtool_cmd_speed(cmd);
245 if (cmd->phy_address != phydev->addr)
248 /* We make sure that we don't pass unsupported
249 * values in to the PHY */
250 cmd->advertising &= phydev->supported;
252 /* Verify the settings we care about. */
253 if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
256 if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
259 if (cmd->autoneg == AUTONEG_DISABLE &&
260 ((speed != SPEED_1000 &&
261 speed != SPEED_100 &&
262 speed != SPEED_10) ||
263 (cmd->duplex != DUPLEX_HALF &&
264 cmd->duplex != DUPLEX_FULL)))
267 phydev->autoneg = cmd->autoneg;
269 phydev->speed = speed;
271 phydev->advertising = cmd->advertising;
273 if (AUTONEG_ENABLE == cmd->autoneg)
274 phydev->advertising |= ADVERTISED_Autoneg;
276 phydev->advertising &= ~ADVERTISED_Autoneg;
278 phydev->duplex = cmd->duplex;
280 /* Restart the PHY */
281 phy_start_aneg(phydev);
285 EXPORT_SYMBOL(phy_ethtool_sset);
287 int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
289 cmd->supported = phydev->supported;
291 cmd->advertising = phydev->advertising;
293 ethtool_cmd_speed_set(cmd, phydev->speed);
294 cmd->duplex = phydev->duplex;
295 cmd->port = PORT_MII;
296 cmd->phy_address = phydev->addr;
297 cmd->transceiver = XCVR_EXTERNAL;
298 cmd->autoneg = phydev->autoneg;
302 EXPORT_SYMBOL(phy_ethtool_gset);
305 * phy_mii_ioctl - generic PHY MII ioctl interface
306 * @phydev: the phy_device struct
307 * @ifr: &struct ifreq for socket ioctl's
308 * @cmd: ioctl cmd to execute
310 * Note that this function is currently incompatible with the
311 * PHYCONTROL layer. It changes registers without regard to
312 * current state. Use at own risk.
314 int phy_mii_ioctl(struct phy_device *phydev,
315 struct ifreq *ifr, int cmd)
317 struct mii_ioctl_data *mii_data = if_mii(ifr);
318 u16 val = mii_data->val_in;
322 mii_data->phy_id = phydev->addr;
326 mii_data->val_out = mdiobus_read(phydev->bus, mii_data->phy_id,
331 if (mii_data->phy_id == phydev->addr) {
332 switch(mii_data->reg_num) {
334 if ((val & (BMCR_RESET|BMCR_ANENABLE)) == 0)
335 phydev->autoneg = AUTONEG_DISABLE;
337 phydev->autoneg = AUTONEG_ENABLE;
338 if ((!phydev->autoneg) && (val & BMCR_FULLDPLX))
339 phydev->duplex = DUPLEX_FULL;
341 phydev->duplex = DUPLEX_HALF;
342 if ((!phydev->autoneg) &&
343 (val & BMCR_SPEED1000))
344 phydev->speed = SPEED_1000;
345 else if ((!phydev->autoneg) &&
346 (val & BMCR_SPEED100))
347 phydev->speed = SPEED_100;
350 phydev->advertising = val;
358 mdiobus_write(phydev->bus, mii_data->phy_id,
359 mii_data->reg_num, val);
361 if (mii_data->reg_num == MII_BMCR &&
363 phydev->drv->config_init) {
364 phy_scan_fixups(phydev);
365 phydev->drv->config_init(phydev);
370 if (phydev->drv->hwtstamp)
371 return phydev->drv->hwtstamp(phydev, ifr);
380 EXPORT_SYMBOL(phy_mii_ioctl);
383 * phy_start_aneg - start auto-negotiation for this PHY device
384 * @phydev: the phy_device struct
386 * Description: Sanitizes the settings (if we're not autonegotiating
387 * them), and then calls the driver's config_aneg function.
388 * If the PHYCONTROL Layer is operating, we change the state to
389 * reflect the beginning of Auto-negotiation or forcing.
391 int phy_start_aneg(struct phy_device *phydev)
395 mutex_lock(&phydev->lock);
397 if (AUTONEG_DISABLE == phydev->autoneg)
398 phy_sanitize_settings(phydev);
400 err = phydev->drv->config_aneg(phydev);
405 if (phydev->state != PHY_HALTED) {
406 if (AUTONEG_ENABLE == phydev->autoneg) {
407 phydev->state = PHY_AN;
408 phydev->link_timeout = PHY_AN_TIMEOUT;
410 phydev->state = PHY_FORCING;
411 phydev->link_timeout = PHY_FORCE_TIMEOUT;
416 mutex_unlock(&phydev->lock);
419 EXPORT_SYMBOL(phy_start_aneg);
422 static void phy_change(struct work_struct *work);
425 * phy_start_machine - start PHY state machine tracking
426 * @phydev: the phy_device struct
427 * @handler: callback function for state change notifications
429 * Description: The PHY infrastructure can run a state machine
430 * which tracks whether the PHY is starting up, negotiating,
431 * etc. This function starts the timer which tracks the state
432 * of the PHY. If you want to be notified when the state changes,
433 * pass in the callback @handler, otherwise, pass NULL. If you
434 * want to maintain your own state machine, do not call this
437 void phy_start_machine(struct phy_device *phydev,
438 void (*handler)(struct net_device *))
440 phydev->adjust_state = handler;
442 schedule_delayed_work(&phydev->state_queue, HZ);
446 * phy_stop_machine - stop the PHY state machine tracking
447 * @phydev: target phy_device struct
449 * Description: Stops the state machine timer, sets the state to UP
450 * (unless it wasn't up yet). This function must be called BEFORE
453 void phy_stop_machine(struct phy_device *phydev)
455 cancel_delayed_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_error - enter HALTED state for this PHY device
467 * @phydev: target phy_device struct
469 * Moves the PHY to the HALTED state in response to a read
470 * or write error, and tells the controller the link is down.
471 * Must not be called from interrupt context, or while the
472 * phydev->lock is held.
474 static void phy_error(struct phy_device *phydev)
476 mutex_lock(&phydev->lock);
477 phydev->state = PHY_HALTED;
478 mutex_unlock(&phydev->lock);
482 * phy_interrupt - PHY interrupt handler
483 * @irq: interrupt line
484 * @phy_dat: phy_device pointer
486 * Description: When a PHY interrupt occurs, the handler disables
487 * interrupts, and schedules a work task to clear the interrupt.
489 static irqreturn_t phy_interrupt(int irq, void *phy_dat)
491 struct phy_device *phydev = phy_dat;
493 if (PHY_HALTED == phydev->state)
494 return IRQ_NONE; /* It can't be ours. */
496 /* The MDIO bus is not allowed to be written in interrupt
497 * context, so we need to disable the irq here. A work
498 * queue will write the PHY to disable and clear the
499 * interrupt, and then reenable the irq line. */
500 disable_irq_nosync(irq);
501 atomic_inc(&phydev->irq_disable);
503 schedule_work(&phydev->phy_queue);
509 * phy_enable_interrupts - Enable the interrupts from the PHY side
510 * @phydev: target phy_device struct
512 static int phy_enable_interrupts(struct phy_device *phydev)
516 err = phy_clear_interrupt(phydev);
521 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
527 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
528 * @phydev: target phy_device struct
530 static int phy_disable_interrupts(struct phy_device *phydev)
534 /* Disable PHY interrupts */
535 err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
540 /* Clear the interrupt */
541 err = phy_clear_interrupt(phydev);
555 * phy_start_interrupts - request and enable interrupts for a PHY device
556 * @phydev: target phy_device struct
558 * Description: Request the interrupt for the given PHY.
559 * If this fails, then we set irq to PHY_POLL.
560 * Otherwise, we enable the interrupts in the PHY.
561 * This should only be called with a valid IRQ number.
562 * Returns 0 on success or < 0 on error.
564 int phy_start_interrupts(struct phy_device *phydev)
568 INIT_WORK(&phydev->phy_queue, phy_change);
570 atomic_set(&phydev->irq_disable, 0);
571 if (request_irq(phydev->irq, phy_interrupt,
575 pr_warn("%s: Can't get IRQ %d (PHY)\n",
576 phydev->bus->name, phydev->irq);
577 phydev->irq = PHY_POLL;
581 err = phy_enable_interrupts(phydev);
585 EXPORT_SYMBOL(phy_start_interrupts);
588 * phy_stop_interrupts - disable interrupts from a PHY device
589 * @phydev: target phy_device struct
591 int phy_stop_interrupts(struct phy_device *phydev)
595 err = phy_disable_interrupts(phydev);
600 free_irq(phydev->irq, phydev);
603 * Cannot call flush_scheduled_work() here as desired because
604 * of rtnl_lock(), but we do not really care about what would
605 * be done, except from enable_irq(), so cancel any work
606 * possibly pending and take care of the matter below.
608 cancel_work_sync(&phydev->phy_queue);
610 * If work indeed has been cancelled, disable_irq() will have
611 * been left unbalanced from phy_interrupt() and enable_irq()
612 * has to be called so that other devices on the line work.
614 while (atomic_dec_return(&phydev->irq_disable) >= 0)
615 enable_irq(phydev->irq);
619 EXPORT_SYMBOL(phy_stop_interrupts);
623 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
624 * @work: work_struct that describes the work to be done
626 static void phy_change(struct work_struct *work)
629 struct phy_device *phydev =
630 container_of(work, struct phy_device, phy_queue);
632 if (phydev->drv->did_interrupt &&
633 !phydev->drv->did_interrupt(phydev))
636 err = phy_disable_interrupts(phydev);
641 mutex_lock(&phydev->lock);
642 if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
643 phydev->state = PHY_CHANGELINK;
644 mutex_unlock(&phydev->lock);
646 atomic_dec(&phydev->irq_disable);
647 enable_irq(phydev->irq);
649 /* Reenable interrupts */
650 if (PHY_HALTED != phydev->state)
651 err = phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
656 /* reschedule state queue work to run as soon as possible */
657 cancel_delayed_work_sync(&phydev->state_queue);
658 schedule_delayed_work(&phydev->state_queue, 0);
663 atomic_dec(&phydev->irq_disable);
664 enable_irq(phydev->irq);
668 disable_irq(phydev->irq);
669 atomic_inc(&phydev->irq_disable);
675 * phy_stop - Bring down the PHY link, and stop checking the status
676 * @phydev: target phy_device struct
678 void phy_stop(struct phy_device *phydev)
680 mutex_lock(&phydev->lock);
682 if (PHY_HALTED == phydev->state)
685 if (phydev->irq != PHY_POLL) {
686 /* Disable PHY Interrupts */
687 phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
689 /* Clear any pending interrupts */
690 phy_clear_interrupt(phydev);
693 phydev->state = PHY_HALTED;
696 mutex_unlock(&phydev->lock);
699 * Cannot call flush_scheduled_work() here as desired because
700 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
701 * will not reenable interrupts.
707 * phy_start - start or restart a PHY device
708 * @phydev: target phy_device struct
710 * Description: Indicates the attached device's readiness to
711 * handle PHY-related work. Used during startup to start the
712 * PHY, and after a call to phy_stop() to resume operation.
713 * Also used to indicate the MDIO bus has cleared an error
716 void phy_start(struct phy_device *phydev)
718 mutex_lock(&phydev->lock);
720 switch (phydev->state) {
722 phydev->state = PHY_PENDING;
725 phydev->state = PHY_UP;
728 phydev->state = PHY_RESUMING;
732 mutex_unlock(&phydev->lock);
734 EXPORT_SYMBOL(phy_stop);
735 EXPORT_SYMBOL(phy_start);
738 * phy_state_machine - Handle the state machine
739 * @work: work_struct that describes the work to be done
741 void phy_state_machine(struct work_struct *work)
743 struct delayed_work *dwork = to_delayed_work(work);
744 struct phy_device *phydev =
745 container_of(dwork, struct phy_device, state_queue);
749 mutex_lock(&phydev->lock);
751 if (phydev->adjust_state)
752 phydev->adjust_state(phydev->attached_dev);
754 switch(phydev->state) {
763 phydev->link_timeout = PHY_AN_TIMEOUT;
767 err = phy_read_status(phydev);
772 /* If the link is down, give up on
773 * negotiation for now */
775 phydev->state = PHY_NOLINK;
776 netif_carrier_off(phydev->attached_dev);
777 phydev->adjust_link(phydev->attached_dev);
781 /* Check if negotiation is done. Break
782 * if there's an error */
783 err = phy_aneg_done(phydev);
787 /* If AN is done, we're running */
789 phydev->state = PHY_RUNNING;
790 netif_carrier_on(phydev->attached_dev);
791 phydev->adjust_link(phydev->attached_dev);
793 } else if (0 == phydev->link_timeout--) {
795 /* If we have the magic_aneg bit,
797 if (phydev->drv->flags & PHY_HAS_MAGICANEG)
802 err = phy_read_status(phydev);
808 phydev->state = PHY_RUNNING;
809 netif_carrier_on(phydev->attached_dev);
810 phydev->adjust_link(phydev->attached_dev);
814 err = genphy_update_link(phydev);
820 phydev->state = PHY_RUNNING;
821 netif_carrier_on(phydev->attached_dev);
823 if (0 == phydev->link_timeout--)
827 phydev->adjust_link(phydev->attached_dev);
830 /* Only register a CHANGE if we are
832 if (PHY_POLL == phydev->irq)
833 phydev->state = PHY_CHANGELINK;
836 err = phy_read_status(phydev);
842 phydev->state = PHY_RUNNING;
843 netif_carrier_on(phydev->attached_dev);
845 phydev->state = PHY_NOLINK;
846 netif_carrier_off(phydev->attached_dev);
849 phydev->adjust_link(phydev->attached_dev);
851 if (PHY_POLL != phydev->irq)
852 err = phy_config_interrupt(phydev,
853 PHY_INTERRUPT_ENABLED);
858 netif_carrier_off(phydev->attached_dev);
859 phydev->adjust_link(phydev->attached_dev);
864 err = phy_clear_interrupt(phydev);
869 err = phy_config_interrupt(phydev,
870 PHY_INTERRUPT_ENABLED);
875 if (AUTONEG_ENABLE == phydev->autoneg) {
876 err = phy_aneg_done(phydev);
880 /* err > 0 if AN is done.
881 * Otherwise, it's 0, and we're
882 * still waiting for AN */
884 err = phy_read_status(phydev);
889 phydev->state = PHY_RUNNING;
890 netif_carrier_on(phydev->attached_dev);
892 phydev->state = PHY_NOLINK;
893 phydev->adjust_link(phydev->attached_dev);
895 phydev->state = PHY_AN;
896 phydev->link_timeout = PHY_AN_TIMEOUT;
899 err = phy_read_status(phydev);
904 phydev->state = PHY_RUNNING;
905 netif_carrier_on(phydev->attached_dev);
907 phydev->state = PHY_NOLINK;
908 phydev->adjust_link(phydev->attached_dev);
913 mutex_unlock(&phydev->lock);
916 err = phy_start_aneg(phydev);
921 schedule_delayed_work(&phydev->state_queue, PHY_STATE_TIME * HZ);
924 static inline void mmd_phy_indirect(struct mii_bus *bus, int prtad, int devad,
927 /* Write the desired MMD Devad */
928 bus->write(bus, addr, MII_MMD_CTRL, devad);
930 /* Write the desired MMD register address */
931 bus->write(bus, addr, MII_MMD_DATA, prtad);
933 /* Select the Function : DATA with no post increment */
934 bus->write(bus, addr, MII_MMD_CTRL, (devad | MII_MMD_CTRL_NOINCR));
938 * phy_read_mmd_indirect - reads data from the MMD registers
939 * @bus: the target MII bus
940 * @prtad: MMD Address
942 * @addr: PHY address on the MII bus
944 * Description: it reads data from the MMD registers (clause 22 to access to
945 * clause 45) of the specified phy address.
946 * To read these register we have:
947 * 1) Write reg 13 // DEVAD
948 * 2) Write reg 14 // MMD Address
949 * 3) Write reg 13 // MMD Data Command for MMD DEVAD
950 * 3) Read reg 14 // Read MMD data
952 static int phy_read_mmd_indirect(struct mii_bus *bus, int prtad, int devad,
957 mmd_phy_indirect(bus, prtad, devad, addr);
959 /* Read the content of the MMD's selected register */
960 ret = bus->read(bus, addr, MII_MMD_DATA);
966 * phy_write_mmd_indirect - writes data to the MMD registers
967 * @bus: the target MII bus
968 * @prtad: MMD Address
970 * @addr: PHY address on the MII bus
971 * @data: data to write in the MMD register
973 * Description: Write data from the MMD registers of the specified
975 * To write these register we have:
976 * 1) Write reg 13 // DEVAD
977 * 2) Write reg 14 // MMD Address
978 * 3) Write reg 13 // MMD Data Command for MMD DEVAD
979 * 3) Write reg 14 // Write MMD data
981 static void phy_write_mmd_indirect(struct mii_bus *bus, int prtad, int devad,
984 mmd_phy_indirect(bus, prtad, devad, addr);
986 /* Write the data into MMD's selected register */
987 bus->write(bus, addr, MII_MMD_DATA, data);
991 * phy_init_eee - init and check the EEE feature
992 * @phydev: target phy_device struct
993 * @clk_stop_enable: PHY may stop the clock during LPI
995 * Description: it checks if the Energy-Efficient Ethernet (EEE)
996 * is supported by looking at the MMD registers 3.20 and 7.60/61
997 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1000 int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1002 int ret = -EPROTONOSUPPORT;
1004 /* According to 802.3az,the EEE is supported only in full duplex-mode.
1005 * Also EEE feature is active when core is operating with MII, GMII
1008 if ((phydev->duplex == DUPLEX_FULL) &&
1009 ((phydev->interface == PHY_INTERFACE_MODE_MII) ||
1010 (phydev->interface == PHY_INTERFACE_MODE_GMII) ||
1011 (phydev->interface == PHY_INTERFACE_MODE_RGMII))) {
1012 int eee_lp, eee_cap, eee_adv;
1016 /* Read phy status to properly get the right settings */
1017 status = phy_read_status(phydev);
1021 /* First check if the EEE ability is supported */
1022 eee_cap = phy_read_mmd_indirect(phydev->bus, MDIO_PCS_EEE_ABLE,
1023 MDIO_MMD_PCS, phydev->addr);
1027 cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1031 /* Check which link settings negotiated and verify it in
1032 * the EEE advertising registers.
1034 eee_lp = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_LPABLE,
1035 MDIO_MMD_AN, phydev->addr);
1039 eee_adv = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_ADV,
1040 MDIO_MMD_AN, phydev->addr);
1044 adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
1045 lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1046 idx = phy_find_setting(phydev->speed, phydev->duplex);
1047 if ((lp & adv & settings[idx].setting))
1050 if (clk_stop_enable) {
1051 /* Configure the PHY to stop receiving xMII
1052 * clock while it is signaling LPI.
1054 int val = phy_read_mmd_indirect(phydev->bus, MDIO_CTRL1,
1060 val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1061 phy_write_mmd_indirect(phydev->bus, MDIO_CTRL1,
1062 MDIO_MMD_PCS, phydev->addr, val);
1065 ret = 0; /* EEE supported */
1071 EXPORT_SYMBOL(phy_init_eee);
1074 * phy_get_eee_err - report the EEE wake error count
1075 * @phydev: target phy_device struct
1077 * Description: it is to report the number of time where the PHY
1078 * failed to complete its normal wake sequence.
1080 int phy_get_eee_err(struct phy_device *phydev)
1082 return phy_read_mmd_indirect(phydev->bus, MDIO_PCS_EEE_WK_ERR,
1083 MDIO_MMD_PCS, phydev->addr);
1086 EXPORT_SYMBOL(phy_get_eee_err);
1089 * phy_ethtool_get_eee - get EEE supported and status
1090 * @phydev: target phy_device struct
1091 * @data: ethtool_eee data
1093 * Description: it reportes the Supported/Advertisement/LP Advertisement
1096 int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1100 /* Get Supported EEE */
1101 val = phy_read_mmd_indirect(phydev->bus, MDIO_PCS_EEE_ABLE,
1102 MDIO_MMD_PCS, phydev->addr);
1105 data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1107 /* Get advertisement EEE */
1108 val = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_ADV,
1109 MDIO_MMD_AN, phydev->addr);
1112 data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1114 /* Get LP advertisement EEE */
1115 val = phy_read_mmd_indirect(phydev->bus, MDIO_AN_EEE_LPABLE,
1116 MDIO_MMD_AN, phydev->addr);
1119 data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1123 EXPORT_SYMBOL(phy_ethtool_get_eee);
1126 * phy_ethtool_set_eee - set EEE supported and status
1127 * @phydev: target phy_device struct
1128 * @data: ethtool_eee data
1130 * Description: it is to program the Advertisement EEE register.
1132 int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1136 val = ethtool_adv_to_mmd_eee_adv_t(data->advertised);
1137 phy_write_mmd_indirect(phydev->bus, MDIO_AN_EEE_ADV, MDIO_MMD_AN,
1142 EXPORT_SYMBOL(phy_ethtool_set_eee);
1144 int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1146 if (phydev->drv->set_wol)
1147 return phydev->drv->set_wol(phydev, wol);
1151 EXPORT_SYMBOL(phy_ethtool_set_wol);
1153 void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1155 if (phydev->drv->get_wol)
1156 phydev->drv->get_wol(phydev, wol);
1158 EXPORT_SYMBOL(phy_ethtool_get_wol);