sys/dev/usb/usb_device.c

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