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;
164 dev->speed = SPEED_UNKNOWN;
165 dev->duplex = DUPLEX_UNKNOWN;
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);
208 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
209 * @bus: the target MII bus
210 * @addr: PHY address on the MII bus
211 * @dev_addr: MMD address in the PHY.
212 * @devices_in_package: where to store the devices in package information.
214 * Description: reads devices in package registers of a MMD at @dev_addr
215 * from PHY at @addr on @bus.
217 * Returns: 0 on success, -EIO on failure.
219 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
220 u32 *devices_in_package)
222 int phy_reg, reg_addr;
224 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
225 phy_reg = mdiobus_read(bus, addr, reg_addr);
228 *devices_in_package = (phy_reg & 0xffff) << 16;
230 reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
231 phy_reg = mdiobus_read(bus, addr, reg_addr);
234 *devices_in_package |= (phy_reg & 0xffff);
240 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
241 * @bus: the target MII bus
242 * @addr: PHY address on the MII bus
243 * @phy_id: where to store the ID retrieved.
244 * @c45_ids: where to store the c45 ID information.
246 * If the PHY devices-in-package appears to be valid, it and the
247 * corresponding identifiers are stored in @c45_ids, zero is stored
248 * in @phy_id. Otherwise 0xffffffff is stored in @phy_id. Returns
252 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
253 struct phy_c45_device_ids *c45_ids) {
256 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
257 u32 *devs = &c45_ids->devices_in_package;
259 /* Find first non-zero Devices In package. Device zero is reserved
260 * for 802.3 c45 complied PHYs, so don't probe it at first.
262 for (i = 1; i < num_ids && *devs == 0; i++) {
263 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
267 if ((*devs & 0x1fffffff) == 0x1fffffff) {
268 /* If mostly Fs, there is no device there,
269 * then let's continue to probe more, as some
270 * 10G PHYs have zero Devices In package,
271 * e.g. Cortina CS4315/CS4340 PHY.
273 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
276 /* no device there, let's get out of here */
277 if ((*devs & 0x1fffffff) == 0x1fffffff) {
278 *phy_id = 0xffffffff;
286 /* Now probe Device Identifiers for each device present. */
287 for (i = 1; i < num_ids; i++) {
288 if (!(c45_ids->devices_in_package & (1 << i)))
291 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
292 phy_reg = mdiobus_read(bus, addr, reg_addr);
295 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
297 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
298 phy_reg = mdiobus_read(bus, addr, reg_addr);
301 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
308 * get_phy_id - reads the specified addr for its ID.
309 * @bus: the target MII bus
310 * @addr: PHY address on the MII bus
311 * @phy_id: where to store the ID retrieved.
312 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
313 * @c45_ids: where to store the c45 ID information.
315 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
316 * of the PHY at @addr on the @bus, stores it in @phy_id and returns
319 * In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
320 * its return value is in turn returned.
323 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
324 bool is_c45, struct phy_c45_device_ids *c45_ids)
329 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
331 /* Grab the bits from PHYIR1, and put them in the upper half */
332 phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
336 *phy_id = (phy_reg & 0xffff) << 16;
338 /* Grab the bits from PHYIR2, and put them in the lower half */
339 phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
343 *phy_id |= (phy_reg & 0xffff);
349 * get_phy_device - reads the specified PHY device and returns its @phy_device
351 * @bus: the target MII bus
352 * @addr: PHY address on the MII bus
353 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
355 * Description: Reads the ID registers of the PHY at @addr on the
356 * @bus, then allocates and returns the phy_device to represent it.
358 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
360 struct phy_c45_device_ids c45_ids = {0};
364 r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
368 /* If the phy_id is mostly Fs, there is no device there */
369 if ((phy_id & 0x1fffffff) == 0x1fffffff)
372 return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
374 EXPORT_SYMBOL(get_phy_device);
377 * phy_device_register - Register the phy device on the MDIO bus
378 * @phydev: phy_device structure to be added to the MDIO bus
380 int phy_device_register(struct phy_device *phydev)
384 /* Don't register a phy if one is already registered at this address */
385 if (phydev->bus->phy_map[phydev->addr])
387 phydev->bus->phy_map[phydev->addr] = phydev;
389 /* Run all of the fixups for this PHY */
390 err = phy_scan_fixups(phydev);
392 pr_err("PHY %d failed to initialize\n", phydev->addr);
396 err = device_add(&phydev->dev);
398 pr_err("PHY %d failed to add\n", phydev->addr);
405 phydev->bus->phy_map[phydev->addr] = NULL;
408 EXPORT_SYMBOL(phy_device_register);
411 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
412 * @phydev: phy_device structure to remove
414 * This doesn't free the phy_device itself, it merely reverses the effects
415 * of phy_device_register(). Use phy_device_free() to free the device
416 * after calling this function.
418 void phy_device_remove(struct phy_device *phydev)
420 struct mii_bus *bus = phydev->bus;
421 int addr = phydev->addr;
423 device_del(&phydev->dev);
424 bus->phy_map[addr] = NULL;
426 EXPORT_SYMBOL(phy_device_remove);
429 * phy_find_first - finds the first PHY device on the bus
430 * @bus: the target MII bus
432 struct phy_device *phy_find_first(struct mii_bus *bus)
436 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
437 if (bus->phy_map[addr])
438 return bus->phy_map[addr];
442 EXPORT_SYMBOL(phy_find_first);
445 * phy_prepare_link - prepares the PHY layer to monitor link status
446 * @phydev: target phy_device struct
447 * @handler: callback function for link status change notifications
449 * Description: Tells the PHY infrastructure to handle the
450 * gory details on monitoring link status (whether through
451 * polling or an interrupt), and to call back to the
452 * connected device driver when the link status changes.
453 * If you want to monitor your own link state, don't call
456 static void phy_prepare_link(struct phy_device *phydev,
457 void (*handler)(struct net_device *))
459 phydev->adjust_link = handler;
463 * phy_connect_direct - connect an ethernet device to a specific phy_device
464 * @dev: the network device to connect
465 * @phydev: the pointer to the phy device
466 * @handler: callback function for state change notifications
467 * @interface: PHY device's interface
469 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
470 void (*handler)(struct net_device *),
471 phy_interface_t interface)
478 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
482 phy_prepare_link(phydev, handler);
483 phy_start_machine(phydev);
485 phy_start_interrupts(phydev);
489 EXPORT_SYMBOL(phy_connect_direct);
492 * phy_connect - connect an ethernet device to a PHY device
493 * @dev: the network device to connect
494 * @bus_id: the id string of the PHY device to connect
495 * @handler: callback function for state change notifications
496 * @interface: PHY device's interface
498 * Description: Convenience function for connecting ethernet
499 * devices to PHY devices. The default behavior is for
500 * the PHY infrastructure to handle everything, and only notify
501 * the connected driver when the link status changes. If you
502 * don't want, or can't use the provided functionality, you may
503 * choose to call only the subset of functions which provide
504 * the desired functionality.
506 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
507 void (*handler)(struct net_device *),
508 phy_interface_t interface)
510 struct phy_device *phydev;
514 /* Search the list of PHY devices on the mdio bus for the
515 * PHY with the requested name
517 d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
519 pr_err("PHY %s not found\n", bus_id);
520 return ERR_PTR(-ENODEV);
522 phydev = to_phy_device(d);
524 rc = phy_connect_direct(dev, phydev, handler, interface);
531 EXPORT_SYMBOL(phy_connect);
534 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
536 * @phydev: target phy_device struct
538 void phy_disconnect(struct phy_device *phydev)
541 phy_stop_interrupts(phydev);
543 phy_stop_machine(phydev);
545 phydev->adjust_link = NULL;
549 EXPORT_SYMBOL(phy_disconnect);
552 * phy_poll_reset - Safely wait until a PHY reset has properly completed
553 * @phydev: The PHY device to poll
555 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
556 * published in 2008, a PHY reset may take up to 0.5 seconds. The MII BMCR
557 * register must be polled until the BMCR_RESET bit clears.
559 * Furthermore, any attempts to write to PHY registers may have no effect
560 * or even generate MDIO bus errors until this is complete.
562 * Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
563 * standard and do not fully reset after the BMCR_RESET bit is set, and may
564 * even *REQUIRE* a soft-reset to properly restart autonegotiation. In an
565 * effort to support such broken PHYs, this function is separate from the
566 * standard phy_init_hw() which will zero all the other bits in the BMCR
567 * and reapply all driver-specific and board-specific fixups.
569 static int phy_poll_reset(struct phy_device *phydev)
571 /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
572 unsigned int retries = 12;
577 ret = phy_read(phydev, MII_BMCR);
580 } while (ret & BMCR_RESET && --retries);
581 if (ret & BMCR_RESET)
584 /* Some chips (smsc911x) may still need up to another 1ms after the
585 * BMCR_RESET bit is cleared before they are usable.
591 int phy_init_hw(struct phy_device *phydev)
595 if (!phydev->drv || !phydev->drv->config_init)
598 if (phydev->drv->soft_reset)
599 ret = phydev->drv->soft_reset(phydev);
601 ret = genphy_soft_reset(phydev);
606 ret = phy_scan_fixups(phydev);
610 return phydev->drv->config_init(phydev);
612 EXPORT_SYMBOL(phy_init_hw);
615 * phy_attach_direct - attach a network device to a given PHY device pointer
616 * @dev: network device to attach
617 * @phydev: Pointer to phy_device to attach
618 * @flags: PHY device's dev_flags
619 * @interface: PHY device's interface
621 * Description: Called by drivers to attach to a particular PHY
622 * device. The phy_device is found, and properly hooked up
623 * to the phy_driver. If no driver is attached, then a
624 * generic driver is used. The phy_device is given a ptr to
625 * the attaching device, and given a callback for link status
626 * change. The phy_device is returned to the attaching driver.
627 * This function takes a reference on the phy device.
629 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
630 u32 flags, phy_interface_t interface)
632 struct mii_bus *bus = phydev->bus;
633 struct device *d = &phydev->dev;
636 if (!try_module_get(bus->owner)) {
637 dev_err(&dev->dev, "failed to get the bus module\n");
643 /* Assume that if there is no driver, that it doesn't
644 * exist, and we should use the genphy driver.
648 d->driver = &genphy_driver[GENPHY_DRV_10G].driver;
650 d->driver = &genphy_driver[GENPHY_DRV_1G].driver;
652 err = d->driver->probe(d);
654 err = device_bind_driver(d);
660 if (phydev->attached_dev) {
661 dev_err(&dev->dev, "PHY already attached\n");
666 phydev->attached_dev = dev;
667 dev->phydev = phydev;
669 phydev->dev_flags = flags;
671 phydev->interface = interface;
673 phydev->state = PHY_READY;
675 /* Do initial configuration here, now that
676 * we have certain key parameters
677 * (dev_flags and interface)
679 err = phy_init_hw(phydev);
689 module_put(bus->owner);
692 EXPORT_SYMBOL(phy_attach_direct);
695 * phy_attach - attach a network device to a particular PHY device
696 * @dev: network device to attach
697 * @bus_id: Bus ID of PHY device to attach
698 * @interface: PHY device's interface
700 * Description: Same as phy_attach_direct() except that a PHY bus_id
701 * string is passed instead of a pointer to a struct phy_device.
703 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
704 phy_interface_t interface)
706 struct bus_type *bus = &mdio_bus_type;
707 struct phy_device *phydev;
712 return ERR_PTR(-EINVAL);
714 /* Search the list of PHY devices on the mdio bus for the
715 * PHY with the requested name
717 d = bus_find_device_by_name(bus, NULL, bus_id);
719 pr_err("PHY %s not found\n", bus_id);
720 return ERR_PTR(-ENODEV);
722 phydev = to_phy_device(d);
724 rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
731 EXPORT_SYMBOL(phy_attach);
734 * phy_detach - detach a PHY device from its network device
735 * @phydev: target phy_device struct
737 * This detaches the phy device from its network device and the phy
738 * driver, and drops the reference count taken in phy_attach_direct().
740 void phy_detach(struct phy_device *phydev)
745 phydev->attached_dev->phydev = NULL;
746 phydev->attached_dev = NULL;
749 /* If the device had no specific driver before (i.e. - it
750 * was using the generic driver), we unbind the device
751 * from the generic driver so that there's a chance a
752 * real driver could be loaded
754 for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
755 if (phydev->dev.driver == &genphy_driver[i].driver) {
756 device_release_driver(&phydev->dev);
762 * The phydev might go away on the put_device() below, so avoid
763 * a use-after-free bug by reading the underlying bus first.
767 put_device(&phydev->dev);
768 module_put(bus->owner);
770 EXPORT_SYMBOL(phy_detach);
772 int phy_suspend(struct phy_device *phydev)
774 struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
775 struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
778 /* If the device has WOL enabled, we cannot suspend the PHY */
779 phy_ethtool_get_wol(phydev, &wol);
784 ret = phydrv->suspend(phydev);
789 phydev->suspended = true;
793 EXPORT_SYMBOL(phy_suspend);
795 int phy_resume(struct phy_device *phydev)
797 struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
801 ret = phydrv->resume(phydev);
806 phydev->suspended = false;
810 EXPORT_SYMBOL(phy_resume);
812 /* Generic PHY support and helper functions */
815 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
816 * @phydev: target phy_device struct
818 * Description: Writes MII_ADVERTISE with the appropriate values,
819 * after sanitizing the values to make sure we only advertise
820 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
821 * hasn't changed, and > 0 if it has changed.
823 static int genphy_config_advert(struct phy_device *phydev)
826 int oldadv, adv, bmsr;
827 int err, changed = 0;
829 /* Only allow advertising what this PHY supports */
830 phydev->advertising &= phydev->supported;
831 advertise = phydev->advertising;
833 /* Setup standard advertisement */
834 adv = phy_read(phydev, MII_ADVERTISE);
839 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
840 ADVERTISE_PAUSE_ASYM);
841 adv |= ethtool_adv_to_mii_adv_t(advertise);
844 err = phy_write(phydev, MII_ADVERTISE, adv);
851 bmsr = phy_read(phydev, MII_BMSR);
855 /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
856 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
859 if (!(bmsr & BMSR_ESTATEN))
862 /* Configure gigabit if it's supported */
863 adv = phy_read(phydev, MII_CTRL1000);
868 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
870 if (phydev->supported & (SUPPORTED_1000baseT_Half |
871 SUPPORTED_1000baseT_Full)) {
872 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
878 err = phy_write(phydev, MII_CTRL1000, adv);
886 * genphy_setup_forced - configures/forces speed/duplex from @phydev
887 * @phydev: target phy_device struct
889 * Description: Configures MII_BMCR to force speed/duplex
890 * to the values in phydev. Assumes that the values are valid.
891 * Please see phy_sanitize_settings().
893 int genphy_setup_forced(struct phy_device *phydev)
898 phydev->asym_pause = 0;
900 if (SPEED_1000 == phydev->speed)
901 ctl |= BMCR_SPEED1000;
902 else if (SPEED_100 == phydev->speed)
903 ctl |= BMCR_SPEED100;
905 if (DUPLEX_FULL == phydev->duplex)
906 ctl |= BMCR_FULLDPLX;
908 return phy_write(phydev, MII_BMCR, ctl);
910 EXPORT_SYMBOL(genphy_setup_forced);
913 * genphy_restart_aneg - Enable and Restart Autonegotiation
914 * @phydev: target phy_device struct
916 int genphy_restart_aneg(struct phy_device *phydev)
918 int ctl = phy_read(phydev, MII_BMCR);
923 ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
925 /* Don't isolate the PHY if we're negotiating */
926 ctl &= ~BMCR_ISOLATE;
928 return phy_write(phydev, MII_BMCR, ctl);
930 EXPORT_SYMBOL(genphy_restart_aneg);
933 * genphy_config_aneg - restart auto-negotiation or write BMCR
934 * @phydev: target phy_device struct
936 * Description: If auto-negotiation is enabled, we configure the
937 * advertising, and then restart auto-negotiation. If it is not
938 * enabled, then we write the BMCR.
940 int genphy_config_aneg(struct phy_device *phydev)
944 if (AUTONEG_ENABLE != phydev->autoneg)
945 return genphy_setup_forced(phydev);
947 result = genphy_config_advert(phydev);
948 if (result < 0) /* error */
951 /* Advertisement hasn't changed, but maybe aneg was never on to
952 * begin with? Or maybe phy was isolated?
954 int ctl = phy_read(phydev, MII_BMCR);
959 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
960 result = 1; /* do restart aneg */
963 /* Only restart aneg if we are advertising something different
964 * than we were before.
967 result = genphy_restart_aneg(phydev);
971 EXPORT_SYMBOL(genphy_config_aneg);
974 * genphy_aneg_done - return auto-negotiation status
975 * @phydev: target phy_device struct
977 * Description: Reads the status register and returns 0 either if
978 * auto-negotiation is incomplete, or if there was an error.
979 * Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
981 int genphy_aneg_done(struct phy_device *phydev)
983 int retval = phy_read(phydev, MII_BMSR);
985 return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
987 EXPORT_SYMBOL(genphy_aneg_done);
989 static int gen10g_config_aneg(struct phy_device *phydev)
995 * genphy_update_link - update link status in @phydev
996 * @phydev: target phy_device struct
998 * Description: Update the value in phydev->link to reflect the
999 * current link value. In order to do this, we need to read
1000 * the status register twice, keeping the second value.
1002 int genphy_update_link(struct phy_device *phydev)
1006 /* Do a fake read */
1007 status = phy_read(phydev, MII_BMSR);
1011 /* Read link and autonegotiation status */
1012 status = phy_read(phydev, MII_BMSR);
1016 if ((status & BMSR_LSTATUS) == 0)
1023 EXPORT_SYMBOL(genphy_update_link);
1026 * genphy_read_status - check the link status and update current link state
1027 * @phydev: target phy_device struct
1029 * Description: Check the link, then figure out the current state
1030 * by comparing what we advertise with what the link partner
1031 * advertises. Start by checking the gigabit possibilities,
1032 * then move on to 10/100.
1034 int genphy_read_status(struct phy_device *phydev)
1041 int common_adv_gb = 0;
1043 /* Update the link, but return if there was an error */
1044 err = genphy_update_link(phydev);
1048 phydev->lp_advertising = 0;
1050 if (AUTONEG_ENABLE == phydev->autoneg) {
1051 if (phydev->supported & (SUPPORTED_1000baseT_Half
1052 | SUPPORTED_1000baseT_Full)) {
1053 lpagb = phy_read(phydev, MII_STAT1000);
1057 adv = phy_read(phydev, MII_CTRL1000);
1061 phydev->lp_advertising =
1062 mii_stat1000_to_ethtool_lpa_t(lpagb);
1063 common_adv_gb = lpagb & adv << 2;
1066 lpa = phy_read(phydev, MII_LPA);
1070 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
1072 adv = phy_read(phydev, MII_ADVERTISE);
1076 common_adv = lpa & adv;
1078 phydev->speed = SPEED_10;
1079 phydev->duplex = DUPLEX_HALF;
1081 phydev->asym_pause = 0;
1083 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1084 phydev->speed = SPEED_1000;
1086 if (common_adv_gb & LPA_1000FULL)
1087 phydev->duplex = DUPLEX_FULL;
1088 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1089 phydev->speed = SPEED_100;
1091 if (common_adv & LPA_100FULL)
1092 phydev->duplex = DUPLEX_FULL;
1094 if (common_adv & LPA_10FULL)
1095 phydev->duplex = DUPLEX_FULL;
1097 if (phydev->duplex == DUPLEX_FULL) {
1098 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1099 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1102 int bmcr = phy_read(phydev, MII_BMCR);
1107 if (bmcr & BMCR_FULLDPLX)
1108 phydev->duplex = DUPLEX_FULL;
1110 phydev->duplex = DUPLEX_HALF;
1112 if (bmcr & BMCR_SPEED1000)
1113 phydev->speed = SPEED_1000;
1114 else if (bmcr & BMCR_SPEED100)
1115 phydev->speed = SPEED_100;
1117 phydev->speed = SPEED_10;
1120 phydev->asym_pause = 0;
1125 EXPORT_SYMBOL(genphy_read_status);
1127 static int gen10g_read_status(struct phy_device *phydev)
1130 u32 mmd_mask = phydev->c45_ids.devices_in_package;
1134 /* For now just lie and say it's 10G all the time */
1135 phydev->speed = SPEED_10000;
1136 phydev->duplex = DUPLEX_FULL;
1138 for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1139 if (!(mmd_mask & 1))
1142 /* Read twice because link state is latched and a
1143 * read moves the current state into the register
1145 phy_read_mmd(phydev, devad, MDIO_STAT1);
1146 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1147 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1155 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1156 * @phydev: target phy_device struct
1158 * Description: Perform a software PHY reset using the standard
1159 * BMCR_RESET bit and poll for the reset bit to be cleared.
1161 * Returns: 0 on success, < 0 on failure
1163 int genphy_soft_reset(struct phy_device *phydev)
1167 ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1171 return phy_poll_reset(phydev);
1173 EXPORT_SYMBOL(genphy_soft_reset);
1175 int genphy_config_init(struct phy_device *phydev)
1180 features = (SUPPORTED_TP | SUPPORTED_MII
1181 | SUPPORTED_AUI | SUPPORTED_FIBRE |
1184 /* Do we support autonegotiation? */
1185 val = phy_read(phydev, MII_BMSR);
1189 if (val & BMSR_ANEGCAPABLE)
1190 features |= SUPPORTED_Autoneg;
1192 if (val & BMSR_100FULL)
1193 features |= SUPPORTED_100baseT_Full;
1194 if (val & BMSR_100HALF)
1195 features |= SUPPORTED_100baseT_Half;
1196 if (val & BMSR_10FULL)
1197 features |= SUPPORTED_10baseT_Full;
1198 if (val & BMSR_10HALF)
1199 features |= SUPPORTED_10baseT_Half;
1201 if (val & BMSR_ESTATEN) {
1202 val = phy_read(phydev, MII_ESTATUS);
1206 if (val & ESTATUS_1000_TFULL)
1207 features |= SUPPORTED_1000baseT_Full;
1208 if (val & ESTATUS_1000_THALF)
1209 features |= SUPPORTED_1000baseT_Half;
1212 phydev->supported &= features;
1213 phydev->advertising &= features;
1218 static int gen10g_soft_reset(struct phy_device *phydev)
1220 /* Do nothing for now */
1223 EXPORT_SYMBOL(genphy_config_init);
1225 static int gen10g_config_init(struct phy_device *phydev)
1227 /* Temporarily just say we support everything */
1228 phydev->supported = SUPPORTED_10000baseT_Full;
1229 phydev->advertising = SUPPORTED_10000baseT_Full;
1234 int genphy_suspend(struct phy_device *phydev)
1238 mutex_lock(&phydev->lock);
1240 value = phy_read(phydev, MII_BMCR);
1241 phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1243 mutex_unlock(&phydev->lock);
1247 EXPORT_SYMBOL(genphy_suspend);
1249 static int gen10g_suspend(struct phy_device *phydev)
1254 int genphy_resume(struct phy_device *phydev)
1258 mutex_lock(&phydev->lock);
1260 value = phy_read(phydev, MII_BMCR);
1261 phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1263 mutex_unlock(&phydev->lock);
1267 EXPORT_SYMBOL(genphy_resume);
1269 static int gen10g_resume(struct phy_device *phydev)
1274 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1276 switch (max_speed) {
1278 phydev->supported &= ~PHY_100BT_FEATURES;
1281 phydev->supported &= ~PHY_1000BT_FEATURES;
1292 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1296 err = __set_phy_supported(phydev, max_speed);
1300 phydev->advertising = phydev->supported;
1304 EXPORT_SYMBOL(phy_set_max_speed);
1306 static void of_set_phy_supported(struct phy_device *phydev)
1308 struct device_node *node = phydev->dev.of_node;
1311 if (!IS_ENABLED(CONFIG_OF_MDIO))
1317 if (!of_property_read_u32(node, "max-speed", &max_speed))
1318 __set_phy_supported(phydev, max_speed);
1322 * phy_probe - probe and init a PHY device
1323 * @dev: device to probe and init
1325 * Description: Take care of setting up the phy_device structure,
1326 * set the state to READY (the driver's init function should
1327 * set it to STARTING if needed).
1329 static int phy_probe(struct device *dev)
1331 struct phy_device *phydev = to_phy_device(dev);
1332 struct device_driver *drv = phydev->dev.driver;
1333 struct phy_driver *phydrv = to_phy_driver(drv);
1336 phydev->drv = phydrv;
1338 /* Disable the interrupt if the PHY doesn't support it
1339 * but the interrupt is still a valid one
1341 if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1342 phy_interrupt_is_valid(phydev))
1343 phydev->irq = PHY_POLL;
1345 if (phydrv->flags & PHY_IS_INTERNAL)
1346 phydev->is_internal = true;
1348 mutex_lock(&phydev->lock);
1350 /* Start out supporting everything. Eventually,
1351 * a controller will attach, and may modify one
1352 * or both of these values
1354 phydev->supported = phydrv->features;
1355 of_set_phy_supported(phydev);
1356 phydev->advertising = phydev->supported;
1358 /* Set the state to READY by default */
1359 phydev->state = PHY_READY;
1361 if (phydev->drv->probe)
1362 err = phydev->drv->probe(phydev);
1364 mutex_unlock(&phydev->lock);
1369 static int phy_remove(struct device *dev)
1371 struct phy_device *phydev = to_phy_device(dev);
1373 cancel_delayed_work_sync(&phydev->state_queue);
1375 mutex_lock(&phydev->lock);
1376 phydev->state = PHY_DOWN;
1377 mutex_unlock(&phydev->lock);
1379 if (phydev->drv->remove)
1380 phydev->drv->remove(phydev);
1387 * phy_driver_register - register a phy_driver with the PHY layer
1388 * @new_driver: new phy_driver to register
1390 int phy_driver_register(struct phy_driver *new_driver)
1394 new_driver->driver.name = new_driver->name;
1395 new_driver->driver.bus = &mdio_bus_type;
1396 new_driver->driver.probe = phy_probe;
1397 new_driver->driver.remove = phy_remove;
1399 retval = driver_register(&new_driver->driver);
1401 pr_err("%s: Error %d in registering driver\n",
1402 new_driver->name, retval);
1407 pr_debug("%s: Registered new driver\n", new_driver->name);
1411 EXPORT_SYMBOL(phy_driver_register);
1413 int phy_drivers_register(struct phy_driver *new_driver, int n)
1417 for (i = 0; i < n; i++) {
1418 ret = phy_driver_register(new_driver + i);
1421 phy_driver_unregister(new_driver + i);
1427 EXPORT_SYMBOL(phy_drivers_register);
1429 void phy_driver_unregister(struct phy_driver *drv)
1431 driver_unregister(&drv->driver);
1433 EXPORT_SYMBOL(phy_driver_unregister);
1435 void phy_drivers_unregister(struct phy_driver *drv, int n)
1439 for (i = 0; i < n; i++)
1440 phy_driver_unregister(drv + i);
1442 EXPORT_SYMBOL(phy_drivers_unregister);
1444 static struct phy_driver genphy_driver[] = {
1446 .phy_id = 0xffffffff,
1447 .phy_id_mask = 0xffffffff,
1448 .name = "Generic PHY",
1449 .soft_reset = genphy_no_soft_reset,
1450 .config_init = genphy_config_init,
1451 .features = PHY_GBIT_FEATURES | SUPPORTED_MII |
1452 SUPPORTED_AUI | SUPPORTED_FIBRE |
1454 .config_aneg = genphy_config_aneg,
1455 .aneg_done = genphy_aneg_done,
1456 .read_status = genphy_read_status,
1457 .suspend = genphy_suspend,
1458 .resume = genphy_resume,
1459 .driver = { .owner = THIS_MODULE, },
1461 .phy_id = 0xffffffff,
1462 .phy_id_mask = 0xffffffff,
1463 .name = "Generic 10G PHY",
1464 .soft_reset = gen10g_soft_reset,
1465 .config_init = gen10g_config_init,
1467 .config_aneg = gen10g_config_aneg,
1468 .read_status = gen10g_read_status,
1469 .suspend = gen10g_suspend,
1470 .resume = gen10g_resume,
1471 .driver = {.owner = THIS_MODULE, },
1474 static int __init phy_init(void)
1478 rc = mdio_bus_init();
1482 rc = phy_drivers_register(genphy_driver,
1483 ARRAY_SIZE(genphy_driver));
1490 static void __exit phy_exit(void)
1492 phy_drivers_unregister(genphy_driver,
1493 ARRAY_SIZE(genphy_driver));
1497 subsys_initcall(phy_init);
1498 module_exit(phy_exit);