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