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.
   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         sc->sc_otg.sc_bus.parent = dev;
 106
 107         /* get USB mode, if any */
 108         if (OF_getprop(ofw_bus_get_node(dev), "dr_mode",
 109             &usb_mode, sizeof(usb_mode)) > 0) {
 110
 111                 /* ensure proper zero termination */
 112                 usb_mode[sizeof(usb_mode) - 1] = 0;
 113
 114                 if (strcasecmp(usb_mode, "host") == 0)
 115                         sc->sc_otg.sc_mode = DWC_MODE_HOST;
 116                 else if (strcasecmp(usb_mode, "peripheral") == 0)
 117                         sc->sc_otg.sc_mode = DWC_MODE_DEVICE;
 118                 else if (strcasecmp(usb_mode, "otg") != 0) {
 119                         device_printf(dev, "Invalid FDT dr_mode: %s\n",
 120                             usb_mode);
 121                 }
 122         }
 123
 124         rid = 0;
 125         sc->sc_otg.sc_io_res =
 126             bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 127
 128         if (!(sc->sc_otg.sc_io_res))
 129                 goto error;
 130
 131         /*
 132          * brcm,bcm2708-usb FDT provides two interrupts, we need only the USB
 133          * interrupt (VC_USB).  The latest FDT for it provides an
 134          * interrupt-names property and swapped them around, while older ones
 135          * did not have interrupt-names and put the usb interrupt in the second
 136          * position.  We'll attempt to use interrupt-names first with a fallback
 137          * to the old method of assuming the index based on the compatible
 138          * string.
 139          */
 140         if (dwc_otg_irq_index(dev, &rid) != 0)
 141                 rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0;
 142         sc->sc_otg.sc_irq_res =
 143             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 144         if (sc->sc_otg.sc_irq_res == NULL)
 145                 goto error;
 146
 147         sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 148         if (sc->sc_otg.sc_bus.bdev == NULL)
 149                 goto error;
 150
 151         err = dwc_otg_init(&sc->sc_otg);
 152         if (err == 0) {
 153                 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
 154         }
 155         if (err)
 156                 goto error;
 157
 158         return (0);
 159
 160 error:
 161         dwc_otg_detach(dev);
 162         return (ENXIO);
 163 }
 164
 165 int
 166 dwc_otg_detach(device_t dev)
 167 {
 168         struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
 169
 170         /* during module unload there are lots of children leftover */
 171         device_delete_children(dev);
 172
 173         if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
 174                 /*
 175                  * only call dwc_otg_uninit() after dwc_otg_init()
 176                  */
 177                 dwc_otg_uninit(&sc->sc_otg);
 178
 179                 bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
 180                     sc->sc_otg.sc_intr_hdl);
 181                 sc->sc_otg.sc_intr_hdl = NULL;
 182         }
 183         /* free IRQ channel, if any */
 184         if (sc->sc_otg.sc_irq_res) {
 185                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 186                     sc->sc_otg.sc_irq_res);
 187                 sc->sc_otg.sc_irq_res = NULL;
 188         }
 189         /* free memory resource, if any */
 190         if (sc->sc_otg.sc_io_res) {
 191                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 192                     sc->sc_otg.sc_io_res);
 193                 sc->sc_otg.sc_io_res = NULL;
 194         }
 195         usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
 196
 197         return (0);
 198 }
 199
 200 static device_method_t dwc_otg_methods[] = {
 201         /* Device interface */
 202         DEVMETHOD(device_probe, dwc_otg_probe),
 203         DEVMETHOD(device_attach, dwc_otg_attach),
 204         DEVMETHOD(device_detach, dwc_otg_detach),
 205         DEVMETHOD(device_suspend, bus_generic_suspend),
 206         DEVMETHOD(device_resume, bus_generic_resume),
 207         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 208
 209         DEVMETHOD_END
 210 };
 211
 212 driver_t dwc_otg_driver = {
 213         .name = "dwcotg",
 214         .methods = dwc_otg_methods,
 215         .size = sizeof(struct dwc_otg_fdt_softc),
 216 };
 217
 218 static devclass_t dwc_otg_devclass;
 219
 220 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0);
 221 MODULE_DEPEND(dwcotg, usb, 1, 1, 1);