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 <wayland-server-protocol.h>
58 #include <tbm_bufmgr.h>
59 #include <tbm_surface_queue.h>
61 #include "tdm_backend.h"
64 #include "tdm_macro.h"
74 * @brief The private header file for a frontend library
79 TDM_DEBUG_BUFFER = (1 << 0),
80 TDM_DEBUG_MUTEX = (1 << 1),
81 TDM_DEBUG_THREAD = (1 << 2),
82 TDM_DEBUG_SERVER = (1 << 3),
83 TDM_DEBUG_VBLANK = (1 << 4),
84 TDM_DEBUG_COMMIT = (1 << 5),
87 extern int tdm_debug_module;
88 extern int tdm_debug_dump;
92 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
93 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
94 #define TDM_TRACE_COUNT(NAME, COUNT) traceCounter(TTRACE_TAG_GRAPHICS, COUNT, "TDM:"#NAME)
95 #define TDM_TRACE_MARK(NAME) traceMark(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
97 #define TDM_TRACE_BEGIN(NAME)
98 #define TDM_TRACE_END()
99 #define TDM_TRACE_COUNT(NAME, COUNT)
100 #define TDM_TRACE_MARK(NAME)
104 TDM_CAPTURE_TARGET_OUTPUT,
105 TDM_CAPTURE_TARGET_LAYER,
106 } tdm_capture_target;
109 TDM_DUMP_FLAG_LAYER = (1 << 0),
110 TDM_DUMP_FLAG_PP = (1 << 1),
111 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
114 #define TDM_DUMP_DIR "/tmp"
117 TDM_COMMIT_TYPE_NONE,
118 TDM_COMMIT_TYPE_OUTPUT,
119 TDM_COMMIT_TYPE_LAYER,
122 typedef struct _tdm_private_display tdm_private_display;
123 typedef struct _tdm_private_output tdm_private_output;
124 typedef struct _tdm_private_layer tdm_private_layer;
125 typedef struct _tdm_private_pp tdm_private_pp;
126 typedef struct _tdm_private_capture tdm_private_capture;
127 typedef struct _tdm_private_loop tdm_private_loop;
128 typedef struct _tdm_private_server tdm_private_server;
129 typedef struct _tdm_private_thread tdm_private_thread;
130 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
131 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
132 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
133 typedef struct _tdm_private_change_handler tdm_private_change_handler;
134 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
136 struct _tdm_private_display {
137 pthread_mutex_t lock;
138 unsigned int init_count;
140 /* backend module info */
142 tdm_backend_module *module_data;
143 tdm_backend_data *bdata;
149 /* backend function */
150 tdm_display_capability capabilities;
151 tdm_func_display func_display;
152 tdm_func_output func_output;
153 tdm_func_layer func_layer;
155 tdm_func_capture func_capture;
157 /* backend capability */
158 tdm_caps_display caps_display;
160 tdm_caps_capture caps_capture;
162 /* output, pp list */
163 struct list_head output_list;
164 struct list_head pp_list;
165 struct list_head capture_list;
169 /* for event handling */
170 tdm_private_loop *private_loop;
173 tdm_output **outputs;
175 /* calling a output commit per a vblank */
176 int commit_per_vblank;
177 tdm_commit_type commit_type;
182 struct _tdm_private_output {
183 struct list_head link;
188 tdm_private_display *private_display;
190 tdm_caps_output caps;
191 tdm_output *output_backend;
194 tdm_output_dpms current_dpms_value;
195 const tdm_output_mode *current_mode;
197 int regist_vblank_cb;
198 int regist_commit_cb;
199 int regist_change_cb;
202 struct list_head layer_list;
203 struct list_head capture_list;
204 struct list_head vblank_handler_list;
205 struct list_head output_commit_handler_list;
207 /* for layer commit */
208 struct list_head layer_commit_handler_list;
209 struct list_head pending_commit_handler_list;
211 int layer_waiting_vblank;
213 /* seperate list for multi-thread*/
214 struct list_head change_handler_list_main;
215 struct list_head change_handler_list_sub;
219 /* TODO: temp solution for handling DPMS things in sub-htread */
220 tdm_event_loop_source *dpms_changed_timer;
223 struct _tdm_private_layer {
224 struct list_head link;
228 tdm_private_display *private_display;
229 tdm_private_output *private_output;
232 tdm_layer *layer_backend;
234 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
235 * And when a layer is committed, it will be moved to committed_buffer.
236 * Finally when a commit handler is called, it will be moved to showing_buffer.
238 tdm_private_layer_buffer *waiting_buffer;
239 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
240 tdm_private_layer_buffer *showing_buffer;
241 tbm_surface_queue_h buffer_queue;
243 struct list_head capture_list;
246 unsigned int committing;
249 unsigned int fps_count;
252 struct _tdm_private_pp {
253 struct list_head link;
257 tdm_private_display *private_display;
261 struct list_head pending_buffer_list;
262 struct list_head buffer_list;
267 tdm_pp_done_handler done_func;
268 void *done_user_data;
271 struct _tdm_private_capture {
272 struct list_head link;
273 struct list_head display_link;
277 tdm_capture_target target;
279 tdm_private_display *private_display;
280 tdm_private_output *private_output;
281 tdm_private_layer *private_layer;
283 tdm_capture *capture_backend;
285 struct list_head pending_buffer_list;
286 struct list_head buffer_list;
288 tdm_info_capture info;
291 tdm_capture_done_handler done_func;
292 void *done_user_data;
296 * Note that we don't need to (un)lock mutex to use this structure. If there is
297 * no TDM thread, all TDM resources are protected by private_display's mutex.
298 * If there is a TDM thread, this struct will be used only in a TDM thread.
299 * So, we don't need to protect this structure by mutex. Not thread-safe.
301 struct _tdm_private_loop {
302 /* TDM uses wl_event_loop to handle various event sources including the TDM
305 struct wl_display *wl_display;
306 struct wl_event_loop *wl_loop;
309 tdm_event_loop_source *backend_source;
311 /* In event loop, all resources are accessed by this dpy.
313 * - DO NOT include other private structure in this structure because this
314 * struct is not protected by mutex.
318 /* for handling TDM client requests */
319 tdm_private_server *private_server;
321 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
322 * private_thread is NULL.
324 tdm_private_thread *private_thread;
327 struct _tdm_private_vblank_handler {
328 struct list_head link;
330 tdm_private_output *private_output;
333 tdm_output_vblank_handler func;
339 struct _tdm_private_output_commit_handler {
340 struct list_head link;
342 tdm_private_output *private_output;
343 tdm_output_commit_handler func;
349 struct _tdm_private_layer_commit_handler {
350 struct list_head link;
352 tdm_private_layer *private_layer;
353 tdm_layer_commit_handler func;
356 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
359 struct _tdm_private_change_handler {
360 struct list_head link;
362 tdm_private_output *private_output;
363 tdm_output_change_handler func;
369 struct _tdm_private_layer_buffer {
370 tbm_surface_h buffer;
371 struct list_head link;
374 typedef struct _tdm_buffer_info {
375 tbm_surface_h buffer;
377 /* ref_count for backend */
378 int backend_ref_count;
380 struct list_head release_funcs;
381 struct list_head destroy_funcs;
383 struct list_head *list;
384 struct list_head link;
387 typedef struct _tdm_pp_private_buffer {
390 struct list_head link;
391 struct list_head commit_link;
392 } tdm_pp_private_buffer;
394 typedef struct _tdm_capture_private_buffer {
395 tbm_surface_h buffer;
396 struct list_head link;
397 struct list_head commit_link;
398 } tdm_capture_private_buffer;
401 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
404 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
406 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
407 tdm_private_capture *
408 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
411 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
412 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
414 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
415 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
417 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
420 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
423 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
424 tdm_output_vblank_handler func, void *user_data);
426 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
428 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
431 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
433 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
436 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
439 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
442 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
445 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
447 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
449 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
451 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
453 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
456 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
457 struct list_head *change_handler_list,
458 tdm_output_change_type type,
460 int no_check_thread_id);
463 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
465 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
467 tdm_private_capture *
468 tdm_capture_create_output_internal(tdm_private_output *private_output,
470 tdm_private_capture *
471 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
474 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
476 /* utility buffer functions for private */
478 tdm_buffer_get_info(tbm_surface_h buffer);
480 tdm_buffer_list_get_first_entry(struct list_head *list);
482 tdm_buffer_list_dump(struct list_head *list);
485 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
487 /* event functions for private */
489 tdm_event_loop_init(tdm_private_display *private_display);
491 tdm_event_loop_deinit(tdm_private_display *private_display);
493 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
495 tdm_event_loop_get_fd(tdm_private_display *private_display);
497 tdm_event_loop_dispatch(tdm_private_display *private_display);
499 tdm_event_loop_flush(tdm_private_display *private_display);
503 TDM_THREAD_CB_OUTPUT_COMMIT,
504 TDM_THREAD_CB_OUTPUT_VBLANK,
505 TDM_THREAD_CB_OUTPUT_STATUS,
506 TDM_THREAD_CB_OUTPUT_DPMS,
507 TDM_THREAD_CB_PP_DONE,
508 TDM_THREAD_CB_CAPTURE_DONE,
509 TDM_THREAD_CB_VBLANK_SW,
510 } tdm_thread_cb_type;
512 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
513 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
514 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
515 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
516 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
517 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
518 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
519 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
521 struct _tdm_thread_cb_base {
522 tdm_thread_cb_type type;
526 struct _tdm_thread_cb_output_vblank {
527 tdm_thread_cb_base base;
529 unsigned int sequence;
531 unsigned int tv_usec;
535 struct _tdm_thread_cb_output_status {
536 tdm_thread_cb_base base;
538 tdm_output_conn_status status;
542 struct _tdm_thread_cb_output_dpms {
543 tdm_thread_cb_base base;
545 tdm_output_dpms dpms;
549 struct _tdm_thread_cb_pp_done {
550 tdm_thread_cb_base base;
557 struct _tdm_thread_cb_capture_done {
558 tdm_thread_cb_base base;
559 double capture_stamp;
560 tbm_surface_h buffer;
564 struct _tdm_thread_cb_vblank_sw {
565 tdm_thread_cb_base base;
570 tdm_thread_init(tdm_private_loop *private_loop);
572 tdm_thread_deinit(tdm_private_loop *private_loop);
574 tdm_thread_get_fd(tdm_private_loop *private_loop);
576 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
578 tdm_thread_handle_cb(tdm_private_loop *private_loop);
580 tdm_thread_in_display_thread(pid_t tid);
582 tdm_thread_is_running(void);
585 tdm_server_init(tdm_private_loop *private_loop);
587 tdm_server_deinit(tdm_private_loop *private_loop);
590 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
592 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
594 tdm_helper_get_time(void);
596 extern pthread_mutex_t tdm_mutex_check_lock;
597 extern int tdm_mutex_locked;
598 extern const char *tdm_mutex_lock_func;
599 extern int tdm_mutex_lock_line;
600 extern const char *tdm_mutex_unlock_func;
601 extern int tdm_mutex_unlock_line;
602 extern int tdm_dump_enable;
603 extern char *tdm_debug_dump_dir;
605 #define _pthread_mutex_unlock(l) \
607 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
608 TDM_INFO("mutex unlock"); \
609 pthread_mutex_lock(&tdm_mutex_check_lock); \
610 tdm_mutex_locked = 0; \
611 tdm_mutex_lock_func = NULL; \
612 tdm_mutex_lock_line = 0; \
613 tdm_mutex_unlock_func = __FUNCTION__; \
614 tdm_mutex_unlock_line = __LINE__; \
615 pthread_mutex_unlock(&tdm_mutex_check_lock); \
616 pthread_mutex_unlock(l); \
618 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
619 #define MUTEX_TIMEOUT_SEC 5
620 #define _pthread_mutex_lock(l) \
622 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
623 TDM_INFO("mutex lock"); \
624 struct timespec rtime; \
625 clock_gettime(CLOCK_REALTIME, &rtime); \
626 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
627 if (pthread_mutex_timedlock(l, &rtime)) { \
628 TDM_ERR("Mutex lock failed PID %d", getpid()); \
629 _pthread_mutex_unlock(l); \
632 pthread_mutex_lock(&tdm_mutex_check_lock); \
633 tdm_mutex_locked = 1; \
634 tdm_mutex_lock_func = __FUNCTION__; \
635 tdm_mutex_lock_line = __LINE__; \
636 tdm_mutex_unlock_func = NULL; \
637 tdm_mutex_unlock_line = 0; \
638 pthread_mutex_unlock(&tdm_mutex_check_lock); \
641 #else //TDM_CONFIG_MUTEX_TIMEOUT
642 #define _pthread_mutex_lock(l) \
644 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
645 TDM_INFO("mutex lock"); \
646 pthread_mutex_lock(l); \
647 pthread_mutex_lock(&tdm_mutex_check_lock); \
648 tdm_mutex_locked = 1; \
649 tdm_mutex_lock_func = __FUNCTION__; \
650 tdm_mutex_lock_line = __LINE__; \
651 tdm_mutex_unlock_func = NULL; \
652 tdm_mutex_unlock_line = 0; \
653 pthread_mutex_unlock(&tdm_mutex_check_lock); \
655 #endif //TDM_CONFIG_MUTEX_TIMEOUT
656 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
657 static inline int TDM_MUTEX_IS_LOCKED(void)
660 /* if thread is not running, we don't need to consider mutex things. */
661 if (!tdm_thread_is_running())
663 pthread_mutex_lock(&tdm_mutex_check_lock);
664 ret = (tdm_mutex_locked == 1);
665 pthread_mutex_unlock(&tdm_mutex_check_lock);
669 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
670 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
673 tdm_display_update_output(tdm_private_display *private_display,
674 tdm_output *output_backend, int pipe);
676 tdm_display_enable_debug_module(const char*modules);
678 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
680 tdm_display_enable_path(const char *path);
682 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
684 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
686 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
689 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
695 #endif /* _TDM_PRIVATE_H_ */