sys/dev/usb/usb_transfer.c

   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 usb2_callback_t usb2_request_callback;
  54
  55 static const struct usb2_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_MAX,       /* 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 usb2_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 usb2_xfer *);
  86 static void     usb2_transfer_unsetup_sub(struct usb2_xfer_root *, uint8_t);
  87 static void     usb2_control_transfer_init(struct usb2_xfer *);
  88 static uint8_t  usb2_start_hardware_sub(struct usb2_xfer *);
  89 static void     usb2_callback_proc(struct usb2_proc_msg *);
  90 static void     usb2_callback_ss_done_defer(struct usb2_xfer *);
  91 static void     usb2_callback_wrapper(struct usb2_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 usb2_xfer *);
  95 static void     usb2_get_std_packet_size(struct usb2_std_packet_size *ptr,
  96                     uint8_t type, uint8_t usb_speed);
  97
  98 /*------------------------------------------------------------------------*
  99  *      usb2_request_callback
 100  *------------------------------------------------------------------------*/
 101 static void
 102 usb2_request_callback(struct usb2_xfer *xfer)
 103 {
 104         if (xfer->flags_int.usb2_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 usb2_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 usb2_timeout_t
 141 usb2_get_dma_delay(struct usb2_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 usb2_setup_params *parm,
 171     struct usb2_page_cache **ppc, usb2_size_t size, usb2_size_t align,
 172     usb2_size_t count)
 173 {
 174         struct usb2_page_cache *pc;
 175         struct usb2_page *pg;
 176         void *buf;
 177         usb2_size_t n_dma_pc;
 178         usb2_size_t n_obj;
 179         usb2_size_t x;
 180         usb2_size_t y;
 181         usb2_size_t r;
 182         usb2_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 "usb2_xfer"
 288  * structure.
 289  *------------------------------------------------------------------------*/
 290 void
 291 usb2_transfer_setup_sub(struct usb2_setup_params *parm)
 292 {
 293         enum {
 294                 REQ_SIZE = 8,
 295                 MIN_PKT = 8,
 296         };
 297         struct usb2_xfer *xfer = parm->curr_xfer;
 298         const struct usb2_config *setup = parm->curr_setup;
 299         struct usb2_endpoint_descriptor *edesc;
 300         struct usb2_std_packet_size std_size;
 301         usb2_frcount_t n_frlengths;
 302         usb2_frcount_t n_frbuffers;
 303         usb2_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.usb2_mode = parm->udev->flags.usb2_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                  * "usb2_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 usb2_error_t
 717 usb2_transfer_setup(struct usb2_device *udev,
 718     const uint8_t *ifaces, struct usb2_xfer **ppxfer,
 719     const struct usb2_config *setup_start, uint16_t n_setup,
 720     void *priv_sc, struct mtx *xfer_mtx)
 721 {
 722         struct usb2_xfer dummy;
 723         struct usb2_setup_params parm;
 724         const struct usb2_config *setup_end = setup_start + n_setup;
 725         const struct usb2_config *setup;
 726         struct usb2_pipe *pipe;
 727         struct usb2_xfer_root *info;
 728         struct usb2_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 == (usb2_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 "usb2_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_MAX) &&
 862                                     (setup->usb_mode != udev->flags.usb2_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                                  * "usb2_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 "usb2_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 usb2_xfer_root *info, uint8_t needs_delay)
1054 {
1055         struct usb2_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                 usb2_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 usb2_xfer **pxfer, uint16_t n_setup)
1110 {
1111         struct usb2_xfer *xfer;
1112         struct usb2_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 usb2_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 usb2_xfer *xfer)
1193 {
1194         struct usb2_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 usb2_xfer *xfer)
1224 {
1225         usb2_frlength_t len;
1226
1227         /* Check for control endpoint stall */
1228         if (xfer->flags.stall_pipe) {
1229                 /* no longer active */
1230                 xfer->flags_int.control_act = 0;
1231         }
1232
1233         /* Check for invalid number of frames */
1234         if (xfer->nframes > 2) {
1235                 /*
1236                  * If you need to split a control transfer, you
1237                  * have to do one part at a time. Only with
1238                  * non-control transfers you can do multiple
1239                  * parts a time.
1240                  */
1241                 DPRINTFN(0, "Too many frames: %u\n",
1242                     (unsigned int)xfer->nframes);
1243                 goto error;
1244         }
1245
1246         /*
1247          * Check if there is a control
1248          * transfer in progress:
1249          */
1250         if (xfer->flags_int.control_act) {
1251
1252                 if (xfer->flags_int.control_hdr) {
1253
1254                         /* clear send header flag */
1255
1256                         xfer->flags_int.control_hdr = 0;
1257
1258                         /* setup control transfer */
1259                         if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) {
1260                                 usb2_control_transfer_init(xfer);
1261                         }
1262                 }
1263                 /* get data length */
1264
1265                 len = xfer->sumlen;
1266
1267         } else {
1268
1269                 /* the size of the SETUP structure is hardcoded ! */
1270
1271                 if (xfer->frlengths[0] != sizeof(struct usb2_device_request)) {
1272                         DPRINTFN(0, "Wrong framelength %u != %zu\n",
1273                             xfer->frlengths[0], sizeof(struct
1274                             usb2_device_request));
1275                         goto error;
1276                 }
1277                 /* check USB mode */
1278                 if (xfer->flags_int.usb2_mode == USB_MODE_DEVICE) {
1279
1280                         /* check number of frames */
1281                         if (xfer->nframes != 1) {
1282                                 /*
1283                                  * We need to receive the setup
1284                                  * message first so that we know the
1285                                  * data direction!
1286                                  */
1287                                 DPRINTF("Misconfigured transfer\n");
1288                                 goto error;
1289                         }
1290                         /*
1291                          * Set a dummy "control_rem" value.  This
1292                          * variable will be overwritten later by a
1293                          * call to "usb2_control_transfer_init()" !
1294                          */
1295                         xfer->flags_int.control_rem = 0xFFFF;
1296                 } else {
1297
1298                         /* setup "endpoint" and "control_rem" */
1299
1300                         usb2_control_transfer_init(xfer);
1301                 }
1302
1303                 /* set transfer-header flag */
1304
1305                 xfer->flags_int.control_hdr = 1;
1306
1307                 /* get data length */
1308
1309                 len = (xfer->sumlen - sizeof(struct usb2_device_request));
1310         }
1311
1312         /* check if there is a length mismatch */
1313
1314         if (len > xfer->flags_int.control_rem) {
1315                 DPRINTFN(0, "Length greater than remaining length!\n");
1316                 goto error;
1317         }
1318         /* check if we are doing a short transfer */
1319
1320         if (xfer->flags.force_short_xfer) {
1321                 xfer->flags_int.control_rem = 0;
1322         } else {
1323                 if ((len != xfer->max_data_length) &&
1324                     (len != xfer->flags_int.control_rem) &&
1325                     (xfer->nframes != 1)) {
1326                         DPRINTFN(0, "Short control transfer without "
1327                             "force_short_xfer set!\n");
1328                         goto error;
1329                 }
1330                 xfer->flags_int.control_rem -= len;
1331         }
1332
1333         /* the status part is executed when "control_act" is 0 */
1334
1335         if ((xfer->flags_int.control_rem > 0) ||
1336             (xfer->flags.manual_status)) {
1337                 /* don't execute the STATUS stage yet */
1338                 xfer->flags_int.control_act = 1;
1339
1340                 /* sanity check */
1341                 if ((!xfer->flags_int.control_hdr) &&
1342                     (xfer->nframes == 1)) {
1343                         /*
1344                          * This is not a valid operation!
1345                          */
1346                         DPRINTFN(0, "Invalid parameter "
1347                             "combination\n");
1348                         goto error;
1349                 }
1350         } else {
1351                 /* time to execute the STATUS stage */
1352                 xfer->flags_int.control_act = 0;
1353         }
1354         return (0);                     /* success */
1355
1356 error:
1357         return (1);                     /* failure */
1358 }
1359
1360 /*------------------------------------------------------------------------*
1361  *      usb2_start_hardware - start USB hardware for the given transfer
1362  *
1363  * This function should only be called from the USB callback.
1364  *------------------------------------------------------------------------*/
1365 void
1366 usb2_start_hardware(struct usb2_xfer *xfer)
1367 {
1368         struct usb2_xfer_root *info;
1369         struct usb2_bus *bus;
1370         usb2_frcount_t x;
1371
1372         info = xfer->xroot;
1373         bus = info->bus;
1374
1375         DPRINTF("xfer=%p, pipe=%p, nframes=%d, dir=%s\n",
1376             xfer, xfer->pipe, xfer->nframes, USB_GET_DATA_ISREAD(xfer) ?
1377             "read" : "write");
1378
1379 #if USB_DEBUG
1380         if (USB_DEBUG_VAR > 0) {
1381                 USB_BUS_LOCK(bus);
1382
1383                 usb2_dump_pipe(xfer->pipe);
1384
1385                 USB_BUS_UNLOCK(bus);
1386         }
1387 #endif
1388
1389         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1390         USB_BUS_LOCK_ASSERT(bus, MA_NOTOWNED);
1391
1392         /* Only open the USB transfer once! */
1393         if (!xfer->flags_int.open) {
1394                 xfer->flags_int.open = 1;
1395
1396                 DPRINTF("open\n");
1397
1398                 USB_BUS_LOCK(bus);
1399                 (xfer->pipe->methods->open) (xfer);
1400                 USB_BUS_UNLOCK(bus);
1401         }
1402         /* set "transferring" flag */
1403         xfer->flags_int.transferring = 1;
1404
1405 #if USB_HAVE_POWERD
1406         /* increment power reference */
1407         usb2_transfer_power_ref(xfer, 1);
1408 #endif
1409         /*
1410          * Check if the transfer is waiting on a queue, most
1411          * frequently the "done_q":
1412          */
1413         if (xfer->wait_queue) {
1414                 USB_BUS_LOCK(bus);
1415                 usb2_transfer_dequeue(xfer);
1416                 USB_BUS_UNLOCK(bus);
1417         }
1418         /* clear "did_dma_delay" flag */
1419         xfer->flags_int.did_dma_delay = 0;
1420
1421         /* clear "did_close" flag */
1422         xfer->flags_int.did_close = 0;
1423
1424 #if USB_HAVE_BUSDMA
1425         /* clear "bdma_setup" flag */
1426         xfer->flags_int.bdma_setup = 0;
1427 #endif
1428         /* by default we cannot cancel any USB transfer immediately */
1429         xfer->flags_int.can_cancel_immed = 0;
1430
1431         /* clear lengths and frame counts by default */
1432         xfer->sumlen = 0;
1433         xfer->actlen = 0;
1434         xfer->aframes = 0;
1435
1436         /* clear any previous errors */
1437         xfer->error = 0;
1438
1439         /* Check if the device is still alive */
1440         if (info->udev->state < USB_STATE_POWERED) {
1441                 USB_BUS_LOCK(bus);
1442                 /*
1443                  * Must return cancelled error code else
1444                  * device drivers can hang.
1445                  */
1446                 usb2_transfer_done(xfer, USB_ERR_CANCELLED);
1447                 USB_BUS_UNLOCK(bus);
1448                 return;
1449         }
1450
1451         /* sanity check */
1452         if (xfer->nframes == 0) {
1453                 if (xfer->flags.stall_pipe) {
1454                         /*
1455                          * Special case - want to stall without transferring
1456                          * any data:
1457                          */
1458                         DPRINTF("xfer=%p nframes=0: stall "
1459                             "or clear stall!\n", xfer);
1460                         USB_BUS_LOCK(bus);
1461                         xfer->flags_int.can_cancel_immed = 1;
1462                         /* start the transfer */
1463                         usb2_command_wrapper(&xfer->pipe->pipe_q, xfer);
1464                         USB_BUS_UNLOCK(bus);
1465                         return;
1466                 }
1467                 USB_BUS_LOCK(bus);
1468                 usb2_transfer_done(xfer, USB_ERR_INVAL);
1469                 USB_BUS_UNLOCK(bus);
1470                 return;
1471         }
1472         /* compute total transfer length */
1473
1474         for (x = 0; x != xfer->nframes; x++) {
1475                 xfer->sumlen += xfer->frlengths[x];
1476                 if (xfer->sumlen < xfer->frlengths[x]) {
1477                         /* length wrapped around */
1478                         USB_BUS_LOCK(bus);
1479                         usb2_transfer_done(xfer, USB_ERR_INVAL);
1480                         USB_BUS_UNLOCK(bus);
1481                         return;
1482                 }
1483         }
1484
1485         /* clear some internal flags */
1486
1487         xfer->flags_int.short_xfer_ok = 0;
1488         xfer->flags_int.short_frames_ok = 0;
1489
1490         /* check if this is a control transfer */
1491
1492         if (xfer->flags_int.control_xfr) {
1493
1494                 if (usb2_start_hardware_sub(xfer)) {
1495                         USB_BUS_LOCK(bus);
1496                         usb2_transfer_done(xfer, USB_ERR_STALLED);
1497                         USB_BUS_UNLOCK(bus);
1498                         return;
1499                 }
1500         }
1501         /*
1502          * Setup filtered version of some transfer flags,
1503          * in case of data read direction
1504          */
1505         if (USB_GET_DATA_ISREAD(xfer)) {
1506
1507                 if (xfer->flags.short_frames_ok) {
1508                         xfer->flags_int.short_xfer_ok = 1;
1509                         xfer->flags_int.short_frames_ok = 1;
1510                 } else if (xfer->flags.short_xfer_ok) {
1511                         xfer->flags_int.short_xfer_ok = 1;
1512
1513                         /* check for control transfer */
1514                         if (xfer->flags_int.control_xfr) {
1515                                 /*
1516                                  * 1) Control transfers do not support
1517                                  * reception of multiple short USB
1518                                  * frames in host mode and device side
1519                                  * mode, with exception of:
1520                                  *
1521                                  * 2) Due to sometimes buggy device
1522                                  * side firmware we need to do a
1523                                  * STATUS stage in case of short
1524                                  * control transfers in USB host mode.
1525                                  * The STATUS stage then becomes the
1526                                  * "alt_next" to the DATA stage.
1527                                  */
1528                                 xfer->flags_int.short_frames_ok = 1;
1529                         }
1530                 }
1531         }
1532         /*
1533          * Check if BUS-DMA support is enabled and try to load virtual
1534          * buffers into DMA, if any:
1535          */
1536 #if USB_HAVE_BUSDMA
1537         if (xfer->flags_int.bdma_enable) {
1538                 /* insert the USB transfer last in the BUS-DMA queue */
1539                 usb2_command_wrapper(&xfer->xroot->dma_q, xfer);
1540                 return;
1541         }
1542 #endif
1543         /*
1544          * Enter the USB transfer into the Host Controller or
1545          * Device Controller schedule:
1546          */
1547         usb2_pipe_enter(xfer);
1548 }
1549
1550 /*------------------------------------------------------------------------*
1551  *      usb2_pipe_enter - factored out code
1552  *------------------------------------------------------------------------*/
1553 void
1554 usb2_pipe_enter(struct usb2_xfer *xfer)
1555 {
1556         struct usb2_pipe *pipe;
1557
1558         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1559
1560         USB_BUS_LOCK(xfer->xroot->bus);
1561
1562         pipe = xfer->pipe;
1563
1564         DPRINTF("enter\n");
1565
1566         /* enter the transfer */
1567         (pipe->methods->enter) (xfer);
1568
1569         xfer->flags_int.can_cancel_immed = 1;
1570
1571         /* check for transfer error */
1572         if (xfer->error) {
1573                 /* some error has happened */
1574                 usb2_transfer_done(xfer, 0);
1575                 USB_BUS_UNLOCK(xfer->xroot->bus);
1576                 return;
1577         }
1578
1579         /* start the transfer */
1580         usb2_command_wrapper(&pipe->pipe_q, xfer);
1581         USB_BUS_UNLOCK(xfer->xroot->bus);
1582 }
1583
1584 /*------------------------------------------------------------------------*
1585  *      usb2_transfer_start - start an USB transfer
1586  *
1587  * NOTE: Calling this function more than one time will only
1588  *       result in a single transfer start, until the USB transfer
1589  *       completes.
1590  *------------------------------------------------------------------------*/
1591 void
1592 usb2_transfer_start(struct usb2_xfer *xfer)
1593 {
1594         if (xfer == NULL) {
1595                 /* transfer is gone */
1596                 return;
1597         }
1598         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1599
1600         /* mark the USB transfer started */
1601
1602         if (!xfer->flags_int.started) {
1603                 xfer->flags_int.started = 1;
1604         }
1605         /* check if the USB transfer callback is already transferring */
1606
1607         if (xfer->flags_int.transferring) {
1608                 return;
1609         }
1610         USB_BUS_LOCK(xfer->xroot->bus);
1611         /* call the USB transfer callback */
1612         usb2_callback_ss_done_defer(xfer);
1613         USB_BUS_UNLOCK(xfer->xroot->bus);
1614 }
1615
1616 /*------------------------------------------------------------------------*
1617  *      usb2_transfer_stop - stop an USB transfer
1618  *
1619  * NOTE: Calling this function more than one time will only
1620  *       result in a single transfer stop.
1621  * NOTE: When this function returns it is not safe to free nor
1622  *       reuse any DMA buffers. See "usb2_transfer_drain()".
1623  *------------------------------------------------------------------------*/
1624 void
1625 usb2_transfer_stop(struct usb2_xfer *xfer)
1626 {
1627         struct usb2_pipe *pipe;
1628
1629         if (xfer == NULL) {
1630                 /* transfer is gone */
1631                 return;
1632         }
1633         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1634
1635         /* check if the USB transfer was ever opened */
1636
1637         if (!xfer->flags_int.open) {
1638                 /* nothing to do except clearing the "started" flag */
1639                 xfer->flags_int.started = 0;
1640                 return;
1641         }
1642         /* try to stop the current USB transfer */
1643
1644         USB_BUS_LOCK(xfer->xroot->bus);
1645         xfer->error = USB_ERR_CANCELLED;/* override any previous error */
1646         /*
1647          * Clear "open" and "started" when both private and USB lock
1648          * is locked so that we don't get a race updating "flags_int"
1649          */
1650         xfer->flags_int.open = 0;
1651         xfer->flags_int.started = 0;
1652
1653         /*
1654          * Check if we can cancel the USB transfer immediately.
1655          */
1656         if (xfer->flags_int.transferring) {
1657                 if (xfer->flags_int.can_cancel_immed &&
1658                     (!xfer->flags_int.did_close)) {
1659                         DPRINTF("close\n");
1660                         /*
1661                          * The following will lead to an USB_ERR_CANCELLED
1662                          * error code being passed to the USB callback.
1663                          */
1664                         (xfer->pipe->methods->close) (xfer);
1665                         /* only close once */
1666                         xfer->flags_int.did_close = 1;
1667                 } else {
1668                         /* need to wait for the next done callback */
1669                 }
1670         } else {
1671                 DPRINTF("close\n");
1672
1673                 /* close here and now */
1674                 (xfer->pipe->methods->close) (xfer);
1675
1676                 /*
1677                  * Any additional DMA delay is done by
1678                  * "usb2_transfer_unsetup()".
1679                  */
1680
1681                 /*
1682                  * Special case. Check if we need to restart a blocked
1683                  * pipe.
1684                  */
1685                 pipe = xfer->pipe;
1686
1687                 /*
1688                  * If the current USB transfer is completing we need
1689                  * to start the next one:
1690                  */
1691                 if (pipe->pipe_q.curr == xfer) {
1692                         usb2_command_wrapper(&pipe->pipe_q, NULL);
1693                 }
1694         }
1695
1696         USB_BUS_UNLOCK(xfer->xroot->bus);
1697 }
1698
1699 /*------------------------------------------------------------------------*
1700  *      usb2_transfer_pending
1701  *
1702  * This function will check if an USB transfer is pending which is a
1703  * little bit complicated!
1704  * Return values:
1705  * 0: Not pending
1706  * 1: Pending: The USB transfer will receive a callback in the future.
1707  *------------------------------------------------------------------------*/
1708 uint8_t
1709 usb2_transfer_pending(struct usb2_xfer *xfer)
1710 {
1711         struct usb2_xfer_root *info;
1712         struct usb2_xfer_queue *pq;
1713
1714         if (xfer == NULL) {
1715                 /* transfer is gone */
1716                 return (0);
1717         }
1718         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
1719
1720         if (xfer->flags_int.transferring) {
1721                 /* trivial case */
1722                 return (1);
1723         }
1724         USB_BUS_LOCK(xfer->xroot->bus);
1725         if (xfer->wait_queue) {
1726                 /* we are waiting on a queue somewhere */
1727                 USB_BUS_UNLOCK(xfer->xroot->bus);
1728                 return (1);
1729         }
1730         info = xfer->xroot;
1731         pq = &info->done_q;
1732
1733         if (pq->curr == xfer) {
1734                 /* we are currently scheduled for callback */
1735                 USB_BUS_UNLOCK(xfer->xroot->bus);
1736                 return (1);
1737         }
1738         /* we are not pending */
1739         USB_BUS_UNLOCK(xfer->xroot->bus);
1740         return (0);
1741 }
1742
1743 /*------------------------------------------------------------------------*
1744  *      usb2_transfer_drain
1745  *
1746  * This function will stop the USB transfer and wait for any
1747  * additional BUS-DMA and HW-DMA operations to complete. Buffers that
1748  * are loaded into DMA can safely be freed or reused after that this
1749  * function has returned.
1750  *------------------------------------------------------------------------*/
1751 void
1752 usb2_transfer_drain(struct usb2_xfer *xfer)
1753 {
1754         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL,
1755             "usb2_transfer_drain can sleep!");
1756
1757         if (xfer == NULL) {
1758                 /* transfer is gone */
1759                 return;
1760         }
1761         if (xfer->xroot->xfer_mtx != &Giant) {
1762                 USB_XFER_LOCK_ASSERT(xfer, MA_NOTOWNED);
1763         }
1764         USB_XFER_LOCK(xfer);
1765
1766         usb2_transfer_stop(xfer);
1767
1768         while (usb2_transfer_pending(xfer)) {
1769                 xfer->flags_int.draining = 1;
1770                 /*
1771                  * Wait until the current outstanding USB
1772                  * transfer is complete !
1773                  */
1774                 usb2_cv_wait(&xfer->xroot->cv_drain, xfer->xroot->xfer_mtx);
1775         }
1776         USB_XFER_UNLOCK(xfer);
1777 }
1778
1779 /*------------------------------------------------------------------------*
1780  *      usb2_set_frame_data
1781  *
1782  * This function sets the pointer of the buffer that should
1783  * loaded directly into DMA for the given USB frame. Passing "ptr"
1784  * equal to NULL while the corresponding "frlength" is greater
1785  * than zero gives undefined results!
1786  *------------------------------------------------------------------------*/
1787 void
1788 usb2_set_frame_data(struct usb2_xfer *xfer, void *ptr, usb2_frcount_t frindex)
1789 {
1790         /* set virtual address to load and length */
1791         xfer->frbuffers[frindex].buffer = ptr;
1792 }
1793
1794 /*------------------------------------------------------------------------*
1795  *      usb2_set_frame_offset
1796  *
1797  * This function sets the frame data buffer offset relative to the beginning
1798  * of the USB DMA buffer allocated for this USB transfer.
1799  *------------------------------------------------------------------------*/
1800 void
1801 usb2_set_frame_offset(struct usb2_xfer *xfer, usb2_frlength_t offset,
1802     usb2_frcount_t frindex)
1803 {
1804         USB_ASSERT(!xfer->flags.ext_buffer, ("Cannot offset data frame "
1805             "when the USB buffer is external!\n"));
1806
1807         /* set virtual address to load */
1808         xfer->frbuffers[frindex].buffer =
1809             USB_ADD_BYTES(xfer->local_buffer, offset);
1810 }
1811
1812 /*------------------------------------------------------------------------*
1813  *      usb2_callback_proc - factored out code
1814  *
1815  * This function performs USB callbacks.
1816  *------------------------------------------------------------------------*/
1817 static void
1818 usb2_callback_proc(struct usb2_proc_msg *_pm)
1819 {
1820         struct usb2_done_msg *pm = (void *)_pm;
1821         struct usb2_xfer_root *info = pm->xroot;
1822
1823         /* Change locking order */
1824         USB_BUS_UNLOCK(info->bus);
1825
1826         /*
1827          * We exploit the fact that the mutex is the same for all
1828          * callbacks that will be called from this thread:
1829          */
1830         mtx_lock(info->xfer_mtx);
1831         USB_BUS_LOCK(info->bus);
1832
1833         /* Continue where we lost track */
1834         usb2_command_wrapper(&info->done_q,
1835             info->done_q.curr);
1836
1837         mtx_unlock(info->xfer_mtx);
1838 }
1839
1840 /*------------------------------------------------------------------------*
1841  *      usb2_callback_ss_done_defer
1842  *
1843  * This function will defer the start, stop and done callback to the
1844  * correct thread.
1845  *------------------------------------------------------------------------*/
1846 static void
1847 usb2_callback_ss_done_defer(struct usb2_xfer *xfer)
1848 {
1849         struct usb2_xfer_root *info = xfer->xroot;
1850         struct usb2_xfer_queue *pq = &info->done_q;
1851
1852         USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
1853
1854         if (pq->curr != xfer) {
1855                 usb2_transfer_enqueue(pq, xfer);
1856         }
1857         if (!pq->recurse_1) {
1858
1859                 /*
1860                  * We have to postpone the callback due to the fact we
1861                  * will have a Lock Order Reversal, LOR, if we try to
1862                  * proceed !
1863                  */
1864                 if (usb2_proc_msignal(info->done_p,
1865                     &info->done_m[0], &info->done_m[1])) {
1866                         /* ignore */
1867                 }
1868         } else {
1869                 /* clear second recurse flag */
1870                 pq->recurse_2 = 0;
1871         }
1872         return;
1873
1874 }
1875
1876 /*------------------------------------------------------------------------*
1877  *      usb2_callback_wrapper
1878  *
1879  * This is a wrapper for USB callbacks. This wrapper does some
1880  * auto-magic things like figuring out if we can call the callback
1881  * directly from the current context or if we need to wakeup the
1882  * interrupt process.
1883  *------------------------------------------------------------------------*/
1884 static void
1885 usb2_callback_wrapper(struct usb2_xfer_queue *pq)
1886 {
1887         struct usb2_xfer *xfer = pq->curr;
1888         struct usb2_xfer_root *info = xfer->xroot;
1889
1890         USB_BUS_LOCK_ASSERT(info->bus, MA_OWNED);
1891         if (!mtx_owned(info->xfer_mtx)) {
1892                 /*
1893                  * Cases that end up here:
1894                  *
1895                  * 5) HW interrupt done callback or other source.
1896                  */
1897                 DPRINTFN(3, "case 5\n");
1898
1899                 /*
1900                  * We have to postpone the callback due to the fact we
1901                  * will have a Lock Order Reversal, LOR, if we try to
1902                  * proceed !
1903                  */
1904                 if (usb2_proc_msignal(info->done_p,
1905                     &info->done_m[0], &info->done_m[1])) {
1906                         /* ignore */
1907                 }
1908                 return;
1909         }
1910         /*
1911          * Cases that end up here:
1912          *
1913          * 1) We are starting a transfer
1914          * 2) We are prematurely calling back a transfer
1915          * 3) We are stopping a transfer
1916          * 4) We are doing an ordinary callback
1917          */
1918         DPRINTFN(3, "case 1-4\n");
1919         /* get next USB transfer in the queue */
1920         info->done_q.curr = NULL;
1921
1922         USB_BUS_UNLOCK(info->bus);
1923         USB_BUS_LOCK_ASSERT(info->bus, MA_NOTOWNED);
1924
1925         /* set correct USB state for callback */
1926         if (!xfer->flags_int.transferring) {
1927                 xfer->usb2_state = USB_ST_SETUP;
1928                 if (!xfer->flags_int.started) {
1929                         /* we got stopped before we even got started */
1930                         USB_BUS_LOCK(info->bus);
1931                         goto done;
1932                 }
1933         } else {
1934
1935                 if (usb2_callback_wrapper_sub(xfer)) {
1936                         /* the callback has been deferred */
1937                         USB_BUS_LOCK(info->bus);
1938                         goto done;
1939                 }
1940 #if USB_HAVE_POWERD
1941                 /* decrement power reference */
1942                 usb2_transfer_power_ref(xfer, -1);
1943 #endif
1944                 xfer->flags_int.transferring = 0;
1945
1946                 if (xfer->error) {
1947                         xfer->usb2_state = USB_ST_ERROR;
1948                 } else {
1949                         /* set transferred state */
1950                         xfer->usb2_state = USB_ST_TRANSFERRED;
1951 #if USB_HAVE_BUSDMA
1952                         /* sync DMA memory, if any */
1953                         if (xfer->flags_int.bdma_enable &&
1954                             (!xfer->flags_int.bdma_no_post_sync)) {
1955                                 usb2_bdma_post_sync(xfer);
1956                         }
1957 #endif
1958                 }
1959         }
1960
1961         /* call processing routine */
1962         (xfer->callback) (xfer);
1963
1964         /* pickup the USB mutex again */
1965         USB_BUS_LOCK(info->bus);
1966
1967         /*
1968          * Check if we got started after that we got cancelled, but
1969          * before we managed to do the callback.
1970          */
1971         if ((!xfer->flags_int.open) &&
1972             (xfer->flags_int.started) &&
1973             (xfer->usb2_state == USB_ST_ERROR)) {
1974                 /* try to loop, but not recursivly */
1975                 usb2_command_wrapper(&info->done_q, xfer);
1976                 return;
1977         }
1978
1979 done:
1980         /*
1981          * Check if we are draining.
1982          */
1983         if (xfer->flags_int.draining &&
1984             (!xfer->flags_int.transferring)) {
1985                 /* "usb2_transfer_drain()" is waiting for end of transfer */
1986                 xfer->flags_int.draining = 0;
1987                 usb2_cv_broadcast(&info->cv_drain);
1988         }
1989
1990         /* do the next callback, if any */
1991         usb2_command_wrapper(&info->done_q,
1992             info->done_q.curr);
1993 }
1994
1995 /*------------------------------------------------------------------------*
1996  *      usb2_dma_delay_done_cb
1997  *
1998  * This function is called when the DMA delay has been exectuded, and
1999  * will make sure that the callback is called to complete the USB
2000  * transfer. This code path is ususally only used when there is an USB
2001  * error like USB_ERR_CANCELLED.
2002  *------------------------------------------------------------------------*/
2003 static void
2004 usb2_dma_delay_done_cb(void *arg)
2005 {
2006         struct usb2_xfer *xfer = arg;
2007
2008         USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2009
2010         DPRINTFN(3, "Completed %p\n", xfer);
2011
2012         /* queue callback for execution, again */
2013         usb2_transfer_done(xfer, 0);
2014 }
2015
2016 /*------------------------------------------------------------------------*
2017  *      usb2_transfer_dequeue
2018  *
2019  *  - This function is used to remove an USB transfer from a USB
2020  *  transfer queue.
2021  *
2022  *  - This function can be called multiple times in a row.
2023  *------------------------------------------------------------------------*/
2024 void
2025 usb2_transfer_dequeue(struct usb2_xfer *xfer)
2026 {
2027         struct usb2_xfer_queue *pq;
2028
2029         pq = xfer->wait_queue;
2030         if (pq) {
2031                 TAILQ_REMOVE(&pq->head, xfer, wait_entry);
2032                 xfer->wait_queue = NULL;
2033         }
2034 }
2035
2036 /*------------------------------------------------------------------------*
2037  *      usb2_transfer_enqueue
2038  *
2039  *  - This function is used to insert an USB transfer into a USB *
2040  *  transfer queue.
2041  *
2042  *  - This function can be called multiple times in a row.
2043  *------------------------------------------------------------------------*/
2044 void
2045 usb2_transfer_enqueue(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer)
2046 {
2047         /*
2048          * Insert the USB transfer into the queue, if it is not
2049          * already on a USB transfer queue:
2050          */
2051         if (xfer->wait_queue == NULL) {
2052                 xfer->wait_queue = pq;
2053                 TAILQ_INSERT_TAIL(&pq->head, xfer, wait_entry);
2054         }
2055 }
2056
2057 /*------------------------------------------------------------------------*
2058  *      usb2_transfer_done
2059  *
2060  *  - This function is used to remove an USB transfer from the busdma,
2061  *  pipe or interrupt queue.
2062  *
2063  *  - This function is used to queue the USB transfer on the done
2064  *  queue.
2065  *
2066  *  - This function is used to stop any USB transfer timeouts.
2067  *------------------------------------------------------------------------*/
2068 void
2069 usb2_transfer_done(struct usb2_xfer *xfer, usb2_error_t error)
2070 {
2071         USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2072
2073         DPRINTF("err=%s\n", usb2_errstr(error));
2074
2075         /*
2076          * If we are not transferring then just return.
2077          * This can happen during transfer cancel.
2078          */
2079         if (!xfer->flags_int.transferring) {
2080                 DPRINTF("not transferring\n");
2081                 return;
2082         }
2083         /* only set transfer error if not already set */
2084         if (!xfer->error) {
2085                 xfer->error = error;
2086         }
2087         /* stop any callouts */
2088         usb2_callout_stop(&xfer->timeout_handle);
2089
2090         /*
2091          * If we are waiting on a queue, just remove the USB transfer
2092          * from the queue, if any. We should have the required locks
2093          * locked to do the remove when this function is called.
2094          */
2095         usb2_transfer_dequeue(xfer);
2096
2097 #if USB_HAVE_BUSDMA
2098         if (mtx_owned(xfer->xroot->xfer_mtx)) {
2099                 struct usb2_xfer_queue *pq;
2100
2101                 /*
2102                  * If the private USB lock is not locked, then we assume
2103                  * that the BUS-DMA load stage has been passed:
2104                  */
2105                 pq = &xfer->xroot->dma_q;
2106
2107                 if (pq->curr == xfer) {
2108                         /* start the next BUS-DMA load, if any */
2109                         usb2_command_wrapper(pq, NULL);
2110                 }
2111         }
2112 #endif
2113         /* keep some statistics */
2114         if (xfer->error) {
2115                 xfer->xroot->bus->stats_err.uds_requests
2116                     [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++;
2117         } else {
2118                 xfer->xroot->bus->stats_ok.uds_requests
2119                     [xfer->pipe->edesc->bmAttributes & UE_XFERTYPE]++;
2120         }
2121
2122         /* call the USB transfer callback */
2123         usb2_callback_ss_done_defer(xfer);
2124 }
2125
2126 /*------------------------------------------------------------------------*
2127  *      usb2_transfer_start_cb
2128  *
2129  * This function is called to start the USB transfer when
2130  * "xfer->interval" is greater than zero, and and the endpoint type is
2131  * BULK or CONTROL.
2132  *------------------------------------------------------------------------*/
2133 static void
2134 usb2_transfer_start_cb(void *arg)
2135 {
2136         struct usb2_xfer *xfer = arg;
2137         struct usb2_pipe *pipe = xfer->pipe;
2138
2139         USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2140
2141         DPRINTF("start\n");
2142
2143         /* start the transfer */
2144         (pipe->methods->start) (xfer);
2145
2146         xfer->flags_int.can_cancel_immed = 1;
2147
2148         /* check for error */
2149         if (xfer->error) {
2150                 /* some error has happened */
2151                 usb2_transfer_done(xfer, 0);
2152         }
2153 }
2154
2155 /*------------------------------------------------------------------------*
2156  *      usb2_transfer_set_stall
2157  *
2158  * This function is used to set the stall flag outside the
2159  * callback. This function is NULL safe.
2160  *------------------------------------------------------------------------*/
2161 void
2162 usb2_transfer_set_stall(struct usb2_xfer *xfer)
2163 {
2164         if (xfer == NULL) {
2165                 /* tearing down */
2166                 return;
2167         }
2168         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
2169
2170         /* avoid any races by locking the USB mutex */
2171         USB_BUS_LOCK(xfer->xroot->bus);
2172
2173         xfer->flags.stall_pipe = 1;
2174
2175         USB_BUS_UNLOCK(xfer->xroot->bus);
2176 }
2177
2178 /*------------------------------------------------------------------------*
2179  *      usb2_transfer_clear_stall
2180  *
2181  * This function is used to clear the stall flag outside the
2182  * callback. This function is NULL safe.
2183  *------------------------------------------------------------------------*/
2184 void
2185 usb2_transfer_clear_stall(struct usb2_xfer *xfer)
2186 {
2187         if (xfer == NULL) {
2188                 /* tearing down */
2189                 return;
2190         }
2191         USB_XFER_LOCK_ASSERT(xfer, MA_OWNED);
2192
2193         /* avoid any races by locking the USB mutex */
2194         USB_BUS_LOCK(xfer->xroot->bus);
2195
2196         xfer->flags.stall_pipe = 0;
2197
2198         USB_BUS_UNLOCK(xfer->xroot->bus);
2199 }
2200
2201 /*------------------------------------------------------------------------*
2202  *      usb2_pipe_start
2203  *
2204  * This function is used to add an USB transfer to the pipe transfer list.
2205  *------------------------------------------------------------------------*/
2206 void
2207 usb2_pipe_start(struct usb2_xfer_queue *pq)
2208 {
2209         struct usb2_pipe *pipe;
2210         struct usb2_xfer *xfer;
2211         uint8_t type;
2212
2213         xfer = pq->curr;
2214         pipe = xfer->pipe;
2215
2216         USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2217
2218         /*
2219          * If the pipe is already stalled we do nothing !
2220          */
2221         if (pipe->is_stalled) {
2222                 return;
2223         }
2224         /*
2225          * Check if we are supposed to stall the pipe:
2226          */
2227         if (xfer->flags.stall_pipe) {
2228                 /* clear stall command */
2229                 xfer->flags.stall_pipe = 0;
2230
2231                 /*
2232                  * Only stall BULK and INTERRUPT endpoints.
2233                  */
2234                 type = (pipe->edesc->bmAttributes & UE_XFERTYPE);
2235                 if ((type == UE_BULK) ||
2236                     (type == UE_INTERRUPT)) {
2237                         struct usb2_device *udev;
2238                         struct usb2_xfer_root *info;
2239
2240                         info = xfer->xroot;
2241                         udev = info->udev;
2242                         pipe->is_stalled = 1;
2243
2244                         if (udev->flags.usb2_mode == USB_MODE_DEVICE) {
2245                                 (udev->bus->methods->set_stall) (
2246                                     udev, NULL, pipe);
2247                         } else if (udev->default_xfer[1]) {
2248                                 info = udev->default_xfer[1]->xroot;
2249                                 if (usb2_proc_msignal(
2250                                     &info->bus->non_giant_callback_proc,
2251                                     &udev->cs_msg[0], &udev->cs_msg[1])) {
2252                                         /* ignore */
2253                                 }
2254                         } else {
2255                                 /* should not happen */
2256                                 DPRINTFN(0, "No stall handler!\n");
2257                         }
2258                         /*
2259                          * We get started again when the stall is cleared!
2260                          */
2261                         return;
2262                 }
2263         }
2264         /* Set or clear stall complete - special case */
2265         if (xfer->nframes == 0) {
2266                 /* we are complete */
2267                 xfer->aframes = 0;
2268                 usb2_transfer_done(xfer, 0);
2269                 return;
2270         }
2271         /*
2272          * Handled cases:
2273          *
2274          * 1) Start the first transfer queued.
2275          *
2276          * 2) Re-start the current USB transfer.
2277          */
2278         /*
2279          * Check if there should be any
2280          * pre transfer start delay:
2281          */
2282         if (xfer->interval > 0) {
2283                 type = (pipe->edesc->bmAttributes & UE_XFERTYPE);
2284                 if ((type == UE_BULK) ||
2285                     (type == UE_CONTROL)) {
2286                         usb2_transfer_timeout_ms(xfer,
2287                             &usb2_transfer_start_cb,
2288                             xfer->interval);
2289                         return;
2290                 }
2291         }
2292         DPRINTF("start\n");
2293
2294         /* start USB transfer */
2295         (pipe->methods->start) (xfer);
2296
2297         xfer->flags_int.can_cancel_immed = 1;
2298
2299         /* check for error */
2300         if (xfer->error) {
2301                 /* some error has happened */
2302                 usb2_transfer_done(xfer, 0);
2303         }
2304 }
2305
2306 /*------------------------------------------------------------------------*
2307  *      usb2_transfer_timeout_ms
2308  *
2309  * This function is used to setup a timeout on the given USB
2310  * transfer. If the timeout has been deferred the callback given by
2311  * "cb" will get called after "ms" milliseconds.
2312  *------------------------------------------------------------------------*/
2313 void
2314 usb2_transfer_timeout_ms(struct usb2_xfer *xfer,
2315     void (*cb) (void *arg), usb2_timeout_t ms)
2316 {
2317         USB_BUS_LOCK_ASSERT(xfer->xroot->bus, MA_OWNED);
2318
2319         /* defer delay */
2320         usb2_callout_reset(&xfer->timeout_handle,
2321             USB_MS_TO_TICKS(ms), cb, xfer);
2322 }
2323
2324 /*------------------------------------------------------------------------*
2325  *      usb2_callback_wrapper_sub
2326  *
2327  *  - This function will update variables in an USB transfer after
2328  *  that the USB transfer is complete.
2329  *
2330  *  - This function is used to start the next USB transfer on the
2331  *  pipe transfer queue, if any.
2332  *
2333  * NOTE: In some special cases the USB transfer will not be removed from
2334  * the pipe queue, but remain first. To enforce USB transfer removal call
2335  * this function passing the error code "USB_ERR_CANCELLED".
2336  *
2337  * Return values:
2338  * 0: Success.
2339  * Else: The callback has been deferred.
2340  *------------------------------------------------------------------------*/
2341 static uint8_t
2342 usb2_callback_wrapper_sub(struct usb2_xfer *xfer)
2343 {
2344         struct usb2_pipe *pipe;
2345         usb2_frcount_t x;
2346
2347         if ((!xfer->flags_int.open) &&
2348             (!xfer->flags_int.did_close)) {
2349                 DPRINTF("close\n");
2350                 USB_BUS_LOCK(xfer->xroot->bus);
2351                 (xfer->pipe->methods->close) (xfer);
2352                 USB_BUS_UNLOCK(xfer->xroot->bus);
2353                 /* only close once */
2354                 xfer->flags_int.did_close = 1;
2355                 return (1);             /* wait for new callback */
2356         }
2357         /*
2358          * If we have a non-hardware induced error we
2359          * need to do the DMA delay!
2360          */
2361         if (((xfer->error == USB_ERR_CANCELLED) ||
2362             (xfer->error == USB_ERR_TIMEOUT)) &&
2363             (!xfer->flags_int.did_dma_delay)) {
2364
2365                 usb2_timeout_t temp;
2366
2367                 /* only delay once */
2368                 xfer->flags_int.did_dma_delay = 1;
2369
2370                 /* we can not cancel this delay */
2371                 xfer->flags_int.can_cancel_immed = 0;
2372
2373                 temp = usb2_get_dma_delay(xfer->xroot->bus);
2374
2375                 DPRINTFN(3, "DMA delay, %u ms, "
2376                     "on %p\n", temp, xfer);
2377
2378                 if (temp != 0) {
2379                         USB_BUS_LOCK(xfer->xroot->bus);
2380                         usb2_transfer_timeout_ms(xfer,
2381                             &usb2_dma_delay_done_cb, temp);
2382                         USB_BUS_UNLOCK(xfer->xroot->bus);
2383                         return (1);     /* wait for new callback */
2384                 }
2385         }
2386         /* check actual number of frames */
2387         if (xfer->aframes > xfer->nframes) {
2388                 if (xfer->error == 0) {
2389                         panic("%s: actual number of frames, %d, is "
2390                             "greater than initial number of frames, %d!\n",
2391                             __FUNCTION__, xfer->aframes, xfer->nframes);
2392                 } else {
2393                         /* just set some valid value */
2394                         xfer->aframes = xfer->nframes;
2395                 }
2396         }
2397         /* compute actual length */
2398         xfer->actlen = 0;
2399
2400         for (x = 0; x != xfer->aframes; x++) {
2401                 xfer->actlen += xfer->frlengths[x];
2402         }
2403
2404         /*
2405          * Frames that were not transferred get zero actual length in
2406          * case the USB device driver does not check the actual number
2407          * of frames transferred, "xfer->aframes":
2408          */
2409         for (; x < xfer->nframes; x++) {
2410                 xfer->frlengths[x] = 0;
2411         }
2412
2413         /* check actual length */
2414         if (xfer->actlen > xfer->sumlen) {
2415                 if (xfer->error == 0) {
2416                         panic("%s: actual length, %d, is greater than "
2417                             "initial length, %d!\n",
2418                             __FUNCTION__, xfer->actlen, xfer->sumlen);
2419                 } else {
2420                         /* just set some valid value */
2421                         xfer->actlen = xfer->sumlen;
2422                 }
2423         }
2424         DPRINTFN(6, "xfer=%p pipe=%p sts=%d alen=%d, slen=%d, afrm=%d, nfrm=%d\n",
2425             xfer, xfer->pipe, xfer->error, xfer->actlen, xfer->sumlen,
2426             xfer->aframes, xfer->nframes);
2427
2428         if (xfer->error) {
2429                 /* end of control transfer, if any */
2430                 xfer->flags_int.control_act = 0;
2431
2432                 /* check if we should block the execution queue */
2433                 if ((xfer->error != USB_ERR_CANCELLED) &&
2434                     (xfer->flags.pipe_bof)) {
2435                         DPRINTFN(2, "xfer=%p: Block On Failure "
2436                             "on pipe=%p\n", xfer, xfer->pipe);
2437                         goto done;
2438                 }
2439         } else {
2440                 /* check for short transfers */
2441                 if (xfer->actlen < xfer->sumlen) {
2442
2443                         /* end of control transfer, if any */
2444                         xfer->flags_int.control_act = 0;
2445
2446                         if (!xfer->flags_int.short_xfer_ok) {
2447                                 xfer->error = USB_ERR_SHORT_XFER;
2448                                 if (xfer->flags.pipe_bof) {
2449                                         DPRINTFN(2, "xfer=%p: Block On Failure on "
2450                                             "Short Transfer on pipe %p.\n",
2451                                             xfer, xfer->pipe);
2452                                         goto done;
2453                                 }
2454                         }
2455                 } else {
2456                         /*
2457                          * Check if we are in the middle of a
2458                          * control transfer:
2459                          */
2460                         if (xfer->flags_int.control_act) {
2461                                 DPRINTFN(5, "xfer=%p: Control transfer "
2462                                     "active on pipe=%p\n", xfer, xfer->pipe);
2463                                 goto done;
2464                         }
2465                 }
2466         }
2467
2468         pipe = xfer->pipe;
2469
2470         /*
2471          * If the current USB transfer is completing we need to start the
2472          * next one:
2473          */
2474         USB_BUS_LOCK(xfer->xroot->bus);
2475         if (pipe->pipe_q.curr == xfer) {
2476                 usb2_command_wrapper(&pipe->pipe_q, NULL);
2477
2478                 if (pipe->pipe_q.curr || TAILQ_FIRST(&pipe->pipe_q.head)) {
2479                         /* there is another USB transfer waiting */
2480                 } else {
2481                         /* this is the last USB transfer */
2482                         /* clear isochronous sync flag */
2483                         xfer->pipe->is_synced = 0;
2484                 }
2485         }
2486         USB_BUS_UNLOCK(xfer->xroot->bus);
2487 done:
2488         return (0);
2489 }
2490
2491 /*------------------------------------------------------------------------*
2492  *      usb2_command_wrapper
2493  *
2494  * This function is used to execute commands non-recursivly on an USB
2495  * transfer.
2496  *------------------------------------------------------------------------*/
2497 void
2498 usb2_command_wrapper(struct usb2_xfer_queue *pq, struct usb2_xfer *xfer)
2499 {
2500         if (xfer) {
2501                 /*
2502                  * If the transfer is not already processing,
2503                  * queue it!
2504                  */
2505                 if (pq->curr != xfer) {
2506                         usb2_transfer_enqueue(pq, xfer);
2507                         if (pq->curr != NULL) {
2508                                 /* something is already processing */
2509                                 DPRINTFN(6, "busy %p\n", pq->curr);
2510                                 return;
2511                         }
2512                 }
2513         } else {
2514                 /* Get next element in queue */
2515                 pq->curr = NULL;
2516         }
2517
2518         if (!pq->recurse_1) {
2519
2520                 do {
2521
2522                         /* set both recurse flags */
2523                         pq->recurse_1 = 1;
2524                         pq->recurse_2 = 1;
2525
2526                         if (pq->curr == NULL) {
2527                                 xfer = TAILQ_FIRST(&pq->head);
2528                                 if (xfer) {
2529                                         TAILQ_REMOVE(&pq->head, xfer,
2530                                             wait_entry);
2531                                         xfer->wait_queue = NULL;
2532                                         pq->curr = xfer;
2533                                 } else {
2534                                         break;
2535                                 }
2536                         }
2537                         DPRINTFN(6, "cb %p (enter)\n", pq->curr);
2538                         (pq->command) (pq);
2539                         DPRINTFN(6, "cb %p (leave)\n", pq->curr);
2540
2541                 } while (!pq->recurse_2);
2542
2543                 /* clear first recurse flag */
2544                 pq->recurse_1 = 0;
2545
2546         } else {
2547                 /* clear second recurse flag */
2548                 pq->recurse_2 = 0;
2549         }
2550 }
2551
2552 /*------------------------------------------------------------------------*
2553  *      usb2_default_transfer_setup
2554  *
2555  * This function is used to setup the default USB control endpoint
2556  * transfer.
2557  *------------------------------------------------------------------------*/
2558 void
2559 usb2_default_transfer_setup(struct usb2_device *udev)
2560 {
2561         struct usb2_xfer *xfer;
2562         uint8_t no_resetup;
2563         uint8_t iface_index;
2564
2565         /* check for root HUB */
2566         if (udev->parent_hub == NULL)
2567                 return;
2568 repeat:
2569
2570         xfer = udev->default_xfer[0];
2571         if (xfer) {
2572                 USB_XFER_LOCK(xfer);
2573                 no_resetup =
2574                     ((xfer->address == udev->address) &&
2575                     (udev->default_ep_desc.wMaxPacketSize[0] ==
2576                     udev->ddesc.bMaxPacketSize));
2577                 if (udev->flags.usb2_mode == USB_MODE_DEVICE) {
2578                         if (no_resetup) {
2579                                 /*
2580                                  * NOTE: checking "xfer->address" and
2581                                  * starting the USB transfer must be
2582                                  * atomic!
2583                                  */
2584                                 usb2_transfer_start(xfer);
2585                         }
2586                 }
2587                 USB_XFER_UNLOCK(xfer);
2588         } else {
2589                 no_resetup = 0;
2590         }
2591
2592         if (no_resetup) {
2593                 /*
2594                  * All parameters are exactly the same like before.
2595                  * Just return.
2596                  */
2597                 return;
2598         }
2599         /*
2600          * Update wMaxPacketSize for the default control endpoint:
2601          */
2602         udev->default_ep_desc.wMaxPacketSize[0] =
2603             udev->ddesc.bMaxPacketSize;
2604
2605         /*
2606          * Unsetup any existing USB transfer:
2607          */
2608         usb2_transfer_unsetup(udev->default_xfer, USB_DEFAULT_XFER_MAX);
2609
2610         /*
2611          * Try to setup a new USB transfer for the
2612          * default control endpoint:
2613          */
2614         iface_index = 0;
2615         if (usb2_transfer_setup(udev, &iface_index,
2616             udev->default_xfer, usb2_control_ep_cfg, USB_DEFAULT_XFER_MAX, NULL,
2617             udev->default_mtx)) {
2618                 DPRINTFN(0, "could not setup default "
2619                     "USB transfer!\n");
2620         } else {
2621                 goto repeat;
2622         }
2623 }
2624
2625 /*------------------------------------------------------------------------*
2626  *      usb2_clear_data_toggle - factored out code
2627  *
2628  * NOTE: the intention of this function is not to reset the hardware
2629  * data toggle.
2630  *------------------------------------------------------------------------*/
2631 void
2632 usb2_clear_data_toggle(struct usb2_device *udev, struct usb2_pipe *pipe)
2633 {
2634         DPRINTFN(5, "udev=%p pipe=%p\n", udev, pipe);
2635
2636         USB_BUS_LOCK(udev->bus);
2637         pipe->toggle_next = 0;
2638         USB_BUS_UNLOCK(udev->bus);
2639 }
2640
2641 /*------------------------------------------------------------------------*
2642  *      usb2_clear_stall_callback - factored out clear stall callback
2643  *
2644  * Input parameters:
2645  *  xfer1: Clear Stall Control Transfer
2646  *  xfer2: Stalled USB Transfer
2647  *
2648  * This function is NULL safe.
2649  *
2650  * Return values:
2651  *   0: In progress
2652  *   Else: Finished
2653  *
2654  * Clear stall config example:
2655  *
2656  * static const struct usb2_config my_clearstall =  {
2657  *      .type = UE_CONTROL,
2658  *      .endpoint = 0,
2659  *      .direction = UE_DIR_ANY,
2660  *      .interval = 50, //50 milliseconds
2661  *      .bufsize = sizeof(struct usb2_device_request),
2662  *      .timeout = 1000, //1.000 seconds
2663  *      .callback = &my_clear_stall_callback, // **
2664  *      .usb_mode = USB_MODE_HOST,
2665  * };
2666  *
2667  * ** "my_clear_stall_callback" calls "usb2_clear_stall_callback"
2668  * passing the correct parameters.
2669  *------------------------------------------------------------------------*/
2670 uint8_t
2671 usb2_clear_stall_callback(struct usb2_xfer *xfer1,
2672     struct usb2_xfer *xfer2)
2673 {
2674         struct usb2_device_request req;
2675
2676         if (xfer2 == NULL) {
2677                 /* looks like we are tearing down */
2678                 DPRINTF("NULL input parameter\n");
2679                 return (0);
2680         }
2681         USB_XFER_LOCK_ASSERT(xfer1, MA_OWNED);
2682         USB_XFER_LOCK_ASSERT(xfer2, MA_OWNED);
2683
2684         switch (USB_GET_STATE(xfer1)) {
2685         case USB_ST_SETUP:
2686
2687                 /*
2688                  * pre-clear the data toggle to DATA0 ("umass.c" and
2689                  * "ata-usb.c" depends on this)
2690                  */
2691
2692                 usb2_clear_data_toggle(xfer2->xroot->udev, xfer2->pipe);
2693
2694                 /* setup a clear-stall packet */
2695
2696                 req.bmRequestType = UT_WRITE_ENDPOINT;
2697                 req.bRequest = UR_CLEAR_FEATURE;
2698                 USETW(req.wValue, UF_ENDPOINT_HALT);
2699                 req.wIndex[0] = xfer2->pipe->edesc->bEndpointAddress;
2700                 req.wIndex[1] = 0;
2701                 USETW(req.wLength, 0);
2702
2703                 /*
2704                  * "usb2_transfer_setup_sub()" will ensure that
2705                  * we have sufficient room in the buffer for
2706                  * the request structure!
2707                  */
2708
2709                 /* copy in the transfer */
2710
2711                 usb2_copy_in(xfer1->frbuffers, 0, &req, sizeof(req));
2712
2713                 /* set length */
2714                 xfer1->frlengths[0] = sizeof(req);
2715                 xfer1->nframes = 1;
2716
2717                 usb2_start_hardware(xfer1);
2718                 return (0);
2719
2720         case USB_ST_TRANSFERRED:
2721                 break;
2722
2723         default:                        /* Error */
2724                 if (xfer1->error == USB_ERR_CANCELLED) {
2725                         return (0);
2726                 }
2727                 break;
2728         }
2729         return (1);                     /* Clear Stall Finished */
2730 }
2731
2732 void
2733 usb2_do_poll(struct usb2_xfer **ppxfer, uint16_t max)
2734 {
2735         static uint8_t once = 0;
2736         /* polling is currently not supported */
2737         if (!once) {
2738                 once = 1;
2739                 printf("usb2_do_poll: USB polling is "
2740                     "not supported!\n");
2741         }
2742 }
2743
2744 static void
2745 usb2_get_std_packet_size(struct usb2_std_packet_size *ptr,
2746     uint8_t type, uint8_t usb_speed)
2747 {
2748         static const uint16_t intr_range_max[USB_SPEED_MAX] = {
2749                 [USB_SPEED_LOW] = 8,
2750                 [USB_SPEED_FULL] = 64,
2751                 [USB_SPEED_HIGH] = 1024,
2752                 [USB_SPEED_VARIABLE] = 1024,
2753                 [USB_SPEED_SUPER] = 1024,
2754         };
2755
2756         static const uint16_t isoc_range_max[USB_SPEED_MAX] = {
2757                 [USB_SPEED_LOW] = 0,    /* invalid */
2758                 [USB_SPEED_FULL] = 1023,
2759                 [USB_SPEED_HIGH] = 1024,
2760                 [USB_SPEED_VARIABLE] = 3584,
2761                 [USB_SPEED_SUPER] = 1024,
2762         };
2763
2764         static const uint16_t control_min[USB_SPEED_MAX] = {
2765                 [USB_SPEED_LOW] = 8,
2766                 [USB_SPEED_FULL] = 8,
2767                 [USB_SPEED_HIGH] = 64,
2768                 [USB_SPEED_VARIABLE] = 512,
2769                 [USB_SPEED_SUPER] = 512,
2770         };
2771
2772         static const uint16_t bulk_min[USB_SPEED_MAX] = {
2773                 [USB_SPEED_LOW] = 0,    /* not supported */
2774                 [USB_SPEED_FULL] = 8,
2775                 [USB_SPEED_HIGH] = 512,
2776                 [USB_SPEED_VARIABLE] = 512,
2777                 [USB_SPEED_SUPER] = 1024,
2778         };
2779
2780         uint16_t temp;
2781
2782         memset(ptr, 0, sizeof(*ptr));
2783
2784         switch (type) {
2785         case UE_INTERRUPT:
2786                 ptr->range.max = intr_range_max[usb_speed];
2787                 break;
2788         case UE_ISOCHRONOUS:
2789                 ptr->range.max = isoc_range_max[usb_speed];
2790                 break;
2791         default:
2792                 if (type == UE_BULK)
2793                         temp = bulk_min[usb_speed];
2794                 else /* UE_CONTROL */
2795                         temp = control_min[usb_speed];
2796
2797                 /* default is fixed */
2798                 ptr->fixed[0] = temp;
2799                 ptr->fixed[1] = temp;
2800                 ptr->fixed[2] = temp;
2801                 ptr->fixed[3] = temp;
2802
2803                 if (usb_speed == USB_SPEED_FULL) {
2804                         /* multiple sizes */
2805                         ptr->fixed[1] = 16;
2806                         ptr->fixed[2] = 32;
2807                         ptr->fixed[3] = 64;
2808                 }
2809                 if ((usb_speed == USB_SPEED_VARIABLE) &&
2810                     (type == UE_BULK)) {
2811                         /* multiple sizes */
2812                         ptr->fixed[2] = 1024;
2813                         ptr->fixed[3] = 1536;
2814                 }
2815                 break;
2816         }
2817 }