5a8e8b7b9f0db2e33adb0746caa79cfcb3f7f010
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>
35 #include <sys/mkdev.h>
37 #ifdef MAJOR_IN_SYSMACROS
38 #include <sys/sysmacros.h>
48 /** Returns the file description for the gbm device
50 * \return The fd that the struct gbm_device was created with
53 gbm_device_get_fd(struct gbm_device
*gbm
)
58 /* FIXME: maybe superfluous, use udev subclass from the fd? */
59 /** Get the backend name for the given gbm device
61 * \return The backend name string - this belongs to the device and must not
64 GBM_EXPORT
const char *
65 gbm_device_get_backend_name(struct gbm_device
*gbm
)
70 /** Test if a format is supported for a given set of usage flags.
72 * \param gbm The created buffer manager
73 * \param format The format to test
74 * \param usage A bitmask of the usages to test the format against
75 * \return 1 if the format is supported otherwise 0
77 * \sa enum gbm_bo_flags for the list of flags that the format can be
80 * \sa enum gbm_bo_format for the list of formats
83 gbm_device_is_format_supported(struct gbm_device
*gbm
,
84 uint32_t format
, uint32_t usage
)
86 return gbm
->is_format_supported(gbm
, format
, usage
);
89 /** Destroy the gbm device and free all resources associated with it.
91 * \param gbm The device created using gbm_create_device()
94 gbm_device_destroy(struct gbm_device
*gbm
)
97 if (gbm
->refcount
== 0)
101 /** Create a gbm device for allocating buffers
103 * The file descriptor passed in is used by the backend to communicate with
104 * platform for allocating the memory. For allocations using DRI this would be
105 * the file descriptor returned when opening a device such as \c
108 * \param fd The file descriptor for a backend specific device
109 * \return The newly created struct gbm_device. The resources associated with
110 * the device should be freed with gbm_device_destroy() when it is no longer
111 * needed. If the creation of the device failed NULL will be returned.
113 GBM_EXPORT
struct gbm_device
*
114 gbm_create_device(int fd
)
116 struct gbm_device
*gbm
= NULL
;
119 if (fd
< 0 || fstat(fd
, &buf
) < 0 || !S_ISCHR(buf
.st_mode
)) {
124 gbm
= _gbm_create_device(fd
);
128 gbm
->dummy
= gbm_create_device
;
135 /** Get the width of the buffer object
137 * \param bo The buffer object
138 * \return The width of the allocated buffer object
141 GBM_EXPORT
unsigned int
142 gbm_bo_get_width(struct gbm_bo
*bo
)
147 /** Get the height of the buffer object
149 * \param bo The buffer object
150 * \return The height of the allocated buffer object
152 GBM_EXPORT
unsigned int
153 gbm_bo_get_height(struct gbm_bo
*bo
)
158 /** Get the stride of the buffer object
160 * This is calculated by the backend when it does the allocation in
163 * \param bo The buffer object
164 * \return The stride of the allocated buffer object in bytes
167 gbm_bo_get_stride(struct gbm_bo
*bo
)
172 /** Get the format of the buffer object
174 * The format of the pixels in the buffer.
176 * \param bo The buffer object
177 * \return The format of buffer object, on of the GBM_FORMAT_* codes
180 gbm_bo_get_format(struct gbm_bo
*bo
)
185 /** Get the handle of the buffer object
187 * This is stored in the platform generic union gbm_bo_handle type. However
188 * the format of this handle is platform specific.
190 * \param bo The buffer object
191 * \return Returns the handle of the allocated buffer object
193 GBM_EXPORT
union gbm_bo_handle
194 gbm_bo_get_handle(struct gbm_bo
*bo
)
199 /** Get a DMA-BUF file descriptor for the buffer object
201 * This function creates a DMA-BUF (also known as PRIME) file descriptor
202 * handle for the buffer object. Each call to gbm_bo_get_fd() returns a new
203 * file descriptor and the caller is responsible for closing the file
206 * \param bo The buffer object
207 * \return Returns a file descriptor referring to the underlying buffer
210 gbm_bo_get_fd(struct gbm_bo
*bo
)
212 return bo
->gbm
->bo_get_fd(bo
);
216 /** Write data into the buffer object
218 * If the buffer object was created with the GBM_BO_USE_WRITE flag,
219 * this function can be used to write data into the buffer object. The
220 * data is copied directly into the object and it's the responsibility
221 * of the caller to make sure the data represents valid pixel data,
222 * according to the width, height, stride and format of the buffer object.
224 * \param bo The buffer object
225 * \param buf The data to write
226 * \param count The number of bytes to write
227 * \return Returns 0 on success, otherwise -1 is returned an errno set
230 gbm_bo_write(struct gbm_bo
*bo
, const void *buf
, size_t count
)
232 return bo
->gbm
->bo_write(bo
, buf
, count
);
235 /** Get the gbm device used to create the buffer object
237 * \param bo The buffer object
238 * \return Returns the gbm device with which the buffer object was created
240 GBM_EXPORT
struct gbm_device
*
241 gbm_bo_get_device(struct gbm_bo
*bo
)
246 /** Set the user data associated with a buffer object
248 * \param bo The buffer object
249 * \param data The data to associate to the buffer object
250 * \param destroy_user_data A callback (which may be %NULL) that will be
251 * called prior to the buffer destruction
254 gbm_bo_set_user_data(struct gbm_bo
*bo
, void *data
,
255 void (*destroy_user_data
)(struct gbm_bo
*, void *))
257 bo
->user_data
= data
;
258 bo
->destroy_user_data
= destroy_user_data
;
261 /** Get the user data associated with a buffer object
263 * \param bo The buffer object
264 * \return Returns the user data associated with the buffer object or %NULL
265 * if no data was associated with it
267 * \sa gbm_bo_set_user_data()
270 gbm_bo_get_user_data(struct gbm_bo
*bo
)
272 return bo
->user_data
;
276 * Destroys the given buffer object and frees all resources associated with
279 * \param bo The buffer object
282 gbm_bo_destroy(struct gbm_bo
*bo
)
284 if (bo
->destroy_user_data
)
285 bo
->destroy_user_data(bo
, bo
->user_data
);
287 bo
->gbm
->bo_destroy(bo
);
291 * Allocate a buffer object for the given dimensions
293 * \param gbm The gbm device returned from gbm_create_device()
294 * \param width The width for the buffer
295 * \param height The height for the buffer
296 * \param format The format to use for the buffer
297 * \param usage The union of the usage flags for this buffer
299 * \return A newly allocated buffer that should be freed with gbm_bo_destroy()
300 * when no longer needed. If an error occurs during allocation %NULL will be
301 * returned and errno set.
303 * \sa enum gbm_bo_format for the list of formats
304 * \sa enum gbm_bo_flags for the list of usage flags
306 GBM_EXPORT
struct gbm_bo
*
307 gbm_bo_create(struct gbm_device
*gbm
,
308 uint32_t width
, uint32_t height
,
309 uint32_t format
, uint32_t usage
)
311 if (width
== 0 || height
== 0) {
316 return gbm
->bo_create(gbm
, width
, height
, format
, usage
);
320 * Create a gbm buffer object from an foreign object
322 * This function imports a foreign object and creates a new gbm bo for it.
323 * This enabled using the foreign object with a display API such as KMS.
324 * Currently three types of foreign objects are supported, indicated by the type
327 * GBM_BO_IMPORT_WL_BUFFER
328 * GBM_BO_IMPORT_EGL_IMAGE
331 * The gbm bo shares the underlying pixels but its life-time is
332 * independent of the foreign object.
334 * \param gbm The gbm device returned from gbm_create_device()
335 * \param gbm The type of object we're importing
336 * \param gbm Pointer to the external object
337 * \param usage The union of the usage flags for this buffer
339 * \return A newly allocated buffer object that should be freed with
340 * gbm_bo_destroy() when no longer needed. On error, %NULL is returned
343 * \sa enum gbm_bo_flags for the list of usage flags
345 GBM_EXPORT
struct gbm_bo
*
346 gbm_bo_import(struct gbm_device
*gbm
,
347 uint32_t type
, void *buffer
, uint32_t usage
)
349 return gbm
->bo_import(gbm
, type
, buffer
, usage
);
353 * Map a region of a gbm buffer object for cpu access
355 * This function maps a region of a gbm bo for cpu read and/or write
358 * \param bo The buffer object
359 * \param x The X (top left origin) starting position of the mapped region for
361 * \param y The Y (top left origin) starting position of the mapped region for
363 * \param width The width of the mapped region for the buffer
364 * \param height The height of the mapped region for the buffer
365 * \param flags The union of the GBM_BO_TRANSFER_* flags for this buffer
366 * \param stride Ptr for returned stride in bytes of the mapped region
367 * \param map_data Returned opaque ptr for the mapped region
369 * \return Address of the mapped buffer that should be unmapped with
370 * gbm_bo_unmap() when no longer needed. On error, %NULL is returned
373 * \sa enum gbm_bo_transfer_flags for the list of flags
376 gbm_bo_map(struct gbm_bo
*bo
,
377 uint32_t x
, uint32_t y
,
378 uint32_t width
, uint32_t height
,
379 uint32_t flags
, uint32_t *stride
, void **map_data
)
381 if (!bo
|| width
== 0 || height
== 0 || !stride
|| !map_data
) {
386 return bo
->gbm
->bo_map(bo
, x
, y
, width
, height
,
387 flags
, stride
, map_data
);
391 * Unmap a previously mapped region of a gbm buffer object
393 * This function unmaps a region of a gbm bo for cpu read and/or write
396 * \param bo The buffer object
397 * \param map_data opaque ptr returned from prior gbm_bo_map
400 gbm_bo_unmap(struct gbm_bo
*bo
, void *map_data
)
402 bo
->gbm
->bo_unmap(bo
, map_data
);
406 * Allocate a surface object
408 * \param gbm The gbm device returned from gbm_create_device()
409 * \param width The width for the surface
410 * \param height The height for the surface
411 * \param format The format to use for the surface
413 * \return A newly allocated surface that should be freed with
414 * gbm_surface_destroy() when no longer needed. If an error occurs
415 * during allocation %NULL will be returned.
417 * \sa enum gbm_bo_format for the list of formats
419 GBM_EXPORT
struct gbm_surface
*
420 gbm_surface_create(struct gbm_device
*gbm
,
421 uint32_t width
, uint32_t height
,
422 uint32_t format
, uint32_t flags
)
424 return gbm
->surface_create(gbm
, width
, height
, format
, flags
);
428 * Destroys the given surface and frees all resources associated with
431 * All buffers locked with gbm_surface_lock_front_buffer() should be
432 * released prior to calling this function.
434 * \param surf The surface
437 gbm_surface_destroy(struct gbm_surface
*surf
)
439 surf
->gbm
->surface_destroy(surf
);
443 * Lock the surface's current front buffer
445 * Lock rendering to the surface's current front buffer until it is
446 * released with gbm_surface_release_buffer().
448 * This function must be called exactly once after calling
449 * eglSwapBuffers. Calling it before any eglSwapBuffer has happened
450 * on the surface or two or more times after eglSwapBuffers is an
451 * error. A new bo representing the new front buffer is returned. On
452 * multiple invocations, all the returned bos must be released in
453 * order to release the actual surface buffer.
455 * \param surf The surface
457 * \return A buffer object that should be released with
458 * gbm_surface_release_buffer() when no longer needed. The implementation
459 * is free to reuse buffers released with gbm_surface_release_buffer() so
460 * this bo should not be destroyed using gbm_bo_destroy(). If an error
461 * occurs this function returns %NULL.
463 GBM_EXPORT
struct gbm_bo
*
464 gbm_surface_lock_front_buffer(struct gbm_surface
*surf
)
466 return surf
->gbm
->surface_lock_front_buffer(surf
);
470 * Release a locked buffer obtained with gbm_surface_lock_front_buffer()
472 * Returns the underlying buffer to the gbm surface. Releasing a bo
473 * will typically make gbm_surface_has_free_buffer() return 1 and thus
474 * allow rendering the next frame, but not always. The implementation
475 * may choose to destroy the bo immediately or reuse it, in which case
476 * the user data associated with it is unchanged.
478 * \param surf The surface
479 * \param bo The buffer object
482 gbm_surface_release_buffer(struct gbm_surface
*surf
, struct gbm_bo
*bo
)
484 surf
->gbm
->surface_release_buffer(surf
, bo
);
488 * Return whether or not a surface has free (non-locked) buffers
490 * Before starting a new frame, the surface must have a buffer
491 * available for rendering. Initially, a gbm surface will have a free
492 * buffer, but after one or more buffers have been locked (\sa
493 * gbm_surface_lock_front_buffer()), the application must check for a
494 * free buffer before rendering.
496 * If a surface doesn't have a free buffer, the application must
497 * return a buffer to the surface using gbm_surface_release_buffer()
498 * and after that, the application can query for free buffers again.
500 * \param surf The surface
501 * \return 1 if the surface has free buffers, 0 otherwise
504 gbm_surface_has_free_buffers(struct gbm_surface
*surf
)
506 return surf
->gbm
->surface_has_free_buffers(surf
);