usb_transfer.c revision 190181
1184610Salfred/* $FreeBSD: head/sys/dev/usb/usb_transfer.c 190181 2009-03-20 21:50:54Z thompsa $ */ 2184610Salfred/*- 3184610Salfred * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4184610Salfred * 5184610Salfred * Redistribution and use in source and binary forms, with or without 6184610Salfred * modification, are permitted provided that the following conditions 7184610Salfred * are met: 8184610Salfred * 1. Redistributions of source code must retain the above copyright 9184610Salfred * notice, this list of conditions and the following disclaimer. 10184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 11184610Salfred * notice, this list of conditions and the following disclaimer in the 12184610Salfred * documentation and/or other materials provided with the distribution. 13184610Salfred * 14184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24184610Salfred * SUCH DAMAGE. 25184610Salfred */ 26184610Salfred 27188942Sthompsa#include <dev/usb/usb_mfunc.h> 28188942Sthompsa#include <dev/usb/usb_error.h> 29188942Sthompsa#include <dev/usb/usb.h> 30184610Salfred 31184610Salfred#define USB_DEBUG_VAR usb2_debug 32184610Salfred 33188942Sthompsa#include <dev/usb/usb_core.h> 34188942Sthompsa#include <dev/usb/usb_busdma.h> 35188942Sthompsa#include <dev/usb/usb_process.h> 36188942Sthompsa#include <dev/usb/usb_transfer.h> 37188942Sthompsa#include <dev/usb/usb_device.h> 38188942Sthompsa#include <dev/usb/usb_debug.h> 39188942Sthompsa#include <dev/usb/usb_util.h> 40184610Salfred 41188942Sthompsa#include <dev/usb/usb_controller.h> 42188942Sthompsa#include <dev/usb/usb_bus.h> 43184610Salfred 44184610Salfredstruct usb2_std_packet_size { 45184610Salfred struct { 46184610Salfred uint16_t min; /* inclusive */ 47184610Salfred uint16_t max; /* inclusive */ 48184610Salfred } range; 49184610Salfred 50184610Salfred uint16_t fixed[4]; 51184610Salfred}; 52184610Salfred 53184610Salfred/* 54184610Salfred * This table stores the all the allowed packet sizes based on 55184610Salfred * endpoint type and USB speed: 56184610Salfred */ 57184610Salfredstatic const struct usb2_std_packet_size 58184610Salfred usb2_std_packet_size[4][USB_SPEED_MAX] = { 59184610Salfred 60184610Salfred [UE_INTERRUPT] = { 61184610Salfred [USB_SPEED_LOW] = {.range = {0, 8}}, 62184610Salfred [USB_SPEED_FULL] = {.range = {0, 64}}, 63184610Salfred [USB_SPEED_HIGH] = {.range = {0, 1024}}, 64184610Salfred [USB_SPEED_VARIABLE] = {.range = {0, 1024}}, 65187180Sthompsa [USB_SPEED_SUPER] = {.range = {0, 1024}}, 66184610Salfred }, 67184610Salfred 68184610Salfred [UE_CONTROL] = { 69184610Salfred [USB_SPEED_LOW] = {.fixed = {8, 8, 8, 8}}, 70184610Salfred [USB_SPEED_FULL] = {.fixed = {8, 16, 32, 64}}, 71184610Salfred [USB_SPEED_HIGH] = {.fixed = {64, 64, 64, 64}}, 72184610Salfred [USB_SPEED_VARIABLE] = {.fixed = {512, 512, 512, 512}}, 73187180Sthompsa [USB_SPEED_SUPER] = {.fixed = {512, 512, 512, 512}}, 74184610Salfred }, 75184610Salfred 76184610Salfred [UE_BULK] = { 77184610Salfred [USB_SPEED_LOW] = {.fixed = {0, 0, 0, 0}}, /* invalid */ 78184610Salfred [USB_SPEED_FULL] = {.fixed = {8, 16, 32, 64}}, 79184610Salfred [USB_SPEED_HIGH] = {.fixed = {512, 512, 512, 512}}, 80184610Salfred [USB_SPEED_VARIABLE] = {.fixed = {512, 512, 1024, 1536}}, 81187180Sthompsa [USB_SPEED_SUPER] = {.fixed = {1024, 1024, 1024, 1024}}, 82184610Salfred }, 83184610Salfred 84184610Salfred [UE_ISOCHRONOUS] = { 85184610Salfred [USB_SPEED_LOW] = {.fixed = {0, 0, 0, 0}}, /* invalid */ 86184610Salfred [USB_SPEED_FULL] = {.range = {0, 1023}}, 87184610Salfred [USB_SPEED_HIGH] = {.range = {0, 1024}}, 88184610Salfred [USB_SPEED_VARIABLE] = {.range = {0, 3584}}, 89187180Sthompsa [USB_SPEED_SUPER] = {.range = {0, 1024}}, 90184610Salfred }, 91184610Salfred}; 92184610Salfred 93184610Salfredstatic const struct usb2_config usb2_control_ep_cfg[USB_DEFAULT_XFER_MAX] = { 94184610Salfred 95184610Salfred /* This transfer is used for generic control endpoint transfers */ 96184610Salfred 97184610Salfred [0] = { 98184610Salfred .type = UE_CONTROL, 99184610Salfred .endpoint = 0x00, /* Control endpoint */ 100184610Salfred .direction = UE_DIR_ANY, 101190181Sthompsa .mh.bufsize = USB_EP0_BUFSIZE, /* bytes */ 102184610Salfred .mh.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,}, 103184610Salfred .mh.callback = &usb2_do_request_callback, 104190181Sthompsa .md.bufsize = USB_EP0_BUFSIZE, /* bytes */ 105184610Salfred .md.flags = {.proxy_buffer = 1,.short_xfer_ok = 0,}, 106184610Salfred .md.callback = &usb2_handle_request_callback, 107184610Salfred }, 108184610Salfred 109184610Salfred /* This transfer is used for generic clear stall only */ 110184610Salfred 111184610Salfred [1] = { 112184610Salfred .type = UE_CONTROL, 113184610Salfred .endpoint = 0x00, /* Control pipe */ 114184610Salfred .direction = UE_DIR_ANY, 115184610Salfred .mh.bufsize = sizeof(struct usb2_device_request), 116184610Salfred .mh.flags = {}, 117184610Salfred .mh.callback = &usb2_do_clear_stall_callback, 118184610Salfred .mh.timeout = 1000, /* 1 second */ 119184610Salfred .mh.interval = 50, /* 50ms */ 120184610Salfred }, 121184610Salfred}; 122184610Salfred 123184610Salfred/* function prototypes */ 124184610Salfred 125185948Sthompsastatic void usb2_update_max_frame_size(struct usb2_xfer *); 126185948Sthompsastatic void usb2_transfer_unsetup_sub(struct usb2_xfer_root *, uint8_t); 127185948Sthompsastatic void usb2_control_transfer_init(struct usb2_xfer *); 128185948Sthompsastatic uint8_t usb2_start_hardware_sub(struct usb2_xfer *); 129185948Sthompsastatic void usb2_callback_proc(struct usb2_proc_msg *); 130185948Sthompsastatic void usb2_callback_ss_done_defer(struct usb2_xfer *); 131185948Sthompsastatic void usb2_callback_wrapper(struct usb2_xfer_queue *); 132185948Sthompsastatic void usb2_dma_delay_done_cb(void *); 133185948Sthompsastatic void usb2_transfer_start_cb(void *); 134185948Sthompsastatic uint8_t usb2_callback_wrapper_sub(struct usb2_xfer *); 135184610Salfred 136184610Salfred/*------------------------------------------------------------------------* 137184610Salfred * usb2_update_max_frame_size 138184610Salfred * 139184610Salfred * This function updates the maximum frame size, hence high speed USB 140184610Salfred * can transfer multiple consecutive packets. 141184610Salfred *------------------------------------------------------------------------*/ 142184610Salfredstatic void 143184610Salfredusb2_update_max_frame_size(struct usb2_xfer *xfer) 144184610Salfred{ 145184610Salfred /* compute maximum frame size */ 146184610Salfred 147184610Salfred if (xfer->max_packet_count == 2) { 148184610Salfred xfer->max_frame_size = 2 * xfer->max_packet_size; 149184610Salfred } else if (xfer->max_packet_count == 3) { 150184610Salfred xfer->max_frame_size = 3 * xfer->max_packet_size; 151184610Salfred } else { 152184610Salfred xfer->max_frame_size = xfer->max_packet_size; 153184610Salfred } 154184610Salfred} 155184610Salfred 156184610Salfred/*------------------------------------------------------------------------* 157184610Salfred * usb2_get_dma_delay 158184610Salfred * 159184610Salfred * The following function is called when we need to 160184610Salfred * synchronize with DMA hardware. 161184610Salfred * 162184610Salfred * Returns: 163184610Salfred * 0: no DMA delay required 164184610Salfred * Else: milliseconds of DMA delay 165184610Salfred *------------------------------------------------------------------------*/ 166190181Sthompsausb2_timeout_t 167184610Salfredusb2_get_dma_delay(struct usb2_bus *bus) 168184610Salfred{ 169184610Salfred uint32_t temp = 0; 170184610Salfred 171184610Salfred if (bus->methods->get_dma_delay) { 172184610Salfred (bus->methods->get_dma_delay) (bus, &temp); 173184610Salfred /* 174184610Salfred * Round up and convert to milliseconds. Note that we use 175184610Salfred * 1024 milliseconds per second. to save a division. 176184610Salfred */ 177184610Salfred temp += 0x3FF; 178184610Salfred temp /= 0x400; 179184610Salfred } 180184610Salfred return (temp); 181184610Salfred} 182184610Salfred 183184610Salfred/*------------------------------------------------------------------------* 184184610Salfred * usb2_transfer_setup_sub_malloc 185184610Salfred * 186184610Salfred * This function will allocate one or more DMA'able memory chunks 187184610Salfred * according to "size", "align" and "count" arguments. "ppc" is 188184610Salfred * pointed to a linear array of USB page caches afterwards. 189184610Salfred * 190184610Salfred * Returns: 191184610Salfred * 0: Success 192184610Salfred * Else: Failure 193184610Salfred *------------------------------------------------------------------------*/ 194190180Sthompsa#if USB_HAVE_BUSDMA 195184610Salfreduint8_t 196184610Salfredusb2_transfer_setup_sub_malloc(struct usb2_setup_params *parm, 197190181Sthompsa struct usb2_page_cache **ppc, usb2_size_t size, usb2_size_t align, 198190181Sthompsa usb2_size_t count) 199184610Salfred{ 200184610Salfred struct usb2_page_cache *pc; 201184610Salfred struct usb2_page *pg; 202184610Salfred void *buf; 203190181Sthompsa usb2_size_t n_dma_pc; 204190181Sthompsa usb2_size_t n_obj; 205190181Sthompsa usb2_size_t x; 206190181Sthompsa usb2_size_t y; 207190181Sthompsa usb2_size_t r; 208190181Sthompsa usb2_size_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} 305190180Sthompsa#endif 306184610Salfred 307184610Salfred/*------------------------------------------------------------------------* 308184610Salfred * usb2_transfer_setup_sub - transfer setup subroutine 309184610Salfred * 310184610Salfred * This function must be called from the "xfer_setup" callback of the 311184610Salfred * USB Host or Device controller driver when setting up an USB 312184610Salfred * transfer. This function will setup correct packet sizes, buffer 313184610Salfred * sizes, flags and more, that are stored in the "usb2_xfer" 314184610Salfred * structure. 315184610Salfred *------------------------------------------------------------------------*/ 316184610Salfredvoid 317184610Salfredusb2_transfer_setup_sub(struct usb2_setup_params *parm) 318184610Salfred{ 319184610Salfred enum { 320184610Salfred REQ_SIZE = 8, 321184610Salfred MIN_PKT = 8, 322184610Salfred }; 323184610Salfred struct usb2_xfer *xfer = parm->curr_xfer; 324184610Salfred const struct usb2_config_sub *setup_sub = parm->curr_setup_sub; 325184610Salfred struct usb2_endpoint_descriptor *edesc; 326184610Salfred struct usb2_std_packet_size std_size; 327190181Sthompsa usb2_frcount_t n_frlengths; 328190181Sthompsa usb2_frcount_t n_frbuffers; 329190181Sthompsa usb2_frcount_t x; 330184610Salfred uint8_t type; 331184610Salfred uint8_t zmps; 332184610Salfred 333184610Salfred /* 334184610Salfred * Sanity check. The following parameters must be initialized before 335184610Salfred * calling this function. 336184610Salfred */ 337184610Salfred if ((parm->hc_max_packet_size == 0) || 338184610Salfred (parm->hc_max_packet_count == 0) || 339184610Salfred (parm->hc_max_frame_size == 0)) { 340184610Salfred parm->err = USB_ERR_INVAL; 341184610Salfred goto done; 342184610Salfred } 343184610Salfred edesc = xfer->pipe->edesc; 344184610Salfred 345184610Salfred type = (edesc->bmAttributes & UE_XFERTYPE); 346184610Salfred 347184610Salfred xfer->flags = setup_sub->flags; 348184610Salfred xfer->nframes = setup_sub->frames; 349184610Salfred xfer->timeout = setup_sub->timeout; 350184610Salfred xfer->callback = setup_sub->callback; 351184610Salfred xfer->interval = setup_sub->interval; 352184610Salfred xfer->endpoint = edesc->bEndpointAddress; 353184610Salfred xfer->max_packet_size = UGETW(edesc->wMaxPacketSize); 354184610Salfred xfer->max_packet_count = 1; 355184610Salfred /* make a shadow copy: */ 356184610Salfred xfer->flags_int.usb2_mode = parm->udev->flags.usb2_mode; 357184610Salfred 358184610Salfred parm->bufsize = setup_sub->bufsize; 359184610Salfred 360184610Salfred if (parm->speed == USB_SPEED_HIGH) { 361184610Salfred xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 362184610Salfred xfer->max_packet_size &= 0x7FF; 363184610Salfred } 364184610Salfred /* range check "max_packet_count" */ 365184610Salfred 366184610Salfred if (xfer->max_packet_count > parm->hc_max_packet_count) { 367184610Salfred xfer->max_packet_count = parm->hc_max_packet_count; 368184610Salfred } 369184610Salfred /* filter "wMaxPacketSize" according to HC capabilities */ 370184610Salfred 371184610Salfred if ((xfer->max_packet_size > parm->hc_max_packet_size) || 372184610Salfred (xfer->max_packet_size == 0)) { 373184610Salfred xfer->max_packet_size = parm->hc_max_packet_size; 374184610Salfred } 375184610Salfred /* filter "wMaxPacketSize" according to standard sizes */ 376184610Salfred 377184610Salfred std_size = usb2_std_packet_size[type][parm->speed]; 378184610Salfred 379184610Salfred if (std_size.range.min || std_size.range.max) { 380184610Salfred 381184610Salfred if (xfer->max_packet_size < std_size.range.min) { 382184610Salfred xfer->max_packet_size = std_size.range.min; 383184610Salfred } 384184610Salfred if (xfer->max_packet_size > std_size.range.max) { 385184610Salfred xfer->max_packet_size = std_size.range.max; 386184610Salfred } 387184610Salfred } else { 388184610Salfred 389184610Salfred if (xfer->max_packet_size >= std_size.fixed[3]) { 390184610Salfred xfer->max_packet_size = std_size.fixed[3]; 391184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[2]) { 392184610Salfred xfer->max_packet_size = std_size.fixed[2]; 393184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[1]) { 394184610Salfred xfer->max_packet_size = std_size.fixed[1]; 395184610Salfred } else { 396184610Salfred /* only one possibility left */ 397184610Salfred xfer->max_packet_size = std_size.fixed[0]; 398184610Salfred } 399184610Salfred } 400184610Salfred 401184610Salfred /* compute "max_frame_size" */ 402184610Salfred 403184610Salfred usb2_update_max_frame_size(xfer); 404184610Salfred 405184610Salfred /* check interrupt interval and transfer pre-delay */ 406184610Salfred 407184610Salfred if (type == UE_ISOCHRONOUS) { 408184610Salfred 409190181Sthompsa uint16_t frame_limit; 410184610Salfred 411184610Salfred xfer->interval = 0; /* not used, must be zero */ 412184610Salfred xfer->flags_int.isochronous_xfr = 1; /* set flag */ 413184610Salfred 414184610Salfred if (xfer->timeout == 0) { 415184610Salfred /* 416184610Salfred * set a default timeout in 417184610Salfred * case something goes wrong! 418184610Salfred */ 419184610Salfred xfer->timeout = 1000 / 4; 420184610Salfred } 421187180Sthompsa switch (parm->speed) { 422187180Sthompsa case USB_SPEED_LOW: 423187180Sthompsa case USB_SPEED_FULL: 424187180Sthompsa frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER; 425187180Sthompsa break; 426187180Sthompsa default: 427184610Salfred frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER; 428187180Sthompsa break; 429184610Salfred } 430184610Salfred 431184610Salfred if (xfer->nframes > frame_limit) { 432184610Salfred /* 433184610Salfred * this is not going to work 434184610Salfred * cross hardware 435184610Salfred */ 436184610Salfred parm->err = USB_ERR_INVAL; 437184610Salfred goto done; 438184610Salfred } 439184610Salfred if (xfer->nframes == 0) { 440184610Salfred /* 441184610Salfred * this is not a valid value 442184610Salfred */ 443184610Salfred parm->err = USB_ERR_ZERO_NFRAMES; 444184610Salfred goto done; 445184610Salfred } 446184610Salfred } else { 447184610Salfred 448184610Salfred /* 449184610Salfred * if a value is specified use that else check the endpoint 450184610Salfred * descriptor 451184610Salfred */ 452184610Salfred if (xfer->interval == 0) { 453184610Salfred 454184610Salfred if (type == UE_INTERRUPT) { 455184610Salfred 456184610Salfred xfer->interval = edesc->bInterval; 457184610Salfred 458187180Sthompsa switch (parm->speed) { 459187180Sthompsa case USB_SPEED_SUPER: 460187180Sthompsa case USB_SPEED_VARIABLE: 461187180Sthompsa /* 125us -> 1ms */ 462187180Sthompsa if (xfer->interval < 4) 463187180Sthompsa xfer->interval = 1; 464187180Sthompsa else if (xfer->interval > 16) 465187180Sthompsa xfer->interval = (1<<(16-4)); 466187180Sthompsa else 467187180Sthompsa xfer->interval = 468187180Sthompsa (1 << (xfer->interval-4)); 469187180Sthompsa break; 470187180Sthompsa case USB_SPEED_HIGH: 471187180Sthompsa /* 125us -> 1ms */ 472187180Sthompsa xfer->interval /= 8; 473187180Sthompsa break; 474187180Sthompsa default: 475187180Sthompsa break; 476184610Salfred } 477184610Salfred if (xfer->interval == 0) { 478184610Salfred /* 479187180Sthompsa * One millisecond is the smallest 480187180Sthompsa * interval we support: 481184610Salfred */ 482184610Salfred xfer->interval = 1; 483184610Salfred } 484184610Salfred } 485184610Salfred } 486184610Salfred } 487184610Salfred 488184610Salfred /* 489184610Salfred * NOTE: we do not allow "max_packet_size" or "max_frame_size" 490184610Salfred * to be equal to zero when setting up USB transfers, hence 491184610Salfred * this leads to alot of extra code in the USB kernel. 492184610Salfred */ 493184610Salfred 494184610Salfred if ((xfer->max_frame_size == 0) || 495184610Salfred (xfer->max_packet_size == 0)) { 496184610Salfred 497184610Salfred zmps = 1; 498184610Salfred 499184610Salfred if ((parm->bufsize <= MIN_PKT) && 500184610Salfred (type != UE_CONTROL) && 501184610Salfred (type != UE_BULK)) { 502184610Salfred 503184610Salfred /* workaround */ 504184610Salfred xfer->max_packet_size = MIN_PKT; 505184610Salfred xfer->max_packet_count = 1; 506184610Salfred parm->bufsize = 0; /* automatic setup length */ 507184610Salfred usb2_update_max_frame_size(xfer); 508184610Salfred 509184610Salfred } else { 510184610Salfred parm->err = USB_ERR_ZERO_MAXP; 511184610Salfred goto done; 512184610Salfred } 513184610Salfred 514184610Salfred } else { 515184610Salfred zmps = 0; 516184610Salfred } 517184610Salfred 518184610Salfred /* 519184610Salfred * check if we should setup a default 520184610Salfred * length: 521184610Salfred */ 522184610Salfred 523184610Salfred if (parm->bufsize == 0) { 524184610Salfred 525184610Salfred parm->bufsize = xfer->max_frame_size; 526184610Salfred 527184610Salfred if (type == UE_ISOCHRONOUS) { 528184610Salfred parm->bufsize *= xfer->nframes; 529184610Salfred } 530184610Salfred } 531184610Salfred /* 532184610Salfred * check if we are about to setup a proxy 533184610Salfred * type of buffer: 534184610Salfred */ 535184610Salfred 536184610Salfred if (xfer->flags.proxy_buffer) { 537184610Salfred 538184610Salfred /* round bufsize up */ 539184610Salfred 540184610Salfred parm->bufsize += (xfer->max_frame_size - 1); 541184610Salfred 542184610Salfred if (parm->bufsize < xfer->max_frame_size) { 543184610Salfred /* length wrapped around */ 544184610Salfred parm->err = USB_ERR_INVAL; 545184610Salfred goto done; 546184610Salfred } 547184610Salfred /* subtract remainder */ 548184610Salfred 549184610Salfred parm->bufsize -= (parm->bufsize % xfer->max_frame_size); 550184610Salfred 551184610Salfred /* add length of USB device request structure, if any */ 552184610Salfred 553184610Salfred if (type == UE_CONTROL) { 554184610Salfred parm->bufsize += REQ_SIZE; /* SETUP message */ 555184610Salfred } 556184610Salfred } 557184610Salfred xfer->max_data_length = parm->bufsize; 558184610Salfred 559184610Salfred /* Setup "n_frlengths" and "n_frbuffers" */ 560184610Salfred 561184610Salfred if (type == UE_ISOCHRONOUS) { 562184610Salfred n_frlengths = xfer->nframes; 563184610Salfred n_frbuffers = 1; 564184610Salfred } else { 565184610Salfred 566184610Salfred if (type == UE_CONTROL) { 567184610Salfred xfer->flags_int.control_xfr = 1; 568184610Salfred if (xfer->nframes == 0) { 569184610Salfred if (parm->bufsize <= REQ_SIZE) { 570184610Salfred /* 571184610Salfred * there will never be any data 572184610Salfred * stage 573184610Salfred */ 574184610Salfred xfer->nframes = 1; 575184610Salfred } else { 576184610Salfred xfer->nframes = 2; 577184610Salfred } 578184610Salfred } 579184610Salfred } else { 580184610Salfred if (xfer->nframes == 0) { 581184610Salfred xfer->nframes = 1; 582184610Salfred } 583184610Salfred } 584184610Salfred 585184610Salfred n_frlengths = xfer->nframes; 586184610Salfred n_frbuffers = xfer->nframes; 587184610Salfred } 588184610Salfred 589184610Salfred /* 590184610Salfred * check if we have room for the 591184610Salfred * USB device request structure: 592184610Salfred */ 593184610Salfred 594184610Salfred if (type == UE_CONTROL) { 595184610Salfred 596184610Salfred if (xfer->max_data_length < REQ_SIZE) { 597184610Salfred /* length wrapped around or too small bufsize */ 598184610Salfred parm->err = USB_ERR_INVAL; 599184610Salfred goto done; 600184610Salfred } 601184610Salfred xfer->max_data_length -= REQ_SIZE; 602184610Salfred } 603184610Salfred /* setup "frlengths" */ 604184610Salfred 605184610Salfred xfer->frlengths = parm->xfer_length_ptr; 606184610Salfred 607184610Salfred parm->xfer_length_ptr += n_frlengths; 608184610Salfred 609184610Salfred /* setup "frbuffers" */ 610184610Salfred 611184610Salfred xfer->frbuffers = parm->xfer_page_cache_ptr; 612184610Salfred 613184610Salfred parm->xfer_page_cache_ptr += n_frbuffers; 614184610Salfred 615184610Salfred /* 616184610Salfred * check if we need to setup 617184610Salfred * a local buffer: 618184610Salfred */ 619184610Salfred 620184610Salfred if (!xfer->flags.ext_buffer) { 621184610Salfred 622184610Salfred /* align data */ 623184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 624184610Salfred 625184610Salfred if (parm->buf) { 626184610Salfred 627184610Salfred xfer->local_buffer = 628184610Salfred USB_ADD_BYTES(parm->buf, parm->size[0]); 629184610Salfred 630184610Salfred usb2_set_frame_offset(xfer, 0, 0); 631184610Salfred 632184610Salfred if ((type == UE_CONTROL) && (n_frbuffers > 1)) { 633184610Salfred usb2_set_frame_offset(xfer, REQ_SIZE, 1); 634184610Salfred } 635184610Salfred } 636184610Salfred parm->size[0] += parm->bufsize; 637184610Salfred 638184610Salfred /* align data again */ 639184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 640184610Salfred } 641184610Salfred /* 642184610Salfred * Compute maximum buffer size 643184610Salfred */ 644184610Salfred 645184610Salfred if (parm->bufsize_max < parm->bufsize) { 646184610Salfred parm->bufsize_max = parm->bufsize; 647184610Salfred } 648190180Sthompsa#if USB_HAVE_BUSDMA 649184610Salfred if (xfer->flags_int.bdma_enable) { 650184610Salfred /* 651184610Salfred * Setup "dma_page_ptr". 652184610Salfred * 653184610Salfred * Proof for formula below: 654184610Salfred * 655184610Salfred * Assume there are three USB frames having length "a", "b" and 656184610Salfred * "c". These USB frames will at maximum need "z" 657184610Salfred * "usb2_page" structures. "z" is given by: 658184610Salfred * 659184610Salfred * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) + 660184610Salfred * ((c / USB_PAGE_SIZE) + 2); 661184610Salfred * 662184610Salfred * Constraining "a", "b" and "c" like this: 663184610Salfred * 664184610Salfred * (a + b + c) <= parm->bufsize 665184610Salfred * 666184610Salfred * We know that: 667184610Salfred * 668184610Salfred * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2)); 669184610Salfred * 670184610Salfred * Here is the general formula: 671184610Salfred */ 672184610Salfred xfer->dma_page_ptr = parm->dma_page_ptr; 673184610Salfred parm->dma_page_ptr += (2 * n_frbuffers); 674184610Salfred parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE); 675184610Salfred } 676190180Sthompsa#endif 677184610Salfred if (zmps) { 678184610Salfred /* correct maximum data length */ 679184610Salfred xfer->max_data_length = 0; 680184610Salfred } 681184610Salfred /* subtract USB frame remainder from "hc_max_frame_size" */ 682184610Salfred 683190181Sthompsa xfer->max_hc_frame_size = 684184610Salfred (parm->hc_max_frame_size - 685184610Salfred (parm->hc_max_frame_size % xfer->max_frame_size)); 686184610Salfred 687190181Sthompsa if (xfer->max_hc_frame_size == 0) { 688184610Salfred parm->err = USB_ERR_INVAL; 689184610Salfred goto done; 690184610Salfred } 691184610Salfred /* initialize max frame count */ 692184610Salfred 693184610Salfred xfer->max_frame_count = xfer->nframes; 694184610Salfred 695184610Salfred /* initialize frame buffers */ 696184610Salfred 697184610Salfred if (parm->buf) { 698184610Salfred for (x = 0; x != n_frbuffers; x++) { 699184610Salfred xfer->frbuffers[x].tag_parent = 700187173Sthompsa &xfer->xroot->dma_parent_tag; 701190180Sthompsa#if USB_HAVE_BUSDMA 702184610Salfred if (xfer->flags_int.bdma_enable && 703184610Salfred (parm->bufsize_max > 0)) { 704184610Salfred 705184610Salfred if (usb2_pc_dmamap_create( 706184610Salfred xfer->frbuffers + x, 707184610Salfred parm->bufsize_max)) { 708184610Salfred parm->err = USB_ERR_NOMEM; 709184610Salfred goto done; 710184610Salfred } 711184610Salfred } 712190180Sthompsa#endif 713184610Salfred } 714184610Salfred } 715184610Salfreddone: 716184610Salfred if (parm->err) { 717184610Salfred /* 718184610Salfred * Set some dummy values so that we avoid division by zero: 719184610Salfred */ 720190181Sthompsa xfer->max_hc_frame_size = 1; 721184610Salfred xfer->max_frame_size = 1; 722184610Salfred xfer->max_packet_size = 1; 723184610Salfred xfer->max_data_length = 0; 724184610Salfred xfer->nframes = 0; 725184610Salfred xfer->max_frame_count = 0; 726184610Salfred } 727184610Salfred} 728184610Salfred 729184610Salfred/*------------------------------------------------------------------------* 730184610Salfred * usb2_transfer_setup - setup an array of USB transfers 731184610Salfred * 732184610Salfred * NOTE: You must always call "usb2_transfer_unsetup" after calling 733184610Salfred * "usb2_transfer_setup" if success was returned. 734184610Salfred * 735184610Salfred * The idea is that the USB device driver should pre-allocate all its 736184610Salfred * transfers by one call to this function. 737184610Salfred * 738184610Salfred * Return values: 739184610Salfred * 0: Success 740184610Salfred * Else: Failure 741184610Salfred *------------------------------------------------------------------------*/ 742184610Salfredusb2_error_t 743184610Salfredusb2_transfer_setup(struct usb2_device *udev, 744184610Salfred const uint8_t *ifaces, struct usb2_xfer **ppxfer, 745184610Salfred const struct usb2_config *setup_start, uint16_t n_setup, 746187173Sthompsa void *priv_sc, struct mtx *xfer_mtx) 747184610Salfred{ 748184610Salfred struct usb2_xfer dummy; 749184610Salfred struct usb2_setup_params parm; 750184610Salfred const struct usb2_config *setup_end = setup_start + n_setup; 751184610Salfred const struct usb2_config *setup; 752184610Salfred struct usb2_pipe *pipe; 753184610Salfred struct usb2_xfer_root *info; 754184610Salfred struct usb2_xfer *xfer; 755184610Salfred void *buf = NULL; 756184610Salfred uint16_t n; 757184610Salfred uint16_t refcount; 758184610Salfred 759184610Salfred parm.err = 0; 760184610Salfred refcount = 0; 761184610Salfred info = NULL; 762184610Salfred 763184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 764184610Salfred "usb2_transfer_setup can sleep!"); 765184610Salfred 766184610Salfred /* do some checking first */ 767184610Salfred 768184610Salfred if (n_setup == 0) { 769184610Salfred DPRINTFN(6, "setup array has zero length!\n"); 770184610Salfred return (USB_ERR_INVAL); 771184610Salfred } 772184610Salfred if (ifaces == 0) { 773184610Salfred DPRINTFN(6, "ifaces array is NULL!\n"); 774184610Salfred return (USB_ERR_INVAL); 775184610Salfred } 776187173Sthompsa if (xfer_mtx == NULL) { 777184610Salfred DPRINTFN(6, "using global lock\n"); 778187173Sthompsa xfer_mtx = &Giant; 779184610Salfred } 780184610Salfred /* sanity checks */ 781184610Salfred for (setup = setup_start, n = 0; 782184610Salfred setup != setup_end; setup++, n++) { 783190181Sthompsa if ((setup->mh.bufsize == (usb2_frlength_t)-1) || 784190181Sthompsa (setup->md.bufsize == (usb2_frlength_t)-1)) { 785184610Salfred parm.err = USB_ERR_BAD_BUFSIZE; 786184610Salfred DPRINTF("invalid bufsize\n"); 787184610Salfred } 788184610Salfred if ((setup->mh.callback == NULL) && 789184610Salfred (setup->md.callback == NULL)) { 790184610Salfred parm.err = USB_ERR_NO_CALLBACK; 791184610Salfred DPRINTF("no callback\n"); 792184610Salfred } 793184610Salfred ppxfer[n] = NULL; 794184610Salfred } 795184610Salfred 796184610Salfred if (parm.err) { 797184610Salfred goto done; 798184610Salfred } 799184610Salfred bzero(&parm, sizeof(parm)); 800184610Salfred 801184610Salfred parm.udev = udev; 802184610Salfred parm.speed = usb2_get_speed(udev); 803184610Salfred parm.hc_max_packet_count = 1; 804184610Salfred 805184610Salfred if (parm.speed >= USB_SPEED_MAX) { 806184610Salfred parm.err = USB_ERR_INVAL; 807184610Salfred goto done; 808184610Salfred } 809184610Salfred /* setup all transfers */ 810184610Salfred 811184610Salfred while (1) { 812184610Salfred 813184610Salfred if (buf) { 814184610Salfred /* 815184610Salfred * Initialize the "usb2_xfer_root" structure, 816184610Salfred * which is common for all our USB transfers. 817184610Salfred */ 818184610Salfred info = USB_ADD_BYTES(buf, 0); 819184610Salfred 820184610Salfred info->memory_base = buf; 821184610Salfred info->memory_size = parm.size[0]; 822184610Salfred 823190180Sthompsa#if USB_HAVE_BUSDMA 824184610Salfred info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]); 825184610Salfred info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]); 826190180Sthompsa#endif 827184610Salfred info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]); 828184610Salfred info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]); 829184610Salfred 830184610Salfred usb2_cv_init(&info->cv_drain, "WDRAIN"); 831184610Salfred 832187173Sthompsa info->xfer_mtx = xfer_mtx; 833190180Sthompsa#if USB_HAVE_BUSDMA 834184610Salfred usb2_dma_tag_setup(&info->dma_parent_tag, 835184610Salfred parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag, 836190180Sthompsa xfer_mtx, &usb2_bdma_done_event, 32, parm.dma_tag_max); 837190180Sthompsa#endif 838184610Salfred 839184610Salfred info->bus = udev->bus; 840187173Sthompsa info->udev = udev; 841184610Salfred 842184610Salfred TAILQ_INIT(&info->done_q.head); 843184610Salfred info->done_q.command = &usb2_callback_wrapper; 844190180Sthompsa#if USB_HAVE_BUSDMA 845184610Salfred TAILQ_INIT(&info->dma_q.head); 846184610Salfred info->dma_q.command = &usb2_bdma_work_loop; 847190180Sthompsa#endif 848184610Salfred info->done_m[0].hdr.pm_callback = &usb2_callback_proc; 849187173Sthompsa info->done_m[0].xroot = info; 850184610Salfred info->done_m[1].hdr.pm_callback = &usb2_callback_proc; 851187173Sthompsa info->done_m[1].xroot = info; 852184610Salfred 853187174Sthompsa if (xfer_mtx == &Giant) 854187174Sthompsa info->done_p = 855187174Sthompsa &udev->bus->giant_callback_proc; 856187174Sthompsa else 857187174Sthompsa info->done_p = 858187174Sthompsa &udev->bus->non_giant_callback_proc; 859184610Salfred } 860184610Salfred /* reset sizes */ 861184610Salfred 862184610Salfred parm.size[0] = 0; 863184610Salfred parm.buf = buf; 864184610Salfred parm.size[0] += sizeof(info[0]); 865184610Salfred 866184610Salfred for (setup = setup_start, n = 0; 867184610Salfred setup != setup_end; setup++, n++) { 868184610Salfred 869184610Salfred /* select mode specific structure */ 870184610Salfred if (udev->flags.usb2_mode == USB_MODE_HOST) { 871184610Salfred parm.curr_setup_sub = &setup->mh; 872184610Salfred } else { 873184610Salfred parm.curr_setup_sub = &setup->md; 874184610Salfred } 875184610Salfred /* skip USB transfers without callbacks: */ 876184610Salfred if (parm.curr_setup_sub->callback == NULL) { 877184610Salfred continue; 878184610Salfred } 879184610Salfred /* see if there is a matching endpoint */ 880184610Salfred pipe = usb2_get_pipe(udev, 881184610Salfred ifaces[setup->if_index], setup); 882184610Salfred 883184610Salfred if (!pipe) { 884184610Salfred if (parm.curr_setup_sub->flags.no_pipe_ok) { 885184610Salfred continue; 886184610Salfred } 887184610Salfred parm.err = USB_ERR_NO_PIPE; 888184610Salfred goto done; 889184610Salfred } 890184610Salfred /* store current setup pointer */ 891184610Salfred parm.curr_setup = setup; 892184610Salfred 893184610Salfred /* align data properly */ 894184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 895184610Salfred 896184610Salfred if (buf) { 897184610Salfred /* 898184610Salfred * Common initialization of the 899184610Salfred * "usb2_xfer" structure. 900184610Salfred */ 901184610Salfred xfer = USB_ADD_BYTES(buf, parm.size[0]); 902184610Salfred xfer->address = udev->address; 903184610Salfred xfer->priv_sc = priv_sc; 904187173Sthompsa xfer->xroot = info; 905184610Salfred 906184824Sthompsa usb2_callout_init_mtx(&xfer->timeout_handle, 907186454Sthompsa &udev->bus->bus_mtx, 0); 908184610Salfred } else { 909184610Salfred /* 910184610Salfred * Setup a dummy xfer, hence we are 911184610Salfred * writing to the "usb2_xfer" 912184610Salfred * structure pointed to by "xfer" 913184610Salfred * before we have allocated any 914184610Salfred * memory: 915184610Salfred */ 916184610Salfred xfer = &dummy; 917184610Salfred bzero(&dummy, sizeof(dummy)); 918184610Salfred refcount++; 919184610Salfred } 920184610Salfred 921188982Sthompsa /* set transfer pipe pointer */ 922188982Sthompsa xfer->pipe = pipe; 923188982Sthompsa 924184610Salfred parm.size[0] += sizeof(xfer[0]); 925188982Sthompsa parm.methods = xfer->pipe->methods; 926188982Sthompsa parm.curr_xfer = xfer; 927184610Salfred 928188982Sthompsa /* 929188982Sthompsa * Call the Host or Device controller transfer 930188982Sthompsa * setup routine: 931188982Sthompsa */ 932188982Sthompsa (udev->bus->methods->xfer_setup) (&parm); 933184610Salfred 934188982Sthompsa /* check for error */ 935188982Sthompsa if (parm.err) 936188982Sthompsa goto done; 937188982Sthompsa 938184610Salfred if (buf) { 939184610Salfred /* 940184610Salfred * Increment the pipe refcount. This 941184610Salfred * basically prevents setting a new 942184610Salfred * configuration and alternate setting 943184610Salfred * when USB transfers are in use on 944184610Salfred * the given interface. Search the USB 945184610Salfred * code for "pipe->refcount" if you 946184610Salfred * want more information. 947184610Salfred */ 948184610Salfred xfer->pipe->refcount++; 949184610Salfred 950188982Sthompsa /* 951188982Sthompsa * Whenever we set ppxfer[] then we 952188982Sthompsa * also need to increment the 953188982Sthompsa * "setup_refcount": 954188982Sthompsa */ 955188982Sthompsa info->setup_refcount++; 956184610Salfred 957188982Sthompsa /* 958188982Sthompsa * Transfer is successfully setup and 959188982Sthompsa * can be used: 960188982Sthompsa */ 961188982Sthompsa ppxfer[n] = xfer; 962184610Salfred } 963184610Salfred } 964184610Salfred 965184610Salfred if (buf || parm.err) { 966184610Salfred goto done; 967184610Salfred } 968184610Salfred if (refcount == 0) { 969184610Salfred /* no transfers - nothing to do ! */ 970184610Salfred goto done; 971184610Salfred } 972184610Salfred /* align data properly */ 973184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 974184610Salfred 975184610Salfred /* store offset temporarily */ 976184610Salfred parm.size[1] = parm.size[0]; 977184610Salfred 978184610Salfred /* 979184610Salfred * The number of DMA tags required depends on 980184610Salfred * the number of endpoints. The current estimate 981184610Salfred * for maximum number of DMA tags per endpoint 982184610Salfred * is two. 983184610Salfred */ 984184610Salfred parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX); 985184610Salfred 986184610Salfred /* 987184610Salfred * DMA tags for QH, TD, Data and more. 988184610Salfred */ 989184610Salfred parm.dma_tag_max += 8; 990184610Salfred 991184610Salfred parm.dma_tag_p += parm.dma_tag_max; 992184610Salfred 993184610Salfred parm.size[0] += ((uint8_t *)parm.dma_tag_p) - 994184610Salfred ((uint8_t *)0); 995184610Salfred 996184610Salfred /* align data properly */ 997184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 998184610Salfred 999184610Salfred /* store offset temporarily */ 1000184610Salfred parm.size[3] = parm.size[0]; 1001184610Salfred 1002184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_ptr) - 1003184610Salfred ((uint8_t *)0); 1004184610Salfred 1005184610Salfred /* align data properly */ 1006184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1007184610Salfred 1008184610Salfred /* store offset temporarily */ 1009184610Salfred parm.size[4] = parm.size[0]; 1010184610Salfred 1011184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) - 1012184610Salfred ((uint8_t *)0); 1013184610Salfred 1014184610Salfred /* store end offset temporarily */ 1015184610Salfred parm.size[5] = parm.size[0]; 1016184610Salfred 1017184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) - 1018184610Salfred ((uint8_t *)0); 1019184610Salfred 1020184610Salfred /* store end offset temporarily */ 1021184610Salfred 1022184610Salfred parm.size[2] = parm.size[0]; 1023184610Salfred 1024184610Salfred /* align data properly */ 1025184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1026184610Salfred 1027184610Salfred parm.size[6] = parm.size[0]; 1028184610Salfred 1029184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) - 1030184610Salfred ((uint8_t *)0); 1031184610Salfred 1032184610Salfred /* align data properly */ 1033184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1034184610Salfred 1035184610Salfred /* allocate zeroed memory */ 1036184610Salfred buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO); 1037184610Salfred 1038184610Salfred if (buf == NULL) { 1039184610Salfred parm.err = USB_ERR_NOMEM; 1040184610Salfred DPRINTFN(0, "cannot allocate memory block for " 1041184610Salfred "configuration (%d bytes)\n", 1042184610Salfred parm.size[0]); 1043184610Salfred goto done; 1044184610Salfred } 1045184610Salfred parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]); 1046184610Salfred parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]); 1047184610Salfred parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]); 1048184610Salfred parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]); 1049184610Salfred parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]); 1050184610Salfred } 1051184610Salfred 1052184610Salfreddone: 1053184610Salfred if (buf) { 1054184610Salfred if (info->setup_refcount == 0) { 1055184610Salfred /* 1056184610Salfred * "usb2_transfer_unsetup_sub" will unlock 1057184824Sthompsa * the bus mutex before returning ! 1058184610Salfred */ 1059184824Sthompsa USB_BUS_LOCK(info->bus); 1060184610Salfred 1061184610Salfred /* something went wrong */ 1062184610Salfred usb2_transfer_unsetup_sub(info, 0); 1063184610Salfred } 1064184610Salfred } 1065184610Salfred if (parm.err) { 1066184610Salfred usb2_transfer_unsetup(ppxfer, n_setup); 1067184610Salfred } 1068184610Salfred return (parm.err); 1069184610Salfred} 1070184610Salfred 1071184610Salfred/*------------------------------------------------------------------------* 1072184610Salfred * usb2_transfer_unsetup_sub - factored out code 1073184610Salfred *------------------------------------------------------------------------*/ 1074184610Salfredstatic void 1075184610Salfredusb2_transfer_unsetup_sub(struct usb2_xfer_root *info, uint8_t needs_delay) 1076184610Salfred{ 1077184610Salfred struct usb2_page_cache *pc; 1078184610Salfred 1079184824Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 1080184610Salfred 1081184610Salfred /* wait for any outstanding DMA operations */ 1082184610Salfred 1083184610Salfred if (needs_delay) { 1084190181Sthompsa usb2_timeout_t temp; 1085184610Salfred temp = usb2_get_dma_delay(info->bus); 1086188411Sthompsa usb2_pause_mtx(&info->bus->bus_mtx, 1087188411Sthompsa USB_MS_TO_TICKS(temp)); 1088184610Salfred } 1089187174Sthompsa 1090187174Sthompsa /* make sure that our done messages are not queued anywhere */ 1091187174Sthompsa usb2_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]); 1092187174Sthompsa 1093184824Sthompsa USB_BUS_UNLOCK(info->bus); 1094184610Salfred 1095190180Sthompsa#if USB_HAVE_BUSDMA 1096184610Salfred /* free DMA'able memory, if any */ 1097184610Salfred pc = info->dma_page_cache_start; 1098184610Salfred while (pc != info->dma_page_cache_end) { 1099184610Salfred usb2_pc_free_mem(pc); 1100184610Salfred pc++; 1101184610Salfred } 1102184610Salfred 1103184610Salfred /* free DMA maps in all "xfer->frbuffers" */ 1104184610Salfred pc = info->xfer_page_cache_start; 1105184610Salfred while (pc != info->xfer_page_cache_end) { 1106184610Salfred usb2_pc_dmamap_destroy(pc); 1107184610Salfred pc++; 1108184610Salfred } 1109184610Salfred 1110184610Salfred /* free all DMA tags */ 1111184610Salfred usb2_dma_tag_unsetup(&info->dma_parent_tag); 1112190180Sthompsa#endif 1113184610Salfred 1114184610Salfred usb2_cv_destroy(&info->cv_drain); 1115184610Salfred 1116184610Salfred /* 1117184610Salfred * free the "memory_base" last, hence the "info" structure is 1118184610Salfred * contained within the "memory_base"! 1119184610Salfred */ 1120184610Salfred free(info->memory_base, M_USB); 1121184610Salfred} 1122184610Salfred 1123184610Salfred/*------------------------------------------------------------------------* 1124184610Salfred * usb2_transfer_unsetup - unsetup/free an array of USB transfers 1125184610Salfred * 1126184610Salfred * NOTE: All USB transfers in progress will get called back passing 1127184610Salfred * the error code "USB_ERR_CANCELLED" before this function 1128184610Salfred * returns. 1129184610Salfred *------------------------------------------------------------------------*/ 1130184610Salfredvoid 1131184610Salfredusb2_transfer_unsetup(struct usb2_xfer **pxfer, uint16_t n_setup) 1132184610Salfred{ 1133184610Salfred struct usb2_xfer *xfer; 1134184610Salfred struct usb2_xfer_root *info; 1135184610Salfred uint8_t needs_delay = 0; 1136184610Salfred 1137184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1138184610Salfred "usb2_transfer_unsetup can sleep!"); 1139184610Salfred 1140184610Salfred while (n_setup--) { 1141184610Salfred xfer = pxfer[n_setup]; 1142184610Salfred 1143188982Sthompsa if (xfer == NULL) 1144188982Sthompsa continue; 1145184610Salfred 1146188982Sthompsa info = xfer->xroot; 1147184610Salfred 1148188982Sthompsa USB_XFER_LOCK(xfer); 1149188982Sthompsa USB_BUS_LOCK(info->bus); 1150184610Salfred 1151188982Sthompsa /* 1152188982Sthompsa * HINT: when you start/stop a transfer, it might be a 1153188982Sthompsa * good idea to directly use the "pxfer[]" structure: 1154188982Sthompsa * 1155188982Sthompsa * usb2_transfer_start(sc->pxfer[0]); 1156188982Sthompsa * usb2_transfer_stop(sc->pxfer[0]); 1157188982Sthompsa * 1158188982Sthompsa * That way, if your code has many parts that will not 1159188982Sthompsa * stop running under the same lock, in other words 1160188982Sthompsa * "xfer_mtx", the usb2_transfer_start and 1161188982Sthompsa * usb2_transfer_stop functions will simply return 1162188982Sthompsa * when they detect a NULL pointer argument. 1163188982Sthompsa * 1164188982Sthompsa * To avoid any races we clear the "pxfer[]" pointer 1165188982Sthompsa * while holding the private mutex of the driver: 1166188982Sthompsa */ 1167188982Sthompsa pxfer[n_setup] = NULL; 1168184610Salfred 1169188982Sthompsa USB_BUS_UNLOCK(info->bus); 1170188982Sthompsa USB_XFER_UNLOCK(xfer); 1171184610Salfred 1172188982Sthompsa usb2_transfer_drain(xfer); 1173184610Salfred 1174190180Sthompsa#if USB_HAVE_BUSDMA 1175188982Sthompsa if (xfer->flags_int.bdma_enable) 1176188982Sthompsa needs_delay = 1; 1177190180Sthompsa#endif 1178188982Sthompsa /* 1179188982Sthompsa * NOTE: default pipe does not have an 1180188982Sthompsa * interface, even if pipe->iface_index == 0 1181188982Sthompsa */ 1182188982Sthompsa xfer->pipe->refcount--; 1183184610Salfred 1184188982Sthompsa usb2_callout_drain(&xfer->timeout_handle); 1185184610Salfred 1186188982Sthompsa USB_BUS_LOCK(info->bus); 1187184610Salfred 1188188982Sthompsa USB_ASSERT(info->setup_refcount != 0, ("Invalid setup " 1189188982Sthompsa "reference count!\n")); 1190184610Salfred 1191188982Sthompsa info->setup_refcount--; 1192188982Sthompsa 1193188982Sthompsa if (info->setup_refcount == 0) { 1194188982Sthompsa usb2_transfer_unsetup_sub(info, 1195188982Sthompsa needs_delay); 1196188982Sthompsa } else { 1197188982Sthompsa USB_BUS_UNLOCK(info->bus); 1198184610Salfred } 1199184610Salfred } 1200184610Salfred} 1201184610Salfred 1202184610Salfred/*------------------------------------------------------------------------* 1203184610Salfred * usb2_control_transfer_init - factored out code 1204184610Salfred * 1205184610Salfred * In USB Device Mode we have to wait for the SETUP packet which 1206184610Salfred * containst the "struct usb2_device_request" structure, before we can 1207184610Salfred * transfer any data. In USB Host Mode we already have the SETUP 1208184610Salfred * packet at the moment the USB transfer is started. This leads us to 1209184610Salfred * having to setup the USB transfer at two different places in 1210184610Salfred * time. This function just contains factored out control transfer 1211184610Salfred * initialisation code, so that we don't duplicate the code. 1212184610Salfred *------------------------------------------------------------------------*/ 1213184610Salfredstatic void 1214184610Salfredusb2_control_transfer_init(struct usb2_xfer *xfer) 1215184610Salfred{ 1216184610Salfred struct usb2_device_request req; 1217184610Salfred 1218184610Salfred /* copy out the USB request header */ 1219184610Salfred 1220184610Salfred usb2_copy_out(xfer->frbuffers, 0, &req, sizeof(req)); 1221184610Salfred 1222184610Salfred /* setup remainder */ 1223184610Salfred 1224184610Salfred xfer->flags_int.control_rem = UGETW(req.wLength); 1225184610Salfred 1226184610Salfred /* copy direction to endpoint variable */ 1227184610Salfred 1228184610Salfred xfer->endpoint &= ~(UE_DIR_IN | UE_DIR_OUT); 1229184610Salfred xfer->endpoint |= 1230184610Salfred (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT; 1231184610Salfred} 1232184610Salfred 1233184610Salfred/*------------------------------------------------------------------------* 1234184610Salfred * usb2_start_hardware_sub 1235184610Salfred * 1236184610Salfred * This function handles initialisation of control transfers. Control 1237184610Salfred * transfers are special in that regard that they can both transmit 1238184610Salfred * and receive data. 1239184610Salfred * 1240184610Salfred * Return values: 1241184610Salfred * 0: Success 1242184610Salfred * Else: Failure 1243184610Salfred *------------------------------------------------------------------------*/ 1244184610Salfredstatic uint8_t 1245184610Salfredusb2_start_hardware_sub(struct usb2_xfer *xfer) 1246184610Salfred{ 1247190181Sthompsa usb2_frlength_t len; 1248184610Salfred 1249184610Salfred /* Check for control endpoint stall */ 1250184610Salfred if (xfer->flags.stall_pipe) { 1251184610Salfred /* no longer active */ 1252184610Salfred xfer->flags_int.control_act = 0; 1253184610Salfred } 1254184610Salfred /* 1255184610Salfred * Check if there is a control 1256184610Salfred * transfer in progress: 1257184610Salfred */ 1258184610Salfred if (xfer->flags_int.control_act) { 1259184610Salfred 1260184610Salfred if (xfer->flags_int.control_hdr) { 1261184610Salfred 1262184610Salfred /* clear send header flag */ 1263184610Salfred 1264184610Salfred xfer->flags_int.control_hdr = 0; 1265184610Salfred 1266184610Salfred /* setup control transfer */ 1267184610Salfred if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) { 1268184610Salfred usb2_control_transfer_init(xfer); 1269184610Salfred } 1270184610Salfred } 1271184610Salfred /* get data length */ 1272184610Salfred 1273184610Salfred len = xfer->sumlen; 1274184610Salfred 1275184610Salfred } else { 1276184610Salfred 1277184610Salfred /* the size of the SETUP structure is hardcoded ! */ 1278184610Salfred 1279184610Salfred if (xfer->frlengths[0] != sizeof(struct usb2_device_request)) { 1280184610Salfred DPRINTFN(0, "Wrong framelength %u != %zu\n", 1281184610Salfred xfer->frlengths[0], sizeof(struct 1282184610Salfred usb2_device_request)); 1283184610Salfred goto error; 1284184610Salfred } 1285184610Salfred /* check USB mode */ 1286184610Salfred if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) { 1287184610Salfred 1288184610Salfred /* check number of frames */ 1289184610Salfred if (xfer->nframes != 1) { 1290184610Salfred /* 1291184610Salfred * We need to receive the setup 1292184610Salfred * message first so that we know the 1293184610Salfred * data direction! 1294184610Salfred */ 1295184610Salfred DPRINTF("Misconfigured transfer\n"); 1296184610Salfred goto error; 1297184610Salfred } 1298184610Salfred /* 1299184610Salfred * Set a dummy "control_rem" value. This 1300184610Salfred * variable will be overwritten later by a 1301184610Salfred * call to "usb2_control_transfer_init()" ! 1302184610Salfred */ 1303184610Salfred xfer->flags_int.control_rem = 0xFFFF; 1304184610Salfred } else { 1305184610Salfred 1306184610Salfred /* setup "endpoint" and "control_rem" */ 1307184610Salfred 1308184610Salfred usb2_control_transfer_init(xfer); 1309184610Salfred } 1310184610Salfred 1311184610Salfred /* set transfer-header flag */ 1312184610Salfred 1313184610Salfred xfer->flags_int.control_hdr = 1; 1314184610Salfred 1315184610Salfred /* get data length */ 1316184610Salfred 1317184610Salfred len = (xfer->sumlen - sizeof(struct usb2_device_request)); 1318184610Salfred } 1319184610Salfred 1320184610Salfred /* check if there is a length mismatch */ 1321184610Salfred 1322184610Salfred if (len > xfer->flags_int.control_rem) { 1323184610Salfred DPRINTFN(0, "Length greater than remaining length!\n"); 1324184610Salfred goto error; 1325184610Salfred } 1326184610Salfred /* check if we are doing a short transfer */ 1327184610Salfred 1328184610Salfred if (xfer->flags.force_short_xfer) { 1329184610Salfred xfer->flags_int.control_rem = 0; 1330184610Salfred } else { 1331184610Salfred if ((len != xfer->max_data_length) && 1332184610Salfred (len != xfer->flags_int.control_rem) && 1333184610Salfred (xfer->nframes != 1)) { 1334184610Salfred DPRINTFN(0, "Short control transfer without " 1335184610Salfred "force_short_xfer set!\n"); 1336184610Salfred goto error; 1337184610Salfred } 1338184610Salfred xfer->flags_int.control_rem -= len; 1339184610Salfred } 1340184610Salfred 1341184610Salfred /* the status part is executed when "control_act" is 0 */ 1342184610Salfred 1343184610Salfred if ((xfer->flags_int.control_rem > 0) || 1344184610Salfred (xfer->flags.manual_status)) { 1345184610Salfred /* don't execute the STATUS stage yet */ 1346184610Salfred xfer->flags_int.control_act = 1; 1347184610Salfred 1348184610Salfred /* sanity check */ 1349184610Salfred if ((!xfer->flags_int.control_hdr) && 1350184610Salfred (xfer->nframes == 1)) { 1351184610Salfred /* 1352184610Salfred * This is not a valid operation! 1353184610Salfred */ 1354184610Salfred DPRINTFN(0, "Invalid parameter " 1355184610Salfred "combination\n"); 1356184610Salfred goto error; 1357184610Salfred } 1358184610Salfred } else { 1359184610Salfred /* time to execute the STATUS stage */ 1360184610Salfred xfer->flags_int.control_act = 0; 1361184610Salfred } 1362184610Salfred return (0); /* success */ 1363184610Salfred 1364184610Salfrederror: 1365184610Salfred return (1); /* failure */ 1366184610Salfred} 1367184610Salfred 1368184610Salfred/*------------------------------------------------------------------------* 1369184610Salfred * usb2_start_hardware - start USB hardware for the given transfer 1370184610Salfred * 1371184610Salfred * This function should only be called from the USB callback. 1372184610Salfred *------------------------------------------------------------------------*/ 1373184610Salfredvoid 1374184610Salfredusb2_start_hardware(struct usb2_xfer *xfer) 1375184610Salfred{ 1376190181Sthompsa usb2_frcount_t x; 1377184610Salfred 1378184610Salfred DPRINTF("xfer=%p, pipe=%p, nframes=%d, dir=%s\n", 1379184610Salfred xfer, xfer->pipe, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ? 1380184610Salfred "read" : "write"); 1381184610Salfred 1382184610Salfred#if USB_DEBUG 1383184610Salfred if (USB_DEBUG_VAR > 0) { 1384187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1385184610Salfred 1386184610Salfred usb2_dump_pipe(xfer->pipe); 1387184610Salfred 1388187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1389184610Salfred } 1390184610Salfred#endif 1391184610Salfred 1392184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1393187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_NOTOWNED); 1394184610Salfred 1395184610Salfred /* Only open the USB transfer once! */ 1396184610Salfred if (!xfer->flags_int.open) { 1397184610Salfred xfer->flags_int.open = 1; 1398184610Salfred 1399184610Salfred DPRINTF("open\n"); 1400184610Salfred 1401187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1402184610Salfred (xfer->pipe->methods->open) (xfer); 1403187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1404184610Salfred } 1405184610Salfred /* set "transferring" flag */ 1406184610Salfred xfer->flags_int.transferring = 1; 1407184610Salfred 1408186730Salfred /* increment power reference */ 1409186730Salfred usb2_transfer_power_ref(xfer, 1); 1410186730Salfred 1411184610Salfred /* 1412184610Salfred * Check if the transfer is waiting on a queue, most 1413184610Salfred * frequently the "done_q": 1414184610Salfred */ 1415184610Salfred if (xfer->wait_queue) { 1416187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1417184610Salfred usb2_transfer_dequeue(xfer); 1418187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1419184610Salfred } 1420184610Salfred /* clear "did_dma_delay" flag */ 1421184610Salfred xfer->flags_int.did_dma_delay = 0; 1422184610Salfred 1423184610Salfred /* clear "did_close" flag */ 1424184610Salfred xfer->flags_int.did_close = 0; 1425184610Salfred 1426190180Sthompsa#if USB_HAVE_BUSDMA 1427184610Salfred /* clear "bdma_setup" flag */ 1428184610Salfred xfer->flags_int.bdma_setup = 0; 1429190180Sthompsa#endif 1430184610Salfred /* by default we cannot cancel any USB transfer immediately */ 1431184610Salfred xfer->flags_int.can_cancel_immed = 0; 1432184610Salfred 1433184610Salfred /* clear lengths and frame counts by default */ 1434184610Salfred xfer->sumlen = 0; 1435184610Salfred xfer->actlen = 0; 1436184610Salfred xfer->aframes = 0; 1437184610Salfred 1438184610Salfred /* clear any previous errors */ 1439184610Salfred xfer->error = 0; 1440184610Salfred 1441184610Salfred /* sanity check */ 1442184610Salfred 1443184610Salfred if (xfer->nframes == 0) { 1444184610Salfred if (xfer->flags.stall_pipe) { 1445184610Salfred /* 1446184610Salfred * Special case - want to stall without transferring 1447184610Salfred * any data: 1448184610Salfred */ 1449184610Salfred DPRINTF("xfer=%p nframes=0: stall " 1450184610Salfred "or clear stall!\n", xfer); 1451187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1452184610Salfred xfer->flags_int.can_cancel_immed = 1; 1453184610Salfred /* start the transfer */ 1454184610Salfred usb2_command_wrapper(&xfer->pipe->pipe_q, xfer); 1455187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1456184610Salfred return; 1457184610Salfred } 1458187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1459184610Salfred usb2_transfer_done(xfer, USB_ERR_INVAL); 1460187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1461184610Salfred return; 1462184610Salfred } 1463184610Salfred /* compute total transfer length */ 1464184610Salfred 1465184610Salfred for (x = 0; x != xfer->nframes; x++) { 1466184610Salfred xfer->sumlen += xfer->frlengths[x]; 1467184610Salfred if (xfer->sumlen < xfer->frlengths[x]) { 1468184610Salfred /* length wrapped around */ 1469187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1470184610Salfred usb2_transfer_done(xfer, USB_ERR_INVAL); 1471187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1472184610Salfred return; 1473184610Salfred } 1474184610Salfred } 1475184610Salfred 1476184610Salfred /* clear some internal flags */ 1477184610Salfred 1478184610Salfred xfer->flags_int.short_xfer_ok = 0; 1479184610Salfred xfer->flags_int.short_frames_ok = 0; 1480184610Salfred 1481184610Salfred /* check if this is a control transfer */ 1482184610Salfred 1483184610Salfred if (xfer->flags_int.control_xfr) { 1484184610Salfred 1485184610Salfred if (usb2_start_hardware_sub(xfer)) { 1486187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1487184610Salfred usb2_transfer_done(xfer, USB_ERR_STALLED); 1488187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1489184610Salfred return; 1490184610Salfred } 1491184610Salfred } 1492184610Salfred /* 1493184610Salfred * Setup filtered version of some transfer flags, 1494184610Salfred * in case of data read direction 1495184610Salfred */ 1496184610Salfred if (USB_GET_DATA_ISREAD(xfer)) { 1497184610Salfred 1498184610Salfred if (xfer->flags_int.control_xfr) { 1499184610Salfred 1500184610Salfred /* 1501184610Salfred * Control transfers do not support reception 1502184610Salfred * of multiple short USB frames ! 1503184610Salfred */ 1504184610Salfred 1505184610Salfred if (xfer->flags.short_xfer_ok) { 1506184610Salfred xfer->flags_int.short_xfer_ok = 1; 1507184610Salfred } 1508184610Salfred } else { 1509184610Salfred 1510184610Salfred if (xfer->flags.short_frames_ok) { 1511184610Salfred xfer->flags_int.short_xfer_ok = 1; 1512184610Salfred xfer->flags_int.short_frames_ok = 1; 1513184610Salfred } else if (xfer->flags.short_xfer_ok) { 1514184610Salfred xfer->flags_int.short_xfer_ok = 1; 1515184610Salfred } 1516184610Salfred } 1517184610Salfred } 1518184610Salfred /* 1519184610Salfred * Check if BUS-DMA support is enabled and try to load virtual 1520184610Salfred * buffers into DMA, if any: 1521184610Salfred */ 1522190180Sthompsa#if USB_HAVE_BUSDMA 1523184610Salfred if (xfer->flags_int.bdma_enable) { 1524184610Salfred /* insert the USB transfer last in the BUS-DMA queue */ 1525187173Sthompsa usb2_command_wrapper(&xfer->xroot->dma_q, xfer); 1526184610Salfred return; 1527184610Salfred } 1528190180Sthompsa#endif 1529184610Salfred /* 1530184610Salfred * Enter the USB transfer into the Host Controller or 1531184610Salfred * Device Controller schedule: 1532184610Salfred */ 1533184610Salfred usb2_pipe_enter(xfer); 1534184610Salfred} 1535184610Salfred 1536184610Salfred/*------------------------------------------------------------------------* 1537184610Salfred * usb2_pipe_enter - factored out code 1538184610Salfred *------------------------------------------------------------------------*/ 1539184610Salfredvoid 1540184610Salfredusb2_pipe_enter(struct usb2_xfer *xfer) 1541184610Salfred{ 1542184610Salfred struct usb2_pipe *pipe; 1543184610Salfred 1544184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1545184610Salfred 1546187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1547184610Salfred 1548184610Salfred pipe = xfer->pipe; 1549184610Salfred 1550184610Salfred DPRINTF("enter\n"); 1551184610Salfred 1552184610Salfred /* enter the transfer */ 1553184610Salfred (pipe->methods->enter) (xfer); 1554184610Salfred 1555184610Salfred /* check cancelability */ 1556184610Salfred if (pipe->methods->enter_is_cancelable) { 1557184610Salfred xfer->flags_int.can_cancel_immed = 1; 1558184610Salfred /* check for transfer error */ 1559184610Salfred if (xfer->error) { 1560184610Salfred /* some error has happened */ 1561184610Salfred usb2_transfer_done(xfer, 0); 1562187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1563184610Salfred return; 1564184610Salfred } 1565184610Salfred } else { 1566184610Salfred xfer->flags_int.can_cancel_immed = 0; 1567184610Salfred } 1568184610Salfred 1569184610Salfred /* start the transfer */ 1570184610Salfred usb2_command_wrapper(&pipe->pipe_q, xfer); 1571187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1572184610Salfred} 1573184610Salfred 1574184610Salfred/*------------------------------------------------------------------------* 1575184610Salfred * usb2_transfer_start - start an USB transfer 1576184610Salfred * 1577184610Salfred * NOTE: Calling this function more than one time will only 1578184610Salfred * result in a single transfer start, until the USB transfer 1579184610Salfred * completes. 1580184610Salfred *------------------------------------------------------------------------*/ 1581184610Salfredvoid 1582184610Salfredusb2_transfer_start(struct usb2_xfer *xfer) 1583184610Salfred{ 1584184610Salfred if (xfer == NULL) { 1585184610Salfred /* transfer is gone */ 1586184610Salfred return; 1587184610Salfred } 1588184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1589184610Salfred 1590184610Salfred /* mark the USB transfer started */ 1591184610Salfred 1592184610Salfred if (!xfer->flags_int.started) { 1593184610Salfred xfer->flags_int.started = 1; 1594184610Salfred } 1595184610Salfred /* check if the USB transfer callback is already transferring */ 1596184610Salfred 1597184610Salfred if (xfer->flags_int.transferring) { 1598184610Salfred return; 1599184610Salfred } 1600187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1601184610Salfred /* call the USB transfer callback */ 1602184610Salfred usb2_callback_ss_done_defer(xfer); 1603187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1604184610Salfred} 1605184610Salfred 1606184610Salfred/*------------------------------------------------------------------------* 1607184610Salfred * usb2_transfer_stop - stop an USB transfer 1608184610Salfred * 1609184610Salfred * NOTE: Calling this function more than one time will only 1610184610Salfred * result in a single transfer stop. 1611184610Salfred * NOTE: When this function returns it is not safe to free nor 1612184610Salfred * reuse any DMA buffers. See "usb2_transfer_drain()". 1613184610Salfred *------------------------------------------------------------------------*/ 1614184610Salfredvoid 1615184610Salfredusb2_transfer_stop(struct usb2_xfer *xfer) 1616184610Salfred{ 1617184610Salfred struct usb2_pipe *pipe; 1618184610Salfred 1619184610Salfred if (xfer == NULL) { 1620184610Salfred /* transfer is gone */ 1621184610Salfred return; 1622184610Salfred } 1623184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1624184610Salfred 1625184610Salfred /* check if the USB transfer was ever opened */ 1626184610Salfred 1627184610Salfred if (!xfer->flags_int.open) { 1628184610Salfred /* nothing to do except clearing the "started" flag */ 1629184610Salfred xfer->flags_int.started = 0; 1630184610Salfred return; 1631184610Salfred } 1632184610Salfred /* try to stop the current USB transfer */ 1633184610Salfred 1634187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1635184610Salfred xfer->error = USB_ERR_CANCELLED;/* override any previous error */ 1636184610Salfred /* 1637184610Salfred * Clear "open" and "started" when both private and USB lock 1638184610Salfred * is locked so that we don't get a race updating "flags_int" 1639184610Salfred */ 1640184610Salfred xfer->flags_int.open = 0; 1641184610Salfred xfer->flags_int.started = 0; 1642184610Salfred 1643184610Salfred /* 1644184610Salfred * Check if we can cancel the USB transfer immediately. 1645184610Salfred */ 1646184610Salfred if (xfer->flags_int.transferring) { 1647184610Salfred if (xfer->flags_int.can_cancel_immed && 1648184610Salfred (!xfer->flags_int.did_close)) { 1649184610Salfred DPRINTF("close\n"); 1650184610Salfred /* 1651184610Salfred * The following will lead to an USB_ERR_CANCELLED 1652184610Salfred * error code being passed to the USB callback. 1653184610Salfred */ 1654184610Salfred (xfer->pipe->methods->close) (xfer); 1655184610Salfred /* only close once */ 1656184610Salfred xfer->flags_int.did_close = 1; 1657184610Salfred } else { 1658184610Salfred /* need to wait for the next done callback */ 1659184610Salfred } 1660184610Salfred } else { 1661184610Salfred DPRINTF("close\n"); 1662184610Salfred 1663184610Salfred /* close here and now */ 1664184610Salfred (xfer->pipe->methods->close) (xfer); 1665184610Salfred 1666184610Salfred /* 1667184610Salfred * Any additional DMA delay is done by 1668184610Salfred * "usb2_transfer_unsetup()". 1669184610Salfred */ 1670184610Salfred 1671184610Salfred /* 1672184610Salfred * Special case. Check if we need to restart a blocked 1673184610Salfred * pipe. 1674184610Salfred */ 1675184610Salfred pipe = xfer->pipe; 1676184610Salfred 1677184610Salfred /* 1678184610Salfred * If the current USB transfer is completing we need 1679184610Salfred * to start the next one: 1680184610Salfred */ 1681184610Salfred if (pipe->pipe_q.curr == xfer) { 1682184610Salfred usb2_command_wrapper(&pipe->pipe_q, NULL); 1683184610Salfred } 1684184610Salfred } 1685184610Salfred 1686187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1687184610Salfred} 1688184610Salfred 1689184610Salfred/*------------------------------------------------------------------------* 1690184610Salfred * usb2_transfer_pending 1691184610Salfred * 1692184610Salfred * This function will check if an USB transfer is pending which is a 1693184610Salfred * little bit complicated! 1694184610Salfred * Return values: 1695184610Salfred * 0: Not pending 1696184610Salfred * 1: Pending: The USB transfer will receive a callback in the future. 1697184610Salfred *------------------------------------------------------------------------*/ 1698184610Salfreduint8_t 1699184610Salfredusb2_transfer_pending(struct usb2_xfer *xfer) 1700184610Salfred{ 1701184610Salfred struct usb2_xfer_root *info; 1702184610Salfred struct usb2_xfer_queue *pq; 1703184610Salfred 1704188600Sthompsa if (xfer == NULL) { 1705188600Sthompsa /* transfer is gone */ 1706188600Sthompsa return (0); 1707188600Sthompsa } 1708184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1709184610Salfred 1710184610Salfred if (xfer->flags_int.transferring) { 1711184610Salfred /* trivial case */ 1712184610Salfred return (1); 1713184610Salfred } 1714187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1715184610Salfred if (xfer->wait_queue) { 1716184610Salfred /* we are waiting on a queue somewhere */ 1717187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1718184610Salfred return (1); 1719184610Salfred } 1720187173Sthompsa info = xfer->xroot; 1721184610Salfred pq = &info->done_q; 1722184610Salfred 1723184610Salfred if (pq->curr == xfer) { 1724184610Salfred /* we are currently scheduled for callback */ 1725187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1726184610Salfred return (1); 1727184610Salfred } 1728184610Salfred /* we are not pending */ 1729187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1730184610Salfred return (0); 1731184610Salfred} 1732184610Salfred 1733184610Salfred/*------------------------------------------------------------------------* 1734184610Salfred * usb2_transfer_drain 1735184610Salfred * 1736184610Salfred * This function will stop the USB transfer and wait for any 1737184610Salfred * additional BUS-DMA and HW-DMA operations to complete. Buffers that 1738184610Salfred * are loaded into DMA can safely be freed or reused after that this 1739184610Salfred * function has returned. 1740184610Salfred *------------------------------------------------------------------------*/ 1741184610Salfredvoid 1742184610Salfredusb2_transfer_drain(struct usb2_xfer *xfer) 1743184610Salfred{ 1744184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1745184610Salfred "usb2_transfer_drain can sleep!"); 1746184610Salfred 1747184610Salfred if (xfer == NULL) { 1748184610Salfred /* transfer is gone */ 1749184610Salfred return; 1750184610Salfred } 1751187173Sthompsa if (xfer->xroot->xfer_mtx != &Giant) { 1752184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED); 1753184610Salfred } 1754184824Sthompsa USB_XFER_LOCK(xfer); 1755184610Salfred 1756184610Salfred usb2_transfer_stop(xfer); 1757184610Salfred 1758184610Salfred while (usb2_transfer_pending(xfer)) { 1759184610Salfred xfer->flags_int.draining = 1; 1760184610Salfred /* 1761184610Salfred * Wait until the current outstanding USB 1762184610Salfred * transfer is complete ! 1763184610Salfred */ 1764187173Sthompsa usb2_cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx); 1765184610Salfred } 1766184824Sthompsa USB_XFER_UNLOCK(xfer); 1767184610Salfred} 1768184610Salfred 1769184610Salfred/*------------------------------------------------------------------------* 1770184610Salfred * usb2_set_frame_data 1771184610Salfred * 1772184610Salfred * This function sets the pointer of the buffer that should 1773184610Salfred * loaded directly into DMA for the given USB frame. Passing "ptr" 1774184610Salfred * equal to NULL while the corresponding "frlength" is greater 1775184610Salfred * than zero gives undefined results! 1776184610Salfred *------------------------------------------------------------------------*/ 1777184610Salfredvoid 1778190181Sthompsausb2_set_frame_data(struct usb2_xfer *xfer, void *ptr, usb2_frcount_t frindex) 1779184610Salfred{ 1780184610Salfred /* set virtual address to load and length */ 1781184610Salfred xfer->frbuffers[frindex].buffer = ptr; 1782184610Salfred} 1783184610Salfred 1784184610Salfred/*------------------------------------------------------------------------* 1785184610Salfred * usb2_set_frame_offset 1786184610Salfred * 1787184610Salfred * This function sets the frame data buffer offset relative to the beginning 1788184610Salfred * of the USB DMA buffer allocated for this USB transfer. 1789184610Salfred *------------------------------------------------------------------------*/ 1790184610Salfredvoid 1791190181Sthompsausb2_set_frame_offset(struct usb2_xfer *xfer, usb2_frlength_t offset, 1792190181Sthompsa usb2_frcount_t frindex) 1793184610Salfred{ 1794184610Salfred USB_ASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame " 1795184610Salfred "when the USB buffer is external!\n")); 1796184610Salfred 1797184610Salfred /* set virtual address to load */ 1798184610Salfred xfer->frbuffers[frindex].buffer = 1799184610Salfred USB_ADD_BYTES(xfer->local_buffer, offset); 1800184610Salfred} 1801184610Salfred 1802184610Salfred/*------------------------------------------------------------------------* 1803184610Salfred * usb2_callback_proc - factored out code 1804184610Salfred * 1805184610Salfred * This function performs USB callbacks. 1806184610Salfred *------------------------------------------------------------------------*/ 1807184610Salfredstatic void 1808184610Salfredusb2_callback_proc(struct usb2_proc_msg *_pm) 1809184610Salfred{ 1810184610Salfred struct usb2_done_msg *pm = (void *)_pm; 1811187173Sthompsa struct usb2_xfer_root *info = pm->xroot; 1812184610Salfred 1813184610Salfred /* Change locking order */ 1814184824Sthompsa USB_BUS_UNLOCK(info->bus); 1815184610Salfred 1816184610Salfred /* 1817184610Salfred * We exploit the fact that the mutex is the same for all 1818184610Salfred * callbacks that will be called from this thread: 1819184610Salfred */ 1820187173Sthompsa mtx_lock(info->xfer_mtx); 1821184824Sthompsa USB_BUS_LOCK(info->bus); 1822184610Salfred 1823184610Salfred /* Continue where we lost track */ 1824184610Salfred usb2_command_wrapper(&info->done_q, 1825184610Salfred info->done_q.curr); 1826184610Salfred 1827187173Sthompsa mtx_unlock(info->xfer_mtx); 1828184610Salfred} 1829184610Salfred 1830184610Salfred/*------------------------------------------------------------------------* 1831184610Salfred * usb2_callback_ss_done_defer 1832184610Salfred * 1833184610Salfred * This function will defer the start, stop and done callback to the 1834184610Salfred * correct thread. 1835184610Salfred *------------------------------------------------------------------------*/ 1836184610Salfredstatic void 1837184610Salfredusb2_callback_ss_done_defer(struct usb2_xfer *xfer) 1838184610Salfred{ 1839187173Sthompsa struct usb2_xfer_root *info = xfer->xroot; 1840184610Salfred struct usb2_xfer_queue *pq = &info->done_q; 1841184610Salfred 1842187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1843184824Sthompsa 1844184610Salfred if (pq->curr != xfer) { 1845184610Salfred usb2_transfer_enqueue(pq, xfer); 1846184610Salfred } 1847184610Salfred if (!pq->recurse_1) { 1848184610Salfred 1849184610Salfred /* 1850184610Salfred * We have to postpone the callback due to the fact we 1851184610Salfred * will have a Lock Order Reversal, LOR, if we try to 1852184610Salfred * proceed ! 1853184610Salfred */ 1854187174Sthompsa if (usb2_proc_msignal(info->done_p, 1855184610Salfred &info->done_m[0], &info->done_m[1])) { 1856184610Salfred /* ignore */ 1857184610Salfred } 1858184610Salfred } else { 1859184610Salfred /* clear second recurse flag */ 1860184610Salfred pq->recurse_2 = 0; 1861184610Salfred } 1862184610Salfred return; 1863184610Salfred 1864184610Salfred} 1865184610Salfred 1866184610Salfred/*------------------------------------------------------------------------* 1867184610Salfred * usb2_callback_wrapper 1868184610Salfred * 1869184610Salfred * This is a wrapper for USB callbacks. This wrapper does some 1870184610Salfred * auto-magic things like figuring out if we can call the callback 1871184610Salfred * directly from the current context or if we need to wakeup the 1872184610Salfred * interrupt process. 1873184610Salfred *------------------------------------------------------------------------*/ 1874184610Salfredstatic void 1875184610Salfredusb2_callback_wrapper(struct usb2_xfer_queue *pq) 1876184610Salfred{ 1877184610Salfred struct usb2_xfer *xfer = pq->curr; 1878187173Sthompsa struct usb2_xfer_root *info = xfer->xroot; 1879184610Salfred 1880187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1881187173Sthompsa if (!mtx_owned(xfer->xroot->xfer_mtx)) { 1882184610Salfred /* 1883184610Salfred * Cases that end up here: 1884184610Salfred * 1885184610Salfred * 5) HW interrupt done callback or other source. 1886184610Salfred */ 1887184610Salfred DPRINTFN(3, "case 5\n"); 1888184610Salfred 1889184610Salfred /* 1890184610Salfred * We have to postpone the callback due to the fact we 1891184610Salfred * will have a Lock Order Reversal, LOR, if we try to 1892184610Salfred * proceed ! 1893184610Salfred */ 1894187174Sthompsa if (usb2_proc_msignal(info->done_p, 1895184610Salfred &info->done_m[0], &info->done_m[1])) { 1896184610Salfred /* ignore */ 1897184610Salfred } 1898184610Salfred return; 1899184610Salfred } 1900184610Salfred /* 1901184610Salfred * Cases that end up here: 1902184610Salfred * 1903184610Salfred * 1) We are starting a transfer 1904184610Salfred * 2) We are prematurely calling back a transfer 1905184610Salfred * 3) We are stopping a transfer 1906184610Salfred * 4) We are doing an ordinary callback 1907184610Salfred */ 1908184610Salfred DPRINTFN(3, "case 1-4\n"); 1909184610Salfred /* get next USB transfer in the queue */ 1910184610Salfred info->done_q.curr = NULL; 1911184610Salfred 1912187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1913187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_NOTOWNED); 1914184610Salfred 1915184610Salfred /* set correct USB state for callback */ 1916184610Salfred if (!xfer->flags_int.transferring) { 1917184610Salfred xfer->usb2_state = USB_ST_SETUP; 1918184610Salfred if (!xfer->flags_int.started) { 1919184610Salfred /* we got stopped before we even got started */ 1920187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1921184610Salfred goto done; 1922184610Salfred } 1923184610Salfred } else { 1924184610Salfred 1925184610Salfred if (usb2_callback_wrapper_sub(xfer)) { 1926184610Salfred /* the callback has been deferred */ 1927187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1928184610Salfred goto done; 1929184610Salfred } 1930186730Salfred /* decrement power reference */ 1931186730Salfred usb2_transfer_power_ref(xfer, -1); 1932186730Salfred 1933184610Salfred xfer->flags_int.transferring = 0; 1934184610Salfred 1935184610Salfred if (xfer->error) { 1936184610Salfred xfer->usb2_state = USB_ST_ERROR; 1937184610Salfred } else { 1938184610Salfred /* set transferred state */ 1939184610Salfred xfer->usb2_state = USB_ST_TRANSFERRED; 1940190180Sthompsa#if USB_HAVE_BUSDMA 1941184610Salfred /* sync DMA memory, if any */ 1942184610Salfred if (xfer->flags_int.bdma_enable && 1943184610Salfred (!xfer->flags_int.bdma_no_post_sync)) { 1944184610Salfred usb2_bdma_post_sync(xfer); 1945184610Salfred } 1946190180Sthompsa#endif 1947184610Salfred } 1948184610Salfred } 1949184610Salfred 1950184610Salfred /* call processing routine */ 1951184610Salfred (xfer->callback) (xfer); 1952184610Salfred 1953184610Salfred /* pickup the USB mutex again */ 1954187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1955184610Salfred 1956184610Salfred /* 1957184610Salfred * Check if we got started after that we got cancelled, but 1958187166Sthompsa * before we managed to do the callback. 1959184610Salfred */ 1960184610Salfred if ((!xfer->flags_int.open) && 1961184610Salfred (xfer->flags_int.started) && 1962184610Salfred (xfer->usb2_state == USB_ST_ERROR)) { 1963184610Salfred /* try to loop, but not recursivly */ 1964184610Salfred usb2_command_wrapper(&info->done_q, xfer); 1965184610Salfred return; 1966187166Sthompsa } 1967187166Sthompsa 1968187166Sthompsadone: 1969187166Sthompsa /* 1970187166Sthompsa * Check if we are draining. 1971187166Sthompsa */ 1972187166Sthompsa if (xfer->flags_int.draining && 1973184610Salfred (!xfer->flags_int.transferring)) { 1974184610Salfred /* "usb2_transfer_drain()" is waiting for end of transfer */ 1975184610Salfred xfer->flags_int.draining = 0; 1976187173Sthompsa usb2_cv_broadcast(&xfer->xroot->cv_drain); 1977184610Salfred } 1978187166Sthompsa 1979184610Salfred /* do the next callback, if any */ 1980184610Salfred usb2_command_wrapper(&info->done_q, 1981184610Salfred info->done_q.curr); 1982184610Salfred} 1983184610Salfred 1984184610Salfred/*------------------------------------------------------------------------* 1985184610Salfred * usb2_dma_delay_done_cb 1986184610Salfred * 1987184610Salfred * This function is called when the DMA delay has been exectuded, and 1988184610Salfred * will make sure that the callback is called to complete the USB 1989184610Salfred * transfer. This code path is ususally only used when there is an USB 1990184610Salfred * error like USB_ERR_CANCELLED. 1991184610Salfred *------------------------------------------------------------------------*/ 1992184610Salfredstatic void 1993184610Salfredusb2_dma_delay_done_cb(void *arg) 1994184610Salfred{ 1995184610Salfred struct usb2_xfer *xfer = arg; 1996184610Salfred 1997187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1998184610Salfred 1999184610Salfred DPRINTFN(3, "Completed %p\n", xfer); 2000184610Salfred 2001184610Salfred /* queue callback for execution, again */ 2002184610Salfred usb2_transfer_done(xfer, 0); 2003184610Salfred} 2004184610Salfred 2005184610Salfred/*------------------------------------------------------------------------* 2006184610Salfred * usb2_transfer_dequeue 2007184610Salfred * 2008184610Salfred * - This function is used to remove an USB transfer from a USB 2009184610Salfred * transfer queue. 2010184610Salfred * 2011184610Salfred * - This function can be called multiple times in a row. 2012184610Salfred *------------------------------------------------------------------------*/ 2013184610Salfredvoid 2014184610Salfredusb2_transfer_dequeue(struct usb2_xfer *xfer) 2015184610Salfred{ 2016184610Salfred struct usb2_xfer_queue *pq; 2017184610Salfred 2018184610Salfred pq = xfer->wait_queue; 2019184610Salfred if (pq) { 2020184610Salfred TAILQ_REMOVE(&pq->head, xfer, wait_entry); 2021184610Salfred xfer->wait_queue = NULL; 2022184610Salfred } 2023184610Salfred} 2024184610Salfred 2025184610Salfred/*------------------------------------------------------------------------* 2026184610Salfred * usb2_transfer_enqueue 2027184610Salfred * 2028184610Salfred * - This function is used to insert an USB transfer into a USB * 2029184610Salfred * transfer queue. 2030184610Salfred * 2031184610Salfred * - This function can be called multiple times in a row. 2032184610Salfred *------------------------------------------------------------------------*/ 2033184610Salfredvoid 2034184610Salfredusb2_transfer_enqueue(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer) 2035184610Salfred{ 2036184610Salfred /* 2037184610Salfred * Insert the USB transfer into the queue, if it is not 2038184610Salfred * already on a USB transfer queue: 2039184610Salfred */ 2040184610Salfred if (xfer->wait_queue == NULL) { 2041184610Salfred xfer->wait_queue = pq; 2042184610Salfred TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry); 2043184610Salfred } 2044184610Salfred} 2045184610Salfred 2046184610Salfred/*------------------------------------------------------------------------* 2047184610Salfred * usb2_transfer_done 2048184610Salfred * 2049184610Salfred * - This function is used to remove an USB transfer from the busdma, 2050184610Salfred * pipe or interrupt queue. 2051184610Salfred * 2052184610Salfred * - This function is used to queue the USB transfer on the done 2053184610Salfred * queue. 2054184610Salfred * 2055184610Salfred * - This function is used to stop any USB transfer timeouts. 2056184610Salfred *------------------------------------------------------------------------*/ 2057184610Salfredvoid 2058184610Salfredusb2_transfer_done(struct usb2_xfer *xfer, usb2_error_t error) 2059184610Salfred{ 2060187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2061184610Salfred 2062184610Salfred DPRINTF("err=%s\n", usb2_errstr(error)); 2063184610Salfred 2064184610Salfred /* 2065184610Salfred * If we are not transferring then just return. 2066184610Salfred * This can happen during transfer cancel. 2067184610Salfred */ 2068184610Salfred if (!xfer->flags_int.transferring) { 2069184610Salfred DPRINTF("not transferring\n"); 2070184610Salfred return; 2071184610Salfred } 2072184610Salfred /* only set transfer error if not already set */ 2073184610Salfred if (!xfer->error) { 2074184610Salfred xfer->error = error; 2075184610Salfred } 2076184610Salfred /* stop any callouts */ 2077184610Salfred usb2_callout_stop(&xfer->timeout_handle); 2078184610Salfred 2079184610Salfred /* 2080184610Salfred * If we are waiting on a queue, just remove the USB transfer 2081184610Salfred * from the queue, if any. We should have the required locks 2082184610Salfred * locked to do the remove when this function is called. 2083184610Salfred */ 2084184610Salfred usb2_transfer_dequeue(xfer); 2085184610Salfred 2086190180Sthompsa#if USB_HAVE_BUSDMA 2087187173Sthompsa if (mtx_owned(xfer->xroot->xfer_mtx)) { 2088190180Sthompsa struct usb2_xfer_queue *pq; 2089190180Sthompsa 2090184610Salfred /* 2091184610Salfred * If the private USB lock is not locked, then we assume 2092184610Salfred * that the BUS-DMA load stage has been passed: 2093184610Salfred */ 2094187173Sthompsa pq = &xfer->xroot->dma_q; 2095184610Salfred 2096184610Salfred if (pq->curr == xfer) { 2097184610Salfred /* start the next BUS-DMA load, if any */ 2098184610Salfred usb2_command_wrapper(pq, NULL); 2099184610Salfred } 2100184610Salfred } 2101190180Sthompsa#endif 2102184610Salfred /* keep some statistics */ 2103184610Salfred if (xfer->error) { 2104187173Sthompsa xfer->xroot->bus->stats_err.uds_requests 2105184610Salfred [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++; 2106184610Salfred } else { 2107187173Sthompsa xfer->xroot->bus->stats_ok.uds_requests 2108184610Salfred [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++; 2109184610Salfred } 2110184610Salfred 2111184610Salfred /* call the USB transfer callback */ 2112184610Salfred usb2_callback_ss_done_defer(xfer); 2113184610Salfred} 2114184610Salfred 2115184610Salfred/*------------------------------------------------------------------------* 2116184610Salfred * usb2_transfer_start_cb 2117184610Salfred * 2118184610Salfred * This function is called to start the USB transfer when 2119184610Salfred * "xfer->interval" is greater than zero, and and the endpoint type is 2120184610Salfred * BULK or CONTROL. 2121184610Salfred *------------------------------------------------------------------------*/ 2122184610Salfredstatic void 2123184610Salfredusb2_transfer_start_cb(void *arg) 2124184610Salfred{ 2125184610Salfred struct usb2_xfer *xfer = arg; 2126184610Salfred struct usb2_pipe *pipe = xfer->pipe; 2127184610Salfred 2128187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2129184610Salfred 2130184610Salfred DPRINTF("start\n"); 2131184610Salfred 2132184610Salfred /* start the transfer */ 2133184610Salfred (pipe->methods->start) (xfer); 2134184610Salfred 2135184610Salfred /* check cancelability */ 2136184610Salfred if (pipe->methods->start_is_cancelable) { 2137184610Salfred xfer->flags_int.can_cancel_immed = 1; 2138184610Salfred if (xfer->error) { 2139184610Salfred /* some error has happened */ 2140184610Salfred usb2_transfer_done(xfer, 0); 2141184610Salfred } 2142184610Salfred } else { 2143184610Salfred xfer->flags_int.can_cancel_immed = 0; 2144184610Salfred } 2145184610Salfred} 2146184610Salfred 2147184610Salfred/*------------------------------------------------------------------------* 2148184610Salfred * usb2_transfer_set_stall 2149184610Salfred * 2150184610Salfred * This function is used to set the stall flag outside the 2151184610Salfred * callback. This function is NULL safe. 2152184610Salfred *------------------------------------------------------------------------*/ 2153184610Salfredvoid 2154184610Salfredusb2_transfer_set_stall(struct usb2_xfer *xfer) 2155184610Salfred{ 2156184610Salfred if (xfer == NULL) { 2157184610Salfred /* tearing down */ 2158184610Salfred return; 2159184610Salfred } 2160184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2161184610Salfred 2162184610Salfred /* avoid any races by locking the USB mutex */ 2163187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2164184610Salfred 2165184610Salfred xfer->flags.stall_pipe = 1; 2166184610Salfred 2167187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2168184610Salfred} 2169184610Salfred 2170184610Salfred/*------------------------------------------------------------------------* 2171184610Salfred * usb2_transfer_clear_stall 2172184610Salfred * 2173184610Salfred * This function is used to clear the stall flag outside the 2174184610Salfred * callback. This function is NULL safe. 2175184610Salfred *------------------------------------------------------------------------*/ 2176184610Salfredvoid 2177184610Salfredusb2_transfer_clear_stall(struct usb2_xfer *xfer) 2178184610Salfred{ 2179184610Salfred if (xfer == NULL) { 2180184610Salfred /* tearing down */ 2181184610Salfred return; 2182184610Salfred } 2183184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2184184610Salfred 2185184610Salfred /* avoid any races by locking the USB mutex */ 2186187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2187184610Salfred 2188184610Salfred xfer->flags.stall_pipe = 0; 2189184610Salfred 2190187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2191184610Salfred} 2192184610Salfred 2193184610Salfred/*------------------------------------------------------------------------* 2194184610Salfred * usb2_pipe_start 2195184610Salfred * 2196184610Salfred * This function is used to add an USB transfer to the pipe transfer list. 2197184610Salfred *------------------------------------------------------------------------*/ 2198184610Salfredvoid 2199184610Salfredusb2_pipe_start(struct usb2_xfer_queue *pq) 2200184610Salfred{ 2201184610Salfred struct usb2_pipe *pipe; 2202184610Salfred struct usb2_xfer *xfer; 2203184610Salfred uint8_t type; 2204184610Salfred 2205184610Salfred xfer = pq->curr; 2206184610Salfred pipe = xfer->pipe; 2207184610Salfred 2208187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2209184610Salfred 2210184610Salfred /* 2211184610Salfred * If the pipe is already stalled we do nothing ! 2212184610Salfred */ 2213184610Salfred if (pipe->is_stalled) { 2214184610Salfred return; 2215184610Salfred } 2216184610Salfred /* 2217184610Salfred * Check if we are supposed to stall the pipe: 2218184610Salfred */ 2219184610Salfred if (xfer->flags.stall_pipe) { 2220184610Salfred /* clear stall command */ 2221184610Salfred xfer->flags.stall_pipe = 0; 2222184610Salfred 2223184610Salfred /* 2224184610Salfred * Only stall BULK and INTERRUPT endpoints. 2225184610Salfred */ 2226184610Salfred type = (pipe->edesc->bmAttributes & UE_XFERTYPE); 2227184610Salfred if ((type == UE_BULK) || 2228184610Salfred (type == UE_INTERRUPT)) { 2229184610Salfred struct usb2_device *udev; 2230184610Salfred struct usb2_xfer_root *info; 2231184610Salfred 2232187173Sthompsa info = xfer->xroot; 2233187173Sthompsa udev = info->udev; 2234184610Salfred pipe->is_stalled = 1; 2235184610Salfred 2236184610Salfred if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 2237184610Salfred (udev->bus->methods->set_stall) ( 2238184610Salfred udev, NULL, pipe); 2239184610Salfred } else if (udev->default_xfer[1]) { 2240187173Sthompsa info = udev->default_xfer[1]->xroot; 2241187174Sthompsa if (usb2_proc_msignal( 2242187174Sthompsa &info->bus->non_giant_callback_proc, 2243184610Salfred &udev->cs_msg[0], &udev->cs_msg[1])) { 2244184610Salfred /* ignore */ 2245184610Salfred } 2246184610Salfred } else { 2247184610Salfred /* should not happen */ 2248184610Salfred DPRINTFN(0, "No stall handler!\n"); 2249184610Salfred } 2250184610Salfred /* 2251184610Salfred * We get started again when the stall is cleared! 2252184610Salfred */ 2253184610Salfred return; 2254184610Salfred } 2255184610Salfred } 2256184610Salfred /* Set or clear stall complete - special case */ 2257184610Salfred if (xfer->nframes == 0) { 2258184610Salfred /* we are complete */ 2259184610Salfred xfer->aframes = 0; 2260184610Salfred usb2_transfer_done(xfer, 0); 2261184610Salfred return; 2262184610Salfred } 2263184610Salfred /* 2264184610Salfred * Handled cases: 2265184610Salfred * 2266184610Salfred * 1) Start the first transfer queued. 2267184610Salfred * 2268184610Salfred * 2) Re-start the current USB transfer. 2269184610Salfred */ 2270184610Salfred /* 2271184610Salfred * Check if there should be any 2272184610Salfred * pre transfer start delay: 2273184610Salfred */ 2274184610Salfred if (xfer->interval > 0) { 2275184610Salfred type = (pipe->edesc->bmAttributes & UE_XFERTYPE); 2276184610Salfred if ((type == UE_BULK) || 2277184610Salfred (type == UE_CONTROL)) { 2278184610Salfred usb2_transfer_timeout_ms(xfer, 2279184610Salfred &usb2_transfer_start_cb, 2280184610Salfred xfer->interval); 2281184610Salfred return; 2282184610Salfred } 2283184610Salfred } 2284184610Salfred DPRINTF("start\n"); 2285184610Salfred 2286184610Salfred /* start USB transfer */ 2287184610Salfred (pipe->methods->start) (xfer); 2288184610Salfred 2289184610Salfred /* check cancelability */ 2290184610Salfred if (pipe->methods->start_is_cancelable) { 2291184610Salfred xfer->flags_int.can_cancel_immed = 1; 2292184610Salfred if (xfer->error) { 2293184610Salfred /* some error has happened */ 2294184610Salfred usb2_transfer_done(xfer, 0); 2295184610Salfred } 2296184610Salfred } else { 2297184610Salfred xfer->flags_int.can_cancel_immed = 0; 2298184610Salfred } 2299184610Salfred} 2300184610Salfred 2301184610Salfred/*------------------------------------------------------------------------* 2302184610Salfred * usb2_transfer_timeout_ms 2303184610Salfred * 2304184610Salfred * This function is used to setup a timeout on the given USB 2305184610Salfred * transfer. If the timeout has been deferred the callback given by 2306184610Salfred * "cb" will get called after "ms" milliseconds. 2307184610Salfred *------------------------------------------------------------------------*/ 2308184610Salfredvoid 2309184610Salfredusb2_transfer_timeout_ms(struct usb2_xfer *xfer, 2310190181Sthompsa void (*cb) (void *arg), usb2_timeout_t ms) 2311184610Salfred{ 2312187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2313184610Salfred 2314184610Salfred /* defer delay */ 2315184610Salfred usb2_callout_reset(&xfer->timeout_handle, 2316184610Salfred USB_MS_TO_TICKS(ms), cb, xfer); 2317184610Salfred} 2318184610Salfred 2319184610Salfred/*------------------------------------------------------------------------* 2320184610Salfred * usb2_callback_wrapper_sub 2321184610Salfred * 2322184610Salfred * - This function will update variables in an USB transfer after 2323184610Salfred * that the USB transfer is complete. 2324184610Salfred * 2325184610Salfred * - This function is used to start the next USB transfer on the 2326184610Salfred * pipe transfer queue, if any. 2327184610Salfred * 2328184610Salfred * NOTE: In some special cases the USB transfer will not be removed from 2329184610Salfred * the pipe queue, but remain first. To enforce USB transfer removal call 2330184610Salfred * this function passing the error code "USB_ERR_CANCELLED". 2331184610Salfred * 2332184610Salfred * Return values: 2333184610Salfred * 0: Success. 2334184610Salfred * Else: The callback has been deferred. 2335184610Salfred *------------------------------------------------------------------------*/ 2336184610Salfredstatic uint8_t 2337184610Salfredusb2_callback_wrapper_sub(struct usb2_xfer *xfer) 2338184610Salfred{ 2339184610Salfred struct usb2_pipe *pipe; 2340190181Sthompsa usb2_frcount_t x; 2341184610Salfred 2342184610Salfred if ((!xfer->flags_int.open) && 2343184610Salfred (!xfer->flags_int.did_close)) { 2344184610Salfred DPRINTF("close\n"); 2345187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2346184610Salfred (xfer->pipe->methods->close) (xfer); 2347187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2348184610Salfred /* only close once */ 2349184610Salfred xfer->flags_int.did_close = 1; 2350184610Salfred return (1); /* wait for new callback */ 2351184610Salfred } 2352184610Salfred /* 2353184610Salfred * If we have a non-hardware induced error we 2354184610Salfred * need to do the DMA delay! 2355184610Salfred */ 2356184610Salfred if (((xfer->error == USB_ERR_CANCELLED) || 2357184610Salfred (xfer->error == USB_ERR_TIMEOUT)) && 2358184610Salfred (!xfer->flags_int.did_dma_delay)) { 2359184610Salfred 2360190181Sthompsa usb2_timeout_t temp; 2361184610Salfred 2362184610Salfred /* only delay once */ 2363184610Salfred xfer->flags_int.did_dma_delay = 1; 2364184610Salfred 2365184610Salfred /* we can not cancel this delay */ 2366184610Salfred xfer->flags_int.can_cancel_immed = 0; 2367184610Salfred 2368187173Sthompsa temp = usb2_get_dma_delay(xfer->xroot->bus); 2369184610Salfred 2370184610Salfred DPRINTFN(3, "DMA delay, %u ms, " 2371184610Salfred "on %p\n", temp, xfer); 2372184610Salfred 2373184610Salfred if (temp != 0) { 2374187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2375184610Salfred usb2_transfer_timeout_ms(xfer, 2376184610Salfred &usb2_dma_delay_done_cb, temp); 2377187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2378184610Salfred return (1); /* wait for new callback */ 2379184610Salfred } 2380184610Salfred } 2381184610Salfred /* check actual number of frames */ 2382184610Salfred if (xfer->aframes > xfer->nframes) { 2383184610Salfred if (xfer->error == 0) { 2384184610Salfred panic("%s: actual number of frames, %d, is " 2385184610Salfred "greater than initial number of frames, %d!\n", 2386184610Salfred __FUNCTION__, xfer->aframes, xfer->nframes); 2387184610Salfred } else { 2388184610Salfred /* just set some valid value */ 2389184610Salfred xfer->aframes = xfer->nframes; 2390184610Salfred } 2391184610Salfred } 2392184610Salfred /* compute actual length */ 2393184610Salfred xfer->actlen = 0; 2394184610Salfred 2395184610Salfred for (x = 0; x != xfer->aframes; x++) { 2396184610Salfred xfer->actlen += xfer->frlengths[x]; 2397184610Salfred } 2398184610Salfred 2399184610Salfred /* 2400184610Salfred * Frames that were not transferred get zero actual length in 2401184610Salfred * case the USB device driver does not check the actual number 2402184610Salfred * of frames transferred, "xfer->aframes": 2403184610Salfred */ 2404184610Salfred for (; x < xfer->nframes; x++) { 2405184610Salfred xfer->frlengths[x] = 0; 2406184610Salfred } 2407184610Salfred 2408184610Salfred /* check actual length */ 2409184610Salfred if (xfer->actlen > xfer->sumlen) { 2410184610Salfred if (xfer->error == 0) { 2411184610Salfred panic("%s: actual length, %d, is greater than " 2412184610Salfred "initial length, %d!\n", 2413184610Salfred __FUNCTION__, xfer->actlen, xfer->sumlen); 2414184610Salfred } else { 2415184610Salfred /* just set some valid value */ 2416184610Salfred xfer->actlen = xfer->sumlen; 2417184610Salfred } 2418184610Salfred } 2419184610Salfred DPRINTFN(6, "xfer=%p pipe=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n", 2420184610Salfred xfer, xfer->pipe, xfer->error, xfer->actlen, xfer->sumlen, 2421184610Salfred xfer->aframes, xfer->nframes); 2422184610Salfred 2423184610Salfred if (xfer->error) { 2424184610Salfred /* end of control transfer, if any */ 2425184610Salfred xfer->flags_int.control_act = 0; 2426184610Salfred 2427184610Salfred /* check if we should block the execution queue */ 2428184610Salfred if ((xfer->error != USB_ERR_CANCELLED) && 2429184610Salfred (xfer->flags.pipe_bof)) { 2430184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure " 2431184610Salfred "on pipe=%p\n", xfer, xfer->pipe); 2432184610Salfred goto done; 2433184610Salfred } 2434184610Salfred } else { 2435184610Salfred /* check for short transfers */ 2436184610Salfred if (xfer->actlen < xfer->sumlen) { 2437184610Salfred 2438184610Salfred /* end of control transfer, if any */ 2439184610Salfred xfer->flags_int.control_act = 0; 2440184610Salfred 2441184610Salfred if (!xfer->flags_int.short_xfer_ok) { 2442184610Salfred xfer->error = USB_ERR_SHORT_XFER; 2443184610Salfred if (xfer->flags.pipe_bof) { 2444184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure on " 2445184610Salfred "Short Transfer on pipe %p.\n", 2446184610Salfred xfer, xfer->pipe); 2447184610Salfred goto done; 2448184610Salfred } 2449184610Salfred } 2450184610Salfred } else { 2451184610Salfred /* 2452184610Salfred * Check if we are in the middle of a 2453184610Salfred * control transfer: 2454184610Salfred */ 2455184610Salfred if (xfer->flags_int.control_act) { 2456184610Salfred DPRINTFN(5, "xfer=%p: Control transfer " 2457184610Salfred "active on pipe=%p\n", xfer, xfer->pipe); 2458184610Salfred goto done; 2459184610Salfred } 2460184610Salfred } 2461184610Salfred } 2462184610Salfred 2463184610Salfred pipe = xfer->pipe; 2464184610Salfred 2465184610Salfred /* 2466184610Salfred * If the current USB transfer is completing we need to start the 2467184610Salfred * next one: 2468184610Salfred */ 2469187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2470184610Salfred if (pipe->pipe_q.curr == xfer) { 2471184610Salfred usb2_command_wrapper(&pipe->pipe_q, NULL); 2472184610Salfred 2473184610Salfred if (pipe->pipe_q.curr || TAILQ_FIRST(&pipe->pipe_q.head)) { 2474184610Salfred /* there is another USB transfer waiting */ 2475184610Salfred } else { 2476184610Salfred /* this is the last USB transfer */ 2477184610Salfred /* clear isochronous sync flag */ 2478184610Salfred xfer->pipe->is_synced = 0; 2479184610Salfred } 2480184610Salfred } 2481187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2482184610Salfreddone: 2483184610Salfred return (0); 2484184610Salfred} 2485184610Salfred 2486184610Salfred/*------------------------------------------------------------------------* 2487184610Salfred * usb2_command_wrapper 2488184610Salfred * 2489184610Salfred * This function is used to execute commands non-recursivly on an USB 2490184610Salfred * transfer. 2491184610Salfred *------------------------------------------------------------------------*/ 2492184610Salfredvoid 2493184610Salfredusb2_command_wrapper(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer) 2494184610Salfred{ 2495184610Salfred if (xfer) { 2496184610Salfred /* 2497184610Salfred * If the transfer is not already processing, 2498184610Salfred * queue it! 2499184610Salfred */ 2500184610Salfred if (pq->curr != xfer) { 2501184610Salfred usb2_transfer_enqueue(pq, xfer); 2502184610Salfred if (pq->curr != NULL) { 2503184610Salfred /* something is already processing */ 2504184610Salfred DPRINTFN(6, "busy %p\n", pq->curr); 2505184610Salfred return; 2506184610Salfred } 2507184610Salfred } 2508184610Salfred } else { 2509184610Salfred /* Get next element in queue */ 2510184610Salfred pq->curr = NULL; 2511184610Salfred } 2512184610Salfred 2513184610Salfred if (!pq->recurse_1) { 2514184610Salfred 2515184610Salfred do { 2516184610Salfred 2517184610Salfred /* set both recurse flags */ 2518184610Salfred pq->recurse_1 = 1; 2519184610Salfred pq->recurse_2 = 1; 2520184610Salfred 2521184610Salfred if (pq->curr == NULL) { 2522184610Salfred xfer = TAILQ_FIRST(&pq->head); 2523184610Salfred if (xfer) { 2524184610Salfred TAILQ_REMOVE(&pq->head, xfer, 2525184610Salfred wait_entry); 2526184610Salfred xfer->wait_queue = NULL; 2527184610Salfred pq->curr = xfer; 2528184610Salfred } else { 2529184610Salfred break; 2530184610Salfred } 2531184610Salfred } 2532184610Salfred DPRINTFN(6, "cb %p (enter)\n", pq->curr); 2533184610Salfred (pq->command) (pq); 2534184610Salfred DPRINTFN(6, "cb %p (leave)\n", pq->curr); 2535184610Salfred 2536184610Salfred } while (!pq->recurse_2); 2537184610Salfred 2538184610Salfred /* clear first recurse flag */ 2539184610Salfred pq->recurse_1 = 0; 2540184610Salfred 2541184610Salfred } else { 2542184610Salfred /* clear second recurse flag */ 2543184610Salfred pq->recurse_2 = 0; 2544184610Salfred } 2545184610Salfred} 2546184610Salfred 2547184610Salfred/*------------------------------------------------------------------------* 2548184610Salfred * usb2_default_transfer_setup 2549184610Salfred * 2550184610Salfred * This function is used to setup the default USB control endpoint 2551184610Salfred * transfer. 2552184610Salfred *------------------------------------------------------------------------*/ 2553184610Salfredvoid 2554184610Salfredusb2_default_transfer_setup(struct usb2_device *udev) 2555184610Salfred{ 2556184610Salfred struct usb2_xfer *xfer; 2557184610Salfred uint8_t no_resetup; 2558184610Salfred uint8_t iface_index; 2559184610Salfred 2560184610Salfredrepeat: 2561184610Salfred 2562184610Salfred xfer = udev->default_xfer[0]; 2563184610Salfred if (xfer) { 2564184824Sthompsa USB_XFER_LOCK(xfer); 2565184610Salfred no_resetup = 2566184610Salfred ((xfer->address == udev->address) && 2567184610Salfred (udev->default_ep_desc.wMaxPacketSize[0] == 2568184610Salfred udev->ddesc.bMaxPacketSize)); 2569184610Salfred if (udev->flags.usb2_mode == USB_MODE_DEVICE) { 2570184610Salfred if (no_resetup) { 2571184610Salfred /* 2572184610Salfred * NOTE: checking "xfer->address" and 2573184610Salfred * starting the USB transfer must be 2574184610Salfred * atomic! 2575184610Salfred */ 2576184610Salfred usb2_transfer_start(xfer); 2577184610Salfred } 2578184610Salfred } 2579184824Sthompsa USB_XFER_UNLOCK(xfer); 2580184610Salfred } else { 2581184610Salfred no_resetup = 0; 2582184610Salfred } 2583184610Salfred 2584184610Salfred if (no_resetup) { 2585184610Salfred /* 2586184610Salfred * All parameters are exactly the same like before. 2587184610Salfred * Just return. 2588184610Salfred */ 2589184610Salfred return; 2590184610Salfred } 2591184610Salfred /* 2592184610Salfred * Update wMaxPacketSize for the default control endpoint: 2593184610Salfred */ 2594184610Salfred udev->default_ep_desc.wMaxPacketSize[0] = 2595184610Salfred udev->ddesc.bMaxPacketSize; 2596184610Salfred 2597184610Salfred /* 2598184610Salfred * Unsetup any existing USB transfer: 2599184610Salfred */ 2600184610Salfred usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 2601184610Salfred 2602184610Salfred /* 2603184610Salfred * Try to setup a new USB transfer for the 2604184610Salfred * default control endpoint: 2605184610Salfred */ 2606184610Salfred iface_index = 0; 2607184610Salfred if (usb2_transfer_setup(udev, &iface_index, 2608184610Salfred udev->default_xfer, usb2_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL, 2609184610Salfred udev->default_mtx)) { 2610184610Salfred DPRINTFN(0, "could not setup default " 2611184610Salfred "USB transfer!\n"); 2612184610Salfred } else { 2613184610Salfred goto repeat; 2614184610Salfred } 2615184610Salfred} 2616184610Salfred 2617184610Salfred/*------------------------------------------------------------------------* 2618184610Salfred * usb2_clear_data_toggle - factored out code 2619184610Salfred * 2620184610Salfred * NOTE: the intention of this function is not to reset the hardware 2621184610Salfred * data toggle. 2622184610Salfred *------------------------------------------------------------------------*/ 2623184610Salfredvoid 2624184610Salfredusb2_clear_data_toggle(struct usb2_device *udev, struct usb2_pipe *pipe) 2625184610Salfred{ 2626184610Salfred DPRINTFN(5, "udev=%p pipe=%p\n", udev, pipe); 2627184610Salfred 2628184824Sthompsa USB_BUS_LOCK(udev->bus); 2629184610Salfred pipe->toggle_next = 0; 2630184824Sthompsa USB_BUS_UNLOCK(udev->bus); 2631184610Salfred} 2632184610Salfred 2633184610Salfred/*------------------------------------------------------------------------* 2634184610Salfred * usb2_clear_stall_callback - factored out clear stall callback 2635184610Salfred * 2636184610Salfred * Input parameters: 2637184610Salfred * xfer1: Clear Stall Control Transfer 2638184610Salfred * xfer2: Stalled USB Transfer 2639184610Salfred * 2640184610Salfred * This function is NULL safe. 2641184610Salfred * 2642184610Salfred * Return values: 2643184610Salfred * 0: In progress 2644184610Salfred * Else: Finished 2645184610Salfred * 2646184610Salfred * Clear stall config example: 2647184610Salfred * 2648184610Salfred * static const struct usb2_config my_clearstall = { 2649184610Salfred * .type = UE_CONTROL, 2650184610Salfred * .endpoint = 0, 2651184610Salfred * .direction = UE_DIR_ANY, 2652184610Salfred * .interval = 50, //50 milliseconds 2653184610Salfred * .bufsize = sizeof(struct usb2_device_request), 2654184610Salfred * .mh.timeout = 1000, //1.000 seconds 2655184610Salfred * .mh.flags = { }, 2656184610Salfred * .mh.callback = &my_clear_stall_callback, // ** 2657184610Salfred * }; 2658184610Salfred * 2659184610Salfred * ** "my_clear_stall_callback" calls "usb2_clear_stall_callback" 2660184610Salfred * passing the correct parameters. 2661184610Salfred *------------------------------------------------------------------------*/ 2662184610Salfreduint8_t 2663184610Salfredusb2_clear_stall_callback(struct usb2_xfer *xfer1, 2664184610Salfred struct usb2_xfer *xfer2) 2665184610Salfred{ 2666184610Salfred struct usb2_device_request req; 2667184610Salfred 2668184610Salfred if (xfer2 == NULL) { 2669184610Salfred /* looks like we are tearing down */ 2670184610Salfred DPRINTF("NULL input parameter\n"); 2671184610Salfred return (0); 2672184610Salfred } 2673184824Sthompsa USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED); 2674184824Sthompsa USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED); 2675184610Salfred 2676184610Salfred switch (USB_GET_STATE(xfer1)) { 2677184610Salfred case USB_ST_SETUP: 2678184610Salfred 2679184610Salfred /* 2680184610Salfred * pre-clear the data toggle to DATA0 ("umass.c" and 2681184610Salfred * "ata-usb.c" depends on this) 2682184610Salfred */ 2683184610Salfred 2684187173Sthompsa usb2_clear_data_toggle(xfer2->xroot->udev, xfer2->pipe); 2685184610Salfred 2686184610Salfred /* setup a clear-stall packet */ 2687184610Salfred 2688184610Salfred req.bmRequestType = UT_WRITE_ENDPOINT; 2689184610Salfred req.bRequest = UR_CLEAR_FEATURE; 2690184610Salfred USETW(req.wValue, UF_ENDPOINT_HALT); 2691184610Salfred req.wIndex[0] = xfer2->pipe->edesc->bEndpointAddress; 2692184610Salfred req.wIndex[1] = 0; 2693184610Salfred USETW(req.wLength, 0); 2694184610Salfred 2695184610Salfred /* 2696184610Salfred * "usb2_transfer_setup_sub()" will ensure that 2697184610Salfred * we have sufficient room in the buffer for 2698184610Salfred * the request structure! 2699184610Salfred */ 2700184610Salfred 2701184610Salfred /* copy in the transfer */ 2702184610Salfred 2703184610Salfred usb2_copy_in(xfer1->frbuffers, 0, &req, sizeof(req)); 2704184610Salfred 2705184610Salfred /* set length */ 2706184610Salfred xfer1->frlengths[0] = sizeof(req); 2707184610Salfred xfer1->nframes = 1; 2708184610Salfred 2709184610Salfred usb2_start_hardware(xfer1); 2710184610Salfred return (0); 2711184610Salfred 2712184610Salfred case USB_ST_TRANSFERRED: 2713184610Salfred break; 2714184610Salfred 2715184610Salfred default: /* Error */ 2716184610Salfred if (xfer1->error == USB_ERR_CANCELLED) { 2717184610Salfred return (0); 2718184610Salfred } 2719184610Salfred break; 2720184610Salfred } 2721184610Salfred return (1); /* Clear Stall Finished */ 2722184610Salfred} 2723184610Salfred 2724184610Salfredvoid 2725184610Salfredusb2_do_poll(struct usb2_xfer **ppxfer, uint16_t max) 2726184610Salfred{ 2727188983Sthompsa static uint8_t once = 0; 2728188983Sthompsa /* polling is currently not supported */ 2729188983Sthompsa if (!once) { 2730188983Sthompsa once = 1; 2731188983Sthompsa printf("usb2_do_poll: USB polling is " 2732188983Sthompsa "not supported!\n"); 2733184610Salfred } 2734184610Salfred} 2735