musb_otg_atmelarm.c revision 186439
1/* $FreeBSD: head/sys/dev/usb2/controller/musb2_otg_atmelarm.c 186439 2008-12-23 17:36:25Z 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 sc->sc_otg.sc_bus.parent = dev; 108 if (usb2_bus_mem_alloc_all(&sc->sc_otg.sc_bus, 109 USB_GET_DMA_TAG(dev), NULL)) { 110 return (ENOMEM); 111 } 112 rid = 0; 113 sc->sc_otg.sc_io_res = 114 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); 115 116 if (!(sc->sc_otg.sc_io_res)) { 117 err = ENOMEM; 118 goto error; 119 } 120 sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res); 121 sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res); 122 sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res); 123 124 rid = 0; 125 sc->sc_otg.sc_irq_res = 126 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 127 if (!(sc->sc_otg.sc_irq_res)) { 128 goto error; 129 } 130 sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1); 131 if (!(sc->sc_otg.sc_bus.bdev)) { 132 goto error; 133 } 134 device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus); 135 136 err = usb2_config_td_setup(&sc->sc_otg.sc_config_td, sc, 137 &sc->sc_otg.sc_bus.bus_mtx, NULL, 0, 4); 138 if (err) { 139 device_printf(dev, "could not setup config thread!\n"); 140 goto error; 141 } 142#if (__FreeBSD_version >= 700031) 143 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 144 NULL, (void *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 145#else 146 err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 147 (void *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl); 148#endif 149 if (err) { 150 sc->sc_otg.sc_intr_hdl = NULL; 151 goto error; 152 } 153 err = musbotg_init(&sc->sc_otg); 154 if (!err) { 155 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev); 156 } 157 if (err) { 158 goto error; 159 } else { 160 /* poll VBUS one time */ 161 musbotg_vbus_interrupt(sc); 162 } 163 return (0); 164 165error: 166 musbotg_detach(dev); 167 return (ENXIO); 168} 169 170static int 171musbotg_detach(device_t dev) 172{ 173 struct musbotg_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_all_children(dev); 184 185 if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) { 186 /* 187 * only call musbotg_uninit() after musbotg_init() 188 */ 189 musbotg_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 usb2_config_td_unsetup(&sc->sc_otg.sc_config_td); 208 209 usb2_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL); 210 211 return (0); 212} 213 214static int 215musbotg_shutdown(device_t dev) 216{ 217 struct musbotg_super_softc *sc = device_get_softc(dev); 218 int err; 219 220 err = bus_generic_shutdown(dev); 221 if (err) 222 return (err); 223 224 musbotg_uninit(&sc->sc_otg); 225 226 return (0); 227} 228 229static device_method_t musbotg_methods[] = { 230 /* Device interface */ 231 DEVMETHOD(device_probe, musbotg_probe), 232 DEVMETHOD(device_attach, musbotg_attach), 233 DEVMETHOD(device_detach, musbotg_detach), 234 DEVMETHOD(device_shutdown, musbotg_shutdown), 235 236 /* Bus interface */ 237 DEVMETHOD(bus_print_child, bus_generic_print_child), 238 239 {0, 0} 240}; 241 242static driver_t musbotg_driver = { 243 "musbotg", 244 musbotg_methods, 245 sizeof(struct musbotg_super_softc), 246}; 247 248static devclass_t musbotg_devclass; 249 250DRIVER_MODULE(musbotg, atmelarm, musbotg_driver, musbotg_devclass, 0, 0); 251MODULE_DEPEND(musbotg, usb2_controller, 1, 1, 1); 252MODULE_DEPEND(musbotg, usb2_core, 1, 1, 1); 253