sys/dev/usb/controller/dwc_otg_fdt.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2012 Hans Petter Selasky. 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 <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/bus.h>
  34 #include <sys/condvar.h>
  35 #include <sys/kernel.h>
  36 #include <sys/lock.h>
  37 #include <sys/malloc.h>
  38 #include <sys/module.h>
  39 #include <sys/mutex.h>
  40 #include <sys/rman.h>
  41
  42 #include <dev/ofw/openfirm.h>
  43 #include <dev/ofw/ofw_bus.h>
  44 #include <dev/ofw/ofw_bus_subr.h>
  45
  46 #include <dev/usb/usb.h>
  47 #include <dev/usb/usbdi.h>
  48
  49 #include <dev/usb/usb_core.h>
  50 #include <dev/usb/usb_busdma.h>
  51 #include <dev/usb/usb_process.h>
  52 #include <dev/usb/usb_util.h>
  53
  54 #include <dev/usb/usb_controller.h>
  55 #include <dev/usb/usb_bus.h>
  56
  57 #include <dev/usb/controller/dwc_otg.h>
  58 #include <dev/usb/controller/dwc_otg_fdt.h>
  59
  60 static device_probe_t dwc_otg_probe;
  61
  62 static struct ofw_compat_data compat_data[] = {
  63         { "synopsys,designware-hs-otg2",        1 },
  64         { "snps,dwc2",                          1 },
  65         { NULL,                                 0 }
  66 };
  67
  68 static int
  69 dwc_otg_probe(device_t dev)
  70 {
  71
  72         if (!ofw_bus_status_okay(dev))
  73                 return (ENXIO);
  74
  75         if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
  76                 return (ENXIO);
  77
  78         device_set_desc(dev, "DWC OTG 2.0 integrated USB controller");
  79
  80         return (BUS_PROBE_DEFAULT);
  81 }
  82
  83 static int
  84 dwc_otg_irq_index(device_t dev, int *rid)
  85 {
  86         int idx, rv;
  87         phandle_t node;
  88
  89         node = ofw_bus_get_node(dev);
  90         rv = ofw_bus_find_string_index(node, "interrupt-names", "usb", &idx);
  91         if (rv != 0)
  92                 return (rv);
  93         *rid = idx;
  94         return (0);
  95 }
  96
  97 int
  98 dwc_otg_attach(device_t dev)
  99 {
 100         struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
 101         char usb_mode[24];
 102         int err;
 103         int rid;
 104
 105         /* initialise some bus fields */
 106         sc->sc_otg.sc_bus.parent = dev;
 107         sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
 108         sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES;
 109         sc->sc_otg.sc_bus.dma_bits = 32;
 110
 111         /* get USB mode, if any */
 112         if (OF_getprop(ofw_bus_get_node(dev), "dr_mode",
 113             &usb_mode, sizeof(usb_mode)) > 0) {
 114
 115                 /* ensure proper zero termination */
 116                 usb_mode[sizeof(usb_mode) - 1] = 0;
 117
 118                 if (strcasecmp(usb_mode, "host") == 0)
 119                         sc->sc_otg.sc_mode = DWC_MODE_HOST;
 120                 else if (strcasecmp(usb_mode, "peripheral") == 0)
 121                         sc->sc_otg.sc_mode = DWC_MODE_DEVICE;
 122                 else if (strcasecmp(usb_mode, "otg") != 0) {
 123                         device_printf(dev, "Invalid FDT dr_mode: %s\n",
 124                             usb_mode);
 125                 }
 126         }
 127
 128         /* get all DMA memory */
 129         if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
 130             USB_GET_DMA_TAG(dev), NULL)) {
 131                 return (ENOMEM);
 132         }
 133         rid = 0;
 134         sc->sc_otg.sc_io_res =
 135             bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 136
 137         if (!(sc->sc_otg.sc_io_res)) {
 138                 err = ENOMEM;
 139                 goto error;
 140         }
 141         sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
 142         sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
 143         sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
 144
 145
 146         /*
 147          * brcm,bcm2708-usb FDT provides two interrupts, we need only the USB
 148          * interrupt (VC_USB).  The latest FDT for it provides an
 149          * interrupt-names property and swapped them around, while older ones
 150          * did not have interrupt-names and put the usb interrupt in the second
 151          * position.  We'll attempt to use interrupt-names first with a fallback
 152          * to the old method of assuming the index based on the compatible
 153          * string.
 154          */
 155         if (dwc_otg_irq_index(dev, &rid) != 0)
 156                 rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0;
 157         sc->sc_otg.sc_irq_res =
 158             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 159         if (sc->sc_otg.sc_irq_res == NULL)
 160                 goto error;
 161
 162         sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 163         if (sc->sc_otg.sc_bus.bdev == NULL)
 164                 goto error;
 165
 166         device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
 167
 168         err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE,
 169             &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
 170         if (err) {
 171                 sc->sc_otg.sc_intr_hdl = NULL;
 172                 goto error;
 173         }
 174         err = dwc_otg_init(&sc->sc_otg);
 175         if (err == 0) {
 176                 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
 177         }
 178         if (err)
 179                 goto error;
 180
 181
 182         return (0);
 183
 184 error:
 185         dwc_otg_detach(dev);
 186         return (ENXIO);
 187 }
 188
 189 int
 190 dwc_otg_detach(device_t dev)
 191 {
 192         struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
 193
 194         /* during module unload there are lots of children leftover */
 195         device_delete_children(dev);
 196
 197         if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
 198                 /*
 199                  * only call dwc_otg_uninit() after dwc_otg_init()
 200                  */
 201                 dwc_otg_uninit(&sc->sc_otg);
 202
 203                 bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
 204                     sc->sc_otg.sc_intr_hdl);
 205                 sc->sc_otg.sc_intr_hdl = NULL;
 206         }
 207         /* free IRQ channel, if any */
 208         if (sc->sc_otg.sc_irq_res) {
 209                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 210                     sc->sc_otg.sc_irq_res);
 211                 sc->sc_otg.sc_irq_res = NULL;
 212         }
 213         /* free memory resource, if any */
 214         if (sc->sc_otg.sc_io_res) {
 215                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 216                     sc->sc_otg.sc_io_res);
 217                 sc->sc_otg.sc_io_res = NULL;
 218         }
 219         usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
 220
 221         return (0);
 222 }
 223
 224 static device_method_t dwc_otg_methods[] = {
 225         /* Device interface */
 226         DEVMETHOD(device_probe, dwc_otg_probe),
 227         DEVMETHOD(device_attach, dwc_otg_attach),
 228         DEVMETHOD(device_detach, dwc_otg_detach),
 229         DEVMETHOD(device_suspend, bus_generic_suspend),
 230         DEVMETHOD(device_resume, bus_generic_resume),
 231         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 232
 233         DEVMETHOD_END
 234 };
 235
 236 driver_t dwc_otg_driver = {
 237         .name = "dwcotg",
 238         .methods = dwc_otg_methods,
 239         .size = sizeof(struct dwc_otg_fdt_softc),
 240 };
 241
 242 static devclass_t dwc_otg_devclass;
 243
 244 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0);
 245 MODULE_DEPEND(dwcotg, usb, 1, 1, 1);