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 0x1e318086:
 103                 return ("Intel Panther Point USB 3.0 controller");
 104
 105         default:
 106                 break;
 107         }
 108
 109         if ((pci_get_class(self) == PCIC_SERIALBUS)
 110             && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
 111             && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) {
 112                 return ("XHCI (generic) USB 3.0 controller");
 113         }
 114         return (NULL);                  /* dunno */
 115 }
 116
 117 static int
 118 xhci_pci_probe(device_t self)
 119 {
 120         const char *desc = xhci_pci_match(self);
 121
 122         if (desc) {
 123                 device_set_desc(self, desc);
 124                 return (0);
 125         } else {
 126                 return (ENXIO);
 127         }
 128 }
 129
 130 static int
 131 xhci_pci_attach(device_t self)
 132 {
 133         struct xhci_softc *sc = device_get_softc(self);
 134         int err;
 135         int rid;
 136
 137         /* XXX check for 64-bit capability */
 138
 139         if (xhci_init(sc, self)) {
 140                 device_printf(self, "Could not initialize softc\n");
 141                 goto error;
 142         }
 143
 144         pci_enable_busmaster(self);
 145
 146         rid = PCI_XHCI_CBMEM;
 147         sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
 148             RF_ACTIVE);
 149         if (!sc->sc_io_res) {
 150                 device_printf(self, "Could not map memory\n");
 151                 goto error;
 152         }
 153         sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
 154         sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
 155         sc->sc_io_size = rman_get_size(sc->sc_io_res);
 156
 157         rid = 0;
 158         sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 159             RF_SHAREABLE | RF_ACTIVE);
 160         if (sc->sc_irq_res == NULL) {
 161                 device_printf(self, "Could not allocate IRQ\n");
 162                 goto error;
 163         }
 164         sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
 165         if (sc->sc_bus.bdev == NULL) {
 166                 device_printf(self, "Could not add USB device\n");
 167                 goto error;
 168         }
 169         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 170
 171         sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self));
 172
 173 #if (__FreeBSD_version >= 700031)
 174         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 175             NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
 176 #else
 177         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 178             (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
 179 #endif
 180         if (err) {
 181                 device_printf(self, "Could not setup IRQ, err=%d\n", err);
 182                 sc->sc_intr_hdl = NULL;
 183                 goto error;
 184         }
 185         xhci_pci_take_controller(self);
 186
 187         err = xhci_halt_controller(sc);
 188
 189         if (err == 0)
 190                 err = xhci_start_controller(sc);
 191
 192         if (err == 0)
 193                 err = device_probe_and_attach(sc->sc_bus.bdev);
 194
 195         if (err) {
 196                 device_printf(self, "XHCI halt/start/probe failed err=%d\n", err);
 197                 goto error;
 198         }
 199         return (0);
 200
 201 error:
 202         xhci_pci_detach(self);
 203         return (ENXIO);
 204 }
 205
 206 static int
 207 xhci_pci_detach(device_t self)
 208 {
 209         struct xhci_softc *sc = device_get_softc(self);
 210         device_t bdev;
 211
 212         if (sc->sc_bus.bdev != NULL) {
 213                 bdev = sc->sc_bus.bdev;
 214                 device_detach(bdev);
 215                 device_delete_child(self, bdev);
 216         }
 217         /* during module unload there are lots of children leftover */
 218         device_delete_children(self);
 219
 220         pci_disable_busmaster(self);
 221
 222         if (sc->sc_irq_res && sc->sc_intr_hdl) {
 223
 224                 xhci_halt_controller(sc);
 225
 226                 bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
 227                 sc->sc_intr_hdl = NULL;
 228         }
 229         if (sc->sc_irq_res) {
 230                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
 231                 sc->sc_irq_res = NULL;
 232         }
 233         if (sc->sc_io_res) {
 234                 bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM,
 235                     sc->sc_io_res);
 236                 sc->sc_io_res = NULL;
 237         }
 238
 239         xhci_uninit(sc);
 240
 241         return (0);
 242 }
 243
 244 static int
 245 xhci_pci_take_controller(device_t self)
 246 {
 247         struct xhci_softc *sc = device_get_softc(self);
 248         uint32_t cparams;
 249         uint32_t eecp;
 250         uint32_t eec;
 251         uint16_t to;
 252         uint8_t bios_sem;
 253
 254         cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0);
 255
 256         eec = -1;
 257
 258         /* Synchronise with the BIOS if it owns the controller. */
 259         for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec);
 260             eecp += XHCI_XECP_NEXT(eec) << 2) {
 261                 eec = XREAD4(sc, capa, eecp);
 262
 263                 if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY)
 264                         continue;
 265                 bios_sem = XREAD1(sc, capa, eecp +
 266                     XHCI_XECP_BIOS_SEM);
 267                 if (bios_sem == 0)
 268                         continue;
 269                 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
 270                     "to give up control\n");
 271                 XWRITE1(sc, capa, eecp +
 272                     XHCI_XECP_OS_SEM, 1);
 273                 to = 500;
 274                 while (1) {
 275                         bios_sem = XREAD1(sc, capa, eecp +
 276                             XHCI_XECP_BIOS_SEM);
 277                         if (bios_sem == 0)
 278                                 break;
 279
 280                         if (--to == 0) {
 281                                 device_printf(sc->sc_bus.bdev,
 282                                     "timed out waiting for BIOS\n");
 283                                 break;
 284                         }
 285                         usb_pause_mtx(NULL, hz / 100);  /* wait 10ms */
 286                 }
 287         }
 288         return (0);
 289 }