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
21 #include <linux/err.h>
22 #include <linux/compiler.h>
24 DECLARE_GLOBAL_DATA_PTR;
26 /* Generic PHY support and helper functions */
29 * genphy_config_advert - sanitize and advertise auto-negotation parameters
30 * @phydev: target phy_device struct
32 * Description: Writes MII_ADVERTISE with the appropriate values,
33 * after sanitizing the values to make sure we only advertise
34 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
35 * hasn't changed, and > 0 if it has changed.
37 static int genphy_config_advert(struct phy_device *phydev)
43 /* Only allow advertising what
44 * this PHY supports */
45 phydev->advertising &= phydev->supported;
46 advertise = phydev->advertising;
48 /* Setup standard advertisement */
49 oldadv = adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
54 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
55 ADVERTISE_PAUSE_ASYM);
56 if (advertise & ADVERTISED_10baseT_Half)
57 adv |= ADVERTISE_10HALF;
58 if (advertise & ADVERTISED_10baseT_Full)
59 adv |= ADVERTISE_10FULL;
60 if (advertise & ADVERTISED_100baseT_Half)
61 adv |= ADVERTISE_100HALF;
62 if (advertise & ADVERTISED_100baseT_Full)
63 adv |= ADVERTISE_100FULL;
64 if (advertise & ADVERTISED_Pause)
65 adv |= ADVERTISE_PAUSE_CAP;
66 if (advertise & ADVERTISED_Asym_Pause)
67 adv |= ADVERTISE_PAUSE_ASYM;
68 if (advertise & ADVERTISED_1000baseX_Half)
69 adv |= ADVERTISE_1000XHALF;
70 if (advertise & ADVERTISED_1000baseX_Full)
71 adv |= ADVERTISE_1000XFULL;
74 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE, adv);
81 /* Configure gigabit if it's supported */
82 if (phydev->supported & (SUPPORTED_1000baseT_Half |
83 SUPPORTED_1000baseT_Full)) {
84 oldadv = adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_CTRL1000);
89 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
90 if (advertise & SUPPORTED_1000baseT_Half)
91 adv |= ADVERTISE_1000HALF;
92 if (advertise & SUPPORTED_1000baseT_Full)
93 adv |= ADVERTISE_1000FULL;
96 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_CTRL1000,
110 * genphy_setup_forced - configures/forces speed/duplex from @phydev
111 * @phydev: target phy_device struct
113 * Description: Configures MII_BMCR to force speed/duplex
114 * to the values in phydev. Assumes that the values are valid.
116 static int genphy_setup_forced(struct phy_device *phydev)
121 phydev->pause = phydev->asym_pause = 0;
123 if (SPEED_1000 == phydev->speed)
124 ctl |= BMCR_SPEED1000;
125 else if (SPEED_100 == phydev->speed)
126 ctl |= BMCR_SPEED100;
128 if (DUPLEX_FULL == phydev->duplex)
129 ctl |= BMCR_FULLDPLX;
131 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
138 * genphy_restart_aneg - Enable and Restart Autonegotiation
139 * @phydev: target phy_device struct
141 int genphy_restart_aneg(struct phy_device *phydev)
145 ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
150 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
152 /* Don't isolate the PHY if we're negotiating */
153 ctl &= ~(BMCR_ISOLATE);
155 ctl = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
162 * genphy_config_aneg - restart auto-negotiation or write BMCR
163 * @phydev: target phy_device struct
165 * Description: If auto-negotiation is enabled, we configure the
166 * advertising, and then restart auto-negotiation. If it is not
167 * enabled, then we write the BMCR.
169 int genphy_config_aneg(struct phy_device *phydev)
173 if (AUTONEG_ENABLE != phydev->autoneg)
174 return genphy_setup_forced(phydev);
176 result = genphy_config_advert(phydev);
178 if (result < 0) /* error */
182 /* Advertisment hasn't changed, but maybe aneg was never on to
183 * begin with? Or maybe phy was isolated? */
184 int ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
189 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
190 result = 1; /* do restart aneg */
193 /* Only restart aneg if we are advertising something different
194 * than we were before. */
196 result = genphy_restart_aneg(phydev);
202 * genphy_update_link - update link status in @phydev
203 * @phydev: target phy_device struct
205 * Description: Update the value in phydev->link to reflect the
206 * current link value. In order to do this, we need to read
207 * the status register twice, keeping the second value.
209 int genphy_update_link(struct phy_device *phydev)
211 unsigned int mii_reg;
214 * Wait if the link is up, and autonegotiation is in progress
215 * (ie - we're capable and it's not done)
217 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
220 * If we already saw the link up, and it hasn't gone down, then
221 * we don't need to wait for autoneg again
223 if (phydev->link && mii_reg & BMSR_LSTATUS)
226 if ((mii_reg & BMSR_ANEGCAPABLE) && !(mii_reg & BMSR_ANEGCOMPLETE)) {
229 printf("%s Waiting for PHY auto negotiation to complete",
231 while (!(mii_reg & BMSR_ANEGCOMPLETE)) {
235 if (i > PHY_ANEG_TIMEOUT) {
236 printf(" TIMEOUT !\n");
242 puts("user interrupt!\n");
247 if ((i++ % 500) == 0)
250 udelay(1000); /* 1 ms */
251 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
256 /* Read the link a second time to clear the latched state */
257 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
259 if (mii_reg & BMSR_LSTATUS)
269 * Generic function which updates the speed and duplex. If
270 * autonegotiation is enabled, it uses the AND of the link
271 * partner's advertised capabilities and our advertised
272 * capabilities. If autonegotiation is disabled, we use the
273 * appropriate bits in the control register.
275 * Stolen from Linux's mii.c and phy_device.c
277 int genphy_parse_link(struct phy_device *phydev)
279 int mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
281 /* We're using autonegotiation */
282 if (phydev->supported & SUPPORTED_Autoneg) {
287 /* Check for gigabit capability */
288 if (phydev->supported & (SUPPORTED_1000baseT_Full |
289 SUPPORTED_1000baseT_Half)) {
290 /* We want a list of states supported by
291 * both PHYs in the link
293 gblpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_STAT1000);
295 debug("Could not read MII_STAT1000. Ignoring gigabit capability\n");
298 gblpa &= phy_read(phydev,
299 MDIO_DEVAD_NONE, MII_CTRL1000) << 2;
302 /* Set the baseline so we only have to set them
303 * if they're different
305 phydev->speed = SPEED_10;
306 phydev->duplex = DUPLEX_HALF;
308 /* Check the gigabit fields */
309 if (gblpa & (PHY_1000BTSR_1000FD | PHY_1000BTSR_1000HD)) {
310 phydev->speed = SPEED_1000;
312 if (gblpa & PHY_1000BTSR_1000FD)
313 phydev->duplex = DUPLEX_FULL;
319 lpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
320 lpa &= phy_read(phydev, MDIO_DEVAD_NONE, MII_LPA);
322 if (lpa & (LPA_100FULL | LPA_100HALF)) {
323 phydev->speed = SPEED_100;
325 if (lpa & LPA_100FULL)
326 phydev->duplex = DUPLEX_FULL;
328 } else if (lpa & LPA_10FULL)
329 phydev->duplex = DUPLEX_FULL;
332 * Extended status may indicate that the PHY supports
333 * 1000BASE-T/X even though the 1000BASE-T registers
334 * are missing. In this case we can't tell whether the
335 * peer also supports it, so we only check extended
336 * status if the 1000BASE-T registers are actually
339 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
340 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
343 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
344 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
345 phydev->speed = SPEED_1000;
346 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
347 phydev->duplex = DUPLEX_FULL;
351 u32 bmcr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
353 phydev->speed = SPEED_10;
354 phydev->duplex = DUPLEX_HALF;
356 if (bmcr & BMCR_FULLDPLX)
357 phydev->duplex = DUPLEX_FULL;
359 if (bmcr & BMCR_SPEED1000)
360 phydev->speed = SPEED_1000;
361 else if (bmcr & BMCR_SPEED100)
362 phydev->speed = SPEED_100;
368 int genphy_config(struct phy_device *phydev)
373 /* For now, I'll claim that the generic driver supports
374 * all possible port types */
375 features = (SUPPORTED_TP | SUPPORTED_MII
376 | SUPPORTED_AUI | SUPPORTED_FIBRE |
379 /* Do we support autonegotiation? */
380 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
385 if (val & BMSR_ANEGCAPABLE)
386 features |= SUPPORTED_Autoneg;
388 if (val & BMSR_100FULL)
389 features |= SUPPORTED_100baseT_Full;
390 if (val & BMSR_100HALF)
391 features |= SUPPORTED_100baseT_Half;
392 if (val & BMSR_10FULL)
393 features |= SUPPORTED_10baseT_Full;
394 if (val & BMSR_10HALF)
395 features |= SUPPORTED_10baseT_Half;
397 if (val & BMSR_ESTATEN) {
398 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
403 if (val & ESTATUS_1000_TFULL)
404 features |= SUPPORTED_1000baseT_Full;
405 if (val & ESTATUS_1000_THALF)
406 features |= SUPPORTED_1000baseT_Half;
407 if (val & ESTATUS_1000_XFULL)
408 features |= SUPPORTED_1000baseX_Full;
409 if (val & ESTATUS_1000_XHALF)
410 features |= SUPPORTED_1000baseX_Half;
413 phydev->supported = features;
414 phydev->advertising = features;
416 genphy_config_aneg(phydev);
421 int genphy_startup(struct phy_device *phydev)
423 genphy_update_link(phydev);
424 genphy_parse_link(phydev);
429 int genphy_shutdown(struct phy_device *phydev)
434 static struct phy_driver genphy_driver = {
437 .name = "Generic PHY",
439 .config = genphy_config,
440 .startup = genphy_startup,
441 .shutdown = genphy_shutdown,
444 static LIST_HEAD(phy_drivers);
448 #ifdef CONFIG_PHY_AQUANTIA
451 #ifdef CONFIG_PHY_ATHEROS
454 #ifdef CONFIG_PHY_BROADCOM
457 #ifdef CONFIG_PHY_CORTINA
460 #ifdef CONFIG_PHY_DAVICOM
463 #ifdef CONFIG_PHY_ET1011C
466 #ifdef CONFIG_PHY_LXT
469 #ifdef CONFIG_PHY_MARVELL
472 #ifdef CONFIG_PHY_MICREL
475 #ifdef CONFIG_PHY_NATSEMI
478 #ifdef CONFIG_PHY_REALTEK
481 #ifdef CONFIG_PHY_SMSC
484 #ifdef CONFIG_PHY_TERANETICS
485 phy_teranetics_init();
487 #ifdef CONFIG_PHY_VITESSE
494 int phy_register(struct phy_driver *drv)
496 INIT_LIST_HEAD(&drv->list);
497 list_add_tail(&drv->list, &phy_drivers);
499 #ifdef CONFIG_NEEDS_MANUAL_RELOC
501 drv->probe += gd->reloc_off;
503 drv->config += gd->reloc_off;
505 drv->startup += gd->reloc_off;
507 drv->shutdown += gd->reloc_off;
509 drv->readext += gd->reloc_off;
511 drv->writeext += gd->reloc_off;
516 static int phy_probe(struct phy_device *phydev)
520 phydev->advertising = phydev->supported = phydev->drv->features;
521 phydev->mmds = phydev->drv->mmds;
523 if (phydev->drv->probe)
524 err = phydev->drv->probe(phydev);
529 static struct phy_driver *generic_for_interface(phy_interface_t interface)
531 #ifdef CONFIG_PHYLIB_10G
532 if (is_10g_interface(interface))
533 return &gen10g_driver;
536 return &genphy_driver;
539 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
540 phy_interface_t interface)
542 struct list_head *entry;
543 int phy_id = phydev->phy_id;
544 struct phy_driver *drv = NULL;
546 list_for_each(entry, &phy_drivers) {
547 drv = list_entry(entry, struct phy_driver, list);
548 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
552 /* If we made it here, there's no driver for this PHY */
553 return generic_for_interface(interface);
556 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
558 phy_interface_t interface)
560 struct phy_device *dev;
562 /* We allocate the device, and initialize the
564 dev = malloc(sizeof(*dev));
566 printf("Failed to allocate PHY device for %s:%d\n",
571 memset(dev, 0, sizeof(*dev));
575 dev->interface = interface;
577 dev->autoneg = AUTONEG_ENABLE;
580 dev->phy_id = phy_id;
583 dev->drv = get_phy_driver(dev, interface);
587 bus->phymap[addr] = dev;
593 * get_phy_id - reads the specified addr for its ID.
594 * @bus: the target MII bus
595 * @addr: PHY address on the MII bus
596 * @phy_id: where to store the ID retrieved.
598 * Description: Reads the ID registers of the PHY at @addr on the
599 * @bus, stores it in @phy_id and returns zero on success.
601 int __weak get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
605 /* Grab the bits from PHYIR1, and put them
606 * in the upper half */
607 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
612 *phy_id = (phy_reg & 0xffff) << 16;
614 /* Grab the bits from PHYIR2, and put them in the lower half */
615 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
620 *phy_id |= (phy_reg & 0xffff);
625 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
626 unsigned phy_mask, int devad, phy_interface_t interface)
628 u32 phy_id = 0xffffffff;
630 int addr = ffs(phy_mask) - 1;
631 int r = get_phy_id(bus, addr, devad, &phy_id);
632 /* If the PHY ID is mostly f's, we didn't find anything */
633 if (r == 0 && (phy_id & 0x1fffffff) != 0x1fffffff)
634 return phy_device_create(bus, addr, phy_id, interface);
635 phy_mask &= ~(1 << addr);
640 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
641 unsigned phy_mask, phy_interface_t interface)
643 /* If we have one, return the existing device, with new interface */
645 int addr = ffs(phy_mask) - 1;
646 if (bus->phymap[addr]) {
647 bus->phymap[addr]->interface = interface;
648 return bus->phymap[addr];
650 phy_mask &= ~(1 << addr);
655 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
656 unsigned phy_mask, phy_interface_t interface)
659 struct phy_device *phydev;
661 phydev = search_for_existing_phy(bus, phy_mask, interface);
664 /* Try Standard (ie Clause 22) access */
665 /* Otherwise we have to try Clause 45 */
666 for (i = 0; i < 5; i++) {
667 phydev = create_phy_by_mask(bus, phy_mask,
668 i ? i : MDIO_DEVAD_NONE, interface);
675 debug("\n%s PHY: ", bus->name);
677 int addr = ffs(phy_mask) - 1;
679 phy_mask &= ~(1 << addr);
681 debug("not found\n");
687 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
688 * @bus: the target MII bus
689 * @addr: PHY address on the MII bus
691 * Description: Reads the ID registers of the PHY at @addr on the
692 * @bus, then allocates and returns the phy_device to represent it.
694 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
695 phy_interface_t interface)
697 return get_phy_device_by_mask(bus, 1 << addr, interface);
700 int phy_reset(struct phy_device *phydev)
704 int devad = MDIO_DEVAD_NONE;
706 #ifdef CONFIG_PHYLIB_10G
707 /* If it's 10G, we need to issue reset through one of the MMDs */
708 if (is_10g_interface(phydev->interface)) {
710 gen10g_discover_mmds(phydev);
712 devad = ffs(phydev->mmds) - 1;
716 reg = phy_read(phydev, devad, MII_BMCR);
718 debug("PHY status read failed\n");
724 if (phy_write(phydev, devad, MII_BMCR, reg) < 0) {
725 debug("PHY reset failed\n");
729 #ifdef CONFIG_PHY_RESET_DELAY
730 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
733 * Poll the control register for the reset bit to go to 0 (it is
734 * auto-clearing). This should happen within 0.5 seconds per the
737 while ((reg & BMCR_RESET) && timeout--) {
738 reg = phy_read(phydev, devad, MII_BMCR);
741 debug("PHY status read failed\n");
747 if (reg & BMCR_RESET) {
748 puts("PHY reset timed out\n");
755 int miiphy_reset(const char *devname, unsigned char addr)
757 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
758 struct phy_device *phydev;
761 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
762 * If later code tries to connect with the right interface, this will
763 * be corrected by get_phy_device in phy_connect()
765 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
767 return phy_reset(phydev);
770 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
771 phy_interface_t interface)
777 /* Wait 15ms to make sure the PHY has come out of hard reset */
781 return get_phy_device_by_mask(bus, phy_mask, interface);
785 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev)
787 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
790 /* Soft Reset the PHY */
792 if (phydev->dev && phydev->dev != dev) {
793 printf("%s:%d is connected to %s. Reconnecting to %s\n",
794 phydev->bus->name, phydev->addr,
795 phydev->dev->name, dev->name);
798 debug("%s connected to %s\n", dev->name, phydev->drv->name);
802 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
803 struct udevice *dev, phy_interface_t interface)
805 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
806 struct eth_device *dev, phy_interface_t interface)
809 struct phy_device *phydev;
811 phydev = phy_find_by_mask(bus, 1 << addr, interface);
813 phy_connect_dev(phydev, dev);
815 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
820 * Start the PHY. Returns 0 on success, or a negative error code.
822 int phy_startup(struct phy_device *phydev)
824 if (phydev->drv->startup)
825 return phydev->drv->startup(phydev);
830 __weak int board_phy_config(struct phy_device *phydev)
832 if (phydev->drv->config)
833 return phydev->drv->config(phydev);
837 int phy_config(struct phy_device *phydev)
839 /* Invoke an optional board-specific helper */
840 board_phy_config(phydev);
845 int phy_shutdown(struct phy_device *phydev)
847 if (phydev->drv->shutdown)
848 phydev->drv->shutdown(phydev);
853 int phy_get_interface_by_name(const char *str)
857 for (i = 0; i < PHY_INTERFACE_MODE_COUNT; i++) {
858 if (!strcmp(str, phy_interface_strings[i]))