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 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)
104 GBM_EXPORT struct gbm_device *
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)) {
113 fprintf(stderr, "_gbm_mesa_get_device: invalid fd: %d\n", fd);
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)) {
149 fprintf(stderr, "gbm_create_device: invalid fd: %d\n", fd);
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 /** Write data into the buffer object
236 * If the buffer object was created with the GBM_BO_USE_WRITE flag,
237 * this function can used to write data into the buffer object. The
238 * data is copied directly into the object and it's the responsiblity
239 * of the caller to make sure the data represents valid pixel data,
240 * according to the width, height, stride and format of the buffer object.
242 * \param bo The buffer object
243 * \param buf The data to write
244 * \param count The number of bytes to write
245 * \return Returns -1 on error, 0 otherwise
248 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count)
250 return bo->gbm->bo_write(bo, buf, count);
253 /** Get the gbm device used to create the buffer object
255 * \param bo The buffer object
256 * \return Returns the gbm device with which the buffer object was created
258 GBM_EXPORT struct gbm_device *
259 gbm_bo_get_device(struct gbm_bo *bo)
264 /** Set the user data associated with a buffer object
266 * \param bo The buffer object
267 * \param data The data to associate to the buffer object
268 * \param destroy_user_data A callback (which may be %NULL) that will be
269 * called prior to the buffer destruction
272 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
273 void (*destroy_user_data)(struct gbm_bo *, void *))
275 bo->user_data = data;
276 bo->destroy_user_data = destroy_user_data;
279 /** Get the user data associated with a buffer object
281 * \param bo The buffer object
282 * \return Returns the user data associated with the buffer object or %NULL
283 * if no data was associated with it
285 * \sa gbm_bo_set_user_data()
288 gbm_bo_get_user_data(struct gbm_bo *bo)
290 return bo->user_data;
294 * Destroys the given buffer object and frees all resources associated with
297 * \param bo The buffer object
300 gbm_bo_destroy(struct gbm_bo *bo)
302 if (bo->destroy_user_data)
303 bo->destroy_user_data(bo, bo->user_data);
305 bo->gbm->bo_destroy(bo);
309 * Allocate a buffer object for the given dimensions
311 * \param gbm The gbm device returned from gbm_create_device()
312 * \param width The width for the buffer
313 * \param height The height for the buffer
314 * \param format The format to use for the buffer
315 * \param usage The union of the usage flags for this buffer
317 * \return A newly allocated buffer that should be freed with gbm_bo_destroy()
318 * when no longer needed. If an error occurs during allocation %NULL will be
321 * \sa enum gbm_bo_format for the list of formats
322 * \sa enum gbm_bo_flags for the list of usage flags
324 GBM_EXPORT struct gbm_bo *
325 gbm_bo_create(struct gbm_device *gbm,
326 uint32_t width, uint32_t height,
327 uint32_t format, uint32_t usage)
329 if (width == 0 || height == 0)
332 if (usage & GBM_BO_USE_CURSOR_64X64 &&
333 (width != 64 || height != 64))
336 return gbm->bo_create(gbm, width, height, format, usage);
340 * Create a gbm buffer object from an foreign object
342 * This function imports a foreign object and creates a new gbm bo for it.
343 * This enabled using the foreign object with a display API such as KMS.
344 * Currently two types of foreign objects are supported, indicated by the type
347 * GBM_BO_IMPORT_WL_BUFFER
348 * GBM_BO_IMPORT_EGL_IMAGE
350 * The the gbm bo shares the underlying pixels but its life-time is
351 * independent of the foreign object.
353 * \param gbm The gbm device returned from gbm_create_device()
354 * \param gbm The type of object we're importing
355 * \param gbm Pointer to the external object
356 * \param usage The union of the usage flags for this buffer
358 * \return A newly allocated buffer object that should be freed with
359 * gbm_bo_destroy() when no longer needed.
361 * \sa enum gbm_bo_flags for the list of usage flags
363 GBM_EXPORT struct gbm_bo *
364 gbm_bo_import(struct gbm_device *gbm,
365 uint32_t type, void *buffer, uint32_t usage)
367 return gbm->bo_import(gbm, type, buffer, usage);
371 * Allocate a surface object
373 * \param gbm The gbm device returned from gbm_create_device()
374 * \param width The width for the surface
375 * \param height The height for the surface
376 * \param format The format to use for the surface
378 * \return A newly allocated surface that should be freed with
379 * gbm_surface_destroy() when no longer needed. If an error occurs
380 * during allocation %NULL will be returned.
382 * \sa enum gbm_bo_format for the list of formats
384 GBM_EXPORT struct gbm_surface *
385 gbm_surface_create(struct gbm_device *gbm,
386 uint32_t width, uint32_t height,
387 uint32_t format, uint32_t flags)
389 return gbm->surface_create(gbm, width, height, format, flags);
393 * Destroys the given surface and frees all resources associated with
396 * All buffers locked with gbm_surface_lock_front_buffer() should be
397 * released prior to calling this function.
399 * \param surf The surface
402 gbm_surface_destroy(struct gbm_surface *surf)
404 surf->gbm->surface_destroy(surf);
408 * Lock the surface's current front buffer
410 * Lock rendering to the surface's current front buffer until it is
411 * released with gbm_surface_release_buffer().
413 * This function must be called exactly once after calling
414 * eglSwapBuffers. Calling it before any eglSwapBuffer has happened
415 * on the surface or two or more times after eglSwapBuffers is an
416 * error. A new bo representing the new front buffer is returned. On
417 * multiple invocations, all the returned bos must be released in
418 * order to release the actual surface buffer.
420 * \param surf The surface
422 * \return A buffer object that should be released with
423 * gbm_surface_release_buffer() when no longer needed. The implementation
424 * is free to reuse buffers released with gbm_surface_release_buffer() so
425 * this bo should not be destroyed using gbm_bo_destroy(). If an error
426 * occurs this function returns %NULL.
428 GBM_EXPORT struct gbm_bo *
429 gbm_surface_lock_front_buffer(struct gbm_surface *surf)
431 return surf->gbm->surface_lock_front_buffer(surf);
435 * Release a locked buffer obtained with gbm_surface_lock_front_buffer()
437 * Returns the underlying buffer to the gbm surface. Releasing a bo
438 * will typically make gbm_surface_has_free_buffer() return 1 and thus
439 * allow rendering the next frame, but not always. The implementation
440 * may choose to destroy the bo immediately or reuse it, in which case
441 * the user data associated with it is unchanged.
443 * \param surf The surface
444 * \param bo The buffer object
447 gbm_surface_release_buffer(struct gbm_surface *surf, struct gbm_bo *bo)
449 surf->gbm->surface_release_buffer(surf, bo);
453 * Return whether or not a surface has free (non-locked) buffers
455 * Before starting a new frame, the surface must have a buffer
456 * available for rendering. Initially, a gbm surface will have a free
457 * buffer, but after one of more buffers have been locked (\sa
458 * gbm_surface_lock_front_buffer()), the application must check for a
459 * free buffer before rendering.
461 * If a surface doesn't have a free buffer, the application must
462 * return a buffer to the surface using gbm_surface_release_buffer()
463 * and after that, the application can query for free buffers again.
465 * \param surf The surface
466 * \return 1 if the surface has free buffers, 0 otherwise
469 gbm_surface_has_free_buffers(struct gbm_surface *surf)
471 return surf->gbm->surface_has_free_buffers(surf);