1 /**************************************************************************
5 Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
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>
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:
22 The above copyright notice and this permission notice (including the
23 next paragraph) shall be included in all copies or substantial portions
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.
34 **************************************************************************/
36 #ifndef _TDM_PRIVATE_H_
37 #define _TDM_PRIVATE_H_
46 #include <sys/types.h>
52 #include <sys/syscall.h>
53 #include <sys/types.h>
55 #include <tbm_bufmgr.h>
56 #include <tbm_surface_queue.h>
58 #include "tdm_backend.h"
61 #include "tdm_macro.h"
71 * @brief The private header file for a frontend library
74 extern int tdm_debug_buffer;
75 extern int tdm_debug_mutex;
76 extern int tdm_debug_thread;
80 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
81 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
83 #define TDM_TRACE_BEGIN(NAME)
84 #define TDM_TRACE_END()
87 #define prototype_name_fn(res) const char * res##_str(int type)
89 prototype_name_fn(dpms);
90 prototype_name_fn(status);
93 TDM_CAPTURE_TARGET_OUTPUT,
94 TDM_CAPTURE_TARGET_LAYER,
97 typedef struct _tdm_private_display tdm_private_display;
98 typedef struct _tdm_private_output tdm_private_output;
99 typedef struct _tdm_private_layer tdm_private_layer;
100 typedef struct _tdm_private_pp tdm_private_pp;
101 typedef struct _tdm_private_capture tdm_private_capture;
102 typedef struct _tdm_private_loop tdm_private_loop;
103 typedef struct _tdm_private_server tdm_private_server;
104 typedef struct _tdm_private_thread tdm_private_thread;
105 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
106 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
107 typedef struct _tdm_private_change_handler tdm_private_change_handler;
109 struct _tdm_private_display {
110 pthread_mutex_t lock;
111 unsigned int init_count;
113 /* backend module info */
115 tdm_backend_module *module_data;
116 tdm_backend_data *bdata;
122 /* backend function */
123 tdm_display_capability capabilities;
124 tdm_func_display func_display;
125 tdm_func_output func_output;
126 tdm_func_layer func_layer;
128 tdm_func_capture func_capture;
130 /* backend capability */
131 tdm_caps_display caps_display;
133 tdm_caps_capture caps_capture;
135 /* output, pp list */
136 struct list_head output_list;
137 struct list_head pp_list;
138 struct list_head capture_list;
142 /* for event handling */
143 tdm_private_loop *private_loop;
146 struct _tdm_private_output {
147 struct list_head link;
151 tdm_private_display *private_display;
153 tdm_caps_output caps;
154 tdm_output *output_backend;
157 tdm_output_dpms current_dpms_value;
159 int regist_vblank_cb;
160 int regist_commit_cb;
161 int regist_change_cb;
163 struct list_head layer_list;
164 struct list_head capture_list;
165 struct list_head vblank_handler_list;
166 struct list_head commit_handler_list;
168 /* seperate list for multi-thread*/
169 struct list_head change_handler_list_main;
170 struct list_head change_handler_list_sub;
175 struct _tdm_private_layer {
176 struct list_head link;
178 tdm_private_display *private_display;
179 tdm_private_output *private_output;
182 tdm_layer *layer_backend;
184 tbm_surface_h pending_buffer;
185 tbm_surface_h waiting_buffer;
186 tbm_surface_h showing_buffer;
187 tbm_surface_queue_h buffer_queue;
189 struct list_head capture_list;
194 struct _tdm_private_pp {
195 struct list_head link;
199 tdm_private_display *private_display;
203 struct list_head src_pending_buffer_list;
204 struct list_head dst_pending_buffer_list;
205 struct list_head src_buffer_list;
206 struct list_head dst_buffer_list;
211 struct _tdm_private_capture {
212 struct list_head link;
213 struct list_head display_link;
217 tdm_capture_target target;
219 tdm_private_display *private_display;
220 tdm_private_output *private_output;
221 tdm_private_layer *private_layer;
223 tdm_capture *capture_backend;
225 struct list_head pending_buffer_list;
226 struct list_head buffer_list;
232 * Note that we don't need to (un)lock mutex to use this structure. If there is
233 * no TDM thread, all TDM resources are protected by private_display's mutex.
234 * If there is a TDM thread, this struct will be used only in a TDM thread.
235 * So, we don't need to protect this structure by mutex. Not thread-safe.
237 struct _tdm_private_loop {
238 /* TDM uses wl_event_loop to handle various event sources including the TDM
241 struct wl_display *wl_display;
242 struct wl_event_loop *wl_loop;
245 tdm_event_loop_source *backend_source;
247 /* In event loop, all resources are accessed by this dpy.
249 * - DO NOT include other private structure in this structure because this
250 * struct is not protected by mutex.
254 /* for handling TDM client requests */
255 tdm_private_server *private_server;
257 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
258 * private_thread is NULL.
260 tdm_private_thread *private_thread;
263 struct _tdm_private_vblank_handler {
264 struct list_head link;
266 tdm_private_output *private_output;
267 tdm_output_vblank_handler func;
273 struct _tdm_private_commit_handler {
274 struct list_head link;
276 tdm_private_output *private_output;
277 tdm_output_commit_handler func;
283 struct _tdm_private_change_handler {
284 struct list_head link;
286 tdm_private_output *private_output;
287 tdm_output_change_handler func;
293 typedef struct _tdm_buffer_info {
294 tbm_surface_h buffer;
296 /* ref_count for backend */
297 int backend_ref_count;
299 struct list_head release_funcs;
300 struct list_head destroy_funcs;
302 struct list_head *list;
303 struct list_head link;
307 tdm_get_dpms_str(tdm_output_dpms dpms_value);
310 tdm_display_find_output_stamp(tdm_private_display *private_display,
311 unsigned long stamp);
313 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
314 tdm_private_capture *
315 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
318 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
319 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
321 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
322 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
324 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
327 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
330 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
334 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
335 struct list_head *change_handler_list,
336 tdm_output_change_type type,
340 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
342 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
344 tdm_private_capture *
345 tdm_capture_create_output_internal(tdm_private_output *private_output,
347 tdm_private_capture *
348 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
351 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
353 /* utility buffer functions for private */
355 tdm_buffer_get_info(tbm_surface_h buffer);
357 tdm_buffer_list_get_first_entry(struct list_head *list);
359 tdm_buffer_list_dump(struct list_head *list);
361 /* event functions for private */
363 tdm_event_loop_init(tdm_private_display *private_display);
365 tdm_event_loop_deinit(tdm_private_display *private_display);
367 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
369 tdm_event_loop_get_fd(tdm_private_display *private_display);
371 tdm_event_loop_dispatch(tdm_private_display *private_display);
373 tdm_event_loop_flush(tdm_private_display *private_display);
377 TDM_THREAD_CB_OUTPUT_COMMIT,
378 TDM_THREAD_CB_OUTPUT_VBLANK,
379 TDM_THREAD_CB_OUTPUT_STATUS,
380 TDM_THREAD_CB_PP_DONE,
381 TDM_THREAD_CB_CAPTURE_DONE,
382 } tdm_thread_cb_type;
384 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
385 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
386 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
387 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
388 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
389 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
391 struct _tdm_thread_cb_base {
392 tdm_thread_cb_type type;
396 struct _tdm_thread_cb_output_vblank {
397 tdm_thread_cb_base base;
398 unsigned long output_stamp;
399 unsigned int sequence;
401 unsigned int tv_usec;
405 struct _tdm_thread_cb_output_status {
406 tdm_thread_cb_base base;
407 unsigned long output_stamp;
408 tdm_output_conn_status status;
412 struct _tdm_thread_cb_pp_done {
413 tdm_thread_cb_base base;
414 unsigned long pp_stamp;
420 struct _tdm_thread_cb_capture_done {
421 tdm_thread_cb_base base;
422 unsigned long capture_stamp;
423 tbm_surface_h buffer;
428 tdm_thread_init(tdm_private_loop *private_loop);
430 tdm_thread_deinit(tdm_private_loop *private_loop);
432 tdm_thread_get_fd(tdm_private_loop *private_loop);
434 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
436 tdm_thread_handle_cb(tdm_private_loop *private_loop);
438 tdm_thread_in_display_thread(pid_t tid);
440 tdm_thread_is_running(void);
443 tdm_server_init(tdm_private_loop *private_loop);
445 tdm_server_deinit(tdm_private_loop *private_loop);
448 tdm_helper_get_time_in_millis(void);
450 tdm_helper_get_time_in_micros(void);
452 extern pthread_mutex_t tdm_mutex_check_lock;
453 extern int tdm_mutex_locked;
454 extern int tdm_dump_enable;
457 tdm_helper_get_dump_count(void);
459 tdm_helper_get_dump_path(void);
461 #define _pthread_mutex_unlock(l) \
463 if (tdm_debug_mutex) \
464 TDM_INFO("mutex unlock"); \
465 pthread_mutex_lock(&tdm_mutex_check_lock); \
466 tdm_mutex_locked = 0; \
467 pthread_mutex_unlock(&tdm_mutex_check_lock); \
468 pthread_mutex_unlock(l); \
470 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
471 #define MUTEX_TIMEOUT_SEC 5
472 #define _pthread_mutex_lock(l) \
474 if (tdm_debug_mutex) \
475 TDM_INFO("mutex lock"); \
476 struct timespec rtime; \
477 clock_gettime(CLOCK_REALTIME, &rtime); \
478 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
479 if (pthread_mutex_timedlock(l, &rtime)) { \
480 TDM_ERR("Mutex lock failed PID %d", getpid()); \
481 _pthread_mutex_unlock(l); \
484 pthread_mutex_lock(&tdm_mutex_check_lock); \
485 tdm_mutex_locked = 1; \
486 pthread_mutex_unlock(&tdm_mutex_check_lock); \
489 #else //TDM_CONFIG_MUTEX_TIMEOUT
490 #define _pthread_mutex_lock(l) \
492 if (tdm_debug_mutex) \
493 TDM_INFO("mutex lock"); \
494 pthread_mutex_lock(l); \
495 pthread_mutex_lock(&tdm_mutex_check_lock); \
496 tdm_mutex_locked = 1; \
497 pthread_mutex_unlock(&tdm_mutex_check_lock); \
499 #endif //TDM_CONFIG_MUTEX_TIMEOUT
500 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
501 static inline int TDM_MUTEX_IS_LOCKED(void)
504 pthread_mutex_lock(&tdm_mutex_check_lock);
505 ret = (tdm_mutex_locked == 1);
506 pthread_mutex_unlock(&tdm_mutex_check_lock);
514 #endif /* _TDM_PRIVATE_H_ */