dwc_otg_fdt.c revision 330897
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: stable/11/sys/dev/usb/controller/dwc_otg_fdt.c 330897 2018-03-14 03:19:51Z eadler $"); 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 60static device_probe_t dwc_otg_probe; 61static device_detach_t dwc_otg_detach; 62 63static int 64dwc_otg_probe(device_t dev) 65{ 66 67 if (!ofw_bus_status_okay(dev)) 68 return (ENXIO); 69 70 if (!ofw_bus_is_compatible(dev, "synopsys,designware-hs-otg2")) 71 return (ENXIO); 72 73 device_set_desc(dev, "DWC OTG 2.0 integrated USB controller"); 74 75 return (BUS_PROBE_DEFAULT); 76} 77 78int 79dwc_otg_attach(device_t dev) 80{ 81 struct dwc_otg_fdt_softc *sc = device_get_softc(dev); 82 char usb_mode[24]; 83 int err; 84 int rid; 85 86 /* initialise some bus fields */ 87 sc->sc_otg.sc_bus.parent = dev; 88 sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices; 89 sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES; 90 sc->sc_otg.sc_bus.dma_bits = 32; 91 92 /* get USB mode, if any */ 93 if (OF_getprop(ofw_bus_get_node(dev), "dr_mode", 94 &usb_mode, sizeof(usb_mode)) > 0) { 95 96 /* ensure proper zero termination */ 97 usb_mode[sizeof(usb_mode) - 1] = 0; 98 99 if (strcasecmp(usb_mode, "host") == 0) 100 sc->sc_otg.sc_mode = DWC_MODE_HOST; 101 else if (strcasecmp(usb_mode, "peripheral") == 0) 102 sc->sc_otg.sc_mode = DWC_MODE_DEVICE; 103 else if (strcasecmp(usb_mode, "otg") != 0) { 104 device_printf(dev, "Invalid FDT dr_mode: %s\n", 105 usb_mode); 106 } 107 } 108 109 /* get all DMA memory */ 110 if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus, 111 USB_GET_DMA_TAG(dev), NULL)) { 112 return (ENOMEM); 113 } 114 rid = 0; 115 sc->sc_otg.sc_io_res = 116 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); 117 118 if (!(sc->sc_otg.sc_io_res)) { 119 err = ENOMEM; 120 goto error; 121 } 122 sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res); 123 sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res); 124 sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res); 125 126 127 /* 128 * brcm,bcm2708-usb FDT provides two interrupts, 129 * we need only second one (VC_USB) 130 */ 131 rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0; 132 sc->sc_otg.sc_irq_res = 133 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 134 if (sc->sc_otg.sc_irq_res == NULL) 135 goto error; 136 137 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1); 138 if (sc->sc_otg.sc_bus.bdev == NULL) 139 goto error; 140 141 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus); 142 143 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE, 144 &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 145 if (err) { 146 sc->sc_otg.sc_intr_hdl = NULL; 147 goto error; 148 } 149 err = dwc_otg_init(&sc->sc_otg); 150 if (err == 0) { 151 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev); 152 } 153 if (err) 154 goto error; 155 156 157 return (0); 158 159error: 160 dwc_otg_detach(dev); 161 return (ENXIO); 162} 163 164static int 165dwc_otg_detach(device_t dev) 166{ 167 struct dwc_otg_fdt_softc *sc = device_get_softc(dev); 168 int err; 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 err = 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 200static 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 212driver_t dwc_otg_driver = { 213 .name = "dwcotg", 214 .methods = dwc_otg_methods, 215 .size = sizeof(struct dwc_otg_fdt_softc), 216}; 217 218static devclass_t dwc_otg_devclass; 219 220DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0); 221MODULE_DEPEND(dwcotg, usb, 1, 1, 1); 222