drivers/usb/core/driver.c

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