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 (at) 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 unsigned int 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 unsigned int 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 bo->stride; 169 } 170 171 /** Get the format of the buffer object 172 * 173 * The format of the pixels in the buffer. 174 * 175 * \param bo The buffer object 176 * \return The format of buffer object, on of the GBM_FORMAT_* codes 177 */ 178 GBM_EXPORT uint32_t 179 gbm_bo_get_format(struct gbm_bo *bo) 180 { 181 return bo->format; 182 } 183 184 /** Get the handle of the buffer object 185 * 186 * This is stored in the platform generic union gbm_bo_handle type. However 187 * the format of this handle is platform specific. 188 * 189 * \param bo The buffer object 190 * \return Returns the handle of the allocated buffer object 191 */ 192 GBM_EXPORT union gbm_bo_handle 193 gbm_bo_get_handle(struct gbm_bo *bo) 194 { 195 return bo->handle; 196 } 197 198 /** Get a DMA-BUF file descriptor for the buffer object 199 * 200 * This function creates a DMA-BUF (also known as PRIME) file descriptor 201 * handle for the buffer object. Each call to gbm_bo_get_fd() returns a new 202 * file descriptor and the caller is responsible for closing the file 203 * descriptor. 204 205 * \param bo The buffer object 206 * \return Returns a file descriptor referring to the underlying buffer or -1 207 * if an error occurs. 208 */ 209 GBM_EXPORT int 210 gbm_bo_get_fd(struct gbm_bo *bo) 211 { 212 return bo->gbm->bo_get_fd(bo); 213 } 214 215 216 /** Write data into the buffer object 217 * 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. 223 * 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 228 */ 229 GBM_EXPORT int 230 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count) 231 { 232 return bo->gbm->bo_write(bo, buf, count); 233 } 234 235 /** Get the gbm device used to create the buffer object 236 * 237 * \param bo The buffer object 238 * \return Returns the gbm device with which the buffer object was created 239 */ 240 GBM_EXPORT struct gbm_device * 241 gbm_bo_get_device(struct gbm_bo *bo) 242 { 243 return bo->gbm; 244 } 245 246 /** Set the user data associated with a buffer object 247 * 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 252 */ 253 GBM_EXPORT void 254 gbm_bo_set_user_data(struct gbm_bo *bo, void *data, 255 void (*destroy_user_data)(struct gbm_bo *, void *)) 256 { 257 bo->user_data = data; 258 bo->destroy_user_data = destroy_user_data; 259 } 260 261 /** Get the user data associated with a buffer object 262 * 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 266 * 267 * \sa gbm_bo_set_user_data() 268 */ 269 GBM_EXPORT void * 270 gbm_bo_get_user_data(struct gbm_bo *bo) 271 { 272 return bo->user_data; 273 } 274 275 /** 276 * Destroys the given buffer object and frees all resources associated with 277 * it. 278 * 279 * \param bo The buffer object 280 */ 281 GBM_EXPORT void 282 gbm_bo_destroy(struct gbm_bo *bo) 283 { 284 if (bo->destroy_user_data) 285 bo->destroy_user_data(bo, bo->user_data); 286 287 bo->gbm->bo_destroy(bo); 288 } 289 290 /** 291 * Allocate a buffer object for the given dimensions 292 * 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 298 * 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. 302 * 303 * \sa enum gbm_bo_format for the list of formats 304 * \sa enum gbm_bo_flags for the list of usage flags 305 */ 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) 310 { 311 if (width == 0 || height == 0) { 312 errno = EINVAL; 313 return NULL; 314 } 315 316 return gbm->bo_create(gbm, width, height, format, usage); 317 } 318 319 /** 320 * Create a gbm buffer object from an foreign object 321 * 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 325 * argument: 326 * 327 * GBM_BO_IMPORT_WL_BUFFER 328 * GBM_BO_IMPORT_EGL_IMAGE 329 * GBM_BO_IMPORT_FD 330 * 331 * The gbm bo shares the underlying pixels but its life-time is 332 * independent of the foreign object. 333 * 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 338 * 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 341 * and errno is set. 342 * 343 * \sa enum gbm_bo_flags for the list of usage flags 344 */ 345 GBM_EXPORT struct gbm_bo * 346 gbm_bo_import(struct gbm_device *gbm, 347 uint32_t type, void *buffer, uint32_t usage) 348 { 349 return gbm->bo_import(gbm, type, buffer, usage); 350 } 351 352 /** 353 * Map a region of a gbm buffer object for cpu access 354 * 355 * This function maps a region of a gbm bo for cpu read and/or write 356 * access. 357 * 358 * \param bo The buffer object 359 * \param x The X (top left origin) starting position of the mapped region for 360 * the buffer 361 * \param y The Y (top left origin) starting position of the mapped region for 362 * the buffer 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 368 * 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 371 * and errno is set. 372 * 373 * \sa enum gbm_bo_transfer_flags for the list of flags 374 */ 375 GBM_EXPORT void * 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) 380 { 381 if (!bo || width == 0 || height == 0 || !stride || !map_data) { 382 errno = EINVAL; 383 return NULL; 384 } 385 386 return bo->gbm->bo_map(bo, x, y, width, height, 387 flags, stride, map_data); 388 } 389 390 /** 391 * Unmap a previously mapped region of a gbm buffer object 392 * 393 * This function unmaps a region of a gbm bo for cpu read and/or write 394 * access. 395 * 396 * \param bo The buffer object 397 * \param map_data opaque ptr returned from prior gbm_bo_map 398 */ 399 GBM_EXPORT void 400 gbm_bo_unmap(struct gbm_bo *bo, void *map_data) 401 { 402 bo->gbm->bo_unmap(bo, map_data); 403 } 404 405 /** 406 * Allocate a surface object 407 * 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 412 * 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. 416 * 417 * \sa enum gbm_bo_format for the list of formats 418 */ 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) 423 { 424 return gbm->surface_create(gbm, width, height, format, flags); 425 } 426 427 /** 428 * Destroys the given surface and frees all resources associated with 429 * it. 430 * 431 * All buffers locked with gbm_surface_lock_front_buffer() should be 432 * released prior to calling this function. 433 * 434 * \param surf The surface 435 */ 436 GBM_EXPORT void 437 gbm_surface_destroy(struct gbm_surface *surf) 438 { 439 surf->gbm->surface_destroy(surf); 440 } 441 442 /** 443 * Lock the surface's current front buffer 444 * 445 * Lock rendering to the surface's current front buffer until it is 446 * released with gbm_surface_release_buffer(). 447 * 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. 454 * 455 * \param surf The surface 456 * 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. 462 */ 463 GBM_EXPORT struct gbm_bo * 464 gbm_surface_lock_front_buffer(struct gbm_surface *surf) 465 { 466 return surf->gbm->surface_lock_front_buffer(surf); 467 } 468 469 /** 470 * Release a locked buffer obtained with gbm_surface_lock_front_buffer() 471 * 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. 477 * 478 * \param surf The surface 479 * \param bo The buffer object 480 */ 481 GBM_EXPORT void 482 gbm_surface_release_buffer(struct gbm_surface *surf, struct gbm_bo *bo) 483 { 484 surf->gbm->surface_release_buffer(surf, bo); 485 } 486 487 /** 488 * Return whether or not a surface has free (non-locked) buffers 489 * 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. 495 * 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. 499 * 500 * \param surf The surface 501 * \return 1 if the surface has free buffers, 0 otherwise 502 */ 503 GBM_EXPORT int 504 gbm_surface_has_free_buffers(struct gbm_surface *surf) 505 { 506 return surf->gbm->surface_has_free_buffers(surf); 507 } 508
