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)
117 phydev->pause = phydev->asym_pause = 0;
119 if (SPEED_1000 == phydev->speed)
120 ctl |= BMCR_SPEED1000;
121 else if (SPEED_100 == phydev->speed)
122 ctl |= BMCR_SPEED100;
124 if (DUPLEX_FULL == phydev->duplex)
125 ctl |= BMCR_FULLDPLX;
127 err = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
134 * genphy_restart_aneg - Enable and Restart Autonegotiation
135 * @phydev: target phy_device struct
137 int genphy_restart_aneg(struct phy_device *phydev)
141 ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
146 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
148 /* Don't isolate the PHY if we're negotiating */
149 ctl &= ~(BMCR_ISOLATE);
151 ctl = phy_write(phydev, MDIO_DEVAD_NONE, MII_BMCR, ctl);
158 * genphy_config_aneg - restart auto-negotiation or write BMCR
159 * @phydev: target phy_device struct
161 * Description: If auto-negotiation is enabled, we configure the
162 * advertising, and then restart auto-negotiation. If it is not
163 * enabled, then we write the BMCR.
165 int genphy_config_aneg(struct phy_device *phydev)
169 if (AUTONEG_ENABLE != phydev->autoneg)
170 return genphy_setup_forced(phydev);
172 result = genphy_config_advert(phydev);
174 if (result < 0) /* error */
178 /* Advertisment hasn't changed, but maybe aneg was never on to
179 * begin with? Or maybe phy was isolated? */
180 int ctl = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
185 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
186 result = 1; /* do restart aneg */
189 /* Only restart aneg if we are advertising something different
190 * than we were before. */
192 result = genphy_restart_aneg(phydev);
198 * genphy_update_link - update link status in @phydev
199 * @phydev: target phy_device struct
201 * Description: Update the value in phydev->link to reflect the
202 * current link value. In order to do this, we need to read
203 * the status register twice, keeping the second value.
205 int genphy_update_link(struct phy_device *phydev)
207 unsigned int mii_reg;
210 * Wait if the link is up, and autonegotiation is in progress
211 * (ie - we're capable and it's not done)
213 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
216 * If we already saw the link up, and it hasn't gone down, then
217 * we don't need to wait for autoneg again
219 if (phydev->link && mii_reg & BMSR_LSTATUS)
222 if ((mii_reg & BMSR_ANEGCAPABLE) && !(mii_reg & BMSR_ANEGCOMPLETE)) {
225 printf("%s Waiting for PHY auto negotiation to complete",
227 while (!(mii_reg & BMSR_ANEGCOMPLETE)) {
231 if (i > PHY_ANEG_TIMEOUT) {
232 printf(" TIMEOUT !\n");
238 puts("user interrupt!\n");
243 if ((i++ % 500) == 0)
246 udelay(1000); /* 1 ms */
247 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
252 /* Read the link a second time to clear the latched state */
253 mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
255 if (mii_reg & BMSR_LSTATUS)
265 * Generic function which updates the speed and duplex. If
266 * autonegotiation is enabled, it uses the AND of the link
267 * partner's advertised capabilities and our advertised
268 * capabilities. If autonegotiation is disabled, we use the
269 * appropriate bits in the control register.
271 * Stolen from Linux's mii.c and phy_device.c
273 int genphy_parse_link(struct phy_device *phydev)
275 int mii_reg = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
277 /* We're using autonegotiation */
278 if (mii_reg & BMSR_ANEGCAPABLE) {
283 /* Check for gigabit capability */
284 if (mii_reg & BMSR_ERCAP) {
285 /* We want a list of states supported by
286 * both PHYs in the link
288 gblpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_STAT1000);
289 gblpa &= phy_read(phydev,
290 MDIO_DEVAD_NONE, MII_CTRL1000) << 2;
293 /* Set the baseline so we only have to set them
294 * if they're different
296 phydev->speed = SPEED_10;
297 phydev->duplex = DUPLEX_HALF;
299 /* Check the gigabit fields */
300 if (gblpa & (PHY_1000BTSR_1000FD | PHY_1000BTSR_1000HD)) {
301 phydev->speed = SPEED_1000;
303 if (gblpa & PHY_1000BTSR_1000FD)
304 phydev->duplex = DUPLEX_FULL;
310 lpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
311 lpa &= phy_read(phydev, MDIO_DEVAD_NONE, MII_LPA);
313 if (lpa & (LPA_100FULL | LPA_100HALF)) {
314 phydev->speed = SPEED_100;
316 if (lpa & LPA_100FULL)
317 phydev->duplex = DUPLEX_FULL;
319 } else if (lpa & LPA_10FULL)
320 phydev->duplex = DUPLEX_FULL;
323 * Extended status may indicate that the PHY supports
324 * 1000BASE-T/X even though the 1000BASE-T registers
325 * are missing. In this case we can't tell whether the
326 * peer also supports it, so we only check extended
327 * status if the 1000BASE-T registers are actually
330 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
331 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
334 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
335 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
336 phydev->speed = SPEED_1000;
337 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
338 phydev->duplex = DUPLEX_FULL;
342 u32 bmcr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
344 phydev->speed = SPEED_10;
345 phydev->duplex = DUPLEX_HALF;
347 if (bmcr & BMCR_FULLDPLX)
348 phydev->duplex = DUPLEX_FULL;
350 if (bmcr & BMCR_SPEED1000)
351 phydev->speed = SPEED_1000;
352 else if (bmcr & BMCR_SPEED100)
353 phydev->speed = SPEED_100;
359 int genphy_config(struct phy_device *phydev)
364 /* For now, I'll claim that the generic driver supports
365 * all possible port types */
366 features = (SUPPORTED_TP | SUPPORTED_MII
367 | SUPPORTED_AUI | SUPPORTED_FIBRE |
370 /* Do we support autonegotiation? */
371 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
376 if (val & BMSR_ANEGCAPABLE)
377 features |= SUPPORTED_Autoneg;
379 if (val & BMSR_100FULL)
380 features |= SUPPORTED_100baseT_Full;
381 if (val & BMSR_100HALF)
382 features |= SUPPORTED_100baseT_Half;
383 if (val & BMSR_10FULL)
384 features |= SUPPORTED_10baseT_Full;
385 if (val & BMSR_10HALF)
386 features |= SUPPORTED_10baseT_Half;
388 if (val & BMSR_ESTATEN) {
389 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
394 if (val & ESTATUS_1000_TFULL)
395 features |= SUPPORTED_1000baseT_Full;
396 if (val & ESTATUS_1000_THALF)
397 features |= SUPPORTED_1000baseT_Half;
398 if (val & ESTATUS_1000_XFULL)
399 features |= SUPPORTED_1000baseX_Full;
400 if (val & ESTATUS_1000_XHALF)
401 features |= SUPPORTED_1000baseX_Half;
404 phydev->supported = features;
405 phydev->advertising = features;
407 genphy_config_aneg(phydev);
412 int genphy_startup(struct phy_device *phydev)
414 genphy_update_link(phydev);
415 genphy_parse_link(phydev);
420 int genphy_shutdown(struct phy_device *phydev)
425 static struct phy_driver genphy_driver = {
428 .name = "Generic PHY",
430 .config = genphy_config,
431 .startup = genphy_startup,
432 .shutdown = genphy_shutdown,
435 static LIST_HEAD(phy_drivers);
439 #ifdef CONFIG_PHY_ATHEROS
442 #ifdef CONFIG_PHY_BROADCOM
445 #ifdef CONFIG_PHY_DAVICOM
448 #ifdef CONFIG_PHY_ET1011C
451 #ifdef CONFIG_PHY_ICPLUS
454 #ifdef CONFIG_PHY_LXT
457 #ifdef CONFIG_PHY_MARVELL
460 #ifdef CONFIG_PHY_MICREL
463 #ifdef CONFIG_PHY_NATSEMI
466 #ifdef CONFIG_PHY_REALTEK
469 #ifdef CONFIG_PHY_SMSC
472 #ifdef CONFIG_PHY_TERANETICS
473 phy_teranetics_init();
475 #ifdef CONFIG_PHY_VITESSE
482 int phy_register(struct phy_driver *drv)
484 INIT_LIST_HEAD(&drv->list);
485 list_add_tail(&drv->list, &phy_drivers);
490 static int phy_probe(struct phy_device *phydev)
494 phydev->advertising = phydev->supported = phydev->drv->features;
495 phydev->mmds = phydev->drv->mmds;
497 if (phydev->drv->probe)
498 err = phydev->drv->probe(phydev);
503 static struct phy_driver *generic_for_interface(phy_interface_t interface)
505 #ifdef CONFIG_PHYLIB_10G
506 if (is_10g_interface(interface))
507 return &gen10g_driver;
510 return &genphy_driver;
513 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
514 phy_interface_t interface)
516 struct list_head *entry;
517 int phy_id = phydev->phy_id;
518 struct phy_driver *drv = NULL;
520 list_for_each(entry, &phy_drivers) {
521 drv = list_entry(entry, struct phy_driver, list);
522 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
526 /* If we made it here, there's no driver for this PHY */
527 return generic_for_interface(interface);
530 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
532 phy_interface_t interface)
534 struct phy_device *dev;
536 /* We allocate the device, and initialize the
538 dev = malloc(sizeof(*dev));
540 printf("Failed to allocate PHY device for %s:%d\n",
545 memset(dev, 0, sizeof(*dev));
549 dev->interface = interface;
551 dev->autoneg = AUTONEG_ENABLE;
554 dev->phy_id = phy_id;
557 dev->drv = get_phy_driver(dev, interface);
561 bus->phymap[addr] = dev;
567 * get_phy_id - reads the specified addr for its ID.
568 * @bus: the target MII bus
569 * @addr: PHY address on the MII bus
570 * @phy_id: where to store the ID retrieved.
572 * Description: Reads the ID registers of the PHY at @addr on the
573 * @bus, stores it in @phy_id and returns zero on success.
575 static int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
579 /* Grab the bits from PHYIR1, and put them
580 * in the upper half */
581 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
586 *phy_id = (phy_reg & 0xffff) << 16;
588 /* Grab the bits from PHYIR2, and put them in the lower half */
589 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
594 *phy_id |= (phy_reg & 0xffff);
599 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
600 unsigned phy_mask, int devad, phy_interface_t interface)
602 u32 phy_id = 0xffffffff;
604 int addr = ffs(phy_mask) - 1;
605 int r = get_phy_id(bus, addr, devad, &phy_id);
608 /* If the PHY ID is mostly f's, we didn't find anything */
609 if ((phy_id & 0x1fffffff) != 0x1fffffff)
610 return phy_device_create(bus, addr, phy_id, interface);
611 phy_mask &= ~(1 << addr);
616 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
617 unsigned phy_mask, phy_interface_t interface)
619 /* If we have one, return the existing device, with new interface */
621 int addr = ffs(phy_mask) - 1;
622 if (bus->phymap[addr]) {
623 bus->phymap[addr]->interface = interface;
624 return bus->phymap[addr];
626 phy_mask &= ~(1 << addr);
631 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
632 unsigned phy_mask, phy_interface_t interface)
635 struct phy_device *phydev;
637 phydev = search_for_existing_phy(bus, phy_mask, interface);
640 /* Try Standard (ie Clause 22) access */
641 /* Otherwise we have to try Clause 45 */
642 for (i = 0; i < 5; i++) {
643 phydev = create_phy_by_mask(bus, phy_mask,
644 i ? i : MDIO_DEVAD_NONE, interface);
650 printf("Phy not found\n");
651 return phy_device_create(bus, ffs(phy_mask) - 1, 0xffffffff, interface);
655 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
656 * @bus: the target MII bus
657 * @addr: PHY address on the MII bus
659 * Description: Reads the ID registers of the PHY at @addr on the
660 * @bus, then allocates and returns the phy_device to represent it.
662 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
663 phy_interface_t interface)
665 return get_phy_device_by_mask(bus, 1 << addr, interface);
668 int phy_reset(struct phy_device *phydev)
672 int devad = MDIO_DEVAD_NONE;
674 #ifdef CONFIG_PHYLIB_10G
675 /* If it's 10G, we need to issue reset through one of the MMDs */
676 if (is_10g_interface(phydev->interface)) {
678 gen10g_discover_mmds(phydev);
680 devad = ffs(phydev->mmds) - 1;
684 reg = phy_read(phydev, devad, MII_BMCR);
686 debug("PHY status read failed\n");
692 if (phy_write(phydev, devad, MII_BMCR, reg) < 0) {
693 debug("PHY reset failed\n");
697 #ifdef CONFIG_PHY_RESET_DELAY
698 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
701 * Poll the control register for the reset bit to go to 0 (it is
702 * auto-clearing). This should happen within 0.5 seconds per the
705 while ((reg & BMCR_RESET) && timeout--) {
706 reg = phy_read(phydev, devad, MII_BMCR);
709 debug("PHY status read failed\n");
715 if (reg & BMCR_RESET) {
716 puts("PHY reset timed out\n");
723 int miiphy_reset(const char *devname, unsigned char addr)
725 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
726 struct phy_device *phydev;
729 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
730 * If later code tries to connect with the right interface, this will
731 * be corrected by get_phy_device in phy_connect()
733 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
735 return phy_reset(phydev);
738 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
739 phy_interface_t interface)
745 /* Wait 15ms to make sure the PHY has come out of hard reset */
747 return get_phy_device_by_mask(bus, phy_mask, interface);
750 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
752 /* Soft Reset the PHY */
755 printf("%s:%d is connected to %s. Reconnecting to %s\n",
756 phydev->bus->name, phydev->addr,
757 phydev->dev->name, dev->name);
760 debug("%s connected to %s\n", dev->name, phydev->drv->name);
763 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
764 struct eth_device *dev, phy_interface_t interface)
766 struct phy_device *phydev;
768 phydev = phy_find_by_mask(bus, 1 << addr, interface);
770 phy_connect_dev(phydev, dev);
772 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
777 * Start the PHY. Returns 0 on success, or a negative error code.
779 int phy_startup(struct phy_device *phydev)
781 if (phydev->drv->startup)
782 return phydev->drv->startup(phydev);
787 static int __board_phy_config(struct phy_device *phydev)
789 if (phydev->drv->config)
790 return phydev->drv->config(phydev);
794 int board_phy_config(struct phy_device *phydev)
795 __attribute__((weak, alias("__board_phy_config")));
797 int phy_config(struct phy_device *phydev)
799 /* Invoke an optional board-specific helper */
800 board_phy_config(phydev);
805 int phy_shutdown(struct phy_device *phydev)
807 if (phydev->drv->shutdown)
808 phydev->drv->shutdown(phydev);