1 /* $FreeBSD$ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 4 * 5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #ifdef USB_GLOBAL_INCLUDE_FILE 30 #include USB_GLOBAL_INCLUDE_FILE 31 #else 32 #include "opt_ddb.h" 33 34 #include <sys/stdint.h> 35 #include <sys/stddef.h> 36 #include <sys/param.h> 37 #include <sys/queue.h> 38 #include <sys/types.h> 39 #include <sys/systm.h> 40 #include <sys/kernel.h> 41 #include <sys/bus.h> 42 #include <sys/module.h> 43 #include <sys/lock.h> 44 #include <sys/mutex.h> 45 #include <sys/condvar.h> 46 #include <sys/sysctl.h> 47 #include <sys/sx.h> 48 #include <sys/unistd.h> 49 #include <sys/callout.h> 50 #include <sys/malloc.h> 51 #include <sys/priv.h> 52 53 #include <dev/usb/usb.h> 54 #include <dev/usb/usbdi.h> 55 56 #define USB_DEBUG_VAR usb_ctrl_debug 57 58 #include <dev/usb/usb_core.h> 59 #include <dev/usb/usb_debug.h> 60 #include <dev/usb/usb_process.h> 61 #include <dev/usb/usb_busdma.h> 62 #include <dev/usb/usb_dynamic.h> 63 #include <dev/usb/usb_device.h> 64 #include <dev/usb/usb_dev.h> 65 #include <dev/usb/usb_hub.h> 66 67 #include <dev/usb/usb_controller.h> 68 #include <dev/usb/usb_bus.h> 69 #include <dev/usb/usb_pf.h> 70 #include "usb_if.h" 71 #endif /* USB_GLOBAL_INCLUDE_FILE */ 72 73 /* function prototypes */ 74 75 static device_probe_t usb_probe; 76 static device_attach_t usb_attach; 77 static device_detach_t usb_detach; 78 static device_suspend_t usb_suspend; 79 static device_resume_t usb_resume; 80 static device_shutdown_t usb_shutdown; 81 82 static void usb_attach_sub(device_t, struct usb_bus *); 83 84 /* static variables */ 85 86 #ifdef USB_DEBUG 87 static int usb_ctrl_debug = 0; 88 89 static SYSCTL_NODE(_hw_usb, OID_AUTO, ctrl, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 90 "USB controller"); 91 SYSCTL_INT(_hw_usb_ctrl, OID_AUTO, debug, CTLFLAG_RWTUN, &usb_ctrl_debug, 0, 92 "Debug level"); 93 #endif 94 95 #if USB_HAVE_ROOT_MOUNT_HOLD 96 static int usb_no_boot_wait = 0; 97 SYSCTL_INT(_hw_usb, OID_AUTO, no_boot_wait, CTLFLAG_RDTUN, &usb_no_boot_wait, 0, 98 "No USB device enumerate waiting at boot."); 99 #endif 100 101 static int usb_no_suspend_wait = 0; 102 SYSCTL_INT(_hw_usb, OID_AUTO, no_suspend_wait, CTLFLAG_RWTUN, 103 &usb_no_suspend_wait, 0, "No USB device waiting at system suspend."); 104 105 static int usb_no_shutdown_wait = 0; 106 SYSCTL_INT(_hw_usb, OID_AUTO, no_shutdown_wait, CTLFLAG_RWTUN, 107 &usb_no_shutdown_wait, 0, "No USB device waiting at system shutdown."); 108 109 static device_method_t usb_methods[] = { 110 DEVMETHOD(device_probe, usb_probe), 111 DEVMETHOD(device_attach, usb_attach), 112 DEVMETHOD(device_detach, usb_detach), 113 DEVMETHOD(device_suspend, usb_suspend), 114 DEVMETHOD(device_resume, usb_resume), 115 DEVMETHOD(device_shutdown, usb_shutdown), 116 117 DEVMETHOD_END 118 }; 119 120 static driver_t usb_driver = { 121 .name = "usbus", 122 .methods = usb_methods, 123 .size = 0, 124 }; 125 126 /* Host Only Drivers */ 127 DRIVER_MODULE(usbus, ohci, usb_driver, 0, 0); 128 DRIVER_MODULE(usbus, uhci, usb_driver, 0, 0); 129 DRIVER_MODULE(usbus, ehci, usb_driver, 0, 0); 130 DRIVER_MODULE(usbus, xhci, usb_driver, 0, 0); 131 132 /* Device Only Drivers */ 133 DRIVER_MODULE(usbus, musbotg, usb_driver, 0, 0); 134 DRIVER_MODULE(usbus, uss820dci, usb_driver, 0, 0); 135 DRIVER_MODULE(usbus, octusb, usb_driver, 0, 0); 136 137 /* Dual Mode Drivers */ 138 DRIVER_MODULE(usbus, dwcotg, usb_driver, 0, 0); 139 DRIVER_MODULE(usbus, saf1761otg, usb_driver, 0, 0); 140 141 /*------------------------------------------------------------------------* 142 * usb_probe 143 * 144 * This function is called from "{ehci,ohci,uhci}_pci_attach()". 145 *------------------------------------------------------------------------*/ 146 static int 147 usb_probe(device_t dev) 148 { 149 DPRINTF("\n"); 150 return (0); 151 } 152 153 #if USB_HAVE_ROOT_MOUNT_HOLD 154 static void 155 usb_root_mount_rel(struct usb_bus *bus) 156 { 157 if (bus->bus_roothold != NULL) { 158 DPRINTF("Releasing root mount hold %p\n", bus->bus_roothold); 159 root_mount_rel(bus->bus_roothold); 160 bus->bus_roothold = NULL; 161 } 162 } 163 #endif 164 165 /*------------------------------------------------------------------------* 166 * usb_attach 167 *------------------------------------------------------------------------*/ 168 static int 169 usb_attach(device_t dev) 170 { 171 struct usb_bus *bus = device_get_ivars(dev); 172 173 DPRINTF("\n"); 174 175 if (bus == NULL) { 176 device_printf(dev, "USB device has no ivars\n"); 177 return (ENXIO); 178 } 179 180 #if USB_HAVE_ROOT_MOUNT_HOLD 181 if (usb_no_boot_wait == 0) { 182 /* delay vfs_mountroot until the bus is explored */ 183 bus->bus_roothold = root_mount_hold(device_get_nameunit(dev)); 184 } 185 #endif 186 usb_attach_sub(dev, bus); 187 188 return (0); /* return success */ 189 } 190 191 /*------------------------------------------------------------------------* 192 * usb_detach 193 *------------------------------------------------------------------------*/ 194 static int 195 usb_detach(device_t dev) 196 { 197 struct usb_bus *bus = device_get_softc(dev); 198 199 DPRINTF("\n"); 200 201 if (bus == NULL) { 202 /* was never setup properly */ 203 return (0); 204 } 205 /* Stop power watchdog */ 206 usb_callout_drain(&bus->power_wdog); 207 208 #if USB_HAVE_ROOT_MOUNT_HOLD 209 /* Let the USB explore process detach all devices. */ 210 usb_root_mount_rel(bus); 211 #endif 212 213 USB_BUS_LOCK(bus); 214 215 /* Queue detach job */ 216 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 217 &bus->detach_msg[0], &bus->detach_msg[1]); 218 219 /* Wait for detach to complete */ 220 usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus), 221 &bus->detach_msg[0], &bus->detach_msg[1]); 222 223 #if USB_HAVE_UGEN 224 /* Wait for cleanup to complete */ 225 usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus), 226 &bus->cleanup_msg[0], &bus->cleanup_msg[1]); 227 #endif 228 USB_BUS_UNLOCK(bus); 229 230 #if USB_HAVE_PER_BUS_PROCESS 231 /* Get rid of USB callback processes */ 232 233 usb_proc_free(USB_BUS_GIANT_PROC(bus)); 234 usb_proc_free(USB_BUS_NON_GIANT_ISOC_PROC(bus)); 235 usb_proc_free(USB_BUS_NON_GIANT_BULK_PROC(bus)); 236 237 /* Get rid of USB explore process */ 238 239 usb_proc_free(USB_BUS_EXPLORE_PROC(bus)); 240 241 /* Get rid of control transfer process */ 242 243 usb_proc_free(USB_BUS_CONTROL_XFER_PROC(bus)); 244 #endif 245 246 #if USB_HAVE_PF 247 usbpf_detach(bus); 248 #endif 249 return (0); 250 } 251 252 /*------------------------------------------------------------------------* 253 * usb_suspend 254 *------------------------------------------------------------------------*/ 255 static int 256 usb_suspend(device_t dev) 257 { 258 struct usb_bus *bus = device_get_softc(dev); 259 260 DPRINTF("\n"); 261 262 if (bus == NULL) { 263 /* was never setup properly */ 264 return (0); 265 } 266 267 USB_BUS_LOCK(bus); 268 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 269 &bus->suspend_msg[0], &bus->suspend_msg[1]); 270 if (usb_no_suspend_wait == 0) { 271 /* wait for suspend callback to be executed */ 272 usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus), 273 &bus->suspend_msg[0], &bus->suspend_msg[1]); 274 } 275 USB_BUS_UNLOCK(bus); 276 277 return (0); 278 } 279 280 /*------------------------------------------------------------------------* 281 * usb_resume 282 *------------------------------------------------------------------------*/ 283 static int 284 usb_resume(device_t dev) 285 { 286 struct usb_bus *bus = device_get_softc(dev); 287 288 DPRINTF("\n"); 289 290 if (bus == NULL) { 291 /* was never setup properly */ 292 return (0); 293 } 294 295 USB_BUS_LOCK(bus); 296 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 297 &bus->resume_msg[0], &bus->resume_msg[1]); 298 USB_BUS_UNLOCK(bus); 299 300 return (0); 301 } 302 303 /*------------------------------------------------------------------------* 304 * usb_bus_reset_async_locked 305 *------------------------------------------------------------------------*/ 306 void 307 usb_bus_reset_async_locked(struct usb_bus *bus) 308 { 309 USB_BUS_LOCK_ASSERT(bus, MA_OWNED); 310 311 DPRINTF("\n"); 312 313 if (bus->reset_msg[0].hdr.pm_qentry.tqe_prev != NULL || 314 bus->reset_msg[1].hdr.pm_qentry.tqe_prev != NULL) { 315 DPRINTF("Reset already pending\n"); 316 return; 317 } 318 319 device_printf(bus->parent, "Resetting controller\n"); 320 321 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 322 &bus->reset_msg[0], &bus->reset_msg[1]); 323 } 324 325 /*------------------------------------------------------------------------* 326 * usb_shutdown 327 *------------------------------------------------------------------------*/ 328 static int 329 usb_shutdown(device_t dev) 330 { 331 struct usb_bus *bus = device_get_softc(dev); 332 333 DPRINTF("\n"); 334 335 if (bus == NULL) { 336 /* was never setup properly */ 337 return (0); 338 } 339 340 DPRINTF("%s: Controller shutdown\n", device_get_nameunit(bus->bdev)); 341 342 USB_BUS_LOCK(bus); 343 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 344 &bus->shutdown_msg[0], &bus->shutdown_msg[1]); 345 if (usb_no_shutdown_wait == 0) { 346 /* wait for shutdown callback to be executed */ 347 usb_proc_mwait(USB_BUS_EXPLORE_PROC(bus), 348 &bus->shutdown_msg[0], &bus->shutdown_msg[1]); 349 } 350 USB_BUS_UNLOCK(bus); 351 352 DPRINTF("%s: Controller shutdown complete\n", 353 device_get_nameunit(bus->bdev)); 354 355 return (0); 356 } 357 358 /*------------------------------------------------------------------------* 359 * usb_bus_explore 360 * 361 * This function is used to explore the device tree from the root. 362 *------------------------------------------------------------------------*/ 363 static void 364 usb_bus_explore(struct usb_proc_msg *pm) 365 { 366 struct usb_bus *bus; 367 struct usb_device *udev; 368 369 bus = ((struct usb_bus_msg *)pm)->bus; 370 udev = bus->devices[USB_ROOT_HUB_ADDR]; 371 372 if (bus->no_explore != 0) 373 return; 374 375 if (udev != NULL) { 376 USB_BUS_UNLOCK(bus); 377 uhub_explore_handle_re_enumerate(udev); 378 USB_BUS_LOCK(bus); 379 } 380 381 if (udev != NULL && udev->hub != NULL) { 382 if (bus->do_probe) { 383 bus->do_probe = 0; 384 bus->driver_added_refcount++; 385 } 386 if (bus->driver_added_refcount == 0) { 387 /* avoid zero, hence that is memory default */ 388 bus->driver_added_refcount = 1; 389 } 390 391 #ifdef DDB 392 /* 393 * The following three lines of code are only here to 394 * recover from DDB: 395 */ 396 usb_proc_rewakeup(USB_BUS_CONTROL_XFER_PROC(bus)); 397 usb_proc_rewakeup(USB_BUS_GIANT_PROC(bus)); 398 usb_proc_rewakeup(USB_BUS_NON_GIANT_ISOC_PROC(bus)); 399 usb_proc_rewakeup(USB_BUS_NON_GIANT_BULK_PROC(bus)); 400 #endif 401 402 USB_BUS_UNLOCK(bus); 403 404 #if USB_HAVE_POWERD 405 /* 406 * First update the USB power state! 407 */ 408 usb_bus_powerd(bus); 409 #endif 410 /* Explore the Root USB HUB. */ 411 (udev->hub->explore) (udev); 412 USB_BUS_LOCK(bus); 413 } 414 #if USB_HAVE_ROOT_MOUNT_HOLD 415 usb_root_mount_rel(bus); 416 #endif 417 } 418 419 /*------------------------------------------------------------------------* 420 * usb_bus_detach 421 * 422 * This function is used to detach the device tree from the root. 423 *------------------------------------------------------------------------*/ 424 static void 425 usb_bus_detach(struct usb_proc_msg *pm) 426 { 427 struct usb_bus *bus; 428 struct usb_device *udev; 429 device_t dev; 430 431 bus = ((struct usb_bus_msg *)pm)->bus; 432 udev = bus->devices[USB_ROOT_HUB_ADDR]; 433 dev = bus->bdev; 434 /* clear the softc */ 435 device_set_softc(dev, NULL); 436 USB_BUS_UNLOCK(bus); 437 438 /* detach children first */ 439 bus_topo_lock(); 440 bus_generic_detach(dev); 441 bus_topo_unlock(); 442 443 /* 444 * Free USB device and all subdevices, if any. 445 */ 446 usb_free_device(udev, 0); 447 448 USB_BUS_LOCK(bus); 449 /* clear bdev variable last */ 450 bus->bdev = NULL; 451 } 452 453 /*------------------------------------------------------------------------* 454 * usb_bus_suspend 455 * 456 * This function is used to suspend the USB controller. 457 *------------------------------------------------------------------------*/ 458 static void 459 usb_bus_suspend(struct usb_proc_msg *pm) 460 { 461 struct usb_bus *bus; 462 struct usb_device *udev; 463 usb_error_t err; 464 uint8_t do_unlock; 465 466 DPRINTF("\n"); 467 468 bus = ((struct usb_bus_msg *)pm)->bus; 469 udev = bus->devices[USB_ROOT_HUB_ADDR]; 470 471 if (udev == NULL || bus->bdev == NULL) 472 return; 473 474 USB_BUS_UNLOCK(bus); 475 476 /* 477 * We use the shutdown event here because the suspend and 478 * resume events are reserved for the USB port suspend and 479 * resume. The USB system suspend is implemented like full 480 * shutdown and all connected USB devices will be disconnected 481 * subsequently. At resume all USB devices will be 482 * re-connected again. 483 */ 484 485 bus_generic_shutdown(bus->bdev); 486 487 do_unlock = usbd_enum_lock(udev); 488 489 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX); 490 if (err) 491 device_printf(bus->bdev, "Could not unconfigure root HUB\n"); 492 493 USB_BUS_LOCK(bus); 494 bus->hw_power_state = 0; 495 bus->no_explore = 1; 496 USB_BUS_UNLOCK(bus); 497 498 if (bus->methods->set_hw_power != NULL) 499 (bus->methods->set_hw_power) (bus); 500 501 if (bus->methods->set_hw_power_sleep != NULL) 502 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SUSPEND); 503 504 if (do_unlock) 505 usbd_enum_unlock(udev); 506 507 USB_BUS_LOCK(bus); 508 } 509 510 /*------------------------------------------------------------------------* 511 * usb_bus_resume 512 * 513 * This function is used to resume the USB controller. 514 *------------------------------------------------------------------------*/ 515 static void 516 usb_bus_resume(struct usb_proc_msg *pm) 517 { 518 struct usb_bus *bus; 519 struct usb_device *udev; 520 usb_error_t err; 521 uint8_t do_unlock; 522 523 DPRINTF("\n"); 524 525 bus = ((struct usb_bus_msg *)pm)->bus; 526 udev = bus->devices[USB_ROOT_HUB_ADDR]; 527 528 if (udev == NULL || bus->bdev == NULL) 529 return; 530 531 USB_BUS_UNLOCK(bus); 532 533 do_unlock = usbd_enum_lock(udev); 534 #if 0 535 DEVMETHOD(usb_take_controller, NULL); /* dummy */ 536 #endif 537 USB_TAKE_CONTROLLER(device_get_parent(bus->bdev)); 538 539 USB_BUS_LOCK(bus); 540 bus->hw_power_state = 541 USB_HW_POWER_CONTROL | 542 USB_HW_POWER_BULK | 543 USB_HW_POWER_INTERRUPT | 544 USB_HW_POWER_ISOC | 545 USB_HW_POWER_NON_ROOT_HUB; 546 bus->no_explore = 0; 547 USB_BUS_UNLOCK(bus); 548 549 if (bus->methods->set_hw_power_sleep != NULL) 550 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_RESUME); 551 552 if (bus->methods->set_hw_power != NULL) 553 (bus->methods->set_hw_power) (bus); 554 555 /* restore USB configuration to index 0 */ 556 err = usbd_set_config_index(udev, 0); 557 if (err) 558 device_printf(bus->bdev, "Could not configure root HUB\n"); 559 560 /* probe and attach */ 561 err = usb_probe_and_attach(udev, USB_IFACE_INDEX_ANY); 562 if (err) { 563 device_printf(bus->bdev, "Could not probe and " 564 "attach root HUB\n"); 565 } 566 567 if (do_unlock) 568 usbd_enum_unlock(udev); 569 570 USB_BUS_LOCK(bus); 571 } 572 573 /*------------------------------------------------------------------------* 574 * usb_bus_reset 575 * 576 * This function is used to reset the USB controller. 577 *------------------------------------------------------------------------*/ 578 static void 579 usb_bus_reset(struct usb_proc_msg *pm) 580 { 581 struct usb_bus *bus; 582 583 DPRINTF("\n"); 584 585 bus = ((struct usb_bus_msg *)pm)->bus; 586 587 if (bus->bdev == NULL || bus->no_explore != 0) 588 return; 589 590 /* a suspend and resume will reset the USB controller */ 591 usb_bus_suspend(pm); 592 usb_bus_resume(pm); 593 } 594 595 /*------------------------------------------------------------------------* 596 * usb_bus_shutdown 597 * 598 * This function is used to shutdown the USB controller. 599 *------------------------------------------------------------------------*/ 600 static void 601 usb_bus_shutdown(struct usb_proc_msg *pm) 602 { 603 struct usb_bus *bus; 604 struct usb_device *udev; 605 usb_error_t err; 606 uint8_t do_unlock; 607 608 bus = ((struct usb_bus_msg *)pm)->bus; 609 udev = bus->devices[USB_ROOT_HUB_ADDR]; 610 611 if (udev == NULL || bus->bdev == NULL) 612 return; 613 614 USB_BUS_UNLOCK(bus); 615 616 bus_generic_shutdown(bus->bdev); 617 618 do_unlock = usbd_enum_lock(udev); 619 620 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX); 621 if (err) 622 device_printf(bus->bdev, "Could not unconfigure root HUB\n"); 623 624 USB_BUS_LOCK(bus); 625 bus->hw_power_state = 0; 626 bus->no_explore = 1; 627 USB_BUS_UNLOCK(bus); 628 629 if (bus->methods->set_hw_power != NULL) 630 (bus->methods->set_hw_power) (bus); 631 632 if (bus->methods->set_hw_power_sleep != NULL) 633 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SHUTDOWN); 634 635 if (do_unlock) 636 usbd_enum_unlock(udev); 637 638 USB_BUS_LOCK(bus); 639 } 640 641 /*------------------------------------------------------------------------* 642 * usb_bus_cleanup 643 * 644 * This function is used to cleanup leftover USB character devices. 645 *------------------------------------------------------------------------*/ 646 #if USB_HAVE_UGEN 647 static void 648 usb_bus_cleanup(struct usb_proc_msg *pm) 649 { 650 struct usb_bus *bus; 651 struct usb_fs_privdata *pd; 652 653 bus = ((struct usb_bus_msg *)pm)->bus; 654 655 while ((pd = LIST_FIRST(&bus->pd_cleanup_list)) != NULL) { 656 LIST_REMOVE(pd, pd_next); 657 USB_BUS_UNLOCK(bus); 658 659 usb_destroy_dev_sync(pd); 660 661 USB_BUS_LOCK(bus); 662 } 663 } 664 #endif 665 666 static void 667 usb_power_wdog(void *arg) 668 { 669 struct usb_bus *bus = arg; 670 671 USB_BUS_LOCK_ASSERT(bus, MA_OWNED); 672 673 usb_callout_reset(&bus->power_wdog, 674 4 * hz, usb_power_wdog, arg); 675 676 #ifdef DDB 677 /* 678 * The following line of code is only here to recover from 679 * DDB: 680 */ 681 usb_proc_rewakeup(USB_BUS_EXPLORE_PROC(bus)); /* recover from DDB */ 682 #endif 683 684 #if USB_HAVE_POWERD 685 USB_BUS_UNLOCK(bus); 686 687 usb_bus_power_update(bus); 688 689 USB_BUS_LOCK(bus); 690 #endif 691 } 692 693 /*------------------------------------------------------------------------* 694 * usb_bus_attach 695 * 696 * This function attaches USB in context of the explore thread. 697 *------------------------------------------------------------------------*/ 698 static void 699 usb_bus_attach(struct usb_proc_msg *pm) 700 { 701 struct usb_bus *bus; 702 struct usb_device *child; 703 device_t dev; 704 usb_error_t err; 705 enum usb_dev_speed speed; 706 707 bus = ((struct usb_bus_msg *)pm)->bus; 708 dev = bus->bdev; 709 710 DPRINTF("\n"); 711 712 switch (bus->usbrev) { 713 case USB_REV_1_0: 714 speed = USB_SPEED_FULL; 715 device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n"); 716 break; 717 718 case USB_REV_1_1: 719 speed = USB_SPEED_FULL; 720 device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n"); 721 break; 722 723 case USB_REV_2_0: 724 speed = USB_SPEED_HIGH; 725 device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n"); 726 break; 727 728 case USB_REV_2_5: 729 speed = USB_SPEED_VARIABLE; 730 device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n"); 731 break; 732 733 case USB_REV_3_0: 734 speed = USB_SPEED_SUPER; 735 device_printf(bus->bdev, "5.0Gbps Super Speed USB v3.0\n"); 736 break; 737 738 default: 739 device_printf(bus->bdev, "Unsupported USB revision\n"); 740 #if USB_HAVE_ROOT_MOUNT_HOLD 741 usb_root_mount_rel(bus); 742 #endif 743 return; 744 } 745 746 /* default power_mask value */ 747 bus->hw_power_state = 748 USB_HW_POWER_CONTROL | 749 USB_HW_POWER_BULK | 750 USB_HW_POWER_INTERRUPT | 751 USB_HW_POWER_ISOC | 752 USB_HW_POWER_NON_ROOT_HUB; 753 754 USB_BUS_UNLOCK(bus); 755 756 /* make sure power is set at least once */ 757 758 if (bus->methods->set_hw_power != NULL) { 759 (bus->methods->set_hw_power) (bus); 760 } 761 762 /* allocate the Root USB device */ 763 764 child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1, 765 speed, USB_MODE_HOST); 766 if (child) { 767 err = usb_probe_and_attach(child, 768 USB_IFACE_INDEX_ANY); 769 if (!err) { 770 if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) || 771 (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) { 772 err = USB_ERR_NO_ROOT_HUB; 773 } 774 } 775 } else { 776 err = USB_ERR_NOMEM; 777 } 778 779 USB_BUS_LOCK(bus); 780 781 if (err) { 782 device_printf(bus->bdev, "Root HUB problem, error=%s\n", 783 usbd_errstr(err)); 784 #if USB_HAVE_ROOT_MOUNT_HOLD 785 usb_root_mount_rel(bus); 786 #endif 787 } 788 789 /* set softc - we are ready */ 790 device_set_softc(dev, bus); 791 792 /* start watchdog */ 793 usb_power_wdog(bus); 794 } 795 796 /*------------------------------------------------------------------------* 797 * usb_attach_sub 798 * 799 * This function creates a thread which runs the USB attach code. 800 *------------------------------------------------------------------------*/ 801 static void 802 usb_attach_sub(device_t dev, struct usb_bus *bus) 803 { 804 bus_topo_lock(); 805 if (usb_devclass_ptr == NULL) 806 usb_devclass_ptr = devclass_find("usbus"); 807 bus_topo_unlock(); 808 809 #if USB_HAVE_PF 810 usbpf_attach(bus); 811 #endif 812 /* Initialise USB process messages */ 813 bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore; 814 bus->explore_msg[0].bus = bus; 815 bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore; 816 bus->explore_msg[1].bus = bus; 817 818 bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach; 819 bus->detach_msg[0].bus = bus; 820 bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach; 821 bus->detach_msg[1].bus = bus; 822 823 bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach; 824 bus->attach_msg[0].bus = bus; 825 bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach; 826 bus->attach_msg[1].bus = bus; 827 828 bus->suspend_msg[0].hdr.pm_callback = &usb_bus_suspend; 829 bus->suspend_msg[0].bus = bus; 830 bus->suspend_msg[1].hdr.pm_callback = &usb_bus_suspend; 831 bus->suspend_msg[1].bus = bus; 832 833 bus->resume_msg[0].hdr.pm_callback = &usb_bus_resume; 834 bus->resume_msg[0].bus = bus; 835 bus->resume_msg[1].hdr.pm_callback = &usb_bus_resume; 836 bus->resume_msg[1].bus = bus; 837 838 bus->reset_msg[0].hdr.pm_callback = &usb_bus_reset; 839 bus->reset_msg[0].bus = bus; 840 bus->reset_msg[1].hdr.pm_callback = &usb_bus_reset; 841 bus->reset_msg[1].bus = bus; 842 843 bus->shutdown_msg[0].hdr.pm_callback = &usb_bus_shutdown; 844 bus->shutdown_msg[0].bus = bus; 845 bus->shutdown_msg[1].hdr.pm_callback = &usb_bus_shutdown; 846 bus->shutdown_msg[1].bus = bus; 847 848 #if USB_HAVE_UGEN 849 LIST_INIT(&bus->pd_cleanup_list); 850 bus->cleanup_msg[0].hdr.pm_callback = &usb_bus_cleanup; 851 bus->cleanup_msg[0].bus = bus; 852 bus->cleanup_msg[1].hdr.pm_callback = &usb_bus_cleanup; 853 bus->cleanup_msg[1].bus = bus; 854 #endif 855 856 #if USB_HAVE_PER_BUS_PROCESS 857 /* Create USB explore and callback processes */ 858 859 if (usb_proc_create(USB_BUS_GIANT_PROC(bus), 860 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) { 861 device_printf(dev, "WARNING: Creation of USB Giant " 862 "callback process failed.\n"); 863 } else if (usb_proc_create(USB_BUS_NON_GIANT_ISOC_PROC(bus), 864 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_HIGHEST)) { 865 device_printf(dev, "WARNING: Creation of USB non-Giant ISOC " 866 "callback process failed.\n"); 867 } else if (usb_proc_create(USB_BUS_NON_GIANT_BULK_PROC(bus), 868 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_HIGH)) { 869 device_printf(dev, "WARNING: Creation of USB non-Giant BULK " 870 "callback process failed.\n"); 871 } else if (usb_proc_create(USB_BUS_EXPLORE_PROC(bus), 872 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) { 873 device_printf(dev, "WARNING: Creation of USB explore " 874 "process failed.\n"); 875 } else if (usb_proc_create(USB_BUS_CONTROL_XFER_PROC(bus), 876 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) { 877 device_printf(dev, "WARNING: Creation of USB control transfer " 878 "process failed.\n"); 879 } else 880 #endif 881 { 882 /* Get final attach going */ 883 USB_BUS_LOCK(bus); 884 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 885 &bus->attach_msg[0], &bus->attach_msg[1]); 886 USB_BUS_UNLOCK(bus); 887 888 /* Do initial explore */ 889 usb_needs_explore(bus, 1); 890 } 891 } 892 SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL); 893 894 /*------------------------------------------------------------------------* 895 * usb_bus_mem_flush_all_cb 896 *------------------------------------------------------------------------*/ 897 #if USB_HAVE_BUSDMA 898 static void 899 usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc, 900 struct usb_page *pg, usb_size_t size, usb_size_t align) 901 { 902 usb_pc_cpu_flush(pc); 903 } 904 #endif 905 906 /*------------------------------------------------------------------------* 907 * usb_bus_mem_flush_all - factored out code 908 *------------------------------------------------------------------------*/ 909 #if USB_HAVE_BUSDMA 910 void 911 usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb) 912 { 913 if (cb) { 914 cb(bus, &usb_bus_mem_flush_all_cb); 915 } 916 } 917 #endif 918 919 /*------------------------------------------------------------------------* 920 * usb_bus_mem_alloc_all_cb 921 *------------------------------------------------------------------------*/ 922 #if USB_HAVE_BUSDMA 923 static void 924 usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc, 925 struct usb_page *pg, usb_size_t size, usb_size_t align) 926 { 927 /* need to initialize the page cache */ 928 pc->tag_parent = bus->dma_parent_tag; 929 930 if (usb_pc_alloc_mem(pc, pg, size, align)) { 931 bus->alloc_failed = 1; 932 } 933 } 934 #endif 935 936 /*------------------------------------------------------------------------* 937 * usb_bus_mem_alloc_all - factored out code 938 * 939 * Returns: 940 * 0: Success 941 * Else: Failure 942 *------------------------------------------------------------------------*/ 943 uint8_t 944 usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, 945 usb_bus_mem_cb_t *cb) 946 { 947 bus->alloc_failed = 0; 948 949 mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent), 950 "usb_def_mtx", MTX_DEF | MTX_RECURSE); 951 952 mtx_init(&bus->bus_spin_lock, device_get_nameunit(bus->parent), 953 "usb_spin_mtx", MTX_SPIN | MTX_RECURSE); 954 955 usb_callout_init_mtx(&bus->power_wdog, 956 &bus->bus_mtx, 0); 957 958 TAILQ_INIT(&bus->intr_q.head); 959 960 #if USB_HAVE_BUSDMA 961 usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags, 962 dmat, &bus->bus_mtx, NULL, bus->dma_bits, USB_BUS_DMA_TAG_MAX); 963 #endif 964 if ((bus->devices_max > USB_MAX_DEVICES) || 965 (bus->devices_max < USB_MIN_DEVICES) || 966 (bus->devices == NULL)) { 967 DPRINTFN(0, "Devices field has not been " 968 "initialised properly\n"); 969 bus->alloc_failed = 1; /* failure */ 970 } 971 #if USB_HAVE_BUSDMA 972 if (cb) { 973 cb(bus, &usb_bus_mem_alloc_all_cb); 974 } 975 #endif 976 if (bus->alloc_failed) { 977 usb_bus_mem_free_all(bus, cb); 978 } 979 return (bus->alloc_failed); 980 } 981 982 /*------------------------------------------------------------------------* 983 * usb_bus_mem_free_all_cb 984 *------------------------------------------------------------------------*/ 985 #if USB_HAVE_BUSDMA 986 static void 987 usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc, 988 struct usb_page *pg, usb_size_t size, usb_size_t align) 989 { 990 usb_pc_free_mem(pc); 991 } 992 #endif 993 994 /*------------------------------------------------------------------------* 995 * usb_bus_mem_free_all - factored out code 996 *------------------------------------------------------------------------*/ 997 void 998 usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb) 999 { 1000 #if USB_HAVE_BUSDMA 1001 if (cb) { 1002 cb(bus, &usb_bus_mem_free_all_cb); 1003 } 1004 usb_dma_tag_unsetup(bus->dma_parent_tag); 1005 #endif 1006 1007 mtx_destroy(&bus->bus_mtx); 1008 mtx_destroy(&bus->bus_spin_lock); 1009 } 1010 1011 /* convenience wrappers */ 1012 void 1013 usb_proc_explore_mwait(struct usb_device *udev, void *pm1, void *pm2) 1014 { 1015 usb_proc_mwait(USB_BUS_EXPLORE_PROC(udev->bus), pm1, pm2); 1016 } 1017 1018 void * 1019 usb_proc_explore_msignal(struct usb_device *udev, void *pm1, void *pm2) 1020 { 1021 return (usb_proc_msignal(USB_BUS_EXPLORE_PROC(udev->bus), pm1, pm2)); 1022 } 1023 1024 void 1025 usb_proc_explore_lock(struct usb_device *udev) 1026 { 1027 USB_BUS_LOCK(udev->bus); 1028 } 1029 1030 void 1031 usb_proc_explore_unlock(struct usb_device *udev) 1032 { 1033 USB_BUS_UNLOCK(udev->bus); 1034 } 1035