• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <stddef.h>
39 #include <stdint.h>
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 #define GBM_MAX_PLANES 4
73 
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))
76 
77 #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */
78 
79 /* color index */
80 #define GBM_FORMAT_C8		__gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
81 
82 /* 8 bpp Red */
83 #define GBM_FORMAT_R8		__gbm_fourcc_code('R', '8', ' ', ' ') /* [7:0] R */
84 
85 /* 16 bpp RG */
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 */
88 
89 /* 8 bpp RGB */
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 */
92 
93 /* 16 bpp RGB */
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 */
98 
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 */
103 
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 */
108 
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 */
113 
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 */
116 
117 /* 24 bpp RGB */
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 */
120 
121 /* 32 bpp RGB */
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 */
126 
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 */
131 
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 */
136 
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 */
141 
142 /* packed YCbCr */
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 */
147 
148 #define GBM_FORMAT_AYUV		__gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */
149 
150 /*
151  * 2 plane YCbCr
152  * index 0 = Y plane, [7:0] Y
153  * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
154  * or
155  * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
156  */
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 */
161 
162 /*
163  * 3 plane YCbCr
164  * index 0: Y plane, [7:0] Y
165  * index 1: Cb plane, [7:0] Cb
166  * index 2: Cr plane, [7:0] Cr
167  * or
168  * index 1: Cr plane, [7:0] Cr
169  * index 2: Cb plane, [7:0] Cb
170  */
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 */
181 
182 /*
183  * Format Modifiers:
184  *
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.
188  *
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.
191  */
192 
193 /* Vendor Ids: */
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 */
201 
202 #define gbm_fourcc_mod_code(vendor, val) \
203 	((((__u64)GBM_FORMAT_MOD_VENDOR_## vendor) << 56) | (val & 0x00ffffffffffffffULL))
204 
205 /**
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
208  * appropriate
209  *
210  * \sa Use gbm_device_is_format_supported() to check if the combination of format
211  * and use flags are supported
212  */
213 enum gbm_bo_flags {
214    /**
215     * Buffer is going to be presented to the screen using an API such as KMS
216     */
217    GBM_BO_USE_SCANOUT      = (1 << 0),
218    /**
219     * Buffer is going to be used as cursor
220     */
221    GBM_BO_USE_CURSOR       = (1 << 1),
222    /**
223     * Deprecated
224     */
225    GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR,
226    /**
227     * Buffer is to be used for rendering - for example it is going to be used
228     * as the storage for a color buffer
229     */
230    GBM_BO_USE_RENDERING    = (1 << 2),
231    /**
232     * Deprecated
233     */
234    GBM_BO_USE_WRITE    = (1 << 3),
235    /**
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().
241     */
242    GBM_BO_USE_LINEAR    = (1 << 4),
243    /**
244     * The buffer will be used as a texture that will be sampled from.
245     */
246    GBM_BO_USE_TEXTURING    = (1 << 5),
247    /**
248     * The buffer will be written to by a camera subsystem.
249     */
250    GBM_BO_USE_CAMERA_WRITE = (1 << 6),
251    /**
252     * The buffer will be read from by a camera subsystem.
253     */
254    GBM_BO_USE_CAMERA_READ = (1 << 7),
255    /**
256     * Buffer inaccessible to unprivileged users.
257     */
258    GBM_BO_USE_PROTECTED = (1 << 8),
259    /**
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.
263     */
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),
268    /**
269     * The buffer will be written by a video decode accelerator.
270     */
271    GBM_BO_USE_HW_VIDEO_DECODER = (1 << 13),
272 };
273 
274 int
275 gbm_device_get_fd(struct gbm_device *gbm);
276 
277 const char *
278 gbm_device_get_backend_name(struct gbm_device *gbm);
279 
280 int
281 gbm_device_is_format_supported(struct gbm_device *gbm,
282                                uint32_t format, uint32_t usage);
283 
284 void
285 gbm_device_destroy(struct gbm_device *gbm);
286 
287 struct gbm_device *
288 gbm_create_device(int fd);
289 
290 struct gbm_bo *
291 gbm_bo_create(struct gbm_device *gbm,
292               uint32_t width, uint32_t height,
293               uint32_t format, uint32_t flags);
294 
295 struct gbm_bo *
296 gbm_bo_create_with_modifiers(struct gbm_device *gbm,
297                              uint32_t width, uint32_t height,
298                              uint32_t format,
299                              const uint64_t *modifiers, uint32_t count);
300 
301 #define GBM_BO_IMPORT_WL_BUFFER         0x5501
302 #define GBM_BO_IMPORT_EGL_IMAGE         0x5502
303 #define GBM_BO_IMPORT_FD                0x5503
304 #define GBM_BO_IMPORT_FD_PLANAR         0x5504
305 
306 struct gbm_import_fd_data {
307    int fd;
308    uint32_t width;
309    uint32_t height;
310    uint32_t stride;
311    uint32_t format;
312 };
313 
314 struct gbm_import_fd_planar_data {
315    int fds[GBM_MAX_PLANES];
316    uint32_t width;
317    uint32_t height;
318    uint32_t format;
319    uint32_t strides[GBM_MAX_PLANES];
320    uint32_t offsets[GBM_MAX_PLANES];
321    uint64_t format_modifiers[GBM_MAX_PLANES];
322 };
323 
324 struct gbm_bo *
325 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
326               void *buffer, uint32_t usage);
327 
328 /**
329  * Flags to indicate the type of mapping for the buffer - these are
330  * passed into gbm_bo_map(). The caller must set the union of all the
331  * flags that are appropriate.
332  *
333  * These flags are independent of the GBM_BO_USE_* creation flags. However,
334  * mapping the buffer may require copying to/from a staging buffer.
335  *
336  * See also: pipe_transfer_usage
337  */
338 enum gbm_bo_transfer_flags {
339    /**
340     * Buffer contents read back (or accessed directly) at transfer
341     * create time.
342     */
343    GBM_BO_TRANSFER_READ       = (1 << 0),
344    /**
345     * Buffer contents will be written back at unmap time
346     * (or modified as a result of being accessed directly).
347     */
348    GBM_BO_TRANSFER_WRITE      = (1 << 1),
349    /**
350     * Read/modify/write
351     */
352    GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE),
353 };
354 
355 void *
356 gbm_bo_map(struct gbm_bo *bo,
357            uint32_t x, uint32_t y, uint32_t width, uint32_t height,
358            uint32_t flags, uint32_t *stride, void **map_data, size_t plane);
359 
360 void
361 gbm_bo_unmap(struct gbm_bo *bo, void *map_data);
362 
363 uint32_t
364 gbm_bo_get_width(struct gbm_bo *bo);
365 
366 uint32_t
367 gbm_bo_get_height(struct gbm_bo *bo);
368 
369 uint32_t
370 gbm_bo_get_stride(struct gbm_bo *bo);
371 
372 /* Tegra bringup hack to pass tiling parameters at EGLImage creation. */
373 uint32_t
374 gbm_bo_get_stride_or_tiling(struct gbm_bo *bo);
375 
376 uint32_t
377 gbm_bo_get_format(struct gbm_bo *bo);
378 
379 uint64_t
380 gbm_bo_get_format_modifier(struct gbm_bo *bo);
381 
382 struct gbm_device *
383 gbm_bo_get_device(struct gbm_bo *bo);
384 
385 union gbm_bo_handle
386 gbm_bo_get_handle(struct gbm_bo *bo);
387 
388 int
389 gbm_bo_get_fd(struct gbm_bo *bo);
390 
391 size_t
392 gbm_bo_get_num_planes(struct gbm_bo *bo);
393 
394 union gbm_bo_handle
395 gbm_bo_get_plane_handle(struct gbm_bo *bo, size_t plane);
396 
397 int
398 gbm_bo_get_plane_fd(struct gbm_bo *bo, size_t plane);
399 
400 uint32_t
401 gbm_bo_get_plane_offset(struct gbm_bo *bo, size_t plane);
402 
403 uint32_t
404 gbm_bo_get_plane_size(struct gbm_bo *bo, size_t plane);
405 
406 uint32_t
407 gbm_bo_get_plane_stride(struct gbm_bo *bo, size_t plane);
408 
409 uint64_t
410 gbm_bo_get_plane_format_modifier(struct gbm_bo *bo, size_t plane);
411 
412 void
413 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
414 		     void (*destroy_user_data)(struct gbm_bo *, void *));
415 
416 void *
417 gbm_bo_get_user_data(struct gbm_bo *bo);
418 
419 void
420 gbm_bo_destroy(struct gbm_bo *bo);
421 
422 struct gbm_surface *
423 gbm_surface_create(struct gbm_device *gbm,
424                    uint32_t width, uint32_t height,
425 		   uint32_t format, uint32_t flags);
426 
427 struct gbm_bo *
428 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
429 
430 void
431 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
432 
433 int
434 gbm_surface_has_free_buffers(struct gbm_surface *surface);
435 
436 void
437 gbm_surface_destroy(struct gbm_surface *surface);
438 
439 #ifdef __cplusplus
440 }
441 #endif
442 
443 #endif
444