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