xhci_pci.c revision 308402
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: stable/10/sys/dev/usb/controller/xhci_pci.c 308402 2016-11-07 09:19:04Z hselasky $"); 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 63static device_probe_t xhci_pci_probe; 64static device_attach_t xhci_pci_attach; 65static device_detach_t xhci_pci_detach; 66static usb_take_controller_t xhci_pci_take_controller; 67 68static 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 81static driver_t xhci_driver = { 82 .name = "xhci", 83 .methods = xhci_device_methods, 84 .size = sizeof(struct xhci_softc), 85}; 86 87static devclass_t xhci_devclass; 88 89DRIVER_MODULE(xhci, pci, xhci_driver, xhci_devclass, NULL, NULL); 90MODULE_DEPEND(xhci, usb, 1, 1, 1); 91 92static const char * 93xhci_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 case 0xa12f8086: 126 return ("Intel Sunrise Point USB 3.0 controller"); 127 128 case 0xa01b177d: 129 return ("Cavium ThunderX USB 3.0 controller"); 130 131 default: 132 break; 133 } 134 135 if ((pci_get_class(self) == PCIC_SERIALBUS) 136 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 137 && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) { 138 return ("XHCI (generic) USB 3.0 controller"); 139 } 140 return (NULL); /* dunno */ 141} 142 143static int 144xhci_pci_probe(device_t self) 145{ 146 const char *desc = xhci_pci_match(self); 147 148 if (desc) { 149 device_set_desc(self, desc); 150 return (BUS_PROBE_DEFAULT); 151 } else { 152 return (ENXIO); 153 } 154} 155 156static int xhci_use_msi = 1; 157TUNABLE_INT("hw.usb.xhci.msi", &xhci_use_msi); 158 159static void 160xhci_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 169static int 170xhci_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 194static int 195xhci_pci_attach(device_t self) 196{ 197 struct xhci_softc *sc = device_get_softc(self); 198 int count, err, 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_msi && usemsi) { 251 count = 1; 252 if (pci_alloc_msi(self, &count) == 0) { 253 if (bootverbose) 254 device_printf(self, "MSI enabled\n"); 255 rid = 1; 256 } 257 } 258 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 259 RF_ACTIVE | (rid != 0 ? 0 : RF_SHAREABLE)); 260 if (sc->sc_irq_res == NULL) { 261 pci_release_msi(self); 262 device_printf(self, "Could not allocate IRQ\n"); 263 /* goto error; FALLTHROUGH - use polling */ 264 } 265 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 266 if (sc->sc_bus.bdev == NULL) { 267 device_printf(self, "Could not add USB device\n"); 268 goto error; 269 } 270 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 271 272 sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self)); 273 274 if (sc->sc_irq_res != NULL) { 275 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 276 NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl); 277 if (err != 0) { 278 bus_release_resource(self, SYS_RES_IRQ, 279 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res); 280 sc->sc_irq_res = NULL; 281 pci_release_msi(self); 282 device_printf(self, "Could not setup IRQ, err=%d\n", err); 283 sc->sc_intr_hdl = NULL; 284 } 285 } 286 if (sc->sc_irq_res == NULL || sc->sc_intr_hdl == NULL) { 287 if (xhci_use_polling() != 0) { 288 device_printf(self, "Interrupt polling at %dHz\n", hz); 289 USB_BUS_LOCK(&sc->sc_bus); 290 xhci_interrupt_poll(sc); 291 USB_BUS_UNLOCK(&sc->sc_bus); 292 } else 293 goto error; 294 } 295 296 xhci_pci_take_controller(self); 297 298 err = xhci_halt_controller(sc); 299 300 if (err == 0) 301 err = xhci_start_controller(sc); 302 303 if (err == 0) 304 err = device_probe_and_attach(sc->sc_bus.bdev); 305 306 if (err) { 307 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err); 308 goto error; 309 } 310 return (0); 311 312error: 313 xhci_pci_detach(self); 314 return (ENXIO); 315} 316 317static int 318xhci_pci_detach(device_t self) 319{ 320 struct xhci_softc *sc = device_get_softc(self); 321 322 /* during module unload there are lots of children leftover */ 323 device_delete_children(self); 324 325 usb_callout_drain(&sc->sc_callout); 326 xhci_halt_controller(sc); 327 328 pci_disable_busmaster(self); 329 330 if (sc->sc_irq_res && sc->sc_intr_hdl) { 331 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 332 sc->sc_intr_hdl = NULL; 333 } 334 if (sc->sc_irq_res) { 335 bus_release_resource(self, SYS_RES_IRQ, 336 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res); 337 sc->sc_irq_res = NULL; 338 pci_release_msi(self); 339 } 340 if (sc->sc_io_res) { 341 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM, 342 sc->sc_io_res); 343 sc->sc_io_res = NULL; 344 } 345 346 xhci_uninit(sc); 347 348 return (0); 349} 350 351static int 352xhci_pci_take_controller(device_t self) 353{ 354 struct xhci_softc *sc = device_get_softc(self); 355 uint32_t cparams; 356 uint32_t eecp; 357 uint32_t eec; 358 uint16_t to; 359 uint8_t bios_sem; 360 361 cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0); 362 363 eec = -1; 364 365 /* Synchronise with the BIOS if it owns the controller. */ 366 for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec); 367 eecp += XHCI_XECP_NEXT(eec) << 2) { 368 eec = XREAD4(sc, capa, eecp); 369 370 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY) 371 continue; 372 bios_sem = XREAD1(sc, capa, eecp + 373 XHCI_XECP_BIOS_SEM); 374 if (bios_sem == 0) 375 continue; 376 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 377 "to give up control\n"); 378 XWRITE1(sc, capa, eecp + 379 XHCI_XECP_OS_SEM, 1); 380 to = 500; 381 while (1) { 382 bios_sem = XREAD1(sc, capa, eecp + 383 XHCI_XECP_BIOS_SEM); 384 if (bios_sem == 0) 385 break; 386 387 if (--to == 0) { 388 device_printf(sc->sc_bus.bdev, 389 "timed out waiting for BIOS\n"); 390 break; 391 } 392 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 393 } 394 } 395 return (0); 396} 397