src/tbm_bufmgr_int.h

   1 /**************************************************************************
   2
   3 libtbm
   4
   5 Copyright 2012 Samsung Electronics co., Ltd. All Rights Reserved.
   6
   7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
   8 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
   9
  10 Permission is hereby granted, free of charge, to any person obtaining a
  11 copy of this software and associated documentation files (the
  12 "Software"), to deal in the Software without restriction, including
  13 without limitation the rights to use, copy, modify, merge, publish,
  14 distribute, sub license, and/or sell copies of the Software, and to
  15 permit persons to whom the Software is furnished to do so, subject to
  16 the following conditions:
  17
  18 The above copyright notice and this permission notice (including the
  19 next paragraph) shall be included in all copies or substantial portions
  20 of the Software.
  21
  22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  23 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  25 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  27 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  28 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30 **************************************************************************/
  31
  32 #ifndef _TBM_BUFMGR_INT_H_
  33 #define _TBM_BUFMGR_INT_H_
  34
  35 #include <unistd.h>
  36 #include <limits.h>
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <sys/ioctl.h>
  40 #include <sys/types.h>
  41 #include <sys/stat.h>
  42 #include <fcntl.h>
  43 #include <dlfcn.h>
  44 #include <dirent.h>
  45 #include <string.h>
  46 #include <errno.h>
  47 #include <pthread.h>
  48 #include <tbm_bufmgr.h>
  49 #include <tbm_surface.h>
  50 #include <tbm_surface_internal.h>
  51 #include <tbm_bufmgr_backend.h>
  52 #include <tbm_surface_queue.h>
  53
  54 /* check condition */
  55 #define TBM_RETURN_IF_FAIL(cond) {\
  56         if (!(cond)) {\
  57                 TBM_LOG("[%s] : '%s' failed.\n", __func__, #cond);\
  58                 return;\
  59         } \
  60 }
  61 #define TBM_RETURN_VAL_IF_FAIL(cond, val) {\
  62         if (!(cond)) {\
  63                 TBM_LOG("[%s] : '%s' failed.\n", __func__, #cond);\
  64                 return val;\
  65         } \
  66 }
  67
  68 /* check flags */
  69 #define RETURN_CHECK_FLAG(cond) {\
  70         if ((cond)) {\
  71                 return;\
  72         } \
  73 }
  74 #define RETURN_VAL_CHECK_FLAG(cond, val) {\
  75         if ((cond)) {\
  76                 return val;\
  77         } \
  78 }
  79
  80 /* check validation */
  81 #define TBM_BUFMGR_IS_VALID(mgr) (mgr)
  82 #define TBM_BO_IS_VALID(bo) (bo && \
  83                             TBM_BUFMGR_IS_VALID(bo->bufmgr) && \
  84                             bo->item_link.next && \
  85                             bo->item_link.next->prev == &bo->item_link)
  86 #define TBM_SURFACE_IS_VALID(surf) (surf && \
  87                                    TBM_BUFMGR_IS_VALID(surf->bufmgr) && \
  88                                    surf->item_link.next && \
  89                                    surf->item_link.next->prev == &surf->item_link)
  90
  91 #define TBM_DEBUG(fmt, ...)   fprintf(stderr, "[TBM:DEBUG(%d)] " fmt, getpid(), ##__VA_ARGS__)
  92 #define TBM_LOG(fmt, ...)  fprintf(stderr, "[TBM(%d):%s] " fmt, getpid(), __func__, ##__VA_ARGS__)
  93
  94 struct list_head {
  95         struct list_head *prev;
  96         struct list_head *next;
  97 };
  98
  99 /* unneeded version 2.0 */
 100 #define TBM_ALL_CTRL_BACKEND_VALID(flags) \
 101                 ((flags&TBM_CACHE_CTRL_BACKEND) &&\
 102                 (flags&TBM_LOCK_CTRL_BACKEND))
 103 #define TBM_CACHE_CTRL_BACKEND_VALID(flags) \
 104                 (flags&TBM_CACHE_CTRL_BACKEND)
 105 #define TBM_LOCK_CTRL_BACKEND_VALID(flags) \
 106                 (flags&TBM_LOCK_CTRL_BACKEND)
 107
 108 typedef union _tbm_bo_cache_state tbm_bo_cache_state;
 109
 110 union _tbm_bo_cache_state {
 111         unsigned int val;
 112         struct {
 113                 unsigned int cntFlush: 16;      /*Flush all index for sync */
 114                 unsigned int isCacheable: 1;
 115                 unsigned int isCached: 1;
 116                 unsigned int isDirtied: 2;
 117         } data;
 118 };
 119 /* unneeded version 2.0 */
 120
 121 /**
 122  * @brief tbm_bo : buffer object of Tizen Buffer Manager
 123  */
 124 struct _tbm_bo {
 125         tbm_bufmgr bufmgr;                      /* tbm buffer manager */
 126
 127         int ref_cnt;                            /* ref count of bo */
 128
 129         int flags;                                      /* TBM_BO_FLAGS :bo memory type */
 130
 131         struct list_head user_data_list;        /* list of the user_date in bo */
 132
 133         void *priv;                                     /* bo private */
 134
 135         struct list_head item_link;     /* link of bo */
 136
 137         tbm_surface_h surface; /* tbm_surface */
 138
 139         int lock_cnt;                           /* lock count of bo */
 140
 141         unsigned int map_cnt;           /* device map count */
 142
 143         /* unneeded version 2.0 */
 144         tbm_bo_handle default_handle; /*default handle */
 145
 146         unsigned int tgl_key;           /*global key for tizen global lock */
 147
 148         /* for cache control */
 149         tbm_bo_cache_state cache_state; /*cache state */
 150         /* unneeded version 2.0 */
 151 };
 152
 153 /**
 154  * @brief tbm_bufmgr : structure for tizen buffer manager
 155  *
 156  */
 157 struct _tbm_bufmgr {
 158         pthread_mutex_t lock;           /* mutex lock */
 159
 160         int ref_count;                          /*reference count */
 161
 162         int fd;                                         /* bufmgr fd */
 163
 164         int lock_type;                          /* lock_type of bufmgr */
 165
 166         struct list_head bo_list;       /* list of bos belonging to bufmgr */
 167
 168         struct list_head surf_list;     /* list of surfaces belonging to bufmgr */
 169
 170         void *module_data;
 171
 172         tbm_bufmgr_backend backend;     /* bufmgr backend */
 173
 174         int use_2_0;
 175
 176         /* unneeded version 2.0 */
 177         int lock_fd;                            /* fd of tizen global lock */
 178
 179         int fd_flag;                            /* flag set 1 when bufmgr fd open in tbm_bufmgr_init */
 180
 181         int use_map_cache;                      /* flag to use the map_cahce */
 182         /* unneeded version 2.0 */
 183 };
 184
 185 /**
 186  * @brief tbm_surface : structure for tizen buffer surface
 187  *
 188  */
 189 struct _tbm_surface {
 190         tbm_bufmgr bufmgr;                      /* tbm buffer manager */
 191
 192         tbm_surface_info_s info;        /* tbm surface information */
 193
 194         int flags;
 195
 196         int num_bos;                            /* the number of buffer objects */
 197
 198         tbm_bo bos[4];
 199
 200         int num_planes;                         /* the number of buffer objects */
 201
 202         int planes_bo_idx[TBM_SURF_PLANE_MAX];
 203
 204         int refcnt;
 205
 206         unsigned int debug_pid;
 207
 208         struct list_head item_link; /* link of surface */
 209
 210         struct list_head user_data_list;        /* list of the user_date in surface */
 211 };
 212
 213 typedef struct {
 214         unsigned long key;
 215         void *data;
 216         tbm_data_free free_func;
 217
 218         /* link of user_data */
 219         struct list_head item_link;
 220 } tbm_user_data;
 221
 222 int tbm_bufmgr_get_drm_fd_x11(void);
 223 int tbm_bufmgr_get_drm_fd_wayland(void);
 224
 225 int _tbm_bo_set_surface(tbm_bo bo, tbm_surface_h surface);
 226
 227 /* functions for mutex */
 228 int tbm_surface_internal_get_info(tbm_surface_h surface, int opt,
 229                                   tbm_surface_info_s *info, int map);
 230 void tbm_surface_internal_unmap(tbm_surface_h surface);
 231 unsigned int tbm_surface_internal_get_width(tbm_surface_h surface);
 232 unsigned int tbm_surface_internal_get_height(tbm_surface_h surface);
 233 tbm_format tbm_surface_internal_get_format(tbm_surface_h surface);
 234 unsigned int _tbm_surface_internal_get_debug_pid(tbm_surface_h surface);
 235 char *_tbm_surface_internal_format_to_str(tbm_format format);
 236
 237 tbm_user_data *user_data_lookup(struct list_head *user_data_list,
 238                                 unsigned long key);
 239 tbm_user_data *user_data_create(unsigned long key,
 240                                 tbm_data_free data_free_func);
 241 void user_data_delete(tbm_user_data *user_data);
 242
 243 #endif                                                  /* _TBM_BUFMGR_INT_H_ */