musb_otg_atmelarm.c revision 185950
1/* $FreeBSD: head/sys/dev/usb2/controller/musb2_otg_atmelarm.c 185950 2008-12-11 23:17:48Z thompsa $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. 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#include <dev/usb2/include/usb2_mfunc.h> 28#include <dev/usb2/include/usb2_defs.h> 29#include <dev/usb2/include/usb2_standard.h> 30 31#include <dev/usb2/core/usb2_core.h> 32#include <dev/usb2/core/usb2_busdma.h> 33#include <dev/usb2/core/usb2_process.h> 34#include <dev/usb2/core/usb2_config_td.h> 35#include <dev/usb2/core/usb2_sw_transfer.h> 36#include <dev/usb2/core/usb2_util.h> 37 38#include <dev/usb2/controller/usb2_controller.h> 39#include <dev/usb2/controller/usb2_bus.h> 40#include <dev/usb2/controller/musb2_otg.h> 41 42#include <sys/rman.h> 43 44static device_probe_t musbotg_probe; 45static device_attach_t musbotg_attach; 46static device_detach_t musbotg_detach; 47static device_shutdown_t musbotg_shutdown; 48 49struct musbotg_super_softc { 50 struct musbotg_softc sc_otg; /* must be first */ 51}; 52 53static void 54musbotg_vbus_interrupt(struct musbotg_super_softc *sc) 55{ 56 uint8_t vbus_val = 1; /* fake VBUS on - TODO */ 57 58 /* just forward it */ 59 60 (sc->sc_otg.sc_bus.methods->vbus_interrupt) 61 (&sc->sc_otg.sc_bus, vbus_val); 62} 63 64static void 65musbotg_clocks_on(void *arg) 66{ 67#if 0 68 struct musbotg_super_softc *sc = arg; 69 70#endif 71} 72 73static void 74musbotg_clocks_off(void *arg) 75{ 76#if 0 77 struct musbotg_super_softc *sc = arg; 78 79#endif 80} 81 82static int 83musbotg_probe(device_t dev) 84{ 85 device_set_desc(dev, "MUSB OTG integrated USB controller"); 86 return (0); 87} 88 89static int 90musbotg_attach(device_t dev) 91{ 92 struct musbotg_super_softc *sc = device_get_softc(dev); 93 int err; 94 int rid; 95 96 if (sc == NULL) { 97 return (ENXIO); 98 } 99 /* setup MUSB OTG USB controller interface softc */ 100 101 sc->sc_otg.sc_clocks_on = &musbotg_clocks_on; 102 sc->sc_otg.sc_clocks_off = &musbotg_clocks_off; 103 sc->sc_otg.sc_clocks_arg = sc; 104 105 /* get all DMA memory */ 106 107 if (usb2_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 rid = 0; 124 sc->sc_otg.sc_irq_res = 125 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 126 if (!(sc->sc_otg.sc_irq_res)) { 127 goto error; 128 } 129 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1); 130 if (!(sc->sc_otg.sc_bus.bdev)) { 131 goto error; 132 } 133 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus); 134 135 err = usb2_config_td_setup(&sc->sc_otg.sc_config_td, sc, 136 &sc->sc_otg.sc_bus.bus_mtx, NULL, 0, 4); 137 if (err) { 138 device_printf(dev, "could not setup config thread!\n"); 139 goto error; 140 } 141#if (__FreeBSD_version >= 700031) 142 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 143 NULL, (void *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 144#else 145 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 146 (void *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 147#endif 148 if (err) { 149 sc->sc_otg.sc_intr_hdl = NULL; 150 goto error; 151 } 152 err = musbotg_init(&sc->sc_otg); 153 if (!err) { 154 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev); 155 } 156 if (err) { 157 goto error; 158 } else { 159 /* poll VBUS one time */ 160 musbotg_vbus_interrupt(sc); 161 } 162 return (0); 163 164error: 165 musbotg_detach(dev); 166 return (ENXIO); 167} 168 169static int 170musbotg_detach(device_t dev) 171{ 172 struct musbotg_super_softc *sc = device_get_softc(dev); 173 device_t bdev; 174 int err; 175 176 if (sc->sc_otg.sc_bus.bdev) { 177 bdev = sc->sc_otg.sc_bus.bdev; 178 device_detach(bdev); 179 device_delete_child(dev, bdev); 180 } 181 /* during module unload there are lots of children leftover */ 182 device_delete_all_children(dev); 183 184 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) { 185 /* 186 * only call musbotg_uninit() after musbotg_init() 187 */ 188 musbotg_uninit(&sc->sc_otg); 189 190 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res, 191 sc->sc_otg.sc_intr_hdl); 192 sc->sc_otg.sc_intr_hdl = NULL; 193 } 194 /* free IRQ channel, if any */ 195 if (sc->sc_otg.sc_irq_res) { 196 bus_release_resource(dev, SYS_RES_IRQ, 0, 197 sc->sc_otg.sc_irq_res); 198 sc->sc_otg.sc_irq_res = NULL; 199 } 200 /* free memory resource, if any */ 201 if (sc->sc_otg.sc_io_res) { 202 bus_release_resource(dev, SYS_RES_MEMORY, 0, 203 sc->sc_otg.sc_io_res); 204 sc->sc_otg.sc_io_res = NULL; 205 } 206 usb2_config_td_unsetup(&sc->sc_otg.sc_config_td); 207 208 usb2_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL); 209 210 return (0); 211} 212 213static int 214musbotg_shutdown(device_t dev) 215{ 216 struct musbotg_super_softc *sc = device_get_softc(dev); 217 int err; 218 219 err = bus_generic_shutdown(dev); 220 if (err) 221 return (err); 222 223 musbotg_uninit(&sc->sc_otg); 224 225 return (0); 226} 227 228static device_method_t musbotg_methods[] = { 229 /* Device interface */ 230 DEVMETHOD(device_probe, musbotg_probe), 231 DEVMETHOD(device_attach, musbotg_attach), 232 DEVMETHOD(device_detach, musbotg_detach), 233 DEVMETHOD(device_shutdown, musbotg_shutdown), 234 235 /* Bus interface */ 236 DEVMETHOD(bus_print_child, bus_generic_print_child), 237 238 {0, 0} 239}; 240 241static driver_t musbotg_driver = { 242 "musbotg", 243 musbotg_methods, 244 sizeof(struct musbotg_super_softc), 245}; 246 247static devclass_t musbotg_devclass; 248 249DRIVER_MODULE(musbotg, atmelarm, musbotg_driver, musbotg_devclass, 0, 0); 250MODULE_DEPEND(musbotg, usb2_controller, 1, 1, 1); 251MODULE_DEPEND(musbotg, usb2_core, 1, 1, 1); 252