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