at91_ohci.c revision 187170
1/*- 2 * Copyright (c) 2006 M. Warner Losh. 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 ``AS IS'' AND ANY EXPRESS OR 14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 */ 24 25#include <sys/cdefs.h> 26__FBSDID("$FreeBSD: head/sys/dev/usb2/controller/ohci2_atmelarm.c 187170 2009-01-13 19:02:40Z thompsa $"); 27 28#include <dev/usb2/include/usb2_mfunc.h> 29#include <dev/usb2/include/usb2_defs.h> 30#include <dev/usb2/include/usb2_standard.h> 31 32#include <dev/usb2/core/usb2_core.h> 33#include <dev/usb2/core/usb2_busdma.h> 34#include <dev/usb2/core/usb2_process.h> 35#include <dev/usb2/core/usb2_config_td.h> 36#include <dev/usb2/core/usb2_sw_transfer.h> 37#include <dev/usb2/core/usb2_util.h> 38 39#include <dev/usb2/controller/usb2_controller.h> 40#include <dev/usb2/controller/usb2_bus.h> 41#include <dev/usb2/controller/ohci2.h> 42 43#include <sys/rman.h> 44 45#include <arm/at91/at91_pmcvar.h> 46 47#define MEM_RID 0 48 49static device_probe_t ohci_atmelarm_probe; 50static device_attach_t ohci_atmelarm_attach; 51static device_detach_t ohci_atmelarm_detach; 52 53struct at91_ohci_softc { 54 struct ohci_softc sc_ohci; /* must be first */ 55 struct at91_pmc_clock *iclk; 56 struct at91_pmc_clock *fclk; 57}; 58 59static int 60ohci_atmelarm_probe(device_t dev) 61{ 62 device_set_desc(dev, "AT91 integrated OHCI controller"); 63 return (BUS_PROBE_DEFAULT); 64} 65 66static int 67ohci_atmelarm_attach(device_t dev) 68{ 69 struct at91_ohci_softc *sc = device_get_softc(dev); 70 int err; 71 int rid; 72 73 if (sc == NULL) { 74 return (ENXIO); 75 } 76 /* initialise some bus fields */ 77 sc->sc_ohci.sc_bus.parent = dev; 78 sc->sc_ohci.sc_bus.devices = sc->sc_ohci.sc_devices; 79 sc->sc_ohci.sc_bus.devices_max = OHCI_MAX_DEVICES; 80 81 /* get all DMA memory */ 82 if (usb2_bus_mem_alloc_all(&sc->sc_ohci.sc_bus, 83 USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) { 84 return (ENOMEM); 85 } 86 sc->iclk = at91_pmc_clock_ref("ohci_clk"); 87 sc->fclk = at91_pmc_clock_ref("uhpck"); 88 89 sc->sc_ohci.sc_dev = dev; 90 91 rid = MEM_RID; 92 sc->sc_ohci.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, 93 &rid, RF_ACTIVE); 94 95 if (!(sc->sc_ohci.sc_io_res)) { 96 err = ENOMEM; 97 goto error; 98 } 99 sc->sc_ohci.sc_io_tag = rman_get_bustag(sc->sc_ohci.sc_io_res); 100 sc->sc_ohci.sc_io_hdl = rman_get_bushandle(sc->sc_ohci.sc_io_res); 101 sc->sc_ohci.sc_io_size = rman_get_size(sc->sc_ohci.sc_io_res); 102 103 rid = 0; 104 sc->sc_ohci.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 105 RF_ACTIVE); 106 if (!(sc->sc_ohci.sc_irq_res)) { 107 goto error; 108 } 109 sc->sc_ohci.sc_bus.bdev = device_add_child(dev, "usbus", -1); 110 if (!(sc->sc_ohci.sc_bus.bdev)) { 111 goto error; 112 } 113 device_set_ivars(sc->sc_ohci.sc_bus.bdev, &sc->sc_ohci.sc_bus); 114 115 strlcpy(sc->sc_ohci.sc_vendor, "Atmel", sizeof(sc->sc_ohci.sc_vendor)); 116 117 err = usb2_config_td_setup(&sc->sc_ohci.sc_config_td, sc, 118 &sc->sc_ohci.sc_bus.bus_mtx, NULL, 0, 4); 119 if (err) { 120 device_printf(dev, "could not setup config thread!\n"); 121 goto error; 122 } 123#if (__FreeBSD_version >= 700031) 124 err = bus_setup_intr(dev, sc->sc_ohci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 125 NULL, (void *)ohci_interrupt, sc, &sc->sc_ohci.sc_intr_hdl); 126#else 127 err = bus_setup_intr(dev, sc->sc_ohci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 128 (void *)ohci_interrupt, sc, &sc->sc_ohci.sc_intr_hdl); 129#endif 130 if (err) { 131 sc->sc_ohci.sc_intr_hdl = NULL; 132 goto error; 133 } 134 /* 135 * turn on the clocks from the AT91's point of view. Keep the unit in reset. 136 */ 137 at91_pmc_clock_enable(sc->iclk); 138 at91_pmc_clock_enable(sc->fclk); 139 bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl, 140 OHCI_CONTROL, 0); 141 142 err = ohci_init(&sc->sc_ohci); 143 if (!err) { 144 err = device_probe_and_attach(sc->sc_ohci.sc_bus.bdev); 145 } 146 if (err) { 147 goto error; 148 } 149 return (0); 150 151error: 152 ohci_atmelarm_detach(dev); 153 return (ENXIO); 154} 155 156static int 157ohci_atmelarm_detach(device_t dev) 158{ 159 struct at91_ohci_softc *sc = device_get_softc(dev); 160 device_t bdev; 161 int err; 162 163 if (sc->sc_ohci.sc_bus.bdev) { 164 bdev = sc->sc_ohci.sc_bus.bdev; 165 device_detach(bdev); 166 device_delete_child(dev, bdev); 167 } 168 /* during module unload there are lots of children leftover */ 169 device_delete_all_children(dev); 170 171 /* 172 * Put the controller into reset, then disable clocks and do 173 * the MI tear down. We have to disable the clocks/hardware 174 * after we do the rest of the teardown. We also disable the 175 * clocks in the opposite order we acquire them, but that 176 * doesn't seem to be absolutely necessary. We free up the 177 * clocks after we disable them, so the system could, in 178 * theory, reuse them. 179 */ 180 bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl, 181 OHCI_CONTROL, 0); 182 183 at91_pmc_clock_disable(sc->fclk); 184 at91_pmc_clock_disable(sc->iclk); 185 at91_pmc_clock_deref(sc->fclk); 186 at91_pmc_clock_deref(sc->iclk); 187 188 if (sc->sc_ohci.sc_irq_res && sc->sc_ohci.sc_intr_hdl) { 189 /* 190 * only call ohci_detach() after ohci_init() 191 */ 192 ohci_detach(&sc->sc_ohci); 193 194 err = bus_teardown_intr(dev, sc->sc_ohci.sc_irq_res, sc->sc_ohci.sc_intr_hdl); 195 sc->sc_ohci.sc_intr_hdl = NULL; 196 } 197 if (sc->sc_ohci.sc_irq_res) { 198 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_ohci.sc_irq_res); 199 sc->sc_ohci.sc_irq_res = NULL; 200 } 201 if (sc->sc_ohci.sc_io_res) { 202 bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID, 203 sc->sc_ohci.sc_io_res); 204 sc->sc_ohci.sc_io_res = NULL; 205 } 206 usb2_config_td_unsetup(&sc->sc_ohci.sc_config_td); 207 208 usb2_bus_mem_free_all(&sc->sc_ohci.sc_bus, &ohci_iterate_hw_softc); 209 210 return (0); 211} 212 213static device_method_t ohci_methods[] = { 214 /* Device interface */ 215 DEVMETHOD(device_probe, ohci_atmelarm_probe), 216 DEVMETHOD(device_attach, ohci_atmelarm_attach), 217 DEVMETHOD(device_detach, ohci_atmelarm_detach), 218 DEVMETHOD(device_shutdown, bus_generic_shutdown), 219 220 /* Bus interface */ 221 DEVMETHOD(bus_print_child, bus_generic_print_child), 222 223 {0, 0} 224}; 225 226static driver_t ohci_driver = { 227 "ohci", 228 ohci_methods, 229 sizeof(struct at91_ohci_softc), 230}; 231 232static devclass_t ohci_devclass; 233 234DRIVER_MODULE(ohci, atmelarm, ohci_driver, ohci_devclass, 0, 0); 235MODULE_DEPEND(ohci, usb2_controller, 1, 1, 1); 236MODULE_DEPEND(ohci, usb2_core, 1, 1, 1); 237