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