2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2015 Semihalf.
5 * Copyright (c) 2015 Stormshield.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/stdint.h>
34 #include <sys/stddef.h>
35 #include <sys/param.h>
36 #include <sys/queue.h>
37 #include <sys/types.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <sys/condvar.h>
45 #include <sys/sysctl.h>
47 #include <sys/unistd.h>
51 #include <dev/usb/usb.h>
52 #include <dev/usb/usbdi.h>
54 #include <dev/usb/usb_core.h>
55 #include <dev/usb/usb_busdma.h>
56 #include <dev/usb/usb_process.h>
57 #include <dev/usb/usb_util.h>
59 #include <dev/usb/usb_controller.h>
60 #include <dev/usb/usb_bus.h>
61 #include <dev/usb/controller/xhci.h>
62 #include <dev/usb/controller/xhcireg.h>
64 #include "generic_xhci.h"
69 generic_xhci_attach(device_t dev)
71 struct xhci_softc *sc = device_get_softc(dev);
74 sc->sc_bus.parent = dev;
75 sc->sc_bus.devices = sc->sc_devices;
76 sc->sc_bus.devices_max = XHCI_MAX_DEVICES;
78 sc->sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
80 if (sc->sc_io_res == NULL) {
81 device_printf(dev, "Failed to map memory\n");
82 generic_xhci_detach(dev);
86 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
87 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
88 sc->sc_io_size = rman_get_size(sc->sc_io_res);
90 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
91 RF_SHAREABLE | RF_ACTIVE);
92 if (sc->sc_irq_res == NULL) {
93 device_printf(dev, "Failed to allocate IRQ\n");
94 generic_xhci_detach(dev);
98 sc->sc_bus.bdev = device_add_child(dev, "usbus", -1);
99 if (sc->sc_bus.bdev == NULL) {
100 device_printf(dev, "Failed to add USB device\n");
101 generic_xhci_detach(dev);
105 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
107 sprintf(sc->sc_vendor, XHCI_HC_VENDOR);
108 device_set_desc(sc->sc_bus.bdev, XHCI_HC_DEVSTR);
110 err = bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
111 NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
113 device_printf(dev, "Failed to setup error IRQ, %d\n", err);
114 sc->sc_intr_hdl = NULL;
115 generic_xhci_detach(dev);
119 err = xhci_init(sc, dev, IS_DMA_32B);
121 device_printf(dev, "Failed to init XHCI, with error %d\n", err);
122 generic_xhci_detach(dev);
126 err = xhci_start_controller(sc);
128 device_printf(dev, "Failed to start XHCI controller, with error %d\n", err);
129 generic_xhci_detach(dev);
133 err = device_probe_and_attach(sc->sc_bus.bdev);
135 device_printf(dev, "Failed to initialize USB, with error %d\n", err);
136 generic_xhci_detach(dev);
144 generic_xhci_detach(device_t dev)
146 struct xhci_softc *sc = device_get_softc(dev);
149 /* during module unload there are lots of children leftover */
150 device_delete_children(dev);
152 if (sc->sc_irq_res != NULL && sc->sc_intr_hdl != NULL) {
153 err = bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr_hdl);
155 device_printf(dev, "Could not tear down irq, %d\n",
157 sc->sc_intr_hdl = NULL;
160 if (sc->sc_irq_res != NULL) {
161 bus_release_resource(dev, SYS_RES_IRQ,
162 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res);
163 sc->sc_irq_res = NULL;
166 if (sc->sc_io_res != NULL) {
167 bus_release_resource(dev, SYS_RES_MEMORY,
168 rman_get_rid(sc->sc_io_res), sc->sc_io_res);
169 sc->sc_io_res = NULL;
177 static device_method_t xhci_methods[] = {
178 /* Device interface */
179 DEVMETHOD(device_attach, generic_xhci_attach),
180 DEVMETHOD(device_detach, generic_xhci_detach),
181 DEVMETHOD(device_suspend, bus_generic_suspend),
182 DEVMETHOD(device_resume, bus_generic_resume),
183 DEVMETHOD(device_shutdown, bus_generic_shutdown),
188 driver_t generic_xhci_driver = {
191 sizeof(struct xhci_softc),