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 struct phy_device* phy_device_create(struct mii_bus *bus, int addr, int phy_id)
58 struct phy_device *dev;
59 /* We allocate the device, and initialize the
61 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
64 return (struct phy_device*) PTR_ERR((void*)-ENOMEM);
66 dev->dev.release = phy_device_release;
70 dev->pause = dev->asym_pause = 0;
72 dev->interface = PHY_INTERFACE_MODE_GMII;
74 dev->autoneg = AUTONEG_ENABLE;
80 dev->state = PHY_DOWN;
82 mutex_init(&dev->lock);
86 EXPORT_SYMBOL(phy_device_create);
89 * get_phy_id - reads the specified addr for its ID.
90 * @bus: the target MII bus
91 * @addr: PHY address on the MII bus
92 * @phy_id: where to store the ID retrieved.
94 * Description: Reads the ID registers of the PHY at @addr on the
95 * @bus, stores it in @phy_id and returns zero on success.
97 int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id)
101 /* Grab the bits from PHYIR1, and put them
102 * in the upper half */
103 phy_reg = bus->read(bus, addr, MII_PHYSID1);
108 *phy_id = (phy_reg & 0xffff) << 16;
110 /* Grab the bits from PHYIR2, and put them in the lower half */
111 phy_reg = bus->read(bus, addr, MII_PHYSID2);
116 *phy_id |= (phy_reg & 0xffff);
122 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
123 * @bus: the target MII bus
124 * @addr: PHY address on the MII bus
126 * Description: Reads the ID registers of the PHY at @addr on the
127 * @bus, then allocates and returns the phy_device to represent it.
129 struct phy_device * get_phy_device(struct mii_bus *bus, int addr)
131 struct phy_device *dev = NULL;
135 r = get_phy_id(bus, addr, &phy_id);
139 /* If the phy_id is all Fs, there is no device there */
140 if (0xffffffff == phy_id)
143 dev = phy_device_create(bus, addr, phy_id);
149 * phy_prepare_link - prepares the PHY layer to monitor link status
150 * @phydev: target phy_device struct
151 * @handler: callback function for link status change notifications
153 * Description: Tells the PHY infrastructure to handle the
154 * gory details on monitoring link status (whether through
155 * polling or an interrupt), and to call back to the
156 * connected device driver when the link status changes.
157 * If you want to monitor your own link state, don't call
160 void phy_prepare_link(struct phy_device *phydev,
161 void (*handler)(struct net_device *))
163 phydev->adjust_link = handler;
167 * phy_connect - connect an ethernet device to a PHY device
168 * @dev: the network device to connect
169 * @phy_id: the PHY device to connect
170 * @handler: callback function for state change notifications
171 * @flags: PHY device's dev_flags
172 * @interface: PHY device's interface
174 * Description: Convenience function for connecting ethernet
175 * devices to PHY devices. The default behavior is for
176 * the PHY infrastructure to handle everything, and only notify
177 * the connected driver when the link status changes. If you
178 * don't want, or can't use the provided functionality, you may
179 * choose to call only the subset of functions which provide
180 * the desired functionality.
182 struct phy_device * phy_connect(struct net_device *dev, const char *phy_id,
183 void (*handler)(struct net_device *), u32 flags,
184 phy_interface_t interface)
186 struct phy_device *phydev;
188 phydev = phy_attach(dev, phy_id, flags, interface);
193 phy_prepare_link(phydev, handler);
195 phy_start_machine(phydev, NULL);
198 phy_start_interrupts(phydev);
202 EXPORT_SYMBOL(phy_connect);
205 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY device
206 * @phydev: target phy_device struct
208 void phy_disconnect(struct phy_device *phydev)
211 phy_stop_interrupts(phydev);
213 phy_stop_machine(phydev);
215 phydev->adjust_link = NULL;
219 EXPORT_SYMBOL(phy_disconnect);
221 static int phy_compare_id(struct device *dev, void *data)
223 return strcmp((char *)data, dev->bus_id) ? 0 : 1;
227 * phy_attach - attach a network device to a particular PHY device
228 * @dev: network device to attach
229 * @phy_id: PHY device to attach
230 * @flags: PHY device's dev_flags
231 * @interface: PHY device's interface
233 * Description: Called by drivers to attach to a particular PHY
234 * device. The phy_device is found, and properly hooked up
235 * to the phy_driver. If no driver is attached, then the
236 * genphy_driver is used. The phy_device is given a ptr to
237 * the attaching device, and given a callback for link status
238 * change. The phy_device is returned to the attaching driver.
240 struct phy_device *phy_attach(struct net_device *dev,
241 const char *phy_id, u32 flags, phy_interface_t interface)
243 struct bus_type *bus = &mdio_bus_type;
244 struct phy_device *phydev;
247 /* Search the list of PHY devices on the mdio bus for the
248 * PHY with the requested name */
249 d = bus_find_device(bus, NULL, (void *)phy_id, phy_compare_id);
252 phydev = to_phy_device(d);
254 printk(KERN_ERR "%s not found\n", phy_id);
255 return ERR_PTR(-ENODEV);
258 /* Assume that if there is no driver, that it doesn't
259 * exist, and we should use the genphy driver. */
260 if (NULL == d->driver) {
262 d->driver = &genphy_driver.driver;
264 err = d->driver->probe(d);
266 err = device_bind_driver(d);
272 if (phydev->attached_dev) {
273 printk(KERN_ERR "%s: %s already attached\n",
275 return ERR_PTR(-EBUSY);
278 phydev->attached_dev = dev;
280 phydev->dev_flags = flags;
282 phydev->interface = interface;
284 /* Do initial configuration here, now that
285 * we have certain key parameters
286 * (dev_flags and interface) */
287 if (phydev->drv->config_init) {
290 err = phydev->drv->config_init(phydev);
298 EXPORT_SYMBOL(phy_attach);
301 * phy_detach - detach a PHY device from its network device
302 * @phydev: target phy_device struct
304 void phy_detach(struct phy_device *phydev)
306 phydev->attached_dev = NULL;
308 /* If the device had no specific driver before (i.e. - it
309 * was using the generic driver), we unbind the device
310 * from the generic driver so that there's a chance a
311 * real driver could be loaded */
312 if (phydev->dev.driver == &genphy_driver.driver)
313 device_release_driver(&phydev->dev);
315 EXPORT_SYMBOL(phy_detach);
318 /* Generic PHY support and helper functions */
321 * genphy_config_advert - sanitize and advertise auto-negotation parameters
322 * @phydev: target phy_device struct
324 * Description: Writes MII_ADVERTISE with the appropriate values,
325 * after sanitizing the values to make sure we only advertise
328 int genphy_config_advert(struct phy_device *phydev)
334 /* Only allow advertising what
335 * this PHY supports */
336 phydev->advertising &= phydev->supported;
337 advertise = phydev->advertising;
339 /* Setup standard advertisement */
340 adv = phy_read(phydev, MII_ADVERTISE);
345 adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
346 ADVERTISE_PAUSE_ASYM);
347 if (advertise & ADVERTISED_10baseT_Half)
348 adv |= ADVERTISE_10HALF;
349 if (advertise & ADVERTISED_10baseT_Full)
350 adv |= ADVERTISE_10FULL;
351 if (advertise & ADVERTISED_100baseT_Half)
352 adv |= ADVERTISE_100HALF;
353 if (advertise & ADVERTISED_100baseT_Full)
354 adv |= ADVERTISE_100FULL;
355 if (advertise & ADVERTISED_Pause)
356 adv |= ADVERTISE_PAUSE_CAP;
357 if (advertise & ADVERTISED_Asym_Pause)
358 adv |= ADVERTISE_PAUSE_ASYM;
360 err = phy_write(phydev, MII_ADVERTISE, adv);
365 /* Configure gigabit if it's supported */
366 if (phydev->supported & (SUPPORTED_1000baseT_Half |
367 SUPPORTED_1000baseT_Full)) {
368 adv = phy_read(phydev, MII_CTRL1000);
373 adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
374 if (advertise & SUPPORTED_1000baseT_Half)
375 adv |= ADVERTISE_1000HALF;
376 if (advertise & SUPPORTED_1000baseT_Full)
377 adv |= ADVERTISE_1000FULL;
378 err = phy_write(phydev, MII_CTRL1000, adv);
386 EXPORT_SYMBOL(genphy_config_advert);
389 * genphy_setup_forced - configures/forces speed/duplex from @phydev
390 * @phydev: target phy_device struct
392 * Description: Configures MII_BMCR to force speed/duplex
393 * to the values in phydev. Assumes that the values are valid.
394 * Please see phy_sanitize_settings().
396 int genphy_setup_forced(struct phy_device *phydev)
400 phydev->pause = phydev->asym_pause = 0;
402 if (SPEED_1000 == phydev->speed)
403 ctl |= BMCR_SPEED1000;
404 else if (SPEED_100 == phydev->speed)
405 ctl |= BMCR_SPEED100;
407 if (DUPLEX_FULL == phydev->duplex)
408 ctl |= BMCR_FULLDPLX;
410 ctl = phy_write(phydev, MII_BMCR, ctl);
415 /* We just reset the device, so we'd better configure any
416 * settings the PHY requires to operate */
417 if (phydev->drv->config_init)
418 ctl = phydev->drv->config_init(phydev);
425 * genphy_restart_aneg - Enable and Restart Autonegotiation
426 * @phydev: target phy_device struct
428 int genphy_restart_aneg(struct phy_device *phydev)
432 ctl = phy_read(phydev, MII_BMCR);
437 ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);
439 /* Don't isolate the PHY if we're negotiating */
440 ctl &= ~(BMCR_ISOLATE);
442 ctl = phy_write(phydev, MII_BMCR, ctl);
449 * genphy_config_aneg - restart auto-negotiation or write BMCR
450 * @phydev: target phy_device struct
452 * Description: If auto-negotiation is enabled, we configure the
453 * advertising, and then restart auto-negotiation. If it is not
454 * enabled, then we write the BMCR.
456 int genphy_config_aneg(struct phy_device *phydev)
460 if (AUTONEG_ENABLE == phydev->autoneg) {
461 err = genphy_config_advert(phydev);
466 err = genphy_restart_aneg(phydev);
468 err = genphy_setup_forced(phydev);
472 EXPORT_SYMBOL(genphy_config_aneg);
475 * genphy_update_link - update link status in @phydev
476 * @phydev: target phy_device struct
478 * Description: Update the value in phydev->link to reflect the
479 * current link value. In order to do this, we need to read
480 * the status register twice, keeping the second value.
482 int genphy_update_link(struct phy_device *phydev)
487 status = phy_read(phydev, MII_BMSR);
492 /* Read link and autonegotiation status */
493 status = phy_read(phydev, MII_BMSR);
498 if ((status & BMSR_LSTATUS) == 0)
505 EXPORT_SYMBOL(genphy_update_link);
508 * genphy_read_status - check the link status and update current link state
509 * @phydev: target phy_device struct
511 * Description: Check the link, then figure out the current state
512 * by comparing what we advertise with what the link partner
513 * advertises. Start by checking the gigabit possibilities,
514 * then move on to 10/100.
516 int genphy_read_status(struct phy_device *phydev)
523 /* Update the link, but return if there
525 err = genphy_update_link(phydev);
529 if (AUTONEG_ENABLE == phydev->autoneg) {
530 if (phydev->supported & (SUPPORTED_1000baseT_Half
531 | SUPPORTED_1000baseT_Full)) {
532 lpagb = phy_read(phydev, MII_STAT1000);
537 adv = phy_read(phydev, MII_CTRL1000);
545 lpa = phy_read(phydev, MII_LPA);
550 adv = phy_read(phydev, MII_ADVERTISE);
557 phydev->speed = SPEED_10;
558 phydev->duplex = DUPLEX_HALF;
559 phydev->pause = phydev->asym_pause = 0;
561 if (lpagb & (LPA_1000FULL | LPA_1000HALF)) {
562 phydev->speed = SPEED_1000;
564 if (lpagb & LPA_1000FULL)
565 phydev->duplex = DUPLEX_FULL;
566 } else if (lpa & (LPA_100FULL | LPA_100HALF)) {
567 phydev->speed = SPEED_100;
569 if (lpa & LPA_100FULL)
570 phydev->duplex = DUPLEX_FULL;
572 if (lpa & LPA_10FULL)
573 phydev->duplex = DUPLEX_FULL;
575 if (phydev->duplex == DUPLEX_FULL){
576 phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
577 phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
580 int bmcr = phy_read(phydev, MII_BMCR);
584 if (bmcr & BMCR_FULLDPLX)
585 phydev->duplex = DUPLEX_FULL;
587 phydev->duplex = DUPLEX_HALF;
589 if (bmcr & BMCR_SPEED1000)
590 phydev->speed = SPEED_1000;
591 else if (bmcr & BMCR_SPEED100)
592 phydev->speed = SPEED_100;
594 phydev->speed = SPEED_10;
596 phydev->pause = phydev->asym_pause = 0;
601 EXPORT_SYMBOL(genphy_read_status);
603 static int genphy_config_init(struct phy_device *phydev)
608 /* For now, I'll claim that the generic driver supports
609 * all possible port types */
610 features = (SUPPORTED_TP | SUPPORTED_MII
611 | SUPPORTED_AUI | SUPPORTED_FIBRE |
614 /* Do we support autonegotiation? */
615 val = phy_read(phydev, MII_BMSR);
620 if (val & BMSR_ANEGCAPABLE)
621 features |= SUPPORTED_Autoneg;
623 if (val & BMSR_100FULL)
624 features |= SUPPORTED_100baseT_Full;
625 if (val & BMSR_100HALF)
626 features |= SUPPORTED_100baseT_Half;
627 if (val & BMSR_10FULL)
628 features |= SUPPORTED_10baseT_Full;
629 if (val & BMSR_10HALF)
630 features |= SUPPORTED_10baseT_Half;
632 if (val & BMSR_ESTATEN) {
633 val = phy_read(phydev, MII_ESTATUS);
638 if (val & ESTATUS_1000_TFULL)
639 features |= SUPPORTED_1000baseT_Full;
640 if (val & ESTATUS_1000_THALF)
641 features |= SUPPORTED_1000baseT_Half;
644 phydev->supported = features;
645 phydev->advertising = features;
652 * phy_probe - probe and init a PHY device
653 * @dev: device to probe and init
655 * Description: Take care of setting up the phy_device structure,
656 * set the state to READY (the driver's init function should
657 * set it to STARTING if needed).
659 static int phy_probe(struct device *dev)
661 struct phy_device *phydev;
662 struct phy_driver *phydrv;
663 struct device_driver *drv;
666 phydev = to_phy_device(dev);
668 /* Make sure the driver is held.
669 * XXX -- Is this correct? */
670 drv = get_driver(phydev->dev.driver);
671 phydrv = to_phy_driver(drv);
672 phydev->drv = phydrv;
674 /* Disable the interrupt if the PHY doesn't support it */
675 if (!(phydrv->flags & PHY_HAS_INTERRUPT))
676 phydev->irq = PHY_POLL;
678 mutex_lock(&phydev->lock);
680 /* Start out supporting everything. Eventually,
681 * a controller will attach, and may modify one
682 * or both of these values */
683 phydev->supported = phydrv->features;
684 phydev->advertising = phydrv->features;
686 /* Set the state to READY by default */
687 phydev->state = PHY_READY;
689 if (phydev->drv->probe)
690 err = phydev->drv->probe(phydev);
692 mutex_unlock(&phydev->lock);
698 static int phy_remove(struct device *dev)
700 struct phy_device *phydev;
702 phydev = to_phy_device(dev);
704 mutex_lock(&phydev->lock);
705 phydev->state = PHY_DOWN;
706 mutex_unlock(&phydev->lock);
708 if (phydev->drv->remove)
709 phydev->drv->remove(phydev);
711 put_driver(dev->driver);
718 * phy_driver_register - register a phy_driver with the PHY layer
719 * @new_driver: new phy_driver to register
721 int phy_driver_register(struct phy_driver *new_driver)
725 memset(&new_driver->driver, 0, sizeof(new_driver->driver));
726 new_driver->driver.name = new_driver->name;
727 new_driver->driver.bus = &mdio_bus_type;
728 new_driver->driver.probe = phy_probe;
729 new_driver->driver.remove = phy_remove;
731 retval = driver_register(&new_driver->driver);
734 printk(KERN_ERR "%s: Error %d in registering driver\n",
735 new_driver->name, retval);
740 pr_debug("%s: Registered new driver\n", new_driver->name);
744 EXPORT_SYMBOL(phy_driver_register);
746 void phy_driver_unregister(struct phy_driver *drv)
748 driver_unregister(&drv->driver);
750 EXPORT_SYMBOL(phy_driver_unregister);
752 static struct phy_driver genphy_driver = {
753 .phy_id = 0xffffffff,
754 .phy_id_mask = 0xffffffff,
755 .name = "Generic PHY",
756 .config_init = genphy_config_init,
758 .config_aneg = genphy_config_aneg,
759 .read_status = genphy_read_status,
760 .driver = {.owner= THIS_MODULE, },
763 static int __init phy_init(void)
767 rc = mdio_bus_init();
771 rc = phy_driver_register(&genphy_driver);
778 static void __exit phy_exit(void)
780 phy_driver_unregister(&genphy_driver);
784 subsys_initcall(phy_init);
785 module_exit(phy_exit);