usb_transfer.c revision 195960
1/* $FreeBSD: head/sys/dev/usb/usb_transfer.c 195960 2009-07-30 00:14:34Z alfred $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27#include <sys/stdint.h> 28#include <sys/stddef.h> 29#include <sys/param.h> 30#include <sys/queue.h> 31#include <sys/types.h> 32#include <sys/systm.h> 33#include <sys/kernel.h> 34#include <sys/bus.h> 35#include <sys/linker_set.h> 36#include <sys/module.h> 37#include <sys/lock.h> 38#include <sys/mutex.h> 39#include <sys/condvar.h> 40#include <sys/sysctl.h> 41#include <sys/sx.h> 42#include <sys/unistd.h> 43#include <sys/callout.h> 44#include <sys/malloc.h> 45#include <sys/priv.h> 46 47#include <dev/usb/usb.h> 48#include <dev/usb/usbdi.h> 49#include <dev/usb/usbdi_util.h> 50 51#define USB_DEBUG_VAR usb_debug 52 53#include <dev/usb/usb_core.h> 54#include <dev/usb/usb_busdma.h> 55#include <dev/usb/usb_process.h> 56#include <dev/usb/usb_transfer.h> 57#include <dev/usb/usb_device.h> 58#include <dev/usb/usb_debug.h> 59#include <dev/usb/usb_util.h> 60 61#include <dev/usb/usb_controller.h> 62#include <dev/usb/usb_bus.h> 63 64struct usb_std_packet_size { 65 struct { 66 uint16_t min; /* inclusive */ 67 uint16_t max; /* inclusive */ 68 } range; 69 70 uint16_t fixed[4]; 71}; 72 73static usb_callback_t usb_request_callback; 74 75static const struct usb_config usb_control_ep_cfg[USB_DEFAULT_XFER_MAX] = { 76 77 /* This transfer is used for generic control endpoint transfers */ 78 79 [0] = { 80 .type = UE_CONTROL, 81 .endpoint = 0x00, /* Control endpoint */ 82 .direction = UE_DIR_ANY, 83 .bufsize = USB_EP0_BUFSIZE, /* bytes */ 84 .flags = {.proxy_buffer = 1,}, 85 .callback = &usb_request_callback, 86 .usb_mode = USB_MODE_DUAL, /* both modes */ 87 }, 88 89 /* This transfer is used for generic clear stall only */ 90 91 [1] = { 92 .type = UE_CONTROL, 93 .endpoint = 0x00, /* Control pipe */ 94 .direction = UE_DIR_ANY, 95 .bufsize = sizeof(struct usb_device_request), 96 .callback = &usb_do_clear_stall_callback, 97 .timeout = 1000, /* 1 second */ 98 .interval = 50, /* 50ms */ 99 .usb_mode = USB_MODE_HOST, 100 }, 101}; 102 103/* function prototypes */ 104 105static void usbd_update_max_frame_size(struct usb_xfer *); 106static void usbd_transfer_unsetup_sub(struct usb_xfer_root *, uint8_t); 107static void usbd_control_transfer_init(struct usb_xfer *); 108static int usbd_setup_ctrl_transfer(struct usb_xfer *); 109static void usb_callback_proc(struct usb_proc_msg *); 110static void usbd_callback_ss_done_defer(struct usb_xfer *); 111static void usbd_callback_wrapper(struct usb_xfer_queue *); 112static void usb_dma_delay_done_cb(void *); 113static void usbd_transfer_start_cb(void *); 114static uint8_t usbd_callback_wrapper_sub(struct usb_xfer *); 115static void usbd_get_std_packet_size(struct usb_std_packet_size *ptr, 116 uint8_t type, enum usb_dev_speed speed); 117 118/*------------------------------------------------------------------------* 119 * usb_request_callback 120 *------------------------------------------------------------------------*/ 121static void 122usb_request_callback(struct usb_xfer *xfer, usb_error_t error) 123{ 124 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) 125 usb_handle_request_callback(xfer, error); 126 else 127 usbd_do_request_callback(xfer, error); 128} 129 130/*------------------------------------------------------------------------* 131 * usbd_update_max_frame_size 132 * 133 * This function updates the maximum frame size, hence high speed USB 134 * can transfer multiple consecutive packets. 135 *------------------------------------------------------------------------*/ 136static void 137usbd_update_max_frame_size(struct usb_xfer *xfer) 138{ 139 /* compute maximum frame size */ 140 141 if (xfer->max_packet_count == 2) { 142 xfer->max_frame_size = 2 * xfer->max_packet_size; 143 } else if (xfer->max_packet_count == 3) { 144 xfer->max_frame_size = 3 * xfer->max_packet_size; 145 } else { 146 xfer->max_frame_size = xfer->max_packet_size; 147 } 148} 149 150/*------------------------------------------------------------------------* 151 * usbd_get_dma_delay 152 * 153 * The following function is called when we need to 154 * synchronize with DMA hardware. 155 * 156 * Returns: 157 * 0: no DMA delay required 158 * Else: milliseconds of DMA delay 159 *------------------------------------------------------------------------*/ 160usb_timeout_t 161usbd_get_dma_delay(struct usb_bus *bus) 162{ 163 uint32_t temp = 0; 164 165 if (bus->methods->get_dma_delay) { 166 (bus->methods->get_dma_delay) (bus, &temp); 167 /* 168 * Round up and convert to milliseconds. Note that we use 169 * 1024 milliseconds per second. to save a division. 170 */ 171 temp += 0x3FF; 172 temp /= 0x400; 173 } 174 return (temp); 175} 176 177/*------------------------------------------------------------------------* 178 * usbd_transfer_setup_sub_malloc 179 * 180 * This function will allocate one or more DMA'able memory chunks 181 * according to "size", "align" and "count" arguments. "ppc" is 182 * pointed to a linear array of USB page caches afterwards. 183 * 184 * Returns: 185 * 0: Success 186 * Else: Failure 187 *------------------------------------------------------------------------*/ 188#if USB_HAVE_BUSDMA 189uint8_t 190usbd_transfer_setup_sub_malloc(struct usb_setup_params *parm, 191 struct usb_page_cache **ppc, usb_size_t size, usb_size_t align, 192 usb_size_t count) 193{ 194 struct usb_page_cache *pc; 195 struct usb_page *pg; 196 void *buf; 197 usb_size_t n_dma_pc; 198 usb_size_t n_obj; 199 usb_size_t x; 200 usb_size_t y; 201 usb_size_t r; 202 usb_size_t z; 203 204 USB_ASSERT(align > 1, ("Invalid alignment, 0x%08x!\n", 205 align)); 206 USB_ASSERT(size > 0, ("Invalid size = 0!\n")); 207 208 if (count == 0) { 209 return (0); /* nothing to allocate */ 210 } 211 /* 212 * Make sure that the size is aligned properly. 213 */ 214 size = -((-size) & (-align)); 215 216 /* 217 * Try multi-allocation chunks to reduce the number of DMA 218 * allocations, hence DMA allocations are slow. 219 */ 220 if (size >= PAGE_SIZE) { 221 n_dma_pc = count; 222 n_obj = 1; 223 } else { 224 /* compute number of objects per page */ 225 n_obj = (PAGE_SIZE / size); 226 /* 227 * Compute number of DMA chunks, rounded up 228 * to nearest one: 229 */ 230 n_dma_pc = ((count + n_obj - 1) / n_obj); 231 } 232 233 if (parm->buf == NULL) { 234 /* for the future */ 235 parm->dma_page_ptr += n_dma_pc; 236 parm->dma_page_cache_ptr += n_dma_pc; 237 parm->dma_page_ptr += count; 238 parm->xfer_page_cache_ptr += count; 239 return (0); 240 } 241 for (x = 0; x != n_dma_pc; x++) { 242 /* need to initialize the page cache */ 243 parm->dma_page_cache_ptr[x].tag_parent = 244 &parm->curr_xfer->xroot->dma_parent_tag; 245 } 246 for (x = 0; x != count; x++) { 247 /* need to initialize the page cache */ 248 parm->xfer_page_cache_ptr[x].tag_parent = 249 &parm->curr_xfer->xroot->dma_parent_tag; 250 } 251 252 if (ppc) { 253 *ppc = parm->xfer_page_cache_ptr; 254 } 255 r = count; /* set remainder count */ 256 z = n_obj * size; /* set allocation size */ 257 pc = parm->xfer_page_cache_ptr; 258 pg = parm->dma_page_ptr; 259 260 for (x = 0; x != n_dma_pc; x++) { 261 262 if (r < n_obj) { 263 /* compute last remainder */ 264 z = r * size; 265 n_obj = r; 266 } 267 if (usb_pc_alloc_mem(parm->dma_page_cache_ptr, 268 pg, z, align)) { 269 return (1); /* failure */ 270 } 271 /* Set beginning of current buffer */ 272 buf = parm->dma_page_cache_ptr->buffer; 273 /* Make room for one DMA page cache and one page */ 274 parm->dma_page_cache_ptr++; 275 pg++; 276 277 for (y = 0; (y != n_obj); y++, r--, pc++, pg++) { 278 279 /* Load sub-chunk into DMA */ 280 if (usb_pc_dmamap_create(pc, size)) { 281 return (1); /* failure */ 282 } 283 pc->buffer = USB_ADD_BYTES(buf, y * size); 284 pc->page_start = pg; 285 286 mtx_lock(pc->tag_parent->mtx); 287 if (usb_pc_load_mem(pc, size, 1 /* synchronous */ )) { 288 mtx_unlock(pc->tag_parent->mtx); 289 return (1); /* failure */ 290 } 291 mtx_unlock(pc->tag_parent->mtx); 292 } 293 } 294 295 parm->xfer_page_cache_ptr = pc; 296 parm->dma_page_ptr = pg; 297 return (0); 298} 299#endif 300 301/*------------------------------------------------------------------------* 302 * usbd_transfer_setup_sub - transfer setup subroutine 303 * 304 * This function must be called from the "xfer_setup" callback of the 305 * USB Host or Device controller driver when setting up an USB 306 * transfer. This function will setup correct packet sizes, buffer 307 * sizes, flags and more, that are stored in the "usb_xfer" 308 * structure. 309 *------------------------------------------------------------------------*/ 310void 311usbd_transfer_setup_sub(struct usb_setup_params *parm) 312{ 313 enum { 314 REQ_SIZE = 8, 315 MIN_PKT = 8, 316 }; 317 struct usb_xfer *xfer = parm->curr_xfer; 318 const struct usb_config *setup = parm->curr_setup; 319 struct usb_endpoint_descriptor *edesc; 320 struct usb_std_packet_size std_size; 321 usb_frcount_t n_frlengths; 322 usb_frcount_t n_frbuffers; 323 usb_frcount_t x; 324 uint8_t type; 325 uint8_t zmps; 326 327 /* 328 * Sanity check. The following parameters must be initialized before 329 * calling this function. 330 */ 331 if ((parm->hc_max_packet_size == 0) || 332 (parm->hc_max_packet_count == 0) || 333 (parm->hc_max_frame_size == 0)) { 334 parm->err = USB_ERR_INVAL; 335 goto done; 336 } 337 edesc = xfer->endpoint->edesc; 338 339 type = (edesc->bmAttributes & UE_XFERTYPE); 340 341 xfer->flags = setup->flags; 342 xfer->nframes = setup->frames; 343 xfer->timeout = setup->timeout; 344 xfer->callback = setup->callback; 345 xfer->interval = setup->interval; 346 xfer->endpointno = edesc->bEndpointAddress; 347 xfer->max_packet_size = UGETW(edesc->wMaxPacketSize); 348 xfer->max_packet_count = 1; 349 /* make a shadow copy: */ 350 xfer->flags_int.usb_mode = parm->udev->flags.usb_mode; 351 352 parm->bufsize = setup->bufsize; 353 354 if (parm->speed == USB_SPEED_HIGH) { 355 xfer->max_packet_count += (xfer->max_packet_size >> 11) & 3; 356 xfer->max_packet_size &= 0x7FF; 357 } 358 /* range check "max_packet_count" */ 359 360 if (xfer->max_packet_count > parm->hc_max_packet_count) { 361 xfer->max_packet_count = parm->hc_max_packet_count; 362 } 363 /* filter "wMaxPacketSize" according to HC capabilities */ 364 365 if ((xfer->max_packet_size > parm->hc_max_packet_size) || 366 (xfer->max_packet_size == 0)) { 367 xfer->max_packet_size = parm->hc_max_packet_size; 368 } 369 /* filter "wMaxPacketSize" according to standard sizes */ 370 371 usbd_get_std_packet_size(&std_size, type, parm->speed); 372 373 if (std_size.range.min || std_size.range.max) { 374 375 if (xfer->max_packet_size < std_size.range.min) { 376 xfer->max_packet_size = std_size.range.min; 377 } 378 if (xfer->max_packet_size > std_size.range.max) { 379 xfer->max_packet_size = std_size.range.max; 380 } 381 } else { 382 383 if (xfer->max_packet_size >= std_size.fixed[3]) { 384 xfer->max_packet_size = std_size.fixed[3]; 385 } else if (xfer->max_packet_size >= std_size.fixed[2]) { 386 xfer->max_packet_size = std_size.fixed[2]; 387 } else if (xfer->max_packet_size >= std_size.fixed[1]) { 388 xfer->max_packet_size = std_size.fixed[1]; 389 } else { 390 /* only one possibility left */ 391 xfer->max_packet_size = std_size.fixed[0]; 392 } 393 } 394 395 /* compute "max_frame_size" */ 396 397 usbd_update_max_frame_size(xfer); 398 399 /* check interrupt interval and transfer pre-delay */ 400 401 if (type == UE_ISOCHRONOUS) { 402 403 uint16_t frame_limit; 404 405 xfer->interval = 0; /* not used, must be zero */ 406 xfer->flags_int.isochronous_xfr = 1; /* set flag */ 407 408 if (xfer->timeout == 0) { 409 /* 410 * set a default timeout in 411 * case something goes wrong! 412 */ 413 xfer->timeout = 1000 / 4; 414 } 415 switch (parm->speed) { 416 case USB_SPEED_LOW: 417 case USB_SPEED_FULL: 418 frame_limit = USB_MAX_FS_ISOC_FRAMES_PER_XFER; 419 break; 420 default: 421 frame_limit = USB_MAX_HS_ISOC_FRAMES_PER_XFER; 422 break; 423 } 424 425 if (xfer->nframes > frame_limit) { 426 /* 427 * this is not going to work 428 * cross hardware 429 */ 430 parm->err = USB_ERR_INVAL; 431 goto done; 432 } 433 if (xfer->nframes == 0) { 434 /* 435 * this is not a valid value 436 */ 437 parm->err = USB_ERR_ZERO_NFRAMES; 438 goto done; 439 } 440 } else { 441 442 /* 443 * if a value is specified use that else check the endpoint 444 * descriptor 445 */ 446 if (xfer->interval == 0) { 447 448 if (type == UE_INTERRUPT) { 449 450 xfer->interval = edesc->bInterval; 451 452 switch (parm->speed) { 453 case USB_SPEED_SUPER: 454 case USB_SPEED_VARIABLE: 455 /* 125us -> 1ms */ 456 if (xfer->interval < 4) 457 xfer->interval = 1; 458 else if (xfer->interval > 16) 459 xfer->interval = (1<<(16-4)); 460 else 461 xfer->interval = 462 (1 << (xfer->interval-4)); 463 break; 464 case USB_SPEED_HIGH: 465 /* 125us -> 1ms */ 466 xfer->interval /= 8; 467 break; 468 default: 469 break; 470 } 471 if (xfer->interval == 0) { 472 /* 473 * One millisecond is the smallest 474 * interval we support: 475 */ 476 xfer->interval = 1; 477 } 478 } 479 } 480 } 481 482 /* 483 * NOTE: we do not allow "max_packet_size" or "max_frame_size" 484 * to be equal to zero when setting up USB transfers, hence 485 * this leads to alot of extra code in the USB kernel. 486 */ 487 488 if ((xfer->max_frame_size == 0) || 489 (xfer->max_packet_size == 0)) { 490 491 zmps = 1; 492 493 if ((parm->bufsize <= MIN_PKT) && 494 (type != UE_CONTROL) && 495 (type != UE_BULK)) { 496 497 /* workaround */ 498 xfer->max_packet_size = MIN_PKT; 499 xfer->max_packet_count = 1; 500 parm->bufsize = 0; /* automatic setup length */ 501 usbd_update_max_frame_size(xfer); 502 503 } else { 504 parm->err = USB_ERR_ZERO_MAXP; 505 goto done; 506 } 507 508 } else { 509 zmps = 0; 510 } 511 512 /* 513 * check if we should setup a default 514 * length: 515 */ 516 517 if (parm->bufsize == 0) { 518 519 parm->bufsize = xfer->max_frame_size; 520 521 if (type == UE_ISOCHRONOUS) { 522 parm->bufsize *= xfer->nframes; 523 } 524 } 525 /* 526 * check if we are about to setup a proxy 527 * type of buffer: 528 */ 529 530 if (xfer->flags.proxy_buffer) { 531 532 /* round bufsize up */ 533 534 parm->bufsize += (xfer->max_frame_size - 1); 535 536 if (parm->bufsize < xfer->max_frame_size) { 537 /* length wrapped around */ 538 parm->err = USB_ERR_INVAL; 539 goto done; 540 } 541 /* subtract remainder */ 542 543 parm->bufsize -= (parm->bufsize % xfer->max_frame_size); 544 545 /* add length of USB device request structure, if any */ 546 547 if (type == UE_CONTROL) { 548 parm->bufsize += REQ_SIZE; /* SETUP message */ 549 } 550 } 551 xfer->max_data_length = parm->bufsize; 552 553 /* Setup "n_frlengths" and "n_frbuffers" */ 554 555 if (type == UE_ISOCHRONOUS) { 556 n_frlengths = xfer->nframes; 557 n_frbuffers = 1; 558 } else { 559 560 if (type == UE_CONTROL) { 561 xfer->flags_int.control_xfr = 1; 562 if (xfer->nframes == 0) { 563 if (parm->bufsize <= REQ_SIZE) { 564 /* 565 * there will never be any data 566 * stage 567 */ 568 xfer->nframes = 1; 569 } else { 570 xfer->nframes = 2; 571 } 572 } 573 } else { 574 if (xfer->nframes == 0) { 575 xfer->nframes = 1; 576 } 577 } 578 579 n_frlengths = xfer->nframes; 580 n_frbuffers = xfer->nframes; 581 } 582 583 /* 584 * check if we have room for the 585 * USB device request structure: 586 */ 587 588 if (type == UE_CONTROL) { 589 590 if (xfer->max_data_length < REQ_SIZE) { 591 /* length wrapped around or too small bufsize */ 592 parm->err = USB_ERR_INVAL; 593 goto done; 594 } 595 xfer->max_data_length -= REQ_SIZE; 596 } 597 /* setup "frlengths" */ 598 xfer->frlengths = parm->xfer_length_ptr; 599 parm->xfer_length_ptr += n_frlengths; 600 601 /* setup "frbuffers" */ 602 xfer->frbuffers = parm->xfer_page_cache_ptr; 603 parm->xfer_page_cache_ptr += n_frbuffers; 604 605 /* initialize max frame count */ 606 xfer->max_frame_count = xfer->nframes; 607 608 /* 609 * check if we need to setup 610 * a local buffer: 611 */ 612 613 if (!xfer->flags.ext_buffer) { 614 615 /* align data */ 616 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 617 618 if (parm->buf) { 619 620 xfer->local_buffer = 621 USB_ADD_BYTES(parm->buf, parm->size[0]); 622 623 usbd_xfer_set_frame_offset(xfer, 0, 0); 624 625 if ((type == UE_CONTROL) && (n_frbuffers > 1)) { 626 usbd_xfer_set_frame_offset(xfer, REQ_SIZE, 1); 627 } 628 } 629 parm->size[0] += parm->bufsize; 630 631 /* align data again */ 632 parm->size[0] += ((-parm->size[0]) & (USB_HOST_ALIGN - 1)); 633 } 634 /* 635 * Compute maximum buffer size 636 */ 637 638 if (parm->bufsize_max < parm->bufsize) { 639 parm->bufsize_max = parm->bufsize; 640 } 641#if USB_HAVE_BUSDMA 642 if (xfer->flags_int.bdma_enable) { 643 /* 644 * Setup "dma_page_ptr". 645 * 646 * Proof for formula below: 647 * 648 * Assume there are three USB frames having length "a", "b" and 649 * "c". These USB frames will at maximum need "z" 650 * "usb_page" structures. "z" is given by: 651 * 652 * z = ((a / USB_PAGE_SIZE) + 2) + ((b / USB_PAGE_SIZE) + 2) + 653 * ((c / USB_PAGE_SIZE) + 2); 654 * 655 * Constraining "a", "b" and "c" like this: 656 * 657 * (a + b + c) <= parm->bufsize 658 * 659 * We know that: 660 * 661 * z <= ((parm->bufsize / USB_PAGE_SIZE) + (3*2)); 662 * 663 * Here is the general formula: 664 */ 665 xfer->dma_page_ptr = parm->dma_page_ptr; 666 parm->dma_page_ptr += (2 * n_frbuffers); 667 parm->dma_page_ptr += (parm->bufsize / USB_PAGE_SIZE); 668 } 669#endif 670 if (zmps) { 671 /* correct maximum data length */ 672 xfer->max_data_length = 0; 673 } 674 /* subtract USB frame remainder from "hc_max_frame_size" */ 675 676 xfer->max_hc_frame_size = 677 (parm->hc_max_frame_size - 678 (parm->hc_max_frame_size % xfer->max_frame_size)); 679 680 if (xfer->max_hc_frame_size == 0) { 681 parm->err = USB_ERR_INVAL; 682 goto done; 683 } 684 685 /* initialize frame buffers */ 686 687 if (parm->buf) { 688 for (x = 0; x != n_frbuffers; x++) { 689 xfer->frbuffers[x].tag_parent = 690 &xfer->xroot->dma_parent_tag; 691#if USB_HAVE_BUSDMA 692 if (xfer->flags_int.bdma_enable && 693 (parm->bufsize_max > 0)) { 694 695 if (usb_pc_dmamap_create( 696 xfer->frbuffers + x, 697 parm->bufsize_max)) { 698 parm->err = USB_ERR_NOMEM; 699 goto done; 700 } 701 } 702#endif 703 } 704 } 705done: 706 if (parm->err) { 707 /* 708 * Set some dummy values so that we avoid division by zero: 709 */ 710 xfer->max_hc_frame_size = 1; 711 xfer->max_frame_size = 1; 712 xfer->max_packet_size = 1; 713 xfer->max_data_length = 0; 714 xfer->nframes = 0; 715 xfer->max_frame_count = 0; 716 } 717} 718 719/*------------------------------------------------------------------------* 720 * usbd_transfer_setup - setup an array of USB transfers 721 * 722 * NOTE: You must always call "usbd_transfer_unsetup" after calling 723 * "usbd_transfer_setup" if success was returned. 724 * 725 * The idea is that the USB device driver should pre-allocate all its 726 * transfers by one call to this function. 727 * 728 * Return values: 729 * 0: Success 730 * Else: Failure 731 *------------------------------------------------------------------------*/ 732usb_error_t 733usbd_transfer_setup(struct usb_device *udev, 734 const uint8_t *ifaces, struct usb_xfer **ppxfer, 735 const struct usb_config *setup_start, uint16_t n_setup, 736 void *priv_sc, struct mtx *xfer_mtx) 737{ 738 struct usb_xfer dummy; 739 struct usb_setup_params parm; 740 const struct usb_config *setup_end = setup_start + n_setup; 741 const struct usb_config *setup; 742 struct usb_endpoint *ep; 743 struct usb_xfer_root *info; 744 struct usb_xfer *xfer; 745 void *buf = NULL; 746 uint16_t n; 747 uint16_t refcount; 748 749 parm.err = 0; 750 refcount = 0; 751 info = NULL; 752 753 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 754 "usbd_transfer_setup can sleep!"); 755 756 /* do some checking first */ 757 758 if (n_setup == 0) { 759 DPRINTFN(6, "setup array has zero length!\n"); 760 return (USB_ERR_INVAL); 761 } 762 if (ifaces == 0) { 763 DPRINTFN(6, "ifaces array is NULL!\n"); 764 return (USB_ERR_INVAL); 765 } 766 if (xfer_mtx == NULL) { 767 DPRINTFN(6, "using global lock\n"); 768 xfer_mtx = &Giant; 769 } 770 /* sanity checks */ 771 for (setup = setup_start, n = 0; 772 setup != setup_end; setup++, n++) { 773 if (setup->bufsize == (usb_frlength_t)-1) { 774 parm.err = USB_ERR_BAD_BUFSIZE; 775 DPRINTF("invalid bufsize\n"); 776 } 777 if (setup->callback == NULL) { 778 parm.err = USB_ERR_NO_CALLBACK; 779 DPRINTF("no callback\n"); 780 } 781 ppxfer[n] = NULL; 782 } 783 784 if (parm.err) { 785 goto done; 786 } 787 bzero(&parm, sizeof(parm)); 788 789 parm.udev = udev; 790 parm.speed = usbd_get_speed(udev); 791 parm.hc_max_packet_count = 1; 792 793 if (parm.speed >= USB_SPEED_MAX) { 794 parm.err = USB_ERR_INVAL; 795 goto done; 796 } 797 /* setup all transfers */ 798 799 while (1) { 800 801 if (buf) { 802 /* 803 * Initialize the "usb_xfer_root" structure, 804 * which is common for all our USB transfers. 805 */ 806 info = USB_ADD_BYTES(buf, 0); 807 808 info->memory_base = buf; 809 info->memory_size = parm.size[0]; 810 811#if USB_HAVE_BUSDMA 812 info->dma_page_cache_start = USB_ADD_BYTES(buf, parm.size[4]); 813 info->dma_page_cache_end = USB_ADD_BYTES(buf, parm.size[5]); 814#endif 815 info->xfer_page_cache_start = USB_ADD_BYTES(buf, parm.size[5]); 816 info->xfer_page_cache_end = USB_ADD_BYTES(buf, parm.size[2]); 817 818 cv_init(&info->cv_drain, "WDRAIN"); 819 820 info->xfer_mtx = xfer_mtx; 821#if USB_HAVE_BUSDMA 822 usb_dma_tag_setup(&info->dma_parent_tag, 823 parm.dma_tag_p, udev->bus->dma_parent_tag[0].tag, 824 xfer_mtx, &usb_bdma_done_event, 32, parm.dma_tag_max); 825#endif 826 827 info->bus = udev->bus; 828 info->udev = udev; 829 830 TAILQ_INIT(&info->done_q.head); 831 info->done_q.command = &usbd_callback_wrapper; 832#if USB_HAVE_BUSDMA 833 TAILQ_INIT(&info->dma_q.head); 834 info->dma_q.command = &usb_bdma_work_loop; 835#endif 836 info->done_m[0].hdr.pm_callback = &usb_callback_proc; 837 info->done_m[0].xroot = info; 838 info->done_m[1].hdr.pm_callback = &usb_callback_proc; 839 info->done_m[1].xroot = info; 840 841 /* 842 * In device side mode control endpoint 843 * requests need to run from a separate 844 * context, else there is a chance of 845 * deadlock! 846 */ 847 if (setup_start == usb_control_ep_cfg) 848 info->done_p = 849 &udev->bus->control_xfer_proc; 850 else if (xfer_mtx == &Giant) 851 info->done_p = 852 &udev->bus->giant_callback_proc; 853 else 854 info->done_p = 855 &udev->bus->non_giant_callback_proc; 856 } 857 /* reset sizes */ 858 859 parm.size[0] = 0; 860 parm.buf = buf; 861 parm.size[0] += sizeof(info[0]); 862 863 for (setup = setup_start, n = 0; 864 setup != setup_end; setup++, n++) { 865 866 /* skip USB transfers without callbacks: */ 867 if (setup->callback == NULL) { 868 continue; 869 } 870 /* see if there is a matching endpoint */ 871 ep = usbd_get_endpoint(udev, 872 ifaces[setup->if_index], setup); 873 874 if ((ep == NULL) || (ep->methods == NULL)) { 875 if (setup->flags.no_pipe_ok) 876 continue; 877 if ((setup->usb_mode != USB_MODE_DUAL) && 878 (setup->usb_mode != udev->flags.usb_mode)) 879 continue; 880 parm.err = USB_ERR_NO_PIPE; 881 goto done; 882 } 883 884 /* align data properly */ 885 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 886 887 /* store current setup pointer */ 888 parm.curr_setup = setup; 889 890 if (buf) { 891 /* 892 * Common initialization of the 893 * "usb_xfer" structure. 894 */ 895 xfer = USB_ADD_BYTES(buf, parm.size[0]); 896 xfer->address = udev->address; 897 xfer->priv_sc = priv_sc; 898 xfer->xroot = info; 899 900 usb_callout_init_mtx(&xfer->timeout_handle, 901 &udev->bus->bus_mtx, 0); 902 } else { 903 /* 904 * Setup a dummy xfer, hence we are 905 * writing to the "usb_xfer" 906 * structure pointed to by "xfer" 907 * before we have allocated any 908 * memory: 909 */ 910 xfer = &dummy; 911 bzero(&dummy, sizeof(dummy)); 912 refcount++; 913 } 914 915 /* set transfer endpoint pointer */ 916 xfer->endpoint = ep; 917 918 parm.size[0] += sizeof(xfer[0]); 919 parm.methods = xfer->endpoint->methods; 920 parm.curr_xfer = xfer; 921 922 /* 923 * Call the Host or Device controller transfer 924 * setup routine: 925 */ 926 (udev->bus->methods->xfer_setup) (&parm); 927 928 /* check for error */ 929 if (parm.err) 930 goto done; 931 932 if (buf) { 933 /* 934 * Increment the endpoint refcount. This 935 * basically prevents setting a new 936 * configuration and alternate setting 937 * when USB transfers are in use on 938 * the given interface. Search the USB 939 * code for "endpoint->refcount" if you 940 * want more information. 941 */ 942 xfer->endpoint->refcount++; 943 944 /* 945 * Whenever we set ppxfer[] then we 946 * also need to increment the 947 * "setup_refcount": 948 */ 949 info->setup_refcount++; 950 951 /* 952 * Transfer is successfully setup and 953 * can be used: 954 */ 955 ppxfer[n] = xfer; 956 } 957 } 958 959 if (buf || parm.err) { 960 goto done; 961 } 962 if (refcount == 0) { 963 /* no transfers - nothing to do ! */ 964 goto done; 965 } 966 /* align data properly */ 967 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 968 969 /* store offset temporarily */ 970 parm.size[1] = parm.size[0]; 971 972 /* 973 * The number of DMA tags required depends on 974 * the number of endpoints. The current estimate 975 * for maximum number of DMA tags per endpoint 976 * is two. 977 */ 978 parm.dma_tag_max += 2 * MIN(n_setup, USB_EP_MAX); 979 980 /* 981 * DMA tags for QH, TD, Data and more. 982 */ 983 parm.dma_tag_max += 8; 984 985 parm.dma_tag_p += parm.dma_tag_max; 986 987 parm.size[0] += ((uint8_t *)parm.dma_tag_p) - 988 ((uint8_t *)0); 989 990 /* align data properly */ 991 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 992 993 /* store offset temporarily */ 994 parm.size[3] = parm.size[0]; 995 996 parm.size[0] += ((uint8_t *)parm.dma_page_ptr) - 997 ((uint8_t *)0); 998 999 /* align data properly */ 1000 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1001 1002 /* store offset temporarily */ 1003 parm.size[4] = parm.size[0]; 1004 1005 parm.size[0] += ((uint8_t *)parm.dma_page_cache_ptr) - 1006 ((uint8_t *)0); 1007 1008 /* store end offset temporarily */ 1009 parm.size[5] = parm.size[0]; 1010 1011 parm.size[0] += ((uint8_t *)parm.xfer_page_cache_ptr) - 1012 ((uint8_t *)0); 1013 1014 /* store end offset temporarily */ 1015 1016 parm.size[2] = parm.size[0]; 1017 1018 /* align data properly */ 1019 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1020 1021 parm.size[6] = parm.size[0]; 1022 1023 parm.size[0] += ((uint8_t *)parm.xfer_length_ptr) - 1024 ((uint8_t *)0); 1025 1026 /* align data properly */ 1027 parm.size[0] += ((-parm.size[0]) & (USB_HOST_ALIGN - 1)); 1028 1029 /* allocate zeroed memory */ 1030 buf = malloc(parm.size[0], M_USB, M_WAITOK | M_ZERO); 1031 1032 if (buf == NULL) { 1033 parm.err = USB_ERR_NOMEM; 1034 DPRINTFN(0, "cannot allocate memory block for " 1035 "configuration (%d bytes)\n", 1036 parm.size[0]); 1037 goto done; 1038 } 1039 parm.dma_tag_p = USB_ADD_BYTES(buf, parm.size[1]); 1040 parm.dma_page_ptr = USB_ADD_BYTES(buf, parm.size[3]); 1041 parm.dma_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[4]); 1042 parm.xfer_page_cache_ptr = USB_ADD_BYTES(buf, parm.size[5]); 1043 parm.xfer_length_ptr = USB_ADD_BYTES(buf, parm.size[6]); 1044 } 1045 1046done: 1047 if (buf) { 1048 if (info->setup_refcount == 0) { 1049 /* 1050 * "usbd_transfer_unsetup_sub" will unlock 1051 * the bus mutex before returning ! 1052 */ 1053 USB_BUS_LOCK(info->bus); 1054 1055 /* something went wrong */ 1056 usbd_transfer_unsetup_sub(info, 0); 1057 } 1058 } 1059 if (parm.err) { 1060 usbd_transfer_unsetup(ppxfer, n_setup); 1061 } 1062 return (parm.err); 1063} 1064 1065/*------------------------------------------------------------------------* 1066 * usbd_transfer_unsetup_sub - factored out code 1067 *------------------------------------------------------------------------*/ 1068static void 1069usbd_transfer_unsetup_sub(struct usb_xfer_root *info, uint8_t needs_delay) 1070{ 1071 struct usb_page_cache *pc; 1072 1073 USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 1074 1075 /* wait for any outstanding DMA operations */ 1076 1077 if (needs_delay) { 1078 usb_timeout_t temp; 1079 temp = usbd_get_dma_delay(info->bus); 1080 usb_pause_mtx(&info->bus->bus_mtx, 1081 USB_MS_TO_TICKS(temp)); 1082 } 1083 1084 /* make sure that our done messages are not queued anywhere */ 1085 usb_proc_mwait(info->done_p, &info->done_m[0], &info->done_m[1]); 1086 1087 USB_BUS_UNLOCK(info->bus); 1088 1089#if USB_HAVE_BUSDMA 1090 /* free DMA'able memory, if any */ 1091 pc = info->dma_page_cache_start; 1092 while (pc != info->dma_page_cache_end) { 1093 usb_pc_free_mem(pc); 1094 pc++; 1095 } 1096 1097 /* free DMA maps in all "xfer->frbuffers" */ 1098 pc = info->xfer_page_cache_start; 1099 while (pc != info->xfer_page_cache_end) { 1100 usb_pc_dmamap_destroy(pc); 1101 pc++; 1102 } 1103 1104 /* free all DMA tags */ 1105 usb_dma_tag_unsetup(&info->dma_parent_tag); 1106#endif 1107 1108 cv_destroy(&info->cv_drain); 1109 1110 /* 1111 * free the "memory_base" last, hence the "info" structure is 1112 * contained within the "memory_base"! 1113 */ 1114 free(info->memory_base, M_USB); 1115} 1116 1117/*------------------------------------------------------------------------* 1118 * usbd_transfer_unsetup - unsetup/free an array of USB transfers 1119 * 1120 * NOTE: All USB transfers in progress will get called back passing 1121 * the error code "USB_ERR_CANCELLED" before this function 1122 * returns. 1123 *------------------------------------------------------------------------*/ 1124void 1125usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup) 1126{ 1127 struct usb_xfer *xfer; 1128 struct usb_xfer_root *info; 1129 uint8_t needs_delay = 0; 1130 1131 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1132 "usbd_transfer_unsetup can sleep!"); 1133 1134 while (n_setup--) { 1135 xfer = pxfer[n_setup]; 1136 1137 if (xfer == NULL) 1138 continue; 1139 1140 info = xfer->xroot; 1141 1142 USB_XFER_LOCK(xfer); 1143 USB_BUS_LOCK(info->bus); 1144 1145 /* 1146 * HINT: when you start/stop a transfer, it might be a 1147 * good idea to directly use the "pxfer[]" structure: 1148 * 1149 * usbd_transfer_start(sc->pxfer[0]); 1150 * usbd_transfer_stop(sc->pxfer[0]); 1151 * 1152 * That way, if your code has many parts that will not 1153 * stop running under the same lock, in other words 1154 * "xfer_mtx", the usbd_transfer_start and 1155 * usbd_transfer_stop functions will simply return 1156 * when they detect a NULL pointer argument. 1157 * 1158 * To avoid any races we clear the "pxfer[]" pointer 1159 * while holding the private mutex of the driver: 1160 */ 1161 pxfer[n_setup] = NULL; 1162 1163 USB_BUS_UNLOCK(info->bus); 1164 USB_XFER_UNLOCK(xfer); 1165 1166 usbd_transfer_drain(xfer); 1167 1168#if USB_HAVE_BUSDMA 1169 if (xfer->flags_int.bdma_enable) 1170 needs_delay = 1; 1171#endif 1172 /* 1173 * NOTE: default endpoint does not have an 1174 * interface, even if endpoint->iface_index == 0 1175 */ 1176 xfer->endpoint->refcount--; 1177 1178 usb_callout_drain(&xfer->timeout_handle); 1179 1180 USB_BUS_LOCK(info->bus); 1181 1182 USB_ASSERT(info->setup_refcount != 0, ("Invalid setup " 1183 "reference count!\n")); 1184 1185 info->setup_refcount--; 1186 1187 if (info->setup_refcount == 0) { 1188 usbd_transfer_unsetup_sub(info, 1189 needs_delay); 1190 } else { 1191 USB_BUS_UNLOCK(info->bus); 1192 } 1193 } 1194} 1195 1196/*------------------------------------------------------------------------* 1197 * usbd_control_transfer_init - factored out code 1198 * 1199 * In USB Device Mode we have to wait for the SETUP packet which 1200 * containst the "struct usb_device_request" structure, before we can 1201 * transfer any data. In USB Host Mode we already have the SETUP 1202 * packet at the moment the USB transfer is started. This leads us to 1203 * having to setup the USB transfer at two different places in 1204 * time. This function just contains factored out control transfer 1205 * initialisation code, so that we don't duplicate the code. 1206 *------------------------------------------------------------------------*/ 1207static void 1208usbd_control_transfer_init(struct usb_xfer *xfer) 1209{ 1210 struct usb_device_request req; 1211 1212 /* copy out the USB request header */ 1213 1214 usbd_copy_out(xfer->frbuffers, 0, &req, sizeof(req)); 1215 1216 /* setup remainder */ 1217 1218 xfer->flags_int.control_rem = UGETW(req.wLength); 1219 1220 /* copy direction to endpoint variable */ 1221 1222 xfer->endpointno &= ~(UE_DIR_IN | UE_DIR_OUT); 1223 xfer->endpointno |= 1224 (req.bmRequestType & UT_READ) ? UE_DIR_IN : UE_DIR_OUT; 1225} 1226 1227/*------------------------------------------------------------------------* 1228 * usbd_setup_ctrl_transfer 1229 * 1230 * This function handles initialisation of control transfers. Control 1231 * transfers are special in that regard that they can both transmit 1232 * and receive data. 1233 * 1234 * Return values: 1235 * 0: Success 1236 * Else: Failure 1237 *------------------------------------------------------------------------*/ 1238static int 1239usbd_setup_ctrl_transfer(struct usb_xfer *xfer) 1240{ 1241 usb_frlength_t len; 1242 1243 /* Check for control endpoint stall */ 1244 if (xfer->flags.stall_pipe && xfer->flags_int.control_act) { 1245 /* the control transfer is no longer active */ 1246 xfer->flags_int.control_stall = 1; 1247 xfer->flags_int.control_act = 0; 1248 } else { 1249 /* don't stall control transfer by default */ 1250 xfer->flags_int.control_stall = 0; 1251 } 1252 1253 /* Check for invalid number of frames */ 1254 if (xfer->nframes > 2) { 1255 /* 1256 * If you need to split a control transfer, you 1257 * have to do one part at a time. Only with 1258 * non-control transfers you can do multiple 1259 * parts a time. 1260 */ 1261 DPRINTFN(0, "Too many frames: %u\n", 1262 (unsigned int)xfer->nframes); 1263 goto error; 1264 } 1265 1266 /* 1267 * Check if there is a control 1268 * transfer in progress: 1269 */ 1270 if (xfer->flags_int.control_act) { 1271 1272 if (xfer->flags_int.control_hdr) { 1273 1274 /* clear send header flag */ 1275 1276 xfer->flags_int.control_hdr = 0; 1277 1278 /* setup control transfer */ 1279 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1280 usbd_control_transfer_init(xfer); 1281 } 1282 } 1283 /* get data length */ 1284 1285 len = xfer->sumlen; 1286 1287 } else { 1288 1289 /* the size of the SETUP structure is hardcoded ! */ 1290 1291 if (xfer->frlengths[0] != sizeof(struct usb_device_request)) { 1292 DPRINTFN(0, "Wrong framelength %u != %zu\n", 1293 xfer->frlengths[0], sizeof(struct 1294 usb_device_request)); 1295 goto error; 1296 } 1297 /* check USB mode */ 1298 if (xfer->flags_int.usb_mode == USB_MODE_DEVICE) { 1299 1300 /* check number of frames */ 1301 if (xfer->nframes != 1) { 1302 /* 1303 * We need to receive the setup 1304 * message first so that we know the 1305 * data direction! 1306 */ 1307 DPRINTF("Misconfigured transfer\n"); 1308 goto error; 1309 } 1310 /* 1311 * Set a dummy "control_rem" value. This 1312 * variable will be overwritten later by a 1313 * call to "usbd_control_transfer_init()" ! 1314 */ 1315 xfer->flags_int.control_rem = 0xFFFF; 1316 } else { 1317 1318 /* setup "endpoint" and "control_rem" */ 1319 1320 usbd_control_transfer_init(xfer); 1321 } 1322 1323 /* set transfer-header flag */ 1324 1325 xfer->flags_int.control_hdr = 1; 1326 1327 /* get data length */ 1328 1329 len = (xfer->sumlen - sizeof(struct usb_device_request)); 1330 } 1331 1332 /* check if there is a length mismatch */ 1333 1334 if (len > xfer->flags_int.control_rem) { 1335 DPRINTFN(0, "Length greater than remaining length!\n"); 1336 goto error; 1337 } 1338 /* check if we are doing a short transfer */ 1339 1340 if (xfer->flags.force_short_xfer) { 1341 xfer->flags_int.control_rem = 0; 1342 } else { 1343 if ((len != xfer->max_data_length) && 1344 (len != xfer->flags_int.control_rem) && 1345 (xfer->nframes != 1)) { 1346 DPRINTFN(0, "Short control transfer without " 1347 "force_short_xfer set!\n"); 1348 goto error; 1349 } 1350 xfer->flags_int.control_rem -= len; 1351 } 1352 1353 /* the status part is executed when "control_act" is 0 */ 1354 1355 if ((xfer->flags_int.control_rem > 0) || 1356 (xfer->flags.manual_status)) { 1357 /* don't execute the STATUS stage yet */ 1358 xfer->flags_int.control_act = 1; 1359 1360 /* sanity check */ 1361 if ((!xfer->flags_int.control_hdr) && 1362 (xfer->nframes == 1)) { 1363 /* 1364 * This is not a valid operation! 1365 */ 1366 DPRINTFN(0, "Invalid parameter " 1367 "combination\n"); 1368 goto error; 1369 } 1370 } else { 1371 /* time to execute the STATUS stage */ 1372 xfer->flags_int.control_act = 0; 1373 } 1374 return (0); /* success */ 1375 1376error: 1377 return (1); /* failure */ 1378} 1379 1380/*------------------------------------------------------------------------* 1381 * usbd_transfer_submit - start USB hardware for the given transfer 1382 * 1383 * This function should only be called from the USB callback. 1384 *------------------------------------------------------------------------*/ 1385void 1386usbd_transfer_submit(struct usb_xfer *xfer) 1387{ 1388 struct usb_xfer_root *info; 1389 struct usb_bus *bus; 1390 usb_frcount_t x; 1391 1392 info = xfer->xroot; 1393 bus = info->bus; 1394 1395 DPRINTF("xfer=%p, endpoint=%p, nframes=%d, dir=%s\n", 1396 xfer, xfer->endpoint, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ? 1397 "read" : "write"); 1398 1399#if USB_DEBUG 1400 if (USB_DEBUG_VAR > 0) { 1401 USB_BUS_LOCK(bus); 1402 1403 usb_dump_endpoint(xfer->endpoint); 1404 1405 USB_BUS_UNLOCK(bus); 1406 } 1407#endif 1408 1409 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1410 USB_BUS_LOCK_ASSERT(bus, MA_NOTOWNED); 1411 1412 /* Only open the USB transfer once! */ 1413 if (!xfer->flags_int.open) { 1414 xfer->flags_int.open = 1; 1415 1416 DPRINTF("open\n"); 1417 1418 USB_BUS_LOCK(bus); 1419 (xfer->endpoint->methods->open) (xfer); 1420 USB_BUS_UNLOCK(bus); 1421 } 1422 /* set "transferring" flag */ 1423 xfer->flags_int.transferring = 1; 1424 1425#if USB_HAVE_POWERD 1426 /* increment power reference */ 1427 usbd_transfer_power_ref(xfer, 1); 1428#endif 1429 /* 1430 * Check if the transfer is waiting on a queue, most 1431 * frequently the "done_q": 1432 */ 1433 if (xfer->wait_queue) { 1434 USB_BUS_LOCK(bus); 1435 usbd_transfer_dequeue(xfer); 1436 USB_BUS_UNLOCK(bus); 1437 } 1438 /* clear "did_dma_delay" flag */ 1439 xfer->flags_int.did_dma_delay = 0; 1440 1441 /* clear "did_close" flag */ 1442 xfer->flags_int.did_close = 0; 1443 1444#if USB_HAVE_BUSDMA 1445 /* clear "bdma_setup" flag */ 1446 xfer->flags_int.bdma_setup = 0; 1447#endif 1448 /* by default we cannot cancel any USB transfer immediately */ 1449 xfer->flags_int.can_cancel_immed = 0; 1450 1451 /* clear lengths and frame counts by default */ 1452 xfer->sumlen = 0; 1453 xfer->actlen = 0; 1454 xfer->aframes = 0; 1455 1456 /* clear any previous errors */ 1457 xfer->error = 0; 1458 1459 /* Check if the device is still alive */ 1460 if (info->udev->state < USB_STATE_POWERED) { 1461 USB_BUS_LOCK(bus); 1462 /* 1463 * Must return cancelled error code else 1464 * device drivers can hang. 1465 */ 1466 usbd_transfer_done(xfer, USB_ERR_CANCELLED); 1467 USB_BUS_UNLOCK(bus); 1468 return; 1469 } 1470 1471 /* sanity check */ 1472 if (xfer->nframes == 0) { 1473 if (xfer->flags.stall_pipe) { 1474 /* 1475 * Special case - want to stall without transferring 1476 * any data: 1477 */ 1478 DPRINTF("xfer=%p nframes=0: stall " 1479 "or clear stall!\n", xfer); 1480 USB_BUS_LOCK(bus); 1481 xfer->flags_int.can_cancel_immed = 1; 1482 /* start the transfer */ 1483 usb_command_wrapper(&xfer->endpoint->endpoint_q, xfer); 1484 USB_BUS_UNLOCK(bus); 1485 return; 1486 } 1487 USB_BUS_LOCK(bus); 1488 usbd_transfer_done(xfer, USB_ERR_INVAL); 1489 USB_BUS_UNLOCK(bus); 1490 return; 1491 } 1492 /* compute total transfer length */ 1493 1494 for (x = 0; x != xfer->nframes; x++) { 1495 xfer->sumlen += xfer->frlengths[x]; 1496 if (xfer->sumlen < xfer->frlengths[x]) { 1497 /* length wrapped around */ 1498 USB_BUS_LOCK(bus); 1499 usbd_transfer_done(xfer, USB_ERR_INVAL); 1500 USB_BUS_UNLOCK(bus); 1501 return; 1502 } 1503 } 1504 1505 /* clear some internal flags */ 1506 1507 xfer->flags_int.short_xfer_ok = 0; 1508 xfer->flags_int.short_frames_ok = 0; 1509 1510 /* check if this is a control transfer */ 1511 1512 if (xfer->flags_int.control_xfr) { 1513 1514 if (usbd_setup_ctrl_transfer(xfer)) { 1515 USB_BUS_LOCK(bus); 1516 usbd_transfer_done(xfer, USB_ERR_STALLED); 1517 USB_BUS_UNLOCK(bus); 1518 return; 1519 } 1520 } 1521 /* 1522 * Setup filtered version of some transfer flags, 1523 * in case of data read direction 1524 */ 1525 if (USB_GET_DATA_ISREAD(xfer)) { 1526 1527 if (xfer->flags.short_frames_ok) { 1528 xfer->flags_int.short_xfer_ok = 1; 1529 xfer->flags_int.short_frames_ok = 1; 1530 } else if (xfer->flags.short_xfer_ok) { 1531 xfer->flags_int.short_xfer_ok = 1; 1532 1533 /* check for control transfer */ 1534 if (xfer->flags_int.control_xfr) { 1535 /* 1536 * 1) Control transfers do not support 1537 * reception of multiple short USB 1538 * frames in host mode and device side 1539 * mode, with exception of: 1540 * 1541 * 2) Due to sometimes buggy device 1542 * side firmware we need to do a 1543 * STATUS stage in case of short 1544 * control transfers in USB host mode. 1545 * The STATUS stage then becomes the 1546 * "alt_next" to the DATA stage. 1547 */ 1548 xfer->flags_int.short_frames_ok = 1; 1549 } 1550 } 1551 } 1552 /* 1553 * Check if BUS-DMA support is enabled and try to load virtual 1554 * buffers into DMA, if any: 1555 */ 1556#if USB_HAVE_BUSDMA 1557 if (xfer->flags_int.bdma_enable) { 1558 /* insert the USB transfer last in the BUS-DMA queue */ 1559 usb_command_wrapper(&xfer->xroot->dma_q, xfer); 1560 return; 1561 } 1562#endif 1563 /* 1564 * Enter the USB transfer into the Host Controller or 1565 * Device Controller schedule: 1566 */ 1567 usbd_pipe_enter(xfer); 1568} 1569 1570/*------------------------------------------------------------------------* 1571 * usbd_pipe_enter - factored out code 1572 *------------------------------------------------------------------------*/ 1573void 1574usbd_pipe_enter(struct usb_xfer *xfer) 1575{ 1576 struct usb_endpoint *ep; 1577 1578 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1579 1580 USB_BUS_LOCK(xfer->xroot->bus); 1581 1582 ep = xfer->endpoint; 1583 1584 DPRINTF("enter\n"); 1585 1586 /* enter the transfer */ 1587 (ep->methods->enter) (xfer); 1588 1589 xfer->flags_int.can_cancel_immed = 1; 1590 1591 /* check for transfer error */ 1592 if (xfer->error) { 1593 /* some error has happened */ 1594 usbd_transfer_done(xfer, 0); 1595 USB_BUS_UNLOCK(xfer->xroot->bus); 1596 return; 1597 } 1598 1599 /* start the transfer */ 1600 usb_command_wrapper(&ep->endpoint_q, xfer); 1601 USB_BUS_UNLOCK(xfer->xroot->bus); 1602} 1603 1604/*------------------------------------------------------------------------* 1605 * usbd_transfer_start - start an USB transfer 1606 * 1607 * NOTE: Calling this function more than one time will only 1608 * result in a single transfer start, until the USB transfer 1609 * completes. 1610 *------------------------------------------------------------------------*/ 1611void 1612usbd_transfer_start(struct usb_xfer *xfer) 1613{ 1614 if (xfer == NULL) { 1615 /* transfer is gone */ 1616 return; 1617 } 1618 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1619 1620 /* mark the USB transfer started */ 1621 1622 if (!xfer->flags_int.started) { 1623 xfer->flags_int.started = 1; 1624 } 1625 /* check if the USB transfer callback is already transferring */ 1626 1627 if (xfer->flags_int.transferring) { 1628 return; 1629 } 1630 USB_BUS_LOCK(xfer->xroot->bus); 1631 /* call the USB transfer callback */ 1632 usbd_callback_ss_done_defer(xfer); 1633 USB_BUS_UNLOCK(xfer->xroot->bus); 1634} 1635 1636/*------------------------------------------------------------------------* 1637 * usbd_transfer_stop - stop an USB transfer 1638 * 1639 * NOTE: Calling this function more than one time will only 1640 * result in a single transfer stop. 1641 * NOTE: When this function returns it is not safe to free nor 1642 * reuse any DMA buffers. See "usbd_transfer_drain()". 1643 *------------------------------------------------------------------------*/ 1644void 1645usbd_transfer_stop(struct usb_xfer *xfer) 1646{ 1647 struct usb_endpoint *ep; 1648 1649 if (xfer == NULL) { 1650 /* transfer is gone */ 1651 return; 1652 } 1653 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1654 1655 /* check if the USB transfer was ever opened */ 1656 1657 if (!xfer->flags_int.open) { 1658 /* nothing to do except clearing the "started" flag */ 1659 xfer->flags_int.started = 0; 1660 return; 1661 } 1662 /* try to stop the current USB transfer */ 1663 1664 USB_BUS_LOCK(xfer->xroot->bus); 1665 xfer->error = USB_ERR_CANCELLED;/* override any previous error */ 1666 /* 1667 * Clear "open" and "started" when both private and USB lock 1668 * is locked so that we don't get a race updating "flags_int" 1669 */ 1670 xfer->flags_int.open = 0; 1671 xfer->flags_int.started = 0; 1672 1673 /* 1674 * Check if we can cancel the USB transfer immediately. 1675 */ 1676 if (xfer->flags_int.transferring) { 1677 if (xfer->flags_int.can_cancel_immed && 1678 (!xfer->flags_int.did_close)) { 1679 DPRINTF("close\n"); 1680 /* 1681 * The following will lead to an USB_ERR_CANCELLED 1682 * error code being passed to the USB callback. 1683 */ 1684 (xfer->endpoint->methods->close) (xfer); 1685 /* only close once */ 1686 xfer->flags_int.did_close = 1; 1687 } else { 1688 /* need to wait for the next done callback */ 1689 } 1690 } else { 1691 DPRINTF("close\n"); 1692 1693 /* close here and now */ 1694 (xfer->endpoint->methods->close) (xfer); 1695 1696 /* 1697 * Any additional DMA delay is done by 1698 * "usbd_transfer_unsetup()". 1699 */ 1700 1701 /* 1702 * Special case. Check if we need to restart a blocked 1703 * endpoint. 1704 */ 1705 ep = xfer->endpoint; 1706 1707 /* 1708 * If the current USB transfer is completing we need 1709 * to start the next one: 1710 */ 1711 if (ep->endpoint_q.curr == xfer) { 1712 usb_command_wrapper(&ep->endpoint_q, NULL); 1713 } 1714 } 1715 1716 USB_BUS_UNLOCK(xfer->xroot->bus); 1717} 1718 1719/*------------------------------------------------------------------------* 1720 * usbd_transfer_pending 1721 * 1722 * This function will check if an USB transfer is pending which is a 1723 * little bit complicated! 1724 * Return values: 1725 * 0: Not pending 1726 * 1: Pending: The USB transfer will receive a callback in the future. 1727 *------------------------------------------------------------------------*/ 1728uint8_t 1729usbd_transfer_pending(struct usb_xfer *xfer) 1730{ 1731 struct usb_xfer_root *info; 1732 struct usb_xfer_queue *pq; 1733 1734 if (xfer == NULL) { 1735 /* transfer is gone */ 1736 return (0); 1737 } 1738 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 1739 1740 if (xfer->flags_int.transferring) { 1741 /* trivial case */ 1742 return (1); 1743 } 1744 USB_BUS_LOCK(xfer->xroot->bus); 1745 if (xfer->wait_queue) { 1746 /* we are waiting on a queue somewhere */ 1747 USB_BUS_UNLOCK(xfer->xroot->bus); 1748 return (1); 1749 } 1750 info = xfer->xroot; 1751 pq = &info->done_q; 1752 1753 if (pq->curr == xfer) { 1754 /* we are currently scheduled for callback */ 1755 USB_BUS_UNLOCK(xfer->xroot->bus); 1756 return (1); 1757 } 1758 /* we are not pending */ 1759 USB_BUS_UNLOCK(xfer->xroot->bus); 1760 return (0); 1761} 1762 1763/*------------------------------------------------------------------------* 1764 * usbd_transfer_drain 1765 * 1766 * This function will stop the USB transfer and wait for any 1767 * additional BUS-DMA and HW-DMA operations to complete. Buffers that 1768 * are loaded into DMA can safely be freed or reused after that this 1769 * function has returned. 1770 *------------------------------------------------------------------------*/ 1771void 1772usbd_transfer_drain(struct usb_xfer *xfer) 1773{ 1774 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, 1775 "usbd_transfer_drain can sleep!"); 1776 1777 if (xfer == NULL) { 1778 /* transfer is gone */ 1779 return; 1780 } 1781 if (xfer->xroot->xfer_mtx != &Giant) { 1782 USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED); 1783 } 1784 USB_XFER_LOCK(xfer); 1785 1786 usbd_transfer_stop(xfer); 1787 1788 while (usbd_transfer_pending(xfer)) { 1789 xfer->flags_int.draining = 1; 1790 /* 1791 * Wait until the current outstanding USB 1792 * transfer is complete ! 1793 */ 1794 cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx); 1795 } 1796 USB_XFER_UNLOCK(xfer); 1797} 1798 1799struct usb_page_cache * 1800usbd_xfer_get_frame(struct usb_xfer *xfer, usb_frcount_t frindex) 1801{ 1802 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1803 1804 return (&xfer->frbuffers[frindex]); 1805} 1806 1807usb_frlength_t 1808usbd_xfer_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex) 1809{ 1810 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1811 1812 return (xfer->frlengths[frindex]); 1813} 1814 1815/*------------------------------------------------------------------------* 1816 * usbd_xfer_set_frame_data 1817 * 1818 * This function sets the pointer of the buffer that should 1819 * loaded directly into DMA for the given USB frame. Passing "ptr" 1820 * equal to NULL while the corresponding "frlength" is greater 1821 * than zero gives undefined results! 1822 *------------------------------------------------------------------------*/ 1823void 1824usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, 1825 void *ptr, usb_frlength_t len) 1826{ 1827 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1828 1829 /* set virtual address to load and length */ 1830 xfer->frbuffers[frindex].buffer = ptr; 1831 usbd_xfer_set_frame_len(xfer, frindex, len); 1832} 1833 1834void 1835usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, 1836 void **ptr, int *len) 1837{ 1838 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1839 1840 if (ptr != NULL) 1841 *ptr = xfer->frbuffers[frindex].buffer; 1842 if (len != NULL) 1843 *len = xfer->frlengths[frindex]; 1844} 1845 1846void 1847usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen, int *aframes, 1848 int *nframes) 1849{ 1850 if (actlen != NULL) 1851 *actlen = xfer->actlen; 1852 if (sumlen != NULL) 1853 *sumlen = xfer->sumlen; 1854 if (aframes != NULL) 1855 *aframes = xfer->aframes; 1856 if (nframes != NULL) 1857 *nframes = xfer->nframes; 1858} 1859 1860/*------------------------------------------------------------------------* 1861 * usbd_xfer_set_frame_offset 1862 * 1863 * This function sets the frame data buffer offset relative to the beginning 1864 * of the USB DMA buffer allocated for this USB transfer. 1865 *------------------------------------------------------------------------*/ 1866void 1867usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset, 1868 usb_frcount_t frindex) 1869{ 1870 KASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame " 1871 "when the USB buffer is external!\n")); 1872 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1873 1874 /* set virtual address to load */ 1875 xfer->frbuffers[frindex].buffer = 1876 USB_ADD_BYTES(xfer->local_buffer, offset); 1877} 1878 1879void 1880usbd_xfer_set_interval(struct usb_xfer *xfer, int i) 1881{ 1882 xfer->interval = i; 1883} 1884 1885void 1886usbd_xfer_set_timeout(struct usb_xfer *xfer, int t) 1887{ 1888 xfer->timeout = t; 1889} 1890 1891void 1892usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n) 1893{ 1894 xfer->nframes = n; 1895} 1896 1897usb_frcount_t 1898usbd_xfer_max_frames(struct usb_xfer *xfer) 1899{ 1900 return (xfer->max_frame_count); 1901} 1902 1903usb_frlength_t 1904usbd_xfer_max_len(struct usb_xfer *xfer) 1905{ 1906 return (xfer->max_data_length); 1907} 1908 1909usb_frlength_t 1910usbd_xfer_max_framelen(struct usb_xfer *xfer) 1911{ 1912 return (xfer->max_frame_size); 1913} 1914 1915void 1916usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex, 1917 usb_frlength_t len) 1918{ 1919 KASSERT(frindex < xfer->max_frame_count, ("frame index overflow")); 1920 1921 xfer->frlengths[frindex] = len; 1922} 1923 1924/*------------------------------------------------------------------------* 1925 * usb_callback_proc - factored out code 1926 * 1927 * This function performs USB callbacks. 1928 *------------------------------------------------------------------------*/ 1929static void 1930usb_callback_proc(struct usb_proc_msg *_pm) 1931{ 1932 struct usb_done_msg *pm = (void *)_pm; 1933 struct usb_xfer_root *info = pm->xroot; 1934 1935 /* Change locking order */ 1936 USB_BUS_UNLOCK(info->bus); 1937 1938 /* 1939 * We exploit the fact that the mutex is the same for all 1940 * callbacks that will be called from this thread: 1941 */ 1942 mtx_lock(info->xfer_mtx); 1943 USB_BUS_LOCK(info->bus); 1944 1945 /* Continue where we lost track */ 1946 usb_command_wrapper(&info->done_q, 1947 info->done_q.curr); 1948 1949 mtx_unlock(info->xfer_mtx); 1950} 1951 1952/*------------------------------------------------------------------------* 1953 * usbd_callback_ss_done_defer 1954 * 1955 * This function will defer the start, stop and done callback to the 1956 * correct thread. 1957 *------------------------------------------------------------------------*/ 1958static void 1959usbd_callback_ss_done_defer(struct usb_xfer *xfer) 1960{ 1961 struct usb_xfer_root *info = xfer->xroot; 1962 struct usb_xfer_queue *pq = &info->done_q; 1963 1964 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 1965 1966 if (pq->curr != xfer) { 1967 usbd_transfer_enqueue(pq, xfer); 1968 } 1969 if (!pq->recurse_1) { 1970 1971 /* 1972 * We have to postpone the callback due to the fact we 1973 * will have a Lock Order Reversal, LOR, if we try to 1974 * proceed ! 1975 */ 1976 if (usb_proc_msignal(info->done_p, 1977 &info->done_m[0], &info->done_m[1])) { 1978 /* ignore */ 1979 } 1980 } else { 1981 /* clear second recurse flag */ 1982 pq->recurse_2 = 0; 1983 } 1984 return; 1985 1986} 1987 1988/*------------------------------------------------------------------------* 1989 * usbd_callback_wrapper 1990 * 1991 * This is a wrapper for USB callbacks. This wrapper does some 1992 * auto-magic things like figuring out if we can call the callback 1993 * directly from the current context or if we need to wakeup the 1994 * interrupt process. 1995 *------------------------------------------------------------------------*/ 1996static void 1997usbd_callback_wrapper(struct usb_xfer_queue *pq) 1998{ 1999 struct usb_xfer *xfer = pq->curr; 2000 struct usb_xfer_root *info = xfer->xroot; 2001 2002 USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED); 2003 if (!mtx_owned(info->xfer_mtx)) { 2004 /* 2005 * Cases that end up here: 2006 * 2007 * 5) HW interrupt done callback or other source. 2008 */ 2009 DPRINTFN(3, "case 5\n"); 2010 2011 /* 2012 * We have to postpone the callback due to the fact we 2013 * will have a Lock Order Reversal, LOR, if we try to 2014 * proceed ! 2015 */ 2016 if (usb_proc_msignal(info->done_p, 2017 &info->done_m[0], &info->done_m[1])) { 2018 /* ignore */ 2019 } 2020 return; 2021 } 2022 /* 2023 * Cases that end up here: 2024 * 2025 * 1) We are starting a transfer 2026 * 2) We are prematurely calling back a transfer 2027 * 3) We are stopping a transfer 2028 * 4) We are doing an ordinary callback 2029 */ 2030 DPRINTFN(3, "case 1-4\n"); 2031 /* get next USB transfer in the queue */ 2032 info->done_q.curr = NULL; 2033 2034 USB_BUS_UNLOCK(info->bus); 2035 USB_BUS_LOCK_ASSERT(info->bus, MA_NOTOWNED); 2036 2037 /* set correct USB state for callback */ 2038 if (!xfer->flags_int.transferring) { 2039 xfer->usb_state = USB_ST_SETUP; 2040 if (!xfer->flags_int.started) { 2041 /* we got stopped before we even got started */ 2042 USB_BUS_LOCK(info->bus); 2043 goto done; 2044 } 2045 } else { 2046 2047 if (usbd_callback_wrapper_sub(xfer)) { 2048 /* the callback has been deferred */ 2049 USB_BUS_LOCK(info->bus); 2050 goto done; 2051 } 2052#if USB_HAVE_POWERD 2053 /* decrement power reference */ 2054 usbd_transfer_power_ref(xfer, -1); 2055#endif 2056 xfer->flags_int.transferring = 0; 2057 2058 if (xfer->error) { 2059 xfer->usb_state = USB_ST_ERROR; 2060 } else { 2061 /* set transferred state */ 2062 xfer->usb_state = USB_ST_TRANSFERRED; 2063#if USB_HAVE_BUSDMA 2064 /* sync DMA memory, if any */ 2065 if (xfer->flags_int.bdma_enable && 2066 (!xfer->flags_int.bdma_no_post_sync)) { 2067 usb_bdma_post_sync(xfer); 2068 } 2069#endif 2070 } 2071 } 2072 2073 /* call processing routine */ 2074 (xfer->callback) (xfer, xfer->error); 2075 2076 /* pickup the USB mutex again */ 2077 USB_BUS_LOCK(info->bus); 2078 2079 /* 2080 * Check if we got started after that we got cancelled, but 2081 * before we managed to do the callback. 2082 */ 2083 if ((!xfer->flags_int.open) && 2084 (xfer->flags_int.started) && 2085 (xfer->usb_state == USB_ST_ERROR)) { 2086 /* try to loop, but not recursivly */ 2087 usb_command_wrapper(&info->done_q, xfer); 2088 return; 2089 } 2090 2091done: 2092 /* 2093 * Check if we are draining. 2094 */ 2095 if (xfer->flags_int.draining && 2096 (!xfer->flags_int.transferring)) { 2097 /* "usbd_transfer_drain()" is waiting for end of transfer */ 2098 xfer->flags_int.draining = 0; 2099 cv_broadcast(&info->cv_drain); 2100 } 2101 2102 /* do the next callback, if any */ 2103 usb_command_wrapper(&info->done_q, 2104 info->done_q.curr); 2105} 2106 2107/*------------------------------------------------------------------------* 2108 * usb_dma_delay_done_cb 2109 * 2110 * This function is called when the DMA delay has been exectuded, and 2111 * will make sure that the callback is called to complete the USB 2112 * transfer. This code path is ususally only used when there is an USB 2113 * error like USB_ERR_CANCELLED. 2114 *------------------------------------------------------------------------*/ 2115static void 2116usb_dma_delay_done_cb(void *arg) 2117{ 2118 struct usb_xfer *xfer = arg; 2119 2120 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2121 2122 DPRINTFN(3, "Completed %p\n", xfer); 2123 2124 /* queue callback for execution, again */ 2125 usbd_transfer_done(xfer, 0); 2126} 2127 2128/*------------------------------------------------------------------------* 2129 * usbd_transfer_dequeue 2130 * 2131 * - This function is used to remove an USB transfer from a USB 2132 * transfer queue. 2133 * 2134 * - This function can be called multiple times in a row. 2135 *------------------------------------------------------------------------*/ 2136void 2137usbd_transfer_dequeue(struct usb_xfer *xfer) 2138{ 2139 struct usb_xfer_queue *pq; 2140 2141 pq = xfer->wait_queue; 2142 if (pq) { 2143 TAILQ_REMOVE(&pq->head, xfer, wait_entry); 2144 xfer->wait_queue = NULL; 2145 } 2146} 2147 2148/*------------------------------------------------------------------------* 2149 * usbd_transfer_enqueue 2150 * 2151 * - This function is used to insert an USB transfer into a USB * 2152 * transfer queue. 2153 * 2154 * - This function can be called multiple times in a row. 2155 *------------------------------------------------------------------------*/ 2156void 2157usbd_transfer_enqueue(struct usb_xfer_queue *pq, struct usb_xfer *xfer) 2158{ 2159 /* 2160 * Insert the USB transfer into the queue, if it is not 2161 * already on a USB transfer queue: 2162 */ 2163 if (xfer->wait_queue == NULL) { 2164 xfer->wait_queue = pq; 2165 TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry); 2166 } 2167} 2168 2169/*------------------------------------------------------------------------* 2170 * usbd_transfer_done 2171 * 2172 * - This function is used to remove an USB transfer from the busdma, 2173 * pipe or interrupt queue. 2174 * 2175 * - This function is used to queue the USB transfer on the done 2176 * queue. 2177 * 2178 * - This function is used to stop any USB transfer timeouts. 2179 *------------------------------------------------------------------------*/ 2180void 2181usbd_transfer_done(struct usb_xfer *xfer, usb_error_t error) 2182{ 2183 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2184 2185 DPRINTF("err=%s\n", usbd_errstr(error)); 2186 2187 /* 2188 * If we are not transferring then just return. 2189 * This can happen during transfer cancel. 2190 */ 2191 if (!xfer->flags_int.transferring) { 2192 DPRINTF("not transferring\n"); 2193 return; 2194 } 2195 /* only set transfer error if not already set */ 2196 if (!xfer->error) { 2197 xfer->error = error; 2198 } 2199 /* stop any callouts */ 2200 usb_callout_stop(&xfer->timeout_handle); 2201 2202 /* 2203 * If we are waiting on a queue, just remove the USB transfer 2204 * from the queue, if any. We should have the required locks 2205 * locked to do the remove when this function is called. 2206 */ 2207 usbd_transfer_dequeue(xfer); 2208 2209#if USB_HAVE_BUSDMA 2210 if (mtx_owned(xfer->xroot->xfer_mtx)) { 2211 struct usb_xfer_queue *pq; 2212 2213 /* 2214 * If the private USB lock is not locked, then we assume 2215 * that the BUS-DMA load stage has been passed: 2216 */ 2217 pq = &xfer->xroot->dma_q; 2218 2219 if (pq->curr == xfer) { 2220 /* start the next BUS-DMA load, if any */ 2221 usb_command_wrapper(pq, NULL); 2222 } 2223 } 2224#endif 2225 /* keep some statistics */ 2226 if (xfer->error) { 2227 xfer->xroot->bus->stats_err.uds_requests 2228 [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++; 2229 } else { 2230 xfer->xroot->bus->stats_ok.uds_requests 2231 [xfer->endpoint->edesc->bmAttributes & UE_XFERTYPE]++; 2232 } 2233 2234 /* call the USB transfer callback */ 2235 usbd_callback_ss_done_defer(xfer); 2236} 2237 2238/*------------------------------------------------------------------------* 2239 * usbd_transfer_start_cb 2240 * 2241 * This function is called to start the USB transfer when 2242 * "xfer->interval" is greater than zero, and and the endpoint type is 2243 * BULK or CONTROL. 2244 *------------------------------------------------------------------------*/ 2245static void 2246usbd_transfer_start_cb(void *arg) 2247{ 2248 struct usb_xfer *xfer = arg; 2249 struct usb_endpoint *ep = xfer->endpoint; 2250 2251 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2252 2253 DPRINTF("start\n"); 2254 2255 /* start the transfer */ 2256 (ep->methods->start) (xfer); 2257 2258 xfer->flags_int.can_cancel_immed = 1; 2259 2260 /* check for error */ 2261 if (xfer->error) { 2262 /* some error has happened */ 2263 usbd_transfer_done(xfer, 0); 2264 } 2265} 2266 2267/*------------------------------------------------------------------------* 2268 * usbd_xfer_set_stall 2269 * 2270 * This function is used to set the stall flag outside the 2271 * callback. This function is NULL safe. 2272 *------------------------------------------------------------------------*/ 2273void 2274usbd_xfer_set_stall(struct usb_xfer *xfer) 2275{ 2276 if (xfer == NULL) { 2277 /* tearing down */ 2278 return; 2279 } 2280 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2281 2282 /* avoid any races by locking the USB mutex */ 2283 USB_BUS_LOCK(xfer->xroot->bus); 2284 xfer->flags.stall_pipe = 1; 2285 USB_BUS_UNLOCK(xfer->xroot->bus); 2286} 2287 2288int 2289usbd_xfer_is_stalled(struct usb_xfer *xfer) 2290{ 2291 return (xfer->endpoint->is_stalled); 2292} 2293 2294/*------------------------------------------------------------------------* 2295 * usbd_transfer_clear_stall 2296 * 2297 * This function is used to clear the stall flag outside the 2298 * callback. This function is NULL safe. 2299 *------------------------------------------------------------------------*/ 2300void 2301usbd_transfer_clear_stall(struct usb_xfer *xfer) 2302{ 2303 if (xfer == NULL) { 2304 /* tearing down */ 2305 return; 2306 } 2307 USB_XFER_LOCK_ASSERT(xfer, MA_OWNED); 2308 2309 /* avoid any races by locking the USB mutex */ 2310 USB_BUS_LOCK(xfer->xroot->bus); 2311 2312 xfer->flags.stall_pipe = 0; 2313 2314 USB_BUS_UNLOCK(xfer->xroot->bus); 2315} 2316 2317/*------------------------------------------------------------------------* 2318 * usbd_pipe_start 2319 * 2320 * This function is used to add an USB transfer to the pipe transfer list. 2321 *------------------------------------------------------------------------*/ 2322void 2323usbd_pipe_start(struct usb_xfer_queue *pq) 2324{ 2325 struct usb_endpoint *ep; 2326 struct usb_xfer *xfer; 2327 uint8_t type; 2328 2329 xfer = pq->curr; 2330 ep = xfer->endpoint; 2331 2332 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2333 2334 /* 2335 * If the endpoint is already stalled we do nothing ! 2336 */ 2337 if (ep->is_stalled) { 2338 return; 2339 } 2340 /* 2341 * Check if we are supposed to stall the endpoint: 2342 */ 2343 if (xfer->flags.stall_pipe) { 2344 /* clear stall command */ 2345 xfer->flags.stall_pipe = 0; 2346 2347 /* 2348 * Only stall BULK and INTERRUPT endpoints. 2349 */ 2350 type = (ep->edesc->bmAttributes & UE_XFERTYPE); 2351 if ((type == UE_BULK) || 2352 (type == UE_INTERRUPT)) { 2353 struct usb_device *udev; 2354 struct usb_xfer_root *info; 2355 uint8_t did_stall; 2356 2357 info = xfer->xroot; 2358 udev = info->udev; 2359 did_stall = 1; 2360 2361 if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2362 (udev->bus->methods->set_stall) ( 2363 udev, NULL, ep, &did_stall); 2364 } else if (udev->default_xfer[1]) { 2365 info = udev->default_xfer[1]->xroot; 2366 usb_proc_msignal( 2367 &info->bus->non_giant_callback_proc, 2368 &udev->cs_msg[0], &udev->cs_msg[1]); 2369 } else { 2370 /* should not happen */ 2371 DPRINTFN(0, "No stall handler!\n"); 2372 } 2373 /* 2374 * Check if we should stall. Some USB hardware 2375 * handles set- and clear-stall in hardware. 2376 */ 2377 if (did_stall) { 2378 /* 2379 * The transfer will be continued when 2380 * the clear-stall control endpoint 2381 * message is received. 2382 */ 2383 ep->is_stalled = 1; 2384 return; 2385 } 2386 } 2387 } 2388 /* Set or clear stall complete - special case */ 2389 if (xfer->nframes == 0) { 2390 /* we are complete */ 2391 xfer->aframes = 0; 2392 usbd_transfer_done(xfer, 0); 2393 return; 2394 } 2395 /* 2396 * Handled cases: 2397 * 2398 * 1) Start the first transfer queued. 2399 * 2400 * 2) Re-start the current USB transfer. 2401 */ 2402 /* 2403 * Check if there should be any 2404 * pre transfer start delay: 2405 */ 2406 if (xfer->interval > 0) { 2407 type = (ep->edesc->bmAttributes & UE_XFERTYPE); 2408 if ((type == UE_BULK) || 2409 (type == UE_CONTROL)) { 2410 usbd_transfer_timeout_ms(xfer, 2411 &usbd_transfer_start_cb, 2412 xfer->interval); 2413 return; 2414 } 2415 } 2416 DPRINTF("start\n"); 2417 2418 /* start USB transfer */ 2419 (ep->methods->start) (xfer); 2420 2421 xfer->flags_int.can_cancel_immed = 1; 2422 2423 /* check for error */ 2424 if (xfer->error) { 2425 /* some error has happened */ 2426 usbd_transfer_done(xfer, 0); 2427 } 2428} 2429 2430/*------------------------------------------------------------------------* 2431 * usbd_transfer_timeout_ms 2432 * 2433 * This function is used to setup a timeout on the given USB 2434 * transfer. If the timeout has been deferred the callback given by 2435 * "cb" will get called after "ms" milliseconds. 2436 *------------------------------------------------------------------------*/ 2437void 2438usbd_transfer_timeout_ms(struct usb_xfer *xfer, 2439 void (*cb) (void *arg), usb_timeout_t ms) 2440{ 2441 USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED); 2442 2443 /* defer delay */ 2444 usb_callout_reset(&xfer->timeout_handle, 2445 USB_MS_TO_TICKS(ms), cb, xfer); 2446} 2447 2448/*------------------------------------------------------------------------* 2449 * usbd_callback_wrapper_sub 2450 * 2451 * - This function will update variables in an USB transfer after 2452 * that the USB transfer is complete. 2453 * 2454 * - This function is used to start the next USB transfer on the 2455 * ep transfer queue, if any. 2456 * 2457 * NOTE: In some special cases the USB transfer will not be removed from 2458 * the pipe queue, but remain first. To enforce USB transfer removal call 2459 * this function passing the error code "USB_ERR_CANCELLED". 2460 * 2461 * Return values: 2462 * 0: Success. 2463 * Else: The callback has been deferred. 2464 *------------------------------------------------------------------------*/ 2465static uint8_t 2466usbd_callback_wrapper_sub(struct usb_xfer *xfer) 2467{ 2468 struct usb_endpoint *ep; 2469 usb_frcount_t x; 2470 2471 if ((!xfer->flags_int.open) && 2472 (!xfer->flags_int.did_close)) { 2473 DPRINTF("close\n"); 2474 USB_BUS_LOCK(xfer->xroot->bus); 2475 (xfer->endpoint->methods->close) (xfer); 2476 USB_BUS_UNLOCK(xfer->xroot->bus); 2477 /* only close once */ 2478 xfer->flags_int.did_close = 1; 2479 return (1); /* wait for new callback */ 2480 } 2481 /* 2482 * If we have a non-hardware induced error we 2483 * need to do the DMA delay! 2484 */ 2485 if (((xfer->error == USB_ERR_CANCELLED) || 2486 (xfer->error == USB_ERR_TIMEOUT)) && 2487 (!xfer->flags_int.did_dma_delay)) { 2488 2489 usb_timeout_t temp; 2490 2491 /* only delay once */ 2492 xfer->flags_int.did_dma_delay = 1; 2493 2494 /* we can not cancel this delay */ 2495 xfer->flags_int.can_cancel_immed = 0; 2496 2497 temp = usbd_get_dma_delay(xfer->xroot->bus); 2498 2499 DPRINTFN(3, "DMA delay, %u ms, " 2500 "on %p\n", temp, xfer); 2501 2502 if (temp != 0) { 2503 USB_BUS_LOCK(xfer->xroot->bus); 2504 usbd_transfer_timeout_ms(xfer, 2505 &usb_dma_delay_done_cb, temp); 2506 USB_BUS_UNLOCK(xfer->xroot->bus); 2507 return (1); /* wait for new callback */ 2508 } 2509 } 2510 /* check actual number of frames */ 2511 if (xfer->aframes > xfer->nframes) { 2512 if (xfer->error == 0) { 2513 panic("%s: actual number of frames, %d, is " 2514 "greater than initial number of frames, %d!\n", 2515 __FUNCTION__, xfer->aframes, xfer->nframes); 2516 } else { 2517 /* just set some valid value */ 2518 xfer->aframes = xfer->nframes; 2519 } 2520 } 2521 /* compute actual length */ 2522 xfer->actlen = 0; 2523 2524 for (x = 0; x != xfer->aframes; x++) { 2525 xfer->actlen += xfer->frlengths[x]; 2526 } 2527 2528 /* 2529 * Frames that were not transferred get zero actual length in 2530 * case the USB device driver does not check the actual number 2531 * of frames transferred, "xfer->aframes": 2532 */ 2533 for (; x < xfer->nframes; x++) { 2534 usbd_xfer_set_frame_len(xfer, x, 0); 2535 } 2536 2537 /* check actual length */ 2538 if (xfer->actlen > xfer->sumlen) { 2539 if (xfer->error == 0) { 2540 panic("%s: actual length, %d, is greater than " 2541 "initial length, %d!\n", 2542 __FUNCTION__, xfer->actlen, xfer->sumlen); 2543 } else { 2544 /* just set some valid value */ 2545 xfer->actlen = xfer->sumlen; 2546 } 2547 } 2548 DPRINTFN(1, "xfer=%p endpoint=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n", 2549 xfer, xfer->endpoint, xfer->error, xfer->actlen, xfer->sumlen, 2550 xfer->aframes, xfer->nframes); 2551 2552 if (xfer->error) { 2553 /* end of control transfer, if any */ 2554 xfer->flags_int.control_act = 0; 2555 2556 /* check if we should block the execution queue */ 2557 if ((xfer->error != USB_ERR_CANCELLED) && 2558 (xfer->flags.pipe_bof)) { 2559 DPRINTFN(2, "xfer=%p: Block On Failure " 2560 "on endpoint=%p\n", xfer, xfer->endpoint); 2561 goto done; 2562 } 2563 } else { 2564 /* check for short transfers */ 2565 if (xfer->actlen < xfer->sumlen) { 2566 2567 /* end of control transfer, if any */ 2568 xfer->flags_int.control_act = 0; 2569 2570 if (!xfer->flags_int.short_xfer_ok) { 2571 xfer->error = USB_ERR_SHORT_XFER; 2572 if (xfer->flags.pipe_bof) { 2573 DPRINTFN(2, "xfer=%p: Block On Failure on " 2574 "Short Transfer on endpoint %p.\n", 2575 xfer, xfer->endpoint); 2576 goto done; 2577 } 2578 } 2579 } else { 2580 /* 2581 * Check if we are in the middle of a 2582 * control transfer: 2583 */ 2584 if (xfer->flags_int.control_act) { 2585 DPRINTFN(5, "xfer=%p: Control transfer " 2586 "active on endpoint=%p\n", xfer, xfer->endpoint); 2587 goto done; 2588 } 2589 } 2590 } 2591 2592 ep = xfer->endpoint; 2593 2594 /* 2595 * If the current USB transfer is completing we need to start the 2596 * next one: 2597 */ 2598 USB_BUS_LOCK(xfer->xroot->bus); 2599 if (ep->endpoint_q.curr == xfer) { 2600 usb_command_wrapper(&ep->endpoint_q, NULL); 2601 2602 if (ep->endpoint_q.curr || TAILQ_FIRST(&ep->endpoint_q.head)) { 2603 /* there is another USB transfer waiting */ 2604 } else { 2605 /* this is the last USB transfer */ 2606 /* clear isochronous sync flag */ 2607 xfer->endpoint->is_synced = 0; 2608 } 2609 } 2610 USB_BUS_UNLOCK(xfer->xroot->bus); 2611done: 2612 return (0); 2613} 2614 2615/*------------------------------------------------------------------------* 2616 * usb_command_wrapper 2617 * 2618 * This function is used to execute commands non-recursivly on an USB 2619 * transfer. 2620 *------------------------------------------------------------------------*/ 2621void 2622usb_command_wrapper(struct usb_xfer_queue *pq, struct usb_xfer *xfer) 2623{ 2624 if (xfer) { 2625 /* 2626 * If the transfer is not already processing, 2627 * queue it! 2628 */ 2629 if (pq->curr != xfer) { 2630 usbd_transfer_enqueue(pq, xfer); 2631 if (pq->curr != NULL) { 2632 /* something is already processing */ 2633 DPRINTFN(6, "busy %p\n", pq->curr); 2634 return; 2635 } 2636 } 2637 } else { 2638 /* Get next element in queue */ 2639 pq->curr = NULL; 2640 } 2641 2642 if (!pq->recurse_1) { 2643 2644 do { 2645 2646 /* set both recurse flags */ 2647 pq->recurse_1 = 1; 2648 pq->recurse_2 = 1; 2649 2650 if (pq->curr == NULL) { 2651 xfer = TAILQ_FIRST(&pq->head); 2652 if (xfer) { 2653 TAILQ_REMOVE(&pq->head, xfer, 2654 wait_entry); 2655 xfer->wait_queue = NULL; 2656 pq->curr = xfer; 2657 } else { 2658 break; 2659 } 2660 } 2661 DPRINTFN(6, "cb %p (enter)\n", pq->curr); 2662 (pq->command) (pq); 2663 DPRINTFN(6, "cb %p (leave)\n", pq->curr); 2664 2665 } while (!pq->recurse_2); 2666 2667 /* clear first recurse flag */ 2668 pq->recurse_1 = 0; 2669 2670 } else { 2671 /* clear second recurse flag */ 2672 pq->recurse_2 = 0; 2673 } 2674} 2675 2676/*------------------------------------------------------------------------* 2677 * usbd_default_transfer_setup 2678 * 2679 * This function is used to setup the default USB control endpoint 2680 * transfer. 2681 *------------------------------------------------------------------------*/ 2682void 2683usbd_default_transfer_setup(struct usb_device *udev) 2684{ 2685 struct usb_xfer *xfer; 2686 uint8_t no_resetup; 2687 uint8_t iface_index; 2688 2689 /* check for root HUB */ 2690 if (udev->parent_hub == NULL) 2691 return; 2692repeat: 2693 2694 xfer = udev->default_xfer[0]; 2695 if (xfer) { 2696 USB_XFER_LOCK(xfer); 2697 no_resetup = 2698 ((xfer->address == udev->address) && 2699 (udev->default_ep_desc.wMaxPacketSize[0] == 2700 udev->ddesc.bMaxPacketSize)); 2701 if (udev->flags.usb_mode == USB_MODE_DEVICE) { 2702 if (no_resetup) { 2703 /* 2704 * NOTE: checking "xfer->address" and 2705 * starting the USB transfer must be 2706 * atomic! 2707 */ 2708 usbd_transfer_start(xfer); 2709 } 2710 } 2711 USB_XFER_UNLOCK(xfer); 2712 } else { 2713 no_resetup = 0; 2714 } 2715 2716 if (no_resetup) { 2717 /* 2718 * All parameters are exactly the same like before. 2719 * Just return. 2720 */ 2721 return; 2722 } 2723 /* 2724 * Update wMaxPacketSize for the default control endpoint: 2725 */ 2726 udev->default_ep_desc.wMaxPacketSize[0] = 2727 udev->ddesc.bMaxPacketSize; 2728 2729 /* 2730 * Unsetup any existing USB transfer: 2731 */ 2732 usbd_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX); 2733 2734 /* 2735 * Try to setup a new USB transfer for the 2736 * default control endpoint: 2737 */ 2738 iface_index = 0; 2739 if (usbd_transfer_setup(udev, &iface_index, 2740 udev->default_xfer, usb_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL, 2741 udev->default_mtx)) { 2742 DPRINTFN(0, "could not setup default " 2743 "USB transfer!\n"); 2744 } else { 2745 goto repeat; 2746 } 2747} 2748 2749/*------------------------------------------------------------------------* 2750 * usbd_clear_data_toggle - factored out code 2751 * 2752 * NOTE: the intention of this function is not to reset the hardware 2753 * data toggle. 2754 *------------------------------------------------------------------------*/ 2755void 2756usbd_clear_data_toggle(struct usb_device *udev, struct usb_endpoint *ep) 2757{ 2758 DPRINTFN(5, "udev=%p endpoint=%p\n", udev, ep); 2759 2760 USB_BUS_LOCK(udev->bus); 2761 ep->toggle_next = 0; 2762 USB_BUS_UNLOCK(udev->bus); 2763} 2764 2765/*------------------------------------------------------------------------* 2766 * usbd_clear_stall_callback - factored out clear stall callback 2767 * 2768 * Input parameters: 2769 * xfer1: Clear Stall Control Transfer 2770 * xfer2: Stalled USB Transfer 2771 * 2772 * This function is NULL safe. 2773 * 2774 * Return values: 2775 * 0: In progress 2776 * Else: Finished 2777 * 2778 * Clear stall config example: 2779 * 2780 * static const struct usb_config my_clearstall = { 2781 * .type = UE_CONTROL, 2782 * .endpoint = 0, 2783 * .direction = UE_DIR_ANY, 2784 * .interval = 50, //50 milliseconds 2785 * .bufsize = sizeof(struct usb_device_request), 2786 * .timeout = 1000, //1.000 seconds 2787 * .callback = &my_clear_stall_callback, // ** 2788 * .usb_mode = USB_MODE_HOST, 2789 * }; 2790 * 2791 * ** "my_clear_stall_callback" calls "usbd_clear_stall_callback" 2792 * passing the correct parameters. 2793 *------------------------------------------------------------------------*/ 2794uint8_t 2795usbd_clear_stall_callback(struct usb_xfer *xfer1, 2796 struct usb_xfer *xfer2) 2797{ 2798 struct usb_device_request req; 2799 2800 if (xfer2 == NULL) { 2801 /* looks like we are tearing down */ 2802 DPRINTF("NULL input parameter\n"); 2803 return (0); 2804 } 2805 USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED); 2806 USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED); 2807 2808 switch (USB_GET_STATE(xfer1)) { 2809 case USB_ST_SETUP: 2810 2811 /* 2812 * pre-clear the data toggle to DATA0 ("umass.c" and 2813 * "ata-usb.c" depends on this) 2814 */ 2815 2816 usbd_clear_data_toggle(xfer2->xroot->udev, xfer2->endpoint); 2817 2818 /* setup a clear-stall packet */ 2819 2820 req.bmRequestType = UT_WRITE_ENDPOINT; 2821 req.bRequest = UR_CLEAR_FEATURE; 2822 USETW(req.wValue, UF_ENDPOINT_HALT); 2823 req.wIndex[0] = xfer2->endpoint->edesc->bEndpointAddress; 2824 req.wIndex[1] = 0; 2825 USETW(req.wLength, 0); 2826 2827 /* 2828 * "usbd_transfer_setup_sub()" will ensure that 2829 * we have sufficient room in the buffer for 2830 * the request structure! 2831 */ 2832 2833 /* copy in the transfer */ 2834 2835 usbd_copy_in(xfer1->frbuffers, 0, &req, sizeof(req)); 2836 2837 /* set length */ 2838 xfer1->frlengths[0] = sizeof(req); 2839 xfer1->nframes = 1; 2840 2841 usbd_transfer_submit(xfer1); 2842 return (0); 2843 2844 case USB_ST_TRANSFERRED: 2845 break; 2846 2847 default: /* Error */ 2848 if (xfer1->error == USB_ERR_CANCELLED) { 2849 return (0); 2850 } 2851 break; 2852 } 2853 return (1); /* Clear Stall Finished */ 2854} 2855 2856/*------------------------------------------------------------------------* 2857 * usbd_transfer_poll 2858 * 2859 * The following function gets called from the USB keyboard driver and 2860 * UMASS when the system has paniced. 2861 * 2862 * NOTE: It is currently not possible to resume normal operation on 2863 * the USB controller which has been polled, due to clearing of the 2864 * "up_dsleep" and "up_msleep" flags. 2865 *------------------------------------------------------------------------*/ 2866void 2867usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max) 2868{ 2869 struct usb_xfer *xfer; 2870 struct usb_xfer_root *xroot; 2871 struct usb_device *udev; 2872 struct usb_proc_msg *pm; 2873 uint16_t n; 2874 uint16_t drop_bus; 2875 uint16_t drop_xfer; 2876 2877 for (n = 0; n != max; n++) { 2878 /* Extra checks to avoid panic */ 2879 xfer = ppxfer[n]; 2880 if (xfer == NULL) 2881 continue; /* no USB transfer */ 2882 xroot = xfer->xroot; 2883 if (xroot == NULL) 2884 continue; /* no USB root */ 2885 udev = xroot->udev; 2886 if (udev == NULL) 2887 continue; /* no USB device */ 2888 if (udev->bus == NULL) 2889 continue; /* no BUS structure */ 2890 if (udev->bus->methods == NULL) 2891 continue; /* no BUS methods */ 2892 if (udev->bus->methods->xfer_poll == NULL) 2893 continue; /* no poll method */ 2894 2895 /* make sure that the BUS mutex is not locked */ 2896 drop_bus = 0; 2897 while (mtx_owned(&xroot->udev->bus->bus_mtx)) { 2898 mtx_unlock(&xroot->udev->bus->bus_mtx); 2899 drop_bus++; 2900 } 2901 2902 /* make sure that the transfer mutex is not locked */ 2903 drop_xfer = 0; 2904 while (mtx_owned(xroot->xfer_mtx)) { 2905 mtx_unlock(xroot->xfer_mtx); 2906 drop_xfer++; 2907 } 2908 2909 /* Make sure cv_signal() and cv_broadcast() is not called */ 2910 udev->bus->control_xfer_proc.up_dsleep = 0; 2911 udev->bus->control_xfer_proc.up_msleep = 0; 2912 udev->bus->explore_proc.up_dsleep = 0; 2913 udev->bus->explore_proc.up_msleep = 0; 2914 udev->bus->giant_callback_proc.up_dsleep = 0; 2915 udev->bus->giant_callback_proc.up_msleep = 0; 2916 udev->bus->non_giant_callback_proc.up_dsleep = 0; 2917 udev->bus->non_giant_callback_proc.up_msleep = 0; 2918 2919 /* poll USB hardware */ 2920 (udev->bus->methods->xfer_poll) (udev->bus); 2921 2922 USB_BUS_LOCK(xroot->bus); 2923 2924 /* check for clear stall */ 2925 if (udev->default_xfer[1] != NULL) { 2926 2927 /* poll clear stall start */ 2928 pm = &udev->cs_msg[0].hdr; 2929 (pm->pm_callback) (pm); 2930 /* poll clear stall done thread */ 2931 pm = &udev->default_xfer[1]-> 2932 xroot->done_m[0].hdr; 2933 (pm->pm_callback) (pm); 2934 } 2935 2936 /* poll done thread */ 2937 pm = &xroot->done_m[0].hdr; 2938 (pm->pm_callback) (pm); 2939 2940 USB_BUS_UNLOCK(xroot->bus); 2941 2942 /* restore transfer mutex */ 2943 while (drop_xfer--) 2944 mtx_lock(xroot->xfer_mtx); 2945 2946 /* restore BUS mutex */ 2947 while (drop_bus--) 2948 mtx_lock(&xroot->udev->bus->bus_mtx); 2949 } 2950} 2951 2952static void 2953usbd_get_std_packet_size(struct usb_std_packet_size *ptr, 2954 uint8_t type, enum usb_dev_speed speed) 2955{ 2956 static const uint16_t intr_range_max[USB_SPEED_MAX] = { 2957 [USB_SPEED_LOW] = 8, 2958 [USB_SPEED_FULL] = 64, 2959 [USB_SPEED_HIGH] = 1024, 2960 [USB_SPEED_VARIABLE] = 1024, 2961 [USB_SPEED_SUPER] = 1024, 2962 }; 2963 2964 static const uint16_t isoc_range_max[USB_SPEED_MAX] = { 2965 [USB_SPEED_LOW] = 0, /* invalid */ 2966 [USB_SPEED_FULL] = 1023, 2967 [USB_SPEED_HIGH] = 1024, 2968 [USB_SPEED_VARIABLE] = 3584, 2969 [USB_SPEED_SUPER] = 1024, 2970 }; 2971 2972 static const uint16_t control_min[USB_SPEED_MAX] = { 2973 [USB_SPEED_LOW] = 8, 2974 [USB_SPEED_FULL] = 8, 2975 [USB_SPEED_HIGH] = 64, 2976 [USB_SPEED_VARIABLE] = 512, 2977 [USB_SPEED_SUPER] = 512, 2978 }; 2979 2980 static const uint16_t bulk_min[USB_SPEED_MAX] = { 2981 [USB_SPEED_LOW] = 0, /* not supported */ 2982 [USB_SPEED_FULL] = 8, 2983 [USB_SPEED_HIGH] = 512, 2984 [USB_SPEED_VARIABLE] = 512, 2985 [USB_SPEED_SUPER] = 1024, 2986 }; 2987 2988 uint16_t temp; 2989 2990 memset(ptr, 0, sizeof(*ptr)); 2991 2992 switch (type) { 2993 case UE_INTERRUPT: 2994 ptr->range.max = intr_range_max[speed]; 2995 break; 2996 case UE_ISOCHRONOUS: 2997 ptr->range.max = isoc_range_max[speed]; 2998 break; 2999 default: 3000 if (type == UE_BULK) 3001 temp = bulk_min[speed]; 3002 else /* UE_CONTROL */ 3003 temp = control_min[speed]; 3004 3005 /* default is fixed */ 3006 ptr->fixed[0] = temp; 3007 ptr->fixed[1] = temp; 3008 ptr->fixed[2] = temp; 3009 ptr->fixed[3] = temp; 3010 3011 if (speed == USB_SPEED_FULL) { 3012 /* multiple sizes */ 3013 ptr->fixed[1] = 16; 3014 ptr->fixed[2] = 32; 3015 ptr->fixed[3] = 64; 3016 } 3017 if ((speed == USB_SPEED_VARIABLE) && 3018 (type == UE_BULK)) { 3019 /* multiple sizes */ 3020 ptr->fixed[2] = 1024; 3021 ptr->fixed[3] = 1536; 3022 } 3023 break; 3024 } 3025} 3026 3027void * 3028usbd_xfer_softc(struct usb_xfer *xfer) 3029{ 3030 return (xfer->priv_sc); 3031} 3032 3033void * 3034usbd_xfer_get_priv(struct usb_xfer *xfer) 3035{ 3036 return (xfer->priv_fifo); 3037} 3038 3039void 3040usbd_xfer_set_priv(struct usb_xfer *xfer, void *ptr) 3041{ 3042 xfer->priv_fifo = ptr; 3043} 3044 3045uint8_t 3046usbd_xfer_state(struct usb_xfer *xfer) 3047{ 3048 return (xfer->usb_state); 3049} 3050 3051void 3052usbd_xfer_set_flag(struct usb_xfer *xfer, int flag) 3053{ 3054 switch (flag) { 3055 case USB_FORCE_SHORT_XFER: 3056 xfer->flags.force_short_xfer = 1; 3057 break; 3058 case USB_SHORT_XFER_OK: 3059 xfer->flags.short_xfer_ok = 1; 3060 break; 3061 case USB_MULTI_SHORT_OK: 3062 xfer->flags.short_frames_ok = 1; 3063 break; 3064 case USB_MANUAL_STATUS: 3065 xfer->flags.manual_status = 1; 3066 break; 3067 } 3068} 3069 3070void 3071usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag) 3072{ 3073 switch (flag) { 3074 case USB_FORCE_SHORT_XFER: 3075 xfer->flags.force_short_xfer = 0; 3076 break; 3077 case USB_SHORT_XFER_OK: 3078 xfer->flags.short_xfer_ok = 0; 3079 break; 3080 case USB_MULTI_SHORT_OK: 3081 xfer->flags.short_frames_ok = 0; 3082 break; 3083 case USB_MANUAL_STATUS: 3084 xfer->flags.manual_status = 0; 3085 break; 3086 } 3087} 3088 3089/* 3090 * The following function returns in milliseconds when the isochronous 3091 * transfer was completed by the hardware. The returned value wraps 3092 * around 65536 milliseconds. 3093 */ 3094uint16_t 3095usbd_xfer_get_timestamp(struct usb_xfer *xfer) 3096{ 3097 return (xfer->isoc_time_complete); 3098} 3099