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-negotiation 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);
121 * genphy_setup_forced - configures/forces speed/duplex from @phydev
122 * @phydev: target phy_device struct
124 * Description: Configures MII_BMCR to force speed/duplex
125 * to the values in phydev. Assumes that the values are valid.
127 static int genphy_setup_forced(struct phy_device *phydev)
130 int ctl = BMCR_ANRESTART;
133 phydev->asym_pause = 0;
135 if (phydev->speed == SPEED_1000)
136 ctl |= BMCR_SPEED1000;
137 else if (phydev->speed == SPEED_100)
138 ctl |= BMCR_SPEED100;
140 if (phydev->duplex == DUPLEX_FULL)
141 ctl |= BMCR_FULLDPLX;
143 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
149 * genphy_restart_aneg - Enable and Restart Autonegotiation
150 * @phydev: target phy_device struct
152 int genphy_restart_aneg(struct phy_device *phydev)
156 ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
161 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
163 /* Don't isolate the PHY if we're negotiating */
164 ctl &= ~(BMCR_ISOLATE);
166 ctl = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
172 * genphy_config_aneg - restart auto-negotiation or write BMCR
173 * @phydev: target phy_device struct
175 * Description: If auto-negotiation is enabled, we configure the
176 * advertising, and then restart auto-negotiation. If it is not
177 * enabled, then we write the BMCR.
179 int genphy_config_aneg(struct phy_device *phydev)
183 if (phydev->autoneg != AUTONEG_ENABLE)
184 return genphy_setup_forced(phydev);
186 result = genphy_config_advert(phydev);
188 if (result < 0) /* error */
193 * Advertisment hasn't changed, but maybe aneg was never on to
194 * 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 */
206 * Only restart aneg if we are advertising something different
207 * than we were before.
210 result = genphy_restart_aneg(phydev);
216 * genphy_update_link - update link status in @phydev
217 * @phydev: target phy_device struct
219 * Description: Update the value in phydev->link to reflect the
220 * current link value. In order to do this, we need to read
221 * the status register twice, keeping the second value.
223 int genphy_update_link(struct phy_device *phydev)
225 unsigned int mii_reg;
228 * Wait if the link is up, and autonegotiation is in progress
229 * (ie - we're capable and it's not done)
231 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
234 * If we already saw the link up, and it hasn't gone down, then
235 * we don't need to wait for autoneg again
237 if (phydev->link && mii_reg & BMSR_LSTATUS)
240 if ((phydev->autoneg == AUTONEG_ENABLE) &&
241 !(mii_reg & BMSR_ANEGCOMPLETE)) {
244 printf("%s Waiting for PHY auto negotiation to complete",
246 while (!(mii_reg & BMSR_ANEGCOMPLETE)) {
250 if (i > PHY_ANEG_TIMEOUT) {
251 printf(" TIMEOUT !\n");
257 puts("user interrupt!\n");
262 if ((i++ % 500) == 0)
265 udelay(1000); /* 1 ms */
266 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
271 /* Read the link a second time to clear the latched state */
272 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
274 if (mii_reg & BMSR_LSTATUS)
284 * Generic function which updates the speed and duplex. If
285 * autonegotiation is enabled, it uses the AND of the link
286 * partner's advertised capabilities and our advertised
287 * capabilities. If autonegotiation is disabled, we use the
288 * appropriate bits in the control register.
290 * Stolen from Linux's mii.c and phy_device.c
292 int genphy_parse_link(struct phy_device *phydev)
294 int mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
296 /* We're using autonegotiation */
297 if (phydev->autoneg == AUTONEG_ENABLE) {
302 /* Check for gigabit capability */
303 if (phydev->supported & (SUPPORTED_1000baseT_Full |
304 SUPPORTED_1000baseT_Half)) {
305 /* We want a list of states supported by
306 * both PHYs in the link
308 gblpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_STAT1000);
310 debug("Could not read MII_STAT1000. ");
311 debug("Ignoring gigabit capability\n");
314 gblpa &= phy_read(phydev,
315 MDIO_DEVAD_NONE, MII_CTRL1000) << 2;
318 /* Set the baseline so we only have to set them
319 * if they're different
321 phydev->speed = SPEED_10;
322 phydev->duplex = DUPLEX_HALF;
324 /* Check the gigabit fields */
325 if (gblpa & (PHY_1000BTSR_1000FD | PHY_1000BTSR_1000HD)) {
326 phydev->speed = SPEED_1000;
328 if (gblpa & PHY_1000BTSR_1000FD)
329 phydev->duplex = DUPLEX_FULL;
335 lpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
336 lpa &= phy_read(phydev, MDIO_DEVAD_NONE, MII_LPA);
338 if (lpa & (LPA_100FULL | LPA_100HALF)) {
339 phydev->speed = SPEED_100;
341 if (lpa & LPA_100FULL)
342 phydev->duplex = DUPLEX_FULL;
344 } else if (lpa & LPA_10FULL) {
345 phydev->duplex = DUPLEX_FULL;
349 * Extended status may indicate that the PHY supports
350 * 1000BASE-T/X even though the 1000BASE-T registers
351 * are missing. In this case we can't tell whether the
352 * peer also supports it, so we only check extended
353 * status if the 1000BASE-T registers are actually
356 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
357 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
360 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
361 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
362 phydev->speed = SPEED_1000;
363 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
364 phydev->duplex = DUPLEX_FULL;
368 u32 bmcr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
370 phydev->speed = SPEED_10;
371 phydev->duplex = DUPLEX_HALF;
373 if (bmcr & BMCR_FULLDPLX)
374 phydev->duplex = DUPLEX_FULL;
376 if (bmcr & BMCR_SPEED1000)
377 phydev->speed = SPEED_1000;
378 else if (bmcr & BMCR_SPEED100)
379 phydev->speed = SPEED_100;
385 int genphy_config(struct phy_device *phydev)
390 features = (SUPPORTED_TP | SUPPORTED_MII
391 | SUPPORTED_AUI | SUPPORTED_FIBRE |
394 /* Do we support autonegotiation? */
395 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
400 if (val & BMSR_ANEGCAPABLE)
401 features |= SUPPORTED_Autoneg;
403 if (val & BMSR_100FULL)
404 features |= SUPPORTED_100baseT_Full;
405 if (val & BMSR_100HALF)
406 features |= SUPPORTED_100baseT_Half;
407 if (val & BMSR_10FULL)
408 features |= SUPPORTED_10baseT_Full;
409 if (val & BMSR_10HALF)
410 features |= SUPPORTED_10baseT_Half;
412 if (val & BMSR_ESTATEN) {
413 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
418 if (val & ESTATUS_1000_TFULL)
419 features |= SUPPORTED_1000baseT_Full;
420 if (val & ESTATUS_1000_THALF)
421 features |= SUPPORTED_1000baseT_Half;
422 if (val & ESTATUS_1000_XFULL)
423 features |= SUPPORTED_1000baseX_Full;
424 if (val & ESTATUS_1000_XHALF)
425 features |= SUPPORTED_1000baseX_Half;
428 phydev->supported &= features;
429 phydev->advertising &= features;
431 genphy_config_aneg(phydev);
436 int genphy_startup(struct phy_device *phydev)
440 ret = genphy_update_link(phydev);
444 return genphy_parse_link(phydev);
447 int genphy_shutdown(struct phy_device *phydev)
452 static struct phy_driver genphy_driver = {
455 .name = "Generic PHY",
456 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
457 SUPPORTED_AUI | SUPPORTED_FIBRE |
459 .config = genphy_config,
460 .startup = genphy_startup,
461 .shutdown = genphy_shutdown,
464 static LIST_HEAD(phy_drivers);
468 #ifdef CONFIG_B53_SWITCH
471 #ifdef CONFIG_MV88E61XX_SWITCH
472 phy_mv88e61xx_init();
474 #ifdef CONFIG_PHY_AQUANTIA
477 #ifdef CONFIG_PHY_ATHEROS
480 #ifdef CONFIG_PHY_BROADCOM
483 #ifdef CONFIG_PHY_CORTINA
486 #ifdef CONFIG_PHY_DAVICOM
489 #ifdef CONFIG_PHY_ET1011C
492 #ifdef CONFIG_PHY_LXT
495 #ifdef CONFIG_PHY_MARVELL
498 #ifdef CONFIG_PHY_MICREL_KSZ8XXX
499 phy_micrel_ksz8xxx_init();
501 #ifdef CONFIG_PHY_MICREL_KSZ90X1
502 phy_micrel_ksz90x1_init();
504 #ifdef CONFIG_PHY_MESON_GXL
505 phy_meson_gxl_init();
507 #ifdef CONFIG_PHY_NATSEMI
510 #ifdef CONFIG_PHY_REALTEK
513 #ifdef CONFIG_PHY_SMSC
516 #ifdef CONFIG_PHY_TERANETICS
517 phy_teranetics_init();
522 #ifdef CONFIG_PHY_VITESSE
525 #ifdef CONFIG_PHY_XILINX
528 #ifdef CONFIG_PHY_MSCC
531 #ifdef CONFIG_PHY_FIXED
537 int phy_register(struct phy_driver *drv)
539 INIT_LIST_HEAD(&drv->list);
540 list_add_tail(&drv->list, &phy_drivers);
542 #ifdef CONFIG_NEEDS_MANUAL_RELOC
544 drv->probe += gd->reloc_off;
546 drv->config += gd->reloc_off;
548 drv->startup += gd->reloc_off;
550 drv->shutdown += gd->reloc_off;
552 drv->readext += gd->reloc_off;
554 drv->writeext += gd->reloc_off;
559 int phy_set_supported(struct phy_device *phydev, u32 max_speed)
561 /* The default values for phydev->supported are provided by the PHY
562 * driver "features" member, we want to reset to sane defaults first
563 * before supporting higher speeds.
565 phydev->supported &= PHY_DEFAULT_FEATURES;
571 phydev->supported |= PHY_1000BT_FEATURES;
574 phydev->supported |= PHY_100BT_FEATURES;
577 phydev->supported |= PHY_10BT_FEATURES;
583 static int phy_probe(struct phy_device *phydev)
587 phydev->advertising = phydev->drv->features;
588 phydev->supported = phydev->drv->features;
590 phydev->mmds = phydev->drv->mmds;
592 if (phydev->drv->probe)
593 err = phydev->drv->probe(phydev);
598 static struct phy_driver *generic_for_interface(phy_interface_t interface)
600 #ifdef CONFIG_PHYLIB_10G
601 if (is_10g_interface(interface))
602 return &gen10g_driver;
605 return &genphy_driver;
608 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
609 phy_interface_t interface)
611 struct list_head *entry;
612 int phy_id = phydev->phy_id;
613 struct phy_driver *drv = NULL;
615 list_for_each(entry, &phy_drivers) {
616 drv = list_entry(entry, struct phy_driver, list);
617 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
621 /* If we made it here, there's no driver for this PHY */
622 return generic_for_interface(interface);
625 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
627 phy_interface_t interface)
629 struct phy_device *dev;
632 * We allocate the device, and initialize the
635 dev = malloc(sizeof(*dev));
637 printf("Failed to allocate PHY device for %s:%d\n",
642 memset(dev, 0, sizeof(*dev));
646 dev->interface = interface;
648 dev->autoneg = AUTONEG_ENABLE;
651 dev->phy_id = phy_id;
654 dev->drv = get_phy_driver(dev, interface);
658 bus->phymap[addr] = dev;
664 * get_phy_id - reads the specified addr for its ID.
665 * @bus: the target MII bus
666 * @addr: PHY address on the MII bus
667 * @phy_id: where to store the ID retrieved.
669 * Description: Reads the ID registers of the PHY at @addr on the
670 * @bus, stores it in @phy_id and returns zero on success.
672 int __weak get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
677 * Grab the bits from PHYIR1, and put them
680 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
685 *phy_id = (phy_reg & 0xffff) << 16;
687 /* Grab the bits from PHYIR2, and put them in the lower half */
688 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
693 *phy_id |= (phy_reg & 0xffff);
698 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
699 uint phy_mask, int devad,
700 phy_interface_t interface)
702 u32 phy_id = 0xffffffff;
705 int addr = ffs(phy_mask) - 1;
706 int r = get_phy_id(bus, addr, devad, &phy_id);
707 /* If the PHY ID is mostly f's, we didn't find anything */
708 if (r == 0 && (phy_id & 0x1fffffff) != 0x1fffffff)
709 return phy_device_create(bus, addr, phy_id, interface);
710 phy_mask &= ~(1 << addr);
715 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
717 phy_interface_t interface)
719 /* If we have one, return the existing device, with new interface */
721 int addr = ffs(phy_mask) - 1;
723 if (bus->phymap[addr]) {
724 bus->phymap[addr]->interface = interface;
725 return bus->phymap[addr];
727 phy_mask &= ~(1 << addr);
732 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
734 phy_interface_t interface)
737 struct phy_device *phydev;
739 phydev = search_for_existing_phy(bus, phy_mask, interface);
742 /* Try Standard (ie Clause 22) access */
743 /* Otherwise we have to try Clause 45 */
744 for (i = 0; i < 5; i++) {
745 phydev = create_phy_by_mask(bus, phy_mask,
746 i ? i : MDIO_DEVAD_NONE, interface);
753 debug("\n%s PHY: ", bus->name);
755 int addr = ffs(phy_mask) - 1;
758 phy_mask &= ~(1 << addr);
760 debug("not found\n");
766 * get_phy_device - reads the specified PHY device and returns its
768 * @bus: the target MII bus
769 * @addr: PHY address on the MII bus
771 * Description: Reads the ID registers of the PHY at @addr on the
772 * @bus, then allocates and returns the phy_device to represent it.
774 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
775 phy_interface_t interface)
777 return get_phy_device_by_mask(bus, 1 << addr, interface);
780 int phy_reset(struct phy_device *phydev)
784 int devad = MDIO_DEVAD_NONE;
786 if (phydev->flags & PHY_FLAG_BROKEN_RESET)
789 #ifdef CONFIG_PHYLIB_10G
790 /* If it's 10G, we need to issue reset through one of the MMDs */
791 if (is_10g_interface(phydev->interface)) {
793 gen10g_discover_mmds(phydev);
795 devad = ffs(phydev->mmds) - 1;
799 if (phy_write(phydev, devad, MII_BMCR, BMCR_RESET) < 0) {
800 debug("PHY reset failed\n");
804 #ifdef CONFIG_PHY_RESET_DELAY
805 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
808 * Poll the control register for the reset bit to go to 0 (it is
809 * auto-clearing). This should happen within 0.5 seconds per the
812 reg = phy_read(phydev, devad, MII_BMCR);
813 while ((reg & BMCR_RESET) && timeout--) {
814 reg = phy_read(phydev, devad, MII_BMCR);
817 debug("PHY status read failed\n");
823 if (reg & BMCR_RESET) {
824 puts("PHY reset timed out\n");
831 int miiphy_reset(const char *devname, unsigned char addr)
833 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
834 struct phy_device *phydev;
837 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
838 * If later code tries to connect with the right interface, this will
839 * be corrected by get_phy_device in phy_connect()
841 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
843 return phy_reset(phydev);
846 struct phy_device *phy_find_by_mask(struct mii_dev *bus, uint phy_mask,
847 phy_interface_t interface)
853 /* Wait 15ms to make sure the PHY has come out of hard reset */
857 return get_phy_device_by_mask(bus, phy_mask, interface);
861 void phy_connect_dev(struct phy_device *phydev, struct udevice *dev)
863 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
866 /* Soft Reset the PHY */
868 if (phydev->dev && phydev->dev != dev) {
869 printf("%s:%d is connected to %s. Reconnecting to %s\n",
870 phydev->bus->name, phydev->addr,
871 phydev->dev->name, dev->name);
874 debug("%s connected to %s\n", dev->name, phydev->drv->name);
878 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
880 phy_interface_t interface)
882 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
883 struct eth_device *dev,
884 phy_interface_t interface)
887 struct phy_device *phydev = NULL;
888 #ifdef CONFIG_PHY_FIXED
892 sn = fdt_first_subnode(gd->fdt_blob, dev_of_offset(dev));
894 name = fdt_get_name(gd->fdt_blob, sn, NULL);
895 if (name && strcmp(name, "fixed-link") == 0) {
896 phydev = phy_device_create(bus,
897 sn, PHY_FIXED_ID, interface);
900 sn = fdt_next_subnode(gd->fdt_blob, sn);
904 phydev = phy_find_by_mask(bus, 1 << addr, interface);
907 phy_connect_dev(phydev, dev);
909 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
914 * Start the PHY. Returns 0 on success, or a negative error code.
916 int phy_startup(struct phy_device *phydev)
918 if (phydev->drv->startup)
919 return phydev->drv->startup(phydev);
924 __weak int board_phy_config(struct phy_device *phydev)
926 if (phydev->drv->config)
927 return phydev->drv->config(phydev);
931 int phy_config(struct phy_device *phydev)
933 /* Invoke an optional board-specific helper */
934 return board_phy_config(phydev);
937 int phy_shutdown(struct phy_device *phydev)
939 if (phydev->drv->shutdown)
940 phydev->drv->shutdown(phydev);
945 int phy_get_interface_by_name(const char *str)
949 for (i = 0; i < PHY_INTERFACE_MODE_COUNT; i++) {
950 if (!strcmp(str, phy_interface_strings[i]))