1 // SPDX-License-Identifier: GPL-2.0+
3 * Generic PHY Management code
5 * Copyright 2011 Freescale Semiconductor, Inc.
8 * Based loosely off of Linux's PHY Lib
19 #include <linux/err.h>
20 #include <linux/compiler.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 /* Generic PHY support and helper functions */
27 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
28 * @phydev: target phy_device struct
30 * Description: Writes MII_ADVERTISE with the appropriate values,
31 * after sanitizing the values to make sure we only advertise
32 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
33 * hasn't changed, and > 0 if it has changed.
35 static int genphy_config_advert(struct phy_device *phydev)
38 int oldadv, adv, bmsr;
41 /* Only allow advertising what this PHY supports */
42 phydev->advertising &= phydev->supported;
43 advertise = phydev->advertising;
45 /* Setup standard advertisement */
46 adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
52 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
53 ADVERTISE_PAUSE_ASYM);
54 if (advertise & ADVERTISED_10baseT_Half)
55 adv |= ADVERTISE_10HALF;
56 if (advertise & ADVERTISED_10baseT_Full)
57 adv |= ADVERTISE_10FULL;
58 if (advertise & ADVERTISED_100baseT_Half)
59 adv |= ADVERTISE_100HALF;
60 if (advertise & ADVERTISED_100baseT_Full)
61 adv |= ADVERTISE_100FULL;
62 if (advertise & ADVERTISED_Pause)
63 adv |= ADVERTISE_PAUSE_CAP;
64 if (advertise & ADVERTISED_Asym_Pause)
65 adv |= ADVERTISE_PAUSE_ASYM;
66 if (advertise & ADVERTISED_1000baseX_Half)
67 adv |= ADVERTISE_1000XHALF;
68 if (advertise & ADVERTISED_1000baseX_Full)
69 adv |= ADVERTISE_1000XFULL;
72 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE, adv);
79 bmsr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
83 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
84 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
87 if (!(bmsr & BMSR_ESTATEN))
90 /* Configure gigabit if it's supported */
91 adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_CTRL1000);
97 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
99 if (phydev->supported & (SUPPORTED_1000baseT_Half |
100 SUPPORTED_1000baseT_Full)) {
101 if (advertise & SUPPORTED_1000baseT_Half)
102 adv |= ADVERTISE_1000HALF;
103 if (advertise & SUPPORTED_1000baseT_Full)
104 adv |= ADVERTISE_1000FULL;
110 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_CTRL1000, adv);
118 * genphy_setup_forced - configures/forces speed/duplex from @phydev
119 * @phydev: target phy_device struct
121 * Description: Configures MII_BMCR to force speed/duplex
122 * to the values in phydev. Assumes that the values are valid.
124 static int genphy_setup_forced(struct phy_device *phydev)
127 int ctl = BMCR_ANRESTART;
130 phydev->asym_pause = 0;
132 if (phydev->speed == SPEED_1000)
133 ctl |= BMCR_SPEED1000;
134 else if (phydev->speed == SPEED_100)
135 ctl |= BMCR_SPEED100;
137 if (phydev->duplex == DUPLEX_FULL)
138 ctl |= BMCR_FULLDPLX;
140 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
146 * genphy_restart_aneg - Enable and Restart Autonegotiation
147 * @phydev: target phy_device struct
149 int genphy_restart_aneg(struct phy_device *phydev)
153 ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
158 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
160 /* Don't isolate the PHY if we're negotiating */
161 ctl &= ~(BMCR_ISOLATE);
163 ctl = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
169 * genphy_config_aneg - restart auto-negotiation or write BMCR
170 * @phydev: target phy_device struct
172 * Description: If auto-negotiation is enabled, we configure the
173 * advertising, and then restart auto-negotiation. If it is not
174 * enabled, then we write the BMCR.
176 int genphy_config_aneg(struct phy_device *phydev)
180 if (phydev->autoneg != AUTONEG_ENABLE)
181 return genphy_setup_forced(phydev);
183 result = genphy_config_advert(phydev);
185 if (result < 0) /* error */
190 * Advertisment hasn't changed, but maybe aneg was never on to
191 * begin with? Or maybe phy was isolated?
193 int ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
198 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
199 result = 1; /* do restart aneg */
203 * Only restart aneg if we are advertising something different
204 * than we were before.
207 result = genphy_restart_aneg(phydev);
213 * genphy_update_link - update link status in @phydev
214 * @phydev: target phy_device struct
216 * Description: Update the value in phydev->link to reflect the
217 * current link value. In order to do this, we need to read
218 * the status register twice, keeping the second value.
220 int genphy_update_link(struct phy_device *phydev)
222 unsigned int mii_reg;
225 * Wait if the link is up, and autonegotiation is in progress
226 * (ie - we're capable and it's not done)
228 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
231 * If we already saw the link up, and it hasn't gone down, then
232 * we don't need to wait for autoneg again
234 if (phydev->link && mii_reg & BMSR_LSTATUS)
237 if ((phydev->autoneg == AUTONEG_ENABLE) &&
238 !(mii_reg & BMSR_ANEGCOMPLETE)) {
241 printf("%s Waiting for PHY auto negotiation to complete",
243 while (!(mii_reg & BMSR_ANEGCOMPLETE)) {
247 if (i > PHY_ANEG_TIMEOUT) {
248 printf(" TIMEOUT !\n");
254 puts("user interrupt!\n");
259 if ((i++ % 500) == 0)
262 udelay(1000); /* 1 ms */
263 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
268 /* Read the link a second time to clear the latched state */
269 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
271 if (mii_reg & BMSR_LSTATUS)
281 * Generic function which updates the speed and duplex. If
282 * autonegotiation is enabled, it uses the AND of the link
283 * partner's advertised capabilities and our advertised
284 * capabilities. If autonegotiation is disabled, we use the
285 * appropriate bits in the control register.
287 * Stolen from Linux's mii.c and phy_device.c
289 int genphy_parse_link(struct phy_device *phydev)
291 int mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
293 /* We're using autonegotiation */
294 if (phydev->autoneg == AUTONEG_ENABLE) {
299 /* Check for gigabit capability */
300 if (phydev->supported & (SUPPORTED_1000baseT_Full |
301 SUPPORTED_1000baseT_Half)) {
302 /* We want a list of states supported by
303 * both PHYs in the link
305 gblpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_STAT1000);
307 debug("Could not read MII_STAT1000. ");
308 debug("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;
346 * Extended status may indicate that the PHY supports
347 * 1000BASE-T/X even though the 1000BASE-T registers
348 * are missing. In this case we can't tell whether the
349 * peer also supports it, so we only check extended
350 * status if the 1000BASE-T registers are actually
353 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
354 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
357 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
358 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
359 phydev->speed = SPEED_1000;
360 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
361 phydev->duplex = DUPLEX_FULL;
365 u32 bmcr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
367 phydev->speed = SPEED_10;
368 phydev->duplex = DUPLEX_HALF;
370 if (bmcr & BMCR_FULLDPLX)
371 phydev->duplex = DUPLEX_FULL;
373 if (bmcr & BMCR_SPEED1000)
374 phydev->speed = SPEED_1000;
375 else if (bmcr & BMCR_SPEED100)
376 phydev->speed = SPEED_100;
382 int genphy_config(struct phy_device *phydev)
387 features = (SUPPORTED_TP | SUPPORTED_MII
388 | SUPPORTED_AUI | SUPPORTED_FIBRE |
391 /* Do we support autonegotiation? */
392 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
397 if (val & BMSR_ANEGCAPABLE)
398 features |= SUPPORTED_Autoneg;
400 if (val & BMSR_100FULL)
401 features |= SUPPORTED_100baseT_Full;
402 if (val & BMSR_100HALF)
403 features |= SUPPORTED_100baseT_Half;
404 if (val & BMSR_10FULL)
405 features |= SUPPORTED_10baseT_Full;
406 if (val & BMSR_10HALF)
407 features |= SUPPORTED_10baseT_Half;
409 if (val & BMSR_ESTATEN) {
410 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
415 if (val & ESTATUS_1000_TFULL)
416 features |= SUPPORTED_1000baseT_Full;
417 if (val & ESTATUS_1000_THALF)
418 features |= SUPPORTED_1000baseT_Half;
419 if (val & ESTATUS_1000_XFULL)
420 features |= SUPPORTED_1000baseX_Full;
421 if (val & ESTATUS_1000_XHALF)
422 features |= SUPPORTED_1000baseX_Half;
425 phydev->supported &= features;
426 phydev->advertising &= features;
428 genphy_config_aneg(phydev);
433 int genphy_startup(struct phy_device *phydev)
437 ret = genphy_update_link(phydev);
441 return genphy_parse_link(phydev);
444 int genphy_shutdown(struct phy_device *phydev)
449 static struct phy_driver genphy_driver = {
452 .name = "Generic PHY",
453 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
454 SUPPORTED_AUI | SUPPORTED_FIBRE |
456 .config = genphy_config,
457 .startup = genphy_startup,
458 .shutdown = genphy_shutdown,
461 static LIST_HEAD(phy_drivers);
465 #ifdef CONFIG_B53_SWITCH
468 #ifdef CONFIG_MV88E61XX_SWITCH
469 phy_mv88e61xx_init();
471 #ifdef CONFIG_PHY_AQUANTIA
474 #ifdef CONFIG_PHY_ATHEROS
477 #ifdef CONFIG_PHY_BROADCOM
480 #ifdef CONFIG_PHY_CORTINA
483 #ifdef CONFIG_PHY_DAVICOM
486 #ifdef CONFIG_PHY_ET1011C
489 #ifdef CONFIG_PHY_LXT
492 #ifdef CONFIG_PHY_MARVELL
495 #ifdef CONFIG_PHY_MICREL_KSZ8XXX
496 phy_micrel_ksz8xxx_init();
498 #ifdef CONFIG_PHY_MICREL_KSZ90X1
499 phy_micrel_ksz90x1_init();
501 #ifdef CONFIG_PHY_MESON_GXL
502 phy_meson_gxl_init();
504 #ifdef CONFIG_PHY_NATSEMI
507 #ifdef CONFIG_PHY_REALTEK
510 #ifdef CONFIG_PHY_SMSC
513 #ifdef CONFIG_PHY_TERANETICS
514 phy_teranetics_init();
519 #ifdef CONFIG_PHY_VITESSE
522 #ifdef CONFIG_PHY_XILINX
525 #ifdef CONFIG_PHY_MSCC
528 #ifdef CONFIG_PHY_FIXED
534 int phy_register(struct phy_driver *drv)
536 INIT_LIST_HEAD(&drv->list);
537 list_add_tail(&drv->list, &phy_drivers);
539 #ifdef CONFIG_NEEDS_MANUAL_RELOC
541 drv->probe += gd->reloc_off;
543 drv->config += gd->reloc_off;
545 drv->startup += gd->reloc_off;
547 drv->shutdown += gd->reloc_off;
549 drv->readext += gd->reloc_off;
551 drv->writeext += gd->reloc_off;
556 int phy_set_supported(struct phy_device *phydev, u32 max_speed)
558 /* The default values for phydev->supported are provided by the PHY
559 * driver "features" member, we want to reset to sane defaults first
560 * before supporting higher speeds.
562 phydev->supported &= PHY_DEFAULT_FEATURES;
568 phydev->supported |= PHY_1000BT_FEATURES;
571 phydev->supported |= PHY_100BT_FEATURES;
574 phydev->supported |= PHY_10BT_FEATURES;
580 static int phy_probe(struct phy_device *phydev)
584 phydev->advertising = phydev->drv->features;
585 phydev->supported = phydev->drv->features;
587 phydev->mmds = phydev->drv->mmds;
589 if (phydev->drv->probe)
590 err = phydev->drv->probe(phydev);
595 static struct phy_driver *generic_for_interface(phy_interface_t interface)
597 #ifdef CONFIG_PHYLIB_10G
598 if (is_10g_interface(interface))
599 return &gen10g_driver;
602 return &genphy_driver;
605 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
606 phy_interface_t interface)
608 struct list_head *entry;
609 int phy_id = phydev->phy_id;
610 struct phy_driver *drv = NULL;
612 list_for_each(entry, &phy_drivers) {
613 drv = list_entry(entry, struct phy_driver, list);
614 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
618 /* If we made it here, there's no driver for this PHY */
619 return generic_for_interface(interface);
622 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
624 phy_interface_t interface)
626 struct phy_device *dev;
629 * We allocate the device, and initialize the
632 dev = malloc(sizeof(*dev));
634 printf("Failed to allocate PHY device for %s:%d\n",
639 memset(dev, 0, sizeof(*dev));
643 dev->interface = interface;
646 dev->node = ofnode_null();
649 dev->autoneg = AUTONEG_ENABLE;
652 dev->phy_id = phy_id;
655 dev->drv = get_phy_driver(dev, interface);
659 bus->phymap[addr] = dev;
665 * get_phy_id - reads the specified addr for its ID.
666 * @bus: the target MII bus
667 * @addr: PHY address on the MII bus
668 * @phy_id: where to store the ID retrieved.
670 * Description: Reads the ID registers of the PHY at @addr on the
671 * @bus, stores it in @phy_id and returns zero on success.
673 int __weak get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
678 * Grab the bits from PHYIR1, and put them
681 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
686 *phy_id = (phy_reg & 0xffff) << 16;
688 /* Grab the bits from PHYIR2, and put them in the lower half */
689 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
694 *phy_id |= (phy_reg & 0xffff);
699 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
700 uint phy_mask, int devad,
701 phy_interface_t interface)
703 u32 phy_id = 0xffffffff;
706 int addr = ffs(phy_mask) - 1;
707 int r = get_phy_id(bus, addr, devad, &phy_id);
708 /* If the PHY ID is mostly f's, we didn't find anything */
709 if (r == 0 && (phy_id & 0x1fffffff) != 0x1fffffff)
710 return phy_device_create(bus, addr, phy_id, interface);
711 phy_mask &= ~(1 << addr);
716 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
718 phy_interface_t interface)
720 /* If we have one, return the existing device, with new interface */
722 int addr = ffs(phy_mask) - 1;
724 if (bus->phymap[addr]) {
725 bus->phymap[addr]->interface = interface;
726 return bus->phymap[addr];
728 phy_mask &= ~(1 << addr);
733 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
735 phy_interface_t interface)
738 struct phy_device *phydev;
740 phydev = search_for_existing_phy(bus, phy_mask, interface);
743 /* Try Standard (ie Clause 22) access */
744 /* Otherwise we have to try Clause 45 */
745 for (i = 0; i < 5; i++) {
746 phydev = create_phy_by_mask(bus, phy_mask,
747 i ? i : MDIO_DEVAD_NONE, interface);
754 debug("\n%s PHY: ", bus->name);
756 int addr = ffs(phy_mask) - 1;
759 phy_mask &= ~(1 << addr);
761 debug("not found\n");
767 * get_phy_device - reads the specified PHY device and returns its
769 * @bus: the target MII bus
770 * @addr: PHY address on the MII bus
772 * Description: Reads the ID registers of the PHY at @addr on the
773 * @bus, then allocates and returns the phy_device to represent it.
775 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
776 phy_interface_t interface)
778 return get_phy_device_by_mask(bus, 1 << addr, interface);
781 int phy_reset(struct phy_device *phydev)
785 int devad = MDIO_DEVAD_NONE;
787 if (phydev->flags & PHY_FLAG_BROKEN_RESET)
790 #ifdef CONFIG_PHYLIB_10G
791 /* If it's 10G, we need to issue reset through one of the MMDs */
792 if (is_10g_interface(phydev->interface)) {
794 gen10g_discover_mmds(phydev);
796 devad = ffs(phydev->mmds) - 1;
800 if (phy_write(phydev, devad, MII_BMCR, BMCR_RESET) < 0) {
801 debug("PHY reset failed\n");
805 #ifdef CONFIG_PHY_RESET_DELAY
806 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
809 * Poll the control register for the reset bit to go to 0 (it is
810 * auto-clearing). This should happen within 0.5 seconds per the
813 reg = phy_read(phydev, devad, MII_BMCR);
814 while ((reg & BMCR_RESET) && timeout--) {
815 reg = phy_read(phydev, devad, MII_BMCR);
818 debug("PHY status read failed\n");
824 if (reg & BMCR_RESET) {
825 puts("PHY reset timed out\n");
832 int miiphy_reset(const char *devname, unsigned char addr)
834 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
835 struct phy_device *phydev;
838 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
839 * If later code tries to connect with the right interface, this will
840 * be corrected by get_phy_device in phy_connect()
842 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
844 return phy_reset(phydev);
847 struct phy_device *phy_find_by_mask(struct mii_dev *bus, uint phy_mask,
848 phy_interface_t interface)
854 /* Wait 15ms to make sure the PHY has come out of hard reset */
858 return get_phy_device_by_mask(bus, phy_mask, interface);
862 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev)
864 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
867 /* Soft Reset the PHY */
869 if (phydev->dev && phydev->dev != dev) {
870 printf("%s:%d is connected to %s. Reconnecting to %s\n",
871 phydev->bus->name, phydev->addr,
872 phydev->dev->name, dev->name);
875 debug("%s connected to %s\n", dev->name, phydev->drv->name);
879 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
881 phy_interface_t interface)
883 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
884 struct eth_device *dev,
885 phy_interface_t interface)
888 struct phy_device *phydev = NULL;
889 #ifdef CONFIG_PHY_FIXED
893 sn = fdt_first_subnode(gd->fdt_blob, dev_of_offset(dev));
895 name = fdt_get_name(gd->fdt_blob, sn, NULL);
896 if (name && strcmp(name, "fixed-link") == 0) {
897 phydev = phy_device_create(bus,
898 sn, PHY_FIXED_ID, interface);
901 sn = fdt_next_subnode(gd->fdt_blob, sn);
905 phydev = phy_find_by_mask(bus, 1 << addr, interface);
908 phy_connect_dev(phydev, dev);
910 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
915 * Start the PHY. Returns 0 on success, or a negative error code.
917 int phy_startup(struct phy_device *phydev)
919 if (phydev->drv->startup)
920 return phydev->drv->startup(phydev);
925 __weak int board_phy_config(struct phy_device *phydev)
927 if (phydev->drv->config)
928 return phydev->drv->config(phydev);
932 int phy_config(struct phy_device *phydev)
934 /* Invoke an optional board-specific helper */
935 return board_phy_config(phydev);
938 int phy_shutdown(struct phy_device *phydev)
940 if (phydev->drv->shutdown)
941 phydev->drv->shutdown(phydev);
946 int phy_get_interface_by_name(const char *str)
950 for (i = 0; i < PHY_INTERFACE_MODE_COUNT; i++) {
951 if (!strcmp(str, phy_interface_strings[i]))