3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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>
37 #include <sys/module.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/sysctl.h>
43 #include <sys/unistd.h>
44 #include <sys/callout.h>
45 #include <sys/malloc.h>
48 #include <dev/usb/usb.h>
49 #include <dev/usb/usbdi.h>
51 #define USB_DEBUG_VAR usb_ctrl_debug
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>
61 #include <dev/usb/usb_controller.h>
62 #include <dev/usb/usb_bus.h>
63 #include <dev/usb/usb_pf.h>
66 /* function prototypes */
68 static device_probe_t usb_probe;
69 static device_attach_t usb_attach;
70 static device_detach_t usb_detach;
71 static device_suspend_t usb_suspend;
72 static device_resume_t usb_resume;
73 static device_shutdown_t usb_shutdown;
75 static void usb_attach_sub(device_t, struct usb_bus *);
77 /* static variables */
80 static int usb_ctrl_debug = 0;
82 SYSCTL_NODE(_hw_usb, OID_AUTO, ctrl, CTLFLAG_RW, 0, "USB controller");
83 SYSCTL_INT(_hw_usb_ctrl, OID_AUTO, debug, CTLFLAG_RW, &usb_ctrl_debug, 0,
87 static int usb_no_boot_wait = 0;
88 TUNABLE_INT("hw.usb.no_boot_wait", &usb_no_boot_wait);
89 SYSCTL_INT(_hw_usb, OID_AUTO, no_boot_wait, CTLFLAG_RDTUN, &usb_no_boot_wait, 0,
90 "No USB device enumerate waiting at boot.");
92 static int usb_no_shutdown_wait = 0;
93 TUNABLE_INT("hw.usb.no_shutdown_wait", &usb_no_shutdown_wait);
94 SYSCTL_INT(_hw_usb, OID_AUTO, no_shutdown_wait, CTLFLAG_RW|CTLFLAG_TUN, &usb_no_shutdown_wait, 0,
95 "No USB device waiting at system shutdown.");
97 static devclass_t usb_devclass;
99 static device_method_t usb_methods[] = {
100 DEVMETHOD(device_probe, usb_probe),
101 DEVMETHOD(device_attach, usb_attach),
102 DEVMETHOD(device_detach, usb_detach),
103 DEVMETHOD(device_suspend, usb_suspend),
104 DEVMETHOD(device_resume, usb_resume),
105 DEVMETHOD(device_shutdown, usb_shutdown),
109 static driver_t usb_driver = {
111 .methods = usb_methods,
115 /* Host Only Drivers */
116 DRIVER_MODULE(usbus, ohci, usb_driver, usb_devclass, 0, 0);
117 DRIVER_MODULE(usbus, uhci, usb_driver, usb_devclass, 0, 0);
118 DRIVER_MODULE(usbus, ehci, usb_driver, usb_devclass, 0, 0);
119 DRIVER_MODULE(usbus, xhci, usb_driver, usb_devclass, 0, 0);
121 /* Device Only Drivers */
122 DRIVER_MODULE(usbus, at91_udp, usb_driver, usb_devclass, 0, 0);
123 DRIVER_MODULE(usbus, musbotg, usb_driver, usb_devclass, 0, 0);
124 DRIVER_MODULE(usbus, uss820, usb_driver, usb_devclass, 0, 0);
126 /*------------------------------------------------------------------------*
129 * This function is called from "{ehci,ohci,uhci}_pci_attach()".
130 *------------------------------------------------------------------------*/
132 usb_probe(device_t dev)
139 usb_root_mount_rel(struct usb_bus *bus)
141 if (bus->bus_roothold != NULL) {
142 DPRINTF("Releasing root mount hold %p\n", bus->bus_roothold);
143 root_mount_rel(bus->bus_roothold);
144 bus->bus_roothold = NULL;
148 /*------------------------------------------------------------------------*
150 *------------------------------------------------------------------------*/
152 usb_attach(device_t dev)
154 struct usb_bus *bus = device_get_ivars(dev);
159 device_printf(dev, "USB device has no ivars\n");
163 if (usb_no_boot_wait == 0) {
164 /* delay vfs_mountroot until the bus is explored */
165 bus->bus_roothold = root_mount_hold(device_get_nameunit(dev));
168 usb_attach_sub(dev, bus);
170 return (0); /* return success */
173 /*------------------------------------------------------------------------*
175 *------------------------------------------------------------------------*/
177 usb_detach(device_t dev)
179 struct usb_bus *bus = device_get_softc(dev);
184 /* was never setup properly */
187 /* Stop power watchdog */
188 usb_callout_drain(&bus->power_wdog);
190 /* Let the USB explore process detach all devices. */
191 usb_root_mount_rel(bus);
195 /* Queue detach job */
196 usb_proc_msignal(&bus->explore_proc,
197 &bus->detach_msg[0], &bus->detach_msg[1]);
199 /* Wait for detach to complete */
200 usb_proc_mwait(&bus->explore_proc,
201 &bus->detach_msg[0], &bus->detach_msg[1]);
205 /* Get rid of USB callback processes */
207 usb_proc_free(&bus->giant_callback_proc);
208 usb_proc_free(&bus->non_giant_callback_proc);
210 /* Get rid of USB explore process */
212 usb_proc_free(&bus->explore_proc);
214 /* Get rid of control transfer process */
216 usb_proc_free(&bus->control_xfer_proc);
224 /*------------------------------------------------------------------------*
226 *------------------------------------------------------------------------*/
228 usb_suspend(device_t dev)
230 struct usb_bus *bus = device_get_softc(dev);
235 /* was never setup properly */
240 usb_proc_msignal(&bus->explore_proc,
241 &bus->suspend_msg[0], &bus->suspend_msg[1]);
247 /*------------------------------------------------------------------------*
249 *------------------------------------------------------------------------*/
251 usb_resume(device_t dev)
253 struct usb_bus *bus = device_get_softc(dev);
258 /* was never setup properly */
263 usb_proc_msignal(&bus->explore_proc,
264 &bus->resume_msg[0], &bus->resume_msg[1]);
270 /*------------------------------------------------------------------------*
272 *------------------------------------------------------------------------*/
274 usb_shutdown(device_t dev)
276 struct usb_bus *bus = device_get_softc(dev);
281 /* was never setup properly */
285 device_printf(bus->bdev, "Controller shutdown\n");
288 usb_proc_msignal(&bus->explore_proc,
289 &bus->shutdown_msg[0], &bus->shutdown_msg[1]);
290 if (usb_no_shutdown_wait == 0) {
291 /* wait for shutdown callback to be executed */
292 usb_proc_mwait(&bus->explore_proc,
293 &bus->shutdown_msg[0], &bus->shutdown_msg[1]);
297 device_printf(bus->bdev, "Controller shutdown complete\n");
302 /*------------------------------------------------------------------------*
305 * This function is used to explore the device tree from the root.
306 *------------------------------------------------------------------------*/
308 usb_bus_explore(struct usb_proc_msg *pm)
311 struct usb_device *udev;
313 bus = ((struct usb_bus_msg *)pm)->bus;
314 udev = bus->devices[USB_ROOT_HUB_ADDR];
316 if (bus->no_explore != 0)
319 if (udev && udev->hub) {
323 bus->driver_added_refcount++;
325 if (bus->driver_added_refcount == 0) {
326 /* avoid zero, hence that is memory default */
327 bus->driver_added_refcount = 1;
332 * The following three lines of code are only here to
335 usb_proc_rewakeup(&bus->control_xfer_proc);
336 usb_proc_rewakeup(&bus->giant_callback_proc);
337 usb_proc_rewakeup(&bus->non_giant_callback_proc);
344 * First update the USB power state!
348 /* Explore the Root USB HUB. */
349 (udev->hub->explore) (udev);
352 usb_root_mount_rel(bus);
355 /*------------------------------------------------------------------------*
358 * This function is used to detach the device tree from the root.
359 *------------------------------------------------------------------------*/
361 usb_bus_detach(struct usb_proc_msg *pm)
364 struct usb_device *udev;
367 bus = ((struct usb_bus_msg *)pm)->bus;
368 udev = bus->devices[USB_ROOT_HUB_ADDR];
370 /* clear the softc */
371 device_set_softc(dev, NULL);
374 /* detach children first */
376 bus_generic_detach(dev);
380 * Free USB device and all subdevices, if any.
382 usb_free_device(udev, 0);
385 /* clear bdev variable last */
389 /*------------------------------------------------------------------------*
392 * This function is used to suspend the USB contoller.
393 *------------------------------------------------------------------------*/
395 usb_bus_suspend(struct usb_proc_msg *pm)
398 struct usb_device *udev;
401 bus = ((struct usb_bus_msg *)pm)->bus;
402 udev = bus->devices[USB_ROOT_HUB_ADDR];
404 if (udev == NULL || bus->bdev == NULL)
409 bus_generic_shutdown(bus->bdev);
411 usbd_enum_lock(udev);
413 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX);
415 device_printf(bus->bdev, "Could not unconfigure root HUB\n");
418 bus->hw_power_state = 0;
422 if (bus->methods->set_hw_power != NULL)
423 (bus->methods->set_hw_power) (bus);
425 if (bus->methods->set_hw_power_sleep != NULL)
426 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SUSPEND);
428 usbd_enum_unlock(udev);
433 /*------------------------------------------------------------------------*
436 * This function is used to resume the USB contoller.
437 *------------------------------------------------------------------------*/
439 usb_bus_resume(struct usb_proc_msg *pm)
442 struct usb_device *udev;
445 bus = ((struct usb_bus_msg *)pm)->bus;
446 udev = bus->devices[USB_ROOT_HUB_ADDR];
448 if (udev == NULL || bus->bdev == NULL)
453 usbd_enum_lock(udev);
455 DEVMETHOD(usb_take_controller, NULL); /* dummy */
457 USB_TAKE_CONTROLLER(device_get_parent(bus->bdev));
460 bus->hw_power_state =
461 USB_HW_POWER_CONTROL |
463 USB_HW_POWER_INTERRUPT |
465 USB_HW_POWER_NON_ROOT_HUB;
469 if (bus->methods->set_hw_power_sleep != NULL)
470 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_RESUME);
472 if (bus->methods->set_hw_power != NULL)
473 (bus->methods->set_hw_power) (bus);
475 err = usbd_set_config_index(udev, 0);
477 device_printf(bus->bdev, "Could not configure root HUB\n");
479 usbd_enum_unlock(udev);
484 /*------------------------------------------------------------------------*
487 * This function is used to shutdown the USB contoller.
488 *------------------------------------------------------------------------*/
490 usb_bus_shutdown(struct usb_proc_msg *pm)
493 struct usb_device *udev;
496 bus = ((struct usb_bus_msg *)pm)->bus;
497 udev = bus->devices[USB_ROOT_HUB_ADDR];
499 if (udev == NULL || bus->bdev == NULL)
504 bus_generic_shutdown(bus->bdev);
506 usbd_enum_lock(udev);
508 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX);
510 device_printf(bus->bdev, "Could not unconfigure root HUB\n");
513 bus->hw_power_state = 0;
517 if (bus->methods->set_hw_power != NULL)
518 (bus->methods->set_hw_power) (bus);
520 if (bus->methods->set_hw_power_sleep != NULL)
521 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SHUTDOWN);
523 usbd_enum_unlock(udev);
529 usb_power_wdog(void *arg)
531 struct usb_bus *bus = arg;
533 USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
535 usb_callout_reset(&bus->power_wdog,
536 4 * hz, usb_power_wdog, arg);
540 * The following line of code is only here to recover from
543 usb_proc_rewakeup(&bus->explore_proc); /* recover from DDB */
549 usb_bus_power_update(bus);
555 /*------------------------------------------------------------------------*
558 * This function attaches USB in context of the explore thread.
559 *------------------------------------------------------------------------*/
561 usb_bus_attach(struct usb_proc_msg *pm)
564 struct usb_device *child;
567 enum usb_dev_speed speed;
569 bus = ((struct usb_bus_msg *)pm)->bus;
574 switch (bus->usbrev) {
576 speed = USB_SPEED_FULL;
577 device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n");
581 speed = USB_SPEED_FULL;
582 device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n");
586 speed = USB_SPEED_HIGH;
587 device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n");
591 speed = USB_SPEED_VARIABLE;
592 device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n");
596 speed = USB_SPEED_SUPER;
597 device_printf(bus->bdev, "5.0Gbps Super Speed USB v3.0\n");
601 device_printf(bus->bdev, "Unsupported USB revision\n");
602 usb_root_mount_rel(bus);
606 /* default power_mask value */
607 bus->hw_power_state =
608 USB_HW_POWER_CONTROL |
610 USB_HW_POWER_INTERRUPT |
612 USB_HW_POWER_NON_ROOT_HUB;
616 /* make sure power is set at least once */
618 if (bus->methods->set_hw_power != NULL) {
619 (bus->methods->set_hw_power) (bus);
622 /* allocate the Root USB device */
624 child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1,
625 speed, USB_MODE_HOST);
627 err = usb_probe_and_attach(child,
628 USB_IFACE_INDEX_ANY);
630 if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) ||
631 (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) {
632 err = USB_ERR_NO_ROOT_HUB;
642 device_printf(bus->bdev, "Root HUB problem, error=%s\n",
644 usb_root_mount_rel(bus);
647 /* set softc - we are ready */
648 device_set_softc(dev, bus);
654 /*------------------------------------------------------------------------*
657 * This function creates a thread which runs the USB attach code.
658 *------------------------------------------------------------------------*/
660 usb_attach_sub(device_t dev, struct usb_bus *bus)
662 const char *pname = device_get_nameunit(dev);
665 if (usb_devclass_ptr == NULL)
666 usb_devclass_ptr = devclass_find("usbus");
672 /* Initialise USB process messages */
673 bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore;
674 bus->explore_msg[0].bus = bus;
675 bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore;
676 bus->explore_msg[1].bus = bus;
678 bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach;
679 bus->detach_msg[0].bus = bus;
680 bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach;
681 bus->detach_msg[1].bus = bus;
683 bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach;
684 bus->attach_msg[0].bus = bus;
685 bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach;
686 bus->attach_msg[1].bus = bus;
688 bus->suspend_msg[0].hdr.pm_callback = &usb_bus_suspend;
689 bus->suspend_msg[0].bus = bus;
690 bus->suspend_msg[1].hdr.pm_callback = &usb_bus_suspend;
691 bus->suspend_msg[1].bus = bus;
693 bus->resume_msg[0].hdr.pm_callback = &usb_bus_resume;
694 bus->resume_msg[0].bus = bus;
695 bus->resume_msg[1].hdr.pm_callback = &usb_bus_resume;
696 bus->resume_msg[1].bus = bus;
698 bus->shutdown_msg[0].hdr.pm_callback = &usb_bus_shutdown;
699 bus->shutdown_msg[0].bus = bus;
700 bus->shutdown_msg[1].hdr.pm_callback = &usb_bus_shutdown;
701 bus->shutdown_msg[1].bus = bus;
703 /* Create USB explore and callback processes */
705 if (usb_proc_create(&bus->giant_callback_proc,
706 &bus->bus_mtx, pname, USB_PRI_MED)) {
707 device_printf(dev, "WARNING: Creation of USB Giant "
708 "callback process failed.\n");
709 } else if (usb_proc_create(&bus->non_giant_callback_proc,
710 &bus->bus_mtx, pname, USB_PRI_HIGH)) {
711 device_printf(dev, "WARNING: Creation of USB non-Giant "
712 "callback process failed.\n");
713 } else if (usb_proc_create(&bus->explore_proc,
714 &bus->bus_mtx, pname, USB_PRI_MED)) {
715 device_printf(dev, "WARNING: Creation of USB explore "
716 "process failed.\n");
717 } else if (usb_proc_create(&bus->control_xfer_proc,
718 &bus->bus_mtx, pname, USB_PRI_MED)) {
719 device_printf(dev, "WARNING: Creation of USB control transfer "
720 "process failed.\n");
722 /* Get final attach going */
724 usb_proc_msignal(&bus->explore_proc,
725 &bus->attach_msg[0], &bus->attach_msg[1]);
728 /* Do initial explore */
729 usb_needs_explore(bus, 1);
733 SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL);
735 /*------------------------------------------------------------------------*
736 * usb_bus_mem_flush_all_cb
737 *------------------------------------------------------------------------*/
740 usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
741 struct usb_page *pg, usb_size_t size, usb_size_t align)
743 usb_pc_cpu_flush(pc);
747 /*------------------------------------------------------------------------*
748 * usb_bus_mem_flush_all - factored out code
749 *------------------------------------------------------------------------*/
752 usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
755 cb(bus, &usb_bus_mem_flush_all_cb);
760 /*------------------------------------------------------------------------*
761 * usb_bus_mem_alloc_all_cb
762 *------------------------------------------------------------------------*/
765 usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
766 struct usb_page *pg, usb_size_t size, usb_size_t align)
768 /* need to initialize the page cache */
769 pc->tag_parent = bus->dma_parent_tag;
771 if (usb_pc_alloc_mem(pc, pg, size, align)) {
772 bus->alloc_failed = 1;
777 /*------------------------------------------------------------------------*
778 * usb_bus_mem_alloc_all - factored out code
783 *------------------------------------------------------------------------*/
785 usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat,
786 usb_bus_mem_cb_t *cb)
788 bus->alloc_failed = 0;
790 mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent),
791 NULL, MTX_DEF | MTX_RECURSE);
793 usb_callout_init_mtx(&bus->power_wdog,
796 TAILQ_INIT(&bus->intr_q.head);
799 usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags,
800 dmat, &bus->bus_mtx, NULL, 32, USB_BUS_DMA_TAG_MAX);
802 if ((bus->devices_max > USB_MAX_DEVICES) ||
803 (bus->devices_max < USB_MIN_DEVICES) ||
804 (bus->devices == NULL)) {
805 DPRINTFN(0, "Devices field has not been "
806 "initialised properly\n");
807 bus->alloc_failed = 1; /* failure */
811 cb(bus, &usb_bus_mem_alloc_all_cb);
814 if (bus->alloc_failed) {
815 usb_bus_mem_free_all(bus, cb);
817 return (bus->alloc_failed);
820 /*------------------------------------------------------------------------*
821 * usb_bus_mem_free_all_cb
822 *------------------------------------------------------------------------*/
825 usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
826 struct usb_page *pg, usb_size_t size, usb_size_t align)
832 /*------------------------------------------------------------------------*
833 * usb_bus_mem_free_all - factored out code
834 *------------------------------------------------------------------------*/
836 usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
840 cb(bus, &usb_bus_mem_free_all_cb);
842 usb_dma_tag_unsetup(bus->dma_parent_tag);
845 mtx_destroy(&bus->bus_mtx);