9d2a0308766daeb7cbd290abce55eacc10f30d00
[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 <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 /** Format of the allocated buffer */
72 enum gbm_bo_format {
73 /** RGB with 8 bits per channel in a 32 bit value */
74 GBM_BO_FORMAT_XRGB8888,
75 /** ARGB with 8 bits per channel in a 32 bit value */
76 GBM_BO_FORMAT_ARGB8888
77 };
78
79 #define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \
80 ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
81
82 #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */
83
84 /* color index */
85 #define GBM_FORMAT_C8 __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
86
87 /* 8 bpp RGB */
88 #define GBM_FORMAT_RGB332 __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */
89 #define GBM_FORMAT_BGR233 __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */
90
91 /* 16 bpp RGB */
92 #define GBM_FORMAT_XRGB4444 __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */
93 #define GBM_FORMAT_XBGR4444 __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */
94 #define GBM_FORMAT_RGBX4444 __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */
95 #define GBM_FORMAT_BGRX4444 __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */
96
97 #define GBM_FORMAT_ARGB4444 __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */
98 #define GBM_FORMAT_ABGR4444 __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */
99 #define GBM_FORMAT_RGBA4444 __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */
100 #define GBM_FORMAT_BGRA4444 __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */
101
102 #define GBM_FORMAT_XRGB1555 __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */
103 #define GBM_FORMAT_XBGR1555 __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */
104 #define GBM_FORMAT_RGBX5551 __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */
105 #define GBM_FORMAT_BGRX5551 __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */
106
107 #define GBM_FORMAT_ARGB1555 __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */
108 #define GBM_FORMAT_ABGR1555 __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */
109 #define GBM_FORMAT_RGBA5551 __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */
110 #define GBM_FORMAT_BGRA5551 __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */
111
112 #define GBM_FORMAT_RGB565 __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */
113 #define GBM_FORMAT_BGR565 __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */
114
115 /* 24 bpp RGB */
116 #define GBM_FORMAT_RGB888 __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */
117 #define GBM_FORMAT_BGR888 __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */
118
119 /* 32 bpp RGB */
120 #define GBM_FORMAT_XRGB8888 __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */
121 #define GBM_FORMAT_XBGR8888 __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */
122 #define GBM_FORMAT_RGBX8888 __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */
123 #define GBM_FORMAT_BGRX8888 __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */
124
125 #define GBM_FORMAT_ARGB8888 __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */
126 #define GBM_FORMAT_ABGR8888 __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */
127 #define GBM_FORMAT_RGBA8888 __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */
128 #define GBM_FORMAT_BGRA8888 __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */
129
130 #define GBM_FORMAT_XRGB2101010 __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */
131 #define GBM_FORMAT_XBGR2101010 __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */
132 #define GBM_FORMAT_RGBX1010102 __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */
133 #define GBM_FORMAT_BGRX1010102 __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */
134
135 #define GBM_FORMAT_ARGB2101010 __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */
136 #define GBM_FORMAT_ABGR2101010 __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */
137 #define GBM_FORMAT_RGBA1010102 __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */
138 #define GBM_FORMAT_BGRA1010102 __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */
139
140 /* packed YCbCr */
141 #define GBM_FORMAT_YUYV __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */
142 #define GBM_FORMAT_YVYU __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */
143 #define GBM_FORMAT_UYVY __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */
144 #define GBM_FORMAT_VYUY __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */
145
146 #define GBM_FORMAT_AYUV __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */
147
148 /*
149 * 2 plane YCbCr
150 * index 0 = Y plane, [7:0] Y
151 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
152 * or
153 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
154 */
155 #define GBM_FORMAT_NV12 __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */
156 #define GBM_FORMAT_NV21 __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */
157 #define GBM_FORMAT_NV16 __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */
158 #define GBM_FORMAT_NV61 __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */
159
160 /*
161 * 3 plane YCbCr
162 * index 0: Y plane, [7:0] Y
163 * index 1: Cb plane, [7:0] Cb
164 * index 2: Cr plane, [7:0] Cr
165 * or
166 * index 1: Cr plane, [7:0] Cr
167 * index 2: Cb plane, [7:0] Cb
168 */
169 #define GBM_FORMAT_YUV410 __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */
170 #define GBM_FORMAT_YVU410 __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */
171 #define GBM_FORMAT_YUV411 __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */
172 #define GBM_FORMAT_YVU411 __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */
173 #define GBM_FORMAT_YUV420 __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */
174 #define GBM_FORMAT_YVU420 __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */
175 #define GBM_FORMAT_YUV422 __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */
176 #define GBM_FORMAT_YVU422 __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */
177 #define GBM_FORMAT_YUV444 __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */
178 #define GBM_FORMAT_YVU444 __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */
179
180
181 /**
182 * Flags to indicate the intended use for the buffer - these are passed into
183 * gbm_bo_create(). The caller must set the union of all the flags that are
184 * appropriate
185 *
186 * \sa Use gbm_device_is_format_supported() to check if the combination of format
187 * and use flags are supported
188 */
189 enum gbm_bo_flags {
190 /**
191 * Buffer is going to be presented to the screen using an API such as KMS
192 */
193 GBM_BO_USE_SCANOUT = (1 << 0),
194 /**
195 * Buffer is going to be used as cursor - the dimensions for the buffer
196 * must be 64x64 if this flag is passed.
197 */
198 GBM_BO_USE_CURSOR_64X64 = (1 << 1),
199 /**
200 * Buffer is to be used for rendering - for example it is going to be used
201 * as the storage for a color buffer
202 */
203 GBM_BO_USE_RENDERING = (1 << 2),
204 /**
205 * Buffer can be used for gbm_bo_write. This is guaranteed to work
206 * with GBM_BO_USE_CURSOR_64X64. but may not work for other
207 * combinations.
208 */
209 GBM_BO_USE_WRITE = (1 << 3),
210 };
211
212 int
213 gbm_device_get_fd(struct gbm_device *gbm);
214
215 const char *
216 gbm_device_get_backend_name(struct gbm_device *gbm);
217
218 int
219 gbm_device_is_format_supported(struct gbm_device *gbm,
220 uint32_t format, uint32_t usage);
221
222 void
223 gbm_device_destroy(struct gbm_device *gbm);
224
225 struct gbm_device *
226 gbm_create_device(int fd);
227
228 struct gbm_bo *
229 gbm_bo_create(struct gbm_device *gbm,
230 uint32_t width, uint32_t height,
231 uint32_t format, uint32_t flags);
232
233 #define GBM_BO_IMPORT_WL_BUFFER 0x5501
234 #define GBM_BO_IMPORT_EGL_IMAGE 0x5502
235
236 struct gbm_bo *
237 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
238 void *buffer, uint32_t usage);
239
240 uint32_t
241 gbm_bo_get_width(struct gbm_bo *bo);
242
243 uint32_t
244 gbm_bo_get_height(struct gbm_bo *bo);
245
246 uint32_t
247 gbm_bo_get_stride(struct gbm_bo *bo);
248
249 uint32_t
250 gbm_bo_get_format(struct gbm_bo *bo);
251
252 struct gbm_device *
253 gbm_bo_get_device(struct gbm_bo *bo);
254
255 union gbm_bo_handle
256 gbm_bo_get_handle(struct gbm_bo *bo);
257
258 int
259 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count);
260
261 void
262 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
263 void (*destroy_user_data)(struct gbm_bo *, void *));
264
265 void *
266 gbm_bo_get_user_data(struct gbm_bo *bo);
267
268 void
269 gbm_bo_destroy(struct gbm_bo *bo);
270
271 struct gbm_surface *
272 gbm_surface_create(struct gbm_device *gbm,
273 uint32_t width, uint32_t height,
274 uint32_t format, uint32_t flags);
275
276 struct gbm_bo *
277 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
278
279 void
280 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
281
282 int
283 gbm_surface_has_free_buffers(struct gbm_surface *surface);
284
285 void
286 gbm_surface_destroy(struct gbm_surface *surface);
287
288 #ifdef __cplusplus
289 }
290 #endif
291
292 #endif