3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/stdint.h>
28 #include <sys/stddef.h>
29 #include <sys/param.h>
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/linker_set.h>
36 #include <sys/module.h>
38 #include <sys/mutex.h>
39 #include <sys/condvar.h>
40 #include <sys/sysctl.h>
42 #include <sys/unistd.h>
43 #include <sys/callout.h>
44 #include <sys/malloc.h>
47 #include <dev/usb/usb.h>
48 #include <dev/usb/usbdi.h>
49 #include <dev/usb/usbdi_util.h>
51 #define USB_DEBUG_VAR usb_debug
53 #include <dev/usb/usb_core.h>
54 #include <dev/usb/usb_busdma.h>
55 #include <dev/usb/usb_process.h>
56 #include <dev/usb/usb_transfer.h>
57 #include <dev/usb/usb_device.h>
58 #include <dev/usb/usb_debug.h>
59 #include <dev/usb/usb_util.h>
61 #include <dev/usb/usb_controller.h>
62 #include <dev/usb/usb_bus.h>
64 struct usb_std_packet_size {
66 uint16_t min; /* inclusive */
67 uint16_t max; /* inclusive */
73 static usb_callback_t usb_request_callback;
75 static const struct usb_config usb_control_ep_cfg[USB_DEFAULT_XFER_MAX] = {
77 /* This transfer is used for generic control endpoint transfers */
81 .endpoint = 0x00, /* Control endpoint */
82 .direction = UE_DIR_ANY,
83 .bufsize = USB_EP0_BUFSIZE, /* bytes */
84 .flags = {.proxy_buffer = 1,},
85 .callback = &usb_request_callback,
86 .usb_mode = USB_MODE_DUAL, /* both modes */
89 /* This transfer is used for generic clear stall only */
93 .endpoint = 0x00, /* Control pipe */
94 .direction = UE_DIR_ANY,
95 .bufsize = sizeof(struct usb_device_request),
96 .callback = &usb_do_clear_stall_callback,
97 .timeout = 1000, /* 1 second */
98 .interval = 50, /* 50ms */
99 .usb_mode = USB_MODE_HOST,
103 /* function prototypes */
105 static void usbd_update_max_frame_size(struct usb_xfer *);
106 static void usbd_transfer_unsetup_sub(struct usb_xfer_root *, uint8_t);
107 static void usbd_control_transfer_init(struct usb_xfer *);
108 static int usbd_setup_ctrl_transfer(struct usb_xfer *);
109 static void usb_callback_proc(struct usb_proc_msg *);
110 static void usbd_callback_ss_done_defer(struct usb_xfer *);
111 static void usbd_callback_wrapper(struct usb_xfer_queue *);
112 static void usb_dma_delay_done_cb(void *);
113 static void usbd_transfer_start_cb(void *);
114 static uint8_t usbd_callback_wrapper_sub(struct usb_xfer *);
115 static void usbd_get_std_packet_size(struct usb_std_packet_size *ptr,
116 uint8_t type, enum usb_dev_speed speed);
118 /*------------------------------------------------------------------------*
119 * usb_request_callback
120 *------------------------------------------------------------------------*/
122 usb_request_callback(struct usb_xfer *xfer, usb_error_t error)
124 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE)
125 usb_handle_request_callback(xfer, error);
127 usbd_do_request_callback(xfer, error);
130 /*------------------------------------------------------------------------*
131 * usbd_update_max_frame_size
133 * This function updates the maximum frame size, hence high speed USB
134 * can transfer multiple consecutive packets.
135 *------------------------------------------------------------------------*/
137 usbd_update_max_frame_size(struct usb_xfer *xfer)
139 /* compute maximum frame size */
141 if (xfer->max_packet_count == 2) {
142 xfer->max_frame_size = 2 * xfer->max_packet_size;
143 } else if (xfer->max_packet_count == 3) {
144 xfer->max_frame_size = 3 * xfer->max_packet_size;
146 xfer->max_frame_size = xfer->max_packet_size;
150 /*------------------------------------------------------------------------*
153 * The following function is called when we need to
154 * synchronize with DMA hardware.
157 * 0: no DMA delay required
158 * Else: milliseconds of DMA delay
159 *------------------------------------------------------------------------*/
161 usbd_get_dma_delay(struct usb_bus *bus)
165 if (bus->methods->get_dma_delay) {
166 (bus->methods->get_dma_delay) (bus, &temp);
168 * Round up and convert to milliseconds. Note that we use
169 * 1024 milliseconds per second. to save a division.
177 /*------------------------------------------------------------------------*
178 * usbd_transfer_setup_sub_malloc
180 * This function will allocate one or more DMA'able memory chunks
181 * according to "size", "align" and "count" arguments. "ppc" is
182 * pointed to a linear array of USB page caches afterwards.
187 *------------------------------------------------------------------------*/
190 usbd_transfer_setup_sub_malloc(struct usb_setup_params *parm,
191 struct usb_page_cache **ppc, usb_size_t size, usb_size_t align,
194 struct usb_page_cache *pc;
204 USB_ASSERT(align > 1, ("Invalid alignment, 0x%08x!\n",
206 USB_ASSERT(size > 0, ("Invalid size = 0!\n"));
209 return (0); /* nothing to allocate */
212 * Make sure that the size is aligned properly.
214 size = -((-size) & (-align));
217 * Try multi-allocation chunks to reduce the number of DMA
218 * allocations, hence DMA allocations are slow.
220 if (size >= PAGE_SIZE) {
224 /* compute number of objects per page */
225 n_obj = (PAGE_SIZE / size);
227 * Compute number of DMA chunks, rounded up
230 n_dma_pc = ((count + n_obj - 1) / n_obj);
233 if (parm->buf == NULL) {
235 parm->dma_page_ptr += n_dma_pc;
236 parm->dma_page_cache_ptr += n_dma_pc;
237 parm->dma_page_ptr += count;
238 parm->xfer_page_cache_ptr += count;
241 for (x = 0; x != n_dma_pc; x++) {
242 /* need to initialize the page cache */
243 parm->dma_page_cache_ptr[x].tag_parent =
244 &parm->curr_xfer->xroot->dma_parent_tag;
246 for (x = 0; x != count; x++) {
247 /* need to initialize the page cache */
248 parm->xfer_page_cache_ptr[x].tag_parent =
249 &parm->curr_xfer->xroot->dma_parent_tag;
253 *ppc = parm->xfer_page_cache_ptr;
255 r = count; /* set remainder count */
256 z = n_obj * size; /* set allocation size */
257 pc = parm->xfer_page_cache_ptr;
258 pg = parm->dma_page_ptr;
260 for (x = 0; x != n_dma_pc; x++) {
263 /* compute last remainder */
267 if (usb_pc_alloc_mem(parm->dma_page_cache_ptr,
269 return (1); /* failure */
271 /* Set beginning of current buffer */
272 buf = parm->dma_page_cache_ptr->buffer;
273 /* Make room for one DMA page cache and one page */
274 parm->dma_page_cache_ptr++;
277 for (y = 0; (y != n_obj); y++, r--, pc++, pg++) {
279 /* Load sub-chunk into DMA */
280 if (usb_pc_dmamap_create(pc, size)) {
281 return (1); /* failure */
283 pc->buffer = USB_ADD_BYTES(buf, y * size);
286 mtx_lock(pc->tag_parent->mtx);
287 if (usb_pc_load_mem(pc, size, 1 /* synchronous */ )) {
288 mtx_unlock(pc->tag_parent->mtx);
289 return (1); /* failure */
291 mtx_unlock(pc->tag_parent->mtx);
295 parm->xfer_page_cache_ptr = pc;
296 parm->dma_page_ptr = pg;
301 /*------------------------------------------------------------------------*
302 * usbd_transfer_setup_sub - transfer setup subroutine
304 * This function must be called from the "xfer_setup" callback of the
305 * USB Host or Device controller driver when setting up an USB
306 * transfer. This function will setup correct packet sizes, buffer
307 * sizes, flags and more, that are stored in the "usb_xfer"
309 *------------------------------------------------------------------------*/
311 usbd_transfer_setup_sub(struct usb_setup_params *parm)
317 struct usb_xfer *xfer = parm->curr_xfer;
318 const struct usb_config *setup = parm->curr_setup;
319 struct usb_endpoint_descriptor *edesc;
320 struct usb_std_packet_size std_size;
321 usb_frcount_t n_frlengths;
322 usb_frcount_t n_frbuffers;
328 * Sanity check. The following parameters must be initialized before
329 * calling this function.
331 if ((parm->hc_max_packet_size == 0) ||
332 (parm->hc_max_packet_count == 0) ||
333 (parm->hc_max_frame_size == 0)) {
334 parm->err = USB_ERR_INVAL;
337 edesc = xfer->endpoint->edesc;
339 type = (edesc->bmAttributes & UE_XFERTYPE);
341 xfer->flags = setup->flags;
342 xfer->nframes = setup->frames;
343 xfer->timeout = setup->timeout;
344 xfer->callback = setup->callback;
345 xfer->interval = setup->interval;
346 xfer->endpointno = edesc->bEndpointAddress;
347 xfer->max_packet_size = UGETW(edesc->wMaxPacketSize);
348 xfer->max_packet_count = 1;
349 /* make a shadow copy: */
350 xfer->flags_int.usb_mode = parm->udev->flags.usb_mode;
352 parm->bufsize = setup->bufsize;
354 if (parm->speed == USB_SPEED_HIGH) {
355 xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3;
356 xfer->max_packet_size &= 0x7FF;
358 /* range check "max_packet_count" */
360 if (xfer->max_packet_count > parm->hc_max_packet_count) {
361 xfer->max_packet_count = parm->hc_max_packet_count;
363 /* filter "wMaxPacketSize" according to HC capabilities */
365 if ((xfer->max_packet_size > parm->hc_max_packet_size) ||
366 (xfer->max_packet_size == 0)) {
367 xfer->max_packet_size = parm->hc_max_packet_size;
369 /* filter "wMaxPacketSize" according to standard sizes */
371 usbd_get_std_packet_size(&std_size, type, parm->speed);
373 if (std_size.range.min || std_size.range.max) {
375 if (xfer->max_packet_size < std_size.range.min) {
376 xfer->max_packet_size = std_size.range.min;
378 if (xfer->max_packet_size > std_size.range.max) {
379 xfer->max_packet_size = std_size.range.max;
383 if (xfer->max_packet_size >= std_size.fixed[3]) {
384 xfer->max_packet_size = std_size.fixed[3];
385 } else if (xfer->max_packet_size >= std_size.fixed[2]) {
386 xfer->max_packet_size = std_size.fixed[2];
387 } else if (xfer->max_packet_size >= std_size.fixed[1]) {
388 xfer->max_packet_size = std_size.fixed[1];
390 /* only one possibility left */
391 xfer->max_packet_size = std_size.fixed[0];
395 /* compute "max_frame_size" */
397 usbd_update_max_frame_size(xfer);
399 /* check interrupt interval and transfer pre-delay */
401 if (type == UE_ISOCHRONOUS) {
403 uint16_t frame_limit;
405 xfer->interval = 0; /* not used, must be zero */
406 xfer->flags_int.isochronous_xfr = 1; /* set flag */
408 if (xfer->timeout == 0) {
410 * set a default timeout in
411 * case something goes wrong!
413 xfer->timeout = 1000 / 4;
415 switch (parm->speed) {
418 frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER;
421 frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER;
425 if (xfer->nframes > frame_limit) {
427 * this is not going to work
430 parm->err = USB_ERR_INVAL;
433 if (xfer->nframes == 0) {
435 * this is not a valid value
437 parm->err = USB_ERR_ZERO_NFRAMES;
443 * if a value is specified use that else check the endpoint
446 if (xfer->interval == 0) {
448 if (type == UE_INTERRUPT) {
450 xfer->interval = edesc->bInterval;
452 switch (parm->speed) {
453 case USB_SPEED_SUPER:
454 case USB_SPEED_VARIABLE:
456 if (xfer->interval < 4)
458 else if (xfer->interval > 16)
459 xfer->interval = (1<<(16-4));
462 (1 << (xfer->interval-4));
471 if (xfer->interval == 0) {
473 * One millisecond is the smallest
474 * interval we support:
483 * NOTE: we do not allow "max_packet_size" or "max_frame_size"
484 * to be equal to zero when setting up USB transfers, hence
485 * this leads to alot of extra code in the USB kernel.
488 if ((xfer->max_frame_size == 0) ||
489 (xfer->max_packet_size == 0)) {
493 if ((parm->bufsize <= MIN_PKT) &&
494 (type != UE_CONTROL) &&
498 xfer->max_packet_size = MIN_PKT;
499 xfer->max_packet_count = 1;
500 parm->bufsize = 0; /* automatic setup length */
501 usbd_update_max_frame_size(xfer);
504 parm->err = USB_ERR_ZERO_MAXP;
513 * check if we should setup a default
517 if (parm->bufsize == 0) {
519 parm->bufsize = xfer->max_frame_size;
521 if (type == UE_ISOCHRONOUS) {
522 parm->bufsize *= xfer->nframes;
526 * check if we are about to setup a proxy
530 if (xfer->flags.proxy_buffer) {
532 /* round bufsize up */
534 parm->bufsize += (xfer->max_frame_size - 1);
536 if (parm->bufsize < xfer->max_frame_size) {
537 /* length wrapped around */
538 parm->err = USB_ERR_INVAL;
541 /* subtract remainder */
543 parm->bufsize -= (parm->bufsize % xfer->max_frame_size);
545 /* add length of USB device request structure, if any */
547 if (type == UE_CONTROL) {
548 parm->bufsize += REQ_SIZE; /* SETUP message */
551 xfer->max_data_length = parm->bufsize;
553 /* Setup "n_frlengths" and "n_frbuffers" */
555 if (type == UE_ISOCHRONOUS) {
556 n_frlengths = xfer->nframes;
560 if (type == UE_CONTROL) {
561 xfer->flags_int.control_xfr = 1;
562 if (xfer->nframes == 0) {
563 if (parm->bufsize <= REQ_SIZE) {
565 * there will never be any data
574 if (xfer->nframes == 0) {
579 n_frlengths = xfer->nframes;
580 n_frbuffers = xfer->nframes;
584 * check if we have room for the
585 * USB device request structure:
588 if (type == UE_CONTROL) {
590 if (xfer->max_data_length < REQ_SIZE) {
591 /* length wrapped around or too small bufsize */
592 parm->err = USB_ERR_INVAL;
595 xfer->max_data_length -= REQ_SIZE;
597 /* setup "frlengths" */
598 xfer->frlengths = parm->xfer_length_ptr;
599 parm->xfer_length_ptr += n_frlengths;
601 /* setup "frbuffers" */
602 xfer->frbuffers = parm->xfer_page_cache_ptr;
603 parm->xfer_page_cache_ptr += n_frbuffers;
605 /* initialize max frame count */
606 xfer->max_frame_count = xfer->nframes;
609 * check if we need to setup
613 if (!xfer->flags.ext_buffer) {
616 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1));
621 USB_ADD_BYTES(parm->buf, parm->size[0]);
623 usbd_xfer_set_frame_offset(xfer, 0, 0);
625 if ((type == UE_CONTROL) && (n_frbuffers > 1)) {
626 usbd_xfer_set_frame_offset(xfer, REQ_SIZE, 1);
629 parm->size[0] += parm->bufsize;
631 /* align data again */
632 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1));
635 * Compute maximum buffer size
638 if (parm->bufsize_max < parm->bufsize) {
639 parm->bufsize_max = parm->bufsize;
642 if (xfer->flags_int.bdma_enable) {
644 * Setup "dma_page_ptr".
646 * Proof for formula below:
648 * Assume there are three USB frames having length "a", "b" and
649 * "c". These USB frames will at maximum need "z"
650 * "usb_page" structures. "z" is given by:
652 * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) +
653 * ((c / USB_PAGE_SIZE) + 2);
655 * Constraining "a", "b" and "c" like this:
657 * (a + b + c) <= parm->bufsize
661 * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2));
663 * Here is the general formula:
665 xfer->dma_page_ptr = parm->dma_page_ptr;
666 parm->dma_page_ptr += (2 * n_frbuffers);
667 parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE);
671 /* correct maximum data length */
672 xfer->max_data_length = 0;
674 /* subtract USB frame remainder from "hc_max_frame_size" */
676 xfer->max_hc_frame_size =
677 (parm->hc_max_frame_size -
678 (parm->hc_max_frame_size % xfer->max_frame_size));
680 if (xfer->max_hc_frame_size == 0) {
681 parm->err = USB_ERR_INVAL;
685 /* initialize frame buffers */
688 for (x = 0; x != n_frbuffers; x++) {
689 xfer->frbuffers[x].tag_parent =
690 &xfer->xroot->dma_parent_tag;
692 if (xfer->flags_int.bdma_enable &&
693 (parm->bufsize_max > 0)) {
695 if (usb_pc_dmamap_create(
697 parm->bufsize_max)) {
698 parm->err = USB_ERR_NOMEM;
708 * Set some dummy values so that we avoid division by zero:
710 xfer->max_hc_frame_size = 1;
711 xfer->max_frame_size = 1;
712 xfer->max_packet_size = 1;
713 xfer->max_data_length = 0;
715 xfer->max_frame_count = 0;
719 /*------------------------------------------------------------------------*
720 * usbd_transfer_setup - setup an array of USB transfers
722 * NOTE: You must always call "usbd_transfer_unsetup" after calling
723 * "usbd_transfer_setup" if success was returned.
725 * The idea is that the USB device driver should pre-allocate all its
726 * transfers by one call to this function.
731 *------------------------------------------------------------------------*/
733 usbd_transfer_setup(struct usb_device *udev,
734 const uint8_t *ifaces, struct usb_xfer **ppxfer,
735 const struct usb_config *setup_start, uint16_t n_setup,
736 void *priv_sc, struct mtx *xfer_mtx)
738 struct usb_xfer dummy;
739 struct usb_setup_params parm;
740 const struct usb_config *setup_end = setup_start + n_setup;
741 const struct usb_config *setup;
742 struct usb_endpoint *ep;
743 struct usb_xfer_root *info;
744 struct usb_xfer *xfer;
753 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
754 "usbd_transfer_setup can sleep!");
756 /* do some checking first */
759 DPRINTFN(6, "setup array has zero length!\n");
760 return (USB_ERR_INVAL);
763 DPRINTFN(6, "ifaces array is NULL!\n");
764 return (USB_ERR_INVAL);
766 if (xfer_mtx == NULL) {
767 DPRINTFN(6, "using global lock\n");
771 for (setup = setup_start, n = 0;
772 setup != setup_end; setup++, n++) {
773 if (setup->bufsize == (usb_frlength_t)-1) {
774 parm.err = USB_ERR_BAD_BUFSIZE;
775 DPRINTF("invalid bufsize\n");
777 if (setup->callback == NULL) {
778 parm.err = USB_ERR_NO_CALLBACK;
779 DPRINTF("no callback\n");
787 bzero(&parm, sizeof(parm));
790 parm.speed = usbd_get_speed(udev);
791 parm.hc_max_packet_count = 1;
793 if (parm.speed >= USB_SPEED_MAX) {
794 parm.err = USB_ERR_INVAL;
797 /* setup all transfers */
803 * Initialize the "usb_xfer_root" structure,
804 * which is common for all our USB transfers.
806 info = USB_ADD_BYTES(buf, 0);
808 info->memory_base = buf;
809 info->memory_size = parm.size[0];
812 info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]);
813 info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]);
815 info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]);
816 info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]);
818 cv_init(&info->cv_drain, "WDRAIN");
820 info->xfer_mtx = xfer_mtx;
822 usb_dma_tag_setup(&info->dma_parent_tag,
823 parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag,
824 xfer_mtx, &usb_bdma_done_event, 32, parm.dma_tag_max);
827 info->bus = udev->bus;
830 TAILQ_INIT(&info->done_q.head);
831 info->done_q.command = &usbd_callback_wrapper;
833 TAILQ_INIT(&info->dma_q.head);
834 info->dma_q.command = &usb_bdma_work_loop;
836 info->done_m[0].hdr.pm_callback = &usb_callback_proc;
837 info->done_m[0].xroot = info;
838 info->done_m[1].hdr.pm_callback = &usb_callback_proc;
839 info->done_m[1].xroot = info;
842 * In device side mode control endpoint
843 * requests need to run from a separate
844 * context, else there is a chance of
847 if (setup_start == usb_control_ep_cfg)
849 &udev->bus->control_xfer_proc;
850 else if (xfer_mtx == &Giant)
852 &udev->bus->giant_callback_proc;
855 &udev->bus->non_giant_callback_proc;
861 parm.size[0] += sizeof(info[0]);
863 for (setup = setup_start, n = 0;
864 setup != setup_end; setup++, n++) {
866 /* skip USB transfers without callbacks: */
867 if (setup->callback == NULL) {
870 /* see if there is a matching endpoint */
871 ep = usbd_get_endpoint(udev,
872 ifaces[setup->if_index], setup);
874 if ((ep == NULL) || (ep->methods == NULL)) {
875 if (setup->flags.no_pipe_ok)
877 if ((setup->usb_mode != USB_MODE_DUAL) &&
878 (setup->usb_mode != udev->flags.usb_mode))
880 parm.err = USB_ERR_NO_PIPE;
884 /* align data properly */
885 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
887 /* store current setup pointer */
888 parm.curr_setup = setup;
892 * Common initialization of the
893 * "usb_xfer" structure.
895 xfer = USB_ADD_BYTES(buf, parm.size[0]);
896 xfer->address = udev->address;
897 xfer->priv_sc = priv_sc;
900 usb_callout_init_mtx(&xfer->timeout_handle,
901 &udev->bus->bus_mtx, 0);
904 * Setup a dummy xfer, hence we are
905 * writing to the "usb_xfer"
906 * structure pointed to by "xfer"
907 * before we have allocated any
911 bzero(&dummy, sizeof(dummy));
915 /* set transfer endpoint pointer */
918 parm.size[0] += sizeof(xfer[0]);
919 parm.methods = xfer->endpoint->methods;
920 parm.curr_xfer = xfer;
923 * Call the Host or Device controller transfer
926 (udev->bus->methods->xfer_setup) (&parm);
928 /* check for error */
934 * Increment the endpoint refcount. This
935 * basically prevents setting a new
936 * configuration and alternate setting
937 * when USB transfers are in use on
938 * the given interface. Search the USB
939 * code for "endpoint->refcount" if you
940 * want more information.
942 xfer->endpoint->refcount++;
945 * Whenever we set ppxfer[] then we
946 * also need to increment the
949 info->setup_refcount++;
952 * Transfer is successfully setup and
959 if (buf || parm.err) {
963 /* no transfers - nothing to do ! */
966 /* align data properly */
967 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
969 /* store offset temporarily */
970 parm.size[1] = parm.size[0];
973 * The number of DMA tags required depends on
974 * the number of endpoints. The current estimate
975 * for maximum number of DMA tags per endpoint
978 parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX);
981 * DMA tags for QH, TD, Data and more.
983 parm.dma_tag_max += 8;
985 parm.dma_tag_p += parm.dma_tag_max;
987 parm.size[0] += ((uint8_t *)parm.dma_tag_p) -
990 /* align data properly */
991 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
993 /* store offset temporarily */
994 parm.size[3] = parm.size[0];
996 parm.size[0] += ((uint8_t *)parm.dma_page_ptr) -
999 /* align data properly */
1000 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
1002 /* store offset temporarily */
1003 parm.size[4] = parm.size[0];
1005 parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) -
1008 /* store end offset temporarily */
1009 parm.size[5] = parm.size[0];
1011 parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) -
1014 /* store end offset temporarily */
1016 parm.size[2] = parm.size[0];
1018 /* align data properly */
1019 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
1021 parm.size[6] = parm.size[0];
1023 parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) -
1026 /* align data properly */
1027 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
1029 /* allocate zeroed memory */
1030 buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO);
1033 parm.err = USB_ERR_NOMEM;
1034 DPRINTFN(0, "cannot allocate memory block for "
1035 "configuration (%d bytes)\n",
1039 parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]);
1040 parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]);
1041 parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]);
1042 parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]);
1043 parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]);
1048 if (info->setup_refcount == 0) {
1050 * "usbd_transfer_unsetup_sub" will unlock
1051 * the bus mutex before returning !
1053 USB_BUS_LOCK(info->bus);
1055 /* something went wrong */
1056 usbd_transfer_unsetup_sub(info, 0);
1060 usbd_transfer_unsetup(ppxfer, n_setup);
1065 /*------------------------------------------------------------------------*
1066 * usbd_transfer_unsetup_sub - factored out code
1067 *------------------------------------------------------------------------*/
1069 usbd_transfer_unsetup_sub(struct usb_xfer_root *info, uint8_t needs_delay)
1071 struct usb_page_cache *pc;
1073 USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED);
1075 /* wait for any outstanding DMA operations */
1079 temp = usbd_get_dma_delay(info->bus);
1080 usb_pause_mtx(&info->bus->bus_mtx,
1081 USB_MS_TO_TICKS(temp));
1084 /* make sure that our done messages are not queued anywhere */
1085 usb_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]);
1087 USB_BUS_UNLOCK(info->bus);
1090 /* free DMA'able memory, if any */
1091 pc = info->dma_page_cache_start;
1092 while (pc != info->dma_page_cache_end) {
1093 usb_pc_free_mem(pc);
1097 /* free DMA maps in all "xfer->frbuffers" */
1098 pc = info->xfer_page_cache_start;
1099 while (pc != info->xfer_page_cache_end) {
1100 usb_pc_dmamap_destroy(pc);
1104 /* free all DMA tags */
1105 usb_dma_tag_unsetup(&info->dma_parent_tag);
1108 cv_destroy(&info->cv_drain);
1111 * free the "memory_base" last, hence the "info" structure is
1112 * contained within the "memory_base"!
1114 free(info->memory_base, M_USB);
1117 /*------------------------------------------------------------------------*
1118 * usbd_transfer_unsetup - unsetup/free an array of USB transfers
1120 * NOTE: All USB transfers in progress will get called back passing
1121 * the error code "USB_ERR_CANCELLED" before this function
1123 *------------------------------------------------------------------------*/
1125 usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup)
1127 struct usb_xfer *xfer;
1128 struct usb_xfer_root *info;
1129 uint8_t needs_delay = 0;
1131 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
1132 "usbd_transfer_unsetup can sleep!");
1135 xfer = pxfer[n_setup];
1142 USB_XFER_LOCK(xfer);
1143 USB_BUS_LOCK(info->bus);
1146 * HINT: when you start/stop a transfer, it might be a
1147 * good idea to directly use the "pxfer[]" structure:
1149 * usbd_transfer_start(sc->pxfer[0]);
1150 * usbd_transfer_stop(sc->pxfer[0]);
1152 * That way, if your code has many parts that will not
1153 * stop running under the same lock, in other words
1154 * "xfer_mtx", the usbd_transfer_start and
1155 * usbd_transfer_stop functions will simply return
1156 * when they detect a NULL pointer argument.
1158 * To avoid any races we clear the "pxfer[]" pointer
1159 * while holding the private mutex of the driver:
1161 pxfer[n_setup] = NULL;
1163 USB_BUS_UNLOCK(info->bus);
1164 USB_XFER_UNLOCK(xfer);
1166 usbd_transfer_drain(xfer);
1169 if (xfer->flags_int.bdma_enable)
1173 * NOTE: default endpoint does not have an
1174 * interface, even if endpoint->iface_index == 0
1176 xfer->endpoint->refcount--;
1178 usb_callout_drain(&xfer->timeout_handle);
1180 USB_BUS_LOCK(info->bus);
1182 USB_ASSERT(info->setup_refcount != 0, ("Invalid setup "
1183 "reference count!\n"));
1185 info->setup_refcount--;
1187 if (info->setup_refcount == 0) {
1188 usbd_transfer_unsetup_sub(info,
1191 USB_BUS_UNLOCK(info->bus);
1196 /*------------------------------------------------------------------------*
1197 * usbd_control_transfer_init - factored out code
1199 * In USB Device Mode we have to wait for the SETUP packet which
1200 * containst the "struct usb_device_request" structure, before we can
1201 * transfer any data. In USB Host Mode we already have the SETUP
1202 * packet at the moment the USB transfer is started. This leads us to
1203 * having to setup the USB transfer at two different places in
1204 * time. This function just contains factored out control transfer
1205 * initialisation code, so that we don't duplicate the code.
1206 *------------------------------------------------------------------------*/
1208 usbd_control_transfer_init(struct usb_xfer *xfer)
1210 struct usb_device_request req;
1212 /* copy out the USB request header */
1214 usbd_copy_out(xfer->frbuffers, 0, &req, sizeof(req));
1216 /* setup remainder */
1218 xfer->flags_int.control_rem = UGETW(req.wLength);
1220 /* copy direction to endpoint variable */
1222 xfer->endpointno &= ~(UE_DIR_IN | UE_DIR_OUT);
1224 (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT;
1227 /*------------------------------------------------------------------------*
1228 * usbd_setup_ctrl_transfer
1230 * This function handles initialisation of control transfers. Control
1231 * transfers are special in that regard that they can both transmit
1237 *------------------------------------------------------------------------*/
1239 usbd_setup_ctrl_transfer(struct usb_xfer *xfer)
1243 /* Check for control endpoint stall */
1244 if (xfer->flags.stall_pipe && xfer->flags_int.control_act) {
1245 /* the control transfer is no longer active */
1246 xfer->flags_int.control_stall = 1;
1247 xfer->flags_int.control_act = 0;
1249 /* don't stall control transfer by default */
1250 xfer->flags_int.control_stall = 0;
1253 /* Check for invalid number of frames */
1254 if (xfer->nframes > 2) {
1256 * If you need to split a control transfer, you
1257 * have to do one part at a time. Only with
1258 * non-control transfers you can do multiple
1261 DPRINTFN(0, "Too many frames: %u\n",
1262 (unsigned int)xfer->nframes);
1267 * Check if there is a control
1268 * transfer in progress:
1270 if (xfer->flags_int.control_act) {
1272 if (xfer->flags_int.control_hdr) {
1274 /* clear send header flag */
1276 xfer->flags_int.control_hdr = 0;
1278 /* setup control transfer */
1279 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) {
1280 usbd_control_transfer_init(xfer);
1283 /* get data length */
1289 /* the size of the SETUP structure is hardcoded ! */
1291 if (xfer->frlengths[0] != sizeof(struct usb_device_request)) {
1292 DPRINTFN(0, "Wrong framelength %u != %zu\n",
1293 xfer->frlengths[0], sizeof(struct
1294 usb_device_request));
1297 /* check USB mode */
1298 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) {
1300 /* check number of frames */
1301 if (xfer->nframes != 1) {
1303 * We need to receive the setup
1304 * message first so that we know the
1307 DPRINTF("Misconfigured transfer\n");
1311 * Set a dummy "control_rem" value. This
1312 * variable will be overwritten later by a
1313 * call to "usbd_control_transfer_init()" !
1315 xfer->flags_int.control_rem = 0xFFFF;
1318 /* setup "endpoint" and "control_rem" */
1320 usbd_control_transfer_init(xfer);
1323 /* set transfer-header flag */
1325 xfer->flags_int.control_hdr = 1;
1327 /* get data length */
1329 len = (xfer->sumlen - sizeof(struct usb_device_request));
1332 /* check if there is a length mismatch */
1334 if (len > xfer->flags_int.control_rem) {
1335 DPRINTFN(0, "Length greater than remaining length!\n");
1338 /* check if we are doing a short transfer */
1340 if (xfer->flags.force_short_xfer) {
1341 xfer->flags_int.control_rem = 0;
1343 if ((len != xfer->max_data_length) &&
1344 (len != xfer->flags_int.control_rem) &&
1345 (xfer->nframes != 1)) {
1346 DPRINTFN(0, "Short control transfer without "
1347 "force_short_xfer set!\n");
1350 xfer->flags_int.control_rem -= len;
1353 /* the status part is executed when "control_act" is 0 */
1355 if ((xfer->flags_int.control_rem > 0) ||
1356 (xfer->flags.manual_status)) {
1357 /* don't execute the STATUS stage yet */
1358 xfer->flags_int.control_act = 1;
1361 if ((!xfer->flags_int.control_hdr) &&
1362 (xfer->nframes == 1)) {
1364 * This is not a valid operation!
1366 DPRINTFN(0, "Invalid parameter "
1371 /* time to execute the STATUS stage */
1372 xfer->flags_int.control_act = 0;
1374 return (0); /* success */
1377 return (1); /* failure */
1380 /*------------------------------------------------------------------------*
1381 * usbd_transfer_submit - start USB hardware for the given transfer
1383 * This function should only be called from the USB callback.
1384 *------------------------------------------------------------------------*/
1386 usbd_transfer_submit(struct usb_xfer *xfer)
1388 struct usb_xfer_root *info;
1389 struct usb_bus *bus;
1395 DPRINTF("xfer=%p, endpoint=%p, nframes=%d, dir=%s\n",
1396 xfer, xfer->endpoint, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ?
1400 if (USB_DEBUG_VAR > 0) {
1403 usb_dump_endpoint(xfer->endpoint);
1405 USB_BUS_UNLOCK(bus);
1409 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1410 USB_BUS_LOCK_ASSERT(bus, MA_NOTOWNED);
1412 /* Only open the USB transfer once! */
1413 if (!xfer->flags_int.open) {
1414 xfer->flags_int.open = 1;
1419 (xfer->endpoint->methods->open) (xfer);
1420 USB_BUS_UNLOCK(bus);
1422 /* set "transferring" flag */
1423 xfer->flags_int.transferring = 1;
1426 /* increment power reference */
1427 usbd_transfer_power_ref(xfer, 1);
1430 * Check if the transfer is waiting on a queue, most
1431 * frequently the "done_q":
1433 if (xfer->wait_queue) {
1435 usbd_transfer_dequeue(xfer);
1436 USB_BUS_UNLOCK(bus);
1438 /* clear "did_dma_delay" flag */
1439 xfer->flags_int.did_dma_delay = 0;
1441 /* clear "did_close" flag */
1442 xfer->flags_int.did_close = 0;
1445 /* clear "bdma_setup" flag */
1446 xfer->flags_int.bdma_setup = 0;
1448 /* by default we cannot cancel any USB transfer immediately */
1449 xfer->flags_int.can_cancel_immed = 0;
1451 /* clear lengths and frame counts by default */
1456 /* clear any previous errors */
1459 /* Check if the device is still alive */
1460 if (info->udev->state < USB_STATE_POWERED) {
1463 * Must return cancelled error code else
1464 * device drivers can hang.
1466 usbd_transfer_done(xfer, USB_ERR_CANCELLED);
1467 USB_BUS_UNLOCK(bus);
1472 if (xfer->nframes == 0) {
1473 if (xfer->flags.stall_pipe) {
1475 * Special case - want to stall without transferring
1478 DPRINTF("xfer=%p nframes=0: stall "
1479 "or clear stall!\n", xfer);
1481 xfer->flags_int.can_cancel_immed = 1;
1482 /* start the transfer */
1483 usb_command_wrapper(&xfer->endpoint->endpoint_q, xfer);
1484 USB_BUS_UNLOCK(bus);
1488 usbd_transfer_done(xfer, USB_ERR_INVAL);
1489 USB_BUS_UNLOCK(bus);
1492 /* compute total transfer length */
1494 for (x = 0; x != xfer->nframes; x++) {
1495 xfer->sumlen += xfer->frlengths[x];
1496 if (xfer->sumlen < xfer->frlengths[x]) {
1497 /* length wrapped around */
1499 usbd_transfer_done(xfer, USB_ERR_INVAL);
1500 USB_BUS_UNLOCK(bus);
1505 /* clear some internal flags */
1507 xfer->flags_int.short_xfer_ok = 0;
1508 xfer->flags_int.short_frames_ok = 0;
1510 /* check if this is a control transfer */
1512 if (xfer->flags_int.control_xfr) {
1514 if (usbd_setup_ctrl_transfer(xfer)) {
1516 usbd_transfer_done(xfer, USB_ERR_STALLED);
1517 USB_BUS_UNLOCK(bus);
1522 * Setup filtered version of some transfer flags,
1523 * in case of data read direction
1525 if (USB_GET_DATA_ISREAD(xfer)) {
1527 if (xfer->flags.short_frames_ok) {
1528 xfer->flags_int.short_xfer_ok = 1;
1529 xfer->flags_int.short_frames_ok = 1;
1530 } else if (xfer->flags.short_xfer_ok) {
1531 xfer->flags_int.short_xfer_ok = 1;
1533 /* check for control transfer */
1534 if (xfer->flags_int.control_xfr) {
1536 * 1) Control transfers do not support
1537 * reception of multiple short USB
1538 * frames in host mode and device side
1539 * mode, with exception of:
1541 * 2) Due to sometimes buggy device
1542 * side firmware we need to do a
1543 * STATUS stage in case of short
1544 * control transfers in USB host mode.
1545 * The STATUS stage then becomes the
1546 * "alt_next" to the DATA stage.
1548 xfer->flags_int.short_frames_ok = 1;
1553 * Check if BUS-DMA support is enabled and try to load virtual
1554 * buffers into DMA, if any:
1557 if (xfer->flags_int.bdma_enable) {
1558 /* insert the USB transfer last in the BUS-DMA queue */
1559 usb_command_wrapper(&xfer->xroot->dma_q, xfer);
1564 * Enter the USB transfer into the Host Controller or
1565 * Device Controller schedule:
1567 usbd_pipe_enter(xfer);
1570 /*------------------------------------------------------------------------*
1571 * usbd_pipe_enter - factored out code
1572 *------------------------------------------------------------------------*/
1574 usbd_pipe_enter(struct usb_xfer *xfer)
1576 struct usb_endpoint *ep;
1578 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1580 USB_BUS_LOCK(xfer->xroot->bus);
1582 ep = xfer->endpoint;
1586 /* enter the transfer */
1587 (ep->methods->enter) (xfer);
1589 xfer->flags_int.can_cancel_immed = 1;
1591 /* check for transfer error */
1593 /* some error has happened */
1594 usbd_transfer_done(xfer, 0);
1595 USB_BUS_UNLOCK(xfer->xroot->bus);
1599 /* start the transfer */
1600 usb_command_wrapper(&ep->endpoint_q, xfer);
1601 USB_BUS_UNLOCK(xfer->xroot->bus);
1604 /*------------------------------------------------------------------------*
1605 * usbd_transfer_start - start an USB transfer
1607 * NOTE: Calling this function more than one time will only
1608 * result in a single transfer start, until the USB transfer
1610 *------------------------------------------------------------------------*/
1612 usbd_transfer_start(struct usb_xfer *xfer)
1615 /* transfer is gone */
1618 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1620 /* mark the USB transfer started */
1622 if (!xfer->flags_int.started) {
1623 xfer->flags_int.started = 1;
1625 /* check if the USB transfer callback is already transferring */
1627 if (xfer->flags_int.transferring) {
1630 USB_BUS_LOCK(xfer->xroot->bus);
1631 /* call the USB transfer callback */
1632 usbd_callback_ss_done_defer(xfer);
1633 USB_BUS_UNLOCK(xfer->xroot->bus);
1636 /*------------------------------------------------------------------------*
1637 * usbd_transfer_stop - stop an USB transfer
1639 * NOTE: Calling this function more than one time will only
1640 * result in a single transfer stop.
1641 * NOTE: When this function returns it is not safe to free nor
1642 * reuse any DMA buffers. See "usbd_transfer_drain()".
1643 *------------------------------------------------------------------------*/
1645 usbd_transfer_stop(struct usb_xfer *xfer)
1647 struct usb_endpoint *ep;
1650 /* transfer is gone */
1653 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1655 /* check if the USB transfer was ever opened */
1657 if (!xfer->flags_int.open) {
1658 /* nothing to do except clearing the "started" flag */
1659 xfer->flags_int.started = 0;
1662 /* try to stop the current USB transfer */
1664 USB_BUS_LOCK(xfer->xroot->bus);
1665 xfer->error = USB_ERR_CANCELLED;/* override any previous error */
1667 * Clear "open" and "started" when both private and USB lock
1668 * is locked so that we don't get a race updating "flags_int"
1670 xfer->flags_int.open = 0;
1671 xfer->flags_int.started = 0;
1674 * Check if we can cancel the USB transfer immediately.
1676 if (xfer->flags_int.transferring) {
1677 if (xfer->flags_int.can_cancel_immed &&
1678 (!xfer->flags_int.did_close)) {
1681 * The following will lead to an USB_ERR_CANCELLED
1682 * error code being passed to the USB callback.
1684 (xfer->endpoint->methods->close) (xfer);
1685 /* only close once */
1686 xfer->flags_int.did_close = 1;
1688 /* need to wait for the next done callback */
1693 /* close here and now */
1694 (xfer->endpoint->methods->close) (xfer);
1697 * Any additional DMA delay is done by
1698 * "usbd_transfer_unsetup()".
1702 * Special case. Check if we need to restart a blocked
1705 ep = xfer->endpoint;
1708 * If the current USB transfer is completing we need
1709 * to start the next one:
1711 if (ep->endpoint_q.curr == xfer) {
1712 usb_command_wrapper(&ep->endpoint_q, NULL);
1716 USB_BUS_UNLOCK(xfer->xroot->bus);
1719 /*------------------------------------------------------------------------*
1720 * usbd_transfer_pending
1722 * This function will check if an USB transfer is pending which is a
1723 * little bit complicated!
1726 * 1: Pending: The USB transfer will receive a callback in the future.
1727 *------------------------------------------------------------------------*/
1729 usbd_transfer_pending(struct usb_xfer *xfer)
1731 struct usb_xfer_root *info;
1732 struct usb_xfer_queue *pq;
1735 /* transfer is gone */
1738 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1740 if (xfer->flags_int.transferring) {
1744 USB_BUS_LOCK(xfer->xroot->bus);
1745 if (xfer->wait_queue) {
1746 /* we are waiting on a queue somewhere */
1747 USB_BUS_UNLOCK(xfer->xroot->bus);
1753 if (pq->curr == xfer) {
1754 /* we are currently scheduled for callback */
1755 USB_BUS_UNLOCK(xfer->xroot->bus);
1758 /* we are not pending */
1759 USB_BUS_UNLOCK(xfer->xroot->bus);
1763 /*------------------------------------------------------------------------*
1764 * usbd_transfer_drain
1766 * This function will stop the USB transfer and wait for any
1767 * additional BUS-DMA and HW-DMA operations to complete. Buffers that
1768 * are loaded into DMA can safely be freed or reused after that this
1769 * function has returned.
1770 *------------------------------------------------------------------------*/
1772 usbd_transfer_drain(struct usb_xfer *xfer)
1774 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
1775 "usbd_transfer_drain can sleep!");
1778 /* transfer is gone */
1781 if (xfer->xroot->xfer_mtx != &Giant) {
1782 USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED);
1784 USB_XFER_LOCK(xfer);
1786 usbd_transfer_stop(xfer);
1788 while (usbd_transfer_pending(xfer) ||
1789 xfer->flags_int.doing_callback) {
1792 * It is allowed that the callback can drop its
1793 * transfer mutex. In that case checking only
1794 * "usbd_transfer_pending()" is not enough to tell if
1795 * the USB transfer is fully drained. We also need to
1796 * check the internal "doing_callback" flag.
1798 xfer->flags_int.draining = 1;
1801 * Wait until the current outstanding USB
1802 * transfer is complete !
1804 cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx);
1806 USB_XFER_UNLOCK(xfer);
1809 struct usb_page_cache *
1810 usbd_xfer_get_frame(struct usb_xfer *xfer, usb_frcount_t frindex)
1812 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow"));
1814 return (&xfer->frbuffers[frindex]);
1818 usbd_xfer_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex)
1820 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow"));
1822 return (xfer->frlengths[frindex]);
1825 /*------------------------------------------------------------------------*
1826 * usbd_xfer_set_frame_data
1828 * This function sets the pointer of the buffer that should
1829 * loaded directly into DMA for the given USB frame. Passing "ptr"
1830 * equal to NULL while the corresponding "frlength" is greater
1831 * than zero gives undefined results!
1832 *------------------------------------------------------------------------*/
1834 usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
1835 void *ptr, usb_frlength_t len)
1837 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow"));
1839 /* set virtual address to load and length */
1840 xfer->frbuffers[frindex].buffer = ptr;
1841 usbd_xfer_set_frame_len(xfer, frindex, len);
1845 usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
1846 void **ptr, int *len)
1848 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow"));
1851 *ptr = xfer->frbuffers[frindex].buffer;
1853 *len = xfer->frlengths[frindex];
1857 usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen, int *aframes,
1861 *actlen = xfer->actlen;
1863 *sumlen = xfer->sumlen;
1864 if (aframes != NULL)
1865 *aframes = xfer->aframes;
1866 if (nframes != NULL)
1867 *nframes = xfer->nframes;
1870 /*------------------------------------------------------------------------*
1871 * usbd_xfer_set_frame_offset
1873 * This function sets the frame data buffer offset relative to the beginning
1874 * of the USB DMA buffer allocated for this USB transfer.
1875 *------------------------------------------------------------------------*/
1877 usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
1878 usb_frcount_t frindex)
1880 KASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame "
1881 "when the USB buffer is external!\n"));
1882 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow"));
1884 /* set virtual address to load */
1885 xfer->frbuffers[frindex].buffer =
1886 USB_ADD_BYTES(xfer->local_buffer, offset);
1890 usbd_xfer_set_interval(struct usb_xfer *xfer, int i)
1896 usbd_xfer_set_timeout(struct usb_xfer *xfer, int t)
1902 usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n)
1908 usbd_xfer_max_frames(struct usb_xfer *xfer)
1910 return (xfer->max_frame_count);
1914 usbd_xfer_max_len(struct usb_xfer *xfer)
1916 return (xfer->max_data_length);
1920 usbd_xfer_max_framelen(struct usb_xfer *xfer)
1922 return (xfer->max_frame_size);
1926 usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
1929 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow"));
1931 xfer->frlengths[frindex] = len;
1934 /*------------------------------------------------------------------------*
1935 * usb_callback_proc - factored out code
1937 * This function performs USB callbacks.
1938 *------------------------------------------------------------------------*/
1940 usb_callback_proc(struct usb_proc_msg *_pm)
1942 struct usb_done_msg *pm = (void *)_pm;
1943 struct usb_xfer_root *info = pm->xroot;
1945 /* Change locking order */
1946 USB_BUS_UNLOCK(info->bus);
1949 * We exploit the fact that the mutex is the same for all
1950 * callbacks that will be called from this thread:
1952 mtx_lock(info->xfer_mtx);
1953 USB_BUS_LOCK(info->bus);
1955 /* Continue where we lost track */
1956 usb_command_wrapper(&info->done_q,
1959 mtx_unlock(info->xfer_mtx);
1962 /*------------------------------------------------------------------------*
1963 * usbd_callback_ss_done_defer
1965 * This function will defer the start, stop and done callback to the
1967 *------------------------------------------------------------------------*/
1969 usbd_callback_ss_done_defer(struct usb_xfer *xfer)
1971 struct usb_xfer_root *info = xfer->xroot;
1972 struct usb_xfer_queue *pq = &info->done_q;
1974 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1976 if (pq->curr != xfer) {
1977 usbd_transfer_enqueue(pq, xfer);
1979 if (!pq->recurse_1) {
1982 * We have to postpone the callback due to the fact we
1983 * will have a Lock Order Reversal, LOR, if we try to
1986 if (usb_proc_msignal(info->done_p,
1987 &info->done_m[0], &info->done_m[1])) {
1991 /* clear second recurse flag */
1998 /*------------------------------------------------------------------------*
1999 * usbd_callback_wrapper
2001 * This is a wrapper for USB callbacks. This wrapper does some
2002 * auto-magic things like figuring out if we can call the callback
2003 * directly from the current context or if we need to wakeup the
2004 * interrupt process.
2005 *------------------------------------------------------------------------*/
2007 usbd_callback_wrapper(struct usb_xfer_queue *pq)
2009 struct usb_xfer *xfer = pq->curr;
2010 struct usb_xfer_root *info = xfer->xroot;
2012 USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED);
2013 if (!mtx_owned(info->xfer_mtx)) {
2015 * Cases that end up here:
2017 * 5) HW interrupt done callback or other source.
2019 DPRINTFN(3, "case 5\n");
2022 * We have to postpone the callback due to the fact we
2023 * will have a Lock Order Reversal, LOR, if we try to
2026 if (usb_proc_msignal(info->done_p,
2027 &info->done_m[0], &info->done_m[1])) {
2033 * Cases that end up here:
2035 * 1) We are starting a transfer
2036 * 2) We are prematurely calling back a transfer
2037 * 3) We are stopping a transfer
2038 * 4) We are doing an ordinary callback
2040 DPRINTFN(3, "case 1-4\n");
2041 /* get next USB transfer in the queue */
2042 info->done_q.curr = NULL;
2044 /* set flag in case of drain */
2045 xfer->flags_int.doing_callback = 1;
2047 USB_BUS_UNLOCK(info->bus);
2048 USB_BUS_LOCK_ASSERT(info->bus, MA_NOTOWNED);
2050 /* set correct USB state for callback */
2051 if (!xfer->flags_int.transferring) {
2052 xfer->usb_state = USB_ST_SETUP;
2053 if (!xfer->flags_int.started) {
2054 /* we got stopped before we even got started */
2055 USB_BUS_LOCK(info->bus);
2060 if (usbd_callback_wrapper_sub(xfer)) {
2061 /* the callback has been deferred */
2062 USB_BUS_LOCK(info->bus);
2066 /* decrement power reference */
2067 usbd_transfer_power_ref(xfer, -1);
2069 xfer->flags_int.transferring = 0;
2072 xfer->usb_state = USB_ST_ERROR;
2074 /* set transferred state */
2075 xfer->usb_state = USB_ST_TRANSFERRED;
2077 /* sync DMA memory, if any */
2078 if (xfer->flags_int.bdma_enable &&
2079 (!xfer->flags_int.bdma_no_post_sync)) {
2080 usb_bdma_post_sync(xfer);
2086 /* call processing routine */
2087 (xfer->callback) (xfer, xfer->error);
2089 /* pickup the USB mutex again */
2090 USB_BUS_LOCK(info->bus);
2093 * Check if we got started after that we got cancelled, but
2094 * before we managed to do the callback.
2096 if ((!xfer->flags_int.open) &&
2097 (xfer->flags_int.started) &&
2098 (xfer->usb_state == USB_ST_ERROR)) {
2099 /* clear flag in case of drain */
2100 xfer->flags_int.doing_callback = 0;
2101 /* try to loop, but not recursivly */
2102 usb_command_wrapper(&info->done_q, xfer);
2107 /* clear flag in case of drain */
2108 xfer->flags_int.doing_callback = 0;
2111 * Check if we are draining.
2113 if (xfer->flags_int.draining &&
2114 (!xfer->flags_int.transferring)) {
2115 /* "usbd_transfer_drain()" is waiting for end of transfer */
2116 xfer->flags_int.draining = 0;
2117 cv_broadcast(&info->cv_drain);
2120 /* do the next callback, if any */
2121 usb_command_wrapper(&info->done_q,
2125 /*------------------------------------------------------------------------*
2126 * usb_dma_delay_done_cb
2128 * This function is called when the DMA delay has been exectuded, and
2129 * will make sure that the callback is called to complete the USB
2130 * transfer. This code path is ususally only used when there is an USB
2131 * error like USB_ERR_CANCELLED.
2132 *------------------------------------------------------------------------*/
2134 usb_dma_delay_done_cb(void *arg)
2136 struct usb_xfer *xfer = arg;
2138 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2140 DPRINTFN(3, "Completed %p\n", xfer);
2142 /* queue callback for execution, again */
2143 usbd_transfer_done(xfer, 0);
2146 /*------------------------------------------------------------------------*
2147 * usbd_transfer_dequeue
2149 * - This function is used to remove an USB transfer from a USB
2152 * - This function can be called multiple times in a row.
2153 *------------------------------------------------------------------------*/
2155 usbd_transfer_dequeue(struct usb_xfer *xfer)
2157 struct usb_xfer_queue *pq;
2159 pq = xfer->wait_queue;
2161 TAILQ_REMOVE(&pq->head, xfer, wait_entry);
2162 xfer->wait_queue = NULL;
2166 /*------------------------------------------------------------------------*
2167 * usbd_transfer_enqueue
2169 * - This function is used to insert an USB transfer into a USB *
2172 * - This function can be called multiple times in a row.
2173 *------------------------------------------------------------------------*/
2175 usbd_transfer_enqueue(struct usb_xfer_queue *pq, struct usb_xfer *xfer)
2178 * Insert the USB transfer into the queue, if it is not
2179 * already on a USB transfer queue:
2181 if (xfer->wait_queue == NULL) {
2182 xfer->wait_queue = pq;
2183 TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry);
2187 /*------------------------------------------------------------------------*
2188 * usbd_transfer_done
2190 * - This function is used to remove an USB transfer from the busdma,
2191 * pipe or interrupt queue.
2193 * - This function is used to queue the USB transfer on the done
2196 * - This function is used to stop any USB transfer timeouts.
2197 *------------------------------------------------------------------------*/
2199 usbd_transfer_done(struct usb_xfer *xfer, usb_error_t error)
2201 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2203 DPRINTF("err=%s\n", usbd_errstr(error));
2206 * If we are not transferring then just return.
2207 * This can happen during transfer cancel.
2209 if (!xfer->flags_int.transferring) {
2210 DPRINTF("not transferring\n");
2213 /* only set transfer error if not already set */
2215 xfer->error = error;
2217 /* stop any callouts */
2218 usb_callout_stop(&xfer->timeout_handle);
2221 * If we are waiting on a queue, just remove the USB transfer
2222 * from the queue, if any. We should have the required locks
2223 * locked to do the remove when this function is called.
2225 usbd_transfer_dequeue(xfer);
2228 if (mtx_owned(xfer->xroot->xfer_mtx)) {
2229 struct usb_xfer_queue *pq;
2232 * If the private USB lock is not locked, then we assume
2233 * that the BUS-DMA load stage has been passed:
2235 pq = &xfer->xroot->dma_q;
2237 if (pq->curr == xfer) {
2238 /* start the next BUS-DMA load, if any */
2239 usb_command_wrapper(pq, NULL);
2243 /* keep some statistics */
2245 xfer->xroot->bus->stats_err.uds_requests
2246 [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++;
2248 xfer->xroot->bus->stats_ok.uds_requests
2249 [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++;
2252 /* call the USB transfer callback */
2253 usbd_callback_ss_done_defer(xfer);
2256 /*------------------------------------------------------------------------*
2257 * usbd_transfer_start_cb
2259 * This function is called to start the USB transfer when
2260 * "xfer->interval" is greater than zero, and and the endpoint type is
2262 *------------------------------------------------------------------------*/
2264 usbd_transfer_start_cb(void *arg)
2266 struct usb_xfer *xfer = arg;
2267 struct usb_endpoint *ep = xfer->endpoint;
2269 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2273 /* start the transfer */
2274 (ep->methods->start) (xfer);
2276 xfer->flags_int.can_cancel_immed = 1;
2278 /* check for error */
2280 /* some error has happened */
2281 usbd_transfer_done(xfer, 0);
2285 /*------------------------------------------------------------------------*
2286 * usbd_xfer_set_stall
2288 * This function is used to set the stall flag outside the
2289 * callback. This function is NULL safe.
2290 *------------------------------------------------------------------------*/
2292 usbd_xfer_set_stall(struct usb_xfer *xfer)
2298 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
2300 /* avoid any races by locking the USB mutex */
2301 USB_BUS_LOCK(xfer->xroot->bus);
2302 xfer->flags.stall_pipe = 1;
2303 USB_BUS_UNLOCK(xfer->xroot->bus);
2307 usbd_xfer_is_stalled(struct usb_xfer *xfer)
2309 return (xfer->endpoint->is_stalled);
2312 /*------------------------------------------------------------------------*
2313 * usbd_transfer_clear_stall
2315 * This function is used to clear the stall flag outside the
2316 * callback. This function is NULL safe.
2317 *------------------------------------------------------------------------*/
2319 usbd_transfer_clear_stall(struct usb_xfer *xfer)
2325 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
2327 /* avoid any races by locking the USB mutex */
2328 USB_BUS_LOCK(xfer->xroot->bus);
2330 xfer->flags.stall_pipe = 0;
2332 USB_BUS_UNLOCK(xfer->xroot->bus);
2335 /*------------------------------------------------------------------------*
2338 * This function is used to add an USB transfer to the pipe transfer list.
2339 *------------------------------------------------------------------------*/
2341 usbd_pipe_start(struct usb_xfer_queue *pq)
2343 struct usb_endpoint *ep;
2344 struct usb_xfer *xfer;
2348 ep = xfer->endpoint;
2350 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2353 * If the endpoint is already stalled we do nothing !
2355 if (ep->is_stalled) {
2359 * Check if we are supposed to stall the endpoint:
2361 if (xfer->flags.stall_pipe) {
2362 /* clear stall command */
2363 xfer->flags.stall_pipe = 0;
2366 * Only stall BULK and INTERRUPT endpoints.
2368 type = (ep->edesc->bmAttributes & UE_XFERTYPE);
2369 if ((type == UE_BULK) ||
2370 (type == UE_INTERRUPT)) {
2371 struct usb_device *udev;
2372 struct usb_xfer_root *info;
2379 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2380 (udev->bus->methods->set_stall) (
2381 udev, NULL, ep, &did_stall);
2382 } else if (udev->default_xfer[1]) {
2383 info = udev->default_xfer[1]->xroot;
2385 &info->bus->non_giant_callback_proc,
2386 &udev->cs_msg[0], &udev->cs_msg[1]);
2388 /* should not happen */
2389 DPRINTFN(0, "No stall handler!\n");
2392 * Check if we should stall. Some USB hardware
2393 * handles set- and clear-stall in hardware.
2397 * The transfer will be continued when
2398 * the clear-stall control endpoint
2399 * message is received.
2406 /* Set or clear stall complete - special case */
2407 if (xfer->nframes == 0) {
2408 /* we are complete */
2410 usbd_transfer_done(xfer, 0);
2416 * 1) Start the first transfer queued.
2418 * 2) Re-start the current USB transfer.
2421 * Check if there should be any
2422 * pre transfer start delay:
2424 if (xfer->interval > 0) {
2425 type = (ep->edesc->bmAttributes & UE_XFERTYPE);
2426 if ((type == UE_BULK) ||
2427 (type == UE_CONTROL)) {
2428 usbd_transfer_timeout_ms(xfer,
2429 &usbd_transfer_start_cb,
2436 /* start USB transfer */
2437 (ep->methods->start) (xfer);
2439 xfer->flags_int.can_cancel_immed = 1;
2441 /* check for error */
2443 /* some error has happened */
2444 usbd_transfer_done(xfer, 0);
2448 /*------------------------------------------------------------------------*
2449 * usbd_transfer_timeout_ms
2451 * This function is used to setup a timeout on the given USB
2452 * transfer. If the timeout has been deferred the callback given by
2453 * "cb" will get called after "ms" milliseconds.
2454 *------------------------------------------------------------------------*/
2456 usbd_transfer_timeout_ms(struct usb_xfer *xfer,
2457 void (*cb) (void *arg), usb_timeout_t ms)
2459 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2462 usb_callout_reset(&xfer->timeout_handle,
2463 USB_MS_TO_TICKS(ms), cb, xfer);
2466 /*------------------------------------------------------------------------*
2467 * usbd_callback_wrapper_sub
2469 * - This function will update variables in an USB transfer after
2470 * that the USB transfer is complete.
2472 * - This function is used to start the next USB transfer on the
2473 * ep transfer queue, if any.
2475 * NOTE: In some special cases the USB transfer will not be removed from
2476 * the pipe queue, but remain first. To enforce USB transfer removal call
2477 * this function passing the error code "USB_ERR_CANCELLED".
2481 * Else: The callback has been deferred.
2482 *------------------------------------------------------------------------*/
2484 usbd_callback_wrapper_sub(struct usb_xfer *xfer)
2486 struct usb_endpoint *ep;
2489 if ((!xfer->flags_int.open) &&
2490 (!xfer->flags_int.did_close)) {
2492 USB_BUS_LOCK(xfer->xroot->bus);
2493 (xfer->endpoint->methods->close) (xfer);
2494 USB_BUS_UNLOCK(xfer->xroot->bus);
2495 /* only close once */
2496 xfer->flags_int.did_close = 1;
2497 return (1); /* wait for new callback */
2500 * If we have a non-hardware induced error we
2501 * need to do the DMA delay!
2503 if (((xfer->error == USB_ERR_CANCELLED) ||
2504 (xfer->error == USB_ERR_TIMEOUT)) &&
2505 (!xfer->flags_int.did_dma_delay)) {
2509 /* only delay once */
2510 xfer->flags_int.did_dma_delay = 1;
2512 /* we can not cancel this delay */
2513 xfer->flags_int.can_cancel_immed = 0;
2515 temp = usbd_get_dma_delay(xfer->xroot->bus);
2517 DPRINTFN(3, "DMA delay, %u ms, "
2518 "on %p\n", temp, xfer);
2521 USB_BUS_LOCK(xfer->xroot->bus);
2522 usbd_transfer_timeout_ms(xfer,
2523 &usb_dma_delay_done_cb, temp);
2524 USB_BUS_UNLOCK(xfer->xroot->bus);
2525 return (1); /* wait for new callback */
2528 /* check actual number of frames */
2529 if (xfer->aframes > xfer->nframes) {
2530 if (xfer->error == 0) {
2531 panic("%s: actual number of frames, %d, is "
2532 "greater than initial number of frames, %d!\n",
2533 __FUNCTION__, xfer->aframes, xfer->nframes);
2535 /* just set some valid value */
2536 xfer->aframes = xfer->nframes;
2539 /* compute actual length */
2542 for (x = 0; x != xfer->aframes; x++) {
2543 xfer->actlen += xfer->frlengths[x];
2547 * Frames that were not transferred get zero actual length in
2548 * case the USB device driver does not check the actual number
2549 * of frames transferred, "xfer->aframes":
2551 for (; x < xfer->nframes; x++) {
2552 usbd_xfer_set_frame_len(xfer, x, 0);
2555 /* check actual length */
2556 if (xfer->actlen > xfer->sumlen) {
2557 if (xfer->error == 0) {
2558 panic("%s: actual length, %d, is greater than "
2559 "initial length, %d!\n",
2560 __FUNCTION__, xfer->actlen, xfer->sumlen);
2562 /* just set some valid value */
2563 xfer->actlen = xfer->sumlen;
2566 DPRINTFN(1, "xfer=%p endpoint=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n",
2567 xfer, xfer->endpoint, xfer->error, xfer->actlen, xfer->sumlen,
2568 xfer->aframes, xfer->nframes);
2571 /* end of control transfer, if any */
2572 xfer->flags_int.control_act = 0;
2574 /* check if we should block the execution queue */
2575 if ((xfer->error != USB_ERR_CANCELLED) &&
2576 (xfer->flags.pipe_bof)) {
2577 DPRINTFN(2, "xfer=%p: Block On Failure "
2578 "on endpoint=%p\n", xfer, xfer->endpoint);
2582 /* check for short transfers */
2583 if (xfer->actlen < xfer->sumlen) {
2585 /* end of control transfer, if any */
2586 xfer->flags_int.control_act = 0;
2588 if (!xfer->flags_int.short_xfer_ok) {
2589 xfer->error = USB_ERR_SHORT_XFER;
2590 if (xfer->flags.pipe_bof) {
2591 DPRINTFN(2, "xfer=%p: Block On Failure on "
2592 "Short Transfer on endpoint %p.\n",
2593 xfer, xfer->endpoint);
2599 * Check if we are in the middle of a
2602 if (xfer->flags_int.control_act) {
2603 DPRINTFN(5, "xfer=%p: Control transfer "
2604 "active on endpoint=%p\n", xfer, xfer->endpoint);
2610 ep = xfer->endpoint;
2613 * If the current USB transfer is completing we need to start the
2616 USB_BUS_LOCK(xfer->xroot->bus);
2617 if (ep->endpoint_q.curr == xfer) {
2618 usb_command_wrapper(&ep->endpoint_q, NULL);
2620 if (ep->endpoint_q.curr || TAILQ_FIRST(&ep->endpoint_q.head)) {
2621 /* there is another USB transfer waiting */
2623 /* this is the last USB transfer */
2624 /* clear isochronous sync flag */
2625 xfer->endpoint->is_synced = 0;
2628 USB_BUS_UNLOCK(xfer->xroot->bus);
2633 /*------------------------------------------------------------------------*
2634 * usb_command_wrapper
2636 * This function is used to execute commands non-recursivly on an USB
2638 *------------------------------------------------------------------------*/
2640 usb_command_wrapper(struct usb_xfer_queue *pq, struct usb_xfer *xfer)
2644 * If the transfer is not already processing,
2647 if (pq->curr != xfer) {
2648 usbd_transfer_enqueue(pq, xfer);
2649 if (pq->curr != NULL) {
2650 /* something is already processing */
2651 DPRINTFN(6, "busy %p\n", pq->curr);
2656 /* Get next element in queue */
2660 if (!pq->recurse_1) {
2664 /* set both recurse flags */
2668 if (pq->curr == NULL) {
2669 xfer = TAILQ_FIRST(&pq->head);
2671 TAILQ_REMOVE(&pq->head, xfer,
2673 xfer->wait_queue = NULL;
2679 DPRINTFN(6, "cb %p (enter)\n", pq->curr);
2681 DPRINTFN(6, "cb %p (leave)\n", pq->curr);
2683 } while (!pq->recurse_2);
2685 /* clear first recurse flag */
2689 /* clear second recurse flag */
2694 /*------------------------------------------------------------------------*
2695 * usbd_default_transfer_setup
2697 * This function is used to setup the default USB control endpoint
2699 *------------------------------------------------------------------------*/
2701 usbd_default_transfer_setup(struct usb_device *udev)
2703 struct usb_xfer *xfer;
2705 uint8_t iface_index;
2707 /* check for root HUB */
2708 if (udev->parent_hub == NULL)
2712 xfer = udev->default_xfer[0];
2714 USB_XFER_LOCK(xfer);
2716 ((xfer->address == udev->address) &&
2717 (udev->default_ep_desc.wMaxPacketSize[0] ==
2718 udev->ddesc.bMaxPacketSize));
2719 if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2722 * NOTE: checking "xfer->address" and
2723 * starting the USB transfer must be
2726 usbd_transfer_start(xfer);
2729 USB_XFER_UNLOCK(xfer);
2736 * All parameters are exactly the same like before.
2742 * Update wMaxPacketSize for the default control endpoint:
2744 udev->default_ep_desc.wMaxPacketSize[0] =
2745 udev->ddesc.bMaxPacketSize;
2748 * Unsetup any existing USB transfer:
2750 usbd_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX);
2753 * Try to setup a new USB transfer for the
2754 * default control endpoint:
2757 if (usbd_transfer_setup(udev, &iface_index,
2758 udev->default_xfer, usb_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL,
2759 udev->default_mtx)) {
2760 DPRINTFN(0, "could not setup default "
2767 /*------------------------------------------------------------------------*
2768 * usbd_clear_data_toggle - factored out code
2770 * NOTE: the intention of this function is not to reset the hardware
2772 *------------------------------------------------------------------------*/
2774 usbd_clear_data_toggle(struct usb_device *udev, struct usb_endpoint *ep)
2776 DPRINTFN(5, "udev=%p endpoint=%p\n", udev, ep);
2778 USB_BUS_LOCK(udev->bus);
2779 ep->toggle_next = 0;
2780 USB_BUS_UNLOCK(udev->bus);
2783 /*------------------------------------------------------------------------*
2784 * usbd_clear_stall_callback - factored out clear stall callback
2787 * xfer1: Clear Stall Control Transfer
2788 * xfer2: Stalled USB Transfer
2790 * This function is NULL safe.
2796 * Clear stall config example:
2798 * static const struct usb_config my_clearstall = {
2799 * .type = UE_CONTROL,
2801 * .direction = UE_DIR_ANY,
2802 * .interval = 50, //50 milliseconds
2803 * .bufsize = sizeof(struct usb_device_request),
2804 * .timeout = 1000, //1.000 seconds
2805 * .callback = &my_clear_stall_callback, // **
2806 * .usb_mode = USB_MODE_HOST,
2809 * ** "my_clear_stall_callback" calls "usbd_clear_stall_callback"
2810 * passing the correct parameters.
2811 *------------------------------------------------------------------------*/
2813 usbd_clear_stall_callback(struct usb_xfer *xfer1,
2814 struct usb_xfer *xfer2)
2816 struct usb_device_request req;
2818 if (xfer2 == NULL) {
2819 /* looks like we are tearing down */
2820 DPRINTF("NULL input parameter\n");
2823 USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED);
2824 USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED);
2826 switch (USB_GET_STATE(xfer1)) {
2830 * pre-clear the data toggle to DATA0 ("umass.c" and
2831 * "ata-usb.c" depends on this)
2834 usbd_clear_data_toggle(xfer2->xroot->udev, xfer2->endpoint);
2836 /* setup a clear-stall packet */
2838 req.bmRequestType = UT_WRITE_ENDPOINT;
2839 req.bRequest = UR_CLEAR_FEATURE;
2840 USETW(req.wValue, UF_ENDPOINT_HALT);
2841 req.wIndex[0] = xfer2->endpoint->edesc->bEndpointAddress;
2843 USETW(req.wLength, 0);
2846 * "usbd_transfer_setup_sub()" will ensure that
2847 * we have sufficient room in the buffer for
2848 * the request structure!
2851 /* copy in the transfer */
2853 usbd_copy_in(xfer1->frbuffers, 0, &req, sizeof(req));
2856 xfer1->frlengths[0] = sizeof(req);
2859 usbd_transfer_submit(xfer1);
2862 case USB_ST_TRANSFERRED:
2865 default: /* Error */
2866 if (xfer1->error == USB_ERR_CANCELLED) {
2871 return (1); /* Clear Stall Finished */
2874 /*------------------------------------------------------------------------*
2875 * usbd_transfer_poll
2877 * The following function gets called from the USB keyboard driver and
2878 * UMASS when the system has paniced.
2880 * NOTE: It is currently not possible to resume normal operation on
2881 * the USB controller which has been polled, due to clearing of the
2882 * "up_dsleep" and "up_msleep" flags.
2883 *------------------------------------------------------------------------*/
2885 usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max)
2887 struct usb_xfer *xfer;
2888 struct usb_xfer_root *xroot;
2889 struct usb_device *udev;
2890 struct usb_proc_msg *pm;
2895 for (n = 0; n != max; n++) {
2896 /* Extra checks to avoid panic */
2899 continue; /* no USB transfer */
2900 xroot = xfer->xroot;
2902 continue; /* no USB root */
2905 continue; /* no USB device */
2906 if (udev->bus == NULL)
2907 continue; /* no BUS structure */
2908 if (udev->bus->methods == NULL)
2909 continue; /* no BUS methods */
2910 if (udev->bus->methods->xfer_poll == NULL)
2911 continue; /* no poll method */
2913 /* make sure that the BUS mutex is not locked */
2915 while (mtx_owned(&xroot->udev->bus->bus_mtx)) {
2916 mtx_unlock(&xroot->udev->bus->bus_mtx);
2920 /* make sure that the transfer mutex is not locked */
2922 while (mtx_owned(xroot->xfer_mtx)) {
2923 mtx_unlock(xroot->xfer_mtx);
2927 /* Make sure cv_signal() and cv_broadcast() is not called */
2928 udev->bus->control_xfer_proc.up_msleep = 0;
2929 udev->bus->explore_proc.up_msleep = 0;
2930 udev->bus->giant_callback_proc.up_msleep = 0;
2931 udev->bus->non_giant_callback_proc.up_msleep = 0;
2933 /* poll USB hardware */
2934 (udev->bus->methods->xfer_poll) (udev->bus);
2936 USB_BUS_LOCK(xroot->bus);
2938 /* check for clear stall */
2939 if (udev->default_xfer[1] != NULL) {
2941 /* poll clear stall start */
2942 pm = &udev->cs_msg[0].hdr;
2943 (pm->pm_callback) (pm);
2944 /* poll clear stall done thread */
2945 pm = &udev->default_xfer[1]->
2946 xroot->done_m[0].hdr;
2947 (pm->pm_callback) (pm);
2950 /* poll done thread */
2951 pm = &xroot->done_m[0].hdr;
2952 (pm->pm_callback) (pm);
2954 USB_BUS_UNLOCK(xroot->bus);
2956 /* restore transfer mutex */
2958 mtx_lock(xroot->xfer_mtx);
2960 /* restore BUS mutex */
2962 mtx_lock(&xroot->udev->bus->bus_mtx);
2967 usbd_get_std_packet_size(struct usb_std_packet_size *ptr,
2968 uint8_t type, enum usb_dev_speed speed)
2970 static const uint16_t intr_range_max[USB_SPEED_MAX] = {
2971 [USB_SPEED_LOW] = 8,
2972 [USB_SPEED_FULL] = 64,
2973 [USB_SPEED_HIGH] = 1024,
2974 [USB_SPEED_VARIABLE] = 1024,
2975 [USB_SPEED_SUPER] = 1024,
2978 static const uint16_t isoc_range_max[USB_SPEED_MAX] = {
2979 [USB_SPEED_LOW] = 0, /* invalid */
2980 [USB_SPEED_FULL] = 1023,
2981 [USB_SPEED_HIGH] = 1024,
2982 [USB_SPEED_VARIABLE] = 3584,
2983 [USB_SPEED_SUPER] = 1024,
2986 static const uint16_t control_min[USB_SPEED_MAX] = {
2987 [USB_SPEED_LOW] = 8,
2988 [USB_SPEED_FULL] = 8,
2989 [USB_SPEED_HIGH] = 64,
2990 [USB_SPEED_VARIABLE] = 512,
2991 [USB_SPEED_SUPER] = 512,
2994 static const uint16_t bulk_min[USB_SPEED_MAX] = {
2995 [USB_SPEED_LOW] = 0, /* not supported */
2996 [USB_SPEED_FULL] = 8,
2997 [USB_SPEED_HIGH] = 512,
2998 [USB_SPEED_VARIABLE] = 512,
2999 [USB_SPEED_SUPER] = 1024,
3004 memset(ptr, 0, sizeof(*ptr));
3008 ptr->range.max = intr_range_max[speed];
3010 case UE_ISOCHRONOUS:
3011 ptr->range.max = isoc_range_max[speed];
3014 if (type == UE_BULK)
3015 temp = bulk_min[speed];
3016 else /* UE_CONTROL */
3017 temp = control_min[speed];
3019 /* default is fixed */
3020 ptr->fixed[0] = temp;
3021 ptr->fixed[1] = temp;
3022 ptr->fixed[2] = temp;
3023 ptr->fixed[3] = temp;
3025 if (speed == USB_SPEED_FULL) {
3026 /* multiple sizes */
3031 if ((speed == USB_SPEED_VARIABLE) &&
3032 (type == UE_BULK)) {
3033 /* multiple sizes */
3034 ptr->fixed[2] = 1024;
3035 ptr->fixed[3] = 1536;
3042 usbd_xfer_softc(struct usb_xfer *xfer)
3044 return (xfer->priv_sc);
3048 usbd_xfer_get_priv(struct usb_xfer *xfer)
3050 return (xfer->priv_fifo);
3054 usbd_xfer_set_priv(struct usb_xfer *xfer, void *ptr)
3056 xfer->priv_fifo = ptr;
3060 usbd_xfer_state(struct usb_xfer *xfer)
3062 return (xfer->usb_state);
3066 usbd_xfer_set_flag(struct usb_xfer *xfer, int flag)
3069 case USB_FORCE_SHORT_XFER:
3070 xfer->flags.force_short_xfer = 1;
3072 case USB_SHORT_XFER_OK:
3073 xfer->flags.short_xfer_ok = 1;
3075 case USB_MULTI_SHORT_OK:
3076 xfer->flags.short_frames_ok = 1;
3078 case USB_MANUAL_STATUS:
3079 xfer->flags.manual_status = 1;
3085 usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag)
3088 case USB_FORCE_SHORT_XFER:
3089 xfer->flags.force_short_xfer = 0;
3091 case USB_SHORT_XFER_OK:
3092 xfer->flags.short_xfer_ok = 0;
3094 case USB_MULTI_SHORT_OK:
3095 xfer->flags.short_frames_ok = 0;
3097 case USB_MANUAL_STATUS:
3098 xfer->flags.manual_status = 0;
3104 * The following function returns in milliseconds when the isochronous
3105 * transfer was completed by the hardware. The returned value wraps
3106 * around 65536 milliseconds.
3109 usbd_xfer_get_timestamp(struct usb_xfer *xfer)
3111 return (xfer->isoc_time_complete);