1 /* Framework for finding and configuring PHYs.
2 * Also contains generic PHY driver
6 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/kernel.h>
18 #include <linux/string.h>
19 #include <linux/errno.h>
20 #include <linux/unistd.h>
21 #include <linux/slab.h>
22 #include <linux/interrupt.h>
23 #include <linux/init.h>
24 #include <linux/delay.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/skbuff.h>
29 #include <linux/module.h>
30 #include <linux/mii.h>
31 #include <linux/ethtool.h>
32 #include <linux/phy.h>
33 #include <linux/mdio.h>
35 #include <linux/uaccess.h>
40 MODULE_DESCRIPTION("PHY library");
41 MODULE_AUTHOR("Andy Fleming");
42 MODULE_LICENSE("GPL");
44 void phy_device_free(struct phy_device *phydev)
46 put_device(&phydev->dev);
48 EXPORT_SYMBOL(phy_device_free);
50 static void phy_device_release(struct device *dev)
52 kfree(to_phy_device(dev));
61 static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
63 static LIST_HEAD(phy_fixup_list);
64 static DEFINE_MUTEX(phy_fixup_lock);
67 * phy_register_fixup - creates a new phy_fixup and adds it to the list
68 * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
69 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
70 * It can also be PHY_ANY_UID
71 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
73 * @run: The actual code to be run when a matching PHY is found
75 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
76 int (*run)(struct phy_device *))
78 struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
83 strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
84 fixup->phy_uid = phy_uid;
85 fixup->phy_uid_mask = phy_uid_mask;
88 mutex_lock(&phy_fixup_lock);
89 list_add_tail(&fixup->list, &phy_fixup_list);
90 mutex_unlock(&phy_fixup_lock);
94 EXPORT_SYMBOL(phy_register_fixup);
96 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
97 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
98 int (*run)(struct phy_device *))
100 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
102 EXPORT_SYMBOL(phy_register_fixup_for_uid);
104 /* Registers a fixup to be run on the PHY with id string bus_id */
105 int phy_register_fixup_for_id(const char *bus_id,
106 int (*run)(struct phy_device *))
108 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
110 EXPORT_SYMBOL(phy_register_fixup_for_id);
112 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
113 * Fixups can be set to match any in one or more fields.
115 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
117 if (strcmp(fixup->bus_id, dev_name(&phydev->dev)) != 0)
118 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
121 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
122 (phydev->phy_id & fixup->phy_uid_mask))
123 if (fixup->phy_uid != PHY_ANY_UID)
129 /* Runs any matching fixups for this phydev */
130 static int phy_scan_fixups(struct phy_device *phydev)
132 struct phy_fixup *fixup;
134 mutex_lock(&phy_fixup_lock);
135 list_for_each_entry(fixup, &phy_fixup_list, list) {
136 if (phy_needs_fixup(phydev, fixup)) {
137 int err = fixup->run(phydev);
140 mutex_unlock(&phy_fixup_lock);
143 phydev->has_fixups = true;
146 mutex_unlock(&phy_fixup_lock);
151 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
153 struct phy_c45_device_ids *c45_ids)
155 struct phy_device *dev;
157 /* We allocate the device, and initialize the default values */
158 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
160 return ERR_PTR(-ENOMEM);
162 dev->dev.release = phy_device_release;
169 dev->interface = PHY_INTERFACE_MODE_GMII;
171 dev->autoneg = AUTONEG_ENABLE;
173 dev->is_c45 = is_c45;
175 dev->phy_id = phy_id;
177 dev->c45_ids = *c45_ids;
179 dev->dev.parent = &bus->dev;
180 dev->dev.bus = &mdio_bus_type;
181 dev->irq = bus->irq ? bus->irq[addr] : PHY_POLL;
182 dev_set_name(&dev->dev, PHY_ID_FMT, bus->id, addr);
184 dev->state = PHY_DOWN;
186 mutex_init(&dev->lock);
187 INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
188 INIT_WORK(&dev->phy_queue, phy_change);
190 /* Request the appropriate module unconditionally; don't
191 * bother trying to do so only if it isn't already loaded,
192 * because that gets complicated. A hotplug event would have
193 * done an unconditional modprobe anyway.
194 * We don't do normal hotplug because it won't work for MDIO
195 * -- because it relies on the device staying around for long
196 * enough for the driver to get loaded. With MDIO, the NIC
197 * driver will get bored and give up as soon as it finds that
198 * there's no driver _already_ loaded.
200 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
202 device_initialize(&dev->dev);
206 EXPORT_SYMBOL(phy_device_create);
209 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
210 * @bus: the target MII bus
211 * @addr: PHY address on the MII bus
212 * @phy_id: where to store the ID retrieved.
213 * @c45_ids: where to store the c45 ID information.
215 * If the PHY devices-in-package appears to be valid, it and the
216 * corresponding identifiers are stored in @c45_ids, zero is stored
217 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
221 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
222 struct phy_c45_device_ids *c45_ids) {
225 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
227 /* Find first non-zero Devices In package. Device
228 * zero is reserved, so don't probe it.
231 i < num_ids && c45_ids->devices_in_package == 0;
233 retry: reg_addr = MII_ADDR_C45 | i << 16 | MDIO_DEVS2;
234 phy_reg = mdiobus_read(bus, addr, reg_addr);
237 c45_ids->devices_in_package = (phy_reg & 0xffff) << 16;
239 reg_addr = MII_ADDR_C45 | i << 16 | MDIO_DEVS1;
240 phy_reg = mdiobus_read(bus, addr, reg_addr);
243 c45_ids->devices_in_package |= (phy_reg & 0xffff);
245 if ((c45_ids->devices_in_package & 0x1fffffff) == 0x1fffffff) {
247 /* If mostly Fs, there is no device there,
248 * then let's continue to probe more, as some
249 * 10G PHYs have zero Devices In package,
250 * e.g. Cortina CS4315/CS4340 PHY.
255 /* no device there, let's get out of here */
256 *phy_id = 0xffffffff;
262 /* Now probe Device Identifiers for each device present. */
263 for (i = 1; i < num_ids; i++) {
264 if (!(c45_ids->devices_in_package & (1 << i)))
267 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
268 phy_reg = mdiobus_read(bus, addr, reg_addr);
271 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
273 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
274 phy_reg = mdiobus_read(bus, addr, reg_addr);
277 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
284 * get_phy_id - reads the specified addr for its ID.
285 * @bus: the target MII bus
286 * @addr: PHY address on the MII bus
287 * @phy_id: where to store the ID retrieved.
288 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
289 * @c45_ids: where to store the c45 ID information.
291 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
292 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
295 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
296 * its return value is in turn returned.
299 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
300 bool is_c45, struct phy_c45_device_ids *c45_ids)
305 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
307 /* Grab the bits from PHYIR1, and put them in the upper half */
308 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
312 *phy_id = (phy_reg & 0xffff) << 16;
314 /* Grab the bits from PHYIR2, and put them in the lower half */
315 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
319 *phy_id |= (phy_reg & 0xffff);
325 * get_phy_device - reads the specified PHY device and returns its @phy_device
327 * @bus: the target MII bus
328 * @addr: PHY address on the MII bus
329 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
331 * Description: Reads the ID registers of the PHY at @addr on the
332 * @bus, then allocates and returns the phy_device to represent it.
334 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
336 struct phy_c45_device_ids c45_ids = {0};
340 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
344 /* If the phy_id is mostly Fs, there is no device there */
345 if ((phy_id & 0x1fffffff) == 0x1fffffff)
348 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
350 EXPORT_SYMBOL(get_phy_device);
353 * phy_device_register - Register the phy device on the MDIO bus
354 * @phydev: phy_device structure to be added to the MDIO bus
356 int phy_device_register(struct phy_device *phydev)
360 /* Don't register a phy if one is already registered at this address */
361 if (phydev->bus->phy_map[phydev->addr])
363 phydev->bus->phy_map[phydev->addr] = phydev;
365 /* Run all of the fixups for this PHY */
366 err = phy_scan_fixups(phydev);
368 pr_err("PHY %d failed to initialize\n", phydev->addr);
372 err = device_add(&phydev->dev);
374 pr_err("PHY %d failed to add\n", phydev->addr);
381 phydev->bus->phy_map[phydev->addr] = NULL;
384 EXPORT_SYMBOL(phy_device_register);
387 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
388 * @phydev: phy_device structure to remove
390 * This doesn't free the phy_device itself, it merely reverses the effects
391 * of phy_device_register(). Use phy_device_free() to free the device
392 * after calling this function.
394 void phy_device_remove(struct phy_device *phydev)
396 struct mii_bus *bus = phydev->bus;
397 int addr = phydev->addr;
399 device_del(&phydev->dev);
400 bus->phy_map[addr] = NULL;
402 EXPORT_SYMBOL(phy_device_remove);
405 * phy_find_first - finds the first PHY device on the bus
406 * @bus: the target MII bus
408 struct phy_device *phy_find_first(struct mii_bus *bus)
412 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
413 if (bus->phy_map[addr])
414 return bus->phy_map[addr];
418 EXPORT_SYMBOL(phy_find_first);
421 * phy_prepare_link - prepares the PHY layer to monitor link status
422 * @phydev: target phy_device struct
423 * @handler: callback function for link status change notifications
425 * Description: Tells the PHY infrastructure to handle the
426 * gory details on monitoring link status (whether through
427 * polling or an interrupt), and to call back to the
428 * connected device driver when the link status changes.
429 * If you want to monitor your own link state, don't call
432 static void phy_prepare_link(struct phy_device *phydev,
433 void (*handler)(struct net_device *))
435 phydev->adjust_link = handler;
439 * phy_connect_direct - connect an ethernet device to a specific phy_device
440 * @dev: the network device to connect
441 * @phydev: the pointer to the phy device
442 * @handler: callback function for state change notifications
443 * @interface: PHY device's interface
445 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
446 void (*handler)(struct net_device *),
447 phy_interface_t interface)
451 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
455 phy_prepare_link(phydev, handler);
456 phy_start_machine(phydev);
458 phy_start_interrupts(phydev);
462 EXPORT_SYMBOL(phy_connect_direct);
465 * phy_connect - connect an ethernet device to a PHY device
466 * @dev: the network device to connect
467 * @bus_id: the id string of the PHY device to connect
468 * @handler: callback function for state change notifications
469 * @interface: PHY device's interface
471 * Description: Convenience function for connecting ethernet
472 * devices to PHY devices. The default behavior is for
473 * the PHY infrastructure to handle everything, and only notify
474 * the connected driver when the link status changes. If you
475 * don't want, or can't use the provided functionality, you may
476 * choose to call only the subset of functions which provide
477 * the desired functionality.
479 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
480 void (*handler)(struct net_device *),
481 phy_interface_t interface)
483 struct phy_device *phydev;
487 /* Search the list of PHY devices on the mdio bus for the
488 * PHY with the requested name
490 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
492 pr_err("PHY %s not found\n", bus_id);
493 return ERR_PTR(-ENODEV);
495 phydev = to_phy_device(d);
497 rc = phy_connect_direct(dev, phydev, handler, interface);
503 EXPORT_SYMBOL(phy_connect);
506 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
508 * @phydev: target phy_device struct
510 void phy_disconnect(struct phy_device *phydev)
513 phy_stop_interrupts(phydev);
515 phy_stop_machine(phydev);
517 phydev->adjust_link = NULL;
521 EXPORT_SYMBOL(phy_disconnect);
524 * phy_poll_reset - Safely wait until a PHY reset has properly completed
525 * @phydev: The PHY device to poll
527 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
528 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
529 * register must be polled until the BMCR_RESET bit clears.
531 * Furthermore, any attempts to write to PHY registers may have no effect
532 * or even generate MDIO bus errors until this is complete.
534 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
535 * standard and do not fully reset after the BMCR_RESET bit is set, and may
536 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
537 * effort to support such broken PHYs, this function is separate from the
538 * standard phy_init_hw() which will zero all the other bits in the BMCR
539 * and reapply all driver-specific and board-specific fixups.
541 static int phy_poll_reset(struct phy_device *phydev)
543 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
544 unsigned int retries = 12;
549 ret = phy_read(phydev, MII_BMCR);
552 } while (ret & BMCR_RESET && --retries);
553 if (ret & BMCR_RESET)
556 /* Some chips (smsc911x) may still need up to another 1ms after the
557 * BMCR_RESET bit is cleared before they are usable.
563 int phy_init_hw(struct phy_device *phydev)
567 if (!phydev->drv || !phydev->drv->config_init)
570 if (phydev->drv->soft_reset)
571 ret = phydev->drv->soft_reset(phydev);
573 ret = genphy_soft_reset(phydev);
578 ret = phy_scan_fixups(phydev);
582 return phydev->drv->config_init(phydev);
584 EXPORT_SYMBOL(phy_init_hw);
587 * phy_attach_direct - attach a network device to a given PHY device pointer
588 * @dev: network device to attach
589 * @phydev: Pointer to phy_device to attach
590 * @flags: PHY device's dev_flags
591 * @interface: PHY device's interface
593 * Description: Called by drivers to attach to a particular PHY
594 * device. The phy_device is found, and properly hooked up
595 * to the phy_driver. If no driver is attached, then a
596 * generic driver is used. The phy_device is given a ptr to
597 * the attaching device, and given a callback for link status
598 * change. The phy_device is returned to the attaching driver.
599 * This function takes a reference on the phy device.
601 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
602 u32 flags, phy_interface_t interface)
604 struct mii_bus *bus = phydev->bus;
605 struct device *d = &phydev->dev;
608 if (!try_module_get(bus->owner)) {
609 dev_err(&dev->dev, "failed to get the bus module\n");
615 /* Assume that if there is no driver, that it doesn't
616 * exist, and we should use the genphy driver.
620 d->driver = &genphy_driver[GENPHY_DRV_10G].driver;
622 d->driver = &genphy_driver[GENPHY_DRV_1G].driver;
624 err = d->driver->probe(d);
626 err = device_bind_driver(d);
632 if (phydev->attached_dev) {
633 dev_err(&dev->dev, "PHY already attached\n");
638 phydev->attached_dev = dev;
639 dev->phydev = phydev;
641 phydev->dev_flags = flags;
643 phydev->interface = interface;
645 phydev->state = PHY_READY;
647 /* Do initial configuration here, now that
648 * we have certain key parameters
649 * (dev_flags and interface)
651 err = phy_init_hw(phydev);
661 module_put(bus->owner);
664 EXPORT_SYMBOL(phy_attach_direct);
667 * phy_attach - attach a network device to a particular PHY device
668 * @dev: network device to attach
669 * @bus_id: Bus ID of PHY device to attach
670 * @interface: PHY device's interface
672 * Description: Same as phy_attach_direct() except that a PHY bus_id
673 * string is passed instead of a pointer to a struct phy_device.
675 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
676 phy_interface_t interface)
678 struct bus_type *bus = &mdio_bus_type;
679 struct phy_device *phydev;
683 /* Search the list of PHY devices on the mdio bus for the
684 * PHY with the requested name
686 d = bus_find_device_by_name(bus, NULL, bus_id);
688 pr_err("PHY %s not found\n", bus_id);
689 return ERR_PTR(-ENODEV);
691 phydev = to_phy_device(d);
693 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
699 EXPORT_SYMBOL(phy_attach);
702 * phy_detach - detach a PHY device from its network device
703 * @phydev: target phy_device struct
705 * This detaches the phy device from its network device and the phy
706 * driver, and drops the reference count taken in phy_attach_direct().
708 void phy_detach(struct phy_device *phydev)
713 phydev->attached_dev->phydev = NULL;
714 phydev->attached_dev = NULL;
717 /* If the device had no specific driver before (i.e. - it
718 * was using the generic driver), we unbind the device
719 * from the generic driver so that there's a chance a
720 * real driver could be loaded
722 for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
723 if (phydev->dev.driver == &genphy_driver[i].driver) {
724 device_release_driver(&phydev->dev);
730 * The phydev might go away on the put_device() below, so avoid
731 * a use-after-free bug by reading the underlying bus first.
735 put_device(&phydev->dev);
736 module_put(bus->owner);
738 EXPORT_SYMBOL(phy_detach);
740 int phy_suspend(struct phy_device *phydev)
742 struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
743 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
746 /* If the device has WOL enabled, we cannot suspend the PHY */
747 phy_ethtool_get_wol(phydev, &wol);
752 ret = phydrv->suspend(phydev);
757 phydev->suspended = true;
761 EXPORT_SYMBOL(phy_suspend);
763 int phy_resume(struct phy_device *phydev)
765 struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
769 ret = phydrv->resume(phydev);
774 phydev->suspended = false;
778 EXPORT_SYMBOL(phy_resume);
780 /* Generic PHY support and helper functions */
783 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
784 * @phydev: target phy_device struct
786 * Description: Writes MII_ADVERTISE with the appropriate values,
787 * after sanitizing the values to make sure we only advertise
788 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
789 * hasn't changed, and > 0 if it has changed.
791 static int genphy_config_advert(struct phy_device *phydev)
794 int oldadv, adv, bmsr;
795 int err, changed = 0;
797 /* Only allow advertising what this PHY supports */
798 phydev->advertising &= phydev->supported;
799 advertise = phydev->advertising;
801 /* Setup standard advertisement */
802 adv = phy_read(phydev, MII_ADVERTISE);
807 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
808 ADVERTISE_PAUSE_ASYM);
809 adv |= ethtool_adv_to_mii_adv_t(advertise);
812 err = phy_write(phydev, MII_ADVERTISE, adv);
819 bmsr = phy_read(phydev, MII_BMSR);
823 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
824 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
827 if (!(bmsr & BMSR_ESTATEN))
830 /* Configure gigabit if it's supported */
831 adv = phy_read(phydev, MII_CTRL1000);
836 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
838 if (phydev->supported & (SUPPORTED_1000baseT_Half |
839 SUPPORTED_1000baseT_Full)) {
840 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
846 err = phy_write(phydev, MII_CTRL1000, adv);
854 * genphy_setup_forced - configures/forces speed/duplex from @phydev
855 * @phydev: target phy_device struct
857 * Description: Configures MII_BMCR to force speed/duplex
858 * to the values in phydev. Assumes that the values are valid.
859 * Please see phy_sanitize_settings().
861 int genphy_setup_forced(struct phy_device *phydev)
866 phydev->asym_pause = 0;
868 if (SPEED_1000 == phydev->speed)
869 ctl |= BMCR_SPEED1000;
870 else if (SPEED_100 == phydev->speed)
871 ctl |= BMCR_SPEED100;
873 if (DUPLEX_FULL == phydev->duplex)
874 ctl |= BMCR_FULLDPLX;
876 return phy_write(phydev, MII_BMCR, ctl);
878 EXPORT_SYMBOL(genphy_setup_forced);
881 * genphy_restart_aneg - Enable and Restart Autonegotiation
882 * @phydev: target phy_device struct
884 int genphy_restart_aneg(struct phy_device *phydev)
886 int ctl = phy_read(phydev, MII_BMCR);
891 ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
893 /* Don't isolate the PHY if we're negotiating */
894 ctl &= ~BMCR_ISOLATE;
896 return phy_write(phydev, MII_BMCR, ctl);
898 EXPORT_SYMBOL(genphy_restart_aneg);
901 * genphy_config_aneg - restart auto-negotiation or write BMCR
902 * @phydev: target phy_device struct
904 * Description: If auto-negotiation is enabled, we configure the
905 * advertising, and then restart auto-negotiation. If it is not
906 * enabled, then we write the BMCR.
908 int genphy_config_aneg(struct phy_device *phydev)
912 if (AUTONEG_ENABLE != phydev->autoneg)
913 return genphy_setup_forced(phydev);
915 result = genphy_config_advert(phydev);
916 if (result < 0) /* error */
919 /* Advertisement hasn't changed, but maybe aneg was never on to
920 * begin with? Or maybe phy was isolated?
922 int ctl = phy_read(phydev, MII_BMCR);
927 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
928 result = 1; /* do restart aneg */
931 /* Only restart aneg if we are advertising something different
932 * than we were before.
935 result = genphy_restart_aneg(phydev);
939 EXPORT_SYMBOL(genphy_config_aneg);
942 * genphy_aneg_done - return auto-negotiation status
943 * @phydev: target phy_device struct
945 * Description: Reads the status register and returns 0 either if
946 * auto-negotiation is incomplete, or if there was an error.
947 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
949 int genphy_aneg_done(struct phy_device *phydev)
951 int retval = phy_read(phydev, MII_BMSR);
953 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
955 EXPORT_SYMBOL(genphy_aneg_done);
957 static int gen10g_config_aneg(struct phy_device *phydev)
963 * genphy_update_link - update link status in @phydev
964 * @phydev: target phy_device struct
966 * Description: Update the value in phydev->link to reflect the
967 * current link value. In order to do this, we need to read
968 * the status register twice, keeping the second value.
970 int genphy_update_link(struct phy_device *phydev)
975 status = phy_read(phydev, MII_BMSR);
979 /* Read link and autonegotiation status */
980 status = phy_read(phydev, MII_BMSR);
984 if ((status & BMSR_LSTATUS) == 0)
991 EXPORT_SYMBOL(genphy_update_link);
994 * genphy_read_status - check the link status and update current link state
995 * @phydev: target phy_device struct
997 * Description: Check the link, then figure out the current state
998 * by comparing what we advertise with what the link partner
999 * advertises. Start by checking the gigabit possibilities,
1000 * then move on to 10/100.
1002 int genphy_read_status(struct phy_device *phydev)
1009 int common_adv_gb = 0;
1011 /* Update the link, but return if there was an error */
1012 err = genphy_update_link(phydev);
1016 phydev->lp_advertising = 0;
1018 if (AUTONEG_ENABLE == phydev->autoneg) {
1019 if (phydev->supported & (SUPPORTED_1000baseT_Half
1020 | SUPPORTED_1000baseT_Full)) {
1021 lpagb = phy_read(phydev, MII_STAT1000);
1025 adv = phy_read(phydev, MII_CTRL1000);
1029 phydev->lp_advertising =
1030 mii_stat1000_to_ethtool_lpa_t(lpagb);
1031 common_adv_gb = lpagb & adv << 2;
1034 lpa = phy_read(phydev, MII_LPA);
1038 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1040 adv = phy_read(phydev, MII_ADVERTISE);
1044 common_adv = lpa & adv;
1046 phydev->speed = SPEED_10;
1047 phydev->duplex = DUPLEX_HALF;
1049 phydev->asym_pause = 0;
1051 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1052 phydev->speed = SPEED_1000;
1054 if (common_adv_gb & LPA_1000FULL)
1055 phydev->duplex = DUPLEX_FULL;
1056 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1057 phydev->speed = SPEED_100;
1059 if (common_adv & LPA_100FULL)
1060 phydev->duplex = DUPLEX_FULL;
1062 if (common_adv & LPA_10FULL)
1063 phydev->duplex = DUPLEX_FULL;
1065 if (phydev->duplex == DUPLEX_FULL) {
1066 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1067 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1070 int bmcr = phy_read(phydev, MII_BMCR);
1075 if (bmcr & BMCR_FULLDPLX)
1076 phydev->duplex = DUPLEX_FULL;
1078 phydev->duplex = DUPLEX_HALF;
1080 if (bmcr & BMCR_SPEED1000)
1081 phydev->speed = SPEED_1000;
1082 else if (bmcr & BMCR_SPEED100)
1083 phydev->speed = SPEED_100;
1085 phydev->speed = SPEED_10;
1088 phydev->asym_pause = 0;
1093 EXPORT_SYMBOL(genphy_read_status);
1095 static int gen10g_read_status(struct phy_device *phydev)
1098 u32 mmd_mask = phydev->c45_ids.devices_in_package;
1102 /* For now just lie and say it's 10G all the time */
1103 phydev->speed = SPEED_10000;
1104 phydev->duplex = DUPLEX_FULL;
1106 for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1107 if (!(mmd_mask & 1))
1110 /* Read twice because link state is latched and a
1111 * read moves the current state into the register
1113 phy_read_mmd(phydev, devad, MDIO_STAT1);
1114 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1115 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1123 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1124 * @phydev: target phy_device struct
1126 * Description: Perform a software PHY reset using the standard
1127 * BMCR_RESET bit and poll for the reset bit to be cleared.
1129 * Returns: 0 on success, < 0 on failure
1131 int genphy_soft_reset(struct phy_device *phydev)
1135 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1139 return phy_poll_reset(phydev);
1141 EXPORT_SYMBOL(genphy_soft_reset);
1143 int genphy_config_init(struct phy_device *phydev)
1148 features = (SUPPORTED_TP | SUPPORTED_MII
1149 | SUPPORTED_AUI | SUPPORTED_FIBRE |
1152 /* Do we support autonegotiation? */
1153 val = phy_read(phydev, MII_BMSR);
1157 if (val & BMSR_ANEGCAPABLE)
1158 features |= SUPPORTED_Autoneg;
1160 if (val & BMSR_100FULL)
1161 features |= SUPPORTED_100baseT_Full;
1162 if (val & BMSR_100HALF)
1163 features |= SUPPORTED_100baseT_Half;
1164 if (val & BMSR_10FULL)
1165 features |= SUPPORTED_10baseT_Full;
1166 if (val & BMSR_10HALF)
1167 features |= SUPPORTED_10baseT_Half;
1169 if (val & BMSR_ESTATEN) {
1170 val = phy_read(phydev, MII_ESTATUS);
1174 if (val & ESTATUS_1000_TFULL)
1175 features |= SUPPORTED_1000baseT_Full;
1176 if (val & ESTATUS_1000_THALF)
1177 features |= SUPPORTED_1000baseT_Half;
1180 phydev->supported &= features;
1181 phydev->advertising &= features;
1186 static int gen10g_soft_reset(struct phy_device *phydev)
1188 /* Do nothing for now */
1191 EXPORT_SYMBOL(genphy_config_init);
1193 static int gen10g_config_init(struct phy_device *phydev)
1195 /* Temporarily just say we support everything */
1196 phydev->supported = SUPPORTED_10000baseT_Full;
1197 phydev->advertising = SUPPORTED_10000baseT_Full;
1202 int genphy_suspend(struct phy_device *phydev)
1206 mutex_lock(&phydev->lock);
1208 value = phy_read(phydev, MII_BMCR);
1209 phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1211 mutex_unlock(&phydev->lock);
1215 EXPORT_SYMBOL(genphy_suspend);
1217 static int gen10g_suspend(struct phy_device *phydev)
1222 int genphy_resume(struct phy_device *phydev)
1226 mutex_lock(&phydev->lock);
1228 value = phy_read(phydev, MII_BMCR);
1229 phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1231 mutex_unlock(&phydev->lock);
1235 EXPORT_SYMBOL(genphy_resume);
1237 static int gen10g_resume(struct phy_device *phydev)
1242 static void of_set_phy_supported(struct phy_device *phydev)
1244 struct device_node *node = phydev->dev.of_node;
1247 if (!IS_ENABLED(CONFIG_OF_MDIO))
1253 if (!of_property_read_u32(node, "max-speed", &max_speed)) {
1254 /* The default values for phydev->supported are provided by the PHY
1255 * driver "features" member, we want to reset to sane defaults fist
1256 * before supporting higher speeds.
1258 phydev->supported &= PHY_DEFAULT_FEATURES;
1260 switch (max_speed) {
1265 phydev->supported |= PHY_1000BT_FEATURES;
1267 phydev->supported |= PHY_100BT_FEATURES;
1269 phydev->supported |= PHY_10BT_FEATURES;
1275 * phy_probe - probe and init a PHY device
1276 * @dev: device to probe and init
1278 * Description: Take care of setting up the phy_device structure,
1279 * set the state to READY (the driver's init function should
1280 * set it to STARTING if needed).
1282 static int phy_probe(struct device *dev)
1284 struct phy_device *phydev = to_phy_device(dev);
1285 struct device_driver *drv = phydev->dev.driver;
1286 struct phy_driver *phydrv = to_phy_driver(drv);
1289 phydev->drv = phydrv;
1291 /* Disable the interrupt if the PHY doesn't support it
1292 * but the interrupt is still a valid one
1294 if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1295 phy_interrupt_is_valid(phydev))
1296 phydev->irq = PHY_POLL;
1298 if (phydrv->flags & PHY_IS_INTERNAL)
1299 phydev->is_internal = true;
1301 mutex_lock(&phydev->lock);
1303 /* Start out supporting everything. Eventually,
1304 * a controller will attach, and may modify one
1305 * or both of these values
1307 phydev->supported = phydrv->features;
1308 of_set_phy_supported(phydev);
1309 phydev->advertising = phydev->supported;
1311 /* Set the state to READY by default */
1312 phydev->state = PHY_READY;
1314 if (phydev->drv->probe)
1315 err = phydev->drv->probe(phydev);
1317 mutex_unlock(&phydev->lock);
1322 static int phy_remove(struct device *dev)
1324 struct phy_device *phydev = to_phy_device(dev);
1326 mutex_lock(&phydev->lock);
1327 phydev->state = PHY_DOWN;
1328 mutex_unlock(&phydev->lock);
1330 if (phydev->drv->remove)
1331 phydev->drv->remove(phydev);
1338 * phy_driver_register - register a phy_driver with the PHY layer
1339 * @new_driver: new phy_driver to register
1341 int phy_driver_register(struct phy_driver *new_driver)
1345 new_driver->driver.name = new_driver->name;
1346 new_driver->driver.bus = &mdio_bus_type;
1347 new_driver->driver.probe = phy_probe;
1348 new_driver->driver.remove = phy_remove;
1350 retval = driver_register(&new_driver->driver);
1352 pr_err("%s: Error %d in registering driver\n",
1353 new_driver->name, retval);
1358 pr_debug("%s: Registered new driver\n", new_driver->name);
1362 EXPORT_SYMBOL(phy_driver_register);
1364 int phy_drivers_register(struct phy_driver *new_driver, int n)
1368 for (i = 0; i < n; i++) {
1369 ret = phy_driver_register(new_driver + i);
1372 phy_driver_unregister(new_driver + i);
1378 EXPORT_SYMBOL(phy_drivers_register);
1380 void phy_driver_unregister(struct phy_driver *drv)
1382 driver_unregister(&drv->driver);
1384 EXPORT_SYMBOL(phy_driver_unregister);
1386 void phy_drivers_unregister(struct phy_driver *drv, int n)
1390 for (i = 0; i < n; i++)
1391 phy_driver_unregister(drv + i);
1393 EXPORT_SYMBOL(phy_drivers_unregister);
1395 static struct phy_driver genphy_driver[] = {
1397 .phy_id = 0xffffffff,
1398 .phy_id_mask = 0xffffffff,
1399 .name = "Generic PHY",
1400 .soft_reset = genphy_soft_reset,
1401 .config_init = genphy_config_init,
1402 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
1403 SUPPORTED_AUI | SUPPORTED_FIBRE |
1405 .config_aneg = genphy_config_aneg,
1406 .aneg_done = genphy_aneg_done,
1407 .read_status = genphy_read_status,
1408 .suspend = genphy_suspend,
1409 .resume = genphy_resume,
1410 .driver = { .owner = THIS_MODULE, },
1412 .phy_id = 0xffffffff,
1413 .phy_id_mask = 0xffffffff,
1414 .name = "Generic 10G PHY",
1415 .soft_reset = gen10g_soft_reset,
1416 .config_init = gen10g_config_init,
1418 .config_aneg = gen10g_config_aneg,
1419 .read_status = gen10g_read_status,
1420 .suspend = gen10g_suspend,
1421 .resume = gen10g_resume,
1422 .driver = {.owner = THIS_MODULE, },
1425 static int __init phy_init(void)
1429 rc = mdio_bus_init();
1433 rc = phy_drivers_register(genphy_driver,
1434 ARRAY_SIZE(genphy_driver));
1441 static void __exit phy_exit(void)
1443 phy_drivers_unregister(genphy_driver,
1444 ARRAY_SIZE(genphy_driver));
1448 subsys_initcall(phy_init);
1449 module_exit(phy_exit);