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