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