usb_controller.c revision 331722
1/* $FreeBSD: stable/11/sys/dev/usb/controller/usb_controller.c 331722 2018-03-29 02:50:57Z eadler $ */ 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 "opt_ddb.h" 31 32#include <sys/stdint.h> 33#include <sys/stddef.h> 34#include <sys/param.h> 35#include <sys/queue.h> 36#include <sys/types.h> 37#include <sys/systm.h> 38#include <sys/kernel.h> 39#include <sys/bus.h> 40#include <sys/module.h> 41#include <sys/lock.h> 42#include <sys/mutex.h> 43#include <sys/condvar.h> 44#include <sys/sysctl.h> 45#include <sys/sx.h> 46#include <sys/unistd.h> 47#include <sys/callout.h> 48#include <sys/malloc.h> 49#include <sys/priv.h> 50 51#include <dev/usb/usb.h> 52#include <dev/usb/usbdi.h> 53 54#define USB_DEBUG_VAR usb_ctrl_debug 55 56#include <dev/usb/usb_core.h> 57#include <dev/usb/usb_debug.h> 58#include <dev/usb/usb_process.h> 59#include <dev/usb/usb_busdma.h> 60#include <dev/usb/usb_dynamic.h> 61#include <dev/usb/usb_device.h> 62#include <dev/usb/usb_dev.h> 63#include <dev/usb/usb_hub.h> 64 65#include <dev/usb/usb_controller.h> 66#include <dev/usb/usb_bus.h> 67#include <dev/usb/usb_pf.h> 68#include "usb_if.h" 69#endif /* USB_GLOBAL_INCLUDE_FILE */ 70 71/* function prototypes */ 72 73static device_probe_t usb_probe; 74static device_attach_t usb_attach; 75static device_detach_t usb_detach; 76static device_suspend_t usb_suspend; 77static device_resume_t usb_resume; 78static device_shutdown_t usb_shutdown; 79 80static void usb_attach_sub(device_t, struct usb_bus *); 81 82/* static variables */ 83 84#ifdef USB_DEBUG 85static int usb_ctrl_debug = 0; 86 87static SYSCTL_NODE(_hw_usb, OID_AUTO, ctrl, CTLFLAG_RW, 0, "USB controller"); 88SYSCTL_INT(_hw_usb_ctrl, OID_AUTO, debug, CTLFLAG_RWTUN, &usb_ctrl_debug, 0, 89 "Debug level"); 90#endif 91 92#if USB_HAVE_ROOT_MOUNT_HOLD 93static int usb_no_boot_wait = 0; 94SYSCTL_INT(_hw_usb, OID_AUTO, no_boot_wait, CTLFLAG_RDTUN, &usb_no_boot_wait, 0, 95 "No USB device enumerate waiting at boot."); 96#endif 97 98static int usb_no_suspend_wait = 0; 99SYSCTL_INT(_hw_usb, OID_AUTO, no_suspend_wait, CTLFLAG_RWTUN, 100 &usb_no_suspend_wait, 0, "No USB device waiting at system suspend."); 101 102static int usb_no_shutdown_wait = 0; 103SYSCTL_INT(_hw_usb, OID_AUTO, no_shutdown_wait, CTLFLAG_RWTUN, 104 &usb_no_shutdown_wait, 0, "No USB device waiting at system shutdown."); 105 106static devclass_t usb_devclass; 107 108static device_method_t usb_methods[] = { 109 DEVMETHOD(device_probe, usb_probe), 110 DEVMETHOD(device_attach, usb_attach), 111 DEVMETHOD(device_detach, usb_detach), 112 DEVMETHOD(device_suspend, usb_suspend), 113 DEVMETHOD(device_resume, usb_resume), 114 DEVMETHOD(device_shutdown, usb_shutdown), 115 116 DEVMETHOD_END 117}; 118 119static driver_t usb_driver = { 120 .name = "usbus", 121 .methods = usb_methods, 122 .size = 0, 123}; 124 125/* Host Only Drivers */ 126DRIVER_MODULE(usbus, ohci, usb_driver, usb_devclass, 0, 0); 127DRIVER_MODULE(usbus, uhci, usb_driver, usb_devclass, 0, 0); 128DRIVER_MODULE(usbus, ehci, usb_driver, usb_devclass, 0, 0); 129DRIVER_MODULE(usbus, xhci, usb_driver, usb_devclass, 0, 0); 130 131/* Device Only Drivers */ 132DRIVER_MODULE(usbus, at91_udp, usb_driver, usb_devclass, 0, 0); 133DRIVER_MODULE(usbus, musbotg, usb_driver, usb_devclass, 0, 0); 134DRIVER_MODULE(usbus, uss820dci, usb_driver, usb_devclass, 0, 0); 135DRIVER_MODULE(usbus, octusb, usb_driver, usb_devclass, 0, 0); 136 137/* Dual Mode Drivers */ 138DRIVER_MODULE(usbus, dwcotg, usb_driver, usb_devclass, 0, 0); 139DRIVER_MODULE(usbus, saf1761otg, usb_driver, usb_devclass, 0, 0); 140 141/*------------------------------------------------------------------------* 142 * usb_probe 143 * 144 * This function is called from "{ehci,ohci,uhci}_pci_attach()". 145 *------------------------------------------------------------------------*/ 146static int 147usb_probe(device_t dev) 148{ 149 DPRINTF("\n"); 150 return (0); 151} 152 153#if USB_HAVE_ROOT_MOUNT_HOLD 154static void 155usb_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 *------------------------------------------------------------------------*/ 168static int 169usb_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 *------------------------------------------------------------------------*/ 194static int 195usb_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 *------------------------------------------------------------------------*/ 255static int 256usb_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 *------------------------------------------------------------------------*/ 283static int 284usb_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 *------------------------------------------------------------------------*/ 306void 307usb_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 *------------------------------------------------------------------------*/ 328static int 329usb_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 *------------------------------------------------------------------------*/ 363static void 364usb_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 383 if (bus->do_probe) { 384 bus->do_probe = 0; 385 bus->driver_added_refcount++; 386 } 387 if (bus->driver_added_refcount == 0) { 388 /* avoid zero, hence that is memory default */ 389 bus->driver_added_refcount = 1; 390 } 391 392#ifdef DDB 393 /* 394 * The following three lines of code are only here to 395 * recover from DDB: 396 */ 397 usb_proc_rewakeup(USB_BUS_CONTROL_XFER_PROC(bus)); 398 usb_proc_rewakeup(USB_BUS_GIANT_PROC(bus)); 399 usb_proc_rewakeup(USB_BUS_NON_GIANT_ISOC_PROC(bus)); 400 usb_proc_rewakeup(USB_BUS_NON_GIANT_BULK_PROC(bus)); 401#endif 402 403 USB_BUS_UNLOCK(bus); 404 405#if USB_HAVE_POWERD 406 /* 407 * First update the USB power state! 408 */ 409 usb_bus_powerd(bus); 410#endif 411 /* Explore the Root USB HUB. */ 412 (udev->hub->explore) (udev); 413 USB_BUS_LOCK(bus); 414 } 415#if USB_HAVE_ROOT_MOUNT_HOLD 416 usb_root_mount_rel(bus); 417#endif 418} 419 420/*------------------------------------------------------------------------* 421 * usb_bus_detach 422 * 423 * This function is used to detach the device tree from the root. 424 *------------------------------------------------------------------------*/ 425static void 426usb_bus_detach(struct usb_proc_msg *pm) 427{ 428 struct usb_bus *bus; 429 struct usb_device *udev; 430 device_t dev; 431 432 bus = ((struct usb_bus_msg *)pm)->bus; 433 udev = bus->devices[USB_ROOT_HUB_ADDR]; 434 dev = bus->bdev; 435 /* clear the softc */ 436 device_set_softc(dev, NULL); 437 USB_BUS_UNLOCK(bus); 438 439 /* detach children first */ 440 mtx_lock(&Giant); 441 bus_generic_detach(dev); 442 mtx_unlock(&Giant); 443 444 /* 445 * Free USB device and all subdevices, if any. 446 */ 447 usb_free_device(udev, 0); 448 449 USB_BUS_LOCK(bus); 450 /* clear bdev variable last */ 451 bus->bdev = NULL; 452} 453 454/*------------------------------------------------------------------------* 455 * usb_bus_suspend 456 * 457 * This function is used to suspend the USB controller. 458 *------------------------------------------------------------------------*/ 459static void 460usb_bus_suspend(struct usb_proc_msg *pm) 461{ 462 struct usb_bus *bus; 463 struct usb_device *udev; 464 usb_error_t err; 465 uint8_t do_unlock; 466 467 DPRINTF("\n"); 468 469 bus = ((struct usb_bus_msg *)pm)->bus; 470 udev = bus->devices[USB_ROOT_HUB_ADDR]; 471 472 if (udev == NULL || bus->bdev == NULL) 473 return; 474 475 USB_BUS_UNLOCK(bus); 476 477 /* 478 * We use the shutdown event here because the suspend and 479 * resume events are reserved for the USB port suspend and 480 * resume. The USB system suspend is implemented like full 481 * shutdown and all connected USB devices will be disconnected 482 * subsequently. At resume all USB devices will be 483 * re-connected again. 484 */ 485 486 bus_generic_shutdown(bus->bdev); 487 488 do_unlock = usbd_enum_lock(udev); 489 490 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX); 491 if (err) 492 device_printf(bus->bdev, "Could not unconfigure root HUB\n"); 493 494 USB_BUS_LOCK(bus); 495 bus->hw_power_state = 0; 496 bus->no_explore = 1; 497 USB_BUS_UNLOCK(bus); 498 499 if (bus->methods->set_hw_power != NULL) 500 (bus->methods->set_hw_power) (bus); 501 502 if (bus->methods->set_hw_power_sleep != NULL) 503 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SUSPEND); 504 505 if (do_unlock) 506 usbd_enum_unlock(udev); 507 508 USB_BUS_LOCK(bus); 509} 510 511/*------------------------------------------------------------------------* 512 * usb_bus_resume 513 * 514 * This function is used to resume the USB controller. 515 *------------------------------------------------------------------------*/ 516static void 517usb_bus_resume(struct usb_proc_msg *pm) 518{ 519 struct usb_bus *bus; 520 struct usb_device *udev; 521 usb_error_t err; 522 uint8_t do_unlock; 523 524 DPRINTF("\n"); 525 526 bus = ((struct usb_bus_msg *)pm)->bus; 527 udev = bus->devices[USB_ROOT_HUB_ADDR]; 528 529 if (udev == NULL || bus->bdev == NULL) 530 return; 531 532 USB_BUS_UNLOCK(bus); 533 534 do_unlock = usbd_enum_lock(udev); 535#if 0 536 DEVMETHOD(usb_take_controller, NULL); /* dummy */ 537#endif 538 USB_TAKE_CONTROLLER(device_get_parent(bus->bdev)); 539 540 USB_BUS_LOCK(bus); 541 bus->hw_power_state = 542 USB_HW_POWER_CONTROL | 543 USB_HW_POWER_BULK | 544 USB_HW_POWER_INTERRUPT | 545 USB_HW_POWER_ISOC | 546 USB_HW_POWER_NON_ROOT_HUB; 547 bus->no_explore = 0; 548 USB_BUS_UNLOCK(bus); 549 550 if (bus->methods->set_hw_power_sleep != NULL) 551 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_RESUME); 552 553 if (bus->methods->set_hw_power != NULL) 554 (bus->methods->set_hw_power) (bus); 555 556 /* restore USB configuration to index 0 */ 557 err = usbd_set_config_index(udev, 0); 558 if (err) 559 device_printf(bus->bdev, "Could not configure root HUB\n"); 560 561 /* probe and attach */ 562 err = usb_probe_and_attach(udev, USB_IFACE_INDEX_ANY); 563 if (err) { 564 device_printf(bus->bdev, "Could not probe and " 565 "attach root HUB\n"); 566 } 567 568 if (do_unlock) 569 usbd_enum_unlock(udev); 570 571 USB_BUS_LOCK(bus); 572} 573 574/*------------------------------------------------------------------------* 575 * usb_bus_reset 576 * 577 * This function is used to reset the USB controller. 578 *------------------------------------------------------------------------*/ 579static void 580usb_bus_reset(struct usb_proc_msg *pm) 581{ 582 struct usb_bus *bus; 583 584 DPRINTF("\n"); 585 586 bus = ((struct usb_bus_msg *)pm)->bus; 587 588 if (bus->bdev == NULL || bus->no_explore != 0) 589 return; 590 591 /* a suspend and resume will reset the USB controller */ 592 usb_bus_suspend(pm); 593 usb_bus_resume(pm); 594} 595 596/*------------------------------------------------------------------------* 597 * usb_bus_shutdown 598 * 599 * This function is used to shutdown the USB controller. 600 *------------------------------------------------------------------------*/ 601static void 602usb_bus_shutdown(struct usb_proc_msg *pm) 603{ 604 struct usb_bus *bus; 605 struct usb_device *udev; 606 usb_error_t err; 607 uint8_t do_unlock; 608 609 bus = ((struct usb_bus_msg *)pm)->bus; 610 udev = bus->devices[USB_ROOT_HUB_ADDR]; 611 612 if (udev == NULL || bus->bdev == NULL) 613 return; 614 615 USB_BUS_UNLOCK(bus); 616 617 bus_generic_shutdown(bus->bdev); 618 619 do_unlock = usbd_enum_lock(udev); 620 621 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX); 622 if (err) 623 device_printf(bus->bdev, "Could not unconfigure root HUB\n"); 624 625 USB_BUS_LOCK(bus); 626 bus->hw_power_state = 0; 627 bus->no_explore = 1; 628 USB_BUS_UNLOCK(bus); 629 630 if (bus->methods->set_hw_power != NULL) 631 (bus->methods->set_hw_power) (bus); 632 633 if (bus->methods->set_hw_power_sleep != NULL) 634 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SHUTDOWN); 635 636 if (do_unlock) 637 usbd_enum_unlock(udev); 638 639 USB_BUS_LOCK(bus); 640} 641 642/*------------------------------------------------------------------------* 643 * usb_bus_cleanup 644 * 645 * This function is used to cleanup leftover USB character devices. 646 *------------------------------------------------------------------------*/ 647#if USB_HAVE_UGEN 648static void 649usb_bus_cleanup(struct usb_proc_msg *pm) 650{ 651 struct usb_bus *bus; 652 struct usb_fs_privdata *pd; 653 654 bus = ((struct usb_bus_msg *)pm)->bus; 655 656 while ((pd = LIST_FIRST(&bus->pd_cleanup_list)) != NULL) { 657 658 LIST_REMOVE(pd, pd_next); 659 USB_BUS_UNLOCK(bus); 660 661 usb_destroy_dev_sync(pd); 662 663 USB_BUS_LOCK(bus); 664 } 665} 666#endif 667 668static void 669usb_power_wdog(void *arg) 670{ 671 struct usb_bus *bus = arg; 672 673 USB_BUS_LOCK_ASSERT(bus, MA_OWNED); 674 675 usb_callout_reset(&bus->power_wdog, 676 4 * hz, usb_power_wdog, arg); 677 678#ifdef DDB 679 /* 680 * The following line of code is only here to recover from 681 * DDB: 682 */ 683 usb_proc_rewakeup(USB_BUS_EXPLORE_PROC(bus)); /* recover from DDB */ 684#endif 685 686#if USB_HAVE_POWERD 687 USB_BUS_UNLOCK(bus); 688 689 usb_bus_power_update(bus); 690 691 USB_BUS_LOCK(bus); 692#endif 693} 694 695/*------------------------------------------------------------------------* 696 * usb_bus_attach 697 * 698 * This function attaches USB in context of the explore thread. 699 *------------------------------------------------------------------------*/ 700static void 701usb_bus_attach(struct usb_proc_msg *pm) 702{ 703 struct usb_bus *bus; 704 struct usb_device *child; 705 device_t dev; 706 usb_error_t err; 707 enum usb_dev_speed speed; 708 709 bus = ((struct usb_bus_msg *)pm)->bus; 710 dev = bus->bdev; 711 712 DPRINTF("\n"); 713 714 switch (bus->usbrev) { 715 case USB_REV_1_0: 716 speed = USB_SPEED_FULL; 717 device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n"); 718 break; 719 720 case USB_REV_1_1: 721 speed = USB_SPEED_FULL; 722 device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n"); 723 break; 724 725 case USB_REV_2_0: 726 speed = USB_SPEED_HIGH; 727 device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n"); 728 break; 729 730 case USB_REV_2_5: 731 speed = USB_SPEED_VARIABLE; 732 device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n"); 733 break; 734 735 case USB_REV_3_0: 736 speed = USB_SPEED_SUPER; 737 device_printf(bus->bdev, "5.0Gbps Super Speed USB v3.0\n"); 738 break; 739 740 default: 741 device_printf(bus->bdev, "Unsupported USB revision\n"); 742#if USB_HAVE_ROOT_MOUNT_HOLD 743 usb_root_mount_rel(bus); 744#endif 745 return; 746 } 747 748 /* default power_mask value */ 749 bus->hw_power_state = 750 USB_HW_POWER_CONTROL | 751 USB_HW_POWER_BULK | 752 USB_HW_POWER_INTERRUPT | 753 USB_HW_POWER_ISOC | 754 USB_HW_POWER_NON_ROOT_HUB; 755 756 USB_BUS_UNLOCK(bus); 757 758 /* make sure power is set at least once */ 759 760 if (bus->methods->set_hw_power != NULL) { 761 (bus->methods->set_hw_power) (bus); 762 } 763 764 /* allocate the Root USB device */ 765 766 child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1, 767 speed, USB_MODE_HOST); 768 if (child) { 769 err = usb_probe_and_attach(child, 770 USB_IFACE_INDEX_ANY); 771 if (!err) { 772 if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) || 773 (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) { 774 err = USB_ERR_NO_ROOT_HUB; 775 } 776 } 777 } else { 778 err = USB_ERR_NOMEM; 779 } 780 781 USB_BUS_LOCK(bus); 782 783 if (err) { 784 device_printf(bus->bdev, "Root HUB problem, error=%s\n", 785 usbd_errstr(err)); 786#if USB_HAVE_ROOT_MOUNT_HOLD 787 usb_root_mount_rel(bus); 788#endif 789 } 790 791 /* set softc - we are ready */ 792 device_set_softc(dev, bus); 793 794 /* start watchdog */ 795 usb_power_wdog(bus); 796} 797 798/*------------------------------------------------------------------------* 799 * usb_attach_sub 800 * 801 * This function creates a thread which runs the USB attach code. 802 *------------------------------------------------------------------------*/ 803static void 804usb_attach_sub(device_t dev, struct usb_bus *bus) 805{ 806 mtx_lock(&Giant); 807 if (usb_devclass_ptr == NULL) 808 usb_devclass_ptr = devclass_find("usbus"); 809 mtx_unlock(&Giant); 810 811#if USB_HAVE_PF 812 usbpf_attach(bus); 813#endif 814 /* Initialise USB process messages */ 815 bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore; 816 bus->explore_msg[0].bus = bus; 817 bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore; 818 bus->explore_msg[1].bus = bus; 819 820 bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach; 821 bus->detach_msg[0].bus = bus; 822 bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach; 823 bus->detach_msg[1].bus = bus; 824 825 bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach; 826 bus->attach_msg[0].bus = bus; 827 bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach; 828 bus->attach_msg[1].bus = bus; 829 830 bus->suspend_msg[0].hdr.pm_callback = &usb_bus_suspend; 831 bus->suspend_msg[0].bus = bus; 832 bus->suspend_msg[1].hdr.pm_callback = &usb_bus_suspend; 833 bus->suspend_msg[1].bus = bus; 834 835 bus->resume_msg[0].hdr.pm_callback = &usb_bus_resume; 836 bus->resume_msg[0].bus = bus; 837 bus->resume_msg[1].hdr.pm_callback = &usb_bus_resume; 838 bus->resume_msg[1].bus = bus; 839 840 bus->reset_msg[0].hdr.pm_callback = &usb_bus_reset; 841 bus->reset_msg[0].bus = bus; 842 bus->reset_msg[1].hdr.pm_callback = &usb_bus_reset; 843 bus->reset_msg[1].bus = bus; 844 845 bus->shutdown_msg[0].hdr.pm_callback = &usb_bus_shutdown; 846 bus->shutdown_msg[0].bus = bus; 847 bus->shutdown_msg[1].hdr.pm_callback = &usb_bus_shutdown; 848 bus->shutdown_msg[1].bus = bus; 849 850#if USB_HAVE_UGEN 851 LIST_INIT(&bus->pd_cleanup_list); 852 bus->cleanup_msg[0].hdr.pm_callback = &usb_bus_cleanup; 853 bus->cleanup_msg[0].bus = bus; 854 bus->cleanup_msg[1].hdr.pm_callback = &usb_bus_cleanup; 855 bus->cleanup_msg[1].bus = bus; 856#endif 857 858#if USB_HAVE_PER_BUS_PROCESS 859 /* Create USB explore and callback processes */ 860 861 if (usb_proc_create(USB_BUS_GIANT_PROC(bus), 862 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) { 863 device_printf(dev, "WARNING: Creation of USB Giant " 864 "callback process failed.\n"); 865 } else if (usb_proc_create(USB_BUS_NON_GIANT_ISOC_PROC(bus), 866 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_HIGHEST)) { 867 device_printf(dev, "WARNING: Creation of USB non-Giant ISOC " 868 "callback process failed.\n"); 869 } else if (usb_proc_create(USB_BUS_NON_GIANT_BULK_PROC(bus), 870 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_HIGH)) { 871 device_printf(dev, "WARNING: Creation of USB non-Giant BULK " 872 "callback process failed.\n"); 873 } else if (usb_proc_create(USB_BUS_EXPLORE_PROC(bus), 874 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) { 875 device_printf(dev, "WARNING: Creation of USB explore " 876 "process failed.\n"); 877 } else if (usb_proc_create(USB_BUS_CONTROL_XFER_PROC(bus), 878 &bus->bus_mtx, device_get_nameunit(dev), USB_PRI_MED)) { 879 device_printf(dev, "WARNING: Creation of USB control transfer " 880 "process failed.\n"); 881 } else 882#endif 883 { 884 /* Get final attach going */ 885 USB_BUS_LOCK(bus); 886 usb_proc_msignal(USB_BUS_EXPLORE_PROC(bus), 887 &bus->attach_msg[0], &bus->attach_msg[1]); 888 USB_BUS_UNLOCK(bus); 889 890 /* Do initial explore */ 891 usb_needs_explore(bus, 1); 892 } 893} 894SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL); 895 896/*------------------------------------------------------------------------* 897 * usb_bus_mem_flush_all_cb 898 *------------------------------------------------------------------------*/ 899#if USB_HAVE_BUSDMA 900static void 901usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc, 902 struct usb_page *pg, usb_size_t size, usb_size_t align) 903{ 904 usb_pc_cpu_flush(pc); 905} 906#endif 907 908/*------------------------------------------------------------------------* 909 * usb_bus_mem_flush_all - factored out code 910 *------------------------------------------------------------------------*/ 911#if USB_HAVE_BUSDMA 912void 913usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb) 914{ 915 if (cb) { 916 cb(bus, &usb_bus_mem_flush_all_cb); 917 } 918} 919#endif 920 921/*------------------------------------------------------------------------* 922 * usb_bus_mem_alloc_all_cb 923 *------------------------------------------------------------------------*/ 924#if USB_HAVE_BUSDMA 925static void 926usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc, 927 struct usb_page *pg, usb_size_t size, usb_size_t align) 928{ 929 /* need to initialize the page cache */ 930 pc->tag_parent = bus->dma_parent_tag; 931 932 if (usb_pc_alloc_mem(pc, pg, size, align)) { 933 bus->alloc_failed = 1; 934 } 935} 936#endif 937 938/*------------------------------------------------------------------------* 939 * usb_bus_mem_alloc_all - factored out code 940 * 941 * Returns: 942 * 0: Success 943 * Else: Failure 944 *------------------------------------------------------------------------*/ 945uint8_t 946usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, 947 usb_bus_mem_cb_t *cb) 948{ 949 bus->alloc_failed = 0; 950 951 mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent), 952 "usb_def_mtx", MTX_DEF | MTX_RECURSE); 953 954 mtx_init(&bus->bus_spin_lock, device_get_nameunit(bus->parent), 955 "usb_spin_mtx", MTX_SPIN | MTX_RECURSE); 956 957 usb_callout_init_mtx(&bus->power_wdog, 958 &bus->bus_mtx, 0); 959 960 TAILQ_INIT(&bus->intr_q.head); 961 962#if USB_HAVE_BUSDMA 963 usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags, 964 dmat, &bus->bus_mtx, NULL, bus->dma_bits, USB_BUS_DMA_TAG_MAX); 965#endif 966 if ((bus->devices_max > USB_MAX_DEVICES) || 967 (bus->devices_max < USB_MIN_DEVICES) || 968 (bus->devices == NULL)) { 969 DPRINTFN(0, "Devices field has not been " 970 "initialised properly\n"); 971 bus->alloc_failed = 1; /* failure */ 972 } 973#if USB_HAVE_BUSDMA 974 if (cb) { 975 cb(bus, &usb_bus_mem_alloc_all_cb); 976 } 977#endif 978 if (bus->alloc_failed) { 979 usb_bus_mem_free_all(bus, cb); 980 } 981 return (bus->alloc_failed); 982} 983 984/*------------------------------------------------------------------------* 985 * usb_bus_mem_free_all_cb 986 *------------------------------------------------------------------------*/ 987#if USB_HAVE_BUSDMA 988static void 989usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc, 990 struct usb_page *pg, usb_size_t size, usb_size_t align) 991{ 992 usb_pc_free_mem(pc); 993} 994#endif 995 996/*------------------------------------------------------------------------* 997 * usb_bus_mem_free_all - factored out code 998 *------------------------------------------------------------------------*/ 999void 1000usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb) 1001{ 1002#if USB_HAVE_BUSDMA 1003 if (cb) { 1004 cb(bus, &usb_bus_mem_free_all_cb); 1005 } 1006 usb_dma_tag_unsetup(bus->dma_parent_tag); 1007#endif 1008 1009 mtx_destroy(&bus->bus_mtx); 1010 mtx_destroy(&bus->bus_spin_lock); 1011} 1012 1013/* convenience wrappers */ 1014void 1015usb_proc_explore_mwait(struct usb_device *udev, void *pm1, void *pm2) 1016{ 1017 usb_proc_mwait(USB_BUS_EXPLORE_PROC(udev->bus), pm1, pm2); 1018} 1019 1020void * 1021usb_proc_explore_msignal(struct usb_device *udev, void *pm1, void *pm2) 1022{ 1023 return (usb_proc_msignal(USB_BUS_EXPLORE_PROC(udev->bus), pm1, pm2)); 1024} 1025 1026void 1027usb_proc_explore_lock(struct usb_device *udev) 1028{ 1029 USB_BUS_LOCK(udev->bus); 1030} 1031 1032void 1033usb_proc_explore_unlock(struct usb_device *udev) 1034{ 1035 USB_BUS_UNLOCK(udev->bus); 1036} 1037