1184610Salfred/* $FreeBSD$ */ 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. 25247090Shselasky */ 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/module.h> 36194677Sthompsa#include <sys/lock.h> 37194677Sthompsa#include <sys/mutex.h> 38194677Sthompsa#include <sys/condvar.h> 39194677Sthompsa#include <sys/sysctl.h> 40194677Sthompsa#include <sys/sx.h> 41194677Sthompsa#include <sys/unistd.h> 42194677Sthompsa#include <sys/callout.h> 43194677Sthompsa#include <sys/malloc.h> 44194677Sthompsa#include <sys/priv.h> 45235480Savg#include <sys/proc.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> 63215649Sweongyo#include <dev/usb/usb_pf.h> 64184610Salfred 65194228Sthompsastruct usb_std_packet_size { 66184610Salfred struct { 67184610Salfred uint16_t min; /* inclusive */ 68184610Salfred uint16_t max; /* inclusive */ 69184610Salfred } range; 70184610Salfred 71184610Salfred uint16_t fixed[4]; 72184610Salfred}; 73184610Salfred 74194228Sthompsastatic usb_callback_t usb_request_callback; 75184610Salfred 76207080Sthompsastatic const struct usb_config usb_control_ep_cfg[USB_CTRL_XFER_MAX] = { 77184610Salfred 78184610Salfred /* This transfer is used for generic control endpoint transfers */ 79184610Salfred 80184610Salfred [0] = { 81184610Salfred .type = UE_CONTROL, 82184610Salfred .endpoint = 0x00, /* Control endpoint */ 83184610Salfred .direction = UE_DIR_ANY, 84190734Sthompsa .bufsize = USB_EP0_BUFSIZE, /* bytes */ 85190734Sthompsa .flags = {.proxy_buffer = 1,}, 86194228Sthompsa .callback = &usb_request_callback, 87192499Sthompsa .usb_mode = USB_MODE_DUAL, /* both modes */ 88184610Salfred }, 89184610Salfred 90184610Salfred /* This transfer is used for generic clear stall only */ 91184610Salfred 92184610Salfred [1] = { 93184610Salfred .type = UE_CONTROL, 94184610Salfred .endpoint = 0x00, /* Control pipe */ 95184610Salfred .direction = UE_DIR_ANY, 96192984Sthompsa .bufsize = sizeof(struct usb_device_request), 97194228Sthompsa .callback = &usb_do_clear_stall_callback, 98190734Sthompsa .timeout = 1000, /* 1 second */ 99190734Sthompsa .interval = 50, /* 50ms */ 100190734Sthompsa .usb_mode = USB_MODE_HOST, 101184610Salfred }, 102184610Salfred}; 103184610Salfred 104184610Salfred/* function prototypes */ 105184610Salfred 106194228Sthompsastatic void usbd_update_max_frame_size(struct usb_xfer *); 107194228Sthompsastatic void usbd_transfer_unsetup_sub(struct usb_xfer_root *, uint8_t); 108194228Sthompsastatic void usbd_control_transfer_init(struct usb_xfer *); 109194677Sthompsastatic int usbd_setup_ctrl_transfer(struct usb_xfer *); 110194228Sthompsastatic void usb_callback_proc(struct usb_proc_msg *); 111194228Sthompsastatic void usbd_callback_ss_done_defer(struct usb_xfer *); 112194228Sthompsastatic void usbd_callback_wrapper(struct usb_xfer_queue *); 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 */ 140213435Shselasky /* this computation should not overflow 16-bit */ 141213435Shselasky /* max = 15 * 1024 */ 142184610Salfred 143213435Shselasky xfer->max_frame_size = xfer->max_packet_size * xfer->max_packet_count; 144184610Salfred} 145184610Salfred 146184610Salfred/*------------------------------------------------------------------------* 147194228Sthompsa * usbd_get_dma_delay 148184610Salfred * 149184610Salfred * The following function is called when we need to 150184610Salfred * synchronize with DMA hardware. 151184610Salfred * 152184610Salfred * Returns: 153184610Salfred * 0: no DMA delay required 154184610Salfred * Else: milliseconds of DMA delay 155184610Salfred *------------------------------------------------------------------------*/ 156193045Sthompsausb_timeout_t 157212134Sthompsausbd_get_dma_delay(struct usb_device *udev) 158184610Salfred{ 159212134Sthompsa struct usb_bus_methods *mtod; 160212134Sthompsa uint32_t temp; 161184610Salfred 162212134Sthompsa mtod = udev->bus->methods; 163212134Sthompsa temp = 0; 164212134Sthompsa 165212134Sthompsa if (mtod->get_dma_delay) { 166212134Sthompsa (mtod->get_dma_delay) (udev, &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 */ 220236477Smarius if (size >= USB_PAGE_SIZE) { 221184610Salfred n_dma_pc = count; 222184610Salfred n_obj = 1; 223184610Salfred } else { 224184610Salfred /* compute number of objects per page */ 225236477Smarius n_obj = (USB_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; 319213435Shselasky struct usb_endpoint_ss_comp_descriptor *ecomp; 320192984Sthompsa struct usb_endpoint_descriptor *edesc; 321194228Sthompsa struct usb_std_packet_size std_size; 322193045Sthompsa usb_frcount_t n_frlengths; 323193045Sthompsa usb_frcount_t n_frbuffers; 324193045Sthompsa usb_frcount_t x; 325263644Shselasky uint16_t maxp_old; 326184610Salfred uint8_t type; 327184610Salfred uint8_t zmps; 328184610Salfred 329184610Salfred /* 330184610Salfred * Sanity check. The following parameters must be initialized before 331184610Salfred * calling this function. 332184610Salfred */ 333184610Salfred if ((parm->hc_max_packet_size == 0) || 334184610Salfred (parm->hc_max_packet_count == 0) || 335184610Salfred (parm->hc_max_frame_size == 0)) { 336184610Salfred parm->err = USB_ERR_INVAL; 337184610Salfred goto done; 338184610Salfred } 339193644Sthompsa edesc = xfer->endpoint->edesc; 340213435Shselasky ecomp = xfer->endpoint->ecomp; 341184610Salfred 342184610Salfred type = (edesc->bmAttributes & UE_XFERTYPE); 343184610Salfred 344190734Sthompsa xfer->flags = setup->flags; 345190734Sthompsa xfer->nframes = setup->frames; 346190734Sthompsa xfer->timeout = setup->timeout; 347190734Sthompsa xfer->callback = setup->callback; 348190734Sthompsa xfer->interval = setup->interval; 349193644Sthompsa xfer->endpointno = edesc->bEndpointAddress; 350184610Salfred xfer->max_packet_size = UGETW(edesc->wMaxPacketSize); 351184610Salfred xfer->max_packet_count = 1; 352184610Salfred /* make a shadow copy: */ 353192499Sthompsa xfer->flags_int.usb_mode = parm->udev->flags.usb_mode; 354184610Salfred 355190734Sthompsa parm->bufsize = setup->bufsize; 356184610Salfred 357213435Shselasky switch (parm->speed) { 358213435Shselasky case USB_SPEED_HIGH: 359213435Shselasky switch (type) { 360213435Shselasky case UE_ISOCHRONOUS: 361213435Shselasky case UE_INTERRUPT: 362213435Shselasky xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 363213435Shselasky 364213435Shselasky /* check for invalid max packet count */ 365213435Shselasky if (xfer->max_packet_count > 3) 366213435Shselasky xfer->max_packet_count = 3; 367213435Shselasky break; 368213435Shselasky default: 369213435Shselasky break; 370213435Shselasky } 371213435Shselasky xfer->max_packet_size &= 0x7FF; 372213435Shselasky break; 373213435Shselasky case USB_SPEED_SUPER: 374184610Salfred xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 375213435Shselasky 376213435Shselasky if (ecomp != NULL) 377213435Shselasky xfer->max_packet_count += ecomp->bMaxBurst; 378213435Shselasky 379213435Shselasky if ((xfer->max_packet_count == 0) || 380213435Shselasky (xfer->max_packet_count > 16)) 381213435Shselasky xfer->max_packet_count = 16; 382213435Shselasky 383213435Shselasky switch (type) { 384213435Shselasky case UE_CONTROL: 385213435Shselasky xfer->max_packet_count = 1; 386213435Shselasky break; 387213435Shselasky case UE_ISOCHRONOUS: 388213435Shselasky if (ecomp != NULL) { 389213435Shselasky uint8_t mult; 390213435Shselasky 391213435Shselasky mult = (ecomp->bmAttributes & 3) + 1; 392213435Shselasky if (mult > 3) 393213435Shselasky mult = 3; 394213435Shselasky 395213435Shselasky xfer->max_packet_count *= mult; 396213435Shselasky } 397213435Shselasky break; 398213435Shselasky default: 399213435Shselasky break; 400213435Shselasky } 401184610Salfred xfer->max_packet_size &= 0x7FF; 402213435Shselasky break; 403213435Shselasky default: 404213435Shselasky break; 405184610Salfred } 406184610Salfred /* range check "max_packet_count" */ 407184610Salfred 408184610Salfred if (xfer->max_packet_count > parm->hc_max_packet_count) { 409184610Salfred xfer->max_packet_count = parm->hc_max_packet_count; 410184610Salfred } 411263644Shselasky 412263644Shselasky /* store max packet size value before filtering */ 413263644Shselasky 414263644Shselasky maxp_old = xfer->max_packet_size; 415263644Shselasky 416184610Salfred /* filter "wMaxPacketSize" according to HC capabilities */ 417184610Salfred 418184610Salfred if ((xfer->max_packet_size > parm->hc_max_packet_size) || 419184610Salfred (xfer->max_packet_size == 0)) { 420184610Salfred xfer->max_packet_size = parm->hc_max_packet_size; 421184610Salfred } 422184610Salfred /* filter "wMaxPacketSize" according to standard sizes */ 423184610Salfred 424194228Sthompsa usbd_get_std_packet_size(&std_size, type, parm->speed); 425184610Salfred 426184610Salfred if (std_size.range.min || std_size.range.max) { 427184610Salfred 428184610Salfred if (xfer->max_packet_size < std_size.range.min) { 429184610Salfred xfer->max_packet_size = std_size.range.min; 430184610Salfred } 431184610Salfred if (xfer->max_packet_size > std_size.range.max) { 432184610Salfred xfer->max_packet_size = std_size.range.max; 433184610Salfred } 434184610Salfred } else { 435184610Salfred 436184610Salfred if (xfer->max_packet_size >= std_size.fixed[3]) { 437184610Salfred xfer->max_packet_size = std_size.fixed[3]; 438184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[2]) { 439184610Salfred xfer->max_packet_size = std_size.fixed[2]; 440184610Salfred } else if (xfer->max_packet_size >= std_size.fixed[1]) { 441184610Salfred xfer->max_packet_size = std_size.fixed[1]; 442184610Salfred } else { 443184610Salfred /* only one possibility left */ 444184610Salfred xfer->max_packet_size = std_size.fixed[0]; 445184610Salfred } 446184610Salfred } 447184610Salfred 448263644Shselasky /* 449263644Shselasky * Check if the max packet size was outside its allowed range 450263644Shselasky * and clamped to a valid value: 451263644Shselasky */ 452263644Shselasky if (maxp_old != xfer->max_packet_size) 453263644Shselasky xfer->flags_int.maxp_was_clamped = 1; 454263644Shselasky 455184610Salfred /* compute "max_frame_size" */ 456184610Salfred 457194228Sthompsa usbd_update_max_frame_size(xfer); 458184610Salfred 459184610Salfred /* check interrupt interval and transfer pre-delay */ 460184610Salfred 461184610Salfred if (type == UE_ISOCHRONOUS) { 462184610Salfred 463190181Sthompsa uint16_t frame_limit; 464184610Salfred 465184610Salfred xfer->interval = 0; /* not used, must be zero */ 466184610Salfred xfer->flags_int.isochronous_xfr = 1; /* set flag */ 467184610Salfred 468184610Salfred if (xfer->timeout == 0) { 469184610Salfred /* 470184610Salfred * set a default timeout in 471184610Salfred * case something goes wrong! 472184610Salfred */ 473184610Salfred xfer->timeout = 1000 / 4; 474184610Salfred } 475187180Sthompsa switch (parm->speed) { 476187180Sthompsa case USB_SPEED_LOW: 477187180Sthompsa case USB_SPEED_FULL: 478187180Sthompsa frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER; 479199059Sthompsa xfer->fps_shift = 0; 480187180Sthompsa break; 481187180Sthompsa default: 482184610Salfred frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER; 483199059Sthompsa xfer->fps_shift = edesc->bInterval; 484199059Sthompsa if (xfer->fps_shift > 0) 485199059Sthompsa xfer->fps_shift--; 486199059Sthompsa if (xfer->fps_shift > 3) 487199059Sthompsa xfer->fps_shift = 3; 488219100Shselasky if (xfer->flags.pre_scale_frames != 0) 489219100Shselasky xfer->nframes <<= (3 - xfer->fps_shift); 490187180Sthompsa break; 491184610Salfred } 492184610Salfred 493184610Salfred if (xfer->nframes > frame_limit) { 494184610Salfred /* 495184610Salfred * this is not going to work 496184610Salfred * cross hardware 497184610Salfred */ 498184610Salfred parm->err = USB_ERR_INVAL; 499184610Salfred goto done; 500184610Salfred } 501184610Salfred if (xfer->nframes == 0) { 502184610Salfred /* 503184610Salfred * this is not a valid value 504184610Salfred */ 505184610Salfred parm->err = USB_ERR_ZERO_NFRAMES; 506184610Salfred goto done; 507184610Salfred } 508184610Salfred } else { 509184610Salfred 510184610Salfred /* 511213435Shselasky * If a value is specified use that else check the 512213435Shselasky * endpoint descriptor! 513184610Salfred */ 514213435Shselasky if (type == UE_INTERRUPT) { 515184610Salfred 516213435Shselasky uint32_t temp; 517184610Salfred 518213435Shselasky if (xfer->interval == 0) { 519213435Shselasky 520184610Salfred xfer->interval = edesc->bInterval; 521184610Salfred 522187180Sthompsa switch (parm->speed) { 523213435Shselasky case USB_SPEED_LOW: 524213435Shselasky case USB_SPEED_FULL: 525213435Shselasky break; 526213435Shselasky default: 527187180Sthompsa /* 125us -> 1ms */ 528187180Sthompsa if (xfer->interval < 4) 529187180Sthompsa xfer->interval = 1; 530187180Sthompsa else if (xfer->interval > 16) 531213435Shselasky xfer->interval = (1 << (16 - 4)); 532187180Sthompsa else 533187180Sthompsa xfer->interval = 534213435Shselasky (1 << (xfer->interval - 4)); 535187180Sthompsa break; 536184610Salfred } 537184610Salfred } 538213435Shselasky 539213435Shselasky if (xfer->interval == 0) { 540213435Shselasky /* 541213435Shselasky * One millisecond is the smallest 542213435Shselasky * interval we support: 543213435Shselasky */ 544213435Shselasky xfer->interval = 1; 545213435Shselasky } 546213435Shselasky 547213435Shselasky xfer->fps_shift = 0; 548213435Shselasky temp = 1; 549213435Shselasky 550213435Shselasky while ((temp != 0) && (temp < xfer->interval)) { 551213435Shselasky xfer->fps_shift++; 552213435Shselasky temp *= 2; 553213435Shselasky } 554213435Shselasky 555213435Shselasky switch (parm->speed) { 556213435Shselasky case USB_SPEED_LOW: 557213435Shselasky case USB_SPEED_FULL: 558213435Shselasky break; 559213435Shselasky default: 560213435Shselasky xfer->fps_shift += 3; 561213435Shselasky break; 562213435Shselasky } 563184610Salfred } 564184610Salfred } 565184610Salfred 566184610Salfred /* 567184610Salfred * NOTE: we do not allow "max_packet_size" or "max_frame_size" 568184610Salfred * to be equal to zero when setting up USB transfers, hence 569184610Salfred * this leads to alot of extra code in the USB kernel. 570184610Salfred */ 571184610Salfred 572184610Salfred if ((xfer->max_frame_size == 0) || 573184610Salfred (xfer->max_packet_size == 0)) { 574184610Salfred 575184610Salfred zmps = 1; 576184610Salfred 577184610Salfred if ((parm->bufsize <= MIN_PKT) && 578184610Salfred (type != UE_CONTROL) && 579184610Salfred (type != UE_BULK)) { 580184610Salfred 581184610Salfred /* workaround */ 582184610Salfred xfer->max_packet_size = MIN_PKT; 583184610Salfred xfer->max_packet_count = 1; 584184610Salfred parm->bufsize = 0; /* automatic setup length */ 585194228Sthompsa usbd_update_max_frame_size(xfer); 586184610Salfred 587184610Salfred } else { 588184610Salfred parm->err = USB_ERR_ZERO_MAXP; 589184610Salfred goto done; 590184610Salfred } 591184610Salfred 592184610Salfred } else { 593184610Salfred zmps = 0; 594184610Salfred } 595184610Salfred 596184610Salfred /* 597184610Salfred * check if we should setup a default 598184610Salfred * length: 599184610Salfred */ 600184610Salfred 601184610Salfred if (parm->bufsize == 0) { 602184610Salfred 603184610Salfred parm->bufsize = xfer->max_frame_size; 604184610Salfred 605184610Salfred if (type == UE_ISOCHRONOUS) { 606184610Salfred parm->bufsize *= xfer->nframes; 607184610Salfred } 608184610Salfred } 609184610Salfred /* 610184610Salfred * check if we are about to setup a proxy 611184610Salfred * type of buffer: 612184610Salfred */ 613184610Salfred 614184610Salfred if (xfer->flags.proxy_buffer) { 615184610Salfred 616184610Salfred /* round bufsize up */ 617184610Salfred 618184610Salfred parm->bufsize += (xfer->max_frame_size - 1); 619184610Salfred 620184610Salfred if (parm->bufsize < xfer->max_frame_size) { 621184610Salfred /* length wrapped around */ 622184610Salfred parm->err = USB_ERR_INVAL; 623184610Salfred goto done; 624184610Salfred } 625184610Salfred /* subtract remainder */ 626184610Salfred 627184610Salfred parm->bufsize -= (parm->bufsize % xfer->max_frame_size); 628184610Salfred 629184610Salfred /* add length of USB device request structure, if any */ 630184610Salfred 631184610Salfred if (type == UE_CONTROL) { 632184610Salfred parm->bufsize += REQ_SIZE; /* SETUP message */ 633184610Salfred } 634184610Salfred } 635184610Salfred xfer->max_data_length = parm->bufsize; 636184610Salfred 637184610Salfred /* Setup "n_frlengths" and "n_frbuffers" */ 638184610Salfred 639184610Salfred if (type == UE_ISOCHRONOUS) { 640184610Salfred n_frlengths = xfer->nframes; 641184610Salfred n_frbuffers = 1; 642184610Salfred } else { 643184610Salfred 644184610Salfred if (type == UE_CONTROL) { 645184610Salfred xfer->flags_int.control_xfr = 1; 646184610Salfred if (xfer->nframes == 0) { 647184610Salfred if (parm->bufsize <= REQ_SIZE) { 648184610Salfred /* 649184610Salfred * there will never be any data 650184610Salfred * stage 651184610Salfred */ 652184610Salfred xfer->nframes = 1; 653184610Salfred } else { 654184610Salfred xfer->nframes = 2; 655184610Salfred } 656184610Salfred } 657184610Salfred } else { 658184610Salfred if (xfer->nframes == 0) { 659184610Salfred xfer->nframes = 1; 660184610Salfred } 661184610Salfred } 662184610Salfred 663184610Salfred n_frlengths = xfer->nframes; 664184610Salfred n_frbuffers = xfer->nframes; 665184610Salfred } 666184610Salfred 667184610Salfred /* 668184610Salfred * check if we have room for the 669184610Salfred * USB device request structure: 670184610Salfred */ 671184610Salfred 672184610Salfred if (type == UE_CONTROL) { 673184610Salfred 674184610Salfred if (xfer->max_data_length < REQ_SIZE) { 675184610Salfred /* length wrapped around or too small bufsize */ 676184610Salfred parm->err = USB_ERR_INVAL; 677184610Salfred goto done; 678184610Salfred } 679184610Salfred xfer->max_data_length -= REQ_SIZE; 680184610Salfred } 681220301Shselasky /* 682220301Shselasky * Setup "frlengths" and shadow "frlengths" for keeping the 683220301Shselasky * initial frame lengths when a USB transfer is complete. This 684220301Shselasky * information is useful when computing isochronous offsets. 685220301Shselasky */ 686184610Salfred xfer->frlengths = parm->xfer_length_ptr; 687220301Shselasky parm->xfer_length_ptr += 2 * n_frlengths; 688184610Salfred 689184610Salfred /* setup "frbuffers" */ 690184610Salfred xfer->frbuffers = parm->xfer_page_cache_ptr; 691184610Salfred parm->xfer_page_cache_ptr += n_frbuffers; 692184610Salfred 693194677Sthompsa /* initialize max frame count */ 694194677Sthompsa xfer->max_frame_count = xfer->nframes; 695194677Sthompsa 696184610Salfred /* 697184610Salfred * check if we need to setup 698184610Salfred * a local buffer: 699184610Salfred */ 700184610Salfred 701184610Salfred if (!xfer->flags.ext_buffer) { 702184610Salfred 703184610Salfred /* align data */ 704184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 705184610Salfred 706184610Salfred if (parm->buf) { 707184610Salfred 708184610Salfred xfer->local_buffer = 709184610Salfred USB_ADD_BYTES(parm->buf, parm->size[0]); 710184610Salfred 711194677Sthompsa usbd_xfer_set_frame_offset(xfer, 0, 0); 712184610Salfred 713184610Salfred if ((type == UE_CONTROL) && (n_frbuffers > 1)) { 714194677Sthompsa usbd_xfer_set_frame_offset(xfer, REQ_SIZE, 1); 715184610Salfred } 716184610Salfred } 717184610Salfred parm->size[0] += parm->bufsize; 718184610Salfred 719184610Salfred /* align data again */ 720184610Salfred parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 721184610Salfred } 722184610Salfred /* 723184610Salfred * Compute maximum buffer size 724184610Salfred */ 725184610Salfred 726184610Salfred if (parm->bufsize_max < parm->bufsize) { 727184610Salfred parm->bufsize_max = parm->bufsize; 728184610Salfred } 729190180Sthompsa#if USB_HAVE_BUSDMA 730184610Salfred if (xfer->flags_int.bdma_enable) { 731184610Salfred /* 732184610Salfred * Setup "dma_page_ptr". 733184610Salfred * 734184610Salfred * Proof for formula below: 735184610Salfred * 736184610Salfred * Assume there are three USB frames having length "a", "b" and 737184610Salfred * "c". These USB frames will at maximum need "z" 738192984Sthompsa * "usb_page" structures. "z" is given by: 739184610Salfred * 740184610Salfred * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) + 741184610Salfred * ((c / USB_PAGE_SIZE) + 2); 742184610Salfred * 743184610Salfred * Constraining "a", "b" and "c" like this: 744184610Salfred * 745184610Salfred * (a + b + c) <= parm->bufsize 746184610Salfred * 747184610Salfred * We know that: 748184610Salfred * 749184610Salfred * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2)); 750184610Salfred * 751184610Salfred * Here is the general formula: 752184610Salfred */ 753184610Salfred xfer->dma_page_ptr = parm->dma_page_ptr; 754184610Salfred parm->dma_page_ptr += (2 * n_frbuffers); 755184610Salfred parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE); 756184610Salfred } 757190180Sthompsa#endif 758184610Salfred if (zmps) { 759184610Salfred /* correct maximum data length */ 760184610Salfred xfer->max_data_length = 0; 761184610Salfred } 762184610Salfred /* subtract USB frame remainder from "hc_max_frame_size" */ 763184610Salfred 764190181Sthompsa xfer->max_hc_frame_size = 765184610Salfred (parm->hc_max_frame_size - 766184610Salfred (parm->hc_max_frame_size % xfer->max_frame_size)); 767184610Salfred 768190181Sthompsa if (xfer->max_hc_frame_size == 0) { 769184610Salfred parm->err = USB_ERR_INVAL; 770184610Salfred goto done; 771184610Salfred } 772184610Salfred 773184610Salfred /* initialize frame buffers */ 774184610Salfred 775184610Salfred if (parm->buf) { 776184610Salfred for (x = 0; x != n_frbuffers; x++) { 777184610Salfred xfer->frbuffers[x].tag_parent = 778187173Sthompsa &xfer->xroot->dma_parent_tag; 779190180Sthompsa#if USB_HAVE_BUSDMA 780184610Salfred if (xfer->flags_int.bdma_enable && 781184610Salfred (parm->bufsize_max > 0)) { 782184610Salfred 783194228Sthompsa if (usb_pc_dmamap_create( 784184610Salfred xfer->frbuffers + x, 785184610Salfred parm->bufsize_max)) { 786184610Salfred parm->err = USB_ERR_NOMEM; 787184610Salfred goto done; 788184610Salfred } 789184610Salfred } 790190180Sthompsa#endif 791184610Salfred } 792184610Salfred } 793184610Salfreddone: 794184610Salfred if (parm->err) { 795184610Salfred /* 796184610Salfred * Set some dummy values so that we avoid division by zero: 797184610Salfred */ 798190181Sthompsa xfer->max_hc_frame_size = 1; 799184610Salfred xfer->max_frame_size = 1; 800184610Salfred xfer->max_packet_size = 1; 801184610Salfred xfer->max_data_length = 0; 802184610Salfred xfer->nframes = 0; 803184610Salfred xfer->max_frame_count = 0; 804184610Salfred } 805184610Salfred} 806184610Salfred 807184610Salfred/*------------------------------------------------------------------------* 808194228Sthompsa * usbd_transfer_setup - setup an array of USB transfers 809184610Salfred * 810194228Sthompsa * NOTE: You must always call "usbd_transfer_unsetup" after calling 811194228Sthompsa * "usbd_transfer_setup" if success was returned. 812184610Salfred * 813184610Salfred * The idea is that the USB device driver should pre-allocate all its 814184610Salfred * transfers by one call to this function. 815184610Salfred * 816184610Salfred * Return values: 817184610Salfred * 0: Success 818184610Salfred * Else: Failure 819184610Salfred *------------------------------------------------------------------------*/ 820193045Sthompsausb_error_t 821194228Sthompsausbd_transfer_setup(struct usb_device *udev, 822192984Sthompsa const uint8_t *ifaces, struct usb_xfer **ppxfer, 823192984Sthompsa const struct usb_config *setup_start, uint16_t n_setup, 824187173Sthompsa void *priv_sc, struct mtx *xfer_mtx) 825184610Salfred{ 826192984Sthompsa const struct usb_config *setup_end = setup_start + n_setup; 827192984Sthompsa const struct usb_config *setup; 828247090Shselasky struct usb_setup_params *parm; 829193644Sthompsa struct usb_endpoint *ep; 830192984Sthompsa struct usb_xfer_root *info; 831192984Sthompsa struct usb_xfer *xfer; 832184610Salfred void *buf = NULL; 833247090Shselasky usb_error_t error = 0; 834184610Salfred uint16_t n; 835184610Salfred uint16_t refcount; 836247090Shselasky uint8_t do_unlock; 837184610Salfred 838184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 839194228Sthompsa "usbd_transfer_setup can sleep!"); 840184610Salfred 841184610Salfred /* do some checking first */ 842184610Salfred 843184610Salfred if (n_setup == 0) { 844184610Salfred DPRINTFN(6, "setup array has zero length!\n"); 845184610Salfred return (USB_ERR_INVAL); 846184610Salfred } 847184610Salfred if (ifaces == 0) { 848184610Salfred DPRINTFN(6, "ifaces array is NULL!\n"); 849184610Salfred return (USB_ERR_INVAL); 850184610Salfred } 851187173Sthompsa if (xfer_mtx == NULL) { 852184610Salfred DPRINTFN(6, "using global lock\n"); 853187173Sthompsa xfer_mtx = &Giant; 854184610Salfred } 855247090Shselasky 856247090Shselasky /* more sanity checks */ 857247090Shselasky 858184610Salfred for (setup = setup_start, n = 0; 859184610Salfred setup != setup_end; setup++, n++) { 860193045Sthompsa if (setup->bufsize == (usb_frlength_t)-1) { 861247090Shselasky error = USB_ERR_BAD_BUFSIZE; 862184610Salfred DPRINTF("invalid bufsize\n"); 863184610Salfred } 864190734Sthompsa if (setup->callback == NULL) { 865247090Shselasky error = USB_ERR_NO_CALLBACK; 866184610Salfred DPRINTF("no callback\n"); 867184610Salfred } 868184610Salfred ppxfer[n] = NULL; 869184610Salfred } 870184610Salfred 871247090Shselasky if (error) 872247090Shselasky return (error); 873184610Salfred 874247090Shselasky /* Protect scratch area */ 875247090Shselasky do_unlock = usbd_enum_lock(udev); 876184610Salfred 877247090Shselasky refcount = 0; 878247090Shselasky info = NULL; 879247090Shselasky 880247090Shselasky parm = &udev->scratch.xfer_setup[0].parm; 881247090Shselasky memset(parm, 0, sizeof(*parm)); 882247090Shselasky 883247090Shselasky parm->udev = udev; 884247090Shselasky parm->speed = usbd_get_speed(udev); 885247090Shselasky parm->hc_max_packet_count = 1; 886247090Shselasky 887247090Shselasky if (parm->speed >= USB_SPEED_MAX) { 888247090Shselasky parm->err = USB_ERR_INVAL; 889184610Salfred goto done; 890184610Salfred } 891184610Salfred /* setup all transfers */ 892184610Salfred 893184610Salfred while (1) { 894184610Salfred 895184610Salfred if (buf) { 896184610Salfred /* 897192984Sthompsa * Initialize the "usb_xfer_root" structure, 898184610Salfred * which is common for all our USB transfers. 899184610Salfred */ 900184610Salfred info = USB_ADD_BYTES(buf, 0); 901184610Salfred 902184610Salfred info->memory_base = buf; 903247090Shselasky info->memory_size = parm->size[0]; 904184610Salfred 905190180Sthompsa#if USB_HAVE_BUSDMA 906247090Shselasky info->dma_page_cache_start = USB_ADD_BYTES(buf, parm->size[4]); 907247090Shselasky info->dma_page_cache_end = USB_ADD_BYTES(buf, parm->size[5]); 908190180Sthompsa#endif 909247090Shselasky info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm->size[5]); 910247090Shselasky info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm->size[2]); 911184610Salfred 912194227Sthompsa cv_init(&info->cv_drain, "WDRAIN"); 913184610Salfred 914187173Sthompsa info->xfer_mtx = xfer_mtx; 915190180Sthompsa#if USB_HAVE_BUSDMA 916194228Sthompsa usb_dma_tag_setup(&info->dma_parent_tag, 917247090Shselasky parm->dma_tag_p, udev->bus->dma_parent_tag[0].tag, 918247090Shselasky xfer_mtx, &usb_bdma_done_event, 32, parm->dma_tag_max); 919190180Sthompsa#endif 920184610Salfred 921184610Salfred info->bus = udev->bus; 922187173Sthompsa info->udev = udev; 923184610Salfred 924184610Salfred TAILQ_INIT(&info->done_q.head); 925194228Sthompsa info->done_q.command = &usbd_callback_wrapper; 926190180Sthompsa#if USB_HAVE_BUSDMA 927184610Salfred TAILQ_INIT(&info->dma_q.head); 928194228Sthompsa info->dma_q.command = &usb_bdma_work_loop; 929190180Sthompsa#endif 930194228Sthompsa info->done_m[0].hdr.pm_callback = &usb_callback_proc; 931187173Sthompsa info->done_m[0].xroot = info; 932194228Sthompsa info->done_m[1].hdr.pm_callback = &usb_callback_proc; 933187173Sthompsa info->done_m[1].xroot = info; 934184610Salfred 935191400Sthompsa /* 936191400Sthompsa * In device side mode control endpoint 937191400Sthompsa * requests need to run from a separate 938191400Sthompsa * context, else there is a chance of 939191400Sthompsa * deadlock! 940191400Sthompsa */ 941194228Sthompsa if (setup_start == usb_control_ep_cfg) 942187174Sthompsa info->done_p = 943191400Sthompsa &udev->bus->control_xfer_proc; 944191400Sthompsa else if (xfer_mtx == &Giant) 945191400Sthompsa info->done_p = 946187174Sthompsa &udev->bus->giant_callback_proc; 947187174Sthompsa else 948187174Sthompsa info->done_p = 949187174Sthompsa &udev->bus->non_giant_callback_proc; 950184610Salfred } 951184610Salfred /* reset sizes */ 952184610Salfred 953247090Shselasky parm->size[0] = 0; 954247090Shselasky parm->buf = buf; 955247090Shselasky parm->size[0] += sizeof(info[0]); 956184610Salfred 957184610Salfred for (setup = setup_start, n = 0; 958184610Salfred setup != setup_end; setup++, n++) { 959184610Salfred 960184610Salfred /* skip USB transfers without callbacks: */ 961190734Sthompsa if (setup->callback == NULL) { 962184610Salfred continue; 963184610Salfred } 964184610Salfred /* see if there is a matching endpoint */ 965194228Sthompsa ep = usbd_get_endpoint(udev, 966184610Salfred ifaces[setup->if_index], setup); 967184610Salfred 968193644Sthompsa if ((ep == NULL) || (ep->methods == NULL)) { 969190734Sthompsa if (setup->flags.no_pipe_ok) 970184610Salfred continue; 971192499Sthompsa if ((setup->usb_mode != USB_MODE_DUAL) && 972192499Sthompsa (setup->usb_mode != udev->flags.usb_mode)) 973190734Sthompsa continue; 974247090Shselasky parm->err = USB_ERR_NO_PIPE; 975184610Salfred goto done; 976184610Salfred } 977184610Salfred 978184610Salfred /* align data properly */ 979247090Shselasky parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 980184610Salfred 981190734Sthompsa /* store current setup pointer */ 982247090Shselasky parm->curr_setup = setup; 983190734Sthompsa 984184610Salfred if (buf) { 985184610Salfred /* 986184610Salfred * Common initialization of the 987192984Sthompsa * "usb_xfer" structure. 988184610Salfred */ 989247090Shselasky xfer = USB_ADD_BYTES(buf, parm->size[0]); 990184610Salfred xfer->address = udev->address; 991184610Salfred xfer->priv_sc = priv_sc; 992187173Sthompsa xfer->xroot = info; 993184610Salfred 994194228Sthompsa usb_callout_init_mtx(&xfer->timeout_handle, 995186454Sthompsa &udev->bus->bus_mtx, 0); 996184610Salfred } else { 997184610Salfred /* 998184610Salfred * Setup a dummy xfer, hence we are 999192984Sthompsa * writing to the "usb_xfer" 1000184610Salfred * structure pointed to by "xfer" 1001184610Salfred * before we have allocated any 1002184610Salfred * memory: 1003184610Salfred */ 1004247090Shselasky xfer = &udev->scratch.xfer_setup[0].dummy; 1005247090Shselasky memset(xfer, 0, sizeof(*xfer)); 1006184610Salfred refcount++; 1007184610Salfred } 1008184610Salfred 1009193644Sthompsa /* set transfer endpoint pointer */ 1010193644Sthompsa xfer->endpoint = ep; 1011188982Sthompsa 1012247090Shselasky parm->size[0] += sizeof(xfer[0]); 1013247090Shselasky parm->methods = xfer->endpoint->methods; 1014247090Shselasky parm->curr_xfer = xfer; 1015184610Salfred 1016188982Sthompsa /* 1017188982Sthompsa * Call the Host or Device controller transfer 1018188982Sthompsa * setup routine: 1019188982Sthompsa */ 1020247090Shselasky (udev->bus->methods->xfer_setup) (parm); 1021184610Salfred 1022188982Sthompsa /* check for error */ 1023247090Shselasky if (parm->err) 1024188982Sthompsa goto done; 1025188982Sthompsa 1026184610Salfred if (buf) { 1027184610Salfred /* 1028193644Sthompsa * Increment the endpoint refcount. This 1029184610Salfred * basically prevents setting a new 1030184610Salfred * configuration and alternate setting 1031184610Salfred * when USB transfers are in use on 1032184610Salfred * the given interface. Search the USB 1033199672Sthompsa * code for "endpoint->refcount_alloc" if you 1034184610Salfred * want more information. 1035184610Salfred */ 1036199672Sthompsa USB_BUS_LOCK(info->bus); 1037199672Sthompsa if (xfer->endpoint->refcount_alloc >= USB_EP_REF_MAX) 1038247090Shselasky parm->err = USB_ERR_INVAL; 1039184610Salfred 1040199672Sthompsa xfer->endpoint->refcount_alloc++; 1041199672Sthompsa 1042199672Sthompsa if (xfer->endpoint->refcount_alloc == 0) 1043199672Sthompsa panic("usbd_transfer_setup(): Refcount wrapped to zero\n"); 1044199672Sthompsa USB_BUS_UNLOCK(info->bus); 1045199672Sthompsa 1046188982Sthompsa /* 1047188982Sthompsa * Whenever we set ppxfer[] then we 1048188982Sthompsa * also need to increment the 1049188982Sthompsa * "setup_refcount": 1050188982Sthompsa */ 1051188982Sthompsa info->setup_refcount++; 1052184610Salfred 1053188982Sthompsa /* 1054188982Sthompsa * Transfer is successfully setup and 1055188982Sthompsa * can be used: 1056188982Sthompsa */ 1057188982Sthompsa ppxfer[n] = xfer; 1058184610Salfred } 1059199672Sthompsa 1060199672Sthompsa /* check for error */ 1061247090Shselasky if (parm->err) 1062199672Sthompsa goto done; 1063184610Salfred } 1064184610Salfred 1065247090Shselasky if (buf != NULL || parm->err != 0) 1066184610Salfred goto done; 1067247090Shselasky 1068247090Shselasky /* if no transfers, nothing to do */ 1069247090Shselasky if (refcount == 0) 1070184610Salfred goto done; 1071247090Shselasky 1072184610Salfred /* align data properly */ 1073247090Shselasky parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 1074184610Salfred 1075184610Salfred /* store offset temporarily */ 1076247090Shselasky parm->size[1] = parm->size[0]; 1077184610Salfred 1078184610Salfred /* 1079184610Salfred * The number of DMA tags required depends on 1080184610Salfred * the number of endpoints. The current estimate 1081184610Salfred * for maximum number of DMA tags per endpoint 1082184610Salfred * is two. 1083184610Salfred */ 1084247090Shselasky parm->dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX); 1085184610Salfred 1086184610Salfred /* 1087184610Salfred * DMA tags for QH, TD, Data and more. 1088184610Salfred */ 1089247090Shselasky parm->dma_tag_max += 8; 1090184610Salfred 1091247090Shselasky parm->dma_tag_p += parm->dma_tag_max; 1092184610Salfred 1093247090Shselasky parm->size[0] += ((uint8_t *)parm->dma_tag_p) - 1094184610Salfred ((uint8_t *)0); 1095184610Salfred 1096184610Salfred /* align data properly */ 1097247090Shselasky parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 1098184610Salfred 1099184610Salfred /* store offset temporarily */ 1100247090Shselasky parm->size[3] = parm->size[0]; 1101184610Salfred 1102247090Shselasky parm->size[0] += ((uint8_t *)parm->dma_page_ptr) - 1103184610Salfred ((uint8_t *)0); 1104184610Salfred 1105184610Salfred /* align data properly */ 1106247090Shselasky parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 1107184610Salfred 1108184610Salfred /* store offset temporarily */ 1109247090Shselasky parm->size[4] = parm->size[0]; 1110184610Salfred 1111247090Shselasky parm->size[0] += ((uint8_t *)parm->dma_page_cache_ptr) - 1112184610Salfred ((uint8_t *)0); 1113184610Salfred 1114184610Salfred /* store end offset temporarily */ 1115247090Shselasky parm->size[5] = parm->size[0]; 1116184610Salfred 1117247090Shselasky parm->size[0] += ((uint8_t *)parm->xfer_page_cache_ptr) - 1118184610Salfred ((uint8_t *)0); 1119184610Salfred 1120184610Salfred /* store end offset temporarily */ 1121184610Salfred 1122247090Shselasky parm->size[2] = parm->size[0]; 1123184610Salfred 1124184610Salfred /* align data properly */ 1125247090Shselasky parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 1126184610Salfred 1127247090Shselasky parm->size[6] = parm->size[0]; 1128184610Salfred 1129247090Shselasky parm->size[0] += ((uint8_t *)parm->xfer_length_ptr) - 1130184610Salfred ((uint8_t *)0); 1131184610Salfred 1132184610Salfred /* align data properly */ 1133247090Shselasky parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 1134184610Salfred 1135184610Salfred /* allocate zeroed memory */ 1136247090Shselasky buf = malloc(parm->size[0], M_USB, M_WAITOK | M_ZERO); 1137184610Salfred 1138184610Salfred if (buf == NULL) { 1139247090Shselasky parm->err = USB_ERR_NOMEM; 1140184610Salfred DPRINTFN(0, "cannot allocate memory block for " 1141184610Salfred "configuration (%d bytes)\n", 1142247090Shselasky parm->size[0]); 1143184610Salfred goto done; 1144184610Salfred } 1145247090Shselasky parm->dma_tag_p = USB_ADD_BYTES(buf, parm->size[1]); 1146247090Shselasky parm->dma_page_ptr = USB_ADD_BYTES(buf, parm->size[3]); 1147247090Shselasky parm->dma_page_cache_ptr = USB_ADD_BYTES(buf, parm->size[4]); 1148247090Shselasky parm->xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm->size[5]); 1149247090Shselasky parm->xfer_length_ptr = USB_ADD_BYTES(buf, parm->size[6]); 1150184610Salfred } 1151184610Salfred 1152184610Salfreddone: 1153184610Salfred if (buf) { 1154184610Salfred if (info->setup_refcount == 0) { 1155184610Salfred /* 1156194228Sthompsa * "usbd_transfer_unsetup_sub" will unlock 1157184824Sthompsa * the bus mutex before returning ! 1158184610Salfred */ 1159184824Sthompsa USB_BUS_LOCK(info->bus); 1160184610Salfred 1161184610Salfred /* something went wrong */ 1162194228Sthompsa usbd_transfer_unsetup_sub(info, 0); 1163184610Salfred } 1164184610Salfred } 1165247090Shselasky 1166247090Shselasky /* check if any errors happened */ 1167247090Shselasky if (parm->err) 1168194228Sthompsa usbd_transfer_unsetup(ppxfer, n_setup); 1169247090Shselasky 1170247090Shselasky error = parm->err; 1171247090Shselasky 1172247090Shselasky if (do_unlock) 1173247090Shselasky usbd_enum_unlock(udev); 1174247090Shselasky 1175247090Shselasky return (error); 1176184610Salfred} 1177184610Salfred 1178184610Salfred/*------------------------------------------------------------------------* 1179194228Sthompsa * usbd_transfer_unsetup_sub - factored out code 1180184610Salfred *------------------------------------------------------------------------*/ 1181184610Salfredstatic void 1182194228Sthompsausbd_transfer_unsetup_sub(struct usb_xfer_root *info, uint8_t needs_delay) 1183184610Salfred{ 1184218475Shselasky#if USB_HAVE_BUSDMA 1185192984Sthompsa struct usb_page_cache *pc; 1186218475Shselasky#endif 1187184610Salfred 1188184824Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 1189184610Salfred 1190184610Salfred /* wait for any outstanding DMA operations */ 1191184610Salfred 1192184610Salfred if (needs_delay) { 1193193045Sthompsa usb_timeout_t temp; 1194212134Sthompsa temp = usbd_get_dma_delay(info->udev); 1195212134Sthompsa if (temp != 0) { 1196212134Sthompsa usb_pause_mtx(&info->bus->bus_mtx, 1197212134Sthompsa USB_MS_TO_TICKS(temp)); 1198212134Sthompsa } 1199184610Salfred } 1200187174Sthompsa 1201187174Sthompsa /* make sure that our done messages are not queued anywhere */ 1202194228Sthompsa usb_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]); 1203187174Sthompsa 1204184824Sthompsa USB_BUS_UNLOCK(info->bus); 1205184610Salfred 1206190180Sthompsa#if USB_HAVE_BUSDMA 1207184610Salfred /* free DMA'able memory, if any */ 1208184610Salfred pc = info->dma_page_cache_start; 1209184610Salfred while (pc != info->dma_page_cache_end) { 1210194228Sthompsa usb_pc_free_mem(pc); 1211184610Salfred pc++; 1212184610Salfred } 1213184610Salfred 1214184610Salfred /* free DMA maps in all "xfer->frbuffers" */ 1215184610Salfred pc = info->xfer_page_cache_start; 1216184610Salfred while (pc != info->xfer_page_cache_end) { 1217194228Sthompsa usb_pc_dmamap_destroy(pc); 1218184610Salfred pc++; 1219184610Salfred } 1220184610Salfred 1221184610Salfred /* free all DMA tags */ 1222194228Sthompsa usb_dma_tag_unsetup(&info->dma_parent_tag); 1223190180Sthompsa#endif 1224184610Salfred 1225194227Sthompsa cv_destroy(&info->cv_drain); 1226184610Salfred 1227184610Salfred /* 1228184610Salfred * free the "memory_base" last, hence the "info" structure is 1229184610Salfred * contained within the "memory_base"! 1230184610Salfred */ 1231184610Salfred free(info->memory_base, M_USB); 1232184610Salfred} 1233184610Salfred 1234184610Salfred/*------------------------------------------------------------------------* 1235194228Sthompsa * usbd_transfer_unsetup - unsetup/free an array of USB transfers 1236184610Salfred * 1237184610Salfred * NOTE: All USB transfers in progress will get called back passing 1238184610Salfred * the error code "USB_ERR_CANCELLED" before this function 1239184610Salfred * returns. 1240184610Salfred *------------------------------------------------------------------------*/ 1241184610Salfredvoid 1242194228Sthompsausbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup) 1243184610Salfred{ 1244192984Sthompsa struct usb_xfer *xfer; 1245192984Sthompsa struct usb_xfer_root *info; 1246184610Salfred uint8_t needs_delay = 0; 1247184610Salfred 1248184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1249194228Sthompsa "usbd_transfer_unsetup can sleep!"); 1250184610Salfred 1251184610Salfred while (n_setup--) { 1252184610Salfred xfer = pxfer[n_setup]; 1253184610Salfred 1254188982Sthompsa if (xfer == NULL) 1255188982Sthompsa continue; 1256184610Salfred 1257188982Sthompsa info = xfer->xroot; 1258184610Salfred 1259188982Sthompsa USB_XFER_LOCK(xfer); 1260188982Sthompsa USB_BUS_LOCK(info->bus); 1261184610Salfred 1262188982Sthompsa /* 1263188982Sthompsa * HINT: when you start/stop a transfer, it might be a 1264188982Sthompsa * good idea to directly use the "pxfer[]" structure: 1265188982Sthompsa * 1266194228Sthompsa * usbd_transfer_start(sc->pxfer[0]); 1267194228Sthompsa * usbd_transfer_stop(sc->pxfer[0]); 1268188982Sthompsa * 1269188982Sthompsa * That way, if your code has many parts that will not 1270188982Sthompsa * stop running under the same lock, in other words 1271194228Sthompsa * "xfer_mtx", the usbd_transfer_start and 1272194228Sthompsa * usbd_transfer_stop functions will simply return 1273188982Sthompsa * when they detect a NULL pointer argument. 1274188982Sthompsa * 1275188982Sthompsa * To avoid any races we clear the "pxfer[]" pointer 1276188982Sthompsa * while holding the private mutex of the driver: 1277188982Sthompsa */ 1278188982Sthompsa pxfer[n_setup] = NULL; 1279184610Salfred 1280188982Sthompsa USB_BUS_UNLOCK(info->bus); 1281188982Sthompsa USB_XFER_UNLOCK(xfer); 1282184610Salfred 1283194228Sthompsa usbd_transfer_drain(xfer); 1284184610Salfred 1285190180Sthompsa#if USB_HAVE_BUSDMA 1286188982Sthompsa if (xfer->flags_int.bdma_enable) 1287188982Sthompsa needs_delay = 1; 1288190180Sthompsa#endif 1289188982Sthompsa /* 1290193644Sthompsa * NOTE: default endpoint does not have an 1291193644Sthompsa * interface, even if endpoint->iface_index == 0 1292188982Sthompsa */ 1293199672Sthompsa USB_BUS_LOCK(info->bus); 1294199672Sthompsa xfer->endpoint->refcount_alloc--; 1295199672Sthompsa USB_BUS_UNLOCK(info->bus); 1296184610Salfred 1297194228Sthompsa usb_callout_drain(&xfer->timeout_handle); 1298184610Salfred 1299188982Sthompsa USB_BUS_LOCK(info->bus); 1300184610Salfred 1301188982Sthompsa USB_ASSERT(info->setup_refcount != 0, ("Invalid setup " 1302199816Sthompsa "reference count\n")); 1303184610Salfred 1304188982Sthompsa info->setup_refcount--; 1305188982Sthompsa 1306188982Sthompsa if (info->setup_refcount == 0) { 1307194228Sthompsa usbd_transfer_unsetup_sub(info, 1308188982Sthompsa needs_delay); 1309188982Sthompsa } else { 1310188982Sthompsa USB_BUS_UNLOCK(info->bus); 1311184610Salfred } 1312184610Salfred } 1313184610Salfred} 1314184610Salfred 1315184610Salfred/*------------------------------------------------------------------------* 1316194228Sthompsa * usbd_control_transfer_init - factored out code 1317184610Salfred * 1318184610Salfred * In USB Device Mode we have to wait for the SETUP packet which 1319192984Sthompsa * containst the "struct usb_device_request" structure, before we can 1320184610Salfred * transfer any data. In USB Host Mode we already have the SETUP 1321184610Salfred * packet at the moment the USB transfer is started. This leads us to 1322184610Salfred * having to setup the USB transfer at two different places in 1323184610Salfred * time. This function just contains factored out control transfer 1324184610Salfred * initialisation code, so that we don't duplicate the code. 1325184610Salfred *------------------------------------------------------------------------*/ 1326184610Salfredstatic void 1327194228Sthompsausbd_control_transfer_init(struct usb_xfer *xfer) 1328184610Salfred{ 1329192984Sthompsa struct usb_device_request req; 1330184610Salfred 1331184610Salfred /* copy out the USB request header */ 1332184610Salfred 1333194228Sthompsa usbd_copy_out(xfer->frbuffers, 0, &req, sizeof(req)); 1334184610Salfred 1335184610Salfred /* setup remainder */ 1336184610Salfred 1337184610Salfred xfer->flags_int.control_rem = UGETW(req.wLength); 1338184610Salfred 1339184610Salfred /* copy direction to endpoint variable */ 1340184610Salfred 1341193644Sthompsa xfer->endpointno &= ~(UE_DIR_IN | UE_DIR_OUT); 1342193644Sthompsa xfer->endpointno |= 1343184610Salfred (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT; 1344184610Salfred} 1345184610Salfred 1346184610Salfred/*------------------------------------------------------------------------* 1347194677Sthompsa * usbd_setup_ctrl_transfer 1348184610Salfred * 1349184610Salfred * This function handles initialisation of control transfers. Control 1350184610Salfred * transfers are special in that regard that they can both transmit 1351184610Salfred * and receive data. 1352184610Salfred * 1353184610Salfred * Return values: 1354184610Salfred * 0: Success 1355184610Salfred * Else: Failure 1356184610Salfred *------------------------------------------------------------------------*/ 1357194677Sthompsastatic int 1358194677Sthompsausbd_setup_ctrl_transfer(struct usb_xfer *xfer) 1359184610Salfred{ 1360193045Sthompsa usb_frlength_t len; 1361184610Salfred 1362184610Salfred /* Check for control endpoint stall */ 1363192552Sthompsa if (xfer->flags.stall_pipe && xfer->flags_int.control_act) { 1364192552Sthompsa /* the control transfer is no longer active */ 1365192552Sthompsa xfer->flags_int.control_stall = 1; 1366184610Salfred xfer->flags_int.control_act = 0; 1367192552Sthompsa } else { 1368192552Sthompsa /* don't stall control transfer by default */ 1369192552Sthompsa xfer->flags_int.control_stall = 0; 1370184610Salfred } 1371190184Sthompsa 1372190184Sthompsa /* Check for invalid number of frames */ 1373190184Sthompsa if (xfer->nframes > 2) { 1374190184Sthompsa /* 1375190184Sthompsa * If you need to split a control transfer, you 1376190184Sthompsa * have to do one part at a time. Only with 1377190184Sthompsa * non-control transfers you can do multiple 1378190184Sthompsa * parts a time. 1379190184Sthompsa */ 1380190184Sthompsa DPRINTFN(0, "Too many frames: %u\n", 1381190184Sthompsa (unsigned int)xfer->nframes); 1382190184Sthompsa goto error; 1383190184Sthompsa } 1384190184Sthompsa 1385184610Salfred /* 1386184610Salfred * Check if there is a control 1387184610Salfred * transfer in progress: 1388184610Salfred */ 1389184610Salfred if (xfer->flags_int.control_act) { 1390184610Salfred 1391184610Salfred if (xfer->flags_int.control_hdr) { 1392184610Salfred 1393184610Salfred /* clear send header flag */ 1394184610Salfred 1395184610Salfred xfer->flags_int.control_hdr = 0; 1396184610Salfred 1397184610Salfred /* setup control transfer */ 1398192499Sthompsa if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1399194228Sthompsa usbd_control_transfer_init(xfer); 1400184610Salfred } 1401184610Salfred } 1402184610Salfred /* get data length */ 1403184610Salfred 1404184610Salfred len = xfer->sumlen; 1405184610Salfred 1406184610Salfred } else { 1407184610Salfred 1408184610Salfred /* the size of the SETUP structure is hardcoded ! */ 1409184610Salfred 1410192984Sthompsa if (xfer->frlengths[0] != sizeof(struct usb_device_request)) { 1411184610Salfred DPRINTFN(0, "Wrong framelength %u != %zu\n", 1412184610Salfred xfer->frlengths[0], sizeof(struct 1413192984Sthompsa usb_device_request)); 1414184610Salfred goto error; 1415184610Salfred } 1416184610Salfred /* check USB mode */ 1417192499Sthompsa if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1418184610Salfred 1419184610Salfred /* check number of frames */ 1420184610Salfred if (xfer->nframes != 1) { 1421184610Salfred /* 1422184610Salfred * We need to receive the setup 1423184610Salfred * message first so that we know the 1424184610Salfred * data direction! 1425184610Salfred */ 1426184610Salfred DPRINTF("Misconfigured transfer\n"); 1427184610Salfred goto error; 1428184610Salfred } 1429184610Salfred /* 1430184610Salfred * Set a dummy "control_rem" value. This 1431184610Salfred * variable will be overwritten later by a 1432194228Sthompsa * call to "usbd_control_transfer_init()" ! 1433184610Salfred */ 1434184610Salfred xfer->flags_int.control_rem = 0xFFFF; 1435184610Salfred } else { 1436184610Salfred 1437184610Salfred /* setup "endpoint" and "control_rem" */ 1438184610Salfred 1439194228Sthompsa usbd_control_transfer_init(xfer); 1440184610Salfred } 1441184610Salfred 1442184610Salfred /* set transfer-header flag */ 1443184610Salfred 1444184610Salfred xfer->flags_int.control_hdr = 1; 1445184610Salfred 1446184610Salfred /* get data length */ 1447184610Salfred 1448192984Sthompsa len = (xfer->sumlen - sizeof(struct usb_device_request)); 1449184610Salfred } 1450184610Salfred 1451184610Salfred /* check if there is a length mismatch */ 1452184610Salfred 1453184610Salfred if (len > xfer->flags_int.control_rem) { 1454197562Sthompsa DPRINTFN(0, "Length (%d) greater than " 1455199816Sthompsa "remaining length (%d)\n", len, 1456197562Sthompsa xfer->flags_int.control_rem); 1457184610Salfred goto error; 1458184610Salfred } 1459184610Salfred /* check if we are doing a short transfer */ 1460184610Salfred 1461184610Salfred if (xfer->flags.force_short_xfer) { 1462184610Salfred xfer->flags_int.control_rem = 0; 1463184610Salfred } else { 1464184610Salfred if ((len != xfer->max_data_length) && 1465184610Salfred (len != xfer->flags_int.control_rem) && 1466184610Salfred (xfer->nframes != 1)) { 1467184610Salfred DPRINTFN(0, "Short control transfer without " 1468199816Sthompsa "force_short_xfer set\n"); 1469184610Salfred goto error; 1470184610Salfred } 1471184610Salfred xfer->flags_int.control_rem -= len; 1472184610Salfred } 1473184610Salfred 1474184610Salfred /* the status part is executed when "control_act" is 0 */ 1475184610Salfred 1476184610Salfred if ((xfer->flags_int.control_rem > 0) || 1477184610Salfred (xfer->flags.manual_status)) { 1478184610Salfred /* don't execute the STATUS stage yet */ 1479184610Salfred xfer->flags_int.control_act = 1; 1480184610Salfred 1481184610Salfred /* sanity check */ 1482184610Salfred if ((!xfer->flags_int.control_hdr) && 1483184610Salfred (xfer->nframes == 1)) { 1484184610Salfred /* 1485184610Salfred * This is not a valid operation! 1486184610Salfred */ 1487184610Salfred DPRINTFN(0, "Invalid parameter " 1488184610Salfred "combination\n"); 1489184610Salfred goto error; 1490184610Salfred } 1491184610Salfred } else { 1492184610Salfred /* time to execute the STATUS stage */ 1493184610Salfred xfer->flags_int.control_act = 0; 1494184610Salfred } 1495184610Salfred return (0); /* success */ 1496184610Salfred 1497184610Salfrederror: 1498184610Salfred return (1); /* failure */ 1499184610Salfred} 1500184610Salfred 1501184610Salfred/*------------------------------------------------------------------------* 1502194228Sthompsa * usbd_transfer_submit - start USB hardware for the given transfer 1503184610Salfred * 1504184610Salfred * This function should only be called from the USB callback. 1505184610Salfred *------------------------------------------------------------------------*/ 1506184610Salfredvoid 1507194228Sthompsausbd_transfer_submit(struct usb_xfer *xfer) 1508184610Salfred{ 1509192984Sthompsa struct usb_xfer_root *info; 1510192984Sthompsa struct usb_bus *bus; 1511193045Sthompsa usb_frcount_t x; 1512184610Salfred 1513191494Sthompsa info = xfer->xroot; 1514191494Sthompsa bus = info->bus; 1515191494Sthompsa 1516193644Sthompsa DPRINTF("xfer=%p, endpoint=%p, nframes=%d, dir=%s\n", 1517193644Sthompsa xfer, xfer->endpoint, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ? 1518184610Salfred "read" : "write"); 1519184610Salfred 1520207077Sthompsa#ifdef USB_DEBUG 1521184610Salfred if (USB_DEBUG_VAR > 0) { 1522191494Sthompsa USB_BUS_LOCK(bus); 1523184610Salfred 1524194228Sthompsa usb_dump_endpoint(xfer->endpoint); 1525184610Salfred 1526191494Sthompsa USB_BUS_UNLOCK(bus); 1527184610Salfred } 1528184610Salfred#endif 1529184610Salfred 1530184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1531191494Sthompsa USB_BUS_LOCK_ASSERT(bus, MA_NOTOWNED); 1532184610Salfred 1533184610Salfred /* Only open the USB transfer once! */ 1534184610Salfred if (!xfer->flags_int.open) { 1535184610Salfred xfer->flags_int.open = 1; 1536184610Salfred 1537184610Salfred DPRINTF("open\n"); 1538184610Salfred 1539191494Sthompsa USB_BUS_LOCK(bus); 1540193644Sthompsa (xfer->endpoint->methods->open) (xfer); 1541191494Sthompsa USB_BUS_UNLOCK(bus); 1542184610Salfred } 1543184610Salfred /* set "transferring" flag */ 1544184610Salfred xfer->flags_int.transferring = 1; 1545184610Salfred 1546190734Sthompsa#if USB_HAVE_POWERD 1547186730Salfred /* increment power reference */ 1548194228Sthompsa usbd_transfer_power_ref(xfer, 1); 1549190734Sthompsa#endif 1550184610Salfred /* 1551184610Salfred * Check if the transfer is waiting on a queue, most 1552184610Salfred * frequently the "done_q": 1553184610Salfred */ 1554184610Salfred if (xfer->wait_queue) { 1555191494Sthompsa USB_BUS_LOCK(bus); 1556194228Sthompsa usbd_transfer_dequeue(xfer); 1557191494Sthompsa USB_BUS_UNLOCK(bus); 1558184610Salfred } 1559184610Salfred /* clear "did_dma_delay" flag */ 1560184610Salfred xfer->flags_int.did_dma_delay = 0; 1561184610Salfred 1562184610Salfred /* clear "did_close" flag */ 1563184610Salfred xfer->flags_int.did_close = 0; 1564184610Salfred 1565190180Sthompsa#if USB_HAVE_BUSDMA 1566184610Salfred /* clear "bdma_setup" flag */ 1567184610Salfred xfer->flags_int.bdma_setup = 0; 1568190180Sthompsa#endif 1569184610Salfred /* by default we cannot cancel any USB transfer immediately */ 1570184610Salfred xfer->flags_int.can_cancel_immed = 0; 1571184610Salfred 1572184610Salfred /* clear lengths and frame counts by default */ 1573184610Salfred xfer->sumlen = 0; 1574184610Salfred xfer->actlen = 0; 1575184610Salfred xfer->aframes = 0; 1576184610Salfred 1577184610Salfred /* clear any previous errors */ 1578184610Salfred xfer->error = 0; 1579184610Salfred 1580191824Sthompsa /* Check if the device is still alive */ 1581191824Sthompsa if (info->udev->state < USB_STATE_POWERED) { 1582191824Sthompsa USB_BUS_LOCK(bus); 1583192051Sthompsa /* 1584192051Sthompsa * Must return cancelled error code else 1585192051Sthompsa * device drivers can hang. 1586192051Sthompsa */ 1587194228Sthompsa usbd_transfer_done(xfer, USB_ERR_CANCELLED); 1588191824Sthompsa USB_BUS_UNLOCK(bus); 1589191824Sthompsa return; 1590191824Sthompsa } 1591191824Sthompsa 1592184610Salfred /* sanity check */ 1593184610Salfred if (xfer->nframes == 0) { 1594184610Salfred if (xfer->flags.stall_pipe) { 1595184610Salfred /* 1596184610Salfred * Special case - want to stall without transferring 1597184610Salfred * any data: 1598184610Salfred */ 1599184610Salfred DPRINTF("xfer=%p nframes=0: stall " 1600184610Salfred "or clear stall!\n", xfer); 1601191494Sthompsa USB_BUS_LOCK(bus); 1602184610Salfred xfer->flags_int.can_cancel_immed = 1; 1603184610Salfred /* start the transfer */ 1604194228Sthompsa usb_command_wrapper(&xfer->endpoint->endpoint_q, xfer); 1605191494Sthompsa USB_BUS_UNLOCK(bus); 1606184610Salfred return; 1607184610Salfred } 1608191494Sthompsa USB_BUS_LOCK(bus); 1609194228Sthompsa usbd_transfer_done(xfer, USB_ERR_INVAL); 1610191494Sthompsa USB_BUS_UNLOCK(bus); 1611184610Salfred return; 1612184610Salfred } 1613220301Shselasky /* compute some variables */ 1614184610Salfred 1615184610Salfred for (x = 0; x != xfer->nframes; x++) { 1616220301Shselasky /* make a copy of the frlenghts[] */ 1617220301Shselasky xfer->frlengths[x + xfer->max_frame_count] = xfer->frlengths[x]; 1618220301Shselasky /* compute total transfer length */ 1619184610Salfred xfer->sumlen += xfer->frlengths[x]; 1620184610Salfred if (xfer->sumlen < xfer->frlengths[x]) { 1621184610Salfred /* length wrapped around */ 1622191494Sthompsa USB_BUS_LOCK(bus); 1623194228Sthompsa usbd_transfer_done(xfer, USB_ERR_INVAL); 1624191494Sthompsa USB_BUS_UNLOCK(bus); 1625184610Salfred return; 1626184610Salfred } 1627184610Salfred } 1628184610Salfred 1629184610Salfred /* clear some internal flags */ 1630184610Salfred 1631184610Salfred xfer->flags_int.short_xfer_ok = 0; 1632184610Salfred xfer->flags_int.short_frames_ok = 0; 1633184610Salfred 1634184610Salfred /* check if this is a control transfer */ 1635184610Salfred 1636184610Salfred if (xfer->flags_int.control_xfr) { 1637184610Salfred 1638194677Sthompsa if (usbd_setup_ctrl_transfer(xfer)) { 1639191494Sthompsa USB_BUS_LOCK(bus); 1640194228Sthompsa usbd_transfer_done(xfer, USB_ERR_STALLED); 1641191494Sthompsa USB_BUS_UNLOCK(bus); 1642184610Salfred return; 1643184610Salfred } 1644184610Salfred } 1645184610Salfred /* 1646184610Salfred * Setup filtered version of some transfer flags, 1647184610Salfred * in case of data read direction 1648184610Salfred */ 1649184610Salfred if (USB_GET_DATA_ISREAD(xfer)) { 1650184610Salfred 1651190184Sthompsa if (xfer->flags.short_frames_ok) { 1652190184Sthompsa xfer->flags_int.short_xfer_ok = 1; 1653190184Sthompsa xfer->flags_int.short_frames_ok = 1; 1654190184Sthompsa } else if (xfer->flags.short_xfer_ok) { 1655190184Sthompsa xfer->flags_int.short_xfer_ok = 1; 1656184610Salfred 1657190184Sthompsa /* check for control transfer */ 1658190184Sthompsa if (xfer->flags_int.control_xfr) { 1659190184Sthompsa /* 1660190184Sthompsa * 1) Control transfers do not support 1661190184Sthompsa * reception of multiple short USB 1662190184Sthompsa * frames in host mode and device side 1663190184Sthompsa * mode, with exception of: 1664190184Sthompsa * 1665190184Sthompsa * 2) Due to sometimes buggy device 1666190184Sthompsa * side firmware we need to do a 1667190184Sthompsa * STATUS stage in case of short 1668190184Sthompsa * control transfers in USB host mode. 1669190184Sthompsa * The STATUS stage then becomes the 1670190184Sthompsa * "alt_next" to the DATA stage. 1671190184Sthompsa */ 1672184610Salfred xfer->flags_int.short_frames_ok = 1; 1673184610Salfred } 1674184610Salfred } 1675184610Salfred } 1676184610Salfred /* 1677184610Salfred * Check if BUS-DMA support is enabled and try to load virtual 1678184610Salfred * buffers into DMA, if any: 1679184610Salfred */ 1680190180Sthompsa#if USB_HAVE_BUSDMA 1681184610Salfred if (xfer->flags_int.bdma_enable) { 1682184610Salfred /* insert the USB transfer last in the BUS-DMA queue */ 1683194228Sthompsa usb_command_wrapper(&xfer->xroot->dma_q, xfer); 1684184610Salfred return; 1685184610Salfred } 1686190180Sthompsa#endif 1687184610Salfred /* 1688184610Salfred * Enter the USB transfer into the Host Controller or 1689184610Salfred * Device Controller schedule: 1690184610Salfred */ 1691194228Sthompsa usbd_pipe_enter(xfer); 1692184610Salfred} 1693184610Salfred 1694184610Salfred/*------------------------------------------------------------------------* 1695194228Sthompsa * usbd_pipe_enter - factored out code 1696184610Salfred *------------------------------------------------------------------------*/ 1697184610Salfredvoid 1698194228Sthompsausbd_pipe_enter(struct usb_xfer *xfer) 1699184610Salfred{ 1700193644Sthompsa struct usb_endpoint *ep; 1701184610Salfred 1702184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1703184610Salfred 1704187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1705184610Salfred 1706193644Sthompsa ep = xfer->endpoint; 1707184610Salfred 1708184610Salfred DPRINTF("enter\n"); 1709184610Salfred 1710235001Shselasky /* the transfer can now be cancelled */ 1711235001Shselasky xfer->flags_int.can_cancel_immed = 1; 1712235001Shselasky 1713184610Salfred /* enter the transfer */ 1714193644Sthompsa (ep->methods->enter) (xfer); 1715184610Salfred 1716190738Sthompsa /* check for transfer error */ 1717190738Sthompsa if (xfer->error) { 1718190738Sthompsa /* some error has happened */ 1719194228Sthompsa usbd_transfer_done(xfer, 0); 1720190738Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1721190738Sthompsa return; 1722184610Salfred } 1723184610Salfred 1724184610Salfred /* start the transfer */ 1725194228Sthompsa usb_command_wrapper(&ep->endpoint_q, xfer); 1726187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1727184610Salfred} 1728184610Salfred 1729184610Salfred/*------------------------------------------------------------------------* 1730194228Sthompsa * usbd_transfer_start - start an USB transfer 1731184610Salfred * 1732184610Salfred * NOTE: Calling this function more than one time will only 1733184610Salfred * result in a single transfer start, until the USB transfer 1734184610Salfred * completes. 1735184610Salfred *------------------------------------------------------------------------*/ 1736184610Salfredvoid 1737194228Sthompsausbd_transfer_start(struct usb_xfer *xfer) 1738184610Salfred{ 1739184610Salfred if (xfer == NULL) { 1740184610Salfred /* transfer is gone */ 1741184610Salfred return; 1742184610Salfred } 1743184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1744184610Salfred 1745184610Salfred /* mark the USB transfer started */ 1746184610Salfred 1747184610Salfred if (!xfer->flags_int.started) { 1748197562Sthompsa /* lock the BUS lock to avoid races updating flags_int */ 1749197562Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1750184610Salfred xfer->flags_int.started = 1; 1751197562Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1752184610Salfred } 1753184610Salfred /* check if the USB transfer callback is already transferring */ 1754184610Salfred 1755184610Salfred if (xfer->flags_int.transferring) { 1756184610Salfred return; 1757184610Salfred } 1758187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1759184610Salfred /* call the USB transfer callback */ 1760194228Sthompsa usbd_callback_ss_done_defer(xfer); 1761187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1762184610Salfred} 1763184610Salfred 1764184610Salfred/*------------------------------------------------------------------------* 1765194228Sthompsa * usbd_transfer_stop - stop an USB transfer 1766184610Salfred * 1767184610Salfred * NOTE: Calling this function more than one time will only 1768184610Salfred * result in a single transfer stop. 1769184610Salfred * NOTE: When this function returns it is not safe to free nor 1770194228Sthompsa * reuse any DMA buffers. See "usbd_transfer_drain()". 1771184610Salfred *------------------------------------------------------------------------*/ 1772184610Salfredvoid 1773194228Sthompsausbd_transfer_stop(struct usb_xfer *xfer) 1774184610Salfred{ 1775193644Sthompsa struct usb_endpoint *ep; 1776184610Salfred 1777184610Salfred if (xfer == NULL) { 1778184610Salfred /* transfer is gone */ 1779184610Salfred return; 1780184610Salfred } 1781184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1782184610Salfred 1783184610Salfred /* check if the USB transfer was ever opened */ 1784184610Salfred 1785184610Salfred if (!xfer->flags_int.open) { 1786197562Sthompsa if (xfer->flags_int.started) { 1787197562Sthompsa /* nothing to do except clearing the "started" flag */ 1788197562Sthompsa /* lock the BUS lock to avoid races updating flags_int */ 1789197562Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1790197562Sthompsa xfer->flags_int.started = 0; 1791197562Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1792197562Sthompsa } 1793184610Salfred return; 1794184610Salfred } 1795184610Salfred /* try to stop the current USB transfer */ 1796184610Salfred 1797187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1798197562Sthompsa /* override any previous error */ 1799197562Sthompsa xfer->error = USB_ERR_CANCELLED; 1800197562Sthompsa 1801184610Salfred /* 1802184610Salfred * Clear "open" and "started" when both private and USB lock 1803184610Salfred * is locked so that we don't get a race updating "flags_int" 1804184610Salfred */ 1805184610Salfred xfer->flags_int.open = 0; 1806184610Salfred xfer->flags_int.started = 0; 1807184610Salfred 1808184610Salfred /* 1809184610Salfred * Check if we can cancel the USB transfer immediately. 1810184610Salfred */ 1811184610Salfred if (xfer->flags_int.transferring) { 1812184610Salfred if (xfer->flags_int.can_cancel_immed && 1813184610Salfred (!xfer->flags_int.did_close)) { 1814184610Salfred DPRINTF("close\n"); 1815184610Salfred /* 1816184610Salfred * The following will lead to an USB_ERR_CANCELLED 1817184610Salfred * error code being passed to the USB callback. 1818184610Salfred */ 1819193644Sthompsa (xfer->endpoint->methods->close) (xfer); 1820184610Salfred /* only close once */ 1821184610Salfred xfer->flags_int.did_close = 1; 1822184610Salfred } else { 1823184610Salfred /* need to wait for the next done callback */ 1824184610Salfred } 1825184610Salfred } else { 1826184610Salfred DPRINTF("close\n"); 1827184610Salfred 1828184610Salfred /* close here and now */ 1829193644Sthompsa (xfer->endpoint->methods->close) (xfer); 1830184610Salfred 1831184610Salfred /* 1832184610Salfred * Any additional DMA delay is done by 1833194228Sthompsa * "usbd_transfer_unsetup()". 1834184610Salfred */ 1835184610Salfred 1836184610Salfred /* 1837184610Salfred * Special case. Check if we need to restart a blocked 1838193644Sthompsa * endpoint. 1839184610Salfred */ 1840193644Sthompsa ep = xfer->endpoint; 1841184610Salfred 1842184610Salfred /* 1843184610Salfred * If the current USB transfer is completing we need 1844184610Salfred * to start the next one: 1845184610Salfred */ 1846193644Sthompsa if (ep->endpoint_q.curr == xfer) { 1847194228Sthompsa usb_command_wrapper(&ep->endpoint_q, NULL); 1848184610Salfred } 1849184610Salfred } 1850184610Salfred 1851187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1852184610Salfred} 1853184610Salfred 1854184610Salfred/*------------------------------------------------------------------------* 1855194228Sthompsa * usbd_transfer_pending 1856184610Salfred * 1857184610Salfred * This function will check if an USB transfer is pending which is a 1858184610Salfred * little bit complicated! 1859184610Salfred * Return values: 1860184610Salfred * 0: Not pending 1861184610Salfred * 1: Pending: The USB transfer will receive a callback in the future. 1862184610Salfred *------------------------------------------------------------------------*/ 1863184610Salfreduint8_t 1864194228Sthompsausbd_transfer_pending(struct usb_xfer *xfer) 1865184610Salfred{ 1866192984Sthompsa struct usb_xfer_root *info; 1867192984Sthompsa struct usb_xfer_queue *pq; 1868184610Salfred 1869188600Sthompsa if (xfer == NULL) { 1870188600Sthompsa /* transfer is gone */ 1871188600Sthompsa return (0); 1872188600Sthompsa } 1873184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1874184610Salfred 1875184610Salfred if (xfer->flags_int.transferring) { 1876184610Salfred /* trivial case */ 1877184610Salfred return (1); 1878184610Salfred } 1879187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 1880184610Salfred if (xfer->wait_queue) { 1881184610Salfred /* we are waiting on a queue somewhere */ 1882187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1883184610Salfred return (1); 1884184610Salfred } 1885187173Sthompsa info = xfer->xroot; 1886184610Salfred pq = &info->done_q; 1887184610Salfred 1888184610Salfred if (pq->curr == xfer) { 1889184610Salfred /* we are currently scheduled for callback */ 1890187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1891184610Salfred return (1); 1892184610Salfred } 1893184610Salfred /* we are not pending */ 1894187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 1895184610Salfred return (0); 1896184610Salfred} 1897184610Salfred 1898184610Salfred/*------------------------------------------------------------------------* 1899194228Sthompsa * usbd_transfer_drain 1900184610Salfred * 1901184610Salfred * This function will stop the USB transfer and wait for any 1902184610Salfred * additional BUS-DMA and HW-DMA operations to complete. Buffers that 1903184610Salfred * are loaded into DMA can safely be freed or reused after that this 1904184610Salfred * function has returned. 1905184610Salfred *------------------------------------------------------------------------*/ 1906184610Salfredvoid 1907194228Sthompsausbd_transfer_drain(struct usb_xfer *xfer) 1908184610Salfred{ 1909184610Salfred WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1910194228Sthompsa "usbd_transfer_drain can sleep!"); 1911184610Salfred 1912184610Salfred if (xfer == NULL) { 1913184610Salfred /* transfer is gone */ 1914184610Salfred return; 1915184610Salfred } 1916187173Sthompsa if (xfer->xroot->xfer_mtx != &Giant) { 1917184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED); 1918184610Salfred } 1919184824Sthompsa USB_XFER_LOCK(xfer); 1920184610Salfred 1921194228Sthompsa usbd_transfer_stop(xfer); 1922184610Salfred 1923198775Sthompsa while (usbd_transfer_pending(xfer) || 1924198775Sthompsa xfer->flags_int.doing_callback) { 1925198775Sthompsa 1926198775Sthompsa /* 1927198775Sthompsa * It is allowed that the callback can drop its 1928198775Sthompsa * transfer mutex. In that case checking only 1929198775Sthompsa * "usbd_transfer_pending()" is not enough to tell if 1930198775Sthompsa * the USB transfer is fully drained. We also need to 1931198775Sthompsa * check the internal "doing_callback" flag. 1932198775Sthompsa */ 1933184610Salfred xfer->flags_int.draining = 1; 1934198775Sthompsa 1935184610Salfred /* 1936184610Salfred * Wait until the current outstanding USB 1937184610Salfred * transfer is complete ! 1938184610Salfred */ 1939194227Sthompsa cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx); 1940184610Salfred } 1941184824Sthompsa USB_XFER_UNLOCK(xfer); 1942184610Salfred} 1943184610Salfred 1944194677Sthompsastruct usb_page_cache * 1945194677Sthompsausbd_xfer_get_frame(struct usb_xfer *xfer, usb_frcount_t frindex) 1946194677Sthompsa{ 1947194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1948194677Sthompsa 1949194677Sthompsa return (&xfer->frbuffers[frindex]); 1950194677Sthompsa} 1951194677Sthompsa 1952246786Shselaskyvoid * 1953246786Shselaskyusbd_xfer_get_frame_buffer(struct usb_xfer *xfer, usb_frcount_t frindex) 1954246786Shselasky{ 1955246786Shselasky struct usb_page_search page_info; 1956246786Shselasky 1957246786Shselasky KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1958246786Shselasky 1959246786Shselasky usbd_get_page(&xfer->frbuffers[frindex], 0, &page_info); 1960246786Shselasky return (page_info.buffer); 1961246786Shselasky} 1962246786Shselasky 1963199059Sthompsa/*------------------------------------------------------------------------* 1964199059Sthompsa * usbd_xfer_get_fps_shift 1965199059Sthompsa * 1966199059Sthompsa * The following function is only useful for isochronous transfers. It 1967199059Sthompsa * returns how many times the frame execution rate has been shifted 1968199059Sthompsa * down. 1969199059Sthompsa * 1970199059Sthompsa * Return value: 1971199059Sthompsa * Success: 0..3 1972199059Sthompsa * Failure: 0 1973199059Sthompsa *------------------------------------------------------------------------*/ 1974199059Sthompsauint8_t 1975199059Sthompsausbd_xfer_get_fps_shift(struct usb_xfer *xfer) 1976199059Sthompsa{ 1977199059Sthompsa return (xfer->fps_shift); 1978199059Sthompsa} 1979199059Sthompsa 1980194677Sthompsausb_frlength_t 1981194682Sthompsausbd_xfer_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex) 1982194677Sthompsa{ 1983194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1984194677Sthompsa 1985194677Sthompsa return (xfer->frlengths[frindex]); 1986194677Sthompsa} 1987194677Sthompsa 1988184610Salfred/*------------------------------------------------------------------------* 1989194677Sthompsa * usbd_xfer_set_frame_data 1990184610Salfred * 1991184610Salfred * This function sets the pointer of the buffer that should 1992184610Salfred * loaded directly into DMA for the given USB frame. Passing "ptr" 1993184610Salfred * equal to NULL while the corresponding "frlength" is greater 1994184610Salfred * than zero gives undefined results! 1995184610Salfred *------------------------------------------------------------------------*/ 1996184610Salfredvoid 1997194677Sthompsausbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, 1998194677Sthompsa void *ptr, usb_frlength_t len) 1999184610Salfred{ 2000194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 2001194677Sthompsa 2002184610Salfred /* set virtual address to load and length */ 2003184610Salfred xfer->frbuffers[frindex].buffer = ptr; 2004194677Sthompsa usbd_xfer_set_frame_len(xfer, frindex, len); 2005184610Salfred} 2006184610Salfred 2007194677Sthompsavoid 2008194682Sthompsausbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, 2009194677Sthompsa void **ptr, int *len) 2010194677Sthompsa{ 2011194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 2012194677Sthompsa 2013194677Sthompsa if (ptr != NULL) 2014194677Sthompsa *ptr = xfer->frbuffers[frindex].buffer; 2015194677Sthompsa if (len != NULL) 2016194677Sthompsa *len = xfer->frlengths[frindex]; 2017194677Sthompsa} 2018194677Sthompsa 2019220301Shselasky/*------------------------------------------------------------------------* 2020220301Shselasky * usbd_xfer_old_frame_length 2021220301Shselasky * 2022220301Shselasky * This function returns the framelength of the given frame at the 2023220301Shselasky * time the transfer was submitted. This function can be used to 2024220301Shselasky * compute the starting data pointer of the next isochronous frame 2025220301Shselasky * when an isochronous transfer has completed. 2026220301Shselasky *------------------------------------------------------------------------*/ 2027220301Shselaskyusb_frlength_t 2028220301Shselaskyusbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex) 2029220301Shselasky{ 2030220301Shselasky KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 2031220301Shselasky 2032220301Shselasky return (xfer->frlengths[frindex + xfer->max_frame_count]); 2033220301Shselasky} 2034220301Shselasky 2035194677Sthompsavoid 2036194677Sthompsausbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen, int *aframes, 2037194677Sthompsa int *nframes) 2038194677Sthompsa{ 2039194677Sthompsa if (actlen != NULL) 2040194677Sthompsa *actlen = xfer->actlen; 2041194677Sthompsa if (sumlen != NULL) 2042194677Sthompsa *sumlen = xfer->sumlen; 2043194677Sthompsa if (aframes != NULL) 2044194677Sthompsa *aframes = xfer->aframes; 2045194677Sthompsa if (nframes != NULL) 2046194677Sthompsa *nframes = xfer->nframes; 2047194677Sthompsa} 2048194677Sthompsa 2049184610Salfred/*------------------------------------------------------------------------* 2050194677Sthompsa * usbd_xfer_set_frame_offset 2051184610Salfred * 2052184610Salfred * This function sets the frame data buffer offset relative to the beginning 2053184610Salfred * of the USB DMA buffer allocated for this USB transfer. 2054184610Salfred *------------------------------------------------------------------------*/ 2055184610Salfredvoid 2056194677Sthompsausbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset, 2057193045Sthompsa usb_frcount_t frindex) 2058184610Salfred{ 2059194677Sthompsa KASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame " 2060199816Sthompsa "when the USB buffer is external\n")); 2061194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 2062184610Salfred 2063184610Salfred /* set virtual address to load */ 2064184610Salfred xfer->frbuffers[frindex].buffer = 2065184610Salfred USB_ADD_BYTES(xfer->local_buffer, offset); 2066184610Salfred} 2067184610Salfred 2068194677Sthompsavoid 2069194677Sthompsausbd_xfer_set_interval(struct usb_xfer *xfer, int i) 2070194677Sthompsa{ 2071194677Sthompsa xfer->interval = i; 2072194677Sthompsa} 2073194677Sthompsa 2074194677Sthompsavoid 2075194677Sthompsausbd_xfer_set_timeout(struct usb_xfer *xfer, int t) 2076194677Sthompsa{ 2077194677Sthompsa xfer->timeout = t; 2078194677Sthompsa} 2079194677Sthompsa 2080194677Sthompsavoid 2081194677Sthompsausbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n) 2082194677Sthompsa{ 2083194677Sthompsa xfer->nframes = n; 2084194677Sthompsa} 2085194677Sthompsa 2086194677Sthompsausb_frcount_t 2087194677Sthompsausbd_xfer_max_frames(struct usb_xfer *xfer) 2088194677Sthompsa{ 2089194677Sthompsa return (xfer->max_frame_count); 2090194677Sthompsa} 2091194677Sthompsa 2092194677Sthompsausb_frlength_t 2093194677Sthompsausbd_xfer_max_len(struct usb_xfer *xfer) 2094194677Sthompsa{ 2095194677Sthompsa return (xfer->max_data_length); 2096194677Sthompsa} 2097194677Sthompsa 2098194677Sthompsausb_frlength_t 2099194677Sthompsausbd_xfer_max_framelen(struct usb_xfer *xfer) 2100194677Sthompsa{ 2101194677Sthompsa return (xfer->max_frame_size); 2102194677Sthompsa} 2103194677Sthompsa 2104194677Sthompsavoid 2105194677Sthompsausbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex, 2106194677Sthompsa usb_frlength_t len) 2107194677Sthompsa{ 2108194677Sthompsa KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 2109194677Sthompsa 2110194677Sthompsa xfer->frlengths[frindex] = len; 2111194677Sthompsa} 2112194677Sthompsa 2113184610Salfred/*------------------------------------------------------------------------* 2114194228Sthompsa * usb_callback_proc - factored out code 2115184610Salfred * 2116184610Salfred * This function performs USB callbacks. 2117184610Salfred *------------------------------------------------------------------------*/ 2118184610Salfredstatic void 2119194228Sthompsausb_callback_proc(struct usb_proc_msg *_pm) 2120184610Salfred{ 2121192984Sthompsa struct usb_done_msg *pm = (void *)_pm; 2122192984Sthompsa struct usb_xfer_root *info = pm->xroot; 2123184610Salfred 2124184610Salfred /* Change locking order */ 2125184824Sthompsa USB_BUS_UNLOCK(info->bus); 2126184610Salfred 2127184610Salfred /* 2128184610Salfred * We exploit the fact that the mutex is the same for all 2129184610Salfred * callbacks that will be called from this thread: 2130184610Salfred */ 2131187173Sthompsa mtx_lock(info->xfer_mtx); 2132184824Sthompsa USB_BUS_LOCK(info->bus); 2133184610Salfred 2134184610Salfred /* Continue where we lost track */ 2135194228Sthompsa usb_command_wrapper(&info->done_q, 2136184610Salfred info->done_q.curr); 2137184610Salfred 2138187173Sthompsa mtx_unlock(info->xfer_mtx); 2139184610Salfred} 2140184610Salfred 2141184610Salfred/*------------------------------------------------------------------------* 2142194228Sthompsa * usbd_callback_ss_done_defer 2143184610Salfred * 2144184610Salfred * This function will defer the start, stop and done callback to the 2145184610Salfred * correct thread. 2146184610Salfred *------------------------------------------------------------------------*/ 2147184610Salfredstatic void 2148194228Sthompsausbd_callback_ss_done_defer(struct usb_xfer *xfer) 2149184610Salfred{ 2150192984Sthompsa struct usb_xfer_root *info = xfer->xroot; 2151192984Sthompsa struct usb_xfer_queue *pq = &info->done_q; 2152184610Salfred 2153187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2154184824Sthompsa 2155184610Salfred if (pq->curr != xfer) { 2156194228Sthompsa usbd_transfer_enqueue(pq, xfer); 2157184610Salfred } 2158184610Salfred if (!pq->recurse_1) { 2159184610Salfred 2160184610Salfred /* 2161184610Salfred * We have to postpone the callback due to the fact we 2162184610Salfred * will have a Lock Order Reversal, LOR, if we try to 2163184610Salfred * proceed ! 2164184610Salfred */ 2165194228Sthompsa if (usb_proc_msignal(info->done_p, 2166184610Salfred &info->done_m[0], &info->done_m[1])) { 2167184610Salfred /* ignore */ 2168184610Salfred } 2169184610Salfred } else { 2170184610Salfred /* clear second recurse flag */ 2171184610Salfred pq->recurse_2 = 0; 2172184610Salfred } 2173184610Salfred return; 2174184610Salfred 2175184610Salfred} 2176184610Salfred 2177184610Salfred/*------------------------------------------------------------------------* 2178194228Sthompsa * usbd_callback_wrapper 2179184610Salfred * 2180184610Salfred * This is a wrapper for USB callbacks. This wrapper does some 2181184610Salfred * auto-magic things like figuring out if we can call the callback 2182184610Salfred * directly from the current context or if we need to wakeup the 2183184610Salfred * interrupt process. 2184184610Salfred *------------------------------------------------------------------------*/ 2185184610Salfredstatic void 2186194228Sthompsausbd_callback_wrapper(struct usb_xfer_queue *pq) 2187184610Salfred{ 2188192984Sthompsa struct usb_xfer *xfer = pq->curr; 2189192984Sthompsa struct usb_xfer_root *info = xfer->xroot; 2190184610Salfred 2191190738Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 2192235410Savg if (!mtx_owned(info->xfer_mtx) && !SCHEDULER_STOPPED()) { 2193184610Salfred /* 2194184610Salfred * Cases that end up here: 2195184610Salfred * 2196184610Salfred * 5) HW interrupt done callback or other source. 2197184610Salfred */ 2198184610Salfred DPRINTFN(3, "case 5\n"); 2199184610Salfred 2200184610Salfred /* 2201184610Salfred * We have to postpone the callback due to the fact we 2202184610Salfred * will have a Lock Order Reversal, LOR, if we try to 2203184610Salfred * proceed ! 2204184610Salfred */ 2205194228Sthompsa if (usb_proc_msignal(info->done_p, 2206184610Salfred &info->done_m[0], &info->done_m[1])) { 2207184610Salfred /* ignore */ 2208184610Salfred } 2209184610Salfred return; 2210184610Salfred } 2211184610Salfred /* 2212184610Salfred * Cases that end up here: 2213184610Salfred * 2214184610Salfred * 1) We are starting a transfer 2215184610Salfred * 2) We are prematurely calling back a transfer 2216184610Salfred * 3) We are stopping a transfer 2217184610Salfred * 4) We are doing an ordinary callback 2218184610Salfred */ 2219184610Salfred DPRINTFN(3, "case 1-4\n"); 2220184610Salfred /* get next USB transfer in the queue */ 2221184610Salfred info->done_q.curr = NULL; 2222184610Salfred 2223198775Sthompsa /* set flag in case of drain */ 2224198775Sthompsa xfer->flags_int.doing_callback = 1; 2225198775Sthompsa 2226190738Sthompsa USB_BUS_UNLOCK(info->bus); 2227190738Sthompsa USB_BUS_LOCK_ASSERT(info->bus, MA_NOTOWNED); 2228184610Salfred 2229184610Salfred /* set correct USB state for callback */ 2230184610Salfred if (!xfer->flags_int.transferring) { 2231194228Sthompsa xfer->usb_state = USB_ST_SETUP; 2232184610Salfred if (!xfer->flags_int.started) { 2233184610Salfred /* we got stopped before we even got started */ 2234190738Sthompsa USB_BUS_LOCK(info->bus); 2235184610Salfred goto done; 2236184610Salfred } 2237184610Salfred } else { 2238184610Salfred 2239194228Sthompsa if (usbd_callback_wrapper_sub(xfer)) { 2240184610Salfred /* the callback has been deferred */ 2241190738Sthompsa USB_BUS_LOCK(info->bus); 2242184610Salfred goto done; 2243184610Salfred } 2244190734Sthompsa#if USB_HAVE_POWERD 2245186730Salfred /* decrement power reference */ 2246194228Sthompsa usbd_transfer_power_ref(xfer, -1); 2247190734Sthompsa#endif 2248184610Salfred xfer->flags_int.transferring = 0; 2249184610Salfred 2250184610Salfred if (xfer->error) { 2251194228Sthompsa xfer->usb_state = USB_ST_ERROR; 2252184610Salfred } else { 2253184610Salfred /* set transferred state */ 2254194228Sthompsa xfer->usb_state = USB_ST_TRANSFERRED; 2255190180Sthompsa#if USB_HAVE_BUSDMA 2256184610Salfred /* sync DMA memory, if any */ 2257184610Salfred if (xfer->flags_int.bdma_enable && 2258184610Salfred (!xfer->flags_int.bdma_no_post_sync)) { 2259194228Sthompsa usb_bdma_post_sync(xfer); 2260184610Salfred } 2261190180Sthompsa#endif 2262184610Salfred } 2263184610Salfred } 2264184610Salfred 2265217558Shselasky#if USB_HAVE_PF 2266215649Sweongyo if (xfer->usb_state != USB_ST_SETUP) 2267215649Sweongyo usbpf_xfertap(xfer, USBPF_XFERTAP_DONE); 2268217558Shselasky#endif 2269184610Salfred /* call processing routine */ 2270194677Sthompsa (xfer->callback) (xfer, xfer->error); 2271184610Salfred 2272184610Salfred /* pickup the USB mutex again */ 2273190738Sthompsa USB_BUS_LOCK(info->bus); 2274184610Salfred 2275184610Salfred /* 2276184610Salfred * Check if we got started after that we got cancelled, but 2277187166Sthompsa * before we managed to do the callback. 2278184610Salfred */ 2279184610Salfred if ((!xfer->flags_int.open) && 2280184610Salfred (xfer->flags_int.started) && 2281194228Sthompsa (xfer->usb_state == USB_ST_ERROR)) { 2282198775Sthompsa /* clear flag in case of drain */ 2283198775Sthompsa xfer->flags_int.doing_callback = 0; 2284184610Salfred /* try to loop, but not recursivly */ 2285194228Sthompsa usb_command_wrapper(&info->done_q, xfer); 2286184610Salfred return; 2287187166Sthompsa } 2288187166Sthompsa 2289187166Sthompsadone: 2290198775Sthompsa /* clear flag in case of drain */ 2291198775Sthompsa xfer->flags_int.doing_callback = 0; 2292198775Sthompsa 2293187166Sthompsa /* 2294187166Sthompsa * Check if we are draining. 2295187166Sthompsa */ 2296187166Sthompsa if (xfer->flags_int.draining && 2297184610Salfred (!xfer->flags_int.transferring)) { 2298194228Sthompsa /* "usbd_transfer_drain()" is waiting for end of transfer */ 2299184610Salfred xfer->flags_int.draining = 0; 2300194227Sthompsa cv_broadcast(&info->cv_drain); 2301184610Salfred } 2302187166Sthompsa 2303184610Salfred /* do the next callback, if any */ 2304194228Sthompsa usb_command_wrapper(&info->done_q, 2305184610Salfred info->done_q.curr); 2306184610Salfred} 2307184610Salfred 2308184610Salfred/*------------------------------------------------------------------------* 2309194228Sthompsa * usb_dma_delay_done_cb 2310184610Salfred * 2311184610Salfred * This function is called when the DMA delay has been exectuded, and 2312184610Salfred * will make sure that the callback is called to complete the USB 2313184610Salfred * transfer. This code path is ususally only used when there is an USB 2314184610Salfred * error like USB_ERR_CANCELLED. 2315184610Salfred *------------------------------------------------------------------------*/ 2316213435Shselaskyvoid 2317213435Shselaskyusb_dma_delay_done_cb(struct usb_xfer *xfer) 2318184610Salfred{ 2319187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2320184610Salfred 2321184610Salfred DPRINTFN(3, "Completed %p\n", xfer); 2322184610Salfred 2323184610Salfred /* queue callback for execution, again */ 2324194228Sthompsa usbd_transfer_done(xfer, 0); 2325184610Salfred} 2326184610Salfred 2327184610Salfred/*------------------------------------------------------------------------* 2328194228Sthompsa * usbd_transfer_dequeue 2329184610Salfred * 2330184610Salfred * - This function is used to remove an USB transfer from a USB 2331184610Salfred * transfer queue. 2332184610Salfred * 2333184610Salfred * - This function can be called multiple times in a row. 2334184610Salfred *------------------------------------------------------------------------*/ 2335184610Salfredvoid 2336194228Sthompsausbd_transfer_dequeue(struct usb_xfer *xfer) 2337184610Salfred{ 2338192984Sthompsa struct usb_xfer_queue *pq; 2339184610Salfred 2340184610Salfred pq = xfer->wait_queue; 2341184610Salfred if (pq) { 2342184610Salfred TAILQ_REMOVE(&pq->head, xfer, wait_entry); 2343184610Salfred xfer->wait_queue = NULL; 2344184610Salfred } 2345184610Salfred} 2346184610Salfred 2347184610Salfred/*------------------------------------------------------------------------* 2348194228Sthompsa * usbd_transfer_enqueue 2349184610Salfred * 2350184610Salfred * - This function is used to insert an USB transfer into a USB * 2351184610Salfred * transfer queue. 2352184610Salfred * 2353184610Salfred * - This function can be called multiple times in a row. 2354184610Salfred *------------------------------------------------------------------------*/ 2355184610Salfredvoid 2356194228Sthompsausbd_transfer_enqueue(struct usb_xfer_queue *pq, struct usb_xfer *xfer) 2357184610Salfred{ 2358184610Salfred /* 2359184610Salfred * Insert the USB transfer into the queue, if it is not 2360184610Salfred * already on a USB transfer queue: 2361184610Salfred */ 2362184610Salfred if (xfer->wait_queue == NULL) { 2363184610Salfred xfer->wait_queue = pq; 2364184610Salfred TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry); 2365184610Salfred } 2366184610Salfred} 2367184610Salfred 2368184610Salfred/*------------------------------------------------------------------------* 2369194228Sthompsa * usbd_transfer_done 2370184610Salfred * 2371184610Salfred * - This function is used to remove an USB transfer from the busdma, 2372184610Salfred * pipe or interrupt queue. 2373184610Salfred * 2374184610Salfred * - This function is used to queue the USB transfer on the done 2375184610Salfred * queue. 2376184610Salfred * 2377184610Salfred * - This function is used to stop any USB transfer timeouts. 2378184610Salfred *------------------------------------------------------------------------*/ 2379184610Salfredvoid 2380194228Sthompsausbd_transfer_done(struct usb_xfer *xfer, usb_error_t error) 2381184610Salfred{ 2382261106Shselasky struct usb_xfer_root *info = xfer->xroot; 2383184610Salfred 2384261106Shselasky USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 2385261106Shselasky 2386194228Sthompsa DPRINTF("err=%s\n", usbd_errstr(error)); 2387184610Salfred 2388184610Salfred /* 2389184610Salfred * If we are not transferring then just return. 2390184610Salfred * This can happen during transfer cancel. 2391184610Salfred */ 2392184610Salfred if (!xfer->flags_int.transferring) { 2393184610Salfred DPRINTF("not transferring\n"); 2394197562Sthompsa /* end of control transfer, if any */ 2395197562Sthompsa xfer->flags_int.control_act = 0; 2396184610Salfred return; 2397184610Salfred } 2398261106Shselasky /* only set transfer error, if not already set */ 2399261106Shselasky if (xfer->error == USB_ERR_NORMAL_COMPLETION) 2400184610Salfred xfer->error = error; 2401261106Shselasky 2402184610Salfred /* stop any callouts */ 2403194228Sthompsa usb_callout_stop(&xfer->timeout_handle); 2404184610Salfred 2405184610Salfred /* 2406184610Salfred * If we are waiting on a queue, just remove the USB transfer 2407184610Salfred * from the queue, if any. We should have the required locks 2408184610Salfred * locked to do the remove when this function is called. 2409184610Salfred */ 2410194228Sthompsa usbd_transfer_dequeue(xfer); 2411184610Salfred 2412190180Sthompsa#if USB_HAVE_BUSDMA 2413261106Shselasky if (mtx_owned(info->xfer_mtx)) { 2414192984Sthompsa struct usb_xfer_queue *pq; 2415190180Sthompsa 2416184610Salfred /* 2417184610Salfred * If the private USB lock is not locked, then we assume 2418184610Salfred * that the BUS-DMA load stage has been passed: 2419184610Salfred */ 2420261106Shselasky pq = &info->dma_q; 2421184610Salfred 2422184610Salfred if (pq->curr == xfer) { 2423184610Salfred /* start the next BUS-DMA load, if any */ 2424194228Sthompsa usb_command_wrapper(pq, NULL); 2425184610Salfred } 2426184610Salfred } 2427190180Sthompsa#endif 2428184610Salfred /* keep some statistics */ 2429184610Salfred if (xfer->error) { 2430261106Shselasky info->bus->stats_err.uds_requests 2431193644Sthompsa [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++; 2432184610Salfred } else { 2433261106Shselasky info->bus->stats_ok.uds_requests 2434193644Sthompsa [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++; 2435184610Salfred } 2436184610Salfred 2437184610Salfred /* call the USB transfer callback */ 2438194228Sthompsa usbd_callback_ss_done_defer(xfer); 2439184610Salfred} 2440184610Salfred 2441184610Salfred/*------------------------------------------------------------------------* 2442194228Sthompsa * usbd_transfer_start_cb 2443184610Salfred * 2444184610Salfred * This function is called to start the USB transfer when 2445184610Salfred * "xfer->interval" is greater than zero, and and the endpoint type is 2446184610Salfred * BULK or CONTROL. 2447184610Salfred *------------------------------------------------------------------------*/ 2448184610Salfredstatic void 2449194228Sthompsausbd_transfer_start_cb(void *arg) 2450184610Salfred{ 2451192984Sthompsa struct usb_xfer *xfer = arg; 2452193644Sthompsa struct usb_endpoint *ep = xfer->endpoint; 2453184610Salfred 2454187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2455184610Salfred 2456184610Salfred DPRINTF("start\n"); 2457184610Salfred 2458217558Shselasky#if USB_HAVE_PF 2459215649Sweongyo usbpf_xfertap(xfer, USBPF_XFERTAP_SUBMIT); 2460217558Shselasky#endif 2461235001Shselasky 2462235001Shselasky /* the transfer can now be cancelled */ 2463235001Shselasky xfer->flags_int.can_cancel_immed = 1; 2464235001Shselasky 2465225695Shselasky /* start USB transfer, if no error */ 2466225695Shselasky if (xfer->error == 0) 2467225695Shselasky (ep->methods->start) (xfer); 2468184610Salfred 2469235001Shselasky /* check for transfer error */ 2470190738Sthompsa if (xfer->error) { 2471190738Sthompsa /* some error has happened */ 2472194228Sthompsa usbd_transfer_done(xfer, 0); 2473184610Salfred } 2474184610Salfred} 2475184610Salfred 2476184610Salfred/*------------------------------------------------------------------------* 2477194677Sthompsa * usbd_xfer_set_stall 2478184610Salfred * 2479184610Salfred * This function is used to set the stall flag outside the 2480184610Salfred * callback. This function is NULL safe. 2481184610Salfred *------------------------------------------------------------------------*/ 2482184610Salfredvoid 2483194677Sthompsausbd_xfer_set_stall(struct usb_xfer *xfer) 2484184610Salfred{ 2485184610Salfred if (xfer == NULL) { 2486184610Salfred /* tearing down */ 2487184610Salfred return; 2488184610Salfred } 2489184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2490184610Salfred 2491184610Salfred /* avoid any races by locking the USB mutex */ 2492187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2493184610Salfred xfer->flags.stall_pipe = 1; 2494187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2495184610Salfred} 2496184610Salfred 2497194677Sthompsaint 2498194677Sthompsausbd_xfer_is_stalled(struct usb_xfer *xfer) 2499194677Sthompsa{ 2500194677Sthompsa return (xfer->endpoint->is_stalled); 2501194677Sthompsa} 2502194677Sthompsa 2503184610Salfred/*------------------------------------------------------------------------* 2504194228Sthompsa * usbd_transfer_clear_stall 2505184610Salfred * 2506184610Salfred * This function is used to clear the stall flag outside the 2507184610Salfred * callback. This function is NULL safe. 2508184610Salfred *------------------------------------------------------------------------*/ 2509184610Salfredvoid 2510194228Sthompsausbd_transfer_clear_stall(struct usb_xfer *xfer) 2511184610Salfred{ 2512184610Salfred if (xfer == NULL) { 2513184610Salfred /* tearing down */ 2514184610Salfred return; 2515184610Salfred } 2516184824Sthompsa USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2517184610Salfred 2518184610Salfred /* avoid any races by locking the USB mutex */ 2519187173Sthompsa USB_BUS_LOCK(xfer->xroot->bus); 2520184610Salfred 2521184610Salfred xfer->flags.stall_pipe = 0; 2522184610Salfred 2523187173Sthompsa USB_BUS_UNLOCK(xfer->xroot->bus); 2524184610Salfred} 2525184610Salfred 2526184610Salfred/*------------------------------------------------------------------------* 2527194228Sthompsa * usbd_pipe_start 2528184610Salfred * 2529184610Salfred * This function is used to add an USB transfer to the pipe transfer list. 2530184610Salfred *------------------------------------------------------------------------*/ 2531184610Salfredvoid 2532194228Sthompsausbd_pipe_start(struct usb_xfer_queue *pq) 2533184610Salfred{ 2534193644Sthompsa struct usb_endpoint *ep; 2535192984Sthompsa struct usb_xfer *xfer; 2536184610Salfred uint8_t type; 2537184610Salfred 2538184610Salfred xfer = pq->curr; 2539193644Sthompsa ep = xfer->endpoint; 2540184610Salfred 2541187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2542184610Salfred 2543184610Salfred /* 2544193644Sthompsa * If the endpoint is already stalled we do nothing ! 2545184610Salfred */ 2546193644Sthompsa if (ep->is_stalled) { 2547184610Salfred return; 2548184610Salfred } 2549184610Salfred /* 2550193644Sthompsa * Check if we are supposed to stall the endpoint: 2551184610Salfred */ 2552184610Salfred if (xfer->flags.stall_pipe) { 2553205035Sthompsa struct usb_device *udev; 2554205035Sthompsa struct usb_xfer_root *info; 2555205035Sthompsa 2556184610Salfred /* clear stall command */ 2557184610Salfred xfer->flags.stall_pipe = 0; 2558184610Salfred 2559205035Sthompsa /* get pointer to USB device */ 2560205035Sthompsa info = xfer->xroot; 2561205035Sthompsa udev = info->udev; 2562205035Sthompsa 2563184610Salfred /* 2564184610Salfred * Only stall BULK and INTERRUPT endpoints. 2565184610Salfred */ 2566193644Sthompsa type = (ep->edesc->bmAttributes & UE_XFERTYPE); 2567184610Salfred if ((type == UE_BULK) || 2568184610Salfred (type == UE_INTERRUPT)) { 2569195121Sthompsa uint8_t did_stall; 2570184610Salfred 2571195121Sthompsa did_stall = 1; 2572184610Salfred 2573192499Sthompsa if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2574184610Salfred (udev->bus->methods->set_stall) ( 2575195121Sthompsa udev, NULL, ep, &did_stall); 2576207080Sthompsa } else if (udev->ctrl_xfer[1]) { 2577207080Sthompsa info = udev->ctrl_xfer[1]->xroot; 2578195121Sthompsa usb_proc_msignal( 2579187174Sthompsa &info->bus->non_giant_callback_proc, 2580195121Sthompsa &udev->cs_msg[0], &udev->cs_msg[1]); 2581184610Salfred } else { 2582184610Salfred /* should not happen */ 2583199816Sthompsa DPRINTFN(0, "No stall handler\n"); 2584184610Salfred } 2585184610Salfred /* 2586195121Sthompsa * Check if we should stall. Some USB hardware 2587195121Sthompsa * handles set- and clear-stall in hardware. 2588184610Salfred */ 2589195121Sthompsa if (did_stall) { 2590195121Sthompsa /* 2591195121Sthompsa * The transfer will be continued when 2592195121Sthompsa * the clear-stall control endpoint 2593195121Sthompsa * message is received. 2594195121Sthompsa */ 2595195121Sthompsa ep->is_stalled = 1; 2596195121Sthompsa return; 2597195121Sthompsa } 2598205035Sthompsa } else if (type == UE_ISOCHRONOUS) { 2599205035Sthompsa 2600205035Sthompsa /* 2601205035Sthompsa * Make sure any FIFO overflow or other FIFO 2602205035Sthompsa * error conditions go away by resetting the 2603205035Sthompsa * endpoint FIFO through the clear stall 2604205035Sthompsa * method. 2605205035Sthompsa */ 2606205035Sthompsa if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2607205035Sthompsa (udev->bus->methods->clear_stall) (udev, ep); 2608205035Sthompsa } 2609184610Salfred } 2610184610Salfred } 2611184610Salfred /* Set or clear stall complete - special case */ 2612184610Salfred if (xfer->nframes == 0) { 2613184610Salfred /* we are complete */ 2614184610Salfred xfer->aframes = 0; 2615194228Sthompsa usbd_transfer_done(xfer, 0); 2616184610Salfred return; 2617184610Salfred } 2618184610Salfred /* 2619184610Salfred * Handled cases: 2620184610Salfred * 2621184610Salfred * 1) Start the first transfer queued. 2622184610Salfred * 2623184610Salfred * 2) Re-start the current USB transfer. 2624184610Salfred */ 2625184610Salfred /* 2626184610Salfred * Check if there should be any 2627184610Salfred * pre transfer start delay: 2628184610Salfred */ 2629184610Salfred if (xfer->interval > 0) { 2630193644Sthompsa type = (ep->edesc->bmAttributes & UE_XFERTYPE); 2631184610Salfred if ((type == UE_BULK) || 2632184610Salfred (type == UE_CONTROL)) { 2633194228Sthompsa usbd_transfer_timeout_ms(xfer, 2634194228Sthompsa &usbd_transfer_start_cb, 2635184610Salfred xfer->interval); 2636184610Salfred return; 2637184610Salfred } 2638184610Salfred } 2639184610Salfred DPRINTF("start\n"); 2640184610Salfred 2641217558Shselasky#if USB_HAVE_PF 2642215649Sweongyo usbpf_xfertap(xfer, USBPF_XFERTAP_SUBMIT); 2643217558Shselasky#endif 2644235001Shselasky /* the transfer can now be cancelled */ 2645235001Shselasky xfer->flags_int.can_cancel_immed = 1; 2646235001Shselasky 2647225695Shselasky /* start USB transfer, if no error */ 2648225695Shselasky if (xfer->error == 0) 2649225695Shselasky (ep->methods->start) (xfer); 2650184610Salfred 2651235001Shselasky /* check for transfer error */ 2652190738Sthompsa if (xfer->error) { 2653190738Sthompsa /* some error has happened */ 2654194228Sthompsa usbd_transfer_done(xfer, 0); 2655184610Salfred } 2656184610Salfred} 2657184610Salfred 2658184610Salfred/*------------------------------------------------------------------------* 2659194228Sthompsa * usbd_transfer_timeout_ms 2660184610Salfred * 2661184610Salfred * This function is used to setup a timeout on the given USB 2662184610Salfred * transfer. If the timeout has been deferred the callback given by 2663184610Salfred * "cb" will get called after "ms" milliseconds. 2664184610Salfred *------------------------------------------------------------------------*/ 2665184610Salfredvoid 2666194228Sthompsausbd_transfer_timeout_ms(struct usb_xfer *xfer, 2667193045Sthompsa void (*cb) (void *arg), usb_timeout_t ms) 2668184610Salfred{ 2669187173Sthompsa USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2670184610Salfred 2671184610Salfred /* defer delay */ 2672194228Sthompsa usb_callout_reset(&xfer->timeout_handle, 2673261466Shselasky USB_MS_TO_TICKS(ms) + USB_CALLOUT_ZERO_TICKS, cb, xfer); 2674184610Salfred} 2675184610Salfred 2676184610Salfred/*------------------------------------------------------------------------* 2677194228Sthompsa * usbd_callback_wrapper_sub 2678184610Salfred * 2679184610Salfred * - This function will update variables in an USB transfer after 2680184610Salfred * that the USB transfer is complete. 2681184610Salfred * 2682184610Salfred * - This function is used to start the next USB transfer on the 2683193644Sthompsa * ep transfer queue, if any. 2684184610Salfred * 2685184610Salfred * NOTE: In some special cases the USB transfer will not be removed from 2686184610Salfred * the pipe queue, but remain first. To enforce USB transfer removal call 2687184610Salfred * this function passing the error code "USB_ERR_CANCELLED". 2688184610Salfred * 2689184610Salfred * Return values: 2690184610Salfred * 0: Success. 2691184610Salfred * Else: The callback has been deferred. 2692184610Salfred *------------------------------------------------------------------------*/ 2693184610Salfredstatic uint8_t 2694194228Sthompsausbd_callback_wrapper_sub(struct usb_xfer *xfer) 2695184610Salfred{ 2696193644Sthompsa struct usb_endpoint *ep; 2697213435Shselasky struct usb_bus *bus; 2698193045Sthompsa usb_frcount_t x; 2699184610Salfred 2700213435Shselasky bus = xfer->xroot->bus; 2701213435Shselasky 2702184610Salfred if ((!xfer->flags_int.open) && 2703184610Salfred (!xfer->flags_int.did_close)) { 2704184610Salfred DPRINTF("close\n"); 2705213435Shselasky USB_BUS_LOCK(bus); 2706193644Sthompsa (xfer->endpoint->methods->close) (xfer); 2707213435Shselasky USB_BUS_UNLOCK(bus); 2708184610Salfred /* only close once */ 2709184610Salfred xfer->flags_int.did_close = 1; 2710184610Salfred return (1); /* wait for new callback */ 2711184610Salfred } 2712184610Salfred /* 2713184610Salfred * If we have a non-hardware induced error we 2714184610Salfred * need to do the DMA delay! 2715184610Salfred */ 2716213435Shselasky if (xfer->error != 0 && !xfer->flags_int.did_dma_delay && 2717213435Shselasky (xfer->error == USB_ERR_CANCELLED || 2718213435Shselasky xfer->error == USB_ERR_TIMEOUT || 2719213435Shselasky bus->methods->start_dma_delay != NULL)) { 2720184610Salfred 2721193045Sthompsa usb_timeout_t temp; 2722184610Salfred 2723197562Sthompsa /* only delay once */ 2724197562Sthompsa xfer->flags_int.did_dma_delay = 1; 2725197562Sthompsa 2726184610Salfred /* we can not cancel this delay */ 2727184610Salfred xfer->flags_int.can_cancel_immed = 0; 2728184610Salfred 2729212134Sthompsa temp = usbd_get_dma_delay(xfer->xroot->udev); 2730184610Salfred 2731184610Salfred DPRINTFN(3, "DMA delay, %u ms, " 2732184610Salfred "on %p\n", temp, xfer); 2733184610Salfred 2734184610Salfred if (temp != 0) { 2735213435Shselasky USB_BUS_LOCK(bus); 2736213435Shselasky /* 2737213435Shselasky * Some hardware solutions have dedicated 2738213435Shselasky * events when it is safe to free DMA'ed 2739213435Shselasky * memory. For the other hardware platforms we 2740213435Shselasky * use a static delay. 2741213435Shselasky */ 2742213435Shselasky if (bus->methods->start_dma_delay != NULL) { 2743213435Shselasky (bus->methods->start_dma_delay) (xfer); 2744213435Shselasky } else { 2745213435Shselasky usbd_transfer_timeout_ms(xfer, 2746235000Shselasky (void (*)(void *))&usb_dma_delay_done_cb, 2747235000Shselasky temp); 2748213435Shselasky } 2749213435Shselasky USB_BUS_UNLOCK(bus); 2750184610Salfred return (1); /* wait for new callback */ 2751184610Salfred } 2752184610Salfred } 2753184610Salfred /* check actual number of frames */ 2754184610Salfred if (xfer->aframes > xfer->nframes) { 2755184610Salfred if (xfer->error == 0) { 2756184610Salfred panic("%s: actual number of frames, %d, is " 2757199816Sthompsa "greater than initial number of frames, %d\n", 2758184610Salfred __FUNCTION__, xfer->aframes, xfer->nframes); 2759184610Salfred } else { 2760184610Salfred /* just set some valid value */ 2761184610Salfred xfer->aframes = xfer->nframes; 2762184610Salfred } 2763184610Salfred } 2764184610Salfred /* compute actual length */ 2765184610Salfred xfer->actlen = 0; 2766184610Salfred 2767184610Salfred for (x = 0; x != xfer->aframes; x++) { 2768184610Salfred xfer->actlen += xfer->frlengths[x]; 2769184610Salfred } 2770184610Salfred 2771184610Salfred /* 2772184610Salfred * Frames that were not transferred get zero actual length in 2773184610Salfred * case the USB device driver does not check the actual number 2774184610Salfred * of frames transferred, "xfer->aframes": 2775184610Salfred */ 2776184610Salfred for (; x < xfer->nframes; x++) { 2777194677Sthompsa usbd_xfer_set_frame_len(xfer, x, 0); 2778184610Salfred } 2779184610Salfred 2780184610Salfred /* check actual length */ 2781184610Salfred if (xfer->actlen > xfer->sumlen) { 2782184610Salfred if (xfer->error == 0) { 2783184610Salfred panic("%s: actual length, %d, is greater than " 2784199816Sthompsa "initial length, %d\n", 2785184610Salfred __FUNCTION__, xfer->actlen, xfer->sumlen); 2786184610Salfred } else { 2787184610Salfred /* just set some valid value */ 2788184610Salfred xfer->actlen = xfer->sumlen; 2789184610Salfred } 2790184610Salfred } 2791194677Sthompsa DPRINTFN(1, "xfer=%p endpoint=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n", 2792193644Sthompsa xfer, xfer->endpoint, xfer->error, xfer->actlen, xfer->sumlen, 2793184610Salfred xfer->aframes, xfer->nframes); 2794184610Salfred 2795184610Salfred if (xfer->error) { 2796184610Salfred /* end of control transfer, if any */ 2797184610Salfred xfer->flags_int.control_act = 0; 2798184610Salfred 2799261106Shselasky#if USB_HAVE_TT_SUPPORT 2800261106Shselasky switch (xfer->error) { 2801261106Shselasky case USB_ERR_NORMAL_COMPLETION: 2802261106Shselasky case USB_ERR_SHORT_XFER: 2803261106Shselasky case USB_ERR_STALLED: 2804261106Shselasky case USB_ERR_CANCELLED: 2805261106Shselasky /* nothing to do */ 2806261106Shselasky break; 2807261106Shselasky default: 2808261106Shselasky /* try to reset the TT, if any */ 2809261106Shselasky USB_BUS_LOCK(bus); 2810261106Shselasky uhub_tt_buffer_reset_async_locked(xfer->xroot->udev, xfer->endpoint); 2811261106Shselasky USB_BUS_UNLOCK(bus); 2812261106Shselasky break; 2813261106Shselasky } 2814261106Shselasky#endif 2815184610Salfred /* check if we should block the execution queue */ 2816184610Salfred if ((xfer->error != USB_ERR_CANCELLED) && 2817184610Salfred (xfer->flags.pipe_bof)) { 2818184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure " 2819193644Sthompsa "on endpoint=%p\n", xfer, xfer->endpoint); 2820184610Salfred goto done; 2821184610Salfred } 2822184610Salfred } else { 2823184610Salfred /* check for short transfers */ 2824184610Salfred if (xfer->actlen < xfer->sumlen) { 2825184610Salfred 2826184610Salfred /* end of control transfer, if any */ 2827184610Salfred xfer->flags_int.control_act = 0; 2828184610Salfred 2829184610Salfred if (!xfer->flags_int.short_xfer_ok) { 2830184610Salfred xfer->error = USB_ERR_SHORT_XFER; 2831184610Salfred if (xfer->flags.pipe_bof) { 2832184610Salfred DPRINTFN(2, "xfer=%p: Block On Failure on " 2833193644Sthompsa "Short Transfer on endpoint %p.\n", 2834193644Sthompsa xfer, xfer->endpoint); 2835184610Salfred goto done; 2836184610Salfred } 2837184610Salfred } 2838184610Salfred } else { 2839184610Salfred /* 2840184610Salfred * Check if we are in the middle of a 2841184610Salfred * control transfer: 2842184610Salfred */ 2843184610Salfred if (xfer->flags_int.control_act) { 2844184610Salfred DPRINTFN(5, "xfer=%p: Control transfer " 2845193644Sthompsa "active on endpoint=%p\n", xfer, xfer->endpoint); 2846184610Salfred goto done; 2847184610Salfred } 2848184610Salfred } 2849184610Salfred } 2850184610Salfred 2851193644Sthompsa ep = xfer->endpoint; 2852184610Salfred 2853184610Salfred /* 2854184610Salfred * If the current USB transfer is completing we need to start the 2855184610Salfred * next one: 2856184610Salfred */ 2857213435Shselasky USB_BUS_LOCK(bus); 2858193644Sthompsa if (ep->endpoint_q.curr == xfer) { 2859194228Sthompsa usb_command_wrapper(&ep->endpoint_q, NULL); 2860184610Salfred 2861193644Sthompsa if (ep->endpoint_q.curr || TAILQ_FIRST(&ep->endpoint_q.head)) { 2862184610Salfred /* there is another USB transfer waiting */ 2863184610Salfred } else { 2864184610Salfred /* this is the last USB transfer */ 2865184610Salfred /* clear isochronous sync flag */ 2866193644Sthompsa xfer->endpoint->is_synced = 0; 2867184610Salfred } 2868184610Salfred } 2869213435Shselasky USB_BUS_UNLOCK(bus); 2870184610Salfreddone: 2871184610Salfred return (0); 2872184610Salfred} 2873184610Salfred 2874184610Salfred/*------------------------------------------------------------------------* 2875194228Sthompsa * usb_command_wrapper 2876184610Salfred * 2877184610Salfred * This function is used to execute commands non-recursivly on an USB 2878184610Salfred * transfer. 2879184610Salfred *------------------------------------------------------------------------*/ 2880184610Salfredvoid 2881194228Sthompsausb_command_wrapper(struct usb_xfer_queue *pq, struct usb_xfer *xfer) 2882184610Salfred{ 2883184610Salfred if (xfer) { 2884184610Salfred /* 2885184610Salfred * If the transfer is not already processing, 2886184610Salfred * queue it! 2887184610Salfred */ 2888184610Salfred if (pq->curr != xfer) { 2889194228Sthompsa usbd_transfer_enqueue(pq, xfer); 2890184610Salfred if (pq->curr != NULL) { 2891184610Salfred /* something is already processing */ 2892184610Salfred DPRINTFN(6, "busy %p\n", pq->curr); 2893184610Salfred return; 2894184610Salfred } 2895184610Salfred } 2896184610Salfred } else { 2897184610Salfred /* Get next element in queue */ 2898184610Salfred pq->curr = NULL; 2899184610Salfred } 2900184610Salfred 2901184610Salfred if (!pq->recurse_1) { 2902184610Salfred 2903184610Salfred do { 2904184610Salfred 2905184610Salfred /* set both recurse flags */ 2906184610Salfred pq->recurse_1 = 1; 2907184610Salfred pq->recurse_2 = 1; 2908184610Salfred 2909184610Salfred if (pq->curr == NULL) { 2910184610Salfred xfer = TAILQ_FIRST(&pq->head); 2911184610Salfred if (xfer) { 2912184610Salfred TAILQ_REMOVE(&pq->head, xfer, 2913184610Salfred wait_entry); 2914184610Salfred xfer->wait_queue = NULL; 2915184610Salfred pq->curr = xfer; 2916184610Salfred } else { 2917184610Salfred break; 2918184610Salfred } 2919184610Salfred } 2920184610Salfred DPRINTFN(6, "cb %p (enter)\n", pq->curr); 2921184610Salfred (pq->command) (pq); 2922184610Salfred DPRINTFN(6, "cb %p (leave)\n", pq->curr); 2923184610Salfred 2924184610Salfred } while (!pq->recurse_2); 2925184610Salfred 2926184610Salfred /* clear first recurse flag */ 2927184610Salfred pq->recurse_1 = 0; 2928184610Salfred 2929184610Salfred } else { 2930184610Salfred /* clear second recurse flag */ 2931184610Salfred pq->recurse_2 = 0; 2932184610Salfred } 2933184610Salfred} 2934184610Salfred 2935184610Salfred/*------------------------------------------------------------------------* 2936207080Sthompsa * usbd_ctrl_transfer_setup 2937184610Salfred * 2938184610Salfred * This function is used to setup the default USB control endpoint 2939184610Salfred * transfer. 2940184610Salfred *------------------------------------------------------------------------*/ 2941184610Salfredvoid 2942207080Sthompsausbd_ctrl_transfer_setup(struct usb_device *udev) 2943184610Salfred{ 2944192984Sthompsa struct usb_xfer *xfer; 2945184610Salfred uint8_t no_resetup; 2946184610Salfred uint8_t iface_index; 2947184610Salfred 2948190735Sthompsa /* check for root HUB */ 2949190735Sthompsa if (udev->parent_hub == NULL) 2950190735Sthompsa return; 2951184610Salfredrepeat: 2952184610Salfred 2953207080Sthompsa xfer = udev->ctrl_xfer[0]; 2954184610Salfred if (xfer) { 2955184824Sthompsa USB_XFER_LOCK(xfer); 2956184610Salfred no_resetup = 2957184610Salfred ((xfer->address == udev->address) && 2958207080Sthompsa (udev->ctrl_ep_desc.wMaxPacketSize[0] == 2959184610Salfred udev->ddesc.bMaxPacketSize)); 2960192499Sthompsa if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2961184610Salfred if (no_resetup) { 2962184610Salfred /* 2963184610Salfred * NOTE: checking "xfer->address" and 2964184610Salfred * starting the USB transfer must be 2965184610Salfred * atomic! 2966184610Salfred */ 2967194228Sthompsa usbd_transfer_start(xfer); 2968184610Salfred } 2969184610Salfred } 2970184824Sthompsa USB_XFER_UNLOCK(xfer); 2971184610Salfred } else { 2972184610Salfred no_resetup = 0; 2973184610Salfred } 2974184610Salfred 2975184610Salfred if (no_resetup) { 2976184610Salfred /* 2977184610Salfred * All parameters are exactly the same like before. 2978184610Salfred * Just return. 2979184610Salfred */ 2980184610Salfred return; 2981184610Salfred } 2982184610Salfred /* 2983184610Salfred * Update wMaxPacketSize for the default control endpoint: 2984184610Salfred */ 2985207080Sthompsa udev->ctrl_ep_desc.wMaxPacketSize[0] = 2986184610Salfred udev->ddesc.bMaxPacketSize; 2987184610Salfred 2988184610Salfred /* 2989184610Salfred * Unsetup any existing USB transfer: 2990184610Salfred */ 2991207080Sthompsa usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX); 2992184610Salfred 2993184610Salfred /* 2994222790Shselasky * Reset clear stall error counter. 2995222790Shselasky */ 2996222790Shselasky udev->clear_stall_errors = 0; 2997222790Shselasky 2998222790Shselasky /* 2999184610Salfred * Try to setup a new USB transfer for the 3000184610Salfred * default control endpoint: 3001184610Salfred */ 3002184610Salfred iface_index = 0; 3003194228Sthompsa if (usbd_transfer_setup(udev, &iface_index, 3004207080Sthompsa udev->ctrl_xfer, usb_control_ep_cfg, USB_CTRL_XFER_MAX, NULL, 3005207079Sthompsa &udev->device_mtx)) { 3006184610Salfred DPRINTFN(0, "could not setup default " 3007199816Sthompsa "USB transfer\n"); 3008184610Salfred } else { 3009184610Salfred goto repeat; 3010184610Salfred } 3011184610Salfred} 3012184610Salfred 3013184610Salfred/*------------------------------------------------------------------------* 3014194228Sthompsa * usbd_clear_data_toggle - factored out code 3015184610Salfred * 3016184610Salfred * NOTE: the intention of this function is not to reset the hardware 3017184610Salfred * data toggle. 3018184610Salfred *------------------------------------------------------------------------*/ 3019184610Salfredvoid 3020213435Shselaskyusbd_clear_stall_locked(struct usb_device *udev, struct usb_endpoint *ep) 3021213435Shselasky{ 3022213435Shselasky USB_BUS_LOCK_ASSERT(udev->bus, MA_OWNED); 3023213435Shselasky 3024213435Shselasky /* check that we have a valid case */ 3025213435Shselasky if (udev->flags.usb_mode == USB_MODE_HOST && 3026213435Shselasky udev->parent_hub != NULL && 3027213435Shselasky udev->bus->methods->clear_stall != NULL && 3028213435Shselasky ep->methods != NULL) { 3029213435Shselasky (udev->bus->methods->clear_stall) (udev, ep); 3030213435Shselasky } 3031213435Shselasky} 3032213435Shselasky 3033213435Shselasky/*------------------------------------------------------------------------* 3034213435Shselasky * usbd_clear_data_toggle - factored out code 3035213435Shselasky * 3036213435Shselasky * NOTE: the intention of this function is not to reset the hardware 3037213435Shselasky * data toggle on the USB device side. 3038213435Shselasky *------------------------------------------------------------------------*/ 3039213435Shselaskyvoid 3040194228Sthompsausbd_clear_data_toggle(struct usb_device *udev, struct usb_endpoint *ep) 3041184610Salfred{ 3042193644Sthompsa DPRINTFN(5, "udev=%p endpoint=%p\n", udev, ep); 3043184610Salfred 3044184824Sthompsa USB_BUS_LOCK(udev->bus); 3045193644Sthompsa ep->toggle_next = 0; 3046213435Shselasky /* some hardware needs a callback to clear the data toggle */ 3047213435Shselasky usbd_clear_stall_locked(udev, ep); 3048184824Sthompsa USB_BUS_UNLOCK(udev->bus); 3049184610Salfred} 3050184610Salfred 3051184610Salfred/*------------------------------------------------------------------------* 3052194228Sthompsa * usbd_clear_stall_callback - factored out clear stall callback 3053184610Salfred * 3054184610Salfred * Input parameters: 3055184610Salfred * xfer1: Clear Stall Control Transfer 3056184610Salfred * xfer2: Stalled USB Transfer 3057184610Salfred * 3058184610Salfred * This function is NULL safe. 3059184610Salfred * 3060184610Salfred * Return values: 3061184610Salfred * 0: In progress 3062184610Salfred * Else: Finished 3063184610Salfred * 3064184610Salfred * Clear stall config example: 3065184610Salfred * 3066192984Sthompsa * static const struct usb_config my_clearstall = { 3067184610Salfred * .type = UE_CONTROL, 3068184610Salfred * .endpoint = 0, 3069184610Salfred * .direction = UE_DIR_ANY, 3070184610Salfred * .interval = 50, //50 milliseconds 3071192984Sthompsa * .bufsize = sizeof(struct usb_device_request), 3072190734Sthompsa * .timeout = 1000, //1.000 seconds 3073190734Sthompsa * .callback = &my_clear_stall_callback, // ** 3074190734Sthompsa * .usb_mode = USB_MODE_HOST, 3075184610Salfred * }; 3076184610Salfred * 3077194228Sthompsa * ** "my_clear_stall_callback" calls "usbd_clear_stall_callback" 3078184610Salfred * passing the correct parameters. 3079184610Salfred *------------------------------------------------------------------------*/ 3080184610Salfreduint8_t 3081194228Sthompsausbd_clear_stall_callback(struct usb_xfer *xfer1, 3082192984Sthompsa struct usb_xfer *xfer2) 3083184610Salfred{ 3084192984Sthompsa struct usb_device_request req; 3085184610Salfred 3086184610Salfred if (xfer2 == NULL) { 3087184610Salfred /* looks like we are tearing down */ 3088184610Salfred DPRINTF("NULL input parameter\n"); 3089184610Salfred return (0); 3090184610Salfred } 3091184824Sthompsa USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED); 3092184824Sthompsa USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED); 3093184610Salfred 3094184610Salfred switch (USB_GET_STATE(xfer1)) { 3095184610Salfred case USB_ST_SETUP: 3096184610Salfred 3097184610Salfred /* 3098184610Salfred * pre-clear the data toggle to DATA0 ("umass.c" and 3099184610Salfred * "ata-usb.c" depends on this) 3100184610Salfred */ 3101184610Salfred 3102194228Sthompsa usbd_clear_data_toggle(xfer2->xroot->udev, xfer2->endpoint); 3103184610Salfred 3104184610Salfred /* setup a clear-stall packet */ 3105184610Salfred 3106184610Salfred req.bmRequestType = UT_WRITE_ENDPOINT; 3107184610Salfred req.bRequest = UR_CLEAR_FEATURE; 3108184610Salfred USETW(req.wValue, UF_ENDPOINT_HALT); 3109193644Sthompsa req.wIndex[0] = xfer2->endpoint->edesc->bEndpointAddress; 3110184610Salfred req.wIndex[1] = 0; 3111184610Salfred USETW(req.wLength, 0); 3112184610Salfred 3113184610Salfred /* 3114194228Sthompsa * "usbd_transfer_setup_sub()" will ensure that 3115184610Salfred * we have sufficient room in the buffer for 3116184610Salfred * the request structure! 3117184610Salfred */ 3118184610Salfred 3119184610Salfred /* copy in the transfer */ 3120184610Salfred 3121194228Sthompsa usbd_copy_in(xfer1->frbuffers, 0, &req, sizeof(req)); 3122184610Salfred 3123184610Salfred /* set length */ 3124184610Salfred xfer1->frlengths[0] = sizeof(req); 3125184610Salfred xfer1->nframes = 1; 3126184610Salfred 3127194228Sthompsa usbd_transfer_submit(xfer1); 3128184610Salfred return (0); 3129184610Salfred 3130184610Salfred case USB_ST_TRANSFERRED: 3131184610Salfred break; 3132184610Salfred 3133184610Salfred default: /* Error */ 3134184610Salfred if (xfer1->error == USB_ERR_CANCELLED) { 3135184610Salfred return (0); 3136184610Salfred } 3137184610Salfred break; 3138184610Salfred } 3139184610Salfred return (1); /* Clear Stall Finished */ 3140184610Salfred} 3141184610Salfred 3142195960Salfred/*------------------------------------------------------------------------* 3143195960Salfred * usbd_transfer_poll 3144195960Salfred * 3145195960Salfred * The following function gets called from the USB keyboard driver and 3146195960Salfred * UMASS when the system has paniced. 3147195960Salfred * 3148195960Salfred * NOTE: It is currently not possible to resume normal operation on 3149195960Salfred * the USB controller which has been polled, due to clearing of the 3150195960Salfred * "up_dsleep" and "up_msleep" flags. 3151195960Salfred *------------------------------------------------------------------------*/ 3152184610Salfredvoid 3153194677Sthompsausbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max) 3154184610Salfred{ 3155195960Salfred struct usb_xfer *xfer; 3156195960Salfred struct usb_xfer_root *xroot; 3157195960Salfred struct usb_device *udev; 3158195960Salfred struct usb_proc_msg *pm; 3159195960Salfred uint16_t n; 3160195960Salfred uint16_t drop_bus; 3161195960Salfred uint16_t drop_xfer; 3162195960Salfred 3163195960Salfred for (n = 0; n != max; n++) { 3164195960Salfred /* Extra checks to avoid panic */ 3165195960Salfred xfer = ppxfer[n]; 3166195960Salfred if (xfer == NULL) 3167195960Salfred continue; /* no USB transfer */ 3168195960Salfred xroot = xfer->xroot; 3169195960Salfred if (xroot == NULL) 3170195960Salfred continue; /* no USB root */ 3171195960Salfred udev = xroot->udev; 3172195960Salfred if (udev == NULL) 3173195960Salfred continue; /* no USB device */ 3174195960Salfred if (udev->bus == NULL) 3175195960Salfred continue; /* no BUS structure */ 3176195960Salfred if (udev->bus->methods == NULL) 3177195960Salfred continue; /* no BUS methods */ 3178195960Salfred if (udev->bus->methods->xfer_poll == NULL) 3179195960Salfred continue; /* no poll method */ 3180195960Salfred 3181195960Salfred /* make sure that the BUS mutex is not locked */ 3182195960Salfred drop_bus = 0; 3183235410Savg while (mtx_owned(&xroot->udev->bus->bus_mtx) && !SCHEDULER_STOPPED()) { 3184195960Salfred mtx_unlock(&xroot->udev->bus->bus_mtx); 3185195960Salfred drop_bus++; 3186195960Salfred } 3187195960Salfred 3188195960Salfred /* make sure that the transfer mutex is not locked */ 3189195960Salfred drop_xfer = 0; 3190235410Savg while (mtx_owned(xroot->xfer_mtx) && !SCHEDULER_STOPPED()) { 3191195960Salfred mtx_unlock(xroot->xfer_mtx); 3192195960Salfred drop_xfer++; 3193195960Salfred } 3194195960Salfred 3195195960Salfred /* Make sure cv_signal() and cv_broadcast() is not called */ 3196195960Salfred udev->bus->control_xfer_proc.up_msleep = 0; 3197195960Salfred udev->bus->explore_proc.up_msleep = 0; 3198195960Salfred udev->bus->giant_callback_proc.up_msleep = 0; 3199195960Salfred udev->bus->non_giant_callback_proc.up_msleep = 0; 3200195960Salfred 3201195960Salfred /* poll USB hardware */ 3202195960Salfred (udev->bus->methods->xfer_poll) (udev->bus); 3203195960Salfred 3204195960Salfred USB_BUS_LOCK(xroot->bus); 3205195960Salfred 3206195960Salfred /* check for clear stall */ 3207207080Sthompsa if (udev->ctrl_xfer[1] != NULL) { 3208195960Salfred 3209195960Salfred /* poll clear stall start */ 3210195960Salfred pm = &udev->cs_msg[0].hdr; 3211195960Salfred (pm->pm_callback) (pm); 3212195960Salfred /* poll clear stall done thread */ 3213207080Sthompsa pm = &udev->ctrl_xfer[1]-> 3214195960Salfred xroot->done_m[0].hdr; 3215195960Salfred (pm->pm_callback) (pm); 3216195960Salfred } 3217195960Salfred 3218195960Salfred /* poll done thread */ 3219195960Salfred pm = &xroot->done_m[0].hdr; 3220195960Salfred (pm->pm_callback) (pm); 3221195960Salfred 3222195960Salfred USB_BUS_UNLOCK(xroot->bus); 3223195960Salfred 3224195960Salfred /* restore transfer mutex */ 3225195960Salfred while (drop_xfer--) 3226195960Salfred mtx_lock(xroot->xfer_mtx); 3227195960Salfred 3228195960Salfred /* restore BUS mutex */ 3229195960Salfred while (drop_bus--) 3230195960Salfred mtx_lock(&xroot->udev->bus->bus_mtx); 3231184610Salfred } 3232184610Salfred} 3233190734Sthompsa 3234190734Sthompsastatic void 3235194228Sthompsausbd_get_std_packet_size(struct usb_std_packet_size *ptr, 3236192500Sthompsa uint8_t type, enum usb_dev_speed speed) 3237190734Sthompsa{ 3238190734Sthompsa static const uint16_t intr_range_max[USB_SPEED_MAX] = { 3239190734Sthompsa [USB_SPEED_LOW] = 8, 3240190734Sthompsa [USB_SPEED_FULL] = 64, 3241190734Sthompsa [USB_SPEED_HIGH] = 1024, 3242190734Sthompsa [USB_SPEED_VARIABLE] = 1024, 3243190734Sthompsa [USB_SPEED_SUPER] = 1024, 3244190734Sthompsa }; 3245190734Sthompsa 3246190734Sthompsa static const uint16_t isoc_range_max[USB_SPEED_MAX] = { 3247190734Sthompsa [USB_SPEED_LOW] = 0, /* invalid */ 3248190734Sthompsa [USB_SPEED_FULL] = 1023, 3249190734Sthompsa [USB_SPEED_HIGH] = 1024, 3250190734Sthompsa [USB_SPEED_VARIABLE] = 3584, 3251190734Sthompsa [USB_SPEED_SUPER] = 1024, 3252190734Sthompsa }; 3253190734Sthompsa 3254190734Sthompsa static const uint16_t control_min[USB_SPEED_MAX] = { 3255190734Sthompsa [USB_SPEED_LOW] = 8, 3256190734Sthompsa [USB_SPEED_FULL] = 8, 3257190734Sthompsa [USB_SPEED_HIGH] = 64, 3258190734Sthompsa [USB_SPEED_VARIABLE] = 512, 3259190734Sthompsa [USB_SPEED_SUPER] = 512, 3260190734Sthompsa }; 3261190734Sthompsa 3262190734Sthompsa static const uint16_t bulk_min[USB_SPEED_MAX] = { 3263209443Sthompsa [USB_SPEED_LOW] = 8, 3264190734Sthompsa [USB_SPEED_FULL] = 8, 3265190734Sthompsa [USB_SPEED_HIGH] = 512, 3266190734Sthompsa [USB_SPEED_VARIABLE] = 512, 3267190734Sthompsa [USB_SPEED_SUPER] = 1024, 3268190734Sthompsa }; 3269190734Sthompsa 3270190734Sthompsa uint16_t temp; 3271190734Sthompsa 3272190734Sthompsa memset(ptr, 0, sizeof(*ptr)); 3273190734Sthompsa 3274190734Sthompsa switch (type) { 3275190734Sthompsa case UE_INTERRUPT: 3276192500Sthompsa ptr->range.max = intr_range_max[speed]; 3277190734Sthompsa break; 3278190734Sthompsa case UE_ISOCHRONOUS: 3279192500Sthompsa ptr->range.max = isoc_range_max[speed]; 3280190734Sthompsa break; 3281190734Sthompsa default: 3282190734Sthompsa if (type == UE_BULK) 3283192500Sthompsa temp = bulk_min[speed]; 3284190734Sthompsa else /* UE_CONTROL */ 3285192500Sthompsa temp = control_min[speed]; 3286190734Sthompsa 3287190734Sthompsa /* default is fixed */ 3288190734Sthompsa ptr->fixed[0] = temp; 3289190734Sthompsa ptr->fixed[1] = temp; 3290190734Sthompsa ptr->fixed[2] = temp; 3291190734Sthompsa ptr->fixed[3] = temp; 3292190734Sthompsa 3293192500Sthompsa if (speed == USB_SPEED_FULL) { 3294190734Sthompsa /* multiple sizes */ 3295190734Sthompsa ptr->fixed[1] = 16; 3296190734Sthompsa ptr->fixed[2] = 32; 3297190734Sthompsa ptr->fixed[3] = 64; 3298190734Sthompsa } 3299192500Sthompsa if ((speed == USB_SPEED_VARIABLE) && 3300190734Sthompsa (type == UE_BULK)) { 3301190734Sthompsa /* multiple sizes */ 3302190734Sthompsa ptr->fixed[2] = 1024; 3303190734Sthompsa ptr->fixed[3] = 1536; 3304190734Sthompsa } 3305190734Sthompsa break; 3306190734Sthompsa } 3307190734Sthompsa} 3308194677Sthompsa 3309194677Sthompsavoid * 3310194677Sthompsausbd_xfer_softc(struct usb_xfer *xfer) 3311194677Sthompsa{ 3312194677Sthompsa return (xfer->priv_sc); 3313194677Sthompsa} 3314194677Sthompsa 3315194677Sthompsavoid * 3316194677Sthompsausbd_xfer_get_priv(struct usb_xfer *xfer) 3317194677Sthompsa{ 3318194677Sthompsa return (xfer->priv_fifo); 3319194677Sthompsa} 3320194677Sthompsa 3321194677Sthompsavoid 3322194677Sthompsausbd_xfer_set_priv(struct usb_xfer *xfer, void *ptr) 3323194677Sthompsa{ 3324194677Sthompsa xfer->priv_fifo = ptr; 3325194677Sthompsa} 3326194677Sthompsa 3327194677Sthompsauint8_t 3328194677Sthompsausbd_xfer_state(struct usb_xfer *xfer) 3329194677Sthompsa{ 3330194677Sthompsa return (xfer->usb_state); 3331194677Sthompsa} 3332194677Sthompsa 3333194677Sthompsavoid 3334194677Sthompsausbd_xfer_set_flag(struct usb_xfer *xfer, int flag) 3335194677Sthompsa{ 3336194677Sthompsa switch (flag) { 3337194677Sthompsa case USB_FORCE_SHORT_XFER: 3338194677Sthompsa xfer->flags.force_short_xfer = 1; 3339194677Sthompsa break; 3340194677Sthompsa case USB_SHORT_XFER_OK: 3341194677Sthompsa xfer->flags.short_xfer_ok = 1; 3342194677Sthompsa break; 3343195121Sthompsa case USB_MULTI_SHORT_OK: 3344195121Sthompsa xfer->flags.short_frames_ok = 1; 3345195121Sthompsa break; 3346195121Sthompsa case USB_MANUAL_STATUS: 3347195121Sthompsa xfer->flags.manual_status = 1; 3348195121Sthompsa break; 3349194677Sthompsa } 3350194677Sthompsa} 3351194677Sthompsa 3352194677Sthompsavoid 3353194677Sthompsausbd_xfer_clr_flag(struct usb_xfer *xfer, int flag) 3354194677Sthompsa{ 3355194677Sthompsa switch (flag) { 3356194677Sthompsa case USB_FORCE_SHORT_XFER: 3357194677Sthompsa xfer->flags.force_short_xfer = 0; 3358194677Sthompsa break; 3359194677Sthompsa case USB_SHORT_XFER_OK: 3360194677Sthompsa xfer->flags.short_xfer_ok = 0; 3361194677Sthompsa break; 3362195121Sthompsa case USB_MULTI_SHORT_OK: 3363195121Sthompsa xfer->flags.short_frames_ok = 0; 3364195121Sthompsa break; 3365195121Sthompsa case USB_MANUAL_STATUS: 3366195121Sthompsa xfer->flags.manual_status = 0; 3367195121Sthompsa break; 3368194677Sthompsa } 3369194677Sthompsa} 3370195121Sthompsa 3371195121Sthompsa/* 3372195121Sthompsa * The following function returns in milliseconds when the isochronous 3373195121Sthompsa * transfer was completed by the hardware. The returned value wraps 3374195121Sthompsa * around 65536 milliseconds. 3375195121Sthompsa */ 3376195121Sthompsauint16_t 3377195121Sthompsausbd_xfer_get_timestamp(struct usb_xfer *xfer) 3378195121Sthompsa{ 3379195121Sthompsa return (xfer->isoc_time_complete); 3380195121Sthompsa} 3381263644Shselasky 3382263644Shselasky/* 3383263644Shselasky * The following function returns non-zero if the max packet size 3384263644Shselasky * field was clamped to a valid value. Else it returns zero. 3385263644Shselasky */ 3386263644Shselaskyuint8_t 3387263644Shselaskyusbd_xfer_maxp_was_clamped(struct usb_xfer *xfer) 3388263644Shselasky{ 3389263644Shselasky return (xfer->flags_int.maxp_was_clamped); 3390263644Shselasky} 3391