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 45 /* Quirks for allocating a buffer. */ 46 #define BO_QUIRK_NONE 0 47 #define BO_QUIRK_DUMB32BPP (1ull << 0) 48 49 /* Map flags */ 50 #define BO_MAP_NONE 0 51 #define BO_MAP_READ (1 << 0) 52 #define BO_MAP_WRITE (1 << 1) 53 #define BO_MAP_READ_WRITE (BO_MAP_READ | BO_MAP_WRITE) 54 55 /* This is our extension to <drm_fourcc.h>. We need to make sure we don't step 56 * on the namespace of already defined formats, which can be done by using invalid 57 * fourcc codes. 58 */ 59 #define DRM_FORMAT_NONE fourcc_code('0', '0', '0', '0') 60 #define DRM_FORMAT_YVU420_ANDROID fourcc_code('9', '9', '9', '7') 61 #define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED fourcc_code('9', '9', '9', '8') 62 #define DRM_FORMAT_FLEX_YCbCr_420_888 fourcc_code('9', '9', '9', '9') 63 64 /* This is a 10-bit bayer format for private reprocessing on MediaTek ISP. It's 65 * a private RAW format that other DRM drivers will never support and thus 66 * making it not upstreamable (i.e., defined in official DRM headers). */ 67 #define DRM_FORMAT_MTISP_SXYZW10 fourcc_code('M', 'B', '1', '0') 68 69 // TODO(crbug.com/958181): remove this definition once drm_fourcc.h contains it. 70 #ifndef DRM_FORMAT_P010 71 #define DRM_FORMAT_P010 fourcc_code('P', '0', '1', '0') 72 #endif 73 74 //TODO: remove this defination once drm_fourcc.h contains it. 75 #ifndef I915_FORMAT_MOD_Y_TILED_GEN12_RC_CCS 76 #define I915_FORMAT_MOD_Y_TILED_GEN12_RC_CCS fourcc_mod_code(INTEL, 6) 77 #endif 78 79 // clang-format on 80 struct driver; 81 struct bo; 82 struct combination; 83 84 union bo_handle { 85 void *ptr; 86 int32_t s32; 87 uint32_t u32; 88 int64_t s64; 89 uint64_t u64; 90 }; 91 92 struct drv_import_fd_data { 93 int fds[DRV_MAX_PLANES]; 94 uint32_t strides[DRV_MAX_PLANES]; 95 uint32_t offsets[DRV_MAX_PLANES]; 96 uint64_t format_modifier; 97 uint32_t width; 98 uint32_t height; 99 uint32_t format; 100 uint32_t tiling; 101 uint64_t use_flags; 102 }; 103 104 struct vma { 105 void *addr; 106 size_t length; 107 uint32_t handle; 108 uint32_t map_flags; 109 int32_t refcount; 110 uint32_t map_strides[DRV_MAX_PLANES]; 111 void *priv; 112 }; 113 114 struct rectangle { 115 uint32_t x; 116 uint32_t y; 117 uint32_t width; 118 uint32_t height; 119 }; 120 121 struct mapping { 122 struct vma *vma; 123 struct rectangle rect; 124 uint32_t refcount; 125 }; 126 127 struct driver *drv_create(int fd); 128 129 void drv_destroy(struct driver *drv); 130 131 int drv_get_fd(struct driver *drv); 132 133 const char *drv_get_name(struct driver *drv); 134 135 struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t use_flags); 136 137 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format, 138 uint64_t use_flags, bool is_test_buffer); 139 140 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format, 141 uint64_t use_flags); 142 143 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height, 144 uint32_t format, const uint64_t *modifiers, uint32_t count); 145 146 void drv_bo_destroy(struct bo *bo); 147 148 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data); 149 150 void *drv_bo_map(struct bo *bo, const struct rectangle *rect, uint32_t map_flags, 151 struct mapping **map_data, size_t plane); 152 153 int drv_bo_unmap(struct bo *bo, struct mapping *mapping); 154 155 int drv_bo_invalidate(struct bo *bo, struct mapping *mapping); 156 157 int drv_bo_flush(struct bo *bo, struct mapping *mapping); 158 159 int drv_bo_flush_or_unmap(struct bo *bo, struct mapping *mapping); 160 161 uint32_t drv_bo_get_width(struct bo *bo); 162 163 uint32_t drv_bo_get_height(struct bo *bo); 164 165 size_t drv_bo_get_num_planes(struct bo *bo); 166 167 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane); 168 169 int drv_bo_get_plane_fd(struct bo *bo, size_t plane); 170 171 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane); 172 173 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane); 174 175 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane); 176 177 uint64_t drv_bo_get_format_modifier(struct bo *bo); 178 179 uint32_t drv_bo_get_format(struct bo *bo); 180 181 uint32_t drv_bo_get_tiling(struct bo *bo); 182 183 uint64_t drv_bo_get_use_flags(struct bo *bo); 184 185 size_t drv_bo_get_total_size(struct bo *bo); 186 187 uint32_t drv_get_standard_fourcc(uint32_t fourcc_internal); 188 189 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane); 190 191 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane); 192 193 void drv_resolve_format_and_use_flags(struct driver *drv, uint32_t format, uint64_t use_flags, 194 uint32_t *out_format, uint64_t *out_use_flags); 195 196 uint64_t drv_resolve_use_flags(struct driver *drv, uint32_t format, uint64_t use_flags); 197 198 size_t drv_num_planes_from_format(uint32_t format); 199 200 size_t drv_num_planes_from_modifier(struct driver *drv, uint32_t format, uint64_t modifier); 201 202 uint32_t drv_num_buffers_per_bo(struct bo *bo); 203 204 int drv_resource_info(struct bo *bo, uint32_t strides[DRV_MAX_PLANES], 205 uint32_t offsets[DRV_MAX_PLANES], uint64_t *format_modifier); 206 207 uint32_t drv_get_max_texture_2d_size(struct driver *drv); 208 209 #define drv_log(format, ...) \ 210 do { \ 211 drv_log_prefix("minigbm", __FILE__, __LINE__, format, ##__VA_ARGS__); \ 212 } while (0) 213 214 __attribute__((format(printf, 4, 5))) void drv_log_prefix(const char *prefix, const char *file, 215 int line, const char *format, ...); 216 217 #ifdef __cplusplus 218 } 219 #endif 220 221 #endif 222