sys/dev/usb/controller/ohci_atmelarm.c

   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$");
  27
  28 #include <sys/stdint.h>
  29 #include <sys/stddef.h>
  30 #include <sys/param.h>
  31 #include <sys/queue.h>
  32 #include <sys/types.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/bus.h>
  36 #include <sys/module.h>
  37 #include <sys/lock.h>
  38 #include <sys/mutex.h>
  39 #include <sys/condvar.h>
  40 #include <sys/sysctl.h>
  41 #include <sys/sx.h>
  42 #include <sys/unistd.h>
  43 #include <sys/callout.h>
  44 #include <sys/malloc.h>
  45 #include <sys/priv.h>
  46
  47 #include <dev/usb/usb.h>
  48 #include <dev/usb/usbdi.h>
  49
  50 #include <dev/usb/usb_core.h>
  51 #include <dev/usb/usb_busdma.h>
  52 #include <dev/usb/usb_process.h>
  53 #include <dev/usb/usb_util.h>
  54
  55 #include <dev/usb/usb_controller.h>
  56 #include <dev/usb/usb_bus.h>
  57 #include <dev/usb/controller/ohci.h>
  58 #include <dev/usb/controller/ohcireg.h>
  59
  60 #include <sys/rman.h>
  61
  62 #include <arm/at91/at91_pmcvar.h>
  63
  64 #define MEM_RID 0
  65
  66 static device_probe_t ohci_atmelarm_probe;
  67 static device_attach_t ohci_atmelarm_attach;
  68 static device_detach_t ohci_atmelarm_detach;
  69
  70 struct at91_ohci_softc {
  71         struct ohci_softc sc_ohci;      /* must be first */
  72         struct at91_pmc_clock *mclk;
  73         struct at91_pmc_clock *iclk;
  74         struct at91_pmc_clock *fclk;
  75 };
  76
  77 static int
  78 ohci_atmelarm_probe(device_t dev)
  79 {
  80
  81         device_set_desc(dev, "AT91 integrated OHCI controller");
  82         return (BUS_PROBE_DEFAULT);
  83 }
  84
  85 static int
  86 ohci_atmelarm_attach(device_t dev)
  87 {
  88         struct at91_ohci_softc *sc = device_get_softc(dev);
  89         int err;
  90         int rid;
  91
  92         /* initialise some bus fields */
  93         sc->sc_ohci.sc_bus.parent = dev;
  94         sc->sc_ohci.sc_bus.devices = sc->sc_ohci.sc_devices;
  95         sc->sc_ohci.sc_bus.devices_max = OHCI_MAX_DEVICES;
  96
  97         /* get all DMA memory */
  98         if (usb_bus_mem_alloc_all(&sc->sc_ohci.sc_bus,
  99             USB_GET_DMA_TAG(dev), &ohci_iterate_hw_softc)) {
 100                 return (ENOMEM);
 101         }
 102         sc->mclk = at91_pmc_clock_ref("mck");
 103         sc->iclk = at91_pmc_clock_ref("ohci_clk");
 104         sc->fclk = at91_pmc_clock_ref("uhpck");
 105
 106         sc->sc_ohci.sc_dev = dev;
 107
 108         rid = MEM_RID;
 109         sc->sc_ohci.sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
 110             &rid, RF_ACTIVE);
 111
 112         if (!(sc->sc_ohci.sc_io_res)) {
 113                 err = ENOMEM;
 114                 goto error;
 115         }
 116         sc->sc_ohci.sc_io_tag = rman_get_bustag(sc->sc_ohci.sc_io_res);
 117         sc->sc_ohci.sc_io_hdl = rman_get_bushandle(sc->sc_ohci.sc_io_res);
 118         sc->sc_ohci.sc_io_size = rman_get_size(sc->sc_ohci.sc_io_res);
 119
 120         rid = 0;
 121         sc->sc_ohci.sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 122             RF_ACTIVE);
 123         if (!(sc->sc_ohci.sc_irq_res)) {
 124                 goto error;
 125         }
 126         sc->sc_ohci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 127         if (!(sc->sc_ohci.sc_bus.bdev)) {
 128                 goto error;
 129         }
 130         device_set_ivars(sc->sc_ohci.sc_bus.bdev, &sc->sc_ohci.sc_bus);
 131
 132         strlcpy(sc->sc_ohci.sc_vendor, "Atmel", sizeof(sc->sc_ohci.sc_vendor));
 133
 134 #if (__FreeBSD_version >= 700031)
 135         err = bus_setup_intr(dev, sc->sc_ohci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 136             NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_ohci.sc_intr_hdl);
 137 #else
 138         err = bus_setup_intr(dev, sc->sc_ohci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 139             (driver_intr_t *)ohci_interrupt, sc, &sc->sc_ohci.sc_intr_hdl);
 140 #endif
 141         if (err) {
 142                 sc->sc_ohci.sc_intr_hdl = NULL;
 143                 goto error;
 144         }
 145         /*
 146          * turn on the clocks from the AT91's point of view.  Keep the unit in reset.
 147          */
 148         at91_pmc_clock_enable(sc->mclk);
 149         at91_pmc_clock_enable(sc->iclk);
 150         at91_pmc_clock_enable(sc->fclk);
 151         bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl,
 152             OHCI_CONTROL, 0);
 153
 154         err = ohci_init(&sc->sc_ohci);
 155         if (!err) {
 156                 err = device_probe_and_attach(sc->sc_ohci.sc_bus.bdev);
 157         }
 158         if (err) {
 159                 goto error;
 160         }
 161         return (0);
 162
 163 error:
 164         ohci_atmelarm_detach(dev);
 165         return (ENXIO);
 166 }
 167
 168 static int
 169 ohci_atmelarm_detach(device_t dev)
 170 {
 171         struct at91_ohci_softc *sc = device_get_softc(dev);
 172         device_t bdev;
 173         int err;
 174
 175         if (sc->sc_ohci.sc_bus.bdev) {
 176                 bdev = sc->sc_ohci.sc_bus.bdev;
 177                 device_detach(bdev);
 178                 device_delete_child(dev, bdev);
 179         }
 180         /* during module unload there are lots of children leftover */
 181         device_delete_children(dev);
 182
 183         /*
 184          * Put the controller into reset, then disable clocks and do
 185          * the MI tear down.  We have to disable the clocks/hardware
 186          * after we do the rest of the teardown.  We also disable the
 187          * clocks in the opposite order we acquire them, but that
 188          * doesn't seem to be absolutely necessary.  We free up the
 189          * clocks after we disable them, so the system could, in
 190          * theory, reuse them.
 191          */
 192         bus_space_write_4(sc->sc_ohci.sc_io_tag, sc->sc_ohci.sc_io_hdl,
 193             OHCI_CONTROL, 0);
 194
 195         at91_pmc_clock_disable(sc->fclk);
 196         at91_pmc_clock_disable(sc->iclk);
 197         at91_pmc_clock_disable(sc->mclk);
 198         at91_pmc_clock_deref(sc->fclk);
 199         at91_pmc_clock_deref(sc->iclk);
 200         at91_pmc_clock_deref(sc->mclk);
 201
 202         if (sc->sc_ohci.sc_irq_res && sc->sc_ohci.sc_intr_hdl) {
 203                 /*
 204                  * only call ohci_detach() after ohci_init()
 205                  */
 206                 ohci_detach(&sc->sc_ohci);
 207
 208                 err = bus_teardown_intr(dev, sc->sc_ohci.sc_irq_res, sc->sc_ohci.sc_intr_hdl);
 209                 sc->sc_ohci.sc_intr_hdl = NULL;
 210         }
 211         if (sc->sc_ohci.sc_irq_res) {
 212                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_ohci.sc_irq_res);
 213                 sc->sc_ohci.sc_irq_res = NULL;
 214         }
 215         if (sc->sc_ohci.sc_io_res) {
 216                 bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID,
 217                     sc->sc_ohci.sc_io_res);
 218                 sc->sc_ohci.sc_io_res = NULL;
 219         }
 220         usb_bus_mem_free_all(&sc->sc_ohci.sc_bus, &ohci_iterate_hw_softc);
 221
 222         return (0);
 223 }
 224
 225 static device_method_t ohci_methods[] = {
 226         /* Device interface */
 227         DEVMETHOD(device_probe, ohci_atmelarm_probe),
 228         DEVMETHOD(device_attach, ohci_atmelarm_attach),
 229         DEVMETHOD(device_detach, ohci_atmelarm_detach),
 230         DEVMETHOD(device_suspend, bus_generic_suspend),
 231         DEVMETHOD(device_resume, bus_generic_resume),
 232         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 233
 234         DEVMETHOD_END
 235 };
 236
 237 static driver_t ohci_driver = {
 238         .name = "ohci",
 239         .methods = ohci_methods,
 240         .size = sizeof(struct at91_ohci_softc),
 241 };
 242
 243 static devclass_t ohci_devclass;
 244
 245 DRIVER_MODULE(ohci, atmelarm, ohci_driver, ohci_devclass, 0, 0);
 246 MODULE_DEPEND(ohci, usb, 1, 1, 1);