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(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
95 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
96 #define TDM_TRACE_COUNT(NAME, COUNT) traceCounter(TTRACE_TAG_GRAPHICS, COUNT, "TDM:"#NAME)
97 #define TDM_TRACE_MARK(NAME) traceMark(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
99 #define TDM_TRACE_BEGIN(NAME)
100 #define TDM_TRACE_END()
101 #define TDM_TRACE_COUNT(NAME, COUNT)
102 #define TDM_TRACE_MARK(NAME)
106 TDM_CAPTURE_TARGET_OUTPUT,
107 TDM_CAPTURE_TARGET_LAYER,
108 } tdm_capture_target;
111 TDM_DUMP_FLAG_LAYER = (1 << 0),
112 TDM_DUMP_FLAG_PP = (1 << 1),
113 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
114 TDM_DUMP_FLAG_WINDOW = (1 << 3),
117 #define TDM_DUMP_DIR "/tmp"
120 TDM_COMMIT_TYPE_NONE,
121 TDM_COMMIT_TYPE_OUTPUT,
122 TDM_COMMIT_TYPE_LAYER,
125 typedef struct _tdm_private_display tdm_private_display;
126 typedef struct _tdm_private_output tdm_private_output;
127 typedef struct _tdm_private_layer tdm_private_layer;
128 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
129 typedef struct _tdm_private_pp tdm_private_pp;
130 typedef struct _tdm_private_capture tdm_private_capture;
131 typedef struct _tdm_private_loop tdm_private_loop;
132 typedef struct _tdm_private_server tdm_private_server;
133 typedef struct _tdm_private_thread tdm_private_thread;
134 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
135 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
136 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
137 typedef struct _tdm_private_change_handler tdm_private_change_handler;
138 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
140 struct _tdm_private_display {
141 pthread_mutex_t lock;
142 unsigned int init_count;
144 /* backend module info */
146 tdm_backend_module *module_data;
147 tdm_backend_data *bdata;
153 /* backend function */
154 tdm_display_capability capabilities;
155 tdm_func_display func_display;
156 tdm_func_output func_output;
157 tdm_func_layer func_layer;
158 tdm_func_hwc_window func_hwc_window;
160 tdm_func_capture func_capture;
162 /* backend capability */
163 tdm_caps_display caps_display;
165 tdm_caps_capture caps_capture;
167 /* output, pp list */
168 struct list_head output_list;
169 struct list_head pp_list;
170 struct list_head capture_list;
174 /* for event handling */
175 tdm_private_loop *private_loop;
178 tdm_output **outputs;
180 /* calling a output commit per a vblank */
181 int commit_per_vblank;
182 tdm_commit_type commit_type;
189 struct _tdm_private_output {
190 struct list_head link;
195 tdm_private_display *private_display;
197 tdm_caps_output caps;
198 tdm_output *output_backend;
201 tdm_output_dpms current_dpms_value;
202 unsigned int waiting_dpms_change;
203 const tdm_output_mode *current_mode;
205 int regist_vblank_cb;
206 int regist_commit_cb;
207 int regist_change_cb;
210 struct list_head layer_list;
211 struct list_head hwc_window_list;
212 struct list_head capture_list;
213 struct list_head vblank_handler_list;
214 struct list_head output_commit_handler_list;
216 /* for layer commit */
217 struct list_head layer_commit_handler_list;
218 struct list_head pending_commit_handler_list;
220 int layer_waiting_vblank;
222 /* seperate list for multi-thread*/
223 struct list_head change_handler_list_main;
224 struct list_head change_handler_list_sub;
228 /* TODO: temp solution for handling DPMS things in sub-htread */
229 tdm_event_loop_source *dpms_changed_timer;
232 /* look at the tdm_output_set_need_revalidate_handler() declaration for the details */
233 tdm_output_need_validate_handler hndl;
238 struct _tdm_private_layer {
239 struct list_head link;
243 tdm_private_display *private_display;
244 tdm_private_output *private_output;
247 tdm_layer *layer_backend;
249 /* pending data until committed */
250 unsigned int pending_info_changed;
251 tdm_info_layer pending_info;
252 unsigned int pending_buffer_changed;
253 tbm_surface_h pending_buffer;
255 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
256 * And when a layer is committed, it will be moved to committed_buffer.
257 * Finally when a commit handler is called, it will be moved to showing_buffer.
259 tdm_private_layer_buffer *waiting_buffer;
260 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
261 tdm_private_layer_buffer *showing_buffer;
262 tbm_surface_queue_h buffer_queue;
264 struct list_head capture_list;
267 unsigned int committing;
270 unsigned int fps_count;
273 struct _tdm_private_hwc_window {
274 struct list_head link;
279 tdm_private_display *private_display;
280 tdm_private_output *private_output;
282 tdm_hwc_window *hwc_window_backend;
286 struct _tdm_private_pp {
287 struct list_head link;
291 tdm_private_display *private_display;
295 struct list_head pending_buffer_list;
296 struct list_head buffer_list;
301 tdm_pp_done_handler done_func;
302 void *done_user_data;
305 struct _tdm_private_capture {
306 struct list_head link;
307 struct list_head display_link;
311 tdm_capture_target target;
313 tdm_private_display *private_display;
314 tdm_private_output *private_output;
315 tdm_private_layer *private_layer;
317 tdm_capture *capture_backend;
319 struct list_head pending_buffer_list;
320 struct list_head buffer_list;
322 tdm_info_capture info;
325 tdm_capture_done_handler done_func;
326 void *done_user_data;
330 * Note that we don't need to (un)lock mutex to use this structure. If there is
331 * no TDM thread, all TDM resources are protected by private_display's mutex.
332 * If there is a TDM thread, this struct will be used only in a TDM thread.
333 * So, we don't need to protect this structure by mutex. Not thread-safe.
335 struct _tdm_private_loop {
336 /* TDM uses wl_event_loop to handle various event sources including the TDM
339 struct wl_display *wl_display;
340 struct wl_event_loop *wl_loop;
343 tdm_event_loop_source *backend_source;
345 /* In event loop, all resources are accessed by this dpy.
347 * - DO NOT include other private structure in this structure because this
348 * struct is not protected by mutex.
352 /* for handling TDM client requests */
353 tdm_private_server *private_server;
355 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
356 * private_thread is NULL.
358 tdm_private_thread *private_thread;
361 struct _tdm_private_vblank_handler {
362 struct list_head link;
364 tdm_private_output *private_output;
367 tdm_output_vblank_handler func;
373 struct _tdm_private_output_commit_handler {
374 struct list_head link;
376 tdm_private_output *private_output;
377 tdm_output_commit_handler func;
383 struct _tdm_private_layer_commit_handler {
384 struct list_head link;
386 tdm_private_layer *private_layer;
387 tdm_layer_commit_handler func;
390 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
393 struct _tdm_private_change_handler {
394 struct list_head link;
396 tdm_private_output *private_output;
397 tdm_output_change_handler func;
403 struct _tdm_private_layer_buffer {
404 tbm_surface_h buffer;
405 struct list_head link;
408 typedef struct _tdm_buffer_info {
409 tbm_surface_h buffer;
411 /* ref_count for backend */
412 int backend_ref_count;
414 struct list_head release_funcs;
415 struct list_head destroy_funcs;
417 struct list_head *list;
418 struct list_head link;
421 typedef struct _tdm_pp_private_buffer {
424 struct list_head link;
425 struct list_head commit_link;
426 } tdm_pp_private_buffer;
428 typedef struct _tdm_capture_private_buffer {
429 tbm_surface_h buffer;
430 struct list_head link;
431 struct list_head commit_link;
432 } tdm_capture_private_buffer;
435 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
438 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
440 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
441 tdm_private_capture *
442 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
445 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
446 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
448 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
449 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
451 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
454 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
457 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
458 tdm_output_vblank_handler func, void *user_data);
460 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
462 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
465 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
467 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
469 tdm_layer_remove_commit_handler_internal(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
472 tdm_layer_commit_pending_data(tdm_private_layer *private_layer);
474 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
477 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
480 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
483 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
485 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
487 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
489 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
491 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
494 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
495 struct list_head *change_handler_list,
496 tdm_output_change_type type,
498 int no_check_thread_id);
501 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
503 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
506 tdm_hwc_window_create_internal(tdm_private_output *private_output, tdm_error *error);
508 tdm_hwc_window_destroy_internal(tdm_private_hwc_window * private_hwc_window);
510 tdm_private_capture *
511 tdm_capture_create_output_internal(tdm_private_output *private_output,
513 tdm_private_capture *
514 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
517 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
519 /* utility buffer functions for private */
521 tdm_buffer_get_info(tbm_surface_h buffer);
523 tdm_buffer_list_get_first_entry(struct list_head *list);
525 tdm_buffer_list_dump(struct list_head *list);
528 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
530 /* event functions for private */
532 tdm_event_loop_init(tdm_private_display *private_display);
534 tdm_event_loop_deinit(tdm_private_display *private_display);
536 tdm_event_loop_stop(tdm_private_display *private_display);
538 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
540 tdm_event_loop_get_fd(tdm_private_display *private_display);
542 tdm_event_loop_dispatch(tdm_private_display *private_display);
544 tdm_event_loop_flush(tdm_private_display *private_display);
546 tdm_event_loop_trace_enable(tdm_private_display *private_display, unsigned int enable);
550 TDM_THREAD_CB_OUTPUT_COMMIT,
551 TDM_THREAD_CB_OUTPUT_VBLANK,
552 TDM_THREAD_CB_OUTPUT_STATUS,
553 TDM_THREAD_CB_OUTPUT_DPMS,
554 TDM_THREAD_CB_PP_DONE,
555 TDM_THREAD_CB_CAPTURE_DONE,
556 TDM_THREAD_CB_VBLANK_SW,
557 TDM_THREAD_CB_NEED_VALIDATE,
558 } tdm_thread_cb_type;
560 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
561 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
562 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
563 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
564 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
565 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
566 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
567 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
568 typedef struct _tdm_thread_cb_need_validate tdm_thread_cb_need_validate;
570 struct _tdm_thread_cb_base {
571 tdm_thread_cb_type type;
575 struct _tdm_thread_cb_output_vblank {
576 tdm_thread_cb_base base;
578 unsigned int sequence;
580 unsigned int tv_usec;
584 struct _tdm_thread_cb_output_status {
585 tdm_thread_cb_base base;
587 tdm_output_conn_status status;
591 struct _tdm_thread_cb_output_dpms {
592 tdm_thread_cb_base base;
594 tdm_output_dpms dpms;
598 struct _tdm_thread_cb_pp_done {
599 tdm_thread_cb_base base;
606 struct _tdm_thread_cb_capture_done {
607 tdm_thread_cb_base base;
608 double capture_stamp;
609 tbm_surface_h buffer;
613 struct _tdm_thread_cb_vblank_sw {
614 tdm_thread_cb_base base;
618 struct _tdm_thread_cb_need_validate {
619 tdm_thread_cb_base base;
620 tdm_private_output *o;
624 tdm_thread_init(tdm_private_loop *private_loop);
626 tdm_thread_deinit(tdm_private_loop *private_loop);
628 tdm_thread_get_fd(tdm_private_loop *private_loop);
630 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
632 tdm_thread_handle_cb(tdm_private_loop *private_loop);
634 tdm_thread_in_display_thread(pid_t tid);
636 tdm_thread_is_running(void);
639 tdm_server_init(tdm_private_loop *private_loop);
641 tdm_server_deinit(tdm_private_loop *private_loop);
643 tdm_server_get_client_name(pid_t pid);
646 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
648 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
650 tdm_helper_get_time(void);
652 extern pthread_mutex_t tdm_mutex_check_lock;
653 extern int tdm_mutex_locked;
654 extern const char *tdm_mutex_lock_func;
655 extern int tdm_mutex_lock_line;
656 extern const char *tdm_mutex_unlock_func;
657 extern int tdm_mutex_unlock_line;
658 extern int tdm_dump_enable;
659 extern char *tdm_debug_dump_dir;
661 #define _pthread_mutex_unlock(l) \
663 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
664 TDM_INFO("mutex unlock"); \
665 pthread_mutex_lock(&tdm_mutex_check_lock); \
666 tdm_mutex_locked = 0; \
667 tdm_mutex_lock_func = NULL; \
668 tdm_mutex_lock_line = 0; \
669 tdm_mutex_unlock_func = __FUNCTION__; \
670 tdm_mutex_unlock_line = __LINE__; \
671 pthread_mutex_unlock(&tdm_mutex_check_lock); \
672 pthread_mutex_unlock(l); \
674 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
675 #define MUTEX_TIMEOUT_SEC 5
676 #define _pthread_mutex_lock(l) \
678 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
679 TDM_INFO("mutex lock"); \
680 struct timespec rtime; \
681 clock_gettime(CLOCK_REALTIME, &rtime); \
682 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
683 if (pthread_mutex_timedlock(l, &rtime)) { \
684 TDM_ERR("Mutex lock failed PID %d", getpid()); \
685 _pthread_mutex_unlock(l); \
688 pthread_mutex_lock(&tdm_mutex_check_lock); \
689 tdm_mutex_locked = 1; \
690 tdm_mutex_lock_func = __FUNCTION__; \
691 tdm_mutex_lock_line = __LINE__; \
692 tdm_mutex_unlock_func = NULL; \
693 tdm_mutex_unlock_line = 0; \
694 pthread_mutex_unlock(&tdm_mutex_check_lock); \
697 #else //TDM_CONFIG_MUTEX_TIMEOUT
698 #define _pthread_mutex_lock(l) \
700 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
701 TDM_INFO("mutex lock"); \
702 pthread_mutex_lock(l); \
703 pthread_mutex_lock(&tdm_mutex_check_lock); \
704 tdm_mutex_locked = 1; \
705 tdm_mutex_lock_func = __FUNCTION__; \
706 tdm_mutex_lock_line = __LINE__; \
707 tdm_mutex_unlock_func = NULL; \
708 tdm_mutex_unlock_line = 0; \
709 pthread_mutex_unlock(&tdm_mutex_check_lock); \
711 #endif //TDM_CONFIG_MUTEX_TIMEOUT
712 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
713 static inline int TDM_MUTEX_IS_LOCKED(void)
716 /* if thread is not running, we don't need to consider mutex things. */
717 if (!tdm_thread_is_running())
719 pthread_mutex_lock(&tdm_mutex_check_lock);
720 ret = (tdm_mutex_locked == 1);
721 pthread_mutex_unlock(&tdm_mutex_check_lock);
725 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
726 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
729 tdm_display_update_output(tdm_private_display *private_display,
730 tdm_output *output_backend, int pipe);
732 tdm_display_enable_debug_module(const char*modules);
734 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
736 tdm_display_enable_path(const char *path);
738 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
740 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
742 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
745 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
748 tdm_handle_need_validate_event(tdm_thread_cb_need_validate *ev);
750 struct argument_details {
760 #endif /* _TDM_PRIVATE_H_ */