gbm: fix typo
[mesa.git] / src / gbm / main / gbm.c
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 #include <stddef.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <stdint.h>
33
34 #ifdef MAJOR_IN_MKDEV
35 #include <sys/mkdev.h>
36 #endif
37 #ifdef MAJOR_IN_SYSMACROS
38 #include <sys/sysmacros.h>
39 #endif
40 #include <sys/stat.h>
41 #include <unistd.h>
42 #include <errno.h>
43
44 #include "gbm.h"
45 #include "gbmint.h"
46 #include "backend.h"
47
48 /** Returns the file description for the gbm device
49 *
50 * \return The fd that the struct gbm_device was created with
51 */
52 GBM_EXPORT int
53 gbm_device_get_fd(struct gbm_device *gbm)
54 {
55 return gbm->fd;
56 }
57
58 /** Get the backend name for the given gbm device
59 *
60 * \return The backend name string - this belongs to the device and must not
61 * be freed
62 */
63 GBM_EXPORT const char *
64 gbm_device_get_backend_name(struct gbm_device *gbm)
65 {
66 return gbm->name;
67 }
68
69 /** Test if a format is supported for a given set of usage flags.
70 *
71 * \param gbm The created buffer manager
72 * \param format The format to test
73 * \param usage A bitmask of the usages to test the format against
74 * \return 1 if the format is supported otherwise 0
75 *
76 * \sa enum gbm_bo_flags for the list of flags that the format can be
77 * tested against
78 *
79 * \sa enum gbm_bo_format for the list of formats
80 */
81 GBM_EXPORT int
82 gbm_device_is_format_supported(struct gbm_device *gbm,
83 uint32_t format, uint32_t usage)
84 {
85 return gbm->is_format_supported(gbm, format, usage);
86 }
87
88 /** Destroy the gbm device and free all resources associated with it.
89 *
90 * \param gbm The device created using gbm_create_device()
91 */
92 GBM_EXPORT void
93 gbm_device_destroy(struct gbm_device *gbm)
94 {
95 gbm->refcount--;
96 if (gbm->refcount == 0)
97 gbm->destroy(gbm);
98 }
99
100 /** Create a gbm device for allocating buffers
101 *
102 * The file descriptor passed in is used by the backend to communicate with
103 * platform for allocating the memory. For allocations using DRI this would be
104 * the file descriptor returned when opening a device such as \c
105 * /dev/dri/card0
106 *
107 * \param fd The file descriptor for a backend specific device
108 * \return The newly created struct gbm_device. The resources associated with
109 * the device should be freed with gbm_device_destroy() when it is no longer
110 * needed. If the creation of the device failed NULL will be returned.
111 */
112 GBM_EXPORT struct gbm_device *
113 gbm_create_device(int fd)
114 {
115 struct gbm_device *gbm = NULL;
116 struct stat buf;
117
118 if (fd < 0 || fstat(fd, &buf) < 0 || !S_ISCHR(buf.st_mode)) {
119 errno = EINVAL;
120 return NULL;
121 }
122
123 gbm = _gbm_create_device(fd);
124 if (gbm == NULL)
125 return NULL;
126
127 gbm->dummy = gbm_create_device;
128 gbm->stat = buf;
129 gbm->refcount = 1;
130
131 return gbm;
132 }
133
134 /** Get the width of the buffer object
135 *
136 * \param bo The buffer object
137 * \return The width of the allocated buffer object
138 *
139 */
140 GBM_EXPORT uint32_t
141 gbm_bo_get_width(struct gbm_bo *bo)
142 {
143 return bo->width;
144 }
145
146 /** Get the height of the buffer object
147 *
148 * \param bo The buffer object
149 * \return The height of the allocated buffer object
150 */
151 GBM_EXPORT uint32_t
152 gbm_bo_get_height(struct gbm_bo *bo)
153 {
154 return bo->height;
155 }
156
157 /** Get the stride of the buffer object
158 *
159 * This is calculated by the backend when it does the allocation in
160 * gbm_bo_create()
161 *
162 * \param bo The buffer object
163 * \return The stride of the allocated buffer object in bytes
164 */
165 GBM_EXPORT uint32_t
166 gbm_bo_get_stride(struct gbm_bo *bo)
167 {
168 return gbm_bo_get_stride_for_plane(bo, 0);
169 }
170
171 /** Get the stride for the given plane
172 *
173 * \param bo The buffer object
174 * \param plane for which you want the stride
175 *
176 * \sa gbm_bo_get_stride()
177 */
178 GBM_EXPORT uint32_t
179 gbm_bo_get_stride_for_plane(struct gbm_bo *bo, int plane)
180 {
181 return bo->gbm->bo_get_stride(bo, plane);
182 }
183
184 /** Get the format of the buffer object
185 *
186 * The format of the pixels in the buffer.
187 *
188 * \param bo The buffer object
189 * \return The format of buffer object, one of the GBM_FORMAT_* codes
190 */
191 GBM_EXPORT uint32_t
192 gbm_bo_get_format(struct gbm_bo *bo)
193 {
194 return bo->format;
195 }
196
197 /** Get the offset for the data of the specified plane
198 *
199 * Extra planes, and even the first plane, may have an offset from the start of
200 * the buffer object. This function will provide the offset for the given plane
201 * to be used in various KMS APIs.
202 *
203 * \param bo The buffer object
204 * \return The offset
205 */
206 GBM_EXPORT uint32_t
207 gbm_bo_get_offset(struct gbm_bo *bo, int plane)
208 {
209 return bo->gbm->bo_get_offset(bo, plane);
210 }
211
212 /** Get the gbm device used to create the buffer object
213 *
214 * \param bo The buffer object
215 * \return Returns the gbm device with which the buffer object was created
216 */
217 GBM_EXPORT struct gbm_device *
218 gbm_bo_get_device(struct gbm_bo *bo)
219 {
220 return bo->gbm;
221 }
222
223 /** Get the handle of the buffer object
224 *
225 * This is stored in the platform generic union gbm_bo_handle type. However
226 * the format of this handle is platform specific.
227 *
228 * \param bo The buffer object
229 * \return Returns the handle of the allocated buffer object
230 */
231 GBM_EXPORT union gbm_bo_handle
232 gbm_bo_get_handle(struct gbm_bo *bo)
233 {
234 return bo->handle;
235 }
236
237 /** Get a DMA-BUF file descriptor for the buffer object
238 *
239 * This function creates a DMA-BUF (also known as PRIME) file descriptor
240 * handle for the buffer object. Each call to gbm_bo_get_fd() returns a new
241 * file descriptor and the caller is responsible for closing the file
242 * descriptor.
243
244 * \param bo The buffer object
245 * \return Returns a file descriptor referring to the underlying buffer or -1
246 * if an error occurs.
247 */
248 GBM_EXPORT int
249 gbm_bo_get_fd(struct gbm_bo *bo)
250 {
251 return bo->gbm->bo_get_fd(bo);
252 }
253
254 /** Get the number of planes for the given bo.
255 *
256 * \param bo The buffer object
257 * \return The number of planes
258 */
259 GBM_EXPORT int
260 gbm_bo_get_plane_count(struct gbm_bo *bo)
261 {
262 return bo->gbm->bo_get_planes(bo);
263 }
264
265 /** Get the handle for the specified plane of the buffer object
266 *
267 * This function gets the handle for any plane associated with the BO. When
268 * dealing with multi-planar formats, or formats which might have implicit
269 * planes based on different underlying hardware it is necessary for the client
270 * to be able to get this information to pass to the DRM.
271 *
272 * \param bo The buffer object
273 * \param plane the plane to get a handle for
274 *
275 * \sa gbm_bo_get_handle()
276 */
277 GBM_EXPORT union gbm_bo_handle
278 gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane)
279 {
280 return bo->gbm->bo_get_handle(bo, plane);
281 }
282
283 /**
284 * Get the chosen modifier for the buffer object
285 *
286 * This function returns the modifier that was chosen for the object. These
287 * properties may be generic, or platform/implementation dependent.
288 *
289 * \param bo The buffer object
290 * \return Returns the selected modifier (chosen by the implementation) for the
291 * BO.
292 * \sa gbm_bo_create_with_modifiers() where possible modifiers are set
293 * \sa gbm_surface_create_with_modifiers() where possible modifiers are set
294 * \sa define DRM_FORMAT_MOD_* in drm_fourcc.h for possible modifiers
295 */
296 GBM_EXPORT uint64_t
297 gbm_bo_get_modifier(struct gbm_bo *bo)
298 {
299 return bo->gbm->bo_get_modifier(bo);
300 }
301
302 /** Write data into the buffer object
303 *
304 * If the buffer object was created with the GBM_BO_USE_WRITE flag,
305 * this function can be used to write data into the buffer object. The
306 * data is copied directly into the object and it's the responsibility
307 * of the caller to make sure the data represents valid pixel data,
308 * according to the width, height, stride and format of the buffer object.
309 *
310 * \param bo The buffer object
311 * \param buf The data to write
312 * \param count The number of bytes to write
313 * \return Returns 0 on success, otherwise -1 is returned an errno set
314 */
315 GBM_EXPORT int
316 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count)
317 {
318 return bo->gbm->bo_write(bo, buf, count);
319 }
320
321 /** Set the user data associated with a buffer object
322 *
323 * \param bo The buffer object
324 * \param data The data to associate to the buffer object
325 * \param destroy_user_data A callback (which may be %NULL) that will be
326 * called prior to the buffer destruction
327 */
328 GBM_EXPORT void
329 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
330 void (*destroy_user_data)(struct gbm_bo *, void *))
331 {
332 bo->user_data = data;
333 bo->destroy_user_data = destroy_user_data;
334 }
335
336 /** Get the user data associated with a buffer object
337 *
338 * \param bo The buffer object
339 * \return Returns the user data associated with the buffer object or %NULL
340 * if no data was associated with it
341 *
342 * \sa gbm_bo_set_user_data()
343 */
344 GBM_EXPORT void *
345 gbm_bo_get_user_data(struct gbm_bo *bo)
346 {
347 return bo->user_data;
348 }
349
350 /**
351 * Destroys the given buffer object and frees all resources associated with
352 * it.
353 *
354 * \param bo The buffer object
355 */
356 GBM_EXPORT void
357 gbm_bo_destroy(struct gbm_bo *bo)
358 {
359 if (bo->destroy_user_data)
360 bo->destroy_user_data(bo, bo->user_data);
361
362 bo->gbm->bo_destroy(bo);
363 }
364
365 /**
366 * Allocate a buffer object for the given dimensions
367 *
368 * \param gbm The gbm device returned from gbm_create_device()
369 * \param width The width for the buffer
370 * \param height The height for the buffer
371 * \param format The format to use for the buffer
372 * \param usage The union of the usage flags for this buffer
373 *
374 * \return A newly allocated buffer that should be freed with gbm_bo_destroy()
375 * when no longer needed. If an error occurs during allocation %NULL will be
376 * returned and errno set.
377 *
378 * \sa enum gbm_bo_format for the list of formats
379 * \sa enum gbm_bo_flags for the list of usage flags
380 */
381 GBM_EXPORT struct gbm_bo *
382 gbm_bo_create(struct gbm_device *gbm,
383 uint32_t width, uint32_t height,
384 uint32_t format, uint32_t usage)
385 {
386 if (width == 0 || height == 0) {
387 errno = EINVAL;
388 return NULL;
389 }
390
391 return gbm->bo_create(gbm, width, height, format, usage, NULL, 0);
392 }
393
394 GBM_EXPORT struct gbm_bo *
395 gbm_bo_create_with_modifiers(struct gbm_device *gbm,
396 uint32_t width, uint32_t height,
397 uint32_t format,
398 const uint64_t *modifiers,
399 const unsigned int count)
400 {
401 if (width == 0 || height == 0) {
402 errno = EINVAL;
403 return NULL;
404 }
405
406 if ((count && !modifiers) || (modifiers && !count)) {
407 errno = EINVAL;
408 return NULL;
409 }
410
411 return gbm->bo_create(gbm, width, height, format, 0, modifiers, count);
412 }
413 /**
414 * Create a gbm buffer object from an foreign object
415 *
416 * This function imports a foreign object and creates a new gbm bo for it.
417 * This enabled using the foreign object with a display API such as KMS.
418 * Currently three types of foreign objects are supported, indicated by the type
419 * argument:
420 *
421 * GBM_BO_IMPORT_WL_BUFFER
422 * GBM_BO_IMPORT_EGL_IMAGE
423 * GBM_BO_IMPORT_FD
424 *
425 * The gbm bo shares the underlying pixels but its life-time is
426 * independent of the foreign object.
427 *
428 * \param gbm The gbm device returned from gbm_create_device()
429 * \param type The type of object we're importing
430 * \param buffer Pointer to the external object
431 * \param usage The union of the usage flags for this buffer
432 *
433 * \return A newly allocated buffer object that should be freed with
434 * gbm_bo_destroy() when no longer needed. On error, %NULL is returned
435 * and errno is set.
436 *
437 * \sa enum gbm_bo_flags for the list of usage flags
438 */
439 GBM_EXPORT struct gbm_bo *
440 gbm_bo_import(struct gbm_device *gbm,
441 uint32_t type, void *buffer, uint32_t usage)
442 {
443 return gbm->bo_import(gbm, type, buffer, usage);
444 }
445
446 /**
447 * Map a region of a gbm buffer object for cpu access
448 *
449 * This function maps a region of a gbm bo for cpu read and/or write
450 * access.
451 *
452 * \param bo The buffer object
453 * \param x The X (top left origin) starting position of the mapped region for
454 * the buffer
455 * \param y The Y (top left origin) starting position of the mapped region for
456 * the buffer
457 * \param width The width of the mapped region for the buffer
458 * \param height The height of the mapped region for the buffer
459 * \param flags The union of the GBM_BO_TRANSFER_* flags for this buffer
460 * \param stride Ptr for returned stride in bytes of the mapped region
461 * \param map_data Returned opaque ptr for the mapped region
462 *
463 * \return Address of the mapped buffer that should be unmapped with
464 * gbm_bo_unmap() when no longer needed. On error, %NULL is returned
465 * and errno is set.
466 *
467 * \sa enum gbm_bo_transfer_flags for the list of flags
468 */
469 GBM_EXPORT void *
470 gbm_bo_map(struct gbm_bo *bo,
471 uint32_t x, uint32_t y,
472 uint32_t width, uint32_t height,
473 uint32_t flags, uint32_t *stride, void **map_data)
474 {
475 if (!bo || width == 0 || height == 0 || !stride || !map_data) {
476 errno = EINVAL;
477 return NULL;
478 }
479
480 return bo->gbm->bo_map(bo, x, y, width, height,
481 flags, stride, map_data);
482 }
483
484 /**
485 * Unmap a previously mapped region of a gbm buffer object
486 *
487 * This function unmaps a region of a gbm bo for cpu read and/or write
488 * access.
489 *
490 * \param bo The buffer object
491 * \param map_data opaque ptr returned from prior gbm_bo_map
492 */
493 GBM_EXPORT void
494 gbm_bo_unmap(struct gbm_bo *bo, void *map_data)
495 {
496 bo->gbm->bo_unmap(bo, map_data);
497 }
498
499 /**
500 * Allocate a surface object
501 *
502 * \param gbm The gbm device returned from gbm_create_device()
503 * \param width The width for the surface
504 * \param height The height for the surface
505 * \param format The format to use for the surface
506 *
507 * \return A newly allocated surface that should be freed with
508 * gbm_surface_destroy() when no longer needed. If an error occurs
509 * during allocation %NULL will be returned.
510 *
511 * \sa enum gbm_bo_format for the list of formats
512 */
513 GBM_EXPORT struct gbm_surface *
514 gbm_surface_create(struct gbm_device *gbm,
515 uint32_t width, uint32_t height,
516 uint32_t format, uint32_t flags)
517 {
518 return gbm->surface_create(gbm, width, height, format, flags, NULL, 0);
519 }
520
521 GBM_EXPORT struct gbm_surface *
522 gbm_surface_create_with_modifiers(struct gbm_device *gbm,
523 uint32_t width, uint32_t height,
524 uint32_t format,
525 const uint64_t *modifiers,
526 const unsigned int count)
527 {
528 if ((count && !modifiers) || (modifiers && !count)) {
529 errno = EINVAL;
530 return NULL;
531 }
532
533 return gbm->surface_create(gbm, width, height, format, 0,
534 modifiers, count);
535 }
536
537 /**
538 * Destroys the given surface and frees all resources associated with
539 * it.
540 *
541 * All buffers locked with gbm_surface_lock_front_buffer() should be
542 * released prior to calling this function.
543 *
544 * \param surf The surface
545 */
546 GBM_EXPORT void
547 gbm_surface_destroy(struct gbm_surface *surf)
548 {
549 surf->gbm->surface_destroy(surf);
550 }
551
552 /**
553 * Lock the surface's current front buffer
554 *
555 * Lock rendering to the surface's current front buffer until it is
556 * released with gbm_surface_release_buffer().
557 *
558 * This function must be called exactly once after calling
559 * eglSwapBuffers. Calling it before any eglSwapBuffer has happened
560 * on the surface or two or more times after eglSwapBuffers is an
561 * error. A new bo representing the new front buffer is returned. On
562 * multiple invocations, all the returned bos must be released in
563 * order to release the actual surface buffer.
564 *
565 * \param surf The surface
566 *
567 * \return A buffer object that should be released with
568 * gbm_surface_release_buffer() when no longer needed. The implementation
569 * is free to reuse buffers released with gbm_surface_release_buffer() so
570 * this bo should not be destroyed using gbm_bo_destroy(). If an error
571 * occurs this function returns %NULL.
572 */
573 GBM_EXPORT struct gbm_bo *
574 gbm_surface_lock_front_buffer(struct gbm_surface *surf)
575 {
576 return surf->gbm->surface_lock_front_buffer(surf);
577 }
578
579 /**
580 * Release a locked buffer obtained with gbm_surface_lock_front_buffer()
581 *
582 * Returns the underlying buffer to the gbm surface. Releasing a bo
583 * will typically make gbm_surface_has_free_buffer() return 1 and thus
584 * allow rendering the next frame, but not always. The implementation
585 * may choose to destroy the bo immediately or reuse it, in which case
586 * the user data associated with it is unchanged.
587 *
588 * \param surf The surface
589 * \param bo The buffer object
590 */
591 GBM_EXPORT void
592 gbm_surface_release_buffer(struct gbm_surface *surf, struct gbm_bo *bo)
593 {
594 surf->gbm->surface_release_buffer(surf, bo);
595 }
596
597 /**
598 * Return whether or not a surface has free (non-locked) buffers
599 *
600 * Before starting a new frame, the surface must have a buffer
601 * available for rendering. Initially, a gbm surface will have a free
602 * buffer, but after one or more buffers have been locked (\sa
603 * gbm_surface_lock_front_buffer()), the application must check for a
604 * free buffer before rendering.
605 *
606 * If a surface doesn't have a free buffer, the application must
607 * return a buffer to the surface using gbm_surface_release_buffer()
608 * and after that, the application can query for free buffers again.
609 *
610 * \param surf The surface
611 * \return 1 if the surface has free buffers, 0 otherwise
612 */
613 GBM_EXPORT int
614 gbm_surface_has_free_buffers(struct gbm_surface *surf)
615 {
616 return surf->gbm->surface_has_free_buffers(surf);
617 }