sys/dev/usb/controller/xhci_mv.c

   1 /*-
   2  * Copyright (c) 2015 Semihalf.
   3  * Copyright (c) 2015 Stormshield.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include "opt_bus.h"
  32
  33 #include <sys/stdint.h>
  34 #include <sys/stddef.h>
  35 #include <sys/param.h>
  36 #include <sys/queue.h>
  37 #include <sys/types.h>
  38 #include <sys/systm.h>
  39 #include <sys/kernel.h>
  40 #include <sys/bus.h>
  41 #include <sys/module.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/condvar.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/sx.h>
  47 #include <sys/unistd.h>
  48 #include <sys/priv.h>
  49 #include <sys/rman.h>
  50
  51 #include <dev/ofw/ofw_bus.h>
  52 #include <dev/ofw/ofw_bus_subr.h>
  53
  54 #include <dev/usb/usb.h>
  55 #include <dev/usb/usbdi.h>
  56
  57 #include <dev/usb/usb_core.h>
  58 #include <dev/usb/usb_busdma.h>
  59 #include <dev/usb/usb_process.h>
  60 #include <dev/usb/usb_util.h>
  61
  62 #include <dev/usb/usb_controller.h>
  63 #include <dev/usb/usb_bus.h>
  64 #include <dev/usb/controller/xhci.h>
  65 #include <dev/usb/controller/xhcireg.h>
  66
  67 #define XHCI_HC_DEVSTR  "Marvell Integrated USB 3.0 controller"
  68 #define XHCI_HC_VENDOR  "Marvell"
  69
  70 #define IS_DMA_32B      1
  71
  72 static device_attach_t xhci_attach;
  73 static device_detach_t xhci_detach;
  74
  75 static struct ofw_compat_data compat_data[] = {
  76         {"marvell,armada-380-xhci",     true},
  77         {"marvell,armada3700-xhci",     true},
  78         {"marvell,armada-8k-xhci",      true},
  79         {NULL,                          false}
  80 };
  81
  82 static int
  83 xhci_probe(device_t dev)
  84 {
  85
  86         if (!ofw_bus_status_okay(dev))
  87                 return (ENXIO);
  88
  89         if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
  90                 return (ENXIO);
  91
  92         device_set_desc(dev, XHCI_HC_DEVSTR);
  93
  94         return (BUS_PROBE_DEFAULT);
  95 }
  96
  97 static int
  98 xhci_attach(device_t dev)
  99 {
 100         struct xhci_softc *sc = device_get_softc(dev);
 101         int err = 0, rid = 0;
 102
 103         sc->sc_bus.parent = dev;
 104         sc->sc_bus.devices = sc->sc_devices;
 105         sc->sc_bus.devices_max = XHCI_MAX_DEVICES;
 106
 107         sc->sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 108             RF_ACTIVE);
 109         if (sc->sc_io_res == NULL) {
 110                 device_printf(dev, "Failed to map memory\n");
 111                 xhci_detach(dev);
 112                 return (ENXIO);
 113         }
 114
 115         sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
 116         sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
 117         sc->sc_io_size = rman_get_size(sc->sc_io_res);
 118
 119         sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 120             RF_SHAREABLE | RF_ACTIVE);
 121         if (sc->sc_irq_res == NULL) {
 122                 device_printf(dev, "Failed to allocate IRQ\n");
 123                 xhci_detach(dev);
 124                 return (ENXIO);
 125         }
 126
 127         sc->sc_bus.bdev = device_add_child(dev, "usbus", -1);
 128         if (sc->sc_bus.bdev == NULL) {
 129                 device_printf(dev, "Failed to add USB device\n");
 130                 xhci_detach(dev);
 131                 return (ENXIO);
 132         }
 133
 134         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 135
 136         sprintf(sc->sc_vendor, XHCI_HC_VENDOR);
 137         device_set_desc(sc->sc_bus.bdev, XHCI_HC_DEVSTR);
 138
 139         err = bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 140             NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
 141         if (err != 0) {
 142                 device_printf(dev, "Failed to setup error IRQ, %d\n", err);
 143                 sc->sc_intr_hdl = NULL;
 144                 xhci_detach(dev);
 145                 return (err);
 146         }
 147
 148         err = xhci_init(sc, dev, IS_DMA_32B);
 149         if (err != 0) {
 150                 device_printf(dev, "Failed to init XHCI, with error %d\n", err);
 151                 xhci_detach(dev);
 152                 return (ENXIO);
 153         }
 154
 155         err = xhci_start_controller(sc);
 156         if (err != 0) {
 157                 device_printf(dev, "Failed to start XHCI controller, with error %d\n", err);
 158                 xhci_detach(dev);
 159                 return (ENXIO);
 160         }
 161
 162         err = device_probe_and_attach(sc->sc_bus.bdev);
 163         if (err != 0) {
 164                 device_printf(dev, "Failed to initialize USB, with error %d\n", err);
 165                 xhci_detach(dev);
 166                 return (ENXIO);
 167         }
 168
 169         return (0);
 170 }
 171
 172 static int
 173 xhci_detach(device_t dev)
 174 {
 175         struct xhci_softc *sc = device_get_softc(dev);
 176         int err;
 177
 178         /* during module unload there are lots of children leftover */
 179         device_delete_children(dev);
 180
 181         if (sc->sc_irq_res != NULL && sc->sc_intr_hdl != NULL) {
 182                 err = bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr_hdl);
 183                 if (err != 0)
 184                         device_printf(dev, "Could not tear down irq, %d\n",
 185                             err);
 186                 sc->sc_intr_hdl = NULL;
 187         }
 188
 189         if (sc->sc_irq_res != NULL) {
 190                 bus_release_resource(dev, SYS_RES_IRQ,
 191                     rman_get_rid(sc->sc_irq_res), sc->sc_irq_res);
 192                 sc->sc_irq_res = NULL;
 193         }
 194
 195         if (sc->sc_io_res != NULL) {
 196                 bus_release_resource(dev, SYS_RES_MEMORY,
 197                     rman_get_rid(sc->sc_io_res), sc->sc_io_res);
 198                 sc->sc_io_res = NULL;
 199         }
 200
 201         xhci_uninit(sc);
 202
 203         return (0);
 204 }
 205
 206 static device_method_t xhci_methods[] = {
 207         /* Device interface */
 208         DEVMETHOD(device_probe, xhci_probe),
 209         DEVMETHOD(device_attach, xhci_attach),
 210         DEVMETHOD(device_detach, xhci_detach),
 211         DEVMETHOD(device_suspend, bus_generic_suspend),
 212         DEVMETHOD(device_resume, bus_generic_resume),
 213         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 214
 215         DEVMETHOD_END
 216 };
 217
 218 static driver_t xhci_driver = {
 219         "xhci",
 220         xhci_methods,
 221         sizeof(struct xhci_softc),
 222 };
 223
 224 static devclass_t xhci_devclass;
 225
 226 DRIVER_MODULE(xhci, simplebus, xhci_driver, xhci_devclass, 0, 0);
 227 MODULE_DEPEND(xhci, usb, 1, 1, 1);