src/tdm_private.h

   1 /**************************************************************************
   2
   3 libtdm
   4
   5 Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
   6
   7 Contact: Eunchul Kim <chulspro.kim@samsung.com>,
   8          JinYoung Jeon <jy0.jeon@samsung.com>,
   9          Taeheon Kim <th908.kim@samsung.com>,
  10          YoungJun Cho <yj44.cho@samsung.com>,
  11          SooChan Lim <sc1.lim@samsung.com>,
  12          Boram Park <sc1.lim@samsung.com>
  13
  14 Permission is hereby granted, free of charge, to any person obtaining a
  15 copy of this software and associated documentation files (the
  16 "Software"), to deal in the Software without restriction, including
  17 without limitation the rights to use, copy, modify, merge, publish,
  18 distribute, sub license, and/or sell copies of the Software, and to
  19 permit persons to whom the Software is furnished to do so, subject to
  20 the following conditions:
  21
  22 The above copyright notice and this permission notice (including the
  23 next paragraph) shall be included in all copies or substantial portions
  24 of the Software.
  25
  26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  27 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  29 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  30 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  31 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  32 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33
  34 **************************************************************************/
  35
  36 #ifndef _TDM_PRIVATE_H_
  37 #define _TDM_PRIVATE_H_
  38
  39 #include <stdio.h>
  40 #include <string.h>
  41 #include <stdlib.h>
  42 #include <pthread.h>
  43 #include <errno.h>
  44 #include <unistd.h>
  45 #include <limits.h>
  46 #include <sys/types.h>
  47 #include <sys/stat.h>
  48 #include <fcntl.h>
  49 #include <dlfcn.h>
  50 #include <dirent.h>
  51
  52 #include <tbm_bufmgr.h>
  53 #include <tbm_surface_queue.h>
  54
  55 #include "tdm_backend.h"
  56 #include "tdm_log.h"
  57 #include "tdm_list.h"
  58
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63 /**
  64  * @file tdm_private.h
  65  * @brief The private header file for a frontend library
  66  */
  67
  68 extern int tdm_debug_buffer;
  69 extern int tdm_debug_mutex;
  70
  71 #undef EXTERN
  72 #undef DEPRECATED
  73 #undef INTERN
  74
  75 #if defined(__GNUC__) && __GNUC__ >= 4
  76 #define EXTERN __attribute__ ((visibility("default")))
  77 #else
  78 #define EXTERN
  79 #endif
  80
  81 #if defined(__GNUC__) && __GNUC__ >= 4
  82 #define INTERN __attribute__ ((visibility("hidden")))
  83 #else
  84 #define INTERN
  85 #endif
  86
  87 #if defined(__GNUC__) && __GNUC__ >= 4
  88 #define DEPRECATED __attribute__ ((deprecated))
  89 #else
  90 #define DEPRECATED
  91 #endif
  92
  93 /* check condition */
  94 #define TDM_RETURN_IF_FAIL(cond) {\
  95     if (!(cond)) {\
  96         TDM_ERR ("'%s' failed", #cond);\
  97         return;\
  98     }\
  99 }
 100 #define TDM_RETURN_VAL_IF_FAIL(cond, val) {\
 101     if (!(cond)) {\
 102         TDM_ERR ("'%s' failed", #cond);\
 103         return val;\
 104     }\
 105 }
 106 #define TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(cond, error_v, val) {\
 107     if (!(cond)) {\
 108         TDM_ERR ("'%s' failed", #cond);\
 109         ret = error_v;\
 110         if (error) *error = ret;\
 111         return val;\
 112     }\
 113 }
 114
 115 #define TDM_WARNING_IF_FAIL(cond)  {\
 116     if (!(cond))\
 117         TDM_ERR ("'%s' failed", #cond);\
 118 }
 119 #define TDM_GOTO_IF_FAIL(cond, dst) {\
 120     if (!(cond)) {\
 121         TDM_ERR ("'%s' failed", #cond);\
 122         goto dst;\
 123     }\
 124 }
 125
 126 #ifdef HAVE_TTRACE
 127 #include <ttrace.h>
 128 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
 129 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
 130 #else
 131 #define TDM_TRACE_BEGIN(NAME)
 132 #define TDM_TRACE_END()
 133 #endif
 134
 135 #define TDM_NEVER_GET_HERE() TDM_ERR("** NEVER GET HERE **")
 136
 137 #define TDM_SNPRINTF(p, len, fmt, ARG...)  \
 138     do { \
 139         if (p && len && *len > 0) \
 140         { \
 141             int s = snprintf(p, *len, fmt, ##ARG); \
 142             p += s; \
 143             *len -= s; \
 144         } \
 145     } while (0)
 146
 147 #define C(b,m)              (((b) >> (m)) & 0xFF)
 148 #define B(c,s)              ((((unsigned int)(c)) & 0xff) << (s))
 149 #define FOURCC(a,b,c,d)     (B(d,24) | B(c,16) | B(b,8) | B(a,0))
 150 #define FOURCC_STR(id)      C(id,0), C(id,8), C(id,16), C(id,24)
 151 #define FOURCC_ID(str)      FOURCC(((char*)str)[0],((char*)str)[1],((char*)str)[2],((char*)str)[3])
 152
 153 typedef enum {
 154         TDM_CAPTURE_TARGET_OUTPUT,
 155         TDM_CAPTURE_TARGET_LAYER,
 156 } tdm_capture_target;
 157
 158 typedef struct _tdm_private_display tdm_private_display;
 159 typedef struct _tdm_private_output tdm_private_output;
 160 typedef struct _tdm_private_layer tdm_private_layer;
 161 typedef struct _tdm_private_pp tdm_private_pp;
 162 typedef struct _tdm_private_capture tdm_private_capture;
 163 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
 164 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
 165
 166 struct _tdm_private_display {
 167         pthread_mutex_t lock;
 168         unsigned int init_count;
 169
 170         /* backend module info */
 171         void *module;
 172         tdm_backend_module *module_data;
 173         tdm_backend_data *bdata;
 174
 175         /* backend function */
 176         tdm_display_capability capabilities;
 177         tdm_func_display func_display;
 178         tdm_func_output func_output;
 179         tdm_func_layer func_layer;
 180         tdm_func_pp func_pp;
 181         tdm_func_capture func_capture;
 182
 183         /* backend capability */
 184         tdm_caps_display caps_display;
 185         tdm_caps_pp caps_pp;
 186         tdm_caps_capture caps_capture;
 187
 188         /* output, pp list */
 189         struct list_head output_list;
 190         struct list_head pp_list;
 191
 192         void **outputs_ptr;
 193 };
 194
 195 struct _tdm_private_output {
 196         struct list_head link;
 197
 198         tdm_private_display *private_display;
 199
 200         tdm_caps_output caps;
 201         tdm_output *output_backend;
 202
 203         unsigned int pipe;
 204
 205         int regist_vblank_cb;
 206         int regist_commit_cb;
 207
 208         struct list_head layer_list;
 209         struct list_head capture_list;
 210         struct list_head vblank_handler_list;
 211         struct list_head commit_handler_list;
 212
 213         void **layers_ptr;
 214 };
 215
 216 struct _tdm_private_layer {
 217         struct list_head link;
 218
 219         tdm_private_display *private_display;
 220         tdm_private_output *private_output;
 221
 222         tdm_caps_layer caps;
 223         tdm_layer *layer_backend;
 224
 225         tbm_surface_h pending_buffer;
 226         tbm_surface_h waiting_buffer;
 227         tbm_surface_h showing_buffer;
 228         tbm_surface_queue_h buffer_queue;
 229
 230         struct list_head capture_list;
 231
 232         unsigned int usable;
 233 };
 234
 235 struct _tdm_private_pp {
 236         struct list_head link;
 237
 238         tdm_private_display *private_display;
 239
 240         tdm_pp *pp_backend;
 241
 242         struct list_head src_pending_buffer_list;
 243         struct list_head dst_pending_buffer_list;
 244         struct list_head src_buffer_list;
 245         struct list_head dst_buffer_list;
 246 };
 247
 248 struct _tdm_private_capture {
 249         struct list_head link;
 250
 251         tdm_capture_target target;
 252
 253         tdm_private_display *private_display;
 254         tdm_private_output *private_output;
 255         tdm_private_layer *private_layer;
 256
 257         tdm_capture *capture_backend;
 258
 259         struct list_head pending_buffer_list;
 260         struct list_head buffer_list;
 261 };
 262
 263 struct _tdm_private_vblank_handler {
 264         struct list_head link;
 265
 266         tdm_private_output *private_output;
 267         tdm_output_vblank_handler func;
 268         void *user_data;
 269 };
 270
 271 struct _tdm_private_commit_handler {
 272         struct list_head link;
 273
 274         tdm_private_output *private_output;
 275         tdm_output_commit_handler func;
 276         void *user_data;
 277 };
 278
 279 typedef struct _tdm_buffer_info {
 280         tbm_surface_h buffer;
 281
 282         /* ref_count for backend */
 283         int backend_ref_count;
 284
 285         struct list_head release_funcs;
 286         struct list_head destroy_funcs;
 287
 288         struct list_head *list;
 289         struct list_head link;
 290 } tdm_buffer_info;
 291
 292 tdm_private_pp *
 293 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
 294 void
 295 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
 296
 297 tdm_private_capture *
 298 tdm_capture_create_output_internal(tdm_private_output *private_output,
 299                                    tdm_error *error);
 300 tdm_private_capture *
 301 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
 302                                   tdm_error *error);
 303 void
 304 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
 305
 306 /* utility buffer functions for private */
 307 tdm_buffer_info*
 308 tdm_buffer_get_info(tbm_surface_h buffer);
 309 tbm_surface_h
 310 tdm_buffer_list_get_first_entry(struct list_head *list);
 311 void
 312 tdm_buffer_list_dump(struct list_head *list);
 313
 314 #define _pthread_mutex_lock(l) \
 315     do {if (tdm_debug_mutex) TDM_INFO("mutex lock"); pthread_mutex_lock(l);} while (0)
 316 #define _pthread_mutex_unlock(l) \
 317     do {if (tdm_debug_mutex) TDM_INFO("mutex unlock"); pthread_mutex_unlock(l);} while (0)
 318
 319 #ifdef __cplusplus
 320 }
 321 #endif
 322
 323 #endif /* _TDM_PRIVATE_H_ */