drivers/usb/core/driver.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * drivers/usb/driver.c - most of the driver model stuff for usb
   4  *
   5  * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de>
   6  *
   7  * based on drivers/usb/usb.c which had the following copyrights:
   8  *      (C) Copyright Linus Torvalds 1999
   9  *      (C) Copyright Johannes Erdfelt 1999-2001
  10  *      (C) Copyright Andreas Gal 1999
  11  *      (C) Copyright Gregory P. Smith 1999
  12  *      (C) Copyright Deti Fliegl 1999 (new USB architecture)
  13  *      (C) Copyright Randy Dunlap 2000
  14  *      (C) Copyright David Brownell 2000-2004
  15  *      (C) Copyright Yggdrasil Computing, Inc. 2000
  16  *              (usb_device_id matching changes by Adam J. Richter)
  17  *      (C) Copyright Greg Kroah-Hartman 2002-2003
  18  *
  19  * Released under the GPLv2 only.
  20  *
  21  * NOTE! This is not actually a driver at all, rather this is
  22  * just a collection of helper routines that implement the
  23  * matching, probing, releasing, suspending and resuming for
  24  * real drivers.
  25  *
  26  */
  27
  28 #include <linux/device.h>
  29 #include <linux/slab.h>
  30 #include <linux/export.h>
  31 #include <linux/usb.h>
  32 #include <linux/usb/quirks.h>
  33 #include <linux/usb/hcd.h>
  34
  35 #include "usb.h"
  36
  37
  38 /*
  39  * Adds a new dynamic USBdevice ID to this driver,
  40  * and cause the driver to probe for all devices again.
  41  */
  42 ssize_t usb_store_new_id(struct usb_dynids *dynids,
  43                          const struct usb_device_id *id_table,
  44                          struct device_driver *driver,
  45                          const char *buf, size_t count)
  46 {
  47         struct usb_dynid *dynid;
  48         u32 idVendor = 0;
  49         u32 idProduct = 0;
  50         unsigned int bInterfaceClass = 0;
  51         u32 refVendor, refProduct;
  52         int fields = 0;
  53         int retval = 0;
  54
  55         fields = sscanf(buf, "%x %x %x %x %x", &idVendor, &idProduct,
  56                         &bInterfaceClass, &refVendor, &refProduct);
  57         if (fields < 2)
  58                 return -EINVAL;
  59
  60         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
  61         if (!dynid)
  62                 return -ENOMEM;
  63
  64         INIT_LIST_HEAD(&dynid->node);
  65         dynid->id.idVendor = idVendor;
  66         dynid->id.idProduct = idProduct;
  67         dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
  68         if (fields > 2 && bInterfaceClass) {
  69                 if (bInterfaceClass > 255) {
  70                         retval = -EINVAL;
  71                         goto fail;
  72                 }
  73
  74                 dynid->id.bInterfaceClass = (u8)bInterfaceClass;
  75                 dynid->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
  76         }
  77
  78         if (fields > 4) {
  79                 const struct usb_device_id *id = id_table;
  80
  81                 if (!id) {
  82                         retval = -ENODEV;
  83                         goto fail;
  84                 }
  85
  86                 for (; id->match_flags; id++)
  87                         if (id->idVendor == refVendor && id->idProduct == refProduct)
  88                                 break;
  89
  90                 if (id->match_flags) {
  91                         dynid->id.driver_info = id->driver_info;
  92                 } else {
  93                         retval = -ENODEV;
  94                         goto fail;
  95                 }
  96         }
  97
  98         spin_lock(&dynids->lock);
  99         list_add_tail(&dynid->node, &dynids->list);
 100         spin_unlock(&dynids->lock);
 101
 102         retval = driver_attach(driver);
 103
 104         if (retval)
 105                 return retval;
 106         return count;
 107
 108 fail:
 109         kfree(dynid);
 110         return retval;
 111 }
 112 EXPORT_SYMBOL_GPL(usb_store_new_id);
 113
 114 ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf)
 115 {
 116         struct usb_dynid *dynid;
 117         size_t count = 0;
 118
 119         list_for_each_entry(dynid, &dynids->list, node)
 120                 if (dynid->id.bInterfaceClass != 0)
 121                         count += scnprintf(&buf[count], PAGE_SIZE - count, "%04x %04x %02x\n",
 122                                            dynid->id.idVendor, dynid->id.idProduct,
 123                                            dynid->id.bInterfaceClass);
 124                 else
 125                         count += scnprintf(&buf[count], PAGE_SIZE - count, "%04x %04x\n",
 126                                            dynid->id.idVendor, dynid->id.idProduct);
 127         return count;
 128 }
 129 EXPORT_SYMBOL_GPL(usb_show_dynids);
 130
 131 static ssize_t new_id_show(struct device_driver *driver, char *buf)
 132 {
 133         struct usb_driver *usb_drv = to_usb_driver(driver);
 134
 135         return usb_show_dynids(&usb_drv->dynids, buf);
 136 }
 137
 138 static ssize_t new_id_store(struct device_driver *driver,
 139                             const char *buf, size_t count)
 140 {
 141         struct usb_driver *usb_drv = to_usb_driver(driver);
 142
 143         return usb_store_new_id(&usb_drv->dynids, usb_drv->id_table, driver, buf, count);
 144 }
 145 static DRIVER_ATTR_RW(new_id);
 146
 147 /*
 148  * Remove a USB device ID from this driver
 149  */
 150 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
 151                                size_t count)
 152 {
 153         struct usb_dynid *dynid, *n;
 154         struct usb_driver *usb_driver = to_usb_driver(driver);
 155         u32 idVendor;
 156         u32 idProduct;
 157         int fields;
 158
 159         fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
 160         if (fields < 2)
 161                 return -EINVAL;
 162
 163         spin_lock(&usb_driver->dynids.lock);
 164         list_for_each_entry_safe(dynid, n, &usb_driver->dynids.list, node) {
 165                 struct usb_device_id *id = &dynid->id;
 166
 167                 if ((id->idVendor == idVendor) &&
 168                     (id->idProduct == idProduct)) {
 169                         list_del(&dynid->node);
 170                         kfree(dynid);
 171                         break;
 172                 }
 173         }
 174         spin_unlock(&usb_driver->dynids.lock);
 175         return count;
 176 }
 177
 178 static ssize_t remove_id_show(struct device_driver *driver, char *buf)
 179 {
 180         return new_id_show(driver, buf);
 181 }
 182 static DRIVER_ATTR_RW(remove_id);
 183
 184 static int usb_create_newid_files(struct usb_driver *usb_drv)
 185 {
 186         int error = 0;
 187
 188         if (usb_drv->no_dynamic_id)
 189                 goto exit;
 190
 191         if (usb_drv->probe != NULL) {
 192                 error = driver_create_file(&usb_drv->drvwrap.driver,
 193                                            &driver_attr_new_id);
 194                 if (error == 0) {
 195                         error = driver_create_file(&usb_drv->drvwrap.driver,
 196                                         &driver_attr_remove_id);
 197                         if (error)
 198                                 driver_remove_file(&usb_drv->drvwrap.driver,
 199                                                 &driver_attr_new_id);
 200                 }
 201         }
 202 exit:
 203         return error;
 204 }
 205
 206 static void usb_remove_newid_files(struct usb_driver *usb_drv)
 207 {
 208         if (usb_drv->no_dynamic_id)
 209                 return;
 210
 211         if (usb_drv->probe != NULL) {
 212                 driver_remove_file(&usb_drv->drvwrap.driver,
 213                                 &driver_attr_remove_id);
 214                 driver_remove_file(&usb_drv->drvwrap.driver,
 215                                    &driver_attr_new_id);
 216         }
 217 }
 218
 219 static void usb_free_dynids(struct usb_driver *usb_drv)
 220 {
 221         struct usb_dynid *dynid, *n;
 222
 223         spin_lock(&usb_drv->dynids.lock);
 224         list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
 225                 list_del(&dynid->node);
 226                 kfree(dynid);
 227         }
 228         spin_unlock(&usb_drv->dynids.lock);
 229 }
 230
 231 static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
 232                                                         struct usb_driver *drv)
 233 {
 234         struct usb_dynid *dynid;
 235
 236         spin_lock(&drv->dynids.lock);
 237         list_for_each_entry(dynid, &drv->dynids.list, node) {
 238                 if (usb_match_one_id(intf, &dynid->id)) {
 239                         spin_unlock(&drv->dynids.lock);
 240                         return &dynid->id;
 241                 }
 242         }
 243         spin_unlock(&drv->dynids.lock);
 244         return NULL;
 245 }
 246
 247
 248 /* called from driver core with dev locked */
 249 static int usb_probe_device(struct device *dev)
 250 {
 251         struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
 252         struct usb_device *udev = to_usb_device(dev);
 253         int error = 0;
 254
 255         dev_dbg(dev, "%s\n", __func__);
 256
 257         /* TODO: Add real matching code */
 258
 259         /* The device should always appear to be in use
 260          * unless the driver supports autosuspend.
 261          */
 262         if (!udriver->supports_autosuspend)
 263                 error = usb_autoresume_device(udev);
 264         if (error)
 265                 return error;
 266
 267         if (udriver->generic_subclass)
 268                 error = usb_generic_driver_probe(udev);
 269         if (error)
 270                 return error;
 271
 272         /* Probe the USB device with the driver in hand, but only
 273          * defer to a generic driver in case the current USB
 274          * device driver has an id_table or a match function; i.e.,
 275          * when the device driver was explicitly matched against
 276          * a device.
 277          *
 278          * If the device driver does not have either of these,
 279          * then we assume that it can bind to any device and is
 280          * not truly a more specialized/non-generic driver, so a
 281          * return value of -ENODEV should not force the device
 282          * to be handled by the generic USB driver, as there
 283          * can still be another, more specialized, device driver.
 284          *
 285          * This accommodates the usbip driver.
 286          *
 287          * TODO: What if, in the future, there are multiple
 288          * specialized USB device drivers for a particular device?
 289          * In such cases, there is a need to try all matching
 290          * specialised device drivers prior to setting the
 291          * use_generic_driver bit.
 292          */
 293         error = udriver->probe(udev);
 294         if (error == -ENODEV && udriver != &usb_generic_driver &&
 295             (udriver->id_table || udriver->match)) {
 296                 udev->use_generic_driver = 1;
 297                 return -EPROBE_DEFER;
 298         }
 299         return error;
 300 }
 301
 302 /* called from driver core with dev locked */
 303 static int usb_unbind_device(struct device *dev)
 304 {
 305         struct usb_device *udev = to_usb_device(dev);
 306         struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
 307
 308         if (udriver->disconnect)
 309                 udriver->disconnect(udev);
 310         if (udriver->generic_subclass)
 311                 usb_generic_driver_disconnect(udev);
 312         if (!udriver->supports_autosuspend)
 313                 usb_autosuspend_device(udev);
 314         return 0;
 315 }
 316
 317 /* called from driver core with dev locked */
 318 static int usb_probe_interface(struct device *dev)
 319 {
 320         struct usb_driver *driver = to_usb_driver(dev->driver);
 321         struct usb_interface *intf = to_usb_interface(dev);
 322         struct usb_device *udev = interface_to_usbdev(intf);
 323         const struct usb_device_id *id;
 324         int error = -ENODEV;
 325         int lpm_disable_error = -ENODEV;
 326
 327         dev_dbg(dev, "%s\n", __func__);
 328
 329         intf->needs_binding = 0;
 330
 331         if (usb_device_is_owned(udev))
 332                 return error;
 333
 334         if (udev->authorized == 0) {
 335                 dev_err(&intf->dev, "Device is not authorized for usage\n");
 336                 return error;
 337         } else if (intf->authorized == 0) {
 338                 dev_err(&intf->dev, "Interface %d is not authorized for usage\n",
 339                                 intf->altsetting->desc.bInterfaceNumber);
 340                 return error;
 341         }
 342
 343         id = usb_match_dynamic_id(intf, driver);
 344         if (!id)
 345                 id = usb_match_id(intf, driver->id_table);
 346         if (!id)
 347                 return error;
 348
 349         dev_dbg(dev, "%s - got id\n", __func__);
 350
 351         error = usb_autoresume_device(udev);
 352         if (error)
 353                 return error;
 354
 355         intf->condition = USB_INTERFACE_BINDING;
 356
 357         /* Probed interfaces are initially active.  They are
 358          * runtime-PM-enabled only if the driver has autosuspend support.
 359          * They are sensitive to their children's power states.
 360          */
 361         pm_runtime_set_active(dev);
 362         pm_suspend_ignore_children(dev, false);
 363         if (driver->supports_autosuspend)
 364                 pm_runtime_enable(dev);
 365
 366         /* If the new driver doesn't allow hub-initiated LPM, and we can't
 367          * disable hub-initiated LPM, then fail the probe.
 368          *
 369          * Otherwise, leaving LPM enabled should be harmless, because the
 370          * endpoint intervals should remain the same, and the U1/U2 timeouts
 371          * should remain the same.
 372          *
 373          * If we need to install alt setting 0 before probe, or another alt
 374          * setting during probe, that should also be fine.  usb_set_interface()
 375          * will attempt to disable LPM, and fail if it can't disable it.
 376          */
 377         if (driver->disable_hub_initiated_lpm) {
 378                 lpm_disable_error = usb_unlocked_disable_lpm(udev);
 379                 if (lpm_disable_error) {
 380                         dev_err(&intf->dev, "%s Failed to disable LPM for driver %s\n",
 381                                 __func__, driver->name);
 382                         error = lpm_disable_error;
 383                         goto err;
 384                 }
 385         }
 386
 387         /* Carry out a deferred switch to altsetting 0 */
 388         if (intf->needs_altsetting0) {
 389                 error = usb_set_interface(udev, intf->altsetting[0].
 390                                 desc.bInterfaceNumber, 0);
 391                 if (error < 0)
 392                         goto err;
 393                 intf->needs_altsetting0 = 0;
 394         }
 395
 396         error = driver->probe(intf, id);
 397         if (error)
 398                 goto err;
 399
 400         intf->condition = USB_INTERFACE_BOUND;
 401
 402         /* If the LPM disable succeeded, balance the ref counts. */
 403         if (!lpm_disable_error)
 404                 usb_unlocked_enable_lpm(udev);
 405
 406         usb_autosuspend_device(udev);
 407         return error;
 408
 409  err:
 410         usb_set_intfdata(intf, NULL);
 411         intf->needs_remote_wakeup = 0;
 412         intf->condition = USB_INTERFACE_UNBOUND;
 413
 414         /* If the LPM disable succeeded, balance the ref counts. */
 415         if (!lpm_disable_error)
 416                 usb_unlocked_enable_lpm(udev);
 417
 418         /* Unbound interfaces are always runtime-PM-disabled and -suspended */
 419         if (driver->supports_autosuspend)
 420                 pm_runtime_disable(dev);
 421         pm_runtime_set_suspended(dev);
 422
 423         usb_autosuspend_device(udev);
 424         return error;
 425 }
 426
 427 /* called from driver core with dev locked */
 428 static int usb_unbind_interface(struct device *dev)
 429 {
 430         struct usb_driver *driver = to_usb_driver(dev->driver);
 431         struct usb_interface *intf = to_usb_interface(dev);
 432         struct usb_host_endpoint *ep, **eps = NULL;
 433         struct usb_device *udev;
 434         int i, j, error, r;
 435         int lpm_disable_error = -ENODEV;
 436
 437         intf->condition = USB_INTERFACE_UNBINDING;
 438
 439         /* Autoresume for set_interface call below */
 440         udev = interface_to_usbdev(intf);
 441         error = usb_autoresume_device(udev);
 442
 443         /* If hub-initiated LPM policy may change, attempt to disable LPM until
 444          * the driver is unbound.  If LPM isn't disabled, that's fine because it
 445          * wouldn't be enabled unless all the bound interfaces supported
 446          * hub-initiated LPM.
 447          */
 448         if (driver->disable_hub_initiated_lpm)
 449                 lpm_disable_error = usb_unlocked_disable_lpm(udev);
 450
 451         /*
 452          * Terminate all URBs for this interface unless the driver
 453          * supports "soft" unbinding and the device is still present.
 454          */
 455         if (!driver->soft_unbind || udev->state == USB_STATE_NOTATTACHED)
 456                 usb_disable_interface(udev, intf, false);
 457
 458         driver->disconnect(intf);
 459
 460         /* Free streams */
 461         for (i = 0, j = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
 462                 ep = &intf->cur_altsetting->endpoint[i];
 463                 if (ep->streams == 0)
 464                         continue;
 465                 if (j == 0) {
 466                         eps = kmalloc_array(USB_MAXENDPOINTS, sizeof(void *),
 467                                       GFP_KERNEL);
 468                         if (!eps)
 469                                 break;
 470                 }
 471                 eps[j++] = ep;
 472         }
 473         if (j) {
 474                 usb_free_streams(intf, eps, j, GFP_KERNEL);
 475                 kfree(eps);
 476         }
 477
 478         /* Reset other interface state.
 479          * We cannot do a Set-Interface if the device is suspended or
 480          * if it is prepared for a system sleep (since installing a new
 481          * altsetting means creating new endpoint device entries).
 482          * When either of these happens, defer the Set-Interface.
 483          */
 484         if (intf->cur_altsetting->desc.bAlternateSetting == 0) {
 485                 /* Already in altsetting 0 so skip Set-Interface.
 486                  * Just re-enable it without affecting the endpoint toggles.
 487                  */
 488                 usb_enable_interface(udev, intf, false);
 489         } else if (!error && !intf->dev.power.is_prepared) {
 490                 r = usb_set_interface(udev, intf->altsetting[0].
 491                                 desc.bInterfaceNumber, 0);
 492                 if (r < 0)
 493                         intf->needs_altsetting0 = 1;
 494         } else {
 495                 intf->needs_altsetting0 = 1;
 496         }
 497         usb_set_intfdata(intf, NULL);
 498
 499         intf->condition = USB_INTERFACE_UNBOUND;
 500         intf->needs_remote_wakeup = 0;
 501
 502         /* Attempt to re-enable USB3 LPM, if the disable succeeded. */
 503         if (!lpm_disable_error)
 504                 usb_unlocked_enable_lpm(udev);
 505
 506         /* Unbound interfaces are always runtime-PM-disabled and -suspended */
 507         if (driver->supports_autosuspend)
 508                 pm_runtime_disable(dev);
 509         pm_runtime_set_suspended(dev);
 510
 511         if (!error)
 512                 usb_autosuspend_device(udev);
 513
 514         return 0;
 515 }
 516
 517 /**
 518  * usb_driver_claim_interface - bind a driver to an interface
 519  * @driver: the driver to be bound
 520  * @iface: the interface to which it will be bound; must be in the
 521  *      usb device's active configuration
 522  * @priv: driver data associated with that interface
 523  *
 524  * This is used by usb device drivers that need to claim more than one
 525  * interface on a device when probing (audio and acm are current examples).
 526  * No device driver should directly modify internal usb_interface or
 527  * usb_device structure members.
 528  *
 529  * Few drivers should need to use this routine, since the most natural
 530  * way to bind to an interface is to return the private data from
 531  * the driver's probe() method.
 532  *
 533  * Callers must own the device lock, so driver probe() entries don't need
 534  * extra locking, but other call contexts may need to explicitly claim that
 535  * lock.
 536  *
 537  * Return: 0 on success.
 538  */
 539 int usb_driver_claim_interface(struct usb_driver *driver,
 540                                 struct usb_interface *iface, void *priv)
 541 {
 542         struct device *dev;
 543         int retval = 0;
 544
 545         if (!iface)
 546                 return -ENODEV;
 547
 548         dev = &iface->dev;
 549         if (dev->driver)
 550                 return -EBUSY;
 551
 552         /* reject claim if interface is not authorized */
 553         if (!iface->authorized)
 554                 return -ENODEV;
 555
 556         dev->driver = &driver->drvwrap.driver;
 557         usb_set_intfdata(iface, priv);
 558         iface->needs_binding = 0;
 559
 560         iface->condition = USB_INTERFACE_BOUND;
 561
 562         /* Claimed interfaces are initially inactive (suspended) and
 563          * runtime-PM-enabled, but only if the driver has autosuspend
 564          * support.  Otherwise they are marked active, to prevent the
 565          * device from being autosuspended, but left disabled.  In either
 566          * case they are sensitive to their children's power states.
 567          */
 568         pm_suspend_ignore_children(dev, false);
 569         if (driver->supports_autosuspend)
 570                 pm_runtime_enable(dev);
 571         else
 572                 pm_runtime_set_active(dev);
 573
 574         /* if interface was already added, bind now; else let
 575          * the future device_add() bind it, bypassing probe()
 576          */
 577         if (device_is_registered(dev))
 578                 retval = device_bind_driver(dev);
 579
 580         if (retval) {
 581                 dev->driver = NULL;
 582                 usb_set_intfdata(iface, NULL);
 583                 iface->needs_remote_wakeup = 0;
 584                 iface->condition = USB_INTERFACE_UNBOUND;
 585
 586                 /*
 587                  * Unbound interfaces are always runtime-PM-disabled
 588                  * and runtime-PM-suspended
 589                  */
 590                 if (driver->supports_autosuspend)
 591                         pm_runtime_disable(dev);
 592                 pm_runtime_set_suspended(dev);
 593         }
 594
 595         return retval;
 596 }
 597 EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
 598
 599 /**
 600  * usb_driver_release_interface - unbind a driver from an interface
 601  * @driver: the driver to be unbound
 602  * @iface: the interface from which it will be unbound
 603  *
 604  * This can be used by drivers to release an interface without waiting
 605  * for their disconnect() methods to be called.  In typical cases this
 606  * also causes the driver disconnect() method to be called.
 607  *
 608  * This call is synchronous, and may not be used in an interrupt context.
 609  * Callers must own the device lock, so driver disconnect() entries don't
 610  * need extra locking, but other call contexts may need to explicitly claim
 611  * that lock.
 612  */
 613 void usb_driver_release_interface(struct usb_driver *driver,
 614                                         struct usb_interface *iface)
 615 {
 616         struct device *dev = &iface->dev;
 617
 618         /* this should never happen, don't release something that's not ours */
 619         if (!dev->driver || dev->driver != &driver->drvwrap.driver)
 620                 return;
 621
 622         /* don't release from within disconnect() */
 623         if (iface->condition != USB_INTERFACE_BOUND)
 624                 return;
 625         iface->condition = USB_INTERFACE_UNBINDING;
 626
 627         /* Release via the driver core only if the interface
 628          * has already been registered
 629          */
 630         if (device_is_registered(dev)) {
 631                 device_release_driver(dev);
 632         } else {
 633                 device_lock(dev);
 634                 usb_unbind_interface(dev);
 635                 dev->driver = NULL;
 636                 device_unlock(dev);
 637         }
 638 }
 639 EXPORT_SYMBOL_GPL(usb_driver_release_interface);
 640
 641 /* returns 0 if no match, 1 if match */
 642 int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
 643 {
 644         if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
 645             id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
 646                 return 0;
 647
 648         if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
 649             id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
 650                 return 0;
 651
 652         /* No need to test id->bcdDevice_lo != 0, since 0 is never
 653            greater than any unsigned number. */
 654         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
 655             (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
 656                 return 0;
 657
 658         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
 659             (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
 660                 return 0;
 661
 662         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
 663             (id->bDeviceClass != dev->descriptor.bDeviceClass))
 664                 return 0;
 665
 666         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
 667             (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
 668                 return 0;
 669
 670         if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
 671             (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
 672                 return 0;
 673
 674         return 1;
 675 }
 676
 677 /* returns 0 if no match, 1 if match */
 678 int usb_match_one_id_intf(struct usb_device *dev,
 679                           struct usb_host_interface *intf,
 680                           const struct usb_device_id *id)
 681 {
 682         /* The interface class, subclass, protocol and number should never be
 683          * checked for a match if the device class is Vendor Specific,
 684          * unless the match record specifies the Vendor ID. */
 685         if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
 686                         !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
 687                         (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
 688                                 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
 689                                 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
 690                                 USB_DEVICE_ID_MATCH_INT_NUMBER)))
 691                 return 0;
 692
 693         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
 694             (id->bInterfaceClass != intf->desc.bInterfaceClass))
 695                 return 0;
 696
 697         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
 698             (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
 699                 return 0;
 700
 701         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
 702             (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
 703                 return 0;
 704
 705         if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
 706             (id->bInterfaceNumber != intf->desc.bInterfaceNumber))
 707                 return 0;
 708
 709         return 1;
 710 }
 711
 712 /* returns 0 if no match, 1 if match */
 713 int usb_match_one_id(struct usb_interface *interface,
 714                      const struct usb_device_id *id)
 715 {
 716         struct usb_host_interface *intf;
 717         struct usb_device *dev;
 718
 719         /* proc_connectinfo in devio.c may call us with id == NULL. */
 720         if (id == NULL)
 721                 return 0;
 722
 723         intf = interface->cur_altsetting;
 724         dev = interface_to_usbdev(interface);
 725
 726         if (!usb_match_device(dev, id))
 727                 return 0;
 728
 729         return usb_match_one_id_intf(dev, intf, id);
 730 }
 731 EXPORT_SYMBOL_GPL(usb_match_one_id);
 732
 733 /**
 734  * usb_match_id - find first usb_device_id matching device or interface
 735  * @interface: the interface of interest
 736  * @id: array of usb_device_id structures, terminated by zero entry
 737  *
 738  * usb_match_id searches an array of usb_device_id's and returns
 739  * the first one matching the device or interface, or null.
 740  * This is used when binding (or rebinding) a driver to an interface.
 741  * Most USB device drivers will use this indirectly, through the usb core,
 742  * but some layered driver frameworks use it directly.
 743  * These device tables are exported with MODULE_DEVICE_TABLE, through
 744  * modutils, to support the driver loading functionality of USB hotplugging.
 745  *
 746  * Return: The first matching usb_device_id, or %NULL.
 747  *
 748  * What Matches:
 749  *
 750  * The "match_flags" element in a usb_device_id controls which
 751  * members are used.  If the corresponding bit is set, the
 752  * value in the device_id must match its corresponding member
 753  * in the device or interface descriptor, or else the device_id
 754  * does not match.
 755  *
 756  * "driver_info" is normally used only by device drivers,
 757  * but you can create a wildcard "matches anything" usb_device_id
 758  * as a driver's "modules.usbmap" entry if you provide an id with
 759  * only a nonzero "driver_info" field.  If you do this, the USB device
 760  * driver's probe() routine should use additional intelligence to
 761  * decide whether to bind to the specified interface.
 762  *
 763  * What Makes Good usb_device_id Tables:
 764  *
 765  * The match algorithm is very simple, so that intelligence in
 766  * driver selection must come from smart driver id records.
 767  * Unless you have good reasons to use another selection policy,
 768  * provide match elements only in related groups, and order match
 769  * specifiers from specific to general.  Use the macros provided
 770  * for that purpose if you can.
 771  *
 772  * The most specific match specifiers use device descriptor
 773  * data.  These are commonly used with product-specific matches;
 774  * the USB_DEVICE macro lets you provide vendor and product IDs,
 775  * and you can also match against ranges of product revisions.
 776  * These are widely used for devices with application or vendor
 777  * specific bDeviceClass values.
 778  *
 779  * Matches based on device class/subclass/protocol specifications
 780  * are slightly more general; use the USB_DEVICE_INFO macro, or
 781  * its siblings.  These are used with single-function devices
 782  * where bDeviceClass doesn't specify that each interface has
 783  * its own class.
 784  *
 785  * Matches based on interface class/subclass/protocol are the
 786  * most general; they let drivers bind to any interface on a
 787  * multiple-function device.  Use the USB_INTERFACE_INFO
 788  * macro, or its siblings, to match class-per-interface style
 789  * devices (as recorded in bInterfaceClass).
 790  *
 791  * Note that an entry created by USB_INTERFACE_INFO won't match
 792  * any interface if the device class is set to Vendor-Specific.
 793  * This is deliberate; according to the USB spec the meanings of
 794  * the interface class/subclass/protocol for these devices are also
 795  * vendor-specific, and hence matching against a standard product
 796  * class wouldn't work anyway.  If you really want to use an
 797  * interface-based match for such a device, create a match record
 798  * that also specifies the vendor ID.  (Unforunately there isn't a
 799  * standard macro for creating records like this.)
 800  *
 801  * Within those groups, remember that not all combinations are
 802  * meaningful.  For example, don't give a product version range
 803  * without vendor and product IDs; or specify a protocol without
 804  * its associated class and subclass.
 805  */
 806 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
 807                                          const struct usb_device_id *id)
 808 {
 809         /* proc_connectinfo in devio.c may call us with id == NULL. */
 810         if (id == NULL)
 811                 return NULL;
 812
 813         /* It is important to check that id->driver_info is nonzero,
 814            since an entry that is all zeroes except for a nonzero
 815            id->driver_info is the way to create an entry that
 816            indicates that the driver want to examine every
 817            device and interface. */
 818         for (; id->idVendor || id->idProduct || id->bDeviceClass ||
 819                id->bInterfaceClass || id->driver_info; id++) {
 820                 if (usb_match_one_id(interface, id))
 821                         return id;
 822         }
 823
 824         return NULL;
 825 }
 826 EXPORT_SYMBOL_GPL(usb_match_id);
 827
 828 const struct usb_device_id *usb_device_match_id(struct usb_device *udev,
 829                                 const struct usb_device_id *id)
 830 {
 831         if (!id)
 832                 return NULL;
 833
 834         for (; id->idVendor || id->idProduct ; id++) {
 835                 if (usb_match_device(udev, id))
 836                         return id;
 837         }
 838
 839         return NULL;
 840 }
 841
 842 static int usb_device_match(struct device *dev, struct device_driver *drv)
 843 {
 844         /* devices and interfaces are handled separately */
 845         if (is_usb_device(dev)) {
 846                 struct usb_device *udev;
 847                 struct usb_device_driver *udrv;
 848
 849                 /* interface drivers never match devices */
 850                 if (!is_usb_device_driver(drv))
 851                         return 0;
 852
 853                 udev = to_usb_device(dev);
 854                 udrv = to_usb_device_driver(drv);
 855
 856                 if (udrv->id_table)
 857                         return usb_device_match_id(udev, udrv->id_table) != NULL;
 858
 859                 if (udrv->match)
 860                         return udrv->match(udev);
 861
 862                 /* If the device driver under consideration does not have a
 863                  * id_table or a match function, then let the driver's probe
 864                  * function decide.
 865                  */
 866                 return 1;
 867
 868         } else if (is_usb_interface(dev)) {
 869                 struct usb_interface *intf;
 870                 struct usb_driver *usb_drv;
 871                 const struct usb_device_id *id;
 872
 873                 /* device drivers never match interfaces */
 874                 if (is_usb_device_driver(drv))
 875                         return 0;
 876
 877                 intf = to_usb_interface(dev);
 878                 usb_drv = to_usb_driver(drv);
 879
 880                 id = usb_match_id(intf, usb_drv->id_table);
 881                 if (id)
 882                         return 1;
 883
 884                 id = usb_match_dynamic_id(intf, usb_drv);
 885                 if (id)
 886                         return 1;
 887         }
 888
 889         return 0;
 890 }
 891
 892 static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
 893 {
 894         struct usb_device *usb_dev;
 895
 896         if (is_usb_device(dev)) {
 897                 usb_dev = to_usb_device(dev);
 898         } else if (is_usb_interface(dev)) {
 899                 struct usb_interface *intf = to_usb_interface(dev);
 900
 901                 usb_dev = interface_to_usbdev(intf);
 902         } else {
 903                 return 0;
 904         }
 905
 906         if (usb_dev->devnum < 0) {
 907                 /* driver is often null here; dev_dbg() would oops */
 908                 pr_debug("usb %s: already deleted?\n", dev_name(dev));
 909                 return -ENODEV;
 910         }
 911         if (!usb_dev->bus) {
 912                 pr_debug("usb %s: bus removed?\n", dev_name(dev));
 913                 return -ENODEV;
 914         }
 915
 916         /* per-device configurations are common */
 917         if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
 918                            le16_to_cpu(usb_dev->descriptor.idVendor),
 919                            le16_to_cpu(usb_dev->descriptor.idProduct),
 920                            le16_to_cpu(usb_dev->descriptor.bcdDevice)))
 921                 return -ENOMEM;
 922
 923         /* class-based driver binding models */
 924         if (add_uevent_var(env, "TYPE=%d/%d/%d",
 925                            usb_dev->descriptor.bDeviceClass,
 926                            usb_dev->descriptor.bDeviceSubClass,
 927                            usb_dev->descriptor.bDeviceProtocol))
 928                 return -ENOMEM;
 929
 930         return 0;
 931 }
 932
 933 static int __usb_bus_reprobe_drivers(struct device *dev, void *data)
 934 {
 935         struct usb_device_driver *new_udriver = data;
 936         struct usb_device *udev;
 937         int ret;
 938
 939         /* Don't reprobe if current driver isn't usb_generic_driver */
 940         if (dev->driver != &usb_generic_driver.drvwrap.driver)
 941                 return 0;
 942
 943         udev = to_usb_device(dev);
 944         if (usb_device_match_id(udev, new_udriver->id_table) == NULL &&
 945             (!new_udriver->match || new_udriver->match(udev) == 0))
 946                 return 0;
 947
 948         ret = device_reprobe(dev);
 949         if (ret && ret != -EPROBE_DEFER)
 950                 dev_err(dev, "Failed to reprobe device (error %d)\n", ret);
 951
 952         return 0;
 953 }
 954
 955 /**
 956  * usb_register_device_driver - register a USB device (not interface) driver
 957  * @new_udriver: USB operations for the device driver
 958  * @owner: module owner of this driver.
 959  *
 960  * Registers a USB device driver with the USB core.  The list of
 961  * unattached devices will be rescanned whenever a new driver is
 962  * added, allowing the new driver to attach to any recognized devices.
 963  *
 964  * Return: A negative error code on failure and 0 on success.
 965  */
 966 int usb_register_device_driver(struct usb_device_driver *new_udriver,
 967                 struct module *owner)
 968 {
 969         int retval = 0;
 970
 971         if (usb_disabled())
 972                 return -ENODEV;
 973
 974         new_udriver->drvwrap.for_devices = 1;
 975         new_udriver->drvwrap.driver.name = new_udriver->name;
 976         new_udriver->drvwrap.driver.bus = &usb_bus_type;
 977         new_udriver->drvwrap.driver.probe = usb_probe_device;
 978         new_udriver->drvwrap.driver.remove = usb_unbind_device;
 979         new_udriver->drvwrap.driver.owner = owner;
 980         new_udriver->drvwrap.driver.dev_groups = new_udriver->dev_groups;
 981
 982         retval = driver_register(&new_udriver->drvwrap.driver);
 983
 984         if (!retval) {
 985                 pr_info("%s: registered new device driver %s\n",
 986                         usbcore_name, new_udriver->name);
 987                 /*
 988                  * Check whether any device could be better served with
 989                  * this new driver
 990                  */
 991                 bus_for_each_dev(&usb_bus_type, NULL, new_udriver,
 992                                  __usb_bus_reprobe_drivers);
 993         } else {
 994                 pr_err("%s: error %d registering device driver %s\n",
 995                         usbcore_name, retval, new_udriver->name);
 996         }
 997
 998         return retval;
 999 }
