src/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 _BSD_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
  40 #include "gbm.h"
  41 #include "gbmint.h"
  42 #include "backend.h"
  43
  44 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
  45
  46 static struct gbm_device *devices[16];
  47
  48 static int device_num = 0;
  49
  50 /** Returns the file description for the gbm device
  51  *
  52  * \return The fd that the struct gbm_device was created with
  53  */
  54 GBM_EXPORT int
  55 gbm_device_get_fd(struct gbm_device *gbm)
  56 {
  57    return gbm->fd;
  58 }
  59
  60 /* FIXME: maybe superfluous, use udev subclass from the fd? */
  61 /** Get the backend name for the given gbm device
  62  *
  63  * \return The backend name string - this belongs to the device and must not
  64  * be freed
  65  */
  66 GBM_EXPORT const char *
  67 gbm_device_get_backend_name(struct gbm_device *gbm)
  68 {
  69    return gbm->name;
  70 }
  71
  72 /** Test if a format is supported for a given set of usage flags.
  73  *
  74  * \param gbm The created buffer manager
  75  * \param format The format to test
  76  * \param usage A bitmask of the usages to test the format against
  77  * \return 1 if the format is supported otherwise 0
  78  *
  79  * \sa enum gbm_bo_flags for the list of flags that the format can be
  80  * tested against
  81  *
  82  * \sa enum gbm_bo_format for the list of formats
  83  */
  84 GBM_EXPORT int
  85 gbm_device_is_format_supported(struct gbm_device *gbm,
  86                                uint32_t format, uint32_t usage)
  87 {
  88    return gbm->is_format_supported(gbm, format, usage);
  89 }
  90
  91 /** Destroy the gbm device and free all resources associated with it.
  92  *
  93  * \param gbm The device created using gbm_create_device()
  94  */
  95 GBM_EXPORT void
  96 gbm_device_destroy(struct gbm_device *gbm)
  97 {
  98    gbm->refcount--;
  99    if (gbm->refcount == 0)
 100       gbm->destroy(gbm);
 101 }
 102
 103 struct gbm_device *
 104 _gbm_mesa_get_device(int fd)
 105 {
 106    struct gbm_device *gbm = NULL;
 107    struct stat buf;
 108    dev_t dev;
 109    int i;
 110
 111    if (fd < 0 || fstat(fd, &buf) < 0 || !S_ISCHR(buf.st_mode)) {
 112       fprintf(stderr, "_gbm_mesa_get_device: invalid fd: %d\n", fd);
 113       return NULL;
 114    }
 115
 116    for (i = 0; i < device_num; ++i) {
 117       dev = devices[i]->stat.st_rdev;
 118       if (major(dev) == major(buf.st_rdev) &&
 119           minor(dev) == minor(buf.st_rdev)) {
 120          gbm = devices[i];
 121          gbm->refcount++;
 122          break;
 123       }
 124    }
 125
 126    return gbm;
 127 }
 128
 129 /** Create a gbm device for allocating buffers
 130  *
 131  * The file descriptor passed in is used by the backend to communicate with
 132  * platform for allocating the memory. For allocations using DRI this would be
 133  * the file descriptor returned when opening a device such as \c
 134  * /dev/dri/card0
 135  *
 136  * \param fd The file descriptor for an backend specific device
 137  * \return The newly created struct gbm_device. The resources associated with
 138  * the device should be freed with gbm_device_destroy() when it is no longer
 139  * needed. If the creation of the device failed NULL will be returned.
 140  */
 141 GBM_EXPORT struct gbm_device *
 142 gbm_create_device(int fd)
 143 {
 144    struct gbm_device *gbm = NULL;
 145    struct stat buf;
 146
 147    if (fd < 0 || fstat(fd, &buf) < 0 || !S_ISCHR(buf.st_mode)) {
 148       fprintf(stderr, "gbm_create_device: invalid fd: %d\n", fd);
 149       return NULL;
 150    }
 151
 152    if (device_num == 0)
 153       memset(devices, 0, sizeof devices);
 154
 155    gbm = _gbm_create_device(fd);
 156    if (gbm == NULL)
 157       return NULL;
 158
 159    gbm->dummy = gbm_create_device;
 160    gbm->stat = buf;
 161    gbm->refcount = 1;
 162
 163    if (device_num < ARRAY_SIZE(devices)-1)
 164       devices[device_num++] = gbm;
 165
 166    return gbm;
 167 }
 168
 169 /** Get the width of the buffer object
 170  *
 171  * \param bo The buffer object
 172  * \return The width of the allocated buffer object
 173  *
 174  */
 175 GBM_EXPORT unsigned int
 176 gbm_bo_get_width(struct gbm_bo *bo)
 177 {
 178    return bo->width;
 179 }
 180
 181 /** Get the height of the buffer object
 182  *
 183  * \param bo The buffer object
 184  * \return The height of the allocated buffer object
 185  */
 186 GBM_EXPORT unsigned int
 187 gbm_bo_get_height(struct gbm_bo *bo)
 188 {
 189    return bo->height;
 190 }
 191
 192 /** Get the stride of the buffer object
 193  *
 194  * This is calculated by the backend when it does the allocation in
 195  * gbm_bo_create()
 196  *
 197  * \param bo The buffer object
 198  * \return The stride of the allocated buffer object in bytes
 199  */
 200 GBM_EXPORT uint32_t
 201 gbm_bo_get_stride(struct gbm_bo *bo)
 202 {
 203    return bo->stride;
 204 }
 205
 206 /** Get the format of the buffer object
 207  *
 208  * The format of the pixels in the buffer.
 209  *
 210  * \param bo The buffer object
 211  * \return The format of buffer object, on of the GBM_FORMAT_* codes
 212  */
 213 GBM_EXPORT uint32_t
 214 gbm_bo_get_format(struct gbm_bo *bo)
 215 {
 216    return bo->format;
 217 }
 218
 219 /** Get the handle of the buffer object
 220  *
 221  * This is stored in the platform generic union gbm_bo_handle type. However
 222  * the format of this handle is platform specific.
 223  *
 224  * \param bo The buffer object
 225  * \return Returns the handle of the allocated buffer object
 226  */
 227 GBM_EXPORT union gbm_bo_handle
 228 gbm_bo_get_handle(struct gbm_bo *bo)
 229 {
 230    return bo->handle;
 231 }
 232
 233 /** Get a DMA-BUF file descriptor for the buffer object
 234  *
 235  * This function creates a DMA-BUF (also known as PRIME) file descriptor
 236  * handle for the buffer object.  Eeach call to gbm_bo_get_fd() returns a new
 237  * file descriptor and the caller is responsible for closing the file
 238  * descriptor.
 239
 240  * \param bo The buffer object
 241  * \return Returns a file descriptor referring  to the underlying buffer
 242  */
 243 GBM_EXPORT int
 244 gbm_bo_get_fd(struct gbm_bo *bo)
 245 {
 246    return bo->gbm->bo_get_fd(bo);
 247 }
 248
 249
 250 /** Write data into the buffer object
 251  *
 252  * If the buffer object was created with the GBM_BO_USE_WRITE flag,
 253  * this function can used to write data into the buffer object.  The
 254  * data is copied directly into the object and it's the responsiblity
 255  * of the caller to make sure the data represents valid pixel data,
 256  * according to the width, height, stride and format of the buffer object.
 257  *
 258  * \param bo The buffer object
 259  * \param buf The data to write
 260  * \param count The number of bytes to write
 261  * \return Returns -1 on error, 0 otherwise
 262  */
 263 GBM_EXPORT int
 264 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count)
 265 {
 266    return bo->gbm->bo_write(bo, buf, count);
 267 }
 268
 269 /** Get the gbm device used to create the buffer object
 270  *
 271  * \param bo The buffer object
 272  * \return Returns the gbm device with which the buffer object was created
 273  */
 274 GBM_EXPORT struct gbm_device *
 275 gbm_bo_get_device(struct gbm_bo *bo)
 276 {
 277         return bo->gbm;
 278 }
 279
 280 /** Set the user data associated with a buffer object
 281  *
 282  * \param bo The buffer object
 283  * \param data The data to associate to the buffer object
 284  * \param destroy_user_data A callback (which may be %NULL) that will be
 285  * called prior to the buffer destruction
 286  */
 287 GBM_EXPORT void
 288 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
 289                      void (*destroy_user_data)(struct gbm_bo *, void *))
 290 {
 291    bo->user_data = data;
 292    bo->destroy_user_data = destroy_user_data;
 293 }
 294
 295 /** Get the user data associated with a buffer object
 296  *
 297  * \param bo The buffer object
 298  * \return Returns the user data associated with the buffer object or %NULL
 299  * if no data was associated with it
 300  *
 301  * \sa gbm_bo_set_user_data()
 302  */
 303 GBM_EXPORT void *
 304 gbm_bo_get_user_data(struct gbm_bo *bo)
 305 {
 306    return bo->user_data;
 307 }
 308
 309 /**
 310  * Destroys the given buffer object and frees all resources associated with
 311  * it.
 312  *
 313  * \param bo The buffer object
 314  */
 315 GBM_EXPORT void
 316 gbm_bo_destroy(struct gbm_bo *bo)
 317 {
 318    if (bo->destroy_user_data)
 319       bo->destroy_user_data(bo, bo->user_data);
 320
 321    bo->gbm->bo_destroy(bo);
 322 }
 323
 324 /**
 325  * Allocate a buffer object for the given dimensions
 326  *
 327  * \param gbm The gbm device returned from gbm_create_device()
 328  * \param width The width for the buffer
 329  * \param height The height for the buffer
 330  * \param format The format to use for the buffer
 331  * \param usage The union of the usage flags for this buffer
 332  *
 333  * \return A newly allocated buffer that should be freed with gbm_bo_destroy()
 334  * when no longer needed. If an error occurs during allocation %NULL will be
 335  * returned.
 336  *
 337  * \sa enum gbm_bo_format for the list of formats
 338  * \sa enum gbm_bo_flags for the list of usage flags
 339  */
 340 GBM_EXPORT struct gbm_bo *
 341 gbm_bo_create(struct gbm_device *gbm,
 342               uint32_t width, uint32_t height,
 343               uint32_t format, uint32_t usage)
 344 {
 345    if (width == 0 || height == 0)
 346       return NULL;
 347
 348    if (usage & GBM_BO_USE_CURSOR_64X64 &&
 349        (width != 64 || height != 64))
 350       return NULL;
 351
 352    return gbm->bo_create(gbm, width, height, format, usage);
 353 }
 354
 355 /**
 356  * Create a gbm buffer object from an foreign object
 357  *
 358  * This function imports a foreign object and creates a new gbm bo for it.
 359  * This enabled using the foreign object with a display API such as KMS.
 360  * Currently two types of foreign objects are supported, indicated by the type
 361  * argument:
 362  *
 363  *   GBM_BO_IMPORT_WL_BUFFER
 364  *   GBM_BO_IMPORT_EGL_IMAGE
 365  *   GBM_BO_IMPORT_FD
 366  *
 367  * The the gbm bo shares the underlying pixels but its life-time is
 368  * independent of the foreign object.
 369  *
 370  * \param gbm The gbm device returned from gbm_create_device()
 371  * \param gbm The type of object we're importing
 372  * \param gbm Pointer to the external object
 373  * \param usage The union of the usage flags for this buffer
 374  *
 375  * \return A newly allocated buffer object that should be freed with
 376  * gbm_bo_destroy() when no longer needed.
 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  * Allocate a surface object
 389  *
 390  * \param gbm The gbm device returned from gbm_create_device()
 391  * \param width The width for the surface
 392  * \param height The height for the surface
 393  * \param format The format to use for the surface
 394  *
 395  * \return A newly allocated surface that should be freed with
 396  * gbm_surface_destroy() when no longer needed. If an error occurs
 397  * during allocation %NULL will be returned.
 398  *
 399  * \sa enum gbm_bo_format for the list of formats
 400  */
 401 GBM_EXPORT struct gbm_surface *
 402 gbm_surface_create(struct gbm_device *gbm,
 403                    uint32_t width, uint32_t height,
 404                    uint32_t format, uint32_t flags)
 405 {
 406    return gbm->surface_create(gbm, width, height, format, flags);
 407 }
 408
 409 /**
 410  * Destroys the given surface and frees all resources associated with
 411  * it.
 412  *
 413  * All buffers locked with gbm_surface_lock_front_buffer() should be
 414  * released prior to calling this function.
 415  *
 416  * \param surf The surface
 417  */
 418 GBM_EXPORT void
 419 gbm_surface_destroy(struct gbm_surface *surf)
 420 {
 421    surf->gbm->surface_destroy(surf);
 422 }
 423
 424 /**
 425  * Lock the surface's current front buffer
 426  *
 427  * Lock rendering to the surface's current front buffer until it is
 428  * released with gbm_surface_release_buffer().
 429  *
 430  * This function must be called exactly once after calling
 431  * eglSwapBuffers.  Calling it before any eglSwapBuffer has happened
 432  * on the surface or two or more times after eglSwapBuffers is an
 433  * error.  A new bo representing the new front buffer is returned.  On
 434  * multiple invocations, all the returned bos must be released in
 435  * order to release the actual surface buffer.
 436  *
 437  * \param surf The surface
 438  *
 439  * \return A buffer object that should be released with
 440  * gbm_surface_release_buffer() when no longer needed.  The implementation
 441  * is free to reuse buffers released with gbm_surface_release_buffer() so
 442  * this bo should not be destroyed using gbm_bo_destroy().  If an error
 443  * occurs this function returns %NULL.
 444  */
 445 GBM_EXPORT struct gbm_bo *
 446 gbm_surface_lock_front_buffer(struct gbm_surface *surf)
 447 {
 448    return surf->gbm->surface_lock_front_buffer(surf);
 449 }
 450
 451 /**
 452  * Release a locked buffer obtained with gbm_surface_lock_front_buffer()
 453  *
 454  * Returns the underlying buffer to the gbm surface.  Releasing a bo
 455  * will typically make gbm_surface_has_free_buffer() return 1 and thus
 456  * allow rendering the next frame, but not always. The implementation
 457  * may choose to destroy the bo immediately or reuse it, in which case
 458  * the user data associated with it is unchanged.
 459  *
 460  * \param surf The surface
 461  * \param bo The buffer object
 462  */
 463 GBM_EXPORT void
 464 gbm_surface_release_buffer(struct gbm_surface *surf, struct gbm_bo *bo)
 465 {
 466    surf->gbm->surface_release_buffer(surf, bo);
 467 }
 468
 469 /**
 470  * Return whether or not a surface has free (non-locked) buffers
 471  *
 472  * Before starting a new frame, the surface must have a buffer
 473  * available for rendering.  Initially, a gbm surface will have a free
 474  * buffer, but after one of more buffers have been locked (\sa
 475  * gbm_surface_lock_front_buffer()), the application must check for a
 476  * free buffer before rendering.
 477  *
 478  * If a surface doesn't have a free buffer, the application must
 479  * return a buffer to the surface using gbm_surface_release_buffer()
 480  * and after that, the application can query for free buffers again.
 481  *
 482  * \param surf The surface
 483  * \return 1 if the surface has free buffers, 0 otherwise
 484  */
 485 GBM_EXPORT int
 486 gbm_surface_has_free_buffers(struct gbm_surface *surf)
 487 {
 488    return surf->gbm->surface_has_free_buffers(surf);
 489 }