usb_transfer.c revision 190184
1184610Salfred/* $FreeBSD: head/sys/dev/usb/usb_transfer.c 190184 2009-03-20 22:01:45Z thompsa $ */ 2184610Salfred/*- 3184610Salfred * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4184610Salfred * 5184610Salfred * Redistribution and use in source and binary forms, with or without 6184610Salfred * modification, are permitted provided that the following conditions 7184610Salfred * are met: 8184610Salfred * 1. Redistributions of source code must retain the above copyright 9184610Salfred * notice, this list of conditions and the following disclaimer. 10184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 11184610Salfred * notice, this list of conditions and the following disclaimer in the 12184610Salfred * documentation and/or other materials provided with the distribution. 13184610Salfred * 14184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24184610Salfred * SUCH DAMAGE. 25184610Salfred */ 26184610Salfred 27188942Sthompsa#include <dev/usb/usb_mfunc.h> 28188942Sthompsa#include <dev/usb/usb_error.h> 29188942Sthompsa#include <dev/usb/usb.h> 30184610Salfred 31184610Salfred#define USB_DEBUG_VAR usb2_debug 32184610Salfred 33188942Sthompsa#include <dev/usb/usb_core.h> 34188942Sthompsa#include <dev/usb/usb_busdma.h> 35188942Sthompsa#include <dev/usb/usb_process.h> 36188942Sthompsa#include <dev/usb/usb_transfer.h> 37188942Sthompsa#include <dev/usb/usb_device.h> 38188942Sthompsa#include <dev/usb/usb_debug.h> 39188942Sthompsa#include <dev/usb/usb_util.h> 40184610Salfred 41188942Sthompsa#include <dev/usb/usb_controller.h> 42188942Sthompsa#include <dev/usb/usb_bus.h> 43184610Salfred 44184610Salfredstruct usb2_std_packet_size { 45184610Salfred struct { 46184610Salfred uint16_t min; /* inclusive */ 47184610Salfred uint16_t max; /* inclusive */ 48184610Salfred } range; 49184610Salfred 50184610Salfred uint16_t fixed[4]; 51184610Salfred}; 52184610Salfred 53184610Salfred/* 54184610Salfred * This table stores the all the allowed packet sizes based on 55184610Salfred * endpoint type and USB speed: 56184610Salfred */ 57184610Salfredstatic const struct usb2_std_packet_size 58184610Salfred usb2_std_packet_size[4][USB_SPEED_MAX] = { 59184610Salfred 60184610Salfred [UE_INTERRUPT] = { 61184610Salfred [USB_SPEED_LOW] = {.range = {0, 8}}, 62184610Salfred [USB_SPEED_FULL] = {.range = {0, 64}}, 63184610Salfred [USB_SPEED_HIGH] = {.range = {0, 1024}}, 64184610Salfred [USB_SPEED_VARIABLE] = {.range = {0, 1024}}, 65187180Sthompsa [USB_SPEED_SUPER] = {.range = {0, 1024}}, 66184610Salfred }, 67184610Salfred 68184610Salfred [UE_CONTROL] = { 69184610Salfred [USB_SPEED_LOW] = {.fixed = {8, 8, 8, 8}}, 70184610Salfred [USB_SPEED_FULL] = {.fixed = {8, 16, 32, 64}}, 71184610Salfred [USB_SPEED_HIGH] = {.fixed = {64, 64, 64, 64}}, 72184610Salfred [USB_SPEED_VARIABLE] = {.fixed = {512, 512, 512, 512}}, 73187180Sthompsa [USB_SPEED_SUPER] = {.fixed = {512, 512, 512, 512}}, 74184610Salfred }, 75184610Salfred 76184610Salfred [UE_BULK] = { 77184610Salfred [USB_SPEED_LOW] = {.fixed = {0, 0, 0, 0}}, /* invalid */ 78184610Salfred [USB_SPEED_FULL] = {.fixed = {8, 16, 32, 64}}, 79184610Salfred [USB_SPEED_HIGH] = {.fixed = {512, 512, 512, 512}}, 80184610Salfred [USB_SPEED_VARIABLE] = {.fixed = {512, 512, 1024, 1536}}, 81187180Sthompsa [USB_SPEED_SUPER] = {.fixed = {1024, 1024, 1024, 1024}}, 82184610Salfred }, 83184610Salfred 84184610Salfred [UE_ISOCHRONOUS] = { 85184610Salfred [USB_SPEED_LOW] = {.fixed = {0, 0, 0, 0}}, /* invalid */ 86184610Salfred [USB_SPEED_FULL] = {.range = {0, 1023}}, 87184610Salfred [USB_SPEED_HIGH] = {.range = {0, 1024}}, 88184610Salfred [USB_SPEED_VARIABLE] = {.range = {0, 3584}}, 89187180Sthompsa [USB_SPEED_SUPER] = {.range = {0, 1024}}, 90184610Salfred }, 91184610Salfred}; 92184610Salfred 93184610Salfredstatic const struct usb2_config usb2_control_ep_cfg[USB_DEFAULT_XFER_MAX] = { 94184610Salfred 95184610Salfred /* This transfer is used for generic control endpoint transfers */ 96184610Salfred 97184610Salfred [0] = { 98184610Salfred .type = UE_CONTROL, 99184610Salfred .endpoint = 0x00, /* Control endpoint */ 100184610Salfred .direction = UE_DIR_ANY, 101190181Sthompsa .mh.bufsize = USB_EP0_BUFSIZE, /* bytes */ 102184610Salfred .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,}, 103184610Salfred .mh.callback = &usb2_do_request_callback, 104190181Sthompsa .md.bufsize = USB_EP0_BUFSIZE, /* bytes */ 105184610Salfred .md.flags = {.proxy_buffer = 1,.short_xfer_ok = 0,}, 106184610Salfred .md.callback = &usb2_handle_request_callback, 107184610Salfred }, 108184610Salfred 109184610Salfred /* This transfer is used for generic clear stall only */ 110184610Salfred 111184610Salfred [1] = { 112184610Salfred .type = UE_CONTROL, 113184610Salfred .endpoint = 0x00, /* Control pipe */ 114184610Salfred .direction = UE_DIR_ANY, 115184610Salfred .mh.bufsize = sizeof(struct usb2_device_request), 116184610Salfred .mh.callback = &usb2_do_clear_stall_callback, 117184610Salfred .mh.timeout = 1000, /* 1 second */ 118184610Salfred .mh.interval = 50, /* 50ms */ 119184610Salfred }, 120184610Salfred}; 121184610Salfred 122184610Salfred/* function prototypes */ 123184610Salfred 124185948Sthompsastatic void usb2_update_max_frame_size(struct usb2_xfer *); 125185948Sthompsastatic void usb2_transfer_unsetup_sub(struct usb2_xfer_root *, uint8_t); 126185948Sthompsastatic void usb2_control_transfer_init(struct usb2_xfer *); 127185948Sthompsastatic uint8_t usb2_start_hardware_sub(struct usb2_xfer *); 128185948Sthompsastatic void usb2_callback_proc(struct usb2_proc_msg *); 129185948Sthompsastatic void usb2_callback_ss_done_defer(struct usb2_xfer *); 130185948Sthompsastatic void usb2_callback_wrapper(struct usb2_xfer_queue *); 131185948Sthompsastatic void usb2_dma_delay_done_cb(void *); 132185948Sthompsastatic void usb2_transfer_start_cb(void *); 133185948Sthompsastatic uint8_t usb2_callback_wrapper_sub(struct usb2_xfer *); 134184610Salfred 135184610Salfred/*------------------------------------------------------------------------* 136184610Salfred * usb2_update_max_frame_size 137184610Salfred * 138184610Salfred * This function updates the maximum frame size, hence high speed USB 139184610Salfred * can transfer multiple consecutive packets. 140184610Salfred *------------------------------------------------------------------------*/ 141184610Salfredstatic void 142184610Salfredusb2_update_max_frame_size(struct usb2_xfer *xfer) 143184610Salfred{ 144184610Salfred /* compute maximum frame size */ 145184610Salfred 146184610Salfred if (xfer->max_packet_count == 2) { 147184610Salfred xfer->max_frame_size = 2 * xfer->max_packet_size; 148184610Salfred } else if (xfer->max_packet_count == 3) { 149184610Salfred xfer->max_frame_size = 3 * xfer->max_packet_size; 150184610Salfred } else { 151184610Salfred xfer->max_frame_size = xfer->max_packet_size; 152184610Salfred } 153184610Salfred} 154184610Salfred 155184610Salfred/*------------------------------------------------------------------------* 156184610Salfred * usb2_get_dma_delay 157184610Salfred * 158184610Salfred * The following function is called when we need to 159184610Salfred * synchronize with DMA hardware. 160184610Salfred * 161184610Salfred * Returns: 162184610Salfred * 0: no DMA delay required 163184610Salfred * Else: milliseconds of DMA delay 164184610Salfred *------------------------------------------------------------------------*/ 165190181Sthompsausb2_timeout_t 166184610Salfredusb2_get_dma_delay(struct usb2_bus *bus) 167184610Salfred{ 168184610Salfred uint32_t temp = 0; 169184610Salfred 170184610Salfred if (bus->methods->get_dma_delay) { 171184610Salfred (bus->methods->get_dma_delay) (bus, &temp); 172184610Salfred /* 173184610Salfred * Round up and convert to milliseconds. Note that we use 174184610Salfred * 1024 milliseconds per second. to save a division. 175184610Salfred */ 176184610Salfred temp += 0x3FF; 177184610Salfred temp /= 0x400; 178184610Salfred } 179184610Salfred return (temp); 180184610Salfred} 181184610Salfred 182184610Salfred/*------------------------------------------------------------------------* 183184610Salfred * usb2_transfer_setup_sub_malloc 184184610Salfred * 185184610Salfred * This function will allocate one or more DMA'able memory chunks 186184610Salfred * according to "size", "align" and "count" arguments. "ppc" is 187184610Salfred * pointed to a linear array of USB page caches afterwards. 188184610Salfred * 189184610Salfred * Returns: 190184610Salfred * 0: Success 191184610Salfred * Else: Failure 192184610Salfred *------------------------------------------------------------------------*/ 193190180Sthompsa#if USB_HAVE_BUSDMA 194184610Salfreduint8_t 195184610Salfredusb2_transfer_setup_sub_malloc(struct usb2_setup_params *parm, 196190181Sthompsa struct usb2_page_cache **ppc, usb2_size_t size, usb2_size_t align, 197190181Sthompsa usb2_size_t count) 198184610Salfred{ 199184610Salfred struct usb2_page_cache *pc; 200184610Salfred struct usb2_page *pg; 201184610Salfred void *buf; 202190181Sthompsa usb2_size_t n_dma_pc; 203190181Sthompsa usb2_size_t n_obj; 204190181Sthompsa usb2_size_t x; 205190181Sthompsa usb2_size_t y; 206190181Sthompsa usb2_size_t r; 207190181Sthompsa usb2_size_t z; 208184610Salfred 209184610Salfred USB_ASSERT(align > 1, ("Invalid alignment, 0x%08x!\n", 210184610Salfred align)); 211184610Salfred USB_ASSERT(size > 0, ("Invalid size = 0!\n")); 212184610Salfred 213184610Salfred if (count == 0) { 214184610Salfred return (0); /* nothing to allocate */ 215184610Salfred } 216184610Salfred /* 217184610Salfred * Make sure that the size is aligned properly. 218184610Salfred */ 219184610Salfred size = -((-size) & (-align)); 220184610Salfred 221184610Salfred /* 222184610Salfred * Try multi-allocation chunks to reduce the number of DMA 223184610Salfred * allocations, hence DMA allocations are slow. 224184610Salfred */ 225184610Salfred if (size >= PAGE_SIZE) { 226184610Salfred n_dma_pc = count; 227184610Salfred n_obj = 1; 228184610Salfred } else { 229184610Salfred /* compute number of objects per page */ 230184610Salfred n_obj = (PAGE_SIZE / size); 231184610Salfred /* 232184610Salfred * Compute number of DMA chunks, rounded up 233184610Salfred * to nearest one: 234184610Salfred */ 235184610Salfred n_dma_pc = ((count + n_obj - 1) / n_obj); 236184610Salfred } 237184610Salfred 238184610Salfred if (parm->buf == NULL) { 239184610Salfred /* for the future */ 240184610Salfred parm->dma_page_ptr += n_dma_pc; 241184610Salfred parm->dma_page_cache_ptr += n_dma_pc; 242184610Salfred parm->dma_page_ptr += count; 243184610Salfred parm->xfer_page_cache_ptr += count; 244184610Salfred return (0); 245184610Salfred } 246184610Salfred for (x = 0; x != n_dma_pc; x++) { 247184610Salfred /* need to initialize the page cache */ 248184610Salfred parm->dma_page_cache_ptr[x].tag_parent = 249187173Sthompsa &parm->curr_xfer->xroot->dma_parent_tag; 250184610Salfred } 251184610Salfred for (x = 0; x != count; x++) { 252184610Salfred /* need to initialize the page cache */ 253184610Salfred parm->xfer_page_cache_ptr[x].tag_parent = 254187173Sthompsa &parm->curr_xfer->xroot->dma_parent_tag; 255184610Salfred } 256184610Salfred 257184610Salfred if (ppc) { 258184610Salfred *ppc = parm->xfer_page_cache_ptr; 259184610Salfred } 260184610Salfred r = count; /* set remainder count */ 261184610Salfred z = n_obj * size; /* set allocation size */ 262184610Salfred pc = parm->xfer_page_cache_ptr; 263184610Salfred pg = parm->dma_page_ptr; 264184610Salfred 265184610Salfred for (x = 0; x != n_dma_pc; x++) { 266184610Salfred 267184610Salfred if (r < n_obj) { 268184610Salfred /* compute last remainder */ 269184610Salfred z = r * size; 270184610Salfred n_obj = r; 271184610Salfred } 272184610Salfred if (usb2_pc_alloc_mem(parm->dma_page_cache_ptr, 273184610Salfred pg, z, align)) { 274184610Salfred return (1); /* failure */ 275184610Salfred } 276184610Salfred /* Set beginning of current buffer */ 277184610Salfred buf = parm->dma_page_cache_ptr->buffer; 278184610Salfred /* Make room for one DMA page cache and one page */ 279184610Salfred parm->dma_page_cache_ptr++; 280184610Salfred pg++; 281184610Salfred 282184610Salfred for (y = 0; (y != n_obj); y++, r--, pc++, pg++) { 283184610Salfred 284184610Salfred /* Load sub-chunk into DMA */ 285184610Salfred if (usb2_pc_dmamap_create(pc, size)) { 286184610Salfred return (1); /* failure */ 287184610Salfred } 288184610Salfred pc->buffer = USB_ADD_BYTES(buf, y * size); 289184610Salfred pc->page_start = pg; 290184610Salfred 291184610Salfred mtx_lock(pc->tag_parent->mtx); 292184610Salfred if (usb2_pc_load_mem(pc, size, 1 /* synchronous */ )) { 293184610Salfred mtx_unlock(pc->tag_parent->mtx); 294184610Salfred return (1); /* failure */ 295184610Salfred } 296184610Salfred mtx_unlock(pc->tag_parent->mtx); 297184610Salfred } 298184610Salfred } 299184610Salfred 300184610Salfred parm->xfer_page_cache_ptr = pc; 301184610Salfred parm->dma_page_ptr = pg; 302184610Salfred return (0); 303184610Salfred} 304190180Sthompsa#endif 305184610Salfred 306184610Salfred/*------------------------------------------------------------------------* 307184610Salfred * usb2_transfer_setup_sub - transfer setup subroutine 308184610Salfred * 309184610Salfred * This function must be called from the "xfer_setup" callback of the 310184610Salfred * USB Host or Device controller driver when setting up an USB 311184610Salfred * transfer. This function will setup correct packet sizes, buffer 312184610Salfred * sizes, flags and more, that are stored in the "usb2_xfer" 313184610Salfred * structure. 314184610Salfred *------------------------------------------------------------------------*/ 315184610Salfredvoid 316184610Salfredusb2_transfer_setup_sub(struct usb2_setup_params *parm) 317184610Salfred{ 318184610Salfred enum { 319184610Salfred REQ_SIZE = 8, 320184610Salfred MIN_PKT = 8, 321184610Salfred }; 322184610Salfred struct usb2_xfer *xfer = parm->curr_xfer; 323184610Salfred const struct usb2_config_sub *setup_sub = parm->curr_setup_sub; 324184610Salfred struct usb2_endpoint_descriptor *edesc; 325184610Salfred struct usb2_std_packet_size std_size; 326190181Sthompsa usb2_frcount_t n_frlengths; 327190181Sthompsa usb2_frcount_t n_frbuffers; 328190181Sthompsa usb2_frcount_t x; 329184610Salfred uint8_t type; 330184610Salfred uint8_t zmps; 331184610Salfred 332184610Salfred /* 333184610Salfred * Sanity check. The following parameters must be initialized before 334184610Salfred * calling this function. 335184610Salfred */ 336184610Salfred if ((parm->hc_max_packet_size == 0) || 337184610Salfred (parm->hc_max_packet_count == 0) || 338184610Salfred (parm->hc_max_frame_size == 0)) { 339184610Salfred parm->err = USB_ERR_INVAL; 340184610Salfred goto done; 341184610Salfred } 342184610Salfred edesc = xfer->pipe->edesc; 343184610Salfred 344184610Salfred type = (edesc->bmAttributes & UE_XFERTYPE); 345184610Salfred 346184610Salfred xfer->flags = setup_sub->flags; 347184610Salfred xfer->nframes = setup_sub->frames; 348184610Salfred xfer->timeout = setup_sub->timeout; 349184610Salfred xfer->callback = setup_sub->callback; 350184610Salfred xfer->interval = setup_sub->interval; 351184610Salfred xfer->endpoint = edesc->bEndpointAddress; 352184610Salfred xfer->max_packet_size = UGETW(edesc->wMaxPacketSize); 353184610Salfred xfer->max_packet_count = 1; 354184610Salfred /* make a shadow copy: */ 355184610Salfred xfer->flags_int.usb2_mode = parm->udev->flags.usb2_mode; 356184610Salfred 357184610Salfred parm->bufsize = setup_sub->bufsize; 358184610Salfred 359184610Salfred if (parm->speed == USB_SPEED_HIGH) { 360184610Salfred xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 361184610Salfred xfer->max_packet_size &= 0x7FF; 362184610Salfred } 363184610Salfred /* range check "max_packet_count" */ 364184610Salfred 365184610Salfred if (xfer->max_packet_count > parm->hc_max_packet_count) { 366184610Salfred xfer->max_packet_count = parm->hc_max_packet_count; 367184610Salfred } 368184610Salfred /* filter "wMaxPacketSize" according to HC capabilities */ 369184610Salfred 370184610Salfred if ((xfer->max_packet_size > parm->hc_max_packet_size) || 371184610Salfred (xfer->max_packet_size == 0)) { 372184610Salfred xfer->max_packet_size = parm->hc_max_packet_size; 373184610Salfred } 374184610Salfred /* filter "wMaxPacketSize" according to standard sizes */ 375184610Salfred 376184610Salfred std_size = usb2_std_packet_size[type][parm->speed]; 377184610Salfred 378184610Salfred if (std_size.range.min || std_size.range.max) { 379184610Salfred 380184610Salfred if (xfer->max_packet_size < std_size.range.min) { 381184610Salfred xfer->max_packet_size = std_size.range.min; 382184610Salfred } 383184610Salfred if (xfer->max_packet_size > std_size.range.max) { 384184610Salfred xfer->max_packet_size = std_size.range.max; 385184610Salfred } 386184610Salfred } else { 387184610Salfred 388184610Salfred if (xfer->max_packet_size >= std_size.fixed[3]) { 389184610Salfred xfer->max_packet_size = std_size.fixed[3]; 390184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[2]) { 391184610Salfred xfer->max_packet_size = std_size.fixed[2]; 392184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[1]) { 393184610Salfred xfer->max_packet_size = std_size.fixed[1]; 394184610Salfred } else { 395184610Salfred /* only one possibility left */ 396184610Salfred xfer->max_packet_size = std_size.fixed[0]; 397184610Salfred } 398184610Salfred } 399184610Salfred 400184610Salfred /* compute "max_frame_size" */ 401184610Salfred 402184610Salfred usb2_update_max_frame_size(xfer); 403184610Salfred 404184610Salfred /* check interrupt interval and transfer pre-delay */ 405184610Salfred 406184610Salfred if (type == UE_ISOCHRONOUS) { 407184610Salfred 408190181Sthompsa uint16_t frame_limit; 409184610Salfred 410184610Salfred xfer->interval = 0; /* not used, must be zero */ 411184610Salfred xfer->flags_int.isochronous_xfr = 1; /* set flag */ 412184610Salfred 413184610Salfred if (xfer->timeout == 0) { 414184610Salfred /* 415184610Salfred * set a default timeout in 416184610Salfred * case something goes wrong! 417184610Salfred */ 418184610Salfred xfer->timeout = 1000 / 4; 419184610Salfred } 420187180Sthompsa switch (parm->speed) { 421187180Sthompsa case USB_SPEED_LOW: 422187180Sthompsa case USB_SPEED_FULL: 423187180Sthompsa frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER; 424187180Sthompsa break; 425187180Sthompsa default: 426184610Salfred frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER; 427187180Sthompsa break; 428184610Salfred } 429184610Salfred 430184610Salfred if (xfer->nframes > frame_limit) { 431184610Salfred /* 432184610Salfred * this is not going to work 433184610Salfred * cross hardware 434184610Salfred */ 435184610Salfred parm->err = USB_ERR_INVAL; 436184610Salfred goto done; 437184610Salfred } 438184610Salfred if (xfer->nframes == 0) { 439184610Salfred /* 440184610Salfred * this is not a valid value 441184610Salfred */ 442184610Salfred parm->err = USB_ERR_ZERO_NFRAMES; 443184610Salfred goto done; 444184610Salfred } 445184610Salfred } else { 446184610Salfred 447184610Salfred /* 448184610Salfred * if a value is specified use that else check the endpoint 449184610Salfred * descriptor 450184610Salfred */ 451184610Salfred if (xfer->interval == 0) { 452184610Salfred 453184610Salfred if (type == UE_INTERRUPT) { 454184610Salfred 455184610Salfred xfer->interval = edesc->bInterval; 456184610Salfred 457187180Sthompsa switch (parm->speed) { 458187180Sthompsa case USB_SPEED_SUPER: 459187180Sthompsa case USB_SPEED_VARIABLE: 460187180Sthompsa /* 125us -> 1ms */ 461187180Sthompsa if (xfer->interval < 4) 462187180Sthompsa xfer->interval = 1; 463187180Sthompsa else if (xfer->interval > 16) 464187180Sthompsa xfer->interval = (1<<(16-4)); 465187180Sthompsa else 466187180Sthompsa xfer->interval = 467187180Sthompsa (1 << (xfer->interval-4)); 468187180Sthompsa break; 469187180Sthompsa case USB_SPEED_HIGH: 470187180Sthompsa /* 125us -> 1ms */ 471187180Sthompsa xfer->interval /= 8; 472187180Sthompsa break; 473187180Sthompsa default: 474187180Sthompsa break; 475184610Salfred } 476184610Salfred if (xfer->interval == 0) { 477184610Salfred /* 478187180Sthompsa * One millisecond is the smallest 479187180Sthompsa * interval we support: 480184610Salfred */ 481184610Salfred xfer->interval = 1; 482184610Salfred } 483184610Salfred } 484184610Salfred } 485184610Salfred } 486184610Salfred 487184610Salfred /* 488184610Salfred * NOTE: we do not allow "max_packet_size" or "max_frame_size" 489184610Salfred * to be equal to zero when setting up USB transfers, hence 490184610Salfred * this leads to alot of extra code in the USB kernel. 491184610Salfred */ 492184610Salfred 493184610Salfred if ((xfer->max_frame_size == 0) || 494184610Salfred (xfer->max_packet_size == 0)) { 495184610Salfred 496184610Salfred zmps = 1; 497184610Salfred 498184610Salfred if ((parm->bufsize <= MIN_PKT) && 499184610Salfred (type != UE_CONTROL) && 500184610Salfred (type != UE_BULK)) { 501184610Salfred 502184610Salfred /* workaround */ 503184610Salfred xfer->max_packet_size = MIN_PKT; 504184610Salfred xfer->max_packet_count = 1; 505184610Salfred parm->bufsize = 0; /* automatic setup length */ 506184610Salfred usb2_update_max_frame_size(xfer); 507184610Salfred 508184610Salfred } else { 509184610Salfred parm->err = USB_ERR_ZERO_MAXP; 510184610Salfred goto done; 511184610Salfred } 512184610Salfred 513184610Salfred } else { 514184610Salfred zmps = 0; 515184610Salfred } 516184610Salfred 517184610Salfred /* 518184610Salfred * check if we should setup a default 519184610Salfred * length: 520184610Salfred */ 521184610Salfred 522184610Salfred if (parm->bufsize == 0) { 523184610Salfred 524184610Salfred parm->bufsize = xfer->max_frame_size; 525184610Salfred 526184610Salfred if (type == UE_ISOCHRONOUS) { 527184610Salfred parm->bufsize *= xfer->nframes; 528184610Salfred } 529184610Salfred } 530184610Salfred /* 531184610Salfred * check if we are about to setup a proxy 532184610Salfred * type of buffer: 533184610Salfred */ 534184610Salfred 535184610Salfred if (xfer->flags.proxy_buffer) { 536184610Salfred 537184610Salfred /* round bufsize up */ 538184610Salfred 539184610Salfred parm->bufsize += (xfer->max_frame_size - 1); 540184610Salfred 541184610Salfred if (parm->bufsize < xfer->max_frame_size) { 542184610Salfred /* length wrapped around */ 543184610Salfred parm->err = USB_ERR_INVAL; 544184610Salfred goto done; 545184610Salfred } 546184610Salfred /* subtract remainder */ 547184610Salfred 548184610Salfred parm->bufsize -= (parm->bufsize % xfer->max_frame_size); 549184610Salfred 550184610Salfred /* add length of USB device request structure, if any */ 551184610Salfred 552184610Salfred if (type == UE_CONTROL) { 553184610Salfred parm->bufsize += REQ_SIZE; /* SETUP message */ 554184610Salfred } 555184610Salfred } 556184610Salfred xfer->max_data_length = parm->bufsize; 557184610Salfred 558184610Salfred /* Setup "n_frlengths" and "n_frbuffers" */ 559184610Salfred 560184610Salfred if (type == UE_ISOCHRONOUS) { 561184610Salfred n_frlengths = xfer->nframes; 562184610Salfred n_frbuffers = 1; 563184610Salfred } else { 564184610Salfred 565184610Salfred if (type == UE_CONTROL) { 566184610Salfred xfer->flags_int.control_xfr = 1; 567184610Salfred if (xfer->nframes == 0) { 568184610Salfred if (parm->bufsize <= REQ_SIZE) { 569184610Salfred /* 570184610Salfred * there will never be any data 571184610Salfred * stage 572184610Salfred */ 573184610Salfred xfer->nframes = 1; 574184610Salfred } else { 575184610Salfred xfer->nframes = 2; 576184610Salfred } 577184610Salfred } 578184610Salfred } else { 579184610Salfred if (xfer->nframes == 0) { 580184610Salfred xfer->nframes = 1; 581184610Salfred } 582184610Salfred } 583184610Salfred 584184610Salfred n_frlengths = xfer->nframes; 585184610Salfred n_frbuffers = xfer->nframes; 586184610Salfred } 587184610Salfred 588184610Salfred /* 589184610Salfred * check if we have room for the 590184610Salfred * USB device request structure: 591184610Salfred */ 592184610Salfred 593184610Salfred if (type == UE_CONTROL) { 594184610Salfred 595184610Salfred if (xfer->max_data_length < REQ_SIZE) { 596184610Salfred /* length wrapped around or too small bufsize */ 597184610Salfred parm->err = USB_ERR_INVAL; 598184610Salfred goto done; 599184610Salfred } 600184610Salfred xfer->max_data_length -= REQ_SIZE; 601184610Salfred } 602184610Salfred /* setup "frlengths" */ 603184610Salfred 604184610Salfred xfer->frlengths = parm->xfer_length_ptr; 605184610Salfred 606184610Salfred parm->xfer_length_ptr += n_frlengths; 607184610Salfred 608184610Salfred /* setup "frbuffers" */ 609184610Salfred 610184610Salfred xfer->frbuffers = parm->xfer_page_cache_ptr; 611184610Salfred 612184610Salfred parm->xfer_page_cache_ptr += n_frbuffers; 613184610Salfred 614184610Salfred /* 615184610Salfred * check if we need to setup 616184610Salfred * a local buffer: 617184610Salfred */ 618184610Salfred 619184610Salfred if (!xfer->flags.ext_buffer) { 620184610Salfred 621184610Salfred /* align data */ 622184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 623184610Salfred 624184610Salfred if (parm->buf) { 625184610Salfred 626184610Salfred xfer->local_buffer = 627184610Salfred USB_ADD_BYTES(parm->buf, parm->size[0]); 628184610Salfred 629184610Salfred usb2_set_frame_offset(xfer, 0, 0); 630184610Salfred 631184610Salfred if ((type == UE_CONTROL) && (n_frbuffers > 1)) { 632184610Salfred usb2_set_frame_offset(xfer, REQ_SIZE, 1); 633184610Salfred } 634184610Salfred } 635184610Salfred parm->size[0] += parm->bufsize; 636184610Salfred 637184610Salfred /* align data again */ 638184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 639184610Salfred } 640184610Salfred /* 641184610Salfred * Compute maximum buffer size 642184610Salfred */ 643184610Salfred 644184610Salfred if (parm->bufsize_max < parm->bufsize) { 645184610Salfred parm->bufsize_max = parm->bufsize; 646184610Salfred } 647190180Sthompsa#if USB_HAVE_BUSDMA 648184610Salfred if (xfer->flags_int.bdma_enable) { 649184610Salfred /* 650184610Salfred * Setup "dma_page_ptr". 651184610Salfred * 652184610Salfred * Proof for formula below: 653184610Salfred * 654184610Salfred * Assume there are three USB frames having length "a", "b" and 655184610Salfred * "c". These USB frames will at maximum need "z" 656184610Salfred * "usb2_page" structures. "z" is given by: 657184610Salfred * 658184610Salfred * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) + 659184610Salfred * ((c / USB_PAGE_SIZE) + 2); 660184610Salfred * 661184610Salfred * Constraining "a", "b" and "c" like this: 662184610Salfred * 663184610Salfred * (a + b + c) <= parm->bufsize 664184610Salfred * 665184610Salfred * We know that: 666184610Salfred * 667184610Salfred * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2)); 668184610Salfred * 669184610Salfred * Here is the general formula: 670184610Salfred */ 671184610Salfred xfer->dma_page_ptr = parm->dma_page_ptr; 672184610Salfred parm->dma_page_ptr += (2 * n_frbuffers); 673184610Salfred parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE); 674184610Salfred } 675190180Sthompsa#endif 676184610Salfred if (zmps) { 677184610Salfred /* correct maximum data length */ 678184610Salfred xfer->max_data_length = 0; 679184610Salfred } 680184610Salfred /* subtract USB frame remainder from "hc_max_frame_size" */ 681184610Salfred 682190181Sthompsa xfer->max_hc_frame_size = 683184610Salfred (parm->hc_max_frame_size - 684184610Salfred (parm->hc_max_frame_size % xfer->max_frame_size)); 685184610Salfred 686190181Sthompsa if (xfer->max_hc_frame_size == 0) { 687184610Salfred parm->err = USB_ERR_INVAL; 688184610Salfred goto done; 689184610Salfred } 690184610Salfred /* initialize max frame count */ 691184610Salfred 692184610Salfred xfer->max_frame_count = xfer->nframes; 693184610Salfred 694184610Salfred /* initialize frame buffers */ 695184610Salfred 696184610Salfred if (parm->buf) { 697184610Salfred for (x = 0; x != n_frbuffers; x++) { 698184610Salfred xfer->frbuffers[x].tag_parent = 699187173Sthompsa &xfer->xroot->dma_parent_tag; 700190180Sthompsa#if USB_HAVE_BUSDMA 701184610Salfred if (xfer->flags_int.bdma_enable && 702184610Salfred (parm->bufsize_max > 0)) { 703184610Salfred 704184610Salfred if (usb2_pc_dmamap_create( 705184610Salfred xfer->frbuffers + x, 706184610Salfred parm->bufsize_max)) { 707184610Salfred parm->err = USB_ERR_NOMEM; 708184610Salfred goto done; 709184610Salfred } 710184610Salfred } 711190180Sthompsa#endif 712184610Salfred } 713184610Salfred } 714184610Salfreddone: 715184610Salfred if (parm->err) { 716184610Salfred /* 717184610Salfred * Set some dummy values so that we avoid division by zero: 718184610Salfred */ 719190181Sthompsa xfer->max_hc_frame_size = 1; 720184610Salfred xfer->max_frame_size = 1; 721184610Salfred xfer->max_packet_size = 1; 722184610Salfred xfer->max_data_length = 0; 723184610Salfred xfer->nframes = 0; 724184610Salfred xfer->max_frame_count = 0; 725184610Salfred } 726184610Salfred} 727184610Salfred 728184610Salfred/*------------------------------------------------------------------------* 729184610Salfred * usb2_transfer_setup - setup an array of USB transfers 730184610Salfred * 731184610Salfred * NOTE: You must always call "usb2_transfer_unsetup" after calling 732184610Salfred * "usb2_transfer_setup" if success was returned. 733184610Salfred * 734184610Salfred * The idea is that the USB device driver should pre-allocate all its 735184610Salfred * transfers by one call to this function. 736184610Salfred * 737184610Salfred * Return values: 738184610Salfred * 0: Success 739184610Salfred * Else: Failure 740184610Salfred *------------------------------------------------------------------------*/ 741184610Salfredusb2_error_t 742184610Salfredusb2_transfer_setup(struct usb2_device *udev, 743184610Salfred const uint8_t *ifaces, struct usb2_xfer **ppxfer, 744184610Salfred const struct usb2_config *setup_start, uint16_t n_setup, 745187173Sthompsa void *priv_sc, struct mtx *xfer_mtx) 746184610Salfred{ 747184610Salfred struct usb2_xfer dummy; 748184610Salfred struct usb2_setup_params parm; 749184610Salfred const struct usb2_config *setup_end = setup_start + n_setup; 750184610Salfred const struct usb2_config *setup; 751184610Salfred struct usb2_pipe *pipe; 752184610Salfred struct usb2_xfer_root *info; 753184610Salfred struct usb2_xfer *xfer; 754184610Salfred void *buf = NULL; 755184610Salfred uint16_t n; 756184610Salfred uint16_t refcount; 757184610Salfred 758184610Salfred parm.err = 0; 759184610Salfred refcount = 0; 760184610Salfred info = NULL; 761184610Salfred 762184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 763184610Salfred "usb2_transfer_setup can sleep!"); 764184610Salfred 765184610Salfred /* do some checking first */ 766184610Salfred 767184610Salfred if (n_setup == 0) { 768184610Salfred DPRINTFN(6, "setup array has zero length!\n"); 769184610Salfred return (USB_ERR_INVAL); 770184610Salfred } 771184610Salfred if (ifaces == 0) { 772184610Salfred DPRINTFN(6, "ifaces array is NULL!\n"); 773184610Salfred return (USB_ERR_INVAL); 774184610Salfred } 775187173Sthompsa if (xfer_mtx == NULL) { 776184610Salfred DPRINTFN(6, "using global lock\n"); 777187173Sthompsa xfer_mtx = &Giant; 778184610Salfred } 779184610Salfred /* sanity checks */ 780184610Salfred for (setup = setup_start, n = 0; 781184610Salfred setup != setup_end; setup++, n++) { 782190181Sthompsa if ((setup->mh.bufsize == (usb2_frlength_t)-1) || 783190181Sthompsa (setup->md.bufsize == (usb2_frlength_t)-1)) { 784184610Salfred parm.err = USB_ERR_BAD_BUFSIZE; 785184610Salfred DPRINTF("invalid bufsize\n"); 786184610Salfred } 787184610Salfred if ((setup->mh.callback == NULL) && 788184610Salfred (setup->md.callback == NULL)) { 789184610Salfred parm.err = USB_ERR_NO_CALLBACK; 790184610Salfred DPRINTF("no callback\n"); 791184610Salfred } 792184610Salfred ppxfer[n] = NULL; 793184610Salfred } 794184610Salfred 795184610Salfred if (parm.err) { 796184610Salfred goto done; 797184610Salfred } 798184610Salfred bzero(&parm, sizeof(parm)); 799184610Salfred 800184610Salfred parm.udev = udev; 801184610Salfred parm.speed = usb2_get_speed(udev); 802184610Salfred parm.hc_max_packet_count = 1; 803184610Salfred 804184610Salfred if (parm.speed >= USB_SPEED_MAX) { 805184610Salfred parm.err = USB_ERR_INVAL; 806184610Salfred goto done; 807184610Salfred } 808184610Salfred /* setup all transfers */ 809184610Salfred 810184610Salfred while (1) { 811184610Salfred 812184610Salfred if (buf) { 813184610Salfred /* 814184610Salfred * Initialize the "usb2_xfer_root" structure, 815184610Salfred * which is common for all our USB transfers. 816184610Salfred */ 817184610Salfred info = USB_ADD_BYTES(buf, 0); 818184610Salfred 819184610Salfred info->memory_base = buf; 820184610Salfred info->memory_size = parm.size[0]; 821184610Salfred 822190180Sthompsa#if USB_HAVE_BUSDMA 823184610Salfred info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]); 824184610Salfred info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]); 825190180Sthompsa#endif 826184610Salfred info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]); 827184610Salfred info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]); 828184610Salfred 829184610Salfred usb2_cv_init(&info->cv_drain, "WDRAIN"); 830184610Salfred 831187173Sthompsa info->xfer_mtx = xfer_mtx; 832190180Sthompsa#if USB_HAVE_BUSDMA 833184610Salfred usb2_dma_tag_setup(&info->dma_parent_tag, 834184610Salfred parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag, 835190180Sthompsa xfer_mtx, &usb2_bdma_done_event, 32, parm.dma_tag_max); 836190180Sthompsa#endif 837184610Salfred 838184610Salfred info->bus = udev->bus; 839187173Sthompsa info->udev = udev; 840184610Salfred 841184610Salfred TAILQ_INIT(&info->done_q.head); 842184610Salfred info->done_q.command = &usb2_callback_wrapper; 843190180Sthompsa#if USB_HAVE_BUSDMA 844184610Salfred TAILQ_INIT(&info->dma_q.head); 845184610Salfred info->dma_q.command = &usb2_bdma_work_loop; 846190180Sthompsa#endif 847184610Salfred info->done_m[0].hdr.pm_callback = &usb2_callback_proc; 848187173Sthompsa info->done_m[0].xroot = info; 849184610Salfred info->done_m[1].hdr.pm_callback = &usb2_callback_proc; 850187173Sthompsa info->done_m[1].xroot = info; 851184610Salfred 852187174Sthompsa if (xfer_mtx == &Giant) 853187174Sthompsa info->done_p = 854187174Sthompsa &udev->bus->giant_callback_proc; 855187174Sthompsa else 856187174Sthompsa info->done_p = 857187174Sthompsa &udev->bus->non_giant_callback_proc; 858184610Salfred } 859184610Salfred /* reset sizes */ 860184610Salfred 861184610Salfred parm.size[0] = 0; 862184610Salfred parm.buf = buf; 863184610Salfred parm.size[0] += sizeof(info[0]); 864184610Salfred 865184610Salfred for (setup = setup_start, n = 0; 866184610Salfred setup != setup_end; setup++, n++) { 867184610Salfred 868184610Salfred /* select mode specific structure */ 869184610Salfred if (udev->flags.usb2_mode == USB_MODE_HOST) { 870184610Salfred parm.curr_setup_sub = &setup->mh; 871184610Salfred } else { 872184610Salfred parm.curr_setup_sub = &setup->md; 873184610Salfred } 874184610Salfred /* skip USB transfers without callbacks: */ 875184610Salfred if (parm.curr_setup_sub->callback == NULL) { 876184610Salfred continue; 877184610Salfred } 878184610Salfred /* see if there is a matching endpoint */ 879184610Salfred pipe = usb2_get_pipe(udev, 880184610Salfred ifaces[setup->if_index], setup); 881184610Salfred 882184610Salfred if (!pipe) { 883184610Salfred if (parm.curr_setup_sub->flags.no_pipe_ok) { 884184610Salfred continue; 885184610Salfred } 886184610Salfred parm.err = USB_ERR_NO_PIPE; 887184610Salfred goto done; 888184610Salfred } 889184610Salfred /* store current setup pointer */ 890184610Salfred parm.curr_setup = setup; 891184610Salfred 892184610Salfred /* align data properly */ 893184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 894184610Salfred 895184610Salfred if (buf) { 896184610Salfred /* 897184610Salfred * Common initialization of the 898184610Salfred * "usb2_xfer" structure. 899184610Salfred */ 900184610Salfred xfer = USB_ADD_BYTES(buf, parm.size[0]); 901184610Salfred xfer->address = udev->address; 902184610Salfred xfer->priv_sc = priv_sc; 903187173Sthompsa xfer->xroot = info; 904184610Salfred 905184824Sthompsa usb2_callout_init_mtx(&xfer->timeout_handle, 906186454Sthompsa &udev->bus->bus_mtx, 0); 907184610Salfred } else { 908184610Salfred /* 909184610Salfred * Setup a dummy xfer, hence we are 910184610Salfred * writing to the "usb2_xfer" 911184610Salfred * structure pointed to by "xfer" 912184610Salfred * before we have allocated any 913184610Salfred * memory: 914184610Salfred */ 915184610Salfred xfer = &dummy; 916184610Salfred bzero(&dummy, sizeof(dummy)); 917184610Salfred refcount++; 918184610Salfred } 919184610Salfred 920188982Sthompsa /* set transfer pipe pointer */ 921188982Sthompsa xfer->pipe = pipe; 922188982Sthompsa 923184610Salfred parm.size[0] += sizeof(xfer[0]); 924188982Sthompsa parm.methods = xfer->pipe->methods; 925188982Sthompsa parm.curr_xfer = xfer; 926184610Salfred 927188982Sthompsa /* 928188982Sthompsa * Call the Host or Device controller transfer 929188982Sthompsa * setup routine: 930188982Sthompsa */ 931188982Sthompsa (udev->bus->methods->xfer_setup) (&parm); 932184610Salfred 933188982Sthompsa /* check for error */ 934188982Sthompsa if (parm.err) 935188982Sthompsa goto done; 936188982Sthompsa 937184610Salfred if (buf) { 938184610Salfred /* 939184610Salfred * Increment the pipe refcount. This 940184610Salfred * basically prevents setting a new 941184610Salfred * configuration and alternate setting 942184610Salfred * when USB transfers are in use on 943184610Salfred * the given interface. Search the USB 944184610Salfred * code for "pipe->refcount" if you 945184610Salfred * want more information. 946184610Salfred */ 947184610Salfred xfer->pipe->refcount++; 948184610Salfred 949188982Sthompsa /* 950188982Sthompsa * Whenever we set ppxfer[] then we 951188982Sthompsa * also need to increment the 952188982Sthompsa * "setup_refcount": 953188982Sthompsa */ 954188982Sthompsa info->setup_refcount++; 955184610Salfred 956188982Sthompsa /* 957188982Sthompsa * Transfer is successfully setup and 958188982Sthompsa * can be used: 959188982Sthompsa */ 960188982Sthompsa ppxfer[n] = xfer; 961184610Salfred } 962184610Salfred } 963184610Salfred 964184610Salfred if (buf || parm.err) { 965184610Salfred goto done; 966184610Salfred } 967184610Salfred if (refcount == 0) { 968184610Salfred /* no transfers - nothing to do ! */ 969184610Salfred goto done; 970184610Salfred } 971184610Salfred /* align data properly */ 972184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 973184610Salfred 974184610Salfred /* store offset temporarily */ 975184610Salfred parm.size[1] = parm.size[0]; 976184610Salfred 977184610Salfred /* 978184610Salfred * The number of DMA tags required depends on 979184610Salfred * the number of endpoints. The current estimate 980184610Salfred * for maximum number of DMA tags per endpoint 981184610Salfred * is two. 982184610Salfred */ 983184610Salfred parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX); 984184610Salfred 985184610Salfred /* 986184610Salfred * DMA tags for QH, TD, Data and more. 987184610Salfred */ 988184610Salfred parm.dma_tag_max += 8; 989184610Salfred 990184610Salfred parm.dma_tag_p += parm.dma_tag_max; 991184610Salfred 992184610Salfred parm.size[0] += ((uint8_t *)parm.dma_tag_p) - 993184610Salfred ((uint8_t *)0); 994184610Salfred 995184610Salfred /* align data properly */ 996184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 997184610Salfred 998184610Salfred /* store offset temporarily */ 999184610Salfred parm.size[3] = parm.size[0]; 1000184610Salfred 1001184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_ptr) - 1002184610Salfred ((uint8_t *)0); 1003184610Salfred 1004184610Salfred /* align data properly */ 1005184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1006184610Salfred 1007184610Salfred /* store offset temporarily */ 1008184610Salfred parm.size[4] = parm.size[0]; 1009184610Salfred 1010184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) - 1011184610Salfred ((uint8_t *)0); 1012184610Salfred 1013184610Salfred /* store end offset temporarily */ 1014184610Salfred parm.size[5] = parm.size[0]; 1015184610Salfred 1016184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) - 1017184610Salfred ((uint8_t *)0); 1018184610Salfred 1019184610Salfred /* store end offset temporarily */ 1020184610Salfred 1021184610Salfred parm.size[2] = parm.size[0]; 1022184610Salfred 1023184610Salfred /* align data properly */ 1024184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1025184610Salfred 1026184610Salfred parm.size[6] = parm.size[0]; 1027184610Salfred 1028184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) - 1029184610Salfred ((uint8_t *)0); 1030184610Salfred 1031184610Salfred /* align data properly */ 1032184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1033184610Salfred 1034184610Salfred /* allocate zeroed memory */ 1035184610Salfred buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO); 1036184610Salfred 1037184610Salfred if (buf == NULL) { 1038184610Salfred parm.err = USB_ERR_NOMEM; 1039184610Salfred DPRINTFN(0, "cannot allocate memory block for " 1040184610Salfred "configuration (%d bytes)\n", 1041184610Salfred parm.size[0]); 1042184610Salfred goto done; 1043184610Salfred } 1044184610Salfred parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]); 1045184610Salfred parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]); 1046184610Salfred parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]); 1047184610Salfred parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]); 1048184610Salfred parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]); 1049184610Salfred } 1050184610Salfred 1051184610Salfreddone: 1052184610Salfred if (buf) { 1053184610Salfred if (info->setup_refcount == 0) { 1054184610Salfred /* 1055184610Salfred * "usb2_transfer_unsetup_sub" will unlock 1056184824Sthompsa * the bus mutex before returning ! 1057184610Salfred */ 1058184824Sthompsa USB_BUS_LOCK(info->bus); 1059184610Salfred 1060184610Salfred /* something went wrong */ 1061184610Salfred usb2_transfer_unsetup_sub(info, 0); 1062184610Salfred } 1063184610Salfred } 1064184610Salfred if (parm.err) { 1065184610Salfred usb2_transfer_unsetup(ppxfer, n_setup); 1066184610Salfred } 1067184610Salfred return (parm.err); 1068184610Salfred} 1069184610Salfred 1070184610Salfred/*------------------------------------------------------------------------* 1071184610Salfred * usb2_transfer_unsetup_sub - factored out code 1072184610Salfred *------------------------------------------------------------------------*/ 1073184610Salfredstatic void 1074184610Salfredusb2_transfer_unsetup_sub(struct usb2_xfer_root *info, uint8_t needs_delay) 1075184610Salfred{ 1076184610Salfred struct usb2_page_cache *pc; 1077184610Salfred 1078184824Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 1079184610Salfred 1080184610Salfred /* wait for any outstanding DMA operations */ 1081184610Salfred 1082184610Salfred if (needs_delay) { 1083190181Sthompsa usb2_timeout_t temp; 1084184610Salfred temp = usb2_get_dma_delay(info->bus); 1085188411Sthompsa usb2_pause_mtx(&info->bus->bus_mtx, 1086188411Sthompsa USB_MS_TO_TICKS(temp)); 1087184610Salfred } 1088187174Sthompsa 1089187174Sthompsa /* make sure that our done messages are not queued anywhere */ 1090187174Sthompsa usb2_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]); 1091187174Sthompsa 1092184824Sthompsa USB_BUS_UNLOCK(info->bus); 1093184610Salfred 1094190180Sthompsa#if USB_HAVE_BUSDMA 1095184610Salfred /* free DMA'able memory, if any */ 1096184610Salfred pc = info->dma_page_cache_start; 1097184610Salfred while (pc != info->dma_page_cache_end) { 1098184610Salfred usb2_pc_free_mem(pc); 1099184610Salfred pc++; 1100184610Salfred } 1101184610Salfred 1102184610Salfred /* free DMA maps in all "xfer->frbuffers" */ 1103184610Salfred pc = info->xfer_page_cache_start; 1104184610Salfred while (pc != info->xfer_page_cache_end) { 1105184610Salfred usb2_pc_dmamap_destroy(pc); 1106184610Salfred pc++; 1107184610Salfred } 1108184610Salfred 1109184610Salfred /* free all DMA tags */ 1110184610Salfred usb2_dma_tag_unsetup(&info->dma_parent_tag); 1111190180Sthompsa#endif 1112184610Salfred 1113184610Salfred usb2_cv_destroy(&info->cv_drain); 1114184610Salfred 1115184610Salfred /* 1116184610Salfred * free the "memory_base" last, hence the "info" structure is 1117184610Salfred * contained within the "memory_base"! 1118184610Salfred */ 1119184610Salfred free(info->memory_base, M_USB); 1120184610Salfred} 1121184610Salfred 1122184610Salfred/*------------------------------------------------------------------------* 1123184610Salfred * usb2_transfer_unsetup - unsetup/free an array of USB transfers 1124184610Salfred * 1125184610Salfred * NOTE: All USB transfers in progress will get called back passing 1126184610Salfred * the error code "USB_ERR_CANCELLED" before this function 1127184610Salfred * returns. 1128184610Salfred *------------------------------------------------------------------------*/ 1129184610Salfredvoid 1130184610Salfredusb2_transfer_unsetup(struct usb2_xfer **pxfer, uint16_t n_setup) 1131184610Salfred{ 1132184610Salfred struct usb2_xfer *xfer; 1133184610Salfred struct usb2_xfer_root *info; 1134184610Salfred uint8_t needs_delay = 0; 1135184610Salfred 1136184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1137184610Salfred "usb2_transfer_unsetup can sleep!"); 1138184610Salfred 1139184610Salfred while (n_setup--) { 1140184610Salfred xfer = pxfer[n_setup]; 1141184610Salfred 1142188982Sthompsa if (xfer == NULL) 1143188982Sthompsa continue; 1144184610Salfred 1145188982Sthompsa info = xfer->xroot; 1146184610Salfred 1147188982Sthompsa USB_XFER_LOCK(xfer); 1148188982Sthompsa USB_BUS_LOCK(info->bus); 1149184610Salfred 1150188982Sthompsa /* 1151188982Sthompsa * HINT: when you start/stop a transfer, it might be a 1152188982Sthompsa * good idea to directly use the "pxfer[]" structure: 1153188982Sthompsa * 1154188982Sthompsa * usb2_transfer_start(sc->pxfer[0]); 1155188982Sthompsa * usb2_transfer_stop(sc->pxfer[0]); 1156188982Sthompsa * 1157188982Sthompsa * That way, if your code has many parts that will not 1158188982Sthompsa * stop running under the same lock, in other words 1159188982Sthompsa * "xfer_mtx", the usb2_transfer_start and 1160188982Sthompsa * usb2_transfer_stop functions will simply return 1161188982Sthompsa * when they detect a NULL pointer argument. 1162188982Sthompsa * 1163188982Sthompsa * To avoid any races we clear the "pxfer[]" pointer 1164188982Sthompsa * while holding the private mutex of the driver: 1165188982Sthompsa */ 1166188982Sthompsa pxfer[n_setup] = NULL; 1167184610Salfred 1168188982Sthompsa USB_BUS_UNLOCK(info->bus); 1169188982Sthompsa USB_XFER_UNLOCK(xfer); 1170184610Salfred 1171188982Sthompsa usb2_transfer_drain(xfer); 1172184610Salfred 1173190180Sthompsa#if USB_HAVE_BUSDMA 1174188982Sthompsa if (xfer->flags_int.bdma_enable) 1175188982Sthompsa needs_delay = 1; 1176190180Sthompsa#endif 1177188982Sthompsa /* 1178188982Sthompsa * NOTE: default pipe does not have an 1179188982Sthompsa * interface, even if pipe->iface_index == 0 1180188982Sthompsa */ 1181188982Sthompsa xfer->pipe->refcount--; 1182184610Salfred 1183188982Sthompsa usb2_callout_drain(&xfer->timeout_handle); 1184184610Salfred 1185188982Sthompsa USB_BUS_LOCK(info->bus); 1186184610Salfred 1187188982Sthompsa USB_ASSERT(info->setup_refcount != 0, ("Invalid setup " 1188188982Sthompsa "reference count!\n")); 1189184610Salfred 1190188982Sthompsa info->setup_refcount--; 1191188982Sthompsa 1192188982Sthompsa if (info->setup_refcount == 0) { 1193188982Sthompsa usb2_transfer_unsetup_sub(info, 1194188982Sthompsa needs_delay); 1195188982Sthompsa } else { 1196188982Sthompsa USB_BUS_UNLOCK(info->bus); 1197184610Salfred } 1198184610Salfred } 1199184610Salfred} 1200184610Salfred 1201184610Salfred/*------------------------------------------------------------------------* 1202184610Salfred * usb2_control_transfer_init - factored out code 1203184610Salfred * 1204184610Salfred * In USB Device Mode we have to wait for the SETUP packet which 1205184610Salfred * containst the "struct usb2_device_request" structure, before we can 1206184610Salfred * transfer any data. In USB Host Mode we already have the SETUP 1207184610Salfred * packet at the moment the USB transfer is started. This leads us to 1208184610Salfred * having to setup the USB transfer at two different places in 1209184610Salfred * time. This function just contains factored out control transfer 1210184610Salfred * initialisation code, so that we don't duplicate the code. 1211184610Salfred *------------------------------------------------------------------------*/ 1212184610Salfredstatic void 1213184610Salfredusb2_control_transfer_init(struct usb2_xfer *xfer) 1214184610Salfred{ 1215184610Salfred struct usb2_device_request req; 1216184610Salfred 1217184610Salfred /* copy out the USB request header */ 1218184610Salfred 1219184610Salfred usb2_copy_out(xfer->frbuffers, 0, &req, sizeof(req)); 1220184610Salfred 1221184610Salfred /* setup remainder */ 1222184610Salfred 1223184610Salfred xfer->flags_int.control_rem = UGETW(req.wLength); 1224184610Salfred 1225184610Salfred /* copy direction to endpoint variable */ 1226184610Salfred 1227184610Salfred xfer->endpoint &= ~(UE_DIR_IN | UE_DIR_OUT); 1228184610Salfred xfer->endpoint |= 1229184610Salfred (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT; 1230184610Salfred} 1231184610Salfred 1232184610Salfred/*------------------------------------------------------------------------* 1233184610Salfred * usb2_start_hardware_sub 1234184610Salfred * 1235184610Salfred * This function handles initialisation of control transfers. Control 1236184610Salfred * transfers are special in that regard that they can both transmit 1237184610Salfred * and receive data. 1238184610Salfred * 1239184610Salfred * Return values: 1240184610Salfred * 0: Success 1241184610Salfred * Else: Failure 1242184610Salfred *------------------------------------------------------------------------*/ 1243184610Salfredstatic uint8_t 1244184610Salfredusb2_start_hardware_sub(struct usb2_xfer *xfer) 1245184610Salfred{ 1246190181Sthompsa usb2_frlength_t len; 1247184610Salfred 1248184610Salfred /* Check for control endpoint stall */ 1249184610Salfred if (xfer->flags.stall_pipe) { 1250184610Salfred /* no longer active */ 1251184610Salfred xfer->flags_int.control_act = 0; 1252184610Salfred } 1253190184Sthompsa 1254190184Sthompsa /* Check for invalid number of frames */ 1255190184Sthompsa if (xfer->nframes > 2) { 1256190184Sthompsa /* 1257190184Sthompsa * If you need to split a control transfer, you 1258190184Sthompsa * have to do one part at a time. Only with 1259190184Sthompsa * non-control transfers you can do multiple 1260190184Sthompsa * parts a time. 1261190184Sthompsa */ 1262190184Sthompsa DPRINTFN(0, "Too many frames: %u\n", 1263190184Sthompsa (unsigned int)xfer->nframes); 1264190184Sthompsa goto error; 1265190184Sthompsa } 1266190184Sthompsa 1267184610Salfred /* 1268184610Salfred * Check if there is a control 1269184610Salfred * transfer in progress: 1270184610Salfred */ 1271184610Salfred if (xfer->flags_int.control_act) { 1272184610Salfred 1273184610Salfred if (xfer->flags_int.control_hdr) { 1274184610Salfred 1275184610Salfred /* clear send header flag */ 1276184610Salfred 1277184610Salfred xfer->flags_int.control_hdr = 0; 1278184610Salfred 1279184610Salfred /* setup control transfer */ 1280184610Salfred if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) { 1281184610Salfred usb2_control_transfer_init(xfer); 1282184610Salfred } 1283184610Salfred } 1284184610Salfred /* get data length */ 1285184610Salfred 1286184610Salfred len = xfer->sumlen; 1287184610Salfred 1288184610Salfred } else { 1289184610Salfred 1290184610Salfred /* the size of the SETUP structure is hardcoded ! */ 1291184610Salfred 1292184610Salfred if (xfer->frlengths[0] != sizeof(struct usb2_device_request)) { 1293184610Salfred DPRINTFN(0, "Wrong framelength %u != %zu\n", 1294184610Salfred xfer->frlengths[0], sizeof(struct 1295184610Salfred usb2_device_request)); 1296184610Salfred goto error; 1297184610Salfred } 1298184610Salfred /* check USB mode */ 1299184610Salfred if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) { 1300184610Salfred 1301184610Salfred /* check number of frames */ 1302184610Salfred if (xfer->nframes != 1) { 1303184610Salfred /* 1304184610Salfred * We need to receive the setup 1305184610Salfred * message first so that we know the 1306184610Salfred * data direction! 1307184610Salfred */ 1308184610Salfred DPRINTF("Misconfigured transfer\n"); 1309184610Salfred goto error; 1310184610Salfred } 1311184610Salfred /* 1312184610Salfred * Set a dummy "control_rem" value. This 1313184610Salfred * variable will be overwritten later by a 1314184610Salfred * call to "usb2_control_transfer_init()" ! 1315184610Salfred */ 1316184610Salfred xfer->flags_int.control_rem = 0xFFFF; 1317184610Salfred } else { 1318184610Salfred 1319184610Salfred /* setup "endpoint" and "control_rem" */ 1320184610Salfred 1321184610Salfred usb2_control_transfer_init(xfer); 1322184610Salfred } 1323184610Salfred 1324184610Salfred /* set transfer-header flag */ 1325184610Salfred 1326184610Salfred xfer->flags_int.control_hdr = 1; 1327184610Salfred 1328184610Salfred /* get data length */ 1329184610Salfred 1330184610Salfred len = (xfer->sumlen - sizeof(struct usb2_device_request)); 1331184610Salfred } 1332184610Salfred 1333184610Salfred /* check if there is a length mismatch */ 1334184610Salfred 1335184610Salfred if (len > xfer->flags_int.control_rem) { 1336184610Salfred DPRINTFN(0, "Length greater than remaining length!\n"); 1337184610Salfred goto error; 1338184610Salfred } 1339184610Salfred /* check if we are doing a short transfer */ 1340184610Salfred 1341184610Salfred if (xfer->flags.force_short_xfer) { 1342184610Salfred xfer->flags_int.control_rem = 0; 1343184610Salfred } else { 1344184610Salfred if ((len != xfer->max_data_length) && 1345184610Salfred (len != xfer->flags_int.control_rem) && 1346184610Salfred (xfer->nframes != 1)) { 1347184610Salfred DPRINTFN(0, "Short control transfer without " 1348184610Salfred "force_short_xfer set!\n"); 1349184610Salfred goto error; 1350184610Salfred } 1351184610Salfred xfer->flags_int.control_rem -= len; 1352184610Salfred } 1353184610Salfred 1354184610Salfred /* the status part is executed when "control_act" is 0 */ 1355184610Salfred 1356184610Salfred if ((xfer->flags_int.control_rem > 0) || 1357184610Salfred (xfer->flags.manual_status)) { 1358184610Salfred /* don't execute the STATUS stage yet */ 1359184610Salfred xfer->flags_int.control_act = 1; 1360184610Salfred 1361184610Salfred /* sanity check */ 1362184610Salfred if ((!xfer->flags_int.control_hdr) && 1363184610Salfred (xfer->nframes == 1)) { 1364184610Salfred /* 1365184610Salfred * This is not a valid operation! 1366184610Salfred */ 1367184610Salfred DPRINTFN(0, "Invalid parameter " 1368184610Salfred "combination\n"); 1369184610Salfred goto error; 1370184610Salfred } 1371184610Salfred } else { 1372184610Salfred /* time to execute the STATUS stage */ 1373184610Salfred xfer->flags_int.control_act = 0; 1374184610Salfred } 1375184610Salfred return (0); /* success */ 1376184610Salfred 1377184610Salfrederror: 1378184610Salfred return (1); /* failure */ 1379184610Salfred} 1380184610Salfred 1381184610Salfred/*------------------------------------------------------------------------* 1382184610Salfred * usb2_start_hardware - start USB hardware for the given transfer 1383184610Salfred * 1384184610Salfred * This function should only be called from the USB callback. 1385184610Salfred *------------------------------------------------------------------------*/ 1386184610Salfredvoid 1387184610Salfredusb2_start_hardware(struct usb2_xfer *xfer) 1388184610Salfred{ 1389190181Sthompsa usb2_frcount_t x; 1390184610Salfred 1391184610Salfred DPRINTF("xfer=%p, pipe=%p, nframes=%d, dir=%s\n", 1392184610Salfred xfer, xfer->pipe, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ? 1393184610Salfred "read" : "write"); 1394184610Salfred 1395184610Salfred#if USB_DEBUG 1396184610Salfred if (USB_DEBUG_VAR > 0) { 1397187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1398184610Salfred 1399184610Salfred usb2_dump_pipe(xfer->pipe); 1400184610Salfred 1401187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1402184610Salfred } 1403184610Salfred#endif 1404184610Salfred 1405184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1406187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_NOTOWNED); 1407184610Salfred 1408184610Salfred /* Only open the USB transfer once! */ 1409184610Salfred if (!xfer->flags_int.open) { 1410184610Salfred xfer->flags_int.open = 1; 1411184610Salfred 1412184610Salfred DPRINTF("open\n"); 1413184610Salfred 1414187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1415184610Salfred (xfer->pipe->methods->open) (xfer); 1416187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1417184610Salfred } 1418184610Salfred /* set "transferring" flag */ 1419184610Salfred xfer->flags_int.transferring = 1; 1420184610Salfred 1421186730Salfred /* increment power reference */ 1422186730Salfred usb2_transfer_power_ref(xfer, 1); 1423186730Salfred 1424184610Salfred /* 1425184610Salfred * Check if the transfer is waiting on a queue, most 1426184610Salfred * frequently the "done_q": 1427184610Salfred */ 1428184610Salfred if (xfer->wait_queue) { 1429187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1430184610Salfred usb2_transfer_dequeue(xfer); 1431187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1432184610Salfred } 1433184610Salfred /* clear "did_dma_delay" flag */ 1434184610Salfred xfer->flags_int.did_dma_delay = 0; 1435184610Salfred 1436184610Salfred /* clear "did_close" flag */ 1437184610Salfred xfer->flags_int.did_close = 0; 1438184610Salfred 1439190180Sthompsa#if USB_HAVE_BUSDMA 1440184610Salfred /* clear "bdma_setup" flag */ 1441184610Salfred xfer->flags_int.bdma_setup = 0; 1442190180Sthompsa#endif 1443184610Salfred /* by default we cannot cancel any USB transfer immediately */ 1444184610Salfred xfer->flags_int.can_cancel_immed = 0; 1445184610Salfred 1446184610Salfred /* clear lengths and frame counts by default */ 1447184610Salfred xfer->sumlen = 0; 1448184610Salfred xfer->actlen = 0; 1449184610Salfred xfer->aframes = 0; 1450184610Salfred 1451184610Salfred /* clear any previous errors */ 1452184610Salfred xfer->error = 0; 1453184610Salfred 1454184610Salfred /* sanity check */ 1455184610Salfred 1456184610Salfred if (xfer->nframes == 0) { 1457184610Salfred if (xfer->flags.stall_pipe) { 1458184610Salfred /* 1459184610Salfred * Special case - want to stall without transferring 1460184610Salfred * any data: 1461184610Salfred */ 1462184610Salfred DPRINTF("xfer=%p nframes=0: stall " 1463184610Salfred "or clear stall!\n", xfer); 1464187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1465184610Salfred xfer->flags_int.can_cancel_immed = 1; 1466184610Salfred /* start the transfer */ 1467184610Salfred usb2_command_wrapper(&xfer->pipe->pipe_q, xfer); 1468187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1469184610Salfred return; 1470184610Salfred } 1471187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1472184610Salfred usb2_transfer_done(xfer, USB_ERR_INVAL); 1473187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1474184610Salfred return; 1475184610Salfred } 1476184610Salfred /* compute total transfer length */ 1477184610Salfred 1478184610Salfred for (x = 0; x != xfer->nframes; x++) { 1479184610Salfred xfer->sumlen += xfer->frlengths[x]; 1480184610Salfred if (xfer->sumlen < xfer->frlengths[x]) { 1481184610Salfred /* length wrapped around */ 1482187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1483184610Salfred usb2_transfer_done(xfer, USB_ERR_INVAL); 1484187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1485184610Salfred return; 1486184610Salfred } 1487184610Salfred } 1488184610Salfred 1489184610Salfred /* clear some internal flags */ 1490184610Salfred 1491184610Salfred xfer->flags_int.short_xfer_ok = 0; 1492184610Salfred xfer->flags_int.short_frames_ok = 0; 1493184610Salfred 1494184610Salfred /* check if this is a control transfer */ 1495184610Salfred 1496184610Salfred if (xfer->flags_int.control_xfr) { 1497184610Salfred 1498184610Salfred if (usb2_start_hardware_sub(xfer)) { 1499187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1500184610Salfred usb2_transfer_done(xfer, USB_ERR_STALLED); 1501187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1502184610Salfred return; 1503184610Salfred } 1504184610Salfred } 1505184610Salfred /* 1506184610Salfred * Setup filtered version of some transfer flags, 1507184610Salfred * in case of data read direction 1508184610Salfred */ 1509184610Salfred if (USB_GET_DATA_ISREAD(xfer)) { 1510184610Salfred 1511190184Sthompsa if (xfer->flags.short_frames_ok) { 1512190184Sthompsa xfer->flags_int.short_xfer_ok = 1; 1513190184Sthompsa xfer->flags_int.short_frames_ok = 1; 1514190184Sthompsa } else if (xfer->flags.short_xfer_ok) { 1515190184Sthompsa xfer->flags_int.short_xfer_ok = 1; 1516184610Salfred 1517190184Sthompsa /* check for control transfer */ 1518190184Sthompsa if (xfer->flags_int.control_xfr) { 1519190184Sthompsa /* 1520190184Sthompsa * 1) Control transfers do not support 1521190184Sthompsa * reception of multiple short USB 1522190184Sthompsa * frames in host mode and device side 1523190184Sthompsa * mode, with exception of: 1524190184Sthompsa * 1525190184Sthompsa * 2) Due to sometimes buggy device 1526190184Sthompsa * side firmware we need to do a 1527190184Sthompsa * STATUS stage in case of short 1528190184Sthompsa * control transfers in USB host mode. 1529190184Sthompsa * The STATUS stage then becomes the 1530190184Sthompsa * "alt_next" to the DATA stage. 1531190184Sthompsa */ 1532184610Salfred xfer->flags_int.short_frames_ok = 1; 1533184610Salfred } 1534184610Salfred } 1535184610Salfred } 1536184610Salfred /* 1537184610Salfred * Check if BUS-DMA support is enabled and try to load virtual 1538184610Salfred * buffers into DMA, if any: 1539184610Salfred */ 1540190180Sthompsa#if USB_HAVE_BUSDMA 1541184610Salfred if (xfer->flags_int.bdma_enable) { 1542184610Salfred /* insert the USB transfer last in the BUS-DMA queue */ 1543187173Sthompsa usb2_command_wrapper(&xfer->xroot->dma_q, xfer); 1544184610Salfred return; 1545184610Salfred } 1546190180Sthompsa#endif 1547184610Salfred /* 1548184610Salfred * Enter the USB transfer into the Host Controller or 1549184610Salfred * Device Controller schedule: 1550184610Salfred */ 1551184610Salfred usb2_pipe_enter(xfer); 1552184610Salfred} 1553184610Salfred 1554184610Salfred/*------------------------------------------------------------------------* 1555184610Salfred * usb2_pipe_enter - factored out code 1556184610Salfred *------------------------------------------------------------------------*/ 1557184610Salfredvoid 1558184610Salfredusb2_pipe_enter(struct usb2_xfer *xfer) 1559184610Salfred{ 1560184610Salfred struct usb2_pipe *pipe; 1561184610Salfred 1562184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1563184610Salfred 1564187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1565184610Salfred 1566184610Salfred pipe = xfer->pipe; 1567184610Salfred 1568184610Salfred DPRINTF("enter\n"); 1569184610Salfred 1570184610Salfred /* enter the transfer */ 1571184610Salfred (pipe->methods->enter) (xfer); 1572184610Salfred 1573184610Salfred /* check cancelability */ 1574184610Salfred if (pipe->methods->enter_is_cancelable) { 1575184610Salfred xfer->flags_int.can_cancel_immed = 1; 1576184610Salfred /* check for transfer error */ 1577184610Salfred if (xfer->error) { 1578184610Salfred /* some error has happened */ 1579184610Salfred usb2_transfer_done(xfer, 0); 1580187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1581184610Salfred return; 1582184610Salfred } 1583184610Salfred } else { 1584184610Salfred xfer->flags_int.can_cancel_immed = 0; 1585184610Salfred } 1586184610Salfred 1587184610Salfred /* start the transfer */ 1588184610Salfred usb2_command_wrapper(&pipe->pipe_q, xfer); 1589187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1590184610Salfred} 1591184610Salfred 1592184610Salfred/*------------------------------------------------------------------------* 1593184610Salfred * usb2_transfer_start - start an USB transfer 1594184610Salfred * 1595184610Salfred * NOTE: Calling this function more than one time will only 1596184610Salfred * result in a single transfer start, until the USB transfer 1597184610Salfred * completes. 1598184610Salfred *------------------------------------------------------------------------*/ 1599184610Salfredvoid 1600184610Salfredusb2_transfer_start(struct usb2_xfer *xfer) 1601184610Salfred{ 1602184610Salfred if (xfer == NULL) { 1603184610Salfred /* transfer is gone */ 1604184610Salfred return; 1605184610Salfred } 1606184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1607184610Salfred 1608184610Salfred /* mark the USB transfer started */ 1609184610Salfred 1610184610Salfred if (!xfer->flags_int.started) { 1611184610Salfred xfer->flags_int.started = 1; 1612184610Salfred } 1613184610Salfred /* check if the USB transfer callback is already transferring */ 1614184610Salfred 1615184610Salfred if (xfer->flags_int.transferring) { 1616184610Salfred return; 1617184610Salfred } 1618187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1619184610Salfred /* call the USB transfer callback */ 1620184610Salfred usb2_callback_ss_done_defer(xfer); 1621187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1622184610Salfred} 1623184610Salfred 1624184610Salfred/*------------------------------------------------------------------------* 1625184610Salfred * usb2_transfer_stop - stop an USB transfer 1626184610Salfred * 1627184610Salfred * NOTE: Calling this function more than one time will only 1628184610Salfred * result in a single transfer stop. 1629184610Salfred * NOTE: When this function returns it is not safe to free nor 1630184610Salfred * reuse any DMA buffers. See "usb2_transfer_drain()". 1631184610Salfred *------------------------------------------------------------------------*/ 1632184610Salfredvoid 1633184610Salfredusb2_transfer_stop(struct usb2_xfer *xfer) 1634184610Salfred{ 1635184610Salfred struct usb2_pipe *pipe; 1636184610Salfred 1637184610Salfred if (xfer == NULL) { 1638184610Salfred /* transfer is gone */ 1639184610Salfred return; 1640184610Salfred } 1641184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1642184610Salfred 1643184610Salfred /* check if the USB transfer was ever opened */ 1644184610Salfred 1645184610Salfred if (!xfer->flags_int.open) { 1646184610Salfred /* nothing to do except clearing the "started" flag */ 1647184610Salfred xfer->flags_int.started = 0; 1648184610Salfred return; 1649184610Salfred } 1650184610Salfred /* try to stop the current USB transfer */ 1651184610Salfred 1652187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1653184610Salfred xfer->error = USB_ERR_CANCELLED;/* override any previous error */ 1654184610Salfred /* 1655184610Salfred * Clear "open" and "started" when both private and USB lock 1656184610Salfred * is locked so that we don't get a race updating "flags_int" 1657184610Salfred */ 1658184610Salfred xfer->flags_int.open = 0; 1659184610Salfred xfer->flags_int.started = 0; 1660184610Salfred 1661184610Salfred /* 1662184610Salfred * Check if we can cancel the USB transfer immediately. 1663184610Salfred */ 1664184610Salfred if (xfer->flags_int.transferring) { 1665184610Salfred if (xfer->flags_int.can_cancel_immed && 1666184610Salfred (!xfer->flags_int.did_close)) { 1667184610Salfred DPRINTF("close\n"); 1668184610Salfred /* 1669184610Salfred * The following will lead to an USB_ERR_CANCELLED 1670184610Salfred * error code being passed to the USB callback. 1671184610Salfred */ 1672184610Salfred (xfer->pipe->methods->close) (xfer); 1673184610Salfred /* only close once */ 1674184610Salfred xfer->flags_int.did_close = 1; 1675184610Salfred } else { 1676184610Salfred /* need to wait for the next done callback */ 1677184610Salfred } 1678184610Salfred } else { 1679184610Salfred DPRINTF("close\n"); 1680184610Salfred 1681184610Salfred /* close here and now */ 1682184610Salfred (xfer->pipe->methods->close) (xfer); 1683184610Salfred 1684184610Salfred /* 1685184610Salfred * Any additional DMA delay is done by 1686184610Salfred * "usb2_transfer_unsetup()". 1687184610Salfred */ 1688184610Salfred 1689184610Salfred /* 1690184610Salfred * Special case. Check if we need to restart a blocked 1691184610Salfred * pipe. 1692184610Salfred */ 1693184610Salfred pipe = xfer->pipe; 1694184610Salfred 1695184610Salfred /* 1696184610Salfred * If the current USB transfer is completing we need 1697184610Salfred * to start the next one: 1698184610Salfred */ 1699184610Salfred if (pipe->pipe_q.curr == xfer) { 1700184610Salfred usb2_command_wrapper(&pipe->pipe_q, NULL); 1701184610Salfred } 1702184610Salfred } 1703184610Salfred 1704187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1705184610Salfred} 1706184610Salfred 1707184610Salfred/*------------------------------------------------------------------------* 1708184610Salfred * usb2_transfer_pending 1709184610Salfred * 1710184610Salfred * This function will check if an USB transfer is pending which is a 1711184610Salfred * little bit complicated! 1712184610Salfred * Return values: 1713184610Salfred * 0: Not pending 1714184610Salfred * 1: Pending: The USB transfer will receive a callback in the future. 1715184610Salfred *------------------------------------------------------------------------*/ 1716184610Salfreduint8_t 1717184610Salfredusb2_transfer_pending(struct usb2_xfer *xfer) 1718184610Salfred{ 1719184610Salfred struct usb2_xfer_root *info; 1720184610Salfred struct usb2_xfer_queue *pq; 1721184610Salfred 1722188600Sthompsa if (xfer == NULL) { 1723188600Sthompsa /* transfer is gone */ 1724188600Sthompsa return (0); 1725188600Sthompsa } 1726184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1727184610Salfred 1728184610Salfred if (xfer->flags_int.transferring) { 1729184610Salfred /* trivial case */ 1730184610Salfred return (1); 1731184610Salfred } 1732187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1733184610Salfred if (xfer->wait_queue) { 1734184610Salfred /* we are waiting on a queue somewhere */ 1735187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1736184610Salfred return (1); 1737184610Salfred } 1738187173Sthompsa info = xfer->xroot; 1739184610Salfred pq = &info->done_q; 1740184610Salfred 1741184610Salfred if (pq->curr == xfer) { 1742184610Salfred /* we are currently scheduled for callback */ 1743187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1744184610Salfred return (1); 1745184610Salfred } 1746184610Salfred /* we are not pending */ 1747187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1748184610Salfred return (0); 1749184610Salfred} 1750184610Salfred 1751184610Salfred/*------------------------------------------------------------------------* 1752184610Salfred * usb2_transfer_drain 1753184610Salfred * 1754184610Salfred * This function will stop the USB transfer and wait for any 1755184610Salfred * additional BUS-DMA and HW-DMA operations to complete. Buffers that 1756184610Salfred * are loaded into DMA can safely be freed or reused after that this 1757184610Salfred * function has returned. 1758184610Salfred *------------------------------------------------------------------------*/ 1759184610Salfredvoid 1760184610Salfredusb2_transfer_drain(struct usb2_xfer *xfer) 1761184610Salfred{ 1762184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1763184610Salfred "usb2_transfer_drain can sleep!"); 1764184610Salfred 1765184610Salfred if (xfer == NULL) { 1766184610Salfred /* transfer is gone */ 1767184610Salfred return; 1768184610Salfred } 1769187173Sthompsa if (xfer->xroot->xfer_mtx != &Giant) { 1770184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED); 1771184610Salfred } 1772184824Sthompsa USB_XFER_LOCK(xfer); 1773184610Salfred 1774184610Salfred usb2_transfer_stop(xfer); 1775184610Salfred 1776184610Salfred while (usb2_transfer_pending(xfer)) { 1777184610Salfred xfer->flags_int.draining = 1; 1778184610Salfred /* 1779184610Salfred * Wait until the current outstanding USB 1780184610Salfred * transfer is complete ! 1781184610Salfred */ 1782187173Sthompsa usb2_cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx); 1783184610Salfred } 1784184824Sthompsa USB_XFER_UNLOCK(xfer); 1785184610Salfred} 1786184610Salfred 1787184610Salfred/*------------------------------------------------------------------------* 1788184610Salfred * usb2_set_frame_data 1789184610Salfred * 1790184610Salfred * This function sets the pointer of the buffer that should 1791184610Salfred * loaded directly into DMA for the given USB frame. Passing "ptr" 1792184610Salfred * equal to NULL while the corresponding "frlength" is greater 1793184610Salfred * than zero gives undefined results! 1794184610Salfred *------------------------------------------------------------------------*/ 1795184610Salfredvoid 1796190181Sthompsausb2_set_frame_data(struct usb2_xfer *xfer, void *ptr, usb2_frcount_t frindex) 1797184610Salfred{ 1798184610Salfred /* set virtual address to load and length */ 1799184610Salfred xfer->frbuffers[frindex].buffer = ptr; 1800184610Salfred} 1801184610Salfred 1802184610Salfred/*------------------------------------------------------------------------* 1803184610Salfred * usb2_set_frame_offset 1804184610Salfred * 1805184610Salfred * This function sets the frame data buffer offset relative to the beginning 1806184610Salfred * of the USB DMA buffer allocated for this USB transfer. 1807184610Salfred *------------------------------------------------------------------------*/ 1808184610Salfredvoid 1809190181Sthompsausb2_set_frame_offset(struct usb2_xfer *xfer, usb2_frlength_t offset, 1810190181Sthompsa usb2_frcount_t frindex) 1811184610Salfred{ 1812184610Salfred USB_ASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame " 1813184610Salfred "when the USB buffer is external!\n")); 1814184610Salfred 1815184610Salfred /* set virtual address to load */ 1816184610Salfred xfer->frbuffers[frindex].buffer = 1817184610Salfred USB_ADD_BYTES(xfer->local_buffer, offset); 1818184610Salfred} 1819184610Salfred 1820184610Salfred/*------------------------------------------------------------------------* 1821184610Salfred * usb2_callback_proc - factored out code 1822184610Salfred * 1823184610Salfred * This function performs USB callbacks. 1824184610Salfred *------------------------------------------------------------------------*/ 1825184610Salfredstatic void 1826184610Salfredusb2_callback_proc(struct usb2_proc_msg *_pm) 1827184610Salfred{ 1828184610Salfred struct usb2_done_msg *pm = (void *)_pm; 1829187173Sthompsa struct usb2_xfer_root *info = pm->xroot; 1830184610Salfred 1831184610Salfred /* Change locking order */ 1832184824Sthompsa USB_BUS_UNLOCK(info->bus); 1833184610Salfred 1834184610Salfred /* 1835184610Salfred * We exploit the fact that the mutex is the same for all 1836184610Salfred * callbacks that will be called from this thread: 1837184610Salfred */ 1838187173Sthompsa mtx_lock(info->xfer_mtx); 1839184824Sthompsa USB_BUS_LOCK(info->bus); 1840184610Salfred 1841184610Salfred /* Continue where we lost track */ 1842184610Salfred usb2_command_wrapper(&info->done_q, 1843184610Salfred info->done_q.curr); 1844184610Salfred 1845187173Sthompsa mtx_unlock(info->xfer_mtx); 1846184610Salfred} 1847184610Salfred 1848184610Salfred/*------------------------------------------------------------------------* 1849184610Salfred * usb2_callback_ss_done_defer 1850184610Salfred * 1851184610Salfred * This function will defer the start, stop and done callback to the 1852184610Salfred * correct thread. 1853184610Salfred *------------------------------------------------------------------------*/ 1854184610Salfredstatic void 1855184610Salfredusb2_callback_ss_done_defer(struct usb2_xfer *xfer) 1856184610Salfred{ 1857187173Sthompsa struct usb2_xfer_root *info = xfer->xroot; 1858184610Salfred struct usb2_xfer_queue *pq = &info->done_q; 1859184610Salfred 1860187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1861184824Sthompsa 1862184610Salfred if (pq->curr != xfer) { 1863184610Salfred usb2_transfer_enqueue(pq, xfer); 1864184610Salfred } 1865184610Salfred if (!pq->recurse_1) { 1866184610Salfred 1867184610Salfred /* 1868184610Salfred * We have to postpone the callback due to the fact we 1869184610Salfred * will have a Lock Order Reversal, LOR, if we try to 1870184610Salfred * proceed ! 1871184610Salfred */ 1872187174Sthompsa if (usb2_proc_msignal(info->done_p, 1873184610Salfred &info->done_m[0], &info->done_m[1])) { 1874184610Salfred /* ignore */ 1875184610Salfred } 1876184610Salfred } else { 1877184610Salfred /* clear second recurse flag */ 1878184610Salfred pq->recurse_2 = 0; 1879184610Salfred } 1880184610Salfred return; 1881184610Salfred 1882184610Salfred} 1883184610Salfred 1884184610Salfred/*------------------------------------------------------------------------* 1885184610Salfred * usb2_callback_wrapper 1886184610Salfred * 1887184610Salfred * This is a wrapper for USB callbacks. This wrapper does some 1888184610Salfred * auto-magic things like figuring out if we can call the callback 1889184610Salfred * directly from the current context or if we need to wakeup the 1890184610Salfred * interrupt process. 1891184610Salfred *------------------------------------------------------------------------*/ 1892184610Salfredstatic void 1893184610Salfredusb2_callback_wrapper(struct usb2_xfer_queue *pq) 1894184610Salfred{ 1895184610Salfred struct usb2_xfer *xfer = pq->curr; 1896187173Sthompsa struct usb2_xfer_root *info = xfer->xroot; 1897184610Salfred 1898187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1899187173Sthompsa if (!mtx_owned(xfer->xroot->xfer_mtx)) { 1900184610Salfred /* 1901184610Salfred * Cases that end up here: 1902184610Salfred * 1903184610Salfred * 5) HW interrupt done callback or other source. 1904184610Salfred */ 1905184610Salfred DPRINTFN(3, "case 5\n"); 1906184610Salfred 1907184610Salfred /* 1908184610Salfred * We have to postpone the callback due to the fact we 1909184610Salfred * will have a Lock Order Reversal, LOR, if we try to 1910184610Salfred * proceed ! 1911184610Salfred */ 1912187174Sthompsa if (usb2_proc_msignal(info->done_p, 1913184610Salfred &info->done_m[0], &info->done_m[1])) { 1914184610Salfred /* ignore */ 1915184610Salfred } 1916184610Salfred return; 1917184610Salfred } 1918184610Salfred /* 1919184610Salfred * Cases that end up here: 1920184610Salfred * 1921184610Salfred * 1) We are starting a transfer 1922184610Salfred * 2) We are prematurely calling back a transfer 1923184610Salfred * 3) We are stopping a transfer 1924184610Salfred * 4) We are doing an ordinary callback 1925184610Salfred */ 1926184610Salfred DPRINTFN(3, "case 1-4\n"); 1927184610Salfred /* get next USB transfer in the queue */ 1928184610Salfred info->done_q.curr = NULL; 1929184610Salfred 1930187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1931187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_NOTOWNED); 1932184610Salfred 1933184610Salfred /* set correct USB state for callback */ 1934184610Salfred if (!xfer->flags_int.transferring) { 1935184610Salfred xfer->usb2_state = USB_ST_SETUP; 1936184610Salfred if (!xfer->flags_int.started) { 1937184610Salfred /* we got stopped before we even got started */ 1938187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1939184610Salfred goto done; 1940184610Salfred } 1941184610Salfred } else { 1942184610Salfred 1943184610Salfred if (usb2_callback_wrapper_sub(xfer)) { 1944184610Salfred /* the callback has been deferred */ 1945187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1946184610Salfred goto done; 1947184610Salfred } 1948186730Salfred /* decrement power reference */ 1949186730Salfred usb2_transfer_power_ref(xfer, -1); 1950186730Salfred 1951184610Salfred xfer->flags_int.transferring = 0; 1952184610Salfred 1953184610Salfred if (xfer->error) { 1954184610Salfred xfer->usb2_state = USB_ST_ERROR; 1955184610Salfred } else { 1956184610Salfred /* set transferred state */ 1957184610Salfred xfer->usb2_state = USB_ST_TRANSFERRED; 1958190180Sthompsa#if USB_HAVE_BUSDMA 1959184610Salfred /* sync DMA memory, if any */ 1960184610Salfred if (xfer->flags_int.bdma_enable && 1961184610Salfred (!xfer->flags_int.bdma_no_post_sync)) { 1962184610Salfred usb2_bdma_post_sync(xfer); 1963184610Salfred } 1964190180Sthompsa#endif 1965184610Salfred } 1966184610Salfred } 1967184610Salfred 1968184610Salfred /* call processing routine */ 1969184610Salfred (xfer->callback) (xfer); 1970184610Salfred 1971184610Salfred /* pickup the USB mutex again */ 1972187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1973184610Salfred 1974184610Salfred /* 1975184610Salfred * Check if we got started after that we got cancelled, but 1976187166Sthompsa * before we managed to do the callback. 1977184610Salfred */ 1978184610Salfred if ((!xfer->flags_int.open) && 1979184610Salfred (xfer->flags_int.started) && 1980184610Salfred (xfer->usb2_state == USB_ST_ERROR)) { 1981184610Salfred /* try to loop, but not recursivly */ 1982184610Salfred usb2_command_wrapper(&info->done_q, xfer); 1983184610Salfred return; 1984187166Sthompsa } 1985187166Sthompsa 1986187166Sthompsadone: 1987187166Sthompsa /* 1988187166Sthompsa * Check if we are draining. 1989187166Sthompsa */ 1990187166Sthompsa if (xfer->flags_int.draining && 1991184610Salfred (!xfer->flags_int.transferring)) { 1992184610Salfred /* "usb2_transfer_drain()" is waiting for end of transfer */ 1993184610Salfred xfer->flags_int.draining = 0; 1994187173Sthompsa usb2_cv_broadcast(&xfer->xroot->cv_drain); 1995184610Salfred } 1996187166Sthompsa 1997184610Salfred /* do the next callback, if any */ 1998184610Salfred usb2_command_wrapper(&info->done_q, 1999184610Salfred info->done_q.curr); 2000184610Salfred} 2001184610Salfred 2002184610Salfred/*------------------------------------------------------------------------* 2003184610Salfred * usb2_dma_delay_done_cb 2004184610Salfred * 2005184610Salfred * This function is called when the DMA delay has been exectuded, and 2006184610Salfred * will make sure that the callback is called to complete the USB 2007184610Salfred * transfer. This code path is ususally only used when there is an USB 2008184610Salfred * error like USB_ERR_CANCELLED. 2009184610Salfred *------------------------------------------------------------------------*/ 2010184610Salfredstatic void 2011184610Salfredusb2_dma_delay_done_cb(void *arg) 2012184610Salfred{ 2013184610Salfred struct usb2_xfer *xfer = arg; 2014184610Salfred 2015187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2016184610Salfred 2017184610Salfred DPRINTFN(3, "Completed %p\n", xfer); 2018184610Salfred 2019184610Salfred /* queue callback for execution, again */ 2020184610Salfred usb2_transfer_done(xfer, 0); 2021184610Salfred} 2022184610Salfred 2023184610Salfred/*------------------------------------------------------------------------* 2024184610Salfred * usb2_transfer_dequeue 2025184610Salfred * 2026184610Salfred * - This function is used to remove an USB transfer from a USB 2027184610Salfred * transfer queue. 2028184610Salfred * 2029184610Salfred * - This function can be called multiple times in a row. 2030184610Salfred *------------------------------------------------------------------------*/ 2031184610Salfredvoid 2032184610Salfredusb2_transfer_dequeue(struct usb2_xfer *xfer) 2033184610Salfred{ 2034184610Salfred struct usb2_xfer_queue *pq; 2035184610Salfred 2036184610Salfred pq = xfer->wait_queue; 2037184610Salfred if (pq) { 2038184610Salfred TAILQ_REMOVE(&pq->head, xfer, wait_entry); 2039184610Salfred xfer->wait_queue = NULL; 2040184610Salfred } 2041184610Salfred} 2042184610Salfred 2043184610Salfred/*------------------------------------------------------------------------* 2044184610Salfred * usb2_transfer_enqueue 2045184610Salfred * 2046184610Salfred * - This function is used to insert an USB transfer into a USB * 2047184610Salfred * transfer queue. 2048184610Salfred * 2049184610Salfred * - This function can be called multiple times in a row. 2050184610Salfred *------------------------------------------------------------------------*/ 2051184610Salfredvoid 2052184610Salfredusb2_transfer_enqueue(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer) 2053184610Salfred{ 2054184610Salfred /* 2055184610Salfred * Insert the USB transfer into the queue, if it is not 2056184610Salfred * already on a USB transfer queue: 2057184610Salfred */ 2058184610Salfred if (xfer->wait_queue == NULL) { 2059184610Salfred xfer->wait_queue = pq; 2060184610Salfred TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry); 2061184610Salfred } 2062184610Salfred} 2063184610Salfred 2064184610Salfred/*------------------------------------------------------------------------* 2065184610Salfred * usb2_transfer_done 2066184610Salfred * 2067184610Salfred * - This function is used to remove an USB transfer from the busdma, 2068184610Salfred * pipe or interrupt queue. 2069184610Salfred * 2070184610Salfred * - This function is used to queue the USB transfer on the done 2071184610Salfred * queue. 2072184610Salfred * 2073184610Salfred * - This function is used to stop any USB transfer timeouts. 2074184610Salfred *------------------------------------------------------------------------*/ 2075184610Salfredvoid 2076184610Salfredusb2_transfer_done(struct usb2_xfer *xfer, usb2_error_t error) 2077184610Salfred{ 2078187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2079184610Salfred 2080184610Salfred DPRINTF("err=%s\n", usb2_errstr(error)); 2081184610Salfred 2082184610Salfred /* 2083184610Salfred * If we are not transferring then just return. 2084184610Salfred * This can happen during transfer cancel. 2085184610Salfred */ 2086184610Salfred if (!xfer->flags_int.transferring) { 2087184610Salfred DPRINTF("not transferring\n"); 2088184610Salfred return; 2089184610Salfred } 2090184610Salfred /* only set transfer error if not already set */ 2091184610Salfred if (!xfer->error) { 2092184610Salfred xfer->error = error; 2093184610Salfred } 2094184610Salfred /* stop any callouts */ 2095184610Salfred usb2_callout_stop(&xfer->timeout_handle); 2096184610Salfred 2097184610Salfred /* 2098184610Salfred * If we are waiting on a queue, just remove the USB transfer 2099184610Salfred * from the queue, if any. We should have the required locks 2100184610Salfred * locked to do the remove when this function is called. 2101184610Salfred */ 2102184610Salfred usb2_transfer_dequeue(xfer); 2103184610Salfred 2104190180Sthompsa#if USB_HAVE_BUSDMA 2105187173Sthompsa if (mtx_owned(xfer->xroot->xfer_mtx)) { 2106190180Sthompsa struct usb2_xfer_queue *pq; 2107190180Sthompsa 2108184610Salfred /* 2109184610Salfred * If the private USB lock is not locked, then we assume 2110184610Salfred * that the BUS-DMA load stage has been passed: 2111184610Salfred */ 2112187173Sthompsa pq = &xfer->xroot->dma_q; 2113184610Salfred 2114184610Salfred if (pq->curr == xfer) { 2115184610Salfred /* start the next BUS-DMA load, if any */ 2116184610Salfred usb2_command_wrapper(pq, NULL); 2117184610Salfred } 2118184610Salfred } 2119190180Sthompsa#endif 2120184610Salfred /* keep some statistics */ 2121184610Salfred if (xfer->error) { 2122187173Sthompsa xfer->xroot->bus->stats_err.uds_requests 2123184610Salfred [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++; 2124184610Salfred } else { 2125187173Sthompsa xfer->xroot->bus->stats_ok.uds_requests 2126184610Salfred [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++; 2127184610Salfred } 2128184610Salfred 2129184610Salfred /* call the USB transfer callback */ 2130184610Salfred usb2_callback_ss_done_defer(xfer); 2131184610Salfred} 2132184610Salfred 2133184610Salfred/*------------------------------------------------------------------------* 2134184610Salfred * usb2_transfer_start_cb 2135184610Salfred * 2136184610Salfred * This function is called to start the USB transfer when 2137184610Salfred * "xfer->interval" is greater than zero, and and the endpoint type is 2138184610Salfred * BULK or CONTROL. 2139184610Salfred *------------------------------------------------------------------------*/ 2140184610Salfredstatic void 2141184610Salfredusb2_transfer_start_cb(void *arg) 2142184610Salfred{ 2143184610Salfred struct usb2_xfer *xfer = arg; 2144184610Salfred struct usb2_pipe *pipe = xfer->pipe; 2145184610Salfred 2146187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2147184610Salfred 2148184610Salfred DPRINTF("start\n"); 2149184610Salfred 2150184610Salfred /* start the transfer */ 2151184610Salfred (pipe->methods->start) (xfer); 2152184610Salfred 2153184610Salfred /* check cancelability */ 2154184610Salfred if (pipe->methods->start_is_cancelable) { 2155184610Salfred xfer->flags_int.can_cancel_immed = 1; 2156184610Salfred if (xfer->error) { 2157184610Salfred /* some error has happened */ 2158184610Salfred usb2_transfer_done(xfer, 0); 2159184610Salfred } 2160184610Salfred } else { 2161184610Salfred xfer->flags_int.can_cancel_immed = 0; 2162184610Salfred } 2163184610Salfred} 2164184610Salfred 2165184610Salfred/*------------------------------------------------------------------------* 2166184610Salfred * usb2_transfer_set_stall 2167184610Salfred * 2168184610Salfred * This function is used to set the stall flag outside the 2169184610Salfred * callback. This function is NULL safe. 2170184610Salfred *------------------------------------------------------------------------*/ 2171184610Salfredvoid 2172184610Salfredusb2_transfer_set_stall(struct usb2_xfer *xfer) 2173184610Salfred{ 2174184610Salfred if (xfer == NULL) { 2175184610Salfred /* tearing down */ 2176184610Salfred return; 2177184610Salfred } 2178184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2179184610Salfred 2180184610Salfred /* avoid any races by locking the USB mutex */ 2181187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2182184610Salfred 2183184610Salfred xfer->flags.stall_pipe = 1; 2184184610Salfred 2185187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2186184610Salfred} 2187184610Salfred 2188184610Salfred/*------------------------------------------------------------------------* 2189184610Salfred * usb2_transfer_clear_stall 2190184610Salfred * 2191184610Salfred * This function is used to clear the stall flag outside the 2192184610Salfred * callback. This function is NULL safe. 2193184610Salfred *------------------------------------------------------------------------*/ 2194184610Salfredvoid 2195184610Salfredusb2_transfer_clear_stall(struct usb2_xfer *xfer) 2196184610Salfred{ 2197184610Salfred if (xfer == NULL) { 2198184610Salfred /* tearing down */ 2199184610Salfred return; 2200184610Salfred } 2201184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2202184610Salfred 2203184610Salfred /* avoid any races by locking the USB mutex */ 2204187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2205184610Salfred 2206184610Salfred xfer->flags.stall_pipe = 0; 2207184610Salfred 2208187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2209184610Salfred} 2210184610Salfred 2211184610Salfred/*------------------------------------------------------------------------* 2212184610Salfred * usb2_pipe_start 2213184610Salfred * 2214184610Salfred * This function is used to add an USB transfer to the pipe transfer list. 2215184610Salfred *------------------------------------------------------------------------*/ 2216184610Salfredvoid 2217184610Salfredusb2_pipe_start(struct usb2_xfer_queue *pq) 2218184610Salfred{ 2219184610Salfred struct usb2_pipe *pipe; 2220184610Salfred struct usb2_xfer *xfer; 2221184610Salfred uint8_t type; 2222184610Salfred 2223184610Salfred xfer = pq->curr; 2224184610Salfred pipe = xfer->pipe; 2225184610Salfred 2226187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2227184610Salfred 2228184610Salfred /* 2229184610Salfred * If the pipe is already stalled we do nothing ! 2230184610Salfred */ 2231184610Salfred if (pipe->is_stalled) { 2232184610Salfred return; 2233184610Salfred } 2234184610Salfred /* 2235184610Salfred * Check if we are supposed to stall the pipe: 2236184610Salfred */ 2237184610Salfred if (xfer->flags.stall_pipe) { 2238184610Salfred /* clear stall command */ 2239184610Salfred xfer->flags.stall_pipe = 0; 2240184610Salfred 2241184610Salfred /* 2242184610Salfred * Only stall BULK and INTERRUPT endpoints. 2243184610Salfred */ 2244184610Salfred type = (pipe->edesc->bmAttributes & UE_XFERTYPE); 2245184610Salfred if ((type == UE_BULK) || 2246184610Salfred (type == UE_INTERRUPT)) { 2247184610Salfred struct usb2_device *udev; 2248184610Salfred struct usb2_xfer_root *info; 2249184610Salfred 2250187173Sthompsa info = xfer->xroot; 2251187173Sthompsa udev = info->udev; 2252184610Salfred pipe->is_stalled = 1; 2253184610Salfred 2254184610Salfred if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 2255184610Salfred (udev->bus->methods->set_stall) ( 2256184610Salfred udev, NULL, pipe); 2257184610Salfred } else if (udev->default_xfer[1]) { 2258187173Sthompsa info = udev->default_xfer[1]->xroot; 2259187174Sthompsa if (usb2_proc_msignal( 2260187174Sthompsa &info->bus->non_giant_callback_proc, 2261184610Salfred &udev->cs_msg[0], &udev->cs_msg[1])) { 2262184610Salfred /* ignore */ 2263184610Salfred } 2264184610Salfred } else { 2265184610Salfred /* should not happen */ 2266184610Salfred DPRINTFN(0, "No stall handler!\n"); 2267184610Salfred } 2268184610Salfred /* 2269184610Salfred * We get started again when the stall is cleared! 2270184610Salfred */ 2271184610Salfred return; 2272184610Salfred } 2273184610Salfred } 2274184610Salfred /* Set or clear stall complete - special case */ 2275184610Salfred if (xfer->nframes == 0) { 2276184610Salfred /* we are complete */ 2277184610Salfred xfer->aframes = 0; 2278184610Salfred usb2_transfer_done(xfer, 0); 2279184610Salfred return; 2280184610Salfred } 2281184610Salfred /* 2282184610Salfred * Handled cases: 2283184610Salfred * 2284184610Salfred * 1) Start the first transfer queued. 2285184610Salfred * 2286184610Salfred * 2) Re-start the current USB transfer. 2287184610Salfred */ 2288184610Salfred /* 2289184610Salfred * Check if there should be any 2290184610Salfred * pre transfer start delay: 2291184610Salfred */ 2292184610Salfred if (xfer->interval > 0) { 2293184610Salfred type = (pipe->edesc->bmAttributes & UE_XFERTYPE); 2294184610Salfred if ((type == UE_BULK) || 2295184610Salfred (type == UE_CONTROL)) { 2296184610Salfred usb2_transfer_timeout_ms(xfer, 2297184610Salfred &usb2_transfer_start_cb, 2298184610Salfred xfer->interval); 2299184610Salfred return; 2300184610Salfred } 2301184610Salfred } 2302184610Salfred DPRINTF("start\n"); 2303184610Salfred 2304184610Salfred /* start USB transfer */ 2305184610Salfred (pipe->methods->start) (xfer); 2306184610Salfred 2307184610Salfred /* check cancelability */ 2308184610Salfred if (pipe->methods->start_is_cancelable) { 2309184610Salfred xfer->flags_int.can_cancel_immed = 1; 2310184610Salfred if (xfer->error) { 2311184610Salfred /* some error has happened */ 2312184610Salfred usb2_transfer_done(xfer, 0); 2313184610Salfred } 2314184610Salfred } else { 2315184610Salfred xfer->flags_int.can_cancel_immed = 0; 2316184610Salfred } 2317184610Salfred} 2318184610Salfred 2319184610Salfred/*------------------------------------------------------------------------* 2320184610Salfred * usb2_transfer_timeout_ms 2321184610Salfred * 2322184610Salfred * This function is used to setup a timeout on the given USB 2323184610Salfred * transfer. If the timeout has been deferred the callback given by 2324184610Salfred * "cb" will get called after "ms" milliseconds. 2325184610Salfred *------------------------------------------------------------------------*/ 2326184610Salfredvoid 2327184610Salfredusb2_transfer_timeout_ms(struct usb2_xfer *xfer, 2328190181Sthompsa void (*cb) (void *arg), usb2_timeout_t ms) 2329184610Salfred{ 2330187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2331184610Salfred 2332184610Salfred /* defer delay */ 2333184610Salfred usb2_callout_reset(&xfer->timeout_handle, 2334184610Salfred USB_MS_TO_TICKS(ms), cb, xfer); 2335184610Salfred} 2336184610Salfred 2337184610Salfred/*------------------------------------------------------------------------* 2338184610Salfred * usb2_callback_wrapper_sub 2339184610Salfred * 2340184610Salfred * - This function will update variables in an USB transfer after 2341184610Salfred * that the USB transfer is complete. 2342184610Salfred * 2343184610Salfred * - This function is used to start the next USB transfer on the 2344184610Salfred * pipe transfer queue, if any. 2345184610Salfred * 2346184610Salfred * NOTE: In some special cases the USB transfer will not be removed from 2347184610Salfred * the pipe queue, but remain first. To enforce USB transfer removal call 2348184610Salfred * this function passing the error code "USB_ERR_CANCELLED". 2349184610Salfred * 2350184610Salfred * Return values: 2351184610Salfred * 0: Success. 2352184610Salfred * Else: The callback has been deferred. 2353184610Salfred *------------------------------------------------------------------------*/ 2354184610Salfredstatic uint8_t 2355184610Salfredusb2_callback_wrapper_sub(struct usb2_xfer *xfer) 2356184610Salfred{ 2357184610Salfred struct usb2_pipe *pipe; 2358190181Sthompsa usb2_frcount_t x; 2359184610Salfred 2360184610Salfred if ((!xfer->flags_int.open) && 2361184610Salfred (!xfer->flags_int.did_close)) { 2362184610Salfred DPRINTF("close\n"); 2363187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2364184610Salfred (xfer->pipe->methods->close) (xfer); 2365187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2366184610Salfred /* only close once */ 2367184610Salfred xfer->flags_int.did_close = 1; 2368184610Salfred return (1); /* wait for new callback */ 2369184610Salfred } 2370184610Salfred /* 2371184610Salfred * If we have a non-hardware induced error we 2372184610Salfred * need to do the DMA delay! 2373184610Salfred */ 2374184610Salfred if (((xfer->error == USB_ERR_CANCELLED) || 2375184610Salfred (xfer->error == USB_ERR_TIMEOUT)) && 2376184610Salfred (!xfer->flags_int.did_dma_delay)) { 2377184610Salfred 2378190181Sthompsa usb2_timeout_t temp; 2379184610Salfred 2380184610Salfred /* only delay once */ 2381184610Salfred xfer->flags_int.did_dma_delay = 1; 2382184610Salfred 2383184610Salfred /* we can not cancel this delay */ 2384184610Salfred xfer->flags_int.can_cancel_immed = 0; 2385184610Salfred 2386187173Sthompsa temp = usb2_get_dma_delay(xfer->xroot->bus); 2387184610Salfred 2388184610Salfred DPRINTFN(3, "DMA delay, %u ms, " 2389184610Salfred "on %p\n", temp, xfer); 2390184610Salfred 2391184610Salfred if (temp != 0) { 2392187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2393184610Salfred usb2_transfer_timeout_ms(xfer, 2394184610Salfred &usb2_dma_delay_done_cb, temp); 2395187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2396184610Salfred return (1); /* wait for new callback */ 2397184610Salfred } 2398184610Salfred } 2399184610Salfred /* check actual number of frames */ 2400184610Salfred if (xfer->aframes > xfer->nframes) { 2401184610Salfred if (xfer->error == 0) { 2402184610Salfred panic("%s: actual number of frames, %d, is " 2403184610Salfred "greater than initial number of frames, %d!\n", 2404184610Salfred __FUNCTION__, xfer->aframes, xfer->nframes); 2405184610Salfred } else { 2406184610Salfred /* just set some valid value */ 2407184610Salfred xfer->aframes = xfer->nframes; 2408184610Salfred } 2409184610Salfred } 2410184610Salfred /* compute actual length */ 2411184610Salfred xfer->actlen = 0; 2412184610Salfred 2413184610Salfred for (x = 0; x != xfer->aframes; x++) { 2414184610Salfred xfer->actlen += xfer->frlengths[x]; 2415184610Salfred } 2416184610Salfred 2417184610Salfred /* 2418184610Salfred * Frames that were not transferred get zero actual length in 2419184610Salfred * case the USB device driver does not check the actual number 2420184610Salfred * of frames transferred, "xfer->aframes": 2421184610Salfred */ 2422184610Salfred for (; x < xfer->nframes; x++) { 2423184610Salfred xfer->frlengths[x] = 0; 2424184610Salfred } 2425184610Salfred 2426184610Salfred /* check actual length */ 2427184610Salfred if (xfer->actlen > xfer->sumlen) { 2428184610Salfred if (xfer->error == 0) { 2429184610Salfred panic("%s: actual length, %d, is greater than " 2430184610Salfred "initial length, %d!\n", 2431184610Salfred __FUNCTION__, xfer->actlen, xfer->sumlen); 2432184610Salfred } else { 2433184610Salfred /* just set some valid value */ 2434184610Salfred xfer->actlen = xfer->sumlen; 2435184610Salfred } 2436184610Salfred } 2437184610Salfred DPRINTFN(6, "xfer=%p pipe=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n", 2438184610Salfred xfer, xfer->pipe, xfer->error, xfer->actlen, xfer->sumlen, 2439184610Salfred xfer->aframes, xfer->nframes); 2440184610Salfred 2441184610Salfred if (xfer->error) { 2442184610Salfred /* end of control transfer, if any */ 2443184610Salfred xfer->flags_int.control_act = 0; 2444184610Salfred 2445184610Salfred /* check if we should block the execution queue */ 2446184610Salfred if ((xfer->error != USB_ERR_CANCELLED) && 2447184610Salfred (xfer->flags.pipe_bof)) { 2448184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure " 2449184610Salfred "on pipe=%p\n", xfer, xfer->pipe); 2450184610Salfred goto done; 2451184610Salfred } 2452184610Salfred } else { 2453184610Salfred /* check for short transfers */ 2454184610Salfred if (xfer->actlen < xfer->sumlen) { 2455184610Salfred 2456184610Salfred /* end of control transfer, if any */ 2457184610Salfred xfer->flags_int.control_act = 0; 2458184610Salfred 2459184610Salfred if (!xfer->flags_int.short_xfer_ok) { 2460184610Salfred xfer->error = USB_ERR_SHORT_XFER; 2461184610Salfred if (xfer->flags.pipe_bof) { 2462184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure on " 2463184610Salfred "Short Transfer on pipe %p.\n", 2464184610Salfred xfer, xfer->pipe); 2465184610Salfred goto done; 2466184610Salfred } 2467184610Salfred } 2468184610Salfred } else { 2469184610Salfred /* 2470184610Salfred * Check if we are in the middle of a 2471184610Salfred * control transfer: 2472184610Salfred */ 2473184610Salfred if (xfer->flags_int.control_act) { 2474184610Salfred DPRINTFN(5, "xfer=%p: Control transfer " 2475184610Salfred "active on pipe=%p\n", xfer, xfer->pipe); 2476184610Salfred goto done; 2477184610Salfred } 2478184610Salfred } 2479184610Salfred } 2480184610Salfred 2481184610Salfred pipe = xfer->pipe; 2482184610Salfred 2483184610Salfred /* 2484184610Salfred * If the current USB transfer is completing we need to start the 2485184610Salfred * next one: 2486184610Salfred */ 2487187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2488184610Salfred if (pipe->pipe_q.curr == xfer) { 2489184610Salfred usb2_command_wrapper(&pipe->pipe_q, NULL); 2490184610Salfred 2491184610Salfred if (pipe->pipe_q.curr || TAILQ_FIRST(&pipe->pipe_q.head)) { 2492184610Salfred /* there is another USB transfer waiting */ 2493184610Salfred } else { 2494184610Salfred /* this is the last USB transfer */ 2495184610Salfred /* clear isochronous sync flag */ 2496184610Salfred xfer->pipe->is_synced = 0; 2497184610Salfred } 2498184610Salfred } 2499187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2500184610Salfreddone: 2501184610Salfred return (0); 2502184610Salfred} 2503184610Salfred 2504184610Salfred/*------------------------------------------------------------------------* 2505184610Salfred * usb2_command_wrapper 2506184610Salfred * 2507184610Salfred * This function is used to execute commands non-recursivly on an USB 2508184610Salfred * transfer. 2509184610Salfred *------------------------------------------------------------------------*/ 2510184610Salfredvoid 2511184610Salfredusb2_command_wrapper(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer) 2512184610Salfred{ 2513184610Salfred if (xfer) { 2514184610Salfred /* 2515184610Salfred * If the transfer is not already processing, 2516184610Salfred * queue it! 2517184610Salfred */ 2518184610Salfred if (pq->curr != xfer) { 2519184610Salfred usb2_transfer_enqueue(pq, xfer); 2520184610Salfred if (pq->curr != NULL) { 2521184610Salfred /* something is already processing */ 2522184610Salfred DPRINTFN(6, "busy %p\n", pq->curr); 2523184610Salfred return; 2524184610Salfred } 2525184610Salfred } 2526184610Salfred } else { 2527184610Salfred /* Get next element in queue */ 2528184610Salfred pq->curr = NULL; 2529184610Salfred } 2530184610Salfred 2531184610Salfred if (!pq->recurse_1) { 2532184610Salfred 2533184610Salfred do { 2534184610Salfred 2535184610Salfred /* set both recurse flags */ 2536184610Salfred pq->recurse_1 = 1; 2537184610Salfred pq->recurse_2 = 1; 2538184610Salfred 2539184610Salfred if (pq->curr == NULL) { 2540184610Salfred xfer = TAILQ_FIRST(&pq->head); 2541184610Salfred if (xfer) { 2542184610Salfred TAILQ_REMOVE(&pq->head, xfer, 2543184610Salfred wait_entry); 2544184610Salfred xfer->wait_queue = NULL; 2545184610Salfred pq->curr = xfer; 2546184610Salfred } else { 2547184610Salfred break; 2548184610Salfred } 2549184610Salfred } 2550184610Salfred DPRINTFN(6, "cb %p (enter)\n", pq->curr); 2551184610Salfred (pq->command) (pq); 2552184610Salfred DPRINTFN(6, "cb %p (leave)\n", pq->curr); 2553184610Salfred 2554184610Salfred } while (!pq->recurse_2); 2555184610Salfred 2556184610Salfred /* clear first recurse flag */ 2557184610Salfred pq->recurse_1 = 0; 2558184610Salfred 2559184610Salfred } else { 2560184610Salfred /* clear second recurse flag */ 2561184610Salfred pq->recurse_2 = 0; 2562184610Salfred } 2563184610Salfred} 2564184610Salfred 2565184610Salfred/*------------------------------------------------------------------------* 2566184610Salfred * usb2_default_transfer_setup 2567184610Salfred * 2568184610Salfred * This function is used to setup the default USB control endpoint 2569184610Salfred * transfer. 2570184610Salfred *------------------------------------------------------------------------*/ 2571184610Salfredvoid 2572184610Salfredusb2_default_transfer_setup(struct usb2_device *udev) 2573184610Salfred{ 2574184610Salfred struct usb2_xfer *xfer; 2575184610Salfred uint8_t no_resetup; 2576184610Salfred uint8_t iface_index; 2577184610Salfred 2578184610Salfredrepeat: 2579184610Salfred 2580184610Salfred xfer = udev->default_xfer[0]; 2581184610Salfred if (xfer) { 2582184824Sthompsa USB_XFER_LOCK(xfer); 2583184610Salfred no_resetup = 2584184610Salfred ((xfer->address == udev->address) && 2585184610Salfred (udev->default_ep_desc.wMaxPacketSize[0] == 2586184610Salfred udev->ddesc.bMaxPacketSize)); 2587184610Salfred if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 2588184610Salfred if (no_resetup) { 2589184610Salfred /* 2590184610Salfred * NOTE: checking "xfer->address" and 2591184610Salfred * starting the USB transfer must be 2592184610Salfred * atomic! 2593184610Salfred */ 2594184610Salfred usb2_transfer_start(xfer); 2595184610Salfred } 2596184610Salfred } 2597184824Sthompsa USB_XFER_UNLOCK(xfer); 2598184610Salfred } else { 2599184610Salfred no_resetup = 0; 2600184610Salfred } 2601184610Salfred 2602184610Salfred if (no_resetup) { 2603184610Salfred /* 2604184610Salfred * All parameters are exactly the same like before. 2605184610Salfred * Just return. 2606184610Salfred */ 2607184610Salfred return; 2608184610Salfred } 2609184610Salfred /* 2610184610Salfred * Update wMaxPacketSize for the default control endpoint: 2611184610Salfred */ 2612184610Salfred udev->default_ep_desc.wMaxPacketSize[0] = 2613184610Salfred udev->ddesc.bMaxPacketSize; 2614184610Salfred 2615184610Salfred /* 2616184610Salfred * Unsetup any existing USB transfer: 2617184610Salfred */ 2618184610Salfred usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 2619184610Salfred 2620184610Salfred /* 2621184610Salfred * Try to setup a new USB transfer for the 2622184610Salfred * default control endpoint: 2623184610Salfred */ 2624184610Salfred iface_index = 0; 2625184610Salfred if (usb2_transfer_setup(udev, &iface_index, 2626184610Salfred udev->default_xfer, usb2_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL, 2627184610Salfred udev->default_mtx)) { 2628184610Salfred DPRINTFN(0, "could not setup default " 2629184610Salfred "USB transfer!\n"); 2630184610Salfred } else { 2631184610Salfred goto repeat; 2632184610Salfred } 2633184610Salfred} 2634184610Salfred 2635184610Salfred/*------------------------------------------------------------------------* 2636184610Salfred * usb2_clear_data_toggle - factored out code 2637184610Salfred * 2638184610Salfred * NOTE: the intention of this function is not to reset the hardware 2639184610Salfred * data toggle. 2640184610Salfred *------------------------------------------------------------------------*/ 2641184610Salfredvoid 2642184610Salfredusb2_clear_data_toggle(struct usb2_device *udev, struct usb2_pipe *pipe) 2643184610Salfred{ 2644184610Salfred DPRINTFN(5, "udev=%p pipe=%p\n", udev, pipe); 2645184610Salfred 2646184824Sthompsa USB_BUS_LOCK(udev->bus); 2647184610Salfred pipe->toggle_next = 0; 2648184824Sthompsa USB_BUS_UNLOCK(udev->bus); 2649184610Salfred} 2650184610Salfred 2651184610Salfred/*------------------------------------------------------------------------* 2652184610Salfred * usb2_clear_stall_callback - factored out clear stall callback 2653184610Salfred * 2654184610Salfred * Input parameters: 2655184610Salfred * xfer1: Clear Stall Control Transfer 2656184610Salfred * xfer2: Stalled USB Transfer 2657184610Salfred * 2658184610Salfred * This function is NULL safe. 2659184610Salfred * 2660184610Salfred * Return values: 2661184610Salfred * 0: In progress 2662184610Salfred * Else: Finished 2663184610Salfred * 2664184610Salfred * Clear stall config example: 2665184610Salfred * 2666184610Salfred * static const struct usb2_config my_clearstall = { 2667184610Salfred * .type = UE_CONTROL, 2668184610Salfred * .endpoint = 0, 2669184610Salfred * .direction = UE_DIR_ANY, 2670184610Salfred * .interval = 50, //50 milliseconds 2671184610Salfred * .bufsize = sizeof(struct usb2_device_request), 2672184610Salfred * .mh.timeout = 1000, //1.000 seconds 2673184610Salfred * .mh.callback = &my_clear_stall_callback, // ** 2674184610Salfred * }; 2675184610Salfred * 2676184610Salfred * ** "my_clear_stall_callback" calls "usb2_clear_stall_callback" 2677184610Salfred * passing the correct parameters. 2678184610Salfred *------------------------------------------------------------------------*/ 2679184610Salfreduint8_t 2680184610Salfredusb2_clear_stall_callback(struct usb2_xfer *xfer1, 2681184610Salfred struct usb2_xfer *xfer2) 2682184610Salfred{ 2683184610Salfred struct usb2_device_request req; 2684184610Salfred 2685184610Salfred if (xfer2 == NULL) { 2686184610Salfred /* looks like we are tearing down */ 2687184610Salfred DPRINTF("NULL input parameter\n"); 2688184610Salfred return (0); 2689184610Salfred } 2690184824Sthompsa USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED); 2691184824Sthompsa USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED); 2692184610Salfred 2693184610Salfred switch (USB_GET_STATE(xfer1)) { 2694184610Salfred case USB_ST_SETUP: 2695184610Salfred 2696184610Salfred /* 2697184610Salfred * pre-clear the data toggle to DATA0 ("umass.c" and 2698184610Salfred * "ata-usb.c" depends on this) 2699184610Salfred */ 2700184610Salfred 2701187173Sthompsa usb2_clear_data_toggle(xfer2->xroot->udev, xfer2->pipe); 2702184610Salfred 2703184610Salfred /* setup a clear-stall packet */ 2704184610Salfred 2705184610Salfred req.bmRequestType = UT_WRITE_ENDPOINT; 2706184610Salfred req.bRequest = UR_CLEAR_FEATURE; 2707184610Salfred USETW(req.wValue, UF_ENDPOINT_HALT); 2708184610Salfred req.wIndex[0] = xfer2->pipe->edesc->bEndpointAddress; 2709184610Salfred req.wIndex[1] = 0; 2710184610Salfred USETW(req.wLength, 0); 2711184610Salfred 2712184610Salfred /* 2713184610Salfred * "usb2_transfer_setup_sub()" will ensure that 2714184610Salfred * we have sufficient room in the buffer for 2715184610Salfred * the request structure! 2716184610Salfred */ 2717184610Salfred 2718184610Salfred /* copy in the transfer */ 2719184610Salfred 2720184610Salfred usb2_copy_in(xfer1->frbuffers, 0, &req, sizeof(req)); 2721184610Salfred 2722184610Salfred /* set length */ 2723184610Salfred xfer1->frlengths[0] = sizeof(req); 2724184610Salfred xfer1->nframes = 1; 2725184610Salfred 2726184610Salfred usb2_start_hardware(xfer1); 2727184610Salfred return (0); 2728184610Salfred 2729184610Salfred case USB_ST_TRANSFERRED: 2730184610Salfred break; 2731184610Salfred 2732184610Salfred default: /* Error */ 2733184610Salfred if (xfer1->error == USB_ERR_CANCELLED) { 2734184610Salfred return (0); 2735184610Salfred } 2736184610Salfred break; 2737184610Salfred } 2738184610Salfred return (1); /* Clear Stall Finished */ 2739184610Salfred} 2740184610Salfred 2741184610Salfredvoid 2742184610Salfredusb2_do_poll(struct usb2_xfer **ppxfer, uint16_t max) 2743184610Salfred{ 2744188983Sthompsa static uint8_t once = 0; 2745188983Sthompsa /* polling is currently not supported */ 2746188983Sthompsa if (!once) { 2747188983Sthompsa once = 1; 2748188983Sthompsa printf("usb2_do_poll: USB polling is " 2749188983Sthompsa "not supported!\n"); 2750184610Salfred } 2751184610Salfred} 2752