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