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