drivers/usb/core/usb.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * drivers/usb/core/usb.c
   4  *
   5  * (C) Copyright Linus Torvalds 1999
   6  * (C) Copyright Johannes Erdfelt 1999-2001
   7  * (C) Copyright Andreas Gal 1999
   8  * (C) Copyright Gregory P. Smith 1999
   9  * (C) Copyright Deti Fliegl 1999 (new USB architecture)
  10  * (C) Copyright Randy Dunlap 2000
  11  * (C) Copyright David Brownell 2000-2004
  12  * (C) Copyright Yggdrasil Computing, Inc. 2000
  13  *     (usb_device_id matching changes by Adam J. Richter)
  14  * (C) Copyright Greg Kroah-Hartman 2002-2003
  15  *
  16  * Released under the GPLv2 only.
  17  *
  18  * NOTE! This is not actually a driver at all, rather this is
  19  * just a collection of helper routines that implement the
  20  * generic USB things that the real drivers can use..
  21  *
  22  * Think of this as a "USB library" rather than anything else,
  23  * with no callbacks.  Callbacks are evil.
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/string.h>
  29 #include <linux/bitops.h>
  30 #include <linux/slab.h>
  31 #include <linux/interrupt.h>  /* for in_interrupt() */
  32 #include <linux/kmod.h>
  33 #include <linux/init.h>
  34 #include <linux/spinlock.h>
  35 #include <linux/errno.h>
  36 #include <linux/usb.h>
  37 #include <linux/usb/hcd.h>
  38 #include <linux/mutex.h>
  39 #include <linux/workqueue.h>
  40 #include <linux/debugfs.h>
  41 #include <linux/usb/of.h>
  42
  43 #include <asm/io.h>
  44 #include <linux/scatterlist.h>
  45 #include <linux/mm.h>
  46 #include <linux/dma-mapping.h>
  47
  48 #include "hub.h"
  49
  50 const char *usbcore_name = "usbcore";
  51
  52 static bool nousb;      /* Disable USB when built into kernel image */
  53
  54 module_param(nousb, bool, 0444);
  55
  56 /*
  57  * for external read access to <nousb>
  58  */
  59 int usb_disabled(void)
  60 {
  61         return nousb;
  62 }
  63 EXPORT_SYMBOL_GPL(usb_disabled);
  64
  65 #ifdef  CONFIG_PM
  66 /* Default delay value, in seconds */
  67 static int usb_autosuspend_delay = CONFIG_USB_AUTOSUSPEND_DELAY;
  68 module_param_named(autosuspend, usb_autosuspend_delay, int, 0644);
  69 MODULE_PARM_DESC(autosuspend, "default autosuspend delay");
  70
  71 #else
  72 #define usb_autosuspend_delay           0
  73 #endif
  74
  75 static bool match_endpoint(struct usb_endpoint_descriptor *epd,
  76                 struct usb_endpoint_descriptor **bulk_in,
  77                 struct usb_endpoint_descriptor **bulk_out,
  78                 struct usb_endpoint_descriptor **int_in,
  79                 struct usb_endpoint_descriptor **int_out)
  80 {
  81         switch (usb_endpoint_type(epd)) {
  82         case USB_ENDPOINT_XFER_BULK:
  83                 if (usb_endpoint_dir_in(epd)) {
  84                         if (bulk_in && !*bulk_in) {
  85                                 *bulk_in = epd;
  86                                 break;
  87                         }
  88                 } else {
  89                         if (bulk_out && !*bulk_out) {
  90                                 *bulk_out = epd;
  91                                 break;
  92                         }
  93                 }
  94
  95                 return false;
  96         case USB_ENDPOINT_XFER_INT:
  97                 if (usb_endpoint_dir_in(epd)) {
  98                         if (int_in && !*int_in) {
  99                                 *int_in = epd;
 100                                 break;
 101                         }
 102                 } else {
 103                         if (int_out && !*int_out) {
 104                                 *int_out = epd;
 105                                 break;
 106                         }
 107                 }
 108
 109                 return false;
 110         default:
 111                 return false;
 112         }
 113
 114         return (!bulk_in || *bulk_in) && (!bulk_out || *bulk_out) &&
 115                         (!int_in || *int_in) && (!int_out || *int_out);
 116 }
 117
 118 /**
 119  * usb_find_common_endpoints() -- look up common endpoint descriptors
 120  * @alt:        alternate setting to search
 121  * @bulk_in:    pointer to descriptor pointer, or NULL
 122  * @bulk_out:   pointer to descriptor pointer, or NULL
 123  * @int_in:     pointer to descriptor pointer, or NULL
 124  * @int_out:    pointer to descriptor pointer, or NULL
 125  *
 126  * Search the alternate setting's endpoint descriptors for the first bulk-in,
 127  * bulk-out, interrupt-in and interrupt-out endpoints and return them in the
 128  * provided pointers (unless they are NULL).
 129  *
 130  * If a requested endpoint is not found, the corresponding pointer is set to
 131  * NULL.
 132  *
 133  * Return: Zero if all requested descriptors were found, or -ENXIO otherwise.
 134  */
 135 int usb_find_common_endpoints(struct usb_host_interface *alt,
 136                 struct usb_endpoint_descriptor **bulk_in,
 137                 struct usb_endpoint_descriptor **bulk_out,
 138                 struct usb_endpoint_descriptor **int_in,
 139                 struct usb_endpoint_descriptor **int_out)
 140 {
 141         struct usb_endpoint_descriptor *epd;
 142         int i;
 143
 144         if (bulk_in)
 145                 *bulk_in = NULL;
 146         if (bulk_out)
 147                 *bulk_out = NULL;
 148         if (int_in)
 149                 *int_in = NULL;
 150         if (int_out)
 151                 *int_out = NULL;
 152
 153         for (i = 0; i < alt->desc.bNumEndpoints; ++i) {
 154                 epd = &alt->endpoint[i].desc;
 155
 156                 if (match_endpoint(epd, bulk_in, bulk_out, int_in, int_out))
 157                         return 0;
 158         }
 159
 160         return -ENXIO;
 161 }
 162 EXPORT_SYMBOL_GPL(usb_find_common_endpoints);
 163
 164 /**
 165  * usb_find_common_endpoints_reverse() -- look up common endpoint descriptors
 166  * @alt:        alternate setting to search
 167  * @bulk_in:    pointer to descriptor pointer, or NULL
 168  * @bulk_out:   pointer to descriptor pointer, or NULL
 169  * @int_in:     pointer to descriptor pointer, or NULL
 170  * @int_out:    pointer to descriptor pointer, or NULL
 171  *
 172  * Search the alternate setting's endpoint descriptors for the last bulk-in,
 173  * bulk-out, interrupt-in and interrupt-out endpoints and return them in the
 174  * provided pointers (unless they are NULL).
 175  *
 176  * If a requested endpoint is not found, the corresponding pointer is set to
 177  * NULL.
 178  *
 179  * Return: Zero if all requested descriptors were found, or -ENXIO otherwise.
 180  */
 181 int usb_find_common_endpoints_reverse(struct usb_host_interface *alt,
 182                 struct usb_endpoint_descriptor **bulk_in,
 183                 struct usb_endpoint_descriptor **bulk_out,
 184                 struct usb_endpoint_descriptor **int_in,
 185                 struct usb_endpoint_descriptor **int_out)
 186 {
 187         struct usb_endpoint_descriptor *epd;
 188         int i;
 189
 190         if (bulk_in)
 191                 *bulk_in = NULL;
 192         if (bulk_out)
 193                 *bulk_out = NULL;
 194         if (int_in)
 195                 *int_in = NULL;
 196         if (int_out)
 197                 *int_out = NULL;
 198
 199         for (i = alt->desc.bNumEndpoints - 1; i >= 0; --i) {
 200                 epd = &alt->endpoint[i].desc;
 201
 202                 if (match_endpoint(epd, bulk_in, bulk_out, int_in, int_out))
 203                         return 0;
 204         }
 205
 206         return -ENXIO;
 207 }
 208 EXPORT_SYMBOL_GPL(usb_find_common_endpoints_reverse);
 209
 210 /**
 211  * usb_find_alt_setting() - Given a configuration, find the alternate setting
 212  * for the given interface.
 213  * @config: the configuration to search (not necessarily the current config).
 214  * @iface_num: interface number to search in
 215  * @alt_num: alternate interface setting number to search for.
 216  *
 217  * Search the configuration's interface cache for the given alt setting.
 218  *
 219  * Return: The alternate setting, if found. %NULL otherwise.
 220  */
 221 struct usb_host_interface *usb_find_alt_setting(
 222                 struct usb_host_config *config,
 223                 unsigned int iface_num,
 224                 unsigned int alt_num)
 225 {
 226         struct usb_interface_cache *intf_cache = NULL;
 227         int i;
 228
 229         if (!config)
 230                 return NULL;
 231         for (i = 0; i < config->desc.bNumInterfaces; i++) {
 232                 if (config->intf_cache[i]->altsetting[0].desc.bInterfaceNumber
 233                                 == iface_num) {
 234                         intf_cache = config->intf_cache[i];
 235                         break;
 236                 }
 237         }
 238         if (!intf_cache)
 239                 return NULL;
 240         for (i = 0; i < intf_cache->num_altsetting; i++)
 241                 if (intf_cache->altsetting[i].desc.bAlternateSetting == alt_num)
 242                         return &intf_cache->altsetting[i];
 243
 244         printk(KERN_DEBUG "Did not find alt setting %u for intf %u, "
 245                         "config %u\n", alt_num, iface_num,
 246                         config->desc.bConfigurationValue);
 247         return NULL;
 248 }
 249 EXPORT_SYMBOL_GPL(usb_find_alt_setting);
 250
 251 /**
 252  * usb_ifnum_to_if - get the interface object with a given interface number
 253  * @dev: the device whose current configuration is considered
 254  * @ifnum: the desired interface
 255  *
 256  * This walks the device descriptor for the currently active configuration
 257  * to find the interface object with the particular interface number.
 258  *
 259  * Note that configuration descriptors are not required to assign interface
 260  * numbers sequentially, so that it would be incorrect to assume that
 261  * the first interface in that descriptor corresponds to interface zero.
 262  * This routine helps device drivers avoid such mistakes.
 263  * However, you should make sure that you do the right thing with any
 264  * alternate settings available for this interfaces.
 265  *
 266  * Don't call this function unless you are bound to one of the interfaces
 267  * on this device or you have locked the device!
 268  *
 269  * Return: A pointer to the interface that has @ifnum as interface number,
 270  * if found. %NULL otherwise.
 271  */
 272 struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
 273                                       unsigned ifnum)
 274 {
 275         struct usb_host_config *config = dev->actconfig;
 276         int i;
 277
 278         if (!config)
 279                 return NULL;
 280         for (i = 0; i < config->desc.bNumInterfaces; i++)
 281                 if (config->interface[i]->altsetting[0]
 282                                 .desc.bInterfaceNumber == ifnum)
 283                         return config->interface[i];
 284
 285         return NULL;
 286 }
 287 EXPORT_SYMBOL_GPL(usb_ifnum_to_if);
 288
 289 /**
 290  * usb_altnum_to_altsetting - get the altsetting structure with a given alternate setting number.
 291  * @intf: the interface containing the altsetting in question
 292  * @altnum: the desired alternate setting number
 293  *
 294  * This searches the altsetting array of the specified interface for
 295  * an entry with the correct bAlternateSetting value.
 296  *
 297  * Note that altsettings need not be stored sequentially by number, so
 298  * it would be incorrect to assume that the first altsetting entry in
 299  * the array corresponds to altsetting zero.  This routine helps device
 300  * drivers avoid such mistakes.
 301  *
 302  * Don't call this function unless you are bound to the intf interface
 303  * or you have locked the device!
 304  *
 305  * Return: A pointer to the entry of the altsetting array of @intf that
 306  * has @altnum as the alternate setting number. %NULL if not found.
 307  */
 308 struct usb_host_interface *usb_altnum_to_altsetting(
 309                                         const struct usb_interface *intf,
 310                                         unsigned int altnum)
 311 {
 312         int i;
 313
 314         for (i = 0; i < intf->num_altsetting; i++) {
 315                 if (intf->altsetting[i].desc.bAlternateSetting == altnum)
 316                         return &intf->altsetting[i];
 317         }
 318         return NULL;
 319 }
 320 EXPORT_SYMBOL_GPL(usb_altnum_to_altsetting);
 321
 322 struct find_interface_arg {
 323         int minor;
 324         struct device_driver *drv;
 325 };
 326
 327 static int __find_interface(struct device *dev, const void *data)
 328 {
 329         const struct find_interface_arg *arg = data;
 330         struct usb_interface *intf;
 331
 332         if (!is_usb_interface(dev))
 333                 return 0;
 334
 335         if (dev->driver != arg->drv)
 336                 return 0;
 337         intf = to_usb_interface(dev);
 338         return intf->minor == arg->minor;
 339 }
 340
 341 /**
 342  * usb_find_interface - find usb_interface pointer for driver and device
 343  * @drv: the driver whose current configuration is considered
 344  * @minor: the minor number of the desired device
 345  *
 346  * This walks the bus device list and returns a pointer to the interface
 347  * with the matching minor and driver.  Note, this only works for devices
 348  * that share the USB major number.
 349  *
 350  * Return: A pointer to the interface with the matching major and @minor.
 351  */
 352 struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)
 353 {
 354         struct find_interface_arg argb;
 355         struct device *dev;
 356
 357         argb.minor = minor;
 358         argb.drv = &drv->drvwrap.driver;
 359
 360         dev = bus_find_device(&usb_bus_type, NULL, &argb, __find_interface);
 361
 362         /* Drop reference count from bus_find_device */
 363         put_device(dev);
 364
 365         return dev ? to_usb_interface(dev) : NULL;
 366 }
 367 EXPORT_SYMBOL_GPL(usb_find_interface);
 368
 369 struct each_dev_arg {
 370         void *data;
 371         int (*fn)(struct usb_device *, void *);
 372 };
 373
 374 static int __each_dev(struct device *dev, void *data)
 375 {
 376         struct each_dev_arg *arg = (struct each_dev_arg *)data;
 377
 378         /* There are struct usb_interface on the same bus, filter them out */
 379         if (!is_usb_device(dev))
 380                 return 0;
 381
 382         return arg->fn(to_usb_device(dev), arg->data);
 383 }
 384
 385 /**
 386  * usb_for_each_dev - iterate over all USB devices in the system
 387  * @data: data pointer that will be handed to the callback function
 388  * @fn: callback function to be called for each USB device
 389  *
 390  * Iterate over all USB devices and call @fn for each, passing it @data. If it
 391  * returns anything other than 0, we break the iteration prematurely and return
 392  * that value.
 393  */
 394 int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *))
 395 {
 396         struct each_dev_arg arg = {data, fn};
 397
 398         return bus_for_each_dev(&usb_bus_type, NULL, &arg, __each_dev);
 399 }
 400 EXPORT_SYMBOL_GPL(usb_for_each_dev);
 401
 402 /**
 403  * usb_release_dev - free a usb device structure when all users of it are finished.
 404  * @dev: device that's been disconnected
 405  *
 406  * Will be called only by the device core when all users of this usb device are
 407  * done.
 408  */
 409 static void usb_release_dev(struct device *dev)
 410 {
 411         struct usb_device *udev;
 412         struct usb_hcd *hcd;
 413
 414         udev = to_usb_device(dev);
 415         hcd = bus_to_hcd(udev->bus);
 416
 417         usb_destroy_configuration(udev);
 418         usb_release_bos_descriptor(udev);
 419         of_node_put(dev->of_node);
 420         usb_put_hcd(hcd);
 421         kfree(udev->product);
 422         kfree(udev->manufacturer);
 423         kfree(udev->serial);
 424         kfree(udev);
 425 }
 426
 427 static int usb_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
 428 {
 429         struct usb_device *usb_dev;
 430
 431         usb_dev = to_usb_device(dev);
 432
 433         if (add_uevent_var(env, "BUSNUM=%03d", usb_dev->bus->busnum))
 434                 return -ENOMEM;
 435
 436         if (add_uevent_var(env, "DEVNUM=%03d", usb_dev->devnum))
 437                 return -ENOMEM;
 438
 439         return 0;
 440 }
 441
 442 #ifdef  CONFIG_PM
 443
 444 /* USB device Power-Management thunks.
 445  * There's no need to distinguish here between quiescing a USB device
 446  * and powering it down; the generic_suspend() routine takes care of
 447  * it by skipping the usb_port_suspend() call for a quiesce.  And for
 448  * USB interfaces there's no difference at all.
 449  */
 450
 451 static int usb_dev_prepare(struct device *dev)
 452 {
 453         return 0;               /* Implement eventually? */
 454 }
 455
 456 static void usb_dev_complete(struct device *dev)
 457 {
 458         /* Currently used only for rebinding interfaces */
 459         usb_resume_complete(dev);
 460 }
 461
 462 static int usb_dev_suspend(struct device *dev)
 463 {
 464         return usb_suspend(dev, PMSG_SUSPEND);
 465 }
 466
 467 static int usb_dev_resume(struct device *dev)
 468 {
 469         return usb_resume(dev, PMSG_RESUME);
 470 }
 471
 472 static int usb_dev_freeze(struct device *dev)
 473 {
 474         return usb_suspend(dev, PMSG_FREEZE);
 475 }
 476
 477 static int usb_dev_thaw(struct device *dev)
 478 {
 479         return usb_resume(dev, PMSG_THAW);
 480 }
 481
 482 static int usb_dev_poweroff(struct device *dev)
 483 {
 484         return usb_suspend(dev, PMSG_HIBERNATE);
 485 }
 486
 487 static int usb_dev_restore(struct device *dev)
 488 {
 489         return usb_resume(dev, PMSG_RESTORE);
 490 }
 491
 492 static const struct dev_pm_ops usb_device_pm_ops = {
 493         .prepare =      usb_dev_prepare,
 494         .complete =     usb_dev_complete,
 495         .suspend =      usb_dev_suspend,
 496         .resume =       usb_dev_resume,
 497         .freeze =       usb_dev_freeze,
 498         .thaw =         usb_dev_thaw,
 499         .poweroff =     usb_dev_poweroff,
 500         .restore =      usb_dev_restore,
 501         .runtime_suspend =      usb_runtime_suspend,
 502         .runtime_resume =       usb_runtime_resume,
 503         .runtime_idle =         usb_runtime_idle,
 504 };
 505
 506 #endif  /* CONFIG_PM */
 507
 508
 509 static char *usb_devnode(struct device *dev,
 510                          umode_t *mode, kuid_t *uid, kgid_t *gid)
 511 {
 512         struct usb_device *usb_dev;
 513
 514         usb_dev = to_usb_device(dev);
 515         return kasprintf(GFP_KERNEL, "bus/usb/%03d/%03d",
 516                          usb_dev->bus->busnum, usb_dev->devnum);
 517 }
 518
 519 struct device_type usb_device_type = {
 520         .name =         "usb_device",
 521         .release =      usb_release_dev,
 522         .uevent =       usb_dev_uevent,
 523         .devnode =      usb_devnode,
 524 #ifdef CONFIG_PM
 525         .pm =           &usb_device_pm_ops,
 526 #endif
 527 };
 528
 529
 530 /* Returns 1 if @usb_bus is WUSB, 0 otherwise */
 531 static unsigned usb_bus_is_wusb(struct usb_bus *bus)
 532 {
 533         struct usb_hcd *hcd = bus_to_hcd(bus);
 534         return hcd->wireless;
 535 }
 536
 537 static bool usb_dev_authorized(struct usb_device *dev, struct usb_hcd *hcd)
 538 {
 539         struct usb_hub *hub;
 540
 541         if (!dev->parent)
 542                 return true; /* Root hub always ok [and always wired] */
 543
 544         switch (hcd->dev_policy) {
 545         case USB_DEVICE_AUTHORIZE_NONE:
 546         default:
 547                 return false;
 548
 549         case USB_DEVICE_AUTHORIZE_ALL:
 550                 return true;
 551
 552         case USB_DEVICE_AUTHORIZE_INTERNAL:
 553                 hub = usb_hub_to_struct_hub(dev->parent);
 554                 return hub->ports[dev->portnum - 1]->connect_type ==
 555                                 USB_PORT_CONNECT_TYPE_HARD_WIRED;
 556         }
 557 }
 558
 559 /**
 560  * usb_alloc_dev - usb device constructor (usbcore-internal)
 561  * @parent: hub to which device is connected; null to allocate a root hub
 562  * @bus: bus used to access the device
 563  * @port1: one-based index of port; ignored for root hubs
 564  * Context: !in_interrupt()
 565  *
 566  * Only hub drivers (including virtual root hub drivers for host
 567  * controllers) should ever call this.
 568  *
 569  * This call may not be used in a non-sleeping context.
 570  *
 571  * Return: On success, a pointer to the allocated usb device. %NULL on
 572  * failure.
 573  */
 574 struct usb_device *usb_alloc_dev(struct usb_device *parent,
 575                                  struct usb_bus *bus, unsigned port1)
 576 {
 577         struct usb_device *dev;
 578         struct usb_hcd *usb_hcd = bus_to_hcd(bus);
 579         unsigned root_hub = 0;
 580         unsigned raw_port = port1;
 581
 582         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 583         if (!dev)
 584                 return NULL;
 585
 586         if (!usb_get_hcd(usb_hcd)) {
 587                 kfree(dev);
 588                 return NULL;
 589         }
 590         /* Root hubs aren't true devices, so don't allocate HCD resources */
 591         if (usb_hcd->driver->alloc_dev && parent &&
 592                 !usb_hcd->driver->alloc_dev(usb_hcd, dev)) {
 593                 usb_put_hcd(bus_to_hcd(bus));
 594                 kfree(dev);
 595                 return NULL;
 596         }
 597
 598         device_initialize(&dev->dev);
 599         dev->dev.bus = &usb_bus_type;
 600         dev->dev.type = &usb_device_type;
 601         dev->dev.groups = usb_device_groups;
 602         set_dev_node(&dev->dev, dev_to_node(bus->sysdev));
 603         dev->state = USB_STATE_ATTACHED;
 604         dev->lpm_disable_count = 1;
 605         atomic_set(&dev->urbnum, 0);
 606
 607         INIT_LIST_HEAD(&dev->ep0.urb_list);
 608         dev->ep0.desc.bLength = USB_DT_ENDPOINT_SIZE;
 609         dev->ep0.desc.bDescriptorType = USB_DT_ENDPOINT;
 610         /* ep0 maxpacket comes later, from device descriptor */
 611         usb_enable_endpoint(dev, &dev->ep0, false);
 612         dev->can_submit = 1;
 613
 614         /* Save readable and stable topology id, distinguishing devices
 615          * by location for diagnostics, tools, driver model, etc.  The
 616          * string is a path along hub ports, from the root.  Each device's
 617          * dev->devpath will be stable until USB is re-cabled, and hubs
 618          * are often labeled with these port numbers.  The name isn't
 619          * as stable:  bus->busnum changes easily from modprobe order,
 620          * cardbus or pci hotplugging, and so on.
 621          */
 622         if (unlikely(!parent)) {
 623                 dev->devpath[0] = '0';
 624                 dev->route = 0;
 625
 626                 dev->dev.parent = bus->controller;
 627                 device_set_of_node_from_dev(&dev->dev, bus->sysdev);
 628                 dev_set_name(&dev->dev, "usb%d", bus->busnum);
 629                 root_hub = 1;
 630         } else {
 631                 /* match any labeling on the hubs; it's one-based */
 632                 if (parent->devpath[0] == '0') {
 633                         snprintf(dev->devpath, sizeof dev->devpath,
 634                                 "%d", port1);
 635                         /* Root ports are not counted in route string */
 636                         dev->route = 0;
 637                 } else {
 638                         snprintf(dev->devpath, sizeof dev->devpath,
 639                                 "%s.%d", parent->devpath, port1);
 640                         /* Route string assumes hubs have less than 16 ports */
 641                         if (port1 < 15)
 642                                 dev->route = parent->route +
 643                                         (port1 << ((parent->level - 1)*4));
 644                         else
 645                                 dev->route = parent->route +
 646                                         (15 << ((parent->level - 1)*4));
 647                 }
 648
 649                 dev->dev.parent = &parent->dev;
 650                 dev_set_name(&dev->dev, "%d-%s", bus->busnum, dev->devpath);
 651
 652                 if (!parent->parent) {
 653                         /* device under root hub's port */
 654                         raw_port = usb_hcd_find_raw_port_number(usb_hcd,
 655                                 port1);
 656                 }
 657                 dev->dev.of_node = usb_of_get_device_node(parent, raw_port);
 658
 659                 /* hub driver sets up TT records */
 660         }
 661
 662         dev->portnum = port1;
 663         dev->bus = bus;
 664         dev->parent = parent;
 665         INIT_LIST_HEAD(&dev->filelist);
 666
 667 #ifdef  CONFIG_PM
 668         pm_runtime_set_autosuspend_delay(&dev->dev,
 669                         usb_autosuspend_delay * 1000);
 670         dev->connect_time = jiffies;
 671         dev->active_duration = -jiffies;
 672 #endif
 673
 674         dev->authorized = usb_dev_authorized(dev, usb_hcd);
 675         if (!root_hub)
 676                 dev->wusb = usb_bus_is_wusb(bus) ? 1 : 0;
 677
 678         return dev;
 679 }
 680 EXPORT_SYMBOL_GPL(usb_alloc_dev);
 681
 682 /**
 683  * usb_get_dev - increments the reference count of the usb device structure
 684  * @dev: the device being referenced
 685  *
 686  * Each live reference to a device should be refcounted.
 687  *
 688  * Drivers for USB interfaces should normally record such references in
 689  * their probe() methods, when they bind to an interface, and release
 690  * them by calling usb_put_dev(), in their disconnect() methods.
 691  *
 692  * Return: A pointer to the device with the incremented reference counter.
 693  */
 694 struct usb_device *usb_get_dev(struct usb_device *dev)
 695 {
 696         if (dev)
 697                 get_device(&dev->dev);
 698         return dev;
 699 }
 700 EXPORT_SYMBOL_GPL(usb_get_dev);
 701
 702 /**
 703  * usb_put_dev - release a use of the usb device structure
 704  * @dev: device that's been disconnected
 705  *
 706  * Must be called when a user of a device is finished with it.  When the last
 707  * user of the device calls this function, the memory of the device is freed.
 708  */
 709 void usb_put_dev(struct usb_device *dev)
 710 {
 711         if (dev)
 712                 put_device(&dev->dev);
 713 }
 714 EXPORT_SYMBOL_GPL(usb_put_dev);
 715
 716 /**
 717  * usb_get_intf - increments the reference count of the usb interface structure
 718  * @intf: the interface being referenced
 719  *
 720  * Each live reference to a interface must be refcounted.
 721  *
 722  * Drivers for USB interfaces should normally record such references in
 723  * their probe() methods, when they bind to an interface, and release
 724  * them by calling usb_put_intf(), in their disconnect() methods.
 725  *
 726  * Return: A pointer to the interface with the incremented reference counter.
 727  */
 728 struct usb_interface *usb_get_intf(struct usb_interface *intf)
 729 {
 730         if (intf)
 731                 get_device(&intf->dev);
 732         return intf;
 733 }
 734 EXPORT_SYMBOL_GPL(usb_get_intf);
 735
 736 /**
 737  * usb_put_intf - release a use of the usb interface structure
 738  * @intf: interface that's been decremented
 739  *
 740  * Must be called when a user of an interface is finished with it.  When the
 741  * last user of the interface calls this function, the memory of the interface
 742  * is freed.
 743  */
 744 void usb_put_intf(struct usb_interface *intf)
 745 {
 746         if (intf)
 747                 put_device(&intf->dev);
 748 }
 749 EXPORT_SYMBOL_GPL(usb_put_intf);
 750
 751 /*                      USB device locking
 752  *
 753  * USB devices and interfaces are locked using the semaphore in their
 754  * embedded struct device.  The hub driver guarantees that whenever a
 755  * device is connected or disconnected, drivers are called with the
 756  * USB device locked as well as their particular interface.
 757  *
 758  * Complications arise when several devices are to be locked at the same
 759  * time.  Only hub-aware drivers that are part of usbcore ever have to
 760  * do this; nobody else needs to worry about it.  The rule for locking
 761  * is simple:
 762  *
 763  *      When locking both a device and its parent, always lock the
 764  *      the parent first.
 765  */
 766
 767 /**
 768  * usb_lock_device_for_reset - cautiously acquire the lock for a usb device structure
 769  * @udev: device that's being locked
 770  * @iface: interface bound to the driver making the request (optional)
 771  *
 772  * Attempts to acquire the device lock, but fails if the device is
 773  * NOTATTACHED or SUSPENDED, or if iface is specified and the interface
 774  * is neither BINDING nor BOUND.  Rather than sleeping to wait for the
 775  * lock, the routine polls repeatedly.  This is to prevent deadlock with
 776  * disconnect; in some drivers (such as usb-storage) the disconnect()
 777  * or suspend() method will block waiting for a device reset to complete.
 778  *
 779  * Return: A negative error code for failure, otherwise 0.
 780  */
 781 int usb_lock_device_for_reset(struct usb_device *udev,
 782                               const struct usb_interface *iface)
 783 {
 784         unsigned long jiffies_expire = jiffies + HZ;
 785
 786         if (udev->state == USB_STATE_NOTATTACHED)
 787                 return -ENODEV;
 788         if (udev->state == USB_STATE_SUSPENDED)
 789                 return -EHOSTUNREACH;
 790         if (iface && (iface->condition == USB_INTERFACE_UNBINDING ||
 791                         iface->condition == USB_INTERFACE_UNBOUND))
 792                 return -EINTR;
 793
 794         while (!usb_trylock_device(udev)) {
 795
 796                 /* If we can't acquire the lock after waiting one second,
 797                  * we're probably deadlocked */
 798                 if (time_after(jiffies, jiffies_expire))
 799                         return -EBUSY;
 800
 801                 msleep(15);
 802                 if (udev->state == USB_STATE_NOTATTACHED)
 803                         return -ENODEV;
 804                 if (udev->state == USB_STATE_SUSPENDED)
 805                         return -EHOSTUNREACH;
 806                 if (iface && (iface->condition == USB_INTERFACE_UNBINDING ||
 807                                 iface->condition == USB_INTERFACE_UNBOUND))
 808                         return -EINTR;
 809         }
 810         return 0;
 811 }
 812 EXPORT_SYMBOL_GPL(usb_lock_device_for_reset);
 813
 814 /**
 815  * usb_get_current_frame_number - return current bus frame number
 816  * @dev: the device whose bus is being queried
 817  *
 818  * Return: The current frame number for the USB host controller used
 819  * with the given USB device. This can be used when scheduling
 820  * isochronous requests.
 821  *
 822  * Note: Different kinds of host controller have different "scheduling
 823  * horizons". While one type might support scheduling only 32 frames
 824  * into the future, others could support scheduling up to 1024 frames
 825  * into the future.
 826  *
 827  */
 828 int usb_get_current_frame_number(struct usb_device *dev)
 829 {
 830         return usb_hcd_get_frame_number(dev);
 831 }
 832 EXPORT_SYMBOL_GPL(usb_get_current_frame_number);
 833
 834 /*-------------------------------------------------------------------*/
 835 /*
 836  * __usb_get_extra_descriptor() finds a descriptor of specific type in the
 837  * extra field of the interface and endpoint descriptor structs.
 838  */
 839
 840 int __usb_get_extra_descriptor(char *buffer, unsigned size,
 841                                unsigned char type, void **ptr, size_t minsize)
 842 {
 843         struct usb_descriptor_header *header;
 844
 845         while (size >= sizeof(struct usb_descriptor_header)) {
 846                 header = (struct usb_descriptor_header *)buffer;
 847
 848                 if (header->bLength < 2 || header->bLength > size) {
 849                         printk(KERN_ERR
 850                                 "%s: bogus descriptor, type %d length %d\n",
 851                                 usbcore_name,
 852                                 header->bDescriptorType,
 853                                 header->bLength);
 854                         return -1;
 855                 }
 856
 857                 if (header->bDescriptorType == type && header->bLength >= minsize) {
 858                         *ptr = header;
 859                         return 0;
 860                 }
 861
 862                 buffer += header->bLength;
 863                 size -= header->bLength;
 864         }
 865         return -1;
 866 }
 867 EXPORT_SYMBOL_GPL(__usb_get_extra_descriptor);
 868
 869 /**
 870  * usb_alloc_coherent - allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP
 871  * @dev: device the buffer will be used with
 872  * @size: requested buffer size
 873  * @mem_flags: affect whether allocation may block
 874  * @dma: used to return DMA address of buffer
 875  *
 876  * Return: Either null (indicating no buffer could be allocated), or the
 877  * cpu-space pointer to a buffer that may be used to perform DMA to the
 878  * specified device.  Such cpu-space buffers are returned along with the DMA
 879  * address (through the pointer provided).
 880  *
 881  * Note:
 882  * These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags
 883  * to avoid behaviors like using "DMA bounce buffers", or thrashing IOMMU
 884  * hardware during URB completion/resubmit.  The implementation varies between
 885  * platforms, depending on details of how DMA will work to this device.
 886  * Using these buffers also eliminates cacheline sharing problems on
 887  * architectures where CPU caches are not DMA-coherent.  On systems without
 888  * bus-snooping caches, these buffers are uncached.
 889  *
 890  * When the buffer is no longer used, free it with usb_free_coherent().
 891  */
 892 void *usb_alloc_coherent(struct usb_device *dev, size_t size, gfp_t mem_flags,
 893                          dma_addr_t *dma)
 894 {
 895         if (!dev || !dev->bus)
 896                 return NULL;
 897         return hcd_buffer_alloc(dev->bus, size, mem_flags, dma);
 898 }
 899 EXPORT_SYMBOL_GPL(usb_alloc_coherent);
 900
 901 /**
 902  * usb_free_coherent - free memory allocated with usb_alloc_coherent()
 903  * @dev: device the buffer was used with
 904  * @size: requested buffer size
 905  * @addr: CPU address of buffer
 906  * @dma: DMA address of buffer
 907  *
 908  * This reclaims an I/O buffer, letting it be reused.  The memory must have
 909  * been allocated using usb_alloc_coherent(), and the parameters must match
 910  * those provided in that allocation request.
 911  */
 912 void usb_free_coherent(struct usb_device *dev, size_t size, void *addr,
 913                        dma_addr_t dma)
 914 {
 915         if (!dev || !dev->bus)
 916                 return;
 917         if (!addr)
 918                 return;
 919         hcd_buffer_free(dev->bus, size, addr, dma);
 920 }
 921 EXPORT_SYMBOL_GPL(usb_free_coherent);
 922
 923 /*
 924  * Notifications of device and interface registration
 925  */
 926 static int usb_bus_notify(struct notifier_block *nb, unsigned long action,
 927                 void *data)
 928 {
 929         struct device *dev = data;
 930
 931         switch (action) {
 932         case BUS_NOTIFY_ADD_DEVICE:
 933                 if (dev->type == &usb_device_type)
 934                         (void) usb_create_sysfs_dev_files(to_usb_device(dev));
 935                 else if (dev->type == &usb_if_device_type)
 936                         usb_create_sysfs_intf_files(to_usb_interface(dev));
 937                 break;
 938
 939         case BUS_NOTIFY_DEL_DEVICE:
 940                 if (dev->type == &usb_device_type)
 941                         usb_remove_sysfs_dev_files(to_usb_device(dev));
 942                 else if (dev->type == &usb_if_device_type)
 943                         usb_remove_sysfs_intf_files(to_usb_interface(dev));
 944                 break;
 945         }
 946         return 0;
 947 }
 948
 949 static struct notifier_block usb_bus_nb = {
 950         .notifier_call = usb_bus_notify,
 951 };
 952
 953 static struct dentry *usb_devices_root;
 954
 955 static void usb_debugfs_init(void)
 956 {
 957         usb_devices_root = debugfs_create_file("devices", 0444, usb_debug_root,
 958                                                NULL, &usbfs_devices_fops);
 959 }
 960
 961 static void usb_debugfs_cleanup(void)
 962 {
 963         debugfs_remove(usb_devices_root);
 964 }
 965
 966 /*
 967  * Init
 968  */
 969 static int __init usb_init(void)
 970 {
 971         int retval;
 972         if (usb_disabled()) {
 973                 pr_info("%s: USB support disabled\n", usbcore_name);
 974                 return 0;
 975         }
 976         usb_init_pool_max();
 977
 978         usb_debugfs_init();
 979
 980         usb_acpi_register();
 981         retval = bus_register(&usb_bus_type);
 982         if (retval)
 983                 goto bus_register_failed;
 984         retval = bus_register_notifier(&usb_bus_type, &usb_bus_nb);
 985         if (retval)
 986                 goto bus_notifier_failed;
 987         retval = usb_major_init();
 988         if (retval)
 989                 goto major_init_failed;
 990         retval = usb_register(&usbfs_driver);
 991         if (retval)
 992                 goto driver_register_failed;
 993         retval = usb_devio_init();
 994         if (retval)
 995                 goto usb_devio_init_failed;
 996         retval = usb_hub_init();
 997         if (retval)
 998                 goto hub_init_failed;
 999         retval = usb_register_device_driver(&usb_generic_driver, THIS_MODULE);
1000         if (!retval)
1001                 goto out;
1002
1003         usb_hub_cleanup();
1004 hub_init_failed:
1005         usb_devio_cleanup();
1006 usb_devio_init_failed:
1007         usb_deregister(&usbfs_driver);
1008 driver_register_failed:
1009         usb_major_cleanup();
1010 major_init_failed:
1011         bus_unregister_notifier(&usb_bus_type, &usb_bus_nb);
1012 bus_notifier_failed:
1013         bus_unregister(&usb_bus_type);
1014 bus_register_failed:
1015         usb_acpi_unregister();
1016         usb_debugfs_cleanup();
1017 out:
1018         return retval;
1019 }
1020
1021 /*
1022  * Cleanup
1023  */
1024 static void __exit usb_exit(void)
1025 {
1026         /* This will matter if shutdown/reboot does exitcalls. */
1027         if (usb_disabled())
1028                 return;
1029
1030         usb_release_quirk_list();
1031         usb_deregister_device_driver(&usb_generic_driver);
1032         usb_major_cleanup();
1033         usb_deregister(&usbfs_driver);
1034         usb_devio_cleanup();
1035         usb_hub_cleanup();
1036         bus_unregister_notifier(&usb_bus_type, &usb_bus_nb);
1037         bus_unregister(&usb_bus_type);
1038         usb_acpi_unregister();
1039         usb_debugfs_cleanup();
1040         idr_destroy(&usb_bus_idr);
1041 }
1042
1043 subsys_initcall(usb_init);
1044 module_exit(usb_exit);
1045 MODULE_LICENSE("GPL");