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