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