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