2 * Generic PHY Management code
4 * SPDX-License-Identifier: GPL-2.0+
6 * Copyright 2011 Freescale Semiconductor, Inc.
9 * Based loosely off of Linux's PHY Lib
22 #include <linux/err.h>
23 #include <linux/compiler.h>
25 DECLARE_GLOBAL_DATA_PTR;
27 /* Generic PHY support and helper functions */
30 * genphy_config_advert - sanitize and advertise auto-negotation parameters
31 * @phydev: target phy_device struct
33 * Description: Writes MII_ADVERTISE with the appropriate values,
34 * after sanitizing the values to make sure we only advertise
35 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
36 * hasn't changed, and > 0 if it has changed.
38 static int genphy_config_advert(struct phy_device *phydev)
41 int oldadv, adv, bmsr;
44 /* Only allow advertising what this PHY supports */
45 phydev->advertising &= phydev->supported;
46 advertise = phydev->advertising;
48 /* Setup standard advertisement */
49 adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
55 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
56 ADVERTISE_PAUSE_ASYM);
57 if (advertise & ADVERTISED_10baseT_Half)
58 adv |= ADVERTISE_10HALF;
59 if (advertise & ADVERTISED_10baseT_Full)
60 adv |= ADVERTISE_10FULL;
61 if (advertise & ADVERTISED_100baseT_Half)
62 adv |= ADVERTISE_100HALF;
63 if (advertise & ADVERTISED_100baseT_Full)
64 adv |= ADVERTISE_100FULL;
65 if (advertise & ADVERTISED_Pause)
66 adv |= ADVERTISE_PAUSE_CAP;
67 if (advertise & ADVERTISED_Asym_Pause)
68 adv |= ADVERTISE_PAUSE_ASYM;
69 if (advertise & ADVERTISED_1000baseX_Half)
70 adv |= ADVERTISE_1000XHALF;
71 if (advertise & ADVERTISED_1000baseX_Full)
72 adv |= ADVERTISE_1000XFULL;
75 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE, adv);
82 bmsr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
86 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
87 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
90 if (!(bmsr & BMSR_ESTATEN))
93 /* Configure gigabit if it's supported */
94 adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_CTRL1000);
100 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
102 if (phydev->supported & (SUPPORTED_1000baseT_Half |
103 SUPPORTED_1000baseT_Full)) {
104 if (advertise & SUPPORTED_1000baseT_Half)
105 adv |= ADVERTISE_1000HALF;
106 if (advertise & SUPPORTED_1000baseT_Full)
107 adv |= ADVERTISE_1000FULL;
113 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_CTRL1000, adv);
122 * genphy_setup_forced - configures/forces speed/duplex from @phydev
123 * @phydev: target phy_device struct
125 * Description: Configures MII_BMCR to force speed/duplex
126 * to the values in phydev. Assumes that the values are valid.
128 static int genphy_setup_forced(struct phy_device *phydev)
131 int ctl = BMCR_ANRESTART;
133 phydev->pause = phydev->asym_pause = 0;
135 if (SPEED_1000 == phydev->speed)
136 ctl |= BMCR_SPEED1000;
137 else if (SPEED_100 == phydev->speed)
138 ctl |= BMCR_SPEED100;
140 if (DUPLEX_FULL == phydev->duplex)
141 ctl |= BMCR_FULLDPLX;
143 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
150 * genphy_restart_aneg - Enable and Restart Autonegotiation
151 * @phydev: target phy_device struct
153 int genphy_restart_aneg(struct phy_device *phydev)
157 ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
162 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
164 /* Don't isolate the PHY if we're negotiating */
165 ctl &= ~(BMCR_ISOLATE);
167 ctl = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
174 * genphy_config_aneg - restart auto-negotiation or write BMCR
175 * @phydev: target phy_device struct
177 * Description: If auto-negotiation is enabled, we configure the
178 * advertising, and then restart auto-negotiation. If it is not
179 * enabled, then we write the BMCR.
181 int genphy_config_aneg(struct phy_device *phydev)
185 if (AUTONEG_ENABLE != phydev->autoneg)
186 return genphy_setup_forced(phydev);
188 result = genphy_config_advert(phydev);
190 if (result < 0) /* error */
194 /* Advertisment hasn't changed, but maybe aneg was never on to
195 * begin with? Or maybe phy was isolated? */
196 int ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
201 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
202 result = 1; /* do restart aneg */
205 /* Only restart aneg if we are advertising something different
206 * than we were before. */
208 result = genphy_restart_aneg(phydev);
214 * genphy_update_link - update link status in @phydev
215 * @phydev: target phy_device struct
217 * Description: Update the value in phydev->link to reflect the
218 * current link value. In order to do this, we need to read
219 * the status register twice, keeping the second value.
221 int genphy_update_link(struct phy_device *phydev)
223 unsigned int mii_reg;
226 * Wait if the link is up, and autonegotiation is in progress
227 * (ie - we're capable and it's not done)
229 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
232 * If we already saw the link up, and it hasn't gone down, then
233 * we don't need to wait for autoneg again
235 if (phydev->link && mii_reg & BMSR_LSTATUS)
238 if ((phydev->autoneg == AUTONEG_ENABLE) &&
239 !(mii_reg & BMSR_ANEGCOMPLETE)) {
242 printf("%s Waiting for PHY auto negotiation to complete",
244 while (!(mii_reg & BMSR_ANEGCOMPLETE)) {
248 if (i > PHY_ANEG_TIMEOUT) {
249 printf(" TIMEOUT !\n");
255 puts("user interrupt!\n");
260 if ((i++ % 500) == 0)
263 udelay(1000); /* 1 ms */
264 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
269 /* Read the link a second time to clear the latched state */
270 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
272 if (mii_reg & BMSR_LSTATUS)
282 * Generic function which updates the speed and duplex. If
283 * autonegotiation is enabled, it uses the AND of the link
284 * partner's advertised capabilities and our advertised
285 * capabilities. If autonegotiation is disabled, we use the
286 * appropriate bits in the control register.
288 * Stolen from Linux's mii.c and phy_device.c
290 int genphy_parse_link(struct phy_device *phydev)
292 int mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
294 /* We're using autonegotiation */
295 if (phydev->autoneg == AUTONEG_ENABLE) {
300 /* Check for gigabit capability */
301 if (phydev->supported & (SUPPORTED_1000baseT_Full |
302 SUPPORTED_1000baseT_Half)) {
303 /* We want a list of states supported by
304 * both PHYs in the link
306 gblpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_STAT1000);
308 debug("Could not read MII_STAT1000. Ignoring gigabit capability\n");
311 gblpa &= phy_read(phydev,
312 MDIO_DEVAD_NONE, MII_CTRL1000) << 2;
315 /* Set the baseline so we only have to set them
316 * if they're different
318 phydev->speed = SPEED_10;
319 phydev->duplex = DUPLEX_HALF;
321 /* Check the gigabit fields */
322 if (gblpa & (PHY_1000BTSR_1000FD | PHY_1000BTSR_1000HD)) {
323 phydev->speed = SPEED_1000;
325 if (gblpa & PHY_1000BTSR_1000FD)
326 phydev->duplex = DUPLEX_FULL;
332 lpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
333 lpa &= phy_read(phydev, MDIO_DEVAD_NONE, MII_LPA);
335 if (lpa & (LPA_100FULL | LPA_100HALF)) {
336 phydev->speed = SPEED_100;
338 if (lpa & LPA_100FULL)
339 phydev->duplex = DUPLEX_FULL;
341 } else if (lpa & LPA_10FULL)
342 phydev->duplex = DUPLEX_FULL;
345 * Extended status may indicate that the PHY supports
346 * 1000BASE-T/X even though the 1000BASE-T registers
347 * are missing. In this case we can't tell whether the
348 * peer also supports it, so we only check extended
349 * status if the 1000BASE-T registers are actually
352 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
353 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
356 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
357 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
358 phydev->speed = SPEED_1000;
359 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
360 phydev->duplex = DUPLEX_FULL;
364 u32 bmcr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
366 phydev->speed = SPEED_10;
367 phydev->duplex = DUPLEX_HALF;
369 if (bmcr & BMCR_FULLDPLX)
370 phydev->duplex = DUPLEX_FULL;
372 if (bmcr & BMCR_SPEED1000)
373 phydev->speed = SPEED_1000;
374 else if (bmcr & BMCR_SPEED100)
375 phydev->speed = SPEED_100;
381 int genphy_config(struct phy_device *phydev)
386 features = (SUPPORTED_TP | SUPPORTED_MII
387 | SUPPORTED_AUI | SUPPORTED_FIBRE |
390 /* Do we support autonegotiation? */
391 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
396 if (val & BMSR_ANEGCAPABLE)
397 features |= SUPPORTED_Autoneg;
399 if (val & BMSR_100FULL)
400 features |= SUPPORTED_100baseT_Full;
401 if (val & BMSR_100HALF)
402 features |= SUPPORTED_100baseT_Half;
403 if (val & BMSR_10FULL)
404 features |= SUPPORTED_10baseT_Full;
405 if (val & BMSR_10HALF)
406 features |= SUPPORTED_10baseT_Half;
408 if (val & BMSR_ESTATEN) {
409 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
414 if (val & ESTATUS_1000_TFULL)
415 features |= SUPPORTED_1000baseT_Full;
416 if (val & ESTATUS_1000_THALF)
417 features |= SUPPORTED_1000baseT_Half;
418 if (val & ESTATUS_1000_XFULL)
419 features |= SUPPORTED_1000baseX_Full;
420 if (val & ESTATUS_1000_XHALF)
421 features |= SUPPORTED_1000baseX_Half;
424 phydev->supported &= features;
425 phydev->advertising &= features;
427 genphy_config_aneg(phydev);
432 int genphy_startup(struct phy_device *phydev)
436 ret = genphy_update_link(phydev);
440 return genphy_parse_link(phydev);
443 int genphy_shutdown(struct phy_device *phydev)
448 static struct phy_driver genphy_driver = {
451 .name = "Generic PHY",
452 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
453 SUPPORTED_AUI | SUPPORTED_FIBRE |
455 .config = genphy_config,
456 .startup = genphy_startup,
457 .shutdown = genphy_shutdown,
460 static LIST_HEAD(phy_drivers);
464 #ifdef CONFIG_MV88E61XX_SWITCH
465 phy_mv88e61xx_init();
467 #ifdef CONFIG_PHY_AQUANTIA
470 #ifdef CONFIG_PHY_ATHEROS
473 #ifdef CONFIG_PHY_BROADCOM
476 #ifdef CONFIG_PHY_CORTINA
479 #ifdef CONFIG_PHY_DAVICOM
482 #ifdef CONFIG_PHY_ET1011C
485 #ifdef CONFIG_PHY_LXT
488 #ifdef CONFIG_PHY_MARVELL
491 #ifdef CONFIG_PHY_MICREL
494 #ifdef CONFIG_PHY_NATSEMI
497 #ifdef CONFIG_PHY_REALTEK
500 #ifdef CONFIG_PHY_SMSC
503 #ifdef CONFIG_PHY_TERANETICS
504 phy_teranetics_init();
509 #ifdef CONFIG_PHY_VITESSE
512 #ifdef CONFIG_PHY_XILINX
519 int phy_register(struct phy_driver *drv)
521 INIT_LIST_HEAD(&drv->list);
522 list_add_tail(&drv->list, &phy_drivers);
524 #ifdef CONFIG_NEEDS_MANUAL_RELOC
526 drv->probe += gd->reloc_off;
528 drv->config += gd->reloc_off;
530 drv->startup += gd->reloc_off;
532 drv->shutdown += gd->reloc_off;
534 drv->readext += gd->reloc_off;
536 drv->writeext += gd->reloc_off;
541 int phy_set_supported(struct phy_device *phydev, u32 max_speed)
543 /* The default values for phydev->supported are provided by the PHY
544 * driver "features" member, we want to reset to sane defaults first
545 * before supporting higher speeds.
547 phydev->supported &= PHY_DEFAULT_FEATURES;
553 phydev->supported |= PHY_1000BT_FEATURES;
556 phydev->supported |= PHY_100BT_FEATURES;
559 phydev->supported |= PHY_10BT_FEATURES;
565 static int phy_probe(struct phy_device *phydev)
569 phydev->advertising = phydev->supported = phydev->drv->features;
570 phydev->mmds = phydev->drv->mmds;
572 if (phydev->drv->probe)
573 err = phydev->drv->probe(phydev);
578 static struct phy_driver *generic_for_interface(phy_interface_t interface)
580 #ifdef CONFIG_PHYLIB_10G
581 if (is_10g_interface(interface))
582 return &gen10g_driver;
585 return &genphy_driver;
588 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
589 phy_interface_t interface)
591 struct list_head *entry;
592 int phy_id = phydev->phy_id;
593 struct phy_driver *drv = NULL;
595 list_for_each(entry, &phy_drivers) {
596 drv = list_entry(entry, struct phy_driver, list);
597 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
601 /* If we made it here, there's no driver for this PHY */
602 return generic_for_interface(interface);
605 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
607 phy_interface_t interface)
609 struct phy_device *dev;
611 /* We allocate the device, and initialize the
613 dev = malloc(sizeof(*dev));
615 printf("Failed to allocate PHY device for %s:%d\n",
620 memset(dev, 0, sizeof(*dev));
624 dev->interface = interface;
626 dev->autoneg = AUTONEG_ENABLE;
629 dev->phy_id = phy_id;
632 dev->drv = get_phy_driver(dev, interface);
636 bus->phymap[addr] = dev;
642 * get_phy_id - reads the specified addr for its ID.
643 * @bus: the target MII bus
644 * @addr: PHY address on the MII bus
645 * @phy_id: where to store the ID retrieved.
647 * Description: Reads the ID registers of the PHY at @addr on the
648 * @bus, stores it in @phy_id and returns zero on success.
650 int __weak get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
654 /* Grab the bits from PHYIR1, and put them
655 * in the upper half */
656 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
661 *phy_id = (phy_reg & 0xffff) << 16;
663 /* Grab the bits from PHYIR2, and put them in the lower half */
664 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
669 *phy_id |= (phy_reg & 0xffff);
674 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
675 unsigned phy_mask, int devad, phy_interface_t interface)
677 u32 phy_id = 0xffffffff;
679 int addr = ffs(phy_mask) - 1;
680 int r = get_phy_id(bus, addr, devad, &phy_id);
681 /* If the PHY ID is mostly f's, we didn't find anything */
682 if (r == 0 && (phy_id & 0x1fffffff) != 0x1fffffff)
683 return phy_device_create(bus, addr, phy_id, interface);
684 phy_mask &= ~(1 << addr);
689 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
690 unsigned phy_mask, phy_interface_t interface)
692 /* If we have one, return the existing device, with new interface */
694 int addr = ffs(phy_mask) - 1;
695 if (bus->phymap[addr]) {
696 bus->phymap[addr]->interface = interface;
697 return bus->phymap[addr];
699 phy_mask &= ~(1 << addr);
704 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
705 unsigned phy_mask, phy_interface_t interface)
708 struct phy_device *phydev;
710 phydev = search_for_existing_phy(bus, phy_mask, interface);
713 /* Try Standard (ie Clause 22) access */
714 /* Otherwise we have to try Clause 45 */
715 for (i = 0; i < 5; i++) {
716 phydev = create_phy_by_mask(bus, phy_mask,
717 i ? i : MDIO_DEVAD_NONE, interface);
724 debug("\n%s PHY: ", bus->name);
726 int addr = ffs(phy_mask) - 1;
728 phy_mask &= ~(1 << addr);
730 debug("not found\n");
736 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
737 * @bus: the target MII bus
738 * @addr: PHY address on the MII bus
740 * Description: Reads the ID registers of the PHY at @addr on the
741 * @bus, then allocates and returns the phy_device to represent it.
743 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
744 phy_interface_t interface)
746 return get_phy_device_by_mask(bus, 1 << addr, interface);
749 int phy_reset(struct phy_device *phydev)
753 int devad = MDIO_DEVAD_NONE;
755 if (phydev->flags & PHY_FLAG_BROKEN_RESET)
758 #ifdef CONFIG_PHYLIB_10G
759 /* If it's 10G, we need to issue reset through one of the MMDs */
760 if (is_10g_interface(phydev->interface)) {
762 gen10g_discover_mmds(phydev);
764 devad = ffs(phydev->mmds) - 1;
768 if (phy_write(phydev, devad, MII_BMCR, BMCR_RESET) < 0) {
769 debug("PHY reset failed\n");
773 #ifdef CONFIG_PHY_RESET_DELAY
774 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
777 * Poll the control register for the reset bit to go to 0 (it is
778 * auto-clearing). This should happen within 0.5 seconds per the
781 reg = phy_read(phydev, devad, MII_BMCR);
782 while ((reg & BMCR_RESET) && timeout--) {
783 reg = phy_read(phydev, devad, MII_BMCR);
786 debug("PHY status read failed\n");
792 if (reg & BMCR_RESET) {
793 puts("PHY reset timed out\n");
800 int miiphy_reset(const char *devname, unsigned char addr)
802 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
803 struct phy_device *phydev;
806 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
807 * If later code tries to connect with the right interface, this will
808 * be corrected by get_phy_device in phy_connect()
810 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
812 return phy_reset(phydev);
815 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
816 phy_interface_t interface)
822 /* Wait 15ms to make sure the PHY has come out of hard reset */
826 return get_phy_device_by_mask(bus, phy_mask, interface);
830 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev)
832 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
835 /* Soft Reset the PHY */
837 if (phydev->dev && phydev->dev != dev) {
838 printf("%s:%d is connected to %s. Reconnecting to %s\n",
839 phydev->bus->name, phydev->addr,
840 phydev->dev->name, dev->name);
843 debug("%s connected to %s\n", dev->name, phydev->drv->name);
847 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
848 struct udevice *dev, phy_interface_t interface)
850 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
851 struct eth_device *dev, phy_interface_t interface)
854 struct phy_device *phydev;
856 phydev = phy_find_by_mask(bus, 1 << addr, interface);
858 phy_connect_dev(phydev, dev);
860 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
865 * Start the PHY. Returns 0 on success, or a negative error code.
867 int phy_startup(struct phy_device *phydev)
869 if (phydev->drv->startup)
870 return phydev->drv->startup(phydev);
875 __weak int board_phy_config(struct phy_device *phydev)
877 if (phydev->drv->config)
878 return phydev->drv->config(phydev);
882 int phy_config(struct phy_device *phydev)
884 /* Invoke an optional board-specific helper */
885 return board_phy_config(phydev);
888 int phy_shutdown(struct phy_device *phydev)
890 if (phydev->drv->shutdown)
891 phydev->drv->shutdown(phydev);
896 int phy_get_interface_by_name(const char *str)
900 for (i = 0; i < PHY_INTERFACE_MODE_COUNT; i++) {
901 if (!strcmp(str, phy_interface_strings[i]))