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, NULL, NULL); 90 MODULE_DEPEND(xhci, usb, 1, 1, 1); 91 92 static const char * 93 xhci_pci_match(device_t self) 94 { 95 uint32_t device_id = pci_get_devid(self); 96 97 switch (device_id) { 98 case 0x78141022: 99 return ("AMD FCH USB 3.0 controller"); 100 101 case 0x01941033: 102 return ("NEC uPD720200 USB 3.0 controller"); 103 104 case 0x10001b73: 105 return ("Fresco Logic FL1000G USB 3.0 controller"); 106 107 case 0x10421b21: 108 return ("ASMedia ASM1042 USB 3.0 controller"); 109 case 0x11421b21: 110 return ("ASMedia ASM1042A USB 3.0 controller"); 111 112 case 0x0f358086: 113 return ("Intel BayTrail USB 3.0 controller"); 114 case 0x9c318086: 115 case 0x1e318086: 116 return ("Intel Panther Point USB 3.0 controller"); 117 case 0x8c318086: 118 return ("Intel Lynx Point USB 3.0 controller"); 119 case 0x8cb18086: 120 return ("Intel Wildcat Point USB 3.0 controller"); 121 case 0x8d318086: 122 return ("Intel Wellsburg USB 3.0 controller"); 123 case 0x9cb18086: 124 return ("Broadwell Integrated PCH-LP chipset USB 3.0 controller"); 125 126 case 0xa01b177d: 127 return ("Cavium ThunderX USB 3.0 controller"); 128 129 default: 130 break; 131 } 132 133 if ((pci_get_class(self) == PCIC_SERIALBUS) 134 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 135 && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) { 136 return ("XHCI (generic) USB 3.0 controller"); 137 } 138 return (NULL); /* dunno */ 139 } 140 141 static int 142 xhci_pci_probe(device_t self) 143 { 144 const char *desc = xhci_pci_match(self); 145 146 if (desc) { 147 device_set_desc(self, desc); 148 return (BUS_PROBE_DEFAULT); 149 } else { 150 return (ENXIO); 151 } 152 } 153 154 static int xhci_use_msi = 1; 155 TUNABLE_INT("hw.usb.xhci.msi", &xhci_use_msi); 156 static int xhci_use_msix = 1; 157 TUNABLE_INT("hw.usb.xhci.msix", &xhci_use_msix); 158 159 static void 160 xhci_interrupt_poll(void *_sc) 161 { 162 struct xhci_softc *sc = _sc; 163 USB_BUS_UNLOCK(&sc->sc_bus); 164 xhci_interrupt(sc); 165 USB_BUS_LOCK(&sc->sc_bus); 166 usb_callout_reset(&sc->sc_callout, 1, (void *)&xhci_interrupt_poll, sc); 167 } 168 169 static int 170 xhci_pci_port_route(device_t self, uint32_t set, uint32_t clear) 171 { 172 uint32_t temp; 173 uint32_t usb3_mask; 174 uint32_t usb2_mask; 175 176 temp = pci_read_config(self, PCI_XHCI_INTEL_USB3_PSSEN, 4) | 177 pci_read_config(self, PCI_XHCI_INTEL_XUSB2PR, 4); 178 179 temp |= set; 180 temp &= ~clear; 181 182 /* Don't set bits which the hardware doesn't support */ 183 usb3_mask = pci_read_config(self, PCI_XHCI_INTEL_USB3PRM, 4); 184 usb2_mask = pci_read_config(self, PCI_XHCI_INTEL_USB2PRM, 4); 185 186 pci_write_config(self, PCI_XHCI_INTEL_USB3_PSSEN, temp & usb3_mask, 4); 187 pci_write_config(self, PCI_XHCI_INTEL_XUSB2PR, temp & usb2_mask, 4); 188 189 device_printf(self, "Port routing mask set to 0x%08x\n", temp); 190 191 return (0); 192 } 193 194 static int 195 xhci_pci_attach(device_t self) 196 { 197 struct xhci_softc *sc = device_get_softc(self); 198 int count, err, msix_table, rid; 199 uint8_t usemsi = 1; 200 uint8_t usedma32 = 0; 201 202 rid = PCI_XHCI_CBMEM; 203 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 204 RF_ACTIVE); 205 if (!sc->sc_io_res) { 206 device_printf(self, "Could not map memory\n"); 207 return (ENOMEM); 208 } 209 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 210 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 211 sc->sc_io_size = rman_get_size(sc->sc_io_res); 212 213 switch (pci_get_devid(self)) { 214 case 0x01941033: /* NEC uPD720200 USB 3.0 controller */ 215 case 0x00141912: /* NEC uPD720201 USB 3.0 controller */ 216 /* Don't use 64-bit DMA on these controllers. */ 217 usedma32 = 1; 218 break; 219 case 0x10001b73: /* FL1000G */ 220 /* Fresco Logic host doesn't support MSI. */ 221 usemsi = 0; 222 break; 223 case 0x0f358086: /* BayTrail */ 224 case 0x9c318086: /* Panther Point */ 225 case 0x1e318086: /* Panther Point */ 226 case 0x8c318086: /* Lynx Point */ 227 case 0x8cb18086: /* Wildcat Point */ 228 case 0x9cb18086: /* Broadwell Mobile Integrated */ 229 /* 230 * On Intel chipsets, reroute ports from EHCI to XHCI 231 * controller and use a different IMOD value. 232 */ 233 sc->sc_port_route = &xhci_pci_port_route; 234 sc->sc_imod_default = XHCI_IMOD_DEFAULT_LP; 235 break; 236 } 237 238 if (xhci_init(sc, self, usedma32)) { 239 device_printf(self, "Could not initialize softc\n"); 240 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM, 241 sc->sc_io_res); 242 return (ENXIO); 243 } 244 245 pci_enable_busmaster(self); 246 247 usb_callout_init_mtx(&sc->sc_callout, &sc->sc_bus.bus_mtx, 0); 248 249 rid = 0; 250 if (xhci_use_msix && (msix_table = pci_msix_table_bar(self)) >= 0) { 251 sc->sc_msix_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, 252 &msix_table, RF_ACTIVE); 253 if (sc->sc_msix_res == NULL) { 254 /* May not be enabled */ 255 device_printf(self, 256 "Unable to map MSI-X table \n"); 257 } else { 258 count = 1; 259 if (pci_alloc_msix(self, &count) == 0) { 260 if (bootverbose) 261 device_printf(self, "MSI-X enabled\n"); 262 rid = 1; 263 } else { 264 bus_release_resource(self, SYS_RES_MEMORY, 265 msix_table, sc->sc_msix_res); 266 sc->sc_msix_res = NULL; 267 } 268 } 269 } 270 if (rid == 0 && xhci_use_msi && usemsi) { 271 count = 1; 272 if (pci_alloc_msi(self, &count) == 0) { 273 if (bootverbose) 274 device_printf(self, "MSI enabled\n"); 275 rid = 1; 276 } 277 } 278 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 279 RF_ACTIVE | (rid != 0 ? 0 : RF_SHAREABLE)); 280 if (sc->sc_irq_res == NULL) { 281 pci_release_msi(self); 282 device_printf(self, "Could not allocate IRQ\n"); 283 /* goto error; FALLTHROUGH - use polling */ 284 } 285 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 286 if (sc->sc_bus.bdev == NULL) { 287 device_printf(self, "Could not add USB device\n"); 288 goto error; 289 } 290 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 291 292 sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self)); 293 294 if (sc->sc_irq_res != NULL) { 295 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 296 NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl); 297 if (err != 0) { 298 bus_release_resource(self, SYS_RES_IRQ, 299 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res); 300 sc->sc_irq_res = NULL; 301 pci_release_msi(self); 302 device_printf(self, "Could not setup IRQ, err=%d\n", err); 303 sc->sc_intr_hdl = NULL; 304 } 305 } 306 if (sc->sc_irq_res == NULL || sc->sc_intr_hdl == NULL) { 307 if (xhci_use_polling() != 0) { 308 device_printf(self, "Interrupt polling at %dHz\n", hz); 309 USB_BUS_LOCK(&sc->sc_bus); 310 xhci_interrupt_poll(sc); 311 USB_BUS_UNLOCK(&sc->sc_bus); 312 } else 313 goto error; 314 } 315 316 xhci_pci_take_controller(self); 317 318 err = xhci_halt_controller(sc); 319 320 if (err == 0) 321 err = xhci_start_controller(sc); 322 323 if (err == 0) 324 err = device_probe_and_attach(sc->sc_bus.bdev); 325 326 if (err) { 327 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err); 328 goto error; 329 } 330 return (0); 331 332 error: 333 xhci_pci_detach(self); 334 return (ENXIO); 335 } 336 337 static int 338 xhci_pci_detach(device_t self) 339 { 340 struct xhci_softc *sc = device_get_softc(self); 341 device_t bdev; 342 343 if (sc->sc_bus.bdev != NULL) { 344 bdev = sc->sc_bus.bdev; 345 device_detach(bdev); 346 device_delete_child(self, bdev); 347 } 348 /* during module unload there are lots of children leftover */ 349 device_delete_children(self); 350 351 usb_callout_drain(&sc->sc_callout); 352 xhci_halt_controller(sc); 353 354 pci_disable_busmaster(self); 355 356 if (sc->sc_irq_res && sc->sc_intr_hdl) { 357 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 358 sc->sc_intr_hdl = NULL; 359 } 360 if (sc->sc_irq_res) { 361 bus_release_resource(self, SYS_RES_IRQ, 362 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res); 363 sc->sc_irq_res = NULL; 364 pci_release_msi(self); 365 } 366 if (sc->sc_io_res) { 367 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM, 368 sc->sc_io_res); 369 sc->sc_io_res = NULL; 370 } 371 if (sc->sc_msix_res) { 372 bus_release_resource(self, SYS_RES_MEMORY, 373 rman_get_rid(sc->sc_msix_res), sc->sc_msix_res); 374 sc->sc_msix_res = NULL; 375 } 376 377 xhci_uninit(sc); 378 379 return (0); 380 } 381 382 static int 383 xhci_pci_take_controller(device_t self) 384 { 385 struct xhci_softc *sc = device_get_softc(self); 386 uint32_t cparams; 387 uint32_t eecp; 388 uint32_t eec; 389 uint16_t to; 390 uint8_t bios_sem; 391 392 cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0); 393 394 eec = -1; 395 396 /* Synchronise with the BIOS if it owns the controller. */ 397 for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec); 398 eecp += XHCI_XECP_NEXT(eec) << 2) { 399 eec = XREAD4(sc, capa, eecp); 400 401 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY) 402 continue; 403 bios_sem = XREAD1(sc, capa, eecp + 404 XHCI_XECP_BIOS_SEM); 405 if (bios_sem == 0) 406 continue; 407 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 408 "to give up control\n"); 409 XWRITE1(sc, capa, eecp + 410 XHCI_XECP_OS_SEM, 1); 411 to = 500; 412 while (1) { 413 bios_sem = XREAD1(sc, capa, eecp + 414 XHCI_XECP_BIOS_SEM); 415 if (bios_sem == 0) 416 break; 417 418 if (--to == 0) { 419 device_printf(sc->sc_bus.bdev, 420 "timed out waiting for BIOS\n"); 421 break; 422 } 423 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 424 } 425 } 426 return (0); 427 } 428