sys/bus/u4b/usb_device.c

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