1 /* 2 * Copyright 2011 Intel Corporation 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a 5 * copy of this software and associated documentation files (the "Software"), 6 * to deal in the Software without restriction, including without limitation 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 * and/or sell copies of the Software, and to permit persons to whom the 9 * Software is furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice (including the next 12 * paragraph) shall be included in all copies or substantial portions of the 13 * Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 19 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 20 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 22 * DEALINGS IN THE SOFTWARE. 23 * 24 * Authors: 25 * Benjamin Franzke <benjaminfranzke@googlemail.com> 26 */ 27 #ifndef _GBM_H_ 28 #define _GBM_H_ 29 30 #define GBM 1 31 32 #include <stddef.h> 33 #include <stdint.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 /** 40 * \file gbm.h 41 * \brief Generic Buffer Manager 42 */ 43 44 struct gbm_device; 45 struct gbm_bo; 46 struct gbm_iSurface; 47 48 /** 49 * \mainpage The Generic Buffer Manager 50 * 51 * This module provides an abstraction that the caller can use to request a 52 * buffer from the underlying memory management system for the platform. 53 * 54 * This allows the creation of portable code whilst still allowing access to 55 * the underlying memory manager. 56 */ 57 58 /** 59 * Abstraction representing the handle to a buffer allocated by the 60 * manager 61 */ 62 union gbm_bo_handle { 63 void *ptr; 64 int32_t s32; 65 uint32_t u32; 66 int64_t s64; 67 uint64_t u64; 68 }; 69 70 /** Format of the allocated buffer */ 71 enum gbm_bo_format { 72 /** RGB with 8 bits per channel in a 32 bit value */ 73 GBM_BO_FORMAT_XRGB8888, 74 /** ARGB with 8 bits per channel in a 32 bit value */ 75 GBM_BO_FORMAT_ARGB8888 76 }; 77 78 /** 79 * The FourCC format codes are taken from the drm_fourcc.h definition, and 80 * re-namespaced. New GBM formats must not be added, unless they are 81 * identical ports from drm_fourcc. 82 */ 83 #define gbm_fourcc_code(a, b, c, d) \ 84 ((uint32_t)(a) | ((uint32_t)(b) << 8) | ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24)) 85 86 #define GBM_FORMAT_BIG_ENDIAN (1 << 31) /* format is big endian instead of little endian */ 87 88 /* color index */ 89 #define GBM_FORMAT_C8 gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */ 90 91 /* 8 bpp Red */ 92 #define GBM_FORMAT_R8 gbm_fourcc_code('R', '8', ' ', ' ') /* [7:0] R */ 93 94 /* 16 bpp RG */ 95 #define GBM_FORMAT_GR88 gbm_fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */ 96 97 /* 8 bpp RGB */ 98 #define GBM_FORMAT_RGB332 gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */ 99 #define GBM_FORMAT_BGR233 gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */ 100 101 /* 16 bpp RGB */ 102 #define GBM_FORMAT_XRGB4444 gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */ 103 #define GBM_FORMAT_XBGR4444 gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */ 104 #define GBM_FORMAT_RGBX4444 gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */ 105 #define GBM_FORMAT_BGRX4444 gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */ 106 107 #define GBM_FORMAT_ARGB4444 gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */ 108 #define GBM_FORMAT_ABGR4444 gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */ 109 #define GBM_FORMAT_RGBA4444 gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */ 110 #define GBM_FORMAT_BGRA4444 gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */ 111 112 #define GBM_FORMAT_XRGB1555 gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */ 113 #define GBM_FORMAT_XBGR1555 gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */ 114 #define GBM_FORMAT_RGBX5551 gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */ 115 #define GBM_FORMAT_BGRX5551 gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */ 116 117 #define GBM_FORMAT_ARGB1555 gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */ 118 #define GBM_FORMAT_ABGR1555 gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */ 119 #define GBM_FORMAT_RGBA5551 gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */ 120 #define GBM_FORMAT_BGRA5551 gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */ 121 122 #define GBM_FORMAT_RGB565 gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */ 123 #define GBM_FORMAT_BGR565 gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */ 124 125 /* 24 bpp RGB */ 126 #define GBM_FORMAT_RGB888 gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */ 127 #define GBM_FORMAT_BGR888 gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */ 128 129 /* 32 bpp RGB */ 130 #define GBM_FORMAT_XRGB8888 gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */ 131 #define GBM_FORMAT_XBGR8888 gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */ 132 #define GBM_FORMAT_RGBX8888 gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */ 133 #define GBM_FORMAT_BGRX8888 gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */ 134 135 #define GBM_FORMAT_ARGB8888 gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */ 136 #define GBM_FORMAT_ABGR8888 gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */ 137 #define GBM_FORMAT_RGBA8888 gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */ 138 #define GBM_FORMAT_BGRA8888 gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */ 139 140 #define GBM_FORMAT_XRGB2101010 gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */ 141 #define GBM_FORMAT_XBGR2101010 gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */ 142 #define GBM_FORMAT_RGBX1010102 gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */ 143 #define GBM_FORMAT_BGRX1010102 gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */ 144 145 #define GBM_FORMAT_ARGB2101010 gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */ 146 #define GBM_FORMAT_ABGR2101010 gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */ 147 #define GBM_FORMAT_RGBA1010102 gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */ 148 #define GBM_FORMAT_BGRA1010102 gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */ 149 150 /* packed YCbCr */ 151 #define GBM_FORMAT_YUYV gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */ 152 #define GBM_FORMAT_YVYU gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */ 153 #define GBM_FORMAT_UYVY gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */ 154 #define GBM_FORMAT_VYUY gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */ 155 156 #define GBM_FORMAT_AYUV gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */ 157 158 /* 159 * 2 plane YCbCr 160 * index 0 = Y plane, [7:0] Y 161 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian 162 * or 163 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian 164 */ 165 #define GBM_FORMAT_NV12 gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */ 166 #define GBM_FORMAT_NV21 gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */ 167 #define GBM_FORMAT_NV16 gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */ 168 #define GBM_FORMAT_NV61 gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */ 169 170 /* 171 * 3 plane YCbCr 172 * index 0: Y plane, [7:0] Y 173 * index 1: Cb plane, [7:0] Cb 174 * index 2: Cr plane, [7:0] Cr 175 * or 176 * index 1: Cr plane, [7:0] Cr 177 * index 2: Cb plane, [7:0] Cb 178 */ 179 #define GBM_FORMAT_YUV410 gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */ 180 #define GBM_FORMAT_YVU410 gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */ 181 #define GBM_FORMAT_YUV411 gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */ 182 #define GBM_FORMAT_YVU411 gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */ 183 #define GBM_FORMAT_YUV420 gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */ 184 #define GBM_FORMAT_YVU420 gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */ 185 #define GBM_FORMAT_YUV422 gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */ 186 #define GBM_FORMAT_YVU422 gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */ 187 #define GBM_FORMAT_YUV444 gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */ 188 #define GBM_FORMAT_YVU444 gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */ 189 190 /** 191 * Flags to indicate the intended use for the buffer - these are passed into 192 * gbm_bo_create(). The caller must set the union of all the flags that are 193 * appropriate 194 * 195 * \sa Use gbm_device_is_format_supported() to check if the combination of format 196 * and use flags are supported 197 */ 198 enum gbm_bo_flags { 199 /** 200 * Buffer is going to be presented to the screen using an API such as KMS 201 */ 202 GBM_BO_USE_SCANOUT = (1 << 0), 203 /** 204 * Buffer is going to be used as cursor 205 */ 206 GBM_BO_USE_CURSOR = (1 << 1), 207 /** 208 * Deprecated 209 */ 210 GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR, 211 /** 212 * Buffer is to be used for rendering - for example it is going to be used 213 * as the storage for a color buffer 214 */ 215 GBM_BO_USE_RENDERING = (1 << 2), 216 /** 217 * Buffer can be used for gbm_bo_write. This is guaranteed to work 218 * with GBM_BO_USE_CURSOR, but may not work for other combinations. 219 */ 220 GBM_BO_USE_WRITE = (1 << 3), 221 /** 222 * Buffer is linear, i.e. not tiled. 223 */ 224 GBM_BO_USE_LINEAR = (1 << 4), 225 }; 226 227 int gbm_device_get_fd(struct gbm_device *gbm); 228 229 const char *gbm_device_get_backend_name(struct gbm_device *gbm); 230 231 int gbm_device_is_format_supported(struct gbm_device *gbm, uint32_t format, uint32_t usage); 232 233 int gbm_device_get_format_modifier_plane_count(struct gbm_device *gbm, uint32_t format, uint64_t modifier); 234 235 void gbm_device_destroy(struct gbm_device *gbm); 236 237 struct gbm_device *gbm_create_device(int fd); 238 239 struct gbm_bo *gbm_bo_create(struct gbm_device *gbm, uint32_t width, uint32_t height, uint32_t format, uint32_t flags); 240 241 struct gbm_bo *gbm_bo_create_with_modifiers(struct gbm_device *gbm, uint32_t width, uint32_t height, uint32_t format, 242 const uint64_t *modifiers, const unsigned int count); 243 244 #define GBM_BO_IMPORT_WL_BUFFER 0x5501 245 #define GBM_BO_IMPORT_EGL_IMAGE 0x5502 246 #define GBM_BO_IMPORT_FD 0x5503 247 #define GBM_BO_IMPORT_FD_MODIFIER 0x5504 248 249 struct gbm_import_fd_data { 250 int fd; 251 uint32_t width; 252 uint32_t height; 253 uint32_t stride; 254 uint32_t format; 255 }; 256 257 struct gbm_import_fd_modifier_data { 258 uint32_t width; 259 uint32_t height; 260 uint32_t format; 261 uint32_t num_fds; 262 int fds[4]; 263 int strides[4]; 264 int offsets[4]; 265 uint64_t modifier; 266 }; 267 268 struct gbm_bo *bm_bo_import(struct gbm_device *gbm, uint32_t type, void *buffer, uint32_t usage); 269 270 /** 271 * Flags to indicate the type of mapping for the buffer - these are 272 * passed into gbm_bo_map(). The caller must set the union of all the 273 * flags that are appropriate. 274 * 275 * These flags are independent of the GBM_BO_USE_* creation flags. However, 276 * mapping the buffer may require copying to/from a staging buffer. 277 * 278 * See also: pipe_transfer_usage 279 */ 280 enum gbm_bo_transfer_flags { 281 /** 282 * Buffer contents read back (or accessed directly) at transfer 283 * create time. 284 */ 285 GBM_BO_TRANSFER_READ = (1 << 0), 286 /** 287 * Buffer contents will be written back at unmap time 288 * (or modified as a result of being accessed directly). 289 */ 290 GBM_BO_TRANSFER_WRITE = (1 << 1), 291 /** 292 * Read/modify/write 293 */ 294 GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE), 295 }; 296 297 void *gbm_bo_map(struct gbm_bo *bo, uint32_t x, uint32_t y, uint32_t width, uint32_t height, uint32_t flags, 298 uint32_t *stride, void **map_data); 299 300 void gbm_bo_unmap(struct gbm_bo *bo, void *map_data); 301 302 uint32_t gbm_bo_get_width(struct gbm_bo *bo); 303 304 uint32_t gbm_bo_get_height(struct gbm_bo *bo); 305 306 uint32_t gbm_bo_get_stride(struct gbm_bo *bo); 307 308 uint32_t gbm_bo_get_stride_for_plane(struct gbm_bo *bo, int plane); 309 310 uint32_t gbm_bo_get_format(struct gbm_bo *bo); 311 312 uint32_t gbm_bo_get_bpp(struct gbm_bo *bo); 313 314 uint32_t gbm_bo_get_offset(struct gbm_bo *bo, int plane); 315 316 struct gbm_device *gbm_bo_get_device(struct gbm_bo *bo); 317 318 union gbm_bo_handle gbm_bo_get_handle(struct gbm_bo *bo); 319 320 int gbm_bo_get_fd(struct gbm_bo *bo); 321 322 uint64_t gbm_bo_get_modifier(struct gbm_bo *bo); 323 324 int gbm_bo_get_plane_count(struct gbm_bo *bo); 325 326 union gbm_bo_handle gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane); 327 328 int gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count); 329 330 void gbm_bo_set_user_data(struct gbm_bo *bo, void *data, void (*destroy_user_data)(struct gbm_bo *, void *)); 331 332 void *gbm_bo_get_user_data(struct gbm_bo *bo); 333 334 void gbm_bo_destroy(struct gbm_bo *bo); 335 336 struct gbm_iSurface *gbm_iSurface_create(struct gbm_device *gbm, uint32_t width, uint32_t height, uint32_t format, 337 uint32_t flags); 338 339 struct gbm_iSurface *gbm_iSurface_create_with_modifiers(struct gbm_device *gbm, uint32_t width, uint32_t height, 340 uint32_t format, const uint64_t *modifiers, 341 const unsigned int count); 342 343 struct gbm_bo *gbm_iSurface_lock_front_buffer(struct gbm_iSurface *iSurface); 344 345 void gbm_iSurface_release_buffer(struct gbm_iSurface *iSurface, struct gbm_bo *bo); 346 347 int gbm_iSurface_has_free_buffers(struct gbm_iSurface *iSurface); 348 349 void gbm_iSurface_destroy(struct gbm_iSurface *iSurface); 350 351 #ifdef __cplusplus 352 } 353 #endif 354 355 #endif 356