sys/dev/usb/usb_device.c

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/stdint.h>
  28 #include <sys/stddef.h>
  29 #include <sys/param.h>
  30 #include <sys/queue.h>
  31 #include <sys/types.h>
  32 #include <sys/systm.h>
  33 #include <sys/kernel.h>
  34 #include <sys/bus.h>
  35 #include <sys/module.h>
  36 #include <sys/lock.h>
  37 #include <sys/mutex.h>
  38 #include <sys/condvar.h>
  39 #include <sys/sysctl.h>
  40 #include <sys/sx.h>
  41 #include <sys/unistd.h>
  42 #include <sys/callout.h>
  43 #include <sys/malloc.h>
  44 #include <sys/priv.h>
  45 #include <sys/conf.h>
  46 #include <sys/fcntl.h>
  47
  48 #include <dev/usb/usb.h>
  49 #include <dev/usb/usbdi.h>
  50 #include <dev/usb/usbdi_util.h>
  51 #include <dev/usb/usb_ioctl.h>
  52
  53 #if USB_HAVE_UGEN
  54 #include <sys/sbuf.h>
  55 #endif
  56
  57 #include "usbdevs.h"
  58
  59 #define USB_DEBUG_VAR usb_debug
  60
  61 #include <dev/usb/usb_core.h>
  62 #include <dev/usb/usb_debug.h>
  63 #include <dev/usb/usb_process.h>
  64 #include <dev/usb/usb_device.h>
  65 #include <dev/usb/usb_busdma.h>
  66 #include <dev/usb/usb_transfer.h>
  67 #include <dev/usb/usb_request.h>
  68 #include <dev/usb/usb_dynamic.h>
  69 #include <dev/usb/usb_hub.h>
  70 #include <dev/usb/usb_util.h>
  71 #include <dev/usb/usb_msctest.h>
  72 #if USB_HAVE_UGEN
  73 #include <dev/usb/usb_dev.h>
  74 #include <dev/usb/usb_generic.h>
  75 #endif
  76
  77 #include <dev/usb/quirk/usb_quirk.h>
  78
  79 #include <dev/usb/usb_controller.h>
  80 #include <dev/usb/usb_bus.h>
  81
  82 /* function prototypes  */
  83
  84 static void     usb_init_endpoint(struct usb_device *, uint8_t,
  85                     struct usb_endpoint_descriptor *,
  86                     struct usb_endpoint_ss_comp_descriptor *,
  87                     struct usb_endpoint *);
  88 static void     usb_unconfigure(struct usb_device *, uint8_t);
  89 static void     usb_detach_device_sub(struct usb_device *, device_t *,
  90                     char **, uint8_t);
  91 static uint8_t  usb_probe_and_attach_sub(struct usb_device *,
  92                     struct usb_attach_arg *);
  93 static void     usb_init_attach_arg(struct usb_device *,
  94                     struct usb_attach_arg *);
  95 static void     usb_suspend_resume_sub(struct usb_device *, device_t,
  96                     uint8_t);
  97 static void     usbd_clear_stall_proc(struct usb_proc_msg *_pm);
  98 static usb_error_t usb_config_parse(struct usb_device *, uint8_t, uint8_t);
  99 static void     usbd_set_device_strings(struct usb_device *);
 100 #if USB_HAVE_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     char **ppnpinfo, uint8_t flag)
