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