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),
88 extern int tdm_debug_module;
89 extern int tdm_debug_dump;
93 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
94 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
95 #define TDM_TRACE_COUNT(NAME, COUNT) traceCounter(TTRACE_TAG_GRAPHICS, COUNT, "TDM:"#NAME)
96 #define TDM_TRACE_MARK(NAME) traceMark(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
98 #define TDM_TRACE_BEGIN(NAME)
99 #define TDM_TRACE_END()
100 #define TDM_TRACE_COUNT(NAME, COUNT)
101 #define TDM_TRACE_MARK(NAME)
105 TDM_CAPTURE_TARGET_OUTPUT,
106 TDM_CAPTURE_TARGET_LAYER,
107 } tdm_capture_target;
110 TDM_DUMP_FLAG_LAYER = (1 << 0),
111 TDM_DUMP_FLAG_PP = (1 << 1),
112 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
115 #define TDM_DUMP_DIR "/tmp"
118 TDM_COMMIT_TYPE_NONE,
119 TDM_COMMIT_TYPE_OUTPUT,
120 TDM_COMMIT_TYPE_LAYER,
123 typedef struct _tdm_private_display tdm_private_display;
124 typedef struct _tdm_private_output tdm_private_output;
125 typedef struct _tdm_private_layer tdm_private_layer;
126 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
127 typedef struct _tdm_private_pp tdm_private_pp;
128 typedef struct _tdm_private_capture tdm_private_capture;
129 typedef struct _tdm_private_loop tdm_private_loop;
130 typedef struct _tdm_private_server tdm_private_server;
131 typedef struct _tdm_private_thread tdm_private_thread;
132 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
133 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
134 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
135 typedef struct _tdm_private_change_handler tdm_private_change_handler;
136 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
138 struct _tdm_private_display {
139 pthread_mutex_t lock;
140 unsigned int init_count;
142 /* backend module info */
144 tdm_backend_module *module_data;
145 tdm_backend_data *bdata;
151 /* backend function */
152 tdm_display_capability capabilities;
153 tdm_func_display func_display;
154 tdm_func_output func_output;
155 tdm_func_layer func_layer;
156 tdm_func_hwc_window func_hwc_window;
158 tdm_func_capture func_capture;
160 /* backend capability */
161 tdm_caps_display caps_display;
163 tdm_caps_capture caps_capture;
165 /* output, pp list */
166 struct list_head output_list;
167 struct list_head pp_list;
168 struct list_head capture_list;
172 /* for event handling */
173 tdm_private_loop *private_loop;
176 tdm_output **outputs;
178 /* calling a output commit per a vblank */
179 int commit_per_vblank;
180 tdm_commit_type commit_type;
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 const tdm_output_mode *current_mode;
202 int regist_vblank_cb;
203 int regist_commit_cb;
204 int regist_change_cb;
207 struct list_head layer_list;
208 struct list_head hwc_window_list;
209 struct list_head capture_list;
210 struct list_head vblank_handler_list;
211 struct list_head output_commit_handler_list;
213 /* for layer commit */
214 struct list_head layer_commit_handler_list;
215 struct list_head pending_commit_handler_list;
217 int layer_waiting_vblank;
219 /* seperate list for multi-thread*/
220 struct list_head change_handler_list_main;
221 struct list_head change_handler_list_sub;
225 /* TODO: temp solution for handling DPMS things in sub-htread */
226 tdm_event_loop_source *dpms_changed_timer;
229 struct _tdm_private_layer {
230 struct list_head link;
234 tdm_private_display *private_display;
235 tdm_private_output *private_output;
238 tdm_layer *layer_backend;
240 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
241 * And when a layer is committed, it will be moved to committed_buffer.
242 * Finally when a commit handler is called, it will be moved to showing_buffer.
244 tdm_private_layer_buffer *waiting_buffer;
245 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
246 tdm_private_layer_buffer *showing_buffer;
247 tbm_surface_queue_h buffer_queue;
249 struct list_head capture_list;
252 unsigned int committing;
255 unsigned int fps_count;
258 struct _tdm_private_hwc_window {
259 struct list_head link;
263 tdm_private_display *private_display;
264 tdm_private_output *private_output;
266 tdm_hwc_window *hwc_window_backend;
270 struct _tdm_private_pp {
271 struct list_head link;
275 tdm_private_display *private_display;
279 struct list_head pending_buffer_list;
280 struct list_head buffer_list;
285 tdm_pp_done_handler done_func;
286 void *done_user_data;
289 struct _tdm_private_capture {
290 struct list_head link;
291 struct list_head display_link;
295 tdm_capture_target target;
297 tdm_private_display *private_display;
298 tdm_private_output *private_output;
299 tdm_private_layer *private_layer;
301 tdm_capture *capture_backend;
303 struct list_head pending_buffer_list;
304 struct list_head buffer_list;
306 tdm_info_capture info;
309 tdm_capture_done_handler done_func;
310 void *done_user_data;
314 * Note that we don't need to (un)lock mutex to use this structure. If there is
315 * no TDM thread, all TDM resources are protected by private_display's mutex.
316 * If there is a TDM thread, this struct will be used only in a TDM thread.
317 * So, we don't need to protect this structure by mutex. Not thread-safe.
319 struct _tdm_private_loop {
320 /* TDM uses wl_event_loop to handle various event sources including the TDM
323 struct wl_display *wl_display;
324 struct wl_event_loop *wl_loop;
327 tdm_event_loop_source *backend_source;
329 /* In event loop, all resources are accessed by this dpy.
331 * - DO NOT include other private structure in this structure because this
332 * struct is not protected by mutex.
336 /* for handling TDM client requests */
337 tdm_private_server *private_server;
339 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
340 * private_thread is NULL.
342 tdm_private_thread *private_thread;
345 struct _tdm_private_vblank_handler {
346 struct list_head link;
348 tdm_private_output *private_output;
351 tdm_output_vblank_handler func;
357 struct _tdm_private_output_commit_handler {
358 struct list_head link;
360 tdm_private_output *private_output;
361 tdm_output_commit_handler func;
367 struct _tdm_private_layer_commit_handler {
368 struct list_head link;
370 tdm_private_layer *private_layer;
371 tdm_layer_commit_handler func;
374 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
377 struct _tdm_private_change_handler {
378 struct list_head link;
380 tdm_private_output *private_output;
381 tdm_output_change_handler func;
387 struct _tdm_private_layer_buffer {
388 tbm_surface_h buffer;
389 struct list_head link;
392 typedef struct _tdm_buffer_info {
393 tbm_surface_h buffer;
395 /* ref_count for backend */
396 int backend_ref_count;
398 struct list_head release_funcs;
399 struct list_head destroy_funcs;
401 struct list_head *list;
402 struct list_head link;
405 typedef struct _tdm_pp_private_buffer {
408 struct list_head link;
409 struct list_head commit_link;
410 } tdm_pp_private_buffer;
412 typedef struct _tdm_capture_private_buffer {
413 tbm_surface_h buffer;
414 struct list_head link;
415 struct list_head commit_link;
416 } tdm_capture_private_buffer;
419 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
422 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
424 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
425 tdm_private_capture *
426 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
429 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
430 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
432 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
433 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
435 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
438 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
441 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
442 tdm_output_vblank_handler func, void *user_data);
444 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
446 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
449 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
451 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
453 tdm_layer_remove_commit_handler_internal(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
456 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
459 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
462 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
465 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
467 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
469 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
471 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
473 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
476 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
477 struct list_head *change_handler_list,
478 tdm_output_change_type type,
480 int no_check_thread_id);
483 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
485 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
488 tdm_hwc_window_create_internal(tdm_private_output *private_output, tdm_error *error);
490 tdm_hwc_window_destroy_internal(tdm_private_hwc_window * private_hwc_window);
492 tdm_private_capture *
493 tdm_capture_create_output_internal(tdm_private_output *private_output,
495 tdm_private_capture *
496 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
499 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
501 /* utility buffer functions for private */
503 tdm_buffer_get_info(tbm_surface_h buffer);
505 tdm_buffer_list_get_first_entry(struct list_head *list);
507 tdm_buffer_list_dump(struct list_head *list);
510 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
512 /* event functions for private */
514 tdm_event_loop_init(tdm_private_display *private_display);
516 tdm_event_loop_deinit(tdm_private_display *private_display);
518 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
520 tdm_event_loop_get_fd(tdm_private_display *private_display);
522 tdm_event_loop_dispatch(tdm_private_display *private_display);
524 tdm_event_loop_flush(tdm_private_display *private_display);
526 tdm_event_loop_trace_enable(tdm_private_display *private_display, unsigned int enable);
530 TDM_THREAD_CB_OUTPUT_COMMIT,
531 TDM_THREAD_CB_OUTPUT_VBLANK,
532 TDM_THREAD_CB_OUTPUT_STATUS,
533 TDM_THREAD_CB_OUTPUT_DPMS,
534 TDM_THREAD_CB_PP_DONE,
535 TDM_THREAD_CB_CAPTURE_DONE,
536 TDM_THREAD_CB_VBLANK_SW,
537 } tdm_thread_cb_type;
539 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
540 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
541 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
542 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
543 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
544 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
545 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
546 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
548 struct _tdm_thread_cb_base {
549 tdm_thread_cb_type type;
553 struct _tdm_thread_cb_output_vblank {
554 tdm_thread_cb_base base;
556 unsigned int sequence;
558 unsigned int tv_usec;
562 struct _tdm_thread_cb_output_status {
563 tdm_thread_cb_base base;
565 tdm_output_conn_status status;
569 struct _tdm_thread_cb_output_dpms {
570 tdm_thread_cb_base base;
572 tdm_output_dpms dpms;
576 struct _tdm_thread_cb_pp_done {
577 tdm_thread_cb_base base;
584 struct _tdm_thread_cb_capture_done {
585 tdm_thread_cb_base base;
586 double capture_stamp;
587 tbm_surface_h buffer;
591 struct _tdm_thread_cb_vblank_sw {
592 tdm_thread_cb_base base;
597 tdm_thread_init(tdm_private_loop *private_loop);
599 tdm_thread_deinit(tdm_private_loop *private_loop);
601 tdm_thread_get_fd(tdm_private_loop *private_loop);
603 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
605 tdm_thread_handle_cb(tdm_private_loop *private_loop);
607 tdm_thread_in_display_thread(pid_t tid);
609 tdm_thread_is_running(void);
612 tdm_server_init(tdm_private_loop *private_loop);
614 tdm_server_deinit(tdm_private_loop *private_loop);
616 tdm_server_get_client_name(pid_t pid);
619 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
621 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
623 tdm_helper_get_time(void);
625 extern pthread_mutex_t tdm_mutex_check_lock;
626 extern int tdm_mutex_locked;
627 extern const char *tdm_mutex_lock_func;
628 extern int tdm_mutex_lock_line;
629 extern const char *tdm_mutex_unlock_func;
630 extern int tdm_mutex_unlock_line;
631 extern int tdm_dump_enable;
632 extern char *tdm_debug_dump_dir;
634 #define _pthread_mutex_unlock(l) \
636 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
637 TDM_INFO("mutex unlock"); \
638 pthread_mutex_lock(&tdm_mutex_check_lock); \
639 tdm_mutex_locked = 0; \
640 tdm_mutex_lock_func = NULL; \
641 tdm_mutex_lock_line = 0; \
642 tdm_mutex_unlock_func = __FUNCTION__; \
643 tdm_mutex_unlock_line = __LINE__; \
644 pthread_mutex_unlock(&tdm_mutex_check_lock); \
645 pthread_mutex_unlock(l); \
647 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
648 #define MUTEX_TIMEOUT_SEC 5
649 #define _pthread_mutex_lock(l) \
651 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
652 TDM_INFO("mutex lock"); \
653 struct timespec rtime; \
654 clock_gettime(CLOCK_REALTIME, &rtime); \
655 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
656 if (pthread_mutex_timedlock(l, &rtime)) { \
657 TDM_ERR("Mutex lock failed PID %d", getpid()); \
658 _pthread_mutex_unlock(l); \
661 pthread_mutex_lock(&tdm_mutex_check_lock); \
662 tdm_mutex_locked = 1; \
663 tdm_mutex_lock_func = __FUNCTION__; \
664 tdm_mutex_lock_line = __LINE__; \
665 tdm_mutex_unlock_func = NULL; \
666 tdm_mutex_unlock_line = 0; \
667 pthread_mutex_unlock(&tdm_mutex_check_lock); \
670 #else //TDM_CONFIG_MUTEX_TIMEOUT
671 #define _pthread_mutex_lock(l) \
673 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
674 TDM_INFO("mutex lock"); \
675 pthread_mutex_lock(l); \
676 pthread_mutex_lock(&tdm_mutex_check_lock); \
677 tdm_mutex_locked = 1; \
678 tdm_mutex_lock_func = __FUNCTION__; \
679 tdm_mutex_lock_line = __LINE__; \
680 tdm_mutex_unlock_func = NULL; \
681 tdm_mutex_unlock_line = 0; \
682 pthread_mutex_unlock(&tdm_mutex_check_lock); \
684 #endif //TDM_CONFIG_MUTEX_TIMEOUT
685 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
686 static inline int TDM_MUTEX_IS_LOCKED(void)
689 /* if thread is not running, we don't need to consider mutex things. */
690 if (!tdm_thread_is_running())
692 pthread_mutex_lock(&tdm_mutex_check_lock);
693 ret = (tdm_mutex_locked == 1);
694 pthread_mutex_unlock(&tdm_mutex_check_lock);
698 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
699 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
702 tdm_display_update_output(tdm_private_display *private_display,
703 tdm_output *output_backend, int pipe);
705 tdm_display_enable_debug_module(const char*modules);
707 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
709 tdm_display_enable_path(const char *path);
711 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
713 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
715 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
718 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
722 #define TDM_WAYLAND_LOGGER ((WAYLAND_VERSION_MAJOR == 1) && (WAYLAND_VERSION_MINOR > 11))
724 #if !TDM_WAYLAND_LOGGER
725 #ifndef WL_CLOSURE_MAX_ARGS
726 #define WL_CLOSURE_MAX_ARGS 20
731 const struct wl_message *message;
734 union wl_argument args[WL_CLOSURE_MAX_ARGS];
736 struct wl_proxy *proxy;
737 struct wl_array extra[0];
739 #endif /* TDM_WAYLAND_LOGGER */
741 struct argument_details {
751 #endif /* _TDM_PRIVATE_H_ */