gbm.h

   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
  37 extern "C" {
  38 #endif
  39
  40
  41 /**
  42  * \file gbm.h
  43  * \brief Generic Buffer Manager
  44  */
  45
  46 struct gbm_device;
  47 struct gbm_bo;
  48 struct 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  */
  64 union 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 */
  73 enum 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 /*
 154  * Floating point 64bpp RGB
 155  * IEEE 754-2008 binary16 half-precision float
 156  * [15:0] sign:exponent:mantissa 1:5:10
 157  */
 158 #define GBM_FORMAT_XBGR16161616F __gbm_fourcc_code('X', 'B', '4', 'H') /* [63:0] x:B:G:R 16:16:16:16 little endian */
 159
 160 #define GBM_FORMAT_ABGR16161616F __gbm_fourcc_code('A', 'B', '4', 'H') /* [63:0] A:B:G:R 16:16:16:16 little endian */
 161
 162 /* packed YCbCr */
 163 #define GBM_FORMAT_YUYV         __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */
 164 #define GBM_FORMAT_YVYU         __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */
 165 #define GBM_FORMAT_UYVY         __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */
 166 #define GBM_FORMAT_VYUY         __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */
 167
 168 #define GBM_FORMAT_AYUV         __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */
 169
 170 /*
 171  * 2 plane YCbCr
 172  * index 0 = Y plane, [7:0] Y
 173  * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
 174  * or
 175  * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
 176  */
 177 #define GBM_FORMAT_NV12         __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */
 178 #define GBM_FORMAT_NV21         __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */
 179 #define GBM_FORMAT_NV16         __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */
 180 #define GBM_FORMAT_NV61         __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */
 181
 182 /*
 183  * 3 plane YCbCr
 184  * index 0: Y plane, [7:0] Y
 185  * index 1: Cb plane, [7:0] Cb
 186  * index 2: Cr plane, [7:0] Cr
 187  * or
 188  * index 1: Cr plane, [7:0] Cr
 189  * index 2: Cb plane, [7:0] Cb
 190  */
 191 #define GBM_FORMAT_YUV410       __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */
 192 #define GBM_FORMAT_YVU410       __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */
 193 #define GBM_FORMAT_YUV411       __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */
 194 #define GBM_FORMAT_YVU411       __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */
 195 #define GBM_FORMAT_YUV420       __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */
 196 #define GBM_FORMAT_YVU420       __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */
 197 #define GBM_FORMAT_YUV422       __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */
 198 #define GBM_FORMAT_YVU422       __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */
 199 #define GBM_FORMAT_YUV444       __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */
 200 #define GBM_FORMAT_YVU444       __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */
 201
 202 struct gbm_format_name_desc {
 203    char name[5];
 204 };
 205
 206 /**
 207  * Flags to indicate the intended use for the buffer - these are passed into
 208  * gbm_bo_create(). The caller must set the union of all the flags that are
 209  * appropriate
 210  *
 211  * \sa Use gbm_device_is_format_supported() to check if the combination of format
 212  * and use flags are supported
 213  */
 214 enum gbm_bo_flags {
 215    /**
 216     * Buffer is going to be presented to the screen using an API such as KMS
 217     */
 218    GBM_BO_USE_SCANOUT      = (1 << 0),
 219    /**
 220     * Buffer is going to be used as cursor
 221     */
 222    GBM_BO_USE_CURSOR       = (1 << 1),
 223    /**
 224     * Deprecated
 225     */
 226    GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR,
 227    /**
 228     * Buffer is to be used for rendering - for example it is going to be used
 229     * as the storage for a color buffer
 230     */
 231    GBM_BO_USE_RENDERING    = (1 << 2),
 232    /**
 233     * Buffer can be used for gbm_bo_write.  This is guaranteed to work
 234     * with GBM_BO_USE_CURSOR, but may not work for other combinations.
 235     */
 236    GBM_BO_USE_WRITE    = (1 << 3),
 237    /**
 238     * Buffer is linear, i.e. not tiled.
 239     */
 240    GBM_BO_USE_LINEAR = (1 << 4),
 241 };
 242
 243 int
 244 gbm_device_get_fd(struct gbm_device *gbm);
 245
 246 const char *
 247 gbm_device_get_backend_name(struct gbm_device *gbm);
 248
 249 int
 250 gbm_device_is_format_supported(struct gbm_device *gbm,
 251                                uint32_t format, uint32_t usage);
 252
 253 int
 254 gbm_device_get_format_modifier_plane_count(struct gbm_device *gbm,
 255                                            uint32_t format,
 256                                            uint64_t modifier);
 257
 258 void
 259 gbm_device_destroy(struct gbm_device *gbm);
 260
 261 struct gbm_device *
 262 gbm_create_device(int fd);
 263
 264 struct gbm_bo *
 265 gbm_bo_create(struct gbm_device *gbm,
 266               uint32_t width, uint32_t height,
 267               uint32_t format, uint32_t flags);
 268
 269 struct gbm_bo *
 270 gbm_bo_create_with_modifiers(struct gbm_device *gbm,
 271                              uint32_t width, uint32_t height,
 272                              uint32_t format,
 273                              const uint64_t *modifiers,
 274                              const unsigned int count);
 275 #define GBM_BO_IMPORT_WL_BUFFER         0x5501
 276 #define GBM_BO_IMPORT_EGL_IMAGE         0x5502
 277 #define GBM_BO_IMPORT_FD                0x5503
 278 #define GBM_BO_IMPORT_FD_MODIFIER       0x5504
 279
 280 struct gbm_import_fd_data {
 281    int fd;
 282    uint32_t width;
 283    uint32_t height;
 284    uint32_t stride;
 285    uint32_t format;
 286 };
 287
 288 #define GBM_MAX_PLANES 4
 289
 290 struct gbm_import_fd_modifier_data {
 291    uint32_t width;
 292    uint32_t height;
 293    uint32_t format;
 294    uint32_t num_fds;
 295    int fds[GBM_MAX_PLANES];
 296    int strides[GBM_MAX_PLANES];
 297    int offsets[GBM_MAX_PLANES];
 298    uint64_t modifier;
 299 };
 300
 301 struct gbm_bo *
 302 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
 303               void *buffer, uint32_t usage);
 304
 305 /**
 306  * Flags to indicate the type of mapping for the buffer - these are
 307  * passed into gbm_bo_map(). The caller must set the union of all the
 308  * flags that are appropriate.
 309  *
 310  * These flags are independent of the GBM_BO_USE_* creation flags. However,
 311  * mapping the buffer may require copying to/from a staging buffer.
 312  *
 313  * See also: pipe_transfer_usage
 314  */
 315 enum gbm_bo_transfer_flags {
 316    /**
 317     * Buffer contents read back (or accessed directly) at transfer
 318     * create time.
 319     */
 320    GBM_BO_TRANSFER_READ       = (1 << 0),
 321    /**
 322     * Buffer contents will be written back at unmap time
 323     * (or modified as a result of being accessed directly).
 324     */
 325    GBM_BO_TRANSFER_WRITE      = (1 << 1),
 326    /**
 327     * Read/modify/write
 328     */
 329    GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE),
 330 };
 331
 332 void *
 333 gbm_bo_map(struct gbm_bo *bo,
 334            uint32_t x, uint32_t y, uint32_t width, uint32_t height,
 335            uint32_t flags, uint32_t *stride, void **map_data);
 336
 337 void
 338 gbm_bo_unmap(struct gbm_bo *bo, void *map_data);
 339
 340 uint32_t
 341 gbm_bo_get_width(struct gbm_bo *bo);
 342
 343 uint32_t
 344 gbm_bo_get_height(struct gbm_bo *bo);
 345
 346 uint32_t
 347 gbm_bo_get_stride(struct gbm_bo *bo);
 348
 349 uint32_t
 350 gbm_bo_get_stride_for_plane(struct gbm_bo *bo, int plane);
 351
 352 uint32_t
 353 gbm_bo_get_format(struct gbm_bo *bo);
 354
 355 uint32_t
 356 gbm_bo_get_bpp(struct gbm_bo *bo);
 357
 358 uint32_t
 359 gbm_bo_get_offset(struct gbm_bo *bo, int plane);
 360
 361 struct gbm_device *
 362 gbm_bo_get_device(struct gbm_bo *bo);
 363
 364 union gbm_bo_handle
 365 gbm_bo_get_handle(struct gbm_bo *bo);
 366
 367 int
 368 gbm_bo_get_fd(struct gbm_bo *bo);
 369
 370 uint64_t
 371 gbm_bo_get_modifier(struct gbm_bo *bo);
 372
 373 int
 374 gbm_bo_get_plane_count(struct gbm_bo *bo);
 375
 376 union gbm_bo_handle
 377 gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane);
 378
 379 int
 380 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count);
 381
 382 void
 383 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
 384                      void (*destroy_user_data)(struct gbm_bo *, void *));
 385
 386 void *
 387 gbm_bo_get_user_data(struct gbm_bo *bo);
 388
 389 void
 390 gbm_bo_destroy(struct gbm_bo *bo);
 391
 392 struct gbm_surface *
 393 gbm_surface_create(struct gbm_device *gbm,
 394                    uint32_t width, uint32_t height,
 395                    uint32_t format, uint32_t flags);
 396
 397 struct gbm_surface *
 398 gbm_surface_create_with_modifiers(struct gbm_device *gbm,
 399                                   uint32_t width, uint32_t height,
 400                                   uint32_t format,
 401                                   const uint64_t *modifiers,
 402                                   const unsigned int count);
 403
 404 struct gbm_bo *
 405 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
 406
 407 void
 408 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
 409
 410 int
 411 gbm_surface_has_free_buffers(struct gbm_surface *surface);
 412
 413 void
 414 gbm_surface_destroy(struct gbm_surface *surface);
 415
 416 char *
 417 gbm_format_get_name(uint32_t gbm_format, struct gbm_format_name_desc *desc);
 418
 419 #ifdef __cplusplus
 420 }
 421 #endif
 422
 423 #endif