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