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