src/freedreno/drm/freedreno_drmif.h

   1 /*
   2  * Copyright (C) 2012-2018 Rob Clark <robclark@freedesktop.org>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  *
  23  * Authors:
  24  *    Rob Clark <robclark@freedesktop.org>
  25  */
  26
  27 #ifndef FREEDRENO_DRMIF_H_
  28 #define FREEDRENO_DRMIF_H_
  29
  30 #include <stdint.h>
  31
  32 #include "util/u_debug.h"
  33
  34 struct fd_bo;
  35 struct fd_pipe;
  36 struct fd_device;
  37
  38 enum fd_pipe_id {
  39         FD_PIPE_3D = 1,
  40         FD_PIPE_2D = 2,
  41         /* some devices have two 2d blocks.. not really sure how to
  42          * use that yet, so just ignoring the 2nd 2d pipe for now
  43          */
  44         FD_PIPE_MAX
  45 };
  46
  47 enum fd_param_id {
  48         FD_DEVICE_ID,
  49         FD_GMEM_SIZE,
  50         FD_GPU_ID,
  51         FD_CHIP_ID,
  52         FD_MAX_FREQ,
  53         FD_TIMESTAMP,
  54         FD_NR_RINGS,      /* # of rings == # of distinct priority levels */
  55 };
  56
  57 /* bo flags: */
  58 #define DRM_FREEDRENO_GEM_TYPE_SMI        0x00000001
  59 #define DRM_FREEDRENO_GEM_TYPE_KMEM       0x00000002
  60 #define DRM_FREEDRENO_GEM_TYPE_MEM_MASK   0x0000000f
  61 #define DRM_FREEDRENO_GEM_CACHE_NONE      0x00000000
  62 #define DRM_FREEDRENO_GEM_CACHE_WCOMBINE  0x00100000
  63 #define DRM_FREEDRENO_GEM_CACHE_WTHROUGH  0x00200000
  64 #define DRM_FREEDRENO_GEM_CACHE_WBACK     0x00400000
  65 #define DRM_FREEDRENO_GEM_CACHE_WBACKWA   0x00800000
  66 #define DRM_FREEDRENO_GEM_CACHE_MASK      0x00f00000
  67 #define DRM_FREEDRENO_GEM_GPUREADONLY     0x01000000
  68 #define DRM_FREEDRENO_GEM_SCANOUT         0x02000000
  69
  70 /* bo access flags: (keep aligned to MSM_PREP_x) */
  71 #define DRM_FREEDRENO_PREP_READ           0x01
  72 #define DRM_FREEDRENO_PREP_WRITE          0x02
  73 #define DRM_FREEDRENO_PREP_NOSYNC         0x04
  74
  75 /* device functions:
  76  */
  77
  78 struct fd_device * fd_device_new(int fd);
  79 struct fd_device * fd_device_new_dup(int fd);
  80 struct fd_device * fd_device_ref(struct fd_device *dev);
  81 void fd_device_del(struct fd_device *dev);
  82 int fd_device_fd(struct fd_device *dev);
  83
  84 enum fd_version {
  85         FD_VERSION_MADVISE = 1,            /* kernel supports madvise */
  86         FD_VERSION_UNLIMITED_CMDS = 1,     /* submits w/ >4 cmd buffers (growable ringbuffer) */
  87         FD_VERSION_FENCE_FD = 2,           /* submit command supports in/out fences */
  88         FD_VERSION_SUBMIT_QUEUES = 3,      /* submit queues and multiple priority levels */
  89         FD_VERSION_BO_IOVA = 3,            /* supports fd_bo_get/put_iova() */
  90         FD_VERSION_SOFTPIN = 4,            /* adds softpin, bo name, and dump flag */
  91 };
  92 enum fd_version fd_device_version(struct fd_device *dev);
  93
  94 /* pipe functions:
  95  */
  96
  97 struct fd_pipe * fd_pipe_new(struct fd_device *dev, enum fd_pipe_id id);
  98 struct fd_pipe * fd_pipe_new2(struct fd_device *dev, enum fd_pipe_id id, uint32_t prio);
  99 struct fd_pipe * fd_pipe_ref(struct fd_pipe *pipe);
 100 void fd_pipe_del(struct fd_pipe *pipe);
 101 int fd_pipe_get_param(struct fd_pipe *pipe, enum fd_param_id param,
 102                 uint64_t *value);
 103 int fd_pipe_wait(struct fd_pipe *pipe, uint32_t timestamp);
 104 /* timeout in nanosec */
 105 int fd_pipe_wait_timeout(struct fd_pipe *pipe, uint32_t timestamp,
 106                 uint64_t timeout);
 107
 108
 109 /* buffer-object functions:
 110  */
 111
 112 struct fd_bo * _fd_bo_new(struct fd_device *dev,
 113                 uint32_t size, uint32_t flags);
 114 void _fd_bo_set_name(struct fd_bo *bo, const char *fmt, va_list ap);
 115
 116 static inline void
 117 fd_bo_set_name(struct fd_bo *bo, const char *fmt, ...) _util_printf_format(2, 3);
 118
 119 static inline void
 120 fd_bo_set_name(struct fd_bo *bo, const char *fmt, ...)
 121 {
 122 #ifndef NDEBUG
 123         va_list ap;
 124         va_start(ap, fmt);
 125         _fd_bo_set_name(bo, fmt, ap);
 126         va_end(ap);
 127 #endif
 128 }
 129
 130 static inline struct fd_bo *
 131 fd_bo_new(struct fd_device *dev, uint32_t size, uint32_t flags,
 132                 const char *fmt, ...) _util_printf_format(4, 5);
 133
 134 static inline struct fd_bo *
 135 fd_bo_new(struct fd_device *dev, uint32_t size, uint32_t flags,
 136                 const char *fmt, ...)
 137 {
 138         struct fd_bo *bo = _fd_bo_new(dev, size, flags);
 139 #ifndef NDEBUG
 140         if (fmt) {
 141                 va_list ap;
 142                 va_start(ap, fmt);
 143                 _fd_bo_set_name(bo, fmt, ap);
 144                 va_end(ap);
 145         }
 146 #endif
 147         return bo;
 148 }
 149
 150 struct fd_bo *fd_bo_from_handle(struct fd_device *dev,
 151                 uint32_t handle, uint32_t size);
 152 struct fd_bo * fd_bo_from_name(struct fd_device *dev, uint32_t name);
 153 struct fd_bo * fd_bo_from_dmabuf(struct fd_device *dev, int fd);
 154 uint64_t fd_bo_get_iova(struct fd_bo *bo);
 155 void fd_bo_put_iova(struct fd_bo *bo);
 156 struct fd_bo * fd_bo_ref(struct fd_bo *bo);
 157 void fd_bo_del(struct fd_bo *bo);
 158 int fd_bo_get_name(struct fd_bo *bo, uint32_t *name);
 159 uint32_t fd_bo_handle(struct fd_bo *bo);
 160 int fd_bo_dmabuf(struct fd_bo *bo);
 161 uint32_t fd_bo_size(struct fd_bo *bo);
 162 void * fd_bo_map(struct fd_bo *bo);
 163 int fd_bo_cpu_prep(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op);
 164 void fd_bo_cpu_fini(struct fd_bo *bo);
 165
 166 #endif /* FREEDRENO_DRMIF_H_ */