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