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/stdint.h> 30 #include <sys/stddef.h> 31 #include <sys/param.h> 32 #include <sys/queue.h> 33 #include <sys/types.h> 34 #include <sys/systm.h> 35 #include <sys/kernel.h> 36 #include <sys/bus.h> 37 #include <sys/module.h> 38 #include <sys/lock.h> 39 #include <sys/mutex.h> 40 #include <sys/condvar.h> 41 #include <sys/sysctl.h> 42 #include <sys/sx.h> 43 #include <sys/unistd.h> 44 #include <sys/callout.h> 45 #include <sys/malloc.h> 46 #include <sys/priv.h> 47 #include <sys/rman.h> 48 49 #include <dev/fdt/fdt_common.h> 50 #include <dev/ofw/openfirm.h> 51 #include <dev/ofw/ofw_bus.h> 52 #include <dev/ofw/ofw_bus_subr.h> 53 54 #include <dev/usb/usb.h> 55 #include <dev/usb/usbdi.h> 56 57 #include <dev/usb/usb_core.h> 58 #include <dev/usb/usb_busdma.h> 59 #include <dev/usb/usb_process.h> 60 #include <dev/usb/usb_util.h> 61 62 #include <dev/usb/usb_controller.h> 63 #include <dev/usb/usb_bus.h> 64 65 #include <dev/usb/controller/dwc_otg.h> 66 67 static device_probe_t dwc_otg_probe; 68 static device_attach_t dwc_otg_attach; 69 static device_detach_t dwc_otg_detach; 70 71 struct dwc_otg_super_softc { 72 struct dwc_otg_softc sc_otg; /* must be first */ 73 }; 74 75 static int 76 dwc_otg_probe(device_t dev) 77 { 78 79 if (!ofw_bus_status_okay(dev)) 80 return (ENXIO); 81 82 if (!ofw_bus_is_compatible(dev, "synopsys,designware-hs-otg2")) 83 return (ENXIO); 84 85 device_set_desc(dev, "DWC OTG 2.0 integrated USB controller"); 86 87 return (0); 88 } 89 90 static int 91 dwc_otg_attach(device_t dev) 92 { 93 struct dwc_otg_super_softc *sc = device_get_softc(dev); 94 char usb_mode[24]; 95 int err; 96 int rid; 97 98 /* initialise some bus fields */ 99 sc->sc_otg.sc_bus.parent = dev; 100 sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices; 101 sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES; 102 103 /* get USB mode, if any */ 104 if (OF_getprop(ofw_bus_get_node(dev), "dr_mode", 105 &usb_mode, sizeof(usb_mode)) > 0) { 106 107 /* ensure proper zero termination */ 108 usb_mode[sizeof(usb_mode) - 1] = 0; 109 110 if (strcasecmp(usb_mode, "host") == 0) 111 sc->sc_otg.sc_mode = DWC_MODE_HOST; 112 else if (strcasecmp(usb_mode, "peripheral") == 0) 113 sc->sc_otg.sc_mode = DWC_MODE_DEVICE; 114 else if (strcasecmp(usb_mode, "otg") != 0) { 115 device_printf(dev, "Invalid FDT dr_mode: %s\n", 116 usb_mode); 117 } 118 } 119 120 /* get all DMA memory */ 121 if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus, 122 USB_GET_DMA_TAG(dev), NULL)) { 123 return (ENOMEM); 124 } 125 rid = 0; 126 sc->sc_otg.sc_io_res = 127 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); 128 129 if (!(sc->sc_otg.sc_io_res)) { 130 err = ENOMEM; 131 goto error; 132 } 133 sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res); 134 sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res); 135 sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res); 136 137 rid = 0; 138 sc->sc_otg.sc_irq_res = 139 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 140 if (sc->sc_otg.sc_irq_res == NULL) 141 goto error; 142 143 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1); 144 if (sc->sc_otg.sc_bus.bdev == NULL) 145 goto error; 146 147 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus); 148 149 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE, 150 &dwc_otg_filter_interrupt, &dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 151 if (err) { 152 sc->sc_otg.sc_intr_hdl = NULL; 153 goto error; 154 } 155 err = dwc_otg_init(&sc->sc_otg); 156 if (err == 0) { 157 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev); 158 } 159 if (err) 160 goto error; 161 162 163 return (0); 164 165 error: 166 dwc_otg_detach(dev); 167 return (ENXIO); 168 } 169 170 static int 171 dwc_otg_detach(device_t dev) 172 { 173 struct dwc_otg_super_softc *sc = device_get_softc(dev); 174 device_t bdev; 175 int err; 176 177 if (sc->sc_otg.sc_bus.bdev) { 178 bdev = sc->sc_otg.sc_bus.bdev; 179 device_detach(bdev); 180 device_delete_child(dev, bdev); 181 } 182 /* during module unload there are lots of children leftover */ 183 device_delete_children(dev); 184 185 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) { 186 /* 187 * only call dwc_otg_uninit() after dwc_otg_init() 188 */ 189 dwc_otg_uninit(&sc->sc_otg); 190 191 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res, 192 sc->sc_otg.sc_intr_hdl); 193 sc->sc_otg.sc_intr_hdl = NULL; 194 } 195 /* free IRQ channel, if any */ 196 if (sc->sc_otg.sc_irq_res) { 197 bus_release_resource(dev, SYS_RES_IRQ, 0, 198 sc->sc_otg.sc_irq_res); 199 sc->sc_otg.sc_irq_res = NULL; 200 } 201 /* free memory resource, if any */ 202 if (sc->sc_otg.sc_io_res) { 203 bus_release_resource(dev, SYS_RES_MEMORY, 0, 204 sc->sc_otg.sc_io_res); 205 sc->sc_otg.sc_io_res = NULL; 206 } 207 usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL); 208 209 return (0); 210 } 211 212 static device_method_t dwc_otg_methods[] = { 213 /* Device interface */ 214 DEVMETHOD(device_probe, dwc_otg_probe), 215 DEVMETHOD(device_attach, dwc_otg_attach), 216 DEVMETHOD(device_detach, dwc_otg_detach), 217 DEVMETHOD(device_suspend, bus_generic_suspend), 218 DEVMETHOD(device_resume, bus_generic_resume), 219 DEVMETHOD(device_shutdown, bus_generic_shutdown), 220 221 DEVMETHOD_END 222 }; 223 224 static driver_t dwc_otg_driver = { 225 .name = "dwcotg", 226 .methods = dwc_otg_methods, 227 .size = sizeof(struct dwc_otg_super_softc), 228 }; 229 230 static devclass_t dwc_otg_devclass; 231 232 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0); 233 MODULE_DEPEND(dwcotg, usb, 1, 1, 1); 234