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 #define _DEFAULT_SOURCE
  29
  30 #include <stddef.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <stdint.h>
  35
  36 #include <sys/types.h>
  37 #include <sys/stat.h>
  38 #include <unistd.h>
  39 #include <errno.h>
  40
  41 #include "gbm.h"
  42 #include "gbmint.h"
  43 #include "backend.h"
  44
  45 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
  46
  47 static struct gbm_device *devices[16];
  48
  49 static int device_num = 0;
  50
  51 /** Returns the file description for the gbm device
  52  *
  53  * \return The fd that the struct gbm_device was created with
  54  */
  55 GBM_EXPORT int
  56 gbm_device_get_fd(struct gbm_device *gbm)
  57 {
  58    return gbm->fd;
  59 }
  60
  61 /* FIXME: maybe superfluous, use udev subclass from the fd? */
  62 /** Get the backend name for the given gbm device
  63  *
  64  * \return The backend name string - this belongs to the device and must not
  65  * be freed
  66  */
  67 GBM_EXPORT const char *
  68 gbm_device_get_backend_name(struct gbm_device *gbm)
  69 {
  70    return gbm->name;
  71 }
  72
  73 /** Test if a format is supported for a given set of usage flags.
  74  *
  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
  79  *
  80  * \sa enum gbm_bo_flags for the list of flags that the format can be
  81  * tested against
  82  *
  83  * \sa enum gbm_bo_format for the list of formats
  84  */
  85 GBM_EXPORT int
  86 gbm_device_is_format_supported(struct gbm_device *gbm,
  87                                uint32_t format, uint32_t usage)
  88 {
  89    return gbm->is_format_supported(gbm, format, usage);
  90 }
  91
  92 /** Destroy the gbm device and free all resources associated with it.
  93  *
  94  * \param gbm The device created using gbm_create_device()
  95  */
  96 GBM_EXPORT void
  97 gbm_device_destroy(struct gbm_device *gbm)
  98 {
  99    gbm->refcount--;
 100    if (gbm->refcount == 0)
 101       gbm->destroy(gbm);
 102 }
 103
 104 struct gbm_device *
 105 _gbm_mesa_get_device(int fd)
 106 {
 107    struct gbm_device *gbm = NULL;
 108    struct stat buf;
 109    dev_t dev;
 110    int i;
 111
 112    if (fd < 0 || fstat(fd, &buf) < 0 || !S_ISCHR(buf.st_mode)) {
 113       errno = EINVAL;
 114       return NULL;
 115    }
 116
 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)) {
 121          gbm = devices[i];
 122          gbm->refcount++;
 123          break;
 124       }
 125    }
 126
 127    return gbm;
 128 }
 129
 130 /** Create a gbm device for allocating buffers
 131  *
 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
 135  * /dev/dri/card0
 136  *
 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.
 141  */
 142 GBM_EXPORT struct gbm_device *
 143 gbm_create_device(int fd)
 144 {
 145    struct gbm_device *gbm = NULL;
 146    struct stat buf;
 147
 148    if (fd < 0 || fstat(fd, &buf) < 0 || !S_ISCHR(buf.st_mode)) {
 149       errno = EINVAL;
 150       return NULL;
 151    }
 152
 153    if (device_num == 0)
 154       memset(devices, 0, sizeof devices);
 155
 156    gbm = _gbm_create_device(fd);
 157    if (gbm == NULL)
 158       return NULL;
 159
 160    gbm->dummy = gbm_create_device;
 161    gbm->stat = buf;
 162    gbm->refcount = 1;
 163
 164    if (device_num < ARRAY_SIZE(devices)-1)
 165       devices[device_num++] = gbm;
 166
 167    return gbm;
 168 }
 169
 170 /** Get the width of the buffer object
 171  *
 172  * \param bo The buffer object
 173  * \return The width of the allocated buffer object
 174  *
 175  */
 176 GBM_EXPORT unsigned int
 177 gbm_bo_get_width(struct gbm_bo *bo)
 178 {
 179    return bo->width;
 180 }
 181
 182 /** Get the height of the buffer object
 183  *
 184  * \param bo The buffer object
 185  * \return The height of the allocated buffer object
 186  */
 187 GBM_EXPORT unsigned int
 188 gbm_bo_get_height(struct gbm_bo *bo)
 189 {
 190    return bo->height;
 191 }
 192
 193 /** Get the stride of the buffer object
 194  *
 195  * This is calculated by the backend when it does the allocation in
 196  * gbm_bo_create()
 197  *
 198  * \param bo The buffer object
 199  * \return The stride of the allocated buffer object in bytes
 200  */
 201 GBM_EXPORT uint32_t
 202 gbm_bo_get_stride(struct gbm_bo *bo)
 203 {
 204    return bo->stride;
 205 }
 206
 207 /** Get the format of the buffer object
 208  *
 209  * The format of the pixels in the buffer.
 210  *
 211  * \param bo The buffer object
 212  * \return The format of buffer object, on of the GBM_FORMAT_* codes
 213  */
 214 GBM_EXPORT uint32_t
 215 gbm_bo_get_format(struct gbm_bo *bo)
 216 {
 217    return bo->format;
 218 }
 219
 220 /** Get the handle of the buffer object
 221  *
 222  * This is stored in the platform generic union gbm_bo_handle type. However
 223  * the format of this handle is platform specific.
 224  *
 225  * \param bo The buffer object
 226  * \return Returns the handle of the allocated buffer object
 227  */
 228 GBM_EXPORT union gbm_bo_handle
 229 gbm_bo_get_handle(struct gbm_bo *bo)
 230 {
 231    return bo->handle;
 232 }
 233
 234 /** Get a DMA-BUF file descriptor for the buffer object
 235  *
 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
 239  * descriptor.
 240
 241  * \param bo The buffer object
 242  * \return Returns a file descriptor referring  to the underlying buffer
 243  */
 244 GBM_EXPORT int
 245 gbm_bo_get_fd(struct gbm_bo *bo)
 246 {
 247    return bo->gbm->bo_get_fd(bo);
 248 }
 249
 250
 251 /** Write data into the buffer object
 252  *
 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.
 258  *
 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
 263  */
 264 GBM_EXPORT int
 265 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count)
 266 {
 267    return bo->gbm->bo_write(bo, buf, count);
 268 }
 269
 270 /** Get the gbm device used to create the buffer object
 271  *
 272  * \param bo The buffer object
 273  * \return Returns the gbm device with which the buffer object was created
 274  */
 275 GBM_EXPORT struct gbm_device *
 276 gbm_bo_get_device(struct gbm_bo *bo)
 277 {
 278         return bo->gbm;
 279 }
 280
 281 /** Set the user data associated with a buffer object
 282  *
 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
 287  */
 288 GBM_EXPORT void
 289 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
 290                      void (*destroy_user_data)(struct gbm_bo *, void *))
 291 {
 292    bo->user_data = data;
 293    bo->destroy_user_data = destroy_user_data;
 294 }
 295
 296 /** Get the user data associated with a buffer object
 297  *
 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
 301  *
 302  * \sa gbm_bo_set_user_data()
 303  */
 304 GBM_EXPORT void *
 305 gbm_bo_get_user_data(struct gbm_bo *bo)
 306 {
 307    return bo->user_data;
 308 }
 309
 310 /**
 311  * Destroys the given buffer object and frees all resources associated with
 312  * it.
 313  *
 314  * \param bo The buffer object
 315  */
 316 GBM_EXPORT void
 317 gbm_bo_destroy(struct gbm_bo *bo)
 318 {
 319    if (bo->destroy_user_data)
 320       bo->destroy_user_data(bo, bo->user_data);
 321
 322    bo->gbm->bo_destroy(bo);
 323 }
 324
 325 /**
 326  * Allocate a buffer object for the given dimensions
 327  *
 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
 333  *
 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.
 337  *
 338  * \sa enum gbm_bo_format for the list of formats
 339  * \sa enum gbm_bo_flags for the list of usage flags
 340  */
 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)
 345 {
 346    if (width == 0 || height == 0) {
 347       errno = EINVAL;
 348       return NULL;
 349    }
 350
 351    return gbm->bo_create(gbm, width, height, format, usage);
 352 }
 353
 354 /**
 355  * Create a gbm buffer object from an foreign object
 356  *
 357  * This function imports a foreign object and creates a new gbm bo for it.
 358  * This enabled using the foreign object with a display API such as KMS.
 359  * Currently two types of foreign objects are supported, indicated by the type
 360  * argument:
 361  *
 362  *   GBM_BO_IMPORT_WL_BUFFER
 363  *   GBM_BO_IMPORT_EGL_IMAGE
 364  *   GBM_BO_IMPORT_FD
 365  *
 366  * The the gbm bo shares the underlying pixels but its life-time is
 367  * independent of the foreign object.
 368  *
 369  * \param gbm The gbm device returned from gbm_create_device()
 370  * \param gbm The type of object we're importing
 371  * \param gbm Pointer to the external object
 372  * \param usage The union of the usage flags for this buffer
 373  *
 374  * \return A newly allocated buffer object that should be freed with
 375  * gbm_bo_destroy() when no longer needed. On error, %NULL is returned
 376  * and errno is set.
 377  *
 378  * \sa enum gbm_bo_flags for the list of usage flags
 379  */
 380 GBM_EXPORT struct gbm_bo *
 381 gbm_bo_import(struct gbm_device *gbm,
 382               uint32_t type, void *buffer, uint32_t usage)
 383 {
 384    return gbm->bo_import(gbm, type, buffer, usage);
 385 }
 386
 387 /**
 388  * Map a region of a gbm buffer object for cpu access
 389  *
 390  * This function maps a region of a gbm bo for cpu read and/or write
 391  * access.
 392  *
 393  * \param bo The buffer object
 394  * \param x The X (top left origin) starting position of the mapped region for
 395  * the buffer
 396  * \param y The Y (top left origin) starting position of the mapped region for
 397  * the buffer
 398  * \param width The width of the mapped region for the buffer
 399  * \param height The height of the mapped region for the buffer
 400  * \param flags The union of the GBM_BO_TRANSFER_* flags for this buffer
 401  * \param stride Ptr for returned stride in bytes of the mapped region
 402  * \param map_data Returned opaque ptr for the mapped region
 403  *
 404  * \return Address of the mapped buffer that should be unmapped with
 405  * gbm_bo_unmap() when no longer needed. On error, %NULL is returned
 406  * and errno is set.
 407  *
 408  * \sa enum gbm_bo_transfer_flags for the list of flags
 409  */
 410 GBM_EXPORT void *
 411 gbm_bo_map(struct gbm_bo *bo,
 412               uint32_t x, uint32_t y,
 413               uint32_t width, uint32_t height,
 414               uint32_t flags, uint32_t *stride, void **map_data)
 415 {
 416    if (!bo || width == 0 || height == 0 || !stride || !map_data) {
 417       errno = EINVAL;
 418       return NULL;
 419    }
 420
 421    return bo->gbm->bo_map(bo, x, y, width, height,
 422                           flags, stride, map_data);
 423 }
 424
 425 /**
 426  * Unmap a previously mapped region of a gbm buffer object
 427  *
 428  * This function unmaps a region of a gbm bo for cpu read and/or write
 429  * access.
 430  *
 431  * \param bo The buffer object
 432  * \param map_data opaque ptr returned from prior gbm_bo_map
 433  */
 434 GBM_EXPORT void
 435 gbm_bo_unmap(struct gbm_bo *bo, void *map_data)
 436 {
 437    bo->gbm->bo_unmap(bo, map_data);
 438 }
 439
 440 /**
 441  * Allocate a surface object
 442  *
 443  * \param gbm The gbm device returned from gbm_create_device()
 444  * \param width The width for the surface
 445  * \param height The height for the surface
 446  * \param format The format to use for the surface
 447  *
 448  * \return A newly allocated surface that should be freed with
 449  * gbm_surface_destroy() when no longer needed. If an error occurs
 450  * during allocation %NULL will be returned.
 451  *
 452  * \sa enum gbm_bo_format for the list of formats
 453  */
 454 GBM_EXPORT struct gbm_surface *
 455 gbm_surface_create(struct gbm_device *gbm,
 456                    uint32_t width, uint32_t height,
 457                    uint32_t format, uint32_t flags)
 458 {
 459    return gbm->surface_create(gbm, width, height, format, flags);
 460 }
 461
 462 /**
 463  * Destroys the given surface and frees all resources associated with
 464  * it.
 465  *
 466  * All buffers locked with gbm_surface_lock_front_buffer() should be
 467  * released prior to calling this function.
 468  *
 469  * \param surf The surface
 470  */
 471 GBM_EXPORT void
 472 gbm_surface_destroy(struct gbm_surface *surf)
 473 {
 474    surf->gbm->surface_destroy(surf);
 475 }
 476
 477 /**
 478  * Lock the surface's current front buffer
 479  *
 480  * Lock rendering to the surface's current front buffer until it is
 481  * released with gbm_surface_release_buffer().
 482  *
 483  * This function must be called exactly once after calling
 484  * eglSwapBuffers.  Calling it before any eglSwapBuffer has happened
 485  * on the surface or two or more times after eglSwapBuffers is an
 486  * error.  A new bo representing the new front buffer is returned.  On
 487  * multiple invocations, all the returned bos must be released in
 488  * order to release the actual surface buffer.
 489  *
 490  * \param surf The surface
 491  *
 492  * \return A buffer object that should be released with
 493  * gbm_surface_release_buffer() when no longer needed.  The implementation
 494  * is free to reuse buffers released with gbm_surface_release_buffer() so
 495  * this bo should not be destroyed using gbm_bo_destroy().  If an error
 496  * occurs this function returns %NULL.
 497  */
 498 GBM_EXPORT struct gbm_bo *
 499 gbm_surface_lock_front_buffer(struct gbm_surface *surf)
 500 {
 501    return surf->gbm->surface_lock_front_buffer(surf);
 502 }
 503
 504 /**
 505  * Release a locked buffer obtained with gbm_surface_lock_front_buffer()
 506  *
 507  * Returns the underlying buffer to the gbm surface.  Releasing a bo
 508  * will typically make gbm_surface_has_free_buffer() return 1 and thus
 509  * allow rendering the next frame, but not always. The implementation
 510  * may choose to destroy the bo immediately or reuse it, in which case
 511  * the user data associated with it is unchanged.
 512  *
 513  * \param surf The surface
 514  * \param bo The buffer object
 515  */
 516 GBM_EXPORT void
 517 gbm_surface_release_buffer(struct gbm_surface *surf, struct gbm_bo *bo)
 518 {
 519    surf->gbm->surface_release_buffer(surf, bo);
 520 }
 521
 522 /**
 523  * Return whether or not a surface has free (non-locked) buffers
 524  *
 525  * Before starting a new frame, the surface must have a buffer
 526  * available for rendering.  Initially, a gbm surface will have a free
 527  * buffer, but after one of more buffers have been locked (\sa
 528  * gbm_surface_lock_front_buffer()), the application must check for a
 529  * free buffer before rendering.
 530  *
 531  * If a surface doesn't have a free buffer, the application must
 532  * return a buffer to the surface using gbm_surface_release_buffer()
 533  * and after that, the application can query for free buffers again.
 534  *
 535  * \param surf The surface
 536  * \return 1 if the surface has free buffers, 0 otherwise
 537  */
 538 GBM_EXPORT int
 539 gbm_surface_has_free_buffers(struct gbm_surface *surf)
 540 {
 541    return surf->gbm->surface_has_free_buffers(surf);
 542 }