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