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