sys/dev/usb/usb_device.c

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