usb_transfer.c revision 187166
1184610Salfred/* $FreeBSD: head/sys/dev/usb2/core/usb2_transfer.c 187166 2009-01-13 19:01:56Z 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 27184610Salfred#include <dev/usb2/include/usb2_mfunc.h> 28184610Salfred#include <dev/usb2/include/usb2_error.h> 29184610Salfred#include <dev/usb2/include/usb2_standard.h> 30184610Salfred#include <dev/usb2/include/usb2_defs.h> 31184610Salfred 32184610Salfred#define USB_DEBUG_VAR usb2_debug 33184610Salfred 34184610Salfred#include <dev/usb2/core/usb2_core.h> 35184610Salfred#include <dev/usb2/core/usb2_busdma.h> 36184610Salfred#include <dev/usb2/core/usb2_process.h> 37184610Salfred#include <dev/usb2/core/usb2_transfer.h> 38184610Salfred#include <dev/usb2/core/usb2_device.h> 39184610Salfred#include <dev/usb2/core/usb2_debug.h> 40184610Salfred#include <dev/usb2/core/usb2_util.h> 41184610Salfred 42184610Salfred#include <dev/usb2/controller/usb2_controller.h> 43184610Salfred#include <dev/usb2/controller/usb2_bus.h> 44184610Salfred 45184610Salfredstruct usb2_std_packet_size { 46184610Salfred struct { 47184610Salfred uint16_t min; /* inclusive */ 48184610Salfred uint16_t max; /* inclusive */ 49184610Salfred } range; 50184610Salfred 51184610Salfred uint16_t fixed[4]; 52184610Salfred}; 53184610Salfred 54184610Salfred/* 55184610Salfred * This table stores the all the allowed packet sizes based on 56184610Salfred * endpoint type and USB speed: 57184610Salfred */ 58184610Salfredstatic const struct usb2_std_packet_size 59184610Salfred usb2_std_packet_size[4][USB_SPEED_MAX] = { 60184610Salfred 61184610Salfred [UE_INTERRUPT] = { 62184610Salfred [USB_SPEED_LOW] = {.range = {0, 8}}, 63184610Salfred [USB_SPEED_FULL] = {.range = {0, 64}}, 64184610Salfred [USB_SPEED_HIGH] = {.range = {0, 1024}}, 65184610Salfred [USB_SPEED_VARIABLE] = {.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}}, 73184610Salfred }, 74184610Salfred 75184610Salfred [UE_BULK] = { 76184610Salfred [USB_SPEED_LOW] = {.fixed = {0, 0, 0, 0}}, /* invalid */ 77184610Salfred [USB_SPEED_FULL] = {.fixed = {8, 16, 32, 64}}, 78184610Salfred [USB_SPEED_HIGH] = {.fixed = {512, 512, 512, 512}}, 79184610Salfred [USB_SPEED_VARIABLE] = {.fixed = {512, 512, 1024, 1536}}, 80184610Salfred }, 81184610Salfred 82184610Salfred [UE_ISOCHRONOUS] = { 83184610Salfred [USB_SPEED_LOW] = {.fixed = {0, 0, 0, 0}}, /* invalid */ 84184610Salfred [USB_SPEED_FULL] = {.range = {0, 1023}}, 85184610Salfred [USB_SPEED_HIGH] = {.range = {0, 1024}}, 86184610Salfred [USB_SPEED_VARIABLE] = {.range = {0, 3584}}, 87184610Salfred }, 88184610Salfred}; 89184610Salfred 90184610Salfredstatic const struct usb2_config usb2_control_ep_cfg[USB_DEFAULT_XFER_MAX] = { 91184610Salfred 92184610Salfred /* This transfer is used for generic control endpoint transfers */ 93184610Salfred 94184610Salfred [0] = { 95184610Salfred .type = UE_CONTROL, 96184610Salfred .endpoint = 0x00, /* Control endpoint */ 97184610Salfred .direction = UE_DIR_ANY, 98184610Salfred .mh.bufsize = 1024, /* bytes */ 99184610Salfred .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,}, 100184610Salfred .mh.callback = &usb2_do_request_callback, 101184610Salfred .md.bufsize = 1024, /* bytes */ 102184610Salfred .md.flags = {.proxy_buffer = 1,.short_xfer_ok = 0,}, 103184610Salfred .md.callback = &usb2_handle_request_callback, 104184610Salfred }, 105184610Salfred 106184610Salfred /* This transfer is used for generic clear stall only */ 107184610Salfred 108184610Salfred [1] = { 109184610Salfred .type = UE_CONTROL, 110184610Salfred .endpoint = 0x00, /* Control pipe */ 111184610Salfred .direction = UE_DIR_ANY, 112184610Salfred .mh.bufsize = sizeof(struct usb2_device_request), 113184610Salfred .mh.flags = {}, 114184610Salfred .mh.callback = &usb2_do_clear_stall_callback, 115184610Salfred .mh.timeout = 1000, /* 1 second */ 116184610Salfred .mh.interval = 50, /* 50ms */ 117184610Salfred }, 118184610Salfred}; 119184610Salfred 120184610Salfred/* function prototypes */ 121184610Salfred 122185948Sthompsastatic void usb2_update_max_frame_size(struct usb2_xfer *); 123185948Sthompsastatic void usb2_transfer_unsetup_sub(struct usb2_xfer_root *, uint8_t); 124185948Sthompsastatic void usb2_control_transfer_init(struct usb2_xfer *); 125185948Sthompsastatic uint8_t usb2_start_hardware_sub(struct usb2_xfer *); 126185948Sthompsastatic void usb2_callback_proc(struct usb2_proc_msg *); 127185948Sthompsastatic void usb2_callback_ss_done_defer(struct usb2_xfer *); 128185948Sthompsastatic void usb2_callback_wrapper(struct usb2_xfer_queue *); 129185948Sthompsastatic void usb2_dma_delay_done_cb(void *); 130185948Sthompsastatic void usb2_transfer_start_cb(void *); 131185948Sthompsastatic uint8_t usb2_callback_wrapper_sub(struct usb2_xfer *); 132184610Salfred 133184610Salfred/*------------------------------------------------------------------------* 134184610Salfred * usb2_update_max_frame_size 135184610Salfred * 136184610Salfred * This function updates the maximum frame size, hence high speed USB 137184610Salfred * can transfer multiple consecutive packets. 138184610Salfred *------------------------------------------------------------------------*/ 139184610Salfredstatic void 140184610Salfredusb2_update_max_frame_size(struct usb2_xfer *xfer) 141184610Salfred{ 142184610Salfred /* compute maximum frame size */ 143184610Salfred 144184610Salfred if (xfer->max_packet_count == 2) { 145184610Salfred xfer->max_frame_size = 2 * xfer->max_packet_size; 146184610Salfred } else if (xfer->max_packet_count == 3) { 147184610Salfred xfer->max_frame_size = 3 * xfer->max_packet_size; 148184610Salfred } else { 149184610Salfred xfer->max_frame_size = xfer->max_packet_size; 150184610Salfred } 151184610Salfred} 152184610Salfred 153184610Salfred/*------------------------------------------------------------------------* 154184610Salfred * usb2_get_dma_delay 155184610Salfred * 156184610Salfred * The following function is called when we need to 157184610Salfred * synchronize with DMA hardware. 158184610Salfred * 159184610Salfred * Returns: 160184610Salfred * 0: no DMA delay required 161184610Salfred * Else: milliseconds of DMA delay 162184610Salfred *------------------------------------------------------------------------*/ 163186730Salfreduint32_t 164184610Salfredusb2_get_dma_delay(struct usb2_bus *bus) 165184610Salfred{ 166184610Salfred uint32_t temp = 0; 167184610Salfred 168184610Salfred if (bus->methods->get_dma_delay) { 169184610Salfred (bus->methods->get_dma_delay) (bus, &temp); 170184610Salfred /* 171184610Salfred * Round up and convert to milliseconds. Note that we use 172184610Salfred * 1024 milliseconds per second. to save a division. 173184610Salfred */ 174184610Salfred temp += 0x3FF; 175184610Salfred temp /= 0x400; 176184610Salfred } 177184610Salfred return (temp); 178184610Salfred} 179184610Salfred 180184610Salfred/*------------------------------------------------------------------------* 181184610Salfred * usb2_transfer_setup_sub_malloc 182184610Salfred * 183184610Salfred * This function will allocate one or more DMA'able memory chunks 184184610Salfred * according to "size", "align" and "count" arguments. "ppc" is 185184610Salfred * pointed to a linear array of USB page caches afterwards. 186184610Salfred * 187184610Salfred * Returns: 188184610Salfred * 0: Success 189184610Salfred * Else: Failure 190184610Salfred *------------------------------------------------------------------------*/ 191184610Salfreduint8_t 192184610Salfredusb2_transfer_setup_sub_malloc(struct usb2_setup_params *parm, 193184610Salfred struct usb2_page_cache **ppc, uint32_t size, uint32_t align, 194184610Salfred uint32_t count) 195184610Salfred{ 196184610Salfred struct usb2_page_cache *pc; 197184610Salfred struct usb2_page *pg; 198184610Salfred void *buf; 199184610Salfred uint32_t n_dma_pc; 200184610Salfred uint32_t n_obj; 201184610Salfred uint32_t x; 202184610Salfred uint32_t y; 203184610Salfred uint32_t r; 204184610Salfred uint32_t z; 205184610Salfred 206184610Salfred USB_ASSERT(align > 1, ("Invalid alignment, 0x%08x!\n", 207184610Salfred align)); 208184610Salfred USB_ASSERT(size > 0, ("Invalid size = 0!\n")); 209184610Salfred 210184610Salfred if (count == 0) { 211184610Salfred return (0); /* nothing to allocate */ 212184610Salfred } 213184610Salfred /* 214184610Salfred * Make sure that the size is aligned properly. 215184610Salfred */ 216184610Salfred size = -((-size) & (-align)); 217184610Salfred 218184610Salfred /* 219184610Salfred * Try multi-allocation chunks to reduce the number of DMA 220184610Salfred * allocations, hence DMA allocations are slow. 221184610Salfred */ 222184610Salfred if (size >= PAGE_SIZE) { 223184610Salfred n_dma_pc = count; 224184610Salfred n_obj = 1; 225184610Salfred } else { 226184610Salfred /* compute number of objects per page */ 227184610Salfred n_obj = (PAGE_SIZE / size); 228184610Salfred /* 229184610Salfred * Compute number of DMA chunks, rounded up 230184610Salfred * to nearest one: 231184610Salfred */ 232184610Salfred n_dma_pc = ((count + n_obj - 1) / n_obj); 233184610Salfred } 234184610Salfred 235184610Salfred if (parm->buf == NULL) { 236184610Salfred /* for the future */ 237184610Salfred parm->dma_page_ptr += n_dma_pc; 238184610Salfred parm->dma_page_cache_ptr += n_dma_pc; 239184610Salfred parm->dma_page_ptr += count; 240184610Salfred parm->xfer_page_cache_ptr += count; 241184610Salfred return (0); 242184610Salfred } 243184610Salfred for (x = 0; x != n_dma_pc; x++) { 244184610Salfred /* need to initialize the page cache */ 245184610Salfred parm->dma_page_cache_ptr[x].tag_parent = 246184610Salfred &parm->curr_xfer->usb2_root->dma_parent_tag; 247184610Salfred } 248184610Salfred for (x = 0; x != count; x++) { 249184610Salfred /* need to initialize the page cache */ 250184610Salfred parm->xfer_page_cache_ptr[x].tag_parent = 251184610Salfred &parm->curr_xfer->usb2_root->dma_parent_tag; 252184610Salfred } 253184610Salfred 254184610Salfred if (ppc) { 255184610Salfred *ppc = parm->xfer_page_cache_ptr; 256184610Salfred } 257184610Salfred r = count; /* set remainder count */ 258184610Salfred z = n_obj * size; /* set allocation size */ 259184610Salfred pc = parm->xfer_page_cache_ptr; 260184610Salfred pg = parm->dma_page_ptr; 261184610Salfred 262184610Salfred for (x = 0; x != n_dma_pc; x++) { 263184610Salfred 264184610Salfred if (r < n_obj) { 265184610Salfred /* compute last remainder */ 266184610Salfred z = r * size; 267184610Salfred n_obj = r; 268184610Salfred } 269184610Salfred if (usb2_pc_alloc_mem(parm->dma_page_cache_ptr, 270184610Salfred pg, z, align)) { 271184610Salfred return (1); /* failure */ 272184610Salfred } 273184610Salfred /* Set beginning of current buffer */ 274184610Salfred buf = parm->dma_page_cache_ptr->buffer; 275184610Salfred /* Make room for one DMA page cache and one page */ 276184610Salfred parm->dma_page_cache_ptr++; 277184610Salfred pg++; 278184610Salfred 279184610Salfred for (y = 0; (y != n_obj); y++, r--, pc++, pg++) { 280184610Salfred 281184610Salfred /* Load sub-chunk into DMA */ 282184610Salfred if (usb2_pc_dmamap_create(pc, size)) { 283184610Salfred return (1); /* failure */ 284184610Salfred } 285184610Salfred pc->buffer = USB_ADD_BYTES(buf, y * size); 286184610Salfred pc->page_start = pg; 287184610Salfred 288184610Salfred mtx_lock(pc->tag_parent->mtx); 289184610Salfred if (usb2_pc_load_mem(pc, size, 1 /* synchronous */ )) { 290184610Salfred mtx_unlock(pc->tag_parent->mtx); 291184610Salfred return (1); /* failure */ 292184610Salfred } 293184610Salfred mtx_unlock(pc->tag_parent->mtx); 294184610Salfred } 295184610Salfred } 296184610Salfred 297184610Salfred parm->xfer_page_cache_ptr = pc; 298184610Salfred parm->dma_page_ptr = pg; 299184610Salfred return (0); 300184610Salfred} 301184610Salfred 302184610Salfred/*------------------------------------------------------------------------* 303184610Salfred * usb2_transfer_setup_sub - transfer setup subroutine 304184610Salfred * 305184610Salfred * This function must be called from the "xfer_setup" callback of the 306184610Salfred * USB Host or Device controller driver when setting up an USB 307184610Salfred * transfer. This function will setup correct packet sizes, buffer 308184610Salfred * sizes, flags and more, that are stored in the "usb2_xfer" 309184610Salfred * structure. 310184610Salfred *------------------------------------------------------------------------*/ 311184610Salfredvoid 312184610Salfredusb2_transfer_setup_sub(struct usb2_setup_params *parm) 313184610Salfred{ 314184610Salfred enum { 315184610Salfred REQ_SIZE = 8, 316184610Salfred MIN_PKT = 8, 317184610Salfred }; 318184610Salfred struct usb2_xfer *xfer = parm->curr_xfer; 319184610Salfred const struct usb2_config_sub *setup_sub = parm->curr_setup_sub; 320184610Salfred struct usb2_endpoint_descriptor *edesc; 321184610Salfred struct usb2_std_packet_size std_size; 322184610Salfred uint32_t n_frlengths; 323184610Salfred uint32_t n_frbuffers; 324184610Salfred uint32_t x; 325184610Salfred uint8_t type; 326184610Salfred uint8_t zmps; 327184610Salfred 328184610Salfred /* 329184610Salfred * Sanity check. The following parameters must be initialized before 330184610Salfred * calling this function. 331184610Salfred */ 332184610Salfred if ((parm->hc_max_packet_size == 0) || 333184610Salfred (parm->hc_max_packet_count == 0) || 334184610Salfred (parm->hc_max_frame_size == 0)) { 335184610Salfred parm->err = USB_ERR_INVAL; 336184610Salfred goto done; 337184610Salfred } 338184610Salfred edesc = xfer->pipe->edesc; 339184610Salfred 340184610Salfred type = (edesc->bmAttributes & UE_XFERTYPE); 341184610Salfred 342184610Salfred xfer->flags = setup_sub->flags; 343184610Salfred xfer->nframes = setup_sub->frames; 344184610Salfred xfer->timeout = setup_sub->timeout; 345184610Salfred xfer->callback = setup_sub->callback; 346184610Salfred xfer->interval = setup_sub->interval; 347184610Salfred xfer->endpoint = edesc->bEndpointAddress; 348184610Salfred xfer->max_packet_size = UGETW(edesc->wMaxPacketSize); 349184610Salfred xfer->max_packet_count = 1; 350184610Salfred /* make a shadow copy: */ 351184610Salfred xfer->flags_int.usb2_mode = parm->udev->flags.usb2_mode; 352184610Salfred 353184610Salfred parm->bufsize = setup_sub->bufsize; 354184610Salfred 355184610Salfred if (parm->speed == USB_SPEED_HIGH) { 356184610Salfred xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 357184610Salfred xfer->max_packet_size &= 0x7FF; 358184610Salfred } 359184610Salfred /* range check "max_packet_count" */ 360184610Salfred 361184610Salfred if (xfer->max_packet_count > parm->hc_max_packet_count) { 362184610Salfred xfer->max_packet_count = parm->hc_max_packet_count; 363184610Salfred } 364184610Salfred /* filter "wMaxPacketSize" according to HC capabilities */ 365184610Salfred 366184610Salfred if ((xfer->max_packet_size > parm->hc_max_packet_size) || 367184610Salfred (xfer->max_packet_size == 0)) { 368184610Salfred xfer->max_packet_size = parm->hc_max_packet_size; 369184610Salfred } 370184610Salfred /* filter "wMaxPacketSize" according to standard sizes */ 371184610Salfred 372184610Salfred std_size = usb2_std_packet_size[type][parm->speed]; 373184610Salfred 374184610Salfred if (std_size.range.min || std_size.range.max) { 375184610Salfred 376184610Salfred if (xfer->max_packet_size < std_size.range.min) { 377184610Salfred xfer->max_packet_size = std_size.range.min; 378184610Salfred } 379184610Salfred if (xfer->max_packet_size > std_size.range.max) { 380184610Salfred xfer->max_packet_size = std_size.range.max; 381184610Salfred } 382184610Salfred } else { 383184610Salfred 384184610Salfred if (xfer->max_packet_size >= std_size.fixed[3]) { 385184610Salfred xfer->max_packet_size = std_size.fixed[3]; 386184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[2]) { 387184610Salfred xfer->max_packet_size = std_size.fixed[2]; 388184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[1]) { 389184610Salfred xfer->max_packet_size = std_size.fixed[1]; 390184610Salfred } else { 391184610Salfred /* only one possibility left */ 392184610Salfred xfer->max_packet_size = std_size.fixed[0]; 393184610Salfred } 394184610Salfred } 395184610Salfred 396184610Salfred /* compute "max_frame_size" */ 397184610Salfred 398184610Salfred usb2_update_max_frame_size(xfer); 399184610Salfred 400184610Salfred /* check interrupt interval and transfer pre-delay */ 401184610Salfred 402184610Salfred if (type == UE_ISOCHRONOUS) { 403184610Salfred 404184610Salfred uint32_t frame_limit; 405184610Salfred 406184610Salfred xfer->interval = 0; /* not used, must be zero */ 407184610Salfred xfer->flags_int.isochronous_xfr = 1; /* set flag */ 408184610Salfred 409184610Salfred if (xfer->timeout == 0) { 410184610Salfred /* 411184610Salfred * set a default timeout in 412184610Salfred * case something goes wrong! 413184610Salfred */ 414184610Salfred xfer->timeout = 1000 / 4; 415184610Salfred } 416184610Salfred if (parm->speed == USB_SPEED_HIGH) { 417184610Salfred frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER; 418184610Salfred } else { 419184610Salfred frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER; 420184610Salfred } 421184610Salfred 422184610Salfred if (xfer->nframes > frame_limit) { 423184610Salfred /* 424184610Salfred * this is not going to work 425184610Salfred * cross hardware 426184610Salfred */ 427184610Salfred parm->err = USB_ERR_INVAL; 428184610Salfred goto done; 429184610Salfred } 430184610Salfred if (xfer->nframes == 0) { 431184610Salfred /* 432184610Salfred * this is not a valid value 433184610Salfred */ 434184610Salfred parm->err = USB_ERR_ZERO_NFRAMES; 435184610Salfred goto done; 436184610Salfred } 437184610Salfred } else { 438184610Salfred 439184610Salfred /* 440184610Salfred * if a value is specified use that else check the endpoint 441184610Salfred * descriptor 442184610Salfred */ 443184610Salfred if (xfer->interval == 0) { 444184610Salfred 445184610Salfred if (type == UE_INTERRUPT) { 446184610Salfred 447184610Salfred xfer->interval = edesc->bInterval; 448184610Salfred 449184610Salfred if (parm->speed == USB_SPEED_HIGH) { 450184610Salfred xfer->interval /= 8; /* 125us -> 1ms */ 451184610Salfred } 452184610Salfred if (xfer->interval == 0) { 453184610Salfred /* 454184610Salfred * one millisecond is the smallest 455184610Salfred * interval 456184610Salfred */ 457184610Salfred xfer->interval = 1; 458184610Salfred } 459184610Salfred } 460184610Salfred } 461184610Salfred } 462184610Salfred 463184610Salfred /* 464184610Salfred * NOTE: we do not allow "max_packet_size" or "max_frame_size" 465184610Salfred * to be equal to zero when setting up USB transfers, hence 466184610Salfred * this leads to alot of extra code in the USB kernel. 467184610Salfred */ 468184610Salfred 469184610Salfred if ((xfer->max_frame_size == 0) || 470184610Salfred (xfer->max_packet_size == 0)) { 471184610Salfred 472184610Salfred zmps = 1; 473184610Salfred 474184610Salfred if ((parm->bufsize <= MIN_PKT) && 475184610Salfred (type != UE_CONTROL) && 476184610Salfred (type != UE_BULK)) { 477184610Salfred 478184610Salfred /* workaround */ 479184610Salfred xfer->max_packet_size = MIN_PKT; 480184610Salfred xfer->max_packet_count = 1; 481184610Salfred parm->bufsize = 0; /* automatic setup length */ 482184610Salfred usb2_update_max_frame_size(xfer); 483184610Salfred 484184610Salfred } else { 485184610Salfred parm->err = USB_ERR_ZERO_MAXP; 486184610Salfred goto done; 487184610Salfred } 488184610Salfred 489184610Salfred } else { 490184610Salfred zmps = 0; 491184610Salfred } 492184610Salfred 493184610Salfred /* 494184610Salfred * check if we should setup a default 495184610Salfred * length: 496184610Salfred */ 497184610Salfred 498184610Salfred if (parm->bufsize == 0) { 499184610Salfred 500184610Salfred parm->bufsize = xfer->max_frame_size; 501184610Salfred 502184610Salfred if (type == UE_ISOCHRONOUS) { 503184610Salfred parm->bufsize *= xfer->nframes; 504184610Salfred } 505184610Salfred } 506184610Salfred /* 507184610Salfred * check if we are about to setup a proxy 508184610Salfred * type of buffer: 509184610Salfred */ 510184610Salfred 511184610Salfred if (xfer->flags.proxy_buffer) { 512184610Salfred 513184610Salfred /* round bufsize up */ 514184610Salfred 515184610Salfred parm->bufsize += (xfer->max_frame_size - 1); 516184610Salfred 517184610Salfred if (parm->bufsize < xfer->max_frame_size) { 518184610Salfred /* length wrapped around */ 519184610Salfred parm->err = USB_ERR_INVAL; 520184610Salfred goto done; 521184610Salfred } 522184610Salfred /* subtract remainder */ 523184610Salfred 524184610Salfred parm->bufsize -= (parm->bufsize % xfer->max_frame_size); 525184610Salfred 526184610Salfred /* add length of USB device request structure, if any */ 527184610Salfred 528184610Salfred if (type == UE_CONTROL) { 529184610Salfred parm->bufsize += REQ_SIZE; /* SETUP message */ 530184610Salfred } 531184610Salfred } 532184610Salfred xfer->max_data_length = parm->bufsize; 533184610Salfred 534184610Salfred /* Setup "n_frlengths" and "n_frbuffers" */ 535184610Salfred 536184610Salfred if (type == UE_ISOCHRONOUS) { 537184610Salfred n_frlengths = xfer->nframes; 538184610Salfred n_frbuffers = 1; 539184610Salfred } else { 540184610Salfred 541184610Salfred if (type == UE_CONTROL) { 542184610Salfred xfer->flags_int.control_xfr = 1; 543184610Salfred if (xfer->nframes == 0) { 544184610Salfred if (parm->bufsize <= REQ_SIZE) { 545184610Salfred /* 546184610Salfred * there will never be any data 547184610Salfred * stage 548184610Salfred */ 549184610Salfred xfer->nframes = 1; 550184610Salfred } else { 551184610Salfred xfer->nframes = 2; 552184610Salfred } 553184610Salfred } 554184610Salfred } else { 555184610Salfred if (xfer->nframes == 0) { 556184610Salfred xfer->nframes = 1; 557184610Salfred } 558184610Salfred } 559184610Salfred 560184610Salfred n_frlengths = xfer->nframes; 561184610Salfred n_frbuffers = xfer->nframes; 562184610Salfred } 563184610Salfred 564184610Salfred /* 565184610Salfred * check if we have room for the 566184610Salfred * USB device request structure: 567184610Salfred */ 568184610Salfred 569184610Salfred if (type == UE_CONTROL) { 570184610Salfred 571184610Salfred if (xfer->max_data_length < REQ_SIZE) { 572184610Salfred /* length wrapped around or too small bufsize */ 573184610Salfred parm->err = USB_ERR_INVAL; 574184610Salfred goto done; 575184610Salfred } 576184610Salfred xfer->max_data_length -= REQ_SIZE; 577184610Salfred } 578184610Salfred /* setup "frlengths" */ 579184610Salfred 580184610Salfred xfer->frlengths = parm->xfer_length_ptr; 581184610Salfred 582184610Salfred parm->xfer_length_ptr += n_frlengths; 583184610Salfred 584184610Salfred /* setup "frbuffers" */ 585184610Salfred 586184610Salfred xfer->frbuffers = parm->xfer_page_cache_ptr; 587184610Salfred 588184610Salfred parm->xfer_page_cache_ptr += n_frbuffers; 589184610Salfred 590184610Salfred /* 591184610Salfred * check if we need to setup 592184610Salfred * a local buffer: 593184610Salfred */ 594184610Salfred 595184610Salfred if (!xfer->flags.ext_buffer) { 596184610Salfred 597184610Salfred /* align data */ 598184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 599184610Salfred 600184610Salfred if (parm->buf) { 601184610Salfred 602184610Salfred xfer->local_buffer = 603184610Salfred USB_ADD_BYTES(parm->buf, parm->size[0]); 604184610Salfred 605184610Salfred usb2_set_frame_offset(xfer, 0, 0); 606184610Salfred 607184610Salfred if ((type == UE_CONTROL) && (n_frbuffers > 1)) { 608184610Salfred usb2_set_frame_offset(xfer, REQ_SIZE, 1); 609184610Salfred } 610184610Salfred } 611184610Salfred parm->size[0] += parm->bufsize; 612184610Salfred 613184610Salfred /* align data again */ 614184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 615184610Salfred } 616184610Salfred /* 617184610Salfred * Compute maximum buffer size 618184610Salfred */ 619184610Salfred 620184610Salfred if (parm->bufsize_max < parm->bufsize) { 621184610Salfred parm->bufsize_max = parm->bufsize; 622184610Salfred } 623184610Salfred if (xfer->flags_int.bdma_enable) { 624184610Salfred /* 625184610Salfred * Setup "dma_page_ptr". 626184610Salfred * 627184610Salfred * Proof for formula below: 628184610Salfred * 629184610Salfred * Assume there are three USB frames having length "a", "b" and 630184610Salfred * "c". These USB frames will at maximum need "z" 631184610Salfred * "usb2_page" structures. "z" is given by: 632184610Salfred * 633184610Salfred * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) + 634184610Salfred * ((c / USB_PAGE_SIZE) + 2); 635184610Salfred * 636184610Salfred * Constraining "a", "b" and "c" like this: 637184610Salfred * 638184610Salfred * (a + b + c) <= parm->bufsize 639184610Salfred * 640184610Salfred * We know that: 641184610Salfred * 642184610Salfred * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2)); 643184610Salfred * 644184610Salfred * Here is the general formula: 645184610Salfred */ 646184610Salfred xfer->dma_page_ptr = parm->dma_page_ptr; 647184610Salfred parm->dma_page_ptr += (2 * n_frbuffers); 648184610Salfred parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE); 649184610Salfred } 650184610Salfred if (zmps) { 651184610Salfred /* correct maximum data length */ 652184610Salfred xfer->max_data_length = 0; 653184610Salfred } 654184610Salfred /* subtract USB frame remainder from "hc_max_frame_size" */ 655184610Salfred 656184610Salfred xfer->max_usb2_frame_size = 657184610Salfred (parm->hc_max_frame_size - 658184610Salfred (parm->hc_max_frame_size % xfer->max_frame_size)); 659184610Salfred 660184610Salfred if (xfer->max_usb2_frame_size == 0) { 661184610Salfred parm->err = USB_ERR_INVAL; 662184610Salfred goto done; 663184610Salfred } 664184610Salfred /* initialize max frame count */ 665184610Salfred 666184610Salfred xfer->max_frame_count = xfer->nframes; 667184610Salfred 668184610Salfred /* initialize frame buffers */ 669184610Salfred 670184610Salfred if (parm->buf) { 671184610Salfred for (x = 0; x != n_frbuffers; x++) { 672184610Salfred xfer->frbuffers[x].tag_parent = 673184610Salfred &xfer->usb2_root->dma_parent_tag; 674184610Salfred 675184610Salfred if (xfer->flags_int.bdma_enable && 676184610Salfred (parm->bufsize_max > 0)) { 677184610Salfred 678184610Salfred if (usb2_pc_dmamap_create( 679184610Salfred xfer->frbuffers + x, 680184610Salfred parm->bufsize_max)) { 681184610Salfred parm->err = USB_ERR_NOMEM; 682184610Salfred goto done; 683184610Salfred } 684184610Salfred } 685184610Salfred } 686184610Salfred } 687184610Salfreddone: 688184610Salfred if (parm->err) { 689184610Salfred /* 690184610Salfred * Set some dummy values so that we avoid division by zero: 691184610Salfred */ 692184610Salfred xfer->max_usb2_frame_size = 1; 693184610Salfred xfer->max_frame_size = 1; 694184610Salfred xfer->max_packet_size = 1; 695184610Salfred xfer->max_data_length = 0; 696184610Salfred xfer->nframes = 0; 697184610Salfred xfer->max_frame_count = 0; 698184610Salfred } 699184610Salfred} 700184610Salfred 701184610Salfred/*------------------------------------------------------------------------* 702184610Salfred * usb2_transfer_setup - setup an array of USB transfers 703184610Salfred * 704184610Salfred * NOTE: You must always call "usb2_transfer_unsetup" after calling 705184610Salfred * "usb2_transfer_setup" if success was returned. 706184610Salfred * 707184610Salfred * The idea is that the USB device driver should pre-allocate all its 708184610Salfred * transfers by one call to this function. 709184610Salfred * 710184610Salfred * Return values: 711184610Salfred * 0: Success 712184610Salfred * Else: Failure 713184610Salfred *------------------------------------------------------------------------*/ 714184610Salfredusb2_error_t 715184610Salfredusb2_transfer_setup(struct usb2_device *udev, 716184610Salfred const uint8_t *ifaces, struct usb2_xfer **ppxfer, 717184610Salfred const struct usb2_config *setup_start, uint16_t n_setup, 718184610Salfred void *priv_sc, struct mtx *priv_mtx) 719184610Salfred{ 720184610Salfred struct usb2_xfer dummy; 721184610Salfred struct usb2_setup_params parm; 722184610Salfred const struct usb2_config *setup_end = setup_start + n_setup; 723184610Salfred const struct usb2_config *setup; 724184610Salfred struct usb2_pipe *pipe; 725184610Salfred struct usb2_xfer_root *info; 726184610Salfred struct usb2_xfer *xfer; 727184610Salfred void *buf = NULL; 728184610Salfred uint16_t n; 729184610Salfred uint16_t refcount; 730184610Salfred 731184610Salfred parm.err = 0; 732184610Salfred refcount = 0; 733184610Salfred info = NULL; 734184610Salfred 735184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 736184610Salfred "usb2_transfer_setup can sleep!"); 737184610Salfred 738184610Salfred /* do some checking first */ 739184610Salfred 740184610Salfred if (n_setup == 0) { 741184610Salfred DPRINTFN(6, "setup array has zero length!\n"); 742184610Salfred return (USB_ERR_INVAL); 743184610Salfred } 744184610Salfred if (ifaces == 0) { 745184610Salfred DPRINTFN(6, "ifaces array is NULL!\n"); 746184610Salfred return (USB_ERR_INVAL); 747184610Salfred } 748184610Salfred if (priv_mtx == NULL) { 749184610Salfred DPRINTFN(6, "using global lock\n"); 750184610Salfred priv_mtx = &Giant; 751184610Salfred } 752184610Salfred /* sanity checks */ 753184610Salfred for (setup = setup_start, n = 0; 754184610Salfred setup != setup_end; setup++, n++) { 755184610Salfred if ((setup->mh.bufsize == 0xffffffff) || 756184610Salfred (setup->md.bufsize == 0xffffffff)) { 757184610Salfred parm.err = USB_ERR_BAD_BUFSIZE; 758184610Salfred DPRINTF("invalid bufsize\n"); 759184610Salfred } 760184610Salfred if ((setup->mh.callback == NULL) && 761184610Salfred (setup->md.callback == NULL)) { 762184610Salfred parm.err = USB_ERR_NO_CALLBACK; 763184610Salfred DPRINTF("no callback\n"); 764184610Salfred } 765184610Salfred ppxfer[n] = NULL; 766184610Salfred } 767184610Salfred 768184610Salfred if (parm.err) { 769184610Salfred goto done; 770184610Salfred } 771184610Salfred bzero(&parm, sizeof(parm)); 772184610Salfred 773184610Salfred parm.udev = udev; 774184610Salfred parm.speed = usb2_get_speed(udev); 775184610Salfred parm.hc_max_packet_count = 1; 776184610Salfred 777184610Salfred if (parm.speed >= USB_SPEED_MAX) { 778184610Salfred parm.err = USB_ERR_INVAL; 779184610Salfred goto done; 780184610Salfred } 781184610Salfred /* setup all transfers */ 782184610Salfred 783184610Salfred while (1) { 784184610Salfred 785184610Salfred if (buf) { 786184610Salfred /* 787184610Salfred * Initialize the "usb2_xfer_root" structure, 788184610Salfred * which is common for all our USB transfers. 789184610Salfred */ 790184610Salfred info = USB_ADD_BYTES(buf, 0); 791184610Salfred 792184610Salfred info->memory_base = buf; 793184610Salfred info->memory_size = parm.size[0]; 794184610Salfred 795184610Salfred info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]); 796184610Salfred info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]); 797184610Salfred info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]); 798184610Salfred info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]); 799184610Salfred 800184610Salfred usb2_cv_init(&info->cv_drain, "WDRAIN"); 801184610Salfred 802184610Salfred info->priv_mtx = priv_mtx; 803184610Salfred 804184610Salfred usb2_dma_tag_setup(&info->dma_parent_tag, 805184610Salfred parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag, 806184610Salfred priv_mtx, &usb2_bdma_done_event, info, 32, parm.dma_tag_max); 807184610Salfred 808184610Salfred info->bus = udev->bus; 809184610Salfred 810184610Salfred TAILQ_INIT(&info->done_q.head); 811184610Salfred info->done_q.command = &usb2_callback_wrapper; 812184610Salfred 813184610Salfred TAILQ_INIT(&info->dma_q.head); 814184610Salfred info->dma_q.command = &usb2_bdma_work_loop; 815184610Salfred 816184610Salfred info->done_m[0].hdr.pm_callback = &usb2_callback_proc; 817184610Salfred info->done_m[0].usb2_root = info; 818184610Salfred info->done_m[1].hdr.pm_callback = &usb2_callback_proc; 819184610Salfred info->done_m[1].usb2_root = info; 820184610Salfred 821184610Salfred /* create a callback thread */ 822184610Salfred 823184610Salfred if (usb2_proc_setup(&info->done_p, 824184824Sthompsa &udev->bus->bus_mtx, USB_PRI_HIGH)) { 825184610Salfred parm.err = USB_ERR_NO_INTR_THREAD; 826184610Salfred goto done; 827184610Salfred } 828184610Salfred } 829184610Salfred /* reset sizes */ 830184610Salfred 831184610Salfred parm.size[0] = 0; 832184610Salfred parm.buf = buf; 833184610Salfred parm.size[0] += sizeof(info[0]); 834184610Salfred 835184610Salfred for (setup = setup_start, n = 0; 836184610Salfred setup != setup_end; setup++, n++) { 837184610Salfred 838184610Salfred /* select mode specific structure */ 839184610Salfred if (udev->flags.usb2_mode == USB_MODE_HOST) { 840184610Salfred parm.curr_setup_sub = &setup->mh; 841184610Salfred } else { 842184610Salfred parm.curr_setup_sub = &setup->md; 843184610Salfred } 844184610Salfred /* skip USB transfers without callbacks: */ 845184610Salfred if (parm.curr_setup_sub->callback == NULL) { 846184610Salfred continue; 847184610Salfred } 848184610Salfred /* see if there is a matching endpoint */ 849184610Salfred pipe = usb2_get_pipe(udev, 850184610Salfred ifaces[setup->if_index], setup); 851184610Salfred 852184610Salfred if (!pipe) { 853184610Salfred if (parm.curr_setup_sub->flags.no_pipe_ok) { 854184610Salfred continue; 855184610Salfred } 856184610Salfred parm.err = USB_ERR_NO_PIPE; 857184610Salfred goto done; 858184610Salfred } 859184610Salfred /* store current setup pointer */ 860184610Salfred parm.curr_setup = setup; 861184610Salfred 862184610Salfred /* align data properly */ 863184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 864184610Salfred 865184610Salfred if (buf) { 866184610Salfred 867184610Salfred /* 868184610Salfred * Common initialization of the 869184610Salfred * "usb2_xfer" structure. 870184610Salfred */ 871184610Salfred xfer = USB_ADD_BYTES(buf, parm.size[0]); 872184610Salfred 873184610Salfred ppxfer[n] = xfer; 874184610Salfred xfer->udev = udev; 875184610Salfred xfer->address = udev->address; 876184610Salfred xfer->priv_sc = priv_sc; 877184824Sthompsa xfer->xfer_mtx = priv_mtx; 878184610Salfred xfer->usb2_root = info; 879184610Salfred info->setup_refcount++; 880184610Salfred 881184824Sthompsa usb2_callout_init_mtx(&xfer->timeout_handle, 882186454Sthompsa &udev->bus->bus_mtx, 0); 883184610Salfred } else { 884184610Salfred /* 885184610Salfred * Setup a dummy xfer, hence we are 886184610Salfred * writing to the "usb2_xfer" 887184610Salfred * structure pointed to by "xfer" 888184610Salfred * before we have allocated any 889184610Salfred * memory: 890184610Salfred */ 891184610Salfred xfer = &dummy; 892184610Salfred bzero(&dummy, sizeof(dummy)); 893184610Salfred refcount++; 894184610Salfred } 895184610Salfred 896184610Salfred parm.size[0] += sizeof(xfer[0]); 897184610Salfred 898184610Salfred xfer->pipe = pipe; 899184610Salfred 900184610Salfred if (buf) { 901184610Salfred /* 902184610Salfred * Increment the pipe refcount. This 903184610Salfred * basically prevents setting a new 904184610Salfred * configuration and alternate setting 905184610Salfred * when USB transfers are in use on 906184610Salfred * the given interface. Search the USB 907184610Salfred * code for "pipe->refcount" if you 908184610Salfred * want more information. 909184610Salfred */ 910184610Salfred xfer->pipe->refcount++; 911184610Salfred } 912184610Salfred parm.methods = xfer->pipe->methods; 913184610Salfred parm.curr_xfer = xfer; 914184610Salfred 915184610Salfred /* 916184610Salfred * Call the Host or Device controller transfer setup 917184610Salfred * routine: 918184610Salfred */ 919184610Salfred (udev->bus->methods->xfer_setup) (&parm); 920184610Salfred 921184610Salfred if (parm.err) { 922184610Salfred goto done; 923184610Salfred } 924184610Salfred } 925184610Salfred 926184610Salfred if (buf || parm.err) { 927184610Salfred goto done; 928184610Salfred } 929184610Salfred if (refcount == 0) { 930184610Salfred /* no transfers - nothing to do ! */ 931184610Salfred goto done; 932184610Salfred } 933184610Salfred /* align data properly */ 934184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 935184610Salfred 936184610Salfred /* store offset temporarily */ 937184610Salfred parm.size[1] = parm.size[0]; 938184610Salfred 939184610Salfred /* 940184610Salfred * The number of DMA tags required depends on 941184610Salfred * the number of endpoints. The current estimate 942184610Salfred * for maximum number of DMA tags per endpoint 943184610Salfred * is two. 944184610Salfred */ 945184610Salfred parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX); 946184610Salfred 947184610Salfred /* 948184610Salfred * DMA tags for QH, TD, Data and more. 949184610Salfred */ 950184610Salfred parm.dma_tag_max += 8; 951184610Salfred 952184610Salfred parm.dma_tag_p += parm.dma_tag_max; 953184610Salfred 954184610Salfred parm.size[0] += ((uint8_t *)parm.dma_tag_p) - 955184610Salfred ((uint8_t *)0); 956184610Salfred 957184610Salfred /* align data properly */ 958184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 959184610Salfred 960184610Salfred /* store offset temporarily */ 961184610Salfred parm.size[3] = parm.size[0]; 962184610Salfred 963184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_ptr) - 964184610Salfred ((uint8_t *)0); 965184610Salfred 966184610Salfred /* align data properly */ 967184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 968184610Salfred 969184610Salfred /* store offset temporarily */ 970184610Salfred parm.size[4] = parm.size[0]; 971184610Salfred 972184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) - 973184610Salfred ((uint8_t *)0); 974184610Salfred 975184610Salfred /* store end offset temporarily */ 976184610Salfred parm.size[5] = parm.size[0]; 977184610Salfred 978184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) - 979184610Salfred ((uint8_t *)0); 980184610Salfred 981184610Salfred /* store end offset temporarily */ 982184610Salfred 983184610Salfred parm.size[2] = parm.size[0]; 984184610Salfred 985184610Salfred /* align data properly */ 986184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 987184610Salfred 988184610Salfred parm.size[6] = parm.size[0]; 989184610Salfred 990184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) - 991184610Salfred ((uint8_t *)0); 992184610Salfred 993184610Salfred /* align data properly */ 994184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 995184610Salfred 996184610Salfred /* allocate zeroed memory */ 997184610Salfred buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO); 998184610Salfred 999184610Salfred if (buf == NULL) { 1000184610Salfred parm.err = USB_ERR_NOMEM; 1001184610Salfred DPRINTFN(0, "cannot allocate memory block for " 1002184610Salfred "configuration (%d bytes)\n", 1003184610Salfred parm.size[0]); 1004184610Salfred goto done; 1005184610Salfred } 1006184610Salfred parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]); 1007184610Salfred parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]); 1008184610Salfred parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]); 1009184610Salfred parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]); 1010184610Salfred parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]); 1011184610Salfred } 1012184610Salfred 1013184610Salfreddone: 1014184610Salfred if (buf) { 1015184610Salfred if (info->setup_refcount == 0) { 1016184610Salfred /* 1017184610Salfred * "usb2_transfer_unsetup_sub" will unlock 1018184824Sthompsa * the bus mutex before returning ! 1019184610Salfred */ 1020184824Sthompsa USB_BUS_LOCK(info->bus); 1021184610Salfred 1022184610Salfred /* something went wrong */ 1023184610Salfred usb2_transfer_unsetup_sub(info, 0); 1024184610Salfred } 1025184610Salfred } 1026184610Salfred if (parm.err) { 1027184610Salfred usb2_transfer_unsetup(ppxfer, n_setup); 1028184610Salfred } 1029184610Salfred return (parm.err); 1030184610Salfred} 1031184610Salfred 1032184610Salfred/*------------------------------------------------------------------------* 1033184610Salfred * usb2_transfer_unsetup_sub - factored out code 1034184610Salfred *------------------------------------------------------------------------*/ 1035184610Salfredstatic void 1036184610Salfredusb2_transfer_unsetup_sub(struct usb2_xfer_root *info, uint8_t needs_delay) 1037184610Salfred{ 1038184610Salfred struct usb2_page_cache *pc; 1039184610Salfred uint32_t temp; 1040184610Salfred 1041184824Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 1042184610Salfred 1043184610Salfred /* wait for any outstanding DMA operations */ 1044184610Salfred 1045184610Salfred if (needs_delay) { 1046184610Salfred temp = usb2_get_dma_delay(info->bus); 1047184824Sthompsa usb2_pause_mtx(&info->bus->bus_mtx, temp); 1048184610Salfred } 1049184824Sthompsa USB_BUS_UNLOCK(info->bus); 1050184610Salfred 1051184610Salfred /* wait for interrupt thread to exit */ 1052184610Salfred usb2_proc_unsetup(&info->done_p); 1053184610Salfred 1054184610Salfred /* free DMA'able memory, if any */ 1055184610Salfred pc = info->dma_page_cache_start; 1056184610Salfred while (pc != info->dma_page_cache_end) { 1057184610Salfred usb2_pc_free_mem(pc); 1058184610Salfred pc++; 1059184610Salfred } 1060184610Salfred 1061184610Salfred /* free DMA maps in all "xfer->frbuffers" */ 1062184610Salfred pc = info->xfer_page_cache_start; 1063184610Salfred while (pc != info->xfer_page_cache_end) { 1064184610Salfred usb2_pc_dmamap_destroy(pc); 1065184610Salfred pc++; 1066184610Salfred } 1067184610Salfred 1068184610Salfred /* free all DMA tags */ 1069184610Salfred usb2_dma_tag_unsetup(&info->dma_parent_tag); 1070184610Salfred 1071184610Salfred usb2_cv_destroy(&info->cv_drain); 1072184610Salfred 1073184610Salfred /* 1074184610Salfred * free the "memory_base" last, hence the "info" structure is 1075184610Salfred * contained within the "memory_base"! 1076184610Salfred */ 1077184610Salfred free(info->memory_base, M_USB); 1078184610Salfred} 1079184610Salfred 1080184610Salfred/*------------------------------------------------------------------------* 1081184610Salfred * usb2_transfer_unsetup - unsetup/free an array of USB transfers 1082184610Salfred * 1083184610Salfred * NOTE: All USB transfers in progress will get called back passing 1084184610Salfred * the error code "USB_ERR_CANCELLED" before this function 1085184610Salfred * returns. 1086184610Salfred *------------------------------------------------------------------------*/ 1087184610Salfredvoid 1088184610Salfredusb2_transfer_unsetup(struct usb2_xfer **pxfer, uint16_t n_setup) 1089184610Salfred{ 1090184610Salfred struct usb2_xfer *xfer; 1091184610Salfred struct usb2_xfer_root *info; 1092184610Salfred uint8_t needs_delay = 0; 1093184610Salfred 1094184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1095184610Salfred "usb2_transfer_unsetup can sleep!"); 1096184610Salfred 1097184610Salfred while (n_setup--) { 1098184610Salfred xfer = pxfer[n_setup]; 1099184610Salfred 1100184610Salfred if (xfer) { 1101184610Salfred if (xfer->pipe) { 1102184824Sthompsa USB_XFER_LOCK(xfer); 1103184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1104184610Salfred 1105184610Salfred /* 1106184610Salfred * HINT: when you start/stop a transfer, it 1107184610Salfred * might be a good idea to directly use the 1108184610Salfred * "pxfer[]" structure: 1109184610Salfred * 1110184610Salfred * usb2_transfer_start(sc->pxfer[0]); 1111184610Salfred * usb2_transfer_stop(sc->pxfer[0]); 1112184610Salfred * 1113184610Salfred * That way, if your code has many parts that 1114184610Salfred * will not stop running under the same 1115184610Salfred * lock, in other words "priv_mtx", the 1116184610Salfred * usb2_transfer_start and 1117184610Salfred * usb2_transfer_stop functions will simply 1118184610Salfred * return when they detect a NULL pointer 1119184610Salfred * argument. 1120184610Salfred * 1121184610Salfred * To avoid any races we clear the "pxfer[]" 1122184610Salfred * pointer while holding the private mutex 1123184610Salfred * of the driver: 1124184610Salfred */ 1125184610Salfred pxfer[n_setup] = NULL; 1126184610Salfred 1127184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1128184824Sthompsa USB_XFER_UNLOCK(xfer); 1129184610Salfred 1130184610Salfred usb2_transfer_drain(xfer); 1131184610Salfred 1132184610Salfred if (xfer->flags_int.bdma_enable) { 1133184610Salfred needs_delay = 1; 1134184610Salfred } 1135184610Salfred /* 1136184610Salfred * NOTE: default pipe does not have an 1137184610Salfred * interface, even if pipe->iface_index == 0 1138184610Salfred */ 1139184610Salfred xfer->pipe->refcount--; 1140184610Salfred 1141184610Salfred } else { 1142184610Salfred /* clear the transfer pointer */ 1143184610Salfred pxfer[n_setup] = NULL; 1144184610Salfred } 1145184610Salfred 1146184610Salfred usb2_callout_drain(&xfer->timeout_handle); 1147184610Salfred 1148184610Salfred if (xfer->usb2_root) { 1149184610Salfred info = xfer->usb2_root; 1150184610Salfred 1151184824Sthompsa USB_BUS_LOCK(info->bus); 1152184610Salfred 1153184610Salfred USB_ASSERT(info->setup_refcount != 0, 1154184610Salfred ("Invalid setup " 1155184610Salfred "reference count!\n")); 1156184610Salfred 1157184610Salfred info->setup_refcount--; 1158184610Salfred 1159184610Salfred if (info->setup_refcount == 0) { 1160184610Salfred usb2_transfer_unsetup_sub(info, 1161184610Salfred needs_delay); 1162184610Salfred } else { 1163184824Sthompsa USB_BUS_UNLOCK(info->bus); 1164184610Salfred } 1165184610Salfred } 1166184610Salfred } 1167184610Salfred } 1168184610Salfred} 1169184610Salfred 1170184610Salfred/*------------------------------------------------------------------------* 1171184610Salfred * usb2_control_transfer_init - factored out code 1172184610Salfred * 1173184610Salfred * In USB Device Mode we have to wait for the SETUP packet which 1174184610Salfred * containst the "struct usb2_device_request" structure, before we can 1175184610Salfred * transfer any data. In USB Host Mode we already have the SETUP 1176184610Salfred * packet at the moment the USB transfer is started. This leads us to 1177184610Salfred * having to setup the USB transfer at two different places in 1178184610Salfred * time. This function just contains factored out control transfer 1179184610Salfred * initialisation code, so that we don't duplicate the code. 1180184610Salfred *------------------------------------------------------------------------*/ 1181184610Salfredstatic void 1182184610Salfredusb2_control_transfer_init(struct usb2_xfer *xfer) 1183184610Salfred{ 1184184610Salfred struct usb2_device_request req; 1185184610Salfred 1186184610Salfred /* copy out the USB request header */ 1187184610Salfred 1188184610Salfred usb2_copy_out(xfer->frbuffers, 0, &req, sizeof(req)); 1189184610Salfred 1190184610Salfred /* setup remainder */ 1191184610Salfred 1192184610Salfred xfer->flags_int.control_rem = UGETW(req.wLength); 1193184610Salfred 1194184610Salfred /* copy direction to endpoint variable */ 1195184610Salfred 1196184610Salfred xfer->endpoint &= ~(UE_DIR_IN | UE_DIR_OUT); 1197184610Salfred xfer->endpoint |= 1198184610Salfred (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT; 1199184610Salfred} 1200184610Salfred 1201184610Salfred/*------------------------------------------------------------------------* 1202184610Salfred * usb2_start_hardware_sub 1203184610Salfred * 1204184610Salfred * This function handles initialisation of control transfers. Control 1205184610Salfred * transfers are special in that regard that they can both transmit 1206184610Salfred * and receive data. 1207184610Salfred * 1208184610Salfred * Return values: 1209184610Salfred * 0: Success 1210184610Salfred * Else: Failure 1211184610Salfred *------------------------------------------------------------------------*/ 1212184610Salfredstatic uint8_t 1213184610Salfredusb2_start_hardware_sub(struct usb2_xfer *xfer) 1214184610Salfred{ 1215184610Salfred uint32_t len; 1216184610Salfred 1217184610Salfred /* Check for control endpoint stall */ 1218184610Salfred if (xfer->flags.stall_pipe) { 1219184610Salfred /* no longer active */ 1220184610Salfred xfer->flags_int.control_act = 0; 1221184610Salfred } 1222184610Salfred /* 1223184610Salfred * Check if there is a control 1224184610Salfred * transfer in progress: 1225184610Salfred */ 1226184610Salfred if (xfer->flags_int.control_act) { 1227184610Salfred 1228184610Salfred if (xfer->flags_int.control_hdr) { 1229184610Salfred 1230184610Salfred /* clear send header flag */ 1231184610Salfred 1232184610Salfred xfer->flags_int.control_hdr = 0; 1233184610Salfred 1234184610Salfred /* setup control transfer */ 1235184610Salfred if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) { 1236184610Salfred usb2_control_transfer_init(xfer); 1237184610Salfred } 1238184610Salfred } 1239184610Salfred /* get data length */ 1240184610Salfred 1241184610Salfred len = xfer->sumlen; 1242184610Salfred 1243184610Salfred } else { 1244184610Salfred 1245184610Salfred /* the size of the SETUP structure is hardcoded ! */ 1246184610Salfred 1247184610Salfred if (xfer->frlengths[0] != sizeof(struct usb2_device_request)) { 1248184610Salfred DPRINTFN(0, "Wrong framelength %u != %zu\n", 1249184610Salfred xfer->frlengths[0], sizeof(struct 1250184610Salfred usb2_device_request)); 1251184610Salfred goto error; 1252184610Salfred } 1253184610Salfred /* check USB mode */ 1254184610Salfred if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) { 1255184610Salfred 1256184610Salfred /* check number of frames */ 1257184610Salfred if (xfer->nframes != 1) { 1258184610Salfred /* 1259184610Salfred * We need to receive the setup 1260184610Salfred * message first so that we know the 1261184610Salfred * data direction! 1262184610Salfred */ 1263184610Salfred DPRINTF("Misconfigured transfer\n"); 1264184610Salfred goto error; 1265184610Salfred } 1266184610Salfred /* 1267184610Salfred * Set a dummy "control_rem" value. This 1268184610Salfred * variable will be overwritten later by a 1269184610Salfred * call to "usb2_control_transfer_init()" ! 1270184610Salfred */ 1271184610Salfred xfer->flags_int.control_rem = 0xFFFF; 1272184610Salfred } else { 1273184610Salfred 1274184610Salfred /* setup "endpoint" and "control_rem" */ 1275184610Salfred 1276184610Salfred usb2_control_transfer_init(xfer); 1277184610Salfred } 1278184610Salfred 1279184610Salfred /* set transfer-header flag */ 1280184610Salfred 1281184610Salfred xfer->flags_int.control_hdr = 1; 1282184610Salfred 1283184610Salfred /* get data length */ 1284184610Salfred 1285184610Salfred len = (xfer->sumlen - sizeof(struct usb2_device_request)); 1286184610Salfred } 1287184610Salfred 1288184610Salfred /* check if there is a length mismatch */ 1289184610Salfred 1290184610Salfred if (len > xfer->flags_int.control_rem) { 1291184610Salfred DPRINTFN(0, "Length greater than remaining length!\n"); 1292184610Salfred goto error; 1293184610Salfred } 1294184610Salfred /* check if we are doing a short transfer */ 1295184610Salfred 1296184610Salfred if (xfer->flags.force_short_xfer) { 1297184610Salfred xfer->flags_int.control_rem = 0; 1298184610Salfred } else { 1299184610Salfred if ((len != xfer->max_data_length) && 1300184610Salfred (len != xfer->flags_int.control_rem) && 1301184610Salfred (xfer->nframes != 1)) { 1302184610Salfred DPRINTFN(0, "Short control transfer without " 1303184610Salfred "force_short_xfer set!\n"); 1304184610Salfred goto error; 1305184610Salfred } 1306184610Salfred xfer->flags_int.control_rem -= len; 1307184610Salfred } 1308184610Salfred 1309184610Salfred /* the status part is executed when "control_act" is 0 */ 1310184610Salfred 1311184610Salfred if ((xfer->flags_int.control_rem > 0) || 1312184610Salfred (xfer->flags.manual_status)) { 1313184610Salfred /* don't execute the STATUS stage yet */ 1314184610Salfred xfer->flags_int.control_act = 1; 1315184610Salfred 1316184610Salfred /* sanity check */ 1317184610Salfred if ((!xfer->flags_int.control_hdr) && 1318184610Salfred (xfer->nframes == 1)) { 1319184610Salfred /* 1320184610Salfred * This is not a valid operation! 1321184610Salfred */ 1322184610Salfred DPRINTFN(0, "Invalid parameter " 1323184610Salfred "combination\n"); 1324184610Salfred goto error; 1325184610Salfred } 1326184610Salfred } else { 1327184610Salfred /* time to execute the STATUS stage */ 1328184610Salfred xfer->flags_int.control_act = 0; 1329184610Salfred } 1330184610Salfred return (0); /* success */ 1331184610Salfred 1332184610Salfrederror: 1333184610Salfred return (1); /* failure */ 1334184610Salfred} 1335184610Salfred 1336184610Salfred/*------------------------------------------------------------------------* 1337184610Salfred * usb2_start_hardware - start USB hardware for the given transfer 1338184610Salfred * 1339184610Salfred * This function should only be called from the USB callback. 1340184610Salfred *------------------------------------------------------------------------*/ 1341184610Salfredvoid 1342184610Salfredusb2_start_hardware(struct usb2_xfer *xfer) 1343184610Salfred{ 1344184610Salfred uint32_t x; 1345184610Salfred 1346184610Salfred DPRINTF("xfer=%p, pipe=%p, nframes=%d, dir=%s\n", 1347184610Salfred xfer, xfer->pipe, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ? 1348184610Salfred "read" : "write"); 1349184610Salfred 1350184610Salfred#if USB_DEBUG 1351184610Salfred if (USB_DEBUG_VAR > 0) { 1352184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1353184610Salfred 1354184610Salfred usb2_dump_pipe(xfer->pipe); 1355184610Salfred 1356184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1357184610Salfred } 1358184610Salfred#endif 1359184610Salfred 1360184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1361184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_NOTOWNED); 1362184610Salfred 1363184610Salfred /* Only open the USB transfer once! */ 1364184610Salfred if (!xfer->flags_int.open) { 1365184610Salfred xfer->flags_int.open = 1; 1366184610Salfred 1367184610Salfred DPRINTF("open\n"); 1368184610Salfred 1369184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1370184610Salfred (xfer->pipe->methods->open) (xfer); 1371184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1372184610Salfred } 1373184610Salfred /* set "transferring" flag */ 1374184610Salfred xfer->flags_int.transferring = 1; 1375184610Salfred 1376186730Salfred /* increment power reference */ 1377186730Salfred usb2_transfer_power_ref(xfer, 1); 1378186730Salfred 1379184610Salfred /* 1380184610Salfred * Check if the transfer is waiting on a queue, most 1381184610Salfred * frequently the "done_q": 1382184610Salfred */ 1383184610Salfred if (xfer->wait_queue) { 1384184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1385184610Salfred usb2_transfer_dequeue(xfer); 1386184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1387184610Salfred } 1388184610Salfred /* clear "did_dma_delay" flag */ 1389184610Salfred xfer->flags_int.did_dma_delay = 0; 1390184610Salfred 1391184610Salfred /* clear "did_close" flag */ 1392184610Salfred xfer->flags_int.did_close = 0; 1393184610Salfred 1394184610Salfred /* clear "bdma_setup" flag */ 1395184610Salfred xfer->flags_int.bdma_setup = 0; 1396184610Salfred 1397184610Salfred /* by default we cannot cancel any USB transfer immediately */ 1398184610Salfred xfer->flags_int.can_cancel_immed = 0; 1399184610Salfred 1400184610Salfred /* clear lengths and frame counts by default */ 1401184610Salfred xfer->sumlen = 0; 1402184610Salfred xfer->actlen = 0; 1403184610Salfred xfer->aframes = 0; 1404184610Salfred 1405184610Salfred /* clear any previous errors */ 1406184610Salfred xfer->error = 0; 1407184610Salfred 1408184610Salfred /* sanity check */ 1409184610Salfred 1410184610Salfred if (xfer->nframes == 0) { 1411184610Salfred if (xfer->flags.stall_pipe) { 1412184610Salfred /* 1413184610Salfred * Special case - want to stall without transferring 1414184610Salfred * any data: 1415184610Salfred */ 1416184610Salfred DPRINTF("xfer=%p nframes=0: stall " 1417184610Salfred "or clear stall!\n", xfer); 1418184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1419184610Salfred xfer->flags_int.can_cancel_immed = 1; 1420184610Salfred /* start the transfer */ 1421184610Salfred usb2_command_wrapper(&xfer->pipe->pipe_q, xfer); 1422184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1423184610Salfred return; 1424184610Salfred } 1425184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1426184610Salfred usb2_transfer_done(xfer, USB_ERR_INVAL); 1427184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1428184610Salfred return; 1429184610Salfred } 1430184610Salfred /* compute total transfer length */ 1431184610Salfred 1432184610Salfred for (x = 0; x != xfer->nframes; x++) { 1433184610Salfred xfer->sumlen += xfer->frlengths[x]; 1434184610Salfred if (xfer->sumlen < xfer->frlengths[x]) { 1435184610Salfred /* length wrapped around */ 1436184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1437184610Salfred usb2_transfer_done(xfer, USB_ERR_INVAL); 1438184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1439184610Salfred return; 1440184610Salfred } 1441184610Salfred } 1442184610Salfred 1443184610Salfred /* clear some internal flags */ 1444184610Salfred 1445184610Salfred xfer->flags_int.short_xfer_ok = 0; 1446184610Salfred xfer->flags_int.short_frames_ok = 0; 1447184610Salfred 1448184610Salfred /* check if this is a control transfer */ 1449184610Salfred 1450184610Salfred if (xfer->flags_int.control_xfr) { 1451184610Salfred 1452184610Salfred if (usb2_start_hardware_sub(xfer)) { 1453184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1454184610Salfred usb2_transfer_done(xfer, USB_ERR_STALLED); 1455184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1456184610Salfred return; 1457184610Salfred } 1458184610Salfred } 1459184610Salfred /* 1460184610Salfred * Setup filtered version of some transfer flags, 1461184610Salfred * in case of data read direction 1462184610Salfred */ 1463184610Salfred if (USB_GET_DATA_ISREAD(xfer)) { 1464184610Salfred 1465184610Salfred if (xfer->flags_int.control_xfr) { 1466184610Salfred 1467184610Salfred /* 1468184610Salfred * Control transfers do not support reception 1469184610Salfred * of multiple short USB frames ! 1470184610Salfred */ 1471184610Salfred 1472184610Salfred if (xfer->flags.short_xfer_ok) { 1473184610Salfred xfer->flags_int.short_xfer_ok = 1; 1474184610Salfred } 1475184610Salfred } else { 1476184610Salfred 1477184610Salfred if (xfer->flags.short_frames_ok) { 1478184610Salfred xfer->flags_int.short_xfer_ok = 1; 1479184610Salfred xfer->flags_int.short_frames_ok = 1; 1480184610Salfred } else if (xfer->flags.short_xfer_ok) { 1481184610Salfred xfer->flags_int.short_xfer_ok = 1; 1482184610Salfred } 1483184610Salfred } 1484184610Salfred } 1485184610Salfred /* 1486184610Salfred * Check if BUS-DMA support is enabled and try to load virtual 1487184610Salfred * buffers into DMA, if any: 1488184610Salfred */ 1489184610Salfred if (xfer->flags_int.bdma_enable) { 1490184610Salfred /* insert the USB transfer last in the BUS-DMA queue */ 1491184610Salfred usb2_command_wrapper(&xfer->usb2_root->dma_q, xfer); 1492184610Salfred return; 1493184610Salfred } 1494184610Salfred /* 1495184610Salfred * Enter the USB transfer into the Host Controller or 1496184610Salfred * Device Controller schedule: 1497184610Salfred */ 1498184610Salfred usb2_pipe_enter(xfer); 1499184610Salfred} 1500184610Salfred 1501184610Salfred/*------------------------------------------------------------------------* 1502184610Salfred * usb2_pipe_enter - factored out code 1503184610Salfred *------------------------------------------------------------------------*/ 1504184610Salfredvoid 1505184610Salfredusb2_pipe_enter(struct usb2_xfer *xfer) 1506184610Salfred{ 1507184610Salfred struct usb2_pipe *pipe; 1508184610Salfred 1509184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1510184610Salfred 1511184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1512184610Salfred 1513184610Salfred pipe = xfer->pipe; 1514184610Salfred 1515184610Salfred DPRINTF("enter\n"); 1516184610Salfred 1517184610Salfred /* enter the transfer */ 1518184610Salfred (pipe->methods->enter) (xfer); 1519184610Salfred 1520184610Salfred /* check cancelability */ 1521184610Salfred if (pipe->methods->enter_is_cancelable) { 1522184610Salfred xfer->flags_int.can_cancel_immed = 1; 1523184610Salfred /* check for transfer error */ 1524184610Salfred if (xfer->error) { 1525184610Salfred /* some error has happened */ 1526184610Salfred usb2_transfer_done(xfer, 0); 1527184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1528184610Salfred return; 1529184610Salfred } 1530184610Salfred } else { 1531184610Salfred xfer->flags_int.can_cancel_immed = 0; 1532184610Salfred } 1533184610Salfred 1534184610Salfred /* start the transfer */ 1535184610Salfred usb2_command_wrapper(&pipe->pipe_q, xfer); 1536184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1537184610Salfred} 1538184610Salfred 1539184610Salfred/*------------------------------------------------------------------------* 1540184610Salfred * usb2_transfer_start - start an USB transfer 1541184610Salfred * 1542184610Salfred * NOTE: Calling this function more than one time will only 1543184610Salfred * result in a single transfer start, until the USB transfer 1544184610Salfred * completes. 1545184610Salfred *------------------------------------------------------------------------*/ 1546184610Salfredvoid 1547184610Salfredusb2_transfer_start(struct usb2_xfer *xfer) 1548184610Salfred{ 1549184610Salfred if (xfer == NULL) { 1550184610Salfred /* transfer is gone */ 1551184610Salfred return; 1552184610Salfred } 1553184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1554184610Salfred 1555184610Salfred /* mark the USB transfer started */ 1556184610Salfred 1557184610Salfred if (!xfer->flags_int.started) { 1558184610Salfred xfer->flags_int.started = 1; 1559184610Salfred } 1560184610Salfred /* check if the USB transfer callback is already transferring */ 1561184610Salfred 1562184610Salfred if (xfer->flags_int.transferring) { 1563184610Salfred return; 1564184610Salfred } 1565184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1566184610Salfred /* call the USB transfer callback */ 1567184610Salfred usb2_callback_ss_done_defer(xfer); 1568184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1569184610Salfred} 1570184610Salfred 1571184610Salfred/*------------------------------------------------------------------------* 1572184610Salfred * usb2_transfer_stop - stop an USB transfer 1573184610Salfred * 1574184610Salfred * NOTE: Calling this function more than one time will only 1575184610Salfred * result in a single transfer stop. 1576184610Salfred * NOTE: When this function returns it is not safe to free nor 1577184610Salfred * reuse any DMA buffers. See "usb2_transfer_drain()". 1578184610Salfred *------------------------------------------------------------------------*/ 1579184610Salfredvoid 1580184610Salfredusb2_transfer_stop(struct usb2_xfer *xfer) 1581184610Salfred{ 1582184610Salfred struct usb2_pipe *pipe; 1583184610Salfred 1584184610Salfred if (xfer == NULL) { 1585184610Salfred /* transfer is gone */ 1586184610Salfred return; 1587184610Salfred } 1588184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1589184610Salfred 1590184610Salfred /* check if the USB transfer was ever opened */ 1591184610Salfred 1592184610Salfred if (!xfer->flags_int.open) { 1593184610Salfred /* nothing to do except clearing the "started" flag */ 1594184610Salfred xfer->flags_int.started = 0; 1595184610Salfred return; 1596184610Salfred } 1597184610Salfred /* try to stop the current USB transfer */ 1598184610Salfred 1599184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1600184610Salfred xfer->error = USB_ERR_CANCELLED;/* override any previous error */ 1601184610Salfred /* 1602184610Salfred * Clear "open" and "started" when both private and USB lock 1603184610Salfred * is locked so that we don't get a race updating "flags_int" 1604184610Salfred */ 1605184610Salfred xfer->flags_int.open = 0; 1606184610Salfred xfer->flags_int.started = 0; 1607184610Salfred 1608184610Salfred /* 1609184610Salfred * Check if we can cancel the USB transfer immediately. 1610184610Salfred */ 1611184610Salfred if (xfer->flags_int.transferring) { 1612184610Salfred if (xfer->flags_int.can_cancel_immed && 1613184610Salfred (!xfer->flags_int.did_close)) { 1614184610Salfred DPRINTF("close\n"); 1615184610Salfred /* 1616184610Salfred * The following will lead to an USB_ERR_CANCELLED 1617184610Salfred * error code being passed to the USB callback. 1618184610Salfred */ 1619184610Salfred (xfer->pipe->methods->close) (xfer); 1620184610Salfred /* only close once */ 1621184610Salfred xfer->flags_int.did_close = 1; 1622184610Salfred } else { 1623184610Salfred /* need to wait for the next done callback */ 1624184610Salfred } 1625184610Salfred } else { 1626184610Salfred DPRINTF("close\n"); 1627184610Salfred 1628184610Salfred /* close here and now */ 1629184610Salfred (xfer->pipe->methods->close) (xfer); 1630184610Salfred 1631184610Salfred /* 1632184610Salfred * Any additional DMA delay is done by 1633184610Salfred * "usb2_transfer_unsetup()". 1634184610Salfred */ 1635184610Salfred 1636184610Salfred /* 1637184610Salfred * Special case. Check if we need to restart a blocked 1638184610Salfred * pipe. 1639184610Salfred */ 1640184610Salfred pipe = xfer->pipe; 1641184610Salfred 1642184610Salfred /* 1643184610Salfred * If the current USB transfer is completing we need 1644184610Salfred * to start the next one: 1645184610Salfred */ 1646184610Salfred if (pipe->pipe_q.curr == xfer) { 1647184610Salfred usb2_command_wrapper(&pipe->pipe_q, NULL); 1648184610Salfred } 1649184610Salfred } 1650184610Salfred 1651184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1652184610Salfred} 1653184610Salfred 1654184610Salfred/*------------------------------------------------------------------------* 1655184610Salfred * usb2_transfer_pending 1656184610Salfred * 1657184610Salfred * This function will check if an USB transfer is pending which is a 1658184610Salfred * little bit complicated! 1659184610Salfred * Return values: 1660184610Salfred * 0: Not pending 1661184610Salfred * 1: Pending: The USB transfer will receive a callback in the future. 1662184610Salfred *------------------------------------------------------------------------*/ 1663184610Salfreduint8_t 1664184610Salfredusb2_transfer_pending(struct usb2_xfer *xfer) 1665184610Salfred{ 1666184610Salfred struct usb2_xfer_root *info; 1667184610Salfred struct usb2_xfer_queue *pq; 1668184610Salfred 1669184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1670184610Salfred 1671184610Salfred if (xfer->flags_int.transferring) { 1672184610Salfred /* trivial case */ 1673184610Salfred return (1); 1674184610Salfred } 1675184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1676184610Salfred if (xfer->wait_queue) { 1677184610Salfred /* we are waiting on a queue somewhere */ 1678184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1679184610Salfred return (1); 1680184610Salfred } 1681184610Salfred info = xfer->usb2_root; 1682184610Salfred pq = &info->done_q; 1683184610Salfred 1684184610Salfred if (pq->curr == xfer) { 1685184610Salfred /* we are currently scheduled for callback */ 1686184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1687184610Salfred return (1); 1688184610Salfred } 1689184610Salfred /* we are not pending */ 1690184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1691184610Salfred return (0); 1692184610Salfred} 1693184610Salfred 1694184610Salfred/*------------------------------------------------------------------------* 1695184610Salfred * usb2_transfer_drain 1696184610Salfred * 1697184610Salfred * This function will stop the USB transfer and wait for any 1698184610Salfred * additional BUS-DMA and HW-DMA operations to complete. Buffers that 1699184610Salfred * are loaded into DMA can safely be freed or reused after that this 1700184610Salfred * function has returned. 1701184610Salfred *------------------------------------------------------------------------*/ 1702184610Salfredvoid 1703184610Salfredusb2_transfer_drain(struct usb2_xfer *xfer) 1704184610Salfred{ 1705184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1706184610Salfred "usb2_transfer_drain can sleep!"); 1707184610Salfred 1708184610Salfred if (xfer == NULL) { 1709184610Salfred /* transfer is gone */ 1710184610Salfred return; 1711184610Salfred } 1712184824Sthompsa if (xfer->xfer_mtx != &Giant) { 1713184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED); 1714184610Salfred } 1715184824Sthompsa USB_XFER_LOCK(xfer); 1716184610Salfred 1717184610Salfred usb2_transfer_stop(xfer); 1718184610Salfred 1719184610Salfred while (usb2_transfer_pending(xfer)) { 1720184610Salfred xfer->flags_int.draining = 1; 1721184610Salfred /* 1722184610Salfred * Wait until the current outstanding USB 1723184610Salfred * transfer is complete ! 1724184610Salfred */ 1725184824Sthompsa usb2_cv_wait(&xfer->usb2_root->cv_drain, xfer->xfer_mtx); 1726184610Salfred } 1727184824Sthompsa USB_XFER_UNLOCK(xfer); 1728184610Salfred} 1729184610Salfred 1730184610Salfred/*------------------------------------------------------------------------* 1731184610Salfred * usb2_set_frame_data 1732184610Salfred * 1733184610Salfred * This function sets the pointer of the buffer that should 1734184610Salfred * loaded directly into DMA for the given USB frame. Passing "ptr" 1735184610Salfred * equal to NULL while the corresponding "frlength" is greater 1736184610Salfred * than zero gives undefined results! 1737184610Salfred *------------------------------------------------------------------------*/ 1738184610Salfredvoid 1739184610Salfredusb2_set_frame_data(struct usb2_xfer *xfer, void *ptr, uint32_t frindex) 1740184610Salfred{ 1741184610Salfred /* set virtual address to load and length */ 1742184610Salfred xfer->frbuffers[frindex].buffer = ptr; 1743184610Salfred} 1744184610Salfred 1745184610Salfred/*------------------------------------------------------------------------* 1746184610Salfred * usb2_set_frame_offset 1747184610Salfred * 1748184610Salfred * This function sets the frame data buffer offset relative to the beginning 1749184610Salfred * of the USB DMA buffer allocated for this USB transfer. 1750184610Salfred *------------------------------------------------------------------------*/ 1751184610Salfredvoid 1752184610Salfredusb2_set_frame_offset(struct usb2_xfer *xfer, uint32_t offset, 1753184610Salfred uint32_t frindex) 1754184610Salfred{ 1755184610Salfred USB_ASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame " 1756184610Salfred "when the USB buffer is external!\n")); 1757184610Salfred 1758184610Salfred /* set virtual address to load */ 1759184610Salfred xfer->frbuffers[frindex].buffer = 1760184610Salfred USB_ADD_BYTES(xfer->local_buffer, offset); 1761184610Salfred} 1762184610Salfred 1763184610Salfred/*------------------------------------------------------------------------* 1764184610Salfred * usb2_callback_proc - factored out code 1765184610Salfred * 1766184610Salfred * This function performs USB callbacks. 1767184610Salfred *------------------------------------------------------------------------*/ 1768184610Salfredstatic void 1769184610Salfredusb2_callback_proc(struct usb2_proc_msg *_pm) 1770184610Salfred{ 1771184610Salfred struct usb2_done_msg *pm = (void *)_pm; 1772184610Salfred struct usb2_xfer_root *info = pm->usb2_root; 1773184610Salfred 1774184610Salfred /* Change locking order */ 1775184824Sthompsa USB_BUS_UNLOCK(info->bus); 1776184610Salfred 1777184610Salfred /* 1778184610Salfred * We exploit the fact that the mutex is the same for all 1779184610Salfred * callbacks that will be called from this thread: 1780184610Salfred */ 1781184610Salfred mtx_lock(info->priv_mtx); 1782184824Sthompsa USB_BUS_LOCK(info->bus); 1783184610Salfred 1784184610Salfred /* Continue where we lost track */ 1785184610Salfred usb2_command_wrapper(&info->done_q, 1786184610Salfred info->done_q.curr); 1787184610Salfred 1788184610Salfred mtx_unlock(info->priv_mtx); 1789184610Salfred} 1790184610Salfred 1791184610Salfred/*------------------------------------------------------------------------* 1792184610Salfred * usb2_callback_ss_done_defer 1793184610Salfred * 1794184610Salfred * This function will defer the start, stop and done callback to the 1795184610Salfred * correct thread. 1796184610Salfred *------------------------------------------------------------------------*/ 1797184610Salfredstatic void 1798184610Salfredusb2_callback_ss_done_defer(struct usb2_xfer *xfer) 1799184610Salfred{ 1800184610Salfred struct usb2_xfer_root *info = xfer->usb2_root; 1801184610Salfred struct usb2_xfer_queue *pq = &info->done_q; 1802184610Salfred 1803184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 1804184824Sthompsa 1805184610Salfred if (pq->curr != xfer) { 1806184610Salfred usb2_transfer_enqueue(pq, xfer); 1807184610Salfred } 1808184610Salfred if (!pq->recurse_1) { 1809184610Salfred 1810184610Salfred /* 1811184610Salfred * We have to postpone the callback due to the fact we 1812184610Salfred * will have a Lock Order Reversal, LOR, if we try to 1813184610Salfred * proceed ! 1814184610Salfred */ 1815184610Salfred if (usb2_proc_msignal(&info->done_p, 1816184610Salfred &info->done_m[0], &info->done_m[1])) { 1817184610Salfred /* ignore */ 1818184610Salfred } 1819184610Salfred } else { 1820184610Salfred /* clear second recurse flag */ 1821184610Salfred pq->recurse_2 = 0; 1822184610Salfred } 1823184610Salfred return; 1824184610Salfred 1825184610Salfred} 1826184610Salfred 1827184610Salfred/*------------------------------------------------------------------------* 1828184610Salfred * usb2_callback_wrapper 1829184610Salfred * 1830184610Salfred * This is a wrapper for USB callbacks. This wrapper does some 1831184610Salfred * auto-magic things like figuring out if we can call the callback 1832184610Salfred * directly from the current context or if we need to wakeup the 1833184610Salfred * interrupt process. 1834184610Salfred *------------------------------------------------------------------------*/ 1835184610Salfredstatic void 1836184610Salfredusb2_callback_wrapper(struct usb2_xfer_queue *pq) 1837184610Salfred{ 1838184610Salfred struct usb2_xfer *xfer = pq->curr; 1839184610Salfred struct usb2_xfer_root *info = xfer->usb2_root; 1840184610Salfred 1841184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 1842184824Sthompsa if (!mtx_owned(xfer->xfer_mtx)) { 1843184610Salfred /* 1844184610Salfred * Cases that end up here: 1845184610Salfred * 1846184610Salfred * 5) HW interrupt done callback or other source. 1847184610Salfred */ 1848184610Salfred DPRINTFN(3, "case 5\n"); 1849184610Salfred 1850184610Salfred /* 1851184610Salfred * We have to postpone the callback due to the fact we 1852184610Salfred * will have a Lock Order Reversal, LOR, if we try to 1853184610Salfred * proceed ! 1854184610Salfred */ 1855184610Salfred if (usb2_proc_msignal(&info->done_p, 1856184610Salfred &info->done_m[0], &info->done_m[1])) { 1857184610Salfred /* ignore */ 1858184610Salfred } 1859184610Salfred return; 1860184610Salfred } 1861184610Salfred /* 1862184610Salfred * Cases that end up here: 1863184610Salfred * 1864184610Salfred * 1) We are starting a transfer 1865184610Salfred * 2) We are prematurely calling back a transfer 1866184610Salfred * 3) We are stopping a transfer 1867184610Salfred * 4) We are doing an ordinary callback 1868184610Salfred */ 1869184610Salfred DPRINTFN(3, "case 1-4\n"); 1870184610Salfred /* get next USB transfer in the queue */ 1871184610Salfred info->done_q.curr = NULL; 1872184610Salfred 1873184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 1874184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_NOTOWNED); 1875184610Salfred 1876184610Salfred /* set correct USB state for callback */ 1877184610Salfred if (!xfer->flags_int.transferring) { 1878184610Salfred xfer->usb2_state = USB_ST_SETUP; 1879184610Salfred if (!xfer->flags_int.started) { 1880184610Salfred /* we got stopped before we even got started */ 1881184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1882184610Salfred goto done; 1883184610Salfred } 1884184610Salfred } else { 1885184610Salfred 1886184610Salfred if (usb2_callback_wrapper_sub(xfer)) { 1887184610Salfred /* the callback has been deferred */ 1888184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1889184610Salfred goto done; 1890184610Salfred } 1891186730Salfred /* decrement power reference */ 1892186730Salfred usb2_transfer_power_ref(xfer, -1); 1893186730Salfred 1894184610Salfred xfer->flags_int.transferring = 0; 1895184610Salfred 1896184610Salfred if (xfer->error) { 1897184610Salfred xfer->usb2_state = USB_ST_ERROR; 1898184610Salfred } else { 1899184610Salfred /* set transferred state */ 1900184610Salfred xfer->usb2_state = USB_ST_TRANSFERRED; 1901184610Salfred 1902184610Salfred /* sync DMA memory, if any */ 1903184610Salfred if (xfer->flags_int.bdma_enable && 1904184610Salfred (!xfer->flags_int.bdma_no_post_sync)) { 1905184610Salfred usb2_bdma_post_sync(xfer); 1906184610Salfred } 1907184610Salfred } 1908184610Salfred } 1909184610Salfred 1910184610Salfred /* call processing routine */ 1911184610Salfred (xfer->callback) (xfer); 1912184610Salfred 1913184610Salfred /* pickup the USB mutex again */ 1914184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 1915184610Salfred 1916184610Salfred /* 1917184610Salfred * Check if we got started after that we got cancelled, but 1918187166Sthompsa * before we managed to do the callback. 1919184610Salfred */ 1920184610Salfred if ((!xfer->flags_int.open) && 1921184610Salfred (xfer->flags_int.started) && 1922184610Salfred (xfer->usb2_state == USB_ST_ERROR)) { 1923184610Salfred /* try to loop, but not recursivly */ 1924184610Salfred usb2_command_wrapper(&info->done_q, xfer); 1925184610Salfred return; 1926187166Sthompsa } 1927187166Sthompsa 1928187166Sthompsadone: 1929187166Sthompsa /* 1930187166Sthompsa * Check if we are draining. 1931187166Sthompsa */ 1932187166Sthompsa if (xfer->flags_int.draining && 1933184610Salfred (!xfer->flags_int.transferring)) { 1934184610Salfred /* "usb2_transfer_drain()" is waiting for end of transfer */ 1935184610Salfred xfer->flags_int.draining = 0; 1936184610Salfred usb2_cv_broadcast(&xfer->usb2_root->cv_drain); 1937184610Salfred } 1938187166Sthompsa 1939184610Salfred /* do the next callback, if any */ 1940184610Salfred usb2_command_wrapper(&info->done_q, 1941184610Salfred info->done_q.curr); 1942184610Salfred} 1943184610Salfred 1944184610Salfred/*------------------------------------------------------------------------* 1945184610Salfred * usb2_dma_delay_done_cb 1946184610Salfred * 1947184610Salfred * This function is called when the DMA delay has been exectuded, and 1948184610Salfred * will make sure that the callback is called to complete the USB 1949184610Salfred * transfer. This code path is ususally only used when there is an USB 1950184610Salfred * error like USB_ERR_CANCELLED. 1951184610Salfred *------------------------------------------------------------------------*/ 1952184610Salfredstatic void 1953184610Salfredusb2_dma_delay_done_cb(void *arg) 1954184610Salfred{ 1955184610Salfred struct usb2_xfer *xfer = arg; 1956184610Salfred 1957184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 1958184610Salfred 1959184610Salfred DPRINTFN(3, "Completed %p\n", xfer); 1960184610Salfred 1961184610Salfred /* queue callback for execution, again */ 1962184610Salfred usb2_transfer_done(xfer, 0); 1963184610Salfred} 1964184610Salfred 1965184610Salfred/*------------------------------------------------------------------------* 1966184610Salfred * usb2_transfer_dequeue 1967184610Salfred * 1968184610Salfred * - This function is used to remove an USB transfer from a USB 1969184610Salfred * transfer queue. 1970184610Salfred * 1971184610Salfred * - This function can be called multiple times in a row. 1972184610Salfred *------------------------------------------------------------------------*/ 1973184610Salfredvoid 1974184610Salfredusb2_transfer_dequeue(struct usb2_xfer *xfer) 1975184610Salfred{ 1976184610Salfred struct usb2_xfer_queue *pq; 1977184610Salfred 1978184610Salfred pq = xfer->wait_queue; 1979184610Salfred if (pq) { 1980184610Salfred TAILQ_REMOVE(&pq->head, xfer, wait_entry); 1981184610Salfred xfer->wait_queue = NULL; 1982184610Salfred } 1983184610Salfred} 1984184610Salfred 1985184610Salfred/*------------------------------------------------------------------------* 1986184610Salfred * usb2_transfer_enqueue 1987184610Salfred * 1988184610Salfred * - This function is used to insert an USB transfer into a USB * 1989184610Salfred * transfer queue. 1990184610Salfred * 1991184610Salfred * - This function can be called multiple times in a row. 1992184610Salfred *------------------------------------------------------------------------*/ 1993184610Salfredvoid 1994184610Salfredusb2_transfer_enqueue(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer) 1995184610Salfred{ 1996184610Salfred /* 1997184610Salfred * Insert the USB transfer into the queue, if it is not 1998184610Salfred * already on a USB transfer queue: 1999184610Salfred */ 2000184610Salfred if (xfer->wait_queue == NULL) { 2001184610Salfred xfer->wait_queue = pq; 2002184610Salfred TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry); 2003184610Salfred } 2004184610Salfred} 2005184610Salfred 2006184610Salfred/*------------------------------------------------------------------------* 2007184610Salfred * usb2_transfer_done 2008184610Salfred * 2009184610Salfred * - This function is used to remove an USB transfer from the busdma, 2010184610Salfred * pipe or interrupt queue. 2011184610Salfred * 2012184610Salfred * - This function is used to queue the USB transfer on the done 2013184610Salfred * queue. 2014184610Salfred * 2015184610Salfred * - This function is used to stop any USB transfer timeouts. 2016184610Salfred *------------------------------------------------------------------------*/ 2017184610Salfredvoid 2018184610Salfredusb2_transfer_done(struct usb2_xfer *xfer, usb2_error_t error) 2019184610Salfred{ 2020184610Salfred struct usb2_xfer_queue *pq; 2021184610Salfred 2022184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 2023184610Salfred 2024184610Salfred DPRINTF("err=%s\n", usb2_errstr(error)); 2025184610Salfred 2026184610Salfred /* 2027184610Salfred * If we are not transferring then just return. 2028184610Salfred * This can happen during transfer cancel. 2029184610Salfred */ 2030184610Salfred if (!xfer->flags_int.transferring) { 2031184610Salfred DPRINTF("not transferring\n"); 2032184610Salfred return; 2033184610Salfred } 2034184610Salfred /* only set transfer error if not already set */ 2035184610Salfred if (!xfer->error) { 2036184610Salfred xfer->error = error; 2037184610Salfred } 2038184610Salfred /* stop any callouts */ 2039184610Salfred usb2_callout_stop(&xfer->timeout_handle); 2040184610Salfred 2041184610Salfred /* 2042184610Salfred * If we are waiting on a queue, just remove the USB transfer 2043184610Salfred * from the queue, if any. We should have the required locks 2044184610Salfred * locked to do the remove when this function is called. 2045184610Salfred */ 2046184610Salfred usb2_transfer_dequeue(xfer); 2047184610Salfred 2048184824Sthompsa if (mtx_owned(xfer->xfer_mtx)) { 2049184610Salfred /* 2050184610Salfred * If the private USB lock is not locked, then we assume 2051184610Salfred * that the BUS-DMA load stage has been passed: 2052184610Salfred */ 2053184610Salfred pq = &xfer->usb2_root->dma_q; 2054184610Salfred 2055184610Salfred if (pq->curr == xfer) { 2056184610Salfred /* start the next BUS-DMA load, if any */ 2057184610Salfred usb2_command_wrapper(pq, NULL); 2058184610Salfred } 2059184610Salfred } 2060184610Salfred /* keep some statistics */ 2061184610Salfred if (xfer->error) { 2062184610Salfred xfer->udev->bus->stats_err.uds_requests 2063184610Salfred [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++; 2064184610Salfred } else { 2065184610Salfred xfer->udev->bus->stats_ok.uds_requests 2066184610Salfred [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++; 2067184610Salfred } 2068184610Salfred 2069184610Salfred /* call the USB transfer callback */ 2070184610Salfred usb2_callback_ss_done_defer(xfer); 2071184610Salfred} 2072184610Salfred 2073184610Salfred/*------------------------------------------------------------------------* 2074184610Salfred * usb2_transfer_start_cb 2075184610Salfred * 2076184610Salfred * This function is called to start the USB transfer when 2077184610Salfred * "xfer->interval" is greater than zero, and and the endpoint type is 2078184610Salfred * BULK or CONTROL. 2079184610Salfred *------------------------------------------------------------------------*/ 2080184610Salfredstatic void 2081184610Salfredusb2_transfer_start_cb(void *arg) 2082184610Salfred{ 2083184610Salfred struct usb2_xfer *xfer = arg; 2084184610Salfred struct usb2_pipe *pipe = xfer->pipe; 2085184610Salfred 2086184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 2087184610Salfred 2088184610Salfred DPRINTF("start\n"); 2089184610Salfred 2090184610Salfred /* start the transfer */ 2091184610Salfred (pipe->methods->start) (xfer); 2092184610Salfred 2093184610Salfred /* check cancelability */ 2094184610Salfred if (pipe->methods->start_is_cancelable) { 2095184610Salfred xfer->flags_int.can_cancel_immed = 1; 2096184610Salfred if (xfer->error) { 2097184610Salfred /* some error has happened */ 2098184610Salfred usb2_transfer_done(xfer, 0); 2099184610Salfred } 2100184610Salfred } else { 2101184610Salfred xfer->flags_int.can_cancel_immed = 0; 2102184610Salfred } 2103184610Salfred} 2104184610Salfred 2105184610Salfred/*------------------------------------------------------------------------* 2106184610Salfred * usb2_transfer_set_stall 2107184610Salfred * 2108184610Salfred * This function is used to set the stall flag outside the 2109184610Salfred * callback. This function is NULL safe. 2110184610Salfred *------------------------------------------------------------------------*/ 2111184610Salfredvoid 2112184610Salfredusb2_transfer_set_stall(struct usb2_xfer *xfer) 2113184610Salfred{ 2114184610Salfred if (xfer == NULL) { 2115184610Salfred /* tearing down */ 2116184610Salfred return; 2117184610Salfred } 2118184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2119184610Salfred 2120184610Salfred /* avoid any races by locking the USB mutex */ 2121184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2122184610Salfred 2123184610Salfred xfer->flags.stall_pipe = 1; 2124184610Salfred 2125184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2126184610Salfred} 2127184610Salfred 2128184610Salfred/*------------------------------------------------------------------------* 2129184610Salfred * usb2_transfer_clear_stall 2130184610Salfred * 2131184610Salfred * This function is used to clear the stall flag outside the 2132184610Salfred * callback. This function is NULL safe. 2133184610Salfred *------------------------------------------------------------------------*/ 2134184610Salfredvoid 2135184610Salfredusb2_transfer_clear_stall(struct usb2_xfer *xfer) 2136184610Salfred{ 2137184610Salfred if (xfer == NULL) { 2138184610Salfred /* tearing down */ 2139184610Salfred return; 2140184610Salfred } 2141184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2142184610Salfred 2143184610Salfred /* avoid any races by locking the USB mutex */ 2144184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2145184610Salfred 2146184610Salfred xfer->flags.stall_pipe = 0; 2147184610Salfred 2148184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2149184610Salfred} 2150184610Salfred 2151184610Salfred/*------------------------------------------------------------------------* 2152184610Salfred * usb2_pipe_start 2153184610Salfred * 2154184610Salfred * This function is used to add an USB transfer to the pipe transfer list. 2155184610Salfred *------------------------------------------------------------------------*/ 2156184610Salfredvoid 2157184610Salfredusb2_pipe_start(struct usb2_xfer_queue *pq) 2158184610Salfred{ 2159184610Salfred struct usb2_pipe *pipe; 2160184610Salfred struct usb2_xfer *xfer; 2161184610Salfred uint8_t type; 2162184610Salfred 2163184610Salfred xfer = pq->curr; 2164184610Salfred pipe = xfer->pipe; 2165184610Salfred 2166184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 2167184610Salfred 2168184610Salfred /* 2169184610Salfred * If the pipe is already stalled we do nothing ! 2170184610Salfred */ 2171184610Salfred if (pipe->is_stalled) { 2172184610Salfred return; 2173184610Salfred } 2174184610Salfred /* 2175184610Salfred * Check if we are supposed to stall the pipe: 2176184610Salfred */ 2177184610Salfred if (xfer->flags.stall_pipe) { 2178184610Salfred /* clear stall command */ 2179184610Salfred xfer->flags.stall_pipe = 0; 2180184610Salfred 2181184610Salfred /* 2182184610Salfred * Only stall BULK and INTERRUPT endpoints. 2183184610Salfred */ 2184184610Salfred type = (pipe->edesc->bmAttributes & UE_XFERTYPE); 2185184610Salfred if ((type == UE_BULK) || 2186184610Salfred (type == UE_INTERRUPT)) { 2187184610Salfred struct usb2_device *udev; 2188184610Salfred struct usb2_xfer_root *info; 2189184610Salfred 2190184610Salfred udev = xfer->udev; 2191184610Salfred pipe->is_stalled = 1; 2192184610Salfred 2193184610Salfred if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 2194184610Salfred (udev->bus->methods->set_stall) ( 2195184610Salfred udev, NULL, pipe); 2196184610Salfred } else if (udev->default_xfer[1]) { 2197184610Salfred info = udev->default_xfer[1]->usb2_root; 2198184610Salfred if (usb2_proc_msignal(&info->done_p, 2199184610Salfred &udev->cs_msg[0], &udev->cs_msg[1])) { 2200184610Salfred /* ignore */ 2201184610Salfred } 2202184610Salfred } else { 2203184610Salfred /* should not happen */ 2204184610Salfred DPRINTFN(0, "No stall handler!\n"); 2205184610Salfred } 2206184610Salfred /* 2207184610Salfred * We get started again when the stall is cleared! 2208184610Salfred */ 2209184610Salfred return; 2210184610Salfred } 2211184610Salfred } 2212184610Salfred /* Set or clear stall complete - special case */ 2213184610Salfred if (xfer->nframes == 0) { 2214184610Salfred /* we are complete */ 2215184610Salfred xfer->aframes = 0; 2216184610Salfred usb2_transfer_done(xfer, 0); 2217184610Salfred return; 2218184610Salfred } 2219184610Salfred /* 2220184610Salfred * Handled cases: 2221184610Salfred * 2222184610Salfred * 1) Start the first transfer queued. 2223184610Salfred * 2224184610Salfred * 2) Re-start the current USB transfer. 2225184610Salfred */ 2226184610Salfred /* 2227184610Salfred * Check if there should be any 2228184610Salfred * pre transfer start delay: 2229184610Salfred */ 2230184610Salfred if (xfer->interval > 0) { 2231184610Salfred type = (pipe->edesc->bmAttributes & UE_XFERTYPE); 2232184610Salfred if ((type == UE_BULK) || 2233184610Salfred (type == UE_CONTROL)) { 2234184610Salfred usb2_transfer_timeout_ms(xfer, 2235184610Salfred &usb2_transfer_start_cb, 2236184610Salfred xfer->interval); 2237184610Salfred return; 2238184610Salfred } 2239184610Salfred } 2240184610Salfred DPRINTF("start\n"); 2241184610Salfred 2242184610Salfred /* start USB transfer */ 2243184610Salfred (pipe->methods->start) (xfer); 2244184610Salfred 2245184610Salfred /* check cancelability */ 2246184610Salfred if (pipe->methods->start_is_cancelable) { 2247184610Salfred xfer->flags_int.can_cancel_immed = 1; 2248184610Salfred if (xfer->error) { 2249184610Salfred /* some error has happened */ 2250184610Salfred usb2_transfer_done(xfer, 0); 2251184610Salfred } 2252184610Salfred } else { 2253184610Salfred xfer->flags_int.can_cancel_immed = 0; 2254184610Salfred } 2255184610Salfred} 2256184610Salfred 2257184610Salfred/*------------------------------------------------------------------------* 2258184610Salfred * usb2_transfer_timeout_ms 2259184610Salfred * 2260184610Salfred * This function is used to setup a timeout on the given USB 2261184610Salfred * transfer. If the timeout has been deferred the callback given by 2262184610Salfred * "cb" will get called after "ms" milliseconds. 2263184610Salfred *------------------------------------------------------------------------*/ 2264184610Salfredvoid 2265184610Salfredusb2_transfer_timeout_ms(struct usb2_xfer *xfer, 2266184610Salfred void (*cb) (void *arg), uint32_t ms) 2267184610Salfred{ 2268184824Sthompsa USB_BUS_LOCK_ASSERT(xfer->udev->bus, MA_OWNED); 2269184610Salfred 2270184610Salfred /* defer delay */ 2271184610Salfred usb2_callout_reset(&xfer->timeout_handle, 2272184610Salfred USB_MS_TO_TICKS(ms), cb, xfer); 2273184610Salfred} 2274184610Salfred 2275184610Salfred/*------------------------------------------------------------------------* 2276184610Salfred * usb2_callback_wrapper_sub 2277184610Salfred * 2278184610Salfred * - This function will update variables in an USB transfer after 2279184610Salfred * that the USB transfer is complete. 2280184610Salfred * 2281184610Salfred * - This function is used to start the next USB transfer on the 2282184610Salfred * pipe transfer queue, if any. 2283184610Salfred * 2284184610Salfred * NOTE: In some special cases the USB transfer will not be removed from 2285184610Salfred * the pipe queue, but remain first. To enforce USB transfer removal call 2286184610Salfred * this function passing the error code "USB_ERR_CANCELLED". 2287184610Salfred * 2288184610Salfred * Return values: 2289184610Salfred * 0: Success. 2290184610Salfred * Else: The callback has been deferred. 2291184610Salfred *------------------------------------------------------------------------*/ 2292184610Salfredstatic uint8_t 2293184610Salfredusb2_callback_wrapper_sub(struct usb2_xfer *xfer) 2294184610Salfred{ 2295184610Salfred struct usb2_pipe *pipe; 2296184610Salfred uint32_t x; 2297184610Salfred 2298184610Salfred if ((!xfer->flags_int.open) && 2299184610Salfred (!xfer->flags_int.did_close)) { 2300184610Salfred DPRINTF("close\n"); 2301184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2302184610Salfred (xfer->pipe->methods->close) (xfer); 2303184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2304184610Salfred /* only close once */ 2305184610Salfred xfer->flags_int.did_close = 1; 2306184610Salfred return (1); /* wait for new callback */ 2307184610Salfred } 2308184610Salfred /* 2309184610Salfred * If we have a non-hardware induced error we 2310184610Salfred * need to do the DMA delay! 2311184610Salfred */ 2312184610Salfred if (((xfer->error == USB_ERR_CANCELLED) || 2313184610Salfred (xfer->error == USB_ERR_TIMEOUT)) && 2314184610Salfred (!xfer->flags_int.did_dma_delay)) { 2315184610Salfred 2316184610Salfred uint32_t temp; 2317184610Salfred 2318184610Salfred /* only delay once */ 2319184610Salfred xfer->flags_int.did_dma_delay = 1; 2320184610Salfred 2321184610Salfred /* we can not cancel this delay */ 2322184610Salfred xfer->flags_int.can_cancel_immed = 0; 2323184610Salfred 2324184610Salfred temp = usb2_get_dma_delay(xfer->udev->bus); 2325184610Salfred 2326184610Salfred DPRINTFN(3, "DMA delay, %u ms, " 2327184610Salfred "on %p\n", temp, xfer); 2328184610Salfred 2329184610Salfred if (temp != 0) { 2330184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2331184610Salfred usb2_transfer_timeout_ms(xfer, 2332184610Salfred &usb2_dma_delay_done_cb, temp); 2333184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2334184610Salfred return (1); /* wait for new callback */ 2335184610Salfred } 2336184610Salfred } 2337184610Salfred /* check actual number of frames */ 2338184610Salfred if (xfer->aframes > xfer->nframes) { 2339184610Salfred if (xfer->error == 0) { 2340184610Salfred panic("%s: actual number of frames, %d, is " 2341184610Salfred "greater than initial number of frames, %d!\n", 2342184610Salfred __FUNCTION__, xfer->aframes, xfer->nframes); 2343184610Salfred } else { 2344184610Salfred /* just set some valid value */ 2345184610Salfred xfer->aframes = xfer->nframes; 2346184610Salfred } 2347184610Salfred } 2348184610Salfred /* compute actual length */ 2349184610Salfred xfer->actlen = 0; 2350184610Salfred 2351184610Salfred for (x = 0; x != xfer->aframes; x++) { 2352184610Salfred xfer->actlen += xfer->frlengths[x]; 2353184610Salfred } 2354184610Salfred 2355184610Salfred /* 2356184610Salfred * Frames that were not transferred get zero actual length in 2357184610Salfred * case the USB device driver does not check the actual number 2358184610Salfred * of frames transferred, "xfer->aframes": 2359184610Salfred */ 2360184610Salfred for (; x < xfer->nframes; x++) { 2361184610Salfred xfer->frlengths[x] = 0; 2362184610Salfred } 2363184610Salfred 2364184610Salfred /* check actual length */ 2365184610Salfred if (xfer->actlen > xfer->sumlen) { 2366184610Salfred if (xfer->error == 0) { 2367184610Salfred panic("%s: actual length, %d, is greater than " 2368184610Salfred "initial length, %d!\n", 2369184610Salfred __FUNCTION__, xfer->actlen, xfer->sumlen); 2370184610Salfred } else { 2371184610Salfred /* just set some valid value */ 2372184610Salfred xfer->actlen = xfer->sumlen; 2373184610Salfred } 2374184610Salfred } 2375184610Salfred DPRINTFN(6, "xfer=%p pipe=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n", 2376184610Salfred xfer, xfer->pipe, xfer->error, xfer->actlen, xfer->sumlen, 2377184610Salfred xfer->aframes, xfer->nframes); 2378184610Salfred 2379184610Salfred if (xfer->error) { 2380184610Salfred /* end of control transfer, if any */ 2381184610Salfred xfer->flags_int.control_act = 0; 2382184610Salfred 2383184610Salfred /* check if we should block the execution queue */ 2384184610Salfred if ((xfer->error != USB_ERR_CANCELLED) && 2385184610Salfred (xfer->flags.pipe_bof)) { 2386184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure " 2387184610Salfred "on pipe=%p\n", xfer, xfer->pipe); 2388184610Salfred goto done; 2389184610Salfred } 2390184610Salfred } else { 2391184610Salfred /* check for short transfers */ 2392184610Salfred if (xfer->actlen < xfer->sumlen) { 2393184610Salfred 2394184610Salfred /* end of control transfer, if any */ 2395184610Salfred xfer->flags_int.control_act = 0; 2396184610Salfred 2397184610Salfred if (!xfer->flags_int.short_xfer_ok) { 2398184610Salfred xfer->error = USB_ERR_SHORT_XFER; 2399184610Salfred if (xfer->flags.pipe_bof) { 2400184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure on " 2401184610Salfred "Short Transfer on pipe %p.\n", 2402184610Salfred xfer, xfer->pipe); 2403184610Salfred goto done; 2404184610Salfred } 2405184610Salfred } 2406184610Salfred } else { 2407184610Salfred /* 2408184610Salfred * Check if we are in the middle of a 2409184610Salfred * control transfer: 2410184610Salfred */ 2411184610Salfred if (xfer->flags_int.control_act) { 2412184610Salfred DPRINTFN(5, "xfer=%p: Control transfer " 2413184610Salfred "active on pipe=%p\n", xfer, xfer->pipe); 2414184610Salfred goto done; 2415184610Salfred } 2416184610Salfred } 2417184610Salfred } 2418184610Salfred 2419184610Salfred pipe = xfer->pipe; 2420184610Salfred 2421184610Salfred /* 2422184610Salfred * If the current USB transfer is completing we need to start the 2423184610Salfred * next one: 2424184610Salfred */ 2425184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2426184610Salfred if (pipe->pipe_q.curr == xfer) { 2427184610Salfred usb2_command_wrapper(&pipe->pipe_q, NULL); 2428184610Salfred 2429184610Salfred if (pipe->pipe_q.curr || TAILQ_FIRST(&pipe->pipe_q.head)) { 2430184610Salfred /* there is another USB transfer waiting */ 2431184610Salfred } else { 2432184610Salfred /* this is the last USB transfer */ 2433184610Salfred /* clear isochronous sync flag */ 2434184610Salfred xfer->pipe->is_synced = 0; 2435184610Salfred } 2436184610Salfred } 2437184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2438184610Salfreddone: 2439184610Salfred return (0); 2440184610Salfred} 2441184610Salfred 2442184610Salfred/*------------------------------------------------------------------------* 2443184610Salfred * usb2_command_wrapper 2444184610Salfred * 2445184610Salfred * This function is used to execute commands non-recursivly on an USB 2446184610Salfred * transfer. 2447184610Salfred *------------------------------------------------------------------------*/ 2448184610Salfredvoid 2449184610Salfredusb2_command_wrapper(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer) 2450184610Salfred{ 2451184610Salfred if (xfer) { 2452184610Salfred /* 2453184610Salfred * If the transfer is not already processing, 2454184610Salfred * queue it! 2455184610Salfred */ 2456184610Salfred if (pq->curr != xfer) { 2457184610Salfred usb2_transfer_enqueue(pq, xfer); 2458184610Salfred if (pq->curr != NULL) { 2459184610Salfred /* something is already processing */ 2460184610Salfred DPRINTFN(6, "busy %p\n", pq->curr); 2461184610Salfred return; 2462184610Salfred } 2463184610Salfred } 2464184610Salfred } else { 2465184610Salfred /* Get next element in queue */ 2466184610Salfred pq->curr = NULL; 2467184610Salfred } 2468184610Salfred 2469184610Salfred if (!pq->recurse_1) { 2470184610Salfred 2471184610Salfred do { 2472184610Salfred 2473184610Salfred /* set both recurse flags */ 2474184610Salfred pq->recurse_1 = 1; 2475184610Salfred pq->recurse_2 = 1; 2476184610Salfred 2477184610Salfred if (pq->curr == NULL) { 2478184610Salfred xfer = TAILQ_FIRST(&pq->head); 2479184610Salfred if (xfer) { 2480184610Salfred TAILQ_REMOVE(&pq->head, xfer, 2481184610Salfred wait_entry); 2482184610Salfred xfer->wait_queue = NULL; 2483184610Salfred pq->curr = xfer; 2484184610Salfred } else { 2485184610Salfred break; 2486184610Salfred } 2487184610Salfred } 2488184610Salfred DPRINTFN(6, "cb %p (enter)\n", pq->curr); 2489184610Salfred (pq->command) (pq); 2490184610Salfred DPRINTFN(6, "cb %p (leave)\n", pq->curr); 2491184610Salfred 2492184610Salfred } while (!pq->recurse_2); 2493184610Salfred 2494184610Salfred /* clear first recurse flag */ 2495184610Salfred pq->recurse_1 = 0; 2496184610Salfred 2497184610Salfred } else { 2498184610Salfred /* clear second recurse flag */ 2499184610Salfred pq->recurse_2 = 0; 2500184610Salfred } 2501184610Salfred} 2502184610Salfred 2503184610Salfred/*------------------------------------------------------------------------* 2504184610Salfred * usb2_default_transfer_setup 2505184610Salfred * 2506184610Salfred * This function is used to setup the default USB control endpoint 2507184610Salfred * transfer. 2508184610Salfred *------------------------------------------------------------------------*/ 2509184610Salfredvoid 2510184610Salfredusb2_default_transfer_setup(struct usb2_device *udev) 2511184610Salfred{ 2512184610Salfred struct usb2_xfer *xfer; 2513184610Salfred uint8_t no_resetup; 2514184610Salfred uint8_t iface_index; 2515184610Salfred 2516184610Salfredrepeat: 2517184610Salfred 2518184610Salfred xfer = udev->default_xfer[0]; 2519184610Salfred if (xfer) { 2520184824Sthompsa USB_XFER_LOCK(xfer); 2521184610Salfred no_resetup = 2522184610Salfred ((xfer->address == udev->address) && 2523184610Salfred (udev->default_ep_desc.wMaxPacketSize[0] == 2524184610Salfred udev->ddesc.bMaxPacketSize)); 2525184610Salfred if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 2526184610Salfred if (no_resetup) { 2527184610Salfred /* 2528184610Salfred * NOTE: checking "xfer->address" and 2529184610Salfred * starting the USB transfer must be 2530184610Salfred * atomic! 2531184610Salfred */ 2532184610Salfred usb2_transfer_start(xfer); 2533184610Salfred } 2534184610Salfred } 2535184824Sthompsa USB_XFER_UNLOCK(xfer); 2536184610Salfred } else { 2537184610Salfred no_resetup = 0; 2538184610Salfred } 2539184610Salfred 2540184610Salfred if (no_resetup) { 2541184610Salfred /* 2542184610Salfred * All parameters are exactly the same like before. 2543184610Salfred * Just return. 2544184610Salfred */ 2545184610Salfred return; 2546184610Salfred } 2547184610Salfred /* 2548184610Salfred * Update wMaxPacketSize for the default control endpoint: 2549184610Salfred */ 2550184610Salfred udev->default_ep_desc.wMaxPacketSize[0] = 2551184610Salfred udev->ddesc.bMaxPacketSize; 2552184610Salfred 2553184610Salfred /* 2554184610Salfred * Unsetup any existing USB transfer: 2555184610Salfred */ 2556184610Salfred usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 2557184610Salfred 2558184610Salfred /* 2559184610Salfred * Try to setup a new USB transfer for the 2560184610Salfred * default control endpoint: 2561184610Salfred */ 2562184610Salfred iface_index = 0; 2563184610Salfred if (usb2_transfer_setup(udev, &iface_index, 2564184610Salfred udev->default_xfer, usb2_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL, 2565184610Salfred udev->default_mtx)) { 2566184610Salfred DPRINTFN(0, "could not setup default " 2567184610Salfred "USB transfer!\n"); 2568184610Salfred } else { 2569184610Salfred goto repeat; 2570184610Salfred } 2571184610Salfred} 2572184610Salfred 2573184610Salfred/*------------------------------------------------------------------------* 2574184610Salfred * usb2_clear_data_toggle - factored out code 2575184610Salfred * 2576184610Salfred * NOTE: the intention of this function is not to reset the hardware 2577184610Salfred * data toggle. 2578184610Salfred *------------------------------------------------------------------------*/ 2579184610Salfredvoid 2580184610Salfredusb2_clear_data_toggle(struct usb2_device *udev, struct usb2_pipe *pipe) 2581184610Salfred{ 2582184610Salfred DPRINTFN(5, "udev=%p pipe=%p\n", udev, pipe); 2583184610Salfred 2584184824Sthompsa USB_BUS_LOCK(udev->bus); 2585184610Salfred pipe->toggle_next = 0; 2586184824Sthompsa USB_BUS_UNLOCK(udev->bus); 2587184610Salfred} 2588184610Salfred 2589184610Salfred/*------------------------------------------------------------------------* 2590184610Salfred * usb2_clear_stall_callback - factored out clear stall callback 2591184610Salfred * 2592184610Salfred * Input parameters: 2593184610Salfred * xfer1: Clear Stall Control Transfer 2594184610Salfred * xfer2: Stalled USB Transfer 2595184610Salfred * 2596184610Salfred * This function is NULL safe. 2597184610Salfred * 2598184610Salfred * Return values: 2599184610Salfred * 0: In progress 2600184610Salfred * Else: Finished 2601184610Salfred * 2602184610Salfred * Clear stall config example: 2603184610Salfred * 2604184610Salfred * static const struct usb2_config my_clearstall = { 2605184610Salfred * .type = UE_CONTROL, 2606184610Salfred * .endpoint = 0, 2607184610Salfred * .direction = UE_DIR_ANY, 2608184610Salfred * .interval = 50, //50 milliseconds 2609184610Salfred * .bufsize = sizeof(struct usb2_device_request), 2610184610Salfred * .mh.timeout = 1000, //1.000 seconds 2611184610Salfred * .mh.flags = { }, 2612184610Salfred * .mh.callback = &my_clear_stall_callback, // ** 2613184610Salfred * }; 2614184610Salfred * 2615184610Salfred * ** "my_clear_stall_callback" calls "usb2_clear_stall_callback" 2616184610Salfred * passing the correct parameters. 2617184610Salfred *------------------------------------------------------------------------*/ 2618184610Salfreduint8_t 2619184610Salfredusb2_clear_stall_callback(struct usb2_xfer *xfer1, 2620184610Salfred struct usb2_xfer *xfer2) 2621184610Salfred{ 2622184610Salfred struct usb2_device_request req; 2623184610Salfred 2624184610Salfred if (xfer2 == NULL) { 2625184610Salfred /* looks like we are tearing down */ 2626184610Salfred DPRINTF("NULL input parameter\n"); 2627184610Salfred return (0); 2628184610Salfred } 2629184824Sthompsa USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED); 2630184824Sthompsa USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED); 2631184610Salfred 2632184610Salfred switch (USB_GET_STATE(xfer1)) { 2633184610Salfred case USB_ST_SETUP: 2634184610Salfred 2635184610Salfred /* 2636184610Salfred * pre-clear the data toggle to DATA0 ("umass.c" and 2637184610Salfred * "ata-usb.c" depends on this) 2638184610Salfred */ 2639184610Salfred 2640184610Salfred usb2_clear_data_toggle(xfer2->udev, xfer2->pipe); 2641184610Salfred 2642184610Salfred /* setup a clear-stall packet */ 2643184610Salfred 2644184610Salfred req.bmRequestType = UT_WRITE_ENDPOINT; 2645184610Salfred req.bRequest = UR_CLEAR_FEATURE; 2646184610Salfred USETW(req.wValue, UF_ENDPOINT_HALT); 2647184610Salfred req.wIndex[0] = xfer2->pipe->edesc->bEndpointAddress; 2648184610Salfred req.wIndex[1] = 0; 2649184610Salfred USETW(req.wLength, 0); 2650184610Salfred 2651184610Salfred /* 2652184610Salfred * "usb2_transfer_setup_sub()" will ensure that 2653184610Salfred * we have sufficient room in the buffer for 2654184610Salfred * the request structure! 2655184610Salfred */ 2656184610Salfred 2657184610Salfred /* copy in the transfer */ 2658184610Salfred 2659184610Salfred usb2_copy_in(xfer1->frbuffers, 0, &req, sizeof(req)); 2660184610Salfred 2661184610Salfred /* set length */ 2662184610Salfred xfer1->frlengths[0] = sizeof(req); 2663184610Salfred xfer1->nframes = 1; 2664184610Salfred 2665184610Salfred usb2_start_hardware(xfer1); 2666184610Salfred return (0); 2667184610Salfred 2668184610Salfred case USB_ST_TRANSFERRED: 2669184610Salfred break; 2670184610Salfred 2671184610Salfred default: /* Error */ 2672184610Salfred if (xfer1->error == USB_ERR_CANCELLED) { 2673184610Salfred return (0); 2674184610Salfred } 2675184610Salfred break; 2676184610Salfred } 2677184610Salfred return (1); /* Clear Stall Finished */ 2678184610Salfred} 2679184610Salfred 2680184610Salfred#if (USB_NO_POLL == 0) 2681184610Salfred 2682184610Salfred/*------------------------------------------------------------------------* 2683184610Salfred * usb2_callout_poll 2684184610Salfred *------------------------------------------------------------------------*/ 2685184610Salfredstatic void 2686184610Salfredusb2_callout_poll(struct usb2_xfer *xfer) 2687184610Salfred{ 2688184610Salfred struct usb2_callout *co; 2689184610Salfred void (*cb) (void *); 2690184610Salfred void *arg; 2691184610Salfred struct mtx *mtx; 2692184610Salfred uint32_t delta; 2693184610Salfred 2694184610Salfred if (xfer == NULL) { 2695184610Salfred return; 2696184610Salfred } 2697184610Salfred co = &xfer->timeout_handle; 2698184610Salfred 2699184610Salfred#if __FreeBSD_version >= 800000 2700184610Salfred mtx = (void *)(co->co.c_lock); 2701184610Salfred#else 2702184610Salfred mtx = co->co.c_mtx; 2703184610Salfred#endif 2704184610Salfred mtx_lock(mtx); 2705184610Salfred 2706184610Salfred if (usb2_callout_pending(co)) { 2707184610Salfred delta = ticks - co->co.c_time; 2708184610Salfred if (!(delta & 0x80000000)) { 2709184610Salfred 2710184610Salfred cb = co->co.c_func; 2711184610Salfred arg = co->co.c_arg; 2712184610Salfred 2713184610Salfred /* timed out */ 2714184610Salfred usb2_callout_stop(co); 2715184610Salfred 2716184610Salfred (cb) (arg); 2717184610Salfred } 2718184610Salfred } 2719186454Sthompsa mtx_unlock(mtx); 2720184610Salfred} 2721184610Salfred 2722184610Salfred 2723184610Salfred/*------------------------------------------------------------------------* 2724184610Salfred * usb2_do_poll 2725184610Salfred * 2726184610Salfred * This function is called from keyboard driver when in polling 2727184610Salfred * mode. 2728184610Salfred *------------------------------------------------------------------------*/ 2729184610Salfredvoid 2730184610Salfredusb2_do_poll(struct usb2_xfer **ppxfer, uint16_t max) 2731184610Salfred{ 2732184610Salfred struct usb2_xfer *xfer; 2733184610Salfred struct usb2_xfer_root *usb2_root; 2734184610Salfred struct usb2_device *udev; 2735184610Salfred struct usb2_proc_msg *pm; 2736184610Salfred uint32_t to; 2737184610Salfred uint16_t n; 2738184610Salfred 2739184610Salfred /* compute system tick delay */ 2740184610Salfred to = ((uint32_t)(1000000)) / ((uint32_t)(hz)); 2741184610Salfred DELAY(to); 2742184610Salfred atomic_add_int((volatile int *)&ticks, 1); 2743184610Salfred 2744184610Salfred for (n = 0; n != max; n++) { 2745184610Salfred xfer = ppxfer[n]; 2746184610Salfred if (xfer) { 2747184610Salfred usb2_root = xfer->usb2_root; 2748184610Salfred udev = xfer->udev; 2749184610Salfred 2750184610Salfred /* 2751184610Salfred * Poll hardware - signal that we are polling by 2752184610Salfred * locking the private mutex: 2753184610Salfred */ 2754184824Sthompsa USB_XFER_LOCK(xfer); 2755184610Salfred (udev->bus->methods->do_poll) (udev->bus); 2756184824Sthompsa USB_XFER_UNLOCK(xfer); 2757184610Salfred 2758184610Salfred /* poll clear stall start */ 2759184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2760184610Salfred pm = &udev->cs_msg[0].hdr; 2761184610Salfred (pm->pm_callback) (pm); 2762184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2763184610Salfred 2764184610Salfred if (udev->default_xfer[1]) { 2765184610Salfred 2766184610Salfred /* poll timeout */ 2767184610Salfred usb2_callout_poll(udev->default_xfer[1]); 2768184610Salfred 2769184610Salfred /* poll clear stall done thread */ 2770184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2771184610Salfred pm = &udev->default_xfer[1]-> 2772184610Salfred usb2_root->done_m[0].hdr; 2773184610Salfred (pm->pm_callback) (pm); 2774184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2775184610Salfred } 2776184610Salfred /* poll timeout */ 2777184610Salfred usb2_callout_poll(xfer); 2778184610Salfred 2779184610Salfred /* poll done thread */ 2780184824Sthompsa USB_BUS_LOCK(xfer->udev->bus); 2781184610Salfred pm = &usb2_root->done_m[0].hdr; 2782184610Salfred (pm->pm_callback) (pm); 2783184824Sthompsa USB_BUS_UNLOCK(xfer->udev->bus); 2784184610Salfred } 2785184610Salfred } 2786184610Salfred} 2787184610Salfred 2788184610Salfred#else 2789184610Salfred 2790184610Salfredvoid 2791184610Salfredusb2_do_poll(struct usb2_xfer **ppxfer, uint16_t max) 2792184610Salfred{ 2793184610Salfred /* polling not supported */ 2794184610Salfred} 2795184610Salfred 2796184610Salfred#endif 2797