sys/dev/usb/usb_device.c

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