2 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 #include <sys/stdint.h>
27 #include <sys/param.h>
28 #include <sys/queue.h>
29 #include <sys/types.h>
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
33 #include <sys/module.h>
35 #include <sys/mutex.h>
36 #include <sys/condvar.h>
37 #include <sys/sysctl.h>
38 #include <sys/unistd.h>
39 #include <sys/callout.h>
40 #include <sys/malloc.h>
43 #include <bus/u4b/usb.h>
44 #include <bus/u4b/usbdi.h>
46 #include <bus/u4b/usb_core.h>
47 #include <bus/u4b/usb_busdma.h>
48 #include <bus/u4b/usb_process.h>
49 #include <bus/u4b/usb_util.h>
51 #include <bus/u4b/usb_controller.h>
52 #include <bus/u4b/usb_bus.h>
53 #include <bus/u4b/usb_pci.h>
54 #include <bus/u4b/controller/xhci.h>
55 #include <bus/u4b/controller/xhcireg.h>
58 static device_probe_t xhci_pci_probe;
59 static device_attach_t xhci_pci_attach;
60 static device_detach_t xhci_pci_detach;
61 static usb_take_controller_t xhci_pci_take_controller;
63 static device_method_t xhci_device_methods[] = {
64 /* device interface */
65 DEVMETHOD(device_probe, xhci_pci_probe),
66 DEVMETHOD(device_attach, xhci_pci_attach),
67 DEVMETHOD(device_detach, xhci_pci_detach),
68 DEVMETHOD(device_suspend, bus_generic_suspend),
69 DEVMETHOD(device_resume, bus_generic_resume),
70 DEVMETHOD(device_shutdown, bus_generic_shutdown),
71 DEVMETHOD(usb_take_controller, xhci_pci_take_controller),
76 static driver_t xhci_driver = {
78 .methods = xhci_device_methods,
79 .size = sizeof(struct xhci_softc),
82 static devclass_t xhci_devclass;
84 DRIVER_MODULE(xhci, pci, xhci_driver, xhci_devclass, NULL, NULL);
85 MODULE_DEPEND(xhci, usb, 1, 1, 1);
89 xhci_pci_match(device_t self)
91 if ((pci_get_class(self) == PCIC_SERIALBUS)
92 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
93 && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) {
94 return ("XHCI (generic) USB 3.0 controller");
96 return (NULL); /* dunno */
100 xhci_pci_probe(device_t self)
102 const char *desc = xhci_pci_match(self);
105 device_set_desc(self, desc);
113 xhci_pci_attach(device_t self)
115 struct xhci_softc *sc = device_get_softc(self);
119 /* XXX check for 64-bit capability */
121 if (xhci_init(sc, self)) {
122 device_printf(self, "Could not initialize softc\n");
126 pci_enable_busmaster(self);
128 rid = PCI_XHCI_CBMEM;
129 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
131 if (!sc->sc_io_res) {
132 device_printf(self, "Could not map memory\n");
135 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
136 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
137 sc->sc_io_size = rman_get_size(sc->sc_io_res);
140 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
141 RF_SHAREABLE | RF_ACTIVE);
142 if (sc->sc_irq_res == NULL) {
143 device_printf(self, "Could not allocate IRQ\n");
146 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
147 if (sc->sc_bus.bdev == NULL) {
148 device_printf(self, "Could not add USB device\n");
151 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
153 ksprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self));
155 err = bus_setup_intr(self, sc->sc_irq_res, INTR_MPSAFE,
156 (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl, NULL);
158 device_printf(self, "Could not setup IRQ, err=%d\n", err);
159 sc->sc_intr_hdl = NULL;
162 xhci_pci_take_controller(self);
164 err = xhci_halt_controller(sc);
167 err = xhci_start_controller(sc);
170 err = device_probe_and_attach(sc->sc_bus.bdev);
173 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err);
179 xhci_pci_detach(self);
184 xhci_pci_detach(device_t self)
186 struct xhci_softc *sc = device_get_softc(self);
189 if (sc->sc_bus.bdev != NULL) {
190 bdev = sc->sc_bus.bdev;
192 device_delete_child(self, bdev);
195 /* during module unload there are lots of children leftover */
196 device_delete_children(self);
199 pci_disable_busmaster(self);
201 if (sc->sc_irq_res && sc->sc_intr_hdl) {
203 xhci_halt_controller(sc);
205 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
206 sc->sc_intr_hdl = NULL;
208 if (sc->sc_irq_res) {
209 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
210 sc->sc_irq_res = NULL;
213 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM,
215 sc->sc_io_res = NULL;
224 xhci_pci_take_controller(device_t self)
226 struct xhci_softc *sc = device_get_softc(self);
233 cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0);
237 /* Synchronise with the BIOS if it owns the controller. */
238 for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec);
239 eecp += XHCI_XECP_NEXT(eec) << 2) {
240 eec = XREAD4(sc, capa, eecp);
242 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY)
244 bios_sem = XREAD1(sc, capa, eecp +
248 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
249 "to give up control\n");
250 XWRITE1(sc, capa, eecp +
251 XHCI_XECP_OS_SEM, 1);
254 bios_sem = XREAD1(sc, capa, eecp +
260 device_printf(sc->sc_bus.bdev,
261 "timed out waiting for BIOS\n");
264 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */