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