drivers/usb/core/usb.c

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