1 /*- 2 * Copyright (c) 2010 Hans Petter Selasky. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 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. 12 * 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 23 * SUCH DAMAGE. 24 */ 25 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> 32 #include <sys/bus.h> 33 #include <sys/module.h> 34 #include <sys/lock.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> 41 #include <sys/priv.h> 42 43 #include <bus/u4b/usb.h> 44 #include <bus/u4b/usbdi.h> 45 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> 50 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> 56 #include "usb_if.h" 57 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; 62 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), 72 73 DEVMETHOD_END 74 }; 75 76 static driver_t xhci_driver = { 77 .name = "xhci", 78 .methods = xhci_device_methods, 79 .size = sizeof(struct xhci_softc), 80 }; 81 82 static devclass_t xhci_devclass; 83 84 DRIVER_MODULE(xhci, pci, xhci_driver, xhci_devclass, NULL, NULL); 85 MODULE_DEPEND(xhci, usb, 1, 1, 1); 86 87 88 static const char * 89 xhci_pci_match(device_t self) 90 { 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"); 95 } 96 return (NULL); /* dunno */ 97 } 98 99 static int 100 xhci_pci_probe(device_t self) 101 { 102 const char *desc = xhci_pci_match(self); 103 104 if (desc) { 105 device_set_desc(self, desc); 106 return (0); 107 } else { 108 return (ENXIO); 109 } 110 } 111 112 static int 113 xhci_pci_attach(device_t self) 114 { 115 struct xhci_softc *sc = device_get_softc(self); 116 int err; 117 int rid; 118 119 /* XXX check for 64-bit capability */ 120 121 if (xhci_init(sc, self)) { 122 device_printf(self, "Could not initialize softc\n"); 123 goto error; 124 } 125 126 pci_enable_busmaster(self); 127 128 rid = PCI_XHCI_CBMEM; 129 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 130 RF_ACTIVE); 131 if (!sc->sc_io_res) { 132 device_printf(self, "Could not map memory\n"); 133 goto error; 134 } 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); 138 139 rid = 0; 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"); 144 goto error; 145 } 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"); 149 goto error; 150 } 151 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 152 153 ksprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self)); 154 155 err = bus_setup_intr(self, sc->sc_irq_res, INTR_MPSAFE, 156 (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl, NULL); 157 if (err) { 158 device_printf(self, "Could not setup IRQ, err=%d\n", err); 159 sc->sc_intr_hdl = NULL; 160 goto error; 161 } 162 xhci_pci_take_controller(self); 163 164 err = xhci_halt_controller(sc); 165 166 if (err == 0) 167 err = xhci_start_controller(sc); 168 169 if (err == 0) 170 err = device_probe_and_attach(sc->sc_bus.bdev); 171 172 if (err) { 173 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err); 174 goto error; 175 } 176 return (0); 177 178 error: 179 xhci_pci_detach(self); 180 return (ENXIO); 181 } 182 183 static int 184 xhci_pci_detach(device_t self) 185 { 186 struct xhci_softc *sc = device_get_softc(self); 187 device_t bdev; 188 189 if (sc->sc_bus.bdev != NULL) { 190 bdev = sc->sc_bus.bdev; 191 device_detach(bdev); 192 device_delete_child(self, bdev); 193 } 194 /* during module unload there are lots of children leftover */ 195 device_delete_children(self); 196 197 pci_disable_busmaster(self); 198 199 if (sc->sc_irq_res && sc->sc_intr_hdl) { 200 201 xhci_halt_controller(sc); 202 203 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 204 sc->sc_intr_hdl = NULL; 205 } 206 if (sc->sc_irq_res) { 207 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 208 sc->sc_irq_res = NULL; 209 } 210 if (sc->sc_io_res) { 211 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM, 212 sc->sc_io_res); 213 sc->sc_io_res = NULL; 214 } 215 216 xhci_uninit(sc); 217 218 return (0); 219 } 220 221 static int 222 xhci_pci_take_controller(device_t self) 223 { 224 struct xhci_softc *sc = device_get_softc(self); 225 uint32_t cparams; 226 uint32_t eecp; 227 uint32_t eec; 228 uint16_t to; 229 uint8_t bios_sem; 230 231 cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0); 232 233 eec = -1; 234 235 /* Synchronise with the BIOS if it owns the controller. */ 236 for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec); 237 eecp += XHCI_XECP_NEXT(eec) << 2) { 238 eec = XREAD4(sc, capa, eecp); 239 240 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY) 241 continue; 242 bios_sem = XREAD1(sc, capa, eecp + 243 XHCI_XECP_BIOS_SEM); 244 if (bios_sem == 0) 245 continue; 246 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 247 "to give up control\n"); 248 XWRITE1(sc, capa, eecp + 249 XHCI_XECP_OS_SEM, 1); 250 to = 500; 251 while (1) { 252 bios_sem = XREAD1(sc, capa, eecp + 253 XHCI_XECP_BIOS_SEM); 254 if (bios_sem == 0) 255 break; 256 257 if (--to == 0) { 258 device_printf(sc->sc_bus.bdev, 259 "timed out waiting for BIOS\n"); 260 break; 261 } 262 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 263 } 264 } 265 return (0); 266 } 267