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 <stdbool.h> 16 #include <stdint.h> 17 #include <stdlib.h> 18 19 #define DRV_MAX_PLANES 4 20 21 // clang-format off 22 /* Use flags */ 23 #define BO_USE_NONE 0 24 #define BO_USE_SCANOUT (1ull << 0) 25 #define BO_USE_CURSOR (1ull << 1) 26 #define BO_USE_CURSOR_64X64 BO_USE_CURSOR 27 #define BO_USE_RENDERING (1ull << 2) 28 /* Skip for GBM_BO_USE_WRITE */ 29 #define BO_USE_LINEAR (1ull << 4) 30 #define BO_USE_TEXTURE (1ull << 5) 31 #define BO_USE_CAMERA_WRITE (1ull << 6) 32 #define BO_USE_CAMERA_READ (1ull << 7) 33 #define BO_USE_PROTECTED (1ull << 8) 34 #define BO_USE_SW_READ_OFTEN (1ull << 9) 35 #define BO_USE_SW_READ_RARELY (1ull << 10) 36 #define BO_USE_SW_WRITE_OFTEN (1ull << 11) 37 #define BO_USE_SW_WRITE_RARELY (1ull << 12) 38 #define BO_USE_HW_VIDEO_DECODER (1ull << 13) 39 #define BO_USE_HW_VIDEO_ENCODER (1ull << 14) 40 #define BO_USE_TEST_ALLOC (1ull << 15) 41 #define BO_USE_FRONT_RENDERING (1ull << 16) 42 #define BO_USE_RENDERSCRIPT (1ull << 17) 43 #define BO_USE_GPU_DATA_BUFFER (1ull << 18) 44 #define BO_USE_SENSOR_DIRECT_DATA (1ull << 19) 45 46 #define BO_USE_ARC_SCREEN_CAP_PROBED (1ull << 63) 47 48 /* Quirks for allocating a buffer. */ 49 #define BO_QUIRK_NONE 0 50 #define BO_QUIRK_DUMB32BPP (1ull << 0) 51 52 /* Map flags */ 53 #define BO_MAP_NONE 0 54 #define BO_MAP_READ (1 << 0) 55 #define BO_MAP_WRITE (1 << 1) 56 #define BO_MAP_READ_WRITE (BO_MAP_READ | BO_MAP_WRITE) 57 58 /* This is our extension to <drm_fourcc.h>. We need to make sure we don't step 59 * on the namespace of already defined formats, which can be done by using invalid 60 * fourcc codes. 61 */ 62 #define DRM_FORMAT_NONE fourcc_code('0', '0', '0', '0') 63 #define DRM_FORMAT_YVU420_ANDROID fourcc_code('9', '9', '9', '7') 64 #define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED fourcc_code('9', '9', '9', '8') 65 #define DRM_FORMAT_FLEX_YCbCr_420_888 fourcc_code('9', '9', '9', '9') 66 67 #ifndef DRM_FORMAT_DEPTH16 68 #define DRM_FORMAT_DEPTH16 fourcc_code('D', '1', '6', ' ') 69 #define DRM_FORMAT_DEPTH24 fourcc_code('D', '2', '4', 'X') 70 #define DRM_FORMAT_DEPTH24_STENCIL8 fourcc_code('D', '2', '4', 'S') 71 #define DRM_FORMAT_DEPTH32 fourcc_code('D', '3', '2', 'F') 72 #define DRM_FORMAT_DEPTH32_STENCIL8 fourcc_code('D', 'F', 'S', '8') 73 #endif 74 75 /* This is a 10-bit bayer format for private reprocessing on MediaTek ISP. It's 76 * a private RAW format that other DRM drivers will never support and thus 77 * making it not upstreamable (i.e., defined in official DRM headers). */ 78 #define DRM_FORMAT_MTISP_SXYZW10 fourcc_code('M', 'B', '1', '0') 79 80 // TODO(crbug.com/958181): remove this definition once drm_fourcc.h contains it. 81 #ifndef DRM_FORMAT_P010 82 #define DRM_FORMAT_P010 fourcc_code('P', '0', '1', '0') 83 #endif 84 85 //TODO: remove this defination once drm_fourcc.h contains it. 86 #ifndef I915_FORMAT_MOD_Y_TILED_GEN12_RC_CCS 87 #define I915_FORMAT_MOD_Y_TILED_GEN12_RC_CCS fourcc_mod_code(INTEL, 6) 88 #endif 89 90 //TODO: remove this defination once drm_fourcc.h contains it. 91 #ifndef I915_FORMAT_MOD_4_TILED 92 #define I915_FORMAT_MOD_4_TILED fourcc_mod_code(INTEL, 9) 93 #endif 94 95 #ifndef I915_FORMAT_MOD_4_TILED_MTL_RC_CCS 96 //TODO: remove this defination once drm_fourcc.h contains it. 97 /* 98 * Intel color control surfaces (CCS) for display ver 14 render compression. 99 * 100 * The main surface is tile4 and at plane index 0, the CCS is linear and 101 * at index 1. A 64B CCS cache line corresponds to an area of 4x1 tiles in 102 * main surface. In other words, 4 bits in CCS map to a main surface cache 103 * line pair. The main surface pitch is required to be a multiple of four 104 * tile4 widths. 105 */ 106 #define I915_FORMAT_MOD_4_TILED_MTL_RC_CCS fourcc_mod_code(INTEL, 13) 107 #endif 108 109 // clang-format on 110 struct driver; 111 struct bo; 112 struct combination; 113 114 union bo_handle { 115 void *ptr; 116 int32_t s32; 117 uint32_t u32; 118 int64_t s64; 119 uint64_t u64; 120 }; 121 122 struct drv_import_fd_data { 123 int fds[DRV_MAX_PLANES]; 124 uint32_t strides[DRV_MAX_PLANES]; 125 uint32_t offsets[DRV_MAX_PLANES]; 126 uint64_t format_modifier; 127 uint32_t width; 128 uint32_t height; 129 uint32_t format; 130 uint32_t tiling; 131 uint64_t use_flags; 132 }; 133 134 struct vma { 135 void *addr; 136 size_t length; 137 uint32_t handle; 138 uint32_t map_flags; 139 int32_t refcount; 140 uint32_t map_strides[DRV_MAX_PLANES]; 141 void *priv; 142 }; 143 144 struct rectangle { 145 uint32_t x; 146 uint32_t y; 147 uint32_t width; 148 uint32_t height; 149 }; 150 151 struct mapping { 152 struct vma *vma; 153 struct rectangle rect; 154 uint32_t refcount; 155 }; 156 157 void drv_preload(bool load); 158 159 struct driver *drv_create(int fd); 160 161 void drv_destroy(struct driver *drv); 162 163 int drv_get_fd(struct driver *drv); 164 165 const char *drv_get_name(struct driver *drv); 166 167 struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t use_flags); 168 169 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format, 170 uint64_t use_flags, bool is_test_buffer); 171 172 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format, 173 uint64_t use_flags); 174 175 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height, 176 uint32_t format, const uint64_t *modifiers, uint32_t count); 177 178 void drv_bo_destroy(struct bo *bo); 179 180 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data); 181 182 void *drv_bo_map(struct bo *bo, const struct rectangle *rect, uint32_t map_flags, 183 struct mapping **map_data, size_t plane); 184 185 int drv_bo_unmap(struct bo *bo, struct mapping *mapping); 186 187 bool drv_bo_cached(struct bo *bo); 188 189 int drv_bo_invalidate(struct bo *bo, struct mapping *mapping); 190 191 int drv_bo_flush(struct bo *bo, struct mapping *mapping); 192 193 int drv_bo_flush_or_unmap(struct bo *bo, struct mapping *mapping); 194 195 uint32_t drv_bo_get_width(struct bo *bo); 196 197 uint32_t drv_bo_get_height(struct bo *bo); 198 199 size_t drv_bo_get_num_planes(struct bo *bo); 200 201 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane); 202 203 int drv_bo_get_plane_fd(struct bo *bo, size_t plane); 204 205 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane); 206 207 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane); 208 209 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane); 210 211 uint64_t drv_bo_get_format_modifier(struct bo *bo); 212 213 uint32_t drv_bo_get_format(struct bo *bo); 214 215 uint32_t drv_bo_get_tiling(struct bo *bo); 216 217 uint64_t drv_bo_get_use_flags(struct bo *bo); 218 219 size_t drv_bo_get_total_size(struct bo *bo); 220 221 void drv_bo_log_info(const struct bo *bo, const char *prefix); 222 223 uint32_t drv_get_standard_fourcc(uint32_t fourcc_internal); 224 225 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane); 226 227 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane); 228 229 void drv_resolve_format_and_use_flags(struct driver *drv, uint32_t format, uint64_t use_flags, 230 uint32_t *out_format, uint64_t *out_use_flags); 231 232 uint64_t drv_resolve_use_flags(struct driver *drv, uint32_t format, uint64_t use_flags); 233 234 size_t drv_num_planes_from_format(uint32_t format); 235 236 size_t drv_num_planes_from_modifier(struct driver *drv, uint32_t format, uint64_t modifier); 237 int drv_resource_info(struct bo *bo, uint32_t strides[DRV_MAX_PLANES], 238 uint32_t offsets[DRV_MAX_PLANES], uint64_t *format_modifier); 239 240 uint32_t drv_get_max_texture_2d_size(struct driver *drv); 241 242 enum drv_log_level { 243 DRV_LOGV, 244 DRV_LOGD, 245 DRV_LOGI, 246 DRV_LOGE, 247 }; 248 249 #define _drv_log(level, format, ...) \ 250 do { \ 251 drv_log_prefix(level, "minigbm", __func__, __LINE__, format, ##__VA_ARGS__); \ 252 } while (0) 253 254 #define drv_loge(format, ...) _drv_log(DRV_LOGE, format, ##__VA_ARGS__) 255 #ifdef NDEBUG 256 #define drv_logv(format, ...) 257 #else 258 #define drv_logv(format, ...) _drv_log(DRV_LOGV, format, ##__VA_ARGS__) 259 #endif 260 #define drv_logd(format, ...) _drv_log(DRV_LOGD, format, ##__VA_ARGS__) 261 #define drv_logi(format, ...) _drv_log(DRV_LOGI, format, ##__VA_ARGS__) 262 263 __attribute__((format(printf, 5, 6))) void drv_log_prefix(enum drv_log_level level, 264 const char *prefix, const char *file, 265 int line, const char *format, ...); 266 267 #ifdef __cplusplus 268 } 269 #endif 270 271 #endif 272