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
20 #include <linux/err.h>
22 /* Generic PHY support and helper functions */
25 * genphy_config_advert - sanitize and advertise auto-negotation parameters
26 * @phydev: target phy_device struct
28 * Description: Writes MII_ADVERTISE with the appropriate values,
29 * after sanitizing the values to make sure we only advertise
30 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
31 * hasn't changed, and > 0 if it has changed.
33 static int genphy_config_advert(struct phy_device *phydev)
39 /* Only allow advertising what
40 * this PHY supports */
41 phydev->advertising &= phydev->supported;
42 advertise = phydev->advertising;
44 /* Setup standard advertisement */
45 oldadv = adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
50 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
51 ADVERTISE_PAUSE_ASYM);
52 if (advertise & ADVERTISED_10baseT_Half)
53 adv |= ADVERTISE_10HALF;
54 if (advertise & ADVERTISED_10baseT_Full)
55 adv |= ADVERTISE_10FULL;
56 if (advertise & ADVERTISED_100baseT_Half)
57 adv |= ADVERTISE_100HALF;
58 if (advertise & ADVERTISED_100baseT_Full)
59 adv |= ADVERTISE_100FULL;
60 if (advertise & ADVERTISED_Pause)
61 adv |= ADVERTISE_PAUSE_CAP;
62 if (advertise & ADVERTISED_Asym_Pause)
63 adv |= ADVERTISE_PAUSE_ASYM;
64 if (advertise & ADVERTISED_1000baseX_Half)
65 adv |= ADVERTISE_1000XHALF;
66 if (advertise & ADVERTISED_1000baseX_Full)
67 adv |= ADVERTISE_1000XFULL;
70 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE, adv);
77 /* Configure gigabit if it's supported */
78 if (phydev->supported & (SUPPORTED_1000baseT_Half |
79 SUPPORTED_1000baseT_Full)) {
80 oldadv = adv = phy_read(phydev, MDIO_DEVAD_NONE, MII_CTRL1000);
85 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
86 if (advertise & SUPPORTED_1000baseT_Half)
87 adv |= ADVERTISE_1000HALF;
88 if (advertise & SUPPORTED_1000baseT_Full)
89 adv |= ADVERTISE_1000FULL;
92 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_CTRL1000,
106 * genphy_setup_forced - configures/forces speed/duplex from @phydev
107 * @phydev: target phy_device struct
109 * Description: Configures MII_BMCR to force speed/duplex
110 * to the values in phydev. Assumes that the values are valid.
112 static int genphy_setup_forced(struct phy_device *phydev)
116 phydev->pause = phydev->asym_pause = 0;
118 if (SPEED_1000 == phydev->speed)
119 ctl |= BMCR_SPEED1000;
120 else if (SPEED_100 == phydev->speed)
121 ctl |= BMCR_SPEED100;
123 if (DUPLEX_FULL == phydev->duplex)
124 ctl |= BMCR_FULLDPLX;
126 return phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
131 * genphy_restart_aneg - Enable and Restart Autonegotiation
132 * @phydev: target phy_device struct
134 int genphy_restart_aneg(struct phy_device *phydev)
138 ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
143 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
145 /* Don't isolate the PHY if we're negotiating */
146 ctl &= ~(BMCR_ISOLATE);
148 return phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
153 * genphy_config_aneg - restart auto-negotiation or write BMCR
154 * @phydev: target phy_device struct
156 * Description: If auto-negotiation is enabled, we configure the
157 * advertising, and then restart auto-negotiation. If it is not
158 * enabled, then we write the BMCR.
160 int genphy_config_aneg(struct phy_device *phydev)
164 if (AUTONEG_ENABLE != phydev->autoneg)
165 return genphy_setup_forced(phydev);
167 result = genphy_config_advert(phydev);
169 if (result < 0) /* error */
173 /* Advertisment hasn't changed, but maybe aneg was never on to
174 * begin with? Or maybe phy was isolated? */
175 int ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
180 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
181 result = 1; /* do restart aneg */
184 /* Only restart aneg if we are advertising something different
185 * than we were before. */
187 result = genphy_restart_aneg(phydev);
193 * genphy_update_link - update link status in @phydev
194 * @phydev: target phy_device struct
196 * Description: Update the value in phydev->link to reflect the
197 * current link value. In order to do this, we need to read
198 * the status register twice, keeping the second value.
200 int genphy_update_link(struct phy_device *phydev)
205 * Wait if the link is up, and autonegotiation is in progress
206 * (ie - we're capable and it's not done)
208 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
213 * If we already saw the link up, and it hasn't gone down, then
214 * we don't need to wait for autoneg again
216 if (phydev->link && mii_reg & BMSR_LSTATUS)
219 if ((mii_reg & BMSR_ANEGCAPABLE) && !(mii_reg & BMSR_ANEGCOMPLETE)) {
222 printf("%s Waiting for PHY auto negotiation to complete",
224 while (!(mii_reg & BMSR_ANEGCOMPLETE)) {
228 if (i > PHY_ANEG_TIMEOUT) {
229 printf(" TIMEOUT !\n");
235 puts("user interrupt!\n");
240 if ((i++ % 500) == 0)
243 udelay(1000); /* 1 ms */
244 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
251 /* Read the link a second time to clear the latched state */
252 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
256 if (mii_reg & BMSR_LSTATUS)
266 * Generic function which updates the speed and duplex. If
267 * autonegotiation is enabled, it uses the AND of the link
268 * partner's advertised capabilities and our advertised
269 * capabilities. If autonegotiation is disabled, we use the
270 * appropriate bits in the control register.
272 * Stolen from Linux's mii.c and phy_device.c
274 int genphy_parse_link(struct phy_device *phydev)
276 int mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
281 /* We're using autonegotiation */
282 if (mii_reg & BMSR_ANEGCAPABLE) {
288 /* Check for gigabit capability */
289 if (mii_reg & BMSR_ERCAP) {
290 /* We want a list of states supported by
291 * both PHYs in the link
293 ret = phy_read(phydev, MDIO_DEVAD_NONE, MII_STAT1000);
298 ret = phy_read(phydev, MDIO_DEVAD_NONE, MII_CTRL1000);
304 /* Set the baseline so we only have to set them
305 * if they're different
307 phydev->speed = SPEED_10;
308 phydev->duplex = DUPLEX_HALF;
310 /* Check the gigabit fields */
311 if (gblpa & (PHY_1000BTSR_1000FD | PHY_1000BTSR_1000HD)) {
312 phydev->speed = SPEED_1000;
314 if (gblpa & PHY_1000BTSR_1000FD)
315 phydev->duplex = DUPLEX_FULL;
321 ret = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
326 ret = phy_read(phydev, MDIO_DEVAD_NONE, MII_LPA);
331 if (lpa & (LPA_100FULL | LPA_100HALF)) {
332 phydev->speed = SPEED_100;
334 if (lpa & LPA_100FULL)
335 phydev->duplex = DUPLEX_FULL;
337 } else if (lpa & LPA_10FULL)
338 phydev->duplex = DUPLEX_FULL;
341 * Extended status may indicate that the PHY supports
342 * 1000BASE-T/X even though the 1000BASE-T registers
343 * are missing. In this case we can't tell whether the
344 * peer also supports it, so we only check extended
345 * status if the 1000BASE-T registers are actually
348 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
349 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
354 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
355 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
356 phydev->speed = SPEED_1000;
357 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
358 phydev->duplex = DUPLEX_FULL;
362 int 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 /* For now, I'll claim that the generic driver supports
388 * all possible port types */
389 features = (SUPPORTED_TP | SUPPORTED_MII
390 | SUPPORTED_AUI | SUPPORTED_FIBRE |
393 /* Do we support autonegotiation? */
394 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
399 if (val & BMSR_ANEGCAPABLE)
400 features |= SUPPORTED_Autoneg;
402 if (val & BMSR_100FULL)
403 features |= SUPPORTED_100baseT_Full;
404 if (val & BMSR_100HALF)
405 features |= SUPPORTED_100baseT_Half;
406 if (val & BMSR_10FULL)
407 features |= SUPPORTED_10baseT_Full;
408 if (val & BMSR_10HALF)
409 features |= SUPPORTED_10baseT_Half;
411 if (val & BMSR_ESTATEN) {
412 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
417 if (val & ESTATUS_1000_TFULL)
418 features |= SUPPORTED_1000baseT_Full;
419 if (val & ESTATUS_1000_THALF)
420 features |= SUPPORTED_1000baseT_Half;
421 if (val & ESTATUS_1000_XFULL)
422 features |= SUPPORTED_1000baseX_Full;
423 if (val & ESTATUS_1000_XHALF)
424 features |= SUPPORTED_1000baseX_Half;
427 phydev->supported = features;
428 phydev->advertising = features;
430 genphy_config_aneg(phydev);
435 int genphy_startup(struct phy_device *phydev)
437 genphy_update_link(phydev);
438 genphy_parse_link(phydev);
443 int genphy_shutdown(struct phy_device *phydev)
448 static struct phy_driver genphy_driver = {
451 .name = "Generic PHY",
453 .config = genphy_config,
454 .startup = genphy_startup,
455 .shutdown = genphy_shutdown,
458 static LIST_HEAD(phy_drivers);
462 #ifdef CONFIG_PHY_ATHEROS
465 #ifdef CONFIG_PHY_BROADCOM
468 #ifdef CONFIG_PHY_DAVICOM
471 #ifdef CONFIG_PHY_ET1011C
474 #ifdef CONFIG_PHY_ICPLUS
477 #ifdef CONFIG_PHY_LXT
480 #ifdef CONFIG_PHY_MARVELL
483 #ifdef CONFIG_PHY_MICREL
486 #ifdef CONFIG_PHY_NATSEMI
489 #ifdef CONFIG_PHY_REALTEK
492 #ifdef CONFIG_PHY_SMSC
495 #ifdef CONFIG_PHY_TERANETICS
496 phy_teranetics_init();
498 #ifdef CONFIG_PHY_VITESSE
505 int phy_register(struct phy_driver *drv)
507 INIT_LIST_HEAD(&drv->list);
508 list_add_tail(&drv->list, &phy_drivers);
513 static int phy_probe(struct phy_device *phydev)
517 phydev->advertising = phydev->supported = phydev->drv->features;
518 phydev->mmds = phydev->drv->mmds;
520 if (phydev->drv->probe)
521 err = phydev->drv->probe(phydev);
526 static struct phy_driver *generic_for_interface(phy_interface_t interface)
528 #ifdef CONFIG_PHYLIB_10G
529 if (is_10g_interface(interface))
530 return &gen10g_driver;
533 return &genphy_driver;
536 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
537 phy_interface_t interface)
539 struct list_head *entry;
540 int phy_id = phydev->phy_id;
541 struct phy_driver *drv = NULL;
543 list_for_each(entry, &phy_drivers) {
544 drv = list_entry(entry, struct phy_driver, list);
545 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
549 /* If we made it here, there's no driver for this PHY */
550 return generic_for_interface(interface);
553 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
555 phy_interface_t interface)
557 struct phy_device *dev;
559 /* We allocate the device, and initialize the
561 dev = malloc(sizeof(*dev));
563 printf("Failed to allocate PHY device for %s:%d\n",
568 memset(dev, 0, sizeof(*dev));
572 dev->interface = interface;
574 dev->autoneg = AUTONEG_ENABLE;
577 dev->phy_id = phy_id;
580 dev->drv = get_phy_driver(dev, interface);
584 bus->phymap[addr] = dev;
590 * get_phy_id - reads the specified addr for its ID.
591 * @bus: the target MII bus
592 * @addr: PHY address on the MII bus
593 * @phy_id: where to store the ID retrieved.
595 * Description: Reads the ID registers of the PHY at @addr on the
596 * @bus, stores it in @phy_id and returns zero on success.
598 static int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
602 /* Grab the bits from PHYIR1, and put them
603 * in the upper half */
604 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
609 *phy_id = (phy_reg & 0xffff) << 16;
611 /* Grab the bits from PHYIR2, and put them in the lower half */
612 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
617 *phy_id |= (phy_reg & 0xffff);
622 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
623 unsigned phy_mask, int devad, phy_interface_t interface)
625 u32 phy_id = 0xffffffff;
627 int addr = ffs(phy_mask) - 1;
628 int r = get_phy_id(bus, addr, devad, &phy_id);
631 /* If the PHY ID is mostly f's, we didn't find anything */
632 if ((phy_id & 0x1fffffff) != 0x1fffffff)
633 return phy_device_create(bus, addr, phy_id, interface);
634 phy_mask &= ~(1 << addr);
639 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
640 unsigned phy_mask, phy_interface_t interface)
642 /* If we have one, return the existing device, with new interface */
644 int addr = ffs(phy_mask) - 1;
645 if (bus->phymap[addr]) {
646 bus->phymap[addr]->interface = interface;
647 return bus->phymap[addr];
649 phy_mask &= ~(1 << addr);
654 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
655 unsigned phy_mask, phy_interface_t interface)
658 struct phy_device *phydev;
660 phydev = search_for_existing_phy(bus, phy_mask, interface);
663 /* Try Standard (ie Clause 22) access */
664 /* Otherwise we have to try Clause 45 */
665 for (i = 0; i < 5; i++) {
666 phydev = create_phy_by_mask(bus, phy_mask,
667 i ? i : MDIO_DEVAD_NONE, interface);
673 printf("Phy not found\n");
674 return phy_device_create(bus, ffs(phy_mask) - 1, 0xffffffff, interface);
678 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
679 * @bus: the target MII bus
680 * @addr: PHY address on the MII bus
682 * Description: Reads the ID registers of the PHY at @addr on the
683 * @bus, then allocates and returns the phy_device to represent it.
685 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
686 phy_interface_t interface)
688 return get_phy_device_by_mask(bus, 1 << addr, interface);
691 int phy_reset(struct phy_device *phydev)
696 int devad = MDIO_DEVAD_NONE;
698 #ifdef CONFIG_PHYLIB_10G
699 /* If it's 10G, we need to issue reset through one of the MMDs */
700 if (is_10g_interface(phydev->interface)) {
702 gen10g_discover_mmds(phydev);
704 devad = ffs(phydev->mmds) - 1;
708 reg = phy_read(phydev, devad, MII_BMCR);
710 debug("PHY status read failed\n");
716 err = phy_write(phydev, devad, MII_BMCR, reg);
718 debug("PHY reset failed\n");
722 #ifdef CONFIG_PHY_RESET_DELAY
723 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
726 * Poll the control register for the reset bit to go to 0 (it is
727 * auto-clearing). This should happen within 0.5 seconds per the
730 while ((reg & BMCR_RESET) && timeout-- >= 0) {
731 reg = phy_read(phydev, devad, MII_BMCR);
734 debug("PHY status read failed\n");
740 if (reg & BMCR_RESET) {
741 puts("PHY reset timed out\n");
748 int miiphy_reset(const char *devname, unsigned char addr)
750 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
751 struct phy_device *phydev;
754 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
755 * If later code tries to connect with the right interface, this will
756 * be corrected by get_phy_device in phy_connect()
758 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
760 return phy_reset(phydev);
763 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
764 phy_interface_t interface)
770 /* Wait 15ms to make sure the PHY has come out of hard reset */
772 return get_phy_device_by_mask(bus, phy_mask, interface);
775 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
777 /* Soft Reset the PHY */
780 printf("%s:%d is connected to %s. Reconnecting to %s\n",
781 phydev->bus->name, phydev->addr,
782 phydev->dev->name, dev->name);
785 debug("%s connected to %s\n", dev->name, phydev->drv->name);
788 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
789 struct eth_device *dev, phy_interface_t interface)
791 struct phy_device *phydev;
793 phydev = phy_find_by_mask(bus, 1 << addr, interface);
795 phy_connect_dev(phydev, dev);
797 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
802 * Start the PHY. Returns 0 on success, or a negative error code.
804 int phy_startup(struct phy_device *phydev)
806 if (phydev->drv->startup)
807 return phydev->drv->startup(phydev);
812 static int __board_phy_config(struct phy_device *phydev)
814 if (phydev->drv->config)
815 return phydev->drv->config(phydev);
819 int board_phy_config(struct phy_device *phydev)
820 __attribute__((weak, alias("__board_phy_config")));
822 int phy_config(struct phy_device *phydev)
824 /* Invoke an optional board-specific helper */
825 board_phy_config(phydev);
830 int phy_shutdown(struct phy_device *phydev)
832 if (phydev->drv->shutdown)
833 phydev->drv->shutdown(phydev);