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 RG */ 98#define GBM_FORMAT_GR88 __gbm_fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */ 99 100/* 8 bpp RGB */ 101#define GBM_FORMAT_RGB332 __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */ 102#define GBM_FORMAT_BGR233 __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */ 103 104/* 16 bpp RGB */ 105#define GBM_FORMAT_XRGB4444 __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */ 106#define GBM_FORMAT_XBGR4444 __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */ 107#define GBM_FORMAT_RGBX4444 __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */ 108#define GBM_FORMAT_BGRX4444 __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */ 109 110#define GBM_FORMAT_ARGB4444 __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */ 111#define GBM_FORMAT_ABGR4444 __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */ 112#define GBM_FORMAT_RGBA4444 __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */ 113#define GBM_FORMAT_BGRA4444 __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */ 114 115#define GBM_FORMAT_XRGB1555 __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */ 116#define GBM_FORMAT_XBGR1555 __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */ 117#define GBM_FORMAT_RGBX5551 __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */ 118#define GBM_FORMAT_BGRX5551 __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */ 119 120#define GBM_FORMAT_ARGB1555 __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */ 121#define GBM_FORMAT_ABGR1555 __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */ 122#define GBM_FORMAT_RGBA5551 __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */ 123#define GBM_FORMAT_BGRA5551 __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */ 124 125#define GBM_FORMAT_RGB565 __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */ 126#define GBM_FORMAT_BGR565 __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */ 127 128/* 24 bpp RGB */ 129#define GBM_FORMAT_RGB888 __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */ 130#define GBM_FORMAT_BGR888 __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */ 131 132/* 32 bpp RGB */ 133#define GBM_FORMAT_XRGB8888 __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */ 134#define GBM_FORMAT_XBGR8888 __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */ 135#define GBM_FORMAT_RGBX8888 __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */ 136#define GBM_FORMAT_BGRX8888 __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */ 137 138#define GBM_FORMAT_ARGB8888 __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */ 139#define GBM_FORMAT_ABGR8888 __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */ 140#define GBM_FORMAT_RGBA8888 __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */ 141#define GBM_FORMAT_BGRA8888 __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */ 142 143#define GBM_FORMAT_XRGB2101010 __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */ 144#define GBM_FORMAT_XBGR2101010 __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */ 145#define GBM_FORMAT_RGBX1010102 __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */ 146#define GBM_FORMAT_BGRX1010102 __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */ 147 148#define GBM_FORMAT_ARGB2101010 __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */ 149#define GBM_FORMAT_ABGR2101010 __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */ 150#define GBM_FORMAT_RGBA1010102 __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */ 151#define GBM_FORMAT_BGRA1010102 __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */ 152 153/* packed YCbCr */ 154#define GBM_FORMAT_YUYV __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */ 155#define GBM_FORMAT_YVYU __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */ 156#define GBM_FORMAT_UYVY __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */ 157#define GBM_FORMAT_VYUY __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */ 158 159#define GBM_FORMAT_AYUV __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */ 160 161/* 162 * 2 plane YCbCr 163 * index 0 = Y plane, [7:0] Y 164 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian 165 * or 166 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian 167 */ 168#define GBM_FORMAT_NV12 __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */ 169#define GBM_FORMAT_NV21 __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */ 170#define GBM_FORMAT_NV16 __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */ 171#define GBM_FORMAT_NV61 __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */ 172 173/* 174 * 3 plane YCbCr 175 * index 0: Y plane, [7:0] Y 176 * index 1: Cb plane, [7:0] Cb 177 * index 2: Cr plane, [7:0] Cr 178 * or 179 * index 1: Cr plane, [7:0] Cr 180 * index 2: Cb plane, [7:0] Cb 181 */ 182#define GBM_FORMAT_YUV410 __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */ 183#define GBM_FORMAT_YVU410 __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */ 184#define GBM_FORMAT_YUV411 __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */ 185#define GBM_FORMAT_YVU411 __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */ 186#define GBM_FORMAT_YUV420 __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */ 187#define GBM_FORMAT_YVU420 __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */ 188#define GBM_FORMAT_YUV422 __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */ 189#define GBM_FORMAT_YVU422 __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */ 190#define GBM_FORMAT_YUV444 __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */ 191#define GBM_FORMAT_YVU444 __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */ 192 193struct gbm_format_name_desc { 194 char name[5]; 195}; 196 197/** 198 * Flags to indicate the intended use for the buffer - these are passed into 199 * gbm_bo_create(). The caller must set the union of all the flags that are 200 * appropriate 201 * 202 * \sa Use gbm_device_is_format_supported() to check if the combination of format 203 * and use flags are supported 204 */ 205enum gbm_bo_flags { 206 /** 207 * Buffer is going to be presented to the screen using an API such as KMS 208 */ 209 GBM_BO_USE_SCANOUT = (1 << 0), 210 /** 211 * Buffer is going to be used as cursor 212 */ 213 GBM_BO_USE_CURSOR = (1 << 1), 214 /** 215 * Deprecated 216 */ 217 GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR, 218 /** 219 * Buffer is to be used for rendering - for example it is going to be used 220 * as the storage for a color buffer 221 */ 222 GBM_BO_USE_RENDERING = (1 << 2), 223 /** 224 * Buffer can be used for gbm_bo_write. This is guaranteed to work 225 * with GBM_BO_USE_CURSOR, but may not work for other combinations. 226 */ 227 GBM_BO_USE_WRITE = (1 << 3), 228 /** 229 * Buffer is linear, i.e. not tiled. 230 */ 231 GBM_BO_USE_LINEAR = (1 << 4), 232}; 233 234int 235gbm_device_get_fd(struct gbm_device *gbm); 236 237const char * 238gbm_device_get_backend_name(struct gbm_device *gbm); 239 240int 241gbm_device_is_format_supported(struct gbm_device *gbm, 242 uint32_t format, uint32_t usage); 243 244int 245gbm_device_get_format_modifier_plane_count(struct gbm_device *gbm, 246 uint32_t format, 247 uint64_t modifier); 248 249void 250gbm_device_destroy(struct gbm_device *gbm); 251 252struct gbm_device * 253gbm_create_device(int fd); 254 255struct gbm_bo * 256gbm_bo_create(struct gbm_device *gbm, 257 uint32_t width, uint32_t height, 258 uint32_t format, uint32_t flags); 259 260struct gbm_bo * 261gbm_bo_create_with_modifiers(struct gbm_device *gbm, 262 uint32_t width, uint32_t height, 263 uint32_t format, 264 const uint64_t *modifiers, 265 const unsigned int count); 266#define GBM_BO_IMPORT_WL_BUFFER 0x5501 267#define GBM_BO_IMPORT_EGL_IMAGE 0x5502 268#define GBM_BO_IMPORT_FD 0x5503 269#define GBM_BO_IMPORT_FD_MODIFIER 0x5504 270 271struct gbm_import_fd_data { 272 int fd; 273 uint32_t width; 274 uint32_t height; 275 uint32_t stride; 276 uint32_t format; 277}; 278 279struct gbm_import_fd_modifier_data { 280 uint32_t width; 281 uint32_t height; 282 uint32_t format; 283 uint32_t num_fds; 284 int fds[4]; 285 int strides[4]; 286 int offsets[4]; 287 uint64_t modifier; 288}; 289 290struct gbm_bo * 291gbm_bo_import(struct gbm_device *gbm, uint32_t type, 292 void *buffer, uint32_t usage); 293 294/** 295 * Flags to indicate the type of mapping for the buffer - these are 296 * passed into gbm_bo_map(). The caller must set the union of all the 297 * flags that are appropriate. 298 * 299 * These flags are independent of the GBM_BO_USE_* creation flags. However, 300 * mapping the buffer may require copying to/from a staging buffer. 301 * 302 * See also: pipe_transfer_usage 303 */ 304enum gbm_bo_transfer_flags { 305 /** 306 * Buffer contents read back (or accessed directly) at transfer 307 * create time. 308 */ 309 GBM_BO_TRANSFER_READ = (1 << 0), 310 /** 311 * Buffer contents will be written back at unmap time 312 * (or modified as a result of being accessed directly). 313 */ 314 GBM_BO_TRANSFER_WRITE = (1 << 1), 315 /** 316 * Read/modify/write 317 */ 318 GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE), 319}; 320 321void * 322gbm_bo_map(struct gbm_bo *bo, 323 uint32_t x, uint32_t y, uint32_t width, uint32_t height, 324 uint32_t flags, uint32_t *stride, void **map_data); 325 326void 327gbm_bo_unmap(struct gbm_bo *bo, void *map_data); 328 329uint32_t 330gbm_bo_get_width(struct gbm_bo *bo); 331 332uint32_t 333gbm_bo_get_height(struct gbm_bo *bo); 334 335uint32_t 336gbm_bo_get_stride(struct gbm_bo *bo); 337 338uint32_t 339gbm_bo_get_stride_for_plane(struct gbm_bo *bo, int plane); 340 341uint32_t 342gbm_bo_get_format(struct gbm_bo *bo); 343 344uint32_t 345gbm_bo_get_bpp(struct gbm_bo *bo); 346 347uint32_t 348gbm_bo_get_offset(struct gbm_bo *bo, int plane); 349 350struct gbm_device * 351gbm_bo_get_device(struct gbm_bo *bo); 352 353union gbm_bo_handle 354gbm_bo_get_handle(struct gbm_bo *bo); 355 356int 357gbm_bo_get_fd(struct gbm_bo *bo); 358 359uint64_t 360gbm_bo_get_modifier(struct gbm_bo *bo); 361 362int 363gbm_bo_get_plane_count(struct gbm_bo *bo); 364 365union gbm_bo_handle 366gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane); 367 368int 369gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count); 370 371void 372gbm_bo_set_user_data(struct gbm_bo *bo, void *data, 373 void (*destroy_user_data)(struct gbm_bo *, void *)); 374 375void * 376gbm_bo_get_user_data(struct gbm_bo *bo); 377 378void 379gbm_bo_destroy(struct gbm_bo *bo); 380 381struct gbm_surface * 382gbm_surface_create(struct gbm_device *gbm, 383 uint32_t width, uint32_t height, 384 uint32_t format, uint32_t flags); 385 386struct gbm_surface * 387gbm_surface_create_with_modifiers(struct gbm_device *gbm, 388 uint32_t width, uint32_t height, 389 uint32_t format, 390 const uint64_t *modifiers, 391 const unsigned int count); 392 393struct gbm_bo * 394gbm_surface_lock_front_buffer(struct gbm_surface *surface); 395 396void 397gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo); 398 399int 400gbm_surface_has_free_buffers(struct gbm_surface *surface); 401 402void 403gbm_surface_destroy(struct gbm_surface *surface); 404 405char * 406gbm_format_get_name(uint32_t gbm_format, struct gbm_format_name_desc *desc); 407 408#ifdef __cplusplus 409} 410#endif 411 412#endif 413