sys/dev/usb/usb_device.c

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