1 /*- 2 * Copyright (c) 2006 M. Warner Losh. 3 * Copyright (c) 2016 Emmanuel Vadot <manu@freebsd.org> All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 /* 28 * Generic OHCI driver based on AT91 OHCI 29 */ 30 31 #include <sys/cdefs.h> 32 __FBSDID("$FreeBSD$"); 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/bus.h> 37 #include <sys/rman.h> 38 #include <sys/condvar.h> 39 #include <sys/kernel.h> 40 #include <sys/module.h> 41 42 #include <machine/bus.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 #include <dev/usb/controller/ohci.h> 57 #include <dev/usb/controller/ohcireg.h> 58 59 #ifdef EXT_RESOURCES 60 #include <dev/extres/clk/clk.h> 61 #include <dev/extres/hwreset/hwreset.h> 62 #include <dev/extres/phy/phy.h> 63 #endif 64 65 #include "generic_usb_if.h" 66 67 #ifdef EXT_RESOURCES 68 struct clk_list { 69 TAILQ_ENTRY(clk_list) next; 70 clk_t clk; 71 }; 72 #endif 73 74 struct generic_ohci_softc { 75 ohci_softc_t ohci_sc; 76 77 #ifdef EXT_RESOURCES 78 hwreset_t rst; 79 phy_t phy; 80 TAILQ_HEAD(, clk_list) clk_list; 81 #endif 82 }; 83 84 static int generic_ohci_detach(device_t); 85 86 static int 87 generic_ohci_probe(device_t dev) 88 { 89 90 if (!ofw_bus_status_okay(dev)) 91 return (ENXIO); 92 93 if (!ofw_bus_is_compatible(dev, "generic-ohci")) 94 return (ENXIO); 95 96 device_set_desc(dev, "Generic OHCI Controller"); 97 98 return (BUS_PROBE_DEFAULT); 99 } 100 101 static int 102 generic_ohci_attach(device_t dev) 103 { 104 struct generic_ohci_softc *sc = device_get_softc(dev); 105 int err, rid; 106 #ifdef EXT_RESOURCES 107 int off; 108 struct clk_list *clkp; 109 clk_t clk; 110 #endif 111 112 sc->ohci_sc.sc_bus.parent = dev; 113 sc->ohci_sc.sc_bus.devices = sc->ohci_sc.sc_devices; 114 sc->ohci_sc.sc_bus.devices_max = OHCI_MAX_DEVICES; 115 sc->ohci_sc.sc_bus.dma_bits = 32; 116 117 /* get all DMA memory */ 118 if (usb_bus_mem_alloc_all(&sc->ohci_sc.sc_bus, 119 USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) { 120 return (ENOMEM); 121 } 122 123 rid = 0; 124 sc->ohci_sc.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, 125 &rid, RF_ACTIVE); 126 if (sc->ohci_sc.sc_io_res == 0) { 127 err = ENOMEM; 128 goto error; 129 } 130 131 sc->ohci_sc.sc_io_tag = rman_get_bustag(sc->ohci_sc.sc_io_res); 132 sc->ohci_sc.sc_io_hdl = rman_get_bushandle(sc->ohci_sc.sc_io_res); 133 sc->ohci_sc.sc_io_size = rman_get_size(sc->ohci_sc.sc_io_res); 134 135 rid = 0; 136 sc->ohci_sc.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 137 RF_ACTIVE); 138 if (sc->ohci_sc.sc_irq_res == 0) { 139 err = ENXIO; 140 goto error; 141 } 142 sc->ohci_sc.sc_bus.bdev = device_add_child(dev, "usbus", -1); 143 if (sc->ohci_sc.sc_bus.bdev == 0) { 144 err = ENXIO; 145 goto error; 146 } 147 device_set_ivars(sc->ohci_sc.sc_bus.bdev, &sc->ohci_sc.sc_bus); 148 149 strlcpy(sc->ohci_sc.sc_vendor, "Generic", 150 sizeof(sc->ohci_sc.sc_vendor)); 151 152 err = bus_setup_intr(dev, sc->ohci_sc.sc_irq_res, 153 INTR_TYPE_BIO | INTR_MPSAFE, NULL, 154 (driver_intr_t *)ohci_interrupt, sc, &sc->ohci_sc.sc_intr_hdl); 155 if (err) { 156 sc->ohci_sc.sc_intr_hdl = NULL; 157 goto error; 158 } 159 160 #ifdef EXT_RESOURCES 161 TAILQ_INIT(&sc->clk_list); 162 /* Enable clock */ 163 for (off = 0; clk_get_by_ofw_index(dev, 0, off, &clk) == 0; off++) { 164 err = clk_enable(clk); 165 if (err != 0) { 166 device_printf(dev, "Could not enable clock %s\n", 167 clk_get_name(clk)); 168 goto error; 169 } 170 clkp = malloc(sizeof(*clkp), M_DEVBUF, M_WAITOK | M_ZERO); 171 clkp->clk = clk; 172 TAILQ_INSERT_TAIL(&sc->clk_list, clkp, next); 173 } 174 175 /* De-assert reset */ 176 if (hwreset_get_by_ofw_idx(dev, 0, 0, &sc->rst) == 0) { 177 err = hwreset_deassert(sc->rst); 178 if (err != 0) { 179 device_printf(dev, "Could not de-assert reset %d\n", 180 off); 181 goto error; 182 } 183 } 184 185 /* Enable phy */ 186 if (phy_get_by_ofw_name(dev, 0, "usb", &sc->phy) == 0) { 187 err = phy_enable(sc->phy); 188 if (err != 0) { 189 device_printf(dev, "Could not enable phy\n"); 190 goto error; 191 } 192 } 193 #endif 194 195 if (GENERIC_USB_INIT(dev) != 0) { 196 err = ENXIO; 197 goto error; 198 } 199 200 err = ohci_init(&sc->ohci_sc); 201 if (err == 0) 202 err = device_probe_and_attach(sc->ohci_sc.sc_bus.bdev); 203 if (err) 204 goto error; 205 206 return (0); 207 error: 208 generic_ohci_detach(dev); 209 return (err); 210 } 211 212 static int 213 generic_ohci_detach(device_t dev) 214 { 215 struct generic_ohci_softc *sc = device_get_softc(dev); 216 int err; 217 #ifdef EXT_RESOURCES 218 struct clk_list *clk, *clk_tmp; 219 #endif 220 221 /* during module unload there are lots of children leftover */ 222 device_delete_children(dev); 223 224 /* 225 * Put the controller into reset, then disable clocks and do 226 * the MI tear down. We have to disable the clocks/hardware 227 * after we do the rest of the teardown. We also disable the 228 * clocks in the opposite order we acquire them, but that 229 * doesn't seem to be absolutely necessary. We free up the 230 * clocks after we disable them, so the system could, in 231 * theory, reuse them. 232 */ 233 bus_space_write_4(sc->ohci_sc.sc_io_tag, sc->ohci_sc.sc_io_hdl, 234 OHCI_CONTROL, 0); 235 236 if (sc->ohci_sc.sc_irq_res && sc->ohci_sc.sc_intr_hdl) { 237 /* 238 * only call ohci_detach() after ohci_init() 239 */ 240 ohci_detach(&sc->ohci_sc); 241 242 err = bus_teardown_intr(dev, sc->ohci_sc.sc_irq_res, 243 sc->ohci_sc.sc_intr_hdl); 244 sc->ohci_sc.sc_intr_hdl = NULL; 245 } 246 if (sc->ohci_sc.sc_irq_res) { 247 bus_release_resource(dev, SYS_RES_IRQ, 0, 248 sc->ohci_sc.sc_irq_res); 249 sc->ohci_sc.sc_irq_res = NULL; 250 } 251 if (sc->ohci_sc.sc_io_res) { 252 bus_release_resource(dev, SYS_RES_MEMORY, 0, 253 sc->ohci_sc.sc_io_res); 254 sc->ohci_sc.sc_io_res = NULL; 255 } 256 usb_bus_mem_free_all(&sc->ohci_sc.sc_bus, &ohci_iterate_hw_softc); 257 258 #ifdef EXT_RESOURCES 259 /* Disable phy */ 260 if (sc->phy) { 261 err = phy_disable(sc->phy); 262 if (err != 0) 263 device_printf(dev, "Could not disable phy\n"); 264 phy_release(sc->phy); 265 } 266 267 /* Disable clock */ 268 TAILQ_FOREACH_SAFE(clk, &sc->clk_list, next, clk_tmp) { 269 err = clk_disable(clk->clk); 270 if (err != 0) 271 device_printf(dev, "Could not disable clock %s\n", 272 clk_get_name(clk->clk)); 273 err = clk_release(clk->clk); 274 if (err != 0) 275 device_printf(dev, "Could not release clock %s\n", 276 clk_get_name(clk->clk)); 277 TAILQ_REMOVE(&sc->clk_list, clk, next); 278 free(clk, M_DEVBUF); 279 } 280 281 /* De-assert reset */ 282 if (sc->rst) { 283 err = hwreset_assert(sc->rst); 284 if (err != 0) 285 device_printf(dev, "Could not assert reset\n"); 286 hwreset_release(sc->rst); 287 } 288 #endif 289 290 if (GENERIC_USB_DEINIT(dev) != 0) 291 return (ENXIO); 292 293 return (0); 294 } 295 296 static device_method_t generic_ohci_methods[] = { 297 /* Device interface */ 298 DEVMETHOD(device_probe, generic_ohci_probe), 299 DEVMETHOD(device_attach, generic_ohci_attach), 300 DEVMETHOD(device_detach, generic_ohci_detach), 301 302 DEVMETHOD(device_suspend, bus_generic_suspend), 303 DEVMETHOD(device_resume, bus_generic_resume), 304 DEVMETHOD(device_shutdown, bus_generic_shutdown), 305 306 DEVMETHOD_END 307 }; 308 309 driver_t generic_ohci_driver = { 310 .name = "ohci", 311 .methods = generic_ohci_methods, 312 .size = sizeof(struct generic_ohci_softc), 313 }; 314 315 static devclass_t generic_ohci_devclass; 316 317 DRIVER_MODULE(ohci, simplebus, generic_ohci_driver, 318 generic_ohci_devclass, 0, 0); 319 MODULE_DEPEND(ohci, usb, 1, 1, 1); 320