drivers/usb/core/driver.c

   1 /*
   2  * drivers/usb/driver.c - most of the driver model stuff for usb
   3  *
   4  * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de>
   5  *
   6  * based on drivers/usb/usb.c which had the following copyrights:
   7  *      (C) Copyright Linus Torvalds 1999
   8  *      (C) Copyright Johannes Erdfelt 1999-2001
   9  *      (C) Copyright Andreas Gal 1999
  10  *      (C) Copyright Gregory P. Smith 1999
  11  *      (C) Copyright Deti Fliegl 1999 (new USB architecture)
  12  *      (C) Copyright Randy Dunlap 2000
  13  *      (C) Copyright David Brownell 2000-2004
  14  *      (C) Copyright Yggdrasil Computing, Inc. 2000
  15  *              (usb_device_id matching changes by Adam J. Richter)
  16  *      (C) Copyright Greg Kroah-Hartman 2002-2003
  17  *
  18  * NOTE! This is not actually a driver at all, rather this is
  19  * just a collection of helper routines that implement the
  20  * matching, probing, releasing, suspending and resuming for
  21  * real drivers.
  22  *
  23  */
  24
  25 #include <linux/device.h>
  26 #include <linux/usb.h>
  27 #include <linux/workqueue.h>
  28 #include "hcd.h"
  29 #include "usb.h"
  30
  31 #ifdef CONFIG_HOTPLUG
  32
  33 /*
  34  * Adds a new dynamic USBdevice ID to this driver,
  35  * and cause the driver to probe for all devices again.
  36  */
  37 ssize_t usb_store_new_id(struct usb_dynids *dynids,
  38                          struct device_driver *driver,
  39                          const char *buf, size_t count)
  40 {
  41         struct usb_dynid *dynid;
  42         u32 idVendor = 0;
  43         u32 idProduct = 0;
  44         int fields = 0;
  45         int retval = 0;
  46
  47         fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
  48         if (fields < 2)
  49                 return -EINVAL;
  50
  51         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
  52         if (!dynid)
  53                 return -ENOMEM;
  54
  55         INIT_LIST_HEAD(&dynid->node);
  56         dynid->id.idVendor = idVendor;
  57         dynid->id.idProduct = idProduct;
  58         dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
  59
  60         spin_lock(&dynids->lock);
  61         list_add_tail(&dynids->list, &dynid->node);
  62         spin_unlock(&dynids->lock);
  63
  64         if (get_driver(driver)) {
  65                 retval = driver_attach(driver);
  66                 put_driver(driver);
  67         }
  68
  69         if (retval)
  70                 return retval;
  71         return count;
  72 }
  73 EXPORT_SYMBOL_GPL(usb_store_new_id);
  74
  75 static ssize_t store_new_id(struct device_driver *driver,
  76                             const char *buf, size_t count)
  77 {
  78         struct usb_driver *usb_drv = to_usb_driver(driver);
  79
  80         return usb_store_new_id(&usb_drv->dynids, driver, buf, count);
  81 }
  82 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
  83
  84 static int usb_create_newid_file(struct usb_driver *usb_drv)
  85 {
  86         int error = 0;
  87
  88         if (usb_drv->no_dynamic_id)
  89                 goto exit;
  90
  91         if (usb_drv->probe != NULL)
  92                 error = sysfs_create_file(&usb_drv->drvwrap.driver.kobj,
  93                                           &driver_attr_new_id.attr);
  94 exit:
  95         return error;
  96 }
  97
  98 static void usb_remove_newid_file(struct usb_driver *usb_drv)
  99 {
 100         if (usb_drv->no_dynamic_id)
 101                 return;
 102
 103         if (usb_drv->probe != NULL)
 104                 sysfs_remove_file(&usb_drv->drvwrap.driver.kobj,
 105                                   &driver_attr_new_id.attr);
 106 }
 107
 108 static void usb_free_dynids(struct usb_driver *usb_drv)
 109 {
 110         struct usb_dynid *dynid, *n;
 111
 112         spin_lock(&usb_drv->dynids.lock);
 113         list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
 114                 list_del(&dynid->node);
 115                 kfree(dynid);
 116         }
 117         spin_unlock(&usb_drv->dynids.lock);
 118 }
 119 #else
 120 static inline int usb_create_newid_file(struct usb_driver *usb_drv)
 121 {
 122         return 0;
 123 }
 124
 125 static void usb_remove_newid_file(struct usb_driver *usb_drv)
 126 {
 127 }
 128
 129 static inline void usb_free_dynids(struct usb_driver *usb_drv)
 130 {
 131 }
 132 #endif
 133
 134 static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
 135                                                         struct usb_driver *drv)
 136 {
 137         struct usb_dynid *dynid;
 138
 139         spin_lock(&drv->dynids.lock);
 140         list_for_each_entry(dynid, &drv->dynids.list, node) {
 141                 if (usb_match_one_id(intf, &dynid->id)) {
 142                         spin_unlock(&drv->dynids.lock);
 143                         return &dynid->id;
 144                 }
 145         }
 146         spin_unlock(&drv->dynids.lock);
 147         return NULL;
 148 }
 149
 150
 151 /* called from driver core with dev locked */
 152 static int usb_probe_device(struct device *dev)
 153 {
 154         struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
 155         struct usb_device *udev;
 156         int error = -ENODEV;
 157
 158         dev_dbg(dev, "%s\n", __FUNCTION__);
 159
 160         if (!is_usb_device(dev))        /* Sanity check */
 161                 return error;
 162
 163         udev = to_usb_device(dev);
 164
 165         /* TODO: Add real matching code */
 166
 167         /* The device should always appear to be in use
 168          * unless the driver suports autosuspend.
 169          */
 170         udev->pm_usage_cnt = !(udriver->supports_autosuspend);
 171
 172         error = udriver->probe(udev);
 173         return error;
 174 }
 175
 176 /* called from driver core with dev locked */
 177 static int usb_unbind_device(struct device *dev)
 178 {
 179         struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
 180
 181         udriver->disconnect(to_usb_device(dev));
 182         return 0;
 183 }
 184
 185
 186 /* called from driver core with dev locked */
 187 static int usb_probe_interface(struct device *dev)
 188 {
 189         struct usb_driver *driver = to_usb_driver(dev->driver);
 190         struct usb_interface *intf;
 191         struct usb_device *udev;
 192         const struct usb_device_id *id;
 193         int error = -ENODEV;
 194
 195         dev_dbg(dev, "%s\n", __FUNCTION__);
 196
 197         if (is_usb_device(dev))         /* Sanity check */
 198                 return error;
 199
 200         intf = to_usb_interface(dev);
 201         udev = interface_to_usbdev(intf);
 202
 203         id = usb_match_id(intf, driver->id_table);
 204         if (!id)
 205                 id = usb_match_dynamic_id(intf, driver);
 206         if (id) {
 207                 dev_dbg(dev, "%s - got id\n", __FUNCTION__);
 208
 209                 error = usb_autoresume_device(udev);
 210                 if (error)
 211                         return error;
 212
 213                 /* Interface "power state" doesn't correspond to any hardware
 214                  * state whatsoever.  We use it to record when it's bound to
 215                  * a driver that may start I/0:  it's not frozen/quiesced.
 216                  */
 217                 mark_active(intf);
 218                 intf->condition = USB_INTERFACE_BINDING;
 219
 220                 /* The interface should always appear to be in use
 221                  * unless the driver suports autosuspend.
 222                  */
 223                 intf->pm_usage_cnt = !(driver->supports_autosuspend);
 224
 225                 error = driver->probe(intf, id);
 226                 if (error) {
 227                         mark_quiesced(intf);
 228                         intf->needs_remote_wakeup = 0;
 229                         intf->condition = USB_INTERFACE_UNBOUND;
 230                 } else
 231                         intf->condition = USB_INTERFACE_BOUND;
 232
 233                 usb_autosuspend_device(udev);
 234         }
 235
 236         return error;
 237 }
 238
 239 /* called from driver core with dev locked */
 240 static int usb_unbind_interface(struct device *dev)
 241 {
 242         struct usb_driver *driver = to_usb_driver(dev->driver);
 243         struct usb_interface *intf = to_usb_interface(dev);
 244         struct usb_device *udev;
 245         int error;
 246
 247         intf->condition = USB_INTERFACE_UNBINDING;
 248
 249         /* Autoresume for set_interface call below */
 250         udev = interface_to_usbdev(intf);
 251         error = usb_autoresume_device(udev);
 252
 253         /* release all urbs for this interface */
 254         usb_disable_interface(interface_to_usbdev(intf), intf);
 255
 256         driver->disconnect(intf);
 257
 258         /* reset other interface state */
 259         usb_set_interface(interface_to_usbdev(intf),
 260                         intf->altsetting[0].desc.bInterfaceNumber,
 261                         0);
 262         usb_set_intfdata(intf, NULL);
 263
 264         intf->condition = USB_INTERFACE_UNBOUND;
 265         mark_quiesced(intf);
 266         intf->needs_remote_wakeup = 0;
 267
 268         if (!error)
 269                 usb_autosuspend_device(udev);
 270
 271         return 0;
 272 }
 273
 274 /**
 275  * usb_driver_claim_interface - bind a driver to an interface
 276  * @driver: the driver to be bound
 277  * @iface: the interface to which it will be bound; must be in the
 278  *      usb device's active configuration
 279  * @priv: driver data associated with that interface
 280  *
 281  * This is used by usb device drivers that need to claim more than one
 282  * interface on a device when probing (audio and acm are current examples).
 283  * No device driver should directly modify internal usb_interface or
 284  * usb_device structure members.
 285  *
 286  * Few drivers should need to use this routine, since the most natural
 287  * way to bind to an interface is to return the private data from
 288  * the driver's probe() method.
 289  *
 290  * Callers must own the device lock and the driver model's usb_bus_type.subsys
 291  * writelock.  So driver probe() entries don't need extra locking,
 292  * but other call contexts may need to explicitly claim those locks.
 293  */
 294 int usb_driver_claim_interface(struct usb_driver *driver,
 295                                 struct usb_interface *iface, void* priv)
 296 {
 297         struct device *dev = &iface->dev;
 298         struct usb_device *udev = interface_to_usbdev(iface);
 299         int retval = 0;
 300
 301         if (dev->driver)
 302                 return -EBUSY;
 303
 304         dev->driver = &driver->drvwrap.driver;
 305         usb_set_intfdata(iface, priv);
 306
 307         usb_pm_lock(udev);
 308         iface->condition = USB_INTERFACE_BOUND;
 309         mark_active(iface);
 310         iface->pm_usage_cnt = !(driver->supports_autosuspend);
 311         usb_pm_unlock(udev);
 312
 313         /* if interface was already added, bind now; else let
 314          * the future device_add() bind it, bypassing probe()
 315          */
 316         if (device_is_registered(dev))
 317                 retval = device_bind_driver(dev);
 318
 319         return retval;
 320 }
 321 EXPORT_SYMBOL(usb_driver_claim_interface);
 322
 323 /**
 324  * usb_driver_release_interface - unbind a driver from an interface
 325  * @driver: the driver to be unbound
 326  * @iface: the interface from which it will be unbound
 327  *
 328  * This can be used by drivers to release an interface without waiting
 329  * for their disconnect() methods to be called.  In typical cases this
 330  * also causes the driver disconnect() method to be called.
 331  *
 332  * This call is synchronous, and may not be used in an interrupt context.
 333  * Callers must own the device lock and the driver model's usb_bus_type.subsys
 334  * writelock.  So driver disconnect() entries don't need extra locking,
 335  * but other call contexts may need to explicitly claim those locks.
 336  */
 337 void usb_driver_release_interface(struct usb_driver *driver,
 338                                         struct usb_interface *iface)
 339 {
 340         struct device *dev = &iface->dev;
 341         struct usb_device *udev = interface_to_usbdev(iface);
 342
 343         /* this should never happen, don't release something that's not ours */
 344         if (!dev->driver || dev->driver != &driver->drvwrap.driver)
 345                 return;
 346
 347         /* don't release from within disconnect() */
 348         if (iface->condition != USB_INTERFACE_BOUND)
 349                 return;
 350
 351         /* don't release if the interface hasn't been added yet */
 352         if (device_is_registered(dev)) {
 353                 iface->condition = USB_INTERFACE_UNBINDING;
 354                 device_release_driver(dev);
 355         }
 356
 357         dev->driver = NULL;
 358         usb_set_intfdata(iface, NULL);
 359
 360         usb_pm_lock(udev);
 361         iface->condition = USB_INTERFACE_UNBOUND;
 362         mark_quiesced(iface);
 363         iface->needs_remote_wakeup = 0;
 364         usb_pm_unlock(udev);
 365 }
 366 EXPORT_SYMBOL(usb_driver_release_interface);
 367
 368 /* returns 0 if no match, 1 if match */
 369 int usb_match_one_id(struct usb_interface *interface,
 370                      const struct usb_device_id *id)
 371 {
 372         struct usb_host_interface *intf;
 373         struct usb_device *dev;
 374
 375         /* proc_connectinfo in devio.c may call us with id == NULL. */
 376         if (id == NULL)
 377                 return 0;
 378
 379         intf = interface->cur_altsetting;
 380         dev = interface_to_usbdev(interface);
 381
 382         if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
 383             id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
 384                 return 0;
 385
 386         if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
 387             id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
 388                 return 0;
 389
 390         /* No need to test id->bcdDevice_lo != 0, since 0 is never
 391            greater than any unsigned number. */
 392         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
 393             (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
 394                 return 0;
 395
 396         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
 397             (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
 398                 return 0;
 399
 400         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
 401             (id->bDeviceClass != dev->descriptor.bDeviceClass))
 402                 return 0;
 403
 404         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
 405             (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
 406                 return 0;
 407
 408         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
 409             (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
 410                 return 0;
 411
 412         /* The interface class, subclass, and protocol should never be
 413          * checked for a match if the device class is Vendor Specific,
 414          * unless the match record specifies the Vendor ID. */
 415         if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
 416                         !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
 417                         (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
 418                                 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
 419                                 USB_DEVICE_ID_MATCH_INT_PROTOCOL)))
 420                 return 0;
 421
 422         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
 423             (id->bInterfaceClass != intf->desc.bInterfaceClass))
 424                 return 0;
 425
 426         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
 427             (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
 428                 return 0;
 429
 430         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
 431             (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
 432                 return 0;
 433
 434         return 1;
 435 }
 436 EXPORT_SYMBOL_GPL(usb_match_one_id);
 437
 438 /**
 439  * usb_match_id - find first usb_device_id matching device or interface
 440  * @interface: the interface of interest
 441  * @id: array of usb_device_id structures, terminated by zero entry
 442  *
 443  * usb_match_id searches an array of usb_device_id's and returns
 444  * the first one matching the device or interface, or null.
 445  * This is used when binding (or rebinding) a driver to an interface.
 446  * Most USB device drivers will use this indirectly, through the usb core,
 447  * but some layered driver frameworks use it directly.
 448  * These device tables are exported with MODULE_DEVICE_TABLE, through
 449  * modutils, to support the driver loading functionality of USB hotplugging.
 450  *
 451  * What Matches:
 452  *
 453  * The "match_flags" element in a usb_device_id controls which
 454  * members are used.  If the corresponding bit is set, the
 455  * value in the device_id must match its corresponding member
 456  * in the device or interface descriptor, or else the device_id
 457  * does not match.
 458  *
 459  * "driver_info" is normally used only by device drivers,
 460  * but you can create a wildcard "matches anything" usb_device_id
 461  * as a driver's "modules.usbmap" entry if you provide an id with
 462  * only a nonzero "driver_info" field.  If you do this, the USB device
 463  * driver's probe() routine should use additional intelligence to
 464  * decide whether to bind to the specified interface.
 465  *
 466  * What Makes Good usb_device_id Tables:
 467  *
 468  * The match algorithm is very simple, so that intelligence in
 469  * driver selection must come from smart driver id records.
 470  * Unless you have good reasons to use another selection policy,
 471  * provide match elements only in related groups, and order match
 472  * specifiers from specific to general.  Use the macros provided
 473  * for that purpose if you can.
 474  *
 475  * The most specific match specifiers use device descriptor
 476  * data.  These are commonly used with product-specific matches;
 477  * the USB_DEVICE macro lets you provide vendor and product IDs,
 478  * and you can also match against ranges of product revisions.
 479  * These are widely used for devices with application or vendor
 480  * specific bDeviceClass values.
 481  *
 482  * Matches based on device class/subclass/protocol specifications
 483  * are slightly more general; use the USB_DEVICE_INFO macro, or
 484  * its siblings.  These are used with single-function devices
 485  * where bDeviceClass doesn't specify that each interface has
 486  * its own class.
 487  *
 488  * Matches based on interface class/subclass/protocol are the
 489  * most general; they let drivers bind to any interface on a
 490  * multiple-function device.  Use the USB_INTERFACE_INFO
 491  * macro, or its siblings, to match class-per-interface style
 492  * devices (as recorded in bInterfaceClass).
 493  *
 494  * Note that an entry created by USB_INTERFACE_INFO won't match
 495  * any interface if the device class is set to Vendor-Specific.
 496  * This is deliberate; according to the USB spec the meanings of
 497  * the interface class/subclass/protocol for these devices are also
 498  * vendor-specific, and hence matching against a standard product
 499  * class wouldn't work anyway.  If you really want to use an
 500  * interface-based match for such a device, create a match record
 501  * that also specifies the vendor ID.  (Unforunately there isn't a
 502  * standard macro for creating records like this.)
 503  *
 504  * Within those groups, remember that not all combinations are
 505  * meaningful.  For example, don't give a product version range
 506  * without vendor and product IDs; or specify a protocol without
 507  * its associated class and subclass.
 508  */
 509 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
 510                                          const struct usb_device_id *id)
 511 {
 512         /* proc_connectinfo in devio.c may call us with id == NULL. */
 513         if (id == NULL)
 514                 return NULL;
 515
 516         /* It is important to check that id->driver_info is nonzero,
 517            since an entry that is all zeroes except for a nonzero
 518            id->driver_info is the way to create an entry that
 519            indicates that the driver want to examine every
 520            device and interface. */
 521         for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
 522                id->driver_info; id++) {
 523                 if (usb_match_one_id(interface, id))
 524                         return id;
 525         }
 526
 527         return NULL;
 528 }
 529 EXPORT_SYMBOL_GPL_FUTURE(usb_match_id);
 530
 531 static int usb_device_match(struct device *dev, struct device_driver *drv)
 532 {
 533         /* devices and interfaces are handled separately */
 534         if (is_usb_device(dev)) {
 535
 536                 /* interface drivers never match devices */
 537                 if (!is_usb_device_driver(drv))
 538                         return 0;
 539
 540                 /* TODO: Add real matching code */
 541                 return 1;
 542
 543         } else {
 544                 struct usb_interface *intf;
 545                 struct usb_driver *usb_drv;
 546                 const struct usb_device_id *id;
 547
 548                 /* device drivers never match interfaces */
 549                 if (is_usb_device_driver(drv))
 550                         return 0;
 551
 552                 intf = to_usb_interface(dev);
 553                 usb_drv = to_usb_driver(drv);
 554
 555                 id = usb_match_id(intf, usb_drv->id_table);
 556                 if (id)
 557                         return 1;
 558
 559                 id = usb_match_dynamic_id(intf, usb_drv);
 560                 if (id)
 561                         return 1;
 562         }
 563
 564         return 0;
 565 }
 566
 567 #ifdef  CONFIG_HOTPLUG
 568
 569 /*
 570  * This sends an uevent to userspace, typically helping to load driver
 571  * or other modules, configure the device, and more.  Drivers can provide
 572  * a MODULE_DEVICE_TABLE to help with module loading subtasks.
 573  *
 574  * We're called either from khubd (the typical case) or from root hub
 575  * (init, kapmd, modprobe, rmmod, etc), but the agents need to handle
 576  * delays in event delivery.  Use sysfs (and DEVPATH) to make sure the
 577  * device (and this configuration!) are still present.
 578  */
 579 static int usb_uevent(struct device *dev, char **envp, int num_envp,
 580                       char *buffer, int buffer_size)
 581 {
 582         struct usb_interface *intf;
 583         struct usb_device *usb_dev;
 584         struct usb_host_interface *alt;
 585         int i = 0;
 586         int length = 0;
 587
 588         if (!dev)
 589                 return -ENODEV;
 590
 591         /* driver is often null here; dev_dbg() would oops */
 592         pr_debug ("usb %s: uevent\n", dev->bus_id);
 593
 594         if (is_usb_device(dev)) {
 595                 usb_dev = to_usb_device(dev);
 596                 alt = NULL;
 597         } else {
 598                 intf = to_usb_interface(dev);
 599                 usb_dev = interface_to_usbdev(intf);
 600                 alt = intf->cur_altsetting;
 601         }
 602
 603         if (usb_dev->devnum < 0) {
 604                 pr_debug ("usb %s: already deleted?\n", dev->bus_id);
 605                 return -ENODEV;
 606         }
 607         if (!usb_dev->bus) {
 608                 pr_debug ("usb %s: bus removed?\n", dev->bus_id);
 609                 return -ENODEV;
 610         }
 611
 612 #ifdef  CONFIG_USB_DEVICEFS
 613         /* If this is available, userspace programs can directly read
 614          * all the device descriptors we don't tell them about.  Or
 615          * even act as usermode drivers.
 616          *
 617          * FIXME reduce hardwired intelligence here
 618          */
 619         if (add_uevent_var(envp, num_envp, &i,
 620                            buffer, buffer_size, &length,
 621                            "DEVICE=/proc/bus/usb/%03d/%03d",
 622                            usb_dev->bus->busnum, usb_dev->devnum))
 623                 return -ENOMEM;
 624 #endif
 625
 626         /* per-device configurations are common */
 627         if (add_uevent_var(envp, num_envp, &i,
 628                            buffer, buffer_size, &length,
 629                            "PRODUCT=%x/%x/%x",
 630                            le16_to_cpu(usb_dev->descriptor.idVendor),
 631                            le16_to_cpu(usb_dev->descriptor.idProduct),
 632                            le16_to_cpu(usb_dev->descriptor.bcdDevice)))
 633                 return -ENOMEM;
 634
 635         /* class-based driver binding models */
 636         if (add_uevent_var(envp, num_envp, &i,
 637                            buffer, buffer_size, &length,
 638                            "TYPE=%d/%d/%d",
 639                            usb_dev->descriptor.bDeviceClass,
 640                            usb_dev->descriptor.bDeviceSubClass,
 641                            usb_dev->descriptor.bDeviceProtocol))
 642                 return -ENOMEM;
 643
 644         if (!is_usb_device(dev)) {
 645
 646                 if (add_uevent_var(envp, num_envp, &i,
 647                            buffer, buffer_size, &length,
 648                            "INTERFACE=%d/%d/%d",
 649                            alt->desc.bInterfaceClass,
 650                            alt->desc.bInterfaceSubClass,
 651                            alt->desc.bInterfaceProtocol))
 652                         return -ENOMEM;
 653
 654                 if (add_uevent_var(envp, num_envp, &i,
 655                            buffer, buffer_size, &length,
 656                            "MODALIAS=usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02X",
 657                            le16_to_cpu(usb_dev->descriptor.idVendor),
 658                            le16_to_cpu(usb_dev->descriptor.idProduct),
 659                            le16_to_cpu(usb_dev->descriptor.bcdDevice),
 660                            usb_dev->descriptor.bDeviceClass,
 661                            usb_dev->descriptor.bDeviceSubClass,
 662                            usb_dev->descriptor.bDeviceProtocol,
 663                            alt->desc.bInterfaceClass,
 664                            alt->desc.bInterfaceSubClass,
 665                            alt->desc.bInterfaceProtocol))
 666                         return -ENOMEM;
 667         }
 668
 669         envp[i] = NULL;
 670
 671         return 0;
 672 }
 673
 674 #else
 675
 676 static int usb_uevent(struct device *dev, char **envp,
 677                         int num_envp, char *buffer, int buffer_size)
 678 {
 679         return -ENODEV;
 680 }
 681
 682 #endif  /* CONFIG_HOTPLUG */
 683
 684 /**
 685  * usb_register_device_driver - register a USB device (not interface) driver
 686  * @new_udriver: USB operations for the device driver
 687  * @owner: module owner of this driver.
 688  *
 689  * Registers a USB device driver with the USB core.  The list of
 690  * unattached devices will be rescanned whenever a new driver is
 691  * added, allowing the new driver to attach to any recognized devices.
 692  * Returns a negative error code on failure and 0 on success.
 693  */
 694 int usb_register_device_driver(struct usb_device_driver *new_udriver,
 695                 struct module *owner)
 696 {
 697         int retval = 0;
 698
 699         if (usb_disabled())
 700                 return -ENODEV;
 701
 702         new_udriver->drvwrap.for_devices = 1;
 703         new_udriver->drvwrap.driver.name = (char *) new_udriver->name;
 704         new_udriver->drvwrap.driver.bus = &usb_bus_type;
 705         new_udriver->drvwrap.driver.probe = usb_probe_device;
 706         new_udriver->drvwrap.driver.remove = usb_unbind_device;
 707         new_udriver->drvwrap.driver.owner = owner;
 708
 709         retval = driver_register(&new_udriver->drvwrap.driver);
 710
 711         if (!retval) {
 712                 pr_info("%s: registered new device driver %s\n",
 713                         usbcore_name, new_udriver->name);
 714                 usbfs_update_special();
 715         } else {
 716                 printk(KERN_ERR "%s: error %d registering device "
 717                         "       driver %s\n",
 718                         usbcore_name, retval, new_udriver->name);
 719         }
 720
 721         return retval;
 722 }
 723 EXPORT_SYMBOL_GPL(usb_register_device_driver);
 724
 725 /**
 726  * usb_deregister_device_driver - unregister a USB device (not interface) driver
 727  * @udriver: USB operations of the device driver to unregister
 728  * Context: must be able to sleep
 729  *
 730  * Unlinks the specified driver from the internal USB driver list.
 731  */
 732 void usb_deregister_device_driver(struct usb_device_driver *udriver)
 733 {
 734         pr_info("%s: deregistering device driver %s\n",
 735                         usbcore_name, udriver->name);
 736
 737         driver_unregister(&udriver->drvwrap.driver);
 738         usbfs_update_special();
 739 }
 740 EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
 741
 742 /**
 743  * usb_register_driver - register a USB interface driver
 744  * @new_driver: USB operations for the interface driver
 745  * @owner: module owner of this driver.
 746  *
 747  * Registers a USB interface driver with the USB core.  The list of
 748  * unattached interfaces will be rescanned whenever a new driver is
 749  * added, allowing the new driver to attach to any recognized interfaces.
 750  * Returns a negative error code on failure and 0 on success.
 751  *
 752  * NOTE: if you want your driver to use the USB major number, you must call
 753  * usb_register_dev() to enable that functionality.  This function no longer
 754  * takes care of that.
 755  */
 756 int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
 757                         const char *mod_name)
 758 {
 759         int retval = 0;
 760
 761         if (usb_disabled())
 762                 return -ENODEV;
 763
 764         new_driver->drvwrap.for_devices = 0;
 765         new_driver->drvwrap.driver.name = (char *) new_driver->name;
 766         new_driver->drvwrap.driver.bus = &usb_bus_type;
 767         new_driver->drvwrap.driver.probe = usb_probe_interface;
 768         new_driver->drvwrap.driver.remove = usb_unbind_interface;
 769         new_driver->drvwrap.driver.owner = owner;
 770         new_driver->drvwrap.driver.mod_name = mod_name;
 771         spin_lock_init(&new_driver->dynids.lock);
 772         INIT_LIST_HEAD(&new_driver->dynids.list);
 773
 774         retval = driver_register(&new_driver->drvwrap.driver);
 775
 776         if (!retval) {
 777                 pr_info("%s: registered new interface driver %s\n",
 778                         usbcore_name, new_driver->name);
 779                 usbfs_update_special();
 780                 usb_create_newid_file(new_driver);
 781         } else {
 782                 printk(KERN_ERR "%s: error %d registering interface "
 783                         "       driver %s\n",
 784                         usbcore_name, retval, new_driver->name);
 785         }
 786
 787         return retval;
 788 }
 789 EXPORT_SYMBOL_GPL_FUTURE(usb_register_driver);
 790
 791 /**
 792  * usb_deregister - unregister a USB interface driver
 793  * @driver: USB operations of the interface driver to unregister
 794  * Context: must be able to sleep
 795  *
 796  * Unlinks the specified driver from the internal USB driver list.
 797  *
 798  * NOTE: If you called usb_register_dev(), you still need to call
 799  * usb_deregister_dev() to clean up your driver's allocated minor numbers,
 800  * this * call will no longer do it for you.
 801  */
 802 void usb_deregister(struct usb_driver *driver)
 803 {
 804         pr_info("%s: deregistering interface driver %s\n",
 805                         usbcore_name, driver->name);
 806
 807         usb_remove_newid_file(driver);
 808         usb_free_dynids(driver);
 809         driver_unregister(&driver->drvwrap.driver);
 810
 811         usbfs_update_special();
 812 }
 813 EXPORT_SYMBOL_GPL_FUTURE(usb_deregister);
 814
 815 #ifdef CONFIG_PM
 816
 817 /* Caller has locked udev's pm_mutex */
 818 static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
 819 {
 820         struct usb_device_driver        *udriver;
 821         int                             status = 0;
 822
 823         if (udev->state == USB_STATE_NOTATTACHED ||
 824                         udev->state == USB_STATE_SUSPENDED)
 825                 goto done;
 826
 827         /* For devices that don't have a driver, we do a standard suspend. */
 828         if (udev->dev.driver == NULL) {
 829                 udev->do_remote_wakeup = 0;
 830                 status = usb_port_suspend(udev);
 831                 goto done;
 832         }
 833
 834         udriver = to_usb_device_driver(udev->dev.driver);
 835         status = udriver->suspend(udev, msg);
 836
 837 done:
 838         // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
 839         if (status == 0)
 840                 udev->dev.power.power_state.event = msg.event;
 841         return status;
 842 }
 843
 844 /* Caller has locked udev's pm_mutex */
 845 static int usb_resume_device(struct usb_device *udev)
 846 {
 847         struct usb_device_driver        *udriver;
 848         int                             status = 0;
 849
 850         if (udev->state == USB_STATE_NOTATTACHED ||
 851                         udev->state != USB_STATE_SUSPENDED)
 852                 goto done;
 853
 854         /* Can't resume it if it doesn't have a driver. */
 855         if (udev->dev.driver == NULL) {
 856                 status = -ENOTCONN;
 857                 goto done;
 858         }
 859
 860         udriver = to_usb_device_driver(udev->dev.driver);
 861         status = udriver->resume(udev);
 862
 863 done:
 864         // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
 865         if (status == 0)
 866                 udev->dev.power.power_state.event = PM_EVENT_ON;
 867         return status;
 868 }
 869
 870 /* Caller has locked intf's usb_device's pm mutex */
 871 static int usb_suspend_interface(struct usb_interface *intf, pm_message_t msg)
 872 {
 873         struct usb_driver       *driver;
 874         int                     status = 0;
 875
 876         /* with no hardware, USB interfaces only use FREEZE and ON states */
 877         if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
 878                         !is_active(intf))
 879                 goto done;
 880
 881         if (intf->condition == USB_INTERFACE_UNBOUND)   /* This can't happen */
 882                 goto done;
 883         driver = to_usb_driver(intf->dev.driver);
 884
 885         if (driver->suspend && driver->resume) {
 886                 status = driver->suspend(intf, msg);
 887                 if (status == 0)
 888                         mark_quiesced(intf);
 889                 else if (!interface_to_usbdev(intf)->auto_pm)
 890                         dev_err(&intf->dev, "%s error %d\n",
 891                                         "suspend", status);
 892         } else {
 893                 // FIXME else if there's no suspend method, disconnect...
 894                 // Not possible if auto_pm is set...
 895                 dev_warn(&intf->dev, "no suspend for driver %s?\n",
 896                                 driver->name);
 897                 mark_quiesced(intf);
 898         }
 899
 900 done:
 901         // dev_dbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
 902         if (status == 0)
 903                 intf->dev.power.power_state.event = msg.event;
 904         return status;
 905 }
 906
 907 /* Caller has locked intf's usb_device's pm_mutex */
 908 static int usb_resume_interface(struct usb_interface *intf)
 909 {
 910         struct usb_driver       *driver;
 911         int                     status = 0;
 912
 913         if (interface_to_usbdev(intf)->state == USB_STATE_NOTATTACHED ||
 914                         is_active(intf))
 915                 goto done;
 916
 917         /* Don't let autoresume interfere with unbinding */
 918         if (intf->condition == USB_INTERFACE_UNBINDING)
 919                 goto done;
 920
 921         /* Can't resume it if it doesn't have a driver. */
 922         if (intf->condition == USB_INTERFACE_UNBOUND) {
 923                 status = -ENOTCONN;
 924                 goto done;
 925         }
 926         driver = to_usb_driver(intf->dev.driver);
 927
 928         if (driver->resume) {
 929                 status = driver->resume(intf);
 930                 if (status)
 931                         dev_err(&intf->dev, "%s error %d\n",
 932                                         "resume", status);
 933                 else
 934                         mark_active(intf);
 935         } else {
 936                 dev_warn(&intf->dev, "no resume for driver %s?\n",
 937                                 driver->name);
 938                 mark_active(intf);
 939         }
 940
 941 done:
 942         // dev_dbg(&intf->dev, "%s: status %d\n", __FUNCTION__, status);
 943         if (status == 0)
 944                 intf->dev.power.power_state.event = PM_EVENT_ON;
 945         return status;
 946 }
 947
 948 #ifdef  CONFIG_USB_SUSPEND
 949
 950 /* Internal routine to check whether we may autosuspend a device. */
 951 static int autosuspend_check(struct usb_device *udev)
 952 {
 953         int                     i;
 954         struct usb_interface    *intf;
 955
 956         /* For autosuspend, fail fast if anything is in use.
 957          * Also fail if any interfaces require remote wakeup but it
 958          * isn't available. */
 959         udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
 960         if (udev->pm_usage_cnt > 0)
 961                 return -EBUSY;
 962         if (udev->actconfig) {
 963                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
 964                         intf = udev->actconfig->interface[i];
 965                         if (!is_active(intf))
 966                                 continue;
 967                         if (intf->pm_usage_cnt > 0)
 968                                 return -EBUSY;
 969                         if (intf->needs_remote_wakeup &&
 970                                         !udev->do_remote_wakeup) {
 971                                 dev_dbg(&udev->dev, "remote wakeup needed "
 972                                                 "for autosuspend\n");
 973                                 return -EOPNOTSUPP;
 974                         }
 975                 }
 976         }
 977         return 0;
 978 }
 979
 980 #else
 981
 982 #define autosuspend_check(udev)         0
 983
 984 #endif
 985
 986 /**
 987  * usb_suspend_both - suspend a USB device and its interfaces
 988  * @udev: the usb_device to suspend
 989  * @msg: Power Management message describing this state transition
 990  *
 991  * This is the central routine for suspending USB devices.  It calls the
 992  * suspend methods for all the interface drivers in @udev and then calls
 993  * the suspend method for @udev itself.  If an error occurs at any stage,
 994  * all the interfaces which were suspended are resumed so that they remain
 995  * in the same state as the device.
 996  *
 997  * If an autosuspend is in progress (@udev->auto_pm is set), the routine
 998  * checks first to make sure that neither the device itself or any of its
 999  * active interfaces is in use (pm_usage_cnt is greater than 0).  If they
1000  * are, the autosuspend fails.
1001  *
1002  * If the suspend succeeds, the routine recursively queues an autosuspend
1003  * request for @udev's parent device, thereby propagating the change up
1004  * the device tree.  If all of the parent's children are now suspended,
1005  * the parent will autosuspend in turn.
1006  *
1007  * The suspend method calls are subject to mutual exclusion under control
1008  * of @udev's pm_mutex.  Many of these calls are also under the protection
1009  * of @udev's device lock (including all requests originating outside the
1010  * USB subsystem), but autosuspend requests generated by a child device or
1011  * interface driver may not be.  Usbcore will insure that the method calls
1012  * do not arrive during bind, unbind, or reset operations.  However, drivers
1013  * must be prepared to handle suspend calls arriving at unpredictable times.
1014  * The only way to block such calls is to do an autoresume (preventing
1015  * autosuspends) while holding @udev's device lock (preventing outside
1016  * suspends).
1017  *
1018  * The caller must hold @udev->pm_mutex.
1019  *
1020  * This routine can run only in process context.
1021  */
1022 int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1023 {
1024         int                     status = 0;
1025         int                     i = 0;
1026         struct usb_interface    *intf;
1027         struct usb_device       *parent = udev->parent;
1028
1029         cancel_delayed_work(&udev->autosuspend);
1030         if (udev->state == USB_STATE_NOTATTACHED)
1031                 return 0;
1032         if (udev->state == USB_STATE_SUSPENDED)
1033                 return 0;
1034
1035         udev->do_remote_wakeup = device_may_wakeup(&udev->dev);
1036
1037         if (udev->auto_pm) {
1038                 status = autosuspend_check(udev);
1039                 if (status < 0)
1040                         return status;
1041         }
1042
1043         /* Suspend all the interfaces and then udev itself */
1044         if (udev->actconfig) {
1045                 for (; i < udev->actconfig->desc.bNumInterfaces; i++) {
1046                         intf = udev->actconfig->interface[i];
1047                         status = usb_suspend_interface(intf, msg);
1048                         if (status != 0)
1049                                 break;
1050                 }
1051         }
1052         if (status == 0)
1053                 status = usb_suspend_device(udev, msg);
1054
1055         /* If the suspend failed, resume interfaces that did get suspended */
1056         if (status != 0) {
1057                 while (--i >= 0) {
1058                         intf = udev->actconfig->interface[i];
1059                         usb_resume_interface(intf);
1060                 }
1061
1062         /* If the suspend succeeded, propagate it up the tree */
1063         } else if (parent)
1064                 usb_autosuspend_device(parent);
1065
1066         // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
1067         return status;
1068 }
1069
1070 /**
1071  * usb_resume_both - resume a USB device and its interfaces
1072  * @udev: the usb_device to resume
1073  *
1074  * This is the central routine for resuming USB devices.  It calls the
1075  * the resume method for @udev and then calls the resume methods for all
1076  * the interface drivers in @udev.
1077  *
1078  * Before starting the resume, the routine calls itself recursively for
1079  * the parent device of @udev, thereby propagating the change up the device
1080  * tree and assuring that @udev will be able to resume.  If the parent is
1081  * unable to resume successfully, the routine fails.
1082  *
1083  * The resume method calls are subject to mutual exclusion under control
1084  * of @udev's pm_mutex.  Many of these calls are also under the protection
1085  * of @udev's device lock (including all requests originating outside the
1086  * USB subsystem), but autoresume requests generated by a child device or
1087  * interface driver may not be.  Usbcore will insure that the method calls
1088  * do not arrive during bind, unbind, or reset operations.  However, drivers
1089  * must be prepared to handle resume calls arriving at unpredictable times.
1090  * The only way to block such calls is to do an autoresume (preventing
1091  * other autoresumes) while holding @udev's device lock (preventing outside
1092  * resumes).
1093  *
1094  * The caller must hold @udev->pm_mutex.
1095  *
1096  * This routine can run only in process context.
1097  */
1098 int usb_resume_both(struct usb_device *udev)
1099 {
1100         int                     status = 0;
1101         int                     i;
1102         struct usb_interface    *intf;
1103         struct usb_device       *parent = udev->parent;
1104
1105         cancel_delayed_work(&udev->autosuspend);
1106         if (udev->state == USB_STATE_NOTATTACHED)
1107                 return -ENODEV;
1108
1109         /* Propagate the resume up the tree, if necessary */
1110         if (udev->state == USB_STATE_SUSPENDED) {
1111                 if (parent) {
1112                         status = usb_autoresume_device(parent);
1113                         if (status == 0) {
1114                                 status = usb_resume_device(udev);
1115                                 if (status) {
1116                                         usb_autosuspend_device(parent);
1117
1118                                         /* It's possible usb_resume_device()
1119                                          * failed after the port was
1120                                          * unsuspended, causing udev to be
1121                                          * logically disconnected.  We don't
1122                                          * want usb_disconnect() to autosuspend
1123                                          * the parent again, so tell it that
1124                                          * udev disconnected while still
1125                                          * suspended. */
1126                                         if (udev->state ==
1127                                                         USB_STATE_NOTATTACHED)
1128                                                 udev->discon_suspended = 1;
1129                                 }
1130                         }
1131                 } else {
1132
1133                         /* We can't progagate beyond the USB subsystem,
1134                          * so if a root hub's controller is suspended
1135                          * then we're stuck. */
1136                         if (udev->dev.parent->power.power_state.event !=
1137                                         PM_EVENT_ON)
1138                                 status = -EHOSTUNREACH;
1139                         else
1140                                 status = usb_resume_device(udev);
1141                 }
1142         } else {
1143
1144                 /* Needed only for setting udev->dev.power.power_state.event
1145                  * and for possible debugging message. */
1146                 status = usb_resume_device(udev);
1147         }
1148
1149         if (status == 0 && udev->actconfig) {
1150                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1151                         intf = udev->actconfig->interface[i];
1152                         usb_resume_interface(intf);
1153                 }
1154         }
1155
1156         // dev_dbg(&udev->dev, "%s: status %d\n", __FUNCTION__, status);
1157         return status;
1158 }
1159
1160 #ifdef CONFIG_USB_SUSPEND
1161
1162 /* Internal routine to adjust a device's usage counter and change
1163  * its autosuspend state.
1164  */
1165 static int usb_autopm_do_device(struct usb_device *udev, int inc_usage_cnt)
1166 {
1167         int     status = 0;
1168
1169         usb_pm_lock(udev);
1170         udev->pm_usage_cnt += inc_usage_cnt;
1171         WARN_ON(udev->pm_usage_cnt < 0);
1172         if (inc_usage_cnt >= 0 && udev->pm_usage_cnt > 0) {
1173                 udev->auto_pm = 1;
1174                 status = usb_resume_both(udev);
1175                 if (status != 0)
1176                         udev->pm_usage_cnt -= inc_usage_cnt;
1177         } else if (inc_usage_cnt <= 0 && autosuspend_check(udev) == 0)
1178                 queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
1179                                 USB_AUTOSUSPEND_DELAY);
1180         usb_pm_unlock(udev);
1181         return status;
1182 }
1183
1184 /**
1185  * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1186  * @udev: the usb_device to autosuspend
1187  *
1188  * This routine should be called when a core subsystem is finished using
1189  * @udev and wants to allow it to autosuspend.  Examples would be when
1190  * @udev's device file in usbfs is closed or after a configuration change.
1191  *
1192  * @udev's usage counter is decremented.  If it or any of the usage counters
1193  * for an active interface is greater than 0, no autosuspend request will be
1194  * queued.  (If an interface driver does not support autosuspend then its
1195  * usage counter is permanently positive.)  Furthermore, if an interface
1196  * driver requires remote-wakeup capability during autosuspend but remote
1197  * wakeup is disabled, the autosuspend will fail.
1198  *
1199  * Often the caller will hold @udev's device lock, but this is not
1200  * necessary.
1201  *
1202  * This routine can run only in process context.
1203  */
1204 void usb_autosuspend_device(struct usb_device *udev)
1205 {
1206         int     status;
1207
1208         status = usb_autopm_do_device(udev, -1);
1209         // dev_dbg(&udev->dev, "%s: cnt %d\n",
1210         //              __FUNCTION__, udev->pm_usage_cnt);
1211 }
1212
1213 /**
1214  * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1215  * @udev: the usb_device to autoresume
1216  *
1217  * This routine should be called when a core subsystem wants to use @udev
1218  * and needs to guarantee that it is not suspended.  No autosuspend will
1219  * occur until usb_autosuspend_device is called.  (Note that this will not
1220  * prevent suspend events originating in the PM core.)  Examples would be
1221  * when @udev's device file in usbfs is opened or when a remote-wakeup
1222  * request is received.
1223  *
1224  * @udev's usage counter is incremented to prevent subsequent autosuspends.
1225  * However if the autoresume fails then the usage counter is re-decremented.
1226  *
1227  * Often the caller will hold @udev's device lock, but this is not
1228  * necessary (and attempting it might cause deadlock).
1229  *
1230  * This routine can run only in process context.
1231  */
1232 int usb_autoresume_device(struct usb_device *udev)
1233 {
1234         int     status;
1235
1236         status = usb_autopm_do_device(udev, 1);
1237         // dev_dbg(&udev->dev, "%s: status %d cnt %d\n",
1238         //              __FUNCTION__, status, udev->pm_usage_cnt);
1239         return status;
1240 }
1241
1242 /* Internal routine to adjust an interface's usage counter and change
1243  * its device's autosuspend state.
1244  */
1245 static int usb_autopm_do_interface(struct usb_interface *intf,
1246                 int inc_usage_cnt)
1247 {
1248         struct usb_device       *udev = interface_to_usbdev(intf);
1249         int                     status = 0;
1250
1251         usb_pm_lock(udev);
1252         if (intf->condition == USB_INTERFACE_UNBOUND)
1253                 status = -ENODEV;
1254         else {
1255                 intf->pm_usage_cnt += inc_usage_cnt;
1256                 if (inc_usage_cnt >= 0 && intf->pm_usage_cnt > 0) {
1257                         udev->auto_pm = 1;
1258                         status = usb_resume_both(udev);
1259                         if (status != 0)
1260                                 intf->pm_usage_cnt -= inc_usage_cnt;
1261                 } else if (inc_usage_cnt <= 0 && autosuspend_check(udev) == 0)
1262                         queue_delayed_work(ksuspend_usb_wq, &udev->autosuspend,
1263                                         USB_AUTOSUSPEND_DELAY);
1264         }
1265         usb_pm_unlock(udev);
1266         return status;
1267 }
1268
1269 /**
1270  * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1271  * @intf: the usb_interface whose counter should be decremented
1272  *
1273  * This routine should be called by an interface driver when it is
1274  * finished using @intf and wants to allow it to autosuspend.  A typical
1275  * example would be a character-device driver when its device file is
1276  * closed.
1277  *
1278  * The routine decrements @intf's usage counter.  When the counter reaches
1279  * 0, a delayed autosuspend request for @intf's device is queued.  When
1280  * the delay expires, if @intf->pm_usage_cnt is still <= 0 along with all
1281  * the other usage counters for the sibling interfaces and @intf's
1282  * usb_device, the device and all its interfaces will be autosuspended.
1283  *
1284  * Note that @intf->pm_usage_cnt is owned by the interface driver.  The
1285  * core will not change its value other than the increment and decrement
1286  * in usb_autopm_get_interface and usb_autopm_put_interface.  The driver
1287  * may use this simple counter-oriented discipline or may set the value
1288  * any way it likes.
1289  *
1290  * If the driver has set @intf->needs_remote_wakeup then autosuspend will
1291  * take place only if the device's remote-wakeup facility is enabled.
1292  *
1293  * Suspend method calls queued by this routine can arrive at any time
1294  * while @intf is resumed and its usage counter is equal to 0.  They are
1295  * not protected by the usb_device's lock but only by its pm_mutex.
1296  * Drivers must provide their own synchronization.
1297  *
1298  * This routine can run only in process context.
1299  */
1300 void usb_autopm_put_interface(struct usb_interface *intf)
1301 {
1302         int     status;
1303
1304         status = usb_autopm_do_interface(intf, -1);
1305         // dev_dbg(&intf->dev, "%s: status %d cnt %d\n",
1306         //              __FUNCTION__, status, intf->pm_usage_cnt);
1307 }
1308 EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1309
1310 /**
1311  * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1312  * @intf: the usb_interface whose counter should be incremented
1313  *
1314  * This routine should be called by an interface driver when it wants to
1315  * use @intf and needs to guarantee that it is not suspended.  In addition,
1316  * the routine prevents @intf from being autosuspended subsequently.  (Note
1317  * that this will not prevent suspend events originating in the PM core.)
1318  * This prevention will persist until usb_autopm_put_interface() is called
1319  * or @intf is unbound.  A typical example would be a character-device
1320  * driver when its device file is opened.
1321  *
1322  * The routine increments @intf's usage counter.  So long as the counter
1323  * is greater than 0, autosuspend will not be allowed for @intf or its
1324  * usb_device.  When the driver is finished using @intf it should call
1325  * usb_autopm_put_interface() to decrement the usage counter and queue
1326  * a delayed autosuspend request (if the counter is <= 0).
1327  *
1328  * Note that @intf->pm_usage_cnt is owned by the interface driver.  The
1329  * core will not change its value other than the increment and decrement
1330  * in usb_autopm_get_interface and usb_autopm_put_interface.  The driver
1331  * may use this simple counter-oriented discipline or may set the value
1332  * any way it likes.
1333  *
1334  * Resume method calls generated by this routine can arrive at any time
1335  * while @intf is suspended.  They are not protected by the usb_device's
1336  * lock but only by its pm_mutex.  Drivers must provide their own
1337  * synchronization.
1338  *
1339  * This routine can run only in process context.
1340  */
1341 int usb_autopm_get_interface(struct usb_interface *intf)
1342 {
1343         int     status;
1344
1345         status = usb_autopm_do_interface(intf, 1);
1346         // dev_dbg(&intf->dev, "%s: status %d cnt %d\n",
1347         //              __FUNCTION__, status, intf->pm_usage_cnt);
1348         return status;
1349 }
1350 EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1351
1352 /**
1353  * usb_autopm_set_interface - set a USB interface's autosuspend state
1354  * @intf: the usb_interface whose state should be set
1355  *
1356  * This routine sets the autosuspend state of @intf's device according
1357  * to @intf's usage counter, which the caller must have set previously.
1358  * If the counter is <= 0, the device is autosuspended (if it isn't
1359  * already suspended and if nothing else prevents the autosuspend).  If
1360  * the counter is > 0, the device is autoresumed (if it isn't already
1361  * awake).
1362  */
1363 int usb_autopm_set_interface(struct usb_interface *intf)
1364 {
1365         int     status;
1366
1367         status = usb_autopm_do_interface(intf, 0);
1368         // dev_dbg(&intf->dev, "%s: status %d cnt %d\n",
1369         //              __FUNCTION__, status, intf->pm_usage_cnt);
1370         return status;
1371 }
1372 EXPORT_SYMBOL_GPL(usb_autopm_set_interface);
1373
1374 #endif /* CONFIG_USB_SUSPEND */
1375
1376 static int usb_suspend(struct device *dev, pm_message_t message)
1377 {
1378         int     status;
1379
1380         if (is_usb_device(dev)) {
1381                 struct usb_device *udev = to_usb_device(dev);
1382
1383                 usb_pm_lock(udev);
1384                 udev->auto_pm = 0;
1385                 status = usb_suspend_both(udev, message);
1386                 usb_pm_unlock(udev);
1387         } else
1388                 status = 0;
1389         return status;
1390 }
1391
1392 static int usb_resume(struct device *dev)
1393 {
1394         int     status;
1395
1396         if (is_usb_device(dev)) {
1397                 struct usb_device *udev = to_usb_device(dev);
1398
1399                 usb_pm_lock(udev);
1400                 udev->auto_pm = 0;
1401                 status = usb_resume_both(udev);
1402                 usb_pm_unlock(udev);
1403
1404                 /* Rebind drivers that had no suspend method? */
1405         } else
1406                 status = 0;
1407         return status;
1408 }
1409
1410 #endif /* CONFIG_PM */
1411
1412 struct bus_type usb_bus_type = {
1413         .name =         "usb",
1414         .match =        usb_device_match,
1415         .uevent =       usb_uevent,
1416 #ifdef CONFIG_PM
1417         .suspend =      usb_suspend,
1418         .resume =       usb_resume,
1419 #endif
1420 };