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_
47 #include <sys/types.h>
53 #include <sys/syscall.h>
54 #include <sys/types.h>
57 #include <tbm_bufmgr.h>
58 #include <tbm_surface_queue.h>
60 #include "tdm_backend.h"
63 #include "tdm_macro.h"
73 * @brief The private header file for a frontend library
78 TDM_DEBUG_BUFFER = (1 << 0),
79 TDM_DEBUG_MUTEX = (1 << 1),
80 TDM_DEBUG_THREAD = (1 << 2),
81 TDM_DEBUG_SERVER = (1 << 3),
82 TDM_DEBUG_VBLANK = (1 << 4),
83 TDM_DEBUG_COMMIT = (1 << 5),
86 extern int tdm_debug_module;
87 extern int tdm_debug_dump;
91 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
92 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
93 #define TDM_TRACE_COUNT(NAME, COUNT) traceCounter(TTRACE_TAG_GRAPHICS, COUNT, "TDM:"#NAME)
94 #define TDM_TRACE_MARK(NAME) traceMark(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
96 #define TDM_TRACE_BEGIN(NAME)
97 #define TDM_TRACE_END()
98 #define TDM_TRACE_COUNT(NAME, COUNT)
99 #define TDM_TRACE_MARK(NAME)
103 TDM_CAPTURE_TARGET_OUTPUT,
104 TDM_CAPTURE_TARGET_LAYER,
105 } tdm_capture_target;
108 TDM_DUMP_FLAG_LAYER = (1 << 0),
109 TDM_DUMP_FLAG_PP = (1 << 1),
110 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
113 #define TDM_DUMP_DIR "/tmp"
116 TDM_COMMIT_TYPE_NONE,
117 TDM_COMMIT_TYPE_OUTPUT,
118 TDM_COMMIT_TYPE_LAYER,
121 typedef struct _tdm_private_display tdm_private_display;
122 typedef struct _tdm_private_output tdm_private_output;
123 typedef struct _tdm_private_layer tdm_private_layer;
124 typedef struct _tdm_private_pp tdm_private_pp;
125 typedef struct _tdm_private_capture tdm_private_capture;
126 typedef struct _tdm_private_loop tdm_private_loop;
127 typedef struct _tdm_private_server tdm_private_server;
128 typedef struct _tdm_private_thread tdm_private_thread;
129 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
130 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
131 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
132 typedef struct _tdm_private_change_handler tdm_private_change_handler;
133 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
135 struct _tdm_private_display {
136 pthread_mutex_t lock;
137 unsigned int init_count;
139 /* backend module info */
141 tdm_backend_module *module_data;
142 tdm_backend_data *bdata;
148 /* backend function */
149 tdm_display_capability capabilities;
150 tdm_func_display func_display;
151 tdm_func_output func_output;
152 tdm_func_layer func_layer;
154 tdm_func_capture func_capture;
156 /* backend capability */
157 tdm_caps_display caps_display;
159 tdm_caps_capture caps_capture;
161 /* output, pp list */
162 struct list_head output_list;
163 struct list_head pp_list;
164 struct list_head capture_list;
168 /* for event handling */
169 tdm_private_loop *private_loop;
172 tdm_output **outputs;
174 /* calling a output commit per a vblank */
175 int commit_per_vblank;
176 tdm_commit_type commit_type;
181 struct _tdm_private_output {
182 struct list_head link;
187 tdm_private_display *private_display;
189 tdm_caps_output caps;
190 tdm_output *output_backend;
193 tdm_output_dpms current_dpms_value;
194 const tdm_output_mode *current_mode;
196 int regist_vblank_cb;
197 int regist_commit_cb;
198 int regist_change_cb;
201 struct list_head layer_list;
202 struct list_head capture_list;
203 struct list_head vblank_handler_list;
204 struct list_head output_commit_handler_list;
206 /* for layer commit */
207 struct list_head layer_commit_handler_list;
208 struct list_head pending_commit_handler_list;
210 int layer_waiting_vblank;
212 /* seperate list for multi-thread*/
213 struct list_head change_handler_list_main;
214 struct list_head change_handler_list_sub;
218 /* TODO: temp solution for handling DPMS things in sub-htread */
219 tdm_event_loop_source *dpms_changed_timer;
222 struct _tdm_private_layer {
223 struct list_head link;
227 tdm_private_display *private_display;
228 tdm_private_output *private_output;
231 tdm_layer *layer_backend;
233 tdm_private_layer_buffer *pending_buffer;
234 tdm_private_layer_buffer *waiting_buffer;
235 tdm_private_layer_buffer *showing_buffer;
236 tbm_surface_queue_h buffer_queue;
238 struct list_head capture_list;
241 unsigned int committing;
244 unsigned int fps_count;
247 struct _tdm_private_pp {
248 struct list_head link;
252 tdm_private_display *private_display;
256 struct list_head pending_buffer_list;
257 struct list_head buffer_list;
262 tdm_pp_done_handler done_func;
263 void *done_user_data;
266 struct _tdm_private_capture {
267 struct list_head link;
268 struct list_head display_link;
272 tdm_capture_target target;
274 tdm_private_display *private_display;
275 tdm_private_output *private_output;
276 tdm_private_layer *private_layer;
278 tdm_capture *capture_backend;
280 struct list_head pending_buffer_list;
281 struct list_head buffer_list;
283 tdm_info_capture info;
286 tdm_capture_done_handler done_func;
287 void *done_user_data;
291 * Note that we don't need to (un)lock mutex to use this structure. If there is
292 * no TDM thread, all TDM resources are protected by private_display's mutex.
293 * If there is a TDM thread, this struct will be used only in a TDM thread.
294 * So, we don't need to protect this structure by mutex. Not thread-safe.
296 struct _tdm_private_loop {
297 /* TDM uses wl_event_loop to handle various event sources including the TDM
300 struct wl_display *wl_display;
301 struct wl_event_loop *wl_loop;
304 tdm_event_loop_source *backend_source;
306 /* In event loop, all resources are accessed by this dpy.
308 * - DO NOT include other private structure in this structure because this
309 * struct is not protected by mutex.
313 /* for handling TDM client requests */
314 tdm_private_server *private_server;
316 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
317 * private_thread is NULL.
319 tdm_private_thread *private_thread;
322 struct _tdm_private_vblank_handler {
323 struct list_head link;
325 tdm_private_output *private_output;
328 tdm_output_vblank_handler func;
334 struct _tdm_private_output_commit_handler {
335 struct list_head link;
337 tdm_private_output *private_output;
338 tdm_output_commit_handler func;
344 struct _tdm_private_layer_commit_handler {
345 struct list_head link;
347 tdm_private_layer *private_layer;
348 tdm_layer_commit_handler func;
352 struct _tdm_private_change_handler {
353 struct list_head link;
355 tdm_private_output *private_output;
356 tdm_output_change_handler func;
362 struct _tdm_private_layer_buffer {
363 tbm_surface_h buffer;
364 struct list_head link;
367 typedef struct _tdm_buffer_info {
368 tbm_surface_h buffer;
370 /* ref_count for backend */
371 int backend_ref_count;
373 struct list_head release_funcs;
374 struct list_head destroy_funcs;
376 struct list_head *list;
377 struct list_head link;
380 typedef struct _tdm_pp_private_buffer {
383 struct list_head link;
384 struct list_head commit_link;
385 } tdm_pp_private_buffer;
387 typedef struct _tdm_capture_private_buffer {
388 tbm_surface_h buffer;
389 struct list_head link;
390 struct list_head commit_link;
391 } tdm_capture_private_buffer;
394 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
397 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
399 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
400 tdm_private_capture *
401 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
404 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
405 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
407 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
408 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
410 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
413 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
416 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
417 tdm_output_vblank_handler func, void *user_data);
420 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
423 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
426 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
428 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
431 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
432 struct list_head *change_handler_list,
433 tdm_output_change_type type,
435 int no_check_thread_id);
438 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
440 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
442 tdm_private_capture *
443 tdm_capture_create_output_internal(tdm_private_output *private_output,
445 tdm_private_capture *
446 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
449 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
451 /* utility buffer functions for private */
453 tdm_buffer_get_info(tbm_surface_h buffer);
455 tdm_buffer_list_get_first_entry(struct list_head *list);
457 tdm_buffer_list_dump(struct list_head *list);
460 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
462 /* event functions for private */
464 tdm_event_loop_init(tdm_private_display *private_display);
466 tdm_event_loop_deinit(tdm_private_display *private_display);
468 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
470 tdm_event_loop_get_fd(tdm_private_display *private_display);
472 tdm_event_loop_dispatch(tdm_private_display *private_display);
474 tdm_event_loop_flush(tdm_private_display *private_display);
478 TDM_THREAD_CB_OUTPUT_COMMIT,
479 TDM_THREAD_CB_OUTPUT_VBLANK,
480 TDM_THREAD_CB_OUTPUT_STATUS,
481 TDM_THREAD_CB_OUTPUT_DPMS,
482 TDM_THREAD_CB_PP_DONE,
483 TDM_THREAD_CB_CAPTURE_DONE,
484 TDM_THREAD_CB_VBLANK_SW,
485 } tdm_thread_cb_type;
487 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
488 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
489 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
490 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
491 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
492 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
493 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
494 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
496 struct _tdm_thread_cb_base {
497 tdm_thread_cb_type type;
501 struct _tdm_thread_cb_output_vblank {
502 tdm_thread_cb_base base;
504 unsigned int sequence;
506 unsigned int tv_usec;
510 struct _tdm_thread_cb_output_status {
511 tdm_thread_cb_base base;
513 tdm_output_conn_status status;
517 struct _tdm_thread_cb_output_dpms {
518 tdm_thread_cb_base base;
520 tdm_output_dpms dpms;
524 struct _tdm_thread_cb_pp_done {
525 tdm_thread_cb_base base;
532 struct _tdm_thread_cb_capture_done {
533 tdm_thread_cb_base base;
534 double capture_stamp;
535 tbm_surface_h buffer;
539 struct _tdm_thread_cb_vblank_sw {
540 tdm_thread_cb_base base;
545 tdm_thread_init(tdm_private_loop *private_loop);
547 tdm_thread_deinit(tdm_private_loop *private_loop);
549 tdm_thread_get_fd(tdm_private_loop *private_loop);
551 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
553 tdm_thread_handle_cb(tdm_private_loop *private_loop);
555 tdm_thread_in_display_thread(pid_t tid);
557 tdm_thread_is_running(void);
560 tdm_server_init(tdm_private_loop *private_loop);
562 tdm_server_deinit(tdm_private_loop *private_loop);
564 tdm_server_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
566 tdm_server_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
569 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
571 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
573 tdm_helper_get_time(void);
575 extern pthread_mutex_t tdm_mutex_check_lock;
576 extern int tdm_mutex_locked;
577 extern const char *tdm_mutex_lock_func;
578 extern int tdm_mutex_lock_line;
579 extern int tdm_dump_enable;
580 extern char *tdm_debug_dump_dir;
582 #define _pthread_mutex_unlock(l) \
584 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
585 TDM_INFO("mutex unlock"); \
586 pthread_mutex_lock(&tdm_mutex_check_lock); \
587 tdm_mutex_locked = 0; \
588 tdm_mutex_lock_func = NULL; \
589 tdm_mutex_lock_line = 0; \
590 pthread_mutex_unlock(&tdm_mutex_check_lock); \
591 pthread_mutex_unlock(l); \
593 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
594 #define MUTEX_TIMEOUT_SEC 5
595 #define _pthread_mutex_lock(l) \
597 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
598 TDM_INFO("mutex lock"); \
599 struct timespec rtime; \
600 clock_gettime(CLOCK_REALTIME, &rtime); \
601 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
602 if (pthread_mutex_timedlock(l, &rtime)) { \
603 TDM_ERR("Mutex lock failed PID %d", getpid()); \
604 _pthread_mutex_unlock(l); \
607 pthread_mutex_lock(&tdm_mutex_check_lock); \
608 tdm_mutex_locked = 1; \
609 tdm_mutex_lock_func = __FUNCTION__; \
610 tdm_mutex_lock_line = __LINE__; \
611 pthread_mutex_unlock(&tdm_mutex_check_lock); \
614 #else //TDM_CONFIG_MUTEX_TIMEOUT
615 #define _pthread_mutex_lock(l) \
617 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
618 TDM_INFO("mutex lock"); \
619 pthread_mutex_lock(l); \
620 pthread_mutex_lock(&tdm_mutex_check_lock); \
621 tdm_mutex_locked = 1; \
622 tdm_mutex_lock_func = __FUNCTION__; \
623 tdm_mutex_lock_line = __LINE__; \
624 pthread_mutex_unlock(&tdm_mutex_check_lock); \
626 #endif //TDM_CONFIG_MUTEX_TIMEOUT
627 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
628 static inline int TDM_MUTEX_IS_LOCKED(void)
631 /* if thread is not running, we don't need to consider mutex things. */
632 if (!tdm_thread_is_running())
634 pthread_mutex_lock(&tdm_mutex_check_lock);
635 ret = (tdm_mutex_locked == 1);
636 pthread_mutex_unlock(&tdm_mutex_check_lock);
640 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
641 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
644 tdm_display_update_output(tdm_private_display *private_display,
645 tdm_output *output_backend, int pipe);
647 tdm_display_enable_debug_module(const char*modules);
649 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
651 tdm_display_enable_path(const char *path);
653 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
655 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
657 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
660 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
666 #endif /* _TDM_PRIVATE_H_ */