sys/dev/usb/usb_device.c

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