907ca3c90bf353c24e98c523f37b7686d76ab47f
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>
36 #include <sys/types.h>
45 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
47 static struct gbm_device
*devices
[16];
49 static int device_num
= 0;
51 /** Returns the file description for the gbm device
53 * \return The fd that the struct gbm_device was created with
56 gbm_device_get_fd(struct gbm_device
*gbm
)
61 /* FIXME: maybe superfluous, use udev subclass from the fd? */
62 /** Get the backend name for the given gbm device
64 * \return The backend name string - this belongs to the device and must not
67 GBM_EXPORT
const char *
68 gbm_device_get_backend_name(struct gbm_device
*gbm
)
73 /** Test if a format is supported for a given set of usage flags.
75 * \param gbm The created buffer manager
76 * \param format The format to test
77 * \param usage A bitmask of the usages to test the format against
78 * \return 1 if the format is supported otherwise 0
80 * \sa enum gbm_bo_flags for the list of flags that the format can be
83 * \sa enum gbm_bo_format for the list of formats
86 gbm_device_is_format_supported(struct gbm_device
*gbm
,
87 uint32_t format
, uint32_t usage
)
89 return gbm
->is_format_supported(gbm
, format
, usage
);
92 /** Destroy the gbm device and free all resources associated with it.
94 * \param gbm The device created using gbm_create_device()
97 gbm_device_destroy(struct gbm_device
*gbm
)
100 if (gbm
->refcount
== 0)
105 _gbm_mesa_get_device(int fd
)
107 struct gbm_device
*gbm
= NULL
;
112 if (fd
< 0 || fstat(fd
, &buf
) < 0 || !S_ISCHR(buf
.st_mode
)) {
117 for (i
= 0; i
< device_num
; ++i
) {
118 dev
= devices
[i
]->stat
.st_rdev
;
119 if (major(dev
) == major(buf
.st_rdev
) &&
120 minor(dev
) == minor(buf
.st_rdev
)) {
130 /** Create a gbm device for allocating buffers
132 * The file descriptor passed in is used by the backend to communicate with
133 * platform for allocating the memory. For allocations using DRI this would be
134 * the file descriptor returned when opening a device such as \c
137 * \param fd The file descriptor for an backend specific device
138 * \return The newly created struct gbm_device. The resources associated with
139 * the device should be freed with gbm_device_destroy() when it is no longer
140 * needed. If the creation of the device failed NULL will be returned.
142 GBM_EXPORT
struct gbm_device
*
143 gbm_create_device(int fd
)
145 struct gbm_device
*gbm
= NULL
;
148 if (fd
< 0 || fstat(fd
, &buf
) < 0 || !S_ISCHR(buf
.st_mode
)) {
154 memset(devices
, 0, sizeof devices
);
156 gbm
= _gbm_create_device(fd
);
160 gbm
->dummy
= gbm_create_device
;
164 if (device_num
< ARRAY_SIZE(devices
)-1)
165 devices
[device_num
++] = gbm
;
170 /** Get the width of the buffer object
172 * \param bo The buffer object
173 * \return The width of the allocated buffer object
176 GBM_EXPORT
unsigned int
177 gbm_bo_get_width(struct gbm_bo
*bo
)
182 /** Get the height of the buffer object
184 * \param bo The buffer object
185 * \return The height of the allocated buffer object
187 GBM_EXPORT
unsigned int
188 gbm_bo_get_height(struct gbm_bo
*bo
)
193 /** Get the stride of the buffer object
195 * This is calculated by the backend when it does the allocation in
198 * \param bo The buffer object
199 * \return The stride of the allocated buffer object in bytes
202 gbm_bo_get_stride(struct gbm_bo
*bo
)
207 /** Get the format of the buffer object
209 * The format of the pixels in the buffer.
211 * \param bo The buffer object
212 * \return The format of buffer object, on of the GBM_FORMAT_* codes
215 gbm_bo_get_format(struct gbm_bo
*bo
)
220 /** Get the handle of the buffer object
222 * This is stored in the platform generic union gbm_bo_handle type. However
223 * the format of this handle is platform specific.
225 * \param bo The buffer object
226 * \return Returns the handle of the allocated buffer object
228 GBM_EXPORT
union gbm_bo_handle
229 gbm_bo_get_handle(struct gbm_bo
*bo
)
234 /** Get a DMA-BUF file descriptor for the buffer object
236 * This function creates a DMA-BUF (also known as PRIME) file descriptor
237 * handle for the buffer object. Eeach call to gbm_bo_get_fd() returns a new
238 * file descriptor and the caller is responsible for closing the file
241 * \param bo The buffer object
242 * \return Returns a file descriptor referring to the underlying buffer
245 gbm_bo_get_fd(struct gbm_bo
*bo
)
247 return bo
->gbm
->bo_get_fd(bo
);
251 /** Write data into the buffer object
253 * If the buffer object was created with the GBM_BO_USE_WRITE flag,
254 * this function can used to write data into the buffer object. The
255 * data is copied directly into the object and it's the responsiblity
256 * of the caller to make sure the data represents valid pixel data,
257 * according to the width, height, stride and format of the buffer object.
259 * \param bo The buffer object
260 * \param buf The data to write
261 * \param count The number of bytes to write
262 * \return Returns 0 on success, otherwise -1 is returned an errno set
265 gbm_bo_write(struct gbm_bo
*bo
, const void *buf
, size_t count
)
267 return bo
->gbm
->bo_write(bo
, buf
, count
);
270 /** Get the gbm device used to create the buffer object
272 * \param bo The buffer object
273 * \return Returns the gbm device with which the buffer object was created
275 GBM_EXPORT
struct gbm_device
*
276 gbm_bo_get_device(struct gbm_bo
*bo
)
281 /** Set the user data associated with a buffer object
283 * \param bo The buffer object
284 * \param data The data to associate to the buffer object
285 * \param destroy_user_data A callback (which may be %NULL) that will be
286 * called prior to the buffer destruction
289 gbm_bo_set_user_data(struct gbm_bo
*bo
, void *data
,
290 void (*destroy_user_data
)(struct gbm_bo
*, void *))
292 bo
->user_data
= data
;
293 bo
->destroy_user_data
= destroy_user_data
;
296 /** Get the user data associated with a buffer object
298 * \param bo The buffer object
299 * \return Returns the user data associated with the buffer object or %NULL
300 * if no data was associated with it
302 * \sa gbm_bo_set_user_data()
305 gbm_bo_get_user_data(struct gbm_bo
*bo
)
307 return bo
->user_data
;
311 * Destroys the given buffer object and frees all resources associated with
314 * \param bo The buffer object
317 gbm_bo_destroy(struct gbm_bo
*bo
)
319 if (bo
->destroy_user_data
)
320 bo
->destroy_user_data(bo
, bo
->user_data
);
322 bo
->gbm
->bo_destroy(bo
);
326 * Allocate a buffer object for the given dimensions
328 * \param gbm The gbm device returned from gbm_create_device()
329 * \param width The width for the buffer
330 * \param height The height for the buffer
331 * \param format The format to use for the buffer
332 * \param usage The union of the usage flags for this buffer
334 * \return A newly allocated buffer that should be freed with gbm_bo_destroy()
335 * when no longer needed. If an error occurs during allocation %NULL will be
336 * returned and errno set.
338 * \sa enum gbm_bo_format for the list of formats
339 * \sa enum gbm_bo_flags for the list of usage flags
341 GBM_EXPORT
struct gbm_bo
*
342 gbm_bo_create(struct gbm_device
*gbm
,
343 uint32_t width
, uint32_t height
,
344 uint32_t format
, uint32_t usage
)
346 if (width
== 0 || height
== 0) {
351 if (usage
& GBM_BO_USE_CURSOR_64X64
&&
352 (width
!= 64 || height
!= 64)) {
357 return gbm
->bo_create(gbm
, width
, height
, format
, usage
);
361 * Create a gbm buffer object from an foreign object
363 * This function imports a foreign object and creates a new gbm bo for it.
364 * This enabled using the foreign object with a display API such as KMS.
365 * Currently two types of foreign objects are supported, indicated by the type
368 * GBM_BO_IMPORT_WL_BUFFER
369 * GBM_BO_IMPORT_EGL_IMAGE
372 * The the gbm bo shares the underlying pixels but its life-time is
373 * independent of the foreign object.
375 * \param gbm The gbm device returned from gbm_create_device()
376 * \param gbm The type of object we're importing
377 * \param gbm Pointer to the external object
378 * \param usage The union of the usage flags for this buffer
380 * \return A newly allocated buffer object that should be freed with
381 * gbm_bo_destroy() when no longer needed. On error, %NULL is returned
384 * \sa enum gbm_bo_flags for the list of usage flags
386 GBM_EXPORT
struct gbm_bo
*
387 gbm_bo_import(struct gbm_device
*gbm
,
388 uint32_t type
, void *buffer
, uint32_t usage
)
390 return gbm
->bo_import(gbm
, type
, buffer
, usage
);
394 * Allocate a surface object
396 * \param gbm The gbm device returned from gbm_create_device()
397 * \param width The width for the surface
398 * \param height The height for the surface
399 * \param format The format to use for the surface
401 * \return A newly allocated surface that should be freed with
402 * gbm_surface_destroy() when no longer needed. If an error occurs
403 * during allocation %NULL will be returned.
405 * \sa enum gbm_bo_format for the list of formats
407 GBM_EXPORT
struct gbm_surface
*
408 gbm_surface_create(struct gbm_device
*gbm
,
409 uint32_t width
, uint32_t height
,
410 uint32_t format
, uint32_t flags
)
412 return gbm
->surface_create(gbm
, width
, height
, format
, flags
);
416 * Destroys the given surface and frees all resources associated with
419 * All buffers locked with gbm_surface_lock_front_buffer() should be
420 * released prior to calling this function.
422 * \param surf The surface
425 gbm_surface_destroy(struct gbm_surface
*surf
)
427 surf
->gbm
->surface_destroy(surf
);
431 * Lock the surface's current front buffer
433 * Lock rendering to the surface's current front buffer until it is
434 * released with gbm_surface_release_buffer().
436 * This function must be called exactly once after calling
437 * eglSwapBuffers. Calling it before any eglSwapBuffer has happened
438 * on the surface or two or more times after eglSwapBuffers is an
439 * error. A new bo representing the new front buffer is returned. On
440 * multiple invocations, all the returned bos must be released in
441 * order to release the actual surface buffer.
443 * \param surf The surface
445 * \return A buffer object that should be released with
446 * gbm_surface_release_buffer() when no longer needed. The implementation
447 * is free to reuse buffers released with gbm_surface_release_buffer() so
448 * this bo should not be destroyed using gbm_bo_destroy(). If an error
449 * occurs this function returns %NULL.
451 GBM_EXPORT
struct gbm_bo
*
452 gbm_surface_lock_front_buffer(struct gbm_surface
*surf
)
454 return surf
->gbm
->surface_lock_front_buffer(surf
);
458 * Release a locked buffer obtained with gbm_surface_lock_front_buffer()
460 * Returns the underlying buffer to the gbm surface. Releasing a bo
461 * will typically make gbm_surface_has_free_buffer() return 1 and thus
462 * allow rendering the next frame, but not always. The implementation
463 * may choose to destroy the bo immediately or reuse it, in which case
464 * the user data associated with it is unchanged.
466 * \param surf The surface
467 * \param bo The buffer object
470 gbm_surface_release_buffer(struct gbm_surface
*surf
, struct gbm_bo
*bo
)
472 surf
->gbm
->surface_release_buffer(surf
, bo
);
476 * Return whether or not a surface has free (non-locked) buffers
478 * Before starting a new frame, the surface must have a buffer
479 * available for rendering. Initially, a gbm surface will have a free
480 * buffer, but after one of more buffers have been locked (\sa
481 * gbm_surface_lock_front_buffer()), the application must check for a
482 * free buffer before rendering.
484 * If a surface doesn't have a free buffer, the application must
485 * return a buffer to the surface using gbm_surface_release_buffer()
486 * and after that, the application can query for free buffers again.
488 * \param surf The surface
489 * \return 1 if the surface has free buffers, 0 otherwise
492 gbm_surface_has_free_buffers(struct gbm_surface
*surf
)
494 return surf
->gbm
->surface_has_free_buffers(surf
);