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