sys/dev/usb/usb_request.c

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
   4  * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
   5  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/stdint.h>
  30 #include <sys/stddef.h>
  31 #include <sys/param.h>
  32 #include <sys/queue.h>
  33 #include <sys/types.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/bus.h>
  37 #include <sys/module.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #include <sys/condvar.h>
  41 #include <sys/sysctl.h>
  42 #include <sys/sx.h>
  43 #include <sys/unistd.h>
  44 #include <sys/callout.h>
  45 #include <sys/malloc.h>
  46 #include <sys/priv.h>
  47
  48 #include <dev/usb/usb.h>
  49 #include <dev/usb/usbdi.h>
  50 #include <dev/usb/usbdi_util.h>
  51 #include <dev/usb/usbhid.h>
  52
  53 #define USB_DEBUG_VAR usb_debug
  54
  55 #include <dev/usb/usb_core.h>
  56 #include <dev/usb/usb_busdma.h>
  57 #include <dev/usb/usb_request.h>
  58 #include <dev/usb/usb_process.h>
  59 #include <dev/usb/usb_transfer.h>
  60 #include <dev/usb/usb_debug.h>
  61 #include <dev/usb/usb_device.h>
  62 #include <dev/usb/usb_util.h>
  63 #include <dev/usb/usb_dynamic.h>
  64
  65 #include <dev/usb/usb_controller.h>
  66 #include <dev/usb/usb_bus.h>
  67 #include <sys/ctype.h>
  68
  69 static int usb_no_cs_fail;
  70
  71 SYSCTL_INT(_hw_usb, OID_AUTO, no_cs_fail, CTLFLAG_RW,
  72     &usb_no_cs_fail, 0, "USB clear stall failures are ignored, if set");
  73
  74 static int usb_full_ddesc;
  75
  76 SYSCTL_INT(_hw_usb, OID_AUTO, full_ddesc, CTLFLAG_RW,
  77     &usb_full_ddesc, 0, "USB always read complete device descriptor, if set");
  78
  79 #ifdef USB_DEBUG
  80 #ifdef USB_REQ_DEBUG
  81 /* The following structures are used in connection to fault injection. */
  82 struct usb_ctrl_debug {
  83         int bus_index;          /* target bus */
  84         int dev_index;          /* target address */
  85         int ds_fail;            /* fail data stage */
  86         int ss_fail;            /* fail status stage */
  87         int ds_delay;           /* data stage delay in ms */
  88         int ss_delay;           /* status stage delay in ms */
  89         int bmRequestType_value;
  90         int bRequest_value;
  91 };
  92
  93 struct usb_ctrl_debug_bits {
  94         uint16_t ds_delay;
  95         uint16_t ss_delay;
  96         uint8_t ds_fail:1;
  97         uint8_t ss_fail:1;
  98         uint8_t enabled:1;
  99 };
 100
 101 /* The default is to disable fault injection. */
 102
 103 static struct usb_ctrl_debug usb_ctrl_debug = {
 104         .bus_index = -1,
 105         .dev_index = -1,
 106         .bmRequestType_value = -1,
 107         .bRequest_value = -1,
 108 };
 109
 110 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_bus_fail, CTLFLAG_RW,
 111     &usb_ctrl_debug.bus_index, 0, "USB controller index to fail");
 112 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_dev_fail, CTLFLAG_RW,
 113     &usb_ctrl_debug.dev_index, 0, "USB device address to fail");
 114 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_ds_fail, CTLFLAG_RW,
 115     &usb_ctrl_debug.ds_fail, 0, "USB fail data stage");
 116 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_ss_fail, CTLFLAG_RW,
 117     &usb_ctrl_debug.ss_fail, 0, "USB fail status stage");
 118 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_ds_delay, CTLFLAG_RW,
 119     &usb_ctrl_debug.ds_delay, 0, "USB data stage delay in ms");
 120 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_ss_delay, CTLFLAG_RW,
 121     &usb_ctrl_debug.ss_delay, 0, "USB status stage delay in ms");
 122 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_rt_fail, CTLFLAG_RW,
 123     &usb_ctrl_debug.bmRequestType_value, 0, "USB bmRequestType to fail");
 124 SYSCTL_INT(_hw_usb, OID_AUTO, ctrl_rv_fail, CTLFLAG_RW,
 125     &usb_ctrl_debug.bRequest_value, 0, "USB bRequest to fail");
 126
 127 /*------------------------------------------------------------------------*
 128  *      usbd_get_debug_bits
 129  *
 130  * This function is only useful in USB host mode.
 131  *------------------------------------------------------------------------*/
 132 static void
 133 usbd_get_debug_bits(struct usb_device *udev, struct usb_device_request *req,
 134     struct usb_ctrl_debug_bits *dbg)
 135 {
 136         int temp;
 137
 138         memset(dbg, 0, sizeof(*dbg));
 139
 140         /* Compute data stage delay */
 141
 142         temp = usb_ctrl_debug.ds_delay;
 143         if (temp < 0)
 144                 temp = 0;
 145         else if (temp > (16*1024))
 146                 temp = (16*1024);
 147
 148         dbg->ds_delay = temp;
 149
 150         /* Compute status stage delay */
 151
 152         temp = usb_ctrl_debug.ss_delay;
 153         if (temp < 0)
 154                 temp = 0;
 155         else if (temp > (16*1024))
 156                 temp = (16*1024);
 157
 158         dbg->ss_delay = temp;
 159
 160         /* Check if this control request should be failed */
 161
 162         if (usbd_get_bus_index(udev) != usb_ctrl_debug.bus_index)
 163                 return;
 164
 165         if (usbd_get_device_index(udev) != usb_ctrl_debug.dev_index)
 166                 return;
 167
 168         temp = usb_ctrl_debug.bmRequestType_value;
 169
 170         if ((temp != req->bmRequestType) && (temp >= 0) && (temp <= 255))
 171                 return;
 172
 173         temp = usb_ctrl_debug.bRequest_value;
 174
 175         if ((temp != req->bRequest) && (temp >= 0) && (temp <= 255))
 176                 return;
 177
 178         temp = usb_ctrl_debug.ds_fail;
 179         if (temp)
 180                 dbg->ds_fail = 1;
 181
 182         temp = usb_ctrl_debug.ss_fail;
 183         if (temp)
 184                 dbg->ss_fail = 1;
 185
 186         dbg->enabled = 1;
 187 }
 188 #endif  /* USB_REQ_DEBUG */
 189 #endif  /* USB_DEBUG */
 190
 191 /*------------------------------------------------------------------------*
 192  *      usbd_do_request_callback
 193  *
 194  * This function is the USB callback for generic USB Host control
 195  * transfers.
 196  *------------------------------------------------------------------------*/
 197 void
 198 usbd_do_request_callback(struct usb_xfer *xfer, usb_error_t error)
 199 {
 200         ;                               /* workaround for a bug in "indent" */
 201
 202         DPRINTF("st=%u\n", USB_GET_STATE(xfer));
 203
 204         switch (USB_GET_STATE(xfer)) {
 205         case USB_ST_SETUP:
 206                 usbd_transfer_submit(xfer);
 207                 break;
 208         default:
 209                 cv_signal(&xfer->xroot->udev->ctrlreq_cv);
 210                 break;
 211         }
 212 }
 213
 214 /*------------------------------------------------------------------------*
 215  *      usb_do_clear_stall_callback
 216  *
 217  * This function is the USB callback for generic clear stall requests.
 218  *------------------------------------------------------------------------*/
 219 void
 220 usb_do_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
 221 {
 222         struct usb_device_request req;
 223         struct usb_device *udev;
 224         struct usb_endpoint *ep;
 225         struct usb_endpoint *ep_end;
 226         struct usb_endpoint *ep_first;
 227         uint8_t to;
 228
 229         udev = xfer->xroot->udev;
 230
 231         USB_BUS_LOCK(udev->bus);
 232
 233         /* round robin endpoint clear stall */
 234
 235         ep = udev->ep_curr;
 236         ep_end = udev->endpoints + udev->endpoints_max;
 237         ep_first = udev->endpoints;
 238         to = udev->endpoints_max;
 239
 240         switch (USB_GET_STATE(xfer)) {
 241         case USB_ST_TRANSFERRED:
 242 tr_transferred:
 243                 /* reset error counter */
 244                 udev->clear_stall_errors = 0;
 245
 246                 if (ep == NULL)
 247                         goto tr_setup;          /* device was unconfigured */
 248                 if (ep->edesc &&
 249                     ep->is_stalled) {
 250                         ep->toggle_next = 0;
 251                         ep->is_stalled = 0;
 252                         /* some hardware needs a callback to clear the data toggle */
 253                         usbd_clear_stall_locked(udev, ep);
 254                         /* start up the current or next transfer, if any */
 255                         usb_command_wrapper(&ep->endpoint_q,
 256                             ep->endpoint_q.curr);
 257                 }
 258                 ep++;
 259
 260         case USB_ST_SETUP:
 261 tr_setup:
 262                 if (to == 0)
 263                         break;                  /* no endpoints - nothing to do */
 264                 if ((ep < ep_first) || (ep >= ep_end))
 265                         ep = ep_first;  /* endpoint wrapped around */
 266                 if (ep->edesc &&
 267                     ep->is_stalled) {
 268
 269                         /* setup a clear-stall packet */
 270
 271                         req.bmRequestType = UT_WRITE_ENDPOINT;
 272                         req.bRequest = UR_CLEAR_FEATURE;
 273                         USETW(req.wValue, UF_ENDPOINT_HALT);
 274                         req.wIndex[0] = ep->edesc->bEndpointAddress;
 275                         req.wIndex[1] = 0;
 276                         USETW(req.wLength, 0);
 277
 278                         /* copy in the transfer */
 279
 280                         usbd_copy_in(xfer->frbuffers, 0, &req, sizeof(req));
 281
 282                         /* set length */
 283                         usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
 284                         xfer->nframes = 1;
 285                         USB_BUS_UNLOCK(udev->bus);
 286
 287                         usbd_transfer_submit(xfer);
 288
 289                         USB_BUS_LOCK(udev->bus);
 290                         break;
 291                 }
 292                 ep++;
 293                 to--;
 294                 goto tr_setup;
 295
 296         default:
 297                 if (error == USB_ERR_CANCELLED)
 298                         break;
 299
 300                 DPRINTF("Clear stall failed.\n");
 301
 302                 /*
 303                  * Some VMs like VirtualBox always return failure on
 304                  * clear-stall which we sometimes should just ignore.
 305                  */
 306                 if (usb_no_cs_fail)
 307                         goto tr_transferred;
 308                 if (udev->clear_stall_errors == USB_CS_RESET_LIMIT)
 309                         goto tr_setup;
 310
 311                 if (error == USB_ERR_TIMEOUT) {
 312                         udev->clear_stall_errors = USB_CS_RESET_LIMIT;
 313                         DPRINTF("Trying to re-enumerate.\n");
 314                         usbd_start_re_enumerate(udev);
 315                 } else {
 316                         udev->clear_stall_errors++;
 317                         if (udev->clear_stall_errors == USB_CS_RESET_LIMIT) {
 318                                 DPRINTF("Trying to re-enumerate.\n");
 319                                 usbd_start_re_enumerate(udev);
 320                         }
 321                 }
 322                 goto tr_setup;
 323         }
 324
 325         /* store current endpoint */
 326         udev->ep_curr = ep;
 327         USB_BUS_UNLOCK(udev->bus);
 328 }
 329
 330 static usb_handle_req_t *
 331 usbd_get_hr_func(struct usb_device *udev)
 332 {
 333         /* figure out if there is a Handle Request function */
 334         if (udev->flags.usb_mode == USB_MODE_DEVICE)
 335                 return (usb_temp_get_desc_p);
 336         else if (udev->parent_hub == NULL)
 337                 return (udev->bus->methods->roothub_exec);
 338         else
 339                 return (NULL);
 340 }
 341
 342 /*------------------------------------------------------------------------*
 343  *      usbd_do_request_flags and usbd_do_request
 344  *
 345  * Description of arguments passed to these functions:
 346  *
 347  * "udev" - this is the "usb_device" structure pointer on which the
 348  * request should be performed. It is possible to call this function
 349  * in both Host Side mode and Device Side mode.
 350  *
 351  * "mtx" - if this argument is non-NULL the mutex pointed to by it
 352  * will get dropped and picked up during the execution of this
 353  * function, hence this function sometimes needs to sleep. If this
 354  * argument is NULL it has no effect.
 355  *
 356  * "req" - this argument must always be non-NULL and points to an
 357  * 8-byte structure holding the USB request to be done. The USB
 358  * request structure has a bit telling the direction of the USB
 359  * request, if it is a read or a write.
 360  *
 361  * "data" - if the "wLength" part of the structure pointed to by "req"
 362  * is non-zero this argument must point to a valid kernel buffer which
 363  * can hold at least "wLength" bytes. If "wLength" is zero "data" can
 364  * be NULL.
 365  *
 366  * "flags" - here is a list of valid flags:
 367  *
 368  *  o USB_SHORT_XFER_OK: allows the data transfer to be shorter than
 369  *  specified
 370  *
 371  *  o USB_DELAY_STATUS_STAGE: allows the status stage to be performed
 372  *  at a later point in time. This is tunable by the "hw.usb.ss_delay"
 373  *  sysctl. This flag is mostly useful for debugging.
 374  *
 375  *  o USB_USER_DATA_PTR: treat the "data" pointer like a userland
 376  *  pointer.
 377  *
 378  * "actlen" - if non-NULL the actual transfer length will be stored in
 379  * the 16-bit unsigned integer pointed to by "actlen". This
 380  * information is mostly useful when the "USB_SHORT_XFER_OK" flag is
 381  * used.
 382  *
 383  * "timeout" - gives the timeout for the control transfer in
 384  * milliseconds. A "timeout" value less than 50 milliseconds is
 385  * treated like a 50 millisecond timeout. A "timeout" value greater
 386  * than 30 seconds is treated like a 30 second timeout. This USB stack
 387  * does not allow control requests without a timeout.
 388  *
 389  * NOTE: This function is thread safe. All calls to "usbd_do_request_flags"
 390  * will be serialized by the use of the USB device enumeration lock.
 391  *
 392  * Returns:
 393  *    0: Success
 394  * Else: Failure
 395  *------------------------------------------------------------------------*/
 396 usb_error_t
 397 usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
 398     struct usb_device_request *req, void *data, uint16_t flags,
 399     uint16_t *actlen, usb_timeout_t timeout)
 400 {
 401 #ifdef USB_REQ_DEBUG
 402         struct usb_ctrl_debug_bits dbg;
 403 #endif
 404         usb_handle_req_t *hr_func;
 405         struct usb_xfer *xfer;
 406         const void *desc;
 407         int err = 0;
 408         usb_ticks_t start_ticks;
 409         usb_ticks_t delta_ticks;
 410         usb_ticks_t max_ticks;
 411         uint16_t length;
 412         uint16_t temp;
 413         uint16_t acttemp;
 414         uint8_t do_unlock;
 415
 416         if (timeout < 50) {
 417                 /* timeout is too small */
 418                 timeout = 50;
 419         }
 420         if (timeout > 30000) {
 421                 /* timeout is too big */
 422                 timeout = 30000;
 423         }
 424         length = UGETW(req->wLength);
 425
 426         DPRINTFN(5, "udev=%p bmRequestType=0x%02x bRequest=0x%02x "
 427             "wValue=0x%02x%02x wIndex=0x%02x%02x wLength=0x%02x%02x\n",
 428             udev, req->bmRequestType, req->bRequest,
 429             req->wValue[1], req->wValue[0],
 430             req->wIndex[1], req->wIndex[0],
 431             req->wLength[1], req->wLength[0]);
 432
 433         /* Check if the device is still alive */
 434         if (udev->state < USB_STATE_POWERED) {
 435                 DPRINTF("usb device has gone\n");
 436                 return (USB_ERR_NOT_CONFIGURED);
 437         }
 438
 439         /*
 440          * Set "actlen" to a known value in case the caller does not
 441          * check the return value:
 442          */
 443         if (actlen)
 444                 *actlen = 0;
 445
 446 #if (USB_HAVE_USER_IO == 0)
 447         if (flags & USB_USER_DATA_PTR)
 448                 return (USB_ERR_INVAL);
 449 #endif
 450         if ((mtx != NULL) && (mtx != &Giant)) {
 451                 mtx_unlock(mtx);
 452                 mtx_assert(mtx, MA_NOTOWNED);
 453         }
 454
 455         /*
 456          * Serialize access to this function:
 457          */
 458         do_unlock = usbd_ctrl_lock(udev);
 459
 460         hr_func = usbd_get_hr_func(udev);
 461
 462         if (hr_func != NULL) {
 463                 DPRINTF("Handle Request function is set\n");
 464
 465                 desc = NULL;
 466                 temp = 0;
 467
 468                 if (!(req->bmRequestType & UT_READ)) {
 469                         if (length != 0) {
 470                                 DPRINTFN(1, "The handle request function "
 471                                     "does not support writing data!\n");
 472                                 err = USB_ERR_INVAL;
 473                                 goto done;
 474                         }
 475                 }
 476
 477                 /* The root HUB code needs the BUS lock locked */
 478
 479                 USB_BUS_LOCK(udev->bus);
 480                 err = (hr_func) (udev, req, &desc, &temp);
 481                 USB_BUS_UNLOCK(udev->bus);
 482
 483                 if (err)
 484                         goto done;
 485
 486                 if (length > temp) {
 487                         if (!(flags & USB_SHORT_XFER_OK)) {
 488                                 err = USB_ERR_SHORT_XFER;
 489                                 goto done;
 490                         }
 491                         length = temp;
 492                 }
 493                 if (actlen)
 494                         *actlen = length;
 495
 496                 if (length > 0) {
 497 #if USB_HAVE_USER_IO
 498                         if (flags & USB_USER_DATA_PTR) {
 499                                 if (copyout(desc, data, length)) {
 500                                         err = USB_ERR_INVAL;
 501                                         goto done;
 502                                 }
 503                         } else
 504 #endif
 505                                 memcpy(data, desc, length);
 506                 }
 507                 goto done;              /* success */
 508         }
 509
 510         /*
 511          * Setup a new USB transfer or use the existing one, if any:
 512          */
 513         usbd_ctrl_transfer_setup(udev);
 514
 515         xfer = udev->ctrl_xfer[0];
 516         if (xfer == NULL) {
 517                 /* most likely out of memory */
 518                 err = USB_ERR_NOMEM;
 519                 goto done;
 520         }
 521
 522 #ifdef USB_REQ_DEBUG
 523         /* Get debug bits */
 524         usbd_get_debug_bits(udev, req, &dbg);
 525
 526         /* Check for fault injection */
 527         if (dbg.enabled)
 528                 flags |= USB_DELAY_STATUS_STAGE;
 529 #endif
 530         USB_XFER_LOCK(xfer);
 531
 532         if (flags & USB_DELAY_STATUS_STAGE)
 533                 xfer->flags.manual_status = 1;
 534         else
 535                 xfer->flags.manual_status = 0;
 536
 537         if (flags & USB_SHORT_XFER_OK)
 538                 xfer->flags.short_xfer_ok = 1;
 539         else
 540                 xfer->flags.short_xfer_ok = 0;
 541
 542         xfer->timeout = timeout;
 543
 544         start_ticks = ticks;
 545
 546         max_ticks = USB_MS_TO_TICKS(timeout);
 547
 548         usbd_copy_in(xfer->frbuffers, 0, req, sizeof(*req));
 549
 550         usbd_xfer_set_frame_len(xfer, 0, sizeof(*req));
 551
 552         while (1) {
 553                 temp = length;
 554                 if (temp > usbd_xfer_max_len(xfer)) {
 555                         temp = usbd_xfer_max_len(xfer);
 556                 }
 557 #ifdef USB_REQ_DEBUG
 558                 if (xfer->flags.manual_status) {
 559                         if (usbd_xfer_frame_len(xfer, 0) != 0) {
 560                                 /* Execute data stage separately */
 561                                 temp = 0;
 562                         } else if (temp > 0) {
 563                                 if (dbg.ds_fail) {
 564                                         err = USB_ERR_INVAL;
 565                                         break;
 566                                 }
 567                                 if (dbg.ds_delay > 0) {
 568                                         usb_pause_mtx(
 569                                             xfer->xroot->xfer_mtx,
 570                                             USB_MS_TO_TICKS(dbg.ds_delay));
 571                                         /* make sure we don't time out */
 572                                         start_ticks = ticks;
 573                                 }
 574                         }
 575                 }
 576 #endif
 577                 usbd_xfer_set_frame_len(xfer, 1, temp);
 578
 579                 if (temp > 0) {
 580                         if (!(req->bmRequestType & UT_READ)) {
 581 #if USB_HAVE_USER_IO
 582                                 if (flags & USB_USER_DATA_PTR) {
 583                                         USB_XFER_UNLOCK(xfer);
 584                                         err = usbd_copy_in_user(xfer->frbuffers + 1,
 585                                             0, data, temp);
 586                                         USB_XFER_LOCK(xfer);
 587                                         if (err) {
 588                                                 err = USB_ERR_INVAL;
 589                                                 break;
 590                                         }
 591                                 } else
 592 #endif
 593                                         usbd_copy_in(xfer->frbuffers + 1,
 594                                             0, data, temp);
 595                         }
 596                         usbd_xfer_set_frames(xfer, 2);
 597                 } else {
 598                         if (usbd_xfer_frame_len(xfer, 0) == 0) {
 599                                 if (xfer->flags.manual_status) {
 600 #ifdef USB_REQ_DEBUG
 601                                         if (dbg.ss_fail) {
 602                                                 err = USB_ERR_INVAL;
 603                                                 break;
 604                                         }
 605                                         if (dbg.ss_delay > 0) {
 606                                                 usb_pause_mtx(
 607                                                     xfer->xroot->xfer_mtx,
 608                                                     USB_MS_TO_TICKS(dbg.ss_delay));
 609                                                 /* make sure we don't time out */
 610                                                 start_ticks = ticks;
 611                                         }
 612 #endif
 613                                         xfer->flags.manual_status = 0;
 614                                 } else {
 615                                         break;
 616                                 }
 617                         }
 618                         usbd_xfer_set_frames(xfer, 1);
 619                 }
 620
 621                 usbd_transfer_start(xfer);
 622
 623                 while (usbd_transfer_pending(xfer)) {
 624                         cv_wait(&udev->ctrlreq_cv,
 625                             xfer->xroot->xfer_mtx);
 626                 }
 627
 628                 err = xfer->error;
 629
 630                 if (err) {
 631                         break;
 632                 }
 633
 634                 /* get actual length of DATA stage */
 635
 636                 if (xfer->aframes < 2) {
 637                         acttemp = 0;
 638                 } else {
 639                         acttemp = usbd_xfer_frame_len(xfer, 1);
 640                 }
 641
 642                 /* check for short packet */
 643
 644                 if (temp > acttemp) {
 645                         temp = acttemp;
 646                         length = temp;
 647                 }
 648                 if (temp > 0) {
 649                         if (req->bmRequestType & UT_READ) {
 650 #if USB_HAVE_USER_IO
 651                                 if (flags & USB_USER_DATA_PTR) {
 652                                         USB_XFER_UNLOCK(xfer);
 653                                         err = usbd_copy_out_user(xfer->frbuffers + 1,
 654                                             0, data, temp);
 655                                         USB_XFER_LOCK(xfer);
 656                                         if (err) {
 657                                                 err = USB_ERR_INVAL;
 658                                                 break;
 659                                         }
 660                                 } else
 661 #endif
 662                                         usbd_copy_out(xfer->frbuffers + 1,
 663                                             0, data, temp);
 664                         }
 665                 }
 666                 /*
 667                  * Clear "frlengths[0]" so that we don't send the setup
 668                  * packet again:
 669                  */
 670                 usbd_xfer_set_frame_len(xfer, 0, 0);
 671
 672                 /* update length and data pointer */
 673                 length -= temp;
 674                 data = USB_ADD_BYTES(data, temp);
 675
 676                 if (actlen) {
 677                         (*actlen) += temp;
 678                 }
 679                 /* check for timeout */
 680
 681                 delta_ticks = ticks - start_ticks;
 682                 if (delta_ticks > max_ticks) {
 683                         if (!err) {
 684                                 err = USB_ERR_TIMEOUT;
 685                         }
 686                 }
 687                 if (err) {
 688                         break;
 689                 }
 690         }
 691
 692         if (err) {
 693                 /*
 694                  * Make sure that the control endpoint is no longer
 695                  * blocked in case of a non-transfer related error:
 696                  */
 697                 usbd_transfer_stop(xfer);
 698         }
 699         USB_XFER_UNLOCK(xfer);
 700
 701 done:
 702         if (do_unlock)
 703                 usbd_ctrl_unlock(udev);
 704
 705         if ((mtx != NULL) && (mtx != &Giant))
 706                 mtx_lock(mtx);
 707
 708         switch (err) {
 709         case USB_ERR_NORMAL_COMPLETION:
 710         case USB_ERR_SHORT_XFER:
 711         case USB_ERR_STALLED:
 712         case USB_ERR_CANCELLED:
 713                 break;
 714         default:
 715                 DPRINTF("I/O error - waiting a bit for TT cleanup\n");
 716                 usb_pause_mtx(mtx, hz / 16);
 717                 break;
 718         }
 719         return ((usb_error_t)err);
 720 }
 721
 722 /*------------------------------------------------------------------------*
 723  *      usbd_do_request_proc - factored out code
 724  *
 725  * This function is factored out code. It does basically the same like
 726  * usbd_do_request_flags, except it will check the status of the
 727  * passed process argument before doing the USB request. If the
 728  * process is draining the USB_ERR_IOERROR code will be returned. It
 729  * is assumed that the mutex associated with the process is locked
 730  * when calling this function.
 731  *------------------------------------------------------------------------*/
 732 usb_error_t
 733 usbd_do_request_proc(struct usb_device *udev, struct usb_process *pproc,
 734     struct usb_device_request *req, void *data, uint16_t flags,
 735     uint16_t *actlen, usb_timeout_t timeout)
 736 {
 737         usb_error_t err;
 738         uint16_t len;
 739
 740         /* get request data length */
 741         len = UGETW(req->wLength);
 742
 743         /* check if the device is being detached */
 744         if (usb_proc_is_gone(pproc)) {
 745                 err = USB_ERR_IOERROR;
 746                 goto done;
 747         }
 748
 749         /* forward the USB request */
 750         err = usbd_do_request_flags(udev, pproc->up_mtx,
 751             req, data, flags, actlen, timeout);
 752
 753 done:
 754         /* on failure we zero the data */
 755         /* on short packet we zero the unused data */
 756         if ((len != 0) && (req->bmRequestType & UE_DIR_IN)) {
 757                 if (err)
 758                         memset(data, 0, len);
 759                 else if (actlen && *actlen != len)
 760                         memset(((uint8_t *)data) + *actlen, 0, len - *actlen);
 761         }
 762         return (err);
 763 }
 764
 765 /*------------------------------------------------------------------------*
 766  *      usbd_req_reset_port
 767  *
 768  * This function will instruct a USB HUB to perform a reset sequence
 769  * on the specified port number.
 770  *
 771  * Returns:
 772  *    0: Success. The USB device should now be at address zero.
 773  * Else: Failure. No USB device is present and the USB port should be
 774  *       disabled.
 775  *------------------------------------------------------------------------*/
 776 usb_error_t
 777 usbd_req_reset_port(struct usb_device *udev, struct mtx *mtx, uint8_t port)
 778 {
 779         struct usb_port_status ps;
 780         usb_error_t err;
 781         uint16_t n;
 782         uint16_t status;
 783         uint16_t change;
 784
 785         DPRINTF("\n");
 786
 787         /* clear any leftover port reset changes first */
 788         usbd_req_clear_port_feature(
 789             udev, mtx, port, UHF_C_PORT_RESET);
 790
 791         /* assert port reset on the given port */
 792         err = usbd_req_set_port_feature(
 793             udev, mtx, port, UHF_PORT_RESET);
 794
 795         /* check for errors */
 796         if (err)
 797                 goto done;
 798         n = 0;
 799         while (1) {
 800                 /* wait for the device to recover from reset */
 801                 usb_pause_mtx(mtx, USB_MS_TO_TICKS(usb_port_reset_delay));
 802                 n += usb_port_reset_delay;
 803                 err = usbd_req_get_port_status(udev, mtx, &ps, port);
 804                 if (err)
 805                         goto done;
 806
 807                 status = UGETW(ps.wPortStatus);
 808                 change = UGETW(ps.wPortChange);
 809
 810                 /* if the device disappeared, just give up */
 811                 if (!(status & UPS_CURRENT_CONNECT_STATUS))
 812                         goto done;
 813
 814                 /* check if reset is complete */
 815                 if (change & UPS_C_PORT_RESET)
 816                         break;
 817
 818                 /*
 819                  * Some Virtual Machines like VirtualBox 4.x fail to
 820                  * generate a port reset change event. Check if reset
 821                  * is no longer asserted.
 822                  */
 823                 if (!(status & UPS_RESET))
 824                         break;
 825
 826                 /* check for timeout */
 827                 if (n > 1000) {
 828                         n = 0;
 829                         break;
 830                 }
 831         }
 832
 833         /* clear port reset first */
 834         err = usbd_req_clear_port_feature(
 835             udev, mtx, port, UHF_C_PORT_RESET);
 836         if (err)
 837                 goto done;
 838
 839         /* check for timeout */
 840         if (n == 0) {
 841                 err = USB_ERR_TIMEOUT;
 842                 goto done;
 843         }
 844         /* wait for the device to recover from reset */
 845         usb_pause_mtx(mtx, USB_MS_TO_TICKS(usb_port_reset_recovery));
 846
 847 done:
 848         DPRINTFN(2, "port %d reset returning error=%s\n",
 849             port, usbd_errstr(err));
 850         return (err);
 851 }
 852
 853 /*------------------------------------------------------------------------*
 854  *      usbd_req_warm_reset_port
 855  *
 856  * This function will instruct an USB HUB to perform a warm reset
 857  * sequence on the specified port number. This kind of reset is not
 858  * mandatory for LOW-, FULL- and HIGH-speed USB HUBs and is targeted
 859  * for SUPER-speed USB HUBs.
 860  *
 861  * Returns:
 862  *    0: Success. The USB device should now be available again.
 863  * Else: Failure. No USB device is present and the USB port should be
 864  *       disabled.
 865  *------------------------------------------------------------------------*/
 866 usb_error_t
 867 usbd_req_warm_reset_port(struct usb_device *udev, struct mtx *mtx,
 868     uint8_t port)
 869 {
 870         struct usb_port_status ps;
 871         usb_error_t err;
 872         uint16_t n;
 873         uint16_t status;
 874         uint16_t change;
 875
 876         DPRINTF("\n");
 877
 878         err = usbd_req_get_port_status(udev, mtx, &ps, port);
 879         if (err)
 880                 goto done;
 881
 882         status = UGETW(ps.wPortStatus);
 883
 884         switch (UPS_PORT_LINK_STATE_GET(status)) {
 885         case UPS_PORT_LS_U3:
 886         case UPS_PORT_LS_COMP_MODE:
 887         case UPS_PORT_LS_LOOPBACK:
 888         case UPS_PORT_LS_SS_INA:
 889                 break;
 890         default:
 891                 DPRINTF("Wrong state for warm reset\n");
 892                 return (0);
 893         }
 894
 895         /* clear any leftover warm port reset changes first */
 896         usbd_req_clear_port_feature(udev, mtx,
 897             port, UHF_C_BH_PORT_RESET);
 898
 899         /* set warm port reset */
 900         err = usbd_req_set_port_feature(udev, mtx,
 901             port, UHF_BH_PORT_RESET);
 902         if (err)
 903                 goto done;
 904
 905         n = 0;
 906         while (1) {
 907                 /* wait for the device to recover from reset */
 908                 usb_pause_mtx(mtx, USB_MS_TO_TICKS(usb_port_reset_delay));
 909                 n += usb_port_reset_delay;
 910                 err = usbd_req_get_port_status(udev, mtx, &ps, port);
 911                 if (err)
 912                         goto done;
 913
 914                 status = UGETW(ps.wPortStatus);
 915                 change = UGETW(ps.wPortChange);
 916
 917                 /* if the device disappeared, just give up */
 918                 if (!(status & UPS_CURRENT_CONNECT_STATUS))
 919                         goto done;
 920
 921                 /* check if reset is complete */
 922                 if (change & UPS_C_BH_PORT_RESET)
 923                         break;
 924
 925                 /* check for timeout */
 926                 if (n > 1000) {
 927                         n = 0;
 928                         break;
 929                 }
 930         }
 931
 932         /* clear port reset first */
 933         err = usbd_req_clear_port_feature(
 934             udev, mtx, port, UHF_C_BH_PORT_RESET);
 935         if (err)
 936                 goto done;
 937
 938         /* check for timeout */
 939         if (n == 0) {
 940                 err = USB_ERR_TIMEOUT;
 941                 goto done;
 942         }
 943         /* wait for the device to recover from reset */
 944         usb_pause_mtx(mtx, USB_MS_TO_TICKS(usb_port_reset_recovery));
 945
 946 done:
 947         DPRINTFN(2, "port %d warm reset returning error=%s\n",
 948             port, usbd_errstr(err));
 949         return (err);
 950 }
 951
 952 /*------------------------------------------------------------------------*
 953  *      usbd_req_get_desc
 954  *
 955  * This function can be used to retrieve USB descriptors. It contains
 956  * some additional logic like zeroing of missing descriptor bytes and
 957  * retrying an USB descriptor in case of failure. The "min_len"
 958  * argument specifies the minimum descriptor length. The "max_len"
 959  * argument specifies the maximum descriptor length. If the real
 960  * descriptor length is less than the minimum length the missing
 961  * byte(s) will be zeroed. The type field, the second byte of the USB
 962  * descriptor, will get forced to the correct type. If the "actlen"
 963  * pointer is non-NULL, the actual length of the transfer will get
 964  * stored in the 16-bit unsigned integer which it is pointing to. The
 965  * first byte of the descriptor will not get updated. If the "actlen"
 966  * pointer is NULL the first byte of the descriptor will get updated
 967  * to reflect the actual length instead. If "min_len" is not equal to
 968  * "max_len" then this function will try to retrive the beginning of
 969  * the descriptor and base the maximum length on the first byte of the
 970  * descriptor.
 971  *
 972  * Returns:
 973  *    0: Success
 974  * Else: Failure
 975  *------------------------------------------------------------------------*/
 976 usb_error_t
 977 usbd_req_get_desc(struct usb_device *udev,
 978     struct mtx *mtx, uint16_t *actlen, void *desc,
 979     uint16_t min_len, uint16_t max_len,
 980     uint16_t id, uint8_t type, uint8_t index,
 981     uint8_t retries)
 982 {
 983         struct usb_device_request req;
 984         uint8_t *buf;
 985         usb_error_t err;
 986
 987         DPRINTFN(4, "id=%d, type=%d, index=%d, max_len=%d\n",
 988             id, type, index, max_len);
 989
 990         req.bmRequestType = UT_READ_DEVICE;
 991         req.bRequest = UR_GET_DESCRIPTOR;
 992         USETW2(req.wValue, type, index);
 993         USETW(req.wIndex, id);
 994
 995         while (1) {
 996
 997                 if ((min_len < 2) || (max_len < 2)) {
 998                         err = USB_ERR_INVAL;
 999                         goto done;
1000                 }
1001                 USETW(req.wLength, min_len);
1002
1003                 err = usbd_do_request_flags(udev, mtx, &req,
1004                     desc, 0, NULL, 500 /* ms */);
1005
1006                 if (err) {
1007                         if (!retries) {
1008                                 goto done;
1009                         }
1010                         retries--;
1011
1012                         usb_pause_mtx(mtx, hz / 5);
1013
1014                         continue;
1015                 }
1016                 buf = desc;
1017
1018                 if (min_len == max_len) {
1019
1020                         /* enforce correct length */
1021                         if ((buf[0] > min_len) && (actlen == NULL))
1022                                 buf[0] = min_len;
1023
1024                         /* enforce correct type */
1025                         buf[1] = type;
1026
1027                         goto done;
1028                 }
1029                 /* range check */
1030
1031                 if (max_len > buf[0]) {
1032                         max_len = buf[0];
1033                 }
1034                 /* zero minimum data */
1035
1036                 while (min_len > max_len) {
1037                         min_len--;
1038                         buf[min_len] = 0;
1039                 }
1040
1041                 /* set new minimum length */
1042
1043                 min_len = max_len;
1044         }
1045 done:
1046         if (actlen != NULL) {
1047                 if (err)
1048                         *actlen = 0;
1049                 else
1050                         *actlen = min_len;
1051         }
1052         return (err);
1053 }
1054
1055 /*------------------------------------------------------------------------*
1056  *      usbd_req_get_string_any
1057  *
1058  * This function will return the string given by "string_index"
1059  * using the first language ID. The maximum length "len" includes
1060  * the terminating zero. The "len" argument should be twice as
1061  * big pluss 2 bytes, compared with the actual maximum string length !
1062  *
1063  * Returns:
1064  *    0: Success
1065  * Else: Failure
1066  *------------------------------------------------------------------------*/
1067 usb_error_t
1068 usbd_req_get_string_any(struct usb_device *udev, struct mtx *mtx, char *buf,
1069     uint16_t len, uint8_t string_index)
1070 {
1071         char *s;
1072         uint8_t *temp;
1073         uint16_t i;
1074         uint16_t n;
1075         uint16_t c;
1076         uint8_t swap;
1077         usb_error_t err;
1078
1079         if (len == 0) {
1080                 /* should not happen */
1081                 return (USB_ERR_NORMAL_COMPLETION);
1082         }
1083         if (string_index == 0) {
1084                 /* this is the language table */
1085                 buf[0] = 0;
1086                 return (USB_ERR_INVAL);
1087         }
1088         if (udev->flags.no_strings) {
1089                 buf[0] = 0;
1090                 return (USB_ERR_STALLED);
1091         }
1092         err = usbd_req_get_string_desc
1093             (udev, mtx, buf, len, udev->langid, string_index);
1094         if (err) {
1095                 buf[0] = 0;
1096                 return (err);
1097         }
1098         temp = (uint8_t *)buf;
1099
1100         if (temp[0] < 2) {
1101                 /* string length is too short */
1102                 buf[0] = 0;
1103                 return (USB_ERR_INVAL);
1104         }
1105         /* reserve one byte for terminating zero */
1106         len--;
1107
1108         /* find maximum length */
1109         s = buf;
1110         n = (temp[0] / 2) - 1;
1111         if (n > len) {
1112                 n = len;
1113         }
1114         /* skip descriptor header */
1115         temp += 2;
1116
1117         /* reset swap state */
1118         swap = 3;
1119
1120         /* convert and filter */
1121         for (i = 0; (i != n); i++) {
1122                 c = UGETW(temp + (2 * i));
1123
1124                 /* convert from Unicode, handle buggy strings */
1125                 if (((c & 0xff00) == 0) && (swap & 1)) {
1126                         /* Little Endian, default */
1127                         *s = c;
1128                         swap = 1;
1129                 } else if (((c & 0x00ff) == 0) && (swap & 2)) {
1130                         /* Big Endian */
1131                         *s = c >> 8;
1132                         swap = 2;
1133                 } else {
1134                         /* silently skip bad character */
1135                         continue;
1136                 }
1137
1138                 /*
1139                  * Filter by default - We only allow alphanumerical
1140                  * and a few more to avoid any problems with scripts
1141                  * and daemons.
1142                  */
1143                 if (isalpha(*s) ||
1144                     isdigit(*s) ||
1145                     *s == '-' ||
1146                     *s == '+' ||
1147                     *s == ' ' ||
1148                     *s == '.' ||
1149                     *s == ',') {
1150                         /* allowed */
1151                         s++;
1152                 }
1153                 /* silently skip bad character */
1154         }
1155         *s = 0;                         /* zero terminate resulting string */
1156         return (USB_ERR_NORMAL_COMPLETION);
1157 }
1158
1159 /*------------------------------------------------------------------------*
1160  *      usbd_req_get_string_desc
1161  *
1162  * If you don't know the language ID, consider using
1163  * "usbd_req_get_string_any()".
1164  *
1165  * Returns:
1166  *    0: Success
1167  * Else: Failure
1168  *------------------------------------------------------------------------*/
1169 usb_error_t
1170 usbd_req_get_string_desc(struct usb_device *udev, struct mtx *mtx, void *sdesc,
1171     uint16_t max_len, uint16_t lang_id,
1172     uint8_t string_index)
1173 {
1174         return (usbd_req_get_desc(udev, mtx, NULL, sdesc, 2, max_len, lang_id,
1175             UDESC_STRING, string_index, 0));
1176 }
1177
1178 /*------------------------------------------------------------------------*
1179  *      usbd_req_get_config_desc_ptr
1180  *
1181  * This function is used in device side mode to retrieve the pointer
1182  * to the generated config descriptor. This saves allocating space for
1183  * an additional config descriptor when setting the configuration.
1184  *
1185  * Returns:
1186  *    0: Success
1187  * Else: Failure
1188  *------------------------------------------------------------------------*/
1189 usb_error_t
1190 usbd_req_get_descriptor_ptr(struct usb_device *udev,
1191     struct usb_config_descriptor **ppcd, uint16_t wValue)
1192 {
1193         struct usb_device_request req;
1194         usb_handle_req_t *hr_func;
1195         const void *ptr;
1196         uint16_t len;
1197         usb_error_t err;
1198
1199         req.bmRequestType = UT_READ_DEVICE;
1200         req.bRequest = UR_GET_DESCRIPTOR;
1201         USETW(req.wValue, wValue);
1202         USETW(req.wIndex, 0);
1203         USETW(req.wLength, 0);
1204
1205         ptr = NULL;
1206         len = 0;
1207
1208         hr_func = usbd_get_hr_func(udev);
1209
1210         if (hr_func == NULL)
1211                 err = USB_ERR_INVAL;
1212         else {
1213                 USB_BUS_LOCK(udev->bus);
1214                 err = (hr_func) (udev, &req, &ptr, &len);
1215                 USB_BUS_UNLOCK(udev->bus);
1216         }
1217
1218         if (err)
1219                 ptr = NULL;
1220         else if (ptr == NULL)
1221                 err = USB_ERR_INVAL;
1222
1223         *ppcd = __DECONST(struct usb_config_descriptor *, ptr);
1224
1225         return (err);
1226 }
1227
1228 /*------------------------------------------------------------------------*
1229  *      usbd_req_get_config_desc
1230  *
1231  * Returns:
1232  *    0: Success
1233  * Else: Failure
1234  *------------------------------------------------------------------------*/
1235 usb_error_t
1236 usbd_req_get_config_desc(struct usb_device *udev, struct mtx *mtx,
1237     struct usb_config_descriptor *d, uint8_t conf_index)
1238 {
1239         usb_error_t err;
1240
1241         DPRINTFN(4, "confidx=%d\n", conf_index);
1242
1243         err = usbd_req_get_desc(udev, mtx, NULL, d, sizeof(*d),
1244             sizeof(*d), 0, UDESC_CONFIG, conf_index, 0);
1245         if (err) {
1246                 goto done;
1247         }
1248         /* Extra sanity checking */
1249         if (UGETW(d->wTotalLength) < (uint16_t)sizeof(*d)) {
1250                 err = USB_ERR_INVAL;
1251         }
1252 done:
1253         return (err);
1254 }
1255
1256 /*------------------------------------------------------------------------*
1257  *      usbd_req_get_config_desc_full
1258  *
1259  * This function gets the complete USB configuration descriptor and
1260  * ensures that "wTotalLength" is correct.
1261  *
1262  * Returns:
1263  *    0: Success
1264  * Else: Failure
1265  *------------------------------------------------------------------------*/
1266 usb_error_t
1267 usbd_req_get_config_desc_full(struct usb_device *udev, struct mtx *mtx,
1268     struct usb_config_descriptor **ppcd, struct malloc_type *mtype,
1269     uint8_t index)
1270 {
1271         struct usb_config_descriptor cd;
1272         struct usb_config_descriptor *cdesc;
1273         uint16_t len;
1274         usb_error_t err;
1275
1276         DPRINTFN(4, "index=%d\n", index);
1277
1278         *ppcd = NULL;
1279
1280         err = usbd_req_get_config_desc(udev, mtx, &cd, index);
1281         if (err) {
1282                 return (err);
1283         }
1284         /* get full descriptor */
1285         len = UGETW(cd.wTotalLength);
1286         if (len < sizeof(*cdesc)) {
1287                 /* corrupt descriptor */
1288                 return (USB_ERR_INVAL);
1289         }
1290         cdesc = malloc(len, mtype, M_WAITOK);
1291         if (cdesc == NULL) {
1292                 return (USB_ERR_NOMEM);
1293         }
1294         err = usbd_req_get_desc(udev, mtx, NULL, cdesc, len, len, 0,
1295             UDESC_CONFIG, index, 3);
1296         if (err) {
1297                 free(cdesc, mtype);
1298                 return (err);
1299         }
1300         /* make sure that the device is not fooling us: */
1301         USETW(cdesc->wTotalLength, len);
1302
1303         *ppcd = cdesc;
1304
1305         return (0);                     /* success */
1306 }
1307
1308 /*------------------------------------------------------------------------*
1309  *      usbd_req_get_device_desc
1310  *
1311  * Returns:
1312  *    0: Success
1313  * Else: Failure
1314  *------------------------------------------------------------------------*/
1315 usb_error_t
1316 usbd_req_get_device_desc(struct usb_device *udev, struct mtx *mtx,
1317     struct usb_device_descriptor *d)
1318 {
1319         DPRINTFN(4, "\n");
1320         return (usbd_req_get_desc(udev, mtx, NULL, d, sizeof(*d),
1321             sizeof(*d), 0, UDESC_DEVICE, 0, 3));
1322 }
1323
1324 /*------------------------------------------------------------------------*
1325  *      usbd_req_get_alt_interface_no
1326  *
1327  * Returns:
1328  *    0: Success
1329  * Else: Failure
1330  *------------------------------------------------------------------------*/
1331 usb_error_t
1332 usbd_req_get_alt_interface_no(struct usb_device *udev, struct mtx *mtx,
1333     uint8_t *alt_iface_no, uint8_t iface_index)
1334 {
1335         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1336         struct usb_device_request req;
1337
1338         if ((iface == NULL) || (iface->idesc == NULL))
1339                 return (USB_ERR_INVAL);
1340
1341         req.bmRequestType = UT_READ_INTERFACE;
1342         req.bRequest = UR_GET_INTERFACE;
1343         USETW(req.wValue, 0);
1344         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1345         req.wIndex[1] = 0;
1346         USETW(req.wLength, 1);
1347         return (usbd_do_request(udev, mtx, &req, alt_iface_no));
1348 }
1349
1350 /*------------------------------------------------------------------------*
1351  *      usbd_req_set_alt_interface_no
1352  *
1353  * Returns:
1354  *    0: Success
1355  * Else: Failure
1356  *------------------------------------------------------------------------*/
1357 usb_error_t
1358 usbd_req_set_alt_interface_no(struct usb_device *udev, struct mtx *mtx,
1359     uint8_t iface_index, uint8_t alt_no)
1360 {
1361         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1362         struct usb_device_request req;
1363
1364         if ((iface == NULL) || (iface->idesc == NULL))
1365                 return (USB_ERR_INVAL);
1366
1367         req.bmRequestType = UT_WRITE_INTERFACE;
1368         req.bRequest = UR_SET_INTERFACE;
1369         req.wValue[0] = alt_no;
1370         req.wValue[1] = 0;
1371         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1372         req.wIndex[1] = 0;
1373         USETW(req.wLength, 0);
1374         return (usbd_do_request(udev, mtx, &req, 0));
1375 }
1376
1377 /*------------------------------------------------------------------------*
1378  *      usbd_req_get_device_status
1379  *
1380  * Returns:
1381  *    0: Success
1382  * Else: Failure
1383  *------------------------------------------------------------------------*/
1384 usb_error_t
1385 usbd_req_get_device_status(struct usb_device *udev, struct mtx *mtx,
1386     struct usb_status *st)
1387 {
1388         struct usb_device_request req;
1389
1390         req.bmRequestType = UT_READ_DEVICE;
1391         req.bRequest = UR_GET_STATUS;
1392         USETW(req.wValue, 0);
1393         USETW(req.wIndex, 0);
1394         USETW(req.wLength, sizeof(*st));
1395         return (usbd_do_request(udev, mtx, &req, st));
1396 }
1397
1398 /*------------------------------------------------------------------------*
1399  *      usbd_req_get_hub_descriptor
1400  *
1401  * Returns:
1402  *    0: Success
1403  * Else: Failure
1404  *------------------------------------------------------------------------*/
1405 usb_error_t
1406 usbd_req_get_hub_descriptor(struct usb_device *udev, struct mtx *mtx,
1407     struct usb_hub_descriptor *hd, uint8_t nports)
1408 {
1409         struct usb_device_request req;
1410         uint16_t len = (nports + 7 + (8 * 8)) / 8;
1411
1412         req.bmRequestType = UT_READ_CLASS_DEVICE;
1413         req.bRequest = UR_GET_DESCRIPTOR;
1414         USETW2(req.wValue, UDESC_HUB, 0);
1415         USETW(req.wIndex, 0);
1416         USETW(req.wLength, len);
1417         return (usbd_do_request(udev, mtx, &req, hd));
1418 }
1419
1420 /*------------------------------------------------------------------------*
1421  *      usbd_req_get_ss_hub_descriptor
1422  *
1423  * Returns:
1424  *    0: Success
1425  * Else: Failure
1426  *------------------------------------------------------------------------*/
1427 usb_error_t
1428 usbd_req_get_ss_hub_descriptor(struct usb_device *udev, struct mtx *mtx,
1429     struct usb_hub_ss_descriptor *hd, uint8_t nports)
1430 {
1431         struct usb_device_request req;
1432         uint16_t len = sizeof(*hd) - 32 + 1 + ((nports + 7) / 8);
1433
1434         req.bmRequestType = UT_READ_CLASS_DEVICE;
1435         req.bRequest = UR_GET_DESCRIPTOR;
1436         USETW2(req.wValue, UDESC_SS_HUB, 0);
1437         USETW(req.wIndex, 0);
1438         USETW(req.wLength, len);
1439         return (usbd_do_request(udev, mtx, &req, hd));
1440 }
1441
1442 /*------------------------------------------------------------------------*
1443  *      usbd_req_get_hub_status
1444  *
1445  * Returns:
1446  *    0: Success
1447  * Else: Failure
1448  *------------------------------------------------------------------------*/
1449 usb_error_t
1450 usbd_req_get_hub_status(struct usb_device *udev, struct mtx *mtx,
1451     struct usb_hub_status *st)
1452 {
1453         struct usb_device_request req;
1454
1455         req.bmRequestType = UT_READ_CLASS_DEVICE;
1456         req.bRequest = UR_GET_STATUS;
1457         USETW(req.wValue, 0);
1458         USETW(req.wIndex, 0);
1459         USETW(req.wLength, sizeof(struct usb_hub_status));
1460         return (usbd_do_request(udev, mtx, &req, st));
1461 }
1462
1463 /*------------------------------------------------------------------------*
1464  *      usbd_req_set_address
1465  *
1466  * This function is used to set the address for an USB device. After
1467  * port reset the USB device will respond at address zero.
1468  *
1469  * Returns:
1470  *    0: Success
1471  * Else: Failure
1472  *------------------------------------------------------------------------*/
1473 usb_error_t
1474 usbd_req_set_address(struct usb_device *udev, struct mtx *mtx, uint16_t addr)
1475 {
1476         struct usb_device_request req;
1477         usb_error_t err;
1478
1479         DPRINTFN(6, "setting device address=%d\n", addr);
1480
1481         req.bmRequestType = UT_WRITE_DEVICE;
1482         req.bRequest = UR_SET_ADDRESS;
1483         USETW(req.wValue, addr);
1484         USETW(req.wIndex, 0);
1485         USETW(req.wLength, 0);
1486
1487         err = USB_ERR_INVAL;
1488
1489         /* check if USB controller handles set address */
1490         if (udev->bus->methods->set_address != NULL)
1491                 err = (udev->bus->methods->set_address) (udev, mtx, addr);
1492
1493         if (err != USB_ERR_INVAL)
1494                 goto done;
1495
1496         /* Setting the address should not take more than 1 second ! */
1497         err = usbd_do_request_flags(udev, mtx, &req, NULL,
1498             USB_DELAY_STATUS_STAGE, NULL, 1000);
1499
1500 done:
1501         /* allow device time to set new address */
1502         usb_pause_mtx(mtx,
1503             USB_MS_TO_TICKS(usb_set_address_settle));
1504
1505         return (err);
1506 }
1507
1508 /*------------------------------------------------------------------------*
1509  *      usbd_req_get_port_status
1510  *
1511  * Returns:
1512  *    0: Success
1513  * Else: Failure
1514  *------------------------------------------------------------------------*/
1515 usb_error_t
1516 usbd_req_get_port_status(struct usb_device *udev, struct mtx *mtx,
1517     struct usb_port_status *ps, uint8_t port)
1518 {
1519         struct usb_device_request req;
1520
1521         req.bmRequestType = UT_READ_CLASS_OTHER;
1522         req.bRequest = UR_GET_STATUS;
1523         USETW(req.wValue, 0);
1524         req.wIndex[0] = port;
1525         req.wIndex[1] = 0;
1526         USETW(req.wLength, sizeof *ps);
1527         return (usbd_do_request(udev, mtx, &req, ps));
1528 }
1529
1530 /*------------------------------------------------------------------------*
1531  *      usbd_req_clear_hub_feature
1532  *
1533  * Returns:
1534  *    0: Success
1535  * Else: Failure
1536  *------------------------------------------------------------------------*/
1537 usb_error_t
1538 usbd_req_clear_hub_feature(struct usb_device *udev, struct mtx *mtx,
1539     uint16_t sel)
1540 {
1541         struct usb_device_request req;
1542
1543         req.bmRequestType = UT_WRITE_CLASS_DEVICE;
1544         req.bRequest = UR_CLEAR_FEATURE;
1545         USETW(req.wValue, sel);
1546         USETW(req.wIndex, 0);
1547         USETW(req.wLength, 0);
1548         return (usbd_do_request(udev, mtx, &req, 0));
1549 }
1550
1551 /*------------------------------------------------------------------------*
1552  *      usbd_req_set_hub_feature
1553  *
1554  * Returns:
1555  *    0: Success
1556  * Else: Failure
1557  *------------------------------------------------------------------------*/
1558 usb_error_t
1559 usbd_req_set_hub_feature(struct usb_device *udev, struct mtx *mtx,
1560     uint16_t sel)
1561 {
1562         struct usb_device_request req;
1563
1564         req.bmRequestType = UT_WRITE_CLASS_DEVICE;
1565         req.bRequest = UR_SET_FEATURE;
1566         USETW(req.wValue, sel);
1567         USETW(req.wIndex, 0);
1568         USETW(req.wLength, 0);
1569         return (usbd_do_request(udev, mtx, &req, 0));
1570 }
1571
1572 /*------------------------------------------------------------------------*
1573  *      usbd_req_set_hub_u1_timeout
1574  *
1575  * Returns:
1576  *    0: Success
1577  * Else: Failure
1578  *------------------------------------------------------------------------*/
1579 usb_error_t
1580 usbd_req_set_hub_u1_timeout(struct usb_device *udev, struct mtx *mtx,
1581     uint8_t port, uint8_t timeout)
1582 {
1583         struct usb_device_request req;
1584
1585         req.bmRequestType = UT_WRITE_CLASS_OTHER;
1586         req.bRequest = UR_SET_FEATURE;
1587         USETW(req.wValue, UHF_PORT_U1_TIMEOUT);
1588         req.wIndex[0] = port;
1589         req.wIndex[1] = timeout;
1590         USETW(req.wLength, 0);
1591         return (usbd_do_request(udev, mtx, &req, 0));
1592 }
1593
1594 /*------------------------------------------------------------------------*
1595  *      usbd_req_set_hub_u2_timeout
1596  *
1597  * Returns:
1598  *    0: Success
1599  * Else: Failure
1600  *------------------------------------------------------------------------*/
1601 usb_error_t
1602 usbd_req_set_hub_u2_timeout(struct usb_device *udev, struct mtx *mtx,
1603     uint8_t port, uint8_t timeout)
1604 {
1605         struct usb_device_request req;
1606
1607         req.bmRequestType = UT_WRITE_CLASS_OTHER;
1608         req.bRequest = UR_SET_FEATURE;
1609         USETW(req.wValue, UHF_PORT_U2_TIMEOUT);
1610         req.wIndex[0] = port;
1611         req.wIndex[1] = timeout;
1612         USETW(req.wLength, 0);
1613         return (usbd_do_request(udev, mtx, &req, 0));
1614 }
1615
1616 /*------------------------------------------------------------------------*
1617  *      usbd_req_set_hub_depth
1618  *
1619  * Returns:
1620  *    0: Success
1621  * Else: Failure
1622  *------------------------------------------------------------------------*/
1623 usb_error_t
1624 usbd_req_set_hub_depth(struct usb_device *udev, struct mtx *mtx,
1625     uint16_t depth)
1626 {
1627         struct usb_device_request req;
1628
1629         req.bmRequestType = UT_WRITE_CLASS_DEVICE;
1630         req.bRequest = UR_SET_HUB_DEPTH;
1631         USETW(req.wValue, depth);
1632         USETW(req.wIndex, 0);
1633         USETW(req.wLength, 0);
1634         return (usbd_do_request(udev, mtx, &req, 0));
1635 }
1636
1637 /*------------------------------------------------------------------------*
1638  *      usbd_req_clear_port_feature
1639  *
1640  * Returns:
1641  *    0: Success
1642  * Else: Failure
1643  *------------------------------------------------------------------------*/
1644 usb_error_t
1645 usbd_req_clear_port_feature(struct usb_device *udev, struct mtx *mtx,
1646     uint8_t port, uint16_t sel)
1647 {
1648         struct usb_device_request req;
1649
1650         req.bmRequestType = UT_WRITE_CLASS_OTHER;
1651         req.bRequest = UR_CLEAR_FEATURE;
1652         USETW(req.wValue, sel);
1653         req.wIndex[0] = port;
1654         req.wIndex[1] = 0;
1655         USETW(req.wLength, 0);
1656         return (usbd_do_request(udev, mtx, &req, 0));
1657 }
1658
1659 /*------------------------------------------------------------------------*
1660  *      usbd_req_set_port_feature
1661  *
1662  * Returns:
1663  *    0: Success
1664  * Else: Failure
1665  *------------------------------------------------------------------------*/
1666 usb_error_t
1667 usbd_req_set_port_feature(struct usb_device *udev, struct mtx *mtx,
1668     uint8_t port, uint16_t sel)
1669 {
1670         struct usb_device_request req;
1671
1672         req.bmRequestType = UT_WRITE_CLASS_OTHER;
1673         req.bRequest = UR_SET_FEATURE;
1674         USETW(req.wValue, sel);
1675         req.wIndex[0] = port;
1676         req.wIndex[1] = 0;
1677         USETW(req.wLength, 0);
1678         return (usbd_do_request(udev, mtx, &req, 0));
1679 }
1680
1681 /*------------------------------------------------------------------------*
1682  *      usbd_req_set_protocol
1683  *
1684  * Returns:
1685  *    0: Success
1686  * Else: Failure
1687  *------------------------------------------------------------------------*/
1688 usb_error_t
1689 usbd_req_set_protocol(struct usb_device *udev, struct mtx *mtx,
1690     uint8_t iface_index, uint16_t report)
1691 {
1692         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1693         struct usb_device_request req;
1694
1695         if ((iface == NULL) || (iface->idesc == NULL)) {
1696                 return (USB_ERR_INVAL);
1697         }
1698         DPRINTFN(5, "iface=%p, report=%d, endpt=%d\n",
1699             iface, report, iface->idesc->bInterfaceNumber);
1700
1701         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1702         req.bRequest = UR_SET_PROTOCOL;
1703         USETW(req.wValue, report);
1704         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1705         req.wIndex[1] = 0;
1706         USETW(req.wLength, 0);
1707         return (usbd_do_request(udev, mtx, &req, 0));
1708 }
1709
1710 /*------------------------------------------------------------------------*
1711  *      usbd_req_set_report
1712  *
1713  * Returns:
1714  *    0: Success
1715  * Else: Failure
1716  *------------------------------------------------------------------------*/
1717 usb_error_t
1718 usbd_req_set_report(struct usb_device *udev, struct mtx *mtx, void *data, uint16_t len,
1719     uint8_t iface_index, uint8_t type, uint8_t id)
1720 {
1721         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1722         struct usb_device_request req;
1723
1724         if ((iface == NULL) || (iface->idesc == NULL)) {
1725                 return (USB_ERR_INVAL);
1726         }
1727         DPRINTFN(5, "len=%d\n", len);
1728
1729         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1730         req.bRequest = UR_SET_REPORT;
1731         USETW2(req.wValue, type, id);
1732         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1733         req.wIndex[1] = 0;
1734         USETW(req.wLength, len);
1735         return (usbd_do_request(udev, mtx, &req, data));
1736 }
1737
1738 /*------------------------------------------------------------------------*
1739  *      usbd_req_get_report
1740  *
1741  * Returns:
1742  *    0: Success
1743  * Else: Failure
1744  *------------------------------------------------------------------------*/
1745 usb_error_t
1746 usbd_req_get_report(struct usb_device *udev, struct mtx *mtx, void *data,
1747     uint16_t len, uint8_t iface_index, uint8_t type, uint8_t id)
1748 {
1749         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1750         struct usb_device_request req;
1751
1752         if ((iface == NULL) || (iface->idesc == NULL)) {
1753                 return (USB_ERR_INVAL);
1754         }
1755         DPRINTFN(5, "len=%d\n", len);
1756
1757         req.bmRequestType = UT_READ_CLASS_INTERFACE;
1758         req.bRequest = UR_GET_REPORT;
1759         USETW2(req.wValue, type, id);
1760         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1761         req.wIndex[1] = 0;
1762         USETW(req.wLength, len);
1763         return (usbd_do_request(udev, mtx, &req, data));
1764 }
1765
1766 /*------------------------------------------------------------------------*
1767  *      usbd_req_set_idle
1768  *
1769  * Returns:
1770  *    0: Success
1771  * Else: Failure
1772  *------------------------------------------------------------------------*/
1773 usb_error_t
1774 usbd_req_set_idle(struct usb_device *udev, struct mtx *mtx,
1775     uint8_t iface_index, uint8_t duration, uint8_t id)
1776 {
1777         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1778         struct usb_device_request req;
1779
1780         if ((iface == NULL) || (iface->idesc == NULL)) {
1781                 return (USB_ERR_INVAL);
1782         }
1783         DPRINTFN(5, "%d %d\n", duration, id);
1784
1785         req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1786         req.bRequest = UR_SET_IDLE;
1787         USETW2(req.wValue, duration, id);
1788         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1789         req.wIndex[1] = 0;
1790         USETW(req.wLength, 0);
1791         return (usbd_do_request(udev, mtx, &req, 0));
1792 }
1793
1794 /*------------------------------------------------------------------------*
1795  *      usbd_req_get_report_descriptor
1796  *
1797  * Returns:
1798  *    0: Success
1799  * Else: Failure
1800  *------------------------------------------------------------------------*/
1801 usb_error_t
1802 usbd_req_get_report_descriptor(struct usb_device *udev, struct mtx *mtx,
1803     void *d, uint16_t size, uint8_t iface_index)
1804 {
1805         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
1806         struct usb_device_request req;
1807
1808         if ((iface == NULL) || (iface->idesc == NULL)) {
1809                 return (USB_ERR_INVAL);
1810         }
1811         req.bmRequestType = UT_READ_INTERFACE;
1812         req.bRequest = UR_GET_DESCRIPTOR;
1813         USETW2(req.wValue, UDESC_REPORT, 0);    /* report id should be 0 */
1814         req.wIndex[0] = iface->idesc->bInterfaceNumber;
1815         req.wIndex[1] = 0;
1816         USETW(req.wLength, size);
1817         return (usbd_do_request(udev, mtx, &req, d));
1818 }
1819
1820 /*------------------------------------------------------------------------*
1821  *      usbd_req_set_config
1822  *
1823  * This function is used to select the current configuration number in
1824  * both USB device side mode and USB host side mode. When setting the
1825  * configuration the function of the interfaces can change.
1826  *
1827  * Returns:
1828  *    0: Success
1829  * Else: Failure
1830  *------------------------------------------------------------------------*/
1831 usb_error_t
1832 usbd_req_set_config(struct usb_device *udev, struct mtx *mtx, uint8_t conf)
1833 {
1834         struct usb_device_request req;
1835
1836         DPRINTF("setting config %d\n", conf);
1837
1838         /* do "set configuration" request */
1839
1840         req.bmRequestType = UT_WRITE_DEVICE;
1841         req.bRequest = UR_SET_CONFIG;
1842         req.wValue[0] = conf;
1843         req.wValue[1] = 0;
1844         USETW(req.wIndex, 0);
1845         USETW(req.wLength, 0);
1846         return (usbd_do_request(udev, mtx, &req, 0));
1847 }
1848
1849 /*------------------------------------------------------------------------*
1850  *      usbd_req_get_config
1851  *
1852  * Returns:
1853  *    0: Success
1854  * Else: Failure
1855  *------------------------------------------------------------------------*/
1856 usb_error_t
1857 usbd_req_get_config(struct usb_device *udev, struct mtx *mtx, uint8_t *pconf)
1858 {
1859         struct usb_device_request req;
1860
1861         req.bmRequestType = UT_READ_DEVICE;
1862         req.bRequest = UR_GET_CONFIG;
1863         USETW(req.wValue, 0);
1864         USETW(req.wIndex, 0);
1865         USETW(req.wLength, 1);
1866         return (usbd_do_request(udev, mtx, &req, pconf));
1867 }
1868
1869 /*------------------------------------------------------------------------*
1870  *      usbd_setup_device_desc
1871  *------------------------------------------------------------------------*/
1872 usb_error_t
1873 usbd_setup_device_desc(struct usb_device *udev, struct mtx *mtx)
1874 {
1875         usb_error_t err;
1876
1877         /*
1878          * Get the first 8 bytes of the device descriptor !
1879          *
1880          * NOTE: "usbd_do_request()" will check the device descriptor
1881          * next time we do a request to see if the maximum packet size
1882          * changed! The 8 first bytes of the device descriptor
1883          * contains the maximum packet size to use on control endpoint
1884          * 0. If this value is different from "USB_MAX_IPACKET" a new
1885          * USB control request will be setup!
1886          */
1887         switch (udev->speed) {
1888         case USB_SPEED_FULL:
1889                 if (usb_full_ddesc != 0) {
1890                         /* get full device descriptor */
1891                         err = usbd_req_get_device_desc(udev, mtx, &udev->ddesc);
1892                         if (err == 0)
1893                                 break;
1894                 }
1895
1896                 /* get partial device descriptor, some devices crash on this */
1897                 err = usbd_req_get_desc(udev, mtx, NULL, &udev->ddesc,
1898                     USB_MAX_IPACKET, USB_MAX_IPACKET, 0, UDESC_DEVICE, 0, 0);
1899                 if (err != 0)
1900                         break;
1901
1902                 /* get the full device descriptor */
1903                 err = usbd_req_get_device_desc(udev, mtx, &udev->ddesc);
1904                 break;
1905
1906         default:
1907                 DPRINTF("Minimum MaxPacketSize is large enough "
1908                     "to hold the complete device descriptor or "
1909                     "only once MaxPacketSize choice\n");
1910
1911                 /* get the full device descriptor */
1912                 err = usbd_req_get_device_desc(udev, mtx, &udev->ddesc);
1913
1914                 /* try one more time, if error */
1915                 if (err != 0)
1916                         err = usbd_req_get_device_desc(udev, mtx, &udev->ddesc);
1917                 break;
1918         }
1919
1920         if (err != 0) {
1921                 DPRINTFN(0, "getting device descriptor "
1922                     "at addr %d failed, %s\n", udev->address,
1923                     usbd_errstr(err));
1924                 return (err);
1925         }
1926
1927         DPRINTF("adding unit addr=%d, rev=%02x, class=%d, "
1928             "subclass=%d, protocol=%d, maxpacket=%d, len=%d, speed=%d\n",
1929             udev->address, UGETW(udev->ddesc.bcdUSB),
1930             udev->ddesc.bDeviceClass,
1931             udev->ddesc.bDeviceSubClass,
1932             udev->ddesc.bDeviceProtocol,
1933             udev->ddesc.bMaxPacketSize,
1934             udev->ddesc.bLength,
1935             udev->speed);
1936
1937         return (err);
1938 }
1939
1940 /*------------------------------------------------------------------------*
1941  *      usbd_req_re_enumerate
1942  *
1943  * NOTE: After this function returns the hardware is in the
1944  * unconfigured state! The application is responsible for setting a
1945  * new configuration.
1946  *
1947  * Returns:
1948  *    0: Success
1949  * Else: Failure
1950  *------------------------------------------------------------------------*/
1951 usb_error_t
1952 usbd_req_re_enumerate(struct usb_device *udev, struct mtx *mtx)
1953 {
1954         struct usb_device *parent_hub;
1955         usb_error_t err;
1956         uint8_t old_addr;
1957         uint8_t do_retry = 1;
1958
1959         if (udev->flags.usb_mode != USB_MODE_HOST) {
1960                 return (USB_ERR_INVAL);
1961         }
1962         old_addr = udev->address;
1963         parent_hub = udev->parent_hub;
1964         if (parent_hub == NULL) {
1965                 return (USB_ERR_INVAL);
1966         }
1967 retry:
1968 #if USB_HAVE_TT_SUPPORT
1969         /*
1970          * Try to reset the High Speed parent HUB of a LOW- or FULL-
1971          * speed device, if any.
1972          */
1973         if (udev->parent_hs_hub != NULL &&
1974             udev->speed != USB_SPEED_HIGH) {
1975                 DPRINTF("Trying to reset parent High Speed TT.\n");
1976                 if (udev->parent_hs_hub == parent_hub &&
1977                     (uhub_count_active_host_ports(parent_hub, USB_SPEED_LOW) +
1978                      uhub_count_active_host_ports(parent_hub, USB_SPEED_FULL)) == 1) {
1979                         /* we can reset the whole TT */
1980                         err = usbd_req_reset_tt(parent_hub, NULL,
1981                             udev->hs_port_no);
1982                 } else {
1983                         /* only reset a particular device and endpoint */
1984                         err = usbd_req_clear_tt_buffer(udev->parent_hs_hub, NULL,
1985                             udev->hs_port_no, old_addr, UE_CONTROL, 0);
1986                 }
1987                 if (err) {
1988                         DPRINTF("Resetting parent High "
1989                             "Speed TT failed (%s).\n",
1990                             usbd_errstr(err));
1991                 }
1992         }
1993 #endif
1994         /* Try to warm reset first */
1995         if (parent_hub->speed == USB_SPEED_SUPER)
1996                 usbd_req_warm_reset_port(parent_hub, mtx, udev->port_no);
1997
1998         /* Try to reset the parent HUB port. */
1999         err = usbd_req_reset_port(parent_hub, mtx, udev->port_no);
2000         if (err) {
2001                 DPRINTFN(0, "addr=%d, port reset failed, %s\n",
2002                     old_addr, usbd_errstr(err));
2003                 goto done;
2004         }
2005
2006         /*
2007          * After that the port has been reset our device should be at
2008          * address zero:
2009          */
2010         udev->address = USB_START_ADDR;
2011
2012         /* reset "bMaxPacketSize" */
2013         udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
2014
2015         /* reset USB state */
2016         usb_set_device_state(udev, USB_STATE_POWERED);
2017
2018         /*
2019          * Restore device address:
2020          */
2021         err = usbd_req_set_address(udev, mtx, old_addr);
2022         if (err) {
2023                 /* XXX ignore any errors! */
2024                 DPRINTFN(0, "addr=%d, set address failed! (%s, ignored)\n",
2025                     old_addr, usbd_errstr(err));
2026         }
2027         /*
2028          * Restore device address, if the controller driver did not
2029          * set a new one:
2030          */
2031         if (udev->address == USB_START_ADDR)
2032                 udev->address = old_addr;
2033
2034         /* setup the device descriptor and the initial "wMaxPacketSize" */
2035         err = usbd_setup_device_desc(udev, mtx);
2036
2037 done:
2038         if (err && do_retry) {
2039                 /* give the USB firmware some time to load */
2040                 usb_pause_mtx(mtx, hz / 2);
2041                 /* no more retries after this retry */
2042                 do_retry = 0;
2043                 /* try again */
2044                 goto retry;
2045         }
2046         /* restore address */
2047         if (udev->address == USB_START_ADDR)
2048                 udev->address = old_addr;
2049         /* update state, if successful */
2050         if (err == 0)
2051                 usb_set_device_state(udev, USB_STATE_ADDRESSED);
2052         return (err);
2053 }
2054
2055 /*------------------------------------------------------------------------*
2056  *      usbd_req_clear_device_feature
2057  *
2058  * Returns:
2059  *    0: Success
2060  * Else: Failure
2061  *------------------------------------------------------------------------*/
2062 usb_error_t
2063 usbd_req_clear_device_feature(struct usb_device *udev, struct mtx *mtx,
2064     uint16_t sel)
2065 {
2066         struct usb_device_request req;
2067
2068         req.bmRequestType = UT_WRITE_DEVICE;
2069         req.bRequest = UR_CLEAR_FEATURE;
2070         USETW(req.wValue, sel);
2071         USETW(req.wIndex, 0);
2072         USETW(req.wLength, 0);
2073         return (usbd_do_request(udev, mtx, &req, 0));
2074 }
2075
2076 /*------------------------------------------------------------------------*
2077  *      usbd_req_set_device_feature
2078  *
2079  * Returns:
2080  *    0: Success
2081  * Else: Failure
2082  *------------------------------------------------------------------------*/
2083 usb_error_t
2084 usbd_req_set_device_feature(struct usb_device *udev, struct mtx *mtx,
2085     uint16_t sel)
2086 {
2087         struct usb_device_request req;
2088
2089         req.bmRequestType = UT_WRITE_DEVICE;
2090         req.bRequest = UR_SET_FEATURE;
2091         USETW(req.wValue, sel);
2092         USETW(req.wIndex, 0);
2093         USETW(req.wLength, 0);
2094         return (usbd_do_request(udev, mtx, &req, 0));
2095 }
2096
2097 /*------------------------------------------------------------------------*
2098  *      usbd_req_reset_tt
2099  *
2100  * Returns:
2101  *    0: Success
2102  * Else: Failure
2103  *------------------------------------------------------------------------*/
2104 usb_error_t
2105 usbd_req_reset_tt(struct usb_device *udev, struct mtx *mtx,
2106     uint8_t port)
2107 {
2108         struct usb_device_request req;
2109
2110         /* For single TT HUBs the port should be 1 */
2111
2112         if (udev->ddesc.bDeviceClass == UDCLASS_HUB &&
2113             udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBSTT)
2114                 port = 1;
2115
2116         req.bmRequestType = UT_WRITE_CLASS_OTHER;
2117         req.bRequest = UR_RESET_TT;
2118         USETW(req.wValue, 0);
2119         req.wIndex[0] = port;
2120         req.wIndex[1] = 0;
2121         USETW(req.wLength, 0);
2122         return (usbd_do_request(udev, mtx, &req, 0));
2123 }
2124
2125 /*------------------------------------------------------------------------*
2126  *      usbd_req_clear_tt_buffer
2127  *
2128  * For single TT HUBs the port should be 1.
2129  *
2130  * Returns:
2131  *    0: Success
2132  * Else: Failure
2133  *------------------------------------------------------------------------*/
2134 usb_error_t
2135 usbd_req_clear_tt_buffer(struct usb_device *udev, struct mtx *mtx,
2136     uint8_t port, uint8_t addr, uint8_t type, uint8_t endpoint)
2137 {
2138         struct usb_device_request req;
2139         uint16_t wValue;
2140
2141         /* For single TT HUBs the port should be 1 */
2142
2143         if (udev->ddesc.bDeviceClass == UDCLASS_HUB &&
2144             udev->ddesc.bDeviceProtocol == UDPROTO_HSHUBSTT)
2145                 port = 1;
2146
2147         wValue = (endpoint & 0xF) | ((addr & 0x7F) << 4) |
2148             ((endpoint & 0x80) << 8) | ((type & 3) << 12);
2149
2150         req.bmRequestType = UT_WRITE_CLASS_OTHER;
2151         req.bRequest = UR_CLEAR_TT_BUFFER;
2152         USETW(req.wValue, wValue);
2153         req.wIndex[0] = port;
2154         req.wIndex[1] = 0;
2155         USETW(req.wLength, 0);
2156         return (usbd_do_request(udev, mtx, &req, 0));
2157 }
2158
2159 /*------------------------------------------------------------------------*
2160  *      usbd_req_set_port_link_state
2161  *
2162  * USB 3.0 specific request
2163  *
2164  * Returns:
2165  *    0: Success
2166  * Else: Failure
2167  *------------------------------------------------------------------------*/
2168 usb_error_t
2169 usbd_req_set_port_link_state(struct usb_device *udev, struct mtx *mtx,
2170     uint8_t port, uint8_t link_state)
2171 {
2172         struct usb_device_request req;
2173
2174         req.bmRequestType = UT_WRITE_CLASS_OTHER;
2175         req.bRequest = UR_SET_FEATURE;
2176         USETW(req.wValue, UHF_PORT_LINK_STATE);
2177         req.wIndex[0] = port;
2178         req.wIndex[1] = link_state;
2179         USETW(req.wLength, 0);
2180         return (usbd_do_request(udev, mtx, &req, 0));
2181 }
2182
2183 /*------------------------------------------------------------------------*
2184  *              usbd_req_set_lpm_info
2185  *
2186  * USB 2.0 specific request for Link Power Management.
2187  *
2188  * Returns:
2189  * 0:                           Success
2190  * USB_ERR_PENDING_REQUESTS:    NYET
2191  * USB_ERR_TIMEOUT:             TIMEOUT
2192  * USB_ERR_STALL:               STALL
2193  * Else:                        Failure
2194  *------------------------------------------------------------------------*/
2195 usb_error_t
2196 usbd_req_set_lpm_info(struct usb_device *udev, struct mtx *mtx,
2197     uint8_t port, uint8_t besl, uint8_t addr, uint8_t rwe)
2198 {
2199         struct usb_device_request req;
2200         usb_error_t err;
2201         uint8_t buf[1];
2202
2203         req.bmRequestType = UT_WRITE_CLASS_OTHER;
2204         req.bRequest = UR_SET_AND_TEST;
2205         USETW(req.wValue, UHF_PORT_L1);
2206         req.wIndex[0] = (port & 0xF) | ((besl & 0xF) << 4);
2207         req.wIndex[1] = (addr & 0x7F) | (rwe ? 0x80 : 0x00);
2208         USETW(req.wLength, sizeof(buf));
2209
2210         /* set default value in case of short transfer */
2211         buf[0] = 0x00;
2212
2213         err = usbd_do_request(udev, mtx, &req, buf);
2214         if (err)
2215                 return (err);
2216
2217         switch (buf[0]) {
2218         case 0x00:      /* SUCCESS */
2219                 break;
2220         case 0x10:      /* NYET */
2221                 err = USB_ERR_PENDING_REQUESTS;
2222                 break;
2223         case 0x11:      /* TIMEOUT */
2224                 err = USB_ERR_TIMEOUT;
2225                 break;
2226         case 0x30:      /* STALL */
2227                 err = USB_ERR_STALLED;
2228                 break;
2229         default:        /* reserved */
2230                 err = USB_ERR_IOERROR;
2231                 break;
2232         }
2233         return (err);
2234 }
2235