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 #undef EXTERN
  69 #undef DEPRECATED
  70 #undef INTERN
  71
  72 #if defined(__GNUC__) && __GNUC__ >= 4
  73 #define EXTERN __attribute__ ((visibility("default")))
  74 #else
  75 #define EXTERN
  76 #endif
  77
  78 #if defined(__GNUC__) && __GNUC__ >= 4
  79 #define INTERN __attribute__ ((visibility("hidden")))
  80 #else
  81 #define INTERN
  82 #endif
  83
  84 #if defined(__GNUC__) && __GNUC__ >= 4
  85 #define DEPRECATED __attribute__ ((deprecated))
  86 #else
  87 #define DEPRECATED
  88 #endif
  89
  90 /* check condition */
  91 #define TDM_RETURN_IF_FAIL(cond) {\
  92     if (!(cond)) {\
  93         TDM_ERR ("'%s' failed", #cond);\
  94         return;\
  95     }\
  96 }
  97 #define TDM_RETURN_VAL_IF_FAIL(cond, val) {\
  98     if (!(cond)) {\
  99         TDM_ERR ("'%s' failed", #cond);\
 100         return val;\
 101     }\
 102 }
 103 #define TDM_RETURN_VAL_IF_FAIL_WITH_ERROR(cond, error_v, val) {\
 104     if (!(cond)) {\
 105         TDM_ERR ("'%s' failed", #cond);\
 106         ret = error_v;\
 107         if (error) *error = ret;\
 108         return val;\
 109     }\
 110 }
 111
 112 #define TDM_WARNING_IF_FAIL(cond)  {\
 113     if (!(cond))\
 114         TDM_ERR ("'%s' failed", #cond);\
 115 }
 116 #define TDM_GOTO_IF_FAIL(cond, dst) {\
 117     if (!(cond)) {\
 118         TDM_ERR ("'%s' failed", #cond);\
 119         goto dst;\
 120     }\
 121 }
 122
 123 #ifdef HAVE_TTRACE
 124 #include <ttrace.h>
 125 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
 126 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
 127 #else
 128 #define TDM_TRACE_BEGIN(NAME)
 129 #define TDM_TRACE_END()
 130 #endif
 131
 132 #define TDM_NEVER_GET_HERE() TDM_ERR("** NEVER GET HERE **")
 133
 134 #define TDM_SNPRINTF(p, len, fmt, ARG...)  \
 135     do { \
 136         if (p && len && *len > 0) \
 137         { \
 138             int s = snprintf(p, *len, fmt, ##ARG); \
 139             p += s; \
 140             *len -= s; \
 141         } \
 142     } while (0)
 143
 144 #define C(b,m)              (((b) >> (m)) & 0xFF)
 145 #define B(c,s)              ((((unsigned int)(c)) & 0xff) << (s))
 146 #define FOURCC(a,b,c,d)     (B(d,24) | B(c,16) | B(b,8) | B(a,0))
 147 #define FOURCC_STR(id)      C(id,0), C(id,8), C(id,16), C(id,24)
 148 #define FOURCC_ID(str)      FOURCC(((char*)str)[0],((char*)str)[1],((char*)str)[2],((char*)str)[3])
 149
 150 typedef enum {
 151         TDM_CAPTURE_TARGET_OUTPUT,
 152         TDM_CAPTURE_TARGET_LAYER,
 153 } tdm_capture_target;
 154
 155 typedef struct _tdm_private_display tdm_private_display;
 156 typedef struct _tdm_private_output tdm_private_output;
 157 typedef struct _tdm_private_layer tdm_private_layer;
 158 typedef struct _tdm_private_pp tdm_private_pp;
 159 typedef struct _tdm_private_capture tdm_private_capture;
 160 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
 161 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
 162
 163 struct _tdm_private_display {
 164         pthread_mutex_t lock;
 165         unsigned int init_count;
 166
 167         /* backend module info */
 168         void *module;
 169         tdm_backend_module *module_data;
 170         tdm_backend_data *bdata;
 171
 172         /* backend function */
 173         tdm_display_capability capabilities;
 174         tdm_func_display func_display;
 175         tdm_func_output func_output;
 176         tdm_func_layer func_layer;
 177         tdm_func_pp func_pp;
 178         tdm_func_capture func_capture;
 179
 180         /* backend capability */
 181         tdm_caps_display caps_display;
 182         tdm_caps_pp caps_pp;
 183         tdm_caps_capture caps_capture;
 184
 185         /* output, pp list */
 186         struct list_head output_list;
 187         struct list_head pp_list;
 188
 189         void **outputs_ptr;
 190 };
 191
 192 struct _tdm_private_output {
 193         struct list_head link;
 194
 195         tdm_private_display *private_display;
 196
 197         tdm_caps_output caps;
 198         tdm_output *output_backend;
 199
 200         unsigned int pipe;
 201
 202         int regist_vblank_cb;
 203         int regist_commit_cb;
 204
 205         struct list_head layer_list;
 206         struct list_head capture_list;
 207         struct list_head vblank_handler_list;
 208         struct list_head commit_handler_list;
 209
 210         void **layers_ptr;
 211 };
 212
 213 struct _tdm_private_layer {
 214         struct list_head link;
 215
 216         tdm_private_display *private_display;
 217         tdm_private_output *private_output;
 218
 219         tdm_caps_layer caps;
 220         tdm_layer *layer_backend;
 221
 222         tbm_surface_h pending_buffer;
 223         tbm_surface_h waiting_buffer;
 224         tbm_surface_h showing_buffer;
 225         tbm_surface_queue_h buffer_queue;
 226
 227         struct list_head capture_list;
 228
 229         unsigned int usable;
 230 };
 231
 232 struct _tdm_private_pp {
 233         struct list_head link;
 234
 235         tdm_private_display *private_display;
 236
 237         tdm_pp *pp_backend;
 238
 239         struct list_head src_pending_buffer_list;
 240         struct list_head dst_pending_buffer_list;
 241         struct list_head src_buffer_list;
 242         struct list_head dst_buffer_list;
 243 };
 244
 245 struct _tdm_private_capture {
 246         struct list_head link;
 247
 248         tdm_capture_target target;
 249
 250         tdm_private_display *private_display;
 251         tdm_private_output *private_output;
 252         tdm_private_layer *private_layer;
 253
 254         tdm_capture *capture_backend;
 255
 256         struct list_head pending_buffer_list;
 257         struct list_head buffer_list;
 258 };
 259
 260 struct _tdm_private_vblank_handler {
 261         struct list_head link;
 262
 263         tdm_private_output *private_output;
 264         tdm_output_vblank_handler func;
 265         void *user_data;
 266 };
 267
 268 struct _tdm_private_commit_handler {
 269         struct list_head link;
 270
 271         tdm_private_output *private_output;
 272         tdm_output_commit_handler func;
 273         void *user_data;
 274 };
 275
 276 typedef struct _tdm_buffer_info {
 277         tbm_surface_h buffer;
 278
 279         /* ref_count for backend */
 280         int backend_ref_count;
 281
 282         struct list_head release_funcs;
 283         struct list_head destroy_funcs;
 284
 285         struct list_head *list;
 286         struct list_head link;
 287 } tdm_buffer_info;
 288
 289 tdm_private_pp *
 290 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
 291 void
 292 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
 293
 294 tdm_private_capture *
 295 tdm_capture_create_output_internal(tdm_private_output *private_output,
 296                                    tdm_error *error);
 297 tdm_private_capture *
 298 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
 299                                   tdm_error *error);
 300 void
 301 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
 302
 303 /* utility buffer functions for private */
 304 tdm_buffer_info*
 305 tdm_buffer_get_info(tbm_surface_h buffer);
 306 tbm_surface_h
 307 tdm_buffer_list_get_first_entry(struct list_head *list);
 308 void
 309 tdm_buffer_list_dump(struct list_head *list);
 310
 311 #ifdef __cplusplus
 312 }
 313 #endif
 314
 315 #endif /* _TDM_PRIVATE_H_ */