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