gbm.h: Add a missing stddef.h include for size_t.
[mesa.git] / src / gbm / main / 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 <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 /** 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 #define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \
81 ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
82
83 #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */
84
85 /* color index */
86 #define GBM_FORMAT_C8 __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
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 /**
183 * Flags to indicate the intended use for the buffer - these are passed into
184 * gbm_bo_create(). The caller must set the union of all the flags that are
185 * appropriate
186 *
187 * \sa Use gbm_device_is_format_supported() to check if the combination of format
188 * and use flags are supported
189 */
190 enum gbm_bo_flags {
191 /**
192 * Buffer is going to be presented to the screen using an API such as KMS
193 */
194 GBM_BO_USE_SCANOUT = (1 << 0),
195 /**
196 * Buffer is going to be used as cursor
197 */
198 GBM_BO_USE_CURSOR = (1 << 1),
199 /**
200 * Deprecated
201 */
202 GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR,
203 /**
204 * Buffer is to be used for rendering - for example it is going to be used
205 * as the storage for a color buffer
206 */
207 GBM_BO_USE_RENDERING = (1 << 2),
208 /**
209 * Buffer can be used for gbm_bo_write. This is guaranteed to work
210 * with GBM_BO_USE_CURSOR. but may not work for other combinations.
211 */
212 GBM_BO_USE_WRITE = (1 << 3),
213 /**
214 * Buffer is linear, i.e. not tiled.
215 */
216 GBM_BO_USE_LINEAR = (1 << 4),
217 };
218
219 int
220 gbm_device_get_fd(struct gbm_device *gbm);
221
222 const char *
223 gbm_device_get_backend_name(struct gbm_device *gbm);
224
225 int
226 gbm_device_is_format_supported(struct gbm_device *gbm,
227 uint32_t format, uint32_t usage);
228
229 void
230 gbm_device_destroy(struct gbm_device *gbm);
231
232 struct gbm_device *
233 gbm_create_device(int fd);
234
235 struct gbm_bo *
236 gbm_bo_create(struct gbm_device *gbm,
237 uint32_t width, uint32_t height,
238 uint32_t format, uint32_t flags);
239
240 #define GBM_BO_IMPORT_WL_BUFFER 0x5501
241 #define GBM_BO_IMPORT_EGL_IMAGE 0x5502
242 #define GBM_BO_IMPORT_FD 0x5503
243
244 struct gbm_import_fd_data {
245 int fd;
246 uint32_t width;
247 uint32_t height;
248 uint32_t stride;
249 uint32_t format;
250 };
251
252 struct gbm_bo *
253 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
254 void *buffer, uint32_t usage);
255
256 uint32_t
257 gbm_bo_get_width(struct gbm_bo *bo);
258
259 uint32_t
260 gbm_bo_get_height(struct gbm_bo *bo);
261
262 uint32_t
263 gbm_bo_get_stride(struct gbm_bo *bo);
264
265 uint32_t
266 gbm_bo_get_format(struct gbm_bo *bo);
267
268 struct gbm_device *
269 gbm_bo_get_device(struct gbm_bo *bo);
270
271 union gbm_bo_handle
272 gbm_bo_get_handle(struct gbm_bo *bo);
273
274 int
275 gbm_bo_get_fd(struct gbm_bo *bo);
276
277 int
278 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count);
279
280 void
281 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
282 void (*destroy_user_data)(struct gbm_bo *, void *));
283
284 void *
285 gbm_bo_get_user_data(struct gbm_bo *bo);
286
287 void
288 gbm_bo_destroy(struct gbm_bo *bo);
289
290 struct gbm_surface *
291 gbm_surface_create(struct gbm_device *gbm,
292 uint32_t width, uint32_t height,
293 uint32_t format, uint32_t flags);
294
295 int
296 gbm_surface_needs_lock_front_buffer(struct gbm_surface *surface);
297
298 struct gbm_bo *
299 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
300
301 void
302 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
303
304 int
305 gbm_surface_has_free_buffers(struct gbm_surface *surface);
306
307 void
308 gbm_surface_destroy(struct gbm_surface *surface);
309
310 #ifdef __cplusplus
311 }
312 #endif
313
314 #endif