usb_transfer.c revision 209443
1184610Salfred/* $FreeBSD: head/sys/dev/usb/usb_transfer.c 209443 2010-06-22 20:57:48Z 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. 25190754Sthompsa */ 26184610Salfred 27194677Sthompsa#include <sys/stdint.h> 28194677Sthompsa#include <sys/stddef.h> 29194677Sthompsa#include <sys/param.h> 30194677Sthompsa#include <sys/queue.h> 31194677Sthompsa#include <sys/types.h> 32194677Sthompsa#include <sys/systm.h> 33194677Sthompsa#include <sys/kernel.h> 34194677Sthompsa#include <sys/bus.h> 35194677Sthompsa#include <sys/linker_set.h> 36194677Sthompsa#include <sys/module.h> 37194677Sthompsa#include <sys/lock.h> 38194677Sthompsa#include <sys/mutex.h> 39194677Sthompsa#include <sys/condvar.h> 40194677Sthompsa#include <sys/sysctl.h> 41194677Sthompsa#include <sys/sx.h> 42194677Sthompsa#include <sys/unistd.h> 43194677Sthompsa#include <sys/callout.h> 44194677Sthompsa#include <sys/malloc.h> 45194677Sthompsa#include <sys/priv.h> 46194677Sthompsa 47188942Sthompsa#include <dev/usb/usb.h> 48194677Sthompsa#include <dev/usb/usbdi.h> 49194677Sthompsa#include <dev/usb/usbdi_util.h> 50184610Salfred 51194228Sthompsa#define USB_DEBUG_VAR usb_debug 52184610Salfred 53188942Sthompsa#include <dev/usb/usb_core.h> 54188942Sthompsa#include <dev/usb/usb_busdma.h> 55188942Sthompsa#include <dev/usb/usb_process.h> 56188942Sthompsa#include <dev/usb/usb_transfer.h> 57188942Sthompsa#include <dev/usb/usb_device.h> 58188942Sthompsa#include <dev/usb/usb_debug.h> 59188942Sthompsa#include <dev/usb/usb_util.h> 60184610Salfred 61188942Sthompsa#include <dev/usb/usb_controller.h> 62188942Sthompsa#include <dev/usb/usb_bus.h> 63184610Salfred 64194228Sthompsastruct usb_std_packet_size { 65184610Salfred struct { 66184610Salfred uint16_t min; /* inclusive */ 67184610Salfred uint16_t max; /* inclusive */ 68184610Salfred } range; 69184610Salfred 70184610Salfred uint16_t fixed[4]; 71184610Salfred}; 72184610Salfred 73194228Sthompsastatic usb_callback_t usb_request_callback; 74184610Salfred 75207080Sthompsastatic const struct usb_config usb_control_ep_cfg[USB_CTRL_XFER_MAX] = { 76184610Salfred 77184610Salfred /* This transfer is used for generic control endpoint transfers */ 78184610Salfred 79184610Salfred [0] = { 80184610Salfred .type = UE_CONTROL, 81184610Salfred .endpoint = 0x00, /* Control endpoint */ 82184610Salfred .direction = UE_DIR_ANY, 83190734Sthompsa .bufsize = USB_EP0_BUFSIZE, /* bytes */ 84190734Sthompsa .flags = {.proxy_buffer = 1,}, 85194228Sthompsa .callback = &usb_request_callback, 86192499Sthompsa .usb_mode = USB_MODE_DUAL, /* both modes */ 87184610Salfred }, 88184610Salfred 89184610Salfred /* This transfer is used for generic clear stall only */ 90184610Salfred 91184610Salfred [1] = { 92184610Salfred .type = UE_CONTROL, 93184610Salfred .endpoint = 0x00, /* Control pipe */ 94184610Salfred .direction = UE_DIR_ANY, 95192984Sthompsa .bufsize = sizeof(struct usb_device_request), 96194228Sthompsa .callback = &usb_do_clear_stall_callback, 97190734Sthompsa .timeout = 1000, /* 1 second */ 98190734Sthompsa .interval = 50, /* 50ms */ 99190734Sthompsa .usb_mode = USB_MODE_HOST, 100184610Salfred }, 101184610Salfred}; 102184610Salfred 103184610Salfred/* function prototypes */ 104184610Salfred 105194228Sthompsastatic void usbd_update_max_frame_size(struct usb_xfer *); 106194228Sthompsastatic void usbd_transfer_unsetup_sub(struct usb_xfer_root *, uint8_t); 107194228Sthompsastatic void usbd_control_transfer_init(struct usb_xfer *); 108194677Sthompsastatic int usbd_setup_ctrl_transfer(struct usb_xfer *); 109194228Sthompsastatic void usb_callback_proc(struct usb_proc_msg *); 110194228Sthompsastatic void usbd_callback_ss_done_defer(struct usb_xfer *); 111194228Sthompsastatic void usbd_callback_wrapper(struct usb_xfer_queue *); 112194228Sthompsastatic void usb_dma_delay_done_cb(void *); 113194228Sthompsastatic void usbd_transfer_start_cb(void *); 114194228Sthompsastatic uint8_t usbd_callback_wrapper_sub(struct usb_xfer *); 115194228Sthompsastatic void usbd_get_std_packet_size(struct usb_std_packet_size *ptr, 116192500Sthompsa uint8_t type, enum usb_dev_speed speed); 117184610Salfred 118184610Salfred/*------------------------------------------------------------------------* 119194228Sthompsa * usb_request_callback 120190734Sthompsa *------------------------------------------------------------------------*/ 121190734Sthompsastatic void 122194677Sthompsausb_request_callback(struct usb_xfer *xfer, usb_error_t error) 123190734Sthompsa{ 124192499Sthompsa if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) 125194677Sthompsa usb_handle_request_callback(xfer, error); 126190734Sthompsa else 127194677Sthompsa usbd_do_request_callback(xfer, error); 128190734Sthompsa} 129190734Sthompsa 130190734Sthompsa/*------------------------------------------------------------------------* 131194228Sthompsa * usbd_update_max_frame_size 132184610Salfred * 133184610Salfred * This function updates the maximum frame size, hence high speed USB 134184610Salfred * can transfer multiple consecutive packets. 135184610Salfred *------------------------------------------------------------------------*/ 136184610Salfredstatic void 137194228Sthompsausbd_update_max_frame_size(struct usb_xfer *xfer) 138184610Salfred{ 139184610Salfred /* compute maximum frame size */ 140184610Salfred 141184610Salfred if (xfer->max_packet_count == 2) { 142184610Salfred xfer->max_frame_size = 2 * xfer->max_packet_size; 143184610Salfred } else if (xfer->max_packet_count == 3) { 144184610Salfred xfer->max_frame_size = 3 * xfer->max_packet_size; 145184610Salfred } else { 146184610Salfred xfer->max_frame_size = xfer->max_packet_size; 147184610Salfred } 148184610Salfred} 149184610Salfred 150184610Salfred/*------------------------------------------------------------------------* 151194228Sthompsa * usbd_get_dma_delay 152184610Salfred * 153184610Salfred * The following function is called when we need to 154184610Salfred * synchronize with DMA hardware. 155184610Salfred * 156184610Salfred * Returns: 157184610Salfred * 0: no DMA delay required 158184610Salfred * Else: milliseconds of DMA delay 159184610Salfred *------------------------------------------------------------------------*/ 160193045Sthompsausb_timeout_t 161194228Sthompsausbd_get_dma_delay(struct usb_bus *bus) 162184610Salfred{ 163184610Salfred uint32_t temp = 0; 164184610Salfred 165184610Salfred if (bus->methods->get_dma_delay) { 166184610Salfred (bus->methods->get_dma_delay) (bus, &temp); 167184610Salfred /* 168184610Salfred * Round up and convert to milliseconds. Note that we use 169184610Salfred * 1024 milliseconds per second. to save a division. 170184610Salfred */ 171184610Salfred temp += 0x3FF; 172184610Salfred temp /= 0x400; 173184610Salfred } 174184610Salfred return (temp); 175184610Salfred} 176184610Salfred 177184610Salfred/*------------------------------------------------------------------------* 178194228Sthompsa * usbd_transfer_setup_sub_malloc 179184610Salfred * 180184610Salfred * This function will allocate one or more DMA'able memory chunks 181184610Salfred * according to "size", "align" and "count" arguments. "ppc" is 182184610Salfred * pointed to a linear array of USB page caches afterwards. 183184610Salfred * 184184610Salfred * Returns: 185184610Salfred * 0: Success 186184610Salfred * Else: Failure 187184610Salfred *------------------------------------------------------------------------*/ 188190180Sthompsa#if USB_HAVE_BUSDMA 189184610Salfreduint8_t 190194228Sthompsausbd_transfer_setup_sub_malloc(struct usb_setup_params *parm, 191193074Sthompsa struct usb_page_cache **ppc, usb_size_t size, usb_size_t align, 192193074Sthompsa usb_size_t count) 193184610Salfred{ 194192984Sthompsa struct usb_page_cache *pc; 195192984Sthompsa struct usb_page *pg; 196184610Salfred void *buf; 197193074Sthompsa usb_size_t n_dma_pc; 198193074Sthompsa usb_size_t n_obj; 199193074Sthompsa usb_size_t x; 200193074Sthompsa usb_size_t y; 201193074Sthompsa usb_size_t r; 202193074Sthompsa usb_size_t z; 203184610Salfred 204199816Sthompsa USB_ASSERT(align > 1, ("Invalid alignment, 0x%08x\n", 205184610Salfred align)); 206199816Sthompsa USB_ASSERT(size > 0, ("Invalid size = 0\n")); 207184610Salfred 208184610Salfred if (count == 0) { 209184610Salfred return (0); /* nothing to allocate */ 210184610Salfred } 211184610Salfred /* 212184610Salfred * Make sure that the size is aligned properly. 213184610Salfred */ 214184610Salfred size = -((-size) & (-align)); 215184610Salfred 216184610Salfred /* 217184610Salfred * Try multi-allocation chunks to reduce the number of DMA 218184610Salfred * allocations, hence DMA allocations are slow. 219184610Salfred */ 220184610Salfred if (size >= PAGE_SIZE) { 221184610Salfred n_dma_pc = count; 222184610Salfred n_obj = 1; 223184610Salfred } else { 224184610Salfred /* compute number of objects per page */ 225184610Salfred n_obj = (PAGE_SIZE / size); 226184610Salfred /* 227184610Salfred * Compute number of DMA chunks, rounded up 228184610Salfred * to nearest one: 229184610Salfred */ 230184610Salfred n_dma_pc = ((count + n_obj - 1) / n_obj); 231184610Salfred } 232184610Salfred 233184610Salfred if (parm->buf == NULL) { 234184610Salfred /* for the future */ 235184610Salfred parm->dma_page_ptr += n_dma_pc; 236184610Salfred parm->dma_page_cache_ptr += n_dma_pc; 237184610Salfred parm->dma_page_ptr += count; 238184610Salfred parm->xfer_page_cache_ptr += count; 239184610Salfred return (0); 240184610Salfred } 241184610Salfred for (x = 0; x != n_dma_pc; x++) { 242184610Salfred /* need to initialize the page cache */ 243184610Salfred parm->dma_page_cache_ptr[x].tag_parent = 244187173Sthompsa &parm->curr_xfer->xroot->dma_parent_tag; 245184610Salfred } 246184610Salfred for (x = 0; x != count; x++) { 247184610Salfred /* need to initialize the page cache */ 248184610Salfred parm->xfer_page_cache_ptr[x].tag_parent = 249187173Sthompsa &parm->curr_xfer->xroot->dma_parent_tag; 250184610Salfred } 251184610Salfred 252184610Salfred if (ppc) { 253184610Salfred *ppc = parm->xfer_page_cache_ptr; 254184610Salfred } 255184610Salfred r = count; /* set remainder count */ 256184610Salfred z = n_obj * size; /* set allocation size */ 257184610Salfred pc = parm->xfer_page_cache_ptr; 258184610Salfred pg = parm->dma_page_ptr; 259184610Salfred 260184610Salfred for (x = 0; x != n_dma_pc; x++) { 261184610Salfred 262184610Salfred if (r < n_obj) { 263184610Salfred /* compute last remainder */ 264184610Salfred z = r * size; 265184610Salfred n_obj = r; 266184610Salfred } 267194228Sthompsa if (usb_pc_alloc_mem(parm->dma_page_cache_ptr, 268184610Salfred pg, z, align)) { 269184610Salfred return (1); /* failure */ 270184610Salfred } 271184610Salfred /* Set beginning of current buffer */ 272184610Salfred buf = parm->dma_page_cache_ptr->buffer; 273184610Salfred /* Make room for one DMA page cache and one page */ 274184610Salfred parm->dma_page_cache_ptr++; 275184610Salfred pg++; 276184610Salfred 277184610Salfred for (y = 0; (y != n_obj); y++, r--, pc++, pg++) { 278184610Salfred 279184610Salfred /* Load sub-chunk into DMA */ 280194228Sthompsa if (usb_pc_dmamap_create(pc, size)) { 281184610Salfred return (1); /* failure */ 282184610Salfred } 283184610Salfred pc->buffer = USB_ADD_BYTES(buf, y * size); 284184610Salfred pc->page_start = pg; 285184610Salfred 286184610Salfred mtx_lock(pc->tag_parent->mtx); 287194228Sthompsa if (usb_pc_load_mem(pc, size, 1 /* synchronous */ )) { 288184610Salfred mtx_unlock(pc->tag_parent->mtx); 289184610Salfred return (1); /* failure */ 290184610Salfred } 291184610Salfred mtx_unlock(pc->tag_parent->mtx); 292184610Salfred } 293184610Salfred } 294184610Salfred 295184610Salfred parm->xfer_page_cache_ptr = pc; 296184610Salfred parm->dma_page_ptr = pg; 297184610Salfred return (0); 298184610Salfred} 299190180Sthompsa#endif 300184610Salfred 301184610Salfred/*------------------------------------------------------------------------* 302194228Sthompsa * usbd_transfer_setup_sub - transfer setup subroutine 303184610Salfred * 304184610Salfred * This function must be called from the "xfer_setup" callback of the 305184610Salfred * USB Host or Device controller driver when setting up an USB 306184610Salfred * transfer. This function will setup correct packet sizes, buffer 307192984Sthompsa * sizes, flags and more, that are stored in the "usb_xfer" 308184610Salfred * structure. 309184610Salfred *------------------------------------------------------------------------*/ 310184610Salfredvoid 311194228Sthompsausbd_transfer_setup_sub(struct usb_setup_params *parm) 312184610Salfred{ 313184610Salfred enum { 314184610Salfred REQ_SIZE = 8, 315184610Salfred MIN_PKT = 8, 316184610Salfred }; 317192984Sthompsa struct usb_xfer *xfer = parm->curr_xfer; 318192984Sthompsa const struct usb_config *setup = parm->curr_setup; 319192984Sthompsa struct usb_endpoint_descriptor *edesc; 320194228Sthompsa struct usb_std_packet_size std_size; 321193045Sthompsa usb_frcount_t n_frlengths; 322193045Sthompsa usb_frcount_t n_frbuffers; 323193045Sthompsa usb_frcount_t x; 324184610Salfred uint8_t type; 325184610Salfred uint8_t zmps; 326184610Salfred 327184610Salfred /* 328184610Salfred * Sanity check. The following parameters must be initialized before 329184610Salfred * calling this function. 330184610Salfred */ 331184610Salfred if ((parm->hc_max_packet_size == 0) || 332184610Salfred (parm->hc_max_packet_count == 0) || 333184610Salfred (parm->hc_max_frame_size == 0)) { 334184610Salfred parm->err = USB_ERR_INVAL; 335184610Salfred goto done; 336184610Salfred } 337193644Sthompsa edesc = xfer->endpoint->edesc; 338184610Salfred 339184610Salfred type = (edesc->bmAttributes & UE_XFERTYPE); 340184610Salfred 341190734Sthompsa xfer->flags = setup->flags; 342190734Sthompsa xfer->nframes = setup->frames; 343190734Sthompsa xfer->timeout = setup->timeout; 344190734Sthompsa xfer->callback = setup->callback; 345190734Sthompsa xfer->interval = setup->interval; 346193644Sthompsa xfer->endpointno = edesc->bEndpointAddress; 347184610Salfred xfer->max_packet_size = UGETW(edesc->wMaxPacketSize); 348184610Salfred xfer->max_packet_count = 1; 349184610Salfred /* make a shadow copy: */ 350192499Sthompsa xfer->flags_int.usb_mode = parm->udev->flags.usb_mode; 351184610Salfred 352190734Sthompsa parm->bufsize = setup->bufsize; 353184610Salfred 354184610Salfred if (parm->speed == USB_SPEED_HIGH) { 355184610Salfred xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 356184610Salfred xfer->max_packet_size &= 0x7FF; 357184610Salfred } 358184610Salfred /* range check "max_packet_count" */ 359184610Salfred 360184610Salfred if (xfer->max_packet_count > parm->hc_max_packet_count) { 361184610Salfred xfer->max_packet_count = parm->hc_max_packet_count; 362184610Salfred } 363184610Salfred /* filter "wMaxPacketSize" according to HC capabilities */ 364184610Salfred 365184610Salfred if ((xfer->max_packet_size > parm->hc_max_packet_size) || 366184610Salfred (xfer->max_packet_size == 0)) { 367184610Salfred xfer->max_packet_size = parm->hc_max_packet_size; 368184610Salfred } 369184610Salfred /* filter "wMaxPacketSize" according to standard sizes */ 370184610Salfred 371194228Sthompsa usbd_get_std_packet_size(&std_size, type, parm->speed); 372184610Salfred 373184610Salfred if (std_size.range.min || std_size.range.max) { 374184610Salfred 375184610Salfred if (xfer->max_packet_size < std_size.range.min) { 376184610Salfred xfer->max_packet_size = std_size.range.min; 377184610Salfred } 378184610Salfred if (xfer->max_packet_size > std_size.range.max) { 379184610Salfred xfer->max_packet_size = std_size.range.max; 380184610Salfred } 381184610Salfred } else { 382184610Salfred 383184610Salfred if (xfer->max_packet_size >= std_size.fixed[3]) { 384184610Salfred xfer->max_packet_size = std_size.fixed[3]; 385184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[2]) { 386184610Salfred xfer->max_packet_size = std_size.fixed[2]; 387184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[1]) { 388184610Salfred xfer->max_packet_size = std_size.fixed[1]; 389184610Salfred } else { 390184610Salfred /* only one possibility left */ 391184610Salfred xfer->max_packet_size = std_size.fixed[0]; 392184610Salfred } 393184610Salfred } 394184610Salfred 395184610Salfred /* compute "max_frame_size" */ 396184610Salfred 397194228Sthompsa usbd_update_max_frame_size(xfer); 398184610Salfred 399184610Salfred /* check interrupt interval and transfer pre-delay */ 400184610Salfred 401184610Salfred if (type == UE_ISOCHRONOUS) { 402184610Salfred 403190181Sthompsa uint16_t frame_limit; 404184610Salfred 405184610Salfred xfer->interval = 0; /* not used, must be zero */ 406184610Salfred xfer->flags_int.isochronous_xfr = 1; /* set flag */ 407184610Salfred 408184610Salfred if (xfer->timeout == 0) { 409184610Salfred /* 410184610Salfred * set a default timeout in 411184610Salfred * case something goes wrong! 412184610Salfred */ 413184610Salfred xfer->timeout = 1000 / 4; 414184610Salfred } 415187180Sthompsa switch (parm->speed) { 416187180Sthompsa case USB_SPEED_LOW: 417187180Sthompsa case USB_SPEED_FULL: 418187180Sthompsa frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER; 419199059Sthompsa xfer->fps_shift = 0; 420187180Sthompsa break; 421187180Sthompsa default: 422184610Salfred frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER; 423199059Sthompsa xfer->fps_shift = edesc->bInterval; 424199059Sthompsa if (xfer->fps_shift > 0) 425199059Sthompsa xfer->fps_shift--; 426199059Sthompsa if (xfer->fps_shift > 3) 427199059Sthompsa xfer->fps_shift = 3; 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 */ 507194228Sthompsa usbd_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 xfer->frlengths = parm->xfer_length_ptr; 605184610Salfred parm->xfer_length_ptr += n_frlengths; 606184610Salfred 607184610Salfred /* setup "frbuffers" */ 608184610Salfred xfer->frbuffers = parm->xfer_page_cache_ptr; 609184610Salfred parm->xfer_page_cache_ptr += n_frbuffers; 610184610Salfred 611194677Sthompsa /* initialize max frame count */ 612194677Sthompsa xfer->max_frame_count = xfer->nframes; 613194677Sthompsa 614184610Salfred /* 615184610Salfred * check if we need to setup 616184610Salfred * a local buffer: 617184610Salfred */ 618184610Salfred 619184610Salfred if (!xfer->flags.ext_buffer) { 620184610Salfred 621184610Salfred /* align data */ 622184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 623184610Salfred 624184610Salfred if (parm->buf) { 625184610Salfred 626184610Salfred xfer->local_buffer = 627184610Salfred USB_ADD_BYTES(parm->buf, parm->size[0]); 628184610Salfred 629194677Sthompsa usbd_xfer_set_frame_offset(xfer, 0, 0); 630184610Salfred 631184610Salfred if ((type == UE_CONTROL) && (n_frbuffers > 1)) { 632194677Sthompsa usbd_xfer_set_frame_offset(xfer, REQ_SIZE, 1); 633184610Salfred } 634184610Salfred } 635184610Salfred parm->size[0] += parm->bufsize; 636184610Salfred 637184610Salfred /* align data again */ 638184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 639184610Salfred } 640184610Salfred /* 641184610Salfred * Compute maximum buffer size 642184610Salfred */ 643184610Salfred 644184610Salfred if (parm->bufsize_max < parm->bufsize) { 645184610Salfred parm->bufsize_max = parm->bufsize; 646184610Salfred } 647190180Sthompsa#if USB_HAVE_BUSDMA 648184610Salfred if (xfer->flags_int.bdma_enable) { 649184610Salfred /* 650184610Salfred * Setup "dma_page_ptr". 651184610Salfred * 652184610Salfred * Proof for formula below: 653184610Salfred * 654184610Salfred * Assume there are three USB frames having length "a", "b" and 655184610Salfred * "c". These USB frames will at maximum need "z" 656192984Sthompsa * "usb_page" structures. "z" is given by: 657184610Salfred * 658184610Salfred * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) + 659184610Salfred * ((c / USB_PAGE_SIZE) + 2); 660184610Salfred * 661184610Salfred * Constraining "a", "b" and "c" like this: 662184610Salfred * 663184610Salfred * (a + b + c) <= parm->bufsize 664184610Salfred * 665184610Salfred * We know that: 666184610Salfred * 667184610Salfred * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2)); 668184610Salfred * 669184610Salfred * Here is the general formula: 670184610Salfred */ 671184610Salfred xfer->dma_page_ptr = parm->dma_page_ptr; 672184610Salfred parm->dma_page_ptr += (2 * n_frbuffers); 673184610Salfred parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE); 674184610Salfred } 675190180Sthompsa#endif 676184610Salfred if (zmps) { 677184610Salfred /* correct maximum data length */ 678184610Salfred xfer->max_data_length = 0; 679184610Salfred } 680184610Salfred /* subtract USB frame remainder from "hc_max_frame_size" */ 681184610Salfred 682190181Sthompsa xfer->max_hc_frame_size = 683184610Salfred (parm->hc_max_frame_size - 684184610Salfred (parm->hc_max_frame_size % xfer->max_frame_size)); 685184610Salfred 686190181Sthompsa if (xfer->max_hc_frame_size == 0) { 687184610Salfred parm->err = USB_ERR_INVAL; 688184610Salfred goto done; 689184610Salfred } 690184610Salfred 691184610Salfred /* initialize frame buffers */ 692184610Salfred 693184610Salfred if (parm->buf) { 694184610Salfred for (x = 0; x != n_frbuffers; x++) { 695184610Salfred xfer->frbuffers[x].tag_parent = 696187173Sthompsa &xfer->xroot->dma_parent_tag; 697190180Sthompsa#if USB_HAVE_BUSDMA 698184610Salfred if (xfer->flags_int.bdma_enable && 699184610Salfred (parm->bufsize_max > 0)) { 700184610Salfred 701194228Sthompsa if (usb_pc_dmamap_create( 702184610Salfred xfer->frbuffers + x, 703184610Salfred parm->bufsize_max)) { 704184610Salfred parm->err = USB_ERR_NOMEM; 705184610Salfred goto done; 706184610Salfred } 707184610Salfred } 708190180Sthompsa#endif 709184610Salfred } 710184610Salfred } 711184610Salfreddone: 712184610Salfred if (parm->err) { 713184610Salfred /* 714184610Salfred * Set some dummy values so that we avoid division by zero: 715184610Salfred */ 716190181Sthompsa xfer->max_hc_frame_size = 1; 717184610Salfred xfer->max_frame_size = 1; 718184610Salfred xfer->max_packet_size = 1; 719184610Salfred xfer->max_data_length = 0; 720184610Salfred xfer->nframes = 0; 721184610Salfred xfer->max_frame_count = 0; 722184610Salfred } 723184610Salfred} 724184610Salfred 725184610Salfred/*------------------------------------------------------------------------* 726194228Sthompsa * usbd_transfer_setup - setup an array of USB transfers 727184610Salfred * 728194228Sthompsa * NOTE: You must always call "usbd_transfer_unsetup" after calling 729194228Sthompsa * "usbd_transfer_setup" if success was returned. 730184610Salfred * 731184610Salfred * The idea is that the USB device driver should pre-allocate all its 732184610Salfred * transfers by one call to this function. 733184610Salfred * 734184610Salfred * Return values: 735184610Salfred * 0: Success 736184610Salfred * Else: Failure 737184610Salfred *------------------------------------------------------------------------*/ 738193045Sthompsausb_error_t 739194228Sthompsausbd_transfer_setup(struct usb_device *udev, 740192984Sthompsa const uint8_t *ifaces, struct usb_xfer **ppxfer, 741192984Sthompsa const struct usb_config *setup_start, uint16_t n_setup, 742187173Sthompsa void *priv_sc, struct mtx *xfer_mtx) 743184610Salfred{ 744192984Sthompsa struct usb_xfer dummy; 745192984Sthompsa struct usb_setup_params parm; 746192984Sthompsa const struct usb_config *setup_end = setup_start + n_setup; 747192984Sthompsa const struct usb_config *setup; 748193644Sthompsa struct usb_endpoint *ep; 749192984Sthompsa struct usb_xfer_root *info; 750192984Sthompsa struct usb_xfer *xfer; 751184610Salfred void *buf = NULL; 752184610Salfred uint16_t n; 753184610Salfred uint16_t refcount; 754184610Salfred 755184610Salfred parm.err = 0; 756184610Salfred refcount = 0; 757184610Salfred info = NULL; 758184610Salfred 759184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 760194228Sthompsa "usbd_transfer_setup can sleep!"); 761184610Salfred 762184610Salfred /* do some checking first */ 763184610Salfred 764184610Salfred if (n_setup == 0) { 765184610Salfred DPRINTFN(6, "setup array has zero length!\n"); 766184610Salfred return (USB_ERR_INVAL); 767184610Salfred } 768184610Salfred if (ifaces == 0) { 769184610Salfred DPRINTFN(6, "ifaces array is NULL!\n"); 770184610Salfred return (USB_ERR_INVAL); 771184610Salfred } 772187173Sthompsa if (xfer_mtx == NULL) { 773184610Salfred DPRINTFN(6, "using global lock\n"); 774187173Sthompsa xfer_mtx = &Giant; 775184610Salfred } 776184610Salfred /* sanity checks */ 777184610Salfred for (setup = setup_start, n = 0; 778184610Salfred setup != setup_end; setup++, n++) { 779193045Sthompsa if (setup->bufsize == (usb_frlength_t)-1) { 780184610Salfred parm.err = USB_ERR_BAD_BUFSIZE; 781184610Salfred DPRINTF("invalid bufsize\n"); 782184610Salfred } 783190734Sthompsa if (setup->callback == NULL) { 784184610Salfred parm.err = USB_ERR_NO_CALLBACK; 785184610Salfred DPRINTF("no callback\n"); 786184610Salfred } 787184610Salfred ppxfer[n] = NULL; 788184610Salfred } 789184610Salfred 790184610Salfred if (parm.err) { 791184610Salfred goto done; 792184610Salfred } 793184610Salfred bzero(&parm, sizeof(parm)); 794184610Salfred 795184610Salfred parm.udev = udev; 796194228Sthompsa parm.speed = usbd_get_speed(udev); 797184610Salfred parm.hc_max_packet_count = 1; 798184610Salfred 799184610Salfred if (parm.speed >= USB_SPEED_MAX) { 800184610Salfred parm.err = USB_ERR_INVAL; 801184610Salfred goto done; 802184610Salfred } 803184610Salfred /* setup all transfers */ 804184610Salfred 805184610Salfred while (1) { 806184610Salfred 807184610Salfred if (buf) { 808184610Salfred /* 809192984Sthompsa * Initialize the "usb_xfer_root" structure, 810184610Salfred * which is common for all our USB transfers. 811184610Salfred */ 812184610Salfred info = USB_ADD_BYTES(buf, 0); 813184610Salfred 814184610Salfred info->memory_base = buf; 815184610Salfred info->memory_size = parm.size[0]; 816184610Salfred 817190180Sthompsa#if USB_HAVE_BUSDMA 818184610Salfred info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]); 819184610Salfred info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]); 820190180Sthompsa#endif 821184610Salfred info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]); 822184610Salfred info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]); 823184610Salfred 824194227Sthompsa cv_init(&info->cv_drain, "WDRAIN"); 825184610Salfred 826187173Sthompsa info->xfer_mtx = xfer_mtx; 827190180Sthompsa#if USB_HAVE_BUSDMA 828194228Sthompsa usb_dma_tag_setup(&info->dma_parent_tag, 829184610Salfred parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag, 830194228Sthompsa xfer_mtx, &usb_bdma_done_event, 32, parm.dma_tag_max); 831190180Sthompsa#endif 832184610Salfred 833184610Salfred info->bus = udev->bus; 834187173Sthompsa info->udev = udev; 835184610Salfred 836184610Salfred TAILQ_INIT(&info->done_q.head); 837194228Sthompsa info->done_q.command = &usbd_callback_wrapper; 838190180Sthompsa#if USB_HAVE_BUSDMA 839184610Salfred TAILQ_INIT(&info->dma_q.head); 840194228Sthompsa info->dma_q.command = &usb_bdma_work_loop; 841190180Sthompsa#endif 842194228Sthompsa info->done_m[0].hdr.pm_callback = &usb_callback_proc; 843187173Sthompsa info->done_m[0].xroot = info; 844194228Sthompsa info->done_m[1].hdr.pm_callback = &usb_callback_proc; 845187173Sthompsa info->done_m[1].xroot = info; 846184610Salfred 847191400Sthompsa /* 848191400Sthompsa * In device side mode control endpoint 849191400Sthompsa * requests need to run from a separate 850191400Sthompsa * context, else there is a chance of 851191400Sthompsa * deadlock! 852191400Sthompsa */ 853194228Sthompsa if (setup_start == usb_control_ep_cfg) 854187174Sthompsa info->done_p = 855191400Sthompsa &udev->bus->control_xfer_proc; 856191400Sthompsa else if (xfer_mtx == &Giant) 857191400Sthompsa info->done_p = 858187174Sthompsa &udev->bus->giant_callback_proc; 859187174Sthompsa else 860187174Sthompsa info->done_p = 861187174Sthompsa &udev->bus->non_giant_callback_proc; 862184610Salfred } 863184610Salfred /* reset sizes */ 864184610Salfred 865184610Salfred parm.size[0] = 0; 866184610Salfred parm.buf = buf; 867184610Salfred parm.size[0] += sizeof(info[0]); 868184610Salfred 869184610Salfred for (setup = setup_start, n = 0; 870184610Salfred setup != setup_end; setup++, n++) { 871184610Salfred 872184610Salfred /* skip USB transfers without callbacks: */ 873190734Sthompsa if (setup->callback == NULL) { 874184610Salfred continue; 875184610Salfred } 876184610Salfred /* see if there is a matching endpoint */ 877194228Sthompsa ep = usbd_get_endpoint(udev, 878184610Salfred ifaces[setup->if_index], setup); 879184610Salfred 880193644Sthompsa if ((ep == NULL) || (ep->methods == NULL)) { 881190734Sthompsa if (setup->flags.no_pipe_ok) 882184610Salfred continue; 883192499Sthompsa if ((setup->usb_mode != USB_MODE_DUAL) && 884192499Sthompsa (setup->usb_mode != udev->flags.usb_mode)) 885190734Sthompsa continue; 886184610Salfred parm.err = USB_ERR_NO_PIPE; 887184610Salfred goto done; 888184610Salfred } 889184610Salfred 890184610Salfred /* align data properly */ 891184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 892184610Salfred 893190734Sthompsa /* store current setup pointer */ 894190734Sthompsa parm.curr_setup = setup; 895190734Sthompsa 896184610Salfred if (buf) { 897184610Salfred /* 898184610Salfred * Common initialization of the 899192984Sthompsa * "usb_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 906194228Sthompsa usb_callout_init_mtx(&xfer->timeout_handle, 907186454Sthompsa &udev->bus->bus_mtx, 0); 908184610Salfred } else { 909184610Salfred /* 910184610Salfred * Setup a dummy xfer, hence we are 911192984Sthompsa * writing to the "usb_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 921193644Sthompsa /* set transfer endpoint pointer */ 922193644Sthompsa xfer->endpoint = ep; 923188982Sthompsa 924184610Salfred parm.size[0] += sizeof(xfer[0]); 925193644Sthompsa parm.methods = xfer->endpoint->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 /* 940193644Sthompsa * Increment the endpoint 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 945199672Sthompsa * code for "endpoint->refcount_alloc" if you 946184610Salfred * want more information. 947184610Salfred */ 948199672Sthompsa USB_BUS_LOCK(info->bus); 949199672Sthompsa if (xfer->endpoint->refcount_alloc >= USB_EP_REF_MAX) 950199672Sthompsa parm.err = USB_ERR_INVAL; 951184610Salfred 952199672Sthompsa xfer->endpoint->refcount_alloc++; 953199672Sthompsa 954199672Sthompsa if (xfer->endpoint->refcount_alloc == 0) 955199672Sthompsa panic("usbd_transfer_setup(): Refcount wrapped to zero\n"); 956199672Sthompsa USB_BUS_UNLOCK(info->bus); 957199672Sthompsa 958188982Sthompsa /* 959188982Sthompsa * Whenever we set ppxfer[] then we 960188982Sthompsa * also need to increment the 961188982Sthompsa * "setup_refcount": 962188982Sthompsa */ 963188982Sthompsa info->setup_refcount++; 964184610Salfred 965188982Sthompsa /* 966188982Sthompsa * Transfer is successfully setup and 967188982Sthompsa * can be used: 968188982Sthompsa */ 969188982Sthompsa ppxfer[n] = xfer; 970184610Salfred } 971199672Sthompsa 972199672Sthompsa /* check for error */ 973199672Sthompsa if (parm.err) 974199672Sthompsa goto done; 975184610Salfred } 976184610Salfred 977184610Salfred if (buf || parm.err) { 978184610Salfred goto done; 979184610Salfred } 980184610Salfred if (refcount == 0) { 981184610Salfred /* no transfers - nothing to do ! */ 982184610Salfred goto done; 983184610Salfred } 984184610Salfred /* align data properly */ 985184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 986184610Salfred 987184610Salfred /* store offset temporarily */ 988184610Salfred parm.size[1] = parm.size[0]; 989184610Salfred 990184610Salfred /* 991184610Salfred * The number of DMA tags required depends on 992184610Salfred * the number of endpoints. The current estimate 993184610Salfred * for maximum number of DMA tags per endpoint 994184610Salfred * is two. 995184610Salfred */ 996184610Salfred parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX); 997184610Salfred 998184610Salfred /* 999184610Salfred * DMA tags for QH, TD, Data and more. 1000184610Salfred */ 1001184610Salfred parm.dma_tag_max += 8; 1002184610Salfred 1003184610Salfred parm.dma_tag_p += parm.dma_tag_max; 1004184610Salfred 1005184610Salfred parm.size[0] += ((uint8_t *)parm.dma_tag_p) - 1006184610Salfred ((uint8_t *)0); 1007184610Salfred 1008184610Salfred /* align data properly */ 1009184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1010184610Salfred 1011184610Salfred /* store offset temporarily */ 1012184610Salfred parm.size[3] = parm.size[0]; 1013184610Salfred 1014184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_ptr) - 1015184610Salfred ((uint8_t *)0); 1016184610Salfred 1017184610Salfred /* align data properly */ 1018184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1019184610Salfred 1020184610Salfred /* store offset temporarily */ 1021184610Salfred parm.size[4] = parm.size[0]; 1022184610Salfred 1023184610Salfred parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) - 1024184610Salfred ((uint8_t *)0); 1025184610Salfred 1026184610Salfred /* store end offset temporarily */ 1027184610Salfred parm.size[5] = parm.size[0]; 1028184610Salfred 1029184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) - 1030184610Salfred ((uint8_t *)0); 1031184610Salfred 1032184610Salfred /* store end offset temporarily */ 1033184610Salfred 1034184610Salfred parm.size[2] = parm.size[0]; 1035184610Salfred 1036184610Salfred /* align data properly */ 1037184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1038184610Salfred 1039184610Salfred parm.size[6] = parm.size[0]; 1040184610Salfred 1041184610Salfred parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) - 1042184610Salfred ((uint8_t *)0); 1043184610Salfred 1044184610Salfred /* align data properly */ 1045184610Salfred parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1046184610Salfred 1047184610Salfred /* allocate zeroed memory */ 1048184610Salfred buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO); 1049184610Salfred 1050184610Salfred if (buf == NULL) { 1051184610Salfred parm.err = USB_ERR_NOMEM; 1052184610Salfred DPRINTFN(0, "cannot allocate memory block for " 1053184610Salfred "configuration (%d bytes)\n", 1054184610Salfred parm.size[0]); 1055184610Salfred goto done; 1056184610Salfred } 1057184610Salfred parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]); 1058184610Salfred parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]); 1059184610Salfred parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]); 1060184610Salfred parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]); 1061184610Salfred parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]); 1062184610Salfred } 1063184610Salfred 1064184610Salfreddone: 1065184610Salfred if (buf) { 1066184610Salfred if (info->setup_refcount == 0) { 1067184610Salfred /* 1068194228Sthompsa * "usbd_transfer_unsetup_sub" will unlock 1069184824Sthompsa * the bus mutex before returning ! 1070184610Salfred */ 1071184824Sthompsa USB_BUS_LOCK(info->bus); 1072184610Salfred 1073184610Salfred /* something went wrong */ 1074194228Sthompsa usbd_transfer_unsetup_sub(info, 0); 1075184610Salfred } 1076184610Salfred } 1077184610Salfred if (parm.err) { 1078194228Sthompsa usbd_transfer_unsetup(ppxfer, n_setup); 1079184610Salfred } 1080184610Salfred return (parm.err); 1081184610Salfred} 1082184610Salfred 1083184610Salfred/*------------------------------------------------------------------------* 1084194228Sthompsa * usbd_transfer_unsetup_sub - factored out code 1085184610Salfred *------------------------------------------------------------------------*/ 1086184610Salfredstatic void 1087194228Sthompsausbd_transfer_unsetup_sub(struct usb_xfer_root *info, uint8_t needs_delay) 1088184610Salfred{ 1089192984Sthompsa struct usb_page_cache *pc; 1090184610Salfred 1091184824Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 1092184610Salfred 1093184610Salfred /* wait for any outstanding DMA operations */ 1094184610Salfred 1095184610Salfred if (needs_delay) { 1096193045Sthompsa usb_timeout_t temp; 1097194228Sthompsa temp = usbd_get_dma_delay(info->bus); 1098194228Sthompsa usb_pause_mtx(&info->bus->bus_mtx, 1099188411Sthompsa USB_MS_TO_TICKS(temp)); 1100184610Salfred } 1101187174Sthompsa 1102187174Sthompsa /* make sure that our done messages are not queued anywhere */ 1103194228Sthompsa usb_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]); 1104187174Sthompsa 1105184824Sthompsa USB_BUS_UNLOCK(info->bus); 1106184610Salfred 1107190180Sthompsa#if USB_HAVE_BUSDMA 1108184610Salfred /* free DMA'able memory, if any */ 1109184610Salfred pc = info->dma_page_cache_start; 1110184610Salfred while (pc != info->dma_page_cache_end) { 1111194228Sthompsa usb_pc_free_mem(pc); 1112184610Salfred pc++; 1113184610Salfred } 1114184610Salfred 1115184610Salfred /* free DMA maps in all "xfer->frbuffers" */ 1116184610Salfred pc = info->xfer_page_cache_start; 1117184610Salfred while (pc != info->xfer_page_cache_end) { 1118194228Sthompsa usb_pc_dmamap_destroy(pc); 1119184610Salfred pc++; 1120184610Salfred } 1121184610Salfred 1122184610Salfred /* free all DMA tags */ 1123194228Sthompsa usb_dma_tag_unsetup(&info->dma_parent_tag); 1124190180Sthompsa#endif 1125184610Salfred 1126194227Sthompsa cv_destroy(&info->cv_drain); 1127184610Salfred 1128184610Salfred /* 1129184610Salfred * free the "memory_base" last, hence the "info" structure is 1130184610Salfred * contained within the "memory_base"! 1131184610Salfred */ 1132184610Salfred free(info->memory_base, M_USB); 1133184610Salfred} 1134184610Salfred 1135184610Salfred/*------------------------------------------------------------------------* 1136194228Sthompsa * usbd_transfer_unsetup - unsetup/free an array of USB transfers 1137184610Salfred * 1138184610Salfred * NOTE: All USB transfers in progress will get called back passing 1139184610Salfred * the error code "USB_ERR_CANCELLED" before this function 1140184610Salfred * returns. 1141184610Salfred *------------------------------------------------------------------------*/ 1142184610Salfredvoid 1143194228Sthompsausbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup) 1144184610Salfred{ 1145192984Sthompsa struct usb_xfer *xfer; 1146192984Sthompsa struct usb_xfer_root *info; 1147184610Salfred uint8_t needs_delay = 0; 1148184610Salfred 1149184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1150194228Sthompsa "usbd_transfer_unsetup can sleep!"); 1151184610Salfred 1152184610Salfred while (n_setup--) { 1153184610Salfred xfer = pxfer[n_setup]; 1154184610Salfred 1155188982Sthompsa if (xfer == NULL) 1156188982Sthompsa continue; 1157184610Salfred 1158188982Sthompsa info = xfer->xroot; 1159184610Salfred 1160188982Sthompsa USB_XFER_LOCK(xfer); 1161188982Sthompsa USB_BUS_LOCK(info->bus); 1162184610Salfred 1163188982Sthompsa /* 1164188982Sthompsa * HINT: when you start/stop a transfer, it might be a 1165188982Sthompsa * good idea to directly use the "pxfer[]" structure: 1166188982Sthompsa * 1167194228Sthompsa * usbd_transfer_start(sc->pxfer[0]); 1168194228Sthompsa * usbd_transfer_stop(sc->pxfer[0]); 1169188982Sthompsa * 1170188982Sthompsa * That way, if your code has many parts that will not 1171188982Sthompsa * stop running under the same lock, in other words 1172194228Sthompsa * "xfer_mtx", the usbd_transfer_start and 1173194228Sthompsa * usbd_transfer_stop functions will simply return 1174188982Sthompsa * when they detect a NULL pointer argument. 1175188982Sthompsa * 1176188982Sthompsa * To avoid any races we clear the "pxfer[]" pointer 1177188982Sthompsa * while holding the private mutex of the driver: 1178188982Sthompsa */ 1179188982Sthompsa pxfer[n_setup] = NULL; 1180184610Salfred 1181188982Sthompsa USB_BUS_UNLOCK(info->bus); 1182188982Sthompsa USB_XFER_UNLOCK(xfer); 1183184610Salfred 1184194228Sthompsa usbd_transfer_drain(xfer); 1185184610Salfred 1186190180Sthompsa#if USB_HAVE_BUSDMA 1187188982Sthompsa if (xfer->flags_int.bdma_enable) 1188188982Sthompsa needs_delay = 1; 1189190180Sthompsa#endif 1190188982Sthompsa /* 1191193644Sthompsa * NOTE: default endpoint does not have an 1192193644Sthompsa * interface, even if endpoint->iface_index == 0 1193188982Sthompsa */ 1194199672Sthompsa USB_BUS_LOCK(info->bus); 1195199672Sthompsa xfer->endpoint->refcount_alloc--; 1196199672Sthompsa USB_BUS_UNLOCK(info->bus); 1197184610Salfred 1198194228Sthompsa usb_callout_drain(&xfer->timeout_handle); 1199184610Salfred 1200188982Sthompsa USB_BUS_LOCK(info->bus); 1201184610Salfred 1202188982Sthompsa USB_ASSERT(info->setup_refcount != 0, ("Invalid setup " 1203199816Sthompsa "reference count\n")); 1204184610Salfred 1205188982Sthompsa info->setup_refcount--; 1206188982Sthompsa 1207188982Sthompsa if (info->setup_refcount == 0) { 1208194228Sthompsa usbd_transfer_unsetup_sub(info, 1209188982Sthompsa needs_delay); 1210188982Sthompsa } else { 1211188982Sthompsa USB_BUS_UNLOCK(info->bus); 1212184610Salfred } 1213184610Salfred } 1214184610Salfred} 1215184610Salfred 1216184610Salfred/*------------------------------------------------------------------------* 1217194228Sthompsa * usbd_control_transfer_init - factored out code 1218184610Salfred * 1219184610Salfred * In USB Device Mode we have to wait for the SETUP packet which 1220192984Sthompsa * containst the "struct usb_device_request" structure, before we can 1221184610Salfred * transfer any data. In USB Host Mode we already have the SETUP 1222184610Salfred * packet at the moment the USB transfer is started. This leads us to 1223184610Salfred * having to setup the USB transfer at two different places in 1224184610Salfred * time. This function just contains factored out control transfer 1225184610Salfred * initialisation code, so that we don't duplicate the code. 1226184610Salfred *------------------------------------------------------------------------*/ 1227184610Salfredstatic void 1228194228Sthompsausbd_control_transfer_init(struct usb_xfer *xfer) 1229184610Salfred{ 1230192984Sthompsa struct usb_device_request req; 1231184610Salfred 1232184610Salfred /* copy out the USB request header */ 1233184610Salfred 1234194228Sthompsa usbd_copy_out(xfer->frbuffers, 0, &req, sizeof(req)); 1235184610Salfred 1236184610Salfred /* setup remainder */ 1237184610Salfred 1238184610Salfred xfer->flags_int.control_rem = UGETW(req.wLength); 1239184610Salfred 1240184610Salfred /* copy direction to endpoint variable */ 1241184610Salfred 1242193644Sthompsa xfer->endpointno &= ~(UE_DIR_IN | UE_DIR_OUT); 1243193644Sthompsa xfer->endpointno |= 1244184610Salfred (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT; 1245184610Salfred} 1246184610Salfred 1247184610Salfred/*------------------------------------------------------------------------* 1248194677Sthompsa * usbd_setup_ctrl_transfer 1249184610Salfred * 1250184610Salfred * This function handles initialisation of control transfers. Control 1251184610Salfred * transfers are special in that regard that they can both transmit 1252184610Salfred * and receive data. 1253184610Salfred * 1254184610Salfred * Return values: 1255184610Salfred * 0: Success 1256184610Salfred * Else: Failure 1257184610Salfred *------------------------------------------------------------------------*/ 1258194677Sthompsastatic int 1259194677Sthompsausbd_setup_ctrl_transfer(struct usb_xfer *xfer) 1260184610Salfred{ 1261193045Sthompsa usb_frlength_t len; 1262184610Salfred 1263184610Salfred /* Check for control endpoint stall */ 1264192552Sthompsa if (xfer->flags.stall_pipe && xfer->flags_int.control_act) { 1265192552Sthompsa /* the control transfer is no longer active */ 1266192552Sthompsa xfer->flags_int.control_stall = 1; 1267184610Salfred xfer->flags_int.control_act = 0; 1268192552Sthompsa } else { 1269192552Sthompsa /* don't stall control transfer by default */ 1270192552Sthompsa xfer->flags_int.control_stall = 0; 1271184610Salfred } 1272190184Sthompsa 1273190184Sthompsa /* Check for invalid number of frames */ 1274190184Sthompsa if (xfer->nframes > 2) { 1275190184Sthompsa /* 1276190184Sthompsa * If you need to split a control transfer, you 1277190184Sthompsa * have to do one part at a time. Only with 1278190184Sthompsa * non-control transfers you can do multiple 1279190184Sthompsa * parts a time. 1280190184Sthompsa */ 1281190184Sthompsa DPRINTFN(0, "Too many frames: %u\n", 1282190184Sthompsa (unsigned int)xfer->nframes); 1283190184Sthompsa goto error; 1284190184Sthompsa } 1285190184Sthompsa 1286184610Salfred /* 1287184610Salfred * Check if there is a control 1288184610Salfred * transfer in progress: 1289184610Salfred */ 1290184610Salfred if (xfer->flags_int.control_act) { 1291184610Salfred 1292184610Salfred if (xfer->flags_int.control_hdr) { 1293184610Salfred 1294184610Salfred /* clear send header flag */ 1295184610Salfred 1296184610Salfred xfer->flags_int.control_hdr = 0; 1297184610Salfred 1298184610Salfred /* setup control transfer */ 1299192499Sthompsa if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1300194228Sthompsa usbd_control_transfer_init(xfer); 1301184610Salfred } 1302184610Salfred } 1303184610Salfred /* get data length */ 1304184610Salfred 1305184610Salfred len = xfer->sumlen; 1306184610Salfred 1307184610Salfred } else { 1308184610Salfred 1309184610Salfred /* the size of the SETUP structure is hardcoded ! */ 1310184610Salfred 1311192984Sthompsa if (xfer->frlengths[0] != sizeof(struct usb_device_request)) { 1312184610Salfred DPRINTFN(0, "Wrong framelength %u != %zu\n", 1313184610Salfred xfer->frlengths[0], sizeof(struct 1314192984Sthompsa usb_device_request)); 1315184610Salfred goto error; 1316184610Salfred } 1317184610Salfred /* check USB mode */ 1318192499Sthompsa if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1319184610Salfred 1320184610Salfred /* check number of frames */ 1321184610Salfred if (xfer->nframes != 1) { 1322184610Salfred /* 1323184610Salfred * We need to receive the setup 1324184610Salfred * message first so that we know the 1325184610Salfred * data direction! 1326184610Salfred */ 1327184610Salfred DPRINTF("Misconfigured transfer\n"); 1328184610Salfred goto error; 1329184610Salfred } 1330184610Salfred /* 1331184610Salfred * Set a dummy "control_rem" value. This 1332184610Salfred * variable will be overwritten later by a 1333194228Sthompsa * call to "usbd_control_transfer_init()" ! 1334184610Salfred */ 1335184610Salfred xfer->flags_int.control_rem = 0xFFFF; 1336184610Salfred } else { 1337184610Salfred 1338184610Salfred /* setup "endpoint" and "control_rem" */ 1339184610Salfred 1340194228Sthompsa usbd_control_transfer_init(xfer); 1341184610Salfred } 1342184610Salfred 1343184610Salfred /* set transfer-header flag */ 1344184610Salfred 1345184610Salfred xfer->flags_int.control_hdr = 1; 1346184610Salfred 1347184610Salfred /* get data length */ 1348184610Salfred 1349192984Sthompsa len = (xfer->sumlen - sizeof(struct usb_device_request)); 1350184610Salfred } 1351184610Salfred 1352184610Salfred /* check if there is a length mismatch */ 1353184610Salfred 1354184610Salfred if (len > xfer->flags_int.control_rem) { 1355197562Sthompsa DPRINTFN(0, "Length (%d) greater than " 1356199816Sthompsa "remaining length (%d)\n", len, 1357197562Sthompsa xfer->flags_int.control_rem); 1358184610Salfred goto error; 1359184610Salfred } 1360184610Salfred /* check if we are doing a short transfer */ 1361184610Salfred 1362184610Salfred if (xfer->flags.force_short_xfer) { 1363184610Salfred xfer->flags_int.control_rem = 0; 1364184610Salfred } else { 1365184610Salfred if ((len != xfer->max_data_length) && 1366184610Salfred (len != xfer->flags_int.control_rem) && 1367184610Salfred (xfer->nframes != 1)) { 1368184610Salfred DPRINTFN(0, "Short control transfer without " 1369199816Sthompsa "force_short_xfer set\n"); 1370184610Salfred goto error; 1371184610Salfred } 1372184610Salfred xfer->flags_int.control_rem -= len; 1373184610Salfred } 1374184610Salfred 1375184610Salfred /* the status part is executed when "control_act" is 0 */ 1376184610Salfred 1377184610Salfred if ((xfer->flags_int.control_rem > 0) || 1378184610Salfred (xfer->flags.manual_status)) { 1379184610Salfred /* don't execute the STATUS stage yet */ 1380184610Salfred xfer->flags_int.control_act = 1; 1381184610Salfred 1382184610Salfred /* sanity check */ 1383184610Salfred if ((!xfer->flags_int.control_hdr) && 1384184610Salfred (xfer->nframes == 1)) { 1385184610Salfred /* 1386184610Salfred * This is not a valid operation! 1387184610Salfred */ 1388184610Salfred DPRINTFN(0, "Invalid parameter " 1389184610Salfred "combination\n"); 1390184610Salfred goto error; 1391184610Salfred } 1392184610Salfred } else { 1393184610Salfred /* time to execute the STATUS stage */ 1394184610Salfred xfer->flags_int.control_act = 0; 1395184610Salfred } 1396184610Salfred return (0); /* success */ 1397184610Salfred 1398184610Salfrederror: 1399184610Salfred return (1); /* failure */ 1400184610Salfred} 1401184610Salfred 1402184610Salfred/*------------------------------------------------------------------------* 1403194228Sthompsa * usbd_transfer_submit - start USB hardware for the given transfer 1404184610Salfred * 1405184610Salfred * This function should only be called from the USB callback. 1406184610Salfred *------------------------------------------------------------------------*/ 1407184610Salfredvoid 1408194228Sthompsausbd_transfer_submit(struct usb_xfer *xfer) 1409184610Salfred{ 1410192984Sthompsa struct usb_xfer_root *info; 1411192984Sthompsa struct usb_bus *bus; 1412193045Sthompsa usb_frcount_t x; 1413184610Salfred 1414191494Sthompsa info = xfer->xroot; 1415191494Sthompsa bus = info->bus; 1416191494Sthompsa 1417193644Sthompsa DPRINTF("xfer=%p, endpoint=%p, nframes=%d, dir=%s\n", 1418193644Sthompsa xfer, xfer->endpoint, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ? 1419184610Salfred "read" : "write"); 1420184610Salfred 1421207077Sthompsa#ifdef USB_DEBUG 1422184610Salfred if (USB_DEBUG_VAR > 0) { 1423191494Sthompsa USB_BUS_LOCK(bus); 1424184610Salfred 1425194228Sthompsa usb_dump_endpoint(xfer->endpoint); 1426184610Salfred 1427191494Sthompsa USB_BUS_UNLOCK(bus); 1428184610Salfred } 1429184610Salfred#endif 1430184610Salfred 1431184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1432191494Sthompsa USB_BUS_LOCK_ASSERT(bus, MA_NOTOWNED); 1433184610Salfred 1434184610Salfred /* Only open the USB transfer once! */ 1435184610Salfred if (!xfer->flags_int.open) { 1436184610Salfred xfer->flags_int.open = 1; 1437184610Salfred 1438184610Salfred DPRINTF("open\n"); 1439184610Salfred 1440191494Sthompsa USB_BUS_LOCK(bus); 1441193644Sthompsa (xfer->endpoint->methods->open) (xfer); 1442191494Sthompsa USB_BUS_UNLOCK(bus); 1443184610Salfred } 1444184610Salfred /* set "transferring" flag */ 1445184610Salfred xfer->flags_int.transferring = 1; 1446184610Salfred 1447190734Sthompsa#if USB_HAVE_POWERD 1448186730Salfred /* increment power reference */ 1449194228Sthompsa usbd_transfer_power_ref(xfer, 1); 1450190734Sthompsa#endif 1451184610Salfred /* 1452184610Salfred * Check if the transfer is waiting on a queue, most 1453184610Salfred * frequently the "done_q": 1454184610Salfred */ 1455184610Salfred if (xfer->wait_queue) { 1456191494Sthompsa USB_BUS_LOCK(bus); 1457194228Sthompsa usbd_transfer_dequeue(xfer); 1458191494Sthompsa USB_BUS_UNLOCK(bus); 1459184610Salfred } 1460184610Salfred /* clear "did_dma_delay" flag */ 1461184610Salfred xfer->flags_int.did_dma_delay = 0; 1462184610Salfred 1463184610Salfred /* clear "did_close" flag */ 1464184610Salfred xfer->flags_int.did_close = 0; 1465184610Salfred 1466190180Sthompsa#if USB_HAVE_BUSDMA 1467184610Salfred /* clear "bdma_setup" flag */ 1468184610Salfred xfer->flags_int.bdma_setup = 0; 1469190180Sthompsa#endif 1470184610Salfred /* by default we cannot cancel any USB transfer immediately */ 1471184610Salfred xfer->flags_int.can_cancel_immed = 0; 1472184610Salfred 1473184610Salfred /* clear lengths and frame counts by default */ 1474184610Salfred xfer->sumlen = 0; 1475184610Salfred xfer->actlen = 0; 1476184610Salfred xfer->aframes = 0; 1477184610Salfred 1478184610Salfred /* clear any previous errors */ 1479184610Salfred xfer->error = 0; 1480184610Salfred 1481191824Sthompsa /* Check if the device is still alive */ 1482191824Sthompsa if (info->udev->state < USB_STATE_POWERED) { 1483191824Sthompsa USB_BUS_LOCK(bus); 1484192051Sthompsa /* 1485192051Sthompsa * Must return cancelled error code else 1486192051Sthompsa * device drivers can hang. 1487192051Sthompsa */ 1488194228Sthompsa usbd_transfer_done(xfer, USB_ERR_CANCELLED); 1489191824Sthompsa USB_BUS_UNLOCK(bus); 1490191824Sthompsa return; 1491191824Sthompsa } 1492191824Sthompsa 1493184610Salfred /* sanity check */ 1494184610Salfred if (xfer->nframes == 0) { 1495184610Salfred if (xfer->flags.stall_pipe) { 1496184610Salfred /* 1497184610Salfred * Special case - want to stall without transferring 1498184610Salfred * any data: 1499184610Salfred */ 1500184610Salfred DPRINTF("xfer=%p nframes=0: stall " 1501184610Salfred "or clear stall!\n", xfer); 1502191494Sthompsa USB_BUS_LOCK(bus); 1503184610Salfred xfer->flags_int.can_cancel_immed = 1; 1504184610Salfred /* start the transfer */ 1505194228Sthompsa usb_command_wrapper(&xfer->endpoint->endpoint_q, xfer); 1506191494Sthompsa USB_BUS_UNLOCK(bus); 1507184610Salfred return; 1508184610Salfred } 1509191494Sthompsa USB_BUS_LOCK(bus); 1510194228Sthompsa usbd_transfer_done(xfer, USB_ERR_INVAL); 1511191494Sthompsa USB_BUS_UNLOCK(bus); 1512184610Salfred return; 1513184610Salfred } 1514184610Salfred /* compute total transfer length */ 1515184610Salfred 1516184610Salfred for (x = 0; x != xfer->nframes; x++) { 1517184610Salfred xfer->sumlen += xfer->frlengths[x]; 1518184610Salfred if (xfer->sumlen < xfer->frlengths[x]) { 1519184610Salfred /* length wrapped around */ 1520191494Sthompsa USB_BUS_LOCK(bus); 1521194228Sthompsa usbd_transfer_done(xfer, USB_ERR_INVAL); 1522191494Sthompsa USB_BUS_UNLOCK(bus); 1523184610Salfred return; 1524184610Salfred } 1525184610Salfred } 1526184610Salfred 1527184610Salfred /* clear some internal flags */ 1528184610Salfred 1529184610Salfred xfer->flags_int.short_xfer_ok = 0; 1530184610Salfred xfer->flags_int.short_frames_ok = 0; 1531184610Salfred 1532184610Salfred /* check if this is a control transfer */ 1533184610Salfred 1534184610Salfred if (xfer->flags_int.control_xfr) { 1535184610Salfred 1536194677Sthompsa if (usbd_setup_ctrl_transfer(xfer)) { 1537191494Sthompsa USB_BUS_LOCK(bus); 1538194228Sthompsa usbd_transfer_done(xfer, USB_ERR_STALLED); 1539191494Sthompsa USB_BUS_UNLOCK(bus); 1540184610Salfred return; 1541184610Salfred } 1542184610Salfred } 1543184610Salfred /* 1544184610Salfred * Setup filtered version of some transfer flags, 1545184610Salfred * in case of data read direction 1546184610Salfred */ 1547184610Salfred if (USB_GET_DATA_ISREAD(xfer)) { 1548184610Salfred 1549190184Sthompsa if (xfer->flags.short_frames_ok) { 1550190184Sthompsa xfer->flags_int.short_xfer_ok = 1; 1551190184Sthompsa xfer->flags_int.short_frames_ok = 1; 1552190184Sthompsa } else if (xfer->flags.short_xfer_ok) { 1553190184Sthompsa xfer->flags_int.short_xfer_ok = 1; 1554184610Salfred 1555190184Sthompsa /* check for control transfer */ 1556190184Sthompsa if (xfer->flags_int.control_xfr) { 1557190184Sthompsa /* 1558190184Sthompsa * 1) Control transfers do not support 1559190184Sthompsa * reception of multiple short USB 1560190184Sthompsa * frames in host mode and device side 1561190184Sthompsa * mode, with exception of: 1562190184Sthompsa * 1563190184Sthompsa * 2) Due to sometimes buggy device 1564190184Sthompsa * side firmware we need to do a 1565190184Sthompsa * STATUS stage in case of short 1566190184Sthompsa * control transfers in USB host mode. 1567190184Sthompsa * The STATUS stage then becomes the 1568190184Sthompsa * "alt_next" to the DATA stage. 1569190184Sthompsa */ 1570184610Salfred xfer->flags_int.short_frames_ok = 1; 1571184610Salfred } 1572184610Salfred } 1573184610Salfred } 1574184610Salfred /* 1575184610Salfred * Check if BUS-DMA support is enabled and try to load virtual 1576184610Salfred * buffers into DMA, if any: 1577184610Salfred */ 1578190180Sthompsa#if USB_HAVE_BUSDMA 1579184610Salfred if (xfer->flags_int.bdma_enable) { 1580184610Salfred /* insert the USB transfer last in the BUS-DMA queue */ 1581194228Sthompsa usb_command_wrapper(&xfer->xroot->dma_q, xfer); 1582184610Salfred return; 1583184610Salfred } 1584190180Sthompsa#endif 1585184610Salfred /* 1586184610Salfred * Enter the USB transfer into the Host Controller or 1587184610Salfred * Device Controller schedule: 1588184610Salfred */ 1589194228Sthompsa usbd_pipe_enter(xfer); 1590184610Salfred} 1591184610Salfred 1592184610Salfred/*------------------------------------------------------------------------* 1593194228Sthompsa * usbd_pipe_enter - factored out code 1594184610Salfred *------------------------------------------------------------------------*/ 1595184610Salfredvoid 1596194228Sthompsausbd_pipe_enter(struct usb_xfer *xfer) 1597184610Salfred{ 1598193644Sthompsa struct usb_endpoint *ep; 1599184610Salfred 1600184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1601184610Salfred 1602187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1603184610Salfred 1604193644Sthompsa ep = xfer->endpoint; 1605184610Salfred 1606184610Salfred DPRINTF("enter\n"); 1607184610Salfred 1608184610Salfred /* enter the transfer */ 1609193644Sthompsa (ep->methods->enter) (xfer); 1610184610Salfred 1611190738Sthompsa xfer->flags_int.can_cancel_immed = 1; 1612190738Sthompsa 1613190738Sthompsa /* check for transfer error */ 1614190738Sthompsa if (xfer->error) { 1615190738Sthompsa /* some error has happened */ 1616194228Sthompsa usbd_transfer_done(xfer, 0); 1617190738Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1618190738Sthompsa return; 1619184610Salfred } 1620184610Salfred 1621184610Salfred /* start the transfer */ 1622194228Sthompsa usb_command_wrapper(&ep->endpoint_q, xfer); 1623187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1624184610Salfred} 1625184610Salfred 1626184610Salfred/*------------------------------------------------------------------------* 1627194228Sthompsa * usbd_transfer_start - start an USB transfer 1628184610Salfred * 1629184610Salfred * NOTE: Calling this function more than one time will only 1630184610Salfred * result in a single transfer start, until the USB transfer 1631184610Salfred * completes. 1632184610Salfred *------------------------------------------------------------------------*/ 1633184610Salfredvoid 1634194228Sthompsausbd_transfer_start(struct usb_xfer *xfer) 1635184610Salfred{ 1636184610Salfred if (xfer == NULL) { 1637184610Salfred /* transfer is gone */ 1638184610Salfred return; 1639184610Salfred } 1640184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1641184610Salfred 1642184610Salfred /* mark the USB transfer started */ 1643184610Salfred 1644184610Salfred if (!xfer->flags_int.started) { 1645197562Sthompsa /* lock the BUS lock to avoid races updating flags_int */ 1646197562Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1647184610Salfred xfer->flags_int.started = 1; 1648197562Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1649184610Salfred } 1650184610Salfred /* check if the USB transfer callback is already transferring */ 1651184610Salfred 1652184610Salfred if (xfer->flags_int.transferring) { 1653184610Salfred return; 1654184610Salfred } 1655187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1656184610Salfred /* call the USB transfer callback */ 1657194228Sthompsa usbd_callback_ss_done_defer(xfer); 1658187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1659184610Salfred} 1660184610Salfred 1661184610Salfred/*------------------------------------------------------------------------* 1662194228Sthompsa * usbd_transfer_stop - stop an USB transfer 1663184610Salfred * 1664184610Salfred * NOTE: Calling this function more than one time will only 1665184610Salfred * result in a single transfer stop. 1666184610Salfred * NOTE: When this function returns it is not safe to free nor 1667194228Sthompsa * reuse any DMA buffers. See "usbd_transfer_drain()". 1668184610Salfred *------------------------------------------------------------------------*/ 1669184610Salfredvoid 1670194228Sthompsausbd_transfer_stop(struct usb_xfer *xfer) 1671184610Salfred{ 1672193644Sthompsa struct usb_endpoint *ep; 1673184610Salfred 1674184610Salfred if (xfer == NULL) { 1675184610Salfred /* transfer is gone */ 1676184610Salfred return; 1677184610Salfred } 1678184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1679184610Salfred 1680184610Salfred /* check if the USB transfer was ever opened */ 1681184610Salfred 1682184610Salfred if (!xfer->flags_int.open) { 1683197562Sthompsa if (xfer->flags_int.started) { 1684197562Sthompsa /* nothing to do except clearing the "started" flag */ 1685197562Sthompsa /* lock the BUS lock to avoid races updating flags_int */ 1686197562Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1687197562Sthompsa xfer->flags_int.started = 0; 1688197562Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1689197562Sthompsa } 1690184610Salfred return; 1691184610Salfred } 1692184610Salfred /* try to stop the current USB transfer */ 1693184610Salfred 1694187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1695197562Sthompsa /* override any previous error */ 1696197562Sthompsa xfer->error = USB_ERR_CANCELLED; 1697197562Sthompsa 1698184610Salfred /* 1699184610Salfred * Clear "open" and "started" when both private and USB lock 1700184610Salfred * is locked so that we don't get a race updating "flags_int" 1701184610Salfred */ 1702184610Salfred xfer->flags_int.open = 0; 1703184610Salfred xfer->flags_int.started = 0; 1704184610Salfred 1705184610Salfred /* 1706184610Salfred * Check if we can cancel the USB transfer immediately. 1707184610Salfred */ 1708184610Salfred if (xfer->flags_int.transferring) { 1709184610Salfred if (xfer->flags_int.can_cancel_immed && 1710184610Salfred (!xfer->flags_int.did_close)) { 1711184610Salfred DPRINTF("close\n"); 1712184610Salfred /* 1713184610Salfred * The following will lead to an USB_ERR_CANCELLED 1714184610Salfred * error code being passed to the USB callback. 1715184610Salfred */ 1716193644Sthompsa (xfer->endpoint->methods->close) (xfer); 1717184610Salfred /* only close once */ 1718184610Salfred xfer->flags_int.did_close = 1; 1719184610Salfred } else { 1720184610Salfred /* need to wait for the next done callback */ 1721184610Salfred } 1722184610Salfred } else { 1723184610Salfred DPRINTF("close\n"); 1724184610Salfred 1725184610Salfred /* close here and now */ 1726193644Sthompsa (xfer->endpoint->methods->close) (xfer); 1727184610Salfred 1728184610Salfred /* 1729184610Salfred * Any additional DMA delay is done by 1730194228Sthompsa * "usbd_transfer_unsetup()". 1731184610Salfred */ 1732184610Salfred 1733184610Salfred /* 1734184610Salfred * Special case. Check if we need to restart a blocked 1735193644Sthompsa * endpoint. 1736184610Salfred */ 1737193644Sthompsa ep = xfer->endpoint; 1738184610Salfred 1739184610Salfred /* 1740184610Salfred * If the current USB transfer is completing we need 1741184610Salfred * to start the next one: 1742184610Salfred */ 1743193644Sthompsa if (ep->endpoint_q.curr == xfer) { 1744194228Sthompsa usb_command_wrapper(&ep->endpoint_q, NULL); 1745184610Salfred } 1746184610Salfred } 1747184610Salfred 1748187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1749184610Salfred} 1750184610Salfred 1751184610Salfred/*------------------------------------------------------------------------* 1752194228Sthompsa * usbd_transfer_pending 1753184610Salfred * 1754184610Salfred * This function will check if an USB transfer is pending which is a 1755184610Salfred * little bit complicated! 1756184610Salfred * Return values: 1757184610Salfred * 0: Not pending 1758184610Salfred * 1: Pending: The USB transfer will receive a callback in the future. 1759184610Salfred *------------------------------------------------------------------------*/ 1760184610Salfreduint8_t 1761194228Sthompsausbd_transfer_pending(struct usb_xfer *xfer) 1762184610Salfred{ 1763192984Sthompsa struct usb_xfer_root *info; 1764192984Sthompsa struct usb_xfer_queue *pq; 1765184610Salfred 1766188600Sthompsa if (xfer == NULL) { 1767188600Sthompsa /* transfer is gone */ 1768188600Sthompsa return (0); 1769188600Sthompsa } 1770184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1771184610Salfred 1772184610Salfred if (xfer->flags_int.transferring) { 1773184610Salfred /* trivial case */ 1774184610Salfred return (1); 1775184610Salfred } 1776187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1777184610Salfred if (xfer->wait_queue) { 1778184610Salfred /* we are waiting on a queue somewhere */ 1779187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1780184610Salfred return (1); 1781184610Salfred } 1782187173Sthompsa info = xfer->xroot; 1783184610Salfred pq = &info->done_q; 1784184610Salfred 1785184610Salfred if (pq->curr == xfer) { 1786184610Salfred /* we are currently scheduled for callback */ 1787187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1788184610Salfred return (1); 1789184610Salfred } 1790184610Salfred /* we are not pending */ 1791187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1792184610Salfred return (0); 1793184610Salfred} 1794184610Salfred 1795184610Salfred/*------------------------------------------------------------------------* 1796194228Sthompsa * usbd_transfer_drain 1797184610Salfred * 1798184610Salfred * This function will stop the USB transfer and wait for any 1799184610Salfred * additional BUS-DMA and HW-DMA operations to complete. Buffers that 1800184610Salfred * are loaded into DMA can safely be freed or reused after that this 1801184610Salfred * function has returned. 1802184610Salfred *------------------------------------------------------------------------*/ 1803184610Salfredvoid 1804194228Sthompsausbd_transfer_drain(struct usb_xfer *xfer) 1805184610Salfred{ 1806184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1807194228Sthompsa "usbd_transfer_drain can sleep!"); 1808184610Salfred 1809184610Salfred if (xfer == NULL) { 1810184610Salfred /* transfer is gone */ 1811184610Salfred return; 1812184610Salfred } 1813187173Sthompsa if (xfer->xroot->xfer_mtx != &Giant) { 1814184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED); 1815184610Salfred } 1816184824Sthompsa USB_XFER_LOCK(xfer); 1817184610Salfred 1818194228Sthompsa usbd_transfer_stop(xfer); 1819184610Salfred 1820198775Sthompsa while (usbd_transfer_pending(xfer) || 1821198775Sthompsa xfer->flags_int.doing_callback) { 1822198775Sthompsa 1823198775Sthompsa /* 1824198775Sthompsa * It is allowed that the callback can drop its 1825198775Sthompsa * transfer mutex. In that case checking only 1826198775Sthompsa * "usbd_transfer_pending()" is not enough to tell if 1827198775Sthompsa * the USB transfer is fully drained. We also need to 1828198775Sthompsa * check the internal "doing_callback" flag. 1829198775Sthompsa */ 1830184610Salfred xfer->flags_int.draining = 1; 1831198775Sthompsa 1832184610Salfred /* 1833184610Salfred * Wait until the current outstanding USB 1834184610Salfred * transfer is complete ! 1835184610Salfred */ 1836194227Sthompsa cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx); 1837184610Salfred } 1838184824Sthompsa USB_XFER_UNLOCK(xfer); 1839184610Salfred} 1840184610Salfred 1841194677Sthompsastruct usb_page_cache * 1842194677Sthompsausbd_xfer_get_frame(struct usb_xfer *xfer, usb_frcount_t frindex) 1843194677Sthompsa{ 1844194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1845194677Sthompsa 1846194677Sthompsa return (&xfer->frbuffers[frindex]); 1847194677Sthompsa} 1848194677Sthompsa 1849199059Sthompsa/*------------------------------------------------------------------------* 1850199059Sthompsa * usbd_xfer_get_fps_shift 1851199059Sthompsa * 1852199059Sthompsa * The following function is only useful for isochronous transfers. It 1853199059Sthompsa * returns how many times the frame execution rate has been shifted 1854199059Sthompsa * down. 1855199059Sthompsa * 1856199059Sthompsa * Return value: 1857199059Sthompsa * Success: 0..3 1858199059Sthompsa * Failure: 0 1859199059Sthompsa *------------------------------------------------------------------------*/ 1860199059Sthompsauint8_t 1861199059Sthompsausbd_xfer_get_fps_shift(struct usb_xfer *xfer) 1862199059Sthompsa{ 1863199059Sthompsa return (xfer->fps_shift); 1864199059Sthompsa} 1865199059Sthompsa 1866194677Sthompsausb_frlength_t 1867194682Sthompsausbd_xfer_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex) 1868194677Sthompsa{ 1869194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1870194677Sthompsa 1871194677Sthompsa return (xfer->frlengths[frindex]); 1872194677Sthompsa} 1873194677Sthompsa 1874184610Salfred/*------------------------------------------------------------------------* 1875194677Sthompsa * usbd_xfer_set_frame_data 1876184610Salfred * 1877184610Salfred * This function sets the pointer of the buffer that should 1878184610Salfred * loaded directly into DMA for the given USB frame. Passing "ptr" 1879184610Salfred * equal to NULL while the corresponding "frlength" is greater 1880184610Salfred * than zero gives undefined results! 1881184610Salfred *------------------------------------------------------------------------*/ 1882184610Salfredvoid 1883194677Sthompsausbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, 1884194677Sthompsa void *ptr, usb_frlength_t len) 1885184610Salfred{ 1886194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1887194677Sthompsa 1888184610Salfred /* set virtual address to load and length */ 1889184610Salfred xfer->frbuffers[frindex].buffer = ptr; 1890194677Sthompsa usbd_xfer_set_frame_len(xfer, frindex, len); 1891184610Salfred} 1892184610Salfred 1893194677Sthompsavoid 1894194682Sthompsausbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, 1895194677Sthompsa void **ptr, int *len) 1896194677Sthompsa{ 1897194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1898194677Sthompsa 1899194677Sthompsa if (ptr != NULL) 1900194677Sthompsa *ptr = xfer->frbuffers[frindex].buffer; 1901194677Sthompsa if (len != NULL) 1902194677Sthompsa *len = xfer->frlengths[frindex]; 1903194677Sthompsa} 1904194677Sthompsa 1905194677Sthompsavoid 1906194677Sthompsausbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen, int *aframes, 1907194677Sthompsa int *nframes) 1908194677Sthompsa{ 1909194677Sthompsa if (actlen != NULL) 1910194677Sthompsa *actlen = xfer->actlen; 1911194677Sthompsa if (sumlen != NULL) 1912194677Sthompsa *sumlen = xfer->sumlen; 1913194677Sthompsa if (aframes != NULL) 1914194677Sthompsa *aframes = xfer->aframes; 1915194677Sthompsa if (nframes != NULL) 1916194677Sthompsa *nframes = xfer->nframes; 1917194677Sthompsa} 1918194677Sthompsa 1919184610Salfred/*------------------------------------------------------------------------* 1920194677Sthompsa * usbd_xfer_set_frame_offset 1921184610Salfred * 1922184610Salfred * This function sets the frame data buffer offset relative to the beginning 1923184610Salfred * of the USB DMA buffer allocated for this USB transfer. 1924184610Salfred *------------------------------------------------------------------------*/ 1925184610Salfredvoid 1926194677Sthompsausbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset, 1927193045Sthompsa usb_frcount_t frindex) 1928184610Salfred{ 1929194677Sthompsa KASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame " 1930199816Sthompsa "when the USB buffer is external\n")); 1931194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1932184610Salfred 1933184610Salfred /* set virtual address to load */ 1934184610Salfred xfer->frbuffers[frindex].buffer = 1935184610Salfred USB_ADD_BYTES(xfer->local_buffer, offset); 1936184610Salfred} 1937184610Salfred 1938194677Sthompsavoid 1939194677Sthompsausbd_xfer_set_interval(struct usb_xfer *xfer, int i) 1940194677Sthompsa{ 1941194677Sthompsa xfer->interval = i; 1942194677Sthompsa} 1943194677Sthompsa 1944194677Sthompsavoid 1945194677Sthompsausbd_xfer_set_timeout(struct usb_xfer *xfer, int t) 1946194677Sthompsa{ 1947194677Sthompsa xfer->timeout = t; 1948194677Sthompsa} 1949194677Sthompsa 1950194677Sthompsavoid 1951194677Sthompsausbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n) 1952194677Sthompsa{ 1953194677Sthompsa xfer->nframes = n; 1954194677Sthompsa} 1955194677Sthompsa 1956194677Sthompsausb_frcount_t 1957194677Sthompsausbd_xfer_max_frames(struct usb_xfer *xfer) 1958194677Sthompsa{ 1959194677Sthompsa return (xfer->max_frame_count); 1960194677Sthompsa} 1961194677Sthompsa 1962194677Sthompsausb_frlength_t 1963194677Sthompsausbd_xfer_max_len(struct usb_xfer *xfer) 1964194677Sthompsa{ 1965194677Sthompsa return (xfer->max_data_length); 1966194677Sthompsa} 1967194677Sthompsa 1968194677Sthompsausb_frlength_t 1969194677Sthompsausbd_xfer_max_framelen(struct usb_xfer *xfer) 1970194677Sthompsa{ 1971194677Sthompsa return (xfer->max_frame_size); 1972194677Sthompsa} 1973194677Sthompsa 1974194677Sthompsavoid 1975194677Sthompsausbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex, 1976194677Sthompsa usb_frlength_t len) 1977194677Sthompsa{ 1978194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1979194677Sthompsa 1980194677Sthompsa xfer->frlengths[frindex] = len; 1981194677Sthompsa} 1982194677Sthompsa 1983184610Salfred/*------------------------------------------------------------------------* 1984194228Sthompsa * usb_callback_proc - factored out code 1985184610Salfred * 1986184610Salfred * This function performs USB callbacks. 1987184610Salfred *------------------------------------------------------------------------*/ 1988184610Salfredstatic void 1989194228Sthompsausb_callback_proc(struct usb_proc_msg *_pm) 1990184610Salfred{ 1991192984Sthompsa struct usb_done_msg *pm = (void *)_pm; 1992192984Sthompsa struct usb_xfer_root *info = pm->xroot; 1993184610Salfred 1994184610Salfred /* Change locking order */ 1995184824Sthompsa USB_BUS_UNLOCK(info->bus); 1996184610Salfred 1997184610Salfred /* 1998184610Salfred * We exploit the fact that the mutex is the same for all 1999184610Salfred * callbacks that will be called from this thread: 2000184610Salfred */ 2001187173Sthompsa mtx_lock(info->xfer_mtx); 2002184824Sthompsa USB_BUS_LOCK(info->bus); 2003184610Salfred 2004184610Salfred /* Continue where we lost track */ 2005194228Sthompsa usb_command_wrapper(&info->done_q, 2006184610Salfred info->done_q.curr); 2007184610Salfred 2008187173Sthompsa mtx_unlock(info->xfer_mtx); 2009184610Salfred} 2010184610Salfred 2011184610Salfred/*------------------------------------------------------------------------* 2012194228Sthompsa * usbd_callback_ss_done_defer 2013184610Salfred * 2014184610Salfred * This function will defer the start, stop and done callback to the 2015184610Salfred * correct thread. 2016184610Salfred *------------------------------------------------------------------------*/ 2017184610Salfredstatic void 2018194228Sthompsausbd_callback_ss_done_defer(struct usb_xfer *xfer) 2019184610Salfred{ 2020192984Sthompsa struct usb_xfer_root *info = xfer->xroot; 2021192984Sthompsa struct usb_xfer_queue *pq = &info->done_q; 2022184610Salfred 2023187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2024184824Sthompsa 2025184610Salfred if (pq->curr != xfer) { 2026194228Sthompsa usbd_transfer_enqueue(pq, xfer); 2027184610Salfred } 2028184610Salfred if (!pq->recurse_1) { 2029184610Salfred 2030184610Salfred /* 2031184610Salfred * We have to postpone the callback due to the fact we 2032184610Salfred * will have a Lock Order Reversal, LOR, if we try to 2033184610Salfred * proceed ! 2034184610Salfred */ 2035194228Sthompsa if (usb_proc_msignal(info->done_p, 2036184610Salfred &info->done_m[0], &info->done_m[1])) { 2037184610Salfred /* ignore */ 2038184610Salfred } 2039184610Salfred } else { 2040184610Salfred /* clear second recurse flag */ 2041184610Salfred pq->recurse_2 = 0; 2042184610Salfred } 2043184610Salfred return; 2044184610Salfred 2045184610Salfred} 2046184610Salfred 2047184610Salfred/*------------------------------------------------------------------------* 2048194228Sthompsa * usbd_callback_wrapper 2049184610Salfred * 2050184610Salfred * This is a wrapper for USB callbacks. This wrapper does some 2051184610Salfred * auto-magic things like figuring out if we can call the callback 2052184610Salfred * directly from the current context or if we need to wakeup the 2053184610Salfred * interrupt process. 2054184610Salfred *------------------------------------------------------------------------*/ 2055184610Salfredstatic void 2056194228Sthompsausbd_callback_wrapper(struct usb_xfer_queue *pq) 2057184610Salfred{ 2058192984Sthompsa struct usb_xfer *xfer = pq->curr; 2059192984Sthompsa struct usb_xfer_root *info = xfer->xroot; 2060184610Salfred 2061190738Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 2062190738Sthompsa if (!mtx_owned(info->xfer_mtx)) { 2063184610Salfred /* 2064184610Salfred * Cases that end up here: 2065184610Salfred * 2066184610Salfred * 5) HW interrupt done callback or other source. 2067184610Salfred */ 2068184610Salfred DPRINTFN(3, "case 5\n"); 2069184610Salfred 2070184610Salfred /* 2071184610Salfred * We have to postpone the callback due to the fact we 2072184610Salfred * will have a Lock Order Reversal, LOR, if we try to 2073184610Salfred * proceed ! 2074184610Salfred */ 2075194228Sthompsa if (usb_proc_msignal(info->done_p, 2076184610Salfred &info->done_m[0], &info->done_m[1])) { 2077184610Salfred /* ignore */ 2078184610Salfred } 2079184610Salfred return; 2080184610Salfred } 2081184610Salfred /* 2082184610Salfred * Cases that end up here: 2083184610Salfred * 2084184610Salfred * 1) We are starting a transfer 2085184610Salfred * 2) We are prematurely calling back a transfer 2086184610Salfred * 3) We are stopping a transfer 2087184610Salfred * 4) We are doing an ordinary callback 2088184610Salfred */ 2089184610Salfred DPRINTFN(3, "case 1-4\n"); 2090184610Salfred /* get next USB transfer in the queue */ 2091184610Salfred info->done_q.curr = NULL; 2092184610Salfred 2093198775Sthompsa /* set flag in case of drain */ 2094198775Sthompsa xfer->flags_int.doing_callback = 1; 2095198775Sthompsa 2096190738Sthompsa USB_BUS_UNLOCK(info->bus); 2097190738Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_NOTOWNED); 2098184610Salfred 2099184610Salfred /* set correct USB state for callback */ 2100184610Salfred if (!xfer->flags_int.transferring) { 2101194228Sthompsa xfer->usb_state = USB_ST_SETUP; 2102184610Salfred if (!xfer->flags_int.started) { 2103184610Salfred /* we got stopped before we even got started */ 2104190738Sthompsa USB_BUS_LOCK(info->bus); 2105184610Salfred goto done; 2106184610Salfred } 2107184610Salfred } else { 2108184610Salfred 2109194228Sthompsa if (usbd_callback_wrapper_sub(xfer)) { 2110184610Salfred /* the callback has been deferred */ 2111190738Sthompsa USB_BUS_LOCK(info->bus); 2112184610Salfred goto done; 2113184610Salfred } 2114190734Sthompsa#if USB_HAVE_POWERD 2115186730Salfred /* decrement power reference */ 2116194228Sthompsa usbd_transfer_power_ref(xfer, -1); 2117190734Sthompsa#endif 2118184610Salfred xfer->flags_int.transferring = 0; 2119184610Salfred 2120184610Salfred if (xfer->error) { 2121194228Sthompsa xfer->usb_state = USB_ST_ERROR; 2122184610Salfred } else { 2123184610Salfred /* set transferred state */ 2124194228Sthompsa xfer->usb_state = USB_ST_TRANSFERRED; 2125190180Sthompsa#if USB_HAVE_BUSDMA 2126184610Salfred /* sync DMA memory, if any */ 2127184610Salfred if (xfer->flags_int.bdma_enable && 2128184610Salfred (!xfer->flags_int.bdma_no_post_sync)) { 2129194228Sthompsa usb_bdma_post_sync(xfer); 2130184610Salfred } 2131190180Sthompsa#endif 2132184610Salfred } 2133184610Salfred } 2134184610Salfred 2135184610Salfred /* call processing routine */ 2136194677Sthompsa (xfer->callback) (xfer, xfer->error); 2137184610Salfred 2138184610Salfred /* pickup the USB mutex again */ 2139190738Sthompsa USB_BUS_LOCK(info->bus); 2140184610Salfred 2141184610Salfred /* 2142184610Salfred * Check if we got started after that we got cancelled, but 2143187166Sthompsa * before we managed to do the callback. 2144184610Salfred */ 2145184610Salfred if ((!xfer->flags_int.open) && 2146184610Salfred (xfer->flags_int.started) && 2147194228Sthompsa (xfer->usb_state == USB_ST_ERROR)) { 2148198775Sthompsa /* clear flag in case of drain */ 2149198775Sthompsa xfer->flags_int.doing_callback = 0; 2150184610Salfred /* try to loop, but not recursivly */ 2151194228Sthompsa usb_command_wrapper(&info->done_q, xfer); 2152184610Salfred return; 2153187166Sthompsa } 2154187166Sthompsa 2155187166Sthompsadone: 2156198775Sthompsa /* clear flag in case of drain */ 2157198775Sthompsa xfer->flags_int.doing_callback = 0; 2158198775Sthompsa 2159187166Sthompsa /* 2160187166Sthompsa * Check if we are draining. 2161187166Sthompsa */ 2162187166Sthompsa if (xfer->flags_int.draining && 2163184610Salfred (!xfer->flags_int.transferring)) { 2164194228Sthompsa /* "usbd_transfer_drain()" is waiting for end of transfer */ 2165184610Salfred xfer->flags_int.draining = 0; 2166194227Sthompsa cv_broadcast(&info->cv_drain); 2167184610Salfred } 2168187166Sthompsa 2169184610Salfred /* do the next callback, if any */ 2170194228Sthompsa usb_command_wrapper(&info->done_q, 2171184610Salfred info->done_q.curr); 2172184610Salfred} 2173184610Salfred 2174184610Salfred/*------------------------------------------------------------------------* 2175194228Sthompsa * usb_dma_delay_done_cb 2176184610Salfred * 2177184610Salfred * This function is called when the DMA delay has been exectuded, and 2178184610Salfred * will make sure that the callback is called to complete the USB 2179184610Salfred * transfer. This code path is ususally only used when there is an USB 2180184610Salfred * error like USB_ERR_CANCELLED. 2181184610Salfred *------------------------------------------------------------------------*/ 2182184610Salfredstatic void 2183194228Sthompsausb_dma_delay_done_cb(void *arg) 2184184610Salfred{ 2185192984Sthompsa struct usb_xfer *xfer = arg; 2186184610Salfred 2187187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2188184610Salfred 2189184610Salfred DPRINTFN(3, "Completed %p\n", xfer); 2190184610Salfred 2191184610Salfred /* queue callback for execution, again */ 2192194228Sthompsa usbd_transfer_done(xfer, 0); 2193184610Salfred} 2194184610Salfred 2195184610Salfred/*------------------------------------------------------------------------* 2196194228Sthompsa * usbd_transfer_dequeue 2197184610Salfred * 2198184610Salfred * - This function is used to remove an USB transfer from a USB 2199184610Salfred * transfer queue. 2200184610Salfred * 2201184610Salfred * - This function can be called multiple times in a row. 2202184610Salfred *------------------------------------------------------------------------*/ 2203184610Salfredvoid 2204194228Sthompsausbd_transfer_dequeue(struct usb_xfer *xfer) 2205184610Salfred{ 2206192984Sthompsa struct usb_xfer_queue *pq; 2207184610Salfred 2208184610Salfred pq = xfer->wait_queue; 2209184610Salfred if (pq) { 2210184610Salfred TAILQ_REMOVE(&pq->head, xfer, wait_entry); 2211184610Salfred xfer->wait_queue = NULL; 2212184610Salfred } 2213184610Salfred} 2214184610Salfred 2215184610Salfred/*------------------------------------------------------------------------* 2216194228Sthompsa * usbd_transfer_enqueue 2217184610Salfred * 2218184610Salfred * - This function is used to insert an USB transfer into a USB * 2219184610Salfred * transfer queue. 2220184610Salfred * 2221184610Salfred * - This function can be called multiple times in a row. 2222184610Salfred *------------------------------------------------------------------------*/ 2223184610Salfredvoid 2224194228Sthompsausbd_transfer_enqueue(struct usb_xfer_queue *pq, struct usb_xfer *xfer) 2225184610Salfred{ 2226184610Salfred /* 2227184610Salfred * Insert the USB transfer into the queue, if it is not 2228184610Salfred * already on a USB transfer queue: 2229184610Salfred */ 2230184610Salfred if (xfer->wait_queue == NULL) { 2231184610Salfred xfer->wait_queue = pq; 2232184610Salfred TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry); 2233184610Salfred } 2234184610Salfred} 2235184610Salfred 2236184610Salfred/*------------------------------------------------------------------------* 2237194228Sthompsa * usbd_transfer_done 2238184610Salfred * 2239184610Salfred * - This function is used to remove an USB transfer from the busdma, 2240184610Salfred * pipe or interrupt queue. 2241184610Salfred * 2242184610Salfred * - This function is used to queue the USB transfer on the done 2243184610Salfred * queue. 2244184610Salfred * 2245184610Salfred * - This function is used to stop any USB transfer timeouts. 2246184610Salfred *------------------------------------------------------------------------*/ 2247184610Salfredvoid 2248194228Sthompsausbd_transfer_done(struct usb_xfer *xfer, usb_error_t error) 2249184610Salfred{ 2250187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2251184610Salfred 2252194228Sthompsa DPRINTF("err=%s\n", usbd_errstr(error)); 2253184610Salfred 2254184610Salfred /* 2255184610Salfred * If we are not transferring then just return. 2256184610Salfred * This can happen during transfer cancel. 2257184610Salfred */ 2258184610Salfred if (!xfer->flags_int.transferring) { 2259184610Salfred DPRINTF("not transferring\n"); 2260197562Sthompsa /* end of control transfer, if any */ 2261197562Sthompsa xfer->flags_int.control_act = 0; 2262184610Salfred return; 2263184610Salfred } 2264184610Salfred /* only set transfer error if not already set */ 2265184610Salfred if (!xfer->error) { 2266184610Salfred xfer->error = error; 2267184610Salfred } 2268184610Salfred /* stop any callouts */ 2269194228Sthompsa usb_callout_stop(&xfer->timeout_handle); 2270184610Salfred 2271184610Salfred /* 2272184610Salfred * If we are waiting on a queue, just remove the USB transfer 2273184610Salfred * from the queue, if any. We should have the required locks 2274184610Salfred * locked to do the remove when this function is called. 2275184610Salfred */ 2276194228Sthompsa usbd_transfer_dequeue(xfer); 2277184610Salfred 2278190180Sthompsa#if USB_HAVE_BUSDMA 2279187173Sthompsa if (mtx_owned(xfer->xroot->xfer_mtx)) { 2280192984Sthompsa struct usb_xfer_queue *pq; 2281190180Sthompsa 2282184610Salfred /* 2283184610Salfred * If the private USB lock is not locked, then we assume 2284184610Salfred * that the BUS-DMA load stage has been passed: 2285184610Salfred */ 2286187173Sthompsa pq = &xfer->xroot->dma_q; 2287184610Salfred 2288184610Salfred if (pq->curr == xfer) { 2289184610Salfred /* start the next BUS-DMA load, if any */ 2290194228Sthompsa usb_command_wrapper(pq, NULL); 2291184610Salfred } 2292184610Salfred } 2293190180Sthompsa#endif 2294184610Salfred /* keep some statistics */ 2295184610Salfred if (xfer->error) { 2296187173Sthompsa xfer->xroot->bus->stats_err.uds_requests 2297193644Sthompsa [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++; 2298184610Salfred } else { 2299187173Sthompsa xfer->xroot->bus->stats_ok.uds_requests 2300193644Sthompsa [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++; 2301184610Salfred } 2302184610Salfred 2303184610Salfred /* call the USB transfer callback */ 2304194228Sthompsa usbd_callback_ss_done_defer(xfer); 2305184610Salfred} 2306184610Salfred 2307184610Salfred/*------------------------------------------------------------------------* 2308194228Sthompsa * usbd_transfer_start_cb 2309184610Salfred * 2310184610Salfred * This function is called to start the USB transfer when 2311184610Salfred * "xfer->interval" is greater than zero, and and the endpoint type is 2312184610Salfred * BULK or CONTROL. 2313184610Salfred *------------------------------------------------------------------------*/ 2314184610Salfredstatic void 2315194228Sthompsausbd_transfer_start_cb(void *arg) 2316184610Salfred{ 2317192984Sthompsa struct usb_xfer *xfer = arg; 2318193644Sthompsa struct usb_endpoint *ep = xfer->endpoint; 2319184610Salfred 2320187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2321184610Salfred 2322184610Salfred DPRINTF("start\n"); 2323184610Salfred 2324184610Salfred /* start the transfer */ 2325193644Sthompsa (ep->methods->start) (xfer); 2326184610Salfred 2327190738Sthompsa xfer->flags_int.can_cancel_immed = 1; 2328190738Sthompsa 2329190738Sthompsa /* check for error */ 2330190738Sthompsa if (xfer->error) { 2331190738Sthompsa /* some error has happened */ 2332194228Sthompsa usbd_transfer_done(xfer, 0); 2333184610Salfred } 2334184610Salfred} 2335184610Salfred 2336184610Salfred/*------------------------------------------------------------------------* 2337194677Sthompsa * usbd_xfer_set_stall 2338184610Salfred * 2339184610Salfred * This function is used to set the stall flag outside the 2340184610Salfred * callback. This function is NULL safe. 2341184610Salfred *------------------------------------------------------------------------*/ 2342184610Salfredvoid 2343194677Sthompsausbd_xfer_set_stall(struct usb_xfer *xfer) 2344184610Salfred{ 2345184610Salfred if (xfer == NULL) { 2346184610Salfred /* tearing down */ 2347184610Salfred return; 2348184610Salfred } 2349184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2350184610Salfred 2351184610Salfred /* avoid any races by locking the USB mutex */ 2352187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2353184610Salfred xfer->flags.stall_pipe = 1; 2354187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2355184610Salfred} 2356184610Salfred 2357194677Sthompsaint 2358194677Sthompsausbd_xfer_is_stalled(struct usb_xfer *xfer) 2359194677Sthompsa{ 2360194677Sthompsa return (xfer->endpoint->is_stalled); 2361194677Sthompsa} 2362194677Sthompsa 2363184610Salfred/*------------------------------------------------------------------------* 2364194228Sthompsa * usbd_transfer_clear_stall 2365184610Salfred * 2366184610Salfred * This function is used to clear the stall flag outside the 2367184610Salfred * callback. This function is NULL safe. 2368184610Salfred *------------------------------------------------------------------------*/ 2369184610Salfredvoid 2370194228Sthompsausbd_transfer_clear_stall(struct usb_xfer *xfer) 2371184610Salfred{ 2372184610Salfred if (xfer == NULL) { 2373184610Salfred /* tearing down */ 2374184610Salfred return; 2375184610Salfred } 2376184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2377184610Salfred 2378184610Salfred /* avoid any races by locking the USB mutex */ 2379187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2380184610Salfred 2381184610Salfred xfer->flags.stall_pipe = 0; 2382184610Salfred 2383187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2384184610Salfred} 2385184610Salfred 2386184610Salfred/*------------------------------------------------------------------------* 2387194228Sthompsa * usbd_pipe_start 2388184610Salfred * 2389184610Salfred * This function is used to add an USB transfer to the pipe transfer list. 2390184610Salfred *------------------------------------------------------------------------*/ 2391184610Salfredvoid 2392194228Sthompsausbd_pipe_start(struct usb_xfer_queue *pq) 2393184610Salfred{ 2394193644Sthompsa struct usb_endpoint *ep; 2395192984Sthompsa struct usb_xfer *xfer; 2396184610Salfred uint8_t type; 2397184610Salfred 2398184610Salfred xfer = pq->curr; 2399193644Sthompsa ep = xfer->endpoint; 2400184610Salfred 2401187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2402184610Salfred 2403184610Salfred /* 2404193644Sthompsa * If the endpoint is already stalled we do nothing ! 2405184610Salfred */ 2406193644Sthompsa if (ep->is_stalled) { 2407184610Salfred return; 2408184610Salfred } 2409184610Salfred /* 2410193644Sthompsa * Check if we are supposed to stall the endpoint: 2411184610Salfred */ 2412184610Salfred if (xfer->flags.stall_pipe) { 2413205035Sthompsa struct usb_device *udev; 2414205035Sthompsa struct usb_xfer_root *info; 2415205035Sthompsa 2416184610Salfred /* clear stall command */ 2417184610Salfred xfer->flags.stall_pipe = 0; 2418184610Salfred 2419205035Sthompsa /* get pointer to USB device */ 2420205035Sthompsa info = xfer->xroot; 2421205035Sthompsa udev = info->udev; 2422205035Sthompsa 2423184610Salfred /* 2424184610Salfred * Only stall BULK and INTERRUPT endpoints. 2425184610Salfred */ 2426193644Sthompsa type = (ep->edesc->bmAttributes & UE_XFERTYPE); 2427184610Salfred if ((type == UE_BULK) || 2428184610Salfred (type == UE_INTERRUPT)) { 2429195121Sthompsa uint8_t did_stall; 2430184610Salfred 2431195121Sthompsa did_stall = 1; 2432184610Salfred 2433192499Sthompsa if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2434184610Salfred (udev->bus->methods->set_stall) ( 2435195121Sthompsa udev, NULL, ep, &did_stall); 2436207080Sthompsa } else if (udev->ctrl_xfer[1]) { 2437207080Sthompsa info = udev->ctrl_xfer[1]->xroot; 2438195121Sthompsa usb_proc_msignal( 2439187174Sthompsa &info->bus->non_giant_callback_proc, 2440195121Sthompsa &udev->cs_msg[0], &udev->cs_msg[1]); 2441184610Salfred } else { 2442184610Salfred /* should not happen */ 2443199816Sthompsa DPRINTFN(0, "No stall handler\n"); 2444184610Salfred } 2445184610Salfred /* 2446195121Sthompsa * Check if we should stall. Some USB hardware 2447195121Sthompsa * handles set- and clear-stall in hardware. 2448184610Salfred */ 2449195121Sthompsa if (did_stall) { 2450195121Sthompsa /* 2451195121Sthompsa * The transfer will be continued when 2452195121Sthompsa * the clear-stall control endpoint 2453195121Sthompsa * message is received. 2454195121Sthompsa */ 2455195121Sthompsa ep->is_stalled = 1; 2456195121Sthompsa return; 2457195121Sthompsa } 2458205035Sthompsa } else if (type == UE_ISOCHRONOUS) { 2459205035Sthompsa 2460205035Sthompsa /* 2461205035Sthompsa * Make sure any FIFO overflow or other FIFO 2462205035Sthompsa * error conditions go away by resetting the 2463205035Sthompsa * endpoint FIFO through the clear stall 2464205035Sthompsa * method. 2465205035Sthompsa */ 2466205035Sthompsa if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2467205035Sthompsa (udev->bus->methods->clear_stall) (udev, ep); 2468205035Sthompsa } 2469184610Salfred } 2470184610Salfred } 2471184610Salfred /* Set or clear stall complete - special case */ 2472184610Salfred if (xfer->nframes == 0) { 2473184610Salfred /* we are complete */ 2474184610Salfred xfer->aframes = 0; 2475194228Sthompsa usbd_transfer_done(xfer, 0); 2476184610Salfred return; 2477184610Salfred } 2478184610Salfred /* 2479184610Salfred * Handled cases: 2480184610Salfred * 2481184610Salfred * 1) Start the first transfer queued. 2482184610Salfred * 2483184610Salfred * 2) Re-start the current USB transfer. 2484184610Salfred */ 2485184610Salfred /* 2486184610Salfred * Check if there should be any 2487184610Salfred * pre transfer start delay: 2488184610Salfred */ 2489184610Salfred if (xfer->interval > 0) { 2490193644Sthompsa type = (ep->edesc->bmAttributes & UE_XFERTYPE); 2491184610Salfred if ((type == UE_BULK) || 2492184610Salfred (type == UE_CONTROL)) { 2493194228Sthompsa usbd_transfer_timeout_ms(xfer, 2494194228Sthompsa &usbd_transfer_start_cb, 2495184610Salfred xfer->interval); 2496184610Salfred return; 2497184610Salfred } 2498184610Salfred } 2499184610Salfred DPRINTF("start\n"); 2500184610Salfred 2501184610Salfred /* start USB transfer */ 2502193644Sthompsa (ep->methods->start) (xfer); 2503184610Salfred 2504190738Sthompsa xfer->flags_int.can_cancel_immed = 1; 2505190738Sthompsa 2506190738Sthompsa /* check for error */ 2507190738Sthompsa if (xfer->error) { 2508190738Sthompsa /* some error has happened */ 2509194228Sthompsa usbd_transfer_done(xfer, 0); 2510184610Salfred } 2511184610Salfred} 2512184610Salfred 2513184610Salfred/*------------------------------------------------------------------------* 2514194228Sthompsa * usbd_transfer_timeout_ms 2515184610Salfred * 2516184610Salfred * This function is used to setup a timeout on the given USB 2517184610Salfred * transfer. If the timeout has been deferred the callback given by 2518184610Salfred * "cb" will get called after "ms" milliseconds. 2519184610Salfred *------------------------------------------------------------------------*/ 2520184610Salfredvoid 2521194228Sthompsausbd_transfer_timeout_ms(struct usb_xfer *xfer, 2522193045Sthompsa void (*cb) (void *arg), usb_timeout_t ms) 2523184610Salfred{ 2524187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2525184610Salfred 2526184610Salfred /* defer delay */ 2527194228Sthompsa usb_callout_reset(&xfer->timeout_handle, 2528184610Salfred USB_MS_TO_TICKS(ms), cb, xfer); 2529184610Salfred} 2530184610Salfred 2531184610Salfred/*------------------------------------------------------------------------* 2532194228Sthompsa * usbd_callback_wrapper_sub 2533184610Salfred * 2534184610Salfred * - This function will update variables in an USB transfer after 2535184610Salfred * that the USB transfer is complete. 2536184610Salfred * 2537184610Salfred * - This function is used to start the next USB transfer on the 2538193644Sthompsa * ep transfer queue, if any. 2539184610Salfred * 2540184610Salfred * NOTE: In some special cases the USB transfer will not be removed from 2541184610Salfred * the pipe queue, but remain first. To enforce USB transfer removal call 2542184610Salfred * this function passing the error code "USB_ERR_CANCELLED". 2543184610Salfred * 2544184610Salfred * Return values: 2545184610Salfred * 0: Success. 2546184610Salfred * Else: The callback has been deferred. 2547184610Salfred *------------------------------------------------------------------------*/ 2548184610Salfredstatic uint8_t 2549194228Sthompsausbd_callback_wrapper_sub(struct usb_xfer *xfer) 2550184610Salfred{ 2551193644Sthompsa struct usb_endpoint *ep; 2552193045Sthompsa usb_frcount_t x; 2553184610Salfred 2554184610Salfred if ((!xfer->flags_int.open) && 2555184610Salfred (!xfer->flags_int.did_close)) { 2556184610Salfred DPRINTF("close\n"); 2557187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2558193644Sthompsa (xfer->endpoint->methods->close) (xfer); 2559187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2560184610Salfred /* only close once */ 2561184610Salfred xfer->flags_int.did_close = 1; 2562184610Salfred return (1); /* wait for new callback */ 2563184610Salfred } 2564184610Salfred /* 2565184610Salfred * If we have a non-hardware induced error we 2566184610Salfred * need to do the DMA delay! 2567184610Salfred */ 2568184610Salfred if (((xfer->error == USB_ERR_CANCELLED) || 2569184610Salfred (xfer->error == USB_ERR_TIMEOUT)) && 2570184610Salfred (!xfer->flags_int.did_dma_delay)) { 2571184610Salfred 2572193045Sthompsa usb_timeout_t temp; 2573184610Salfred 2574197562Sthompsa /* only delay once */ 2575197562Sthompsa xfer->flags_int.did_dma_delay = 1; 2576197562Sthompsa 2577184610Salfred /* we can not cancel this delay */ 2578184610Salfred xfer->flags_int.can_cancel_immed = 0; 2579184610Salfred 2580194228Sthompsa temp = usbd_get_dma_delay(xfer->xroot->bus); 2581184610Salfred 2582184610Salfred DPRINTFN(3, "DMA delay, %u ms, " 2583184610Salfred "on %p\n", temp, xfer); 2584184610Salfred 2585184610Salfred if (temp != 0) { 2586187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2587194228Sthompsa usbd_transfer_timeout_ms(xfer, 2588194228Sthompsa &usb_dma_delay_done_cb, temp); 2589187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2590184610Salfred return (1); /* wait for new callback */ 2591184610Salfred } 2592184610Salfred } 2593184610Salfred /* check actual number of frames */ 2594184610Salfred if (xfer->aframes > xfer->nframes) { 2595184610Salfred if (xfer->error == 0) { 2596184610Salfred panic("%s: actual number of frames, %d, is " 2597199816Sthompsa "greater than initial number of frames, %d\n", 2598184610Salfred __FUNCTION__, xfer->aframes, xfer->nframes); 2599184610Salfred } else { 2600184610Salfred /* just set some valid value */ 2601184610Salfred xfer->aframes = xfer->nframes; 2602184610Salfred } 2603184610Salfred } 2604184610Salfred /* compute actual length */ 2605184610Salfred xfer->actlen = 0; 2606184610Salfred 2607184610Salfred for (x = 0; x != xfer->aframes; x++) { 2608184610Salfred xfer->actlen += xfer->frlengths[x]; 2609184610Salfred } 2610184610Salfred 2611184610Salfred /* 2612184610Salfred * Frames that were not transferred get zero actual length in 2613184610Salfred * case the USB device driver does not check the actual number 2614184610Salfred * of frames transferred, "xfer->aframes": 2615184610Salfred */ 2616184610Salfred for (; x < xfer->nframes; x++) { 2617194677Sthompsa usbd_xfer_set_frame_len(xfer, x, 0); 2618184610Salfred } 2619184610Salfred 2620184610Salfred /* check actual length */ 2621184610Salfred if (xfer->actlen > xfer->sumlen) { 2622184610Salfred if (xfer->error == 0) { 2623184610Salfred panic("%s: actual length, %d, is greater than " 2624199816Sthompsa "initial length, %d\n", 2625184610Salfred __FUNCTION__, xfer->actlen, xfer->sumlen); 2626184610Salfred } else { 2627184610Salfred /* just set some valid value */ 2628184610Salfred xfer->actlen = xfer->sumlen; 2629184610Salfred } 2630184610Salfred } 2631194677Sthompsa DPRINTFN(1, "xfer=%p endpoint=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n", 2632193644Sthompsa xfer, xfer->endpoint, xfer->error, xfer->actlen, xfer->sumlen, 2633184610Salfred xfer->aframes, xfer->nframes); 2634184610Salfred 2635184610Salfred if (xfer->error) { 2636184610Salfred /* end of control transfer, if any */ 2637184610Salfred xfer->flags_int.control_act = 0; 2638184610Salfred 2639184610Salfred /* check if we should block the execution queue */ 2640184610Salfred if ((xfer->error != USB_ERR_CANCELLED) && 2641184610Salfred (xfer->flags.pipe_bof)) { 2642184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure " 2643193644Sthompsa "on endpoint=%p\n", xfer, xfer->endpoint); 2644184610Salfred goto done; 2645184610Salfred } 2646184610Salfred } else { 2647184610Salfred /* check for short transfers */ 2648184610Salfred if (xfer->actlen < xfer->sumlen) { 2649184610Salfred 2650184610Salfred /* end of control transfer, if any */ 2651184610Salfred xfer->flags_int.control_act = 0; 2652184610Salfred 2653184610Salfred if (!xfer->flags_int.short_xfer_ok) { 2654184610Salfred xfer->error = USB_ERR_SHORT_XFER; 2655184610Salfred if (xfer->flags.pipe_bof) { 2656184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure on " 2657193644Sthompsa "Short Transfer on endpoint %p.\n", 2658193644Sthompsa xfer, xfer->endpoint); 2659184610Salfred goto done; 2660184610Salfred } 2661184610Salfred } 2662184610Salfred } else { 2663184610Salfred /* 2664184610Salfred * Check if we are in the middle of a 2665184610Salfred * control transfer: 2666184610Salfred */ 2667184610Salfred if (xfer->flags_int.control_act) { 2668184610Salfred DPRINTFN(5, "xfer=%p: Control transfer " 2669193644Sthompsa "active on endpoint=%p\n", xfer, xfer->endpoint); 2670184610Salfred goto done; 2671184610Salfred } 2672184610Salfred } 2673184610Salfred } 2674184610Salfred 2675193644Sthompsa ep = xfer->endpoint; 2676184610Salfred 2677184610Salfred /* 2678184610Salfred * If the current USB transfer is completing we need to start the 2679184610Salfred * next one: 2680184610Salfred */ 2681187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2682193644Sthompsa if (ep->endpoint_q.curr == xfer) { 2683194228Sthompsa usb_command_wrapper(&ep->endpoint_q, NULL); 2684184610Salfred 2685193644Sthompsa if (ep->endpoint_q.curr || TAILQ_FIRST(&ep->endpoint_q.head)) { 2686184610Salfred /* there is another USB transfer waiting */ 2687184610Salfred } else { 2688184610Salfred /* this is the last USB transfer */ 2689184610Salfred /* clear isochronous sync flag */ 2690193644Sthompsa xfer->endpoint->is_synced = 0; 2691184610Salfred } 2692184610Salfred } 2693187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2694184610Salfreddone: 2695184610Salfred return (0); 2696184610Salfred} 2697184610Salfred 2698184610Salfred/*------------------------------------------------------------------------* 2699194228Sthompsa * usb_command_wrapper 2700184610Salfred * 2701184610Salfred * This function is used to execute commands non-recursivly on an USB 2702184610Salfred * transfer. 2703184610Salfred *------------------------------------------------------------------------*/ 2704184610Salfredvoid 2705194228Sthompsausb_command_wrapper(struct usb_xfer_queue *pq, struct usb_xfer *xfer) 2706184610Salfred{ 2707184610Salfred if (xfer) { 2708184610Salfred /* 2709184610Salfred * If the transfer is not already processing, 2710184610Salfred * queue it! 2711184610Salfred */ 2712184610Salfred if (pq->curr != xfer) { 2713194228Sthompsa usbd_transfer_enqueue(pq, xfer); 2714184610Salfred if (pq->curr != NULL) { 2715184610Salfred /* something is already processing */ 2716184610Salfred DPRINTFN(6, "busy %p\n", pq->curr); 2717184610Salfred return; 2718184610Salfred } 2719184610Salfred } 2720184610Salfred } else { 2721184610Salfred /* Get next element in queue */ 2722184610Salfred pq->curr = NULL; 2723184610Salfred } 2724184610Salfred 2725184610Salfred if (!pq->recurse_1) { 2726184610Salfred 2727184610Salfred do { 2728184610Salfred 2729184610Salfred /* set both recurse flags */ 2730184610Salfred pq->recurse_1 = 1; 2731184610Salfred pq->recurse_2 = 1; 2732184610Salfred 2733184610Salfred if (pq->curr == NULL) { 2734184610Salfred xfer = TAILQ_FIRST(&pq->head); 2735184610Salfred if (xfer) { 2736184610Salfred TAILQ_REMOVE(&pq->head, xfer, 2737184610Salfred wait_entry); 2738184610Salfred xfer->wait_queue = NULL; 2739184610Salfred pq->curr = xfer; 2740184610Salfred } else { 2741184610Salfred break; 2742184610Salfred } 2743184610Salfred } 2744184610Salfred DPRINTFN(6, "cb %p (enter)\n", pq->curr); 2745184610Salfred (pq->command) (pq); 2746184610Salfred DPRINTFN(6, "cb %p (leave)\n", pq->curr); 2747184610Salfred 2748184610Salfred } while (!pq->recurse_2); 2749184610Salfred 2750184610Salfred /* clear first recurse flag */ 2751184610Salfred pq->recurse_1 = 0; 2752184610Salfred 2753184610Salfred } else { 2754184610Salfred /* clear second recurse flag */ 2755184610Salfred pq->recurse_2 = 0; 2756184610Salfred } 2757184610Salfred} 2758184610Salfred 2759184610Salfred/*------------------------------------------------------------------------* 2760207080Sthompsa * usbd_ctrl_transfer_setup 2761184610Salfred * 2762184610Salfred * This function is used to setup the default USB control endpoint 2763184610Salfred * transfer. 2764184610Salfred *------------------------------------------------------------------------*/ 2765184610Salfredvoid 2766207080Sthompsausbd_ctrl_transfer_setup(struct usb_device *udev) 2767184610Salfred{ 2768192984Sthompsa struct usb_xfer *xfer; 2769184610Salfred uint8_t no_resetup; 2770184610Salfred uint8_t iface_index; 2771184610Salfred 2772190735Sthompsa /* check for root HUB */ 2773190735Sthompsa if (udev->parent_hub == NULL) 2774190735Sthompsa return; 2775184610Salfredrepeat: 2776184610Salfred 2777207080Sthompsa xfer = udev->ctrl_xfer[0]; 2778184610Salfred if (xfer) { 2779184824Sthompsa USB_XFER_LOCK(xfer); 2780184610Salfred no_resetup = 2781184610Salfred ((xfer->address == udev->address) && 2782207080Sthompsa (udev->ctrl_ep_desc.wMaxPacketSize[0] == 2783184610Salfred udev->ddesc.bMaxPacketSize)); 2784192499Sthompsa if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2785184610Salfred if (no_resetup) { 2786184610Salfred /* 2787184610Salfred * NOTE: checking "xfer->address" and 2788184610Salfred * starting the USB transfer must be 2789184610Salfred * atomic! 2790184610Salfred */ 2791194228Sthompsa usbd_transfer_start(xfer); 2792184610Salfred } 2793184610Salfred } 2794184824Sthompsa USB_XFER_UNLOCK(xfer); 2795184610Salfred } else { 2796184610Salfred no_resetup = 0; 2797184610Salfred } 2798184610Salfred 2799184610Salfred if (no_resetup) { 2800184610Salfred /* 2801184610Salfred * All parameters are exactly the same like before. 2802184610Salfred * Just return. 2803184610Salfred */ 2804184610Salfred return; 2805184610Salfred } 2806184610Salfred /* 2807184610Salfred * Update wMaxPacketSize for the default control endpoint: 2808184610Salfred */ 2809207080Sthompsa udev->ctrl_ep_desc.wMaxPacketSize[0] = 2810184610Salfred udev->ddesc.bMaxPacketSize; 2811184610Salfred 2812184610Salfred /* 2813184610Salfred * Unsetup any existing USB transfer: 2814184610Salfred */ 2815207080Sthompsa usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 2816184610Salfred 2817184610Salfred /* 2818184610Salfred * Try to setup a new USB transfer for the 2819184610Salfred * default control endpoint: 2820184610Salfred */ 2821184610Salfred iface_index = 0; 2822194228Sthompsa if (usbd_transfer_setup(udev, &iface_index, 2823207080Sthompsa udev->ctrl_xfer, usb_control_ep_cfg, USB_CTRL_XFER_MAX, NULL, 2824207079Sthompsa &udev->device_mtx)) { 2825184610Salfred DPRINTFN(0, "could not setup default " 2826199816Sthompsa "USB transfer\n"); 2827184610Salfred } else { 2828184610Salfred goto repeat; 2829184610Salfred } 2830184610Salfred} 2831184610Salfred 2832184610Salfred/*------------------------------------------------------------------------* 2833194228Sthompsa * usbd_clear_data_toggle - factored out code 2834184610Salfred * 2835184610Salfred * NOTE: the intention of this function is not to reset the hardware 2836184610Salfred * data toggle. 2837184610Salfred *------------------------------------------------------------------------*/ 2838184610Salfredvoid 2839194228Sthompsausbd_clear_data_toggle(struct usb_device *udev, struct usb_endpoint *ep) 2840184610Salfred{ 2841193644Sthompsa DPRINTFN(5, "udev=%p endpoint=%p\n", udev, ep); 2842184610Salfred 2843184824Sthompsa USB_BUS_LOCK(udev->bus); 2844193644Sthompsa ep->toggle_next = 0; 2845184824Sthompsa USB_BUS_UNLOCK(udev->bus); 2846184610Salfred} 2847184610Salfred 2848184610Salfred/*------------------------------------------------------------------------* 2849194228Sthompsa * usbd_clear_stall_callback - factored out clear stall callback 2850184610Salfred * 2851184610Salfred * Input parameters: 2852184610Salfred * xfer1: Clear Stall Control Transfer 2853184610Salfred * xfer2: Stalled USB Transfer 2854184610Salfred * 2855184610Salfred * This function is NULL safe. 2856184610Salfred * 2857184610Salfred * Return values: 2858184610Salfred * 0: In progress 2859184610Salfred * Else: Finished 2860184610Salfred * 2861184610Salfred * Clear stall config example: 2862184610Salfred * 2863192984Sthompsa * static const struct usb_config my_clearstall = { 2864184610Salfred * .type = UE_CONTROL, 2865184610Salfred * .endpoint = 0, 2866184610Salfred * .direction = UE_DIR_ANY, 2867184610Salfred * .interval = 50, //50 milliseconds 2868192984Sthompsa * .bufsize = sizeof(struct usb_device_request), 2869190734Sthompsa * .timeout = 1000, //1.000 seconds 2870190734Sthompsa * .callback = &my_clear_stall_callback, // ** 2871190734Sthompsa * .usb_mode = USB_MODE_HOST, 2872184610Salfred * }; 2873184610Salfred * 2874194228Sthompsa * ** "my_clear_stall_callback" calls "usbd_clear_stall_callback" 2875184610Salfred * passing the correct parameters. 2876184610Salfred *------------------------------------------------------------------------*/ 2877184610Salfreduint8_t 2878194228Sthompsausbd_clear_stall_callback(struct usb_xfer *xfer1, 2879192984Sthompsa struct usb_xfer *xfer2) 2880184610Salfred{ 2881192984Sthompsa struct usb_device_request req; 2882184610Salfred 2883184610Salfred if (xfer2 == NULL) { 2884184610Salfred /* looks like we are tearing down */ 2885184610Salfred DPRINTF("NULL input parameter\n"); 2886184610Salfred return (0); 2887184610Salfred } 2888184824Sthompsa USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED); 2889184824Sthompsa USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED); 2890184610Salfred 2891184610Salfred switch (USB_GET_STATE(xfer1)) { 2892184610Salfred case USB_ST_SETUP: 2893184610Salfred 2894184610Salfred /* 2895184610Salfred * pre-clear the data toggle to DATA0 ("umass.c" and 2896184610Salfred * "ata-usb.c" depends on this) 2897184610Salfred */ 2898184610Salfred 2899194228Sthompsa usbd_clear_data_toggle(xfer2->xroot->udev, xfer2->endpoint); 2900184610Salfred 2901184610Salfred /* setup a clear-stall packet */ 2902184610Salfred 2903184610Salfred req.bmRequestType = UT_WRITE_ENDPOINT; 2904184610Salfred req.bRequest = UR_CLEAR_FEATURE; 2905184610Salfred USETW(req.wValue, UF_ENDPOINT_HALT); 2906193644Sthompsa req.wIndex[0] = xfer2->endpoint->edesc->bEndpointAddress; 2907184610Salfred req.wIndex[1] = 0; 2908184610Salfred USETW(req.wLength, 0); 2909184610Salfred 2910184610Salfred /* 2911194228Sthompsa * "usbd_transfer_setup_sub()" will ensure that 2912184610Salfred * we have sufficient room in the buffer for 2913184610Salfred * the request structure! 2914184610Salfred */ 2915184610Salfred 2916184610Salfred /* copy in the transfer */ 2917184610Salfred 2918194228Sthompsa usbd_copy_in(xfer1->frbuffers, 0, &req, sizeof(req)); 2919184610Salfred 2920184610Salfred /* set length */ 2921184610Salfred xfer1->frlengths[0] = sizeof(req); 2922184610Salfred xfer1->nframes = 1; 2923184610Salfred 2924194228Sthompsa usbd_transfer_submit(xfer1); 2925184610Salfred return (0); 2926184610Salfred 2927184610Salfred case USB_ST_TRANSFERRED: 2928184610Salfred break; 2929184610Salfred 2930184610Salfred default: /* Error */ 2931184610Salfred if (xfer1->error == USB_ERR_CANCELLED) { 2932184610Salfred return (0); 2933184610Salfred } 2934184610Salfred break; 2935184610Salfred } 2936184610Salfred return (1); /* Clear Stall Finished */ 2937184610Salfred} 2938184610Salfred 2939195960Salfred/*------------------------------------------------------------------------* 2940195960Salfred * usbd_transfer_poll 2941195960Salfred * 2942195960Salfred * The following function gets called from the USB keyboard driver and 2943195960Salfred * UMASS when the system has paniced. 2944195960Salfred * 2945195960Salfred * NOTE: It is currently not possible to resume normal operation on 2946195960Salfred * the USB controller which has been polled, due to clearing of the 2947195960Salfred * "up_dsleep" and "up_msleep" flags. 2948195960Salfred *------------------------------------------------------------------------*/ 2949184610Salfredvoid 2950194677Sthompsausbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max) 2951184610Salfred{ 2952195960Salfred struct usb_xfer *xfer; 2953195960Salfred struct usb_xfer_root *xroot; 2954195960Salfred struct usb_device *udev; 2955195960Salfred struct usb_proc_msg *pm; 2956195960Salfred uint16_t n; 2957195960Salfred uint16_t drop_bus; 2958195960Salfred uint16_t drop_xfer; 2959195960Salfred 2960195960Salfred for (n = 0; n != max; n++) { 2961195960Salfred /* Extra checks to avoid panic */ 2962195960Salfred xfer = ppxfer[n]; 2963195960Salfred if (xfer == NULL) 2964195960Salfred continue; /* no USB transfer */ 2965195960Salfred xroot = xfer->xroot; 2966195960Salfred if (xroot == NULL) 2967195960Salfred continue; /* no USB root */ 2968195960Salfred udev = xroot->udev; 2969195960Salfred if (udev == NULL) 2970195960Salfred continue; /* no USB device */ 2971195960Salfred if (udev->bus == NULL) 2972195960Salfred continue; /* no BUS structure */ 2973195960Salfred if (udev->bus->methods == NULL) 2974195960Salfred continue; /* no BUS methods */ 2975195960Salfred if (udev->bus->methods->xfer_poll == NULL) 2976195960Salfred continue; /* no poll method */ 2977195960Salfred 2978195960Salfred /* make sure that the BUS mutex is not locked */ 2979195960Salfred drop_bus = 0; 2980195960Salfred while (mtx_owned(&xroot->udev->bus->bus_mtx)) { 2981195960Salfred mtx_unlock(&xroot->udev->bus->bus_mtx); 2982195960Salfred drop_bus++; 2983195960Salfred } 2984195960Salfred 2985195960Salfred /* make sure that the transfer mutex is not locked */ 2986195960Salfred drop_xfer = 0; 2987195960Salfred while (mtx_owned(xroot->xfer_mtx)) { 2988195960Salfred mtx_unlock(xroot->xfer_mtx); 2989195960Salfred drop_xfer++; 2990195960Salfred } 2991195960Salfred 2992195960Salfred /* Make sure cv_signal() and cv_broadcast() is not called */ 2993195960Salfred udev->bus->control_xfer_proc.up_msleep = 0; 2994195960Salfred udev->bus->explore_proc.up_msleep = 0; 2995195960Salfred udev->bus->giant_callback_proc.up_msleep = 0; 2996195960Salfred udev->bus->non_giant_callback_proc.up_msleep = 0; 2997195960Salfred 2998195960Salfred /* poll USB hardware */ 2999195960Salfred (udev->bus->methods->xfer_poll) (udev->bus); 3000195960Salfred 3001195960Salfred USB_BUS_LOCK(xroot->bus); 3002195960Salfred 3003195960Salfred /* check for clear stall */ 3004207080Sthompsa if (udev->ctrl_xfer[1] != NULL) { 3005195960Salfred 3006195960Salfred /* poll clear stall start */ 3007195960Salfred pm = &udev->cs_msg[0].hdr; 3008195960Salfred (pm->pm_callback) (pm); 3009195960Salfred /* poll clear stall done thread */ 3010207080Sthompsa pm = &udev->ctrl_xfer[1]-> 3011195960Salfred xroot->done_m[0].hdr; 3012195960Salfred (pm->pm_callback) (pm); 3013195960Salfred } 3014195960Salfred 3015195960Salfred /* poll done thread */ 3016195960Salfred pm = &xroot->done_m[0].hdr; 3017195960Salfred (pm->pm_callback) (pm); 3018195960Salfred 3019195960Salfred USB_BUS_UNLOCK(xroot->bus); 3020195960Salfred 3021195960Salfred /* restore transfer mutex */ 3022195960Salfred while (drop_xfer--) 3023195960Salfred mtx_lock(xroot->xfer_mtx); 3024195960Salfred 3025195960Salfred /* restore BUS mutex */ 3026195960Salfred while (drop_bus--) 3027195960Salfred mtx_lock(&xroot->udev->bus->bus_mtx); 3028184610Salfred } 3029184610Salfred} 3030190734Sthompsa 3031190734Sthompsastatic void 3032194228Sthompsausbd_get_std_packet_size(struct usb_std_packet_size *ptr, 3033192500Sthompsa uint8_t type, enum usb_dev_speed speed) 3034190734Sthompsa{ 3035190734Sthompsa static const uint16_t intr_range_max[USB_SPEED_MAX] = { 3036190734Sthompsa [USB_SPEED_LOW] = 8, 3037190734Sthompsa [USB_SPEED_FULL] = 64, 3038190734Sthompsa [USB_SPEED_HIGH] = 1024, 3039190734Sthompsa [USB_SPEED_VARIABLE] = 1024, 3040190734Sthompsa [USB_SPEED_SUPER] = 1024, 3041190734Sthompsa }; 3042190734Sthompsa 3043190734Sthompsa static const uint16_t isoc_range_max[USB_SPEED_MAX] = { 3044190734Sthompsa [USB_SPEED_LOW] = 0, /* invalid */ 3045190734Sthompsa [USB_SPEED_FULL] = 1023, 3046190734Sthompsa [USB_SPEED_HIGH] = 1024, 3047190734Sthompsa [USB_SPEED_VARIABLE] = 3584, 3048190734Sthompsa [USB_SPEED_SUPER] = 1024, 3049190734Sthompsa }; 3050190734Sthompsa 3051190734Sthompsa static const uint16_t control_min[USB_SPEED_MAX] = { 3052190734Sthompsa [USB_SPEED_LOW] = 8, 3053190734Sthompsa [USB_SPEED_FULL] = 8, 3054190734Sthompsa [USB_SPEED_HIGH] = 64, 3055190734Sthompsa [USB_SPEED_VARIABLE] = 512, 3056190734Sthompsa [USB_SPEED_SUPER] = 512, 3057190734Sthompsa }; 3058190734Sthompsa 3059190734Sthompsa static const uint16_t bulk_min[USB_SPEED_MAX] = { 3060209443Sthompsa [USB_SPEED_LOW] = 8, 3061190734Sthompsa [USB_SPEED_FULL] = 8, 3062190734Sthompsa [USB_SPEED_HIGH] = 512, 3063190734Sthompsa [USB_SPEED_VARIABLE] = 512, 3064190734Sthompsa [USB_SPEED_SUPER] = 1024, 3065190734Sthompsa }; 3066190734Sthompsa 3067190734Sthompsa uint16_t temp; 3068190734Sthompsa 3069190734Sthompsa memset(ptr, 0, sizeof(*ptr)); 3070190734Sthompsa 3071190734Sthompsa switch (type) { 3072190734Sthompsa case UE_INTERRUPT: 3073192500Sthompsa ptr->range.max = intr_range_max[speed]; 3074190734Sthompsa break; 3075190734Sthompsa case UE_ISOCHRONOUS: 3076192500Sthompsa ptr->range.max = isoc_range_max[speed]; 3077190734Sthompsa break; 3078190734Sthompsa default: 3079190734Sthompsa if (type == UE_BULK) 3080192500Sthompsa temp = bulk_min[speed]; 3081190734Sthompsa else /* UE_CONTROL */ 3082192500Sthompsa temp = control_min[speed]; 3083190734Sthompsa 3084190734Sthompsa /* default is fixed */ 3085190734Sthompsa ptr->fixed[0] = temp; 3086190734Sthompsa ptr->fixed[1] = temp; 3087190734Sthompsa ptr->fixed[2] = temp; 3088190734Sthompsa ptr->fixed[3] = temp; 3089190734Sthompsa 3090192500Sthompsa if (speed == USB_SPEED_FULL) { 3091190734Sthompsa /* multiple sizes */ 3092190734Sthompsa ptr->fixed[1] = 16; 3093190734Sthompsa ptr->fixed[2] = 32; 3094190734Sthompsa ptr->fixed[3] = 64; 3095190734Sthompsa } 3096192500Sthompsa if ((speed == USB_SPEED_VARIABLE) && 3097190734Sthompsa (type == UE_BULK)) { 3098190734Sthompsa /* multiple sizes */ 3099190734Sthompsa ptr->fixed[2] = 1024; 3100190734Sthompsa ptr->fixed[3] = 1536; 3101190734Sthompsa } 3102190734Sthompsa break; 3103190734Sthompsa } 3104190734Sthompsa} 3105194677Sthompsa 3106194677Sthompsavoid * 3107194677Sthompsausbd_xfer_softc(struct usb_xfer *xfer) 3108194677Sthompsa{ 3109194677Sthompsa return (xfer->priv_sc); 3110194677Sthompsa} 3111194677Sthompsa 3112194677Sthompsavoid * 3113194677Sthompsausbd_xfer_get_priv(struct usb_xfer *xfer) 3114194677Sthompsa{ 3115194677Sthompsa return (xfer->priv_fifo); 3116194677Sthompsa} 3117194677Sthompsa 3118194677Sthompsavoid 3119194677Sthompsausbd_xfer_set_priv(struct usb_xfer *xfer, void *ptr) 3120194677Sthompsa{ 3121194677Sthompsa xfer->priv_fifo = ptr; 3122194677Sthompsa} 3123194677Sthompsa 3124194677Sthompsauint8_t 3125194677Sthompsausbd_xfer_state(struct usb_xfer *xfer) 3126194677Sthompsa{ 3127194677Sthompsa return (xfer->usb_state); 3128194677Sthompsa} 3129194677Sthompsa 3130194677Sthompsavoid 3131194677Sthompsausbd_xfer_set_flag(struct usb_xfer *xfer, int flag) 3132194677Sthompsa{ 3133194677Sthompsa switch (flag) { 3134194677Sthompsa case USB_FORCE_SHORT_XFER: 3135194677Sthompsa xfer->flags.force_short_xfer = 1; 3136194677Sthompsa break; 3137194677Sthompsa case USB_SHORT_XFER_OK: 3138194677Sthompsa xfer->flags.short_xfer_ok = 1; 3139194677Sthompsa break; 3140195121Sthompsa case USB_MULTI_SHORT_OK: 3141195121Sthompsa xfer->flags.short_frames_ok = 1; 3142195121Sthompsa break; 3143195121Sthompsa case USB_MANUAL_STATUS: 3144195121Sthompsa xfer->flags.manual_status = 1; 3145195121Sthompsa break; 3146194677Sthompsa } 3147194677Sthompsa} 3148194677Sthompsa 3149194677Sthompsavoid 3150194677Sthompsausbd_xfer_clr_flag(struct usb_xfer *xfer, int flag) 3151194677Sthompsa{ 3152194677Sthompsa switch (flag) { 3153194677Sthompsa case USB_FORCE_SHORT_XFER: 3154194677Sthompsa xfer->flags.force_short_xfer = 0; 3155194677Sthompsa break; 3156194677Sthompsa case USB_SHORT_XFER_OK: 3157194677Sthompsa xfer->flags.short_xfer_ok = 0; 3158194677Sthompsa break; 3159195121Sthompsa case USB_MULTI_SHORT_OK: 3160195121Sthompsa xfer->flags.short_frames_ok = 0; 3161195121Sthompsa break; 3162195121Sthompsa case USB_MANUAL_STATUS: 3163195121Sthompsa xfer->flags.manual_status = 0; 3164195121Sthompsa break; 3165194677Sthompsa } 3166194677Sthompsa} 3167195121Sthompsa 3168195121Sthompsa/* 3169195121Sthompsa * The following function returns in milliseconds when the isochronous 3170195121Sthompsa * transfer was completed by the hardware. The returned value wraps 3171195121Sthompsa * around 65536 milliseconds. 3172195121Sthompsa */ 3173195121Sthompsauint16_t 3174195121Sthompsausbd_xfer_get_timestamp(struct usb_xfer *xfer) 3175195121Sthompsa{ 3176195121Sthompsa return (xfer->isoc_time_complete); 3177195121Sthompsa} 3178