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);
290 debug("Could not read MII_STAT1000. Ignoring gigabit capability\n");
293 gblpa &= phy_read(phydev,
294 MDIO_DEVAD_NONE, MII_CTRL1000) << 2;
297 /* Set the baseline so we only have to set them
298 * if they're different
300 phydev->speed = SPEED_10;
301 phydev->duplex = DUPLEX_HALF;
303 /* Check the gigabit fields */
304 if (gblpa & (PHY_1000BTSR_1000FD | PHY_1000BTSR_1000HD)) {
305 phydev->speed = SPEED_1000;
307 if (gblpa & PHY_1000BTSR_1000FD)
308 phydev->duplex = DUPLEX_FULL;
314 lpa = phy_read(phydev, MDIO_DEVAD_NONE, MII_ADVERTISE);
315 lpa &= phy_read(phydev, MDIO_DEVAD_NONE, MII_LPA);
317 if (lpa & (LPA_100FULL | LPA_100HALF)) {
318 phydev->speed = SPEED_100;
320 if (lpa & LPA_100FULL)
321 phydev->duplex = DUPLEX_FULL;
323 } else if (lpa & LPA_10FULL)
324 phydev->duplex = DUPLEX_FULL;
327 * Extended status may indicate that the PHY supports
328 * 1000BASE-T/X even though the 1000BASE-T registers
329 * are missing. In this case we can't tell whether the
330 * peer also supports it, so we only check extended
331 * status if the 1000BASE-T registers are actually
334 if ((mii_reg & BMSR_ESTATEN) && !(mii_reg & BMSR_ERCAP))
335 estatus = phy_read(phydev, MDIO_DEVAD_NONE,
338 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_XHALF |
339 ESTATUS_1000_TFULL | ESTATUS_1000_THALF)) {
340 phydev->speed = SPEED_1000;
341 if (estatus & (ESTATUS_1000_XFULL | ESTATUS_1000_TFULL))
342 phydev->duplex = DUPLEX_FULL;
346 u32 bmcr = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMCR);
348 phydev->speed = SPEED_10;
349 phydev->duplex = DUPLEX_HALF;
351 if (bmcr & BMCR_FULLDPLX)
352 phydev->duplex = DUPLEX_FULL;
354 if (bmcr & BMCR_SPEED1000)
355 phydev->speed = SPEED_1000;
356 else if (bmcr & BMCR_SPEED100)
357 phydev->speed = SPEED_100;
363 int genphy_config(struct phy_device *phydev)
368 /* For now, I'll claim that the generic driver supports
369 * all possible port types */
370 features = (SUPPORTED_TP | SUPPORTED_MII
371 | SUPPORTED_AUI | SUPPORTED_FIBRE |
374 /* Do we support autonegotiation? */
375 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_BMSR);
380 if (val & BMSR_ANEGCAPABLE)
381 features |= SUPPORTED_Autoneg;
383 if (val & BMSR_100FULL)
384 features |= SUPPORTED_100baseT_Full;
385 if (val & BMSR_100HALF)
386 features |= SUPPORTED_100baseT_Half;
387 if (val & BMSR_10FULL)
388 features |= SUPPORTED_10baseT_Full;
389 if (val & BMSR_10HALF)
390 features |= SUPPORTED_10baseT_Half;
392 if (val & BMSR_ESTATEN) {
393 val = phy_read(phydev, MDIO_DEVAD_NONE, MII_ESTATUS);
398 if (val & ESTATUS_1000_TFULL)
399 features |= SUPPORTED_1000baseT_Full;
400 if (val & ESTATUS_1000_THALF)
401 features |= SUPPORTED_1000baseT_Half;
402 if (val & ESTATUS_1000_XFULL)
403 features |= SUPPORTED_1000baseX_Full;
404 if (val & ESTATUS_1000_XHALF)
405 features |= SUPPORTED_1000baseX_Half;
408 phydev->supported = features;
409 phydev->advertising = features;
411 genphy_config_aneg(phydev);
416 int genphy_startup(struct phy_device *phydev)
418 genphy_update_link(phydev);
419 genphy_parse_link(phydev);
424 int genphy_shutdown(struct phy_device *phydev)
429 static struct phy_driver genphy_driver = {
432 .name = "Generic PHY",
434 .config = genphy_config,
435 .startup = genphy_startup,
436 .shutdown = genphy_shutdown,
439 static LIST_HEAD(phy_drivers);
443 #ifdef CONFIG_PHY_ATHEROS
446 #ifdef CONFIG_PHY_BROADCOM
449 #ifdef CONFIG_PHY_DAVICOM
452 #ifdef CONFIG_PHY_ET1011C
455 #ifdef CONFIG_PHY_ICPLUS
458 #ifdef CONFIG_PHY_LXT
461 #ifdef CONFIG_PHY_MARVELL
464 #ifdef CONFIG_PHY_MICREL
467 #ifdef CONFIG_PHY_NATSEMI
470 #ifdef CONFIG_PHY_REALTEK
473 #ifdef CONFIG_PHY_SMSC
476 #ifdef CONFIG_PHY_TERANETICS
477 phy_teranetics_init();
479 #ifdef CONFIG_PHY_VITESSE
486 int phy_register(struct phy_driver *drv)
488 INIT_LIST_HEAD(&drv->list);
489 list_add_tail(&drv->list, &phy_drivers);
494 static int phy_probe(struct phy_device *phydev)
498 phydev->advertising = phydev->supported = phydev->drv->features;
499 phydev->mmds = phydev->drv->mmds;
501 if (phydev->drv->probe)
502 err = phydev->drv->probe(phydev);
507 static struct phy_driver *generic_for_interface(phy_interface_t interface)
509 #ifdef CONFIG_PHYLIB_10G
510 if (is_10g_interface(interface))
511 return &gen10g_driver;
514 return &genphy_driver;
517 static struct phy_driver *get_phy_driver(struct phy_device *phydev,
518 phy_interface_t interface)
520 struct list_head *entry;
521 int phy_id = phydev->phy_id;
522 struct phy_driver *drv = NULL;
524 list_for_each(entry, &phy_drivers) {
525 drv = list_entry(entry, struct phy_driver, list);
526 if ((drv->uid & drv->mask) == (phy_id & drv->mask))
530 /* If we made it here, there's no driver for this PHY */
531 return generic_for_interface(interface);
534 static struct phy_device *phy_device_create(struct mii_dev *bus, int addr,
536 phy_interface_t interface)
538 struct phy_device *dev;
540 /* We allocate the device, and initialize the
542 dev = malloc(sizeof(*dev));
544 printf("Failed to allocate PHY device for %s:%d\n",
549 memset(dev, 0, sizeof(*dev));
553 dev->interface = interface;
555 dev->autoneg = AUTONEG_ENABLE;
558 dev->phy_id = phy_id;
561 dev->drv = get_phy_driver(dev, interface);
565 bus->phymap[addr] = dev;
571 * get_phy_id - reads the specified addr for its ID.
572 * @bus: the target MII bus
573 * @addr: PHY address on the MII bus
574 * @phy_id: where to store the ID retrieved.
576 * Description: Reads the ID registers of the PHY at @addr on the
577 * @bus, stores it in @phy_id and returns zero on success.
579 static int get_phy_id(struct mii_dev *bus, int addr, int devad, u32 *phy_id)
583 /* Grab the bits from PHYIR1, and put them
584 * in the upper half */
585 phy_reg = bus->read(bus, addr, devad, MII_PHYSID1);
590 *phy_id = (phy_reg & 0xffff) << 16;
592 /* Grab the bits from PHYIR2, and put them in the lower half */
593 phy_reg = bus->read(bus, addr, devad, MII_PHYSID2);
598 *phy_id |= (phy_reg & 0xffff);
603 static struct phy_device *create_phy_by_mask(struct mii_dev *bus,
604 unsigned phy_mask, int devad, phy_interface_t interface)
606 u32 phy_id = 0xffffffff;
608 int addr = ffs(phy_mask) - 1;
609 int r = get_phy_id(bus, addr, devad, &phy_id);
612 /* If the PHY ID is mostly f's, we didn't find anything */
613 if ((phy_id & 0x1fffffff) != 0x1fffffff)
614 return phy_device_create(bus, addr, phy_id, interface);
615 phy_mask &= ~(1 << addr);
620 static struct phy_device *search_for_existing_phy(struct mii_dev *bus,
621 unsigned phy_mask, phy_interface_t interface)
623 /* If we have one, return the existing device, with new interface */
625 int addr = ffs(phy_mask) - 1;
626 if (bus->phymap[addr]) {
627 bus->phymap[addr]->interface = interface;
628 return bus->phymap[addr];
630 phy_mask &= ~(1 << addr);
635 static struct phy_device *get_phy_device_by_mask(struct mii_dev *bus,
636 unsigned phy_mask, phy_interface_t interface)
639 struct phy_device *phydev;
641 phydev = search_for_existing_phy(bus, phy_mask, interface);
644 /* Try Standard (ie Clause 22) access */
645 /* Otherwise we have to try Clause 45 */
646 for (i = 0; i < 5; i++) {
647 phydev = create_phy_by_mask(bus, phy_mask,
648 i ? i : MDIO_DEVAD_NONE, interface);
654 printf("Phy not found\n");
655 return phy_device_create(bus, ffs(phy_mask) - 1, 0xffffffff, interface);
659 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
660 * @bus: the target MII bus
661 * @addr: PHY address on the MII bus
663 * Description: Reads the ID registers of the PHY at @addr on the
664 * @bus, then allocates and returns the phy_device to represent it.
666 static struct phy_device *get_phy_device(struct mii_dev *bus, int addr,
667 phy_interface_t interface)
669 return get_phy_device_by_mask(bus, 1 << addr, interface);
672 int phy_reset(struct phy_device *phydev)
676 int devad = MDIO_DEVAD_NONE;
678 #ifdef CONFIG_PHYLIB_10G
679 /* If it's 10G, we need to issue reset through one of the MMDs */
680 if (is_10g_interface(phydev->interface)) {
682 gen10g_discover_mmds(phydev);
684 devad = ffs(phydev->mmds) - 1;
688 reg = phy_read(phydev, devad, MII_BMCR);
690 debug("PHY status read failed\n");
696 if (phy_write(phydev, devad, MII_BMCR, reg) < 0) {
697 debug("PHY reset failed\n");
701 #ifdef CONFIG_PHY_RESET_DELAY
702 udelay(CONFIG_PHY_RESET_DELAY); /* Intel LXT971A needs this */
705 * Poll the control register for the reset bit to go to 0 (it is
706 * auto-clearing). This should happen within 0.5 seconds per the
709 while ((reg & BMCR_RESET) && timeout--) {
710 reg = phy_read(phydev, devad, MII_BMCR);
713 debug("PHY status read failed\n");
719 if (reg & BMCR_RESET) {
720 puts("PHY reset timed out\n");
727 int miiphy_reset(const char *devname, unsigned char addr)
729 struct mii_dev *bus = miiphy_get_dev_by_name(devname);
730 struct phy_device *phydev;
733 * miiphy_reset was only used on standard PHYs, so we'll fake it here.
734 * If later code tries to connect with the right interface, this will
735 * be corrected by get_phy_device in phy_connect()
737 phydev = get_phy_device(bus, addr, PHY_INTERFACE_MODE_MII);
739 return phy_reset(phydev);
742 struct phy_device *phy_find_by_mask(struct mii_dev *bus, unsigned phy_mask,
743 phy_interface_t interface)
749 /* Wait 15ms to make sure the PHY has come out of hard reset */
751 return get_phy_device_by_mask(bus, phy_mask, interface);
754 void phy_connect_dev(struct phy_device *phydev, struct eth_device *dev)
756 /* Soft Reset the PHY */
759 printf("%s:%d is connected to %s. Reconnecting to %s\n",
760 phydev->bus->name, phydev->addr,
761 phydev->dev->name, dev->name);
764 debug("%s connected to %s\n", dev->name, phydev->drv->name);
767 struct phy_device *phy_connect(struct mii_dev *bus, int addr,
768 struct eth_device *dev, phy_interface_t interface)
770 struct phy_device *phydev;
772 phydev = phy_find_by_mask(bus, 1 << addr, interface);
774 phy_connect_dev(phydev, dev);
776 printf("Could not get PHY for %s: addr %d\n", bus->name, addr);
781 * Start the PHY. Returns 0 on success, or a negative error code.
783 int phy_startup(struct phy_device *phydev)
785 if (phydev->drv->startup)
786 return phydev->drv->startup(phydev);
791 static int __board_phy_config(struct phy_device *phydev)
793 if (phydev->drv->config)
794 return phydev->drv->config(phydev);
798 int board_phy_config(struct phy_device *phydev)
799 __attribute__((weak, alias("__board_phy_config")));
801 int phy_config(struct phy_device *phydev)
803 /* Invoke an optional board-specific helper */
804 board_phy_config(phydev);
809 int phy_shutdown(struct phy_device *phydev)
811 if (phydev->drv->shutdown)
812 phydev->drv->shutdown(phydev);