Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #include <linux/module.h> |
2 | #include <linux/string.h> | |
3 | #include <linux/bitops.h> | |
4 | #include <linux/slab.h> | |
5 | #include <linux/init.h> | |
d617bc83 | 6 | #include <linux/log2.h> |
1da177e4 | 7 | #include <linux/usb.h> |
51a2f077 | 8 | #include <linux/wait.h> |
27729aad | 9 | #include <linux/usb/hcd.h> |
1da177e4 LT |
10 | |
11 | #define to_urb(d) container_of(d, struct urb, kref) | |
12 | ||
6a2839be | 13 | |
1da177e4 LT |
14 | static void urb_destroy(struct kref *kref) |
15 | { | |
16 | struct urb *urb = to_urb(kref); | |
51a2f077 | 17 | |
8b3b01c8 MH |
18 | if (urb->transfer_flags & URB_FREE_BUFFER) |
19 | kfree(urb->transfer_buffer); | |
20 | ||
1da177e4 LT |
21 | kfree(urb); |
22 | } | |
23 | ||
24 | /** | |
25 | * usb_init_urb - initializes a urb so that it can be used by a USB driver | |
26 | * @urb: pointer to the urb to initialize | |
27 | * | |
28 | * Initializes a urb so that the USB subsystem can use it properly. | |
29 | * | |
30 | * If a urb is created with a call to usb_alloc_urb() it is not | |
31 | * necessary to call this function. Only use this if you allocate the | |
32 | * space for a struct urb on your own. If you call this function, be | |
33 | * careful when freeing the memory for your urb that it is no longer in | |
34 | * use by the USB core. | |
35 | * | |
36 | * Only use this function if you _really_ understand what you are doing. | |
37 | */ | |
38 | void usb_init_urb(struct urb *urb) | |
39 | { | |
40 | if (urb) { | |
41 | memset(urb, 0, sizeof(*urb)); | |
42 | kref_init(&urb->kref); | |
51a2f077 | 43 | INIT_LIST_HEAD(&urb->anchor_list); |
1da177e4 LT |
44 | } |
45 | } | |
782e70c6 | 46 | EXPORT_SYMBOL_GPL(usb_init_urb); |
1da177e4 LT |
47 | |
48 | /** | |
49 | * usb_alloc_urb - creates a new urb for a USB driver to use | |
50 | * @iso_packets: number of iso packets for this urb | |
51 | * @mem_flags: the type of memory to allocate, see kmalloc() for a list of | |
52 | * valid options for this. | |
53 | * | |
54 | * Creates an urb for the USB driver to use, initializes a few internal | |
55 | * structures, incrementes the usage counter, and returns a pointer to it. | |
56 | * | |
57 | * If no memory is available, NULL is returned. | |
58 | * | |
59 | * If the driver want to use this urb for interrupt, control, or bulk | |
60 | * endpoints, pass '0' as the number of iso packets. | |
61 | * | |
62 | * The driver must call usb_free_urb() when it is finished with the urb. | |
63 | */ | |
55016f10 | 64 | struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags) |
1da177e4 LT |
65 | { |
66 | struct urb *urb; | |
67 | ||
ec17cf1c | 68 | urb = kmalloc(sizeof(struct urb) + |
1da177e4 LT |
69 | iso_packets * sizeof(struct usb_iso_packet_descriptor), |
70 | mem_flags); | |
71 | if (!urb) { | |
69a85942 | 72 | printk(KERN_ERR "alloc_urb: kmalloc failed\n"); |
1da177e4 LT |
73 | return NULL; |
74 | } | |
75 | usb_init_urb(urb); | |
76 | return urb; | |
77 | } | |
782e70c6 | 78 | EXPORT_SYMBOL_GPL(usb_alloc_urb); |
1da177e4 LT |
79 | |
80 | /** | |
81 | * usb_free_urb - frees the memory used by a urb when all users of it are finished | |
82 | * @urb: pointer to the urb to free, may be NULL | |
83 | * | |
84 | * Must be called when a user of a urb is finished with it. When the last user | |
85 | * of the urb calls this function, the memory of the urb is freed. | |
86 | * | |
2870fde7 RV |
87 | * Note: The transfer buffer associated with the urb is not freed unless the |
88 | * URB_FREE_BUFFER transfer flag is set. | |
1da177e4 LT |
89 | */ |
90 | void usb_free_urb(struct urb *urb) | |
91 | { | |
92 | if (urb) | |
93 | kref_put(&urb->kref, urb_destroy); | |
94 | } | |
782e70c6 | 95 | EXPORT_SYMBOL_GPL(usb_free_urb); |
1da177e4 LT |
96 | |
97 | /** | |
98 | * usb_get_urb - increments the reference count of the urb | |
99 | * @urb: pointer to the urb to modify, may be NULL | |
100 | * | |
101 | * This must be called whenever a urb is transferred from a device driver to a | |
102 | * host controller driver. This allows proper reference counting to happen | |
103 | * for urbs. | |
104 | * | |
105 | * A pointer to the urb with the incremented reference counter is returned. | |
106 | */ | |
2c044a48 | 107 | struct urb *usb_get_urb(struct urb *urb) |
1da177e4 LT |
108 | { |
109 | if (urb) | |
110 | kref_get(&urb->kref); | |
111 | return urb; | |
112 | } | |
782e70c6 | 113 | EXPORT_SYMBOL_GPL(usb_get_urb); |
51a2f077 ON |
114 | |
115 | /** | |
116 | * usb_anchor_urb - anchors an URB while it is processed | |
117 | * @urb: pointer to the urb to anchor | |
118 | * @anchor: pointer to the anchor | |
119 | * | |
120 | * This can be called to have access to URBs which are to be executed | |
121 | * without bothering to track them | |
122 | */ | |
123 | void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor) | |
124 | { | |
125 | unsigned long flags; | |
126 | ||
127 | spin_lock_irqsave(&anchor->lock, flags); | |
128 | usb_get_urb(urb); | |
129 | list_add_tail(&urb->anchor_list, &anchor->urb_list); | |
130 | urb->anchor = anchor; | |
6a2839be ON |
131 | |
132 | if (unlikely(anchor->poisoned)) { | |
49367d8f | 133 | atomic_inc(&urb->reject); |
6a2839be ON |
134 | } |
135 | ||
51a2f077 ON |
136 | spin_unlock_irqrestore(&anchor->lock, flags); |
137 | } | |
138 | EXPORT_SYMBOL_GPL(usb_anchor_urb); | |
139 | ||
b3e67044 CL |
140 | /* Callers must hold anchor->lock */ |
141 | static void __usb_unanchor_urb(struct urb *urb, struct usb_anchor *anchor) | |
142 | { | |
143 | urb->anchor = NULL; | |
144 | list_del(&urb->anchor_list); | |
145 | usb_put_urb(urb); | |
146 | if (list_empty(&anchor->urb_list)) | |
147 | wake_up(&anchor->wait); | |
148 | } | |
149 | ||
51a2f077 ON |
150 | /** |
151 | * usb_unanchor_urb - unanchors an URB | |
152 | * @urb: pointer to the urb to anchor | |
153 | * | |
154 | * Call this to stop the system keeping track of this URB | |
155 | */ | |
156 | void usb_unanchor_urb(struct urb *urb) | |
157 | { | |
158 | unsigned long flags; | |
159 | struct usb_anchor *anchor; | |
160 | ||
161 | if (!urb) | |
162 | return; | |
163 | ||
164 | anchor = urb->anchor; | |
165 | if (!anchor) | |
166 | return; | |
167 | ||
168 | spin_lock_irqsave(&anchor->lock, flags); | |
b3e67044 CL |
169 | /* |
170 | * At this point, we could be competing with another thread which | |
171 | * has the same intention. To protect the urb from being unanchored | |
172 | * twice, only the winner of the race gets the job. | |
173 | */ | |
174 | if (likely(anchor == urb->anchor)) | |
175 | __usb_unanchor_urb(urb, anchor); | |
51a2f077 | 176 | spin_unlock_irqrestore(&anchor->lock, flags); |
51a2f077 ON |
177 | } |
178 | EXPORT_SYMBOL_GPL(usb_unanchor_urb); | |
179 | ||
1da177e4 LT |
180 | /*-------------------------------------------------------------------*/ |
181 | ||
182 | /** | |
183 | * usb_submit_urb - issue an asynchronous transfer request for an endpoint | |
184 | * @urb: pointer to the urb describing the request | |
185 | * @mem_flags: the type of memory to allocate, see kmalloc() for a list | |
186 | * of valid options for this. | |
187 | * | |
188 | * This submits a transfer request, and transfers control of the URB | |
189 | * describing that request to the USB subsystem. Request completion will | |
190 | * be indicated later, asynchronously, by calling the completion handler. | |
191 | * The three types of completion are success, error, and unlink | |
2c044a48 | 192 | * (a software-induced fault, also called "request cancellation"). |
1da177e4 LT |
193 | * |
194 | * URBs may be submitted in interrupt context. | |
195 | * | |
196 | * The caller must have correctly initialized the URB before submitting | |
197 | * it. Functions such as usb_fill_bulk_urb() and usb_fill_control_urb() are | |
198 | * available to ensure that most fields are correctly initialized, for | |
199 | * the particular kind of transfer, although they will not initialize | |
200 | * any transfer flags. | |
201 | * | |
202 | * Successful submissions return 0; otherwise this routine returns a | |
203 | * negative error number. If the submission is successful, the complete() | |
204 | * callback from the URB will be called exactly once, when the USB core and | |
205 | * Host Controller Driver (HCD) are finished with the URB. When the completion | |
206 | * function is called, control of the URB is returned to the device | |
207 | * driver which issued the request. The completion handler may then | |
208 | * immediately free or reuse that URB. | |
209 | * | |
210 | * With few exceptions, USB device drivers should never access URB fields | |
211 | * provided by usbcore or the HCD until its complete() is called. | |
212 | * The exceptions relate to periodic transfer scheduling. For both | |
213 | * interrupt and isochronous urbs, as part of successful URB submission | |
214 | * urb->interval is modified to reflect the actual transfer period used | |
215 | * (normally some power of two units). And for isochronous urbs, | |
216 | * urb->start_frame is modified to reflect when the URB's transfers were | |
217 | * scheduled to start. Not all isochronous transfer scheduling policies | |
218 | * will work, but most host controller drivers should easily handle ISO | |
219 | * queues going from now until 10-200 msec into the future. | |
220 | * | |
221 | * For control endpoints, the synchronous usb_control_msg() call is | |
222 | * often used (in non-interrupt context) instead of this call. | |
223 | * That is often used through convenience wrappers, for the requests | |
224 | * that are standardized in the USB 2.0 specification. For bulk | |
225 | * endpoints, a synchronous usb_bulk_msg() call is available. | |
226 | * | |
227 | * Request Queuing: | |
228 | * | |
229 | * URBs may be submitted to endpoints before previous ones complete, to | |
230 | * minimize the impact of interrupt latencies and system overhead on data | |
231 | * throughput. With that queuing policy, an endpoint's queue would never | |
232 | * be empty. This is required for continuous isochronous data streams, | |
233 | * and may also be required for some kinds of interrupt transfers. Such | |
234 | * queuing also maximizes bandwidth utilization by letting USB controllers | |
235 | * start work on later requests before driver software has finished the | |
236 | * completion processing for earlier (successful) requests. | |
237 | * | |
238 | * As of Linux 2.6, all USB endpoint transfer queues support depths greater | |
239 | * than one. This was previously a HCD-specific behavior, except for ISO | |
240 | * transfers. Non-isochronous endpoint queues are inactive during cleanup | |
093cf723 | 241 | * after faults (transfer errors or cancellation). |
1da177e4 LT |
242 | * |
243 | * Reserved Bandwidth Transfers: | |
244 | * | |
245 | * Periodic transfers (interrupt or isochronous) are performed repeatedly, | |
246 | * using the interval specified in the urb. Submitting the first urb to | |
247 | * the endpoint reserves the bandwidth necessary to make those transfers. | |
248 | * If the USB subsystem can't allocate sufficient bandwidth to perform | |
249 | * the periodic request, submitting such a periodic request should fail. | |
250 | * | |
79abb1ab SS |
251 | * For devices under xHCI, the bandwidth is reserved at configuration time, or |
252 | * when the alt setting is selected. If there is not enough bus bandwidth, the | |
253 | * configuration/alt setting request will fail. Therefore, submissions to | |
254 | * periodic endpoints on devices under xHCI should never fail due to bandwidth | |
255 | * constraints. | |
256 | * | |
1da177e4 LT |
257 | * Device drivers must explicitly request that repetition, by ensuring that |
258 | * some URB is always on the endpoint's queue (except possibly for short | |
259 | * periods during completion callacks). When there is no longer an urb | |
260 | * queued, the endpoint's bandwidth reservation is canceled. This means | |
261 | * drivers can use their completion handlers to ensure they keep bandwidth | |
262 | * they need, by reinitializing and resubmitting the just-completed urb | |
263 | * until the driver longer needs that periodic bandwidth. | |
264 | * | |
265 | * Memory Flags: | |
266 | * | |
267 | * The general rules for how to decide which mem_flags to use | |
268 | * are the same as for kmalloc. There are four | |
269 | * different possible values; GFP_KERNEL, GFP_NOFS, GFP_NOIO and | |
270 | * GFP_ATOMIC. | |
271 | * | |
272 | * GFP_NOFS is not ever used, as it has not been implemented yet. | |
273 | * | |
274 | * GFP_ATOMIC is used when | |
275 | * (a) you are inside a completion handler, an interrupt, bottom half, | |
276 | * tasklet or timer, or | |
277 | * (b) you are holding a spinlock or rwlock (does not apply to | |
278 | * semaphores), or | |
279 | * (c) current->state != TASK_RUNNING, this is the case only after | |
280 | * you've changed it. | |
2c044a48 | 281 | * |
1da177e4 LT |
282 | * GFP_NOIO is used in the block io path and error handling of storage |
283 | * devices. | |
284 | * | |
285 | * All other situations use GFP_KERNEL. | |
286 | * | |
287 | * Some more specific rules for mem_flags can be inferred, such as | |
288 | * (1) start_xmit, timeout, and receive methods of network drivers must | |
289 | * use GFP_ATOMIC (they are called with a spinlock held); | |
290 | * (2) queuecommand methods of scsi drivers must use GFP_ATOMIC (also | |
291 | * called with a spinlock held); | |
292 | * (3) If you use a kernel thread with a network driver you must use | |
293 | * GFP_NOIO, unless (b) or (c) apply; | |
294 | * (4) after you have done a down() you can use GFP_KERNEL, unless (b) or (c) | |
295 | * apply or your are in a storage driver's block io path; | |
296 | * (5) USB probe and disconnect can use GFP_KERNEL unless (b) or (c) apply; and | |
297 | * (6) changing firmware on a running storage or net device uses | |
298 | * GFP_NOIO, unless b) or c) apply | |
299 | * | |
300 | */ | |
55016f10 | 301 | int usb_submit_urb(struct urb *urb, gfp_t mem_flags) |
1da177e4 | 302 | { |
5b653c79 AS |
303 | int xfertype, max; |
304 | struct usb_device *dev; | |
305 | struct usb_host_endpoint *ep; | |
306 | int is_out; | |
1da177e4 LT |
307 | |
308 | if (!urb || urb->hcpriv || !urb->complete) | |
309 | return -EINVAL; | |
2c044a48 | 310 | dev = urb->dev; |
6da9c990 | 311 | if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED)) |
1da177e4 | 312 | return -ENODEV; |
1da177e4 | 313 | |
5b653c79 AS |
314 | /* For now, get the endpoint from the pipe. Eventually drivers |
315 | * will be required to set urb->ep directly and we will eliminate | |
316 | * urb->pipe. | |
317 | */ | |
fe54b058 | 318 | ep = usb_pipe_endpoint(dev, urb->pipe); |
5b653c79 AS |
319 | if (!ep) |
320 | return -ENOENT; | |
321 | ||
322 | urb->ep = ep; | |
1da177e4 LT |
323 | urb->status = -EINPROGRESS; |
324 | urb->actual_length = 0; | |
1da177e4 LT |
325 | |
326 | /* Lots of sanity checks, so HCDs can rely on clean data | |
327 | * and don't need to duplicate tests | |
328 | */ | |
5b653c79 | 329 | xfertype = usb_endpoint_type(&ep->desc); |
fea34091 AS |
330 | if (xfertype == USB_ENDPOINT_XFER_CONTROL) { |
331 | struct usb_ctrlrequest *setup = | |
332 | (struct usb_ctrlrequest *) urb->setup_packet; | |
333 | ||
334 | if (!setup) | |
335 | return -ENOEXEC; | |
336 | is_out = !(setup->bRequestType & USB_DIR_IN) || | |
337 | !setup->wLength; | |
338 | } else { | |
339 | is_out = usb_endpoint_dir_out(&ep->desc); | |
340 | } | |
341 | ||
ff9c895f AS |
342 | /* Clear the internal flags and cache the direction for later use */ |
343 | urb->transfer_flags &= ~(URB_DIR_MASK | URB_DMA_MAP_SINGLE | | |
344 | URB_DMA_MAP_PAGE | URB_DMA_MAP_SG | URB_MAP_LOCAL | | |
345 | URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL | | |
346 | URB_DMA_SG_COMBINED); | |
347 | urb->transfer_flags |= (is_out ? URB_DIR_OUT : URB_DIR_IN); | |
1da177e4 | 348 | |
5b653c79 AS |
349 | if (xfertype != USB_ENDPOINT_XFER_CONTROL && |
350 | dev->state < USB_STATE_CONFIGURED) | |
1da177e4 LT |
351 | return -ENODEV; |
352 | ||
29cc8897 | 353 | max = usb_endpoint_maxp(&ep->desc); |
1da177e4 LT |
354 | if (max <= 0) { |
355 | dev_dbg(&dev->dev, | |
356 | "bogus endpoint ep%d%s in %s (bad maxpacket %d)\n", | |
5b653c79 | 357 | usb_endpoint_num(&ep->desc), is_out ? "out" : "in", |
441b62c1 | 358 | __func__, max); |
1da177e4 LT |
359 | return -EMSGSIZE; |
360 | } | |
361 | ||
362 | /* periodic transfers limit size per frame/uframe, | |
363 | * but drivers only control those sizes for ISO. | |
364 | * while we're checking, initialize return status. | |
365 | */ | |
5b653c79 | 366 | if (xfertype == USB_ENDPOINT_XFER_ISOC) { |
1da177e4 LT |
367 | int n, len; |
368 | ||
500132a0 PZ |
369 | /* SuperSpeed isoc endpoints have up to 16 bursts of up to |
370 | * 3 packets each | |
371 | */ | |
372 | if (dev->speed == USB_SPEED_SUPER) { | |
373 | int burst = 1 + ep->ss_ep_comp.bMaxBurst; | |
374 | int mult = USB_SS_MULT(ep->ss_ep_comp.bmAttributes); | |
375 | max *= burst; | |
376 | max *= mult; | |
377 | } | |
378 | ||
1da177e4 LT |
379 | /* "high bandwidth" mode, 1-3 packets/uframe? */ |
380 | if (dev->speed == USB_SPEED_HIGH) { | |
381 | int mult = 1 + ((max >> 11) & 0x03); | |
382 | max &= 0x07ff; | |
383 | max *= mult; | |
384 | } | |
385 | ||
2c044a48 | 386 | if (urb->number_of_packets <= 0) |
1da177e4 LT |
387 | return -EINVAL; |
388 | for (n = 0; n < urb->number_of_packets; n++) { | |
9251644a | 389 | len = urb->iso_frame_desc[n].length; |
2c044a48 | 390 | if (len < 0 || len > max) |
1da177e4 | 391 | return -EMSGSIZE; |
9251644a ON |
392 | urb->iso_frame_desc[n].status = -EXDEV; |
393 | urb->iso_frame_desc[n].actual_length = 0; | |
1da177e4 LT |
394 | } |
395 | } | |
396 | ||
397 | /* the I/O buffer must be mapped/unmapped, except when length=0 */ | |
71d2718f | 398 | if (urb->transfer_buffer_length > INT_MAX) |
1da177e4 LT |
399 | return -EMSGSIZE; |
400 | ||
401 | #ifdef DEBUG | |
402 | /* stuff that drivers shouldn't do, but which shouldn't | |
403 | * cause problems in HCDs if they get it wrong. | |
404 | */ | |
405 | { | |
1da177e4 | 406 | unsigned int allowed; |
f661c6f8 AS |
407 | static int pipetypes[4] = { |
408 | PIPE_CONTROL, PIPE_ISOCHRONOUS, PIPE_BULK, PIPE_INTERRUPT | |
409 | }; | |
410 | ||
411 | /* Check that the pipe's type matches the endpoint's type */ | |
0cb54a3e AS |
412 | if (usb_pipetype(urb->pipe) != pipetypes[xfertype]) |
413 | dev_WARN(&dev->dev, "BOGUS urb xfer, pipe %x != type %x\n", | |
f7dd6491 | 414 | usb_pipetype(urb->pipe), pipetypes[xfertype]); |
1da177e4 | 415 | |
0cb54a3e | 416 | /* Check against a simple/standard policy */ |
0ede76fc AS |
417 | allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_INTERRUPT | URB_DIR_MASK | |
418 | URB_FREE_BUFFER); | |
5b653c79 AS |
419 | switch (xfertype) { |
420 | case USB_ENDPOINT_XFER_BULK: | |
1da177e4 LT |
421 | if (is_out) |
422 | allowed |= URB_ZERO_PACKET; | |
423 | /* FALLTHROUGH */ | |
5b653c79 | 424 | case USB_ENDPOINT_XFER_CONTROL: |
1da177e4 LT |
425 | allowed |= URB_NO_FSBR; /* only affects UHCI */ |
426 | /* FALLTHROUGH */ | |
427 | default: /* all non-iso endpoints */ | |
428 | if (!is_out) | |
429 | allowed |= URB_SHORT_NOT_OK; | |
430 | break; | |
5b653c79 | 431 | case USB_ENDPOINT_XFER_ISOC: |
1da177e4 LT |
432 | allowed |= URB_ISO_ASAP; |
433 | break; | |
434 | } | |
0cb54a3e | 435 | allowed &= urb->transfer_flags; |
1da177e4 | 436 | |
0cb54a3e AS |
437 | /* warn if submitter gave bogus flags */ |
438 | if (allowed != urb->transfer_flags) | |
439 | dev_WARN(&dev->dev, "BOGUS urb flags, %x --> %x\n", | |
440 | urb->transfer_flags, allowed); | |
1da177e4 LT |
441 | } |
442 | #endif | |
443 | /* | |
444 | * Force periodic transfer intervals to be legal values that are | |
445 | * a power of two (so HCDs don't need to). | |
446 | * | |
447 | * FIXME want bus->{intr,iso}_sched_horizon values here. Each HC | |
448 | * supports different values... this uses EHCI/UHCI defaults (and | |
449 | * EHCI can use smaller non-default values). | |
450 | */ | |
5b653c79 AS |
451 | switch (xfertype) { |
452 | case USB_ENDPOINT_XFER_ISOC: | |
453 | case USB_ENDPOINT_XFER_INT: | |
1da177e4 | 454 | /* too small? */ |
8e08b976 | 455 | switch (dev->speed) { |
551cdbbe | 456 | case USB_SPEED_WIRELESS: |
8e08b976 DV |
457 | if (urb->interval < 6) |
458 | return -EINVAL; | |
459 | break; | |
460 | default: | |
461 | if (urb->interval <= 0) | |
462 | return -EINVAL; | |
463 | break; | |
464 | } | |
1da177e4 LT |
465 | /* too big? */ |
466 | switch (dev->speed) { | |
6b403b02 SS |
467 | case USB_SPEED_SUPER: /* units are 125us */ |
468 | /* Handle up to 2^(16-1) microframes */ | |
469 | if (urb->interval > (1 << 15)) | |
470 | return -EINVAL; | |
471 | max = 1 << 15; | |
f09a15e6 | 472 | break; |
551cdbbe | 473 | case USB_SPEED_WIRELESS: |
8e08b976 DV |
474 | if (urb->interval > 16) |
475 | return -EINVAL; | |
476 | break; | |
1da177e4 | 477 | case USB_SPEED_HIGH: /* units are microframes */ |
2c044a48 | 478 | /* NOTE usb handles 2^15 */ |
1da177e4 LT |
479 | if (urb->interval > (1024 * 8)) |
480 | urb->interval = 1024 * 8; | |
5b653c79 | 481 | max = 1024 * 8; |
1da177e4 LT |
482 | break; |
483 | case USB_SPEED_FULL: /* units are frames/msec */ | |
484 | case USB_SPEED_LOW: | |
5b653c79 | 485 | if (xfertype == USB_ENDPOINT_XFER_INT) { |
1da177e4 LT |
486 | if (urb->interval > 255) |
487 | return -EINVAL; | |
2c044a48 | 488 | /* NOTE ohci only handles up to 32 */ |
5b653c79 | 489 | max = 128; |
1da177e4 LT |
490 | } else { |
491 | if (urb->interval > 1024) | |
492 | urb->interval = 1024; | |
2c044a48 | 493 | /* NOTE usb and ohci handle up to 2^15 */ |
5b653c79 | 494 | max = 1024; |
1da177e4 LT |
495 | } |
496 | break; | |
497 | default: | |
498 | return -EINVAL; | |
499 | } | |
551cdbbe | 500 | if (dev->speed != USB_SPEED_WIRELESS) { |
8e08b976 DV |
501 | /* Round down to a power of 2, no more than max */ |
502 | urb->interval = min(max, 1 << ilog2(urb->interval)); | |
503 | } | |
1da177e4 LT |
504 | } |
505 | ||
9251644a | 506 | return usb_hcd_submit_urb(urb, mem_flags); |
1da177e4 | 507 | } |
782e70c6 | 508 | EXPORT_SYMBOL_GPL(usb_submit_urb); |
1da177e4 LT |
509 | |
510 | /*-------------------------------------------------------------------*/ | |
511 | ||
512 | /** | |
513 | * usb_unlink_urb - abort/cancel a transfer request for an endpoint | |
514 | * @urb: pointer to urb describing a previously submitted request, | |
515 | * may be NULL | |
516 | * | |
beafef07 AS |
517 | * This routine cancels an in-progress request. URBs complete only once |
518 | * per submission, and may be canceled only once per submission. | |
519 | * Successful cancellation means termination of @urb will be expedited | |
520 | * and the completion handler will be called with a status code | |
521 | * indicating that the request has been canceled (rather than any other | |
522 | * code). | |
523 | * | |
cde217a5 AS |
524 | * Drivers should not call this routine or related routines, such as |
525 | * usb_kill_urb() or usb_unlink_anchored_urbs(), after their disconnect | |
526 | * method has returned. The disconnect function should synchronize with | |
527 | * a driver's I/O routines to insure that all URB-related activity has | |
528 | * completed before it returns. | |
529 | * | |
beafef07 AS |
530 | * This request is always asynchronous. Success is indicated by |
531 | * returning -EINPROGRESS, at which time the URB will probably not yet | |
532 | * have been given back to the device driver. When it is eventually | |
533 | * called, the completion function will see @urb->status == -ECONNRESET. | |
534 | * Failure is indicated by usb_unlink_urb() returning any other value. | |
535 | * Unlinking will fail when @urb is not currently "linked" (i.e., it was | |
536 | * never submitted, or it was unlinked before, or the hardware is already | |
537 | * finished with it), even if the completion handler has not yet run. | |
1da177e4 LT |
538 | * |
539 | * Unlinking and Endpoint Queues: | |
540 | * | |
beafef07 AS |
541 | * [The behaviors and guarantees described below do not apply to virtual |
542 | * root hubs but only to endpoint queues for physical USB devices.] | |
543 | * | |
1da177e4 LT |
544 | * Host Controller Drivers (HCDs) place all the URBs for a particular |
545 | * endpoint in a queue. Normally the queue advances as the controller | |
8835f665 | 546 | * hardware processes each request. But when an URB terminates with an |
beafef07 AS |
547 | * error its queue generally stops (see below), at least until that URB's |
548 | * completion routine returns. It is guaranteed that a stopped queue | |
549 | * will not restart until all its unlinked URBs have been fully retired, | |
550 | * with their completion routines run, even if that's not until some time | |
551 | * after the original completion handler returns. The same behavior and | |
552 | * guarantee apply when an URB terminates because it was unlinked. | |
553 | * | |
554 | * Bulk and interrupt endpoint queues are guaranteed to stop whenever an | |
555 | * URB terminates with any sort of error, including -ECONNRESET, -ENOENT, | |
556 | * and -EREMOTEIO. Control endpoint queues behave the same way except | |
557 | * that they are not guaranteed to stop for -EREMOTEIO errors. Queues | |
558 | * for isochronous endpoints are treated differently, because they must | |
559 | * advance at fixed rates. Such queues do not stop when an URB | |
560 | * encounters an error or is unlinked. An unlinked isochronous URB may | |
561 | * leave a gap in the stream of packets; it is undefined whether such | |
562 | * gaps can be filled in. | |
563 | * | |
564 | * Note that early termination of an URB because a short packet was | |
565 | * received will generate a -EREMOTEIO error if and only if the | |
566 | * URB_SHORT_NOT_OK flag is set. By setting this flag, USB device | |
567 | * drivers can build deep queues for large or complex bulk transfers | |
568 | * and clean them up reliably after any sort of aborted transfer by | |
569 | * unlinking all pending URBs at the first fault. | |
570 | * | |
571 | * When a control URB terminates with an error other than -EREMOTEIO, it | |
572 | * is quite likely that the status stage of the transfer will not take | |
573 | * place. | |
1da177e4 LT |
574 | */ |
575 | int usb_unlink_urb(struct urb *urb) | |
576 | { | |
577 | if (!urb) | |
578 | return -EINVAL; | |
d617bc83 | 579 | if (!urb->dev) |
1da177e4 | 580 | return -ENODEV; |
d617bc83 AS |
581 | if (!urb->ep) |
582 | return -EIDRM; | |
a6d2bb9f | 583 | return usb_hcd_unlink_urb(urb, -ECONNRESET); |
1da177e4 | 584 | } |
782e70c6 | 585 | EXPORT_SYMBOL_GPL(usb_unlink_urb); |
1da177e4 LT |
586 | |
587 | /** | |
588 | * usb_kill_urb - cancel a transfer request and wait for it to finish | |
589 | * @urb: pointer to URB describing a previously submitted request, | |
590 | * may be NULL | |
591 | * | |
592 | * This routine cancels an in-progress request. It is guaranteed that | |
593 | * upon return all completion handlers will have finished and the URB | |
594 | * will be totally idle and available for reuse. These features make | |
595 | * this an ideal way to stop I/O in a disconnect() callback or close() | |
596 | * function. If the request has not already finished or been unlinked | |
597 | * the completion handler will see urb->status == -ENOENT. | |
598 | * | |
599 | * While the routine is running, attempts to resubmit the URB will fail | |
600 | * with error -EPERM. Thus even if the URB's completion handler always | |
601 | * tries to resubmit, it will not succeed and the URB will become idle. | |
602 | * | |
603 | * This routine may not be used in an interrupt context (such as a bottom | |
604 | * half or a completion handler), or when holding a spinlock, or in other | |
605 | * situations where the caller can't schedule(). | |
cde217a5 AS |
606 | * |
607 | * This routine should not be called by a driver after its disconnect | |
608 | * method has returned. | |
1da177e4 LT |
609 | */ |
610 | void usb_kill_urb(struct urb *urb) | |
611 | { | |
e9aa795a | 612 | might_sleep(); |
d617bc83 | 613 | if (!(urb && urb->dev && urb->ep)) |
1da177e4 | 614 | return; |
49367d8f | 615 | atomic_inc(&urb->reject); |
1da177e4 | 616 | |
a6d2bb9f | 617 | usb_hcd_unlink_urb(urb, -ENOENT); |
1da177e4 LT |
618 | wait_event(usb_kill_urb_queue, atomic_read(&urb->use_count) == 0); |
619 | ||
49367d8f | 620 | atomic_dec(&urb->reject); |
1da177e4 | 621 | } |
782e70c6 | 622 | EXPORT_SYMBOL_GPL(usb_kill_urb); |
1da177e4 | 623 | |
55b447bf ON |
624 | /** |
625 | * usb_poison_urb - reliably kill a transfer and prevent further use of an URB | |
626 | * @urb: pointer to URB describing a previously submitted request, | |
627 | * may be NULL | |
628 | * | |
629 | * This routine cancels an in-progress request. It is guaranteed that | |
630 | * upon return all completion handlers will have finished and the URB | |
631 | * will be totally idle and cannot be reused. These features make | |
632 | * this an ideal way to stop I/O in a disconnect() callback. | |
633 | * If the request has not already finished or been unlinked | |
634 | * the completion handler will see urb->status == -ENOENT. | |
635 | * | |
636 | * After and while the routine runs, attempts to resubmit the URB will fail | |
637 | * with error -EPERM. Thus even if the URB's completion handler always | |
638 | * tries to resubmit, it will not succeed and the URB will become idle. | |
639 | * | |
640 | * This routine may not be used in an interrupt context (such as a bottom | |
641 | * half or a completion handler), or when holding a spinlock, or in other | |
642 | * situations where the caller can't schedule(). | |
cde217a5 AS |
643 | * |
644 | * This routine should not be called by a driver after its disconnect | |
645 | * method has returned. | |
55b447bf ON |
646 | */ |
647 | void usb_poison_urb(struct urb *urb) | |
648 | { | |
649 | might_sleep(); | |
650 | if (!(urb && urb->dev && urb->ep)) | |
651 | return; | |
49367d8f | 652 | atomic_inc(&urb->reject); |
55b447bf ON |
653 | |
654 | usb_hcd_unlink_urb(urb, -ENOENT); | |
655 | wait_event(usb_kill_urb_queue, atomic_read(&urb->use_count) == 0); | |
656 | } | |
657 | EXPORT_SYMBOL_GPL(usb_poison_urb); | |
658 | ||
659 | void usb_unpoison_urb(struct urb *urb) | |
660 | { | |
661 | if (!urb) | |
662 | return; | |
663 | ||
49367d8f | 664 | atomic_dec(&urb->reject); |
55b447bf ON |
665 | } |
666 | EXPORT_SYMBOL_GPL(usb_unpoison_urb); | |
667 | ||
51a2f077 ON |
668 | /** |
669 | * usb_kill_anchored_urbs - cancel transfer requests en masse | |
670 | * @anchor: anchor the requests are bound to | |
671 | * | |
672 | * this allows all outstanding URBs to be killed starting | |
673 | * from the back of the queue | |
cde217a5 AS |
674 | * |
675 | * This routine should not be called by a driver after its disconnect | |
676 | * method has returned. | |
51a2f077 ON |
677 | */ |
678 | void usb_kill_anchored_urbs(struct usb_anchor *anchor) | |
679 | { | |
680 | struct urb *victim; | |
681 | ||
682 | spin_lock_irq(&anchor->lock); | |
683 | while (!list_empty(&anchor->urb_list)) { | |
2c044a48 GKH |
684 | victim = list_entry(anchor->urb_list.prev, struct urb, |
685 | anchor_list); | |
51a2f077 ON |
686 | /* we must make sure the URB isn't freed before we kill it*/ |
687 | usb_get_urb(victim); | |
688 | spin_unlock_irq(&anchor->lock); | |
689 | /* this will unanchor the URB */ | |
690 | usb_kill_urb(victim); | |
691 | usb_put_urb(victim); | |
692 | spin_lock_irq(&anchor->lock); | |
693 | } | |
694 | spin_unlock_irq(&anchor->lock); | |
695 | } | |
696 | EXPORT_SYMBOL_GPL(usb_kill_anchored_urbs); | |
697 | ||
6a2839be ON |
698 | |
699 | /** | |
700 | * usb_poison_anchored_urbs - cease all traffic from an anchor | |
701 | * @anchor: anchor the requests are bound to | |
702 | * | |
703 | * this allows all outstanding URBs to be poisoned starting | |
704 | * from the back of the queue. Newly added URBs will also be | |
705 | * poisoned | |
cde217a5 AS |
706 | * |
707 | * This routine should not be called by a driver after its disconnect | |
708 | * method has returned. | |
6a2839be ON |
709 | */ |
710 | void usb_poison_anchored_urbs(struct usb_anchor *anchor) | |
711 | { | |
712 | struct urb *victim; | |
713 | ||
714 | spin_lock_irq(&anchor->lock); | |
715 | anchor->poisoned = 1; | |
716 | while (!list_empty(&anchor->urb_list)) { | |
717 | victim = list_entry(anchor->urb_list.prev, struct urb, | |
718 | anchor_list); | |
719 | /* we must make sure the URB isn't freed before we kill it*/ | |
720 | usb_get_urb(victim); | |
721 | spin_unlock_irq(&anchor->lock); | |
722 | /* this will unanchor the URB */ | |
723 | usb_poison_urb(victim); | |
724 | usb_put_urb(victim); | |
725 | spin_lock_irq(&anchor->lock); | |
726 | } | |
727 | spin_unlock_irq(&anchor->lock); | |
728 | } | |
729 | EXPORT_SYMBOL_GPL(usb_poison_anchored_urbs); | |
cde217a5 | 730 | |
856395d6 ON |
731 | /** |
732 | * usb_unpoison_anchored_urbs - let an anchor be used successfully again | |
733 | * @anchor: anchor the requests are bound to | |
734 | * | |
735 | * Reverses the effect of usb_poison_anchored_urbs | |
736 | * the anchor can be used normally after it returns | |
737 | */ | |
738 | void usb_unpoison_anchored_urbs(struct usb_anchor *anchor) | |
739 | { | |
740 | unsigned long flags; | |
741 | struct urb *lazarus; | |
742 | ||
743 | spin_lock_irqsave(&anchor->lock, flags); | |
744 | list_for_each_entry(lazarus, &anchor->urb_list, anchor_list) { | |
745 | usb_unpoison_urb(lazarus); | |
746 | } | |
747 | anchor->poisoned = 0; | |
748 | spin_unlock_irqrestore(&anchor->lock, flags); | |
749 | } | |
750 | EXPORT_SYMBOL_GPL(usb_unpoison_anchored_urbs); | |
eda76959 ON |
751 | /** |
752 | * usb_unlink_anchored_urbs - asynchronously cancel transfer requests en masse | |
753 | * @anchor: anchor the requests are bound to | |
754 | * | |
755 | * this allows all outstanding URBs to be unlinked starting | |
756 | * from the back of the queue. This function is asynchronous. | |
757 | * The unlinking is just tiggered. It may happen after this | |
758 | * function has returned. | |
cde217a5 AS |
759 | * |
760 | * This routine should not be called by a driver after its disconnect | |
761 | * method has returned. | |
eda76959 ON |
762 | */ |
763 | void usb_unlink_anchored_urbs(struct usb_anchor *anchor) | |
764 | { | |
765 | struct urb *victim; | |
766 | ||
b3e67044 | 767 | while ((victim = usb_get_from_anchor(anchor)) != NULL) { |
eda76959 | 768 | usb_unlink_urb(victim); |
77571f05 | 769 | usb_put_urb(victim); |
eda76959 | 770 | } |
eda76959 ON |
771 | } |
772 | EXPORT_SYMBOL_GPL(usb_unlink_anchored_urbs); | |
773 | ||
51a2f077 ON |
774 | /** |
775 | * usb_wait_anchor_empty_timeout - wait for an anchor to be unused | |
776 | * @anchor: the anchor you want to become unused | |
777 | * @timeout: how long you are willing to wait in milliseconds | |
778 | * | |
779 | * Call this is you want to be sure all an anchor's | |
780 | * URBs have finished | |
781 | */ | |
782 | int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor, | |
783 | unsigned int timeout) | |
784 | { | |
785 | return wait_event_timeout(anchor->wait, list_empty(&anchor->urb_list), | |
786 | msecs_to_jiffies(timeout)); | |
787 | } | |
788 | EXPORT_SYMBOL_GPL(usb_wait_anchor_empty_timeout); | |
19876252 ON |
789 | |
790 | /** | |
791 | * usb_get_from_anchor - get an anchor's oldest urb | |
792 | * @anchor: the anchor whose urb you want | |
793 | * | |
794 | * this will take the oldest urb from an anchor, | |
795 | * unanchor and return it | |
796 | */ | |
797 | struct urb *usb_get_from_anchor(struct usb_anchor *anchor) | |
798 | { | |
799 | struct urb *victim; | |
800 | unsigned long flags; | |
801 | ||
802 | spin_lock_irqsave(&anchor->lock, flags); | |
803 | if (!list_empty(&anchor->urb_list)) { | |
804 | victim = list_entry(anchor->urb_list.next, struct urb, | |
805 | anchor_list); | |
806 | usb_get_urb(victim); | |
b3e67044 | 807 | __usb_unanchor_urb(victim, anchor); |
19876252 | 808 | } else { |
19876252 ON |
809 | victim = NULL; |
810 | } | |
b3e67044 | 811 | spin_unlock_irqrestore(&anchor->lock, flags); |
19876252 ON |
812 | |
813 | return victim; | |
814 | } | |
815 | ||
816 | EXPORT_SYMBOL_GPL(usb_get_from_anchor); | |
817 | ||
818 | /** | |
819 | * usb_scuttle_anchored_urbs - unanchor all an anchor's urbs | |
820 | * @anchor: the anchor whose urbs you want to unanchor | |
821 | * | |
822 | * use this to get rid of all an anchor's urbs | |
823 | */ | |
824 | void usb_scuttle_anchored_urbs(struct usb_anchor *anchor) | |
825 | { | |
826 | struct urb *victim; | |
827 | unsigned long flags; | |
828 | ||
829 | spin_lock_irqsave(&anchor->lock, flags); | |
830 | while (!list_empty(&anchor->urb_list)) { | |
831 | victim = list_entry(anchor->urb_list.prev, struct urb, | |
832 | anchor_list); | |
b3e67044 | 833 | __usb_unanchor_urb(victim, anchor); |
19876252 ON |
834 | } |
835 | spin_unlock_irqrestore(&anchor->lock, flags); | |
836 | } | |
837 | ||
838 | EXPORT_SYMBOL_GPL(usb_scuttle_anchored_urbs); | |
839 | ||
840 | /** | |
841 | * usb_anchor_empty - is an anchor empty | |
842 | * @anchor: the anchor you want to query | |
843 | * | |
844 | * returns 1 if the anchor has no urbs associated with it | |
845 | */ | |
846 | int usb_anchor_empty(struct usb_anchor *anchor) | |
847 | { | |
848 | return list_empty(&anchor->urb_list); | |
849 | } | |
850 | ||
851 | EXPORT_SYMBOL_GPL(usb_anchor_empty); | |
852 |