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