sys/dev/usb/usb_device.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 #ifdef USB_GLOBAL_INCLUDE_FILE
  28 #include USB_GLOBAL_INCLUDE_FILE
  29 #else
  30 #include <sys/stdint.h>
  31 #include <sys/stddef.h>
  32 #include <sys/param.h>
  33 #include <sys/queue.h>
  34 #include <sys/types.h>
  35 #include <sys/systm.h>
  36 #include <sys/kernel.h>
  37 #include <sys/bus.h>
  38 #include <sys/module.h>
  39 #include <sys/lock.h>
  40 #include <sys/mutex.h>
  41 #include <sys/condvar.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/sx.h>
  44 #include <sys/unistd.h>
  45 #include <sys/callout.h>
  46 #include <sys/malloc.h>
  47 #include <sys/priv.h>
  48 #include <sys/conf.h>
  49 #include <sys/fcntl.h>
  50
  51 #include <dev/usb/usb.h>
  52 #include <dev/usb/usbdi.h>
  53 #include <dev/usb/usbdi_util.h>
  54 #include <dev/usb/usb_ioctl.h>
  55
  56 #if USB_HAVE_UGEN
  57 #include <sys/sbuf.h>
  58 #endif
  59
  60 #include "usbdevs.h"
  61
  62 #define USB_DEBUG_VAR usb_debug
  63
  64 #include <dev/usb/usb_core.h>
  65 #include <dev/usb/usb_debug.h>
  66 #include <dev/usb/usb_process.h>
  67 #include <dev/usb/usb_device.h>
  68 #include <dev/usb/usb_busdma.h>
  69 #include <dev/usb/usb_transfer.h>
  70 #include <dev/usb/usb_request.h>
  71 #include <dev/usb/usb_dynamic.h>
  72 #include <dev/usb/usb_hub.h>
  73 #include <dev/usb/usb_util.h>
  74 #include <dev/usb/usb_msctest.h>
  75 #if USB_HAVE_UGEN
  76 #include <dev/usb/usb_dev.h>
  77 #include <dev/usb/usb_generic.h>
  78 #endif
  79
  80 #include <dev/usb/quirk/usb_quirk.h>
  81
  82 #include <dev/usb/usb_controller.h>
  83 #include <dev/usb/usb_bus.h>
  84 #endif                  /* USB_GLOBAL_INCLUDE_FILE */
  85
  86 /* function prototypes  */
  87
  88 static void     usb_init_endpoint(struct usb_device *, uint8_t,
  89                     struct usb_endpoint_descriptor *,
  90                     struct usb_endpoint_ss_comp_descriptor *,
  91                     struct usb_endpoint *);
  92 static void     usb_unconfigure(struct usb_device *, uint8_t);
  93 static void     usb_detach_device_sub(struct usb_device *, device_t *,
  94                     char **, uint8_t);
  95 static uint8_t  usb_probe_and_attach_sub(struct usb_device *,
  96                     struct usb_attach_arg *);
  97 static void     usb_init_attach_arg(struct usb_device *,
  98                     struct usb_attach_arg *);
  99 static void     usb_suspend_resume_sub(struct usb_device *, device_t,
 100                     uint8_t);
 101 static usb_proc_callback_t usbd_clear_stall_proc;
 102 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
 103 static void     usbd_set_device_strings(struct usb_device *);
 104 #if USB_HAVE_DEVCTL
 105 static void     usb_notify_addq(const char *type, struct usb_device *);
 106 #endif
 107 #if USB_HAVE_UGEN
 108 static void     usb_fifo_free_wrap(struct usb_device *, uint8_t, uint8_t);
 109 static void     usb_cdev_create(struct usb_device *);
 110 static void     usb_cdev_free(struct usb_device *);
 111 #endif
 112
 113 /* This variable is global to allow easy access to it: */
 114
 115 #ifdef  USB_TEMPLATE
 116 int     usb_template = USB_TEMPLATE;
 117 #else
 118 int     usb_template;
 119 #endif
 120
 121 TUNABLE_INT("hw.usb.usb_template", &usb_template);
 122 SYSCTL_INT(_hw_usb, OID_AUTO, template, CTLFLAG_RW | CTLFLAG_TUN,
 123     &usb_template, 0, "Selected USB device side template");
 124
 125 /* English is default language */
 126
 127 static int usb_lang_id = 0x0009;
 128 static int usb_lang_mask = 0x00FF;
 129
 130 TUNABLE_INT("hw.usb.usb_lang_id", &usb_lang_id);
 131 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_id, CTLFLAG_RW | CTLFLAG_TUN,
 132     &usb_lang_id, 0, "Preferred USB language ID");
 133
 134 TUNABLE_INT("hw.usb.usb_lang_mask", &usb_lang_mask);
 135 SYSCTL_INT(_hw_usb, OID_AUTO, usb_lang_mask, CTLFLAG_RW | CTLFLAG_TUN,
 136     &usb_lang_mask, 0, "Preferred USB language mask");
 137
 138 static const char* statestr[USB_STATE_MAX] = {
 139         [USB_STATE_DETACHED]    = "DETACHED",
 140         [USB_STATE_ATTACHED]    = "ATTACHED",
 141         [USB_STATE_POWERED]     = "POWERED",
 142         [USB_STATE_ADDRESSED]   = "ADDRESSED",
 143         [USB_STATE_CONFIGURED]  = "CONFIGURED",
 144 };
 145
 146 const char *
 147 usb_statestr(enum usb_dev_state state)
 148 {
 149         return ((state < USB_STATE_MAX) ? statestr[state] : "UNKNOWN");
 150 }
 151
 152 const char *
 153 usb_get_manufacturer(struct usb_device *udev)
 154 {
 155         return (udev->manufacturer ? udev->manufacturer : "Unknown");
 156 }
 157
 158 const char *
 159 usb_get_product(struct usb_device *udev)
 160 {
 161         return (udev->product ? udev->product : "");
 162 }
 163
 164 const char *
 165 usb_get_serial(struct usb_device *udev)
 166 {
 167         return (udev->serial ? udev->serial : "");
 168 }
 169
 170 /*------------------------------------------------------------------------*
 171  *      usbd_get_ep_by_addr
 172  *
 173  * This function searches for an USB ep by endpoint address and
 174  * direction.
 175  *
 176  * Returns:
 177  * NULL: Failure
 178  * Else: Success
 179  *------------------------------------------------------------------------*/
 180 struct usb_endpoint *
 181 usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
 182 {
 183         struct usb_endpoint *ep = udev->endpoints;
 184         struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
 185         enum {
 186                 EA_MASK = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR),
 187         };
 188
 189         /*
 190          * According to the USB specification not all bits are used
 191          * for the endpoint address. Keep defined bits only:
 192          */
 193         ea_val &= EA_MASK;
 194
 195         /*
 196          * Iterate accross all the USB endpoints searching for a match
 197          * based on the endpoint address:
 198          */
 199         for (; ep != ep_end; ep++) {
 200
 201                 if (ep->edesc == NULL) {
 202                         continue;
 203                 }
 204                 /* do the mask and check the value */
 205                 if ((ep->edesc->bEndpointAddress & EA_MASK) == ea_val) {
 206                         goto found;
 207                 }
 208         }
 209
 210         /*
 211          * The default endpoint is always present and is checked separately:
 212          */
 213         if ((udev->ctrl_ep.edesc != NULL) &&
 214             ((udev->ctrl_ep.edesc->bEndpointAddress & EA_MASK) == ea_val)) {
 215                 ep = &udev->ctrl_ep;
 216                 goto found;
 217         }
 218         return (NULL);
 219
 220 found:
 221         return (ep);
 222 }
 223
 224 /*------------------------------------------------------------------------*
 225  *      usbd_get_endpoint
 226  *
 227  * This function searches for an USB endpoint based on the information
 228  * given by the passed "struct usb_config" pointer.
 229  *
 230  * Return values:
 231  * NULL: No match.
 232  * Else: Pointer to "struct usb_endpoint".
 233  *------------------------------------------------------------------------*/
 234 struct usb_endpoint *
 235 usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
 236     const struct usb_config *setup)
 237 {
 238         struct usb_endpoint *ep = udev->endpoints;
 239         struct usb_endpoint *ep_end = udev->endpoints + udev->endpoints_max;
 240         uint8_t index = setup->ep_index;
 241         uint8_t ea_mask;
 242         uint8_t ea_val;
 243         uint8_t type_mask;
 244         uint8_t type_val;
 245
 246         DPRINTFN(10, "udev=%p iface_index=%d address=0x%x "
 247             "type=0x%x dir=0x%x index=%d\n",
 248             udev, iface_index, setup->endpoint,
 249             setup->type, setup->direction, setup->ep_index);
 250
 251         /* check USB mode */
 252
 253         if (setup->usb_mode != USB_MODE_DUAL &&
 254             udev->flags.usb_mode != setup->usb_mode) {
 255                 /* wrong mode - no endpoint */
 256                 return (NULL);
 257         }
 258
 259         /* setup expected endpoint direction mask and value */
 260
 261         if (setup->direction == UE_DIR_RX) {
 262                 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
 263                 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
 264                     UE_DIR_OUT : UE_DIR_IN;
 265         } else if (setup->direction == UE_DIR_TX) {
 266                 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
 267                 ea_val = (udev->flags.usb_mode == USB_MODE_DEVICE) ?
 268                     UE_DIR_IN : UE_DIR_OUT;
 269         } else if (setup->direction == UE_DIR_ANY) {
 270                 /* match any endpoint direction */
 271                 ea_mask = 0;
 272                 ea_val = 0;
 273         } else {
 274                 /* match the given endpoint direction */
 275                 ea_mask = (UE_DIR_IN | UE_DIR_OUT);
 276                 ea_val = (setup->direction & (UE_DIR_IN | UE_DIR_OUT));
 277         }
 278
 279         /* setup expected endpoint address */
 280
 281         if (setup->endpoint == UE_ADDR_ANY) {
 282                 /* match any endpoint address */
 283         } else {
 284                 /* match the given endpoint address */
 285                 ea_mask |= UE_ADDR;
 286                 ea_val |= (setup->endpoint & UE_ADDR);
 287         }
 288
 289         /* setup expected endpoint type */
 290
 291         if (setup->type == UE_BULK_INTR) {
 292                 /* this will match BULK and INTERRUPT endpoints */
 293                 type_mask = 2;
 294                 type_val = 2;
 295         } else if (setup->type == UE_TYPE_ANY) {
 296                 /* match any endpoint type */
 297                 type_mask = 0;
 298                 type_val = 0;
 299         } else {
 300                 /* match the given endpoint type */
 301                 type_mask = UE_XFERTYPE;
 302                 type_val = (setup->type & UE_XFERTYPE);
 303         }
 304
 305         /*
 306          * Iterate accross all the USB endpoints searching for a match
 307          * based on the endpoint address. Note that we are searching
 308          * the endpoints from the beginning of the "udev->endpoints" array.
 309          */
 310         for (; ep != ep_end; ep++) {
 311
 312                 if ((ep->edesc == NULL) ||
 313                     (ep->iface_index != iface_index)) {
 314                         continue;
 315                 }
 316                 /* do the masks and check the values */
 317
 318                 if (((ep->edesc->bEndpointAddress & ea_mask) == ea_val) &&
 319                     ((ep->edesc->bmAttributes & type_mask) == type_val)) {
 320                         if (!index--) {
 321                                 goto found;
 322                         }
 323                 }
 324         }
 325
 326         /*
 327          * Match against default endpoint last, so that "any endpoint", "any
 328          * address" and "any direction" returns the first endpoint of the
 329          * interface. "iface_index" and "direction" is ignored:
 330          */
 331         if ((udev->ctrl_ep.edesc != NULL) &&
 332             ((udev->ctrl_ep.edesc->bEndpointAddress & ea_mask) == ea_val) &&
 333             ((udev->ctrl_ep.edesc->bmAttributes & type_mask) == type_val) &&
 334             (!index)) {
 335                 ep = &udev->ctrl_ep;
 336                 goto found;
 337         }
 338         return (NULL);
 339
 340 found:
 341         return (ep);
 342 }
 343
 344 /*------------------------------------------------------------------------*
 345  *      usbd_interface_count
 346  *
 347  * This function stores the number of USB interfaces excluding
 348  * alternate settings, which the USB config descriptor reports into
 349  * the unsigned 8-bit integer pointed to by "count".
 350  *
 351  * Returns:
 352  *    0: Success
 353  * Else: Failure
 354  *------------------------------------------------------------------------*/
 355 usb_error_t
 356 usbd_interface_count(struct usb_device *udev, uint8_t *count)
 357 {
 358         if (udev->cdesc == NULL) {
 359                 *count = 0;
 360                 return (USB_ERR_NOT_CONFIGURED);
 361         }
 362         *count = udev->ifaces_max;
 363         return (USB_ERR_NORMAL_COMPLETION);
 364 }
 365
 366 /*------------------------------------------------------------------------*
 367  *      usb_init_endpoint
 368  *
 369  * This function will initialise the USB endpoint structure pointed to by
 370  * the "endpoint" argument. The structure pointed to by "endpoint" must be
 371  * zeroed before calling this function.
 372  *------------------------------------------------------------------------*/
 373 static void
 374 usb_init_endpoint(struct usb_device *udev, uint8_t iface_index,
 375     struct usb_endpoint_descriptor *edesc,
 376     struct usb_endpoint_ss_comp_descriptor *ecomp,
 377     struct usb_endpoint *ep)
 378 {
 379         struct usb_bus_methods *methods;
 380         usb_stream_t x;
 381
 382         methods = udev->bus->methods;
 383
 384         (methods->endpoint_init) (udev, edesc, ep);
 385
 386         /* initialise USB endpoint structure */
 387         ep->edesc = edesc;
 388         ep->ecomp = ecomp;
 389         ep->iface_index = iface_index;
 390
 391         /* setup USB stream queues */
 392         for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
 393                 TAILQ_INIT(&ep->endpoint_q[x].head);
 394                 ep->endpoint_q[x].command = &usbd_pipe_start;
 395         }
 396
 397         /* the pipe is not supported by the hardware */
 398         if (ep->methods == NULL)
 399                 return;
 400
 401         /* check for SUPER-speed streams mode endpoint */
 402         if (udev->speed == USB_SPEED_SUPER && ecomp != NULL &&
 403             (edesc->bmAttributes & UE_XFERTYPE) == UE_BULK &&
 404             (UE_GET_BULK_STREAMS(ecomp->bmAttributes) != 0)) {
 405                 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_STREAMS);
 406         } else {
 407                 usbd_set_endpoint_mode(udev, ep, USB_EP_MODE_DEFAULT);
 408         }
 409
 410         /* clear stall, if any */
 411         if (methods->clear_stall != NULL) {
 412                 USB_BUS_LOCK(udev->bus);
 413                 (methods->clear_stall) (udev, ep);
 414                 USB_BUS_UNLOCK(udev->bus);
 415         }
 416 }
 417
 418 /*-----------------------------------------------------------------------*
 419  *      usb_endpoint_foreach
 420  *
 421  * This function will iterate all the USB endpoints except the control
 422  * endpoint. This function is NULL safe.
 423  *
 424  * Return values:
 425  * NULL: End of USB endpoints
 426  * Else: Pointer to next USB endpoint
 427  *------------------------------------------------------------------------*/
 428 struct usb_endpoint *
 429 usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep)
 430 {
 431         struct usb_endpoint *ep_end;
 432
 433         /* be NULL safe */
 434         if (udev == NULL)
 435                 return (NULL);
 436
 437         ep_end = udev->endpoints + udev->endpoints_max;
 438
 439         /* get next endpoint */
 440         if (ep == NULL)
 441                 ep = udev->endpoints;
 442         else
 443                 ep++;
 444
 445         /* find next allocated ep */
 446         while (ep != ep_end) {
 447                 if (ep->edesc != NULL)
 448                         return (ep);
 449                 ep++;
 450         }
 451         return (NULL);
 452 }
 453
 454 #if USB_HAVE_UGEN
 455 static uint16_t
 456 usb_get_refcount(struct usb_device *udev)
 457 {
 458         if (usb_proc_is_called_from(USB_BUS_EXPLORE_PROC(udev->bus)) ||
 459             usb_proc_is_called_from(USB_BUS_CONTROL_XFER_PROC(udev->bus)))
 460                 return (1);
 461         return (2);
 462 }
 463 #endif
 464
 465 /*------------------------------------------------------------------------*
 466  *      usb_wait_pending_ref_locked
 467  *
 468  * This function will wait for any USB references to go away before
 469  * returning and disable further USB device refcounting on the
 470  * specified USB device. This function is used when detaching a USB
 471  * device.
 472  *------------------------------------------------------------------------*/
 473 static void
 474 usb_wait_pending_ref_locked(struct usb_device *udev)
 475 {
 476 #if USB_HAVE_UGEN
 477         const uint16_t refcount = usb_get_refcount(udev);
 478
 479         DPRINTF("Refcount = %d\n", (int)refcount);
 480
 481         while (1) {
 482                 /* wait for any pending references to go away */
 483                 mtx_lock(&usb_ref_lock);
 484                 if (udev->refcount == refcount) {
 485                         /* prevent further refs being taken */
 486                         udev->refcount = USB_DEV_REF_MAX;
 487                         mtx_unlock(&usb_ref_lock);
 488                         break;
 489                 }
 490                 usbd_enum_unlock(udev);
 491                 cv_wait(&udev->ref_cv, &usb_ref_lock);
 492                 mtx_unlock(&usb_ref_lock);
 493                 (void) usbd_enum_lock(udev);
 494         }
 495 #endif
 496 }
 497
 498 /*------------------------------------------------------------------------*
 499  *      usb_ref_restore_locked
 500  *
 501  * This function will restore the reference count value after a call
 502  * to "usb_wait_pending_ref_locked()".
 503  *------------------------------------------------------------------------*/
 504 static void
 505 usb_ref_restore_locked(struct usb_device *udev)
 506 {
 507 #if USB_HAVE_UGEN
 508         const uint16_t refcount = usb_get_refcount(udev);
 509
 510         DPRINTF("Refcount = %d\n", (int)refcount);
 511
 512         /* restore reference count and wakeup waiters, if any */
 513         mtx_lock(&usb_ref_lock);
 514         udev->refcount = refcount;
 515         cv_broadcast(&udev->ref_cv);
 516         mtx_unlock(&usb_ref_lock);
 517 #endif
 518 }
 519
 520 /*------------------------------------------------------------------------*
 521  *      usb_unconfigure
 522  *
 523  * This function will free all USB interfaces and USB endpoints belonging
 524  * to an USB device.
 525  *
 526  * Flag values, see "USB_UNCFG_FLAG_XXX".
 527  *------------------------------------------------------------------------*/
 528 static void
 529 usb_unconfigure(struct usb_device *udev, uint8_t flag)
 530 {
 531         uint8_t do_unlock;
 532
 533         /* Prevent re-enumeration */
 534         do_unlock = usbd_enum_lock(udev);
 535
 536         /* detach all interface drivers */
 537         usb_detach_device(udev, USB_IFACE_INDEX_ANY, flag);
 538
 539 #if USB_HAVE_UGEN
 540         /* free all FIFOs except control endpoint FIFOs */
 541         usb_fifo_free_wrap(udev, USB_IFACE_INDEX_ANY, flag);
 542
 543         /*
 544          * Free all cdev's, if any.
 545          */
 546         usb_cdev_free(udev);
 547 #endif
 548
 549 #if USB_HAVE_COMPAT_LINUX
 550         /* free Linux compat device, if any */
 551         if (udev->linux_endpoint_start) {
 552                 usb_linux_free_device(udev);
 553                 udev->linux_endpoint_start = NULL;
 554         }
 555 #endif
 556
 557         usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_FREE);
 558
 559         /* free "cdesc" after "ifaces" and "endpoints", if any */
 560         if (udev->cdesc != NULL) {
 561                 if (udev->flags.usb_mode != USB_MODE_DEVICE)
 562                         usbd_free_config_desc(udev, udev->cdesc);
 563                 udev->cdesc = NULL;
 564         }
 565         /* set unconfigured state */
 566         udev->curr_config_no = USB_UNCONFIG_NO;
 567         udev->curr_config_index = USB_UNCONFIG_INDEX;
 568
 569         if (do_unlock)
 570                 usbd_enum_unlock(udev);
 571 }
 572
 573 /*------------------------------------------------------------------------*
 574  *      usbd_set_config_index
 575  *
 576  * This function selects configuration by index, independent of the
 577  * actual configuration number. This function should not be used by
 578  * USB drivers.
 579  *
 580  * Returns:
 581  *    0: Success
 582  * Else: Failure
 583  *------------------------------------------------------------------------*/
 584 usb_error_t
 585 usbd_set_config_index(struct usb_device *udev, uint8_t index)
 586 {
 587         struct usb_status ds;
 588         struct usb_config_descriptor *cdp;
 589         uint16_t power;
 590         uint16_t max_power;
 591         uint8_t selfpowered;
 592         uint8_t do_unlock;
 593         usb_error_t err;
 594
 595         DPRINTFN(6, "udev=%p index=%d\n", udev, index);
 596
 597         /* Prevent re-enumeration */
 598         do_unlock = usbd_enum_lock(udev);
 599
 600         usb_unconfigure(udev, 0);
 601
 602         if (index == USB_UNCONFIG_INDEX) {
 603                 /*
 604                  * Leave unallocated when unconfiguring the
 605                  * device. "usb_unconfigure()" will also reset
 606                  * the current config number and index.
 607                  */
 608                 err = usbd_req_set_config(udev, NULL, USB_UNCONFIG_NO);
 609                 if (udev->state == USB_STATE_CONFIGURED)
 610                         usb_set_device_state(udev, USB_STATE_ADDRESSED);
 611                 goto done;
 612         }
 613         /* get the full config descriptor */
 614         if (udev->flags.usb_mode == USB_MODE_DEVICE) {
 615                 /* save some memory */
 616                 err = usbd_req_get_descriptor_ptr(udev, &cdp,
 617                     (UDESC_CONFIG << 8) | index);
 618         } else {
 619                 /* normal request */
 620                 err = usbd_req_get_config_desc_full(udev,
 621                     NULL, &cdp, index);
 622         }
 623         if (err) {
 624                 goto done;
 625         }
 626         /* set the new config descriptor */
 627
 628         udev->cdesc = cdp;
 629
 630         /* Figure out if the device is self or bus powered. */
 631         selfpowered = 0;
 632         if ((!udev->flags.uq_bus_powered) &&
 633             (cdp->bmAttributes & UC_SELF_POWERED) &&
 634             (udev->flags.usb_mode == USB_MODE_HOST)) {
 635                 /* May be self powered. */
 636                 if (cdp->bmAttributes & UC_BUS_POWERED) {
 637                         /* Must ask device. */
 638                         err = usbd_req_get_device_status(udev, NULL, &ds);
 639                         if (err) {
 640                                 DPRINTFN(0, "could not read "
 641                                     "device status: %s\n",
 642                                     usbd_errstr(err));
 643                         } else if (UGETW(ds.wStatus) & UDS_SELF_POWERED) {
 644                                 selfpowered = 1;
 645                         }
 646                         DPRINTF("status=0x%04x \n",
 647                                 UGETW(ds.wStatus));
 648                 } else
 649                         selfpowered = 1;
 650         }
 651         DPRINTF("udev=%p cdesc=%p (addr %d) cno=%d attr=0x%02x, "
 652             "selfpowered=%d, power=%d\n",
 653             udev, cdp,
 654             udev->address, cdp->bConfigurationValue, cdp->bmAttributes,
 655             selfpowered, cdp->bMaxPower * 2);
 656
 657         /* Check if we have enough power. */
 658         power = cdp->bMaxPower * 2;
 659
 660         if (udev->parent_hub) {
 661                 max_power = udev->parent_hub->hub->portpower;
 662         } else {
 663                 max_power = USB_MAX_POWER;
 664         }
 665
 666         if (power > max_power) {
 667                 DPRINTFN(0, "power exceeded %d > %d\n", power, max_power);
 668                 err = USB_ERR_NO_POWER;
 669                 goto done;
 670         }
 671         /* Only update "self_powered" in USB Host Mode */
 672         if (udev->flags.usb_mode == USB_MODE_HOST) {
 673                 udev->flags.self_powered = selfpowered;
 674         }
 675         udev->power = power;
 676         udev->curr_config_no = cdp->bConfigurationValue;
 677         udev->curr_config_index = index;
 678         usb_set_device_state(udev, USB_STATE_CONFIGURED);
 679
 680         /* Set the actual configuration value. */
 681         err = usbd_req_set_config(udev, NULL, cdp->bConfigurationValue);
 682         if (err) {
 683                 goto done;
 684         }
 685
 686         err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_ALLOC);
 687         if (err) {
 688                 goto done;
 689         }
 690
 691         err = usb_config_parse(udev, USB_IFACE_INDEX_ANY, USB_CFG_INIT);
 692         if (err) {
 693                 goto done;
 694         }
 695
 696 #if USB_HAVE_UGEN
 697         /* create device nodes for each endpoint */
 698         usb_cdev_create(udev);
 699 #endif
 700
 701 done:
 702         DPRINTF("error=%s\n", usbd_errstr(err));
 703         if (err) {
 704                 usb_unconfigure(udev, 0);
 705         }
 706         if (do_unlock)
 707                 usbd_enum_unlock(udev);
 708         return (err);
 709 }
 710
 711 /*------------------------------------------------------------------------*
 712  *      usb_config_parse
 713  *
 714  * This function will allocate and free USB interfaces and USB endpoints,
 715  * parse the USB configuration structure and initialise the USB endpoints
 716  * and interfaces. If "iface_index" is not equal to
 717  * "USB_IFACE_INDEX_ANY" then the "cmd" parameter is the
 718  * alternate_setting to be selected for the given interface. Else the
 719  * "cmd" parameter is defined by "USB_CFG_XXX". "iface_index" can be
 720  * "USB_IFACE_INDEX_ANY" or a valid USB interface index. This function
 721  * is typically called when setting the configuration or when setting
 722  * an alternate interface.
 723  *
 724  * Returns:
 725  *    0: Success
 726  * Else: Failure
 727  *------------------------------------------------------------------------*/
 728 static usb_error_t
 729 usb_config_parse(struct usb_device *udev, uint8_t iface_index, uint8_t cmd)
 730 {
 731         struct usb_idesc_parse_state ips;
 732         struct usb_interface_descriptor *id;
 733         struct usb_endpoint_descriptor *ed;
 734         struct usb_interface *iface;
 735         struct usb_endpoint *ep;
 736         usb_error_t err;
 737         uint8_t ep_curr;
 738         uint8_t ep_max;
 739         uint8_t temp;
 740         uint8_t do_init;
 741         uint8_t alt_index;
 742
 743         if (iface_index != USB_IFACE_INDEX_ANY) {
 744                 /* parameter overload */
 745                 alt_index = cmd;
 746                 cmd = USB_CFG_INIT;
 747         } else {
 748                 /* not used */
 749                 alt_index = 0;
 750         }
 751
 752         err = 0;
 753
 754         DPRINTFN(5, "iface_index=%d cmd=%d\n",
 755             iface_index, cmd);
 756
 757         if (cmd == USB_CFG_FREE)
 758                 goto cleanup;
 759
 760         if (cmd == USB_CFG_INIT) {
 761                 sx_assert(&udev->enum_sx, SA_LOCKED);
 762
 763                 /* check for in-use endpoints */
 764
 765                 ep = udev->endpoints;
 766                 ep_max = udev->endpoints_max;
 767                 while (ep_max--) {
 768                         /* look for matching endpoints */
 769                         if ((iface_index == USB_IFACE_INDEX_ANY) ||
 770                             (iface_index == ep->iface_index)) {
 771                                 if (ep->refcount_alloc != 0) {
 772                                         /*
 773                                          * This typically indicates a
 774                                          * more serious error.
 775                                          */
 776                                         err = USB_ERR_IN_USE;
 777                                 } else {
 778                                         /* reset endpoint */
 779                                         memset(ep, 0, sizeof(*ep));
 780                                         /* make sure we don't zero the endpoint again */
 781                                         ep->iface_index = USB_IFACE_INDEX_ANY;
 782                                 }
 783                         }
 784                         ep++;
 785                 }
 786
 787                 if (err)
 788                         return (err);
 789         }
 790
 791         memset(&ips, 0, sizeof(ips));
 792
 793         ep_curr = 0;
 794         ep_max = 0;
 795
 796         while ((id = usb_idesc_foreach(udev->cdesc, &ips))) {
 797
 798                 iface = udev->ifaces + ips.iface_index;
 799
 800                 /* check for specific interface match */
 801
 802                 if (cmd == USB_CFG_INIT) {
 803                         if ((iface_index != USB_IFACE_INDEX_ANY) &&
 804                             (iface_index != ips.iface_index)) {
 805                                 /* wrong interface */
 806                                 do_init = 0;
 807                         } else if (alt_index != ips.iface_index_alt) {
 808                                 /* wrong alternate setting */
 809                                 do_init = 0;
 810                         } else {
 811                                 /* initialise interface */
 812                                 do_init = 1;
 813                         }
 814                 } else
 815                         do_init = 0;
 816
 817                 /* check for new interface */
 818                 if (ips.iface_index_alt == 0) {
 819                         /* update current number of endpoints */
 820                         ep_curr = ep_max;
 821                 }
 822                 /* check for init */
 823                 if (do_init) {
 824                         /* setup the USB interface structure */
 825                         iface->idesc = id;
 826                         /* set alternate index */
 827                         iface->alt_index = alt_index;
 828                         /* set default interface parent */
 829                         if (iface_index == USB_IFACE_INDEX_ANY) {
 830                                 iface->parent_iface_index =
 831                                     USB_IFACE_INDEX_ANY;
 832                         }
 833                 }
 834
 835                 DPRINTFN(5, "found idesc nendpt=%d\n", id->bNumEndpoints);
 836
 837                 ed = (struct usb_endpoint_descriptor *)id;
 838
 839                 temp = ep_curr;
 840
 841                 /* iterate all the endpoint descriptors */
 842                 while ((ed = usb_edesc_foreach(udev->cdesc, ed))) {
 843
 844                         /* check if endpoint limit has been reached */
 845                         if (temp >= USB_MAX_EP_UNITS) {
 846                                 DPRINTF("Endpoint limit reached\n");
 847                                 break;
 848                         }
 849
 850                         ep = udev->endpoints + temp;
 851
 852                         if (do_init) {
 853                                 void *ecomp;
 854
 855                                 ecomp = usb_ed_comp_foreach(udev->cdesc, (void *)ed);
 856                                 if (ecomp != NULL)
 857                                         DPRINTFN(5, "Found endpoint companion descriptor\n");
 858
 859                                 usb_init_endpoint(udev,
 860                                     ips.iface_index, ed, ecomp, ep);
 861                         }
 862
 863                         temp ++;
 864
 865                         /* find maximum number of endpoints */
 866                         if (ep_max < temp)
 867                                 ep_max = temp;
 868                 }
 869         }
 870
 871         /* NOTE: It is valid to have no interfaces and no endpoints! */
 872
 873         if (cmd == USB_CFG_ALLOC) {
 874                 udev->ifaces_max = ips.iface_index;
 875 #if (USB_HAVE_FIXED_IFACE == 0)
 876                 udev->ifaces = NULL;
 877                 if (udev->ifaces_max != 0) {
 878                         udev->ifaces = malloc(sizeof(*iface) * udev->ifaces_max,
 879                                 M_USB, M_WAITOK | M_ZERO);
 880                         if (udev->ifaces == NULL) {
 881                                 err = USB_ERR_NOMEM;
 882                                 goto done;
 883                         }
 884                 }
 885 #endif
 886 #if (USB_HAVE_FIXED_ENDPOINT == 0)
 887                 if (ep_max != 0) {
 888                         udev->endpoints = malloc(sizeof(*ep) * ep_max,
 889                                 M_USB, M_WAITOK | M_ZERO);
 890                         if (udev->endpoints == NULL) {
 891                                 err = USB_ERR_NOMEM;
 892                                 goto done;
 893                         }
 894                 } else {
 895                         udev->endpoints = NULL;
 896                 }
 897 #endif
 898                 USB_BUS_LOCK(udev->bus);
 899                 udev->endpoints_max = ep_max;
 900                 /* reset any ongoing clear-stall */
 901                 udev->ep_curr = NULL;
 902                 USB_BUS_UNLOCK(udev->bus);
 903         }
 904 #if (USB_HAVE_FIXED_IFACE == 0) || (USB_HAVE_FIXED_ENDPOINT == 0)
 905 done:
 906 #endif
 907         if (err) {
 908                 if (cmd == USB_CFG_ALLOC) {
 909 cleanup:
 910                         USB_BUS_LOCK(udev->bus);
 911                         udev->endpoints_max = 0;
 912                         /* reset any ongoing clear-stall */
 913                         udev->ep_curr = NULL;
 914                         USB_BUS_UNLOCK(udev->bus);
 915
 916 #if (USB_HAVE_FIXED_IFACE == 0)
 917                         free(udev->ifaces, M_USB);
 918                         udev->ifaces = NULL;
 919 #endif
 920 #if (USB_HAVE_FIXED_ENDPOINT == 0)
 921                         free(udev->endpoints, M_USB);
 922                         udev->endpoints = NULL;
 923 #endif
 924                         udev->ifaces_max = 0;
 925                 }
 926         }
 927         return (err);
 928 }
 929
 930 /*------------------------------------------------------------------------*
 931  *      usbd_set_alt_interface_index
 932  *
 933  * This function will select an alternate interface index for the
 934  * given interface index. The interface should not be in use when this
 935  * function is called. That means there should not be any open USB
 936  * transfers. Else an error is returned. If the alternate setting is
 937  * already set this function will simply return success. This function
 938  * is called in Host mode and Device mode!
 939  *
 940  * Returns:
 941  *    0: Success
 942  * Else: Failure
 943  *------------------------------------------------------------------------*/
 944 usb_error_t
 945 usbd_set_alt_interface_index(struct usb_device *udev,
 946     uint8_t iface_index, uint8_t alt_index)
 947 {
 948         struct usb_interface *iface = usbd_get_iface(udev, iface_index);
 949         usb_error_t err;
 950         uint8_t do_unlock;
 951
 952         /* Prevent re-enumeration */
 953         do_unlock = usbd_enum_lock(udev);
 954
 955         if (iface == NULL) {
 956                 err = USB_ERR_INVAL;
 957                 goto done;
 958         }
 959         if (iface->alt_index == alt_index) {
 960                 /*
 961                  * Optimise away duplicate setting of
 962                  * alternate setting in USB Host Mode!
 963                  */
 964                 err = 0;
 965                 goto done;
 966         }
 967 #if USB_HAVE_UGEN
 968         /*
 969          * Free all generic FIFOs for this interface, except control
 970          * endpoint FIFOs:
 971          */
 972         usb_fifo_free_wrap(udev, iface_index, 0);
 973 #endif
 974
 975         err = usb_config_parse(udev, iface_index, alt_index);
 976         if (err) {
 977                 goto done;
 978         }
 979         if (iface->alt_index != alt_index) {
 980                 /* the alternate setting does not exist */
 981                 err = USB_ERR_INVAL;
 982                 goto done;
 983         }
 984
 985         err = usbd_req_set_alt_interface_no(udev, NULL, iface_index,
 986             iface->idesc->bAlternateSetting);
 987
 988 done:
 989         if (do_unlock)
 990                 usbd_enum_unlock(udev);
 991         return (err);
 992 }
 993
 994 /*------------------------------------------------------------------------*
 995  *      usbd_set_endpoint_stall
 996  *
 997  * This function is used to make a BULK or INTERRUPT endpoint send
 998  * STALL tokens in USB device mode.
 999  *
1000  * Returns:
1001  *    0: Success
1002  * Else: Failure
1003  *------------------------------------------------------------------------*/
1004 usb_error_t
1005 usbd_set_endpoint_stall(struct usb_device *udev, struct usb_endpoint *ep,
1006     uint8_t do_stall)
1007 {
1008         struct usb_xfer *xfer;
1009         usb_stream_t x;
1010         uint8_t et;
1011         uint8_t was_stalled;
1012
1013         if (ep == NULL) {
1014                 /* nothing to do */
1015                 DPRINTF("Cannot find endpoint\n");
1016                 /*
1017                  * Pretend that the clear or set stall request is
1018                  * successful else some USB host stacks can do
1019                  * strange things, especially when a control endpoint
1020                  * stalls.
1021                  */
1022                 return (0);
1023         }
1024         et = (ep->edesc->bmAttributes & UE_XFERTYPE);
1025
1026         if ((et != UE_BULK) &&
1027             (et != UE_INTERRUPT)) {
1028                 /*
1029                  * Should not stall control
1030                  * nor isochronous endpoints.
1031                  */
1032                 DPRINTF("Invalid endpoint\n");
1033                 return (0);
1034         }
1035         USB_BUS_LOCK(udev->bus);
1036
1037         /* store current stall state */
1038         was_stalled = ep->is_stalled;
1039
1040         /* check for no change */
1041         if (was_stalled && do_stall) {
1042                 /* if the endpoint is already stalled do nothing */
1043                 USB_BUS_UNLOCK(udev->bus);
1044                 DPRINTF("No change\n");
1045                 return (0);
1046         }
1047         /* set stalled state */
1048         ep->is_stalled = 1;
1049
1050         if (do_stall || (!was_stalled)) {
1051                 if (!was_stalled) {
1052                         for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1053                                 /* lookup the current USB transfer, if any */
1054                                 xfer = ep->endpoint_q[x].curr;
1055                                 if (xfer != NULL) {
1056                                         /*
1057                                          * The "xfer_stall" method
1058                                          * will complete the USB
1059                                          * transfer like in case of a
1060                                          * timeout setting the error
1061                                          * code "USB_ERR_STALLED".
1062                                          */
1063                                         (udev->bus->methods->xfer_stall) (xfer);
1064                                 }
1065                         }
1066                 }
1067                 (udev->bus->methods->set_stall) (udev, ep, &do_stall);
1068         }
1069         if (!do_stall) {
1070                 ep->toggle_next = 0;    /* reset data toggle */
1071                 ep->is_stalled = 0;     /* clear stalled state */
1072
1073                 (udev->bus->methods->clear_stall) (udev, ep);
1074
1075                 /* start the current or next transfer, if any */
1076                 for (x = 0; x != USB_MAX_EP_STREAMS; x++) {
1077                         usb_command_wrapper(&ep->endpoint_q[x],
1078                             ep->endpoint_q[x].curr);
1079                 }
1080         }
1081         USB_BUS_UNLOCK(udev->bus);
1082         return (0);
1083 }
1084
1085 /*------------------------------------------------------------------------*
1086  *      usb_reset_iface_endpoints - used in USB device side mode
1087  *------------------------------------------------------------------------*/
1088 usb_error_t
1089 usb_reset_iface_endpoints(struct usb_device *udev, uint8_t iface_index)
1090 {
1091         struct usb_endpoint *ep;
1092         struct usb_endpoint *ep_end;
1093
1094         ep = udev->endpoints;
1095         ep_end = udev->endpoints + udev->endpoints_max;
1096
1097         for (; ep != ep_end; ep++) {
1098
1099                 if ((ep->edesc == NULL) ||
1100                     (ep->iface_index != iface_index)) {
1101                         continue;
1102                 }
1103                 /* simulate a clear stall from the peer */
1104                 usbd_set_endpoint_stall(udev, ep, 0);
1105         }
1106         return (0);
1107 }
1108
1109 /*------------------------------------------------------------------------*
1110  *      usb_detach_device_sub
1111  *
1112  * This function will try to detach an USB device. If it fails a panic
1113  * will result.
1114  *
1115  * Flag values, see "USB_UNCFG_FLAG_XXX".
1116  *------------------------------------------------------------------------*/
1117 static void
1118 usb_detach_device_sub(struct usb_device *udev, device_t *ppdev,
1119     char **ppnpinfo, uint8_t flag)
1120 {
1121         device_t dev;
1122         char *pnpinfo;
1123         int err;
1124
1125         dev = *ppdev;
1126         if (dev) {
1127                 /*
1128                  * NOTE: It is important to clear "*ppdev" before deleting
1129                  * the child due to some device methods being called late
1130                  * during the delete process !
1131                  */
1132                 *ppdev = NULL;
1133
1134                 if (!rebooting) {
1135                         device_printf(dev, "at %s, port %d, addr %d "
1136                             "(disconnected)\n",
1137                             device_get_nameunit(udev->parent_dev),
1138                             udev->port_no, udev->address);
1139                 }
1140
1141                 if (device_is_attached(dev)) {
1142                         if (udev->flags.peer_suspended) {
1143                                 err = DEVICE_RESUME(dev);
1144                                 if (err) {
1145                                         device_printf(dev, "Resume failed\n");
1146                                 }
1147                         }
1148                         if (device_detach(dev)) {
1149                                 goto error;
1150                         }
1151                 }
1152                 if (device_delete_child(udev->parent_dev, dev)) {
1153                         goto error;
1154                 }
1155         }
1156
1157         pnpinfo = *ppnpinfo;
1158         if (pnpinfo != NULL) {
1159                 *ppnpinfo = NULL;
1160                 free(pnpinfo, M_USBDEV);
1161         }
1162         return;
1163
1164 error:
1165         /* Detach is not allowed to fail in the USB world */
1166         panic("usb_detach_device_sub: A USB driver would not detach\n");
1167 }
1168
1169 /*------------------------------------------------------------------------*
1170  *      usb_detach_device
1171  *
1172  * The following function will detach the matching interfaces.
1173  * This function is NULL safe.
1174  *
1175  * Flag values, see "USB_UNCFG_FLAG_XXX".
1176  *------------------------------------------------------------------------*/
1177 void
1178 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1179     uint8_t flag)
1180 {
1181         struct usb_interface *iface;
1182         uint8_t i;
1183
1184         if (udev == NULL) {
1185                 /* nothing to do */
1186                 return;
1187         }
1188         DPRINTFN(4, "udev=%p\n", udev);
1189
1190         sx_assert(&udev->enum_sx, SA_LOCKED);
1191
1192         /* wait for pending refs to go away */
1193         usb_wait_pending_ref_locked(udev);
1194
1195         /*
1196          * First detach the child to give the child's detach routine a
1197          * chance to detach the sub-devices in the correct order.
1198          * Then delete the child using "device_delete_child()" which
1199          * will detach all sub-devices from the bottom and upwards!
1200          */
1201         if (iface_index != USB_IFACE_INDEX_ANY) {
1202                 i = iface_index;
1203                 iface_index = i + 1;
1204         } else {
1205                 i = 0;
1206                 iface_index = USB_IFACE_MAX;
1207         }
1208
1209         /* do the detach */
1210
1211         for (; i != iface_index; i++) {
1212
1213                 iface = usbd_get_iface(udev, i);
1214                 if (iface == NULL) {
1215                         /* looks like the end of the USB interfaces */
1216                         break;
1217                 }
1218                 usb_detach_device_sub(udev, &iface->subdev,
1219                     &iface->pnpinfo, flag);
1220         }
1221
1222         usb_ref_restore_locked(udev);
1223 }
1224
1225 /*------------------------------------------------------------------------*
1226  *      usb_probe_and_attach_sub
1227  *
1228  * Returns:
1229  *    0: Success
1230  * Else: Failure
1231  *------------------------------------------------------------------------*/
1232 static uint8_t
1233 usb_probe_and_attach_sub(struct usb_device *udev,
1234     struct usb_attach_arg *uaa)
1235 {
1236         struct usb_interface *iface;
1237         device_t dev;
1238         int err;
1239
1240         iface = uaa->iface;
1241         if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1242                 /* leave interface alone */
1243                 return (0);
1244         }
1245         dev = iface->subdev;
1246         if (dev) {
1247
1248                 /* clean up after module unload */
1249
1250                 if (device_is_attached(dev)) {
1251                         /* already a device there */
1252                         return (0);
1253                 }
1254                 /* clear "iface->subdev" as early as possible */
1255
1256                 iface->subdev = NULL;
1257
1258                 if (device_delete_child(udev->parent_dev, dev)) {
1259
1260                         /*
1261                          * Panic here, else one can get a double call
1262                          * to device_detach().  USB devices should
1263                          * never fail on detach!
1264                          */
1265                         panic("device_delete_child() failed\n");
1266                 }
1267         }
1268         if (uaa->temp_dev == NULL) {
1269
1270                 /* create a new child */
1271                 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1272                 if (uaa->temp_dev == NULL) {
1273                         device_printf(udev->parent_dev,
1274                             "Device creation failed\n");
1275                         return (1);     /* failure */
1276                 }
1277                 device_set_ivars(uaa->temp_dev, uaa);
1278                 device_quiet(uaa->temp_dev);
1279         }
1280         /*
1281          * Set "subdev" before probe and attach so that "devd" gets
1282          * the information it needs.
1283          */
1284         iface->subdev = uaa->temp_dev;
1285
1286         if (device_probe_and_attach(iface->subdev) == 0) {
1287                 /*
1288                  * The USB attach arguments are only available during probe
1289                  * and attach !
1290                  */
1291                 uaa->temp_dev = NULL;
1292                 device_set_ivars(iface->subdev, NULL);
1293
1294                 if (udev->flags.peer_suspended) {
1295                         err = DEVICE_SUSPEND(iface->subdev);
1296                         if (err)
1297                                 device_printf(iface->subdev, "Suspend failed\n");
1298                 }
1299                 return (0);             /* success */
1300         } else {
1301                 /* No USB driver found */
1302                 iface->subdev = NULL;
1303         }
1304         return (1);                     /* failure */
1305 }
1306
1307 /*------------------------------------------------------------------------*
1308  *      usbd_set_parent_iface
1309  *
1310  * Using this function will lock the alternate interface setting on an
1311  * interface. It is typically used for multi interface drivers. In USB
1312  * device side mode it is assumed that the alternate interfaces all
1313  * have the same endpoint descriptors. The default parent index value
1314  * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1315  * locked.
1316  *------------------------------------------------------------------------*/
1317 void
1318 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1319     uint8_t parent_index)
1320 {
1321         struct usb_interface *iface;
1322
1323         if (udev == NULL) {
1324                 /* nothing to do */
1325                 return;
1326         }
1327         iface = usbd_get_iface(udev, iface_index);
1328         if (iface != NULL)
1329                 iface->parent_iface_index = parent_index;
1330 }
1331
1332 static void
1333 usb_init_attach_arg(struct usb_device *udev,
1334     struct usb_attach_arg *uaa)
1335 {
1336         memset(uaa, 0, sizeof(*uaa));
1337
1338         uaa->device = udev;
1339         uaa->usb_mode = udev->flags.usb_mode;
1340         uaa->port = udev->port_no;
1341         uaa->dev_state = UAA_DEV_READY;
1342
1343         uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1344         uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1345         uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1346         uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1347         uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1348         uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1349         uaa->info.bConfigIndex = udev->curr_config_index;
1350         uaa->info.bConfigNum = udev->curr_config_no;
1351 }
1352
1353 /*------------------------------------------------------------------------*
1354  *      usb_probe_and_attach
1355  *
1356  * This function is called from "uhub_explore_sub()",
1357  * "usb_handle_set_config()" and "usb_handle_request()".
1358  *
1359  * Returns:
1360  *    0: Success
1361  * Else: A control transfer failed
1362  *------------------------------------------------------------------------*/
1363 usb_error_t
1364 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1365 {
1366         struct usb_attach_arg uaa;
1367         struct usb_interface *iface;
1368         uint8_t i;
1369         uint8_t j;
1370         uint8_t do_unlock;
1371
1372         if (udev == NULL) {
1373                 DPRINTF("udev == NULL\n");
1374                 return (USB_ERR_INVAL);
1375         }
1376         /* Prevent re-enumeration */
1377         do_unlock = usbd_enum_lock(udev);
1378
1379         if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1380                 /* do nothing - no configuration has been set */
1381                 goto done;
1382         }
1383         /* setup USB attach arguments */
1384
1385         usb_init_attach_arg(udev, &uaa);
1386
1387         /*
1388          * If the whole USB device is targeted, invoke the USB event
1389          * handler(s):
1390          */
1391         if (iface_index == USB_IFACE_INDEX_ANY) {
1392
1393                 EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1394
1395                 if (uaa.dev_state != UAA_DEV_READY) {
1396                         /* leave device unconfigured */
1397                         usb_unconfigure(udev, 0);
1398                         goto done;
1399                 }
1400         }
1401
1402         /* Check if only one interface should be probed: */
1403         if (iface_index != USB_IFACE_INDEX_ANY) {
1404                 i = iface_index;
1405                 j = i + 1;
1406         } else {
1407                 i = 0;
1408                 j = USB_IFACE_MAX;
1409         }
1410
1411         /* Do the probe and attach */
1412         for (; i != j; i++) {
1413
1414                 iface = usbd_get_iface(udev, i);
1415                 if (iface == NULL) {
1416                         /*
1417                          * Looks like the end of the USB
1418                          * interfaces !
1419                          */
1420                         DPRINTFN(2, "end of interfaces "
1421                             "at %u\n", i);
1422                         break;
1423                 }
1424                 if (iface->idesc == NULL) {
1425                         /* no interface descriptor */
1426                         continue;
1427                 }
1428                 uaa.iface = iface;
1429
1430                 uaa.info.bInterfaceClass =
1431                     iface->idesc->bInterfaceClass;
1432                 uaa.info.bInterfaceSubClass =
1433                     iface->idesc->bInterfaceSubClass;
1434                 uaa.info.bInterfaceProtocol =
1435                     iface->idesc->bInterfaceProtocol;
1436                 uaa.info.bIfaceIndex = i;
1437                 uaa.info.bIfaceNum =
1438                     iface->idesc->bInterfaceNumber;
1439                 uaa.driver_info = 0;    /* reset driver_info */
1440
1441                 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1442                     uaa.info.bInterfaceClass,
1443                     uaa.info.bInterfaceSubClass,
1444                     uaa.info.bInterfaceProtocol,
1445                     uaa.info.bIfaceIndex,
1446                     uaa.info.bIfaceNum);
1447
1448                 usb_probe_and_attach_sub(udev, &uaa);
1449
1450                 /*
1451                  * Remove the leftover child, if any, to enforce that
1452                  * a new nomatch devd event is generated for the next
1453                  * interface if no driver is found:
1454                  */
1455                 if (uaa.temp_dev == NULL)
1456                         continue;
1457                 if (device_delete_child(udev->parent_dev, uaa.temp_dev))
1458                         DPRINTFN(0, "device delete child failed\n");
1459                 uaa.temp_dev = NULL;
1460         }
1461 done:
1462         if (do_unlock)
1463                 usbd_enum_unlock(udev);
1464         return (0);
1465 }
1466
1467 /*------------------------------------------------------------------------*
1468  *      usb_suspend_resume_sub
1469  *
1470  * This function is called when the suspend or resume methods should
1471  * be executed on an USB device.
1472  *------------------------------------------------------------------------*/
1473 static void
1474 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1475 {
1476         int err;
1477
1478         if (dev == NULL) {
1479                 return;
1480         }
1481         if (!device_is_attached(dev)) {
1482                 return;
1483         }
1484         if (do_suspend) {
1485                 err = DEVICE_SUSPEND(dev);
1486         } else {
1487                 err = DEVICE_RESUME(dev);
1488         }
1489         if (err) {
1490                 device_printf(dev, "%s failed\n",
1491                     do_suspend ? "Suspend" : "Resume");
1492         }
1493 }
1494
1495 /*------------------------------------------------------------------------*
1496  *      usb_suspend_resume
1497  *
1498  * The following function will suspend or resume the USB device.
1499  *
1500  * Returns:
1501  *    0: Success
1502  * Else: Failure
1503  *------------------------------------------------------------------------*/
1504 usb_error_t
1505 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1506 {
1507         struct usb_interface *iface;
1508         uint8_t i;
1509
1510         if (udev == NULL) {
1511                 /* nothing to do */
1512                 return (0);
1513         }
1514         DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1515
1516         sx_assert(&udev->sr_sx, SA_LOCKED);
1517
1518         USB_BUS_LOCK(udev->bus);
1519         /* filter the suspend events */
1520         if (udev->flags.peer_suspended == do_suspend) {
1521                 USB_BUS_UNLOCK(udev->bus);
1522                 /* nothing to do */
1523                 return (0);
1524         }
1525         udev->flags.peer_suspended = do_suspend;
1526         USB_BUS_UNLOCK(udev->bus);
1527
1528         /* do the suspend or resume */
1529
1530         for (i = 0; i != USB_IFACE_MAX; i++) {
1531
1532                 iface = usbd_get_iface(udev, i);
1533                 if (iface == NULL) {
1534                         /* looks like the end of the USB interfaces */
1535                         break;
1536                 }
1537                 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1538         }
1539         return (0);
1540 }
1541
1542 /*------------------------------------------------------------------------*
1543  *      usbd_clear_stall_proc
1544  *
1545  * This function performs generic USB clear stall operations.
1546  *------------------------------------------------------------------------*/
1547 static void
1548 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1549 {
1550         struct usb_udev_msg *pm = (void *)_pm;
1551         struct usb_device *udev = pm->udev;
1552
1553         /* Change lock */
1554         USB_BUS_UNLOCK(udev->bus);
1555         mtx_lock(&udev->device_mtx);
1556
1557         /* Start clear stall callback */
1558         usbd_transfer_start(udev->ctrl_xfer[1]);
1559
1560         /* Change lock */
1561         mtx_unlock(&udev->device_mtx);
1562         USB_BUS_LOCK(udev->bus);
1563 }
1564
1565 /*------------------------------------------------------------------------*
1566  *      usb_alloc_device
1567  *
1568  * This function allocates a new USB device. This function is called
1569  * when a new device has been put in the powered state, but not yet in
1570  * the addressed state. Get initial descriptor, set the address, get
1571  * full descriptor and get strings.
1572  *
1573  * Return values:
1574  *    0: Failure
1575  * Else: Success
1576  *------------------------------------------------------------------------*/
1577 struct usb_device *
1578 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1579     struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1580     uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1581 {
1582         struct usb_attach_arg uaa;
1583         struct usb_device *udev;
1584         struct usb_device *adev;
1585         struct usb_device *hub;
1586         uint8_t *scratch_ptr;
1587         usb_error_t err;
1588         uint8_t device_index;
1589         uint8_t config_index;
1590         uint8_t config_quirk;
1591         uint8_t set_config_failed;
1592         uint8_t do_unlock;
1593
1594         DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1595             "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1596             parent_dev, bus, parent_hub, depth, port_index, port_no,
1597             speed, mode);
1598
1599         /*
1600          * Find an unused device index. In USB Host mode this is the
1601          * same as the device address.
1602          *
1603          * Device index zero is not used and device index 1 should
1604          * always be the root hub.
1605          */
1606         for (device_index = USB_ROOT_HUB_ADDR;
1607             (device_index != bus->devices_max) &&
1608             (bus->devices[device_index] != NULL);
1609             device_index++) /* nop */;
1610
1611         if (device_index == bus->devices_max) {
1612                 device_printf(bus->bdev,
1613                     "No free USB device index for new device\n");
1614                 return (NULL);
1615         }
1616
1617         if (depth > 0x10) {
1618                 device_printf(bus->bdev,
1619                     "Invalid device depth\n");
1620                 return (NULL);
1621         }
1622         udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1623         if (udev == NULL) {
1624                 return (NULL);
1625         }
1626         /* initialise our SX-lock */
1627         sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1628         sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_NOWITNESS);
1629
1630         cv_init(&udev->ctrlreq_cv, "WCTRL");
1631         cv_init(&udev->ref_cv, "UGONE");
1632
1633         /* initialise our mutex */
1634         mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1635
1636         /* initialise generic clear stall */
1637         udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1638         udev->cs_msg[0].udev = udev;
1639         udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1640         udev->cs_msg[1].udev = udev;
1641
1642         /* initialise some USB device fields */
1643         udev->parent_hub = parent_hub;
1644         udev->parent_dev = parent_dev;
1645         udev->port_index = port_index;
1646         udev->port_no = port_no;
1647         udev->depth = depth;
1648         udev->bus = bus;
1649         udev->address = USB_START_ADDR; /* default value */
1650         udev->plugtime = (usb_ticks_t)ticks;
1651         /*
1652          * We need to force the power mode to "on" because there are plenty
1653          * of USB devices out there that do not work very well with
1654          * automatic suspend and resume!
1655          */
1656         udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1657         udev->pwr_save.last_xfer_time = ticks;
1658         /* we are not ready yet */
1659         udev->refcount = 1;
1660
1661         /* set up default endpoint descriptor */
1662         udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1663         udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1664         udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1665         udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1666         udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1667         udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1668         udev->ctrl_ep_desc.bInterval = 0;
1669
1670         /* set up default endpoint companion descriptor */
1671         udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1672         udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1673
1674         udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1675
1676         udev->speed = speed;
1677         udev->flags.usb_mode = mode;
1678
1679         /* search for our High Speed USB HUB, if any */
1680
1681         adev = udev;
1682         hub = udev->parent_hub;
1683
1684         while (hub) {
1685                 if (hub->speed == USB_SPEED_HIGH) {
1686                         udev->hs_hub_addr = hub->address;
1687                         udev->parent_hs_hub = hub;
1688                         udev->hs_port_no = adev->port_no;
1689                         break;
1690                 }
1691                 adev = hub;
1692                 hub = hub->parent_hub;
1693         }
1694
1695         /* init the default endpoint */
1696         usb_init_endpoint(udev, 0,
1697             &udev->ctrl_ep_desc,
1698             &udev->ctrl_ep_comp_desc,
1699             &udev->ctrl_ep);
1700
1701         /* set device index */
1702         udev->device_index = device_index;
1703
1704 #if USB_HAVE_UGEN
1705         /* Create ugen name */
1706         snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1707             USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1708             device_index);
1709         LIST_INIT(&udev->pd_list);
1710
1711         /* Create the control endpoint device */
1712         udev->ctrl_dev = usb_make_dev(udev, NULL, 0, 0,
1713             FREAD|FWRITE, UID_ROOT, GID_OPERATOR, 0600);
1714
1715         /* Create a link from /dev/ugenX.X to the default endpoint */
1716         if (udev->ctrl_dev != NULL)
1717                 make_dev_alias(udev->ctrl_dev->cdev, "%s", udev->ugen_name);
1718 #endif
1719         /* Initialise device */
1720         if (bus->methods->device_init != NULL) {
1721                 err = (bus->methods->device_init) (udev);
1722                 if (err != 0) {
1723                         DPRINTFN(0, "device init %d failed "
1724                             "(%s, ignored)\n", device_index,
1725                             usbd_errstr(err));
1726                         goto done;
1727                 }
1728         }
1729         /* set powered device state after device init is complete */
1730         usb_set_device_state(udev, USB_STATE_POWERED);
1731
1732         if (udev->flags.usb_mode == USB_MODE_HOST) {
1733
1734                 err = usbd_req_set_address(udev, NULL, device_index);
1735
1736                 /*
1737                  * This is the new USB device address from now on, if
1738                  * the set address request didn't set it already.
1739                  */
1740                 if (udev->address == USB_START_ADDR)
1741                         udev->address = device_index;
1742
1743                 /*
1744                  * We ignore any set-address errors, hence there are
1745                  * buggy USB devices out there that actually receive
1746                  * the SETUP PID, but manage to set the address before
1747                  * the STATUS stage is ACK'ed. If the device responds
1748                  * to the subsequent get-descriptor at the new
1749                  * address, then we know that the set-address command
1750                  * was successful.
1751                  */
1752                 if (err) {
1753                         DPRINTFN(0, "set address %d failed "
1754                             "(%s, ignored)\n", udev->address,
1755                             usbd_errstr(err));
1756                 }
1757         } else {
1758                 /* We are not self powered */
1759                 udev->flags.self_powered = 0;
1760
1761                 /* Set unconfigured state */
1762                 udev->curr_config_no = USB_UNCONFIG_NO;
1763                 udev->curr_config_index = USB_UNCONFIG_INDEX;
1764
1765                 /* Setup USB descriptors */
1766                 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1767                 if (err) {
1768                         DPRINTFN(0, "setting up USB template failed maybe the USB "
1769                             "template module has not been loaded\n");
1770                         goto done;
1771                 }
1772         }
1773         usb_set_device_state(udev, USB_STATE_ADDRESSED);
1774
1775         /* setup the device descriptor and the initial "wMaxPacketSize" */
1776         err = usbd_setup_device_desc(udev, NULL);
1777
1778         if (err != 0) {
1779                 /* try to enumerate two more times */
1780                 err = usbd_req_re_enumerate(udev, NULL);
1781                 if (err != 0) {
1782                         err = usbd_req_re_enumerate(udev, NULL);
1783                         if (err != 0) {
1784                                 goto done;
1785                         }
1786                 }
1787         }
1788
1789         /*
1790          * Setup temporary USB attach args so that we can figure out some
1791          * basic quirks for this device.
1792          */
1793         usb_init_attach_arg(udev, &uaa);
1794
1795         if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1796                 udev->flags.uq_bus_powered = 1;
1797         }
1798         if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1799                 udev->flags.no_strings = 1;
1800         }
1801         /*
1802          * Workaround for buggy USB devices.
1803          *
1804          * It appears that some string-less USB chips will crash and
1805          * disappear if any attempts are made to read any string
1806          * descriptors.
1807          *
1808          * Try to detect such chips by checking the strings in the USB
1809          * device descriptor. If no strings are present there we
1810          * simply disable all USB strings.
1811          */
1812
1813         /* Protect scratch area */
1814         do_unlock = usbd_enum_lock(udev);
1815
1816         scratch_ptr = udev->scratch.data;
1817
1818         if (udev->ddesc.iManufacturer ||
1819             udev->ddesc.iProduct ||
1820             udev->ddesc.iSerialNumber) {
1821                 /* read out the language ID string */
1822                 err = usbd_req_get_string_desc(udev, NULL,
1823                     (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1824         } else {
1825                 err = USB_ERR_INVAL;
1826         }
1827
1828         if (err || (scratch_ptr[0] < 4)) {
1829                 udev->flags.no_strings = 1;
1830         } else {
1831                 uint16_t langid;
1832                 uint16_t pref;
1833                 uint16_t mask;
1834                 uint8_t x;
1835
1836                 /* load preferred value and mask */
1837                 pref = usb_lang_id;
1838                 mask = usb_lang_mask;
1839
1840                 /* align length correctly */
1841                 scratch_ptr[0] &= ~1U;
1842
1843                 /* fix compiler warning */
1844                 langid = 0;
1845
1846                 /* search for preferred language */
1847                 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1848                         langid = UGETW(scratch_ptr + x);
1849                         if ((langid & mask) == pref)
1850                                 break;
1851                 }
1852                 if (x >= scratch_ptr[0]) {
1853                         /* pick the first language as the default */
1854                         DPRINTFN(1, "Using first language\n");
1855                         langid = UGETW(scratch_ptr + 2);
1856                 }
1857
1858                 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1859                 udev->langid = langid;
1860         }
1861
1862         if (do_unlock)
1863                 usbd_enum_unlock(udev);
1864
1865         /* assume 100mA bus powered for now. Changed when configured. */
1866         udev->power = USB_MIN_POWER;
1867         /* fetch the vendor and product strings from the device */
1868         usbd_set_device_strings(udev);
1869
1870         if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1871                 /* USB device mode setup is complete */
1872                 err = 0;
1873                 goto config_done;
1874         }
1875
1876         /*
1877          * Most USB devices should attach to config index 0 by
1878          * default
1879          */
1880         if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1881                 config_index = 0;
1882                 config_quirk = 1;
1883         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1884                 config_index = 1;
1885                 config_quirk = 1;
1886         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1887                 config_index = 2;
1888                 config_quirk = 1;
1889         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1890                 config_index = 3;
1891                 config_quirk = 1;
1892         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1893                 config_index = 4;
1894                 config_quirk = 1;
1895         } else {
1896                 config_index = 0;
1897                 config_quirk = 0;
1898         }
1899
1900         set_config_failed = 0;
1901 repeat_set_config:
1902
1903         DPRINTF("setting config %u\n", config_index);
1904
1905         /* get the USB device configured */
1906         err = usbd_set_config_index(udev, config_index);
1907         if (err) {
1908                 if (udev->ddesc.bNumConfigurations != 0) {
1909                         if (!set_config_failed) {
1910                                 set_config_failed = 1;
1911                                 /* XXX try to re-enumerate the device */
1912                                 err = usbd_req_re_enumerate(udev, NULL);
1913                                 if (err == 0)
1914                                         goto repeat_set_config;
1915                         }
1916                         DPRINTFN(0, "Failure selecting configuration index %u:"
1917                             "%s, port %u, addr %u (ignored)\n",
1918                             config_index, usbd_errstr(err), udev->port_no,
1919                             udev->address);
1920                 }
1921                 /*
1922                  * Some USB devices do not have any configurations. Ignore any
1923                  * set config failures!
1924                  */
1925                 err = 0;
1926                 goto config_done;
1927         }
1928         if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1929                 if ((udev->cdesc->bNumInterface < 2) &&
1930                     usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1931                         DPRINTFN(0, "Found no endpoints, trying next config\n");
1932                         config_index++;
1933                         goto repeat_set_config;
1934                 }
1935 #if USB_HAVE_MSCTEST
1936                 if (config_index == 0) {
1937                         /*
1938                          * Try to figure out if we have an
1939                          * auto-install disk there:
1940                          */
1941                         if (usb_iface_is_cdrom(udev, 0)) {
1942                                 DPRINTFN(0, "Found possible auto-install "
1943                                     "disk (trying next config)\n");
1944                                 config_index++;
1945                                 goto repeat_set_config;
1946                         }
1947                 }
1948 #endif
1949         }
1950 #if USB_HAVE_MSCTEST
1951         if (set_config_failed == 0 && config_index == 0 &&
1952             usb_test_quirk(&uaa, UQ_MSC_NO_SYNC_CACHE) == 0 &&
1953             usb_test_quirk(&uaa, UQ_MSC_NO_GETMAXLUN) == 0) {
1954
1955                 /*
1956                  * Try to figure out if there are any MSC quirks we
1957                  * should apply automatically:
1958                  */
1959                 err = usb_msc_auto_quirk(udev, 0);
1960
1961                 if (err != 0) {
1962                         set_config_failed = 1;
1963                         goto repeat_set_config;
1964                 }
1965         }
1966 #endif
1967
1968 config_done:
1969         DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1970             udev->address, udev, udev->parent_hub);
1971
1972         /* register our device - we are ready */
1973         usb_bus_port_set_device(bus, parent_hub ?
1974             parent_hub->hub->ports + port_index : NULL, udev, device_index);
1975
1976 #if USB_HAVE_UGEN
1977         /* Symlink the ugen device name */
1978         udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1979
1980         /* Announce device */
1981         printf("%s: <%s> at %s\n", udev->ugen_name,
1982             usb_get_manufacturer(udev),
1983             device_get_nameunit(udev->bus->bdev));
1984 #endif
1985
1986 #if USB_HAVE_DEVCTL
1987         usb_notify_addq("ATTACH", udev);
1988 #endif
1989 done:
1990         if (err) {
1991                 /*
1992                  * Free USB device and all subdevices, if any.
1993                  */
1994                 usb_free_device(udev, 0);
1995                 udev = NULL;
1996         }
1997         return (udev);
1998 }
1999
2000 #if USB_HAVE_UGEN
2001 struct usb_fs_privdata *
2002 usb_make_dev(struct usb_device *udev, const char *devname, int ep,
2003     int fi, int rwmode, uid_t uid, gid_t gid, int mode)
2004 {
2005         struct usb_fs_privdata* pd;
2006         char buffer[32];
2007
2008         /* Store information to locate ourselves again later */
2009         pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
2010             M_WAITOK | M_ZERO);
2011         pd->bus_index = device_get_unit(udev->bus->bdev);
2012         pd->dev_index = udev->device_index;
2013         pd->ep_addr = ep;
2014         pd->fifo_index = fi;
2015         pd->mode = rwmode;
2016
2017         /* Now, create the device itself */
2018         if (devname == NULL) {
2019                 devname = buffer;
2020                 snprintf(buffer, sizeof(buffer), USB_DEVICE_DIR "/%u.%u.%u",
2021                     pd->bus_index, pd->dev_index, pd->ep_addr);
2022         }
2023
2024         pd->cdev = make_dev(&usb_devsw, 0, uid, gid, mode, "%s", devname);
2025
2026         if (pd->cdev == NULL) {
2027                 DPRINTFN(0, "Failed to create device %s\n", devname);
2028                 free(pd, M_USBDEV);
2029                 return (NULL);
2030         }
2031
2032         /* XXX setting si_drv1 and creating the device is not atomic! */
2033         pd->cdev->si_drv1 = pd;
2034
2035         return (pd);
2036 }
2037
2038 void
2039 usb_destroy_dev(struct usb_fs_privdata *pd)
2040 {
2041         if (pd == NULL)
2042                 return;
2043
2044         destroy_dev(pd->cdev);
2045
2046         free(pd, M_USBDEV);
2047 }
2048
2049 static void
2050 usb_cdev_create(struct usb_device *udev)
2051 {
2052         struct usb_config_descriptor *cd;
2053         struct usb_endpoint_descriptor *ed;
2054         struct usb_descriptor *desc;
2055         struct usb_fs_privdata* pd;
2056         int inmode, outmode, inmask, outmask, mode;
2057         uint8_t ep;
2058
2059         KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
2060
2061         DPRINTFN(2, "Creating device nodes\n");
2062
2063         if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
2064                 inmode = FWRITE;
2065                 outmode = FREAD;
2066         } else {                 /* USB_MODE_HOST */
2067                 inmode = FREAD;
2068                 outmode = FWRITE;
2069         }
2070
2071         inmask = 0;
2072         outmask = 0;
2073         desc = NULL;
2074
2075         /*
2076          * Collect all used endpoint numbers instead of just
2077          * generating 16 static endpoints.
2078          */
2079         cd = usbd_get_config_descriptor(udev);
2080         while ((desc = usb_desc_foreach(cd, desc))) {
2081                 /* filter out all endpoint descriptors */
2082                 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
2083                     (desc->bLength >= sizeof(*ed))) {
2084                         ed = (struct usb_endpoint_descriptor *)desc;
2085
2086                         /* update masks */
2087                         ep = ed->bEndpointAddress;
2088                         if (UE_GET_DIR(ep)  == UE_DIR_OUT)
2089                                 outmask |= 1 << UE_GET_ADDR(ep);
2090                         else
2091                                 inmask |= 1 << UE_GET_ADDR(ep);
2092                 }
2093         }
2094
2095         /* Create all available endpoints except EP0 */
2096         for (ep = 1; ep < 16; ep++) {
2097                 mode = (inmask & (1 << ep)) ? inmode : 0;
2098                 mode |= (outmask & (1 << ep)) ? outmode : 0;
2099                 if (mode == 0)
2100                         continue;       /* no IN or OUT endpoint */
2101
2102                 pd = usb_make_dev(udev, NULL, ep, 0,
2103                     mode, UID_ROOT, GID_OPERATOR, 0600);
2104
2105                 if (pd != NULL)
2106                         LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
2107         }
2108 }
2109
2110 static void
2111 usb_cdev_free(struct usb_device *udev)
2112 {
2113         struct usb_fs_privdata* pd;
2114
2115         DPRINTFN(2, "Freeing device nodes\n");
2116
2117         while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
2118                 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
2119
2120                 LIST_REMOVE(pd, pd_next);
2121
2122                 usb_destroy_dev(pd);
2123         }
2124 }
2125 #endif
2126
2127 /*------------------------------------------------------------------------*
2128  *      usb_free_device
2129  *
2130  * This function is NULL safe and will free an USB device and its
2131  * children devices, if any.
2132  *
2133  * Flag values: Reserved, set to zero.
2134  *------------------------------------------------------------------------*/
2135 void
2136 usb_free_device(struct usb_device *udev, uint8_t flag)
2137 {
2138         struct usb_bus *bus;
2139
2140         if (udev == NULL)
2141                 return;         /* already freed */
2142
2143         DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2144
2145         bus = udev->bus;
2146
2147         /* set DETACHED state to prevent any further references */
2148         usb_set_device_state(udev, USB_STATE_DETACHED);
2149
2150 #if USB_HAVE_DEVCTL
2151         usb_notify_addq("DETACH", udev);
2152 #endif
2153
2154 #if USB_HAVE_UGEN
2155         if (!rebooting) {
2156                 printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2157                     usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2158         }
2159
2160         /* Destroy UGEN symlink, if any */
2161         if (udev->ugen_symlink) {
2162                 usb_free_symlink(udev->ugen_symlink);
2163                 udev->ugen_symlink = NULL;
2164         }
2165
2166         usb_destroy_dev(udev->ctrl_dev);
2167 #endif
2168
2169         if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2170                 /* stop receiving any control transfers (Device Side Mode) */
2171                 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2172         }
2173
2174         /* the following will get the device unconfigured in software */
2175         usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2176
2177         /* final device unregister after all character devices are closed */
2178         usb_bus_port_set_device(bus, udev->parent_hub ?
2179             udev->parent_hub->hub->ports + udev->port_index : NULL,
2180             NULL, USB_ROOT_HUB_ADDR);
2181
2182         /* unsetup any leftover default USB transfers */
2183         usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2184
2185         /* template unsetup, if any */
2186         (usb_temp_unsetup_p) (udev);
2187
2188         /*
2189          * Make sure that our clear-stall messages are not queued
2190          * anywhere:
2191          */
2192         USB_BUS_LOCK(udev->bus);
2193         usb_proc_mwait(USB_BUS_NON_GIANT_PROC(udev->bus),
2194             &udev->cs_msg[0], &udev->cs_msg[1]);
2195         USB_BUS_UNLOCK(udev->bus);
2196
2197         sx_destroy(&udev->enum_sx);
2198         sx_destroy(&udev->sr_sx);
2199
2200         cv_destroy(&udev->ctrlreq_cv);
2201         cv_destroy(&udev->ref_cv);
2202
2203         mtx_destroy(&udev->device_mtx);
2204 #if USB_HAVE_UGEN
2205         KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2206 #endif
2207
2208         /* Uninitialise device */
2209         if (bus->methods->device_uninit != NULL)
2210                 (bus->methods->device_uninit) (udev);
2211
2212         /* free device */
2213         free(udev->serial, M_USB);
2214         free(udev->manufacturer, M_USB);
2215         free(udev->product, M_USB);
2216         free(udev, M_USB);
2217 }
2218
2219 /*------------------------------------------------------------------------*
2220  *      usbd_get_iface
2221  *
2222  * This function is the safe way to get the USB interface structure
2223  * pointer by interface index.
2224  *
2225  * Return values:
2226  *   NULL: Interface not present.
2227  *   Else: Pointer to USB interface structure.
2228  *------------------------------------------------------------------------*/
2229 struct usb_interface *
2230 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2231 {
2232         struct usb_interface *iface = udev->ifaces + iface_index;
2233
2234         if (iface_index >= udev->ifaces_max)
2235                 return (NULL);
2236         return (iface);
2237 }
2238
2239 /*------------------------------------------------------------------------*
2240  *      usbd_find_descriptor
2241  *
2242  * This function will lookup the first descriptor that matches the
2243  * criteria given by the arguments "type" and "subtype". Descriptors
2244  * will only be searched within the interface having the index
2245  * "iface_index".  If the "id" argument points to an USB descriptor,
2246  * it will be skipped before the search is started. This allows
2247  * searching for multiple descriptors using the same criteria. Else
2248  * the search is started after the interface descriptor.
2249  *
2250  * Return values:
2251  *   NULL: End of descriptors
2252  *   Else: A descriptor matching the criteria
2253  *------------------------------------------------------------------------*/
2254 void   *
2255 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2256     uint8_t type, uint8_t type_mask,
2257     uint8_t subtype, uint8_t subtype_mask)
2258 {
2259         struct usb_descriptor *desc;
2260         struct usb_config_descriptor *cd;
2261         struct usb_interface *iface;
2262
2263         cd = usbd_get_config_descriptor(udev);
2264         if (cd == NULL) {
2265                 return (NULL);
2266         }
2267         if (id == NULL) {
2268                 iface = usbd_get_iface(udev, iface_index);
2269                 if (iface == NULL) {
2270                         return (NULL);
2271                 }
2272                 id = usbd_get_interface_descriptor(iface);
2273                 if (id == NULL) {
2274                         return (NULL);
2275                 }
2276         }
2277         desc = (void *)id;
2278
2279         while ((desc = usb_desc_foreach(cd, desc))) {
2280
2281                 if (desc->bDescriptorType == UDESC_INTERFACE) {
2282                         break;
2283                 }
2284                 if (((desc->bDescriptorType & type_mask) == type) &&
2285                     ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2286                         return (desc);
2287                 }
2288         }
2289         return (NULL);
2290 }
2291
2292 /*------------------------------------------------------------------------*
2293  *      usb_devinfo
2294  *
2295  * This function will dump information from the device descriptor
2296  * belonging to the USB device pointed to by "udev", to the string
2297  * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2298  * including the terminating zero.
2299  *------------------------------------------------------------------------*/
2300 void
2301 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2302 {
2303         struct usb_device_descriptor *udd = &udev->ddesc;
2304         uint16_t bcdDevice;
2305         uint16_t bcdUSB;
2306
2307         bcdUSB = UGETW(udd->bcdUSB);
2308         bcdDevice = UGETW(udd->bcdDevice);
2309
2310         if (udd->bDeviceClass != 0xFF) {
2311                 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2312                     "%x.%02x, addr %d",
2313                     usb_get_manufacturer(udev),
2314                     usb_get_product(udev),
2315                     udd->bDeviceClass, udd->bDeviceSubClass,
2316                     (bcdUSB >> 8), bcdUSB & 0xFF,
2317                     (bcdDevice >> 8), bcdDevice & 0xFF,
2318                     udev->address);
2319         } else {
2320                 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2321                     "%x.%02x, addr %d",
2322                     usb_get_manufacturer(udev),
2323                     usb_get_product(udev),
2324                     (bcdUSB >> 8), bcdUSB & 0xFF,
2325                     (bcdDevice >> 8), bcdDevice & 0xFF,
2326                     udev->address);
2327         }
2328 }
2329
2330 #ifdef USB_VERBOSE
2331 /*
2332  * Descriptions of of known vendors and devices ("products").
2333  */
2334 struct usb_knowndev {
2335         uint16_t vendor;
2336         uint16_t product;
2337         uint32_t flags;
2338         const char *vendorname;
2339         const char *productname;
2340 };
2341
2342 #define USB_KNOWNDEV_NOPROD     0x01    /* match on vendor only */
2343
2344 #include "usbdevs.h"
2345 #include "usbdevs_data.h"
2346 #endif                                  /* USB_VERBOSE */
2347
2348 static void
2349 usbd_set_device_strings(struct usb_device *udev)
2350 {
2351         struct usb_device_descriptor *udd = &udev->ddesc;
2352 #ifdef USB_VERBOSE
2353         const struct usb_knowndev *kdp;
2354 #endif
2355         char *temp_ptr;
2356         size_t temp_size;
2357         uint16_t vendor_id;
2358         uint16_t product_id;
2359         uint8_t do_unlock;
2360
2361         /* Protect scratch area */
2362         do_unlock = usbd_enum_lock(udev);
2363
2364         temp_ptr = (char *)udev->scratch.data;
2365         temp_size = sizeof(udev->scratch.data);
2366
2367         vendor_id = UGETW(udd->idVendor);
2368         product_id = UGETW(udd->idProduct);
2369
2370         /* get serial number string */
2371         usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2372             udev->ddesc.iSerialNumber);
2373         udev->serial = strdup(temp_ptr, M_USB);
2374
2375         /* get manufacturer string */
2376         usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2377             udev->ddesc.iManufacturer);
2378         usb_trim_spaces(temp_ptr);
2379         if (temp_ptr[0] != '\0')
2380                 udev->manufacturer = strdup(temp_ptr, M_USB);
2381
2382         /* get product string */
2383         usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2384             udev->ddesc.iProduct);
2385         usb_trim_spaces(temp_ptr);
2386         if (temp_ptr[0] != '\0')
2387                 udev->product = strdup(temp_ptr, M_USB);
2388
2389 #ifdef USB_VERBOSE
2390         if (udev->manufacturer == NULL || udev->product == NULL) {
2391                 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2392                         if (kdp->vendor == vendor_id &&
2393                             (kdp->product == product_id ||
2394                             (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2395                                 break;
2396                 }
2397                 if (kdp->vendorname != NULL) {
2398                         /* XXX should use pointer to knowndevs string */
2399                         if (udev->manufacturer == NULL) {
2400                                 udev->manufacturer = strdup(kdp->vendorname,
2401                                     M_USB);
2402                         }
2403                         if (udev->product == NULL &&
2404                             (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2405                                 udev->product = strdup(kdp->productname,
2406                                     M_USB);
2407                         }
2408                 }
2409         }
2410 #endif
2411         /* Provide default strings if none were found */
2412         if (udev->manufacturer == NULL) {
2413                 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2414                 udev->manufacturer = strdup(temp_ptr, M_USB);
2415         }
2416         if (udev->product == NULL) {
2417                 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2418                 udev->product = strdup(temp_ptr, M_USB);
2419         }
2420
2421         if (do_unlock)
2422                 usbd_enum_unlock(udev);
2423 }
2424
2425 /*
2426  * Returns:
2427  * See: USB_MODE_XXX
2428  */
2429 enum usb_hc_mode
2430 usbd_get_mode(struct usb_device *udev)
2431 {
2432         return (udev->flags.usb_mode);
2433 }
2434
2435 /*
2436  * Returns:
2437  * See: USB_SPEED_XXX
2438  */
2439 enum usb_dev_speed
2440 usbd_get_speed(struct usb_device *udev)
2441 {
2442         return (udev->speed);
2443 }
2444
2445 uint32_t
2446 usbd_get_isoc_fps(struct usb_device *udev)
2447 {
2448         ;                               /* indent fix */
2449         switch (udev->speed) {
2450         case USB_SPEED_LOW:
2451         case USB_SPEED_FULL:
2452                 return (1000);
2453         default:
2454                 return (8000);
2455         }
2456 }
2457
2458 struct usb_device_descriptor *
2459 usbd_get_device_descriptor(struct usb_device *udev)
2460 {
2461         if (udev == NULL)
2462                 return (NULL);          /* be NULL safe */
2463         return (&udev->ddesc);
2464 }
2465
2466 struct usb_config_descriptor *
2467 usbd_get_config_descriptor(struct usb_device *udev)
2468 {
2469         if (udev == NULL)
2470                 return (NULL);          /* be NULL safe */
2471         return (udev->cdesc);
2472 }
2473
2474 /*------------------------------------------------------------------------*
2475  *      usb_test_quirk - test a device for a given quirk
2476  *
2477  * Return values:
2478  * 0: The USB device does not have the given quirk.
2479  * Else: The USB device has the given quirk.
2480  *------------------------------------------------------------------------*/
2481 uint8_t
2482 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2483 {
2484         uint8_t found;
2485         uint8_t x;
2486
2487         if (quirk == UQ_NONE)
2488                 return (0);
2489
2490         /* search the automatic per device quirks first */
2491
2492         for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2493                 if (uaa->device->autoQuirk[x] == quirk)
2494                         return (1);
2495         }
2496
2497         /* search global quirk table, if any */
2498
2499         found = (usb_test_quirk_p) (&uaa->info, quirk);
2500
2501         return (found);
2502 }
2503
2504 struct usb_interface_descriptor *
2505 usbd_get_interface_descriptor(struct usb_interface *iface)
2506 {
2507         if (iface == NULL)
2508                 return (NULL);          /* be NULL safe */
2509         return (iface->idesc);
2510 }
2511
2512 uint8_t
2513 usbd_get_interface_altindex(struct usb_interface *iface)
2514 {
2515         return (iface->alt_index);
2516 }
2517
2518 uint8_t
2519 usbd_get_bus_index(struct usb_device *udev)
2520 {
2521         return ((uint8_t)device_get_unit(udev->bus->bdev));
2522 }
2523
2524 uint8_t
2525 usbd_get_device_index(struct usb_device *udev)
2526 {
2527         return (udev->device_index);
2528 }
2529
2530 #if USB_HAVE_DEVCTL
2531 static void
2532 usb_notify_addq(const char *type, struct usb_device *udev)
2533 {
2534         struct usb_interface *iface;
2535         struct sbuf *sb;
2536         int i;
2537
2538         /* announce the device */
2539         sb = sbuf_new_auto();
2540         sbuf_printf(sb,
2541 #if USB_HAVE_UGEN
2542             "ugen=%s "
2543             "cdev=%s "
2544 #endif
2545             "vendor=0x%04x "
2546             "product=0x%04x "
2547             "devclass=0x%02x "
2548             "devsubclass=0x%02x "
2549             "sernum=\"%s\" "
2550             "release=0x%04x "
2551             "mode=%s "
2552             "port=%u "
2553 #if USB_HAVE_UGEN
2554             "parent=%s"
2555 #endif
2556             "",
2557 #if USB_HAVE_UGEN
2558             udev->ugen_name,
2559             udev->ugen_name,
2560 #endif
2561             UGETW(udev->ddesc.idVendor),
2562             UGETW(udev->ddesc.idProduct),
2563             udev->ddesc.bDeviceClass,
2564             udev->ddesc.bDeviceSubClass,
2565             usb_get_serial(udev),
2566             UGETW(udev->ddesc.bcdDevice),
2567             (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2568             udev->port_no
2569 #if USB_HAVE_UGEN
2570             , udev->parent_hub != NULL ?
2571                 udev->parent_hub->ugen_name :
2572                 device_get_nameunit(device_get_parent(udev->bus->bdev))
2573 #endif
2574             );
2575         sbuf_finish(sb);
2576         devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2577         sbuf_delete(sb);
2578
2579         /* announce each interface */
2580         for (i = 0; i < USB_IFACE_MAX; i++) {
2581                 iface = usbd_get_iface(udev, i);
2582                 if (iface == NULL)
2583                         break;          /* end of interfaces */
2584                 if (iface->idesc == NULL)
2585                         continue;       /* no interface descriptor */
2586
2587                 sb = sbuf_new_auto();
2588                 sbuf_printf(sb,
2589 #if USB_HAVE_UGEN
2590                     "ugen=%s "
2591                     "cdev=%s "
2592 #endif
2593                     "vendor=0x%04x "
2594                     "product=0x%04x "
2595                     "devclass=0x%02x "
2596                     "devsubclass=0x%02x "
2597                     "sernum=\"%s\" "
2598                     "release=0x%04x "
2599                     "mode=%s "
2600                     "interface=%d "
2601                     "endpoints=%d "
2602                     "intclass=0x%02x "
2603                     "intsubclass=0x%02x "
2604                     "intprotocol=0x%02x",
2605 #if USB_HAVE_UGEN
2606                     udev->ugen_name,
2607                     udev->ugen_name,
2608 #endif
2609                     UGETW(udev->ddesc.idVendor),
2610                     UGETW(udev->ddesc.idProduct),
2611                     udev->ddesc.bDeviceClass,
2612                     udev->ddesc.bDeviceSubClass,
2613                     usb_get_serial(udev),
2614                     UGETW(udev->ddesc.bcdDevice),
2615                     (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2616                     iface->idesc->bInterfaceNumber,
2617                     iface->idesc->bNumEndpoints,
2618                     iface->idesc->bInterfaceClass,
2619                     iface->idesc->bInterfaceSubClass,
2620                     iface->idesc->bInterfaceProtocol);
2621                 sbuf_finish(sb);
2622                 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2623                 sbuf_delete(sb);
2624         }
2625 }
2626 #endif
2627
2628 #if USB_HAVE_UGEN
2629 /*------------------------------------------------------------------------*
2630  *      usb_fifo_free_wrap
2631  *
2632  * This function will free the FIFOs.
2633  *
2634  * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2635  * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2636  * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2637  * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2638  * control endpoint FIFOs. If "iface_index" is not set to
2639  * "USB_IFACE_INDEX_ANY" the flag has no effect.
2640  *------------------------------------------------------------------------*/
2641 static void
2642 usb_fifo_free_wrap(struct usb_device *udev,
2643     uint8_t iface_index, uint8_t flag)
2644 {
2645         struct usb_fifo *f;
2646         uint16_t i;
2647
2648         /*
2649          * Free any USB FIFOs on the given interface:
2650          */
2651         for (i = 0; i != USB_FIFO_MAX; i++) {
2652                 f = udev->fifo[i];
2653                 if (f == NULL) {
2654                         continue;
2655                 }
2656                 /* Check if the interface index matches */
2657                 if (iface_index == f->iface_index) {
2658                         if (f->methods != &usb_ugen_methods) {
2659                                 /*
2660                                  * Don't free any non-generic FIFOs in
2661                                  * this case.
2662                                  */
2663                                 continue;
2664                         }
2665                         if ((f->dev_ep_index == 0) &&
2666                             (f->fs_xfer == NULL)) {
2667                                 /* no need to free this FIFO */
2668                                 continue;
2669                         }
2670                 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2671                         if ((f->methods == &usb_ugen_methods) &&
2672                             (f->dev_ep_index == 0) &&
2673                             (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2674                             (f->fs_xfer == NULL)) {
2675                                 /* no need to free this FIFO */
2676                                 continue;
2677                         }
2678                 } else {
2679                         /* no need to free this FIFO */
2680                         continue;
2681                 }
2682                 /* wait for pending refs to go away */
2683                 usb_wait_pending_ref_locked(udev);
2684
2685                 /* free this FIFO */
2686                 usb_fifo_free(f);
2687
2688                 /* restore refcount */
2689                 usb_ref_restore_locked(udev);
2690         }
2691 }
2692 #endif
2693
2694 /*------------------------------------------------------------------------*
2695  *      usb_peer_can_wakeup
2696  *
2697  * Return values:
2698  * 0: Peer cannot do resume signalling.
2699  * Else: Peer can do resume signalling.
2700  *------------------------------------------------------------------------*/
2701 uint8_t
2702 usb_peer_can_wakeup(struct usb_device *udev)
2703 {
2704         const struct usb_config_descriptor *cdp;
2705
2706         cdp = udev->cdesc;
2707         if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2708                 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2709         }
2710         return (0);                     /* not supported */
2711 }
2712
2713 void
2714 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2715 {
2716
2717         KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2718
2719         DPRINTF("udev %p state %s -> %s\n", udev,
2720             usb_statestr(udev->state), usb_statestr(state));
2721
2722 #if USB_HAVE_UGEN
2723         mtx_lock(&usb_ref_lock);
2724 #endif
2725         udev->state = state;
2726 #if USB_HAVE_UGEN
2727         mtx_unlock(&usb_ref_lock);
2728 #endif
2729         if (udev->bus->methods->device_state_change != NULL)
2730                 (udev->bus->methods->device_state_change) (udev);
2731 }
2732
2733 enum usb_dev_state
2734 usb_get_device_state(struct usb_device *udev)
2735 {
2736         if (udev == NULL)
2737                 return (USB_STATE_DETACHED);
2738         return (udev->state);
2739 }
2740
2741 uint8_t
2742 usbd_device_attached(struct usb_device *udev)
2743 {
2744         return (udev->state > USB_STATE_DETACHED);
2745 }
2746
2747 /*
2748  * The following function locks enumerating the given USB device. If
2749  * the lock is already grabbed this function returns zero. Else a
2750  * non-zero value is returned.
2751  */
2752 uint8_t
2753 usbd_enum_lock(struct usb_device *udev)
2754 {
2755         if (sx_xlocked(&udev->enum_sx))
2756                 return (0);
2757
2758         sx_xlock(&udev->enum_sx);
2759         sx_xlock(&udev->sr_sx);
2760         /*
2761          * NEWBUS LOCK NOTE: We should check if any parent SX locks
2762          * are locked before locking Giant. Else the lock can be
2763          * locked multiple times.
2764          */
2765         mtx_lock(&Giant);
2766         return (1);
2767 }
2768
2769 /* The following function unlocks enumerating the given USB device. */
2770
2771 void
2772 usbd_enum_unlock(struct usb_device *udev)
2773 {
2774         mtx_unlock(&Giant);
2775         sx_xunlock(&udev->enum_sx);
2776         sx_xunlock(&udev->sr_sx);
2777 }
2778
2779 /* The following function locks suspend and resume. */
2780
2781 void
2782 usbd_sr_lock(struct usb_device *udev)
2783 {
2784         sx_xlock(&udev->sr_sx);
2785         /*
2786          * NEWBUS LOCK NOTE: We should check if any parent SX locks
2787          * are locked before locking Giant. Else the lock can be
2788          * locked multiple times.
2789          */
2790         mtx_lock(&Giant);
2791 }
2792
2793 /* The following function unlocks suspend and resume. */
2794
2795 void
2796 usbd_sr_unlock(struct usb_device *udev)
2797 {
2798         mtx_unlock(&Giant);
2799         sx_xunlock(&udev->sr_sx);
2800 }
2801
2802 /*
2803  * The following function checks the enumerating lock for the given
2804  * USB device.
2805  */
2806
2807 uint8_t
2808 usbd_enum_is_locked(struct usb_device *udev)
2809 {
2810         return (sx_xlocked(&udev->enum_sx));
2811 }
2812
2813 /*
2814  * The following function is used to set the per-interface specific
2815  * plug and play information. The string referred to by the pnpinfo
2816  * argument can safely be freed after calling this function. The
2817  * pnpinfo of an interface will be reset at device detach or when
2818  * passing a NULL argument to this function. This function
2819  * returns zero on success, else a USB_ERR_XXX failure code.
2820  */
2821
2822 usb_error_t
2823 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2824 {
2825         struct usb_interface *iface;
2826
2827         iface = usbd_get_iface(udev, iface_index);
2828         if (iface == NULL)
2829                 return (USB_ERR_INVAL);
2830
2831         if (iface->pnpinfo != NULL) {
2832                 free(iface->pnpinfo, M_USBDEV);
2833                 iface->pnpinfo = NULL;
2834         }
2835
2836         if (pnpinfo == NULL || pnpinfo[0] == 0)
2837                 return (0);             /* success */
2838
2839         iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2840         if (iface->pnpinfo == NULL)
2841                 return (USB_ERR_NOMEM);
2842
2843         return (0);                     /* success */
2844 }
2845
2846 usb_error_t
2847 usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
2848 {
2849         uint8_t x;
2850
2851         for (x = 0; x != USB_MAX_AUTO_QUIRK; x++) {
2852                 if (udev->autoQuirk[x] == 0 ||
2853                     udev->autoQuirk[x] == quirk) {
2854                         udev->autoQuirk[x] = quirk;
2855                         return (0);     /* success */
2856                 }
2857         }
2858         return (USB_ERR_NOMEM);
2859 }
2860
2861 /*
2862  * The following function is used to select the endpoint mode. It
2863  * should not be called outside enumeration context.
2864  */
2865
2866 usb_error_t
2867 usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep,
2868     uint8_t ep_mode)
2869 {
2870         usb_error_t error;
2871         uint8_t do_unlock;
2872
2873         /* Prevent re-enumeration */
2874         do_unlock = usbd_enum_lock(udev);
2875
2876         if (udev->bus->methods->set_endpoint_mode != NULL) {
2877                 error = (udev->bus->methods->set_endpoint_mode) (
2878                     udev, ep, ep_mode);
2879         } else if (ep_mode != USB_EP_MODE_DEFAULT) {
2880                 error = USB_ERR_INVAL;
2881         } else {
2882                 error = 0;
2883         }
2884
2885         /* only set new mode regardless of error */
2886         ep->ep_mode = ep_mode;
2887
2888         if (do_unlock)
2889                 usbd_enum_unlock(udev);
2890         return (error);
2891 }
2892
2893 uint8_t
2894 usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
2895 {
2896         return (ep->ep_mode);
2897 }