sys/dev/usb/controller/ehci_msm.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2018 Ruslan Bukin <br@bsdpad.com>
   5  * All rights reserved.
   6  *
   7  * This software was developed by BAE Systems, the University of Cambridge
   8  * Computer Laboratory, and Memorial University under DARPA/AFRL contract
   9  * FA8650-15-C-7558 ("CADETS"), as part of the DARPA Transparent Computing
  10  * (TC) research program.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 #include "opt_bus.h"
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/bus.h>
  42 #include <sys/rman.h>
  43 #include <sys/condvar.h>
  44 #include <sys/kernel.h>
  45 #include <sys/module.h>
  46
  47 #include <dev/ofw/ofw_bus.h>
  48 #include <dev/ofw/ofw_bus_subr.h>
  49
  50 #include <dev/usb/usb.h>
  51 #include <dev/usb/usbdi.h>
  52
  53 #include <dev/usb/usb_core.h>
  54 #include <dev/usb/usb_busdma.h>
  55 #include <dev/usb/usb_process.h>
  56 #include <dev/usb/usb_util.h>
  57
  58 #include <dev/usb/usb_controller.h>
  59 #include <dev/usb/usb_bus.h>
  60 #include <dev/usb/controller/ehci.h>
  61 #include <dev/usb/controller/ehcireg.h>
  62
  63 struct ehci_msm_softc {
  64         ehci_softc_t            base;
  65         struct resource         *res[3];
  66 };
  67
  68 static struct resource_spec ehci_msm_spec[] = {
  69         { SYS_RES_MEMORY,       0,      RF_ACTIVE },
  70         { SYS_RES_MEMORY,       1,      RF_ACTIVE },
  71         { SYS_RES_IRQ,          0,      RF_ACTIVE },
  72         { -1, 0 }
  73 };
  74
  75 #define EHCI_HC_DEVSTR          "Qualcomm USB 2.0 controller"
  76
  77 static device_attach_t ehci_msm_attach;
  78 static device_detach_t ehci_msm_detach;
  79
  80 static int
  81 ehci_msm_probe(device_t dev)
  82 {
  83
  84         if (!ofw_bus_is_compatible(dev, "qcom,ci-hdrc"))
  85                 return (ENXIO);
  86
  87         device_set_desc(dev, EHCI_HC_DEVSTR);
  88
  89         return (BUS_PROBE_DEFAULT);
  90 }
  91
  92 static int
  93 ehci_msm_attach(device_t dev)
  94 {
  95         struct ehci_msm_softc *esc;
  96         bus_space_handle_t bsh;
  97         ehci_softc_t *sc;
  98         int err;
  99
 100         esc = device_get_softc(dev);
 101         sc = &esc->base;
 102         sc->sc_bus.parent = dev;
 103         sc->sc_bus.devices = sc->sc_devices;
 104         sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
 105         sc->sc_bus.dma_bits = 32;
 106
 107         if (bus_alloc_resources(dev, ehci_msm_spec, esc->res)) {
 108                 device_printf(dev, "could not allocate resources\n");
 109                 return (ENXIO);
 110         }
 111
 112         sc->sc_io_tag = rman_get_bustag(esc->res[0]);
 113
 114         /* Get all DMA memory */
 115         if (usb_bus_mem_alloc_all(&sc->sc_bus,
 116             USB_GET_DMA_TAG(dev), &ehci_iterate_hw_softc)) {
 117                 return (ENOMEM);
 118         }
 119
 120         /* EHCI registers */
 121         sc->sc_io_tag = rman_get_bustag(esc->res[0]);
 122         bsh = rman_get_bushandle(esc->res[0]);
 123         sc->sc_io_size = rman_get_size(esc->res[0]);
 124
 125         if (bus_space_subregion(sc->sc_io_tag, bsh, 0x100,
 126             sc->sc_io_size, &sc->sc_io_hdl) != 0)
 127                 panic("%s: unable to subregion USB host registers",
 128                     device_get_name(dev));
 129
 130         sc->sc_bus.bdev = device_add_child(dev, "usbus", -1);
 131         if (!sc->sc_bus.bdev) {
 132                 device_printf(dev, "Could not add USB device\n");
 133                 goto error;
 134         }
 135         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 136         device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
 137
 138         sprintf(sc->sc_vendor, "Qualcomm");
 139
 140         err = bus_setup_intr(dev, esc->res[2], INTR_TYPE_BIO | INTR_MPSAFE,
 141             NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
 142         if (err) {
 143                 device_printf(dev, "Could not setup irq, %d\n", err);
 144                 sc->sc_intr_hdl = NULL;
 145                 goto error;
 146         }
 147
 148         sc->sc_flags |= EHCI_SCFLG_DONTRESET | EHCI_SCFLG_NORESTERM;
 149
 150         err = ehci_init(sc);
 151         if (!err) {
 152                 sc->sc_flags |= EHCI_SCFLG_DONEINIT;
 153                 err = device_probe_and_attach(sc->sc_bus.bdev);
 154         }
 155
 156         if (err) {
 157                 device_printf(dev, "USB init failed err=%d\n", err);
 158                 goto error;
 159         }
 160         return (0);
 161
 162 error:
 163         ehci_msm_detach(dev);
 164         return (ENXIO);
 165 }
 166
 167 static int
 168 ehci_msm_detach(device_t dev)
 169 {
 170         ehci_softc_t *sc;
 171         device_t bdev;
 172         int err;
 173
 174         sc = device_get_softc(dev);
 175
 176         if (sc->sc_bus.bdev) {
 177                 bdev = sc->sc_bus.bdev;
 178                 device_detach(bdev);
 179                 device_delete_child(dev, bdev);
 180         }
 181
 182         device_delete_children(dev);
 183
 184         if (sc->sc_irq_res && sc->sc_intr_hdl) {
 185                 /* only call ehci_detach() after ehci_init() */
 186                 ehci_detach(sc);
 187
 188                 err = bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr_hdl);
 189                 if (err)
 190                         device_printf(dev, "Could not tear down irq, %d\n",
 191                             err);
 192                 sc->sc_intr_hdl = NULL;
 193         }
 194
 195         if (sc->sc_irq_res) {
 196                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
 197                 sc->sc_irq_res = NULL;
 198         }
 199         if (sc->sc_io_res) {
 200                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 201                     sc->sc_io_res);
 202                 sc->sc_io_res = NULL;
 203         }
 204
 205         usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
 206
 207         return (0);
 208 }
 209
 210
 211 static device_method_t ehci_methods[] = {
 212         /* Device interface */
 213         DEVMETHOD(device_probe,         ehci_msm_probe),
 214         DEVMETHOD(device_attach,        ehci_msm_attach),
 215         DEVMETHOD(device_detach,        ehci_msm_detach),
 216         DEVMETHOD(device_suspend,       bus_generic_suspend),
 217         DEVMETHOD(device_resume,        bus_generic_resume),
 218         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
 219         DEVMETHOD_END
 220 };
 221
 222 static driver_t ehci_driver = {
 223         .name = "ehci",
 224         .methods = ehci_methods,
 225         .size = sizeof(ehci_softc_t),
 226 };
 227
 228 static devclass_t ehci_devclass;
 229
 230 DRIVER_MODULE(ehci_msm, simplebus, ehci_driver, ehci_devclass, 0, 0);
 231 MODULE_DEPEND(ehci_msm, usb, 1, 1, 1);