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 if (!ofw_bus_is_compatible(dev, "synopsys,designware-hs-otg2")) 79 return (ENXIO); 80 81 device_set_desc(dev, "DWC OTG 2.0 integrated USB controller"); 82 83 return (0); 84 } 85 86 static int 87 dwc_otg_attach(device_t dev) 88 { 89 struct dwc_otg_super_softc *sc = device_get_softc(dev); 90 int err; 91 int rid; 92 93 /* initialise some bus fields */ 94 sc->sc_otg.sc_bus.parent = dev; 95 sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices; 96 sc->sc_otg.sc_bus.devices_max = DWC_OTG_MAX_DEVICES; 97 98 /* get all DMA memory */ 99 if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus, 100 USB_GET_DMA_TAG(dev), NULL)) { 101 return (ENOMEM); 102 } 103 rid = 0; 104 sc->sc_otg.sc_io_res = 105 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); 106 107 if (!(sc->sc_otg.sc_io_res)) { 108 err = ENOMEM; 109 goto error; 110 } 111 sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res); 112 sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res); 113 sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res); 114 115 rid = 0; 116 sc->sc_otg.sc_irq_res = 117 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 118 if (sc->sc_otg.sc_irq_res == NULL) 119 goto error; 120 121 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1); 122 if (sc->sc_otg.sc_bus.bdev == NULL) 123 goto error; 124 125 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus); 126 127 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 128 NULL, (driver_intr_t *)dwc_otg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 129 if (err) { 130 sc->sc_otg.sc_intr_hdl = NULL; 131 goto error; 132 } 133 err = dwc_otg_init(&sc->sc_otg); 134 if (err == 0) { 135 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev); 136 } 137 if (err) 138 goto error; 139 140 141 return (0); 142 143 error: 144 dwc_otg_detach(dev); 145 return (ENXIO); 146 } 147 148 static int 149 dwc_otg_detach(device_t dev) 150 { 151 struct dwc_otg_super_softc *sc = device_get_softc(dev); 152 device_t bdev; 153 int err; 154 155 if (sc->sc_otg.sc_bus.bdev) { 156 bdev = sc->sc_otg.sc_bus.bdev; 157 device_detach(bdev); 158 device_delete_child(dev, bdev); 159 } 160 /* during module unload there are lots of children leftover */ 161 device_delete_children(dev); 162 163 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) { 164 /* 165 * only call dwc_otg_uninit() after dwc_otg_init() 166 */ 167 dwc_otg_uninit(&sc->sc_otg); 168 169 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res, 170 sc->sc_otg.sc_intr_hdl); 171 sc->sc_otg.sc_intr_hdl = NULL; 172 } 173 /* free IRQ channel, if any */ 174 if (sc->sc_otg.sc_irq_res) { 175 bus_release_resource(dev, SYS_RES_IRQ, 0, 176 sc->sc_otg.sc_irq_res); 177 sc->sc_otg.sc_irq_res = NULL; 178 } 179 /* free memory resource, if any */ 180 if (sc->sc_otg.sc_io_res) { 181 bus_release_resource(dev, SYS_RES_MEMORY, 0, 182 sc->sc_otg.sc_io_res); 183 sc->sc_otg.sc_io_res = NULL; 184 } 185 usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL); 186 187 return (0); 188 } 189 190 static device_method_t dwc_otg_methods[] = { 191 /* Device interface */ 192 DEVMETHOD(device_probe, dwc_otg_probe), 193 DEVMETHOD(device_attach, dwc_otg_attach), 194 DEVMETHOD(device_detach, dwc_otg_detach), 195 DEVMETHOD(device_suspend, bus_generic_suspend), 196 DEVMETHOD(device_resume, bus_generic_resume), 197 DEVMETHOD(device_shutdown, bus_generic_shutdown), 198 199 DEVMETHOD_END 200 }; 201 202 static driver_t dwc_otg_driver = { 203 .name = "dwcotg", 204 .methods = dwc_otg_methods, 205 .size = sizeof(struct dwc_otg_super_softc), 206 }; 207 208 static devclass_t dwc_otg_devclass; 209 210 DRIVER_MODULE(dwcotg, simplebus, dwc_otg_driver, dwc_otg_devclass, 0, 0); 211 MODULE_DEPEND(dwcotg, usb, 1, 1, 1); 212