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>
55 #include <sys/eventfd.h>
59 #include <wayland-server-protocol.h>
60 #include <tbm_bufmgr.h>
61 #include <tbm_surface_queue.h>
63 #include "tdm_backend.h"
66 #include "tdm_macro.h"
76 * @brief The private header file for a frontend library
81 TDM_DEBUG_BUFFER = (1 << 0),
82 TDM_DEBUG_MUTEX = (1 << 1),
83 TDM_DEBUG_THREAD = (1 << 2),
84 TDM_DEBUG_SERVER = (1 << 3),
85 TDM_DEBUG_VBLANK = (1 << 4),
86 TDM_DEBUG_COMMIT = (1 << 5),
91 TDM_TTRACE_VBLANK = (1 << 0),
92 TDM_TTRACE_CLIENT = (1 << 1),
93 TDM_TTRACE_LAYER = (1 << 2),
94 TDM_TTRACE_PP = (1 << 3),
95 TDM_TTRACE_CAPTURE = (1 << 4),
98 extern int tdm_debug_module;
99 extern int tdm_debug_dump;
100 extern int tdm_ttrace_module;
101 extern int tdm_ttrace_output;
105 #define TDM_TRACE_BEGIN(fmt, ...) traceBegin(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
106 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
107 #define TDM_TRACE_ASYNC_BEGIN(key, name,...) traceAsyncBegin(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
108 #define TDM_TRACE_ASYNC_END(key, name,...) traceAsyncEnd(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
109 #define TDM_TRACE_COUNT(count, fmt, ...) traceCounter(TTRACE_TAG_GRAPHICS, count, fmt, ##__VA_ARGS__)
110 #define TDM_TRACE_MARK(fmt, ...) traceMark(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
112 #define TDM_TRACE_BEGIN(fmt, ...)
113 #define TDM_TRACE_END()
114 #define TDM_TRACE_ASYNC_BEGIN(key, name,...)
115 #define TDM_TRACE_ASYNC_END(key, name,...)
116 #define TDM_TRACE_COUNT(count, fmt, ...)
117 #define TDM_TRACE_MARK(fmt, ...)
121 TDM_CAPTURE_TARGET_OUTPUT,
122 TDM_CAPTURE_TARGET_LAYER,
123 } tdm_capture_target;
126 TDM_DUMP_FLAG_LAYER = (1 << 0),
127 TDM_DUMP_FLAG_PP = (1 << 1),
128 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
129 TDM_DUMP_FLAG_WINDOW = (1 << 3),
132 #define TDM_DUMP_DIR "/tmp"
135 TDM_COMMIT_TYPE_NONE,
136 TDM_COMMIT_TYPE_OUTPUT,
137 TDM_COMMIT_TYPE_LAYER,
140 typedef struct _tdm_private_display tdm_private_display;
141 typedef struct _tdm_private_output tdm_private_output;
142 typedef struct _tdm_private_layer tdm_private_layer;
143 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
144 typedef struct _tdm_private_pp tdm_private_pp;
145 typedef struct _tdm_private_capture tdm_private_capture;
146 typedef struct _tdm_private_loop tdm_private_loop;
147 typedef struct _tdm_private_server tdm_private_server;
148 typedef struct _tdm_private_thread tdm_private_thread;
149 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
150 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
151 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
152 typedef struct _tdm_private_change_handler tdm_private_change_handler;
153 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
155 struct _tdm_private_display {
156 pthread_mutex_t lock;
157 unsigned int init_count;
159 /* backend module info */
161 tdm_backend_module *module_data;
162 tdm_backend_data *bdata;
168 /* backend function */
169 tdm_display_capability capabilities;
170 tdm_func_display func_display;
171 tdm_func_output func_output;
172 tdm_func_layer func_layer;
173 tdm_func_hwc_window func_hwc_window;
175 tdm_func_capture func_capture;
177 /* backend capability */
178 tdm_caps_display caps_display;
180 tdm_caps_capture caps_capture;
182 /* output, pp list */
183 struct list_head output_list;
184 struct list_head pp_list;
185 struct list_head capture_list;
189 /* for event handling */
190 tdm_private_loop *private_loop;
193 tdm_output **outputs;
198 struct _tdm_private_output {
199 struct list_head link;
204 tdm_private_display *private_display;
206 tdm_caps_output caps;
207 tdm_output *output_backend;
210 tdm_output_dpms current_dpms_value;
211 unsigned int waiting_dpms_change;
212 const tdm_output_mode *current_mode;
214 int regist_vblank_cb;
215 int regist_commit_cb;
216 int regist_change_cb;
219 struct list_head layer_list;
220 struct list_head hwc_window_list;
221 struct list_head capture_list;
222 struct list_head vblank_handler_list;
223 struct list_head output_commit_handler_list;
225 /* for layer commit */
226 struct list_head layer_commit_handler_list;
227 struct list_head pending_commit_handler_list;
229 int layer_waiting_vblank;
231 /* seperate list for multi-thread*/
232 struct list_head change_handler_list_main;
233 struct list_head change_handler_list_sub;
237 /* TODO: temp solution for handling DPMS things in sub-htread */
238 tdm_event_loop_source *dpms_changed_timer;
241 /* look at the tdm_output_set_need_revalidate_handler() declaration for the details */
242 tdm_output_need_validate_handler hndl;
246 /* calling a output commit per a vblank */
247 int commit_per_vblank;
248 tdm_commit_type commit_type;
250 /* for ttrace vblank */
251 tdm_vblank *ttrace_vblank;
254 struct _tdm_private_layer {
255 struct list_head link;
259 tdm_private_display *private_display;
260 tdm_private_output *private_output;
263 tdm_layer *layer_backend;
265 /* pending data until committed */
266 unsigned int pending_info_changed;
267 tdm_info_layer pending_info;
268 unsigned int pending_buffer_changed;
269 tbm_surface_h pending_buffer;
271 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
272 * And when a layer is committed, it will be moved to committed_buffer.
273 * Finally when a commit handler is called, it will be moved to showing_buffer.
275 tdm_private_layer_buffer *waiting_buffer;
276 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
277 tdm_private_layer_buffer *showing_buffer;
278 tbm_surface_queue_h buffer_queue;
280 struct list_head capture_list;
283 unsigned int committing;
286 unsigned int fps_count;
289 struct _tdm_private_hwc_window {
290 struct list_head link;
295 tdm_private_display *private_display;
296 tdm_private_output *private_output;
298 tdm_hwc_window *hwc_window_backend;
302 struct _tdm_private_pp {
303 struct list_head link;
307 tdm_private_display *private_display;
311 struct list_head pending_buffer_list;
312 struct list_head buffer_list;
317 tdm_pp_done_handler done_func;
318 void *done_user_data;
321 struct _tdm_private_capture {
322 struct list_head link;
323 struct list_head display_link;
327 tdm_capture_target target;
329 tdm_private_display *private_display;
330 tdm_private_output *private_output;
331 tdm_private_layer *private_layer;
333 tdm_capture *capture_backend;
335 struct list_head pending_buffer_list;
336 struct list_head buffer_list;
338 tdm_info_capture info;
341 tdm_capture_done_handler done_func;
342 void *done_user_data;
346 * Note that we don't need to (un)lock mutex to use this structure. If there is
347 * no TDM thread, all TDM resources are protected by private_display's mutex.
348 * If there is a TDM thread, this struct will be used only in a TDM thread.
349 * So, we don't need to protect this structure by mutex. Not thread-safe.
351 struct _tdm_private_loop {
352 /* TDM uses wl_event_loop to handle various event sources including the TDM
355 struct wl_display *wl_display;
356 struct wl_event_loop *wl_loop;
359 tdm_event_loop_source *backend_source;
361 /* In event loop, all resources are accessed by this dpy.
363 * - DO NOT include other private structure in this structure because this
364 * struct is not protected by mutex.
368 /* for handling TDM client requests */
369 tdm_private_server *private_server;
371 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
372 * private_thread is NULL.
374 tdm_private_thread *private_thread;
377 struct _tdm_private_vblank_handler {
378 struct list_head link;
380 tdm_private_output *private_output;
383 tdm_output_vblank_handler func;
389 struct _tdm_private_output_commit_handler {
390 struct list_head link;
392 tdm_private_output *private_output;
393 tdm_output_commit_handler func;
399 struct _tdm_private_layer_commit_handler {
400 struct list_head link;
402 tdm_private_layer *private_layer;
403 tdm_layer_commit_handler func;
406 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
409 struct _tdm_private_change_handler {
410 struct list_head link;
412 tdm_private_output *private_output;
413 tdm_output_change_handler func;
419 struct _tdm_private_layer_buffer {
420 tbm_surface_h buffer;
421 struct list_head link;
424 typedef struct _tdm_buffer_info {
425 tbm_surface_h buffer;
427 /* ref_count for backend */
428 int backend_ref_count;
430 struct list_head release_funcs;
431 struct list_head destroy_funcs;
433 struct list_head *list;
434 struct list_head link;
437 typedef struct _tdm_pp_private_buffer {
440 struct list_head link;
441 struct list_head commit_link;
442 } tdm_pp_private_buffer;
444 typedef struct _tdm_capture_private_buffer {
445 tbm_surface_h buffer;
446 struct list_head link;
447 struct list_head commit_link;
448 } tdm_capture_private_buffer;
451 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
454 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
456 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
457 tdm_private_capture *
458 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
461 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
462 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
464 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
465 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
467 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
470 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
473 tdm_output_cb_need_validate(tdm_private_output *private_output);
476 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
477 tdm_output_vblank_handler func, void *user_data);
479 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
481 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
484 tdm_output_need_validate_event_init(tdm_output *output);
486 tdm_output_choose_commit_per_vblank_mode(tdm_private_output *private_output, int mode);
489 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
491 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
493 tdm_layer_remove_commit_handler_internal(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
496 tdm_layer_commit_pending_data(tdm_private_layer *private_layer);
498 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
501 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
504 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
507 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
509 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
511 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
513 tdm_vblank_get_stamp(tdm_vblank *vblank);
515 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
517 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
520 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
521 struct list_head *change_handler_list,
522 tdm_output_change_type type,
524 int no_check_thread_id);
527 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
529 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
532 tdm_hwc_window_create_internal(tdm_private_output *private_output, int is_video, tdm_error *error);
534 tdm_hwc_window_destroy_internal(tdm_private_hwc_window * private_hwc_window);
536 tdm_private_capture *
537 tdm_capture_create_output_internal(tdm_private_output *private_output,
539 tdm_private_capture *
540 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
543 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
545 /* utility buffer functions for private */
547 tdm_buffer_get_info(tbm_surface_h buffer);
549 tdm_buffer_list_get_first_entry(struct list_head *list);
551 tdm_buffer_list_dump(struct list_head *list);
554 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
556 /* event functions for private */
558 tdm_event_loop_init(tdm_private_display *private_display);
560 tdm_event_loop_deinit(tdm_private_display *private_display);
562 tdm_event_loop_stop(tdm_private_display *private_display);
564 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
566 tdm_event_loop_get_fd(tdm_private_display *private_display);
568 tdm_event_loop_dispatch(tdm_private_display *private_display);
570 tdm_event_loop_flush(tdm_private_display *private_display);
572 tdm_event_loop_trace_enable(tdm_private_display *private_display, unsigned int enable);
576 TDM_THREAD_CB_OUTPUT_COMMIT,
577 TDM_THREAD_CB_OUTPUT_VBLANK,
578 TDM_THREAD_CB_OUTPUT_STATUS,
579 TDM_THREAD_CB_OUTPUT_DPMS,
580 TDM_THREAD_CB_PP_DONE,
581 TDM_THREAD_CB_CAPTURE_DONE,
582 TDM_THREAD_CB_VBLANK_SW,
583 TDM_THREAD_CB_NEED_VALIDATE,
584 } tdm_thread_cb_type;
586 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
587 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
588 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
589 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
590 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
591 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
592 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
593 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
594 typedef struct _tdm_thread_cb_need_validate tdm_thread_cb_need_validate;
596 struct _tdm_thread_cb_base {
597 tdm_thread_cb_type type;
601 struct _tdm_thread_cb_output_vblank {
602 tdm_thread_cb_base base;
604 unsigned int sequence;
606 unsigned int tv_usec;
610 struct _tdm_thread_cb_output_status {
611 tdm_thread_cb_base base;
613 tdm_output_conn_status status;
617 struct _tdm_thread_cb_output_dpms {
618 tdm_thread_cb_base base;
620 tdm_output_dpms dpms;
624 struct _tdm_thread_cb_pp_done {
625 tdm_thread_cb_base base;
632 struct _tdm_thread_cb_capture_done {
633 tdm_thread_cb_base base;
634 double capture_stamp;
635 tbm_surface_h buffer;
639 struct _tdm_thread_cb_vblank_sw {
640 tdm_thread_cb_base base;
644 struct _tdm_thread_cb_need_validate {
645 tdm_thread_cb_base base;
646 tdm_private_output *o;
650 tdm_thread_init(tdm_private_loop *private_loop);
652 tdm_thread_deinit(tdm_private_loop *private_loop);
654 tdm_thread_get_fd(tdm_private_loop *private_loop);
656 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
658 tdm_thread_handle_cb(tdm_private_loop *private_loop);
660 tdm_thread_in_display_thread(pid_t tid);
662 tdm_thread_is_running(void);
665 tdm_server_init(tdm_private_loop *private_loop);
667 tdm_server_deinit(tdm_private_loop *private_loop);
669 tdm_server_get_client_name(pid_t pid);
671 tdm_server_enable_ttrace_client_vblank(tdm_display *dpy, tdm_output *output, int enable);
674 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
676 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
678 tdm_helper_get_time(void);
680 extern pthread_mutex_t tdm_mutex_check_lock;
681 extern int tdm_mutex_locked;
682 extern const char *tdm_mutex_lock_func;
683 extern int tdm_mutex_lock_line;
684 extern const char *tdm_mutex_unlock_func;
685 extern int tdm_mutex_unlock_line;
686 extern int tdm_dump_enable;
687 extern char *tdm_debug_dump_dir;
689 #define _pthread_mutex_unlock(l) \
691 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
692 TDM_INFO("mutex unlock"); \
693 pthread_mutex_lock(&tdm_mutex_check_lock); \
694 tdm_mutex_locked = 0; \
695 tdm_mutex_lock_func = NULL; \
696 tdm_mutex_lock_line = 0; \
697 tdm_mutex_unlock_func = __FUNCTION__; \
698 tdm_mutex_unlock_line = __LINE__; \
699 pthread_mutex_unlock(&tdm_mutex_check_lock); \
700 pthread_mutex_unlock(l); \
702 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
703 #define MUTEX_TIMEOUT_SEC 5
704 #define _pthread_mutex_lock(l) \
706 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
707 TDM_INFO("mutex lock"); \
708 struct timespec rtime; \
709 clock_gettime(CLOCK_REALTIME, &rtime); \
710 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
711 if (pthread_mutex_timedlock(l, &rtime)) { \
712 TDM_ERR("Mutex lock failed PID %d", getpid()); \
713 _pthread_mutex_unlock(l); \
716 pthread_mutex_lock(&tdm_mutex_check_lock); \
717 tdm_mutex_locked = 1; \
718 tdm_mutex_lock_func = __FUNCTION__; \
719 tdm_mutex_lock_line = __LINE__; \
720 tdm_mutex_unlock_func = NULL; \
721 tdm_mutex_unlock_line = 0; \
722 pthread_mutex_unlock(&tdm_mutex_check_lock); \
725 #else //TDM_CONFIG_MUTEX_TIMEOUT
726 #define _pthread_mutex_lock(l) \
728 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
729 TDM_INFO("mutex lock"); \
730 pthread_mutex_lock(l); \
731 pthread_mutex_lock(&tdm_mutex_check_lock); \
732 tdm_mutex_locked = 1; \
733 tdm_mutex_lock_func = __FUNCTION__; \
734 tdm_mutex_lock_line = __LINE__; \
735 tdm_mutex_unlock_func = NULL; \
736 tdm_mutex_unlock_line = 0; \
737 pthread_mutex_unlock(&tdm_mutex_check_lock); \
739 #endif //TDM_CONFIG_MUTEX_TIMEOUT
740 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
741 static inline int TDM_MUTEX_IS_LOCKED(void)
744 /* if thread is not running, we don't need to consider mutex things. */
745 if (!tdm_thread_is_running())
747 pthread_mutex_lock(&tdm_mutex_check_lock);
748 ret = (tdm_mutex_locked == 1);
749 pthread_mutex_unlock(&tdm_mutex_check_lock);
753 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
754 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
757 tdm_display_update_output(tdm_private_display *private_display,
758 tdm_output *output_backend, int pipe);
760 tdm_display_enable_debug_module(const char*modules);
762 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
764 tdm_display_enable_path(const char *path);
766 tdm_display_enable_ttrace(tdm_private_display *private_display, const char *ttrace, int output_id, char *reply, int *len);
768 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
771 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
773 struct argument_details {
783 #endif /* _TDM_PRIVATE_H_ */