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 <dev/usb/usb_mfunc.h>
28 #include <dev/usb/usb_error.h>
29 #include <dev/usb/usb.h>
31 #define USB_DEBUG_VAR usb2_debug
33 #include <dev/usb/usb_core.h>
34 #include <dev/usb/usb_busdma.h>
35 #include <dev/usb/usb_process.h>
36 #include <dev/usb/usb_transfer.h>
37 #include <dev/usb/usb_device.h>
38 #include <dev/usb/usb_debug.h>
39 #include <dev/usb/usb_util.h>
41 #include <dev/usb/usb_controller.h>
42 #include <dev/usb/usb_bus.h>
44 struct usb2_std_packet_size {
46 uint16_t min; /* inclusive */
47 uint16_t max; /* inclusive */
53 static usb2_callback_t usb2_request_callback;
55 static const struct usb2_config usb2_control_ep_cfg[USB_DEFAULT_XFER_MAX] = {
57 /* This transfer is used for generic control endpoint transfers */
61 .endpoint = 0x00, /* Control endpoint */
62 .direction = UE_DIR_ANY,
63 .bufsize = USB_EP0_BUFSIZE, /* bytes */
64 .flags = {.proxy_buffer = 1,},
65 .callback = &usb2_request_callback,
66 .usb_mode = USB_MODE_MAX, /* both modes */
69 /* This transfer is used for generic clear stall only */
73 .endpoint = 0x00, /* Control pipe */
74 .direction = UE_DIR_ANY,
75 .bufsize = sizeof(struct usb2_device_request),
76 .callback = &usb2_do_clear_stall_callback,
77 .timeout = 1000, /* 1 second */
78 .interval = 50, /* 50ms */
79 .usb_mode = USB_MODE_HOST,
83 /* function prototypes */
85 static void usb2_update_max_frame_size(struct usb2_xfer *);
86 static void usb2_transfer_unsetup_sub(struct usb2_xfer_root *, uint8_t);
87 static void usb2_control_transfer_init(struct usb2_xfer *);
88 static uint8_t usb2_start_hardware_sub(struct usb2_xfer *);
89 static void usb2_callback_proc(struct usb2_proc_msg *);
90 static void usb2_callback_ss_done_defer(struct usb2_xfer *);
91 static void usb2_callback_wrapper(struct usb2_xfer_queue *);
92 static void usb2_dma_delay_done_cb(void *);
93 static void usb2_transfer_start_cb(void *);
94 static uint8_t usb2_callback_wrapper_sub(struct usb2_xfer *);
95 static void usb2_get_std_packet_size(struct usb2_std_packet_size *ptr,
96 uint8_t type, uint8_t usb_speed);
98 /*------------------------------------------------------------------------*
99 * usb2_request_callback
100 *------------------------------------------------------------------------*/
102 usb2_request_callback(struct usb2_xfer *xfer)
104 if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE)
105 usb2_handle_request_callback(xfer);
107 usb2_do_request_callback(xfer);
110 /*------------------------------------------------------------------------*
111 * usb2_update_max_frame_size
113 * This function updates the maximum frame size, hence high speed USB
114 * can transfer multiple consecutive packets.
115 *------------------------------------------------------------------------*/
117 usb2_update_max_frame_size(struct usb2_xfer *xfer)
119 /* compute maximum frame size */
121 if (xfer->max_packet_count == 2) {
122 xfer->max_frame_size = 2 * xfer->max_packet_size;
123 } else if (xfer->max_packet_count == 3) {
124 xfer->max_frame_size = 3 * xfer->max_packet_size;
126 xfer->max_frame_size = xfer->max_packet_size;
130 /*------------------------------------------------------------------------*
133 * The following function is called when we need to
134 * synchronize with DMA hardware.
137 * 0: no DMA delay required
138 * Else: milliseconds of DMA delay
139 *------------------------------------------------------------------------*/
141 usb2_get_dma_delay(struct usb2_bus *bus)
145 if (bus->methods->get_dma_delay) {
146 (bus->methods->get_dma_delay) (bus, &temp);
148 * Round up and convert to milliseconds. Note that we use
149 * 1024 milliseconds per second. to save a division.
157 /*------------------------------------------------------------------------*
158 * usb2_transfer_setup_sub_malloc
160 * This function will allocate one or more DMA'able memory chunks
161 * according to "size", "align" and "count" arguments. "ppc" is
162 * pointed to a linear array of USB page caches afterwards.
167 *------------------------------------------------------------------------*/
170 usb2_transfer_setup_sub_malloc(struct usb2_setup_params *parm,
171 struct usb2_page_cache **ppc, usb2_size_t size, usb2_size_t align,
174 struct usb2_page_cache *pc;
175 struct usb2_page *pg;
177 usb2_size_t n_dma_pc;
184 USB_ASSERT(align > 1, ("Invalid alignment, 0x%08x!\n",
186 USB_ASSERT(size > 0, ("Invalid size = 0!\n"));
189 return (0); /* nothing to allocate */
192 * Make sure that the size is aligned properly.
194 size = -((-size) & (-align));
197 * Try multi-allocation chunks to reduce the number of DMA
198 * allocations, hence DMA allocations are slow.
200 if (size >= PAGE_SIZE) {
204 /* compute number of objects per page */
205 n_obj = (PAGE_SIZE / size);
207 * Compute number of DMA chunks, rounded up
210 n_dma_pc = ((count + n_obj - 1) / n_obj);
213 if (parm->buf == NULL) {
215 parm->dma_page_ptr += n_dma_pc;
216 parm->dma_page_cache_ptr += n_dma_pc;
217 parm->dma_page_ptr += count;
218 parm->xfer_page_cache_ptr += count;
221 for (x = 0; x != n_dma_pc; x++) {
222 /* need to initialize the page cache */
223 parm->dma_page_cache_ptr[x].tag_parent =
224 &parm->curr_xfer->xroot->dma_parent_tag;
226 for (x = 0; x != count; x++) {
227 /* need to initialize the page cache */
228 parm->xfer_page_cache_ptr[x].tag_parent =
229 &parm->curr_xfer->xroot->dma_parent_tag;
233 *ppc = parm->xfer_page_cache_ptr;
235 r = count; /* set remainder count */
236 z = n_obj * size; /* set allocation size */
237 pc = parm->xfer_page_cache_ptr;
238 pg = parm->dma_page_ptr;
240 for (x = 0; x != n_dma_pc; x++) {
243 /* compute last remainder */
247 if (usb2_pc_alloc_mem(parm->dma_page_cache_ptr,
249 return (1); /* failure */
251 /* Set beginning of current buffer */
252 buf = parm->dma_page_cache_ptr->buffer;
253 /* Make room for one DMA page cache and one page */
254 parm->dma_page_cache_ptr++;
257 for (y = 0; (y != n_obj); y++, r--, pc++, pg++) {
259 /* Load sub-chunk into DMA */
260 if (usb2_pc_dmamap_create(pc, size)) {
261 return (1); /* failure */
263 pc->buffer = USB_ADD_BYTES(buf, y * size);
266 mtx_lock(pc->tag_parent->mtx);
267 if (usb2_pc_load_mem(pc, size, 1 /* synchronous */ )) {
268 mtx_unlock(pc->tag_parent->mtx);
269 return (1); /* failure */
271 mtx_unlock(pc->tag_parent->mtx);
275 parm->xfer_page_cache_ptr = pc;
276 parm->dma_page_ptr = pg;
281 /*------------------------------------------------------------------------*
282 * usb2_transfer_setup_sub - transfer setup subroutine
284 * This function must be called from the "xfer_setup" callback of the
285 * USB Host or Device controller driver when setting up an USB
286 * transfer. This function will setup correct packet sizes, buffer
287 * sizes, flags and more, that are stored in the "usb2_xfer"
289 *------------------------------------------------------------------------*/
291 usb2_transfer_setup_sub(struct usb2_setup_params *parm)
297 struct usb2_xfer *xfer = parm->curr_xfer;
298 const struct usb2_config *setup = parm->curr_setup;
299 struct usb2_endpoint_descriptor *edesc;
300 struct usb2_std_packet_size std_size;
301 usb2_frcount_t n_frlengths;
302 usb2_frcount_t n_frbuffers;
308 * Sanity check. The following parameters must be initialized before
309 * calling this function.
311 if ((parm->hc_max_packet_size == 0) ||
312 (parm->hc_max_packet_count == 0) ||
313 (parm->hc_max_frame_size == 0)) {
314 parm->err = USB_ERR_INVAL;
317 edesc = xfer->pipe->edesc;
319 type = (edesc->bmAttributes & UE_XFERTYPE);
321 xfer->flags = setup->flags;
322 xfer->nframes = setup->frames;
323 xfer->timeout = setup->timeout;
324 xfer->callback = setup->callback;
325 xfer->interval = setup->interval;
326 xfer->endpoint = edesc->bEndpointAddress;
327 xfer->max_packet_size = UGETW(edesc->wMaxPacketSize);
328 xfer->max_packet_count = 1;
329 /* make a shadow copy: */
330 xfer->flags_int.usb2_mode = parm->udev->flags.usb2_mode;
332 parm->bufsize = setup->bufsize;
334 if (parm->speed == USB_SPEED_HIGH) {
335 xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3;
336 xfer->max_packet_size &= 0x7FF;
338 /* range check "max_packet_count" */
340 if (xfer->max_packet_count > parm->hc_max_packet_count) {
341 xfer->max_packet_count = parm->hc_max_packet_count;
343 /* filter "wMaxPacketSize" according to HC capabilities */
345 if ((xfer->max_packet_size > parm->hc_max_packet_size) ||
346 (xfer->max_packet_size == 0)) {
347 xfer->max_packet_size = parm->hc_max_packet_size;
349 /* filter "wMaxPacketSize" according to standard sizes */
351 usb2_get_std_packet_size(&std_size, type, parm->speed);
353 if (std_size.range.min || std_size.range.max) {
355 if (xfer->max_packet_size < std_size.range.min) {
356 xfer->max_packet_size = std_size.range.min;
358 if (xfer->max_packet_size > std_size.range.max) {
359 xfer->max_packet_size = std_size.range.max;
363 if (xfer->max_packet_size >= std_size.fixed[3]) {
364 xfer->max_packet_size = std_size.fixed[3];
365 } else if (xfer->max_packet_size >= std_size.fixed[2]) {
366 xfer->max_packet_size = std_size.fixed[2];
367 } else if (xfer->max_packet_size >= std_size.fixed[1]) {
368 xfer->max_packet_size = std_size.fixed[1];
370 /* only one possibility left */
371 xfer->max_packet_size = std_size.fixed[0];
375 /* compute "max_frame_size" */
377 usb2_update_max_frame_size(xfer);
379 /* check interrupt interval and transfer pre-delay */
381 if (type == UE_ISOCHRONOUS) {
383 uint16_t frame_limit;
385 xfer->interval = 0; /* not used, must be zero */
386 xfer->flags_int.isochronous_xfr = 1; /* set flag */
388 if (xfer->timeout == 0) {
390 * set a default timeout in
391 * case something goes wrong!
393 xfer->timeout = 1000 / 4;
395 switch (parm->speed) {
398 frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER;
401 frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER;
405 if (xfer->nframes > frame_limit) {
407 * this is not going to work
410 parm->err = USB_ERR_INVAL;
413 if (xfer->nframes == 0) {
415 * this is not a valid value
417 parm->err = USB_ERR_ZERO_NFRAMES;
423 * if a value is specified use that else check the endpoint
426 if (xfer->interval == 0) {
428 if (type == UE_INTERRUPT) {
430 xfer->interval = edesc->bInterval;
432 switch (parm->speed) {
433 case USB_SPEED_SUPER:
434 case USB_SPEED_VARIABLE:
436 if (xfer->interval < 4)
438 else if (xfer->interval > 16)
439 xfer->interval = (1<<(16-4));
442 (1 << (xfer->interval-4));
451 if (xfer->interval == 0) {
453 * One millisecond is the smallest
454 * interval we support:
463 * NOTE: we do not allow "max_packet_size" or "max_frame_size"
464 * to be equal to zero when setting up USB transfers, hence
465 * this leads to alot of extra code in the USB kernel.
468 if ((xfer->max_frame_size == 0) ||
469 (xfer->max_packet_size == 0)) {
473 if ((parm->bufsize <= MIN_PKT) &&
474 (type != UE_CONTROL) &&
478 xfer->max_packet_size = MIN_PKT;
479 xfer->max_packet_count = 1;
480 parm->bufsize = 0; /* automatic setup length */
481 usb2_update_max_frame_size(xfer);
484 parm->err = USB_ERR_ZERO_MAXP;
493 * check if we should setup a default
497 if (parm->bufsize == 0) {
499 parm->bufsize = xfer->max_frame_size;
501 if (type == UE_ISOCHRONOUS) {
502 parm->bufsize *= xfer->nframes;
506 * check if we are about to setup a proxy
510 if (xfer->flags.proxy_buffer) {
512 /* round bufsize up */
514 parm->bufsize += (xfer->max_frame_size - 1);
516 if (parm->bufsize < xfer->max_frame_size) {
517 /* length wrapped around */
518 parm->err = USB_ERR_INVAL;
521 /* subtract remainder */
523 parm->bufsize -= (parm->bufsize % xfer->max_frame_size);
525 /* add length of USB device request structure, if any */
527 if (type == UE_CONTROL) {
528 parm->bufsize += REQ_SIZE; /* SETUP message */
531 xfer->max_data_length = parm->bufsize;
533 /* Setup "n_frlengths" and "n_frbuffers" */
535 if (type == UE_ISOCHRONOUS) {
536 n_frlengths = xfer->nframes;
540 if (type == UE_CONTROL) {
541 xfer->flags_int.control_xfr = 1;
542 if (xfer->nframes == 0) {
543 if (parm->bufsize <= REQ_SIZE) {
545 * there will never be any data
554 if (xfer->nframes == 0) {
559 n_frlengths = xfer->nframes;
560 n_frbuffers = xfer->nframes;
564 * check if we have room for the
565 * USB device request structure:
568 if (type == UE_CONTROL) {
570 if (xfer->max_data_length < REQ_SIZE) {
571 /* length wrapped around or too small bufsize */
572 parm->err = USB_ERR_INVAL;
575 xfer->max_data_length -= REQ_SIZE;
577 /* setup "frlengths" */
579 xfer->frlengths = parm->xfer_length_ptr;
581 parm->xfer_length_ptr += n_frlengths;
583 /* setup "frbuffers" */
585 xfer->frbuffers = parm->xfer_page_cache_ptr;
587 parm->xfer_page_cache_ptr += n_frbuffers;
590 * check if we need to setup
594 if (!xfer->flags.ext_buffer) {
597 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1));
602 USB_ADD_BYTES(parm->buf, parm->size[0]);
604 usb2_set_frame_offset(xfer, 0, 0);
606 if ((type == UE_CONTROL) && (n_frbuffers > 1)) {
607 usb2_set_frame_offset(xfer, REQ_SIZE, 1);
610 parm->size[0] += parm->bufsize;
612 /* align data again */
613 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1));
616 * Compute maximum buffer size
619 if (parm->bufsize_max < parm->bufsize) {
620 parm->bufsize_max = parm->bufsize;
623 if (xfer->flags_int.bdma_enable) {
625 * Setup "dma_page_ptr".
627 * Proof for formula below:
629 * Assume there are three USB frames having length "a", "b" and
630 * "c". These USB frames will at maximum need "z"
631 * "usb2_page" structures. "z" is given by:
633 * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) +
634 * ((c / USB_PAGE_SIZE) + 2);
636 * Constraining "a", "b" and "c" like this:
638 * (a + b + c) <= parm->bufsize
642 * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2));
644 * Here is the general formula:
646 xfer->dma_page_ptr = parm->dma_page_ptr;
647 parm->dma_page_ptr += (2 * n_frbuffers);
648 parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE);
652 /* correct maximum data length */
653 xfer->max_data_length = 0;
655 /* subtract USB frame remainder from "hc_max_frame_size" */
657 xfer->max_hc_frame_size =
658 (parm->hc_max_frame_size -
659 (parm->hc_max_frame_size % xfer->max_frame_size));
661 if (xfer->max_hc_frame_size == 0) {
662 parm->err = USB_ERR_INVAL;
665 /* initialize max frame count */
667 xfer->max_frame_count = xfer->nframes;
669 /* initialize frame buffers */
672 for (x = 0; x != n_frbuffers; x++) {
673 xfer->frbuffers[x].tag_parent =
674 &xfer->xroot->dma_parent_tag;
676 if (xfer->flags_int.bdma_enable &&
677 (parm->bufsize_max > 0)) {
679 if (usb2_pc_dmamap_create(
681 parm->bufsize_max)) {
682 parm->err = USB_ERR_NOMEM;
692 * Set some dummy values so that we avoid division by zero:
694 xfer->max_hc_frame_size = 1;
695 xfer->max_frame_size = 1;
696 xfer->max_packet_size = 1;
697 xfer->max_data_length = 0;
699 xfer->max_frame_count = 0;
703 /*------------------------------------------------------------------------*
704 * usb2_transfer_setup - setup an array of USB transfers
706 * NOTE: You must always call "usb2_transfer_unsetup" after calling
707 * "usb2_transfer_setup" if success was returned.
709 * The idea is that the USB device driver should pre-allocate all its
710 * transfers by one call to this function.
715 *------------------------------------------------------------------------*/
717 usb2_transfer_setup(struct usb2_device *udev,
718 const uint8_t *ifaces, struct usb2_xfer **ppxfer,
719 const struct usb2_config *setup_start, uint16_t n_setup,
720 void *priv_sc, struct mtx *xfer_mtx)
722 struct usb2_xfer dummy;
723 struct usb2_setup_params parm;
724 const struct usb2_config *setup_end = setup_start + n_setup;
725 const struct usb2_config *setup;
726 struct usb2_pipe *pipe;
727 struct usb2_xfer_root *info;
728 struct usb2_xfer *xfer;
737 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
738 "usb2_transfer_setup can sleep!");
740 /* do some checking first */
743 DPRINTFN(6, "setup array has zero length!\n");
744 return (USB_ERR_INVAL);
747 DPRINTFN(6, "ifaces array is NULL!\n");
748 return (USB_ERR_INVAL);
750 if (xfer_mtx == NULL) {
751 DPRINTFN(6, "using global lock\n");
755 for (setup = setup_start, n = 0;
756 setup != setup_end; setup++, n++) {
757 if (setup->bufsize == (usb2_frlength_t)-1) {
758 parm.err = USB_ERR_BAD_BUFSIZE;
759 DPRINTF("invalid bufsize\n");
761 if (setup->callback == NULL) {
762 parm.err = USB_ERR_NO_CALLBACK;
763 DPRINTF("no callback\n");
771 bzero(&parm, sizeof(parm));
774 parm.speed = usb2_get_speed(udev);
775 parm.hc_max_packet_count = 1;
777 if (parm.speed >= USB_SPEED_MAX) {
778 parm.err = USB_ERR_INVAL;
781 /* setup all transfers */
787 * Initialize the "usb2_xfer_root" structure,
788 * which is common for all our USB transfers.
790 info = USB_ADD_BYTES(buf, 0);
792 info->memory_base = buf;
793 info->memory_size = parm.size[0];
796 info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]);
797 info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]);
799 info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]);
800 info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]);
802 usb2_cv_init(&info->cv_drain, "WDRAIN");
804 info->xfer_mtx = xfer_mtx;
806 usb2_dma_tag_setup(&info->dma_parent_tag,
807 parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag,
808 xfer_mtx, &usb2_bdma_done_event, 32, parm.dma_tag_max);
811 info->bus = udev->bus;
814 TAILQ_INIT(&info->done_q.head);
815 info->done_q.command = &usb2_callback_wrapper;
817 TAILQ_INIT(&info->dma_q.head);
818 info->dma_q.command = &usb2_bdma_work_loop;
820 info->done_m[0].hdr.pm_callback = &usb2_callback_proc;
821 info->done_m[0].xroot = info;
822 info->done_m[1].hdr.pm_callback = &usb2_callback_proc;
823 info->done_m[1].xroot = info;
826 * In device side mode control endpoint
827 * requests need to run from a separate
828 * context, else there is a chance of
831 if (setup_start == usb2_control_ep_cfg)
833 &udev->bus->control_xfer_proc;
834 else if (xfer_mtx == &Giant)
836 &udev->bus->giant_callback_proc;
839 &udev->bus->non_giant_callback_proc;
845 parm.size[0] += sizeof(info[0]);
847 for (setup = setup_start, n = 0;
848 setup != setup_end; setup++, n++) {
850 /* skip USB transfers without callbacks: */
851 if (setup->callback == NULL) {
854 /* see if there is a matching endpoint */
855 pipe = usb2_get_pipe(udev,
856 ifaces[setup->if_index], setup);
858 if ((pipe == NULL) || (pipe->methods == NULL)) {
859 if (setup->flags.no_pipe_ok)
861 if ((setup->usb_mode != USB_MODE_MAX) &&
862 (setup->usb_mode != udev->flags.usb2_mode))
864 parm.err = USB_ERR_NO_PIPE;
868 /* align data properly */
869 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
871 /* store current setup pointer */
872 parm.curr_setup = setup;
876 * Common initialization of the
877 * "usb2_xfer" structure.
879 xfer = USB_ADD_BYTES(buf, parm.size[0]);
880 xfer->address = udev->address;
881 xfer->priv_sc = priv_sc;
884 usb2_callout_init_mtx(&xfer->timeout_handle,
885 &udev->bus->bus_mtx, 0);
888 * Setup a dummy xfer, hence we are
889 * writing to the "usb2_xfer"
890 * structure pointed to by "xfer"
891 * before we have allocated any
895 bzero(&dummy, sizeof(dummy));
899 /* set transfer pipe pointer */
902 parm.size[0] += sizeof(xfer[0]);
903 parm.methods = xfer->pipe->methods;
904 parm.curr_xfer = xfer;
907 * Call the Host or Device controller transfer
910 (udev->bus->methods->xfer_setup) (&parm);
912 /* check for error */
918 * Increment the pipe refcount. This
919 * basically prevents setting a new
920 * configuration and alternate setting
921 * when USB transfers are in use on
922 * the given interface. Search the USB
923 * code for "pipe->refcount" if you
924 * want more information.
926 xfer->pipe->refcount++;
929 * Whenever we set ppxfer[] then we
930 * also need to increment the
933 info->setup_refcount++;
936 * Transfer is successfully setup and
943 if (buf || parm.err) {
947 /* no transfers - nothing to do ! */
950 /* align data properly */
951 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
953 /* store offset temporarily */
954 parm.size[1] = parm.size[0];
957 * The number of DMA tags required depends on
958 * the number of endpoints. The current estimate
959 * for maximum number of DMA tags per endpoint
962 parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX);
965 * DMA tags for QH, TD, Data and more.
967 parm.dma_tag_max += 8;
969 parm.dma_tag_p += parm.dma_tag_max;
971 parm.size[0] += ((uint8_t *)parm.dma_tag_p) -
974 /* align data properly */
975 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
977 /* store offset temporarily */
978 parm.size[3] = parm.size[0];
980 parm.size[0] += ((uint8_t *)parm.dma_page_ptr) -
983 /* align data properly */
984 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
986 /* store offset temporarily */
987 parm.size[4] = parm.size[0];
989 parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) -
992 /* store end offset temporarily */
993 parm.size[5] = parm.size[0];
995 parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) -
998 /* store end offset temporarily */
1000 parm.size[2] = parm.size[0];
1002 /* align data properly */
1003 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
1005 parm.size[6] = parm.size[0];
1007 parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) -
1010 /* align data properly */
1011 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1));
1013 /* allocate zeroed memory */
1014 buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO);
1017 parm.err = USB_ERR_NOMEM;
1018 DPRINTFN(0, "cannot allocate memory block for "
1019 "configuration (%d bytes)\n",
1023 parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]);
1024 parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]);
1025 parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]);
1026 parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]);
1027 parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]);
1032 if (info->setup_refcount == 0) {
1034 * "usb2_transfer_unsetup_sub" will unlock
1035 * the bus mutex before returning !
1037 USB_BUS_LOCK(info->bus);
1039 /* something went wrong */
1040 usb2_transfer_unsetup_sub(info, 0);
1044 usb2_transfer_unsetup(ppxfer, n_setup);
1049 /*------------------------------------------------------------------------*
1050 * usb2_transfer_unsetup_sub - factored out code
1051 *------------------------------------------------------------------------*/
1053 usb2_transfer_unsetup_sub(struct usb2_xfer_root *info, uint8_t needs_delay)
1055 struct usb2_page_cache *pc;
1057 USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED);
1059 /* wait for any outstanding DMA operations */
1062 usb2_timeout_t temp;
1063 temp = usb2_get_dma_delay(info->bus);
1064 usb2_pause_mtx(&info->bus->bus_mtx,
1065 USB_MS_TO_TICKS(temp));
1068 /* make sure that our done messages are not queued anywhere */
1069 usb2_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]);
1071 USB_BUS_UNLOCK(info->bus);
1074 /* free DMA'able memory, if any */
1075 pc = info->dma_page_cache_start;
1076 while (pc != info->dma_page_cache_end) {
1077 usb2_pc_free_mem(pc);
1081 /* free DMA maps in all "xfer->frbuffers" */
1082 pc = info->xfer_page_cache_start;
1083 while (pc != info->xfer_page_cache_end) {
1084 usb2_pc_dmamap_destroy(pc);
1088 /* free all DMA tags */
1089 usb2_dma_tag_unsetup(&info->dma_parent_tag);
1092 usb2_cv_destroy(&info->cv_drain);
1095 * free the "memory_base" last, hence the "info" structure is
1096 * contained within the "memory_base"!
1098 free(info->memory_base, M_USB);
1101 /*------------------------------------------------------------------------*
1102 * usb2_transfer_unsetup - unsetup/free an array of USB transfers
1104 * NOTE: All USB transfers in progress will get called back passing
1105 * the error code "USB_ERR_CANCELLED" before this function
1107 *------------------------------------------------------------------------*/
1109 usb2_transfer_unsetup(struct usb2_xfer **pxfer, uint16_t n_setup)
1111 struct usb2_xfer *xfer;
1112 struct usb2_xfer_root *info;
1113 uint8_t needs_delay = 0;
1115 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
1116 "usb2_transfer_unsetup can sleep!");
1119 xfer = pxfer[n_setup];
1126 USB_XFER_LOCK(xfer);
1127 USB_BUS_LOCK(info->bus);
1130 * HINT: when you start/stop a transfer, it might be a
1131 * good idea to directly use the "pxfer[]" structure:
1133 * usb2_transfer_start(sc->pxfer[0]);
1134 * usb2_transfer_stop(sc->pxfer[0]);
1136 * That way, if your code has many parts that will not
1137 * stop running under the same lock, in other words
1138 * "xfer_mtx", the usb2_transfer_start and
1139 * usb2_transfer_stop functions will simply return
1140 * when they detect a NULL pointer argument.
1142 * To avoid any races we clear the "pxfer[]" pointer
1143 * while holding the private mutex of the driver:
1145 pxfer[n_setup] = NULL;
1147 USB_BUS_UNLOCK(info->bus);
1148 USB_XFER_UNLOCK(xfer);
1150 usb2_transfer_drain(xfer);
1153 if (xfer->flags_int.bdma_enable)
1157 * NOTE: default pipe does not have an
1158 * interface, even if pipe->iface_index == 0
1160 xfer->pipe->refcount--;
1162 usb2_callout_drain(&xfer->timeout_handle);
1164 USB_BUS_LOCK(info->bus);
1166 USB_ASSERT(info->setup_refcount != 0, ("Invalid setup "
1167 "reference count!\n"));
1169 info->setup_refcount--;
1171 if (info->setup_refcount == 0) {
1172 usb2_transfer_unsetup_sub(info,
1175 USB_BUS_UNLOCK(info->bus);
1180 /*------------------------------------------------------------------------*
1181 * usb2_control_transfer_init - factored out code
1183 * In USB Device Mode we have to wait for the SETUP packet which
1184 * containst the "struct usb2_device_request" structure, before we can
1185 * transfer any data. In USB Host Mode we already have the SETUP
1186 * packet at the moment the USB transfer is started. This leads us to
1187 * having to setup the USB transfer at two different places in
1188 * time. This function just contains factored out control transfer
1189 * initialisation code, so that we don't duplicate the code.
1190 *------------------------------------------------------------------------*/
1192 usb2_control_transfer_init(struct usb2_xfer *xfer)
1194 struct usb2_device_request req;
1196 /* copy out the USB request header */
1198 usb2_copy_out(xfer->frbuffers, 0, &req, sizeof(req));
1200 /* setup remainder */
1202 xfer->flags_int.control_rem = UGETW(req.wLength);
1204 /* copy direction to endpoint variable */
1206 xfer->endpoint &= ~(UE_DIR_IN | UE_DIR_OUT);
1208 (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT;
1211 /*------------------------------------------------------------------------*
1212 * usb2_start_hardware_sub
1214 * This function handles initialisation of control transfers. Control
1215 * transfers are special in that regard that they can both transmit
1221 *------------------------------------------------------------------------*/
1223 usb2_start_hardware_sub(struct usb2_xfer *xfer)
1225 usb2_frlength_t len;
1227 /* Check for control endpoint stall */
1228 if (xfer->flags.stall_pipe) {
1229 /* no longer active */
1230 xfer->flags_int.control_act = 0;
1233 /* Check for invalid number of frames */
1234 if (xfer->nframes > 2) {
1236 * If you need to split a control transfer, you
1237 * have to do one part at a time. Only with
1238 * non-control transfers you can do multiple
1241 DPRINTFN(0, "Too many frames: %u\n",
1242 (unsigned int)xfer->nframes);
1247 * Check if there is a control
1248 * transfer in progress:
1250 if (xfer->flags_int.control_act) {
1252 if (xfer->flags_int.control_hdr) {
1254 /* clear send header flag */
1256 xfer->flags_int.control_hdr = 0;
1258 /* setup control transfer */
1259 if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) {
1260 usb2_control_transfer_init(xfer);
1263 /* get data length */
1269 /* the size of the SETUP structure is hardcoded ! */
1271 if (xfer->frlengths[0] != sizeof(struct usb2_device_request)) {
1272 DPRINTFN(0, "Wrong framelength %u != %zu\n",
1273 xfer->frlengths[0], sizeof(struct
1274 usb2_device_request));
1277 /* check USB mode */
1278 if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) {
1280 /* check number of frames */
1281 if (xfer->nframes != 1) {
1283 * We need to receive the setup
1284 * message first so that we know the
1287 DPRINTF("Misconfigured transfer\n");
1291 * Set a dummy "control_rem" value. This
1292 * variable will be overwritten later by a
1293 * call to "usb2_control_transfer_init()" !
1295 xfer->flags_int.control_rem = 0xFFFF;
1298 /* setup "endpoint" and "control_rem" */
1300 usb2_control_transfer_init(xfer);
1303 /* set transfer-header flag */
1305 xfer->flags_int.control_hdr = 1;
1307 /* get data length */
1309 len = (xfer->sumlen - sizeof(struct usb2_device_request));
1312 /* check if there is a length mismatch */
1314 if (len > xfer->flags_int.control_rem) {
1315 DPRINTFN(0, "Length greater than remaining length!\n");
1318 /* check if we are doing a short transfer */
1320 if (xfer->flags.force_short_xfer) {
1321 xfer->flags_int.control_rem = 0;
1323 if ((len != xfer->max_data_length) &&
1324 (len != xfer->flags_int.control_rem) &&
1325 (xfer->nframes != 1)) {
1326 DPRINTFN(0, "Short control transfer without "
1327 "force_short_xfer set!\n");
1330 xfer->flags_int.control_rem -= len;
1333 /* the status part is executed when "control_act" is 0 */
1335 if ((xfer->flags_int.control_rem > 0) ||
1336 (xfer->flags.manual_status)) {
1337 /* don't execute the STATUS stage yet */
1338 xfer->flags_int.control_act = 1;
1341 if ((!xfer->flags_int.control_hdr) &&
1342 (xfer->nframes == 1)) {
1344 * This is not a valid operation!
1346 DPRINTFN(0, "Invalid parameter "
1351 /* time to execute the STATUS stage */
1352 xfer->flags_int.control_act = 0;
1354 return (0); /* success */
1357 return (1); /* failure */
1360 /*------------------------------------------------------------------------*
1361 * usb2_start_hardware - start USB hardware for the given transfer
1363 * This function should only be called from the USB callback.
1364 *------------------------------------------------------------------------*/
1366 usb2_start_hardware(struct usb2_xfer *xfer)
1368 struct usb2_xfer_root *info;
1369 struct usb2_bus *bus;
1375 DPRINTF("xfer=%p, pipe=%p, nframes=%d, dir=%s\n",
1376 xfer, xfer->pipe, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ?
1379 /* Check if the device is still alive */
1380 if (info->udev->state < USB_STATE_POWERED) {
1382 usb2_transfer_done(xfer, USB_ERR_NOT_CONFIGURED);
1383 USB_BUS_UNLOCK(bus);
1388 if (USB_DEBUG_VAR > 0) {
1391 usb2_dump_pipe(xfer->pipe);
1393 USB_BUS_UNLOCK(bus);
1397 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1398 USB_BUS_LOCK_ASSERT(bus, MA_NOTOWNED);
1400 /* Only open the USB transfer once! */
1401 if (!xfer->flags_int.open) {
1402 xfer->flags_int.open = 1;
1407 (xfer->pipe->methods->open) (xfer);
1408 USB_BUS_UNLOCK(bus);
1410 /* set "transferring" flag */
1411 xfer->flags_int.transferring = 1;
1414 /* increment power reference */
1415 usb2_transfer_power_ref(xfer, 1);
1418 * Check if the transfer is waiting on a queue, most
1419 * frequently the "done_q":
1421 if (xfer->wait_queue) {
1423 usb2_transfer_dequeue(xfer);
1424 USB_BUS_UNLOCK(bus);
1426 /* clear "did_dma_delay" flag */
1427 xfer->flags_int.did_dma_delay = 0;
1429 /* clear "did_close" flag */
1430 xfer->flags_int.did_close = 0;
1433 /* clear "bdma_setup" flag */
1434 xfer->flags_int.bdma_setup = 0;
1436 /* by default we cannot cancel any USB transfer immediately */
1437 xfer->flags_int.can_cancel_immed = 0;
1439 /* clear lengths and frame counts by default */
1444 /* clear any previous errors */
1449 if (xfer->nframes == 0) {
1450 if (xfer->flags.stall_pipe) {
1452 * Special case - want to stall without transferring
1455 DPRINTF("xfer=%p nframes=0: stall "
1456 "or clear stall!\n", xfer);
1458 xfer->flags_int.can_cancel_immed = 1;
1459 /* start the transfer */
1460 usb2_command_wrapper(&xfer->pipe->pipe_q, xfer);
1461 USB_BUS_UNLOCK(bus);
1465 usb2_transfer_done(xfer, USB_ERR_INVAL);
1466 USB_BUS_UNLOCK(bus);
1469 /* compute total transfer length */
1471 for (x = 0; x != xfer->nframes; x++) {
1472 xfer->sumlen += xfer->frlengths[x];
1473 if (xfer->sumlen < xfer->frlengths[x]) {
1474 /* length wrapped around */
1476 usb2_transfer_done(xfer, USB_ERR_INVAL);
1477 USB_BUS_UNLOCK(bus);
1482 /* clear some internal flags */
1484 xfer->flags_int.short_xfer_ok = 0;
1485 xfer->flags_int.short_frames_ok = 0;
1487 /* check if this is a control transfer */
1489 if (xfer->flags_int.control_xfr) {
1491 if (usb2_start_hardware_sub(xfer)) {
1493 usb2_transfer_done(xfer, USB_ERR_STALLED);
1494 USB_BUS_UNLOCK(bus);
1499 * Setup filtered version of some transfer flags,
1500 * in case of data read direction
1502 if (USB_GET_DATA_ISREAD(xfer)) {
1504 if (xfer->flags.short_frames_ok) {
1505 xfer->flags_int.short_xfer_ok = 1;
1506 xfer->flags_int.short_frames_ok = 1;
1507 } else if (xfer->flags.short_xfer_ok) {
1508 xfer->flags_int.short_xfer_ok = 1;
1510 /* check for control transfer */
1511 if (xfer->flags_int.control_xfr) {
1513 * 1) Control transfers do not support
1514 * reception of multiple short USB
1515 * frames in host mode and device side
1516 * mode, with exception of:
1518 * 2) Due to sometimes buggy device
1519 * side firmware we need to do a
1520 * STATUS stage in case of short
1521 * control transfers in USB host mode.
1522 * The STATUS stage then becomes the
1523 * "alt_next" to the DATA stage.
1525 xfer->flags_int.short_frames_ok = 1;
1530 * Check if BUS-DMA support is enabled and try to load virtual
1531 * buffers into DMA, if any:
1534 if (xfer->flags_int.bdma_enable) {
1535 /* insert the USB transfer last in the BUS-DMA queue */
1536 usb2_command_wrapper(&xfer->xroot->dma_q, xfer);
1541 * Enter the USB transfer into the Host Controller or
1542 * Device Controller schedule:
1544 usb2_pipe_enter(xfer);
1547 /*------------------------------------------------------------------------*
1548 * usb2_pipe_enter - factored out code
1549 *------------------------------------------------------------------------*/
1551 usb2_pipe_enter(struct usb2_xfer *xfer)
1553 struct usb2_pipe *pipe;
1555 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1557 USB_BUS_LOCK(xfer->xroot->bus);
1563 /* enter the transfer */
1564 (pipe->methods->enter) (xfer);
1566 xfer->flags_int.can_cancel_immed = 1;
1568 /* check for transfer error */
1570 /* some error has happened */
1571 usb2_transfer_done(xfer, 0);
1572 USB_BUS_UNLOCK(xfer->xroot->bus);
1576 /* start the transfer */
1577 usb2_command_wrapper(&pipe->pipe_q, xfer);
1578 USB_BUS_UNLOCK(xfer->xroot->bus);
1581 /*------------------------------------------------------------------------*
1582 * usb2_transfer_start - start an USB transfer
1584 * NOTE: Calling this function more than one time will only
1585 * result in a single transfer start, until the USB transfer
1587 *------------------------------------------------------------------------*/
1589 usb2_transfer_start(struct usb2_xfer *xfer)
1592 /* transfer is gone */
1595 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1597 /* mark the USB transfer started */
1599 if (!xfer->flags_int.started) {
1600 xfer->flags_int.started = 1;
1602 /* check if the USB transfer callback is already transferring */
1604 if (xfer->flags_int.transferring) {
1607 USB_BUS_LOCK(xfer->xroot->bus);
1608 /* call the USB transfer callback */
1609 usb2_callback_ss_done_defer(xfer);
1610 USB_BUS_UNLOCK(xfer->xroot->bus);
1613 /*------------------------------------------------------------------------*
1614 * usb2_transfer_stop - stop an USB transfer
1616 * NOTE: Calling this function more than one time will only
1617 * result in a single transfer stop.
1618 * NOTE: When this function returns it is not safe to free nor
1619 * reuse any DMA buffers. See "usb2_transfer_drain()".
1620 *------------------------------------------------------------------------*/
1622 usb2_transfer_stop(struct usb2_xfer *xfer)
1624 struct usb2_pipe *pipe;
1627 /* transfer is gone */
1630 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1632 /* check if the USB transfer was ever opened */
1634 if (!xfer->flags_int.open) {
1635 /* nothing to do except clearing the "started" flag */
1636 xfer->flags_int.started = 0;
1639 /* try to stop the current USB transfer */
1641 USB_BUS_LOCK(xfer->xroot->bus);
1642 xfer->error = USB_ERR_CANCELLED;/* override any previous error */
1644 * Clear "open" and "started" when both private and USB lock
1645 * is locked so that we don't get a race updating "flags_int"
1647 xfer->flags_int.open = 0;
1648 xfer->flags_int.started = 0;
1651 * Check if we can cancel the USB transfer immediately.
1653 if (xfer->flags_int.transferring) {
1654 if (xfer->flags_int.can_cancel_immed &&
1655 (!xfer->flags_int.did_close)) {
1658 * The following will lead to an USB_ERR_CANCELLED
1659 * error code being passed to the USB callback.
1661 (xfer->pipe->methods->close) (xfer);
1662 /* only close once */
1663 xfer->flags_int.did_close = 1;
1665 /* need to wait for the next done callback */
1670 /* close here and now */
1671 (xfer->pipe->methods->close) (xfer);
1674 * Any additional DMA delay is done by
1675 * "usb2_transfer_unsetup()".
1679 * Special case. Check if we need to restart a blocked
1685 * If the current USB transfer is completing we need
1686 * to start the next one:
1688 if (pipe->pipe_q.curr == xfer) {
1689 usb2_command_wrapper(&pipe->pipe_q, NULL);
1693 USB_BUS_UNLOCK(xfer->xroot->bus);
1696 /*------------------------------------------------------------------------*
1697 * usb2_transfer_pending
1699 * This function will check if an USB transfer is pending which is a
1700 * little bit complicated!
1703 * 1: Pending: The USB transfer will receive a callback in the future.
1704 *------------------------------------------------------------------------*/
1706 usb2_transfer_pending(struct usb2_xfer *xfer)
1708 struct usb2_xfer_root *info;
1709 struct usb2_xfer_queue *pq;
1712 /* transfer is gone */
1715 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1717 if (xfer->flags_int.transferring) {
1721 USB_BUS_LOCK(xfer->xroot->bus);
1722 if (xfer->wait_queue) {
1723 /* we are waiting on a queue somewhere */
1724 USB_BUS_UNLOCK(xfer->xroot->bus);
1730 if (pq->curr == xfer) {
1731 /* we are currently scheduled for callback */
1732 USB_BUS_UNLOCK(xfer->xroot->bus);
1735 /* we are not pending */
1736 USB_BUS_UNLOCK(xfer->xroot->bus);
1740 /*------------------------------------------------------------------------*
1741 * usb2_transfer_drain
1743 * This function will stop the USB transfer and wait for any
1744 * additional BUS-DMA and HW-DMA operations to complete. Buffers that
1745 * are loaded into DMA can safely be freed or reused after that this
1746 * function has returned.
1747 *------------------------------------------------------------------------*/
1749 usb2_transfer_drain(struct usb2_xfer *xfer)
1751 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
1752 "usb2_transfer_drain can sleep!");
1755 /* transfer is gone */
1758 if (xfer->xroot->xfer_mtx != &Giant) {
1759 USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED);
1761 USB_XFER_LOCK(xfer);
1763 usb2_transfer_stop(xfer);
1765 while (usb2_transfer_pending(xfer)) {
1766 xfer->flags_int.draining = 1;
1768 * Wait until the current outstanding USB
1769 * transfer is complete !
1771 usb2_cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx);
1773 USB_XFER_UNLOCK(xfer);
1776 /*------------------------------------------------------------------------*
1777 * usb2_set_frame_data
1779 * This function sets the pointer of the buffer that should
1780 * loaded directly into DMA for the given USB frame. Passing "ptr"
1781 * equal to NULL while the corresponding "frlength" is greater
1782 * than zero gives undefined results!
1783 *------------------------------------------------------------------------*/
1785 usb2_set_frame_data(struct usb2_xfer *xfer, void *ptr, usb2_frcount_t frindex)
1787 /* set virtual address to load and length */
1788 xfer->frbuffers[frindex].buffer = ptr;
1791 /*------------------------------------------------------------------------*
1792 * usb2_set_frame_offset
1794 * This function sets the frame data buffer offset relative to the beginning
1795 * of the USB DMA buffer allocated for this USB transfer.
1796 *------------------------------------------------------------------------*/
1798 usb2_set_frame_offset(struct usb2_xfer *xfer, usb2_frlength_t offset,
1799 usb2_frcount_t frindex)
1801 USB_ASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame "
1802 "when the USB buffer is external!\n"));
1804 /* set virtual address to load */
1805 xfer->frbuffers[frindex].buffer =
1806 USB_ADD_BYTES(xfer->local_buffer, offset);
1809 /*------------------------------------------------------------------------*
1810 * usb2_callback_proc - factored out code
1812 * This function performs USB callbacks.
1813 *------------------------------------------------------------------------*/
1815 usb2_callback_proc(struct usb2_proc_msg *_pm)
1817 struct usb2_done_msg *pm = (void *)_pm;
1818 struct usb2_xfer_root *info = pm->xroot;
1820 /* Change locking order */
1821 USB_BUS_UNLOCK(info->bus);
1824 * We exploit the fact that the mutex is the same for all
1825 * callbacks that will be called from this thread:
1827 mtx_lock(info->xfer_mtx);
1828 USB_BUS_LOCK(info->bus);
1830 /* Continue where we lost track */
1831 usb2_command_wrapper(&info->done_q,
1834 mtx_unlock(info->xfer_mtx);
1837 /*------------------------------------------------------------------------*
1838 * usb2_callback_ss_done_defer
1840 * This function will defer the start, stop and done callback to the
1842 *------------------------------------------------------------------------*/
1844 usb2_callback_ss_done_defer(struct usb2_xfer *xfer)
1846 struct usb2_xfer_root *info = xfer->xroot;
1847 struct usb2_xfer_queue *pq = &info->done_q;
1849 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1851 if (pq->curr != xfer) {
1852 usb2_transfer_enqueue(pq, xfer);
1854 if (!pq->recurse_1) {
1857 * We have to postpone the callback due to the fact we
1858 * will have a Lock Order Reversal, LOR, if we try to
1861 if (usb2_proc_msignal(info->done_p,
1862 &info->done_m[0], &info->done_m[1])) {
1866 /* clear second recurse flag */
1873 /*------------------------------------------------------------------------*
1874 * usb2_callback_wrapper
1876 * This is a wrapper for USB callbacks. This wrapper does some
1877 * auto-magic things like figuring out if we can call the callback
1878 * directly from the current context or if we need to wakeup the
1879 * interrupt process.
1880 *------------------------------------------------------------------------*/
1882 usb2_callback_wrapper(struct usb2_xfer_queue *pq)
1884 struct usb2_xfer *xfer = pq->curr;
1885 struct usb2_xfer_root *info = xfer->xroot;
1887 USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED);
1888 if (!mtx_owned(info->xfer_mtx)) {
1890 * Cases that end up here:
1892 * 5) HW interrupt done callback or other source.
1894 DPRINTFN(3, "case 5\n");
1897 * We have to postpone the callback due to the fact we
1898 * will have a Lock Order Reversal, LOR, if we try to
1901 if (usb2_proc_msignal(info->done_p,
1902 &info->done_m[0], &info->done_m[1])) {
1908 * Cases that end up here:
1910 * 1) We are starting a transfer
1911 * 2) We are prematurely calling back a transfer
1912 * 3) We are stopping a transfer
1913 * 4) We are doing an ordinary callback
1915 DPRINTFN(3, "case 1-4\n");
1916 /* get next USB transfer in the queue */
1917 info->done_q.curr = NULL;
1919 USB_BUS_UNLOCK(info->bus);
1920 USB_BUS_LOCK_ASSERT(info->bus, MA_NOTOWNED);
1922 /* set correct USB state for callback */
1923 if (!xfer->flags_int.transferring) {
1924 xfer->usb2_state = USB_ST_SETUP;
1925 if (!xfer->flags_int.started) {
1926 /* we got stopped before we even got started */
1927 USB_BUS_LOCK(info->bus);
1932 if (usb2_callback_wrapper_sub(xfer)) {
1933 /* the callback has been deferred */
1934 USB_BUS_LOCK(info->bus);
1938 /* decrement power reference */
1939 usb2_transfer_power_ref(xfer, -1);
1941 xfer->flags_int.transferring = 0;
1944 xfer->usb2_state = USB_ST_ERROR;
1946 /* set transferred state */
1947 xfer->usb2_state = USB_ST_TRANSFERRED;
1949 /* sync DMA memory, if any */
1950 if (xfer->flags_int.bdma_enable &&
1951 (!xfer->flags_int.bdma_no_post_sync)) {
1952 usb2_bdma_post_sync(xfer);
1958 /* call processing routine */
1959 (xfer->callback) (xfer);
1961 /* pickup the USB mutex again */
1962 USB_BUS_LOCK(info->bus);
1965 * Check if we got started after that we got cancelled, but
1966 * before we managed to do the callback.
1968 if ((!xfer->flags_int.open) &&
1969 (xfer->flags_int.started) &&
1970 (xfer->usb2_state == USB_ST_ERROR)) {
1971 /* try to loop, but not recursivly */
1972 usb2_command_wrapper(&info->done_q, xfer);
1978 * Check if we are draining.
1980 if (xfer->flags_int.draining &&
1981 (!xfer->flags_int.transferring)) {
1982 /* "usb2_transfer_drain()" is waiting for end of transfer */
1983 xfer->flags_int.draining = 0;
1984 usb2_cv_broadcast(&info->cv_drain);
1987 /* do the next callback, if any */
1988 usb2_command_wrapper(&info->done_q,
1992 /*------------------------------------------------------------------------*
1993 * usb2_dma_delay_done_cb
1995 * This function is called when the DMA delay has been exectuded, and
1996 * will make sure that the callback is called to complete the USB
1997 * transfer. This code path is ususally only used when there is an USB
1998 * error like USB_ERR_CANCELLED.
1999 *------------------------------------------------------------------------*/
2001 usb2_dma_delay_done_cb(void *arg)
2003 struct usb2_xfer *xfer = arg;
2005 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2007 DPRINTFN(3, "Completed %p\n", xfer);
2009 /* queue callback for execution, again */
2010 usb2_transfer_done(xfer, 0);
2013 /*------------------------------------------------------------------------*
2014 * usb2_transfer_dequeue
2016 * - This function is used to remove an USB transfer from a USB
2019 * - This function can be called multiple times in a row.
2020 *------------------------------------------------------------------------*/
2022 usb2_transfer_dequeue(struct usb2_xfer *xfer)
2024 struct usb2_xfer_queue *pq;
2026 pq = xfer->wait_queue;
2028 TAILQ_REMOVE(&pq->head, xfer, wait_entry);
2029 xfer->wait_queue = NULL;
2033 /*------------------------------------------------------------------------*
2034 * usb2_transfer_enqueue
2036 * - This function is used to insert an USB transfer into a USB *
2039 * - This function can be called multiple times in a row.
2040 *------------------------------------------------------------------------*/
2042 usb2_transfer_enqueue(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer)
2045 * Insert the USB transfer into the queue, if it is not
2046 * already on a USB transfer queue:
2048 if (xfer->wait_queue == NULL) {
2049 xfer->wait_queue = pq;
2050 TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry);
2054 /*------------------------------------------------------------------------*
2055 * usb2_transfer_done
2057 * - This function is used to remove an USB transfer from the busdma,
2058 * pipe or interrupt queue.
2060 * - This function is used to queue the USB transfer on the done
2063 * - This function is used to stop any USB transfer timeouts.
2064 *------------------------------------------------------------------------*/
2066 usb2_transfer_done(struct usb2_xfer *xfer, usb2_error_t error)
2068 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2070 DPRINTF("err=%s\n", usb2_errstr(error));
2073 * If we are not transferring then just return.
2074 * This can happen during transfer cancel.
2076 if (!xfer->flags_int.transferring) {
2077 DPRINTF("not transferring\n");
2080 /* only set transfer error if not already set */
2082 xfer->error = error;
2084 /* stop any callouts */
2085 usb2_callout_stop(&xfer->timeout_handle);
2088 * If we are waiting on a queue, just remove the USB transfer
2089 * from the queue, if any. We should have the required locks
2090 * locked to do the remove when this function is called.
2092 usb2_transfer_dequeue(xfer);
2095 if (mtx_owned(xfer->xroot->xfer_mtx)) {
2096 struct usb2_xfer_queue *pq;
2099 * If the private USB lock is not locked, then we assume
2100 * that the BUS-DMA load stage has been passed:
2102 pq = &xfer->xroot->dma_q;
2104 if (pq->curr == xfer) {
2105 /* start the next BUS-DMA load, if any */
2106 usb2_command_wrapper(pq, NULL);
2110 /* keep some statistics */
2112 xfer->xroot->bus->stats_err.uds_requests
2113 [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++;
2115 xfer->xroot->bus->stats_ok.uds_requests
2116 [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++;
2119 /* call the USB transfer callback */
2120 usb2_callback_ss_done_defer(xfer);
2123 /*------------------------------------------------------------------------*
2124 * usb2_transfer_start_cb
2126 * This function is called to start the USB transfer when
2127 * "xfer->interval" is greater than zero, and and the endpoint type is
2129 *------------------------------------------------------------------------*/
2131 usb2_transfer_start_cb(void *arg)
2133 struct usb2_xfer *xfer = arg;
2134 struct usb2_pipe *pipe = xfer->pipe;
2136 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2140 /* start the transfer */
2141 (pipe->methods->start) (xfer);
2143 xfer->flags_int.can_cancel_immed = 1;
2145 /* check for error */
2147 /* some error has happened */
2148 usb2_transfer_done(xfer, 0);
2152 /*------------------------------------------------------------------------*
2153 * usb2_transfer_set_stall
2155 * This function is used to set the stall flag outside the
2156 * callback. This function is NULL safe.
2157 *------------------------------------------------------------------------*/
2159 usb2_transfer_set_stall(struct usb2_xfer *xfer)
2165 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
2167 /* avoid any races by locking the USB mutex */
2168 USB_BUS_LOCK(xfer->xroot->bus);
2170 xfer->flags.stall_pipe = 1;
2172 USB_BUS_UNLOCK(xfer->xroot->bus);
2175 /*------------------------------------------------------------------------*
2176 * usb2_transfer_clear_stall
2178 * This function is used to clear the stall flag outside the
2179 * callback. This function is NULL safe.
2180 *------------------------------------------------------------------------*/
2182 usb2_transfer_clear_stall(struct usb2_xfer *xfer)
2188 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
2190 /* avoid any races by locking the USB mutex */
2191 USB_BUS_LOCK(xfer->xroot->bus);
2193 xfer->flags.stall_pipe = 0;
2195 USB_BUS_UNLOCK(xfer->xroot->bus);
2198 /*------------------------------------------------------------------------*
2201 * This function is used to add an USB transfer to the pipe transfer list.
2202 *------------------------------------------------------------------------*/
2204 usb2_pipe_start(struct usb2_xfer_queue *pq)
2206 struct usb2_pipe *pipe;
2207 struct usb2_xfer *xfer;
2213 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2216 * If the pipe is already stalled we do nothing !
2218 if (pipe->is_stalled) {
2222 * Check if we are supposed to stall the pipe:
2224 if (xfer->flags.stall_pipe) {
2225 /* clear stall command */
2226 xfer->flags.stall_pipe = 0;
2229 * Only stall BULK and INTERRUPT endpoints.
2231 type = (pipe->edesc->bmAttributes & UE_XFERTYPE);
2232 if ((type == UE_BULK) ||
2233 (type == UE_INTERRUPT)) {
2234 struct usb2_device *udev;
2235 struct usb2_xfer_root *info;
2239 pipe->is_stalled = 1;
2241 if (udev->flags.usb2_mode == USB_MODE_DEVICE) {
2242 (udev->bus->methods->set_stall) (
2244 } else if (udev->default_xfer[1]) {
2245 info = udev->default_xfer[1]->xroot;
2246 if (usb2_proc_msignal(
2247 &info->bus->non_giant_callback_proc,
2248 &udev->cs_msg[0], &udev->cs_msg[1])) {
2252 /* should not happen */
2253 DPRINTFN(0, "No stall handler!\n");
2256 * We get started again when the stall is cleared!
2261 /* Set or clear stall complete - special case */
2262 if (xfer->nframes == 0) {
2263 /* we are complete */
2265 usb2_transfer_done(xfer, 0);
2271 * 1) Start the first transfer queued.
2273 * 2) Re-start the current USB transfer.
2276 * Check if there should be any
2277 * pre transfer start delay:
2279 if (xfer->interval > 0) {
2280 type = (pipe->edesc->bmAttributes & UE_XFERTYPE);
2281 if ((type == UE_BULK) ||
2282 (type == UE_CONTROL)) {
2283 usb2_transfer_timeout_ms(xfer,
2284 &usb2_transfer_start_cb,
2291 /* start USB transfer */
2292 (pipe->methods->start) (xfer);
2294 xfer->flags_int.can_cancel_immed = 1;
2296 /* check for error */
2298 /* some error has happened */
2299 usb2_transfer_done(xfer, 0);
2303 /*------------------------------------------------------------------------*
2304 * usb2_transfer_timeout_ms
2306 * This function is used to setup a timeout on the given USB
2307 * transfer. If the timeout has been deferred the callback given by
2308 * "cb" will get called after "ms" milliseconds.
2309 *------------------------------------------------------------------------*/
2311 usb2_transfer_timeout_ms(struct usb2_xfer *xfer,
2312 void (*cb) (void *arg), usb2_timeout_t ms)
2314 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2317 usb2_callout_reset(&xfer->timeout_handle,
2318 USB_MS_TO_TICKS(ms), cb, xfer);
2321 /*------------------------------------------------------------------------*
2322 * usb2_callback_wrapper_sub
2324 * - This function will update variables in an USB transfer after
2325 * that the USB transfer is complete.
2327 * - This function is used to start the next USB transfer on the
2328 * pipe transfer queue, if any.
2330 * NOTE: In some special cases the USB transfer will not be removed from
2331 * the pipe queue, but remain first. To enforce USB transfer removal call
2332 * this function passing the error code "USB_ERR_CANCELLED".
2336 * Else: The callback has been deferred.
2337 *------------------------------------------------------------------------*/
2339 usb2_callback_wrapper_sub(struct usb2_xfer *xfer)
2341 struct usb2_pipe *pipe;
2344 if ((!xfer->flags_int.open) &&
2345 (!xfer->flags_int.did_close)) {
2347 USB_BUS_LOCK(xfer->xroot->bus);
2348 (xfer->pipe->methods->close) (xfer);
2349 USB_BUS_UNLOCK(xfer->xroot->bus);
2350 /* only close once */
2351 xfer->flags_int.did_close = 1;
2352 return (1); /* wait for new callback */
2355 * If we have a non-hardware induced error we
2356 * need to do the DMA delay!
2358 if (((xfer->error == USB_ERR_CANCELLED) ||
2359 (xfer->error == USB_ERR_TIMEOUT)) &&
2360 (!xfer->flags_int.did_dma_delay)) {
2362 usb2_timeout_t temp;
2364 /* only delay once */
2365 xfer->flags_int.did_dma_delay = 1;
2367 /* we can not cancel this delay */
2368 xfer->flags_int.can_cancel_immed = 0;
2370 temp = usb2_get_dma_delay(xfer->xroot->bus);
2372 DPRINTFN(3, "DMA delay, %u ms, "
2373 "on %p\n", temp, xfer);
2376 USB_BUS_LOCK(xfer->xroot->bus);
2377 usb2_transfer_timeout_ms(xfer,
2378 &usb2_dma_delay_done_cb, temp);
2379 USB_BUS_UNLOCK(xfer->xroot->bus);
2380 return (1); /* wait for new callback */
2383 /* check actual number of frames */
2384 if (xfer->aframes > xfer->nframes) {
2385 if (xfer->error == 0) {
2386 panic("%s: actual number of frames, %d, is "
2387 "greater than initial number of frames, %d!\n",
2388 __FUNCTION__, xfer->aframes, xfer->nframes);
2390 /* just set some valid value */
2391 xfer->aframes = xfer->nframes;
2394 /* compute actual length */
2397 for (x = 0; x != xfer->aframes; x++) {
2398 xfer->actlen += xfer->frlengths[x];
2402 * Frames that were not transferred get zero actual length in
2403 * case the USB device driver does not check the actual number
2404 * of frames transferred, "xfer->aframes":
2406 for (; x < xfer->nframes; x++) {
2407 xfer->frlengths[x] = 0;
2410 /* check actual length */
2411 if (xfer->actlen > xfer->sumlen) {
2412 if (xfer->error == 0) {
2413 panic("%s: actual length, %d, is greater than "
2414 "initial length, %d!\n",
2415 __FUNCTION__, xfer->actlen, xfer->sumlen);
2417 /* just set some valid value */
2418 xfer->actlen = xfer->sumlen;
2421 DPRINTFN(6, "xfer=%p pipe=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n",
2422 xfer, xfer->pipe, xfer->error, xfer->actlen, xfer->sumlen,
2423 xfer->aframes, xfer->nframes);
2426 /* end of control transfer, if any */
2427 xfer->flags_int.control_act = 0;
2429 /* check if we should block the execution queue */
2430 if ((xfer->error != USB_ERR_CANCELLED) &&
2431 (xfer->flags.pipe_bof)) {
2432 DPRINTFN(2, "xfer=%p: Block On Failure "
2433 "on pipe=%p\n", xfer, xfer->pipe);
2437 /* check for short transfers */
2438 if (xfer->actlen < xfer->sumlen) {
2440 /* end of control transfer, if any */
2441 xfer->flags_int.control_act = 0;
2443 if (!xfer->flags_int.short_xfer_ok) {
2444 xfer->error = USB_ERR_SHORT_XFER;
2445 if (xfer->flags.pipe_bof) {
2446 DPRINTFN(2, "xfer=%p: Block On Failure on "
2447 "Short Transfer on pipe %p.\n",
2454 * Check if we are in the middle of a
2457 if (xfer->flags_int.control_act) {
2458 DPRINTFN(5, "xfer=%p: Control transfer "
2459 "active on pipe=%p\n", xfer, xfer->pipe);
2468 * If the current USB transfer is completing we need to start the
2471 USB_BUS_LOCK(xfer->xroot->bus);
2472 if (pipe->pipe_q.curr == xfer) {
2473 usb2_command_wrapper(&pipe->pipe_q, NULL);
2475 if (pipe->pipe_q.curr || TAILQ_FIRST(&pipe->pipe_q.head)) {
2476 /* there is another USB transfer waiting */
2478 /* this is the last USB transfer */
2479 /* clear isochronous sync flag */
2480 xfer->pipe->is_synced = 0;
2483 USB_BUS_UNLOCK(xfer->xroot->bus);
2488 /*------------------------------------------------------------------------*
2489 * usb2_command_wrapper
2491 * This function is used to execute commands non-recursivly on an USB
2493 *------------------------------------------------------------------------*/
2495 usb2_command_wrapper(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer)
2499 * If the transfer is not already processing,
2502 if (pq->curr != xfer) {
2503 usb2_transfer_enqueue(pq, xfer);
2504 if (pq->curr != NULL) {
2505 /* something is already processing */
2506 DPRINTFN(6, "busy %p\n", pq->curr);
2511 /* Get next element in queue */
2515 if (!pq->recurse_1) {
2519 /* set both recurse flags */
2523 if (pq->curr == NULL) {
2524 xfer = TAILQ_FIRST(&pq->head);
2526 TAILQ_REMOVE(&pq->head, xfer,
2528 xfer->wait_queue = NULL;
2534 DPRINTFN(6, "cb %p (enter)\n", pq->curr);
2536 DPRINTFN(6, "cb %p (leave)\n", pq->curr);
2538 } while (!pq->recurse_2);
2540 /* clear first recurse flag */
2544 /* clear second recurse flag */
2549 /*------------------------------------------------------------------------*
2550 * usb2_default_transfer_setup
2552 * This function is used to setup the default USB control endpoint
2554 *------------------------------------------------------------------------*/
2556 usb2_default_transfer_setup(struct usb2_device *udev)
2558 struct usb2_xfer *xfer;
2560 uint8_t iface_index;
2562 /* check for root HUB */
2563 if (udev->parent_hub == NULL)
2567 xfer = udev->default_xfer[0];
2569 USB_XFER_LOCK(xfer);
2571 ((xfer->address == udev->address) &&
2572 (udev->default_ep_desc.wMaxPacketSize[0] ==
2573 udev->ddesc.bMaxPacketSize));
2574 if (udev->flags.usb2_mode == USB_MODE_DEVICE) {
2577 * NOTE: checking "xfer->address" and
2578 * starting the USB transfer must be
2581 usb2_transfer_start(xfer);
2584 USB_XFER_UNLOCK(xfer);
2591 * All parameters are exactly the same like before.
2597 * Update wMaxPacketSize for the default control endpoint:
2599 udev->default_ep_desc.wMaxPacketSize[0] =
2600 udev->ddesc.bMaxPacketSize;
2603 * Unsetup any existing USB transfer:
2605 usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX);
2608 * Try to setup a new USB transfer for the
2609 * default control endpoint:
2612 if (usb2_transfer_setup(udev, &iface_index,
2613 udev->default_xfer, usb2_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL,
2614 udev->default_mtx)) {
2615 DPRINTFN(0, "could not setup default "
2622 /*------------------------------------------------------------------------*
2623 * usb2_clear_data_toggle - factored out code
2625 * NOTE: the intention of this function is not to reset the hardware
2627 *------------------------------------------------------------------------*/
2629 usb2_clear_data_toggle(struct usb2_device *udev, struct usb2_pipe *pipe)
2631 DPRINTFN(5, "udev=%p pipe=%p\n", udev, pipe);
2633 USB_BUS_LOCK(udev->bus);
2634 pipe->toggle_next = 0;
2635 USB_BUS_UNLOCK(udev->bus);
2638 /*------------------------------------------------------------------------*
2639 * usb2_clear_stall_callback - factored out clear stall callback
2642 * xfer1: Clear Stall Control Transfer
2643 * xfer2: Stalled USB Transfer
2645 * This function is NULL safe.
2651 * Clear stall config example:
2653 * static const struct usb2_config my_clearstall = {
2654 * .type = UE_CONTROL,
2656 * .direction = UE_DIR_ANY,
2657 * .interval = 50, //50 milliseconds
2658 * .bufsize = sizeof(struct usb2_device_request),
2659 * .timeout = 1000, //1.000 seconds
2660 * .callback = &my_clear_stall_callback, // **
2661 * .usb_mode = USB_MODE_HOST,
2664 * ** "my_clear_stall_callback" calls "usb2_clear_stall_callback"
2665 * passing the correct parameters.
2666 *------------------------------------------------------------------------*/
2668 usb2_clear_stall_callback(struct usb2_xfer *xfer1,
2669 struct usb2_xfer *xfer2)
2671 struct usb2_device_request req;
2673 if (xfer2 == NULL) {
2674 /* looks like we are tearing down */
2675 DPRINTF("NULL input parameter\n");
2678 USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED);
2679 USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED);
2681 switch (USB_GET_STATE(xfer1)) {
2685 * pre-clear the data toggle to DATA0 ("umass.c" and
2686 * "ata-usb.c" depends on this)
2689 usb2_clear_data_toggle(xfer2->xroot->udev, xfer2->pipe);
2691 /* setup a clear-stall packet */
2693 req.bmRequestType = UT_WRITE_ENDPOINT;
2694 req.bRequest = UR_CLEAR_FEATURE;
2695 USETW(req.wValue, UF_ENDPOINT_HALT);
2696 req.wIndex[0] = xfer2->pipe->edesc->bEndpointAddress;
2698 USETW(req.wLength, 0);
2701 * "usb2_transfer_setup_sub()" will ensure that
2702 * we have sufficient room in the buffer for
2703 * the request structure!
2706 /* copy in the transfer */
2708 usb2_copy_in(xfer1->frbuffers, 0, &req, sizeof(req));
2711 xfer1->frlengths[0] = sizeof(req);
2714 usb2_start_hardware(xfer1);
2717 case USB_ST_TRANSFERRED:
2720 default: /* Error */
2721 if (xfer1->error == USB_ERR_CANCELLED) {
2726 return (1); /* Clear Stall Finished */
2730 usb2_do_poll(struct usb2_xfer **ppxfer, uint16_t max)
2732 static uint8_t once = 0;
2733 /* polling is currently not supported */
2736 printf("usb2_do_poll: USB polling is "
2737 "not supported!\n");
2742 usb2_get_std_packet_size(struct usb2_std_packet_size *ptr,
2743 uint8_t type, uint8_t usb_speed)
2745 static const uint16_t intr_range_max[USB_SPEED_MAX] = {
2746 [USB_SPEED_LOW] = 8,
2747 [USB_SPEED_FULL] = 64,
2748 [USB_SPEED_HIGH] = 1024,
2749 [USB_SPEED_VARIABLE] = 1024,
2750 [USB_SPEED_SUPER] = 1024,
2753 static const uint16_t isoc_range_max[USB_SPEED_MAX] = {
2754 [USB_SPEED_LOW] = 0, /* invalid */
2755 [USB_SPEED_FULL] = 1023,
2756 [USB_SPEED_HIGH] = 1024,
2757 [USB_SPEED_VARIABLE] = 3584,
2758 [USB_SPEED_SUPER] = 1024,
2761 static const uint16_t control_min[USB_SPEED_MAX] = {
2762 [USB_SPEED_LOW] = 8,
2763 [USB_SPEED_FULL] = 8,
2764 [USB_SPEED_HIGH] = 64,
2765 [USB_SPEED_VARIABLE] = 512,
2766 [USB_SPEED_SUPER] = 512,
2769 static const uint16_t bulk_min[USB_SPEED_MAX] = {
2770 [USB_SPEED_LOW] = 0, /* not supported */
2771 [USB_SPEED_FULL] = 8,
2772 [USB_SPEED_HIGH] = 512,
2773 [USB_SPEED_VARIABLE] = 512,
2774 [USB_SPEED_SUPER] = 1024,
2779 memset(ptr, 0, sizeof(*ptr));
2783 ptr->range.max = intr_range_max[usb_speed];
2785 case UE_ISOCHRONOUS:
2786 ptr->range.max = isoc_range_max[usb_speed];
2789 if (type == UE_BULK)
2790 temp = bulk_min[usb_speed];
2791 else /* UE_CONTROL */
2792 temp = control_min[usb_speed];
2794 /* default is fixed */
2795 ptr->fixed[0] = temp;
2796 ptr->fixed[1] = temp;
2797 ptr->fixed[2] = temp;
2798 ptr->fixed[3] = temp;
2800 if (usb_speed == USB_SPEED_FULL) {
2801 /* multiple sizes */
2806 if ((usb_speed == USB_SPEED_VARIABLE) &&
2807 (type == UE_BULK)) {
2808 /* multiple sizes */
2809 ptr->fixed[2] = 1024;
2810 ptr->fixed[3] = 1536;