27080561a1c2386567160b7aec7394028e1a60b3
[linux-2.6.git] / drivers / usb / core / urb.c
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>
6 #include <linux/log2.h>
7 #include <linux/usb.h>
8 #include <linux/wait.h>
9 #include "hcd.h"
10
11 #define to_urb(d) container_of(d, struct urb, kref)
12
13
14 static void urb_destroy(struct kref *kref)
15 {
16         struct urb *urb = to_urb(kref);
17
18         if (urb->transfer_flags & URB_FREE_BUFFER)
19                 kfree(urb->transfer_buffer);
20
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);
43                 INIT_LIST_HEAD(&urb->anchor_list);
44         }
45 }
46 EXPORT_SYMBOL_GPL(usb_init_urb);
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  */
64 struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags)
65 {
66         struct urb *urb;
67
68         urb = kmalloc(sizeof(struct urb) +
69                 iso_packets * sizeof(struct usb_iso_packet_descriptor),
70                 mem_flags);
71         if (!urb) {
72                 printk(KERN_ERR "alloc_urb: kmalloc failed\n");
73                 return NULL;
74         }
75         usb_init_urb(urb);
76         return urb;
77 }
78 EXPORT_SYMBOL_GPL(usb_alloc_urb);
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  *
87  * Note: The transfer buffer associated with the urb is not freed unless the
88  * URB_FREE_BUFFER transfer flag is set.
89  */
90 void usb_free_urb(struct urb *urb)
91 {
92         if (urb)
93                 kref_put(&urb->kref, urb_destroy);
94 }
95 EXPORT_SYMBOL_GPL(usb_free_urb);
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  */
107 struct urb *usb_get_urb(struct urb *urb)
108 {
109         if (urb)
110                 kref_get(&urb->kref);
111         return urb;
112 }
113 EXPORT_SYMBOL_GPL(usb_get_urb);
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;
131
132         if (unlikely(anchor->poisoned)) {
133                 atomic_inc(&urb->reject);
134         }
135
136         spin_unlock_irqrestore(&anchor->lock, flags);
137 }
138 EXPORT_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  */
146 void 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 }
171 EXPORT_SYMBOL_GPL(usb_unanchor_urb);
172
173 /*-------------------------------------------------------------------*/
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
185  * (a software-induced fault, also called "request cancellation").
186  *
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
234  * after faults (transfer errors or cancellation).
235  *
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  *
244  * 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  *
250  * 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.
274  *
275  * 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  */
294 int usb_submit_urb(struct urb *urb, gfp_t mem_flags)
295 {
296         int                             xfertype, max;
297         struct usb_device               *dev;
298         struct usb_host_endpoint        *ep;
299         int                             is_out;
300
301         if (!urb || urb->hcpriv || !urb->complete)
302                 return -EINVAL;
303         dev = urb->dev;
304         if ((!dev) || (dev->state < USB_STATE_UNAUTHENTICATED))
305                 return -ENODEV;
306
307         /* 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;
317         urb->status = -EINPROGRESS;
318         urb->actual_length = 0;
319
320         /* Lots of sanity checks, so HCDs can rely on clean data
321          * and don't need to duplicate tests
322          */
323         xfertype = usb_endpoint_type(&ep->desc);
324         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
336         /* Cache the direction for later use */
337         urb->transfer_flags = (urb->transfer_flags & ~URB_DIR_MASK) |
338                         (is_out ? URB_DIR_OUT : URB_DIR_IN);
339
340         if (xfertype != USB_ENDPOINT_XFER_CONTROL &&
341                         dev->state < USB_STATE_CONFIGURED)
342                 return -ENODEV;
343
344         max = le16_to_cpu(ep->desc.wMaxPacketSize);
345         if (max <= 0) {
346                 dev_dbg(&dev->dev,
347                         "bogus endpoint ep%d%s in %s (bad maxpacket %d)\n",
348                         usb_endpoint_num(&ep->desc), is_out ? "out" : "in",
349                         __func__, max);
350                 return -EMSGSIZE;
351         }
352
353         /* periodic transfers limit size per frame/uframe,
354          * but drivers only control those sizes for ISO.
355          * while we're checking, initialize return status.
356          */
357         if (xfertype == USB_ENDPOINT_XFER_ISOC) {
358                 int     n, len;
359
360                 /* FIXME SuperSpeed isoc endpoints have up to 16 bursts */
361                 /* "high bandwidth" mode, 1-3 packets/uframe? */
362                 if (dev->speed == USB_SPEED_HIGH) {
363                         int     mult = 1 + ((max >> 11) & 0x03);
364                         max &= 0x07ff;
365                         max *= mult;
366                 }
367
368                 if (urb->number_of_packets <= 0)
369                         return -EINVAL;
370                 for (n = 0; n < urb->number_of_packets; n++) {
371                         len = urb->iso_frame_desc[n].length;
372                         if (len < 0 || len > max)
373                                 return -EMSGSIZE;
374                         urb->iso_frame_desc[n].status = -EXDEV;
375                         urb->iso_frame_desc[n].actual_length = 0;
376                 }
377         }
378
379         /* the I/O buffer must be mapped/unmapped, except when length=0 */
380         if (urb->transfer_buffer_length > INT_MAX)
381                 return -EMSGSIZE;
382
383 #ifdef DEBUG
384         /* stuff that drivers shouldn't do, but which shouldn't
385          * cause problems in HCDs if they get it wrong.
386          */
387         {
388         unsigned int    orig_flags = urb->transfer_flags;
389         unsigned int    allowed;
390         static int pipetypes[4] = {
391                 PIPE_CONTROL, PIPE_ISOCHRONOUS, PIPE_BULK, PIPE_INTERRUPT
392         };
393
394         /* Check that the pipe's type matches the endpoint's type */
395         if (usb_pipetype(urb->pipe) != pipetypes[xfertype])
396                 return -EPIPE;          /* The most suitable error code :-) */
397
398         /* enforce simple/standard policy */
399         allowed = (URB_NO_TRANSFER_DMA_MAP | URB_NO_SETUP_DMA_MAP |
400                         URB_NO_INTERRUPT | URB_DIR_MASK | URB_FREE_BUFFER);
401         switch (xfertype) {
402         case USB_ENDPOINT_XFER_BULK:
403                 if (is_out)
404                         allowed |= URB_ZERO_PACKET;
405                 /* FALLTHROUGH */
406         case USB_ENDPOINT_XFER_CONTROL:
407                 allowed |= URB_NO_FSBR; /* only affects UHCI */
408                 /* FALLTHROUGH */
409         default:                        /* all non-iso endpoints */
410                 if (!is_out)
411                         allowed |= URB_SHORT_NOT_OK;
412                 break;
413         case USB_ENDPOINT_XFER_ISOC:
414                 allowed |= URB_ISO_ASAP;
415                 break;
416         }
417         urb->transfer_flags &= allowed;
418
419         /* fail if submitter gave bogus flags */
420         if (urb->transfer_flags != orig_flags) {
421                 dev_err(&dev->dev, "BOGUS urb flags, %x --> %x\n",
422                         orig_flags, urb->transfer_flags);
423                 return -EINVAL;
424         }
425         }
426 #endif
427         /*
428          * Force periodic transfer intervals to be legal values that are
429          * a power of two (so HCDs don't need to).
430          *
431          * FIXME want bus->{intr,iso}_sched_horizon values here.  Each HC
432          * supports different values... this uses EHCI/UHCI defaults (and
433          * EHCI can use smaller non-default values).
434          */
435         switch (xfertype) {
436         case USB_ENDPOINT_XFER_ISOC:
437         case USB_ENDPOINT_XFER_INT:
438                 /* too small? */
439                 switch (dev->speed) {
440                 case USB_SPEED_WIRELESS:
441                         if (urb->interval < 6)
442                                 return -EINVAL;
443                         break;
444                 default:
445                         if (urb->interval <= 0)
446                                 return -EINVAL;
447                         break;
448                 }
449                 /* too big? */
450                 switch (dev->speed) {
451                 case USB_SPEED_SUPER:   /* units are 125us */
452                         /* Handle up to 2^(16-1) microframes */
453                         if (urb->interval > (1 << 15))
454                                 return -EINVAL;
455                         max = 1 << 15;
456                 case USB_SPEED_WIRELESS:
457                         if (urb->interval > 16)
458                                 return -EINVAL;
459                         break;
460                 case USB_SPEED_HIGH:    /* units are microframes */
461                         /* NOTE usb handles 2^15 */
462                         if (urb->interval > (1024 * 8))
463                                 urb->interval = 1024 * 8;
464                         max = 1024 * 8;
465                         break;
466                 case USB_SPEED_FULL:    /* units are frames/msec */
467                 case USB_SPEED_LOW:
468                         if (xfertype == USB_ENDPOINT_XFER_INT) {
469                                 if (urb->interval > 255)
470                                         return -EINVAL;
471                                 /* NOTE ohci only handles up to 32 */
472                                 max = 128;
473                         } else {
474                                 if (urb->interval > 1024)
475                                         urb->interval = 1024;
476                                 /* NOTE usb and ohci handle up to 2^15 */
477                                 max = 1024;
478                         }
479                         break;
480                 default:
481                         return -EINVAL;
482                 }
483                 if (dev->speed != USB_SPEED_WIRELESS) {
484                         /* Round down to a power of 2, no more than max */
485                         urb->interval = min(max, 1 << ilog2(urb->interval));
486                 }
487         }
488
489         return usb_hcd_submit_urb(urb, mem_flags);
490 }
491 EXPORT_SYMBOL_GPL(usb_submit_urb);
492
493 /*-------------------------------------------------------------------*/
494
495 /**
496  * usb_unlink_urb - abort/cancel a transfer request for an endpoint
497  * @urb: pointer to urb describing a previously submitted request,
498  *      may be NULL
499  *
500  * This routine cancels an in-progress request.  URBs complete only once
501  * per submission, and may be canceled only once per submission.
502  * Successful cancellation means termination of @urb will be expedited
503  * and the completion handler will be called with a status code
504  * indicating that the request has been canceled (rather than any other
505  * code).
506  *
507  * Drivers should not call this routine or related routines, such as
508  * usb_kill_urb() or usb_unlink_anchored_urbs(), after their disconnect
509  * method has returned.  The disconnect function should synchronize with
510  * a driver's I/O routines to insure that all URB-related activity has
511  * completed before it returns.
512  *
513  * This request is always asynchronous.  Success is indicated by
514  * returning -EINPROGRESS, at which time the URB will probably not yet
515  * have been given back to the device driver.  When it is eventually
516  * called, the completion function will see @urb->status == -ECONNRESET.
517  * Failure is indicated by usb_unlink_urb() returning any other value.
518  * Unlinking will fail when @urb is not currently "linked" (i.e., it was
519  * never submitted, or it was unlinked before, or the hardware is already
520  * finished with it), even if the completion handler has not yet run.
521  *
522  * Unlinking and Endpoint Queues:
523  *
524  * [The behaviors and guarantees described below do not apply to virtual
525  * root hubs but only to endpoint queues for physical USB devices.]
526  *
527  * Host Controller Drivers (HCDs) place all the URBs for a particular
528  * endpoint in a queue.  Normally the queue advances as the controller
529  * hardware processes each request.  But when an URB terminates with an
530  * error its queue generally stops (see below), at least until that URB's
531  * completion routine returns.  It is guaranteed that a stopped queue
532  * will not restart until all its unlinked URBs have been fully retired,
533  * with their completion routines run, even if that's not until some time
534  * after the original completion handler returns.  The same behavior and
535  * guarantee apply when an URB terminates because it was unlinked.
536  *
537  * Bulk and interrupt endpoint queues are guaranteed to stop whenever an
538  * URB terminates with any sort of error, including -ECONNRESET, -ENOENT,
539  * and -EREMOTEIO.  Control endpoint queues behave the same way except
540  * that they are not guaranteed to stop for -EREMOTEIO errors.  Queues
541  * for isochronous endpoints are treated differently, because they must
542  * advance at fixed rates.  Such queues do not stop when an URB
543  * encounters an error or is unlinked.  An unlinked isochronous URB may
544  * leave a gap in the stream of packets; it is undefined whether such
545  * gaps can be filled in.
546  *
547  * Note that early termination of an URB because a short packet was
548  * received will generate a -EREMOTEIO error if and only if the
549  * URB_SHORT_NOT_OK flag is set.  By setting this flag, USB device
550  * drivers can build deep queues for large or complex bulk transfers
551  * and clean them up reliably after any sort of aborted transfer by
552  * unlinking all pending URBs at the first fault.
553  *
554  * When a control URB terminates with an error other than -EREMOTEIO, it
555  * is quite likely that the status stage of the transfer will not take
556  * place.
557  */
558 int usb_unlink_urb(struct urb *urb)
559 {
560         if (!urb)
561                 return -EINVAL;
562         if (!urb->dev)
563                 return -ENODEV;
564         if (!urb->ep)
565                 return -EIDRM;
566         return usb_hcd_unlink_urb(urb, -ECONNRESET);
567 }
568 EXPORT_SYMBOL_GPL(usb_unlink_urb);
569
570 /**
571  * usb_kill_urb - cancel a transfer request and wait for it to finish
572  * @urb: pointer to URB describing a previously submitted request,
573  *      may be NULL
574  *
575  * This routine cancels an in-progress request.  It is guaranteed that
576  * upon return all completion handlers will have finished and the URB
577  * will be totally idle and available for reuse.  These features make
578  * this an ideal way to stop I/O in a disconnect() callback or close()
579  * function.  If the request has not already finished or been unlinked
580  * the completion handler will see urb->status == -ENOENT.
581  *
582  * While the routine is running, attempts to resubmit the URB will fail
583  * with error -EPERM.  Thus even if the URB's completion handler always
584  * tries to resubmit, it will not succeed and the URB will become idle.
585  *
586  * This routine may not be used in an interrupt context (such as a bottom
587  * half or a completion handler), or when holding a spinlock, or in other
588  * situations where the caller can't schedule().
589  *
590  * This routine should not be called by a driver after its disconnect
591  * method has returned.
592  */
593 void usb_kill_urb(struct urb *urb)
594 {
595         might_sleep();
596         if (!(urb && urb->dev && urb->ep))
597                 return;
598         atomic_inc(&urb->reject);
599
600         usb_hcd_unlink_urb(urb, -ENOENT);
601         wait_event(usb_kill_urb_queue, atomic_read(&urb->use_count) == 0);
602
603         atomic_dec(&urb->reject);
604 }
605 EXPORT_SYMBOL_GPL(usb_kill_urb);
606
607 /**
608  * usb_poison_urb - reliably kill a transfer and prevent further use of an URB
609  * @urb: pointer to URB describing a previously submitted request,
610  *      may be NULL
611  *
612  * This routine cancels an in-progress request.  It is guaranteed that
613  * upon return all completion handlers will have finished and the URB
614  * will be totally idle and cannot be reused.  These features make
615  * this an ideal way to stop I/O in a disconnect() callback.
616  * If the request has not already finished or been unlinked
617  * the completion handler will see urb->status == -ENOENT.
618  *
619  * After and while the routine runs, attempts to resubmit the URB will fail
620  * with error -EPERM.  Thus even if the URB's completion handler always
621  * tries to resubmit, it will not succeed and the URB will become idle.
622  *
623  * This routine may not be used in an interrupt context (such as a bottom
624  * half or a completion handler), or when holding a spinlock, or in other
625  * situations where the caller can't schedule().
626  *
627  * This routine should not be called by a driver after its disconnect
628  * method has returned.
629  */
630 void usb_poison_urb(struct urb *urb)
631 {
632         might_sleep();
633         if (!(urb && urb->dev && urb->ep))
634                 return;
635         atomic_inc(&urb->reject);
636
637         usb_hcd_unlink_urb(urb, -ENOENT);
638         wait_event(usb_kill_urb_queue, atomic_read(&urb->use_count) == 0);
639 }
640 EXPORT_SYMBOL_GPL(usb_poison_urb);
641
642 void usb_unpoison_urb(struct urb *urb)
643 {
644         if (!urb)
645                 return;
646
647         atomic_dec(&urb->reject);
648 }
649 EXPORT_SYMBOL_GPL(usb_unpoison_urb);
650
651 /**
652  * usb_kill_anchored_urbs - cancel transfer requests en masse
653  * @anchor: anchor the requests are bound to
654  *
655  * this allows all outstanding URBs to be killed starting
656  * from the back of the queue
657  *
658  * This routine should not be called by a driver after its disconnect
659  * method has returned.
660  */
661 void usb_kill_anchored_urbs(struct usb_anchor *anchor)
662 {
663         struct urb *victim;
664
665         spin_lock_irq(&anchor->lock);
666         while (!list_empty(&anchor->urb_list)) {
667                 victim = list_entry(anchor->urb_list.prev, struct urb,
668                                     anchor_list);
669                 /* we must make sure the URB isn't freed before we kill it*/
670                 usb_get_urb(victim);
671                 spin_unlock_irq(&anchor->lock);
672                 /* this will unanchor the URB */
673                 usb_kill_urb(victim);
674                 usb_put_urb(victim);
675                 spin_lock_irq(&anchor->lock);
676         }
677         spin_unlock_irq(&anchor->lock);
678 }
679 EXPORT_SYMBOL_GPL(usb_kill_anchored_urbs);
680
681
682 /**
683  * usb_poison_anchored_urbs - cease all traffic from an anchor
684  * @anchor: anchor the requests are bound to
685  *
686  * this allows all outstanding URBs to be poisoned starting
687  * from the back of the queue. Newly added URBs will also be
688  * poisoned
689  *
690  * This routine should not be called by a driver after its disconnect
691  * method has returned.
692  */
693 void usb_poison_anchored_urbs(struct usb_anchor *anchor)
694 {
695         struct urb *victim;
696
697         spin_lock_irq(&anchor->lock);
698         anchor->poisoned = 1;
699         while (!list_empty(&anchor->urb_list)) {
700                 victim = list_entry(anchor->urb_list.prev, struct urb,
701                                     anchor_list);
702                 /* we must make sure the URB isn't freed before we kill it*/
703                 usb_get_urb(victim);
704                 spin_unlock_irq(&anchor->lock);
705                 /* this will unanchor the URB */
706                 usb_poison_urb(victim);
707                 usb_put_urb(victim);
708                 spin_lock_irq(&anchor->lock);
709         }
710         spin_unlock_irq(&anchor->lock);
711 }
712 EXPORT_SYMBOL_GPL(usb_poison_anchored_urbs);
713
714 /**
715  * usb_unpoison_anchored_urbs - let an anchor be used successfully again
716  * @anchor: anchor the requests are bound to
717  *
718  * Reverses the effect of usb_poison_anchored_urbs
719  * the anchor can be used normally after it returns
720  */
721 void usb_unpoison_anchored_urbs(struct usb_anchor *anchor)
722 {
723         unsigned long flags;
724         struct urb *lazarus;
725
726         spin_lock_irqsave(&anchor->lock, flags);
727         list_for_each_entry(lazarus, &anchor->urb_list, anchor_list) {
728                 usb_unpoison_urb(lazarus);
729         }
730         anchor->poisoned = 0;
731         spin_unlock_irqrestore(&anchor->lock, flags);
732 }
733 EXPORT_SYMBOL_GPL(usb_unpoison_anchored_urbs);
734 /**
735  * usb_unlink_anchored_urbs - asynchronously cancel transfer requests en masse
736  * @anchor: anchor the requests are bound to
737  *
738  * this allows all outstanding URBs to be unlinked starting
739  * from the back of the queue. This function is asynchronous.
740  * The unlinking is just tiggered. It may happen after this
741  * function has returned.
742  *
743  * This routine should not be called by a driver after its disconnect
744  * method has returned.
745  */
746 void usb_unlink_anchored_urbs(struct usb_anchor *anchor)
747 {
748         struct urb *victim;
749         unsigned long flags;
750
751         spin_lock_irqsave(&anchor->lock, flags);
752         while (!list_empty(&anchor->urb_list)) {
753                 victim = list_entry(anchor->urb_list.prev, struct urb,
754                                     anchor_list);
755                 usb_get_urb(victim);
756                 spin_unlock_irqrestore(&anchor->lock, flags);
757                 /* this will unanchor the URB */
758                 usb_unlink_urb(victim);
759                 usb_put_urb(victim);
760                 spin_lock_irqsave(&anchor->lock, flags);
761         }
762         spin_unlock_irqrestore(&anchor->lock, flags);
763 }
764 EXPORT_SYMBOL_GPL(usb_unlink_anchored_urbs);
765
766 /**
767  * usb_wait_anchor_empty_timeout - wait for an anchor to be unused
768  * @anchor: the anchor you want to become unused
769  * @timeout: how long you are willing to wait in milliseconds
770  *
771  * Call this is you want to be sure all an anchor's
772  * URBs have finished
773  */
774 int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
775                                   unsigned int timeout)
776 {
777         return wait_event_timeout(anchor->wait, list_empty(&anchor->urb_list),
778                                   msecs_to_jiffies(timeout));
779 }
780 EXPORT_SYMBOL_GPL(usb_wait_anchor_empty_timeout);
781
782 /**
783  * usb_get_from_anchor - get an anchor's oldest urb
784  * @anchor: the anchor whose urb you want
785  *
786  * this will take the oldest urb from an anchor,
787  * unanchor and return it
788  */
789 struct urb *usb_get_from_anchor(struct usb_anchor *anchor)
790 {
791         struct urb *victim;
792         unsigned long flags;
793
794         spin_lock_irqsave(&anchor->lock, flags);
795         if (!list_empty(&anchor->urb_list)) {
796                 victim = list_entry(anchor->urb_list.next, struct urb,
797                                     anchor_list);
798                 usb_get_urb(victim);
799                 spin_unlock_irqrestore(&anchor->lock, flags);
800                 usb_unanchor_urb(victim);
801         } else {
802                 spin_unlock_irqrestore(&anchor->lock, flags);
803                 victim = NULL;
804         }
805
806         return victim;
807 }
808
809 EXPORT_SYMBOL_GPL(usb_get_from_anchor);
810
811 /**
812  * usb_scuttle_anchored_urbs - unanchor all an anchor's urbs
813  * @anchor: the anchor whose urbs you want to unanchor
814  *
815  * use this to get rid of all an anchor's urbs
816  */
817 void usb_scuttle_anchored_urbs(struct usb_anchor *anchor)
818 {
819         struct urb *victim;
820         unsigned long flags;
821
822         spin_lock_irqsave(&anchor->lock, flags);
823         while (!list_empty(&anchor->urb_list)) {
824                 victim = list_entry(anchor->urb_list.prev, struct urb,
825                                     anchor_list);
826                 usb_get_urb(victim);
827                 spin_unlock_irqrestore(&anchor->lock, flags);
828                 /* this may free the URB */
829                 usb_unanchor_urb(victim);
830                 usb_put_urb(victim);
831                 spin_lock_irqsave(&anchor->lock, flags);
832         }
833         spin_unlock_irqrestore(&anchor->lock, flags);
834 }
835
836 EXPORT_SYMBOL_GPL(usb_scuttle_anchored_urbs);
837
838 /**
839  * usb_anchor_empty - is an anchor empty
840  * @anchor: the anchor you want to query
841  *
842  * returns 1 if the anchor has no urbs associated with it
843  */
844 int usb_anchor_empty(struct usb_anchor *anchor)
845 {
846         return list_empty(&anchor->urb_list);
847 }
848
849 EXPORT_SYMBOL_GPL(usb_anchor_empty);
850