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