blob: a760e46871c5b66fc0f40055df5d1ace8e0b9ec1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#include <linux/module.h>
2#include <linux/string.h>
3#include <linux/bitops.h>
4#include <linux/slab.h>
5#include <linux/init.h>
Alan Sternd617bc82007-08-02 15:04:52 -04006#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/usb.h>
Oliver Neukum51a2f072007-05-25 13:40:56 +02008#include <linux/wait.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +02009#include <linux/usb/hcd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11#define to_urb(d) container_of(d, struct urb, kref)
12
Oliver Neukum6a2839b2008-07-29 16:18:47 +020013
Linus Torvalds1da177e2005-04-16 15:20:36 -070014static void urb_destroy(struct kref *kref)
15{
16 struct urb *urb = to_urb(kref);
Oliver Neukum51a2f072007-05-25 13:40:56 +020017
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +020018 if (urb->transfer_flags & URB_FREE_BUFFER)
19 kfree(urb->transfer_buffer);
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 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 */
38void usb_init_urb(struct urb *urb)
39{
40 if (urb) {
41 memset(urb, 0, sizeof(*urb));
42 kref_init(&urb->kref);
Oliver Neukum51a2f072007-05-25 13:40:56 +020043 INIT_LIST_HEAD(&urb->anchor_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 }
45}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -060046EXPORT_SYMBOL_GPL(usb_init_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
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 */
Al Viro55016f12005-10-21 03:21:58 -040064struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
66 struct urb *urb;
67
Tobias Klauserec17cf12006-09-13 21:38:41 +020068 urb = kmalloc(sizeof(struct urb) +
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 iso_packets * sizeof(struct usb_iso_packet_descriptor),
70 mem_flags);
71 if (!urb) {
Greg Kroah-Hartman69a85942008-08-14 09:37:34 -070072 printk(KERN_ERR "alloc_urb: kmalloc failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 return NULL;
74 }
75 usb_init_urb(urb);
76 return urb;
77}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -060078EXPORT_SYMBOL_GPL(usb_alloc_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
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 *
Rabin Vincent2870fde2008-11-09 11:40:30 +053087 * Note: The transfer buffer associated with the urb is not freed unless the
88 * URB_FREE_BUFFER transfer flag is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 */
90void usb_free_urb(struct urb *urb)
91{
92 if (urb)
93 kref_put(&urb->kref, urb_destroy);
94}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -060095EXPORT_SYMBOL_GPL(usb_free_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
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 */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800107struct urb *usb_get_urb(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108{
109 if (urb)
110 kref_get(&urb->kref);
111 return urb;
112}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600113EXPORT_SYMBOL_GPL(usb_get_urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +0200114
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 */
123void 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;
Oliver Neukum6a2839b2008-07-29 16:18:47 +0200131
132 if (unlikely(anchor->poisoned)) {
Ming Lei49367d82008-12-12 21:38:45 +0800133 atomic_inc(&urb->reject);
Oliver Neukum6a2839b2008-07-29 16:18:47 +0200134 }
135
Oliver Neukum51a2f072007-05-25 13:40:56 +0200136 spin_unlock_irqrestore(&anchor->lock, flags);
137}
138EXPORT_SYMBOL_GPL(usb_anchor_urb);
139
140/**
141 * usb_unanchor_urb - unanchors an URB
142 * @urb: pointer to the urb to anchor
143 *
144 * Call this to stop the system keeping track of this URB
145 */
146void usb_unanchor_urb(struct urb *urb)
147{
148 unsigned long flags;
149 struct usb_anchor *anchor;
150
151 if (!urb)
152 return;
153
154 anchor = urb->anchor;
155 if (!anchor)
156 return;
157
158 spin_lock_irqsave(&anchor->lock, flags);
159 if (unlikely(anchor != urb->anchor)) {
160 /* we've lost the race to another thread */
161 spin_unlock_irqrestore(&anchor->lock, flags);
162 return;
163 }
164 urb->anchor = NULL;
165 list_del(&urb->anchor_list);
166 spin_unlock_irqrestore(&anchor->lock, flags);
167 usb_put_urb(urb);
168 if (list_empty(&anchor->urb_list))
169 wake_up(&anchor->wait);
170}
171EXPORT_SYMBOL_GPL(usb_unanchor_urb);
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/*-------------------------------------------------------------------*/
174
175/**
176 * usb_submit_urb - issue an asynchronous transfer request for an endpoint
177 * @urb: pointer to the urb describing the request
178 * @mem_flags: the type of memory to allocate, see kmalloc() for a list
179 * of valid options for this.
180 *
181 * This submits a transfer request, and transfers control of the URB
182 * describing that request to the USB subsystem. Request completion will
183 * be indicated later, asynchronously, by calling the completion handler.
184 * The three types of completion are success, error, and unlink
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800185 * (a software-induced fault, also called "request cancellation").
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 *
187 * URBs may be submitted in interrupt context.
188 *
189 * The caller must have correctly initialized the URB before submitting
190 * it. Functions such as usb_fill_bulk_urb() and usb_fill_control_urb() are
191 * available to ensure that most fields are correctly initialized, for
192 * the particular kind of transfer, although they will not initialize
193 * any transfer flags.
194 *
195 * Successful submissions return 0; otherwise this routine returns a
196 * negative error number. If the submission is successful, the complete()
197 * callback from the URB will be called exactly once, when the USB core and
198 * Host Controller Driver (HCD) are finished with the URB. When the completion
199 * function is called, control of the URB is returned to the device
200 * driver which issued the request. The completion handler may then
201 * immediately free or reuse that URB.
202 *
203 * With few exceptions, USB device drivers should never access URB fields
204 * provided by usbcore or the HCD until its complete() is called.
205 * The exceptions relate to periodic transfer scheduling. For both
206 * interrupt and isochronous urbs, as part of successful URB submission
207 * urb->interval is modified to reflect the actual transfer period used
208 * (normally some power of two units). And for isochronous urbs,
209 * urb->start_frame is modified to reflect when the URB's transfers were
210 * scheduled to start. Not all isochronous transfer scheduling policies
211 * will work, but most host controller drivers should easily handle ISO
212 * queues going from now until 10-200 msec into the future.
213 *
214 * For control endpoints, the synchronous usb_control_msg() call is
215 * often used (in non-interrupt context) instead of this call.
216 * That is often used through convenience wrappers, for the requests
217 * that are standardized in the USB 2.0 specification. For bulk
218 * endpoints, a synchronous usb_bulk_msg() call is available.
219 *
220 * Request Queuing:
221 *
222 * URBs may be submitted to endpoints before previous ones complete, to
223 * minimize the impact of interrupt latencies and system overhead on data
224 * throughput. With that queuing policy, an endpoint's queue would never
225 * be empty. This is required for continuous isochronous data streams,
226 * and may also be required for some kinds of interrupt transfers. Such
227 * queuing also maximizes bandwidth utilization by letting USB controllers
228 * start work on later requests before driver software has finished the
229 * completion processing for earlier (successful) requests.
230 *
231 * As of Linux 2.6, all USB endpoint transfer queues support depths greater
232 * than one. This was previously a HCD-specific behavior, except for ISO
233 * transfers. Non-isochronous endpoint queues are inactive during cleanup
Steven Cole093cf722005-05-03 19:07:24 -0600234 * after faults (transfer errors or cancellation).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 *
236 * Reserved Bandwidth Transfers:
237 *
238 * Periodic transfers (interrupt or isochronous) are performed repeatedly,
239 * using the interval specified in the urb. Submitting the first urb to
240 * the endpoint reserves the bandwidth necessary to make those transfers.
241 * If the USB subsystem can't allocate sufficient bandwidth to perform
242 * the periodic request, submitting such a periodic request should fail.
243 *
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700244 * For devices under xHCI, the bandwidth is reserved at configuration time, or
245 * when the alt setting is selected. If there is not enough bus bandwidth, the
246 * configuration/alt setting request will fail. Therefore, submissions to
247 * periodic endpoints on devices under xHCI should never fail due to bandwidth
248 * constraints.
249 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 * Device drivers must explicitly request that repetition, by ensuring that
251 * some URB is always on the endpoint's queue (except possibly for short
252 * periods during completion callacks). When there is no longer an urb
253 * queued, the endpoint's bandwidth reservation is canceled. This means
254 * drivers can use their completion handlers to ensure they keep bandwidth
255 * they need, by reinitializing and resubmitting the just-completed urb
256 * until the driver longer needs that periodic bandwidth.
257 *
258 * Memory Flags:
259 *
260 * The general rules for how to decide which mem_flags to use
261 * are the same as for kmalloc. There are four
262 * different possible values; GFP_KERNEL, GFP_NOFS, GFP_NOIO and
263 * GFP_ATOMIC.
264 *
265 * GFP_NOFS is not ever used, as it has not been implemented yet.
266 *
267 * GFP_ATOMIC is used when
268 * (a) you are inside a completion handler, an interrupt, bottom half,
269 * tasklet or timer, or
270 * (b) you are holding a spinlock or rwlock (does not apply to
271 * semaphores), or
272 * (c) current->state != TASK_RUNNING, this is the case only after
273 * you've changed it.
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800274 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 * GFP_NOIO is used in the block io path and error handling of storage
276 * devices.
277 *
278 * All other situations use GFP_KERNEL.
279 *
280 * Some more specific rules for mem_flags can be inferred, such as
281 * (1) start_xmit, timeout, and receive methods of network drivers must
282 * use GFP_ATOMIC (they are called with a spinlock held);
283 * (2) queuecommand methods of scsi drivers must use GFP_ATOMIC (also
284 * called with a spinlock held);
285 * (3) If you use a kernel thread with a network driver you must use
286 * GFP_NOIO, unless (b) or (c) apply;
287 * (4) after you have done a down() you can use GFP_KERNEL, unless (b) or (c)
288 * apply or your are in a storage driver's block io path;
289 * (5) USB probe and disconnect can use GFP_KERNEL unless (b) or (c) apply; and
290 * (6) changing firmware on a running storage or net device uses
291 * GFP_NOIO, unless b) or c) apply
292 *
293 */
Al Viro55016f12005-10-21 03:21:58 -0400294int usb_submit_urb(struct urb *urb, gfp_t mem_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295{
Alan Stern5b653c72007-07-30 17:04:37 -0400296 int xfertype, max;
297 struct usb_device *dev;
298 struct usb_host_endpoint *ep;
299 int is_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 if (!urb || urb->hcpriv || !urb->complete)
302 return -EINVAL;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800303 dev = urb->dev;
David Vrabel6da9c992009-02-18 14:43:47 +0000304 if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Alan Stern5b653c72007-07-30 17:04:37 -0400307 /* For now, get the endpoint from the pipe. Eventually drivers
308 * will be required to set urb->ep directly and we will eliminate
309 * urb->pipe.
310 */
311 ep = (usb_pipein(urb->pipe) ? dev->ep_in : dev->ep_out)
312 [usb_pipeendpoint(urb->pipe)];
313 if (!ep)
314 return -ENOENT;
315
316 urb->ep = ep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 urb->status = -EINPROGRESS;
318 urb->actual_length = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320 /* Lots of sanity checks, so HCDs can rely on clean data
321 * and don't need to duplicate tests
322 */
Alan Stern5b653c72007-07-30 17:04:37 -0400323 xfertype = usb_endpoint_type(&ep->desc);
Alan Sternfea34092007-07-30 17:06:16 -0400324 if (xfertype == USB_ENDPOINT_XFER_CONTROL) {
325 struct usb_ctrlrequest *setup =
326 (struct usb_ctrlrequest *) urb->setup_packet;
327
328 if (!setup)
329 return -ENOEXEC;
330 is_out = !(setup->bRequestType & USB_DIR_IN) ||
331 !setup->wLength;
332 } else {
333 is_out = usb_endpoint_dir_out(&ep->desc);
334 }
335
Alan Sternff9c8952010-04-02 13:27:28 -0400336 /* Clear the internal flags and cache the direction for later use */
337 urb->transfer_flags &= ~(URB_DIR_MASK | URB_DMA_MAP_SINGLE |
338 URB_DMA_MAP_PAGE | URB_DMA_MAP_SG | URB_MAP_LOCAL |
339 URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL |
340 URB_DMA_SG_COMBINED);
341 urb->transfer_flags |= (is_out ? URB_DIR_OUT : URB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Alan Stern5b653c72007-07-30 17:04:37 -0400343 if (xfertype != USB_ENDPOINT_XFER_CONTROL &&
344 dev->state < USB_STATE_CONFIGURED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 return -ENODEV;
346
Alan Stern5b653c72007-07-30 17:04:37 -0400347 max = le16_to_cpu(ep->desc.wMaxPacketSize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 if (max <= 0) {
349 dev_dbg(&dev->dev,
350 "bogus endpoint ep%d%s in %s (bad maxpacket %d)\n",
Alan Stern5b653c72007-07-30 17:04:37 -0400351 usb_endpoint_num(&ep->desc), is_out ? "out" : "in",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800352 __func__, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return -EMSGSIZE;
354 }
355
356 /* periodic transfers limit size per frame/uframe,
357 * but drivers only control those sizes for ISO.
358 * while we're checking, initialize return status.
359 */
Alan Stern5b653c72007-07-30 17:04:37 -0400360 if (xfertype == USB_ENDPOINT_XFER_ISOC) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 int n, len;
362
Sarah Sharp6b403b02009-04-27 19:54:10 -0700363 /* FIXME SuperSpeed isoc endpoints have up to 16 bursts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 /* "high bandwidth" mode, 1-3 packets/uframe? */
365 if (dev->speed == USB_SPEED_HIGH) {
366 int mult = 1 + ((max >> 11) & 0x03);
367 max &= 0x07ff;
368 max *= mult;
369 }
370
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800371 if (urb->number_of_packets <= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 return -EINVAL;
373 for (n = 0; n < urb->number_of_packets; n++) {
Oliver Neukum92516442007-01-23 15:55:28 -0500374 len = urb->iso_frame_desc[n].length;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800375 if (len < 0 || len > max)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 return -EMSGSIZE;
Oliver Neukum92516442007-01-23 15:55:28 -0500377 urb->iso_frame_desc[n].status = -EXDEV;
378 urb->iso_frame_desc[n].actual_length = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 }
380 }
381
382 /* the I/O buffer must be mapped/unmapped, except when length=0 */
Roel Kluin71d27182009-03-13 12:19:18 +0100383 if (urb->transfer_buffer_length > INT_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 return -EMSGSIZE;
385
386#ifdef DEBUG
387 /* stuff that drivers shouldn't do, but which shouldn't
388 * cause problems in HCDs if they get it wrong.
389 */
390 {
391 unsigned int orig_flags = urb->transfer_flags;
392 unsigned int allowed;
Alan Sternf661c6f2009-12-11 16:20:20 -0500393 static int pipetypes[4] = {
394 PIPE_CONTROL, PIPE_ISOCHRONOUS, PIPE_BULK, PIPE_INTERRUPT
395 };
396
397 /* Check that the pipe's type matches the endpoint's type */
398 if (usb_pipetype(urb->pipe) != pipetypes[xfertype])
399 return -EPIPE; /* The most suitable error code :-) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401 /* enforce simple/standard policy */
Alan Stern0ede76f2010-03-05 15:10:17 -0500402 allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_INTERRUPT | URB_DIR_MASK |
403 URB_FREE_BUFFER);
Alan Stern5b653c72007-07-30 17:04:37 -0400404 switch (xfertype) {
405 case USB_ENDPOINT_XFER_BULK:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 if (is_out)
407 allowed |= URB_ZERO_PACKET;
408 /* FALLTHROUGH */
Alan Stern5b653c72007-07-30 17:04:37 -0400409 case USB_ENDPOINT_XFER_CONTROL:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 allowed |= URB_NO_FSBR; /* only affects UHCI */
411 /* FALLTHROUGH */
412 default: /* all non-iso endpoints */
413 if (!is_out)
414 allowed |= URB_SHORT_NOT_OK;
415 break;
Alan Stern5b653c72007-07-30 17:04:37 -0400416 case USB_ENDPOINT_XFER_ISOC:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 allowed |= URB_ISO_ASAP;
418 break;
419 }
420 urb->transfer_flags &= allowed;
421
422 /* fail if submitter gave bogus flags */
423 if (urb->transfer_flags != orig_flags) {
Greg Kroah-Hartman69a85942008-08-14 09:37:34 -0700424 dev_err(&dev->dev, "BOGUS urb flags, %x --> %x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 orig_flags, urb->transfer_flags);
426 return -EINVAL;
427 }
428 }
429#endif
430 /*
431 * Force periodic transfer intervals to be legal values that are
432 * a power of two (so HCDs don't need to).
433 *
434 * FIXME want bus->{intr,iso}_sched_horizon values here. Each HC
435 * supports different values... this uses EHCI/UHCI defaults (and
436 * EHCI can use smaller non-default values).
437 */
Alan Stern5b653c72007-07-30 17:04:37 -0400438 switch (xfertype) {
439 case USB_ENDPOINT_XFER_ISOC:
440 case USB_ENDPOINT_XFER_INT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 /* too small? */
David Vrabel8e08b972009-08-18 16:11:24 +0100442 switch (dev->speed) {
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -0800443 case USB_SPEED_WIRELESS:
David Vrabel8e08b972009-08-18 16:11:24 +0100444 if (urb->interval < 6)
445 return -EINVAL;
446 break;
447 default:
448 if (urb->interval <= 0)
449 return -EINVAL;
450 break;
451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 /* too big? */
453 switch (dev->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -0700454 case USB_SPEED_SUPER: /* units are 125us */
455 /* Handle up to 2^(16-1) microframes */
456 if (urb->interval > (1 << 15))
457 return -EINVAL;
458 max = 1 << 15;
Matthew Wilcoxf09a15e2010-03-16 12:55:44 -0700459 break;
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -0800460 case USB_SPEED_WIRELESS:
David Vrabel8e08b972009-08-18 16:11:24 +0100461 if (urb->interval > 16)
462 return -EINVAL;
463 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 case USB_SPEED_HIGH: /* units are microframes */
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800465 /* NOTE usb handles 2^15 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 if (urb->interval > (1024 * 8))
467 urb->interval = 1024 * 8;
Alan Stern5b653c72007-07-30 17:04:37 -0400468 max = 1024 * 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 break;
470 case USB_SPEED_FULL: /* units are frames/msec */
471 case USB_SPEED_LOW:
Alan Stern5b653c72007-07-30 17:04:37 -0400472 if (xfertype == USB_ENDPOINT_XFER_INT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 if (urb->interval > 255)
474 return -EINVAL;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800475 /* NOTE ohci only handles up to 32 */
Alan Stern5b653c72007-07-30 17:04:37 -0400476 max = 128;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 } else {
478 if (urb->interval > 1024)
479 urb->interval = 1024;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800480 /* NOTE usb and ohci handle up to 2^15 */
Alan Stern5b653c72007-07-30 17:04:37 -0400481 max = 1024;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 }
483 break;
484 default:
485 return -EINVAL;
486 }
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -0800487 if (dev->speed != USB_SPEED_WIRELESS) {
David Vrabel8e08b972009-08-18 16:11:24 +0100488 /* Round down to a power of 2, no more than max */
489 urb->interval = min(max, 1 << ilog2(urb->interval));
490 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 }
492
Oliver Neukum92516442007-01-23 15:55:28 -0500493 return usb_hcd_submit_urb(urb, mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600495EXPORT_SYMBOL_GPL(usb_submit_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497/*-------------------------------------------------------------------*/
498
499/**
500 * usb_unlink_urb - abort/cancel a transfer request for an endpoint
501 * @urb: pointer to urb describing a previously submitted request,
502 * may be NULL
503 *
Alan Sternbeafef02007-07-13 15:47:16 -0400504 * This routine cancels an in-progress request. URBs complete only once
505 * per submission, and may be canceled only once per submission.
506 * Successful cancellation means termination of @urb will be expedited
507 * and the completion handler will be called with a status code
508 * indicating that the request has been canceled (rather than any other
509 * code).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 *
Alan Sterncde217a2008-10-21 15:28:46 -0400511 * Drivers should not call this routine or related routines, such as
512 * usb_kill_urb() or usb_unlink_anchored_urbs(), after their disconnect
513 * method has returned. The disconnect function should synchronize with
514 * a driver's I/O routines to insure that all URB-related activity has
515 * completed before it returns.
516 *
Alan Sternbeafef02007-07-13 15:47:16 -0400517 * This request is always asynchronous. Success is indicated by
518 * returning -EINPROGRESS, at which time the URB will probably not yet
519 * have been given back to the device driver. When it is eventually
520 * called, the completion function will see @urb->status == -ECONNRESET.
521 * Failure is indicated by usb_unlink_urb() returning any other value.
522 * Unlinking will fail when @urb is not currently "linked" (i.e., it was
523 * never submitted, or it was unlinked before, or the hardware is already
524 * finished with it), even if the completion handler has not yet run.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 *
526 * Unlinking and Endpoint Queues:
527 *
Alan Sternbeafef02007-07-13 15:47:16 -0400528 * [The behaviors and guarantees described below do not apply to virtual
529 * root hubs but only to endpoint queues for physical USB devices.]
530 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 * Host Controller Drivers (HCDs) place all the URBs for a particular
532 * endpoint in a queue. Normally the queue advances as the controller
Alan Stern8835f662005-04-18 17:39:30 -0700533 * hardware processes each request. But when an URB terminates with an
Alan Sternbeafef02007-07-13 15:47:16 -0400534 * error its queue generally stops (see below), at least until that URB's
535 * completion routine returns. It is guaranteed that a stopped queue
536 * will not restart until all its unlinked URBs have been fully retired,
537 * with their completion routines run, even if that's not until some time
538 * after the original completion handler returns. The same behavior and
539 * guarantee apply when an URB terminates because it was unlinked.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 *
Alan Sternbeafef02007-07-13 15:47:16 -0400541 * Bulk and interrupt endpoint queues are guaranteed to stop whenever an
542 * URB terminates with any sort of error, including -ECONNRESET, -ENOENT,
543 * and -EREMOTEIO. Control endpoint queues behave the same way except
544 * that they are not guaranteed to stop for -EREMOTEIO errors. Queues
545 * for isochronous endpoints are treated differently, because they must
546 * advance at fixed rates. Such queues do not stop when an URB
547 * encounters an error or is unlinked. An unlinked isochronous URB may
548 * leave a gap in the stream of packets; it is undefined whether such
549 * gaps can be filled in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 *
Alan Sternbeafef02007-07-13 15:47:16 -0400551 * Note that early termination of an URB because a short packet was
552 * received will generate a -EREMOTEIO error if and only if the
553 * URB_SHORT_NOT_OK flag is set. By setting this flag, USB device
554 * drivers can build deep queues for large or complex bulk transfers
555 * and clean them up reliably after any sort of aborted transfer by
556 * unlinking all pending URBs at the first fault.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 *
Alan Sternbeafef02007-07-13 15:47:16 -0400558 * When a control URB terminates with an error other than -EREMOTEIO, it
559 * is quite likely that the status stage of the transfer will not take
560 * place.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 */
562int usb_unlink_urb(struct urb *urb)
563{
564 if (!urb)
565 return -EINVAL;
Alan Sternd617bc82007-08-02 15:04:52 -0400566 if (!urb->dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 return -ENODEV;
Alan Sternd617bc82007-08-02 15:04:52 -0400568 if (!urb->ep)
569 return -EIDRM;
Alan Sterna6d2bb92006-08-30 11:27:36 -0400570 return usb_hcd_unlink_urb(urb, -ECONNRESET);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600572EXPORT_SYMBOL_GPL(usb_unlink_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574/**
575 * usb_kill_urb - cancel a transfer request and wait for it to finish
576 * @urb: pointer to URB describing a previously submitted request,
577 * may be NULL
578 *
579 * This routine cancels an in-progress request. It is guaranteed that
580 * upon return all completion handlers will have finished and the URB
581 * will be totally idle and available for reuse. These features make
582 * this an ideal way to stop I/O in a disconnect() callback or close()
583 * function. If the request has not already finished or been unlinked
584 * the completion handler will see urb->status == -ENOENT.
585 *
586 * While the routine is running, attempts to resubmit the URB will fail
587 * with error -EPERM. Thus even if the URB's completion handler always
588 * tries to resubmit, it will not succeed and the URB will become idle.
589 *
590 * This routine may not be used in an interrupt context (such as a bottom
591 * half or a completion handler), or when holding a spinlock, or in other
592 * situations where the caller can't schedule().
Alan Sterncde217a2008-10-21 15:28:46 -0400593 *
594 * This routine should not be called by a driver after its disconnect
595 * method has returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 */
597void usb_kill_urb(struct urb *urb)
598{
Greg Kroah-Hartmane9aa7952006-01-23 17:17:21 -0500599 might_sleep();
Alan Sternd617bc82007-08-02 15:04:52 -0400600 if (!(urb && urb->dev && urb->ep))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 return;
Ming Lei49367d82008-12-12 21:38:45 +0800602 atomic_inc(&urb->reject);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Alan Sterna6d2bb92006-08-30 11:27:36 -0400604 usb_hcd_unlink_urb(urb, -ENOENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 wait_event(usb_kill_urb_queue, atomic_read(&urb->use_count) == 0);
606
Ming Lei49367d82008-12-12 21:38:45 +0800607 atomic_dec(&urb->reject);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600609EXPORT_SYMBOL_GPL(usb_kill_urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Oliver Neukum51a2f072007-05-25 13:40:56 +0200611/**
Oliver Neukum55b447b2008-07-29 15:26:15 +0200612 * usb_poison_urb - reliably kill a transfer and prevent further use of an URB
613 * @urb: pointer to URB describing a previously submitted request,
614 * may be NULL
615 *
616 * This routine cancels an in-progress request. It is guaranteed that
617 * upon return all completion handlers will have finished and the URB
618 * will be totally idle and cannot be reused. These features make
619 * this an ideal way to stop I/O in a disconnect() callback.
620 * If the request has not already finished or been unlinked
621 * the completion handler will see urb->status == -ENOENT.
622 *
623 * After and while the routine runs, attempts to resubmit the URB will fail
624 * with error -EPERM. Thus even if the URB's completion handler always
625 * tries to resubmit, it will not succeed and the URB will become idle.
626 *
627 * This routine may not be used in an interrupt context (such as a bottom
628 * half or a completion handler), or when holding a spinlock, or in other
629 * situations where the caller can't schedule().
Alan Sterncde217a2008-10-21 15:28:46 -0400630 *
631 * This routine should not be called by a driver after its disconnect
632 * method has returned.
Oliver Neukum55b447b2008-07-29 15:26:15 +0200633 */
634void usb_poison_urb(struct urb *urb)
635{
636 might_sleep();
637 if (!(urb && urb->dev && urb->ep))
638 return;
Ming Lei49367d82008-12-12 21:38:45 +0800639 atomic_inc(&urb->reject);
Oliver Neukum55b447b2008-07-29 15:26:15 +0200640
641 usb_hcd_unlink_urb(urb, -ENOENT);
642 wait_event(usb_kill_urb_queue, atomic_read(&urb->use_count) == 0);
643}
644EXPORT_SYMBOL_GPL(usb_poison_urb);
645
646void usb_unpoison_urb(struct urb *urb)
647{
648 if (!urb)
649 return;
650
Ming Lei49367d82008-12-12 21:38:45 +0800651 atomic_dec(&urb->reject);
Oliver Neukum55b447b2008-07-29 15:26:15 +0200652}
653EXPORT_SYMBOL_GPL(usb_unpoison_urb);
654
655/**
Oliver Neukum51a2f072007-05-25 13:40:56 +0200656 * usb_kill_anchored_urbs - cancel transfer requests en masse
657 * @anchor: anchor the requests are bound to
658 *
659 * this allows all outstanding URBs to be killed starting
660 * from the back of the queue
Alan Sterncde217a2008-10-21 15:28:46 -0400661 *
662 * This routine should not be called by a driver after its disconnect
663 * method has returned.
Oliver Neukum51a2f072007-05-25 13:40:56 +0200664 */
665void usb_kill_anchored_urbs(struct usb_anchor *anchor)
666{
667 struct urb *victim;
668
669 spin_lock_irq(&anchor->lock);
670 while (!list_empty(&anchor->urb_list)) {
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800671 victim = list_entry(anchor->urb_list.prev, struct urb,
672 anchor_list);
Oliver Neukum51a2f072007-05-25 13:40:56 +0200673 /* we must make sure the URB isn't freed before we kill it*/
674 usb_get_urb(victim);
675 spin_unlock_irq(&anchor->lock);
676 /* this will unanchor the URB */
677 usb_kill_urb(victim);
678 usb_put_urb(victim);
679 spin_lock_irq(&anchor->lock);
680 }
681 spin_unlock_irq(&anchor->lock);
682}
683EXPORT_SYMBOL_GPL(usb_kill_anchored_urbs);
684
Oliver Neukum6a2839b2008-07-29 16:18:47 +0200685
686/**
687 * usb_poison_anchored_urbs - cease all traffic from an anchor
688 * @anchor: anchor the requests are bound to
689 *
690 * this allows all outstanding URBs to be poisoned starting
691 * from the back of the queue. Newly added URBs will also be
692 * poisoned
Alan Sterncde217a2008-10-21 15:28:46 -0400693 *
694 * This routine should not be called by a driver after its disconnect
695 * method has returned.
Oliver Neukum6a2839b2008-07-29 16:18:47 +0200696 */
697void usb_poison_anchored_urbs(struct usb_anchor *anchor)
698{
699 struct urb *victim;
700
701 spin_lock_irq(&anchor->lock);
702 anchor->poisoned = 1;
703 while (!list_empty(&anchor->urb_list)) {
704 victim = list_entry(anchor->urb_list.prev, struct urb,
705 anchor_list);
706 /* we must make sure the URB isn't freed before we kill it*/
707 usb_get_urb(victim);
708 spin_unlock_irq(&anchor->lock);
709 /* this will unanchor the URB */
710 usb_poison_urb(victim);
711 usb_put_urb(victim);
712 spin_lock_irq(&anchor->lock);
713 }
714 spin_unlock_irq(&anchor->lock);
715}
716EXPORT_SYMBOL_GPL(usb_poison_anchored_urbs);
Alan Sterncde217a2008-10-21 15:28:46 -0400717
Oliver Neukum51a2f072007-05-25 13:40:56 +0200718/**
Oliver Neukum856395d2008-12-18 09:17:49 +0100719 * usb_unpoison_anchored_urbs - let an anchor be used successfully again
720 * @anchor: anchor the requests are bound to
721 *
722 * Reverses the effect of usb_poison_anchored_urbs
723 * the anchor can be used normally after it returns
724 */
725void usb_unpoison_anchored_urbs(struct usb_anchor *anchor)
726{
727 unsigned long flags;
728 struct urb *lazarus;
729
730 spin_lock_irqsave(&anchor->lock, flags);
731 list_for_each_entry(lazarus, &anchor->urb_list, anchor_list) {
732 usb_unpoison_urb(lazarus);
733 }
734 anchor->poisoned = 0;
735 spin_unlock_irqrestore(&anchor->lock, flags);
736}
737EXPORT_SYMBOL_GPL(usb_unpoison_anchored_urbs);
738/**
Oliver Neukumeda76952008-04-10 14:07:37 +0200739 * usb_unlink_anchored_urbs - asynchronously cancel transfer requests en masse
740 * @anchor: anchor the requests are bound to
741 *
742 * this allows all outstanding URBs to be unlinked starting
743 * from the back of the queue. This function is asynchronous.
744 * The unlinking is just tiggered. It may happen after this
745 * function has returned.
Alan Sterncde217a2008-10-21 15:28:46 -0400746 *
747 * This routine should not be called by a driver after its disconnect
748 * method has returned.
Oliver Neukumeda76952008-04-10 14:07:37 +0200749 */
750void usb_unlink_anchored_urbs(struct usb_anchor *anchor)
751{
752 struct urb *victim;
Oliver Neukum77571f02008-08-18 16:36:52 +0200753 unsigned long flags;
Oliver Neukumeda76952008-04-10 14:07:37 +0200754
Oliver Neukum77571f02008-08-18 16:36:52 +0200755 spin_lock_irqsave(&anchor->lock, flags);
Oliver Neukumeda76952008-04-10 14:07:37 +0200756 while (!list_empty(&anchor->urb_list)) {
757 victim = list_entry(anchor->urb_list.prev, struct urb,
758 anchor_list);
Oliver Neukum77571f02008-08-18 16:36:52 +0200759 usb_get_urb(victim);
760 spin_unlock_irqrestore(&anchor->lock, flags);
Oliver Neukumeda76952008-04-10 14:07:37 +0200761 /* this will unanchor the URB */
762 usb_unlink_urb(victim);
Oliver Neukum77571f02008-08-18 16:36:52 +0200763 usb_put_urb(victim);
764 spin_lock_irqsave(&anchor->lock, flags);
Oliver Neukumeda76952008-04-10 14:07:37 +0200765 }
Oliver Neukum77571f02008-08-18 16:36:52 +0200766 spin_unlock_irqrestore(&anchor->lock, flags);
Oliver Neukumeda76952008-04-10 14:07:37 +0200767}
768EXPORT_SYMBOL_GPL(usb_unlink_anchored_urbs);
769
770/**
Oliver Neukum51a2f072007-05-25 13:40:56 +0200771 * usb_wait_anchor_empty_timeout - wait for an anchor to be unused
772 * @anchor: the anchor you want to become unused
773 * @timeout: how long you are willing to wait in milliseconds
774 *
775 * Call this is you want to be sure all an anchor's
776 * URBs have finished
777 */
778int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
779 unsigned int timeout)
780{
781 return wait_event_timeout(anchor->wait, list_empty(&anchor->urb_list),
782 msecs_to_jiffies(timeout));
783}
784EXPORT_SYMBOL_GPL(usb_wait_anchor_empty_timeout);
Oliver Neukum19876252008-08-25 22:40:25 +0200785
786/**
787 * usb_get_from_anchor - get an anchor's oldest urb
788 * @anchor: the anchor whose urb you want
789 *
790 * this will take the oldest urb from an anchor,
791 * unanchor and return it
792 */
793struct urb *usb_get_from_anchor(struct usb_anchor *anchor)
794{
795 struct urb *victim;
796 unsigned long flags;
797
798 spin_lock_irqsave(&anchor->lock, flags);
799 if (!list_empty(&anchor->urb_list)) {
800 victim = list_entry(anchor->urb_list.next, struct urb,
801 anchor_list);
802 usb_get_urb(victim);
803 spin_unlock_irqrestore(&anchor->lock, flags);
804 usb_unanchor_urb(victim);
805 } else {
806 spin_unlock_irqrestore(&anchor->lock, flags);
807 victim = NULL;
808 }
809
810 return victim;
811}
812
813EXPORT_SYMBOL_GPL(usb_get_from_anchor);
814
815/**
816 * usb_scuttle_anchored_urbs - unanchor all an anchor's urbs
817 * @anchor: the anchor whose urbs you want to unanchor
818 *
819 * use this to get rid of all an anchor's urbs
820 */
821void usb_scuttle_anchored_urbs(struct usb_anchor *anchor)
822{
823 struct urb *victim;
824 unsigned long flags;
825
826 spin_lock_irqsave(&anchor->lock, flags);
827 while (!list_empty(&anchor->urb_list)) {
828 victim = list_entry(anchor->urb_list.prev, struct urb,
829 anchor_list);
830 usb_get_urb(victim);
831 spin_unlock_irqrestore(&anchor->lock, flags);
832 /* this may free the URB */
833 usb_unanchor_urb(victim);
834 usb_put_urb(victim);
835 spin_lock_irqsave(&anchor->lock, flags);
836 }
837 spin_unlock_irqrestore(&anchor->lock, flags);
838}
839
840EXPORT_SYMBOL_GPL(usb_scuttle_anchored_urbs);
841
842/**
843 * usb_anchor_empty - is an anchor empty
844 * @anchor: the anchor you want to query
845 *
846 * returns 1 if the anchor has no urbs associated with it
847 */
848int usb_anchor_empty(struct usb_anchor *anchor)
849{
850 return list_empty(&anchor->urb_list);
851}
852
853EXPORT_SYMBOL_GPL(usb_anchor_empty);
854