2 * drivers/net/phy/phy_device.c
4 * Framework for finding and configuring PHYs.
5 * Also contains generic PHY driver
9 * Copyright (c) 2004 Freescale Semiconductor, Inc.
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
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>
36 #include <asm/uaccess.h>
38 MODULE_DESCRIPTION("PHY library");
39 MODULE_AUTHOR("Andy Fleming");
40 MODULE_LICENSE("GPL");
42 static struct phy_driver genphy_driver;
43 extern int mdio_bus_init(void);
44 extern void mdio_bus_exit(void);
46 void phy_device_free(struct phy_device *phydev)
51 static void phy_device_release(struct device *dev)
53 phy_device_free(to_phy_device(dev));
56 static LIST_HEAD(phy_fixup_list);
57 static DEFINE_MUTEX(phy_fixup_lock);
60 * Creates a new phy_fixup and adds it to the list
61 * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
62 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
63 * It can also be PHY_ANY_UID
64 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
66 * @run: The actual code to be run when a matching PHY is found
68 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
69 int (*run)(struct phy_device *))
71 struct phy_fixup *fixup;
73 fixup = kzalloc(sizeof(struct phy_fixup), GFP_KERNEL);
77 strncpy(fixup->bus_id, bus_id, BUS_ID_SIZE);
78 fixup->phy_uid = phy_uid;
79 fixup->phy_uid_mask = phy_uid_mask;
82 mutex_lock(&phy_fixup_lock);
83 list_add_tail(&fixup->list, &phy_fixup_list);
84 mutex_unlock(&phy_fixup_lock);
88 EXPORT_SYMBOL(phy_register_fixup);
90 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
91 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
92 int (*run)(struct phy_device *))
94 return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
96 EXPORT_SYMBOL(phy_register_fixup_for_uid);
98 /* Registers a fixup to be run on the PHY with id string bus_id */
99 int phy_register_fixup_for_id(const char *bus_id,
100 int (*run)(struct phy_device *))
102 return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
104 EXPORT_SYMBOL(phy_register_fixup_for_id);
107 * Returns 1 if fixup matches phydev in bus_id and phy_uid.
108 * Fixups can be set to match any in one or more fields.
110 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
112 if (strcmp(fixup->bus_id, phydev->dev.bus_id) != 0)
113 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
116 if ((fixup->phy_uid & fixup->phy_uid_mask) !=
117 (phydev->phy_id & fixup->phy_uid_mask))
118 if (fixup->phy_uid != PHY_ANY_UID)
124 /* Runs any matching fixups for this phydev */
125 int phy_scan_fixups(struct phy_device *phydev)
127 struct phy_fixup *fixup;
129 mutex_lock(&phy_fixup_lock);
130 list_for_each_entry(fixup, &phy_fixup_list, list) {
131 if (phy_needs_fixup(phydev, fixup)) {
134 err = fixup->run(phydev);
140 mutex_unlock(&phy_fixup_lock);
144 EXPORT_SYMBOL(phy_scan_fixups);
146 struct phy_device* phy_device_create(struct mii_bus *bus, int addr, int phy_id)
148 struct phy_device *dev;
149 /* We allocate the device, and initialize the
151 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
154 return (struct phy_device*) PTR_ERR((void*)-ENOMEM);
156 dev->dev.release = phy_device_release;
160 dev->pause = dev->asym_pause = 0;
162 dev->interface = PHY_INTERFACE_MODE_GMII;
164 dev->autoneg = AUTONEG_ENABLE;
167 dev->phy_id = phy_id;
170 dev->state = PHY_DOWN;
172 mutex_init(&dev->lock);
176 EXPORT_SYMBOL(phy_device_create);
179 * get_phy_id - reads the specified addr for its ID.
180 * @bus: the target MII bus
181 * @addr: PHY address on the MII bus
182 * @phy_id: where to store the ID retrieved.
184 * Description: Reads the ID registers of the PHY at @addr on the
185 * @bus, stores it in @phy_id and returns zero on success.
187 int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id)
191 /* Grab the bits from PHYIR1, and put them
192 * in the upper half */
193 phy_reg = bus->read(bus, addr, MII_PHYSID1);
198 *phy_id = (phy_reg & 0xffff) << 16;
200 /* Grab the bits from PHYIR2, and put them in the lower half */
201 phy_reg = bus->read(bus, addr, MII_PHYSID2);
206 *phy_id |= (phy_reg & 0xffff);
210 EXPORT_SYMBOL(get_phy_id);
213 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
214 * @bus: the target MII bus
215 * @addr: PHY address on the MII bus
217 * Description: Reads the ID registers of the PHY at @addr on the
218 * @bus, then allocates and returns the phy_device to represent it.
220 struct phy_device * get_phy_device(struct mii_bus *bus, int addr)
222 struct phy_device *dev = NULL;
226 r = get_phy_id(bus, addr, &phy_id);
230 /* If the phy_id is all Fs or all 0s, there is no device there */
231 if ((0xffff == phy_id) || (0x00 == phy_id))
234 dev = phy_device_create(bus, addr, phy_id);
240 * phy_prepare_link - prepares the PHY layer to monitor link status
241 * @phydev: target phy_device struct
242 * @handler: callback function for link status change notifications
244 * Description: Tells the PHY infrastructure to handle the
245 * gory details on monitoring link status (whether through
246 * polling or an interrupt), and to call back to the
247 * connected device driver when the link status changes.
248 * If you want to monitor your own link state, don't call
251 void phy_prepare_link(struct phy_device *phydev,
252 void (*handler)(struct net_device *))
254 phydev->adjust_link = handler;
258 * phy_connect - connect an ethernet device to a PHY device
259 * @dev: the network device to connect
260 * @bus_id: the id string of the PHY device to connect
261 * @handler: callback function for state change notifications
262 * @flags: PHY device's dev_flags
263 * @interface: PHY device's interface
265 * Description: Convenience function for connecting ethernet
266 * devices to PHY devices. The default behavior is for
267 * the PHY infrastructure to handle everything, and only notify
268 * the connected driver when the link status changes. If you
269 * don't want, or can't use the provided functionality, you may
270 * choose to call only the subset of functions which provide
271 * the desired functionality.
273 struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
274 void (*handler)(struct net_device *), u32 flags,
275 phy_interface_t interface)
277 struct phy_device *phydev;
279 phydev = phy_attach(dev, bus_id, flags, interface);
284 phy_prepare_link(phydev, handler);
286 phy_start_machine(phydev, NULL);
289 phy_start_interrupts(phydev);
293 EXPORT_SYMBOL(phy_connect);
296 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY device
297 * @phydev: target phy_device struct
299 void phy_disconnect(struct phy_device *phydev)
302 phy_stop_interrupts(phydev);
304 phy_stop_machine(phydev);
306 phydev->adjust_link = NULL;
310 EXPORT_SYMBOL(phy_disconnect);
313 * phy_attach - attach a network device to a particular PHY device
314 * @dev: network device to attach
315 * @bus_id: PHY device to attach
316 * @flags: PHY device's dev_flags
317 * @interface: PHY device's interface
319 * Description: Called by drivers to attach to a particular PHY
320 * device. The phy_device is found, and properly hooked up
321 * to the phy_driver. If no driver is attached, then the
322 * genphy_driver is used. The phy_device is given a ptr to
323 * the attaching device, and given a callback for link status
324 * change. The phy_device is returned to the attaching driver.
326 struct phy_device *phy_attach(struct net_device *dev,
327 const char *bus_id, u32 flags, phy_interface_t interface)
329 struct bus_type *bus = &mdio_bus_type;
330 struct phy_device *phydev;
333 /* Search the list of PHY devices on the mdio bus for the
334 * PHY with the requested name */
335 d = bus_find_device_by_name(bus, NULL, bus_id);
337 phydev = to_phy_device(d);
339 printk(KERN_ERR "%s not found\n", bus_id);
340 return ERR_PTR(-ENODEV);
343 /* Assume that if there is no driver, that it doesn't
344 * exist, and we should use the genphy driver. */
345 if (NULL == d->driver) {
347 d->driver = &genphy_driver.driver;
349 err = d->driver->probe(d);
351 err = device_bind_driver(d);
357 if (phydev->attached_dev) {
358 printk(KERN_ERR "%s: %s already attached\n",
360 return ERR_PTR(-EBUSY);
363 phydev->attached_dev = dev;
365 phydev->dev_flags = flags;
367 phydev->interface = interface;
369 /* Do initial configuration here, now that
370 * we have certain key parameters
371 * (dev_flags and interface) */
372 if (phydev->drv->config_init) {
375 err = phy_scan_fixups(phydev);
380 err = phydev->drv->config_init(phydev);
388 EXPORT_SYMBOL(phy_attach);
391 * phy_detach - detach a PHY device from its network device
392 * @phydev: target phy_device struct
394 void phy_detach(struct phy_device *phydev)
396 phydev->attached_dev = NULL;
398 /* If the device had no specific driver before (i.e. - it
399 * was using the generic driver), we unbind the device
400 * from the generic driver so that there's a chance a
401 * real driver could be loaded */
402 if (phydev->dev.driver == &genphy_driver.driver)
403 device_release_driver(&phydev->dev);
405 EXPORT_SYMBOL(phy_detach);
408 /* Generic PHY support and helper functions */
411 * genphy_config_advert - sanitize and advertise auto-negotation parameters
412 * @phydev: target phy_device struct
414 * Description: Writes MII_ADVERTISE with the appropriate values,
415 * after sanitizing the values to make sure we only advertise
416 * what is supported. Returns < 0 on error, 0 if the PHY's advertisement
417 * hasn't changed, and > 0 if it has changed.
419 int genphy_config_advert(struct phy_device *phydev)
423 int err, changed = 0;
425 /* Only allow advertising what
426 * this PHY supports */
427 phydev->advertising &= phydev->supported;
428 advertise = phydev->advertising;
430 /* Setup standard advertisement */
431 oldadv = adv = phy_read(phydev, MII_ADVERTISE);
436 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
437 ADVERTISE_PAUSE_ASYM);
438 if (advertise & ADVERTISED_10baseT_Half)
439 adv |= ADVERTISE_10HALF;
440 if (advertise & ADVERTISED_10baseT_Full)
441 adv |= ADVERTISE_10FULL;
442 if (advertise & ADVERTISED_100baseT_Half)
443 adv |= ADVERTISE_100HALF;
444 if (advertise & ADVERTISED_100baseT_Full)
445 adv |= ADVERTISE_100FULL;
446 if (advertise & ADVERTISED_Pause)
447 adv |= ADVERTISE_PAUSE_CAP;
448 if (advertise & ADVERTISED_Asym_Pause)
449 adv |= ADVERTISE_PAUSE_ASYM;
452 err = phy_write(phydev, MII_ADVERTISE, adv);
459 /* Configure gigabit if it's supported */
460 if (phydev->supported & (SUPPORTED_1000baseT_Half |
461 SUPPORTED_1000baseT_Full)) {
462 oldadv = adv = phy_read(phydev, MII_CTRL1000);
467 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
468 if (advertise & SUPPORTED_1000baseT_Half)
469 adv |= ADVERTISE_1000HALF;
470 if (advertise & SUPPORTED_1000baseT_Full)
471 adv |= ADVERTISE_1000FULL;
474 err = phy_write(phydev, MII_CTRL1000, adv);
484 EXPORT_SYMBOL(genphy_config_advert);
487 * genphy_setup_forced - configures/forces speed/duplex from @phydev
488 * @phydev: target phy_device struct
490 * Description: Configures MII_BMCR to force speed/duplex
491 * to the values in phydev. Assumes that the values are valid.
492 * Please see phy_sanitize_settings().
494 int genphy_setup_forced(struct phy_device *phydev)
499 phydev->pause = phydev->asym_pause = 0;
501 if (SPEED_1000 == phydev->speed)
502 ctl |= BMCR_SPEED1000;
503 else if (SPEED_100 == phydev->speed)
504 ctl |= BMCR_SPEED100;
506 if (DUPLEX_FULL == phydev->duplex)
507 ctl |= BMCR_FULLDPLX;
509 err = phy_write(phydev, MII_BMCR, ctl);
515 * Run the fixups on this PHY, just in case the
516 * board code needs to change something after a reset
518 err = phy_scan_fixups(phydev);
523 /* We just reset the device, so we'd better configure any
524 * settings the PHY requires to operate */
525 if (phydev->drv->config_init)
526 err = phydev->drv->config_init(phydev);
533 * genphy_restart_aneg - Enable and Restart Autonegotiation
534 * @phydev: target phy_device struct
536 int genphy_restart_aneg(struct phy_device *phydev)
540 ctl = phy_read(phydev, MII_BMCR);
545 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
547 /* Don't isolate the PHY if we're negotiating */
548 ctl &= ~(BMCR_ISOLATE);
550 ctl = phy_write(phydev, MII_BMCR, ctl);
554 EXPORT_SYMBOL(genphy_restart_aneg);
558 * genphy_config_aneg - restart auto-negotiation or write BMCR
559 * @phydev: target phy_device struct
561 * Description: If auto-negotiation is enabled, we configure the
562 * advertising, and then restart auto-negotiation. If it is not
563 * enabled, then we write the BMCR.
565 int genphy_config_aneg(struct phy_device *phydev)
569 if (AUTONEG_ENABLE != phydev->autoneg)
570 return genphy_setup_forced(phydev);
572 result = genphy_config_advert(phydev);
574 if (result < 0) /* error */
578 /* Advertisment hasn't changed, but maybe aneg was never on to
579 * begin with? Or maybe phy was isolated? */
580 int ctl = phy_read(phydev, MII_BMCR);
585 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
586 result = 1; /* do restart aneg */
589 /* Only restart aneg if we are advertising something different
590 * than we were before. */
592 result = genphy_restart_aneg(phydev);
596 EXPORT_SYMBOL(genphy_config_aneg);
599 * genphy_update_link - update link status in @phydev
600 * @phydev: target phy_device struct
602 * Description: Update the value in phydev->link to reflect the
603 * current link value. In order to do this, we need to read
604 * the status register twice, keeping the second value.
606 int genphy_update_link(struct phy_device *phydev)
611 status = phy_read(phydev, MII_BMSR);
616 /* Read link and autonegotiation status */
617 status = phy_read(phydev, MII_BMSR);
622 if ((status & BMSR_LSTATUS) == 0)
629 EXPORT_SYMBOL(genphy_update_link);
632 * genphy_read_status - check the link status and update current link state
633 * @phydev: target phy_device struct
635 * Description: Check the link, then figure out the current state
636 * by comparing what we advertise with what the link partner
637 * advertises. Start by checking the gigabit possibilities,
638 * then move on to 10/100.
640 int genphy_read_status(struct phy_device *phydev)
647 /* Update the link, but return if there
649 err = genphy_update_link(phydev);
653 if (AUTONEG_ENABLE == phydev->autoneg) {
654 if (phydev->supported & (SUPPORTED_1000baseT_Half
655 | SUPPORTED_1000baseT_Full)) {
656 lpagb = phy_read(phydev, MII_STAT1000);
661 adv = phy_read(phydev, MII_CTRL1000);
669 lpa = phy_read(phydev, MII_LPA);
674 adv = phy_read(phydev, MII_ADVERTISE);
681 phydev->speed = SPEED_10;
682 phydev->duplex = DUPLEX_HALF;
683 phydev->pause = phydev->asym_pause = 0;
685 if (lpagb & (LPA_1000FULL | LPA_1000HALF)) {
686 phydev->speed = SPEED_1000;
688 if (lpagb & LPA_1000FULL)
689 phydev->duplex = DUPLEX_FULL;
690 } else if (lpa & (LPA_100FULL | LPA_100HALF)) {
691 phydev->speed = SPEED_100;
693 if (lpa & LPA_100FULL)
694 phydev->duplex = DUPLEX_FULL;
696 if (lpa & LPA_10FULL)
697 phydev->duplex = DUPLEX_FULL;
699 if (phydev->duplex == DUPLEX_FULL){
700 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
701 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
704 int bmcr = phy_read(phydev, MII_BMCR);
708 if (bmcr & BMCR_FULLDPLX)
709 phydev->duplex = DUPLEX_FULL;
711 phydev->duplex = DUPLEX_HALF;
713 if (bmcr & BMCR_SPEED1000)
714 phydev->speed = SPEED_1000;
715 else if (bmcr & BMCR_SPEED100)
716 phydev->speed = SPEED_100;
718 phydev->speed = SPEED_10;
720 phydev->pause = phydev->asym_pause = 0;
725 EXPORT_SYMBOL(genphy_read_status);
727 static int genphy_config_init(struct phy_device *phydev)
732 /* For now, I'll claim that the generic driver supports
733 * all possible port types */
734 features = (SUPPORTED_TP | SUPPORTED_MII
735 | SUPPORTED_AUI | SUPPORTED_FIBRE |
738 /* Do we support autonegotiation? */
739 val = phy_read(phydev, MII_BMSR);
744 if (val & BMSR_ANEGCAPABLE)
745 features |= SUPPORTED_Autoneg;
747 if (val & BMSR_100FULL)
748 features |= SUPPORTED_100baseT_Full;
749 if (val & BMSR_100HALF)
750 features |= SUPPORTED_100baseT_Half;
751 if (val & BMSR_10FULL)
752 features |= SUPPORTED_10baseT_Full;
753 if (val & BMSR_10HALF)
754 features |= SUPPORTED_10baseT_Half;
756 if (val & BMSR_ESTATEN) {
757 val = phy_read(phydev, MII_ESTATUS);
762 if (val & ESTATUS_1000_TFULL)
763 features |= SUPPORTED_1000baseT_Full;
764 if (val & ESTATUS_1000_THALF)
765 features |= SUPPORTED_1000baseT_Half;
768 phydev->supported = features;
769 phydev->advertising = features;
776 * phy_probe - probe and init a PHY device
777 * @dev: device to probe and init
779 * Description: Take care of setting up the phy_device structure,
780 * set the state to READY (the driver's init function should
781 * set it to STARTING if needed).
783 static int phy_probe(struct device *dev)
785 struct phy_device *phydev;
786 struct phy_driver *phydrv;
787 struct device_driver *drv;
790 phydev = to_phy_device(dev);
792 /* Make sure the driver is held.
793 * XXX -- Is this correct? */
794 drv = get_driver(phydev->dev.driver);
795 phydrv = to_phy_driver(drv);
796 phydev->drv = phydrv;
798 /* Disable the interrupt if the PHY doesn't support it */
799 if (!(phydrv->flags & PHY_HAS_INTERRUPT))
800 phydev->irq = PHY_POLL;
802 mutex_lock(&phydev->lock);
804 /* Start out supporting everything. Eventually,
805 * a controller will attach, and may modify one
806 * or both of these values */
807 phydev->supported = phydrv->features;
808 phydev->advertising = phydrv->features;
810 /* Set the state to READY by default */
811 phydev->state = PHY_READY;
813 if (phydev->drv->probe)
814 err = phydev->drv->probe(phydev);
816 mutex_unlock(&phydev->lock);
822 static int phy_remove(struct device *dev)
824 struct phy_device *phydev;
826 phydev = to_phy_device(dev);
828 mutex_lock(&phydev->lock);
829 phydev->state = PHY_DOWN;
830 mutex_unlock(&phydev->lock);
832 if (phydev->drv->remove)
833 phydev->drv->remove(phydev);
835 put_driver(dev->driver);
842 * phy_driver_register - register a phy_driver with the PHY layer
843 * @new_driver: new phy_driver to register
845 int phy_driver_register(struct phy_driver *new_driver)
849 memset(&new_driver->driver, 0, sizeof(new_driver->driver));
850 new_driver->driver.name = new_driver->name;
851 new_driver->driver.bus = &mdio_bus_type;
852 new_driver->driver.probe = phy_probe;
853 new_driver->driver.remove = phy_remove;
855 retval = driver_register(&new_driver->driver);
858 printk(KERN_ERR "%s: Error %d in registering driver\n",
859 new_driver->name, retval);
864 pr_debug("%s: Registered new driver\n", new_driver->name);
868 EXPORT_SYMBOL(phy_driver_register);
870 void phy_driver_unregister(struct phy_driver *drv)
872 driver_unregister(&drv->driver);
874 EXPORT_SYMBOL(phy_driver_unregister);
876 static struct phy_driver genphy_driver = {
877 .phy_id = 0xffffffff,
878 .phy_id_mask = 0xffffffff,
879 .name = "Generic PHY",
880 .config_init = genphy_config_init,
882 .config_aneg = genphy_config_aneg,
883 .read_status = genphy_read_status,
884 .driver = {.owner= THIS_MODULE, },
887 static int __init phy_init(void)
891 rc = mdio_bus_init();
895 rc = phy_driver_register(&genphy_driver);
902 static void __exit phy_exit(void)
904 phy_driver_unregister(&genphy_driver);
908 subsys_initcall(phy_init);
909 module_exit(phy_exit);