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