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