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