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>
58 #include <wayland-server-protocol.h>
59 #include <tbm_bufmgr.h>
60 #include <tbm_surface_queue.h>
62 #include "tdm_backend.h"
65 #include "tdm_macro.h"
75 * @brief The private header file for a frontend library
80 TDM_DEBUG_BUFFER = (1 << 0),
81 TDM_DEBUG_MUTEX = (1 << 1),
82 TDM_DEBUG_THREAD = (1 << 2),
83 TDM_DEBUG_SERVER = (1 << 3),
84 TDM_DEBUG_VBLANK = (1 << 4),
85 TDM_DEBUG_COMMIT = (1 << 5),
90 TDM_TTRACE_VBLANK = (1 << 0),
91 TDM_TTRACE_CLIENT = (1 << 1),
92 TDM_TTRACE_LAYER = (1 << 2),
93 TDM_TTRACE_PP = (1 << 3),
94 TDM_TTRACE_CAPTURE = (1 << 4),
97 extern int tdm_debug_module;
98 extern int tdm_debug_dump;
99 extern int tdm_ttrace_module;
100 extern int tdm_ttrace_output;
104 #define TDM_TRACE_BEGIN(fmt, ...) traceBegin(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
105 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
106 #define TDM_TRACE_ASYNC_BEGIN(key, name,...) traceAsyncBegin(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
107 #define TDM_TRACE_ASYNC_END(key, name,...) traceAsyncEnd(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
108 #define TDM_TRACE_COUNT(count, fmt, ...) traceCounter(TTRACE_TAG_GRAPHICS, count, fmt, ##__VA_ARGS__)
109 #define TDM_TRACE_MARK(fmt, ...) traceMark(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
111 #define TDM_TRACE_BEGIN(fmt, ...)
112 #define TDM_TRACE_END()
113 #define TDM_TRACE_ASYNC_BEGIN(key, name,...)
114 #define TDM_TRACE_ASYNC_END(key, name,...)
115 #define TDM_TRACE_COUNT(count, fmt, ...)
116 #define TDM_TRACE_MARK(fmt, ...)
120 TDM_CAPTURE_TARGET_OUTPUT,
121 TDM_CAPTURE_TARGET_LAYER,
122 } tdm_capture_target;
125 TDM_DUMP_FLAG_LAYER = (1 << 0),
126 TDM_DUMP_FLAG_PP = (1 << 1),
127 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
130 #define TDM_DUMP_DIR "/tmp"
133 TDM_COMMIT_TYPE_NONE,
134 TDM_COMMIT_TYPE_OUTPUT,
135 TDM_COMMIT_TYPE_LAYER,
138 typedef struct _tdm_private_display tdm_private_display;
139 typedef struct _tdm_private_output tdm_private_output;
140 typedef struct _tdm_private_layer tdm_private_layer;
141 typedef struct _tdm_private_pp tdm_private_pp;
142 typedef struct _tdm_private_capture tdm_private_capture;
143 typedef struct _tdm_private_loop tdm_private_loop;
144 typedef struct _tdm_private_server tdm_private_server;
145 typedef struct _tdm_private_thread tdm_private_thread;
146 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
147 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
148 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
149 typedef struct _tdm_private_change_handler tdm_private_change_handler;
150 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
152 struct _tdm_private_display {
153 pthread_mutex_t lock;
154 unsigned int init_count;
156 /* backend module info */
158 tdm_backend_module *module_data;
159 tdm_backend_data *bdata;
165 /* backend function */
166 tdm_display_capability capabilities;
167 tdm_func_display func_display;
168 tdm_func_output func_output;
169 tdm_func_layer func_layer;
171 tdm_func_capture func_capture;
173 /* backend capability */
174 tdm_caps_display caps_display;
176 tdm_caps_capture caps_capture;
178 /* output, pp list */
179 struct list_head output_list;
180 struct list_head pp_list;
181 struct list_head capture_list;
185 /* for event handling */
186 tdm_private_loop *private_loop;
189 tdm_output **outputs;
191 /* calling a output commit per a vblank */
192 int commit_per_vblank;
193 tdm_commit_type commit_type;
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 capture_list;
221 struct list_head vblank_handler_list;
222 struct list_head output_commit_handler_list;
224 /* for layer commit */
225 struct list_head layer_commit_handler_list;
226 struct list_head pending_commit_handler_list;
228 int layer_waiting_vblank;
230 /* seperate list for multi-thread*/
231 struct list_head change_handler_list_main;
232 struct list_head change_handler_list_sub;
236 /* TODO: temp solution for handling DPMS things in sub-htread */
237 tdm_event_loop_source *dpms_changed_timer;
239 /* for ttrace vblank */
240 tdm_vblank *ttrace_vblank;
243 struct _tdm_private_layer {
244 struct list_head link;
248 tdm_private_display *private_display;
249 tdm_private_output *private_output;
252 tdm_layer *layer_backend;
254 /* pending data until committed */
255 unsigned int pending_info_changed;
256 tdm_info_layer pending_info;
257 unsigned int pending_buffer_changed;
258 tbm_surface_h pending_buffer;
260 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
261 * And when a layer is committed, it will be moved to committed_buffer.
262 * Finally when a commit handler is called, it will be moved to showing_buffer.
264 tdm_private_layer_buffer *waiting_buffer;
265 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
266 tdm_private_layer_buffer *showing_buffer;
267 tbm_surface_queue_h buffer_queue;
269 struct list_head capture_list;
272 unsigned int committing;
275 unsigned int fps_count;
278 struct _tdm_private_pp {
279 struct list_head link;
283 tdm_private_display *private_display;
287 struct list_head pending_buffer_list;
288 struct list_head buffer_list;
293 tdm_pp_done_handler done_func;
294 void *done_user_data;
297 struct _tdm_private_capture {
298 struct list_head link;
299 struct list_head display_link;
303 tdm_capture_target target;
305 tdm_private_display *private_display;
306 tdm_private_output *private_output;
307 tdm_private_layer *private_layer;
309 tdm_capture *capture_backend;
311 struct list_head pending_buffer_list;
312 struct list_head buffer_list;
314 tdm_info_capture info;
317 tdm_capture_done_handler done_func;
318 void *done_user_data;
322 * Note that we don't need to (un)lock mutex to use this structure. If there is
323 * no TDM thread, all TDM resources are protected by private_display's mutex.
324 * If there is a TDM thread, this struct will be used only in a TDM thread.
325 * So, we don't need to protect this structure by mutex. Not thread-safe.
327 struct _tdm_private_loop {
328 /* TDM uses wl_event_loop to handle various event sources including the TDM
331 struct wl_display *wl_display;
332 struct wl_event_loop *wl_loop;
335 tdm_event_loop_source *backend_source;
337 /* In event loop, all resources are accessed by this dpy.
339 * - DO NOT include other private structure in this structure because this
340 * struct is not protected by mutex.
344 /* for handling TDM client requests */
345 tdm_private_server *private_server;
347 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
348 * private_thread is NULL.
350 tdm_private_thread *private_thread;
353 struct _tdm_private_vblank_handler {
354 struct list_head link;
356 tdm_private_output *private_output;
359 tdm_output_vblank_handler func;
365 struct _tdm_private_output_commit_handler {
366 struct list_head link;
368 tdm_private_output *private_output;
369 tdm_output_commit_handler func;
375 struct _tdm_private_layer_commit_handler {
376 struct list_head link;
378 tdm_private_layer *private_layer;
379 tdm_layer_commit_handler func;
382 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
385 struct _tdm_private_change_handler {
386 struct list_head link;
388 tdm_private_output *private_output;
389 tdm_output_change_handler func;
395 struct _tdm_private_layer_buffer {
396 tbm_surface_h buffer;
397 struct list_head link;
400 typedef struct _tdm_buffer_info {
401 tbm_surface_h buffer;
403 /* ref_count for backend */
404 int backend_ref_count;
406 struct list_head release_funcs;
407 struct list_head destroy_funcs;
409 struct list_head *list;
410 struct list_head link;
413 typedef struct _tdm_pp_private_buffer {
416 struct list_head link;
417 struct list_head commit_link;
418 } tdm_pp_private_buffer;
420 typedef struct _tdm_capture_private_buffer {
421 tbm_surface_h buffer;
422 struct list_head link;
423 struct list_head commit_link;
424 } tdm_capture_private_buffer;
427 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
430 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
432 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
433 tdm_private_capture *
434 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
437 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
438 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
440 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
441 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
443 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
446 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
449 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
450 tdm_output_vblank_handler func, void *user_data);
452 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
454 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
457 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
459 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
461 tdm_layer_remove_commit_handler_internal(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
464 tdm_layer_commit_pending_data(tdm_private_layer *private_layer);
466 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
469 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
472 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
475 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
477 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
479 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
481 tdm_vblank_get_stamp(tdm_vblank *vblank);
483 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
485 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
488 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
489 struct list_head *change_handler_list,
490 tdm_output_change_type type,
492 int no_check_thread_id);
495 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
497 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
499 tdm_private_capture *
500 tdm_capture_create_output_internal(tdm_private_output *private_output,
502 tdm_private_capture *
503 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
506 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
508 /* utility buffer functions for private */
510 tdm_buffer_get_info(tbm_surface_h buffer);
512 tdm_buffer_list_get_first_entry(struct list_head *list);
514 tdm_buffer_list_dump(struct list_head *list);
517 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
519 /* event functions for private */
521 tdm_event_loop_init(tdm_private_display *private_display);
523 tdm_event_loop_deinit(tdm_private_display *private_display);
525 tdm_event_loop_stop(tdm_private_display *private_display);
527 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
529 tdm_event_loop_get_fd(tdm_private_display *private_display);
531 tdm_event_loop_dispatch(tdm_private_display *private_display);
533 tdm_event_loop_flush(tdm_private_display *private_display);
535 tdm_event_loop_trace_enable(tdm_private_display *private_display, unsigned int enable);
539 TDM_THREAD_CB_OUTPUT_COMMIT,
540 TDM_THREAD_CB_OUTPUT_VBLANK,
541 TDM_THREAD_CB_OUTPUT_STATUS,
542 TDM_THREAD_CB_OUTPUT_DPMS,
543 TDM_THREAD_CB_PP_DONE,
544 TDM_THREAD_CB_CAPTURE_DONE,
545 TDM_THREAD_CB_VBLANK_SW,
546 } tdm_thread_cb_type;
548 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
549 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
550 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
551 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
552 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
553 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
554 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
555 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
557 struct _tdm_thread_cb_base {
558 tdm_thread_cb_type type;
562 struct _tdm_thread_cb_output_vblank {
563 tdm_thread_cb_base base;
565 unsigned int sequence;
567 unsigned int tv_usec;
571 struct _tdm_thread_cb_output_status {
572 tdm_thread_cb_base base;
574 tdm_output_conn_status status;
578 struct _tdm_thread_cb_output_dpms {
579 tdm_thread_cb_base base;
581 tdm_output_dpms dpms;
585 struct _tdm_thread_cb_pp_done {
586 tdm_thread_cb_base base;
593 struct _tdm_thread_cb_capture_done {
594 tdm_thread_cb_base base;
595 double capture_stamp;
596 tbm_surface_h buffer;
600 struct _tdm_thread_cb_vblank_sw {
601 tdm_thread_cb_base base;
606 tdm_thread_init(tdm_private_loop *private_loop);
608 tdm_thread_deinit(tdm_private_loop *private_loop);
610 tdm_thread_get_fd(tdm_private_loop *private_loop);
612 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
614 tdm_thread_handle_cb(tdm_private_loop *private_loop);
616 tdm_thread_in_display_thread(pid_t tid);
618 tdm_thread_is_running(void);
621 tdm_server_init(tdm_private_loop *private_loop);
623 tdm_server_deinit(tdm_private_loop *private_loop);
625 tdm_server_get_client_name(pid_t pid);
627 tdm_server_enable_ttrace_client_vblank(tdm_display *dpy, tdm_output *output, int enable);
630 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
632 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
634 tdm_helper_get_time(void);
636 extern pthread_mutex_t tdm_mutex_check_lock;
637 extern int tdm_mutex_locked;
638 extern const char *tdm_mutex_lock_func;
639 extern int tdm_mutex_lock_line;
640 extern const char *tdm_mutex_unlock_func;
641 extern int tdm_mutex_unlock_line;
642 extern int tdm_dump_enable;
643 extern char *tdm_debug_dump_dir;
645 #define _pthread_mutex_unlock(l) \
647 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
648 TDM_INFO("mutex unlock"); \
649 pthread_mutex_lock(&tdm_mutex_check_lock); \
650 tdm_mutex_locked = 0; \
651 tdm_mutex_lock_func = NULL; \
652 tdm_mutex_lock_line = 0; \
653 tdm_mutex_unlock_func = __FUNCTION__; \
654 tdm_mutex_unlock_line = __LINE__; \
655 pthread_mutex_unlock(&tdm_mutex_check_lock); \
656 pthread_mutex_unlock(l); \
658 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
659 #define MUTEX_TIMEOUT_SEC 5
660 #define _pthread_mutex_lock(l) \
662 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
663 TDM_INFO("mutex lock"); \
664 struct timespec rtime; \
665 clock_gettime(CLOCK_REALTIME, &rtime); \
666 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
667 if (pthread_mutex_timedlock(l, &rtime)) { \
668 TDM_ERR("Mutex lock failed PID %d", getpid()); \
669 _pthread_mutex_unlock(l); \
672 pthread_mutex_lock(&tdm_mutex_check_lock); \
673 tdm_mutex_locked = 1; \
674 tdm_mutex_lock_func = __FUNCTION__; \
675 tdm_mutex_lock_line = __LINE__; \
676 tdm_mutex_unlock_func = NULL; \
677 tdm_mutex_unlock_line = 0; \
678 pthread_mutex_unlock(&tdm_mutex_check_lock); \
681 #else //TDM_CONFIG_MUTEX_TIMEOUT
682 #define _pthread_mutex_lock(l) \
684 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
685 TDM_INFO("mutex lock"); \
686 pthread_mutex_lock(l); \
687 pthread_mutex_lock(&tdm_mutex_check_lock); \
688 tdm_mutex_locked = 1; \
689 tdm_mutex_lock_func = __FUNCTION__; \
690 tdm_mutex_lock_line = __LINE__; \
691 tdm_mutex_unlock_func = NULL; \
692 tdm_mutex_unlock_line = 0; \
693 pthread_mutex_unlock(&tdm_mutex_check_lock); \
695 #endif //TDM_CONFIG_MUTEX_TIMEOUT
696 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
697 static inline int TDM_MUTEX_IS_LOCKED(void)
700 /* if thread is not running, we don't need to consider mutex things. */
701 if (!tdm_thread_is_running())
703 pthread_mutex_lock(&tdm_mutex_check_lock);
704 ret = (tdm_mutex_locked == 1);
705 pthread_mutex_unlock(&tdm_mutex_check_lock);
709 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
710 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
713 tdm_display_update_output(tdm_private_display *private_display,
714 tdm_output *output_backend, int pipe);
716 tdm_display_enable_debug_module(const char*modules);
718 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
720 tdm_display_enable_path(const char *path);
722 tdm_display_enable_ttrace(tdm_private_display *private_display, const char *ttrace, int output_id, char *reply, int *len);
724 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
726 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
729 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
732 struct argument_details {
742 #endif /* _TDM_PRIVATE_H_ */