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/cdefs.h> 27 __FBSDID("$FreeBSD$"); 28 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> 36 #include <sys/bus.h> 37 #include <sys/module.h> 38 #include <sys/lock.h> 39 #include <sys/mutex.h> 40 #include <sys/condvar.h> 41 #include <sys/sysctl.h> 42 #include <sys/sx.h> 43 #include <sys/unistd.h> 44 #include <sys/callout.h> 45 #include <sys/malloc.h> 46 #include <sys/priv.h> 47 48 #include <dev/usb/usb.h> 49 #include <dev/usb/usbdi.h> 50 51 #include <dev/usb/usb_core.h> 52 #include <dev/usb/usb_busdma.h> 53 #include <dev/usb/usb_process.h> 54 #include <dev/usb/usb_util.h> 55 56 #include <dev/usb/usb_controller.h> 57 #include <dev/usb/usb_bus.h> 58 #include <dev/usb/usb_pci.h> 59 #include <dev/usb/controller/xhci.h> 60 #include <dev/usb/controller/xhcireg.h> 61 #include "usb_if.h" 62 63 static device_probe_t xhci_pci_probe; 64 static device_attach_t xhci_pci_attach; 65 static device_detach_t xhci_pci_detach; 66 static usb_take_controller_t xhci_pci_take_controller; 67 68 static device_method_t xhci_device_methods[] = { 69 /* device interface */ 70 DEVMETHOD(device_probe, xhci_pci_probe), 71 DEVMETHOD(device_attach, xhci_pci_attach), 72 DEVMETHOD(device_detach, xhci_pci_detach), 73 DEVMETHOD(device_suspend, bus_generic_suspend), 74 DEVMETHOD(device_resume, bus_generic_resume), 75 DEVMETHOD(device_shutdown, bus_generic_shutdown), 76 DEVMETHOD(usb_take_controller, xhci_pci_take_controller), 77 78 DEVMETHOD_END 79 }; 80 81 static driver_t xhci_driver = { 82 .name = "xhci", 83 .methods = xhci_device_methods, 84 .size = sizeof(struct xhci_softc), 85 }; 86 87 static devclass_t xhci_devclass; 88 89 DRIVER_MODULE(xhci, pci, xhci_driver, xhci_devclass, 0, 0); 90 MODULE_DEPEND(xhci, usb, 1, 1, 1); 91 92 93 static const char * 94 xhci_pci_match(device_t self) 95 { 96 uint32_t device_id = pci_get_devid(self); 97 98 switch (device_id) { 99 case 0x01941033: 100 return ("NEC uPD720200 USB 3.0 controller"); 101 102 case 0x10421b21: 103 return ("ASMedia ASM1042 USB 3.0 controller"); 104 105 case 0x1e318086: 106 return ("Intel Panther Point USB 3.0 controller"); 107 case 0x8c318086: 108 return ("Intel Lynx Point USB 3.0 controller"); 109 110 default: 111 break; 112 } 113 114 if ((pci_get_class(self) == PCIC_SERIALBUS) 115 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 116 && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) { 117 return ("XHCI (generic) USB 3.0 controller"); 118 } 119 return (NULL); /* dunno */ 120 } 121 122 static int 123 xhci_pci_probe(device_t self) 124 { 125 const char *desc = xhci_pci_match(self); 126 127 if (desc) { 128 device_set_desc(self, desc); 129 return (0); 130 } else { 131 return (ENXIO); 132 } 133 } 134 135 static int xhci_use_msi = 1; 136 TUNABLE_INT("hw.usb.xhci.msi", &xhci_use_msi); 137 138 static void 139 xhci_interrupt_poll(void *_sc) 140 { 141 struct xhci_softc *sc = _sc; 142 USB_BUS_UNLOCK(&sc->sc_bus); 143 xhci_interrupt(sc); 144 USB_BUS_LOCK(&sc->sc_bus); 145 usb_callout_reset(&sc->sc_callout, 1, (void *)&xhci_interrupt_poll, sc); 146 } 147 148 static int 149 xhci_pci_attach(device_t self) 150 { 151 struct xhci_softc *sc = device_get_softc(self); 152 int count, err, rid; 153 154 /* XXX check for 64-bit capability */ 155 156 if (xhci_init(sc, self)) { 157 device_printf(self, "Could not initialize softc\n"); 158 goto error; 159 } 160 161 pci_enable_busmaster(self); 162 163 rid = PCI_XHCI_CBMEM; 164 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 165 RF_ACTIVE); 166 if (!sc->sc_io_res) { 167 device_printf(self, "Could not map memory\n"); 168 goto error; 169 } 170 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 171 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 172 sc->sc_io_size = rman_get_size(sc->sc_io_res); 173 174 usb_callout_init_mtx(&sc->sc_callout, &sc->sc_bus.bus_mtx, 0); 175 176 sc->sc_irq_rid = 0; 177 if (xhci_use_msi) { 178 count = pci_msi_count(self); 179 if (count >= 1) { 180 count = 1; 181 if (pci_alloc_msi(self, &count) == 0) { 182 if (bootverbose) 183 device_printf(self, "MSI enabled\n"); 184 sc->sc_irq_rid = 1; 185 } 186 } 187 } 188 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, 189 &sc->sc_irq_rid, RF_SHAREABLE | RF_ACTIVE); 190 if (sc->sc_irq_res == NULL) { 191 device_printf(self, "Could not allocate IRQ\n"); 192 goto error; 193 } 194 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 195 if (sc->sc_bus.bdev == NULL) { 196 device_printf(self, "Could not add USB device\n"); 197 goto error; 198 } 199 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 200 201 sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self)); 202 203 if (sc->sc_irq_res != NULL) { 204 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 205 NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl); 206 if (err != 0) { 207 device_printf(self, "Could not setup IRQ, err=%d\n", err); 208 sc->sc_intr_hdl = NULL; 209 } 210 } 211 if (sc->sc_irq_res == NULL || sc->sc_intr_hdl == NULL || 212 xhci_use_polling() != 0) { 213 device_printf(self, "Interrupt polling at %dHz\n", hz); 214 USB_BUS_LOCK(&sc->sc_bus); 215 xhci_interrupt_poll(sc); 216 USB_BUS_UNLOCK(&sc->sc_bus); 217 } 218 219 xhci_pci_take_controller(self); 220 221 err = xhci_halt_controller(sc); 222 223 if (err == 0) 224 err = xhci_start_controller(sc); 225 226 if (err == 0) 227 err = device_probe_and_attach(sc->sc_bus.bdev); 228 229 if (err) { 230 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err); 231 goto error; 232 } 233 return (0); 234 235 error: 236 xhci_pci_detach(self); 237 return (ENXIO); 238 } 239 240 static int 241 xhci_pci_detach(device_t self) 242 { 243 struct xhci_softc *sc = device_get_softc(self); 244 device_t bdev; 245 246 if (sc->sc_bus.bdev != NULL) { 247 bdev = sc->sc_bus.bdev; 248 device_detach(bdev); 249 device_delete_child(self, bdev); 250 } 251 /* during module unload there are lots of children leftover */ 252 device_delete_children(self); 253 254 if (sc->sc_io_res) { 255 usb_callout_drain(&sc->sc_callout); 256 xhci_halt_controller(sc); 257 } 258 259 pci_disable_busmaster(self); 260 261 if (sc->sc_irq_res && sc->sc_intr_hdl) { 262 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 263 sc->sc_intr_hdl = NULL; 264 } 265 if (sc->sc_irq_res) { 266 if (sc->sc_irq_rid == 1) 267 pci_release_msi(self); 268 bus_release_resource(self, SYS_RES_IRQ, sc->sc_irq_rid, 269 sc->sc_irq_res); 270 sc->sc_irq_res = NULL; 271 } 272 if (sc->sc_io_res) { 273 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM, 274 sc->sc_io_res); 275 sc->sc_io_res = NULL; 276 } 277 278 xhci_uninit(sc); 279 280 return (0); 281 } 282 283 static int 284 xhci_pci_take_controller(device_t self) 285 { 286 struct xhci_softc *sc = device_get_softc(self); 287 uint32_t device_id = pci_get_devid(self); 288 uint32_t cparams; 289 uint32_t eecp; 290 uint32_t eec; 291 uint16_t to; 292 uint8_t bios_sem; 293 294 cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0); 295 296 eec = -1; 297 298 /* Synchronise with the BIOS if it owns the controller. */ 299 for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec); 300 eecp += XHCI_XECP_NEXT(eec) << 2) { 301 eec = XREAD4(sc, capa, eecp); 302 303 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY) 304 continue; 305 bios_sem = XREAD1(sc, capa, eecp + 306 XHCI_XECP_BIOS_SEM); 307 if (bios_sem == 0) 308 continue; 309 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 310 "to give up control\n"); 311 XWRITE1(sc, capa, eecp + 312 XHCI_XECP_OS_SEM, 1); 313 to = 500; 314 while (1) { 315 bios_sem = XREAD1(sc, capa, eecp + 316 XHCI_XECP_BIOS_SEM); 317 if (bios_sem == 0) 318 break; 319 320 if (--to == 0) { 321 device_printf(sc->sc_bus.bdev, 322 "timed out waiting for BIOS\n"); 323 break; 324 } 325 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 326 } 327 } 328 329 /* On Intel chipsets reroute ports from EHCI to XHCI controller. */ 330 if (device_id == 0x1e318086 /* Panther Point */ || 331 device_id == 0x8c318086 /* Lynx Point */) { 332 uint32_t temp = xhci_get_port_route(); 333 pci_write_config(self, PCI_XHCI_INTEL_USB3_PSSEN, temp, 4); 334 pci_write_config(self, PCI_XHCI_INTEL_XUSB2PR, temp, 4); 335 } 336 return (0); 337 } 338