2 * Copyright © 2011 Intel Corporation
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:
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
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.
25 * Benjamin Franzke <benjaminfranzke@googlemail.com>
43 * \brief Generic Buffer Manager
51 * \mainpage The Generic Buffer Manager
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.
56 * This allows the creation of portable code whilst still allowing access to
57 * the underlying memory manager.
61 * Abstraction representing the handle to a buffer allocated by the
72 #define GBM_MAX_PLANES 4
74 #define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \
75 ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
77 #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */
80 #define GBM_FORMAT_C8 __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
83 #define GBM_FORMAT_R8 __gbm_fourcc_code('R', '8', ' ', ' ') /* [7:0] R */
86 #define GBM_FORMAT_RG88 __gbm_fourcc_code('R', 'G', '8', '8') /* [15:0] R:G 8:8 little endian */
87 #define GBM_FORMAT_GR88 __gbm_fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */
90 #define GBM_FORMAT_RGB332 __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */
91 #define GBM_FORMAT_BGR233 __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */
94 #define GBM_FORMAT_XRGB4444 __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */
95 #define GBM_FORMAT_XBGR4444 __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */
96 #define GBM_FORMAT_RGBX4444 __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */
97 #define GBM_FORMAT_BGRX4444 __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */
99 #define GBM_FORMAT_ARGB4444 __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */
100 #define GBM_FORMAT_ABGR4444 __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */
101 #define GBM_FORMAT_RGBA4444 __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */
102 #define GBM_FORMAT_BGRA4444 __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */
104 #define GBM_FORMAT_XRGB1555 __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */
105 #define GBM_FORMAT_XBGR1555 __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */
106 #define GBM_FORMAT_RGBX5551 __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */
107 #define GBM_FORMAT_BGRX5551 __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */
109 #define GBM_FORMAT_ARGB1555 __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */
110 #define GBM_FORMAT_ABGR1555 __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */
111 #define GBM_FORMAT_RGBA5551 __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */
112 #define GBM_FORMAT_BGRA5551 __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */
114 #define GBM_FORMAT_RGB565 __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */
115 #define GBM_FORMAT_BGR565 __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */
118 #define GBM_FORMAT_RGB888 __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */
119 #define GBM_FORMAT_BGR888 __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */
122 #define GBM_FORMAT_XRGB8888 __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */
123 #define GBM_FORMAT_XBGR8888 __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */
124 #define GBM_FORMAT_RGBX8888 __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */
125 #define GBM_FORMAT_BGRX8888 __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */
127 #define GBM_FORMAT_ARGB8888 __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */
128 #define GBM_FORMAT_ABGR8888 __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */
129 #define GBM_FORMAT_RGBA8888 __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */
130 #define GBM_FORMAT_BGRA8888 __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */
132 #define GBM_FORMAT_XRGB2101010 __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */
133 #define GBM_FORMAT_XBGR2101010 __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */
134 #define GBM_FORMAT_RGBX1010102 __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */
135 #define GBM_FORMAT_BGRX1010102 __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */
137 #define GBM_FORMAT_ARGB2101010 __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */
138 #define GBM_FORMAT_ABGR2101010 __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */
139 #define GBM_FORMAT_RGBA1010102 __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */
140 #define GBM_FORMAT_BGRA1010102 __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */
143 #define GBM_FORMAT_YUYV __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */
144 #define GBM_FORMAT_YVYU __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */
145 #define GBM_FORMAT_UYVY __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */
146 #define GBM_FORMAT_VYUY __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */
148 #define GBM_FORMAT_AYUV __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */
152 * index 0 = Y plane, [7:0] Y
153 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
155 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
157 #define GBM_FORMAT_NV12 __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */
158 #define GBM_FORMAT_NV21 __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */
159 #define GBM_FORMAT_NV16 __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */
160 #define GBM_FORMAT_NV61 __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */
164 * index 0: Y plane, [7:0] Y
165 * index 1: Cb plane, [7:0] Cb
166 * index 2: Cr plane, [7:0] Cr
168 * index 1: Cr plane, [7:0] Cr
169 * index 2: Cb plane, [7:0] Cb
171 #define GBM_FORMAT_YUV410 __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */
172 #define GBM_FORMAT_YVU410 __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */
173 #define GBM_FORMAT_YUV411 __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */
174 #define GBM_FORMAT_YVU411 __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */
175 #define GBM_FORMAT_YUV420 __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */
176 #define GBM_FORMAT_YVU420 __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */
177 #define GBM_FORMAT_YUV422 __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */
178 #define GBM_FORMAT_YVU422 __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */
179 #define GBM_FORMAT_YUV444 __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */
180 #define GBM_FORMAT_YVU444 __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */
185 * Format modifiers describe, typically, a re-ordering or modification
186 * of the data in a plane of an FB. This can be used to express tiled/
187 * swizzled formats, or compression, or a combination of the two.
189 * The upper 8 bits of the format modifier are a vendor-id as assigned
190 * below. The lower 56 bits are assigned as vendor sees fit.
194 #define GBM_FORMAT_MOD_NONE 0
195 #define GBM_FORMAT_MOD_VENDOR_INTEL 0x01
196 #define GBM_FORMAT_MOD_VENDOR_AMD 0x02
197 #define GBM_FORMAT_MOD_VENDOR_NV 0x03
198 #define GBM_FORMAT_MOD_VENDOR_SAMSUNG 0x04
199 #define GBM_FORMAT_MOD_VENDOR_QCOM 0x05
200 /* add more to the end as needed */
202 #define gbm_fourcc_mod_code(vendor, val) \
203 ((((__u64)GBM_FORMAT_MOD_VENDOR_## vendor) << 56) | (val & 0x00ffffffffffffffULL))
206 * Flags to indicate the intended use for the buffer - these are passed into
207 * gbm_bo_create(). The caller must set the union of all the flags that are
210 * \sa Use gbm_device_is_format_supported() to check if the combination of format
211 * and use flags are supported
215 * Buffer is going to be presented to the screen using an API such as KMS
217 GBM_BO_USE_SCANOUT = (1 << 0),
219 * Buffer is going to be used as cursor
221 GBM_BO_USE_CURSOR = (1 << 1),
225 GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR,
227 * Buffer is to be used for rendering - for example it is going to be used
228 * as the storage for a color buffer
230 GBM_BO_USE_RENDERING = (1 << 2),
234 GBM_BO_USE_WRITE = (1 << 3),
236 * Buffer is guaranteed to be laid out linearly in memory. That is, the
237 * buffer is laid out as an array with 'height' blocks, each block with
238 * length 'stride'. Each stride is in the same order as the rows of the
239 * buffer. This is intended to be used with buffers that will be accessed
240 * via dma-buf mmap().
242 GBM_BO_USE_LINEAR = (1 << 4),
244 * The buffer will be used as a texture that will be sampled from.
246 GBM_BO_USE_TEXTURING = (1 << 5),
248 * The buffer will be written to by a camera subsystem.
250 GBM_BO_USE_CAMERA_WRITE = (1 << 6),
252 * The buffer will be read from by a camera subsystem.
254 GBM_BO_USE_CAMERA_READ = (1 << 7),
256 * Buffer inaccessible to unprivileged users.
258 GBM_BO_USE_PROTECTED = (1 << 8),
260 * These flags specify the frequency of software access. These flags do not
261 * guarantee the buffer is linear, but do guarantee gbm_bo_map(..) will
262 * present a linear view.
264 GBM_BO_USE_SW_READ_OFTEN = (1 << 9),
265 GBM_BO_USE_SW_READ_RARELY = (1 << 10),
266 GBM_BO_USE_SW_WRITE_OFTEN = (1 << 11),
267 GBM_BO_USE_SW_WRITE_RARELY = (1 << 12),
271 gbm_device_get_fd(struct gbm_device *gbm);
274 gbm_device_get_backend_name(struct gbm_device *gbm);
277 gbm_device_is_format_supported(struct gbm_device *gbm,
278 uint32_t format, uint32_t usage);
281 gbm_device_destroy(struct gbm_device *gbm);
284 gbm_create_device(int fd);
287 gbm_bo_create(struct gbm_device *gbm,
288 uint32_t width, uint32_t height,
289 uint32_t format, uint32_t flags);
292 gbm_bo_create_with_modifiers(struct gbm_device *gbm,
293 uint32_t width, uint32_t height,
295 const uint64_t *modifiers, uint32_t count);
297 #define GBM_BO_IMPORT_WL_BUFFER 0x5501
298 #define GBM_BO_IMPORT_EGL_IMAGE 0x5502
299 #define GBM_BO_IMPORT_FD 0x5503
300 #define GBM_BO_IMPORT_FD_PLANAR 0x5504
302 struct gbm_import_fd_data {
310 struct gbm_import_fd_planar_data {
311 int fds[GBM_MAX_PLANES];
315 uint32_t strides[GBM_MAX_PLANES];
316 uint32_t offsets[GBM_MAX_PLANES];
317 uint64_t format_modifiers[GBM_MAX_PLANES];
321 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
322 void *buffer, uint32_t usage);
325 * Flags to indicate the type of mapping for the buffer - these are
326 * passed into gbm_bo_map(). The caller must set the union of all the
327 * flags that are appropriate.
329 * These flags are independent of the GBM_BO_USE_* creation flags. However,
330 * mapping the buffer may require copying to/from a staging buffer.
332 * See also: pipe_transfer_usage
334 enum gbm_bo_transfer_flags {
336 * Buffer contents read back (or accessed directly) at transfer
339 GBM_BO_TRANSFER_READ = (1 << 0),
341 * Buffer contents will be written back at unmap time
342 * (or modified as a result of being accessed directly).
344 GBM_BO_TRANSFER_WRITE = (1 << 1),
348 GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE),
352 gbm_bo_map(struct gbm_bo *bo,
353 uint32_t x, uint32_t y, uint32_t width, uint32_t height,
354 uint32_t flags, uint32_t *stride, void **map_data, size_t plane);
357 gbm_bo_unmap(struct gbm_bo *bo, void *map_data);
360 gbm_bo_get_width(struct gbm_bo *bo);
363 gbm_bo_get_height(struct gbm_bo *bo);
366 gbm_bo_get_stride(struct gbm_bo *bo);
368 /* Tegra bringup hack to pass tiling parameters at EGLImage creation. */
370 gbm_bo_get_stride_or_tiling(struct gbm_bo *bo);
373 gbm_bo_get_format(struct gbm_bo *bo);
376 gbm_bo_get_format_modifier(struct gbm_bo *bo);
379 gbm_bo_get_device(struct gbm_bo *bo);
382 gbm_bo_get_handle(struct gbm_bo *bo);
385 gbm_bo_get_fd(struct gbm_bo *bo);
388 gbm_bo_get_num_planes(struct gbm_bo *bo);
391 gbm_bo_get_plane_handle(struct gbm_bo *bo, size_t plane);
394 gbm_bo_get_plane_fd(struct gbm_bo *bo, size_t plane);
397 gbm_bo_get_plane_offset(struct gbm_bo *bo, size_t plane);
400 gbm_bo_get_plane_size(struct gbm_bo *bo, size_t plane);
403 gbm_bo_get_plane_stride(struct gbm_bo *bo, size_t plane);
406 gbm_bo_get_plane_format_modifier(struct gbm_bo *bo, size_t plane);
409 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
410 void (*destroy_user_data)(struct gbm_bo *, void *));
413 gbm_bo_get_user_data(struct gbm_bo *bo);
416 gbm_bo_destroy(struct gbm_bo *bo);
419 gbm_surface_create(struct gbm_device *gbm,
420 uint32_t width, uint32_t height,
421 uint32_t format, uint32_t flags);
424 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
427 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
430 gbm_surface_has_free_buffers(struct gbm_surface *surface);
433 gbm_surface_destroy(struct gbm_surface *surface);