1 /*- 2 * Copyright (c) 2012 Hans Petter Selasky. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23 * SUCH DAMAGE. 24 */ 25 26 #include <sys/cdefs.h> 27 __FBSDID("$FreeBSD$"); 28 29 #include <sys/param.h> 30 #include <sys/systm.h> 31 #include <sys/bus.h> 32 #include <sys/condvar.h> 33 #include <sys/kernel.h> 34 #include <sys/lock.h> 35 #include <sys/malloc.h> 36 #include <sys/module.h> 37 #include <sys/mutex.h> 38 #include <sys/rman.h> 39 40 #include <dev/ofw/openfirm.h> 41 #include <dev/ofw/ofw_bus.h> 42 #include <dev/ofw/ofw_bus_subr.h> 43 44 #include <dev/usb/usb.h> 45 #include <dev/usb/usbdi.h> 46 47 #include <dev/usb/usb_core.h> 48 #include <dev/usb/usb_busdma.h> 49 #include <dev/usb/usb_process.h> 50 #include <dev/usb/usb_util.h> 51 52 #include <dev/usb/usb_controller.h> 53 #include <dev/usb/usb_bus.h> 54 55 #include <dev/usb/controller/dwc_otg.h> 56 #include <dev/usb/controller/dwc_otg_fdt.h> 57 58 static device_probe_t dwc_otg_probe; 59 60 static int 61 dwc_otg_probe(device_t dev) 62 { 63 64 if (!ofw_bus_status_okay(dev)) 65 return (ENXIO); 66 67 if (!ofw_bus_is_compatible(dev, "synopsys,designware-hs-otg2")) 68 return (ENXIO); 69 70 device_set_desc(dev, "DWC OTG 2.0 integrated USB controller"); 71 72 return (BUS_PROBE_DEFAULT); 73 } 74 75 int 76 dwc_otg_attach(device_t dev) 77 { 78 struct dwc_otg_fdt_softc *sc = device_get_softc(dev); 79 char usb_mode[24]; 80 int err; 81 int rid; 82 83 /* initialise some bus fields */ 84 sc->sc_otg.sc_bus.parent = dev; 85 sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices; 86 sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES; 87 sc->sc_otg.sc_bus.dma_bits = 32; 88 89 /* get USB mode, if any */ 90 if (OF_getprop(ofw_bus_get_node(dev), "dr_mode", 91 &usb_mode, sizeof(usb_mode)) > 0) { 92 93 /* ensure proper zero termination */ 94 usb_mode[sizeof(usb_mode) - 1] = 0; 95 96 if (strcasecmp(usb_mode, "host") == 0) 97 sc->sc_otg.sc_mode = DWC_MODE_HOST; 98 else if (strcasecmp(usb_mode, "peripheral") == 0) 99 sc->sc_otg.sc_mode = DWC_MODE_DEVICE; 100 else if (strcasecmp(usb_mode, "otg") != 0) { 101 device_printf(dev, "Invalid FDT dr_mode: %s\n", 102 usb_mode); 103 } 104 } 105 106 /* get all DMA memory */ 107 if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus, 108 USB_GET_DMA_TAG(dev), NULL)) { 109 return (ENOMEM); 110 } 111 rid = 0; 112 sc->sc_otg.sc_io_res = 113 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); 114 115 if (!(sc->sc_otg.sc_io_res)) { 116 err = ENOMEM; 117 goto error; 118 } 119 sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res); 120 sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res); 121 sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res); 122 123 124 /* 125 * brcm,bcm2708-usb FDT provides two interrupts, 126 * we need only second one (VC_USB) 127 */ 128 rid = ofw_bus_is_compatible(dev, "brcm,bcm2708-usb") ? 1 : 0; 129 sc->sc_otg.sc_irq_res = 130 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 131 if (sc->sc_otg.sc_irq_res == NULL) 132 goto error; 133 134 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1); 135 if (sc->sc_otg.sc_bus.bdev == NULL) 136 goto error; 137 138 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus); 139 140 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE, 141 &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 142 if (err) { 143 sc->sc_otg.sc_intr_hdl = NULL; 144 goto error; 145 } 146 err = dwc_otg_init(&sc->sc_otg); 147 if (err == 0) { 148 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev); 149 } 150 if (err) 151 goto error; 152 153 154 return (0); 155 156 error: 157 dwc_otg_detach(dev); 158 return (ENXIO); 159 } 160 161 int 162 dwc_otg_detach(device_t dev) 163 { 164 struct dwc_otg_fdt_softc *sc = device_get_softc(dev); 165 int err; 166 167 /* during module unload there are lots of children leftover */ 168 device_delete_children(dev); 169 170 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) { 171 /* 172 * only call dwc_otg_uninit() after dwc_otg_init() 173 */ 174 dwc_otg_uninit(&sc->sc_otg); 175 176 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res, 177 sc->sc_otg.sc_intr_hdl); 178 sc->sc_otg.sc_intr_hdl = NULL; 179 } 180 /* free IRQ channel, if any */ 181 if (sc->sc_otg.sc_irq_res) { 182 bus_release_resource(dev, SYS_RES_IRQ, 0, 183 sc->sc_otg.sc_irq_res); 184 sc->sc_otg.sc_irq_res = NULL; 185 } 186 /* free memory resource, if any */ 187 if (sc->sc_otg.sc_io_res) { 188 bus_release_resource(dev, SYS_RES_MEMORY, 0, 189 sc->sc_otg.sc_io_res); 190 sc->sc_otg.sc_io_res = NULL; 191 } 192 usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL); 193 194 return (0); 195 } 196 197 static device_method_t dwc_otg_methods[] = { 198 /* Device interface */ 199 DEVMETHOD(device_probe, dwc_otg_probe), 200 DEVMETHOD(device_attach, dwc_otg_attach), 201 DEVMETHOD(device_detach, dwc_otg_detach), 202 DEVMETHOD(device_suspend, bus_generic_suspend), 203 DEVMETHOD(device_resume, bus_generic_resume), 204 DEVMETHOD(device_shutdown, bus_generic_shutdown), 205 206 DEVMETHOD_END 207 }; 208 209 driver_t dwc_otg_driver = { 210 .name = "dwcotg", 211 .methods = dwc_otg_methods, 212 .size = sizeof(struct dwc_otg_fdt_softc), 213 }; 214 215 static devclass_t dwc_otg_devclass; 216 217 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0); 218 MODULE_DEPEND(dwcotg, usb, 1, 1, 1); 219