sys/bus/u4b/controller/at91dci_atmelarm.c

   1 #include <sys/cdefs.h>
   2 __FBSDID("$FreeBSD$");
   3
   4 /*-
   5  * Copyright (c) 2007-2008 Hans Petter Selasky. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/stdint.h>
  30 #include <sys/stddef.h>
  31 #include <sys/param.h>
  32 #include <sys/queue.h>
  33 #include <sys/types.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/bus.h>
  37 #include <sys/module.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #include <sys/condvar.h>
  41 #include <sys/sysctl.h>
  42 #include <sys/sx.h>
  43 #include <sys/unistd.h>
  44 #include <sys/callout.h>
  45 #include <sys/malloc.h>
  46 #include <sys/priv.h>
  47
  48 #include <dev/usb/usb.h>
  49 #include <dev/usb/usbdi.h>
  50
  51 #include <dev/usb/usb_core.h>
  52 #include <dev/usb/usb_busdma.h>
  53 #include <dev/usb/usb_process.h>
  54 #include <dev/usb/usb_util.h>
  55
  56 #include <dev/usb/usb_controller.h>
  57 #include <dev/usb/usb_bus.h>
  58 #include <dev/usb/controller/at91dci.h>
  59
  60 #include <sys/rman.h>
  61
  62 #include <arm/at91/at91_pmcvar.h>
  63 #include <arm/at91/at91rm92reg.h>
  64 #include <arm/at91/at91_pio_rm9200.h>
  65 #include <arm/at91/at91_piovar.h>
  66
  67 #define MEM_RID 0
  68
  69 /* Pin Definitions - do they belong here or somewhere else ? */
  70
  71 #define VBUS_MASK       AT91C_PIO_PB24
  72 #define VBUS_BASE       AT91RM92_PIOB_BASE
  73
  74 #define PULLUP_MASK     AT91C_PIO_PB22
  75 #define PULLUP_BASE     AT91RM92_PIOB_BASE
  76
  77 static device_probe_t at91_udp_probe;
  78 static device_attach_t at91_udp_attach;
  79 static device_detach_t at91_udp_detach;
  80
  81 struct at91_udp_softc {
  82         struct at91dci_softc sc_dci;    /* must be first */
  83         struct at91_pmc_clock *sc_iclk;
  84         struct at91_pmc_clock *sc_fclk;
  85         struct resource *sc_vbus_irq_res;
  86         void   *sc_vbus_intr_hdl;
  87 };
  88
  89 static void
  90 at91_vbus_poll(struct at91_udp_softc *sc)
  91 {
  92         uint32_t temp;
  93         uint8_t vbus_val;
  94
  95         /* XXX temporary clear interrupts here */
  96
  97         temp = at91_pio_gpio_clear_interrupt(VBUS_BASE);
  98
  99         /* just forward it */
 100
 101         vbus_val = at91_pio_gpio_get(VBUS_BASE, VBUS_MASK);
 102         at91dci_vbus_interrupt(&sc->sc_dci, vbus_val);
 103 }
 104
 105 static void
 106 at91_udp_clocks_on(void *arg)
 107 {
 108         struct at91_udp_softc *sc = arg;
 109
 110         at91_pmc_clock_enable(sc->sc_iclk);
 111         at91_pmc_clock_enable(sc->sc_fclk);
 112 }
 113
 114 static void
 115 at91_udp_clocks_off(void *arg)
 116 {
 117         struct at91_udp_softc *sc = arg;
 118
 119         at91_pmc_clock_disable(sc->sc_fclk);
 120         at91_pmc_clock_disable(sc->sc_iclk);
 121 }
 122
 123 static void
 124 at91_udp_pull_up(void *arg)
 125 {
 126         at91_pio_gpio_set(PULLUP_BASE, PULLUP_MASK);
 127 }
 128
 129 static void
 130 at91_udp_pull_down(void *arg)
 131 {
 132         at91_pio_gpio_clear(PULLUP_BASE, PULLUP_MASK);
 133 }
 134
 135 static int
 136 at91_udp_probe(device_t dev)
 137 {
 138         device_set_desc(dev, "AT91 integrated AT91_UDP controller");
 139         return (0);
 140 }
 141
 142 static int
 143 at91_udp_attach(device_t dev)
 144 {
 145         struct at91_udp_softc *sc = device_get_softc(dev);
 146         int err;
 147         int rid;
 148
 149         /* setup AT9100 USB device controller interface softc */
 150
 151         sc->sc_dci.sc_clocks_on = &at91_udp_clocks_on;
 152         sc->sc_dci.sc_clocks_off = &at91_udp_clocks_off;
 153         sc->sc_dci.sc_clocks_arg = sc;
 154         sc->sc_dci.sc_pull_up = &at91_udp_pull_up;
 155         sc->sc_dci.sc_pull_down = &at91_udp_pull_down;
 156         sc->sc_dci.sc_pull_arg = sc;
 157
 158         /* initialise some bus fields */
 159         sc->sc_dci.sc_bus.parent = dev;
 160         sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices;
 161         sc->sc_dci.sc_bus.devices_max = AT91_MAX_DEVICES;
 162
 163         /* get all DMA memory */
 164         if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
 165             USB_GET_DMA_TAG(dev), NULL)) {
 166                 return (ENOMEM);
 167         }
 168         /*
 169          * configure VBUS input pin, enable deglitch and enable
 170          * interrupt :
 171          */
 172         at91_pio_use_gpio(VBUS_BASE, VBUS_MASK);
 173         at91_pio_gpio_input(VBUS_BASE, VBUS_MASK);
 174         at91_pio_gpio_set_deglitch(VBUS_BASE, VBUS_MASK, 1);
 175         at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 1);
 176
 177         /*
 178          * configure PULLUP output pin :
 179          */
 180         at91_pio_use_gpio(PULLUP_BASE, PULLUP_MASK);
 181         at91_pio_gpio_output(PULLUP_BASE, PULLUP_MASK, 0);
 182
 183         at91_udp_pull_down(sc);
 184
 185         /* wait 10ms for pulldown to stabilise */
 186         usb_pause_mtx(NULL, hz / 100);
 187
 188         sc->sc_iclk = at91_pmc_clock_ref("udc_clk");
 189         sc->sc_fclk = at91_pmc_clock_ref("udpck");
 190
 191         rid = MEM_RID;
 192         sc->sc_dci.sc_io_res =
 193             bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 194
 195         if (!(sc->sc_dci.sc_io_res)) {
 196                 err = ENOMEM;
 197                 goto error;
 198         }
 199         sc->sc_dci.sc_io_tag = rman_get_bustag(sc->sc_dci.sc_io_res);
 200         sc->sc_dci.sc_io_hdl = rman_get_bushandle(sc->sc_dci.sc_io_res);
 201         sc->sc_dci.sc_io_size = rman_get_size(sc->sc_dci.sc_io_res);
 202
 203         rid = 0;
 204         sc->sc_dci.sc_irq_res =
 205             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 206         if (!(sc->sc_dci.sc_irq_res)) {
 207                 goto error;
 208         }
 209         rid = 1;
 210         sc->sc_vbus_irq_res =
 211             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 212         if (!(sc->sc_vbus_irq_res)) {
 213                 goto error;
 214         }
 215         sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 216         if (!(sc->sc_dci.sc_bus.bdev)) {
 217                 goto error;
 218         }
 219         device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
 220
 221 #if (__FreeBSD_version >= 700031)
 222         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 223             NULL, (driver_intr_t *)at91dci_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 224 #else
 225         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 226             (driver_intr_t *)at91dci_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 227 #endif
 228         if (err) {
 229                 sc->sc_dci.sc_intr_hdl = NULL;
 230                 goto error;
 231         }
 232 #if (__FreeBSD_version >= 700031)
 233         err = bus_setup_intr(dev, sc->sc_vbus_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 234             NULL, (driver_intr_t *)at91_vbus_poll, sc, &sc->sc_vbus_intr_hdl);
 235 #else
 236         err = bus_setup_intr(dev, sc->sc_vbus_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 237             (driver_intr_t *)at91_vbus_poll, sc, &sc->sc_vbus_intr_hdl);
 238 #endif
 239         if (err) {
 240                 sc->sc_vbus_intr_hdl = NULL;
 241                 goto error;
 242         }
 243         err = at91dci_init(&sc->sc_dci);
 244         if (!err) {
 245                 err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
 246         }
 247         if (err) {
 248                 goto error;
 249         } else {
 250                 /* poll VBUS one time */
 251                 at91_vbus_poll(sc);
 252         }
 253         return (0);
 254
 255 error:
 256         at91_udp_detach(dev);
 257         return (ENXIO);
 258 }
 259
 260 static int
 261 at91_udp_detach(device_t dev)
 262 {
 263         struct at91_udp_softc *sc = device_get_softc(dev);
 264         device_t bdev;
 265         int err;
 266
 267         if (sc->sc_dci.sc_bus.bdev) {
 268                 bdev = sc->sc_dci.sc_bus.bdev;
 269                 device_detach(bdev);
 270                 device_delete_child(dev, bdev);
 271         }
 272         /* during module unload there are lots of children leftover */
 273         device_delete_children(dev);
 274
 275         /* disable Transceiver */
 276         AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_TXVC, AT91_UDP_TXVC_DIS);
 277
 278         /* disable and clear all interrupts */
 279         AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_IDR, 0xFFFFFFFF);
 280         AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_ICR, 0xFFFFFFFF);
 281
 282         /* disable VBUS interrupt */
 283         at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 0);
 284
 285         if (sc->sc_vbus_irq_res && sc->sc_vbus_intr_hdl) {
 286                 err = bus_teardown_intr(dev, sc->sc_vbus_irq_res,
 287                     sc->sc_vbus_intr_hdl);
 288                 sc->sc_vbus_intr_hdl = NULL;
 289         }
 290         if (sc->sc_vbus_irq_res) {
 291                 bus_release_resource(dev, SYS_RES_IRQ, 1,
 292                     sc->sc_vbus_irq_res);
 293                 sc->sc_vbus_irq_res = NULL;
 294         }
 295         if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) {
 296                 /*
 297                  * only call at91_udp_uninit() after at91_udp_init()
 298                  */
 299                 at91dci_uninit(&sc->sc_dci);
 300
 301                 err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res,
 302                     sc->sc_dci.sc_intr_hdl);
 303                 sc->sc_dci.sc_intr_hdl = NULL;
 304         }
 305         if (sc->sc_dci.sc_irq_res) {
 306                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 307                     sc->sc_dci.sc_irq_res);
 308                 sc->sc_dci.sc_irq_res = NULL;
 309         }
 310         if (sc->sc_dci.sc_io_res) {
 311                 bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID,
 312                     sc->sc_dci.sc_io_res);
 313                 sc->sc_dci.sc_io_res = NULL;
 314         }
 315         usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
 316
 317         /* disable clocks */
 318         at91_pmc_clock_disable(sc->sc_iclk);
 319         at91_pmc_clock_disable(sc->sc_fclk);
 320         at91_pmc_clock_deref(sc->sc_fclk);
 321         at91_pmc_clock_deref(sc->sc_iclk);
 322
 323         return (0);
 324 }
 325
 326 static device_method_t at91_udp_methods[] = {
 327         /* Device interface */
 328         DEVMETHOD(device_probe, at91_udp_probe),
 329         DEVMETHOD(device_attach, at91_udp_attach),
 330         DEVMETHOD(device_detach, at91_udp_detach),
 331         DEVMETHOD(device_suspend, bus_generic_suspend),
 332         DEVMETHOD(device_resume, bus_generic_resume),
 333         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 334
 335         DEVMETHOD_END
 336 };
 337
 338 static driver_t at91_udp_driver = {
 339         .name = "at91_udp",
 340         .methods = at91_udp_methods,
 341         .size = sizeof(struct at91_udp_softc),
 342 };
 343
 344 static devclass_t at91_udp_devclass;
 345
 346 DRIVER_MODULE(at91_udp, atmelarm, at91_udp_driver, at91_udp_devclass, 0, 0);