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_RD|CTLFLAG_TUN, &usb_no_boot_wait, 0,
90 "No USB device enumerate waiting at boot.");
92 static int usb_no_suspend_wait = 0;
93 TUNABLE_INT("hw.usb.no_suspend_wait", &usb_no_suspend_wait);
94 SYSCTL_INT(_hw_usb, OID_AUTO, no_suspend_wait, CTLFLAG_RW|CTLFLAG_TUN,
95 &usb_no_suspend_wait, 0, "No USB device waiting at system suspend.");
97 static int usb_no_shutdown_wait = 0;
98 TUNABLE_INT("hw.usb.no_shutdown_wait", &usb_no_shutdown_wait);
99 SYSCTL_INT(_hw_usb, OID_AUTO, no_shutdown_wait, CTLFLAG_RW|CTLFLAG_TUN,
100 &usb_no_shutdown_wait, 0, "No USB device waiting at system shutdown.");
102 static devclass_t usb_devclass;
104 static device_method_t usb_methods[] = {
105 DEVMETHOD(device_probe, usb_probe),
106 DEVMETHOD(device_attach, usb_attach),
107 DEVMETHOD(device_detach, usb_detach),
108 DEVMETHOD(device_suspend, usb_suspend),
109 DEVMETHOD(device_resume, usb_resume),
110 DEVMETHOD(device_shutdown, usb_shutdown),
114 static driver_t usb_driver = {
116 .methods = usb_methods,
120 /* Host Only Drivers */
121 DRIVER_MODULE(usbus, ohci, usb_driver, usb_devclass, 0, 0);
122 DRIVER_MODULE(usbus, uhci, usb_driver, usb_devclass, 0, 0);
123 DRIVER_MODULE(usbus, ehci, usb_driver, usb_devclass, 0, 0);
124 DRIVER_MODULE(usbus, xhci, usb_driver, usb_devclass, 0, 0);
126 /* Device Only Drivers */
127 DRIVER_MODULE(usbus, at91_udp, usb_driver, usb_devclass, 0, 0);
128 DRIVER_MODULE(usbus, musbotg, usb_driver, usb_devclass, 0, 0);
129 DRIVER_MODULE(usbus, uss820, usb_driver, usb_devclass, 0, 0);
131 /*------------------------------------------------------------------------*
134 * This function is called from "{ehci,ohci,uhci}_pci_attach()".
135 *------------------------------------------------------------------------*/
137 usb_probe(device_t dev)
144 usb_root_mount_rel(struct usb_bus *bus)
146 if (bus->bus_roothold != NULL) {
147 DPRINTF("Releasing root mount hold %p\n", bus->bus_roothold);
148 root_mount_rel(bus->bus_roothold);
149 bus->bus_roothold = NULL;
153 /*------------------------------------------------------------------------*
155 *------------------------------------------------------------------------*/
157 usb_attach(device_t dev)
159 struct usb_bus *bus = device_get_ivars(dev);
164 device_printf(dev, "USB device has no ivars\n");
168 if (usb_no_boot_wait == 0) {
169 /* delay vfs_mountroot until the bus is explored */
170 bus->bus_roothold = root_mount_hold(device_get_nameunit(dev));
173 usb_attach_sub(dev, bus);
175 return (0); /* return success */
178 /*------------------------------------------------------------------------*
180 *------------------------------------------------------------------------*/
182 usb_detach(device_t dev)
184 struct usb_bus *bus = device_get_softc(dev);
189 /* was never setup properly */
192 /* Stop power watchdog */
193 usb_callout_drain(&bus->power_wdog);
195 /* Let the USB explore process detach all devices. */
196 usb_root_mount_rel(bus);
200 /* Queue detach job */
201 usb_proc_msignal(&bus->explore_proc,
202 &bus->detach_msg[0], &bus->detach_msg[1]);
204 /* Wait for detach to complete */
205 usb_proc_mwait(&bus->explore_proc,
206 &bus->detach_msg[0], &bus->detach_msg[1]);
210 /* Get rid of USB callback processes */
212 usb_proc_free(&bus->giant_callback_proc);
213 usb_proc_free(&bus->non_giant_callback_proc);
215 /* Get rid of USB explore process */
217 usb_proc_free(&bus->explore_proc);
219 /* Get rid of control transfer process */
221 usb_proc_free(&bus->control_xfer_proc);
229 /*------------------------------------------------------------------------*
231 *------------------------------------------------------------------------*/
233 usb_suspend(device_t dev)
235 struct usb_bus *bus = device_get_softc(dev);
240 /* was never setup properly */
245 usb_proc_msignal(&bus->explore_proc,
246 &bus->suspend_msg[0], &bus->suspend_msg[1]);
247 if (usb_no_suspend_wait == 0) {
248 /* wait for suspend callback to be executed */
249 usb_proc_mwait(&bus->explore_proc,
250 &bus->suspend_msg[0], &bus->suspend_msg[1]);
257 /*------------------------------------------------------------------------*
259 *------------------------------------------------------------------------*/
261 usb_resume(device_t dev)
263 struct usb_bus *bus = device_get_softc(dev);
268 /* was never setup properly */
273 usb_proc_msignal(&bus->explore_proc,
274 &bus->resume_msg[0], &bus->resume_msg[1]);
280 /*------------------------------------------------------------------------*
282 *------------------------------------------------------------------------*/
284 usb_shutdown(device_t dev)
286 struct usb_bus *bus = device_get_softc(dev);
291 /* was never setup properly */
295 device_printf(bus->bdev, "Controller shutdown\n");
298 usb_proc_msignal(&bus->explore_proc,
299 &bus->shutdown_msg[0], &bus->shutdown_msg[1]);
300 if (usb_no_shutdown_wait == 0) {
301 /* wait for shutdown callback to be executed */
302 usb_proc_mwait(&bus->explore_proc,
303 &bus->shutdown_msg[0], &bus->shutdown_msg[1]);
307 device_printf(bus->bdev, "Controller shutdown complete\n");
312 /*------------------------------------------------------------------------*
315 * This function is used to explore the device tree from the root.
316 *------------------------------------------------------------------------*/
318 usb_bus_explore(struct usb_proc_msg *pm)
321 struct usb_device *udev;
323 bus = ((struct usb_bus_msg *)pm)->bus;
324 udev = bus->devices[USB_ROOT_HUB_ADDR];
326 if (bus->no_explore != 0)
329 if (udev && udev->hub) {
333 bus->driver_added_refcount++;
335 if (bus->driver_added_refcount == 0) {
336 /* avoid zero, hence that is memory default */
337 bus->driver_added_refcount = 1;
342 * The following three lines of code are only here to
345 usb_proc_rewakeup(&bus->control_xfer_proc);
346 usb_proc_rewakeup(&bus->giant_callback_proc);
347 usb_proc_rewakeup(&bus->non_giant_callback_proc);
354 * First update the USB power state!
358 /* Explore the Root USB HUB. */
359 (udev->hub->explore) (udev);
362 usb_root_mount_rel(bus);
365 /*------------------------------------------------------------------------*
368 * This function is used to detach the device tree from the root.
369 *------------------------------------------------------------------------*/
371 usb_bus_detach(struct usb_proc_msg *pm)
374 struct usb_device *udev;
377 bus = ((struct usb_bus_msg *)pm)->bus;
378 udev = bus->devices[USB_ROOT_HUB_ADDR];
380 /* clear the softc */
381 device_set_softc(dev, NULL);
384 /* detach children first */
386 bus_generic_detach(dev);
390 * Free USB device and all subdevices, if any.
392 usb_free_device(udev, 0);
395 /* clear bdev variable last */
399 /*------------------------------------------------------------------------*
402 * This function is used to suspend the USB contoller.
403 *------------------------------------------------------------------------*/
405 usb_bus_suspend(struct usb_proc_msg *pm)
408 struct usb_device *udev;
411 bus = ((struct usb_bus_msg *)pm)->bus;
412 udev = bus->devices[USB_ROOT_HUB_ADDR];
414 if (udev == NULL || bus->bdev == NULL)
420 * We use the shutdown event here because the suspend and
421 * resume events are reserved for the USB port suspend and
422 * resume. The USB system suspend is implemented like full
423 * shutdown and all connected USB devices will be disconnected
424 * subsequently. At resume all USB devices will be
425 * re-connected again.
428 bus_generic_shutdown(bus->bdev);
430 usbd_enum_lock(udev);
432 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX);
434 device_printf(bus->bdev, "Could not unconfigure root HUB\n");
437 bus->hw_power_state = 0;
441 if (bus->methods->set_hw_power != NULL)
442 (bus->methods->set_hw_power) (bus);
444 if (bus->methods->set_hw_power_sleep != NULL)
445 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SUSPEND);
447 usbd_enum_unlock(udev);
452 /*------------------------------------------------------------------------*
455 * This function is used to resume the USB contoller.
456 *------------------------------------------------------------------------*/
458 usb_bus_resume(struct usb_proc_msg *pm)
461 struct usb_device *udev;
464 bus = ((struct usb_bus_msg *)pm)->bus;
465 udev = bus->devices[USB_ROOT_HUB_ADDR];
467 if (udev == NULL || bus->bdev == NULL)
472 usbd_enum_lock(udev);
474 DEVMETHOD(usb_take_controller, NULL); /* dummy */
476 USB_TAKE_CONTROLLER(device_get_parent(bus->bdev));
479 bus->hw_power_state =
480 USB_HW_POWER_CONTROL |
482 USB_HW_POWER_INTERRUPT |
484 USB_HW_POWER_NON_ROOT_HUB;
488 if (bus->methods->set_hw_power_sleep != NULL)
489 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_RESUME);
491 if (bus->methods->set_hw_power != NULL)
492 (bus->methods->set_hw_power) (bus);
494 /* restore USB configuration to index 0 */
495 err = usbd_set_config_index(udev, 0);
497 device_printf(bus->bdev, "Could not configure root HUB\n");
499 /* probe and attach */
500 err = usb_probe_and_attach(udev, USB_IFACE_INDEX_ANY);
502 device_printf(bus->bdev, "Could not probe and "
503 "attach root HUB\n");
506 usbd_enum_unlock(udev);
511 /*------------------------------------------------------------------------*
514 * This function is used to shutdown the USB contoller.
515 *------------------------------------------------------------------------*/
517 usb_bus_shutdown(struct usb_proc_msg *pm)
520 struct usb_device *udev;
523 bus = ((struct usb_bus_msg *)pm)->bus;
524 udev = bus->devices[USB_ROOT_HUB_ADDR];
526 if (udev == NULL || bus->bdev == NULL)
531 bus_generic_shutdown(bus->bdev);
533 usbd_enum_lock(udev);
535 err = usbd_set_config_index(udev, USB_UNCONFIG_INDEX);
537 device_printf(bus->bdev, "Could not unconfigure root HUB\n");
540 bus->hw_power_state = 0;
544 if (bus->methods->set_hw_power != NULL)
545 (bus->methods->set_hw_power) (bus);
547 if (bus->methods->set_hw_power_sleep != NULL)
548 (bus->methods->set_hw_power_sleep) (bus, USB_HW_POWER_SHUTDOWN);
550 usbd_enum_unlock(udev);
556 usb_power_wdog(void *arg)
558 struct usb_bus *bus = arg;
560 USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
562 usb_callout_reset(&bus->power_wdog,
563 4 * hz, usb_power_wdog, arg);
567 * The following line of code is only here to recover from
570 usb_proc_rewakeup(&bus->explore_proc); /* recover from DDB */
576 usb_bus_power_update(bus);
582 /*------------------------------------------------------------------------*
585 * This function attaches USB in context of the explore thread.
586 *------------------------------------------------------------------------*/
588 usb_bus_attach(struct usb_proc_msg *pm)
591 struct usb_device *child;
594 enum usb_dev_speed speed;
596 bus = ((struct usb_bus_msg *)pm)->bus;
601 switch (bus->usbrev) {
603 speed = USB_SPEED_FULL;
604 device_printf(bus->bdev, "12Mbps Full Speed USB v1.0\n");
608 speed = USB_SPEED_FULL;
609 device_printf(bus->bdev, "12Mbps Full Speed USB v1.1\n");
613 speed = USB_SPEED_HIGH;
614 device_printf(bus->bdev, "480Mbps High Speed USB v2.0\n");
618 speed = USB_SPEED_VARIABLE;
619 device_printf(bus->bdev, "480Mbps Wireless USB v2.5\n");
623 speed = USB_SPEED_SUPER;
624 device_printf(bus->bdev, "5.0Gbps Super Speed USB v3.0\n");
628 device_printf(bus->bdev, "Unsupported USB revision\n");
629 usb_root_mount_rel(bus);
633 /* default power_mask value */
634 bus->hw_power_state =
635 USB_HW_POWER_CONTROL |
637 USB_HW_POWER_INTERRUPT |
639 USB_HW_POWER_NON_ROOT_HUB;
643 /* make sure power is set at least once */
645 if (bus->methods->set_hw_power != NULL) {
646 (bus->methods->set_hw_power) (bus);
649 /* allocate the Root USB device */
651 child = usb_alloc_device(bus->bdev, bus, NULL, 0, 0, 1,
652 speed, USB_MODE_HOST);
654 err = usb_probe_and_attach(child,
655 USB_IFACE_INDEX_ANY);
657 if ((bus->devices[USB_ROOT_HUB_ADDR] == NULL) ||
658 (bus->devices[USB_ROOT_HUB_ADDR]->hub == NULL)) {
659 err = USB_ERR_NO_ROOT_HUB;
669 device_printf(bus->bdev, "Root HUB problem, error=%s\n",
671 usb_root_mount_rel(bus);
674 /* set softc - we are ready */
675 device_set_softc(dev, bus);
681 /*------------------------------------------------------------------------*
684 * This function creates a thread which runs the USB attach code.
685 *------------------------------------------------------------------------*/
687 usb_attach_sub(device_t dev, struct usb_bus *bus)
689 const char *pname = device_get_nameunit(dev);
692 if (usb_devclass_ptr == NULL)
693 usb_devclass_ptr = devclass_find("usbus");
699 /* Initialise USB process messages */
700 bus->explore_msg[0].hdr.pm_callback = &usb_bus_explore;
701 bus->explore_msg[0].bus = bus;
702 bus->explore_msg[1].hdr.pm_callback = &usb_bus_explore;
703 bus->explore_msg[1].bus = bus;
705 bus->detach_msg[0].hdr.pm_callback = &usb_bus_detach;
706 bus->detach_msg[0].bus = bus;
707 bus->detach_msg[1].hdr.pm_callback = &usb_bus_detach;
708 bus->detach_msg[1].bus = bus;
710 bus->attach_msg[0].hdr.pm_callback = &usb_bus_attach;
711 bus->attach_msg[0].bus = bus;
712 bus->attach_msg[1].hdr.pm_callback = &usb_bus_attach;
713 bus->attach_msg[1].bus = bus;
715 bus->suspend_msg[0].hdr.pm_callback = &usb_bus_suspend;
716 bus->suspend_msg[0].bus = bus;
717 bus->suspend_msg[1].hdr.pm_callback = &usb_bus_suspend;
718 bus->suspend_msg[1].bus = bus;
720 bus->resume_msg[0].hdr.pm_callback = &usb_bus_resume;
721 bus->resume_msg[0].bus = bus;
722 bus->resume_msg[1].hdr.pm_callback = &usb_bus_resume;
723 bus->resume_msg[1].bus = bus;
725 bus->shutdown_msg[0].hdr.pm_callback = &usb_bus_shutdown;
726 bus->shutdown_msg[0].bus = bus;
727 bus->shutdown_msg[1].hdr.pm_callback = &usb_bus_shutdown;
728 bus->shutdown_msg[1].bus = bus;
730 /* Create USB explore and callback processes */
732 if (usb_proc_create(&bus->giant_callback_proc,
733 &bus->bus_mtx, pname, USB_PRI_MED)) {
734 device_printf(dev, "WARNING: Creation of USB Giant "
735 "callback process failed.\n");
736 } else if (usb_proc_create(&bus->non_giant_callback_proc,
737 &bus->bus_mtx, pname, USB_PRI_HIGH)) {
738 device_printf(dev, "WARNING: Creation of USB non-Giant "
739 "callback process failed.\n");
740 } else if (usb_proc_create(&bus->explore_proc,
741 &bus->bus_mtx, pname, USB_PRI_MED)) {
742 device_printf(dev, "WARNING: Creation of USB explore "
743 "process failed.\n");
744 } else if (usb_proc_create(&bus->control_xfer_proc,
745 &bus->bus_mtx, pname, USB_PRI_MED)) {
746 device_printf(dev, "WARNING: Creation of USB control transfer "
747 "process failed.\n");
749 /* Get final attach going */
751 usb_proc_msignal(&bus->explore_proc,
752 &bus->attach_msg[0], &bus->attach_msg[1]);
755 /* Do initial explore */
756 usb_needs_explore(bus, 1);
760 SYSUNINIT(usb_bus_unload, SI_SUB_KLD, SI_ORDER_ANY, usb_bus_unload, NULL);
762 /*------------------------------------------------------------------------*
763 * usb_bus_mem_flush_all_cb
764 *------------------------------------------------------------------------*/
767 usb_bus_mem_flush_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
768 struct usb_page *pg, usb_size_t size, usb_size_t align)
770 usb_pc_cpu_flush(pc);
774 /*------------------------------------------------------------------------*
775 * usb_bus_mem_flush_all - factored out code
776 *------------------------------------------------------------------------*/
779 usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
782 cb(bus, &usb_bus_mem_flush_all_cb);
787 /*------------------------------------------------------------------------*
788 * usb_bus_mem_alloc_all_cb
789 *------------------------------------------------------------------------*/
792 usb_bus_mem_alloc_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
793 struct usb_page *pg, usb_size_t size, usb_size_t align)
795 /* need to initialize the page cache */
796 pc->tag_parent = bus->dma_parent_tag;
798 if (usb_pc_alloc_mem(pc, pg, size, align)) {
799 bus->alloc_failed = 1;
804 /*------------------------------------------------------------------------*
805 * usb_bus_mem_alloc_all - factored out code
810 *------------------------------------------------------------------------*/
812 usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat,
813 usb_bus_mem_cb_t *cb)
815 bus->alloc_failed = 0;
817 mtx_init(&bus->bus_mtx, device_get_nameunit(bus->parent),
818 NULL, MTX_DEF | MTX_RECURSE);
820 usb_callout_init_mtx(&bus->power_wdog,
823 TAILQ_INIT(&bus->intr_q.head);
826 usb_dma_tag_setup(bus->dma_parent_tag, bus->dma_tags,
827 dmat, &bus->bus_mtx, NULL, 32, USB_BUS_DMA_TAG_MAX);
829 if ((bus->devices_max > USB_MAX_DEVICES) ||
830 (bus->devices_max < USB_MIN_DEVICES) ||
831 (bus->devices == NULL)) {
832 DPRINTFN(0, "Devices field has not been "
833 "initialised properly\n");
834 bus->alloc_failed = 1; /* failure */
838 cb(bus, &usb_bus_mem_alloc_all_cb);
841 if (bus->alloc_failed) {
842 usb_bus_mem_free_all(bus, cb);
844 return (bus->alloc_failed);
847 /*------------------------------------------------------------------------*
848 * usb_bus_mem_free_all_cb
849 *------------------------------------------------------------------------*/
852 usb_bus_mem_free_all_cb(struct usb_bus *bus, struct usb_page_cache *pc,
853 struct usb_page *pg, usb_size_t size, usb_size_t align)
859 /*------------------------------------------------------------------------*
860 * usb_bus_mem_free_all - factored out code
861 *------------------------------------------------------------------------*/
863 usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb)
867 cb(bus, &usb_bus_mem_free_all_cb);
869 usb_dma_tag_unsetup(bus->dma_parent_tag);
872 mtx_destroy(&bus->bus_mtx);