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 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35
  36 #define __GBM__ 1
  37
  38 #include <stdint.h>
  39
  40 /**
  41  * \file gbm.h
  42  * \brief Generic Buffer Manager
  43  */
  44
  45 struct gbm_device;
  46 struct gbm_bo;
  47 struct gbm_surface;
  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 #define GBM_MAX_PLANES 4
  72
  73 #define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \
  74                               ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
  75
  76 #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */
  77
  78 /* color index */
  79 #define GBM_FORMAT_C8           __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
  80
  81 /* 8 bpp Red */
  82 #define GBM_FORMAT_R8           __gbm_fourcc_code('R', '8', ' ', ' ') /* [7:0] R */
  83
  84 /* 16 bpp RG */
  85 #define GBM_FORMAT_RG88         __gbm_fourcc_code('R', 'G', '8', '8') /* [15:0] R:G 8:8 little endian */
  86 #define GBM_FORMAT_GR88         __gbm_fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */
  87
  88 /* 8 bpp RGB */
  89 #define GBM_FORMAT_RGB332       __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */
  90 #define GBM_FORMAT_BGR233       __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */
  91
  92 /* 16 bpp RGB */
  93 #define GBM_FORMAT_XRGB4444     __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */
  94 #define GBM_FORMAT_XBGR4444     __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */
  95 #define GBM_FORMAT_RGBX4444     __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */
  96 #define GBM_FORMAT_BGRX4444     __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */
  97
  98 #define GBM_FORMAT_ARGB4444     __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */
  99 #define GBM_FORMAT_ABGR4444     __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */
 100 #define GBM_FORMAT_RGBA4444     __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */
 101 #define GBM_FORMAT_BGRA4444     __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */
 102
 103 #define GBM_FORMAT_XRGB1555     __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */
 104 #define GBM_FORMAT_XBGR1555     __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */
 105 #define GBM_FORMAT_RGBX5551     __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */
 106 #define GBM_FORMAT_BGRX5551     __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */
 107
 108 #define GBM_FORMAT_ARGB1555     __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */
 109 #define GBM_FORMAT_ABGR1555     __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */
 110 #define GBM_FORMAT_RGBA5551     __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */
 111 #define GBM_FORMAT_BGRA5551     __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */
 112
 113 #define GBM_FORMAT_RGB565       __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */
 114 #define GBM_FORMAT_BGR565       __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */
 115
 116 /* 24 bpp RGB */
 117 #define GBM_FORMAT_RGB888       __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */
 118 #define GBM_FORMAT_BGR888       __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */
 119
 120 /* 32 bpp RGB */
 121 #define GBM_FORMAT_XRGB8888     __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */
 122 #define GBM_FORMAT_XBGR8888     __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */
 123 #define GBM_FORMAT_RGBX8888     __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */
 124 #define GBM_FORMAT_BGRX8888     __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */
 125
 126 #define GBM_FORMAT_ARGB8888     __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */
 127 #define GBM_FORMAT_ABGR8888     __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */
 128 #define GBM_FORMAT_RGBA8888     __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */
 129 #define GBM_FORMAT_BGRA8888     __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */
 130
 131 #define GBM_FORMAT_XRGB2101010  __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */
 132 #define GBM_FORMAT_XBGR2101010  __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */
 133 #define GBM_FORMAT_RGBX1010102  __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */
 134 #define GBM_FORMAT_BGRX1010102  __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */
 135
 136 #define GBM_FORMAT_ARGB2101010  __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */
 137 #define GBM_FORMAT_ABGR2101010  __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */
 138 #define GBM_FORMAT_RGBA1010102  __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */
 139 #define GBM_FORMAT_BGRA1010102  __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */
 140
 141 /* packed YCbCr */
 142 #define GBM_FORMAT_YUYV         __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */
 143 #define GBM_FORMAT_YVYU         __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */
 144 #define GBM_FORMAT_UYVY         __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */
 145 #define GBM_FORMAT_VYUY         __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */
 146
 147 #define GBM_FORMAT_AYUV         __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */
 148
 149 /*
 150  * 2 plane YCbCr
 151  * index 0 = Y plane, [7:0] Y
 152  * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
 153  * or
 154  * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
 155  */
 156 #define GBM_FORMAT_NV12         __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */
 157 #define GBM_FORMAT_NV21         __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */
 158 #define GBM_FORMAT_NV16         __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */
 159 #define GBM_FORMAT_NV61         __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */
 160
 161 /*
 162  * 3 plane YCbCr
 163  * index 0: Y plane, [7:0] Y
 164  * index 1: Cb plane, [7:0] Cb
 165  * index 2: Cr plane, [7:0] Cr
 166  * or
 167  * index 1: Cr plane, [7:0] Cr
 168  * index 2: Cb plane, [7:0] Cb
 169  */
 170 #define GBM_FORMAT_YUV410       __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */
 171 #define GBM_FORMAT_YVU410       __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */
 172 #define GBM_FORMAT_YUV411       __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */
 173 #define GBM_FORMAT_YVU411       __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */
 174 #define GBM_FORMAT_YUV420       __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */
 175 #define GBM_FORMAT_YVU420       __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */
 176 #define GBM_FORMAT_YUV422       __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */
 177 #define GBM_FORMAT_YVU422       __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */
 178 #define GBM_FORMAT_YUV444       __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */
 179 #define GBM_FORMAT_YVU444       __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */
 180
 181 /*
 182  * Format Modifiers:
 183  *
 184  * Format modifiers describe, typically, a re-ordering or modification
 185  * of the data in a plane of an FB.  This can be used to express tiled/
 186  * swizzled formats, or compression, or a combination of the two.
 187  *
 188  * The upper 8 bits of the format modifier are a vendor-id as assigned
 189  * below.  The lower 56 bits are assigned as vendor sees fit.
 190  */
 191
 192 /* Vendor Ids: */
 193 #define GBM_FORMAT_MOD_NONE           0
 194 #define GBM_FORMAT_MOD_VENDOR_INTEL   0x01
 195 #define GBM_FORMAT_MOD_VENDOR_AMD     0x02
 196 #define GBM_FORMAT_MOD_VENDOR_NV      0x03
 197 #define GBM_FORMAT_MOD_VENDOR_SAMSUNG 0x04
 198 #define GBM_FORMAT_MOD_VENDOR_QCOM    0x05
 199 /* add more to the end as needed */
 200
 201 #define gbm_fourcc_mod_code(vendor, val) \
 202         ((((__u64)GBM_FORMAT_MOD_VENDOR_## vendor) << 56) | (val & 0x00ffffffffffffffULL))
 203
 204 /**
 205  * Flags to indicate the intended use for the buffer - these are passed into
 206  * gbm_bo_create(). The caller must set the union of all the flags that are
 207  * appropriate
 208  *
 209  * \sa Use gbm_device_is_format_supported() to check if the combination of format
 210  * and use flags are supported
 211  */
 212 enum gbm_bo_flags {
 213    /**
 214     * Buffer is going to be presented to the screen using an API such as KMS
 215     */
 216    GBM_BO_USE_SCANOUT      = (1 << 0),
 217    /**
 218     * Buffer is going to be used as cursor
 219     */
 220    GBM_BO_USE_CURSOR       = (1 << 1),
 221    /**
 222     * Deprecated
 223     */
 224    GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR,
 225    /**
 226     * Buffer is to be used for rendering - for example it is going to be used
 227     * as the storage for a color buffer
 228     */
 229    GBM_BO_USE_RENDERING    = (1 << 2),
 230    /**
 231     * Deprecated
 232     */
 233    GBM_BO_USE_WRITE    = (1 << 3),
 234    /**
 235     * Buffer is guaranteed to be laid out linearly in memory. That is, the
 236     * buffer is laid out as an array with 'height' blocks, each block with
 237     * length 'stride'. Each stride is in the same order as the rows of the
 238     * buffer.
 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 void
 254 gbm_device_destroy(struct gbm_device *gbm);
 255
 256 struct gbm_device *
 257 gbm_create_device(int fd);
 258
 259 struct gbm_bo *
 260 gbm_bo_create(struct gbm_device *gbm,
 261               uint32_t width, uint32_t height,
 262               uint32_t format, uint32_t flags);
 263
 264 #define GBM_BO_IMPORT_WL_BUFFER         0x5501
 265 #define GBM_BO_IMPORT_EGL_IMAGE         0x5502
 266 #define GBM_BO_IMPORT_FD                0x5503
 267 #define GBM_BO_IMPORT_FD_PLANAR         0x5504
 268
 269 struct gbm_import_fd_data {
 270    int fd;
 271    uint32_t width;
 272    uint32_t height;
 273    uint32_t stride;
 274    uint32_t format;
 275 };
 276
 277 struct gbm_import_fd_planar_data {
 278    int fds[GBM_MAX_PLANES];
 279    uint32_t width;
 280    uint32_t height;
 281    uint32_t format;
 282    uint32_t strides[GBM_MAX_PLANES];
 283    uint32_t offsets[GBM_MAX_PLANES];
 284    uint64_t format_modifiers[GBM_MAX_PLANES];
 285 };
 286
 287 struct gbm_bo *
 288 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
 289               void *buffer, uint32_t usage);
 290
 291 /**
 292  * Flags to indicate the type of mapping for the buffer - these are
 293  * passed into gbm_bo_map(). The caller must set the union of all the
 294  * flags that are appropriate.
 295  *
 296  * These flags are independent of the GBM_BO_USE_* creation flags. However,
 297  * mapping the buffer may require copying to/from a staging buffer.
 298  *
 299  * See also: pipe_transfer_usage
 300  */
 301 enum gbm_bo_transfer_flags {
 302    /**
 303     * Buffer contents read back (or accessed directly) at transfer
 304     * create time.
 305     */
 306    GBM_BO_TRANSFER_READ       = (1 << 0),
 307    /**
 308     * Buffer contents will be written back at unmap time
 309     * (or modified as a result of being accessed directly).
 310     */
 311    GBM_BO_TRANSFER_WRITE      = (1 << 1),
 312    /**
 313     * Read/modify/write
 314     */
 315    GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE),
 316 };
 317
 318 void *
 319 gbm_bo_map(struct gbm_bo *bo,
 320            uint32_t x, uint32_t y, uint32_t width, uint32_t height,
 321            uint32_t flags, uint32_t *stride, void **map_data, size_t plane);
 322
 323 void
 324 gbm_bo_unmap(struct gbm_bo *bo, void *map_data);
 325
 326 uint32_t
 327 gbm_bo_get_width(struct gbm_bo *bo);
 328
 329 uint32_t
 330 gbm_bo_get_height(struct gbm_bo *bo);
 331
 332 uint32_t
 333 gbm_bo_get_stride(struct gbm_bo *bo);
 334
 335 /* Tegra bringup hack to pass tiling parameters at EGLImage creation. */
 336 uint32_t
 337 gbm_bo_get_stride_or_tiling(struct gbm_bo *bo);
 338
 339 uint32_t
 340 gbm_bo_get_format(struct gbm_bo *bo);
 341
 342 uint64_t
 343 gbm_bo_get_format_modifier(struct gbm_bo *bo);
 344
 345 struct gbm_device *
 346 gbm_bo_get_device(struct gbm_bo *bo);
 347
 348 union gbm_bo_handle
 349 gbm_bo_get_handle(struct gbm_bo *bo);
 350
 351 int
 352 gbm_bo_get_fd(struct gbm_bo *bo);
 353
 354 size_t
 355 gbm_bo_get_num_planes(struct gbm_bo *bo);
 356
 357 union gbm_bo_handle
 358 gbm_bo_get_plane_handle(struct gbm_bo *bo, size_t plane);
 359
 360 int
 361 gbm_bo_get_plane_fd(struct gbm_bo *bo, size_t plane);
 362
 363 uint32_t
 364 gbm_bo_get_plane_offset(struct gbm_bo *bo, size_t plane);
 365
 366 uint32_t
 367 gbm_bo_get_plane_size(struct gbm_bo *bo, size_t plane);
 368
 369 uint32_t
 370 gbm_bo_get_plane_stride(struct gbm_bo *bo, size_t plane);
 371
 372 uint64_t
 373 gbm_bo_get_plane_format_modifier(struct gbm_bo *bo, size_t plane);
 374
 375 void
 376 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
 377                      void (*destroy_user_data)(struct gbm_bo *, void *));
 378
 379 void *
 380 gbm_bo_get_user_data(struct gbm_bo *bo);
 381
 382 void
 383 gbm_bo_destroy(struct gbm_bo *bo);
 384
 385 struct gbm_surface *
 386 gbm_surface_create(struct gbm_device *gbm,
 387                    uint32_t width, uint32_t height,
 388                    uint32_t format, uint32_t flags);
 389
 390 struct gbm_bo *
 391 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
 392
 393 void
 394 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
 395
 396 int
 397 gbm_surface_has_free_buffers(struct gbm_surface *surface);
 398
 399 void
 400 gbm_surface_destroy(struct gbm_surface *surface);
 401
 402 #ifdef __cplusplus
 403 }
 404 #endif
 405
 406 #endif