xhci_pci.c revision 227843
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: head/sys/dev/usb/controller/xhci_pci.c 227843 2011-11-22 21:28:20Z marius $"); 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 62static device_probe_t xhci_pci_probe; 63static device_attach_t xhci_pci_attach; 64static device_detach_t xhci_pci_detach; 65static device_suspend_t xhci_pci_suspend; 66static device_resume_t xhci_pci_resume; 67static device_shutdown_t xhci_pci_shutdown; 68static void xhci_pci_takecontroller(device_t); 69 70static device_method_t xhci_device_methods[] = { 71 /* device interface */ 72 DEVMETHOD(device_probe, xhci_pci_probe), 73 DEVMETHOD(device_attach, xhci_pci_attach), 74 DEVMETHOD(device_detach, xhci_pci_detach), 75 DEVMETHOD(device_suspend, xhci_pci_suspend), 76 DEVMETHOD(device_resume, xhci_pci_resume), 77 DEVMETHOD(device_shutdown, xhci_pci_shutdown), 78 79 DEVMETHOD_END 80}; 81 82static driver_t xhci_driver = { 83 .name = "xhci", 84 .methods = xhci_device_methods, 85 .size = sizeof(struct xhci_softc), 86}; 87 88static devclass_t xhci_devclass; 89 90DRIVER_MODULE(xhci, pci, xhci_driver, xhci_devclass, 0, 0); 91MODULE_DEPEND(xhci, usb, 1, 1, 1); 92 93static int 94xhci_pci_suspend(device_t self) 95{ 96 struct xhci_softc *sc = device_get_softc(self); 97 int err; 98 99 err = bus_generic_suspend(self); 100 if (err) 101 return (err); 102 xhci_suspend(sc); 103 return (0); 104} 105 106static int 107xhci_pci_resume(device_t self) 108{ 109 struct xhci_softc *sc = device_get_softc(self); 110 111 xhci_pci_takecontroller(self); 112 xhci_resume(sc); 113 114 bus_generic_resume(self); 115 116 return (0); 117} 118 119static int 120xhci_pci_shutdown(device_t self) 121{ 122 struct xhci_softc *sc = device_get_softc(self); 123 int err; 124 125 err = bus_generic_shutdown(self); 126 if (err) 127 return (err); 128 xhci_shutdown(sc); 129 130 return (0); 131} 132 133static const char * 134xhci_pci_match(device_t self) 135{ 136 if ((pci_get_class(self) == PCIC_SERIALBUS) 137 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 138 && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) { 139 return ("XHCI (generic) USB 3.0 controller"); 140 } 141 return (NULL); /* dunno */ 142} 143 144static int 145xhci_pci_probe(device_t self) 146{ 147 const char *desc = xhci_pci_match(self); 148 149 if (desc) { 150 device_set_desc(self, desc); 151 return (0); 152 } else { 153 return (ENXIO); 154 } 155} 156 157static int 158xhci_pci_attach(device_t self) 159{ 160 struct xhci_softc *sc = device_get_softc(self); 161 int err; 162 int rid; 163 164 /* XXX check for 64-bit capability */ 165 166 if (xhci_init(sc, self)) { 167 device_printf(self, "Could not initialize softc\n"); 168 goto error; 169 } 170 171 pci_enable_busmaster(self); 172 173 rid = PCI_XHCI_CBMEM; 174 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 175 RF_ACTIVE); 176 if (!sc->sc_io_res) { 177 device_printf(self, "Could not map memory\n"); 178 goto error; 179 } 180 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 181 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 182 sc->sc_io_size = rman_get_size(sc->sc_io_res); 183 184 rid = 0; 185 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 186 RF_SHAREABLE | RF_ACTIVE); 187 if (sc->sc_irq_res == NULL) { 188 device_printf(self, "Could not allocate IRQ\n"); 189 goto error; 190 } 191 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 192 if (sc->sc_bus.bdev == NULL) { 193 device_printf(self, "Could not add USB device\n"); 194 goto error; 195 } 196 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 197 198 sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self)); 199 200#if (__FreeBSD_version >= 700031) 201 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 202 NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl); 203#else 204 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 205 (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl); 206#endif 207 if (err) { 208 device_printf(self, "Could not setup IRQ, err=%d\n", err); 209 sc->sc_intr_hdl = NULL; 210 goto error; 211 } 212 xhci_pci_takecontroller(self); 213 214 err = xhci_halt_controller(sc); 215 216 if (err == 0) 217 err = xhci_start_controller(sc); 218 219 if (err == 0) 220 err = device_probe_and_attach(sc->sc_bus.bdev); 221 222 if (err) { 223 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err); 224 goto error; 225 } 226 return (0); 227 228error: 229 xhci_pci_detach(self); 230 return (ENXIO); 231} 232 233static int 234xhci_pci_detach(device_t self) 235{ 236 struct xhci_softc *sc = device_get_softc(self); 237 device_t bdev; 238 239 if (sc->sc_bus.bdev != NULL) { 240 bdev = sc->sc_bus.bdev; 241 device_detach(bdev); 242 device_delete_child(self, bdev); 243 } 244 /* during module unload there are lots of children leftover */ 245 device_delete_all_children(self); 246 247 pci_disable_busmaster(self); 248 249 if (sc->sc_irq_res && sc->sc_intr_hdl) { 250 251 xhci_halt_controller(sc); 252 253 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 254 sc->sc_intr_hdl = NULL; 255 } 256 if (sc->sc_irq_res) { 257 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 258 sc->sc_irq_res = NULL; 259 } 260 if (sc->sc_io_res) { 261 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM, 262 sc->sc_io_res); 263 sc->sc_io_res = NULL; 264 } 265 266 xhci_uninit(sc); 267 268 return (0); 269} 270 271static void 272xhci_pci_takecontroller(device_t self) 273{ 274 struct xhci_softc *sc = device_get_softc(self); 275 uint32_t cparams; 276 uint32_t eecp; 277 uint32_t eec; 278 uint16_t to; 279 uint8_t bios_sem; 280 281 cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0); 282 283 eec = -1; 284 285 /* Synchronise with the BIOS if it owns the controller. */ 286 for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec); 287 eecp += XHCI_XECP_NEXT(eec) << 2) { 288 eec = XREAD4(sc, capa, eecp); 289 290 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY) 291 continue; 292 bios_sem = XREAD1(sc, capa, eecp + 293 XHCI_XECP_BIOS_SEM); 294 if (bios_sem == 0) 295 continue; 296 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 297 "to give up control\n"); 298 XWRITE1(sc, capa, eecp + 299 XHCI_XECP_OS_SEM, 1); 300 to = 500; 301 while (1) { 302 bios_sem = XREAD1(sc, capa, eecp + 303 XHCI_XECP_BIOS_SEM); 304 if (bios_sem == 0) 305 break; 306 307 if (--to == 0) { 308 device_printf(sc->sc_bus.bdev, 309 "timed out waiting for BIOS\n"); 310 break; 311 } 312 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 313 } 314 } 315} 316