sys/dev/terasic/mtl/terasic_mtl_reg.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2012 Robert N. M. Watson
   5  * All rights reserved.
   6  *
   7  * This software was developed by SRI International and the University of
   8  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
   9  * ("CTSRD"), as part of the DARPA CRASH research programme.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #include <sys/param.h>
  37 #include <sys/bus.h>
  38 #include <sys/conf.h>
  39 #include <sys/consio.h>                         /* struct vt_mode */
  40 #include <sys/endian.h>
  41 #include <sys/fbio.h>                           /* video_adapter_t */
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/rman.h>
  45 #include <sys/systm.h>
  46 #include <sys/uio.h>
  47
  48 #include <machine/bus.h>
  49 #include <machine/resource.h>
  50 #include <machine/vm.h>
  51
  52 #include <dev/terasic/mtl/terasic_mtl.h>
  53
  54 static d_mmap_t terasic_mtl_reg_mmap;
  55 static d_read_t terasic_mtl_reg_read;
  56 static d_write_t terasic_mtl_reg_write;
  57
  58 static struct cdevsw terasic_mtl_reg_cdevsw = {
  59         .d_version =    D_VERSION,
  60         .d_mmap =       terasic_mtl_reg_mmap,
  61         .d_read =       terasic_mtl_reg_read,
  62         .d_write =      terasic_mtl_reg_write,
  63         .d_name =       "terasic_mtl_reg",
  64 };
  65
  66 /*
  67  * All I/O to/from the MTL register device must be 32-bit, and aligned to
  68  * 32-bit.
  69  */
  70 static int
  71 terasic_mtl_reg_read(struct cdev *dev, struct uio *uio, int flag)
  72 {
  73         struct terasic_mtl_softc *sc;
  74         u_long offset, size;
  75         uint32_t v;
  76         int error;
  77
  78         if (uio->uio_offset < 0 || uio->uio_offset % 4 != 0 ||
  79             uio->uio_resid % 4 != 0)
  80                 return (ENODEV);
  81         sc = dev->si_drv1;
  82         size = rman_get_size(sc->mtl_reg_res);
  83         error = 0;
  84         if ((uio->uio_offset + uio->uio_resid < 0) ||
  85             (uio->uio_offset + uio->uio_resid > size))
  86                 return (ENODEV);
  87         while (uio->uio_resid > 0) {
  88                 offset = uio->uio_offset;
  89                 if (offset + sizeof(v) > size)
  90                         return (ENODEV);
  91                 v = bus_read_4(sc->mtl_reg_res, offset);
  92                 error = uiomove(&v, sizeof(v), uio);
  93                 if (error)
  94                         return (error);
  95         }
  96         return (error);
  97 }
  98
  99 static int
 100 terasic_mtl_reg_write(struct cdev *dev, struct uio *uio, int flag)
 101 {
 102         struct terasic_mtl_softc *sc;
 103         u_long offset, size;
 104         uint32_t v;
 105         int error;
 106
 107         if (uio->uio_offset < 0 || uio->uio_offset % 4 != 0 ||
 108             uio->uio_resid % 4 != 0)
 109                 return (ENODEV);
 110         sc = dev->si_drv1;
 111         size = rman_get_size(sc->mtl_reg_res);
 112         error = 0;
 113         while (uio->uio_resid > 0) {
 114                 offset = uio->uio_offset;
 115                 if (offset + sizeof(v) > size)
 116                         return (ENODEV);
 117                 error = uiomove(&v, sizeof(v), uio);
 118                 if (error)
 119                         return (error);
 120                 bus_write_4(sc->mtl_reg_res, offset, v);
 121         }
 122         return (error);
 123 }
 124
 125 static int
 126 terasic_mtl_reg_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
 127     int nprot, vm_memattr_t *memattr)
 128 {
 129         struct terasic_mtl_softc *sc;
 130         int error;
 131
 132         sc = dev->si_drv1;
 133         error = 0;
 134         if (trunc_page(offset) == offset &&
 135             rman_get_size(sc->mtl_reg_res) >= offset + PAGE_SIZE) {
 136                 *paddr = rman_get_start(sc->mtl_reg_res) + offset;
 137                 *memattr = VM_MEMATTR_UNCACHEABLE;
 138         } else
 139                 error = ENODEV;
 140         return (error);
 141 }
 142
 143 void
 144 terasic_mtl_reg_blend_get(struct terasic_mtl_softc *sc, uint32_t *blendp)
 145 {
 146
 147         *blendp = le32toh(bus_read_4(sc->mtl_reg_res, TERASIC_MTL_OFF_BLEND));
 148 }
 149
 150 void
 151 terasic_mtl_reg_blend_set(struct terasic_mtl_softc *sc, uint32_t blend)
 152 {
 153
 154         bus_write_4(sc->mtl_reg_res, TERASIC_MTL_OFF_BLEND, htole32(blend));
 155 }
 156
 157 void
 158 terasic_mtl_blend_default_set(struct terasic_mtl_softc *sc, uint8_t colour)
 159 {
 160         uint32_t v;
 161
 162         TERASIC_MTL_LOCK(sc);
 163         terasic_mtl_reg_blend_get(sc, &v);
 164         v &= ~TERASIC_MTL_BLEND_DEFAULT_MASK;
 165         v |= colour << TERASIC_MTL_BLEND_DEFAULT_SHIFT;
 166         terasic_mtl_reg_blend_set(sc, v);
 167         TERASIC_MTL_UNLOCK(sc);
 168 }
 169
 170 void
 171 terasic_mtl_blend_pixel_set(struct terasic_mtl_softc *sc, uint8_t alpha)
 172 {
 173         uint32_t v;
 174
 175         TERASIC_MTL_LOCK(sc);
 176         terasic_mtl_reg_blend_get(sc, &v);
 177         v &= ~TERASIC_MTL_BLEND_PIXEL_MASK;
 178         v |= alpha << TERASIC_MTL_BLEND_PIXEL_SHIFT;
 179         terasic_mtl_reg_blend_set(sc, v);
 180         TERASIC_MTL_UNLOCK(sc);
 181 }
 182
 183 void
 184 terasic_mtl_blend_textfg_set(struct terasic_mtl_softc *sc, uint8_t alpha)
 185 {
 186         uint32_t v;
 187
 188         TERASIC_MTL_LOCK(sc);
 189         terasic_mtl_reg_blend_get(sc, &v);
 190         v &= ~TERASIC_MTL_BLEND_TEXTFG_MASK;
 191         v |= alpha << TERASIC_MTL_BLEND_TEXTFG_SHIFT;
 192         terasic_mtl_reg_blend_set(sc, v);
 193         TERASIC_MTL_UNLOCK(sc);
 194 }
 195
 196 void
 197 terasic_mtl_blend_textbg_set(struct terasic_mtl_softc *sc, uint8_t alpha)
 198 {
 199         uint32_t v;
 200
 201         TERASIC_MTL_LOCK(sc);
 202         terasic_mtl_reg_blend_get(sc, &v);
 203         v &= ~TERASIC_MTL_BLEND_TEXTBG_MASK;
 204         v |= alpha << TERASIC_MTL_BLEND_TEXTBG_SHIFT;
 205         terasic_mtl_reg_blend_set(sc, v);
 206         TERASIC_MTL_UNLOCK(sc);
 207 }
 208
 209 void
 210 terasic_mtl_reg_pixel_endian_set(struct terasic_mtl_softc *sc, int endian_swap)
 211 {
 212         uint32_t v;
 213
 214         TERASIC_MTL_LOCK(sc);
 215         terasic_mtl_reg_blend_get(sc, &v);
 216         if (endian_swap)
 217                 v |= TERASIC_MTL_BLEND_PIXEL_ENDIAN_SWAP;
 218         else
 219                 v &= ~TERASIC_MTL_BLEND_PIXEL_ENDIAN_SWAP;
 220         terasic_mtl_reg_blend_set(sc, v);
 221         TERASIC_MTL_UNLOCK(sc);
 222 }
 223
 224 void
 225 terasic_mtl_reg_textcursor_get(struct terasic_mtl_softc *sc, uint8_t *colp,
 226     uint8_t *rowp)
 227 {
 228         uint32_t v;
 229
 230         v = bus_read_4(sc->mtl_reg_res, TERASIC_MTL_OFF_TEXTCURSOR);
 231         v = le32toh(v);
 232         *colp = (v & TERASIC_MTL_TEXTCURSOR_COL_MASK) >>
 233             TERASIC_MTL_TEXTCURSOR_COL_SHIFT;
 234         *rowp = (v & TERASIC_MTL_TEXTCURSOR_ROW_MASK);
 235 }
 236
 237 void
 238 terasic_mtl_reg_textcursor_set(struct terasic_mtl_softc *sc, uint8_t col,
 239     uint8_t row)
 240 {
 241         uint32_t v;
 242
 243         v = (col << TERASIC_MTL_TEXTCURSOR_COL_SHIFT) | row;
 244         v = htole32(v);
 245         bus_write_4(sc->mtl_reg_res, TERASIC_MTL_OFF_TEXTCURSOR, v);
 246 }
 247
 248 void
 249 terasic_mtl_reg_blank(struct terasic_mtl_softc *sc)
 250 {
 251
 252         device_printf(sc->mtl_dev, "%s: not yet\n", __func__);
 253 }
 254
 255 void
 256 terasic_mtl_reg_textframebufaddr_get(struct terasic_mtl_softc *sc,
 257     uint32_t *addrp)
 258 {
 259         uint32_t addr;
 260
 261         addr = bus_read_4(sc->mtl_reg_res, TERASIC_MTL_OFF_TEXTFRAMEBUFADDR);
 262         *addrp = le32toh(addr);
 263 }
 264
 265 void
 266 terasic_mtl_reg_textframebufaddr_set(struct terasic_mtl_softc *sc,
 267     uint32_t addr)
 268 {
 269
 270         addr = htole32(addr);
 271         bus_write_4(sc->mtl_reg_res, TERASIC_MTL_OFF_TEXTFRAMEBUFADDR, addr);
 272 }
 273
 274 int
 275 terasic_mtl_reg_attach(struct terasic_mtl_softc *sc)
 276 {
 277
 278         sc->mtl_reg_cdev = make_dev(&terasic_mtl_reg_cdevsw, sc->mtl_unit,
 279             UID_ROOT, GID_WHEEL, 0400, "mtl_reg%d", sc->mtl_unit);
 280         if (sc->mtl_reg_cdev == NULL) {
 281                 device_printf(sc->mtl_dev, "%s: make_dev failed\n", __func__);
 282                 return (ENXIO);
 283         }
 284         /* XXXRW: Slight race between make_dev(9) and here. */
 285         sc->mtl_reg_cdev->si_drv1 = sc;
 286         return (0);
 287 }
 288
 289 void
 290 terasic_mtl_reg_detach(struct terasic_mtl_softc *sc)
 291 {
 292
 293         if (sc->mtl_reg_cdev != NULL)
 294                 destroy_dev(sc->mtl_reg_cdev);
 295 }