omap/omap_drm.h

   1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
   2
   3 /*
   4  * Copyright (C) 2011 Texas Instruments, Inc
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors:
  26  *    Rob Clark <rob@ti.com>
  27  */
  28
  29 #ifndef __OMAP_DRM_H__
  30 #define __OMAP_DRM_H__
  31
  32 #include "drm.h"
  33
  34 /* Please note that modifications to all structs defined here are
  35  * subject to backwards-compatibility constraints.
  36  */
  37
  38 #define OMAP_PARAM_CHIPSET_ID   1       /* ie. 0x3430, 0x4430, etc */
  39
  40 struct drm_omap_param {
  41         uint64_t param;                 /* in */
  42         uint64_t value;                 /* in (set_param), out (get_param) */
  43 };
  44
  45 struct drm_omap_get_base {
  46         char plugin_name[64];           /* in */
  47         uint32_t ioctl_base;            /* out */
  48         uint32_t __pad;
  49 };
  50
  51 #define OMAP_BO_SCANOUT         0x00000001      /* scanout capable (phys contiguous) */
  52 #define OMAP_BO_CACHE_MASK      0x00000006      /* cache type mask, see cache modes */
  53 #define OMAP_BO_TILED_MASK      0x00000f00      /* tiled mapping mask, see tiled modes */
  54
  55 /* cache modes */
  56 #define OMAP_BO_CACHED          0x00000000      /* default */
  57 #define OMAP_BO_WC              0x00000002      /* write-combine */
  58 #define OMAP_BO_UNCACHED        0x00000004      /* strongly-ordered (uncached) */
  59
  60 /* tiled modes */
  61 #define OMAP_BO_TILED_8         0x00000100
  62 #define OMAP_BO_TILED_16        0x00000200
  63 #define OMAP_BO_TILED_32        0x00000300
  64 #define OMAP_BO_TILED           (OMAP_BO_TILED_8 | OMAP_BO_TILED_16 | OMAP_BO_TILED_32)
  65
  66 union omap_gem_size {
  67         uint32_t bytes;         /* (for non-tiled formats) */
  68         struct {
  69                 uint16_t width;
  70                 uint16_t height;
  71         } tiled;                /* (for tiled formats) */
  72 };
  73
  74 struct drm_omap_gem_new {
  75         union omap_gem_size size;       /* in */
  76         uint32_t flags;                 /* in */
  77         uint32_t handle;                /* out */
  78         uint32_t __pad;
  79 };
  80
  81 /* mask of operations: */
  82 enum omap_gem_op {
  83         OMAP_GEM_READ = 0x01,
  84         OMAP_GEM_WRITE = 0x02,
  85 };
  86
  87 struct drm_omap_gem_cpu_prep {
  88         uint32_t handle;                /* buffer handle (in) */
  89         uint32_t op;                    /* mask of omap_gem_op (in) */
  90 };
  91
  92 struct drm_omap_gem_cpu_fini {
  93         uint32_t handle;                /* buffer handle (in) */
  94         uint32_t op;                    /* mask of omap_gem_op (in) */
  95         /* TODO maybe here we pass down info about what regions are touched
  96          * by sw so we can be clever about cache ops?  For now a placeholder,
  97          * set to zero and we just do full buffer flush..
  98          */
  99         uint32_t nregions;
 100         uint32_t __pad;
 101 };
 102
 103 struct drm_omap_gem_info {
 104         uint32_t handle;                /* buffer handle (in) */
 105         uint32_t pad;
 106         uint64_t offset;                /* mmap offset (out) */
 107         /* note: in case of tiled buffers, the user virtual size can be
 108          * different from the physical size (ie. how many pages are needed
 109          * to back the object) which is returned in DRM_IOCTL_GEM_OPEN..
 110          * This size here is the one that should be used if you want to
 111          * mmap() the buffer:
 112          */
 113         uint32_t size;                  /* virtual size for mmap'ing (out) */
 114         uint32_t __pad;
 115 };
 116
 117 #define DRM_OMAP_GET_PARAM              0x00
 118 #define DRM_OMAP_SET_PARAM              0x01
 119 #define DRM_OMAP_GET_BASE               0x02
 120 #define DRM_OMAP_GEM_NEW                0x03
 121 #define DRM_OMAP_GEM_CPU_PREP           0x04
 122 #define DRM_OMAP_GEM_CPU_FINI           0x05
 123 #define DRM_OMAP_GEM_INFO               0x06
 124 #define DRM_OMAP_NUM_IOCTLS             0x07
 125
 126 #define DRM_IOCTL_OMAP_GET_PARAM        DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GET_PARAM, struct drm_omap_param)
 127 #define DRM_IOCTL_OMAP_SET_PARAM        DRM_IOW (DRM_COMMAND_BASE + DRM_OMAP_SET_PARAM, struct drm_omap_param)
 128 #define DRM_IOCTL_OMAP_GET_BASE         DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GET_BASE, struct drm_omap_get_base)
 129 #define DRM_IOCTL_OMAP_GEM_NEW          DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GEM_NEW, struct drm_omap_gem_new)
 130 #define DRM_IOCTL_OMAP_GEM_CPU_PREP     DRM_IOW (DRM_COMMAND_BASE + DRM_OMAP_GEM_CPU_PREP, struct drm_omap_gem_cpu_prep)
 131 #define DRM_IOCTL_OMAP_GEM_CPU_FINI     DRM_IOW (DRM_COMMAND_BASE + DRM_OMAP_GEM_CPU_FINI, struct drm_omap_gem_cpu_fini)
 132 #define DRM_IOCTL_OMAP_GEM_INFO         DRM_IOWR(DRM_COMMAND_BASE + DRM_OMAP_GEM_INFO, struct drm_omap_gem_info)
 133
 134 #endif /* __OMAP_DRM_H__ */