Home | History | Annotate | Download | only in main
      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 #ifndef INTERNAL_H_
     29 #define INTERNAL_H_
     30 
     31 #include "gbm.h"
     32 #include <sys/stat.h>
     33 
     34 /* GCC visibility */
     35 #if defined(__GNUC__)
     36 #define GBM_EXPORT __attribute__ ((visibility("default")))
     37 #else
     38 #define GBM_EXPORT
     39 #endif
     40 
     41 /**
     42  * \file gbmint.h
     43  * \brief Internal implementation details of gbm
     44  */
     45 
     46 /**
     47  * The device used for the memory allocation.
     48  *
     49  * The members of this structure should be not accessed directly
     50  */
     51 struct gbm_device {
     52    /* Hack to make a gbm_device detectable by its first element. */
     53    struct gbm_device *(*dummy)(int);
     54 
     55    int fd;
     56    const char *name;
     57    unsigned int refcount;
     58    struct stat stat;
     59 
     60    void (*destroy)(struct gbm_device *gbm);
     61    int (*is_format_supported)(struct gbm_device *gbm,
     62                               uint32_t format,
     63                               uint32_t usage);
     64 
     65    struct gbm_bo *(*bo_create)(struct gbm_device *gbm,
     66                                uint32_t width, uint32_t height,
     67                                uint32_t format,
     68                                uint32_t usage);
     69    struct gbm_bo *(*bo_import)(struct gbm_device *gbm, uint32_t type,
     70                                void *buffer, uint32_t usage);
     71    void *(*bo_map)(struct gbm_bo *bo,
     72                                uint32_t x, uint32_t y,
     73                                uint32_t width, uint32_t height,
     74                                uint32_t flags, uint32_t *stride,
     75                                void **map_data);
     76    void (*bo_unmap)(struct gbm_bo *bo, void *map_data);
     77    int (*bo_write)(struct gbm_bo *bo, const void *buf, size_t data);
     78    int (*bo_get_fd)(struct gbm_bo *bo);
     79    void (*bo_destroy)(struct gbm_bo *bo);
     80 
     81    struct gbm_surface *(*surface_create)(struct gbm_device *gbm,
     82                                          uint32_t width, uint32_t height,
     83                                          uint32_t format, uint32_t flags);
     84    struct gbm_bo *(*surface_lock_front_buffer)(struct gbm_surface *surface);
     85    void (*surface_release_buffer)(struct gbm_surface *surface,
     86                                   struct gbm_bo *bo);
     87    int (*surface_has_free_buffers)(struct gbm_surface *surface);
     88    void (*surface_destroy)(struct gbm_surface *surface);
     89 };
     90 
     91 /**
     92  * The allocated buffer object.
     93  *
     94  * The members in this structure should not be accessed directly.
     95  */
     96 struct gbm_bo {
     97    struct gbm_device *gbm;
     98    uint32_t width;
     99    uint32_t height;
    100    uint32_t stride;
    101    uint32_t format;
    102    union gbm_bo_handle  handle;
    103    void *user_data;
    104    void (*destroy_user_data)(struct gbm_bo *, void *);
    105 };
    106 
    107 struct gbm_surface {
    108    struct gbm_device *gbm;
    109    uint32_t width;
    110    uint32_t height;
    111    uint32_t format;
    112    uint32_t flags;
    113 };
    114 
    115 struct gbm_backend {
    116    const char *backend_name;
    117    struct gbm_device *(*create_device)(int fd);
    118 };
    119 
    120 #endif
    121