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