1036 {
1037         device_t dev;
1038         char *pnpinfo;
1039         int err;
1040
1041         dev = *ppdev;
1042         if (dev) {
1043                 /*
1044                  * NOTE: It is important to clear "*ppdev" before deleting
1045                  * the child due to some device methods being called late
1046                  * during the delete process !
1047                  */
1048                 *ppdev = NULL;
1049
1050                 device_printf(dev, "at %s, port %d, addr %d "
1051                     "(disconnected)\n",
1052                     device_get_nameunit(udev->parent_dev),
1053                     udev->port_no, udev->address);
1054
1055                 if (device_is_attached(dev)) {
1056                         if (udev->flags.peer_suspended) {
1057                                 err = DEVICE_RESUME(dev);
1058                                 if (err) {
1059                                         device_printf(dev, "Resume failed\n");
1060                                 }
1061                         }
1062                         if (device_detach(dev)) {
1063                                 goto error;
1064                         }
1065                 }
1066                 if (device_delete_child(udev->parent_dev, dev)) {
1067                         goto error;
1068                 }
1069         }
1070
1071         pnpinfo = *ppnpinfo;
1072         if (pnpinfo != NULL) {
1073                 *ppnpinfo = NULL;
1074                 free(pnpinfo, M_USBDEV);
1075         }
1076         return;
1077
1078 error:
1079         /* Detach is not allowed to fail in the USB world */
1080         panic("usb_detach_device_sub: A USB driver would not detach\n");
1081 }
1082
1083 /*------------------------------------------------------------------------*
1084  *      usb_detach_device
1085  *
1086  * The following function will detach the matching interfaces.
1087  * This function is NULL safe.
1088  *
1089  * Flag values, see "USB_UNCFG_FLAG_XXX".
1090  *------------------------------------------------------------------------*/
1091 void
1092 usb_detach_device(struct usb_device *udev, uint8_t iface_index,
1093     uint8_t flag)
1094 {
1095         struct usb_interface *iface;
1096         uint8_t i;
1097
1098         if (udev == NULL) {
1099                 /* nothing to do */
1100                 return;
1101         }
1102         DPRINTFN(4, "udev=%p\n", udev);
1103
1104         sx_assert(&udev->enum_sx, SA_LOCKED);
1105
1106         /*
1107          * First detach the child to give the child's detach routine a
1108          * chance to detach the sub-devices in the correct order.
1109          * Then delete the child using "device_delete_child()" which
1110          * will detach all sub-devices from the bottom and upwards!
1111          */
1112         if (iface_index != USB_IFACE_INDEX_ANY) {
1113                 i = iface_index;
1114                 iface_index = i + 1;
1115         } else {
1116                 i = 0;
1117                 iface_index = USB_IFACE_MAX;
1118         }
1119
1120         /* do the detach */
1121
1122         for (; i != iface_index; i++) {
1123
1124                 iface = usbd_get_iface(udev, i);
1125                 if (iface == NULL) {
1126                         /* looks like the end of the USB interfaces */
1127                         break;
1128                 }
1129                 usb_detach_device_sub(udev, &iface->subdev,
1130                     &iface->pnpinfo, flag);
1131         }
1132 }
1133
1134 /*------------------------------------------------------------------------*
1135  *      usb_probe_and_attach_sub
1136  *
1137  * Returns:
1138  *    0: Success
1139  * Else: Failure
1140  *------------------------------------------------------------------------*/
1141 static uint8_t
1142 usb_probe_and_attach_sub(struct usb_device *udev,
1143     struct usb_attach_arg *uaa)
1144 {
1145         struct usb_interface *iface;
1146         device_t dev;
1147         int err;
1148
1149         iface = uaa->iface;
1150         if (iface->parent_iface_index != USB_IFACE_INDEX_ANY) {
1151                 /* leave interface alone */
1152                 return (0);
1153         }
1154         dev = iface->subdev;
1155         if (dev) {
1156
1157                 /* clean up after module unload */
1158
1159                 if (device_is_attached(dev)) {
1160                         /* already a device there */
1161                         return (0);
1162                 }
1163                 /* clear "iface->subdev" as early as possible */
1164
1165                 iface->subdev = NULL;
1166
1167                 if (device_delete_child(udev->parent_dev, dev)) {
1168
1169                         /*
1170                          * Panic here, else one can get a double call
1171                          * to device_detach().  USB devices should
1172                          * never fail on detach!
1173                          */
1174                         panic("device_delete_child() failed\n");
1175                 }
1176         }
1177         if (uaa->temp_dev == NULL) {
1178
1179                 /* create a new child */
1180                 uaa->temp_dev = device_add_child(udev->parent_dev, NULL, -1);
1181                 if (uaa->temp_dev == NULL) {
1182                         device_printf(udev->parent_dev,
1183                             "Device creation failed\n");
1184                         return (1);     /* failure */
1185                 }
1186                 device_set_ivars(uaa->temp_dev, uaa);
1187                 device_quiet(uaa->temp_dev);
1188         }
1189         /*
1190          * Set "subdev" before probe and attach so that "devd" gets
1191          * the information it needs.
1192          */
1193         iface->subdev = uaa->temp_dev;
1194
1195         if (device_probe_and_attach(iface->subdev) == 0) {
1196                 /*
1197                  * The USB attach arguments are only available during probe
1198                  * and attach !
1199                  */
1200                 uaa->temp_dev = NULL;
1201                 device_set_ivars(iface->subdev, NULL);
1202
1203                 if (udev->flags.peer_suspended) {
1204                         err = DEVICE_SUSPEND(iface->subdev);
1205                         if (err)
1206                                 device_printf(iface->subdev, "Suspend failed\n");
1207                 }
1208                 return (0);             /* success */
1209         } else {
1210                 /* No USB driver found */
1211                 iface->subdev = NULL;
1212         }
1213         return (1);                     /* failure */
1214 }
1215
1216 /*------------------------------------------------------------------------*
1217  *      usbd_set_parent_iface
1218  *
1219  * Using this function will lock the alternate interface setting on an
1220  * interface. It is typically used for multi interface drivers. In USB
1221  * device side mode it is assumed that the alternate interfaces all
1222  * have the same endpoint descriptors. The default parent index value
1223  * is "USB_IFACE_INDEX_ANY". Then the alternate setting value is not
1224  * locked.
1225  *------------------------------------------------------------------------*/
1226 void
1227 usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
1228     uint8_t parent_index)
1229 {
1230         struct usb_interface *iface;
1231
1232         iface = usbd_get_iface(udev, iface_index);
1233         if (iface) {
1234                 iface->parent_iface_index = parent_index;
1235         }
1236 }
1237
1238 static void
1239 usb_init_attach_arg(struct usb_device *udev,
1240     struct usb_attach_arg *uaa)
1241 {
1242         bzero(uaa, sizeof(*uaa));
1243
1244         uaa->device = udev;
1245         uaa->usb_mode = udev->flags.usb_mode;
1246         uaa->port = udev->port_no;
1247         uaa->dev_state = UAA_DEV_READY;
1248
1249         uaa->info.idVendor = UGETW(udev->ddesc.idVendor);
1250         uaa->info.idProduct = UGETW(udev->ddesc.idProduct);
1251         uaa->info.bcdDevice = UGETW(udev->ddesc.bcdDevice);
1252         uaa->info.bDeviceClass = udev->ddesc.bDeviceClass;
1253         uaa->info.bDeviceSubClass = udev->ddesc.bDeviceSubClass;
1254         uaa->info.bDeviceProtocol = udev->ddesc.bDeviceProtocol;
1255         uaa->info.bConfigIndex = udev->curr_config_index;
1256         uaa->info.bConfigNum = udev->curr_config_no;
1257 }
1258
1259 /*------------------------------------------------------------------------*
1260  *      usb_probe_and_attach
1261  *
1262  * This function is called from "uhub_explore_sub()",
1263  * "usb_handle_set_config()" and "usb_handle_request()".
1264  *
1265  * Returns:
1266  *    0: Success
1267  * Else: A control transfer failed
1268  *------------------------------------------------------------------------*/
1269 usb_error_t
1270 usb_probe_and_attach(struct usb_device *udev, uint8_t iface_index)
1271 {
1272         struct usb_attach_arg uaa;
1273         struct usb_interface *iface;
1274         uint8_t i;
1275         uint8_t j;
1276         uint8_t do_unlock;
1277
1278         if (udev == NULL) {
1279                 DPRINTF("udev == NULL\n");
1280                 return (USB_ERR_INVAL);
1281         }
1282         /* automatic locking */
1283         if (usbd_enum_is_locked(udev)) {
1284                 do_unlock = 0;
1285         } else {
1286                 do_unlock = 1;
1287                 usbd_enum_lock(udev);
1288         }
1289
1290         if (udev->curr_config_index == USB_UNCONFIG_INDEX) {
1291                 /* do nothing - no configuration has been set */
1292                 goto done;
1293         }
1294         /* setup USB attach arguments */
1295
1296         usb_init_attach_arg(udev, &uaa);
1297
1298         /* Check if only one interface should be probed: */
1299         if (iface_index != USB_IFACE_INDEX_ANY) {
1300                 i = iface_index;
1301                 j = i + 1;
1302         } else {
1303                 i = 0;
1304                 j = USB_IFACE_MAX;
1305         }
1306
1307         /* Do the probe and attach */
1308         for (; i != j; i++) {
1309
1310                 iface = usbd_get_iface(udev, i);
1311                 if (iface == NULL) {
1312                         /*
1313                          * Looks like the end of the USB
1314                          * interfaces !
1315                          */
1316                         DPRINTFN(2, "end of interfaces "
1317                             "at %u\n", i);
1318                         break;
1319                 }
1320                 if (iface->idesc == NULL) {
1321                         /* no interface descriptor */
1322                         continue;
1323                 }
1324                 uaa.iface = iface;
1325
1326                 uaa.info.bInterfaceClass =
1327                     iface->idesc->bInterfaceClass;
1328                 uaa.info.bInterfaceSubClass =
1329                     iface->idesc->bInterfaceSubClass;
1330                 uaa.info.bInterfaceProtocol =
1331                     iface->idesc->bInterfaceProtocol;
1332                 uaa.info.bIfaceIndex = i;
1333                 uaa.info.bIfaceNum =
1334                     iface->idesc->bInterfaceNumber;
1335                 uaa.use_generic = 0;
1336                 uaa.driver_info = 0;    /* reset driver_info */
1337
1338                 DPRINTFN(2, "iclass=%u/%u/%u iindex=%u/%u\n",
1339                     uaa.info.bInterfaceClass,
1340                     uaa.info.bInterfaceSubClass,
1341                     uaa.info.bInterfaceProtocol,
1342                     uaa.info.bIfaceIndex,
1343                     uaa.info.bIfaceNum);
1344
1345                 /* try specific interface drivers first */
1346
1347                 if (usb_probe_and_attach_sub(udev, &uaa)) {
1348                         /* ignore */
1349                 }
1350                 /* try generic interface drivers last */
1351
1352                 uaa.use_generic = 1;
1353                 uaa.driver_info = 0;    /* reset driver_info */
1354
1355                 if (usb_probe_and_attach_sub(udev, &uaa)) {
1356                         /* ignore */
1357                 }
1358         }
1359
1360         if (uaa.temp_dev) {
1361                 /* remove the last created child; it is unused */
1362
1363                 if (device_delete_child(udev->parent_dev, uaa.temp_dev)) {
1364                         DPRINTFN(0, "device delete child failed\n");
1365                 }
1366         }
1367 done:
1368         if (do_unlock)
1369                 usbd_enum_unlock(udev);
1370
1371         return (0);
1372 }
1373
1374 /*------------------------------------------------------------------------*
1375  *      usb_suspend_resume_sub
1376  *
1377  * This function is called when the suspend or resume methods should
1378  * be executed on an USB device.
1379  *------------------------------------------------------------------------*/
1380 static void
1381 usb_suspend_resume_sub(struct usb_device *udev, device_t dev, uint8_t do_suspend)
1382 {
1383         int err;
1384
1385         if (dev == NULL) {
1386                 return;
1387         }
1388         if (!device_is_attached(dev)) {
1389                 return;
1390         }
1391         if (do_suspend) {
1392                 err = DEVICE_SUSPEND(dev);
1393         } else {
1394                 err = DEVICE_RESUME(dev);
1395         }
1396         if (err) {
1397                 device_printf(dev, "%s failed\n",
1398                     do_suspend ? "Suspend" : "Resume");
1399         }
1400 }
1401
1402 /*------------------------------------------------------------------------*
1403  *      usb_suspend_resume
1404  *
1405  * The following function will suspend or resume the USB device.
1406  *
1407  * Returns:
1408  *    0: Success
1409  * Else: Failure
1410  *------------------------------------------------------------------------*/
1411 usb_error_t
1412 usb_suspend_resume(struct usb_device *udev, uint8_t do_suspend)
1413 {
1414         struct usb_interface *iface;
1415         uint8_t i;
1416
1417         if (udev == NULL) {
1418                 /* nothing to do */
1419                 return (0);
1420         }
1421         DPRINTFN(4, "udev=%p do_suspend=%d\n", udev, do_suspend);
1422
1423         sx_assert(&udev->sr_sx, SA_LOCKED);
1424
1425         USB_BUS_LOCK(udev->bus);
1426         /* filter the suspend events */
1427         if (udev->flags.peer_suspended == do_suspend) {
1428                 USB_BUS_UNLOCK(udev->bus);
1429                 /* nothing to do */
1430                 return (0);
1431         }
1432         udev->flags.peer_suspended = do_suspend;
1433         USB_BUS_UNLOCK(udev->bus);
1434
1435         /* do the suspend or resume */
1436
1437         for (i = 0; i != USB_IFACE_MAX; i++) {
1438
1439                 iface = usbd_get_iface(udev, i);
1440                 if (iface == NULL) {
1441                         /* looks like the end of the USB interfaces */
1442                         break;
1443                 }
1444                 usb_suspend_resume_sub(udev, iface->subdev, do_suspend);
1445         }
1446         return (0);
1447 }
1448
1449 /*------------------------------------------------------------------------*
1450  *      usbd_clear_stall_proc
1451  *
1452  * This function performs generic USB clear stall operations.
1453  *------------------------------------------------------------------------*/
1454 static void
1455 usbd_clear_stall_proc(struct usb_proc_msg *_pm)
1456 {
1457         struct usb_clear_stall_msg *pm = (void *)_pm;
1458         struct usb_device *udev = pm->udev;
1459
1460         /* Change lock */
1461         USB_BUS_UNLOCK(udev->bus);
1462         mtx_lock(&udev->device_mtx);
1463
1464         /* Start clear stall callback */
1465         usbd_transfer_start(udev->ctrl_xfer[1]);
1466
1467         /* Change lock */
1468         mtx_unlock(&udev->device_mtx);
1469         USB_BUS_LOCK(udev->bus);
1470 }
1471
1472 /*------------------------------------------------------------------------*
1473  *      usb_alloc_device
1474  *
1475  * This function allocates a new USB device. This function is called
1476  * when a new device has been put in the powered state, but not yet in
1477  * the addressed state. Get initial descriptor, set the address, get
1478  * full descriptor and get strings.
1479  *
1480  * Return values:
1481  *    0: Failure
1482  * Else: Success
1483  *------------------------------------------------------------------------*/
1484 struct usb_device *
1485 usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
1486     struct usb_device *parent_hub, uint8_t depth, uint8_t port_index,
1487     uint8_t port_no, enum usb_dev_speed speed, enum usb_hc_mode mode)
1488 {
1489         struct usb_attach_arg uaa;
1490         struct usb_device *udev;
1491         struct usb_device *adev;
1492         struct usb_device *hub;
1493         uint8_t *scratch_ptr;
1494         size_t scratch_size;
1495         usb_error_t err;
1496         uint8_t device_index;
1497         uint8_t config_index;
1498         uint8_t config_quirk;
1499         uint8_t set_config_failed;
1500
1501         DPRINTF("parent_dev=%p, bus=%p, parent_hub=%p, depth=%u, "
1502             "port_index=%u, port_no=%u, speed=%u, usb_mode=%u\n",
1503             parent_dev, bus, parent_hub, depth, port_index, port_no,
1504             speed, mode);
1505
1506         /*
1507          * Find an unused device index. In USB Host mode this is the
1508          * same as the device address.
1509          *
1510          * Device index zero is not used and device index 1 should
1511          * always be the root hub.
1512          */
1513         for (device_index = USB_ROOT_HUB_ADDR;
1514             (device_index != bus->devices_max) &&
1515             (bus->devices[device_index] != NULL);
1516             device_index++) /* nop */;
1517
1518         if (device_index == bus->devices_max) {
1519                 device_printf(bus->bdev,
1520                     "No free USB device index for new device\n");
1521                 return (NULL);
1522         }
1523
1524         if (depth > 0x10) {
1525                 device_printf(bus->bdev,
1526                     "Invalid device depth\n");
1527                 return (NULL);
1528         }
1529         udev = malloc(sizeof(*udev), M_USB, M_WAITOK | M_ZERO);
1530         if (udev == NULL) {
1531                 return (NULL);
1532         }
1533         /* initialise our SX-lock */
1534         sx_init_flags(&udev->ctrl_sx, "USB device SX lock", SX_DUPOK);
1535
1536         /* initialise our SX-lock */
1537         sx_init_flags(&udev->enum_sx, "USB config SX lock", SX_DUPOK);
1538         sx_init_flags(&udev->sr_sx, "USB suspend and resume SX lock", SX_DUPOK);
1539
1540         cv_init(&udev->ctrlreq_cv, "WCTRL");
1541         cv_init(&udev->ref_cv, "UGONE");
1542
1543         /* initialise our mutex */
1544         mtx_init(&udev->device_mtx, "USB device mutex", NULL, MTX_DEF);
1545
1546         /* initialise generic clear stall */
1547         udev->cs_msg[0].hdr.pm_callback = &usbd_clear_stall_proc;
1548         udev->cs_msg[0].udev = udev;
1549         udev->cs_msg[1].hdr.pm_callback = &usbd_clear_stall_proc;
1550         udev->cs_msg[1].udev = udev;
1551
1552         /* initialise some USB device fields */
1553         udev->parent_hub = parent_hub;
1554         udev->parent_dev = parent_dev;
1555         udev->port_index = port_index;
1556         udev->port_no = port_no;
1557         udev->depth = depth;
1558         udev->bus = bus;
1559         udev->address = USB_START_ADDR; /* default value */
1560         udev->plugtime = (usb_ticks_t)ticks;
1561         /*
1562          * We need to force the power mode to "on" because there are plenty
1563          * of USB devices out there that do not work very well with
1564          * automatic suspend and resume!
1565          */
1566         udev->power_mode = usbd_filter_power_mode(udev, USB_POWER_MODE_ON);
1567         udev->pwr_save.last_xfer_time = ticks;
1568         /* we are not ready yet */
1569         udev->refcount = 1;
1570
1571         /* set up default endpoint descriptor */
1572         udev->ctrl_ep_desc.bLength = sizeof(udev->ctrl_ep_desc);
1573         udev->ctrl_ep_desc.bDescriptorType = UDESC_ENDPOINT;
1574         udev->ctrl_ep_desc.bEndpointAddress = USB_CONTROL_ENDPOINT;
1575         udev->ctrl_ep_desc.bmAttributes = UE_CONTROL;
1576         udev->ctrl_ep_desc.wMaxPacketSize[0] = USB_MAX_IPACKET;
1577         udev->ctrl_ep_desc.wMaxPacketSize[1] = 0;
1578         udev->ctrl_ep_desc.bInterval = 0;
1579
1580         /* set up default endpoint companion descriptor */
1581         udev->ctrl_ep_comp_desc.bLength = sizeof(udev->ctrl_ep_comp_desc);
1582         udev->ctrl_ep_comp_desc.bDescriptorType = UDESC_ENDPOINT_SS_COMP;
1583
1584         udev->ddesc.bMaxPacketSize = USB_MAX_IPACKET;
1585
1586         udev->speed = speed;
1587         udev->flags.usb_mode = mode;
1588
1589         /* search for our High Speed USB HUB, if any */
1590
1591         adev = udev;
1592         hub = udev->parent_hub;
1593
1594         while (hub) {
1595                 if (hub->speed == USB_SPEED_HIGH) {
1596                         udev->hs_hub_addr = hub->address;
1597                         udev->parent_hs_hub = hub;
1598                         udev->hs_port_no = adev->port_no;
1599                         break;
1600                 }
1601                 adev = hub;
1602                 hub = hub->parent_hub;
1603         }
1604
1605         /* init the default endpoint */
1606         usb_init_endpoint(udev, 0,
1607             &udev->ctrl_ep_desc,
1608             &udev->ctrl_ep_comp_desc,
1609             &udev->ctrl_ep);
1610
1611         /* set device index */
1612         udev->device_index = device_index;
1613
1614 #if USB_HAVE_UGEN
1615         /* Create ugen name */
1616         snprintf(udev->ugen_name, sizeof(udev->ugen_name),
1617             USB_GENERIC_NAME "%u.%u", device_get_unit(bus->bdev),
1618             device_index);
1619         LIST_INIT(&udev->pd_list);
1620
1621         /* Create the control endpoint device */
1622         udev->ctrl_dev = usb_make_dev(udev, 0, FREAD|FWRITE);
1623
1624         /* Create a link from /dev/ugenX.X to the default endpoint */
1625         make_dev_alias(udev->ctrl_dev, "%s", udev->ugen_name);
1626 #endif
1627         /* Initialise device */
1628         if (bus->methods->device_init != NULL) {
1629                 err = (bus->methods->device_init) (udev);
1630                 if (err != 0) {
1631                         DPRINTFN(0, "device init %d failed "
1632                             "(%s, ignored)\n", device_index,
1633                             usbd_errstr(err));
1634                         goto done;
1635                 }
1636         }
1637         /* set powered device state after device init is complete */
1638         usb_set_device_state(udev, USB_STATE_POWERED);
1639
1640         if (udev->flags.usb_mode == USB_MODE_HOST) {
1641
1642                 err = usbd_req_set_address(udev, NULL, device_index);
1643
1644                 /*
1645                  * This is the new USB device address from now on, if
1646                  * the set address request didn't set it already.
1647                  */
1648                 if (udev->address == USB_START_ADDR)
1649                         udev->address = device_index;
1650
1651                 /*
1652                  * We ignore any set-address errors, hence there are
1653                  * buggy USB devices out there that actually receive
1654                  * the SETUP PID, but manage to set the address before
1655                  * the STATUS stage is ACK'ed. If the device responds
1656                  * to the subsequent get-descriptor at the new
1657                  * address, then we know that the set-address command
1658                  * was successful.
1659                  */
1660                 if (err) {
1661                         DPRINTFN(0, "set address %d failed "
1662                             "(%s, ignored)\n", udev->address,
1663                             usbd_errstr(err));
1664                 }
1665         } else {
1666                 /* We are not self powered */
1667                 udev->flags.self_powered = 0;
1668
1669                 /* Set unconfigured state */
1670                 udev->curr_config_no = USB_UNCONFIG_NO;
1671                 udev->curr_config_index = USB_UNCONFIG_INDEX;
1672
1673                 /* Setup USB descriptors */
1674                 err = (usb_temp_setup_by_index_p) (udev, usb_template);
1675                 if (err) {
1676                         DPRINTFN(0, "setting up USB template failed maybe the USB "
1677                             "template module has not been loaded\n");
1678                         goto done;
1679                 }
1680         }
1681         usb_set_device_state(udev, USB_STATE_ADDRESSED);
1682
1683         /* setup the device descriptor and the initial "wMaxPacketSize" */
1684         err = usbd_setup_device_desc(udev, NULL);
1685
1686         if (err != 0) {
1687                 /* XXX try to re-enumerate the device */
1688                 err = usbd_req_re_enumerate(udev, NULL);
1689                 if (err)
1690                         goto done;
1691         }
1692
1693         /*
1694          * Setup temporary USB attach args so that we can figure out some
1695          * basic quirks for this device.
1696          */
1697         usb_init_attach_arg(udev, &uaa);
1698
1699         if (usb_test_quirk(&uaa, UQ_BUS_POWERED)) {
1700                 udev->flags.uq_bus_powered = 1;
1701         }
1702         if (usb_test_quirk(&uaa, UQ_NO_STRINGS)) {
1703                 udev->flags.no_strings = 1;
1704         }
1705         /*
1706          * Workaround for buggy USB devices.
1707          *
1708          * It appears that some string-less USB chips will crash and
1709          * disappear if any attempts are made to read any string
1710          * descriptors.
1711          *
1712          * Try to detect such chips by checking the strings in the USB
1713          * device descriptor. If no strings are present there we
1714          * simply disable all USB strings.
1715          */
1716         scratch_ptr = udev->bus->scratch[0].data;
1717         scratch_size = sizeof(udev->bus->scratch[0].data);
1718
1719         if (udev->ddesc.iManufacturer ||
1720             udev->ddesc.iProduct ||
1721             udev->ddesc.iSerialNumber) {
1722                 /* read out the language ID string */
1723                 err = usbd_req_get_string_desc(udev, NULL,
1724                     (char *)scratch_ptr, 4, 0, USB_LANGUAGE_TABLE);
1725         } else {
1726                 err = USB_ERR_INVAL;
1727         }
1728
1729         if (err || (scratch_ptr[0] < 4)) {
1730                 udev->flags.no_strings = 1;
1731         } else {
1732                 uint16_t langid;
1733                 uint16_t pref;
1734                 uint16_t mask;
1735                 uint8_t x;
1736
1737                 /* load preferred value and mask */
1738                 pref = usb_lang_id;
1739                 mask = usb_lang_mask;
1740
1741                 /* align length correctly */
1742                 scratch_ptr[0] &= ~1;
1743
1744                 /* fix compiler warning */
1745                 langid = 0;
1746
1747                 /* search for preferred language */
1748                 for (x = 2; (x < scratch_ptr[0]); x += 2) {
1749                         langid = UGETW(scratch_ptr + x);
1750                         if ((langid & mask) == pref)
1751                                 break;
1752                 }
1753                 if (x >= scratch_ptr[0]) {
1754                         /* pick the first language as the default */
1755                         DPRINTFN(1, "Using first language\n");
1756                         langid = UGETW(scratch_ptr + 2);
1757                 }
1758
1759                 DPRINTFN(1, "Language selected: 0x%04x\n", langid);
1760                 udev->langid = langid;
1761         }
1762
1763         /* assume 100mA bus powered for now. Changed when configured. */
1764         udev->power = USB_MIN_POWER;
1765         /* fetch the vendor and product strings from the device */
1766         usbd_set_device_strings(udev);
1767
1768         if (udev->flags.usb_mode == USB_MODE_DEVICE) {
1769                 /* USB device mode setup is complete */
1770                 err = 0;
1771                 goto config_done;
1772         }
1773
1774         /*
1775          * Most USB devices should attach to config index 0 by
1776          * default
1777          */
1778         if (usb_test_quirk(&uaa, UQ_CFG_INDEX_0)) {
1779                 config_index = 0;
1780                 config_quirk = 1;
1781         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_1)) {
1782                 config_index = 1;
1783                 config_quirk = 1;
1784         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_2)) {
1785                 config_index = 2;
1786                 config_quirk = 1;
1787         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_3)) {
1788                 config_index = 3;
1789                 config_quirk = 1;
1790         } else if (usb_test_quirk(&uaa, UQ_CFG_INDEX_4)) {
1791                 config_index = 4;
1792                 config_quirk = 1;
1793         } else {
1794                 config_index = 0;
1795                 config_quirk = 0;
1796         }
1797
1798         set_config_failed = 0;
1799 repeat_set_config:
1800
1801         DPRINTF("setting config %u\n", config_index);
1802
1803         /* get the USB device configured */
1804         err = usbd_set_config_index(udev, config_index);
1805         if (err) {
1806                 if (udev->ddesc.bNumConfigurations != 0) {
1807                         if (!set_config_failed) {
1808                                 set_config_failed = 1;
1809                                 /* XXX try to re-enumerate the device */
1810                                 err = usbd_req_re_enumerate(udev, NULL);
1811                                 if (err == 0)
1812                                         goto repeat_set_config;
1813                         }
1814                         DPRINTFN(0, "Failure selecting configuration index %u:"
1815                             "%s, port %u, addr %u (ignored)\n",
1816                             config_index, usbd_errstr(err), udev->port_no,
1817                             udev->address);
1818                 }
1819                 /*
1820                  * Some USB devices do not have any configurations. Ignore any
1821                  * set config failures!
1822                  */
1823                 err = 0;
1824                 goto config_done;
1825         }
1826         if (!config_quirk && config_index + 1 < udev->ddesc.bNumConfigurations) {
1827                 if ((udev->cdesc->bNumInterface < 2) &&
1828                     usbd_get_no_descriptors(udev->cdesc, UDESC_ENDPOINT) == 0) {
1829                         DPRINTFN(0, "Found no endpoints, trying next config\n");
1830                         config_index++;
1831                         goto repeat_set_config;
1832                 }
1833                 if (config_index == 0) {
1834                         /*
1835                          * Try to figure out if we have an
1836                          * auto-install disk there:
1837                          */
1838                         if (usb_iface_is_cdrom(udev, 0)) {
1839                                 DPRINTFN(0, "Found possible auto-install "
1840                                     "disk (trying next config)\n");
1841                                 config_index++;
1842                                 goto repeat_set_config;
1843                         }
1844                 }
1845         }
1846         EVENTHANDLER_INVOKE(usb_dev_configured, udev, &uaa);
1847         if (uaa.dev_state != UAA_DEV_READY) {
1848                 /* leave device unconfigured */
1849                 usb_unconfigure(udev, 0);
1850         }
1851
1852 config_done:
1853         DPRINTF("new dev (addr %d), udev=%p, parent_hub=%p\n",
1854             udev->address, udev, udev->parent_hub);
1855
1856         /* register our device - we are ready */
1857         usb_bus_port_set_device(bus, parent_hub ?
1858             parent_hub->hub->ports + port_index : NULL, udev, device_index);
1859
1860 #if USB_HAVE_UGEN
1861         /* Symlink the ugen device name */
1862         udev->ugen_symlink = usb_alloc_symlink(udev->ugen_name);
1863
1864         /* Announce device */
1865         printf("%s: <%s> at %s\n", udev->ugen_name,
1866             usb_get_manufacturer(udev),
1867             device_get_nameunit(udev->bus->bdev));
1868
1869         usb_notify_addq("ATTACH", udev);
1870 #endif
1871 done:
1872         if (err) {
1873                 /*
1874                  * Free USB device and all subdevices, if any.
1875                  */
1876                 usb_free_device(udev, 0);
1877                 udev = NULL;
1878         }
1879         return (udev);
1880 }
1881
1882 #if USB_HAVE_UGEN
1883 static struct cdev *
1884 usb_make_dev(struct usb_device *udev, int ep, int mode)
1885 {
1886         struct usb_fs_privdata* pd;
1887         char devname[20];
1888
1889         /* Store information to locate ourselves again later */
1890         pd = malloc(sizeof(struct usb_fs_privdata), M_USBDEV,
1891             M_WAITOK | M_ZERO);
1892         pd->bus_index = device_get_unit(udev->bus->bdev);
1893         pd->dev_index = udev->device_index;
1894         pd->ep_addr = ep;
1895         pd->mode = mode;
1896
1897         /* Now, create the device itself */
1898         snprintf(devname, sizeof(devname), "%u.%u.%u",
1899             pd->bus_index, pd->dev_index, pd->ep_addr);
1900         pd->cdev = make_dev(&usb_devsw, 0, UID_ROOT,
1901             GID_OPERATOR, 0600, USB_DEVICE_DIR "/%s", devname);
1902         pd->cdev->si_drv1 = pd;
1903
1904         return (pd->cdev);
1905 }
1906
1907 static void
1908 usb_cdev_create(struct usb_device *udev)
1909 {
1910         struct usb_config_descriptor *cd;
1911         struct usb_endpoint_descriptor *ed;
1912         struct usb_descriptor *desc;
1913         struct usb_fs_privdata* pd;
1914         struct cdev *dev;
1915         int inmode, outmode, inmask, outmask, mode;
1916         uint8_t ep;
1917
1918         KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("stale cdev entries"));
1919
1920         DPRINTFN(2, "Creating device nodes\n");
1921
1922         if (usbd_get_mode(udev) == USB_MODE_DEVICE) {
1923                 inmode = FWRITE;
1924                 outmode = FREAD;
1925         } else {                 /* USB_MODE_HOST */
1926                 inmode = FREAD;
1927                 outmode = FWRITE;
1928         }
1929
1930         inmask = 0;
1931         outmask = 0;
1932         desc = NULL;
1933
1934         /*
1935          * Collect all used endpoint numbers instead of just
1936          * generating 16 static endpoints.
1937          */
1938         cd = usbd_get_config_descriptor(udev);
1939         while ((desc = usb_desc_foreach(cd, desc))) {
1940                 /* filter out all endpoint descriptors */
1941                 if ((desc->bDescriptorType == UDESC_ENDPOINT) &&
1942                     (desc->bLength >= sizeof(*ed))) {
1943                         ed = (struct usb_endpoint_descriptor *)desc;
1944
1945                         /* update masks */
1946                         ep = ed->bEndpointAddress;
1947                         if (UE_GET_DIR(ep)  == UE_DIR_OUT)
1948                                 outmask |= 1 << UE_GET_ADDR(ep);
1949                         else
1950                                 inmask |= 1 << UE_GET_ADDR(ep);
1951                 }
1952         }
1953
1954         /* Create all available endpoints except EP0 */
1955         for (ep = 1; ep < 16; ep++) {
1956                 mode = inmask & (1 << ep) ? inmode : 0;
1957                 mode |= outmask & (1 << ep) ? outmode : 0;
1958                 if (mode == 0)
1959                         continue;       /* no IN or OUT endpoint */
1960
1961                 dev = usb_make_dev(udev, ep, mode);
1962                 pd = dev->si_drv1;
1963                 LIST_INSERT_HEAD(&udev->pd_list, pd, pd_next);
1964         }
1965 }
1966
1967 static void
1968 usb_cdev_free(struct usb_device *udev)
1969 {
1970         struct usb_fs_privdata* pd;
1971         struct cdev* pcdev;
1972
1973         DPRINTFN(2, "Freeing device nodes\n");
1974
1975         while ((pd = LIST_FIRST(&udev->pd_list)) != NULL) {
1976                 KASSERT(pd->cdev->si_drv1 == pd, ("privdata corrupt"));
1977
1978                 pcdev = pd->cdev;
1979                 pd->cdev = NULL;
1980                 LIST_REMOVE(pd, pd_next);
1981                 if (pcdev != NULL)
1982                         destroy_dev_sched_cb(pcdev, usb_cdev_cleanup, pd);
1983         }
1984 }
1985
1986 static void
1987 usb_cdev_cleanup(void* arg)
1988 {
1989         free(arg, M_USBDEV);
1990 }
1991 #endif
1992
1993 /*------------------------------------------------------------------------*
1994  *      usb_free_device
1995  *
1996  * This function is NULL safe and will free an USB device and its
1997  * children devices, if any.
1998  *
1999  * Flag values: Reserved, set to zero.
2000  *------------------------------------------------------------------------*/
2001 void
2002 usb_free_device(struct usb_device *udev, uint8_t flag)
2003 {
2004         struct usb_bus *bus;
2005
2006         if (udev == NULL)
2007                 return;         /* already freed */
2008
2009         DPRINTFN(4, "udev=%p port=%d\n", udev, udev->port_no);
2010
2011         bus = udev->bus;
2012         usb_set_device_state(udev, USB_STATE_DETACHED);
2013
2014 #if USB_HAVE_UGEN
2015         usb_notify_addq("DETACH", udev);
2016
2017         printf("%s: <%s> at %s (disconnected)\n", udev->ugen_name,
2018             usb_get_manufacturer(udev), device_get_nameunit(bus->bdev));
2019
2020         /* Destroy UGEN symlink, if any */
2021         if (udev->ugen_symlink) {
2022                 usb_free_symlink(udev->ugen_symlink);
2023                 udev->ugen_symlink = NULL;
2024         }
2025 #endif
2026         /*
2027          * Unregister our device first which will prevent any further
2028          * references:
2029          */
2030         usb_bus_port_set_device(bus, udev->parent_hub ?
2031             udev->parent_hub->hub->ports + udev->port_index : NULL,
2032             NULL, USB_ROOT_HUB_ADDR);
2033
2034 #if USB_HAVE_UGEN
2035         /* wait for all pending references to go away: */
2036         mtx_lock(&usb_ref_lock);
2037         udev->refcount--;
2038         while (udev->refcount != 0) {
2039                 cv_wait(&udev->ref_cv, &usb_ref_lock);
2040         }
2041         mtx_unlock(&usb_ref_lock);
2042
2043         destroy_dev_sched_cb(udev->ctrl_dev, usb_cdev_cleanup,
2044             udev->ctrl_dev->si_drv1);
2045 #endif
2046
2047         if (udev->flags.usb_mode == USB_MODE_DEVICE) {
2048                 /* stop receiving any control transfers (Device Side Mode) */
2049                 usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2050         }
2051
2052         /* the following will get the device unconfigured in software */
2053         usb_unconfigure(udev, USB_UNCFG_FLAG_FREE_EP0);
2054
2055         /* unsetup any leftover default USB transfers */
2056         usbd_transfer_unsetup(udev->ctrl_xfer, USB_CTRL_XFER_MAX);
2057
2058         /* template unsetup, if any */
2059         (usb_temp_unsetup_p) (udev);
2060
2061         /*
2062          * Make sure that our clear-stall messages are not queued
2063          * anywhere:
2064          */
2065         USB_BUS_LOCK(udev->bus);
2066         usb_proc_mwait(&udev->bus->non_giant_callback_proc,
2067             &udev->cs_msg[0], &udev->cs_msg[1]);
2068         USB_BUS_UNLOCK(udev->bus);
2069
2070         sx_destroy(&udev->ctrl_sx);
2071         sx_destroy(&udev->enum_sx);
2072         sx_destroy(&udev->sr_sx);
2073
2074         cv_destroy(&udev->ctrlreq_cv);
2075         cv_destroy(&udev->ref_cv);
2076
2077         mtx_destroy(&udev->device_mtx);
2078 #if USB_HAVE_UGEN
2079         KASSERT(LIST_FIRST(&udev->pd_list) == NULL, ("leaked cdev entries"));
2080 #endif
2081
2082         /* Uninitialise device */
2083         if (bus->methods->device_uninit != NULL)
2084                 (bus->methods->device_uninit) (udev);
2085
2086         /* free device */
2087         free(udev->serial, M_USB);
2088         free(udev->manufacturer, M_USB);
2089         free(udev->product, M_USB);
2090         free(udev, M_USB);
2091 }
2092
2093 /*------------------------------------------------------------------------*
2094  *      usbd_get_iface
2095  *
2096  * This function is the safe way to get the USB interface structure
2097  * pointer by interface index.
2098  *
2099  * Return values:
2100  *   NULL: Interface not present.
2101  *   Else: Pointer to USB interface structure.
2102  *------------------------------------------------------------------------*/
2103 struct usb_interface *
2104 usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
2105 {
2106         struct usb_interface *iface = udev->ifaces + iface_index;
2107
2108         if (iface_index >= udev->ifaces_max)
2109                 return (NULL);
2110         return (iface);
2111 }
2112
2113 /*------------------------------------------------------------------------*
2114  *      usbd_find_descriptor
2115  *
2116  * This function will lookup the first descriptor that matches the
2117  * criteria given by the arguments "type" and "subtype". Descriptors
2118  * will only be searched within the interface having the index
2119  * "iface_index".  If the "id" argument points to an USB descriptor,
2120  * it will be skipped before the search is started. This allows
2121  * searching for multiple descriptors using the same criteria. Else
2122  * the search is started after the interface descriptor.
2123  *
2124  * Return values:
2125  *   NULL: End of descriptors
2126  *   Else: A descriptor matching the criteria
2127  *------------------------------------------------------------------------*/
2128 void   *
2129 usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index,
2130     uint8_t type, uint8_t type_mask,
2131     uint8_t subtype, uint8_t subtype_mask)
2132 {
2133         struct usb_descriptor *desc;
2134         struct usb_config_descriptor *cd;
2135         struct usb_interface *iface;
2136
2137         cd = usbd_get_config_descriptor(udev);
2138         if (cd == NULL) {
2139                 return (NULL);
2140         }
2141         if (id == NULL) {
2142                 iface = usbd_get_iface(udev, iface_index);
2143                 if (iface == NULL) {
2144                         return (NULL);
2145                 }
2146                 id = usbd_get_interface_descriptor(iface);
2147                 if (id == NULL) {
2148                         return (NULL);
2149                 }
2150         }
2151         desc = (void *)id;
2152
2153         while ((desc = usb_desc_foreach(cd, desc))) {
2154
2155                 if (desc->bDescriptorType == UDESC_INTERFACE) {
2156                         break;
2157                 }
2158                 if (((desc->bDescriptorType & type_mask) == type) &&
2159                     ((desc->bDescriptorSubtype & subtype_mask) == subtype)) {
2160                         return (desc);
2161                 }
2162         }
2163         return (NULL);
2164 }
2165
2166 /*------------------------------------------------------------------------*
2167  *      usb_devinfo
2168  *
2169  * This function will dump information from the device descriptor
2170  * belonging to the USB device pointed to by "udev", to the string
2171  * pointed to by "dst_ptr" having a maximum length of "dst_len" bytes
2172  * including the terminating zero.
2173  *------------------------------------------------------------------------*/
2174 void
2175 usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len)
2176 {
2177         struct usb_device_descriptor *udd = &udev->ddesc;
2178         uint16_t bcdDevice;
2179         uint16_t bcdUSB;
2180
2181         bcdUSB = UGETW(udd->bcdUSB);
2182         bcdDevice = UGETW(udd->bcdDevice);
2183
2184         if (udd->bDeviceClass != 0xFF) {
2185                 snprintf(dst_ptr, dst_len, "%s %s, class %d/%d, rev %x.%02x/"
2186                     "%x.%02x, addr %d",
2187                     usb_get_manufacturer(udev),
2188                     usb_get_product(udev),
2189                     udd->bDeviceClass, udd->bDeviceSubClass,
2190                     (bcdUSB >> 8), bcdUSB & 0xFF,
2191                     (bcdDevice >> 8), bcdDevice & 0xFF,
2192                     udev->address);
2193         } else {
2194                 snprintf(dst_ptr, dst_len, "%s %s, rev %x.%02x/"
2195                     "%x.%02x, addr %d",
2196                     usb_get_manufacturer(udev),
2197                     usb_get_product(udev),
2198                     (bcdUSB >> 8), bcdUSB & 0xFF,
2199                     (bcdDevice >> 8), bcdDevice & 0xFF,
2200                     udev->address);
2201         }
2202 }
2203
2204 #ifdef USB_VERBOSE
2205 /*
2206  * Descriptions of of known vendors and devices ("products").
2207  */
2208 struct usb_knowndev {
2209         uint16_t vendor;
2210         uint16_t product;
2211         uint32_t flags;
2212         const char *vendorname;
2213         const char *productname;
2214 };
2215
2216 #define USB_KNOWNDEV_NOPROD     0x01    /* match on vendor only */
2217
2218 #include "usbdevs.h"
2219 #include "usbdevs_data.h"
2220 #endif                                  /* USB_VERBOSE */
2221
2222 static void
2223 usbd_set_device_strings(struct usb_device *udev)
2224 {
2225         struct usb_device_descriptor *udd = &udev->ddesc;
2226 #ifdef USB_VERBOSE
2227         const struct usb_knowndev *kdp;
2228 #endif
2229         char *temp_ptr;
2230         size_t temp_size;
2231         uint16_t vendor_id;
2232         uint16_t product_id;
2233
2234         temp_ptr = (char *)udev->bus->scratch[0].data;
2235         temp_size = sizeof(udev->bus->scratch[0].data);
2236
2237         vendor_id = UGETW(udd->idVendor);
2238         product_id = UGETW(udd->idProduct);
2239
2240         /* get serial number string */
2241         usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2242             udev->ddesc.iSerialNumber);
2243         udev->serial = strdup(temp_ptr, M_USB);
2244
2245         /* get manufacturer string */
2246         usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2247             udev->ddesc.iManufacturer);
2248         usb_trim_spaces(temp_ptr);
2249         if (temp_ptr[0] != '\0')
2250                 udev->manufacturer = strdup(temp_ptr, M_USB);
2251
2252         /* get product string */
2253         usbd_req_get_string_any(udev, NULL, temp_ptr, temp_size,
2254             udev->ddesc.iProduct);
2255         usb_trim_spaces(temp_ptr);
2256         if (temp_ptr[0] != '\0')
2257                 udev->product = strdup(temp_ptr, M_USB);
2258
2259 #ifdef USB_VERBOSE
2260         if (udev->manufacturer == NULL || udev->product == NULL) {
2261                 for (kdp = usb_knowndevs; kdp->vendorname != NULL; kdp++) {
2262                         if (kdp->vendor == vendor_id &&
2263                             (kdp->product == product_id ||
2264                             (kdp->flags & USB_KNOWNDEV_NOPROD) != 0))
2265                                 break;
2266                 }
2267                 if (kdp->vendorname != NULL) {
2268                         /* XXX should use pointer to knowndevs string */
2269                         if (udev->manufacturer == NULL) {
2270                                 udev->manufacturer = strdup(kdp->vendorname,
2271                                     M_USB);
2272                         }
2273                         if (udev->product == NULL &&
2274                             (kdp->flags & USB_KNOWNDEV_NOPROD) == 0) {
2275                                 udev->product = strdup(kdp->productname,
2276                                     M_USB);
2277                         }
2278                 }
2279         }
2280 #endif
2281         /* Provide default strings if none were found */
2282         if (udev->manufacturer == NULL) {
2283                 snprintf(temp_ptr, temp_size, "vendor 0x%04x", vendor_id);
2284                 udev->manufacturer = strdup(temp_ptr, M_USB);
2285         }
2286         if (udev->product == NULL) {
2287                 snprintf(temp_ptr, temp_size, "product 0x%04x", product_id);
2288                 udev->product = strdup(temp_ptr, M_USB);
2289         }
2290 }
2291
2292 /*
2293  * Returns:
2294  * See: USB_MODE_XXX
2295  */
2296 enum usb_hc_mode
2297 usbd_get_mode(struct usb_device *udev)
2298 {
2299         return (udev->flags.usb_mode);
2300 }
2301
2302 /*
2303  * Returns:
2304  * See: USB_SPEED_XXX
2305  */
2306 enum usb_dev_speed
2307 usbd_get_speed(struct usb_device *udev)
2308 {
2309         return (udev->speed);
2310 }
2311
2312 uint32_t
2313 usbd_get_isoc_fps(struct usb_device *udev)
2314 {
2315         ;                               /* indent fix */
2316         switch (udev->speed) {
2317         case USB_SPEED_LOW:
2318         case USB_SPEED_FULL:
2319                 return (1000);
2320         default:
2321                 return (8000);
2322         }
2323 }
2324
2325 struct usb_device_descriptor *
2326 usbd_get_device_descriptor(struct usb_device *udev)
2327 {
2328         if (udev == NULL)
2329                 return (NULL);          /* be NULL safe */
2330         return (&udev->ddesc);
2331 }
2332
2333 struct usb_config_descriptor *
2334 usbd_get_config_descriptor(struct usb_device *udev)
2335 {
2336         if (udev == NULL)
2337                 return (NULL);          /* be NULL safe */
2338         return (udev->cdesc);
2339 }
2340
2341 /*------------------------------------------------------------------------*
2342  *      usb_test_quirk - test a device for a given quirk
2343  *
2344  * Return values:
2345  * 0: The USB device does not have the given quirk.
2346  * Else: The USB device has the given quirk.
2347  *------------------------------------------------------------------------*/
2348 uint8_t
2349 usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
2350 {
2351         uint8_t found;
2352
2353         found = (usb_test_quirk_p) (&uaa->info, quirk);
2354         return (found);
2355 }
2356
2357 struct usb_interface_descriptor *
2358 usbd_get_interface_descriptor(struct usb_interface *iface)
2359 {
2360         if (iface == NULL)
2361                 return (NULL);          /* be NULL safe */
2362         return (iface->idesc);
2363 }
2364
2365 uint8_t
2366 usbd_get_interface_altindex(struct usb_interface *iface)
2367 {
2368         return (iface->alt_index);
2369 }
2370
2371 uint8_t
2372 usbd_get_bus_index(struct usb_device *udev)
2373 {
2374         return ((uint8_t)device_get_unit(udev->bus->bdev));
2375 }
2376
2377 uint8_t
2378 usbd_get_device_index(struct usb_device *udev)
2379 {
2380         return (udev->device_index);
2381 }
2382
2383 #if USB_HAVE_UGEN
2384 /*------------------------------------------------------------------------*
2385  *      usb_notify_addq
2386  *
2387  * This function will generate events for dev.
2388  *------------------------------------------------------------------------*/
2389 #ifndef BURN_BRIDGES
2390 static void
2391 usb_notify_addq_compat(const char *type, struct usb_device *udev)
2392 {
2393         char *data = NULL;
2394         const char *ntype;
2395         struct malloc_type *mt;
2396         const size_t buf_size = 512;
2397
2398         /* Convert notify type */
2399         if (strcmp(type, "ATTACH") == 0)
2400                 ntype = "+";
2401         else if (strcmp(type, "DETACH") == 0)
2402                 ntype = "-";
2403         else
2404                 return;
2405
2406         mtx_lock(&malloc_mtx);
2407         mt = malloc_desc2type("bus");   /* XXX M_BUS */
2408         mtx_unlock(&malloc_mtx);
2409         if (mt == NULL)
2410                 return;
2411
2412         data = malloc(buf_size, mt, M_NOWAIT);
2413         if (data == NULL)
2414                 return;
2415
2416         /* String it all together. */
2417         snprintf(data, buf_size,
2418             "%s"
2419             "%s "
2420             "at port=%u "
2421             "vendor=0x%04x "
2422             "product=0x%04x "
2423             "devclass=0x%02x "
2424             "devsubclass=0x%02x "
2425             "sernum=\"%s\" "
2426             "release=0x%04x "
2427             "on "
2428             "%s\n",
2429             ntype,
2430             udev->ugen_name,
2431             udev->port_no,
2432             UGETW(udev->ddesc.idVendor),
2433             UGETW(udev->ddesc.idProduct),
2434             udev->ddesc.bDeviceClass,
2435             udev->ddesc.bDeviceSubClass,
2436             usb_get_serial(udev),
2437             UGETW(udev->ddesc.bcdDevice),
2438             udev->parent_hub != NULL ?
2439                 udev->parent_hub->ugen_name :
2440                 device_get_nameunit(device_get_parent(udev->bus->bdev)));
2441
2442         devctl_queue_data(data);
2443 }
2444 #endif
2445
2446 static void
2447 usb_notify_addq(const char *type, struct usb_device *udev)
2448 {
2449         struct usb_interface *iface;
2450         struct sbuf *sb;
2451         int i;
2452
2453 #ifndef BURN_BRIDGES
2454         usb_notify_addq_compat(type, udev);
2455 #endif
2456
2457         /* announce the device */
2458         sb = sbuf_new_auto();
2459         sbuf_printf(sb,
2460             "cdev=%s "
2461             "vendor=0x%04x "
2462             "product=0x%04x "
2463             "devclass=0x%02x "
2464             "devsubclass=0x%02x "
2465             "sernum=\"%s\" "
2466             "release=0x%04x "
2467             "mode=%s "
2468             "port=%u "
2469             "parent=%s",
2470             udev->ugen_name,
2471             UGETW(udev->ddesc.idVendor),
2472             UGETW(udev->ddesc.idProduct),
2473             udev->ddesc.bDeviceClass,
2474             udev->ddesc.bDeviceSubClass,
2475             usb_get_serial(udev),
2476             UGETW(udev->ddesc.bcdDevice),
2477             (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2478             udev->port_no,
2479             udev->parent_hub != NULL ?
2480             udev->parent_hub->ugen_name :
2481             device_get_nameunit(device_get_parent(udev->bus->bdev)));
2482         sbuf_finish(sb);
2483         devctl_notify("USB", "DEVICE", type, sbuf_data(sb));
2484         sbuf_delete(sb);
2485
2486         /* announce each interface */
2487         for (i = 0; i < USB_IFACE_MAX; i++) {
2488                 iface = usbd_get_iface(udev, i);
2489                 if (iface == NULL)
2490                         break;          /* end of interfaces */
2491                 if (iface->idesc == NULL)
2492                         continue;       /* no interface descriptor */
2493
2494                 sb = sbuf_new_auto();
2495                 sbuf_printf(sb,
2496                     "cdev=%s "
2497                     "vendor=0x%04x "
2498                     "product=0x%04x "
2499                     "devclass=0x%02x "
2500                     "devsubclass=0x%02x "
2501                     "sernum=\"%s\" "
2502                     "release=0x%04x "
2503                     "mode=%s "
2504                     "interface=%d "
2505                     "endpoints=%d "
2506                     "intclass=0x%02x "
2507                     "intsubclass=0x%02x "
2508                     "intprotocol=0x%02x",
2509                     udev->ugen_name,
2510                     UGETW(udev->ddesc.idVendor),
2511                     UGETW(udev->ddesc.idProduct),
2512                     udev->ddesc.bDeviceClass,
2513                     udev->ddesc.bDeviceSubClass,
2514                     usb_get_serial(udev),
2515                     UGETW(udev->ddesc.bcdDevice),
2516                     (udev->flags.usb_mode == USB_MODE_HOST) ? "host" : "device",
2517                     iface->idesc->bInterfaceNumber,
2518                     iface->idesc->bNumEndpoints,
2519                     iface->idesc->bInterfaceClass,
2520                     iface->idesc->bInterfaceSubClass,
2521                     iface->idesc->bInterfaceProtocol);
2522                 sbuf_finish(sb);
2523                 devctl_notify("USB", "INTERFACE", type, sbuf_data(sb));
2524                 sbuf_delete(sb);
2525         }
2526 }
2527
2528 /*------------------------------------------------------------------------*
2529  *      usb_fifo_free_wrap
2530  *
2531  * This function will free the FIFOs.
2532  *
2533  * Description of "flag" argument: If the USB_UNCFG_FLAG_FREE_EP0 flag
2534  * is set and "iface_index" is set to "USB_IFACE_INDEX_ANY", we free
2535  * all FIFOs. If the USB_UNCFG_FLAG_FREE_EP0 flag is not set and
2536  * "iface_index" is set to "USB_IFACE_INDEX_ANY", we free all non
2537  * control endpoint FIFOs. If "iface_index" is not set to
2538  * "USB_IFACE_INDEX_ANY" the flag has no effect.
2539  *------------------------------------------------------------------------*/
2540 static void
2541 usb_fifo_free_wrap(struct usb_device *udev,
2542     uint8_t iface_index, uint8_t flag)
2543 {
2544         struct usb_fifo *f;
2545         uint16_t i;
2546
2547         /*
2548          * Free any USB FIFOs on the given interface:
2549          */
2550         for (i = 0; i != USB_FIFO_MAX; i++) {
2551                 f = udev->fifo[i];
2552                 if (f == NULL) {
2553                         continue;
2554                 }
2555                 /* Check if the interface index matches */
2556                 if (iface_index == f->iface_index) {
2557                         if (f->methods != &usb_ugen_methods) {
2558                                 /*
2559                                  * Don't free any non-generic FIFOs in
2560                                  * this case.
2561                                  */
2562                                 continue;
2563                         }
2564                         if ((f->dev_ep_index == 0) &&
2565                             (f->fs_xfer == NULL)) {
2566                                 /* no need to free this FIFO */
2567                                 continue;
2568                         }
2569                 } else if (iface_index == USB_IFACE_INDEX_ANY) {
2570                         if ((f->methods == &usb_ugen_methods) &&
2571                             (f->dev_ep_index == 0) &&
2572                             (!(flag & USB_UNCFG_FLAG_FREE_EP0)) &&
2573                             (f->fs_xfer == NULL)) {
2574                                 /* no need to free this FIFO */
2575                                 continue;
2576                         }
2577                 } else {
2578                         /* no need to free this FIFO */
2579                         continue;
2580                 }
2581                 /* free this FIFO */
2582                 usb_fifo_free(f);
2583         }
2584 }
2585 #endif
2586
2587 /*------------------------------------------------------------------------*
2588  *      usb_peer_can_wakeup
2589  *
2590  * Return values:
2591  * 0: Peer cannot do resume signalling.
2592  * Else: Peer can do resume signalling.
2593  *------------------------------------------------------------------------*/
2594 uint8_t
2595 usb_peer_can_wakeup(struct usb_device *udev)
2596 {
2597         const struct usb_config_descriptor *cdp;
2598
2599         cdp = udev->cdesc;
2600         if ((cdp != NULL) && (udev->flags.usb_mode == USB_MODE_HOST)) {
2601                 return (cdp->bmAttributes & UC_REMOTE_WAKEUP);
2602         }
2603         return (0);                     /* not supported */
2604 }
2605
2606 void
2607 usb_set_device_state(struct usb_device *udev, enum usb_dev_state state)
2608 {
2609
2610         KASSERT(state < USB_STATE_MAX, ("invalid udev state"));
2611
2612         DPRINTF("udev %p state %s -> %s\n", udev,
2613             usb_statestr(udev->state), usb_statestr(state));
2614         udev->state = state;
2615
2616         if (udev->bus->methods->device_state_change != NULL)
2617                 (udev->bus->methods->device_state_change) (udev);
2618 }
2619
2620 enum usb_dev_state
2621 usb_get_device_state(struct usb_device *udev)
2622 {
2623         if (udev == NULL)
2624                 return (USB_STATE_DETACHED);
2625         return (udev->state);
2626 }
2627
2628 uint8_t
2629 usbd_device_attached(struct usb_device *udev)
2630 {
2631         return (udev->state > USB_STATE_DETACHED);
2632 }
2633
2634 /* The following function locks enumerating the given USB device. */
2635
2636 void
2637 usbd_enum_lock(struct usb_device *udev)
2638 {
2639         sx_xlock(&udev->enum_sx);
2640         sx_xlock(&udev->sr_sx);
2641         /*
2642          * NEWBUS LOCK NOTE: We should check if any parent SX locks
2643          * are locked before locking Giant. Else the lock can be
2644          * locked multiple times.
2645          */
2646         mtx_lock(&Giant);
2647 }
2648
2649 /* The following function unlocks enumerating the given USB device. */
2650
2651 void
2652 usbd_enum_unlock(struct usb_device *udev)
2653 {
2654         mtx_unlock(&Giant);
2655         sx_xunlock(&udev->enum_sx);
2656         sx_xunlock(&udev->sr_sx);
2657 }
2658
2659 /* The following function locks suspend and resume. */
2660
2661 void
2662 usbd_sr_lock(struct usb_device *udev)
2663 {
2664         sx_xlock(&udev->sr_sx);
2665         /*
2666          * NEWBUS LOCK NOTE: We should check if any parent SX locks
2667          * are locked before locking Giant. Else the lock can be
2668          * locked multiple times.
2669          */
2670         mtx_lock(&Giant);
2671 }
2672
2673 /* The following function unlocks suspend and resume. */
2674
2675 void
2676 usbd_sr_unlock(struct usb_device *udev)
2677 {
2678         mtx_unlock(&Giant);
2679         sx_xunlock(&udev->sr_sx);
2680 }
2681
2682 /*
2683  * The following function checks the enumerating lock for the given
2684  * USB device.
2685  */
2686
2687 uint8_t
2688 usbd_enum_is_locked(struct usb_device *udev)
2689 {
2690         return (sx_xlocked(&udev->enum_sx));
2691 }
2692
2693 /*
2694  * The following function is used to set the per-interface specific
2695  * plug and play information. The string referred to by the pnpinfo
2696  * argument can safely be freed after calling this function. The
2697  * pnpinfo of an interface will be reset at device detach or when
2698  * passing a NULL argument to this function. This function
2699  * returns zero on success, else a USB_ERR_XXX failure code.
2700  */
2701
2702 usb_error_t
2703 usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
2704 {
2705         struct usb_interface *iface;
2706
2707         iface = usbd_get_iface(udev, iface_index);
2708         if (iface == NULL)
2709                 return (USB_ERR_INVAL);
2710
2711         if (iface->pnpinfo != NULL) {
2712                 free(iface->pnpinfo, M_USBDEV);
2713                 iface->pnpinfo = NULL;
2714         }
2715
2716         if (pnpinfo == NULL || pnpinfo[0] == 0)
2717                 return (0);             /* success */
2718
2719         iface->pnpinfo = strdup(pnpinfo, M_USBDEV);
2720         if (iface->pnpinfo == NULL)
2721                 return (USB_ERR_NOMEM);
2722
2723         return (0);                     /* success */
2724 }
2725