2 * message.c - synchronous message handling
5 #include <linux/config.h>
7 #ifdef CONFIG_USB_DEBUG
13 #include <linux/pci.h> /* for scatterlist macros */
14 #include <linux/usb.h>
15 #include <linux/module.h>
16 #include <linux/slab.h>
17 #include <linux/init.h>
19 #include <linux/timer.h>
20 #include <asm/byteorder.h>
22 #include "hcd.h" /* for usbcore internals */
25 static void usb_api_blocking_completion(struct urb *urb, struct pt_regs *regs)
27 complete((struct completion *)urb->context);
31 static void timeout_kill(unsigned long data)
33 struct urb *urb = (struct urb *) data;
35 dev_warn(&urb->dev->dev, "%s timeout on ep%d%s\n",
36 usb_pipecontrol(urb->pipe) ? "control" : "bulk",
37 usb_pipeendpoint(urb->pipe),
38 usb_pipein(urb->pipe) ? "in" : "out");
42 // Starts urb and waits for completion or timeout
43 // note that this call is NOT interruptible, while
44 // many device driver i/o requests should be interruptible
45 static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
47 struct completion done;
48 struct timer_list timer;
51 init_completion(&done);
53 urb->transfer_flags |= URB_ASYNC_UNLINK;
54 urb->actual_length = 0;
55 status = usb_submit_urb(urb, GFP_NOIO);
60 timer.expires = jiffies + timeout;
61 timer.data = (unsigned long)urb;
62 timer.function = timeout_kill;
63 /* grr. timeout _should_ include submit delays. */
66 wait_for_completion(&done);
68 /* note: HCDs return ETIMEDOUT for other reasons too */
69 if (status == -ECONNRESET)
72 del_timer_sync(&timer);
76 *actual_length = urb->actual_length;
81 /*-------------------------------------------------------------------*/
82 // returns status (negative) or length (positive)
83 int usb_internal_control_msg(struct usb_device *usb_dev, unsigned int pipe,
84 struct usb_ctrlrequest *cmd, void *data, int len, int timeout)
90 urb = usb_alloc_urb(0, GFP_NOIO);
94 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char *)cmd, data,
95 len, usb_api_blocking_completion, NULL);
97 retv = usb_start_wait_urb(urb, timeout, &length);
105 * usb_control_msg - Builds a control urb, sends it off and waits for completion
106 * @dev: pointer to the usb device to send the message to
107 * @pipe: endpoint "pipe" to send the message to
108 * @request: USB message request value
109 * @requesttype: USB message request type value
110 * @value: USB message value
111 * @index: USB message index value
112 * @data: pointer to the data to send
113 * @size: length in bytes of the data to send
114 * @timeout: time in jiffies to wait for the message to complete before
115 * timing out (if 0 the wait is forever)
116 * Context: !in_interrupt ()
118 * This function sends a simple control message to a specified endpoint
119 * and waits for the message to complete, or timeout.
121 * If successful, it returns the number of bytes transferred, otherwise a negative error number.
123 * Don't use this function from within an interrupt context, like a
124 * bottom half handler. If you need an asynchronous message, or need to send
125 * a message from within interrupt context, use usb_submit_urb()
126 * If a thread in your driver uses this call, make sure your disconnect()
127 * method can wait for it to complete. Since you don't have a handle on
128 * the URB used, you can't cancel the request.
130 int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype,
131 __u16 value, __u16 index, void *data, __u16 size, int timeout)
133 struct usb_ctrlrequest *dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_NOIO);
139 dr->bRequestType= requesttype;
140 dr->bRequest = request;
141 dr->wValue = cpu_to_le16p(&value);
142 dr->wIndex = cpu_to_le16p(&index);
143 dr->wLength = cpu_to_le16p(&size);
145 //dbg("usb_control_msg");
147 ret = usb_internal_control_msg(dev, pipe, dr, data, size, timeout);
156 * usb_bulk_msg - Builds a bulk urb, sends it off and waits for completion
157 * @usb_dev: pointer to the usb device to send the message to
158 * @pipe: endpoint "pipe" to send the message to
159 * @data: pointer to the data to send
160 * @len: length in bytes of the data to send
161 * @actual_length: pointer to a location to put the actual length transferred in bytes
162 * @timeout: time in jiffies to wait for the message to complete before
163 * timing out (if 0 the wait is forever)
164 * Context: !in_interrupt ()
166 * This function sends a simple bulk message to a specified endpoint
167 * and waits for the message to complete, or timeout.
169 * If successful, it returns 0, otherwise a negative error number.
170 * The number of actual bytes transferred will be stored in the
171 * actual_length paramater.
173 * Don't use this function from within an interrupt context, like a
174 * bottom half handler. If you need an asynchronous message, or need to
175 * send a message from within interrupt context, use usb_submit_urb()
176 * If a thread in your driver uses this call, make sure your disconnect()
177 * method can wait for it to complete. Since you don't have a handle on
178 * the URB used, you can't cancel the request.
180 int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
181 void *data, int len, int *actual_length, int timeout)
188 urb=usb_alloc_urb(0, GFP_KERNEL);
192 usb_fill_bulk_urb(urb, usb_dev, pipe, data, len,
193 usb_api_blocking_completion, NULL);
195 return usb_start_wait_urb(urb,timeout,actual_length);
198 /*-------------------------------------------------------------------*/
200 static void sg_clean (struct usb_sg_request *io)
203 while (io->entries--)
204 usb_free_urb (io->urbs [io->entries]);
208 if (io->dev->dev.dma_mask != 0)
209 usb_buffer_unmap_sg (io->dev, io->pipe, io->sg, io->nents);
213 static void sg_complete (struct urb *urb, struct pt_regs *regs)
215 struct usb_sg_request *io = (struct usb_sg_request *) urb->context;
217 spin_lock (&io->lock);
219 /* In 2.5 we require hcds' endpoint queues not to progress after fault
220 * reports, until the completion callback (this!) returns. That lets
221 * device driver code (like this routine) unlink queued urbs first,
222 * if it needs to, since the HC won't work on them at all. So it's
223 * not possible for page N+1 to overwrite page N, and so on.
225 * That's only for "hard" faults; "soft" faults (unlinks) sometimes
226 * complete before the HCD can get requests away from hardware,
227 * though never during cleanup after a hard fault.
230 && (io->status != -ECONNRESET
231 || urb->status != -ECONNRESET)
232 && urb->actual_length) {
233 dev_err (io->dev->bus->controller,
234 "dev %s ep%d%s scatterlist error %d/%d\n",
236 usb_pipeendpoint (urb->pipe),
237 usb_pipein (urb->pipe) ? "in" : "out",
238 urb->status, io->status);
242 if (urb->status && urb->status != -ECONNRESET) {
243 int i, found, status;
245 io->status = urb->status;
247 /* the previous urbs, and this one, completed already.
248 * unlink pending urbs so they won't rx/tx bad data.
250 for (i = 0, found = 0; i < io->entries; i++) {
254 status = usb_unlink_urb (io->urbs [i]);
255 if (status != -EINPROGRESS && status != -EBUSY)
256 dev_err (&io->dev->dev,
257 "%s, unlink --> %d\n",
258 __FUNCTION__, status);
259 } else if (urb == io->urbs [i])
265 /* on the last completion, signal usb_sg_wait() */
266 io->bytes += urb->actual_length;
269 complete (&io->complete);
271 spin_unlock (&io->lock);
276 * usb_sg_init - initializes scatterlist-based bulk/interrupt I/O request
277 * @io: request block being initialized. until usb_sg_wait() returns,
278 * treat this as a pointer to an opaque block of memory,
279 * @dev: the usb device that will send or receive the data
280 * @pipe: endpoint "pipe" used to transfer the data
281 * @period: polling rate for interrupt endpoints, in frames or
282 * (for high speed endpoints) microframes; ignored for bulk
283 * @sg: scatterlist entries
284 * @nents: how many entries in the scatterlist
285 * @length: how many bytes to send from the scatterlist, or zero to
286 * send every byte identified in the list.
287 * @mem_flags: SLAB_* flags affecting memory allocations in this call
289 * Returns zero for success, else a negative errno value. This initializes a
290 * scatter/gather request, allocating resources such as I/O mappings and urb
291 * memory (except maybe memory used by USB controller drivers).
293 * The request must be issued using usb_sg_wait(), which waits for the I/O to
294 * complete (or to be canceled) and then cleans up all resources allocated by
297 * The request may be canceled with usb_sg_cancel(), either before or after
298 * usb_sg_wait() is called.
301 struct usb_sg_request *io,
302 struct usb_device *dev,
305 struct scatterlist *sg,
315 if (!io || !dev || !sg
316 || usb_pipecontrol (pipe)
317 || usb_pipeisoc (pipe)
321 spin_lock_init (&io->lock);
327 /* not all host controllers use DMA (like the mainstream pci ones);
328 * they can use PIO (sl811) or be software over another transport.
330 dma = (dev->dev.dma_mask != 0);
332 io->entries = usb_buffer_map_sg (dev, pipe, sg, nents);
336 /* initialize all the urbs we'll use */
337 if (io->entries <= 0)
341 io->urbs = kmalloc (io->entries * sizeof *io->urbs, mem_flags);
345 urb_flags = URB_ASYNC_UNLINK | URB_NO_TRANSFER_DMA_MAP
347 if (usb_pipein (pipe))
348 urb_flags |= URB_SHORT_NOT_OK;
350 for (i = 0; i < io->entries; i++, io->count = i) {
353 io->urbs [i] = usb_alloc_urb (0, mem_flags);
359 io->urbs [i]->dev = NULL;
360 io->urbs [i]->pipe = pipe;
361 io->urbs [i]->interval = period;
362 io->urbs [i]->transfer_flags = urb_flags;
364 io->urbs [i]->complete = sg_complete;
365 io->urbs [i]->context = io;
366 io->urbs [i]->status = -EINPROGRESS;
367 io->urbs [i]->actual_length = 0;
370 /* hc may use _only_ transfer_dma */
371 io->urbs [i]->transfer_dma = sg_dma_address (sg + i);
372 len = sg_dma_len (sg + i);
374 /* hc may use _only_ transfer_buffer */
375 io->urbs [i]->transfer_buffer =
376 page_address (sg [i].page) + sg [i].offset;
381 len = min_t (unsigned, len, length);
386 io->urbs [i]->transfer_buffer_length = len;
388 io->urbs [--i]->transfer_flags &= ~URB_NO_INTERRUPT;
390 /* transaction state */
393 init_completion (&io->complete);
403 * usb_sg_wait - synchronously execute scatter/gather request
404 * @io: request block handle, as initialized with usb_sg_init().
405 * some fields become accessible when this call returns.
406 * Context: !in_interrupt ()
408 * This function blocks until the specified I/O operation completes. It
409 * leverages the grouping of the related I/O requests to get good transfer
410 * rates, by queueing the requests. At higher speeds, such queuing can
411 * significantly improve USB throughput.
413 * There are three kinds of completion for this function.
414 * (1) success, where io->status is zero. The number of io->bytes
415 * transferred is as requested.
416 * (2) error, where io->status is a negative errno value. The number
417 * of io->bytes transferred before the error is usually less
418 * than requested, and can be nonzero.
419 * (3) cancelation, a type of error with status -ECONNRESET that
420 * is initiated by usb_sg_cancel().
422 * When this function returns, all memory allocated through usb_sg_init() or
423 * this call will have been freed. The request block parameter may still be
424 * passed to usb_sg_cancel(), or it may be freed. It could also be
425 * reinitialized and then reused.
427 * Data Transfer Rates:
429 * Bulk transfers are valid for full or high speed endpoints.
430 * The best full speed data rate is 19 packets of 64 bytes each
431 * per frame, or 1216 bytes per millisecond.
432 * The best high speed data rate is 13 packets of 512 bytes each
433 * per microframe, or 52 KBytes per millisecond.
435 * The reason to use interrupt transfers through this API would most likely
436 * be to reserve high speed bandwidth, where up to 24 KBytes per millisecond
437 * could be transferred. That capability is less useful for low or full
438 * speed interrupt endpoints, which allow at most one packet per millisecond,
439 * of at most 8 or 64 bytes (respectively).
441 void usb_sg_wait (struct usb_sg_request *io)
443 int i, entries = io->entries;
445 /* queue the urbs. */
446 spin_lock_irq (&io->lock);
447 for (i = 0; i < entries && !io->status; i++) {
450 io->urbs [i]->dev = io->dev;
451 retval = usb_submit_urb (io->urbs [i], SLAB_ATOMIC);
453 /* after we submit, let completions or cancelations fire;
454 * we handshake using io->status.
456 spin_unlock_irq (&io->lock);
458 /* maybe we retrying will recover */
459 case -ENXIO: // hc didn't queue this one
462 io->urbs[i]->dev = NULL;
468 /* no error? continue immediately.
470 * NOTE: to work better with UHCI (4K I/O buffer may
471 * need 3K of TDs) it may be good to limit how many
472 * URBs are queued at once; N milliseconds?
478 /* fail any uncompleted urbs */
480 spin_lock_irq (&io->lock);
481 io->count -= entries - i;
482 if (io->status == -EINPROGRESS)
485 complete (&io->complete);
486 spin_unlock_irq (&io->lock);
488 io->urbs[i]->dev = NULL;
489 io->urbs [i]->status = retval;
490 dev_dbg (&io->dev->dev, "%s, submit --> %d\n",
491 __FUNCTION__, retval);
494 spin_lock_irq (&io->lock);
495 if (retval && io->status == -ECONNRESET)
498 spin_unlock_irq (&io->lock);
500 /* OK, yes, this could be packaged as non-blocking.
501 * So could the submit loop above ... but it's easier to
502 * solve neither problem than to solve both!
504 wait_for_completion (&io->complete);
510 * usb_sg_cancel - stop scatter/gather i/o issued by usb_sg_wait()
511 * @io: request block, initialized with usb_sg_init()
513 * This stops a request after it has been started by usb_sg_wait().
514 * It can also prevents one initialized by usb_sg_init() from starting,
515 * so that call just frees resources allocated to the request.
517 void usb_sg_cancel (struct usb_sg_request *io)
521 spin_lock_irqsave (&io->lock, flags);
523 /* shut everything down, if it didn't already */
527 io->status = -ECONNRESET;
528 for (i = 0; i < io->entries; i++) {
531 if (!io->urbs [i]->dev)
533 retval = usb_unlink_urb (io->urbs [i]);
534 if (retval != -EINPROGRESS && retval != -EBUSY)
535 dev_warn (&io->dev->dev, "%s, unlink --> %d\n",
536 __FUNCTION__, retval);
539 spin_unlock_irqrestore (&io->lock, flags);
542 /*-------------------------------------------------------------------*/
545 * usb_get_descriptor - issues a generic GET_DESCRIPTOR request
546 * @dev: the device whose descriptor is being retrieved
547 * @type: the descriptor type (USB_DT_*)
548 * @index: the number of the descriptor
549 * @buf: where to put the descriptor
550 * @size: how big is "buf"?
551 * Context: !in_interrupt ()
553 * Gets a USB descriptor. Convenience functions exist to simplify
554 * getting some types of descriptors. Use
555 * usb_get_device_descriptor() for USB_DT_DEVICE (not exported),
556 * and usb_get_string() or usb_string() for USB_DT_STRING.
557 * Device (USB_DT_DEVICE) and configuration descriptors (USB_DT_CONFIG)
558 * are part of the device structure.
559 * In addition to a number of USB-standard descriptors, some
560 * devices also use class-specific or vendor-specific descriptors.
562 * This call is synchronous, and may not be used in an interrupt context.
564 * Returns the number of bytes received on success, or else the status code
565 * returned by the underlying usb_control_msg() call.
567 int usb_get_descriptor(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)
572 memset(buf,0,size); // Make sure we parse really received data
574 for (i = 0; i < 3; ++i) {
575 /* retry on length 0 or stall; some devices are flakey */
576 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
577 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
578 (type << 8) + index, 0, buf, size,
579 HZ * USB_CTRL_GET_TIMEOUT);
580 if (!(result == 0 || result == -EPIPE))
587 * usb_get_string - gets a string descriptor
588 * @dev: the device whose string descriptor is being retrieved
589 * @langid: code for language chosen (from string descriptor zero)
590 * @index: the number of the descriptor
591 * @buf: where to put the string
592 * @size: how big is "buf"?
593 * Context: !in_interrupt ()
595 * Retrieves a string, encoded using UTF-16LE (Unicode, 16 bits per character,
596 * in little-endian byte order).
597 * The usb_string() function will often be a convenient way to turn
598 * these strings into kernel-printable form.
600 * Strings may be referenced in device, configuration, interface, or other
601 * descriptors, and could also be used in vendor-specific ways.
603 * This call is synchronous, and may not be used in an interrupt context.
605 * Returns the number of bytes received on success, or else the status code
606 * returned by the underlying usb_control_msg() call.
608 int usb_get_string(struct usb_device *dev, unsigned short langid,
609 unsigned char index, void *buf, int size)
614 for (i = 0; i < 3; ++i) {
615 /* retry on length 0 or stall; some devices are flakey */
616 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
617 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
618 (USB_DT_STRING << 8) + index, langid, buf, size,
619 HZ * USB_CTRL_GET_TIMEOUT);
620 if (!(result == 0 || result == -EPIPE))
626 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
627 unsigned int index, unsigned char *buf)
631 /* Try to read the string descriptor by asking for the maximum
632 * possible number of bytes */
633 rc = usb_get_string(dev, langid, index, buf, 255);
635 /* If that failed try to read the descriptor length, then
636 * ask for just that many bytes */
638 rc = usb_get_string(dev, langid, index, buf, 2);
640 rc = usb_get_string(dev, langid, index, buf, buf[0]);
644 /* There might be extra junk at the end of the descriptor */
654 * usb_string - returns ISO 8859-1 version of a string descriptor
655 * @dev: the device whose string descriptor is being retrieved
656 * @index: the number of the descriptor
657 * @buf: where to put the string
658 * @size: how big is "buf"?
659 * Context: !in_interrupt ()
661 * This converts the UTF-16LE encoded strings returned by devices, from
662 * usb_get_string_descriptor(), to null-terminated ISO-8859-1 encoded ones
663 * that are more usable in most kernel contexts. Note that all characters
664 * in the chosen descriptor that can't be encoded using ISO-8859-1
665 * are converted to the question mark ("?") character, and this function
666 * chooses strings in the first language supported by the device.
668 * The ASCII (or, redundantly, "US-ASCII") character set is the seven-bit
669 * subset of ISO 8859-1. ISO-8859-1 is the eight-bit subset of Unicode,
670 * and is appropriate for use many uses of English and several other
671 * Western European languages. (But it doesn't include the "Euro" symbol.)
673 * This call is synchronous, and may not be used in an interrupt context.
675 * Returns length of the string (>= 0) or usb_control_msg status (< 0).
677 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
683 if (size <= 0 || !buf || !index)
686 tbuf = kmalloc(256, GFP_KERNEL);
690 /* get langid for strings if it's not yet known */
691 if (!dev->have_langid) {
692 err = usb_string_sub(dev, 0, 0, tbuf);
695 "string descriptor 0 read error: %d\n",
698 } else if (err < 4) {
699 dev_err (&dev->dev, "string descriptor 0 too short\n");
703 dev->have_langid = -1;
704 dev->string_langid = tbuf[2] | (tbuf[3]<< 8);
705 /* always use the first langid listed */
706 dev_dbg (&dev->dev, "default language 0x%04x\n",
711 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
715 size--; /* leave room for trailing NULL char in output buffer */
716 for (idx = 0, u = 2; u < err; u += 2) {
719 if (tbuf[u+1]) /* high byte */
720 buf[idx++] = '?'; /* non ISO-8859-1 character */
722 buf[idx++] = tbuf[u];
733 * usb_get_device_descriptor - (re)reads the device descriptor
734 * @dev: the device whose device descriptor is being updated
735 * @size: how much of the descriptor to read
736 * Context: !in_interrupt ()
738 * Updates the copy of the device descriptor stored in the device structure,
739 * which dedicates space for this purpose. Note that several fields are
740 * converted to the host CPU's byte order: the USB version (bcdUSB), and
741 * vendors product and version fields (idVendor, idProduct, and bcdDevice).
742 * That lets device drivers compare against non-byteswapped constants.
744 * Not exported, only for use by the core. If drivers really want to read
745 * the device descriptor directly, they can call usb_get_descriptor() with
746 * type = USB_DT_DEVICE and index = 0.
748 * This call is synchronous, and may not be used in an interrupt context.
750 * Returns the number of bytes received on success, or else the status code
751 * returned by the underlying usb_control_msg() call.
753 int usb_get_device_descriptor(struct usb_device *dev, unsigned int size)
755 struct usb_device_descriptor *desc;
758 if (size > sizeof(*desc))
760 desc = kmalloc(sizeof(*desc), GFP_NOIO);
764 ret = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, size);
766 le16_to_cpus(&desc->bcdUSB);
767 le16_to_cpus(&desc->idVendor);
768 le16_to_cpus(&desc->idProduct);
769 le16_to_cpus(&desc->bcdDevice);
770 memcpy(&dev->descriptor, desc, size);
777 * usb_get_status - issues a GET_STATUS call
778 * @dev: the device whose status is being checked
779 * @type: USB_RECIP_*; for device, interface, or endpoint
780 * @target: zero (for device), else interface or endpoint number
781 * @data: pointer to two bytes of bitmap data
782 * Context: !in_interrupt ()
784 * Returns device, interface, or endpoint status. Normally only of
785 * interest to see if the device is self powered, or has enabled the
786 * remote wakeup facility; or whether a bulk or interrupt endpoint
787 * is halted ("stalled").
789 * Bits in these status bitmaps are set using the SET_FEATURE request,
790 * and cleared using the CLEAR_FEATURE request. The usb_clear_halt()
791 * function should be used to clear halt ("stall") status.
793 * This call is synchronous, and may not be used in an interrupt context.
795 * Returns the number of bytes received on success, or else the status code
796 * returned by the underlying usb_control_msg() call.
798 int usb_get_status(struct usb_device *dev, int type, int target, void *data)
800 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
801 USB_REQ_GET_STATUS, USB_DIR_IN | type, 0, target, data, 2,
802 HZ * USB_CTRL_GET_TIMEOUT);
806 * usb_clear_halt - tells device to clear endpoint halt/stall condition
807 * @dev: device whose endpoint is halted
808 * @pipe: endpoint "pipe" being cleared
809 * Context: !in_interrupt ()
811 * This is used to clear halt conditions for bulk and interrupt endpoints,
812 * as reported by URB completion status. Endpoints that are halted are
813 * sometimes referred to as being "stalled". Such endpoints are unable
814 * to transmit or receive data until the halt status is cleared. Any URBs
815 * queued for such an endpoint should normally be unlinked by the driver
816 * before clearing the halt condition, as described in sections 5.7.5
817 * and 5.8.5 of the USB 2.0 spec.
819 * Note that control and isochronous endpoints don't halt, although control
820 * endpoints report "protocol stall" (for unsupported requests) using the
821 * same status code used to report a true stall.
823 * This call is synchronous, and may not be used in an interrupt context.
825 * Returns zero on success, or else the status code returned by the
826 * underlying usb_control_msg() call.
828 int usb_clear_halt(struct usb_device *dev, int pipe)
831 int endp = usb_pipeendpoint(pipe);
833 if (usb_pipein (pipe))
836 /* we don't care if it wasn't halted first. in fact some devices
837 * (like some ibmcam model 1 units) seem to expect hosts to make
838 * this request for iso endpoints, which can't halt!
840 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
841 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
842 USB_ENDPOINT_HALT, endp, NULL, 0,
843 HZ * USB_CTRL_SET_TIMEOUT);
845 /* don't un-halt or force to DATA0 except on success */
849 /* NOTE: seems like Microsoft and Apple don't bother verifying
850 * the clear "took", so some devices could lock up if you check...
851 * such as the Hagiwara FlashGate DUAL. So we won't bother.
853 * NOTE: make sure the logic here doesn't diverge much from
854 * the copy in usb-storage, for as long as we need two copies.
857 /* toggle was reset by the clear, then ep was reactivated */
858 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
859 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
865 * usb_disable_endpoint -- Disable an endpoint by address
866 * @dev: the device whose endpoint is being disabled
867 * @epaddr: the endpoint's address. Endpoint number for output,
868 * endpoint number + USB_DIR_IN for input
870 * Deallocates hcd/hardware state for this endpoint ... and nukes all
873 * If the HCD hasn't registered a disable() function, this marks the
874 * endpoint as halted and sets its maxpacket size to 0 to prevent
875 * further submissions.
877 void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr)
879 if (dev && dev->bus && dev->bus->op && dev->bus->op->disable)
880 dev->bus->op->disable(dev, epaddr);
882 unsigned int epnum = epaddr & USB_ENDPOINT_NUMBER_MASK;
884 if (usb_endpoint_out(epaddr)) {
885 usb_endpoint_halt(dev, epnum, 1);
886 dev->epmaxpacketout[epnum] = 0;
888 usb_endpoint_halt(dev, epnum, 0);
889 dev->epmaxpacketin[epnum] = 0;
895 * usb_disable_interface -- Disable all endpoints for an interface
896 * @dev: the device whose interface is being disabled
897 * @intf: pointer to the interface descriptor
899 * Disables all the endpoints for the interface's current altsetting.
901 void usb_disable_interface(struct usb_device *dev, struct usb_interface *intf)
903 struct usb_host_interface *alt = intf->cur_altsetting;
906 for (i = 0; i < alt->desc.bNumEndpoints; ++i) {
907 usb_disable_endpoint(dev,
908 alt->endpoint[i].desc.bEndpointAddress);
913 * usb_disable_device - Disable all the endpoints for a USB device
914 * @dev: the device whose endpoints are being disabled
915 * @skip_ep0: 0 to disable endpoint 0, 1 to skip it.
917 * Disables all the device's endpoints, potentially including endpoint 0.
918 * Deallocates hcd/hardware state for the endpoints (nuking all or most
919 * pending urbs) and usbcore state for the interfaces, so that usbcore
920 * must usb_set_configuration() before any interfaces could be used.
922 void usb_disable_device(struct usb_device *dev, int skip_ep0)
926 dev_dbg(&dev->dev, "%s nuking %s URBs\n", __FUNCTION__,
927 skip_ep0 ? "non-ep0" : "all");
928 for (i = skip_ep0; i < 16; ++i) {
929 usb_disable_endpoint(dev, i);
930 usb_disable_endpoint(dev, i + USB_DIR_IN);
932 dev->toggle[0] = dev->toggle[1] = 0;
933 dev->halted[0] = dev->halted[1] = 0;
935 /* getting rid of interfaces will disconnect
936 * any drivers bound to them (a key side effect)
938 if (dev->actconfig) {
939 for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) {
940 struct usb_interface *interface;
942 /* remove this interface */
943 interface = dev->actconfig->interface[i];
944 dev_dbg (&dev->dev, "unregistering interface %s\n",
945 interface->dev.bus_id);
946 usb_remove_sysfs_intf_files(interface);
947 device_del (&interface->dev);
950 /* Now that the interfaces are unbound, nobody should
951 * try to access them.
953 for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) {
954 put_device (&dev->actconfig->interface[i]->dev);
955 dev->actconfig->interface[i] = NULL;
957 dev->actconfig = NULL;
958 if (dev->state == USB_STATE_CONFIGURED)
959 usb_set_device_state(dev, USB_STATE_ADDRESS);
965 * usb_enable_endpoint - Enable an endpoint for USB communications
966 * @dev: the device whose interface is being enabled
967 * @epd: pointer to the endpoint descriptor
969 * Marks the endpoint as running, resets its toggle, and stores
970 * its maxpacket value. For control endpoints, both the input
971 * and output sides are handled.
973 void usb_enable_endpoint(struct usb_device *dev,
974 struct usb_endpoint_descriptor *epd)
976 int maxsize = epd->wMaxPacketSize;
977 unsigned int epaddr = epd->bEndpointAddress;
978 unsigned int epnum = epaddr & USB_ENDPOINT_NUMBER_MASK;
979 int is_control = ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
980 USB_ENDPOINT_XFER_CONTROL);
982 if (usb_endpoint_out(epaddr) || is_control) {
983 usb_endpoint_running(dev, epnum, 1);
984 usb_settoggle(dev, epnum, 1, 0);
985 dev->epmaxpacketout[epnum] = maxsize;
987 if (!usb_endpoint_out(epaddr) || is_control) {
988 usb_endpoint_running(dev, epnum, 0);
989 usb_settoggle(dev, epnum, 0, 0);
990 dev->epmaxpacketin[epnum] = maxsize;
995 * usb_enable_interface - Enable all the endpoints for an interface
996 * @dev: the device whose interface is being enabled
997 * @intf: pointer to the interface descriptor
999 * Enables all the endpoints for the interface's current altsetting.
1001 void usb_enable_interface(struct usb_device *dev,
1002 struct usb_interface *intf)
1004 struct usb_host_interface *alt = intf->cur_altsetting;
1007 for (i = 0; i < alt->desc.bNumEndpoints; ++i)
1008 usb_enable_endpoint(dev, &alt->endpoint[i].desc);
1012 * usb_set_interface - Makes a particular alternate setting be current
1013 * @dev: the device whose interface is being updated
1014 * @interface: the interface being updated
1015 * @alternate: the setting being chosen.
1016 * Context: !in_interrupt ()
1018 * This is used to enable data transfers on interfaces that may not
1019 * be enabled by default. Not all devices support such configurability.
1020 * Only the driver bound to an interface may change its setting.
1022 * Within any given configuration, each interface may have several
1023 * alternative settings. These are often used to control levels of
1024 * bandwidth consumption. For example, the default setting for a high
1025 * speed interrupt endpoint may not send more than 64 bytes per microframe,
1026 * while interrupt transfers of up to 3KBytes per microframe are legal.
1027 * Also, isochronous endpoints may never be part of an
1028 * interface's default setting. To access such bandwidth, alternate
1029 * interface settings must be made current.
1031 * Note that in the Linux USB subsystem, bandwidth associated with
1032 * an endpoint in a given alternate setting is not reserved until an URB
1033 * is submitted that needs that bandwidth. Some other operating systems
1034 * allocate bandwidth early, when a configuration is chosen.
1036 * This call is synchronous, and may not be used in an interrupt context.
1037 * Also, drivers must not change altsettings while urbs are scheduled for
1038 * endpoints in that interface; all such urbs must first be completed
1039 * (perhaps forced by unlinking).
1041 * Returns zero on success, or else the status code returned by the
1042 * underlying usb_control_msg() call.
1044 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
1046 struct usb_interface *iface;
1047 struct usb_host_interface *alt;
1051 iface = usb_ifnum_to_if(dev, interface);
1053 dev_dbg(&dev->dev, "selecting invalid interface %d\n",
1058 alt = usb_altnum_to_altsetting(iface, alternate);
1060 warn("selecting invalid altsetting %d", alternate);
1064 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1065 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
1066 alternate, interface, NULL, 0, HZ * 5);
1068 /* 9.4.10 says devices don't need this and are free to STALL the
1069 * request if the interface only has one alternate setting.
1071 if (ret == -EPIPE && iface->num_altsetting == 1) {
1073 "manual set_interface for iface %d, alt %d\n",
1074 interface, alternate);
1079 /* FIXME drivers shouldn't need to replicate/bugfix the logic here
1080 * when they implement async or easily-killable versions of this or
1081 * other "should-be-internal" functions (like clear_halt).
1082 * should hcd+usbcore postprocess control requests?
1085 /* prevent submissions using previous endpoint settings */
1086 usb_disable_interface(dev, iface);
1088 iface->cur_altsetting = alt;
1090 /* If the interface only has one altsetting and the device didn't
1091 * accept the request, we attempt to carry out the equivalent action
1092 * by manually clearing the HALT feature for each endpoint in the
1098 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
1099 unsigned int epaddr =
1100 alt->endpoint[i].desc.bEndpointAddress;
1102 __create_pipe(dev, USB_ENDPOINT_NUMBER_MASK & epaddr)
1103 | (usb_endpoint_out(epaddr) ? USB_DIR_OUT : USB_DIR_IN);
1105 usb_clear_halt(dev, pipe);
1109 /* 9.1.1.5: reset toggles for all endpoints in the new altsetting
1112 * Despite EP0 is always present in all interfaces/AS, the list of
1113 * endpoints from the descriptor does not contain EP0. Due to its
1114 * omnipresence one might expect EP0 being considered "affected" by
1115 * any SetInterface request and hence assume toggles need to be reset.
1116 * However, EP0 toggles are re-synced for every individual transfer
1117 * during the SETUP stage - hence EP0 toggles are "don't care" here.
1118 * (Likewise, EP0 never "halts" on well designed devices.)
1120 usb_enable_interface(dev, iface);
1126 * usb_reset_configuration - lightweight device reset
1127 * @dev: the device whose configuration is being reset
1129 * This issues a standard SET_CONFIGURATION request to the device using
1130 * the current configuration. The effect is to reset most USB-related
1131 * state in the device, including interface altsettings (reset to zero),
1132 * endpoint halts (cleared), and data toggle (only for bulk and interrupt
1133 * endpoints). Other usbcore state is unchanged, including bindings of
1134 * usb device drivers to interfaces.
1136 * Because this affects multiple interfaces, avoid using this with composite
1137 * (multi-interface) devices. Instead, the driver for each interface may
1138 * use usb_set_interface() on the interfaces it claims. Resetting the whole
1139 * configuration would affect other drivers' interfaces.
1141 * Returns zero on success, else a negative error code.
1143 int usb_reset_configuration(struct usb_device *dev)
1146 struct usb_host_config *config;
1148 /* caller must own dev->serialize (config won't change)
1149 * and the usb bus readlock (so driver bindings are stable);
1150 * so calls during probe() are fine
1153 for (i = 1; i < 16; ++i) {
1154 usb_disable_endpoint(dev, i);
1155 usb_disable_endpoint(dev, i + USB_DIR_IN);
1158 config = dev->actconfig;
1159 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1160 USB_REQ_SET_CONFIGURATION, 0,
1161 config->desc.bConfigurationValue, 0,
1162 NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1164 usb_set_device_state(dev, USB_STATE_ADDRESS);
1168 dev->toggle[0] = dev->toggle[1] = 0;
1169 dev->halted[0] = dev->halted[1] = 0;
1171 /* re-init hc/hcd interface/endpoint state */
1172 for (i = 0; i < config->desc.bNumInterfaces; i++) {
1173 struct usb_interface *intf = config->interface[i];
1174 struct usb_host_interface *alt;
1176 alt = usb_altnum_to_altsetting(intf, 0);
1178 /* No altsetting 0? We'll assume the first altsetting.
1179 * We could use a GetInterface call, but if a device is
1180 * so non-compliant that it doesn't have altsetting 0
1181 * then I wouldn't trust its reply anyway.
1184 alt = &intf->altsetting[0];
1186 intf->cur_altsetting = alt;
1187 usb_enable_interface(dev, intf);
1192 static void release_interface(struct device *dev)
1194 struct usb_interface *intf = to_usb_interface(dev);
1195 struct usb_interface_cache *intfc =
1196 altsetting_to_usb_interface_cache(intf->altsetting);
1198 kref_put(&intfc->ref);
1203 * usb_set_configuration - Makes a particular device setting be current
1204 * @dev: the device whose configuration is being updated
1205 * @configuration: the configuration being chosen.
1206 * Context: !in_interrupt(), caller holds dev->serialize
1208 * This is used to enable non-default device modes. Not all devices
1209 * use this kind of configurability; many devices only have one
1212 * USB device configurations may affect Linux interoperability,
1213 * power consumption and the functionality available. For example,
1214 * the default configuration is limited to using 100mA of bus power,
1215 * so that when certain device functionality requires more power,
1216 * and the device is bus powered, that functionality should be in some
1217 * non-default device configuration. Other device modes may also be
1218 * reflected as configuration options, such as whether two ISDN
1219 * channels are available independently; and choosing between open
1220 * standard device protocols (like CDC) or proprietary ones.
1222 * Note that USB has an additional level of device configurability,
1223 * associated with interfaces. That configurability is accessed using
1224 * usb_set_interface().
1226 * This call is synchronous. The calling context must be able to sleep,
1227 * and must not hold the driver model lock for USB; usb device driver
1228 * probe() methods may not use this routine.
1230 * Returns zero on success, or else the status code returned by the
1231 * underlying call that failed. On succesful completion, each interface
1232 * in the original device configuration has been destroyed, and each one
1233 * in the new configuration has been probed by all relevant usb device
1234 * drivers currently known to the kernel.
1236 int usb_set_configuration(struct usb_device *dev, int configuration)
1239 struct usb_host_config *cp = NULL;
1240 struct usb_interface **new_interfaces = NULL;
1243 /* dev->serialize guards all config changes */
1245 for (i = 0; i < dev->descriptor.bNumConfigurations; i++) {
1246 if (dev->config[i].desc.bConfigurationValue == configuration) {
1247 cp = &dev->config[i];
1251 if ((!cp && configuration != 0))
1254 /* The USB spec says configuration 0 means unconfigured.
1255 * But if a device includes a configuration numbered 0,
1256 * we will accept it as a correctly configured state.
1258 if (cp && configuration == 0)
1259 dev_warn(&dev->dev, "config 0 descriptor??\n");
1261 /* Allocate memory for new interfaces before doing anything else,
1262 * so that if we run out then nothing will have changed. */
1265 nintf = cp->desc.bNumInterfaces;
1266 new_interfaces = kmalloc(nintf * sizeof(*new_interfaces),
1268 if (!new_interfaces) {
1269 dev_err(&dev->dev, "Out of memory");
1273 for (; n < nintf; ++n) {
1274 new_interfaces[n] = kmalloc(
1275 sizeof(struct usb_interface),
1277 if (!new_interfaces[n]) {
1278 dev_err(&dev->dev, "Out of memory");
1282 kfree(new_interfaces[n]);
1283 kfree(new_interfaces);
1289 /* if it's already configured, clear out old state first.
1290 * getting rid of old interfaces means unbinding their drivers.
1292 if (dev->state != USB_STATE_ADDRESS)
1293 usb_disable_device (dev, 1); // Skip ep0
1295 if ((ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1296 USB_REQ_SET_CONFIGURATION, 0, configuration, 0,
1297 NULL, 0, HZ * USB_CTRL_SET_TIMEOUT)) < 0)
1298 goto free_interfaces;
1300 dev->actconfig = cp;
1302 usb_set_device_state(dev, USB_STATE_ADDRESS);
1304 usb_set_device_state(dev, USB_STATE_CONFIGURED);
1306 /* Initialize the new interface structures and the
1307 * hc/hcd/usbcore interface/endpoint state.
1309 for (i = 0; i < nintf; ++i) {
1310 struct usb_interface_cache *intfc;
1311 struct usb_interface *intf;
1312 struct usb_host_interface *alt;
1314 cp->interface[i] = intf = new_interfaces[i];
1315 memset(intf, 0, sizeof(*intf));
1316 intfc = cp->intf_cache[i];
1317 intf->altsetting = intfc->altsetting;
1318 intf->num_altsetting = intfc->num_altsetting;
1319 kref_get(&intfc->ref);
1321 alt = usb_altnum_to_altsetting(intf, 0);
1323 /* No altsetting 0? We'll assume the first altsetting.
1324 * We could use a GetInterface call, but if a device is
1325 * so non-compliant that it doesn't have altsetting 0
1326 * then I wouldn't trust its reply anyway.
1329 alt = &intf->altsetting[0];
1331 intf->cur_altsetting = alt;
1332 usb_enable_interface(dev, intf);
1333 intf->dev.parent = &dev->dev;
1334 intf->dev.driver = NULL;
1335 intf->dev.bus = &usb_bus_type;
1336 intf->dev.dma_mask = dev->dev.dma_mask;
1337 intf->dev.release = release_interface;
1338 device_initialize (&intf->dev);
1339 sprintf (&intf->dev.bus_id[0], "%d-%s:%d.%d",
1340 dev->bus->busnum, dev->devpath,
1342 alt->desc.bInterfaceNumber);
1344 kfree(new_interfaces);
1346 /* Now that all the interfaces are set up, register them
1347 * to trigger binding of drivers to interfaces. probe()
1348 * routines may install different altsettings and may
1349 * claim() any interfaces not yet bound. Many class drivers
1350 * need that: CDC, audio, video, etc.
1352 for (i = 0; i < nintf; ++i) {
1353 struct usb_interface *intf = cp->interface[i];
1354 struct usb_interface_descriptor *desc;
1356 desc = &intf->altsetting [0].desc;
1358 "adding %s (config #%d, interface %d)\n",
1359 intf->dev.bus_id, configuration,
1360 desc->bInterfaceNumber);
1361 ret = device_add (&intf->dev);
1364 "device_add(%s) --> %d\n",
1369 usb_create_sysfs_intf_files (intf);
1376 // synchronous request completion model
1377 EXPORT_SYMBOL(usb_control_msg);
1378 EXPORT_SYMBOL(usb_bulk_msg);
1380 EXPORT_SYMBOL(usb_sg_init);
1381 EXPORT_SYMBOL(usb_sg_cancel);
1382 EXPORT_SYMBOL(usb_sg_wait);
1384 // synchronous control message convenience routines
1385 EXPORT_SYMBOL(usb_get_descriptor);
1386 EXPORT_SYMBOL(usb_get_status);
1387 EXPORT_SYMBOL(usb_get_string);
1388 EXPORT_SYMBOL(usb_string);
1390 // synchronous calls that also maintain usbcore state
1391 EXPORT_SYMBOL(usb_clear_halt);
1392 EXPORT_SYMBOL(usb_reset_configuration);
1393 EXPORT_SYMBOL(usb_set_interface);