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 /* This is a 10-bit bayer format for private reprocessing on MediaTek ISP. It's 68 * a private RAW format that other DRM drivers will never support and thus 69 * making it not upstreamable (i.e., defined in official DRM headers). */ 70 #define DRM_FORMAT_MTISP_SXYZW10 fourcc_code('M', 'B', '1', '0') 71 72 // TODO(crbug.com/958181): remove this definition once drm_fourcc.h contains it. 73 #ifndef DRM_FORMAT_P010 74 #define DRM_FORMAT_P010 fourcc_code('P', '0', '1', '0') 75 #endif 76 77 //TODO: remove this defination once drm_fourcc.h contains it. 78 #ifndef I915_FORMAT_MOD_Y_TILED_GEN12_RC_CCS 79 #define I915_FORMAT_MOD_Y_TILED_GEN12_RC_CCS fourcc_mod_code(INTEL, 6) 80 #endif 81 82 //TODO: remove this defination once drm_fourcc.h contains it. 83 #ifndef I915_FORMAT_MOD_4_TILED 84 #define I915_FORMAT_MOD_4_TILED fourcc_mod_code(INTEL, 9) 85 #endif 86 // clang-format on 87 struct driver; 88 struct bo; 89 struct combination; 90 91 union bo_handle { 92 void *ptr; 93 int32_t s32; 94 uint32_t u32; 95 int64_t s64; 96 uint64_t u64; 97 }; 98 99 struct drv_import_fd_data { 100 int fds[DRV_MAX_PLANES]; 101 uint32_t strides[DRV_MAX_PLANES]; 102 uint32_t offsets[DRV_MAX_PLANES]; 103 uint64_t format_modifier; 104 uint32_t width; 105 uint32_t height; 106 uint32_t format; 107 uint32_t tiling; 108 uint64_t use_flags; 109 }; 110 111 struct vma { 112 void *addr; 113 size_t length; 114 uint32_t handle; 115 uint32_t map_flags; 116 int32_t refcount; 117 uint32_t map_strides[DRV_MAX_PLANES]; 118 void *priv; 119 }; 120 121 struct rectangle { 122 uint32_t x; 123 uint32_t y; 124 uint32_t width; 125 uint32_t height; 126 }; 127 128 struct mapping { 129 struct vma *vma; 130 struct rectangle rect; 131 uint32_t refcount; 132 }; 133 134 void drv_preload(bool load); 135 136 struct driver *drv_create(int fd); 137 138 void drv_destroy(struct driver *drv); 139 140 int drv_get_fd(struct driver *drv); 141 142 const char *drv_get_name(struct driver *drv); 143 144 struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t use_flags); 145 146 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format, 147 uint64_t use_flags, bool is_test_buffer); 148 149 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format, 150 uint64_t use_flags); 151 152 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height, 153 uint32_t format, const uint64_t *modifiers, uint32_t count); 154 155 void drv_bo_destroy(struct bo *bo); 156 157 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data); 158 159 void *drv_bo_map(struct bo *bo, const struct rectangle *rect, uint32_t map_flags, 160 struct mapping **map_data, size_t plane); 161 162 int drv_bo_unmap(struct bo *bo, struct mapping *mapping); 163 164 int drv_bo_invalidate(struct bo *bo, struct mapping *mapping); 165 166 int drv_bo_flush(struct bo *bo, struct mapping *mapping); 167 168 int drv_bo_flush_or_unmap(struct bo *bo, struct mapping *mapping); 169 170 uint32_t drv_bo_get_width(struct bo *bo); 171 172 uint32_t drv_bo_get_height(struct bo *bo); 173 174 size_t drv_bo_get_num_planes(struct bo *bo); 175 176 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane); 177 178 int drv_bo_get_plane_fd(struct bo *bo, size_t plane); 179 180 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane); 181 182 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane); 183 184 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane); 185 186 uint64_t drv_bo_get_format_modifier(struct bo *bo); 187 188 uint32_t drv_bo_get_format(struct bo *bo); 189 190 uint32_t drv_bo_get_tiling(struct bo *bo); 191 192 uint64_t drv_bo_get_use_flags(struct bo *bo); 193 194 size_t drv_bo_get_total_size(struct bo *bo); 195 196 uint32_t drv_get_standard_fourcc(uint32_t fourcc_internal); 197 198 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane); 199 200 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane); 201 202 void drv_resolve_format_and_use_flags(struct driver *drv, uint32_t format, uint64_t use_flags, 203 uint32_t *out_format, uint64_t *out_use_flags); 204 205 uint64_t drv_resolve_use_flags(struct driver *drv, uint32_t format, uint64_t use_flags); 206 207 size_t drv_num_planes_from_format(uint32_t format); 208 209 size_t drv_num_planes_from_modifier(struct driver *drv, uint32_t format, uint64_t modifier); 210 211 uint32_t drv_num_buffers_per_bo(struct bo *bo); 212 213 int drv_resource_info(struct bo *bo, uint32_t strides[DRV_MAX_PLANES], 214 uint32_t offsets[DRV_MAX_PLANES], uint64_t *format_modifier); 215 216 uint32_t drv_get_max_texture_2d_size(struct driver *drv); 217 218 enum drv_log_level { 219 DRV_LOGV, 220 DRV_LOGD, 221 DRV_LOGI, 222 DRV_LOGE, 223 }; 224 225 #define _drv_log(level, format, ...) \ 226 do { \ 227 drv_log_prefix(level, "minigbm", __FILE__, __LINE__, format, ##__VA_ARGS__); \ 228 } while (0) 229 230 #define drv_loge(format, ...) _drv_log(DRV_LOGE, format, ##__VA_ARGS__) 231 #define drv_logv(format, ...) _drv_log(DRV_LOGV, format, ##__VA_ARGS__) 232 #define drv_logd(format, ...) _drv_log(DRV_LOGD, format, ##__VA_ARGS__) 233 #define drv_logi(format, ...) _drv_log(DRV_LOGI, format, ##__VA_ARGS__) 234 235 __attribute__((format(printf, 5, 6))) void drv_log_prefix(enum drv_log_level level, 236 const char *prefix, const char *file, 237 int line, const char *format, ...); 238 239 #ifdef __cplusplus 240 } 241 #endif 242 243 #endif 244