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