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