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