sys/dev/usb/controller/usb_controller.c

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include "opt_ddb.h"
  28
  29 #include <sys/stdint.h>
  30 #include <sys/stddef.h>
  31 #include <sys/param.h>
  32 #include <sys/queue.h>
  33 #include <sys/types.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/bus.h>
  37 #include <sys/module.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #include <sys/condvar.h>
  41 #include <sys/sysctl.h>
  42 #include <sys/sx.h>
  43 #include <sys/unistd.h>
  44 #include <sys/callout.h>
  45 #include <sys/malloc.h>
  46 #include <sys/priv.h>
  47
  48 #include <dev/usb/usb.h>
  49 #include <dev/usb/usbdi.h>
  50
  51 #define USB_DEBUG_VAR usb_ctrl_debug
  52
  53 #include <dev/usb/usb_core.h>
  54 #include <dev/usb/usb_debug.h>
  55 #include <dev/usb/usb_process.h>
  56 #include <dev/usb/usb_busdma.h>
  57 #include <dev/usb/usb_dynamic.h>
  58 #include <dev/usb/usb_device.h>
  59 #include <dev/usb/usb_hub.h>
  60
  61 #include <dev/usb/usb_controller.h>
  62 #include <dev/usb/usb_bus.h>
  63 #include <dev/usb/usb_pf.h>
  64
  65 /* function prototypes  */
  66
  67 static device_probe_t usb_probe;
  68 static device_attach_t usb_attach;
  69 static device_detach_t usb_detach;
  70
  71 static void     usb_attach_sub(device_t, struct usb_bus *);
  72
  73 /* static variables */
  74
  75 #ifdef USB_DEBUG
  76 static int usb_ctrl_debug = 0;
  77
  78 SYSCTL_NODE(_hw_usb, OID_AUTO, ctrl, CTLFLAG_RW, 0, "USB controller");
  79 SYSCTL_INT(_hw_usb_ctrl, OID_AUTO, debug, CTLFLAG_RW, &usb_ctrl_debug, 0,
  80     "Debug level");
  81 #endif
  82
  83 static int usb_no_boot_wait = 0;
  84 TUNABLE_INT("hw.usb.no_boot_wait", &usb_no_boot_wait);
  85 SYSCTL_INT(_hw_usb, OID_AUTO, no_boot_wait, CTLFLAG_RDTUN, &usb_no_boot_wait, 0,
  86     "No device enumerate waiting at boot.");
  87
  88 static devclass_t usb_devclass;
  89
  90 static device_method_t usb_methods[] = {
  91         DEVMETHOD(device_probe, usb_probe),
  92         DEVMETHOD(device_attach, usb_attach),
  93         DEVMETHOD(device_detach, usb_detach),
  94         DEVMETHOD(device_suspend, bus_generic_suspend),
  95         DEVMETHOD(device_resume, bus_generic_resume),
  96         DEVMETHOD(device_shutdown, bus_generic_shutdown),
  97         {0, 0}
  98 };
  99
 100 static driver_t usb_driver = {
 101         .name = "usbus",
 102         .methods = usb_methods,
 103         .size = 0,
 104 };
 105
 106 /* Host Only Drivers */
 107 DRIVER_MODULE(usbus, ohci, usb_driver, usb_devclass, 0, 0);
 108 DRIVER_MODULE(usbus, uhci, usb_driver, usb_devclass, 0, 0);
 109 DRIVER_MODULE(usbus, ehci, usb_driver, usb_devclass, 0, 0);
 110 DRIVER_MODULE(usbus, xhci, usb_driver, usb_devclass, 0, 0);
 111
 112 /* Device Only Drivers */
 113 DRIVER_MODULE(usbus, at91_udp, usb_driver, usb_devclass, 0, 0);
 114 DRIVER_MODULE(usbus, musbotg, usb_driver, usb_devclass, 0, 0);
 115 DRIVER_MODULE(usbus, uss820, usb_driver, usb_devclass, 0, 0);
 116
 117 /*------------------------------------------------------------------------*
 118  *      usb_probe
 119  *
 120  * This function is called from "{ehci,ohci,uhci}_pci_attach()".
 121  *------------------------------------------------------------------------*/
 122 static int
 123 usb_probe(device_t dev)
 124 {
 125         DPRINTF("\n");
 126         return (0);
 127 }
 128
 129 static void
 130 usb_root_mount_rel(struct usb_bus *bus)
 131 {
 132         if (bus->bus_roothold != NULL) {
 133                 DPRINTF("Releasing root mount hold %p\n", bus->bus_roothold);
 134                 root_mount_rel(bus->bus_roothold);
 135                 bus->bus_roothold = NULL;
 136         }
 137 }
 138
 139 /*------------------------------------------------------------------------*
 140  *      usb_attach
 141  *------------------------------------------------------------------------*/
 142 static int
 143 usb_attach(device_t dev)
 144 {
 145         struct usb_bus *bus = device_get_ivars(dev);
 146
 147         DPRINTF("\n");
 148
 149         if (bus == NULL) {
 150                 device_printf(dev, "USB device has no ivars\n");
 151                 return (ENXIO);
 152         }
 153
 154         if (usb_no_boot_wait == 0) {
 155                 /* delay vfs_mountroot until the bus is explored */
 156                 bus->bus_roothold = root_mount_hold(device_get_nameunit(dev));
 157         }
 158
 159         usb_attach_sub(dev, bus);
 160
 161         return (0);                     /* return success */
 162 }
 163
 164 /*------------------------------------------------------------------------*
 165  *      usb_detach
 166  *------------------------------------------------------------------------*/
 167 static int
 168 usb_detach(device_t dev)
 169 {
 170         struct usb_bus *bus = device_get_softc(dev);
 171
 172         DPRINTF("\n");
 173
 174         if (bus == NULL) {
 175                 /* was never setup properly */
 176                 return (0);
 177         }
 178         /* Stop power watchdog */
 179         usb_callout_drain(&bus->power_wdog);
 180
 181         /* Let the USB explore process detach all devices. */
 182         usb_root_mount_rel(bus);
 183
 184         USB_BUS_LOCK(bus);
 185         if (usb_proc_msignal(&bus->explore_proc,
 186             &bus->detach_msg[0], &bus->detach_msg[1])) {
 187                 /* ignore */
 188         }
 189         /* Wait for detach to complete */
 190
 191         usb_proc_mwait(&bus->explore_proc,
 192             &bus->detach_msg[0], &bus->detach_msg[1]);
 193
 194         USB_BUS_UNLOCK(bus);
 195
 196         /* Get rid of USB callback processes */
 197
 198         usb_proc_free(&bus->giant_callback_proc);
 199         usb_proc_free(&bus->non_giant_callback_proc);
 200
 201         /* Get rid of USB explore process */
 202
 203         usb_proc_free(&bus->explore_proc);
 204
 205         /* Get rid of control transfer process */
 206
 207         usb_proc_free(&bus->control_xfer_proc);
 208
 209 #if USB_HAVE_PF
 210         usbpf_detach(bus);
 211 #endif
 212         return (0);
 213 }
 214
 215 /*------------------------------------------------------------------------*
 216  *      usb_bus_explore
 217  *
 218  * This function is used to explore the device tree from the root.
 219  *------------------------------------------------------------------------*/
 220 static void
 221 usb_bus_explore(struct usb_proc_msg *pm)
 222 {
 223         struct usb_bus *bus;
 224         struct usb_device *udev;
 225
 226         bus = ((struct usb_bus_msg *)pm)->bus;
 227         udev = bus->devices[USB_ROOT_HUB_ADDR];
 228
 229         if (udev && udev->hub) {
 230
 231                 if (bus->do_probe) {
 232                         bus->do_probe = 0;
 233                         bus->driver_added_refcount++;
 234                 }
 235                 if (bus->driver_added_refcount == 0) {
 236                         /* avoid zero, hence that is memory default */
 237                         bus->driver_added_refcount = 1;
 238                 }
 239
 240 #ifdef DDB
 241                 /*
 242                  * The following three lines of code are only here to
 243                  * recover from DDB:
 244                  */
 245                 usb_proc_rewakeup(&bus->control_xfer_proc);
 246                 usb_proc_rewakeup(&bus->giant_callback_proc);
 247                 usb_proc_rewakeup(&bus->non_giant_callback_proc);
 248 #endif
 249
 250                 USB_BUS_UNLOCK(bus);
 251
 252 #if USB_HAVE_POWERD
 253                 /*
 254                  * First update the USB power state!
 255                  */
 256                 usb_bus_powerd(bus);
 257 #endif
 258                  /* Explore the Root USB HUB. */
 259                 (udev->hub->explore) (udev);
 260                 USB_BUS_LOCK(bus);
 261         }
 262         usb_root_mount_rel(bus);
 263 }
 264
 265 /*------------------------------------------------------------------------*
 266  *      usb_bus_detach
 267  *
 268  * This function is used to detach the device tree from the root.
 269  *------------------------------------------------------------------------*/
 270 static void
 271 usb_bus_detach(struct usb_proc_msg *pm)
 272 {
 273         struct usb_bus *bus;
 274         struct usb_device *udev;
 275         device_t dev;
 276
 277         bus = ((struct usb_bus_msg *)pm)->bus;
 278         udev = bus->devices[USB_ROOT_HUB_ADDR];
 279         dev = bus->bdev;
 280         /* clear the softc */
 281         device_set_softc(dev, NULL);
 282         USB_BUS_UNLOCK(bus);
 283
 284         /* detach children first */
 285         mtx_lock(&Giant);
 286         bus_generic_detach(dev);
 287         mtx_unlock(&Giant);
 288
 289         /*
 290          * Free USB device and all subdevices, if any.
 291          */
 292         usb_free_device(udev, 0);
 293
 294         USB_BUS_LOCK(bus);
 295         /* clear bdev variable last */
 296         bus->bdev = NULL;
 297 }
 298
 299 static void
 300 usb_power_wdog(void *arg)
 301 {
 302         struct usb_bus *bus = arg;
 303
 304         USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
 305
 306         usb_callout_reset(&bus->power_wdog,
 307             4 * hz, usb_power_wdog, arg);
 308
 309 #ifdef DDB
 310         /*
 311          * The following line of code is only here to recover from
 312          * DDB:
 313          */
 314         usb_proc_rewakeup(&bus->explore_proc);  /* recover from DDB */
 315 #endif
 316
 317 #if USB_HAVE_POWERD
 318         USB_BUS_UNLOCK(bus);
 319
 320         usb_bus_power_update(bus);
 321
 322         USB_BUS_LOCK(bus);
 323 #endif
 324 }
 325
 326 /*------------------------------------------------------------------------*
 327  *      usb_bus_attach
 328  *
 329  * This function attaches USB in context of the explore thread.
 330  *------------------------------------------------------------------------*/
 331 static void
 332 usb_bus_attach(struct usb_proc_msg *pm)
 333 {
 334         struct usb_bus *bus;
 335         struct usb_device *child;
 336         device_t dev;
 337         usb_error_t err;
 338         enum usb_dev_speed speed;
 339
 340         bus = ((struct usb_bus_msg *)pm)->bus;
 341         dev = bus->bdev;
 342
 343         DPRINTF("\n");
 344
 345         switch (bus->usbrev) {
 346         case USB_REV_1_0:
 347                 speed = USB_SPEED_FULL;
 348                 device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n");
 349                 break;
 350
 351         case USB_REV_1_1:
 352                 speed = USB_SPEED_FULL;
 353                 device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n");
 354                 break;
 355
 356         case USB_REV_2_0:
 357                 speed = USB_SPEED_HIGH;
 358                 device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n");
 359                 break;
 360
 361         case USB_REV_2_5:
 362                 speed = USB_SPEED_VARIABLE;
 363                 device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n");
 364                 break;
 365
 366         case USB_REV_3_0:
 367                 speed = USB_SPEED_SUPER;
 368                 device_printf(bus->bdev, "5.0Gbps Super Speed USB v3.0\n");
 369                 break;
 370
 371         default:
 372                 device_printf(bus->bdev, "Unsupported USB revision\n");
 373                 usb_root_mount_rel(bus);
 374                 return;
 375         }
 376
 377         USB_BUS_UNLOCK(bus);
 378
 379         /* default power_mask value */
 380         bus->hw_power_state =
 381           USB_HW_POWER_CONTROL |
 382           USB_HW_POWER_BULK |
 383           USB_HW_POWER_INTERRUPT |
 384           USB_HW_POWER_ISOC |
 385           USB_HW_POWER_NON_ROOT_HUB;
 386
 387         /* make sure power is set at least once */
 388
 389         if (bus->methods->set_hw_power != NULL) {
 390                 (bus->methods->set_hw_power) (bus);
 391         }
 392
 393         /* Allocate the Root USB device */
 394
 395         child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1,
 396             speed, USB_MODE_HOST);
 397         if (child) {
 398                 err = usb_probe_and_attach(child,
 399                     USB_IFACE_INDEX_ANY);
 400                 if (!err) {
 401                         if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) ||
 402                             (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) {
 403                                 err = USB_ERR_NO_ROOT_HUB;
 404                         }
 405                 }
 406         } else {
 407                 err = USB_ERR_NOMEM;
 408         }
 409
 410         USB_BUS_LOCK(bus);
 411
 412         if (err) {
 413                 device_printf(bus->bdev, "Root HUB problem, error=%s\n",
 414                     usbd_errstr(err));
 415                 usb_root_mount_rel(bus);
 416         }
 417
 418         /* set softc - we are ready */
 419         device_set_softc(dev, bus);
 420
 421         /* start watchdog */
 422         usb_power_wdog(bus);
 423 }
 424
 425 /*------------------------------------------------------------------------*
 426  *      usb_attach_sub
 427  *
 428  * This function creates a thread which runs the USB attach code.
 429  *------------------------------------------------------------------------*/
 430 static void
 431 usb_attach_sub(device_t dev, struct usb_bus *bus)
 432 {
 433         const char *pname = device_get_nameunit(dev);
 434
 435         mtx_lock(&Giant);
 436         if (usb_devclass_ptr == NULL)
 437                 usb_devclass_ptr = devclass_find("usbus");
 438         mtx_unlock(&Giant);
 439
 440 #if USB_HAVE_PF
 441         usbpf_attach(bus);
 442 #endif
 443         /* Initialise USB process messages */
 444         bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore;
 445         bus->explore_msg[0].bus = bus;
 446         bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore;
 447         bus->explore_msg[1].bus = bus;
 448
 449         bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach;
 450         bus->detach_msg[0].bus = bus;
 451         bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach;
 452         bus->detach_msg[1].bus = bus;
 453
 454         bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach;
 455         bus->attach_msg[0].bus = bus;
 456         bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach;
 457         bus->attach_msg[1].bus = bus;
 458
 459         /* Create USB explore and callback processes */
 460
 461         if (usb_proc_create(&bus->giant_callback_proc,
 462             &bus->bus_mtx, pname, USB_PRI_MED)) {
 463                 device_printf(dev, "WARNING: Creation of USB Giant "
 464                     "callback process failed.\n");
 465         } else if (usb_proc_create(&bus->non_giant_callback_proc,
 466             &bus->bus_mtx, pname, USB_PRI_HIGH)) {
 467                 device_printf(dev, "WARNING: Creation of USB non-Giant "
 468                     "callback process failed.\n");
 469         } else if (usb_proc_create(&bus->explore_proc,
 470             &bus->bus_mtx, pname, USB_PRI_MED)) {
 471                 device_printf(dev, "WARNING: Creation of USB explore "
 472                     "process failed.\n");
 473         } else if (usb_proc_create(&bus->control_xfer_proc,
 474             &bus->bus_mtx, pname, USB_PRI_MED)) {
 475                 device_printf(dev, "WARNING: Creation of USB control transfer "
 476                     "process failed.\n");
 477         } else {
 478                 /* Get final attach going */
 479                 USB_BUS_LOCK(bus);
 480                 if (usb_proc_msignal(&bus->explore_proc,
 481                     &bus->attach_msg[0], &bus->attach_msg[1])) {
 482                         /* ignore */
 483                 }
 484                 USB_BUS_UNLOCK(bus);
 485
 486                 /* Do initial explore */
 487                 usb_needs_explore(bus, 1);
 488         }
 489 }
 490
 491 SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL);
 492
 493 /*------------------------------------------------------------------------*
 494  *      usb_bus_mem_flush_all_cb
 495  *------------------------------------------------------------------------*/
 496 #if USB_HAVE_BUSDMA
 497 static void
 498 usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
 499     struct usb_page *pg, usb_size_t size, usb_size_t align)
 500 {
 501         usb_pc_cpu_flush(pc);
 502 }
 503 #endif
 504
 505 /*------------------------------------------------------------------------*
 506  *      usb_bus_mem_flush_all - factored out code
 507  *------------------------------------------------------------------------*/
 508 #if USB_HAVE_BUSDMA
 509 void
 510 usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
 511 {
 512         if (cb) {
 513                 cb(bus, &usb_bus_mem_flush_all_cb);
 514         }
 515 }
 516 #endif
 517
 518 /*------------------------------------------------------------------------*
 519  *      usb_bus_mem_alloc_all_cb
 520  *------------------------------------------------------------------------*/
 521 #if USB_HAVE_BUSDMA
 522 static void
 523 usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
 524     struct usb_page *pg, usb_size_t size, usb_size_t align)
 525 {
 526         /* need to initialize the page cache */
 527         pc->tag_parent = bus->dma_parent_tag;
 528
 529         if (usb_pc_alloc_mem(pc, pg, size, align)) {
 530                 bus->alloc_failed = 1;
 531         }
 532 }
 533 #endif
 534
 535 /*------------------------------------------------------------------------*
 536  *      usb_bus_mem_alloc_all - factored out code
 537  *
 538  * Returns:
 539  *    0: Success
 540  * Else: Failure
 541  *------------------------------------------------------------------------*/
 542 uint8_t
 543 usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat,
 544     usb_bus_mem_cb_t *cb)
 545 {
 546         bus->alloc_failed = 0;
 547
 548         mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent),
 549             NULL, MTX_DEF | MTX_RECURSE);
 550
 551         usb_callout_init_mtx(&bus->power_wdog,
 552             &bus->bus_mtx, 0);
 553
 554         TAILQ_INIT(&bus->intr_q.head);
 555
 556 #if USB_HAVE_BUSDMA
 557         usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags,
 558             dmat, &bus->bus_mtx, NULL, 32, USB_BUS_DMA_TAG_MAX);
 559 #endif
 560         if ((bus->devices_max > USB_MAX_DEVICES) ||
 561             (bus->devices_max < USB_MIN_DEVICES) ||
 562             (bus->devices == NULL)) {
 563                 DPRINTFN(0, "Devices field has not been "
 564                     "initialised properly\n");
 565                 bus->alloc_failed = 1;          /* failure */
 566         }
 567 #if USB_HAVE_BUSDMA
 568         if (cb) {
 569                 cb(bus, &usb_bus_mem_alloc_all_cb);
 570         }
 571 #endif
 572         if (bus->alloc_failed) {
 573                 usb_bus_mem_free_all(bus, cb);
 574         }
 575         return (bus->alloc_failed);
 576 }
 577
 578 /*------------------------------------------------------------------------*
 579  *      usb_bus_mem_free_all_cb
 580  *------------------------------------------------------------------------*/
 581 #if USB_HAVE_BUSDMA
 582 static void
 583 usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
 584     struct usb_page *pg, usb_size_t size, usb_size_t align)
 585 {
 586         usb_pc_free_mem(pc);
 587 }
 588 #endif
 589
 590 /*------------------------------------------------------------------------*
 591  *      usb_bus_mem_free_all - factored out code
 592  *------------------------------------------------------------------------*/
 593 void
 594 usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
 595 {
 596 #if USB_HAVE_BUSDMA
 597         if (cb) {
 598                 cb(bus, &usb_bus_mem_free_all_cb);
 599         }
 600         usb_dma_tag_unsetup(bus->dma_parent_tag);
 601 #endif
 602
 603         mtx_destroy(&bus->bus_mtx);
 604 }
 605