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