drv.h

   1 /*
   2  * Copyright 2016 The Chromium OS Authors. All rights reserved.
   3  * Use of this source code is governed by a BSD-style license that can be
   4  * found in the LICENSE file.
   5  */
   6
   7 #ifndef DRV_H_
   8 #define DRV_H_
   9
  10 #ifdef __cplusplus
  11 extern "C" {
  12 #endif
  13
  14 #include <drm_fourcc.h>
  15 #include <stdint.h>
  16
  17 #define DRV_MAX_PLANES 4
  18
  19 // clang-format off
  20 /* Use flags */
  21 #define BO_USE_NONE                     0
  22 #define BO_USE_SCANOUT                  (1ull << 0)
  23 #define BO_USE_CURSOR                   (1ull << 1)
  24 #define BO_USE_CURSOR_64X64             BO_USE_CURSOR
  25 #define BO_USE_RENDERING                (1ull << 2)
  26 /* Skip for GBM_BO_USE_WRITE */
  27 #define BO_USE_LINEAR                   (1ull << 4)
  28 #define BO_USE_TEXTURE                  (1ull << 5)
  29 #define BO_USE_CAMERA_WRITE             (1ull << 6)
  30 #define BO_USE_CAMERA_READ              (1ull << 7)
  31 #define BO_USE_PROTECTED                (1ull << 8)
  32 #define BO_USE_SW_READ_OFTEN            (1ull << 9)
  33 #define BO_USE_SW_READ_RARELY           (1ull << 10)
  34 #define BO_USE_SW_WRITE_OFTEN           (1ull << 11)
  35 #define BO_USE_SW_WRITE_RARELY          (1ull << 12)
  36 #define BO_USE_HW_VIDEO_ENCODER         (1ull << 13)
  37 #define BO_USE_HW_VIDEO_DECODER         (1ull << 14)
  38 #define BO_USE_RENDERSCRIPT             (1ull << 15)
  39
  40
  41 /* Map flags */
  42 #define BO_MAP_NONE 0
  43 #define BO_MAP_READ (1 << 0)
  44 #define BO_MAP_WRITE (1 << 1)
  45 #define BO_MAP_READ_WRITE (BO_MAP_READ | BO_MAP_WRITE)
  46
  47 /* This is our extension to <drm_fourcc.h>.  We need to make sure we don't step
  48  * on the namespace of already defined formats, which can be done by using invalid
  49  * fourcc codes.
  50  */
  51
  52 #define DRM_FORMAT_NONE                         fourcc_code('0', '0', '0', '0')
  53 #define DRM_FORMAT_YVU420_ANDROID               fourcc_code('9', '9', '9', '7')
  54 #define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED  fourcc_code('9', '9', '9', '8')
  55 #define DRM_FORMAT_FLEX_YCbCr_420_888           fourcc_code('9', '9', '9', '9')
  56
  57 // TODO(crbug.com/958181): remove this definition once drm_fourcc.h contains it.
  58 #ifndef DRM_FORMAT_P010
  59 #define DRM_FORMAT_P010 fourcc_code('P', '0', '1', '0')
  60 #endif
  61
  62 // clang-format on
  63 struct driver;
  64 struct bo;
  65 struct combination;
  66
  67 union bo_handle {
  68         void *ptr;
  69         int32_t s32;
  70         uint32_t u32;
  71         int64_t s64;
  72         uint64_t u64;
  73 };
  74
  75 struct drv_import_fd_data {
  76         int fds[DRV_MAX_PLANES];
  77         uint32_t strides[DRV_MAX_PLANES];
  78         uint32_t offsets[DRV_MAX_PLANES];
  79         uint64_t format_modifiers[DRV_MAX_PLANES];
  80         uint32_t width;
  81         uint32_t height;
  82         uint32_t format;
  83         uint64_t use_flags;
  84 };
  85
  86 struct vma {
  87         void *addr;
  88         size_t length;
  89         uint32_t handle;
  90         uint32_t map_flags;
  91         int32_t refcount;
  92         uint32_t map_strides[DRV_MAX_PLANES];
  93         void *priv;
  94 };
  95
  96 struct rectangle {
  97         uint32_t x;
  98         uint32_t y;
  99         uint32_t width;
 100         uint32_t height;
 101 };
 102
 103 struct mapping {
 104         struct vma *vma;
 105         struct rectangle rect;
 106         uint32_t refcount;
 107 };
 108
 109 struct driver *drv_create(int fd);
 110
 111 void drv_destroy(struct driver *drv);
 112
 113 int drv_get_fd(struct driver *drv);
 114
 115 const char *drv_get_name(struct driver *drv);
 116
 117 struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t use_flags);
 118
 119 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
 120                       uint64_t use_flags);
 121
 122 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
 123                          uint64_t use_flags);
 124
 125 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height,
 126                                         uint32_t format, const uint64_t *modifiers, uint32_t count);
 127
 128 void drv_bo_destroy(struct bo *bo);
 129
 130 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);
 131
 132 void *drv_bo_map(struct bo *bo, const struct rectangle *rect, uint32_t map_flags,
 133                  struct mapping **map_data, size_t plane);
 134
 135 int drv_bo_unmap(struct bo *bo, struct mapping *mapping);
 136
 137 int drv_bo_invalidate(struct bo *bo, struct mapping *mapping);
 138
 139 int drv_bo_flush_or_unmap(struct bo *bo, struct mapping *mapping);
 140
 141 uint32_t drv_bo_get_width(struct bo *bo);
 142
 143 uint32_t drv_bo_get_height(struct bo *bo);
 144
 145 uint32_t drv_bo_get_stride_or_tiling(struct bo *bo);
 146
 147 size_t drv_bo_get_num_planes(struct bo *bo);
 148
 149 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane);
 150
 151 int drv_bo_get_plane_fd(struct bo *bo, size_t plane);
 152
 153 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane);
 154
 155 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane);
 156
 157 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane);
 158
 159 uint64_t drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);
 160
 161 uint32_t drv_bo_get_format(struct bo *bo);
 162
 163 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane);
 164
 165 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);
 166
 167 uint32_t drv_resolve_format(struct driver *drv, uint32_t format, uint64_t use_flags);
 168
 169 size_t drv_num_planes_from_format(uint32_t format);
 170
 171 uint32_t drv_num_buffers_per_bo(struct bo *bo);
 172
 173 #define drv_log(format, ...)                                                                       \
 174         do {                                                                                       \
 175                 drv_log_prefix("minigbm", __FILE__, __LINE__, format, ##__VA_ARGS__);              \
 176         } while (0)
 177
 178 __attribute__((format(printf, 4, 5))) void drv_log_prefix(const char *prefix, const char *file,
 179                                                           int line, const char *format, ...);
 180
 181 #ifdef __cplusplus
 182 }
 183 #endif
 184
 185 #endif