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 0x10421b21:
 103                 return ("ASMedia ASM1042 USB 3.0 controller");
 104
 105         case 0x9c318086:
 106         case 0x1e318086:
 107                 return ("Intel Panther Point USB 3.0 controller");
 108         case 0x8c318086:
 109                 return ("Intel Lynx Point USB 3.0 controller");
 110
 111         default:
 112                 break;
 113         }
 114
 115         if ((pci_get_class(self) == PCIC_SERIALBUS)
 116             && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
 117             && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) {
 118                 return ("XHCI (generic) USB 3.0 controller");
 119         }
 120         return (NULL);                  /* dunno */
 121 }
 122
 123 static int
 124 xhci_pci_probe(device_t self)
 125 {
 126         const char *desc = xhci_pci_match(self);
 127
 128         if (desc) {
 129                 device_set_desc(self, desc);
 130                 return (0);
 131         } else {
 132                 return (ENXIO);
 133         }
 134 }
 135
 136 static int xhci_use_msi = 1;
 137 TUNABLE_INT("hw.usb.xhci.msi", &xhci_use_msi);
 138
 139 static int
 140 xhci_pci_port_route(device_t self, uint32_t set, uint32_t clear)
 141 {
 142         uint32_t temp;
 143
 144         temp = pci_read_config(self, PCI_XHCI_INTEL_USB3_PSSEN, 4) |
 145             pci_read_config(self, PCI_XHCI_INTEL_XUSB2PR, 4);
 146
 147         temp |= set;
 148         temp &= ~clear;
 149
 150         pci_write_config(self, PCI_XHCI_INTEL_USB3_PSSEN, temp, 4);
 151         pci_write_config(self, PCI_XHCI_INTEL_XUSB2PR, temp, 4);
 152
 153         device_printf(self, "Port routing mask set to 0x%08x\n", temp);
 154
 155         return (0);
 156 }
 157
 158 static int
 159 xhci_pci_attach(device_t self)
 160 {
 161         struct xhci_softc *sc = device_get_softc(self);
 162         int count, err, 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         sc->sc_irq_rid = 0;
 185         if (xhci_use_msi) {
 186                 count = pci_msi_count(self);
 187                 if (count >= 1) {
 188                         count = 1;
 189                         if (pci_alloc_msi(self, &count) == 0) {
 190                                 if (bootverbose)
 191                                         device_printf(self, "MSI enabled\n");
 192                                 sc->sc_irq_rid = 1;
 193                         }
 194                 }
 195         }
 196         sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ,
 197             &sc->sc_irq_rid, RF_SHAREABLE | RF_ACTIVE);
 198         if (sc->sc_irq_res == NULL) {
 199                 device_printf(self, "Could not allocate IRQ\n");
 200                 goto error;
 201         }
 202         sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
 203         if (sc->sc_bus.bdev == NULL) {
 204                 device_printf(self, "Could not add USB device\n");
 205                 goto error;
 206         }
 207         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 208
 209         sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self));
 210
 211 #if (__FreeBSD_version >= 700031)
 212         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 213             NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
 214 #else
 215         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 216             (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
 217 #endif
 218         if (err) {
 219                 device_printf(self, "Could not setup IRQ, err=%d\n", err);
 220                 sc->sc_intr_hdl = NULL;
 221                 goto error;
 222         }
 223         /* On Intel chipsets reroute ports from EHCI to XHCI controller. */
 224         switch (pci_get_devid(self)) {
 225         case 0x9c318086:        /* Panther Point */
 226         case 0x1e318086:        /* Panther Point */
 227         case 0x8c318086:        /* Lynx Point */
 228                 sc->sc_port_route = &xhci_pci_port_route;
 229                 break;
 230         default:
 231                 break;
 232         }
 233
 234         xhci_pci_take_controller(self);
 235
 236         err = xhci_halt_controller(sc);
 237
 238         if (err == 0)
 239                 err = xhci_start_controller(sc);
 240
 241         if (err == 0)
 242                 err = device_probe_and_attach(sc->sc_bus.bdev);
 243
 244         if (err) {
 245                 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err);
 246                 goto error;
 247         }
 248         return (0);
 249
 250 error:
 251         xhci_pci_detach(self);
 252         return (ENXIO);
 253 }
 254
 255 static int
 256 xhci_pci_detach(device_t self)
 257 {
 258         struct xhci_softc *sc = device_get_softc(self);
 259         device_t bdev;
 260
 261         if (sc->sc_bus.bdev != NULL) {
 262                 bdev = sc->sc_bus.bdev;
 263                 device_detach(bdev);
 264                 device_delete_child(self, bdev);
 265         }
 266         /* during module unload there are lots of children leftover */
 267         device_delete_all_children(self);
 268
 269         pci_disable_busmaster(self);
 270
 271         if (sc->sc_irq_res && sc->sc_intr_hdl) {
 272
 273                 xhci_halt_controller(sc);
 274
 275                 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
 276                 sc->sc_intr_hdl = NULL;
 277         }
 278         if (sc->sc_irq_res) {
 279                 if (sc->sc_irq_rid == 1)
 280                         pci_release_msi(self);
 281                 bus_release_resource(self, SYS_RES_IRQ, sc->sc_irq_rid,
 282                     sc->sc_irq_res);
 283                 sc->sc_irq_res = NULL;
 284         }
 285         if (sc->sc_io_res) {
 286                 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM,
 287                     sc->sc_io_res);
 288                 sc->sc_io_res = NULL;
 289         }
 290
 291         xhci_uninit(sc);
 292
 293         return (0);
 294 }
 295
 296 static int
 297 xhci_pci_take_controller(device_t self)
 298 {
 299         struct xhci_softc *sc = device_get_softc(self);
 300         uint32_t cparams;
 301         uint32_t eecp;
 302         uint32_t eec;
 303         uint16_t to;
 304         uint8_t bios_sem;
 305
 306         cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0);
 307
 308         eec = -1;
 309
 310         /* Synchronise with the BIOS if it owns the controller. */
 311         for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec);
 312             eecp += XHCI_XECP_NEXT(eec) << 2) {
 313                 eec = XREAD4(sc, capa, eecp);
 314
 315                 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY)
 316                         continue;
 317                 bios_sem = XREAD1(sc, capa, eecp +
 318                     XHCI_XECP_BIOS_SEM);
 319                 if (bios_sem == 0)
 320                         continue;
 321                 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
 322                     "to give up control\n");
 323                 XWRITE1(sc, capa, eecp +
 324                     XHCI_XECP_OS_SEM, 1);
 325                 to = 500;
 326                 while (1) {
 327                         bios_sem = XREAD1(sc, capa, eecp +
 328                             XHCI_XECP_BIOS_SEM);
 329                         if (bios_sem == 0)
 330                                 break;
 331
 332                         if (--to == 0) {
 333                                 device_printf(sc->sc_bus.bdev,
 334                                     "timed out waiting for BIOS\n");
 335                                 break;
 336                         }
 337                         usb_pause_mtx(NULL, hz / 100);  /* wait 10ms */
 338                 }
 339         }
 340         return (0);
 341 }