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