sys/dev/usb/controller/xhci_pci.c

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