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),
89 extern int tdm_debug_module;
90 extern int tdm_debug_dump;
94 #define TDM_TRACE_BEGIN(fmt, ...) traceBegin(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
95 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
96 #define TDM_TRACE_ASYNC_BEGIN(key, name,...) traceAsyncBegin(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
97 #define TDM_TRACE_ASYNC_END(key, name,...) traceAsyncEnd(TTRACE_TAG_GRAPHICS, key, name, ##__VA_ARGS__)
98 #define TDM_TRACE_COUNT(count, fmt, ...) traceCounter(TTRACE_TAG_GRAPHICS, count, fmt, ##__VA_ARGS__)
99 #define TDM_TRACE_MARK(fmt, ...) traceMark(TTRACE_TAG_GRAPHICS, fmt, ##__VA_ARGS__)
101 #define TDM_TRACE_BEGIN(fmt, ...)
102 #define TDM_TRACE_END()
103 #define TDM_TRACE_ASYNC_BEGIN(key, name,...)
104 #define TDM_TRACE_ASYNC_END(key, name,...)
105 #define TDM_TRACE_COUNT(count, fmt, ...)
106 #define TDM_TRACE_MARK(fmt, ...)
110 TDM_CAPTURE_TARGET_OUTPUT,
111 TDM_CAPTURE_TARGET_LAYER,
112 } tdm_capture_target;
115 TDM_DUMP_FLAG_LAYER = (1 << 0),
116 TDM_DUMP_FLAG_PP = (1 << 1),
117 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
118 TDM_DUMP_FLAG_WINDOW = (1 << 3),
121 #define TDM_DUMP_DIR "/tmp"
124 TDM_COMMIT_TYPE_NONE,
125 TDM_COMMIT_TYPE_OUTPUT,
126 TDM_COMMIT_TYPE_LAYER,
129 typedef struct _tdm_private_display tdm_private_display;
130 typedef struct _tdm_private_output tdm_private_output;
131 typedef struct _tdm_private_layer tdm_private_layer;
132 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
133 typedef struct _tdm_private_pp tdm_private_pp;
134 typedef struct _tdm_private_capture tdm_private_capture;
135 typedef struct _tdm_private_loop tdm_private_loop;
136 typedef struct _tdm_private_server tdm_private_server;
137 typedef struct _tdm_private_thread tdm_private_thread;
138 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
139 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
140 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
141 typedef struct _tdm_private_change_handler tdm_private_change_handler;
142 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
144 struct _tdm_private_display {
145 pthread_mutex_t lock;
146 unsigned int init_count;
148 /* backend module info */
150 tdm_backend_module *module_data;
151 tdm_backend_data *bdata;
157 /* backend function */
158 tdm_display_capability capabilities;
159 tdm_func_display func_display;
160 tdm_func_output func_output;
161 tdm_func_layer func_layer;
162 tdm_func_hwc_window func_hwc_window;
164 tdm_func_capture func_capture;
166 /* backend capability */
167 tdm_caps_display caps_display;
169 tdm_caps_capture caps_capture;
171 /* output, pp list */
172 struct list_head output_list;
173 struct list_head pp_list;
174 struct list_head capture_list;
178 /* for event handling */
179 tdm_private_loop *private_loop;
182 tdm_output **outputs;
187 struct _tdm_private_output {
188 struct list_head link;
193 tdm_private_display *private_display;
195 tdm_caps_output caps;
196 tdm_output *output_backend;
199 tdm_output_dpms current_dpms_value;
200 unsigned int waiting_dpms_change;
201 const tdm_output_mode *current_mode;
203 int regist_vblank_cb;
204 int regist_commit_cb;
205 int regist_change_cb;
208 struct list_head layer_list;
209 struct list_head hwc_window_list;
210 struct list_head capture_list;
211 struct list_head vblank_handler_list;
212 struct list_head output_commit_handler_list;
214 /* for layer commit */
215 struct list_head layer_commit_handler_list;
216 struct list_head pending_commit_handler_list;
218 int layer_waiting_vblank;
220 /* seperate list for multi-thread*/
221 struct list_head change_handler_list_main;
222 struct list_head change_handler_list_sub;
226 /* TODO: temp solution for handling DPMS things in sub-htread */
227 tdm_event_loop_source *dpms_changed_timer;
230 /* look at the tdm_output_set_need_revalidate_handler() declaration for the details */
231 tdm_output_need_validate_handler hndl;
235 /* calling a output commit per a vblank */
236 int commit_per_vblank;
237 tdm_commit_type commit_type;
239 /* for ttrace vblank */
240 tdm_vblank *ttrace_vblank;
241 unsigned int ttrace_vblank_client;
244 struct _tdm_private_layer {
245 struct list_head link;
249 tdm_private_display *private_display;
250 tdm_private_output *private_output;
253 tdm_layer *layer_backend;
255 /* pending data until committed */
256 unsigned int pending_info_changed;
257 tdm_info_layer pending_info;
258 unsigned int pending_buffer_changed;
259 tbm_surface_h pending_buffer;
261 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
262 * And when a layer is committed, it will be moved to committed_buffer.
263 * Finally when a commit handler is called, it will be moved to showing_buffer.
265 tdm_private_layer_buffer *waiting_buffer;
266 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
267 tdm_private_layer_buffer *showing_buffer;
268 tbm_surface_queue_h buffer_queue;
270 struct list_head capture_list;
273 unsigned int committing;
276 unsigned int fps_count;
279 struct _tdm_private_hwc_window {
280 struct list_head link;
285 tdm_private_display *private_display;
286 tdm_private_output *private_output;
288 tdm_hwc_window *hwc_window_backend;
292 struct _tdm_private_pp {
293 struct list_head link;
297 tdm_private_display *private_display;
301 struct list_head pending_buffer_list;
302 struct list_head buffer_list;
307 tdm_pp_done_handler done_func;
308 void *done_user_data;
311 struct _tdm_private_capture {
312 struct list_head link;
313 struct list_head display_link;
317 tdm_capture_target target;
319 tdm_private_display *private_display;
320 tdm_private_output *private_output;
321 tdm_private_layer *private_layer;
323 tdm_capture *capture_backend;
325 struct list_head pending_buffer_list;
326 struct list_head buffer_list;
328 tdm_info_capture info;
331 tdm_capture_done_handler done_func;
332 void *done_user_data;
336 * Note that we don't need to (un)lock mutex to use this structure. If there is
337 * no TDM thread, all TDM resources are protected by private_display's mutex.
338 * If there is a TDM thread, this struct will be used only in a TDM thread.
339 * So, we don't need to protect this structure by mutex. Not thread-safe.
341 struct _tdm_private_loop {
342 /* TDM uses wl_event_loop to handle various event sources including the TDM
345 struct wl_display *wl_display;
346 struct wl_event_loop *wl_loop;
349 tdm_event_loop_source *backend_source;
351 /* In event loop, all resources are accessed by this dpy.
353 * - DO NOT include other private structure in this structure because this
354 * struct is not protected by mutex.
358 /* for handling TDM client requests */
359 tdm_private_server *private_server;
361 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
362 * private_thread is NULL.
364 tdm_private_thread *private_thread;
367 struct _tdm_private_vblank_handler {
368 struct list_head link;
370 tdm_private_output *private_output;
373 tdm_output_vblank_handler func;
379 struct _tdm_private_output_commit_handler {
380 struct list_head link;
382 tdm_private_output *private_output;
383 tdm_output_commit_handler func;
389 struct _tdm_private_layer_commit_handler {
390 struct list_head link;
392 tdm_private_layer *private_layer;
393 tdm_layer_commit_handler func;
396 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
399 struct _tdm_private_change_handler {
400 struct list_head link;
402 tdm_private_output *private_output;
403 tdm_output_change_handler func;
409 struct _tdm_private_layer_buffer {
410 tbm_surface_h buffer;
411 struct list_head link;
414 typedef struct _tdm_buffer_info {
415 tbm_surface_h buffer;
417 /* ref_count for backend */
418 int backend_ref_count;
420 struct list_head release_funcs;
421 struct list_head destroy_funcs;
423 struct list_head *list;
424 struct list_head link;
427 typedef struct _tdm_pp_private_buffer {
430 struct list_head link;
431 struct list_head commit_link;
432 } tdm_pp_private_buffer;
434 typedef struct _tdm_capture_private_buffer {
435 tbm_surface_h buffer;
436 struct list_head link;
437 struct list_head commit_link;
438 } tdm_capture_private_buffer;
441 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
444 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
446 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
447 tdm_private_capture *
448 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
451 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
452 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
454 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
455 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
457 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
460 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
463 tdm_output_cb_need_validate(tdm_private_output *private_output);
466 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
467 tdm_output_vblank_handler func, void *user_data);
469 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
471 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
474 tdm_output_need_validate_event_init(tdm_output *output);
476 tdm_output_choose_commit_per_vblank_mode(tdm_private_output *private_output, int mode);
479 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
481 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
483 tdm_layer_remove_commit_handler_internal(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
486 tdm_layer_commit_pending_data(tdm_private_layer *private_layer);
488 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
491 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
494 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
497 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
499 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
501 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
503 tdm_vblank_get_stamp(tdm_vblank *vblank);
505 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
507 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
510 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
511 struct list_head *change_handler_list,
512 tdm_output_change_type type,
514 int no_check_thread_id);
517 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
519 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
522 tdm_hwc_window_create_internal(tdm_private_output *private_output, tdm_error *error);
524 tdm_hwc_window_destroy_internal(tdm_private_hwc_window * private_hwc_window);
526 tdm_private_capture *
527 tdm_capture_create_output_internal(tdm_private_output *private_output,
529 tdm_private_capture *
530 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
533 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
535 /* utility buffer functions for private */
537 tdm_buffer_get_info(tbm_surface_h buffer);
539 tdm_buffer_list_get_first_entry(struct list_head *list);
541 tdm_buffer_list_dump(struct list_head *list);
544 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
546 /* event functions for private */
548 tdm_event_loop_init(tdm_private_display *private_display);
550 tdm_event_loop_deinit(tdm_private_display *private_display);
552 tdm_event_loop_stop(tdm_private_display *private_display);
554 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
556 tdm_event_loop_get_fd(tdm_private_display *private_display);
558 tdm_event_loop_dispatch(tdm_private_display *private_display);
560 tdm_event_loop_flush(tdm_private_display *private_display);
562 tdm_event_loop_trace_enable(tdm_private_display *private_display, unsigned int enable);
566 TDM_THREAD_CB_OUTPUT_COMMIT,
567 TDM_THREAD_CB_OUTPUT_VBLANK,
568 TDM_THREAD_CB_OUTPUT_STATUS,
569 TDM_THREAD_CB_OUTPUT_DPMS,
570 TDM_THREAD_CB_PP_DONE,
571 TDM_THREAD_CB_CAPTURE_DONE,
572 TDM_THREAD_CB_VBLANK_SW,
573 TDM_THREAD_CB_NEED_VALIDATE,
574 } tdm_thread_cb_type;
576 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
577 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
578 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
579 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
580 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
581 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
582 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
583 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
584 typedef struct _tdm_thread_cb_need_validate tdm_thread_cb_need_validate;
586 struct _tdm_thread_cb_base {
587 tdm_thread_cb_type type;
591 struct _tdm_thread_cb_output_vblank {
592 tdm_thread_cb_base base;
594 unsigned int sequence;
596 unsigned int tv_usec;
600 struct _tdm_thread_cb_output_status {
601 tdm_thread_cb_base base;
603 tdm_output_conn_status status;
607 struct _tdm_thread_cb_output_dpms {
608 tdm_thread_cb_base base;
610 tdm_output_dpms dpms;
614 struct _tdm_thread_cb_pp_done {
615 tdm_thread_cb_base base;
622 struct _tdm_thread_cb_capture_done {
623 tdm_thread_cb_base base;
624 double capture_stamp;
625 tbm_surface_h buffer;
629 struct _tdm_thread_cb_vblank_sw {
630 tdm_thread_cb_base base;
634 struct _tdm_thread_cb_need_validate {
635 tdm_thread_cb_base base;
636 tdm_private_output *o;
640 tdm_thread_init(tdm_private_loop *private_loop);
642 tdm_thread_deinit(tdm_private_loop *private_loop);
644 tdm_thread_get_fd(tdm_private_loop *private_loop);
646 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
648 tdm_thread_handle_cb(tdm_private_loop *private_loop);
650 tdm_thread_in_display_thread(pid_t tid);
652 tdm_thread_is_running(void);
655 tdm_server_init(tdm_private_loop *private_loop);
657 tdm_server_deinit(tdm_private_loop *private_loop);
659 tdm_server_get_client_name(pid_t pid);
661 tdm_server_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
664 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
666 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
668 tdm_helper_get_time(void);
670 extern pthread_mutex_t tdm_mutex_check_lock;
671 extern int tdm_mutex_locked;
672 extern const char *tdm_mutex_lock_func;
673 extern int tdm_mutex_lock_line;
674 extern const char *tdm_mutex_unlock_func;
675 extern int tdm_mutex_unlock_line;
676 extern int tdm_dump_enable;
677 extern char *tdm_debug_dump_dir;
679 #define _pthread_mutex_unlock(l) \
681 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
682 TDM_INFO("mutex unlock"); \
683 pthread_mutex_lock(&tdm_mutex_check_lock); \
684 tdm_mutex_locked = 0; \
685 tdm_mutex_lock_func = NULL; \
686 tdm_mutex_lock_line = 0; \
687 tdm_mutex_unlock_func = __FUNCTION__; \
688 tdm_mutex_unlock_line = __LINE__; \
689 pthread_mutex_unlock(&tdm_mutex_check_lock); \
690 pthread_mutex_unlock(l); \
692 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
693 #define MUTEX_TIMEOUT_SEC 5
694 #define _pthread_mutex_lock(l) \
696 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
697 TDM_INFO("mutex lock"); \
698 struct timespec rtime; \
699 clock_gettime(CLOCK_REALTIME, &rtime); \
700 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
701 if (pthread_mutex_timedlock(l, &rtime)) { \
702 TDM_ERR("Mutex lock failed PID %d", getpid()); \
703 _pthread_mutex_unlock(l); \
706 pthread_mutex_lock(&tdm_mutex_check_lock); \
707 tdm_mutex_locked = 1; \
708 tdm_mutex_lock_func = __FUNCTION__; \
709 tdm_mutex_lock_line = __LINE__; \
710 tdm_mutex_unlock_func = NULL; \
711 tdm_mutex_unlock_line = 0; \
712 pthread_mutex_unlock(&tdm_mutex_check_lock); \
715 #else //TDM_CONFIG_MUTEX_TIMEOUT
716 #define _pthread_mutex_lock(l) \
718 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
719 TDM_INFO("mutex lock"); \
720 pthread_mutex_lock(l); \
721 pthread_mutex_lock(&tdm_mutex_check_lock); \
722 tdm_mutex_locked = 1; \
723 tdm_mutex_lock_func = __FUNCTION__; \
724 tdm_mutex_lock_line = __LINE__; \
725 tdm_mutex_unlock_func = NULL; \
726 tdm_mutex_unlock_line = 0; \
727 pthread_mutex_unlock(&tdm_mutex_check_lock); \
729 #endif //TDM_CONFIG_MUTEX_TIMEOUT
730 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
731 static inline int TDM_MUTEX_IS_LOCKED(void)
734 /* if thread is not running, we don't need to consider mutex things. */
735 if (!tdm_thread_is_running())
737 pthread_mutex_lock(&tdm_mutex_check_lock);
738 ret = (tdm_mutex_locked == 1);
739 pthread_mutex_unlock(&tdm_mutex_check_lock);
743 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
744 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
747 tdm_display_update_output(tdm_private_display *private_display,
748 tdm_output *output_backend, int pipe);
750 tdm_display_enable_debug_module(const char*modules);
752 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
754 tdm_display_enable_path(const char *path);
756 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
758 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
761 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
763 struct argument_details {
773 #endif /* _TDM_PRIVATE_H_ */