1000 EXPORT_SYMBOL_GPL(usb_register_device_driver);
1001
1002 /**
1003  * usb_deregister_device_driver - unregister a USB device (not interface) driver
1004  * @udriver: USB operations of the device driver to unregister
1005  * Context: must be able to sleep
1006  *
1007  * Unlinks the specified driver from the internal USB driver list.
1008  */
1009 void usb_deregister_device_driver(struct usb_device_driver *udriver)
1010 {
1011         pr_info("%s: deregistering device driver %s\n",
1012                         usbcore_name, udriver->name);
1013
1014         driver_unregister(&udriver->drvwrap.driver);
1015 }
1016 EXPORT_SYMBOL_GPL(usb_deregister_device_driver);
1017
1018 /**
1019  * usb_register_driver - register a USB interface driver
1020  * @new_driver: USB operations for the interface driver
1021  * @owner: module owner of this driver.
1022  * @mod_name: module name string
1023  *
1024  * Registers a USB interface driver with the USB core.  The list of
1025  * unattached interfaces will be rescanned whenever a new driver is
1026  * added, allowing the new driver to attach to any recognized interfaces.
1027  *
1028  * Return: A negative error code on failure and 0 on success.
1029  *
1030  * NOTE: if you want your driver to use the USB major number, you must call
1031  * usb_register_dev() to enable that functionality.  This function no longer
1032  * takes care of that.
1033  */
1034 int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
1035                         const char *mod_name)
1036 {
1037         int retval = 0;
1038
1039         if (usb_disabled())
1040                 return -ENODEV;
1041
1042         new_driver->drvwrap.for_devices = 0;
1043         new_driver->drvwrap.driver.name = new_driver->name;
1044         new_driver->drvwrap.driver.bus = &usb_bus_type;
1045         new_driver->drvwrap.driver.probe = usb_probe_interface;
1046         new_driver->drvwrap.driver.remove = usb_unbind_interface;
1047         new_driver->drvwrap.driver.owner = owner;
1048         new_driver->drvwrap.driver.mod_name = mod_name;
1049         new_driver->drvwrap.driver.dev_groups = new_driver->dev_groups;
1050         spin_lock_init(&new_driver->dynids.lock);
1051         INIT_LIST_HEAD(&new_driver->dynids.list);
1052
1053         retval = driver_register(&new_driver->drvwrap.driver);
1054         if (retval)
1055                 goto out;
1056
1057         retval = usb_create_newid_files(new_driver);
1058         if (retval)
1059                 goto out_newid;
1060
1061         pr_info("%s: registered new interface driver %s\n",
1062                         usbcore_name, new_driver->name);
1063
1064 out:
1065         return retval;
1066
1067 out_newid:
1068         driver_unregister(&new_driver->drvwrap.driver);
1069
1070         pr_err("%s: error %d registering interface driver %s\n",
1071                 usbcore_name, retval, new_driver->name);
1072         goto out;
1073 }
1074 EXPORT_SYMBOL_GPL(usb_register_driver);
1075
1076 /**
1077  * usb_deregister - unregister a USB interface driver
1078  * @driver: USB operations of the interface driver to unregister
1079  * Context: must be able to sleep
1080  *
1081  * Unlinks the specified driver from the internal USB driver list.
1082  *
1083  * NOTE: If you called usb_register_dev(), you still need to call
1084  * usb_deregister_dev() to clean up your driver's allocated minor numbers,
1085  * this * call will no longer do it for you.
1086  */
1087 void usb_deregister(struct usb_driver *driver)
1088 {
1089         pr_info("%s: deregistering interface driver %s\n",
1090                         usbcore_name, driver->name);
1091
1092         usb_remove_newid_files(driver);
1093         driver_unregister(&driver->drvwrap.driver);
1094         usb_free_dynids(driver);
1095 }
1096 EXPORT_SYMBOL_GPL(usb_deregister);
1097
1098 /* Forced unbinding of a USB interface driver, either because
1099  * it doesn't support pre_reset/post_reset/reset_resume or
1100  * because it doesn't support suspend/resume.
1101  *
1102  * The caller must hold @intf's device's lock, but not @intf's lock.
1103  */
1104 void usb_forced_unbind_intf(struct usb_interface *intf)
1105 {
1106         struct usb_driver *driver = to_usb_driver(intf->dev.driver);
1107
1108         dev_dbg(&intf->dev, "forced unbind\n");
1109         usb_driver_release_interface(driver, intf);
1110
1111         /* Mark the interface for later rebinding */
1112         intf->needs_binding = 1;
1113 }
1114
1115 /*
1116  * Unbind drivers for @udev's marked interfaces.  These interfaces have
1117  * the needs_binding flag set, for example by usb_resume_interface().
1118  *
1119  * The caller must hold @udev's device lock.
1120  */
1121 static void unbind_marked_interfaces(struct usb_device *udev)
1122 {
1123         struct usb_host_config  *config;
1124         int                     i;
1125         struct usb_interface    *intf;
1126
1127         config = udev->actconfig;
1128         if (config) {
1129                 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
1130                         intf = config->interface[i];
1131                         if (intf->dev.driver && intf->needs_binding)
1132                                 usb_forced_unbind_intf(intf);
1133                 }
1134         }
1135 }
1136
1137 /* Delayed forced unbinding of a USB interface driver and scan
1138  * for rebinding.
1139  *
1140  * The caller must hold @intf's device's lock, but not @intf's lock.
1141  *
1142  * Note: Rebinds will be skipped if a system sleep transition is in
1143  * progress and the PM "complete" callback hasn't occurred yet.
1144  */
1145 static void usb_rebind_intf(struct usb_interface *intf)
1146 {
1147         int rc;
1148
1149         /* Delayed unbind of an existing driver */
1150         if (intf->dev.driver)
1151                 usb_forced_unbind_intf(intf);
1152
1153         /* Try to rebind the interface */
1154         if (!intf->dev.power.is_prepared) {
1155                 intf->needs_binding = 0;
1156                 rc = device_attach(&intf->dev);
1157                 if (rc < 0 && rc != -EPROBE_DEFER)
1158                         dev_warn(&intf->dev, "rebind failed: %d\n", rc);
1159         }
1160 }
1161
1162 /*
1163  * Rebind drivers to @udev's marked interfaces.  These interfaces have
1164  * the needs_binding flag set.
1165  *
1166  * The caller must hold @udev's device lock.
1167  */
1168 static void rebind_marked_interfaces(struct usb_device *udev)
1169 {
1170         struct usb_host_config  *config;
1171         int                     i;
1172         struct usb_interface    *intf;
1173
1174         config = udev->actconfig;
1175         if (config) {
1176                 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
1177                         intf = config->interface[i];
1178                         if (intf->needs_binding)
1179                                 usb_rebind_intf(intf);
1180                 }
1181         }
1182 }
1183
1184 /*
1185  * Unbind all of @udev's marked interfaces and then rebind all of them.
1186  * This ordering is necessary because some drivers claim several interfaces
1187  * when they are first probed.
1188  *
1189  * The caller must hold @udev's device lock.
1190  */
1191 void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev)
1192 {
1193         unbind_marked_interfaces(udev);
1194         rebind_marked_interfaces(udev);
1195 }
1196
1197 #ifdef CONFIG_PM
1198
1199 /* Unbind drivers for @udev's interfaces that don't support suspend/resume
1200  * There is no check for reset_resume here because it can be determined
1201  * only during resume whether reset_resume is needed.
1202  *
1203  * The caller must hold @udev's device lock.
1204  */
1205 static void unbind_no_pm_drivers_interfaces(struct usb_device *udev)
1206 {
1207         struct usb_host_config  *config;
1208         int                     i;
1209         struct usb_interface    *intf;
1210         struct usb_driver       *drv;
1211
1212         config = udev->actconfig;
1213         if (config) {
1214                 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
1215                         intf = config->interface[i];
1216
1217                         if (intf->dev.driver) {
1218                                 drv = to_usb_driver(intf->dev.driver);
1219                                 if (!drv->suspend || !drv->resume)
1220                                         usb_forced_unbind_intf(intf);
1221                         }
1222                 }
1223         }
1224 }
1225
1226 static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
1227 {
1228         struct usb_device_driver        *udriver;
1229         int                             status = 0;
1230
1231         if (udev->state == USB_STATE_NOTATTACHED ||
1232                         udev->state == USB_STATE_SUSPENDED)
1233                 goto done;
1234
1235         /* For devices that don't have a driver, we do a generic suspend. */
1236         if (udev->dev.driver)
1237                 udriver = to_usb_device_driver(udev->dev.driver);
1238         else {
1239                 udev->do_remote_wakeup = 0;
1240                 udriver = &usb_generic_driver;
1241         }
1242         if (udriver->suspend)
1243                 status = udriver->suspend(udev, msg);
1244         if (status == 0 && udriver->generic_subclass)
1245                 status = usb_generic_driver_suspend(udev, msg);
1246
1247  done:
1248         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1249         return status;
1250 }
1251
1252 static int usb_resume_device(struct usb_device *udev, pm_message_t msg)
1253 {
1254         struct usb_device_driver        *udriver;
1255         int                             status = 0;
1256
1257         if (udev->state == USB_STATE_NOTATTACHED)
1258                 goto done;
1259
1260         /* Can't resume it if it doesn't have a driver. */
1261         if (udev->dev.driver == NULL) {
1262                 status = -ENOTCONN;
1263                 goto done;
1264         }
1265
1266         /* Non-root devices on a full/low-speed bus must wait for their
1267          * companion high-speed root hub, in case a handoff is needed.
1268          */
1269         if (!PMSG_IS_AUTO(msg) && udev->parent && udev->bus->hs_companion)
1270                 device_pm_wait_for_dev(&udev->dev,
1271                                 &udev->bus->hs_companion->root_hub->dev);
1272
1273         if (udev->quirks & USB_QUIRK_RESET_RESUME)
1274                 udev->reset_resume = 1;
1275
1276         udriver = to_usb_device_driver(udev->dev.driver);
1277         if (udriver->generic_subclass)
1278                 status = usb_generic_driver_resume(udev, msg);
1279         if (status == 0 && udriver->resume)
1280                 status = udriver->resume(udev, msg);
1281
1282  done:
1283         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1284         return status;
1285 }
1286
1287 static int usb_suspend_interface(struct usb_device *udev,
1288                 struct usb_interface *intf, pm_message_t msg)
1289 {
1290         struct usb_driver       *driver;
1291         int                     status = 0;
1292
1293         if (udev->state == USB_STATE_NOTATTACHED ||
1294                         intf->condition == USB_INTERFACE_UNBOUND)
1295                 goto done;
1296         driver = to_usb_driver(intf->dev.driver);
1297
1298         /* at this time we know the driver supports suspend */
1299         status = driver->suspend(intf, msg);
1300         if (status && !PMSG_IS_AUTO(msg))
1301                 dev_err(&intf->dev, "suspend error %d\n", status);
1302
1303  done:
1304         dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
1305         return status;
1306 }
1307
1308 static int usb_resume_interface(struct usb_device *udev,
1309                 struct usb_interface *intf, pm_message_t msg, int reset_resume)
1310 {
1311         struct usb_driver       *driver;
1312         int                     status = 0;
1313
1314         if (udev->state == USB_STATE_NOTATTACHED)
1315                 goto done;
1316
1317         /* Don't let autoresume interfere with unbinding */
1318         if (intf->condition == USB_INTERFACE_UNBINDING)
1319                 goto done;
1320
1321         /* Can't resume it if it doesn't have a driver. */
1322         if (intf->condition == USB_INTERFACE_UNBOUND) {
1323
1324                 /* Carry out a deferred switch to altsetting 0 */
1325                 if (intf->needs_altsetting0 && !intf->dev.power.is_prepared) {
1326                         usb_set_interface(udev, intf->altsetting[0].
1327                                         desc.bInterfaceNumber, 0);
1328                         intf->needs_altsetting0 = 0;
1329                 }
1330                 goto done;
1331         }
1332
1333         /* Don't resume if the interface is marked for rebinding */
1334         if (intf->needs_binding)
1335                 goto done;
1336         driver = to_usb_driver(intf->dev.driver);
1337
1338         if (reset_resume) {
1339                 if (driver->reset_resume) {
1340                         status = driver->reset_resume(intf);
1341                         if (status)
1342                                 dev_err(&intf->dev, "%s error %d\n",
1343                                                 "reset_resume", status);
1344                 } else {
1345                         intf->needs_binding = 1;
1346                         dev_dbg(&intf->dev, "no reset_resume for driver %s?\n",
1347                                         driver->name);
1348                 }
1349         } else {
1350                 status = driver->resume(intf);
1351                 if (status)
1352                         dev_err(&intf->dev, "resume error %d\n", status);
1353         }
1354
1355 done:
1356         dev_vdbg(&intf->dev, "%s: status %d\n", __func__, status);
1357
1358         /* Later we will unbind the driver and/or reprobe, if necessary */
1359         return status;
1360 }
1361
1362 /**
1363  * usb_suspend_both - suspend a USB device and its interfaces
1364  * @udev: the usb_device to suspend
1365  * @msg: Power Management message describing this state transition
1366  *
1367  * This is the central routine for suspending USB devices.  It calls the
1368  * suspend methods for all the interface drivers in @udev and then calls
1369  * the suspend method for @udev itself.  When the routine is called in
1370  * autosuspend, if an error occurs at any stage, all the interfaces
1371  * which were suspended are resumed so that they remain in the same
1372  * state as the device, but when called from system sleep, all error
1373  * from suspend methods of interfaces and the non-root-hub device itself
1374  * are simply ignored, so all suspended interfaces are only resumed
1375  * to the device's state when @udev is root-hub and its suspend method
1376  * returns failure.
1377  *
1378  * Autosuspend requests originating from a child device or an interface
1379  * driver may be made without the protection of @udev's device lock, but
1380  * all other suspend calls will hold the lock.  Usbcore will insure that
1381  * method calls do not arrive during bind, unbind, or reset operations.
1382  * However drivers must be prepared to handle suspend calls arriving at
1383  * unpredictable times.
1384  *
1385  * This routine can run only in process context.
1386  *
1387  * Return: 0 if the suspend succeeded.
1388  */
1389 static int usb_suspend_both(struct usb_device *udev, pm_message_t msg)
1390 {
1391         int                     status = 0;
1392         int                     i = 0, n = 0;
1393         struct usb_interface    *intf;
1394
1395         if (udev->state == USB_STATE_NOTATTACHED ||
1396                         udev->state == USB_STATE_SUSPENDED)
1397                 goto done;
1398
1399         /* Suspend all the interfaces and then udev itself */
1400         if (udev->actconfig) {
1401                 n = udev->actconfig->desc.bNumInterfaces;
1402                 for (i = n - 1; i >= 0; --i) {
1403                         intf = udev->actconfig->interface[i];
1404                         status = usb_suspend_interface(udev, intf, msg);
1405
1406                         /* Ignore errors during system sleep transitions */
1407                         if (!PMSG_IS_AUTO(msg))
1408                                 status = 0;
1409                         if (status != 0)
1410                                 break;
1411                 }
1412         }
1413         if (status == 0) {
1414                 status = usb_suspend_device(udev, msg);
1415
1416                 /*
1417                  * Ignore errors from non-root-hub devices during
1418                  * system sleep transitions.  For the most part,
1419                  * these devices should go to low power anyway when
1420                  * the entire bus is suspended.
1421                  */
1422                 if (udev->parent && !PMSG_IS_AUTO(msg))
1423                         status = 0;
1424
1425                 /*
1426                  * If the device is inaccessible, don't try to resume
1427                  * suspended interfaces and just return the error.
1428                  */
1429                 if (status && status != -EBUSY) {
1430                         int err;
1431                         u16 devstat;
1432
1433                         err = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
1434                                                  &devstat);
1435                         if (err) {
1436                                 dev_err(&udev->dev,
1437                                         "Failed to suspend device, error %d\n",
1438                                         status);
1439                                 goto done;
1440                         }
1441                 }
1442         }
1443
1444         /* If the suspend failed, resume interfaces that did get suspended */
1445         if (status != 0) {
1446                 if (udev->actconfig) {
1447                         msg.event ^= (PM_EVENT_SUSPEND | PM_EVENT_RESUME);
1448                         while (++i < n) {
1449                                 intf = udev->actconfig->interface[i];
1450                                 usb_resume_interface(udev, intf, msg, 0);
1451                         }
1452                 }
1453
1454         /* If the suspend succeeded then prevent any more URB submissions
1455          * and flush any outstanding URBs.
1456          */
1457         } else {
1458                 udev->can_submit = 0;
1459                 for (i = 0; i < 16; ++i) {
1460                         usb_hcd_flush_endpoint(udev, udev->ep_out[i]);
1461                         usb_hcd_flush_endpoint(udev, udev->ep_in[i]);
1462                 }
1463         }
1464
1465  done:
1466         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1467         return status;
1468 }
1469
1470 /**
1471  * usb_resume_both - resume a USB device and its interfaces
1472  * @udev: the usb_device to resume
1473  * @msg: Power Management message describing this state transition
1474  *
1475  * This is the central routine for resuming USB devices.  It calls the
1476  * the resume method for @udev and then calls the resume methods for all
1477  * the interface drivers in @udev.
1478  *
1479  * Autoresume requests originating from a child device or an interface
1480  * driver may be made without the protection of @udev's device lock, but
1481  * all other resume calls will hold the lock.  Usbcore will insure that
1482  * method calls do not arrive during bind, unbind, or reset operations.
1483  * However drivers must be prepared to handle resume calls arriving at
1484  * unpredictable times.
1485  *
1486  * This routine can run only in process context.
1487  *
1488  * Return: 0 on success.
1489  */
1490 static int usb_resume_both(struct usb_device *udev, pm_message_t msg)
1491 {
1492         int                     status = 0;
1493         int                     i;
1494         struct usb_interface    *intf;
1495
1496         if (udev->state == USB_STATE_NOTATTACHED) {
1497                 status = -ENODEV;
1498                 goto done;
1499         }
1500         udev->can_submit = 1;
1501
1502         /* Resume the device */
1503         if (udev->state == USB_STATE_SUSPENDED || udev->reset_resume)
1504                 status = usb_resume_device(udev, msg);
1505
1506         /* Resume the interfaces */
1507         if (status == 0 && udev->actconfig) {
1508                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1509                         intf = udev->actconfig->interface[i];
1510                         usb_resume_interface(udev, intf, msg,
1511                                         udev->reset_resume);
1512                 }
1513         }
1514         usb_mark_last_busy(udev);
1515
1516  done:
1517         dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1518         if (!status)
1519                 udev->reset_resume = 0;
1520         return status;
1521 }
1522
1523 static void choose_wakeup(struct usb_device *udev, pm_message_t msg)
1524 {
1525         int     w;
1526
1527         /* Remote wakeup is needed only when we actually go to sleep.
1528          * For things like FREEZE and QUIESCE, if the device is already
1529          * autosuspended then its current wakeup setting is okay.
1530          */
1531         if (msg.event == PM_EVENT_FREEZE || msg.event == PM_EVENT_QUIESCE) {
1532                 if (udev->state != USB_STATE_SUSPENDED)
1533                         udev->do_remote_wakeup = 0;
1534                 return;
1535         }
1536
1537         /* Enable remote wakeup if it is allowed, even if no interface drivers
1538          * actually want it.
1539          */
1540         w = device_may_wakeup(&udev->dev);
1541
1542         /* If the device is autosuspended with the wrong wakeup setting,
1543          * autoresume now so the setting can be changed.
1544          */
1545         if (udev->state == USB_STATE_SUSPENDED && w != udev->do_remote_wakeup)
1546                 pm_runtime_resume(&udev->dev);
1547         udev->do_remote_wakeup = w;
1548 }
1549
1550 /* The device lock is held by the PM core */
1551 int usb_suspend(struct device *dev, pm_message_t msg)
1552 {
1553         struct usb_device       *udev = to_usb_device(dev);
1554         int r;
1555
1556         unbind_no_pm_drivers_interfaces(udev);
1557
1558         /* From now on we are sure all drivers support suspend/resume
1559          * but not necessarily reset_resume()
1560          * so we may still need to unbind and rebind upon resume
1561          */
1562         choose_wakeup(udev, msg);
1563         r = usb_suspend_both(udev, msg);
1564         if (r)
1565                 return r;
1566
1567         if (udev->quirks & USB_QUIRK_DISCONNECT_SUSPEND)
1568                 usb_port_disable(udev);
1569
1570         return 0;
1571 }
1572
1573 /* The device lock is held by the PM core */
1574 int usb_resume_complete(struct device *dev)
1575 {
1576         struct usb_device *udev = to_usb_device(dev);
1577
1578         /* For PM complete calls, all we do is rebind interfaces
1579          * whose needs_binding flag is set
1580          */
1581         if (udev->state != USB_STATE_NOTATTACHED)
1582                 rebind_marked_interfaces(udev);
1583         return 0;
1584 }
1585
1586 /* The device lock is held by the PM core */
1587 int usb_resume(struct device *dev, pm_message_t msg)
1588 {
1589         struct usb_device       *udev = to_usb_device(dev);
1590         int                     status;
1591
1592         /* For all calls, take the device back to full power and
1593          * tell the PM core in case it was autosuspended previously.
1594          * Unbind the interfaces that will need rebinding later,
1595          * because they fail to support reset_resume.
1596          * (This can't be done in usb_resume_interface()
1597          * above because it doesn't own the right set of locks.)
1598          */
1599         status = usb_resume_both(udev, msg);
1600         if (status == 0) {
1601                 pm_runtime_disable(dev);
1602                 pm_runtime_set_active(dev);
1603                 pm_runtime_enable(dev);
1604                 unbind_marked_interfaces(udev);
1605         }
1606
1607         /* Avoid PM error messages for devices disconnected while suspended
1608          * as we'll display regular disconnect messages just a bit later.
1609          */
1610         if (status == -ENODEV || status == -ESHUTDOWN)
1611                 status = 0;
1612         return status;
1613 }
1614
1615 /**
1616  * usb_enable_autosuspend - allow a USB device to be autosuspended
1617  * @udev: the USB device which may be autosuspended
1618  *
1619  * This routine allows @udev to be autosuspended.  An autosuspend won't
1620  * take place until the autosuspend_delay has elapsed and all the other
1621  * necessary conditions are satisfied.
1622  *
1623  * The caller must hold @udev's device lock.
1624  */
1625 void usb_enable_autosuspend(struct usb_device *udev)
1626 {
1627         pm_runtime_allow(&udev->dev);
1628 }
1629 EXPORT_SYMBOL_GPL(usb_enable_autosuspend);
1630
1631 /**
1632  * usb_disable_autosuspend - prevent a USB device from being autosuspended
1633  * @udev: the USB device which may not be autosuspended
1634  *
1635  * This routine prevents @udev from being autosuspended and wakes it up
1636  * if it is already autosuspended.
1637  *
1638  * The caller must hold @udev's device lock.
1639  */
1640 void usb_disable_autosuspend(struct usb_device *udev)
1641 {
1642         pm_runtime_forbid(&udev->dev);
1643 }
1644 EXPORT_SYMBOL_GPL(usb_disable_autosuspend);
1645
1646 /**
1647  * usb_autosuspend_device - delayed autosuspend of a USB device and its interfaces
1648  * @udev: the usb_device to autosuspend
1649  *
1650  * This routine should be called when a core subsystem is finished using
1651  * @udev and wants to allow it to autosuspend.  Examples would be when
1652  * @udev's device file in usbfs is closed or after a configuration change.
1653  *
1654  * @udev's usage counter is decremented; if it drops to 0 and all the
1655  * interfaces are inactive then a delayed autosuspend will be attempted.
1656  * The attempt may fail (see autosuspend_check()).
1657  *
1658  * The caller must hold @udev's device lock.
1659  *
1660  * This routine can run only in process context.
1661  */
1662 void usb_autosuspend_device(struct usb_device *udev)
1663 {
1664         int     status;
1665
1666         usb_mark_last_busy(udev);
1667         status = pm_runtime_put_sync_autosuspend(&udev->dev);
1668         dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
1669                         __func__, atomic_read(&udev->dev.power.usage_count),
1670                         status);
1671 }
1672
1673 /**
1674  * usb_autoresume_device - immediately autoresume a USB device and its interfaces
1675  * @udev: the usb_device to autoresume
1676  *
1677  * This routine should be called when a core subsystem wants to use @udev
1678  * and needs to guarantee that it is not suspended.  No autosuspend will
1679  * occur until usb_autosuspend_device() is called.  (Note that this will
1680  * not prevent suspend events originating in the PM core.)  Examples would
1681  * be when @udev's device file in usbfs is opened or when a remote-wakeup
1682  * request is received.
1683  *
1684  * @udev's usage counter is incremented to prevent subsequent autosuspends.
1685  * However if the autoresume fails then the usage counter is re-decremented.
1686  *
1687  * The caller must hold @udev's device lock.
1688  *
1689  * This routine can run only in process context.
1690  *
1691  * Return: 0 on success. A negative error code otherwise.
1692  */
1693 int usb_autoresume_device(struct usb_device *udev)
1694 {
1695         int     status;
1696
1697         status = pm_runtime_get_sync(&udev->dev);
1698         if (status < 0)
1699                 pm_runtime_put_sync(&udev->dev);
1700         dev_vdbg(&udev->dev, "%s: cnt %d -> %d\n",
1701                         __func__, atomic_read(&udev->dev.power.usage_count),
1702                         status);
1703         if (status > 0)
1704                 status = 0;
1705         return status;
1706 }
1707
1708 /**
1709  * usb_autopm_put_interface - decrement a USB interface's PM-usage counter
1710  * @intf: the usb_interface whose counter should be decremented
1711  *
1712  * This routine should be called by an interface driver when it is
1713  * finished using @intf and wants to allow it to autosuspend.  A typical
1714  * example would be a character-device driver when its device file is
1715  * closed.
1716  *
1717  * The routine decrements @intf's usage counter.  When the counter reaches
1718  * 0, a delayed autosuspend request for @intf's device is attempted.  The
1719  * attempt may fail (see autosuspend_check()).
1720  *
1721  * This routine can run only in process context.
1722  */
1723 void usb_autopm_put_interface(struct usb_interface *intf)
1724 {
1725         struct usb_device       *udev = interface_to_usbdev(intf);
1726         int                     status;
1727
1728         usb_mark_last_busy(udev);
1729         status = pm_runtime_put_sync(&intf->dev);
1730         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1731                         __func__, atomic_read(&intf->dev.power.usage_count),
1732                         status);
1733 }
1734 EXPORT_SYMBOL_GPL(usb_autopm_put_interface);
1735
1736 /**
1737  * usb_autopm_put_interface_async - decrement a USB interface's PM-usage counter
1738  * @intf: the usb_interface whose counter should be decremented
1739  *
1740  * This routine does much the same thing as usb_autopm_put_interface():
1741  * It decrements @intf's usage counter and schedules a delayed
1742  * autosuspend request if the counter is <= 0.  The difference is that it
1743  * does not perform any synchronization; callers should hold a private
1744  * lock and handle all synchronization issues themselves.
1745  *
1746  * Typically a driver would call this routine during an URB's completion
1747  * handler, if no more URBs were pending.
1748  *
1749  * This routine can run in atomic context.
1750  */
1751 void usb_autopm_put_interface_async(struct usb_interface *intf)
1752 {
1753         struct usb_device       *udev = interface_to_usbdev(intf);
1754         int                     status;
1755
1756         usb_mark_last_busy(udev);
1757         status = pm_runtime_put(&intf->dev);
1758         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1759                         __func__, atomic_read(&intf->dev.power.usage_count),
1760                         status);
1761 }
1762 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_async);
1763
1764 /**
1765  * usb_autopm_put_interface_no_suspend - decrement a USB interface's PM-usage counter
1766  * @intf: the usb_interface whose counter should be decremented
1767  *
1768  * This routine decrements @intf's usage counter but does not carry out an
1769  * autosuspend.
1770  *
1771  * This routine can run in atomic context.
1772  */
1773 void usb_autopm_put_interface_no_suspend(struct usb_interface *intf)
1774 {
1775         struct usb_device       *udev = interface_to_usbdev(intf);
1776
1777         usb_mark_last_busy(udev);
1778         pm_runtime_put_noidle(&intf->dev);
1779 }
1780 EXPORT_SYMBOL_GPL(usb_autopm_put_interface_no_suspend);
1781
1782 /**
1783  * usb_autopm_get_interface - increment a USB interface's PM-usage counter
1784  * @intf: the usb_interface whose counter should be incremented
1785  *
1786  * This routine should be called by an interface driver when it wants to
1787  * use @intf and needs to guarantee that it is not suspended.  In addition,
1788  * the routine prevents @intf from being autosuspended subsequently.  (Note
1789  * that this will not prevent suspend events originating in the PM core.)
1790  * This prevention will persist until usb_autopm_put_interface() is called
1791  * or @intf is unbound.  A typical example would be a character-device
1792  * driver when its device file is opened.
1793  *
1794  * @intf's usage counter is incremented to prevent subsequent autosuspends.
1795  * However if the autoresume fails then the counter is re-decremented.
1796  *
1797  * This routine can run only in process context.
1798  *
1799  * Return: 0 on success.
1800  */
1801 int usb_autopm_get_interface(struct usb_interface *intf)
1802 {
1803         int     status;
1804
1805         status = pm_runtime_get_sync(&intf->dev);
1806         if (status < 0)
1807                 pm_runtime_put_sync(&intf->dev);
1808         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1809                         __func__, atomic_read(&intf->dev.power.usage_count),
1810                         status);
1811         if (status > 0)
1812                 status = 0;
1813         return status;
1814 }
1815 EXPORT_SYMBOL_GPL(usb_autopm_get_interface);
1816
1817 /**
1818  * usb_autopm_get_interface_async - increment a USB interface's PM-usage counter
1819  * @intf: the usb_interface whose counter should be incremented
1820  *
1821  * This routine does much the same thing as
1822  * usb_autopm_get_interface(): It increments @intf's usage counter and
1823  * queues an autoresume request if the device is suspended.  The
1824  * differences are that it does not perform any synchronization (callers
1825  * should hold a private lock and handle all synchronization issues
1826  * themselves), and it does not autoresume the device directly (it only
1827  * queues a request).  After a successful call, the device may not yet be
1828  * resumed.
1829  *
1830  * This routine can run in atomic context.
1831  *
1832  * Return: 0 on success. A negative error code otherwise.
1833  */
1834 int usb_autopm_get_interface_async(struct usb_interface *intf)
1835 {
1836         int     status;
1837
1838         status = pm_runtime_get(&intf->dev);
1839         if (status < 0 && status != -EINPROGRESS)
1840                 pm_runtime_put_noidle(&intf->dev);
1841         dev_vdbg(&intf->dev, "%s: cnt %d -> %d\n",
1842                         __func__, atomic_read(&intf->dev.power.usage_count),
1843                         status);
1844         if (status > 0 || status == -EINPROGRESS)
1845                 status = 0;
1846         return status;
1847 }
1848 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_async);
1849
1850 /**
1851  * usb_autopm_get_interface_no_resume - increment a USB interface's PM-usage counter
1852  * @intf: the usb_interface whose counter should be incremented
1853  *
1854  * This routine increments @intf's usage counter but does not carry out an
1855  * autoresume.
1856  *
1857  * This routine can run in atomic context.
1858  */
1859 void usb_autopm_get_interface_no_resume(struct usb_interface *intf)
1860 {
1861         struct usb_device       *udev = interface_to_usbdev(intf);
1862
1863         usb_mark_last_busy(udev);
1864         pm_runtime_get_noresume(&intf->dev);
1865 }
1866 EXPORT_SYMBOL_GPL(usb_autopm_get_interface_no_resume);
1867
1868 /* Internal routine to check whether we may autosuspend a device. */
1869 static int autosuspend_check(struct usb_device *udev)
1870 {
1871         int                     w, i;
1872         struct usb_interface    *intf;
1873
1874         if (udev->state == USB_STATE_NOTATTACHED)
1875                 return -ENODEV;
1876
1877         /* Fail if autosuspend is disabled, or any interfaces are in use, or
1878          * any interface drivers require remote wakeup but it isn't available.
1879          */
1880         w = 0;
1881         if (udev->actconfig) {
1882                 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1883                         intf = udev->actconfig->interface[i];
1884
1885                         /* We don't need to check interfaces that are
1886                          * disabled for runtime PM.  Either they are unbound
1887                          * or else their drivers don't support autosuspend
1888                          * and so they are permanently active.
1889                          */
1890                         if (intf->dev.power.disable_depth)
1891                                 continue;
1892                         if (atomic_read(&intf->dev.power.usage_count) > 0)
1893                                 return -EBUSY;
1894                         w |= intf->needs_remote_wakeup;
1895
1896                         /* Don't allow autosuspend if the device will need
1897                          * a reset-resume and any of its interface drivers
1898                          * doesn't include support or needs remote wakeup.
1899                          */
1900                         if (udev->quirks & USB_QUIRK_RESET_RESUME) {
1901                                 struct usb_driver *driver;
1902
1903                                 driver = to_usb_driver(intf->dev.driver);
1904                                 if (!driver->reset_resume ||
1905                                                 intf->needs_remote_wakeup)
1906                                         return -EOPNOTSUPP;
1907                         }
1908                 }
1909         }
1910         if (w && !device_can_wakeup(&udev->dev)) {
1911                 dev_dbg(&udev->dev, "remote wakeup needed for autosuspend\n");
1912                 return -EOPNOTSUPP;
1913         }
1914
1915         /*
1916          * If the device is a direct child of the root hub and the HCD
1917          * doesn't handle wakeup requests, don't allow autosuspend when
1918          * wakeup is needed.
1919          */
1920         if (w && udev->parent == udev->bus->root_hub &&
1921                         bus_to_hcd(udev->bus)->cant_recv_wakeups) {
1922                 dev_dbg(&udev->dev, "HCD doesn't handle wakeup requests\n");
1923                 return -EOPNOTSUPP;
1924         }
1925
1926         udev->do_remote_wakeup = w;
1927         return 0;
1928 }
1929
1930 int usb_runtime_suspend(struct device *dev)
1931 {
1932         struct usb_device       *udev = to_usb_device(dev);
1933         int                     status;
1934
1935         /* A USB device can be suspended if it passes the various autosuspend
1936          * checks.  Runtime suspend for a USB device means suspending all the
1937          * interfaces and then the device itself.
1938          */
1939         if (autosuspend_check(udev) != 0)
1940                 return -EAGAIN;
1941
1942         status = usb_suspend_both(udev, PMSG_AUTO_SUSPEND);
1943
1944         /* Allow a retry if autosuspend failed temporarily */
1945         if (status == -EAGAIN || status == -EBUSY)
1946                 usb_mark_last_busy(udev);
1947
1948         /*
1949          * The PM core reacts badly unless the return code is 0,
1950          * -EAGAIN, or -EBUSY, so always return -EBUSY on an error
1951          * (except for root hubs, because they don't suspend through
1952          * an upstream port like other USB devices).
1953          */
1954         if (status != 0 && udev->parent)
1955                 return -EBUSY;
1956         return status;
1957 }
1958
1959 int usb_runtime_resume(struct device *dev)
1960 {
1961         struct usb_device       *udev = to_usb_device(dev);
1962         int                     status;
1963
1964         /* Runtime resume for a USB device means resuming both the device
1965          * and all its interfaces.
1966          */
1967         status = usb_resume_both(udev, PMSG_AUTO_RESUME);
1968         return status;
1969 }
1970
1971 int usb_runtime_idle(struct device *dev)
1972 {
1973         struct usb_device       *udev = to_usb_device(dev);
1974
1975         /* An idle USB device can be suspended if it passes the various
1976          * autosuspend checks.
1977          */
1978         if (autosuspend_check(udev) == 0)
1979                 pm_runtime_autosuspend(dev);
1980         /* Tell the core not to suspend it, though. */
1981         return -EBUSY;
1982 }
1983
1984 static int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable)
1985 {
1986         struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1987         int ret = -EPERM;
1988
1989         if (hcd->driver->set_usb2_hw_lpm) {
1990                 ret = hcd->driver->set_usb2_hw_lpm(hcd, udev, enable);
1991                 if (!ret)
1992                         udev->usb2_hw_lpm_enabled = enable;
1993         }
1994
1995         return ret;
1996 }
1997
1998 int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
1999 {
2000         if (!udev->usb2_hw_lpm_capable ||
2001             !udev->usb2_hw_lpm_allowed ||
2002             udev->usb2_hw_lpm_enabled)
2003                 return 0;
2004
2005         return usb_set_usb2_hardware_lpm(udev, 1);
2006 }
2007
2008 int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
2009 {
2010         if (!udev->usb2_hw_lpm_enabled)
2011                 return 0;
2012
2013         return usb_set_usb2_hardware_lpm(udev, 0);
2014 }
2015
2016 #endif /* CONFIG_PM */
2017
2018 struct bus_type usb_bus_type = {
2019         .name =         "usb",
2020         .match =        usb_device_match,
2021         .uevent =       usb_uevent,
2022         .need_parent_lock =     true,
2023 };