drivers/net/phy/mdio_bus.c

   1 /*
   2  * drivers/net/phy/mdio_bus.c
   3  *
   4  * MDIO Bus interface
   5  *
   6  * Author: Andy Fleming
   7  *
   8  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   9  *
  10  * This program is free software; you can redistribute  it and/or modify it
  11  * under  the terms of  the GNU General  Public License as published by the
  12  * Free Software Foundation;  either version 2 of the  License, or (at your
  13  * option) any later version.
  14  *
  15  */
  16 #include <linux/kernel.h>
  17 #include <linux/string.h>
  18 #include <linux/errno.h>
  19 #include <linux/unistd.h>
  20 #include <linux/slab.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/init.h>
  23 #include <linux/delay.h>
  24 #include <linux/device.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/etherdevice.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/spinlock.h>
  29 #include <linux/mm.h>
  30 #include <linux/module.h>
  31 #include <linux/mii.h>
  32 #include <linux/ethtool.h>
  33 #include <linux/phy.h>
  34
  35 #include <asm/io.h>
  36 #include <asm/irq.h>
  37 #include <asm/uaccess.h>
  38
  39 /**
  40  * mdiobus_alloc_size - allocate a mii_bus structure
  41  *
  42  * Description: called by a bus driver to allocate an mii_bus
  43  * structure to fill in.
  44  *
  45  * 'size' is an an extra amount of memory to allocate for private storage.
  46  * If non-zero, then bus->priv is points to that memory.
  47  */
  48 struct mii_bus *mdiobus_alloc_size(size_t size)
  49 {
  50         struct mii_bus *bus;
  51         size_t aligned_size = ALIGN(sizeof(*bus), NETDEV_ALIGN);
  52         size_t alloc_size;
  53
  54         /* If we alloc extra space, it should be aligned */
  55         if (size)
  56                 alloc_size = aligned_size + size;
  57         else
  58                 alloc_size = sizeof(*bus);
  59
  60         bus = kzalloc(alloc_size, GFP_KERNEL);
  61         if (bus) {
  62                 bus->state = MDIOBUS_ALLOCATED;
  63                 if (size)
  64                         bus->priv = (void *)bus + aligned_size;
  65         }
  66
  67         return bus;
  68 }
  69 EXPORT_SYMBOL(mdiobus_alloc_size);
  70
  71 /**
  72  * mdiobus_release - mii_bus device release callback
  73  * @d: the target struct device that contains the mii_bus
  74  *
  75  * Description: called when the last reference to an mii_bus is
  76  * dropped, to free the underlying memory.
  77  */
  78 static void mdiobus_release(struct device *d)
  79 {
  80         struct mii_bus *bus = to_mii_bus(d);
  81         BUG_ON(bus->state != MDIOBUS_RELEASED &&
  82                /* for compatibility with error handling in drivers */
  83                bus->state != MDIOBUS_ALLOCATED);
  84         kfree(bus);
  85 }
  86
  87 static struct class mdio_bus_class = {
  88         .name           = "mdio_bus",
  89         .dev_release    = mdiobus_release,
  90 };
  91
  92 /**
  93  * mdiobus_register - bring up all the PHYs on a given bus and attach them to bus
  94  * @bus: target mii_bus
  95  *
  96  * Description: Called by a bus driver to bring up all the PHYs
  97  *   on a given bus, and attach them to the bus.
  98  *
  99  * Returns 0 on success or < 0 on error.
 100  */
 101 int mdiobus_register(struct mii_bus *bus)
 102 {
 103         int i, err;
 104
 105         if (NULL == bus || NULL == bus->name ||
 106                         NULL == bus->read ||
 107                         NULL == bus->write)
 108                 return -EINVAL;
 109
 110         BUG_ON(bus->state != MDIOBUS_ALLOCATED &&
 111                bus->state != MDIOBUS_UNREGISTERED);
 112
 113         bus->dev.parent = bus->parent;
 114         bus->dev.class = &mdio_bus_class;
 115         bus->dev.groups = NULL;
 116         dev_set_name(&bus->dev, "%s", bus->id);
 117
 118         err = device_register(&bus->dev);
 119         if (err) {
 120                 printk(KERN_ERR "mii_bus %s failed to register\n", bus->id);
 121                 return -EINVAL;
 122         }
 123
 124         mutex_init(&bus->mdio_lock);
 125
 126         if (bus->reset)
 127                 bus->reset(bus);
 128
 129         for (i = 0; i < PHY_MAX_ADDR; i++) {
 130                 if ((bus->phy_mask & (1 << i)) == 0) {
 131                         struct phy_device *phydev;
 132
 133                         phydev = mdiobus_scan(bus, i);
 134                         if (IS_ERR(phydev)) {
 135                                 err = PTR_ERR(phydev);
 136                                 goto error;
 137                         }
 138                 }
 139         }
 140
 141         bus->state = MDIOBUS_REGISTERED;
 142         pr_info("%s: probed\n", bus->name);
 143         return 0;
 144
 145 error:
 146         while (--i >= 0) {
 147                 if (bus->phy_map[i])
 148                         device_unregister(&bus->phy_map[i]->dev);
 149         }
 150         device_del(&bus->dev);
 151         return err;
 152 }
 153 EXPORT_SYMBOL(mdiobus_register);
 154
 155 void mdiobus_unregister(struct mii_bus *bus)
 156 {
 157         int i;
 158
 159         BUG_ON(bus->state != MDIOBUS_REGISTERED);
 160         bus->state = MDIOBUS_UNREGISTERED;
 161
 162         device_del(&bus->dev);
 163         for (i = 0; i < PHY_MAX_ADDR; i++) {
 164                 if (bus->phy_map[i])
 165                         device_unregister(&bus->phy_map[i]->dev);
 166                 bus->phy_map[i] = NULL;
 167         }
 168 }
 169 EXPORT_SYMBOL(mdiobus_unregister);
 170
 171 /**
 172  * mdiobus_free - free a struct mii_bus
 173  * @bus: mii_bus to free
 174  *
 175  * This function releases the reference to the underlying device
 176  * object in the mii_bus.  If this is the last reference, the mii_bus
 177  * will be freed.
 178  */
 179 void mdiobus_free(struct mii_bus *bus)
 180 {
 181         /*
 182          * For compatibility with error handling in drivers.
 183          */
 184         if (bus->state == MDIOBUS_ALLOCATED) {
 185                 kfree(bus);
 186                 return;
 187         }
 188
 189         BUG_ON(bus->state != MDIOBUS_UNREGISTERED);
 190         bus->state = MDIOBUS_RELEASED;
 191
 192         put_device(&bus->dev);
 193 }
 194 EXPORT_SYMBOL(mdiobus_free);
 195
 196 struct phy_device *mdiobus_scan(struct mii_bus *bus, int addr)
 197 {
 198         struct phy_device *phydev;
 199         int err;
 200
 201         phydev = get_phy_device(bus, addr);
 202         if (IS_ERR(phydev) || phydev == NULL)
 203                 return phydev;
 204
 205         err = phy_device_register(phydev);
 206         if (err) {
 207                 phy_device_free(phydev);
 208                 return NULL;
 209         }
 210
 211         return phydev;
 212 }
 213 EXPORT_SYMBOL(mdiobus_scan);
 214
 215 /**
 216  * mdiobus_read - Convenience function for reading a given MII mgmt register
 217  * @bus: the mii_bus struct
 218  * @addr: the phy address
 219  * @regnum: register number to read
 220  *
 221  * NOTE: MUST NOT be called from interrupt context,
 222  * because the bus read/write functions may wait for an interrupt
 223  * to conclude the operation.
 224  */
 225 int mdiobus_read(struct mii_bus *bus, int addr, u32 regnum)
 226 {
 227         int retval;
 228
 229         BUG_ON(in_interrupt());
 230
 231         mutex_lock(&bus->mdio_lock);
 232         retval = bus->read(bus, addr, regnum);
 233         mutex_unlock(&bus->mdio_lock);
 234
 235         return retval;
 236 }
 237 EXPORT_SYMBOL(mdiobus_read);
 238
 239 /**
 240  * mdiobus_write - Convenience function for writing a given MII mgmt register
 241  * @bus: the mii_bus struct
 242  * @addr: the phy address
 243  * @regnum: register number to write
 244  * @val: value to write to @regnum
 245  *
 246  * NOTE: MUST NOT be called from interrupt context,
 247  * because the bus read/write functions may wait for an interrupt
 248  * to conclude the operation.
 249  */
 250 int mdiobus_write(struct mii_bus *bus, int addr, u32 regnum, u16 val)
 251 {
 252         int err;
 253
 254         BUG_ON(in_interrupt());
 255
 256         mutex_lock(&bus->mdio_lock);
 257         err = bus->write(bus, addr, regnum, val);
 258         mutex_unlock(&bus->mdio_lock);
 259
 260         return err;
 261 }
 262 EXPORT_SYMBOL(mdiobus_write);
 263
 264 /**
 265  * mdio_bus_match - determine if given PHY driver supports the given PHY device
 266  * @dev: target PHY device
 267  * @drv: given PHY driver
 268  *
 269  * Description: Given a PHY device, and a PHY driver, return 1 if
 270  *   the driver supports the device.  Otherwise, return 0.
 271  */
 272 static int mdio_bus_match(struct device *dev, struct device_driver *drv)
 273 {
 274         struct phy_device *phydev = to_phy_device(dev);
 275         struct phy_driver *phydrv = to_phy_driver(drv);
 276
 277         return ((phydrv->phy_id & phydrv->phy_id_mask) ==
 278                 (phydev->phy_id & phydrv->phy_id_mask));
 279 }
 280
 281 #ifdef CONFIG_PM
 282
 283 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
 284 {
 285         struct device_driver *drv = phydev->dev.driver;
 286         struct phy_driver *phydrv = to_phy_driver(drv);
 287         struct net_device *netdev = phydev->attached_dev;
 288
 289         if (!drv || !phydrv->suspend)
 290                 return false;
 291
 292         /* PHY not attached? May suspend. */
 293         if (!netdev)
 294                 return true;
 295
 296         /*
 297          * Don't suspend PHY if the attched netdev parent may wakeup.
 298          * The parent may point to a PCI device, as in tg3 driver.
 299          */
 300         if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
 301                 return false;
 302
 303         /*
 304          * Also don't suspend PHY if the netdev itself may wakeup. This
 305          * is the case for devices w/o underlaying pwr. mgmt. aware bus,
 306          * e.g. SoC devices.
 307          */
 308         if (device_may_wakeup(&netdev->dev))
 309                 return false;
 310
 311         return true;
 312 }
 313
 314 static int mdio_bus_suspend(struct device *dev)
 315 {
 316         struct phy_driver *phydrv = to_phy_driver(dev->driver);
 317         struct phy_device *phydev = to_phy_device(dev);
 318
 319         /*
 320          * We must stop the state machine manually, otherwise it stops out of
 321          * control, possibly with the phydev->lock held. Upon resume, netdev
 322          * may call phy routines that try to grab the same lock, and that may
 323          * lead to a deadlock.
 324          */
 325         if (phydev->attached_dev && phydev->adjust_link)
 326                 phy_stop_machine(phydev);
 327
 328         if (!mdio_bus_phy_may_suspend(phydev))
 329                 return 0;
 330
 331         return phydrv->suspend(phydev);
 332 }
 333
 334 static int mdio_bus_resume(struct device *dev)
 335 {
 336         struct phy_driver *phydrv = to_phy_driver(dev->driver);
 337         struct phy_device *phydev = to_phy_device(dev);
 338         int ret;
 339
 340         if (!mdio_bus_phy_may_suspend(phydev))
 341                 goto no_resume;
 342
 343         ret = phydrv->resume(phydev);
 344         if (ret < 0)
 345                 return ret;
 346
 347 no_resume:
 348         if (phydev->attached_dev && phydev->adjust_link)
 349                 phy_start_machine(phydev, NULL);
 350
 351         return 0;
 352 }
 353
 354 static int mdio_bus_restore(struct device *dev)
 355 {
 356         struct phy_device *phydev = to_phy_device(dev);
 357         struct net_device *netdev = phydev->attached_dev;
 358         int ret;
 359
 360         if (!netdev)
 361                 return 0;
 362
 363         ret = phy_init_hw(phydev);
 364         if (ret < 0)
 365                 return ret;
 366
 367         /* The PHY needs to renegotiate. */
 368         phydev->link = 0;
 369         phydev->state = PHY_UP;
 370
 371         phy_start_machine(phydev, NULL);
 372
 373         return 0;
 374 }
 375
 376 static struct dev_pm_ops mdio_bus_pm_ops = {
 377         .suspend = mdio_bus_suspend,
 378         .resume = mdio_bus_resume,
 379         .freeze = mdio_bus_suspend,
 380         .thaw = mdio_bus_resume,
 381         .restore = mdio_bus_restore,
 382 };
 383
 384 #define MDIO_BUS_PM_OPS (&mdio_bus_pm_ops)
 385
 386 #else
 387
 388 #define MDIO_BUS_PM_OPS NULL
 389
 390 #endif /* CONFIG_PM */
 391
 392 struct bus_type mdio_bus_type = {
 393         .name           = "mdio_bus",
 394         .match          = mdio_bus_match,
 395         .pm             = MDIO_BUS_PM_OPS,
 396 };
 397 EXPORT_SYMBOL(mdio_bus_type);
 398
 399 int __init mdio_bus_init(void)
 400 {
 401         int ret;
 402
 403         ret = class_register(&mdio_bus_class);
 404         if (!ret) {
 405                 ret = bus_register(&mdio_bus_type);
 406                 if (ret)
 407                         class_unregister(&mdio_bus_class);
 408         }
 409
 410         return ret;
 411 }
 412
 413 void mdio_bus_exit(void)
 414 {
 415         class_unregister(&mdio_bus_class);
 416         bus_unregister(&mdio_bus_type);
 417 }