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