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 int
  84 dwc_otg_attach(device_t dev)
  85 {
  86         struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
  87         char usb_mode[24];
  88         int err;
  89         int rid;
  90
  91         /* initialise some bus fields */
  92         sc->sc_otg.sc_bus.parent = dev;
  93         sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
  94         sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES;
  95         sc->sc_otg.sc_bus.dma_bits = 32;
  96
  97         /* get USB mode, if any */
  98         if (OF_getprop(ofw_bus_get_node(dev), "dr_mode",
  99             &usb_mode, sizeof(usb_mode)) > 0) {
 100
 101                 /* ensure proper zero termination */
 102                 usb_mode[sizeof(usb_mode) - 1] = 0;
 103
 104                 if (strcasecmp(usb_mode, "host") == 0)
 105                         sc->sc_otg.sc_mode = DWC_MODE_HOST;
 106                 else if (strcasecmp(usb_mode, "peripheral") == 0)
 107                         sc->sc_otg.sc_mode = DWC_MODE_DEVICE;
 108                 else if (strcasecmp(usb_mode, "otg") != 0) {
 109                         device_printf(dev, "Invalid FDT dr_mode: %s\n",
 110                             usb_mode);
 111                 }
 112         }
 113
 114         /* get all DMA memory */
 115         if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
 116             USB_GET_DMA_TAG(dev), NULL)) {
 117                 return (ENOMEM);
 118         }
 119         rid = 0;
 120         sc->sc_otg.sc_io_res =
 121             bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 122
 123         if (!(sc->sc_otg.sc_io_res)) {
 124                 err = ENOMEM;
 125                 goto error;
 126         }
 127         sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
 128         sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
 129         sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
 130
 131
 132         /*
 133          * brcm,bcm2708-usb FDT provides two interrupts,
 134          * we need only second one (VC_USB)
 135          */
 136         rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0;
 137         sc->sc_otg.sc_irq_res =
 138             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 139         if (sc->sc_otg.sc_irq_res == NULL)
 140                 goto error;
 141
 142         sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 143         if (sc->sc_otg.sc_bus.bdev == NULL)
 144                 goto error;
 145
 146         device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
 147
 148         err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE,
 149             &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
 150         if (err) {
 151                 sc->sc_otg.sc_intr_hdl = NULL;
 152                 goto error;
 153         }
 154         err = dwc_otg_init(&sc->sc_otg);
 155         if (err == 0) {
 156                 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
 157         }
 158         if (err)
 159                 goto error;
 160
 161
 162         return (0);
 163
 164 error:
 165         dwc_otg_detach(dev);
 166         return (ENXIO);
 167 }
 168
 169 int
 170 dwc_otg_detach(device_t dev)
 171 {
 172         struct dwc_otg_fdt_softc *sc = device_get_softc(dev);
 173
 174         /* during module unload there are lots of children leftover */
 175         device_delete_children(dev);
 176
 177         if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
 178                 /*
 179                  * only call dwc_otg_uninit() after dwc_otg_init()
 180                  */
 181                 dwc_otg_uninit(&sc->sc_otg);
 182
 183                 bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
 184                     sc->sc_otg.sc_intr_hdl);
 185                 sc->sc_otg.sc_intr_hdl = NULL;
 186         }
 187         /* free IRQ channel, if any */
 188         if (sc->sc_otg.sc_irq_res) {
 189                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 190                     sc->sc_otg.sc_irq_res);
 191                 sc->sc_otg.sc_irq_res = NULL;
 192         }
 193         /* free memory resource, if any */
 194         if (sc->sc_otg.sc_io_res) {
 195                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 196                     sc->sc_otg.sc_io_res);
 197                 sc->sc_otg.sc_io_res = NULL;
 198         }
 199         usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
 200
 201         return (0);
 202 }
 203
 204 static device_method_t dwc_otg_methods[] = {
 205         /* Device interface */
 206         DEVMETHOD(device_probe, dwc_otg_probe),
 207         DEVMETHOD(device_attach, dwc_otg_attach),
 208         DEVMETHOD(device_detach, dwc_otg_detach),
 209         DEVMETHOD(device_suspend, bus_generic_suspend),
 210         DEVMETHOD(device_resume, bus_generic_resume),
 211         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 212
 213         DEVMETHOD_END
 214 };
 215
 216 driver_t dwc_otg_driver = {
 217         .name = "dwcotg",
 218         .methods = dwc_otg_methods,
 219         .size = sizeof(struct dwc_otg_fdt_softc),
 220 };
 221
 222 static devclass_t dwc_otg_devclass;
 223
 224 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0);
 225 MODULE_DEPEND(dwcotg, usb, 1, 1, 1);