sys/dev/terasic/mtl/terasic_mtl_fdt.c

   1 /*-
   2  * Copyright (c) 2012-2013 Robert N. M. Watson
   3  * All rights reserved.
   4  *
   5  * This software was developed by SRI International and the University of
   6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
   7  * ("CTSRD"), as part of the DARPA CRASH research programme.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35 #include <sys/bus.h>
  36 #include <sys/condvar.h>
  37 #include <sys/conf.h>
  38 #include <sys/consio.h>                         /* struct vt_mode */
  39 #include <sys/fbio.h>                           /* video_adapter_t */
  40 #include <sys/kernel.h>
  41 #include <sys/lock.h>
  42 #include <sys/malloc.h>
  43 #include <sys/module.h>
  44 #include <sys/mutex.h>
  45 #include <sys/rman.h>
  46 #include <sys/systm.h>
  47
  48 #include <machine/bus.h>
  49 #include <machine/resource.h>
  50
  51 #include <dev/fdt/fdt_common.h>
  52 #include <dev/ofw/openfirm.h>
  53 #include <dev/ofw/ofw_bus.h>
  54 #include <dev/ofw/ofw_bus_subr.h>
  55
  56 #include <dev/terasic/mtl/terasic_mtl.h>
  57
  58 #include "fb_if.h"
  59
  60 static int
  61 terasic_mtl_fdt_probe(device_t dev)
  62 {
  63
  64         if (!ofw_bus_status_okay(dev))
  65                 return (ENXIO);
  66
  67         if (ofw_bus_is_compatible(dev, "sri-cambridge,mtl")) {
  68                 device_set_desc(dev, "Terasic Multi-touch LCD (MTL)");
  69                 return (BUS_PROBE_DEFAULT);
  70         }
  71         return (ENXIO);
  72 }
  73
  74 static int
  75 terasic_mtl_fdt_attach(device_t dev)
  76 {
  77         struct terasic_mtl_softc *sc;
  78         int error;
  79
  80         sc = device_get_softc(dev);
  81         sc->mtl_dev = dev;
  82         sc->mtl_unit = device_get_unit(dev);
  83
  84         /*
  85          * FDT allows multiple memory resources to be defined for a device;
  86          * query them in the order registers, pixel buffer, text buffer.
  87          * However, we need to sanity-check that they are page-aligned and
  88          * page-sized, so we may still abort.
  89          */
  90         sc->mtl_reg_rid = 0;
  91         sc->mtl_reg_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
  92             &sc->mtl_reg_rid, RF_ACTIVE);
  93         if (sc->mtl_reg_res == NULL) {
  94                 device_printf(dev, "couldn't map register memory\n");
  95                 error = ENXIO;
  96                 goto error;
  97         }
  98         if (rman_get_start(sc->mtl_reg_res) % PAGE_SIZE != 0) {
  99                 device_printf(dev, "improper register address\n");
 100                 error = ENXIO;
 101                 goto error;
 102         }
 103         if (rman_get_size(sc->mtl_reg_res) % PAGE_SIZE != 0) {
 104                 device_printf(dev, "improper register size\n");
 105                 error = ENXIO;
 106                 goto error;
 107         }
 108         device_printf(sc->mtl_dev, "registers at mem %p-%p\n",
 109             (void *)rman_get_start(sc->mtl_reg_res),
 110             (void *)(rman_get_start(sc->mtl_reg_res) +
 111               rman_get_size(sc->mtl_reg_res)));
 112
 113         sc->mtl_pixel_rid = 1;
 114         sc->mtl_pixel_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
 115             &sc->mtl_pixel_rid, RF_ACTIVE);
 116         if (sc->mtl_pixel_res == NULL) {
 117                 device_printf(dev, "couldn't map pixel memory\n");
 118                 error = ENXIO;
 119                 goto error;
 120         }
 121         if (rman_get_start(sc->mtl_pixel_res) % PAGE_SIZE != 0) {
 122                 device_printf(dev, "improper pixel address\n");
 123                 error = ENXIO;
 124                 goto error;
 125         }
 126         if (rman_get_size(sc->mtl_pixel_res) % PAGE_SIZE != 0) {
 127                 device_printf(dev, "improper pixel size\n");
 128                 error = ENXIO;
 129                 goto error;
 130         }
 131         device_printf(sc->mtl_dev, "pixel frame buffer at mem %p-%p\n",
 132             (void *)rman_get_start(sc->mtl_pixel_res),
 133             (void *)(rman_get_start(sc->mtl_pixel_res) +
 134               rman_get_size(sc->mtl_pixel_res)));
 135
 136         sc->mtl_text_rid = 2;
 137         sc->mtl_text_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
 138             &sc->mtl_text_rid, RF_ACTIVE);
 139         if (sc->mtl_text_res == NULL) {
 140                 device_printf(dev, "couldn't map text memory\n");
 141                 error = ENXIO;
 142                 goto error;
 143         }
 144         if (rman_get_start(sc->mtl_text_res) % PAGE_SIZE != 0) {
 145                 device_printf(dev, "improper text address\n");
 146                 error = ENXIO;
 147                 goto error;
 148         }
 149         if (rman_get_size(sc->mtl_text_res) % PAGE_SIZE != 0) {
 150                 device_printf(dev, "improper text size\n");
 151                 error = ENXIO;
 152                 goto error;
 153         }
 154         device_printf(sc->mtl_dev, "text frame buffer at mem %p-%p\n",
 155             (void *)rman_get_start(sc->mtl_text_res),
 156             (void *)(rman_get_start(sc->mtl_text_res) +
 157               rman_get_size(sc->mtl_text_res)));
 158
 159         error = terasic_mtl_attach(sc);
 160         if (error == 0)
 161                 return (0);
 162 error:
 163         if (sc->mtl_text_res != NULL)
 164                 bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_text_rid,
 165                     sc->mtl_text_res);
 166         if (sc->mtl_pixel_res != NULL)
 167                 bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_pixel_rid,
 168                     sc->mtl_pixel_res);
 169         if (sc->mtl_reg_res != NULL)
 170                 bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_reg_rid,
 171                     sc->mtl_reg_res);
 172         return (error);
 173 }
 174
 175 static int
 176 terasic_mtl_fdt_detach(device_t dev)
 177 {
 178         struct terasic_mtl_softc *sc;
 179
 180         sc = device_get_softc(dev);
 181         terasic_mtl_detach(sc);
 182         bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_text_rid,
 183             sc->mtl_text_res);
 184         bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_pixel_rid,
 185             sc->mtl_pixel_res);
 186         bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_reg_rid,
 187             sc->mtl_reg_res);
 188         return (0);
 189 }
 190
 191 static struct fb_info *
 192 terasic_mtl_fb_getinfo(device_t dev)
 193 {
 194         struct terasic_mtl_softc *sc;
 195
 196         sc = device_get_softc(dev);
 197         return (&sc->mtl_fb_info);
 198 }
 199
 200 static device_method_t terasic_mtl_fdt_methods[] = {
 201         DEVMETHOD(device_probe,         terasic_mtl_fdt_probe),
 202         DEVMETHOD(device_attach,        terasic_mtl_fdt_attach),
 203         DEVMETHOD(device_detach,        terasic_mtl_fdt_detach),
 204         DEVMETHOD(fb_getinfo,           terasic_mtl_fb_getinfo),
 205         { 0, 0 }
 206 };
 207
 208 static driver_t terasic_mtl_fdt_driver = {
 209         "terasic_mtl",
 210         terasic_mtl_fdt_methods,
 211         sizeof(struct terasic_mtl_softc),
 212 };
 213
 214 DRIVER_MODULE(mtl, simplebus, terasic_mtl_fdt_driver, terasic_mtl_devclass, 0,
 215     0);