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_pp tdm_private_pp;
127 typedef struct _tdm_private_capture tdm_private_capture;
128 typedef struct _tdm_private_loop tdm_private_loop;
129 typedef struct _tdm_private_server tdm_private_server;
130 typedef struct _tdm_private_thread tdm_private_thread;
131 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
132 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
133 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
134 typedef struct _tdm_private_change_handler tdm_private_change_handler;
135 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
137 struct _tdm_private_display {
138 pthread_mutex_t lock;
139 unsigned int init_count;
141 /* backend module info */
143 tdm_backend_module *module_data;
144 tdm_backend_data *bdata;
150 /* backend function */
151 tdm_display_capability capabilities;
152 tdm_func_display func_display;
153 tdm_func_output func_output;
154 tdm_func_layer func_layer;
156 tdm_func_capture func_capture;
158 /* backend capability */
159 tdm_caps_display caps_display;
161 tdm_caps_capture caps_capture;
163 /* output, pp list */
164 struct list_head output_list;
165 struct list_head pp_list;
166 struct list_head capture_list;
170 /* for event handling */
171 tdm_private_loop *private_loop;
174 tdm_output **outputs;
176 /* calling a output commit per a vblank */
177 int commit_per_vblank;
178 tdm_commit_type commit_type;
183 struct _tdm_private_output {
184 struct list_head link;
189 tdm_private_display *private_display;
191 tdm_caps_output caps;
192 tdm_output *output_backend;
195 tdm_output_dpms current_dpms_value;
196 unsigned int waiting_dpms_change;
197 const tdm_output_mode *current_mode;
199 int regist_vblank_cb;
200 int regist_commit_cb;
201 int regist_change_cb;
204 struct list_head layer_list;
205 struct list_head capture_list;
206 struct list_head vblank_handler_list;
207 struct list_head output_commit_handler_list;
209 /* for layer commit */
210 struct list_head layer_commit_handler_list;
211 struct list_head pending_commit_handler_list;
213 int layer_waiting_vblank;
215 /* seperate list for multi-thread*/
216 struct list_head change_handler_list_main;
217 struct list_head change_handler_list_sub;
221 /* TODO: temp solution for handling DPMS things in sub-htread */
222 tdm_event_loop_source *dpms_changed_timer;
225 struct _tdm_private_layer {
226 struct list_head link;
230 tdm_private_display *private_display;
231 tdm_private_output *private_output;
234 tdm_layer *layer_backend;
236 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
237 * And when a layer is committed, it will be moved to committed_buffer.
238 * Finally when a commit handler is called, it will be moved to showing_buffer.
240 tdm_private_layer_buffer *waiting_buffer;
241 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
242 tdm_private_layer_buffer *showing_buffer;
243 tbm_surface_queue_h buffer_queue;
245 struct list_head capture_list;
248 unsigned int committing;
251 unsigned int fps_count;
254 struct _tdm_private_pp {
255 struct list_head link;
259 tdm_private_display *private_display;
263 struct list_head pending_buffer_list;
264 struct list_head buffer_list;
269 tdm_pp_done_handler done_func;
270 void *done_user_data;
273 struct _tdm_private_capture {
274 struct list_head link;
275 struct list_head display_link;
279 tdm_capture_target target;
281 tdm_private_display *private_display;
282 tdm_private_output *private_output;
283 tdm_private_layer *private_layer;
285 tdm_capture *capture_backend;
287 struct list_head pending_buffer_list;
288 struct list_head buffer_list;
290 tdm_info_capture info;
293 tdm_capture_done_handler done_func;
294 void *done_user_data;
298 * Note that we don't need to (un)lock mutex to use this structure. If there is
299 * no TDM thread, all TDM resources are protected by private_display's mutex.
300 * If there is a TDM thread, this struct will be used only in a TDM thread.
301 * So, we don't need to protect this structure by mutex. Not thread-safe.
303 struct _tdm_private_loop {
304 /* TDM uses wl_event_loop to handle various event sources including the TDM
307 struct wl_display *wl_display;
308 struct wl_event_loop *wl_loop;
311 tdm_event_loop_source *backend_source;
313 /* In event loop, all resources are accessed by this dpy.
315 * - DO NOT include other private structure in this structure because this
316 * struct is not protected by mutex.
320 /* for handling TDM client requests */
321 tdm_private_server *private_server;
323 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
324 * private_thread is NULL.
326 tdm_private_thread *private_thread;
329 struct _tdm_private_vblank_handler {
330 struct list_head link;
332 tdm_private_output *private_output;
335 tdm_output_vblank_handler func;
341 struct _tdm_private_output_commit_handler {
342 struct list_head link;
344 tdm_private_output *private_output;
345 tdm_output_commit_handler func;
351 struct _tdm_private_layer_commit_handler {
352 struct list_head link;
354 tdm_private_layer *private_layer;
355 tdm_layer_commit_handler func;
358 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
361 struct _tdm_private_change_handler {
362 struct list_head link;
364 tdm_private_output *private_output;
365 tdm_output_change_handler func;
371 struct _tdm_private_layer_buffer {
372 tbm_surface_h buffer;
373 struct list_head link;
376 typedef struct _tdm_buffer_info {
377 tbm_surface_h buffer;
379 /* ref_count for backend */
380 int backend_ref_count;
382 struct list_head release_funcs;
383 struct list_head destroy_funcs;
385 struct list_head *list;
386 struct list_head link;
389 typedef struct _tdm_pp_private_buffer {
392 struct list_head link;
393 struct list_head commit_link;
394 } tdm_pp_private_buffer;
396 typedef struct _tdm_capture_private_buffer {
397 tbm_surface_h buffer;
398 struct list_head link;
399 struct list_head commit_link;
400 } tdm_capture_private_buffer;
403 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
406 tdm_display_find_output_stamp(tdm_private_display *private_display, double stamp);
408 tdm_pp_find_stamp(tdm_private_display *private_display, double stamp);
409 tdm_private_capture *
410 tdm_capture_find_stamp(tdm_private_display *private_display, double stamp);
413 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
414 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
416 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
417 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
419 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
422 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
425 tdm_output_wait_vblank_add_front(tdm_output *output, int interval, int sync,
426 tdm_output_vblank_handler func, void *user_data);
428 tdm_output_commit_internal(tdm_output *output, int sync, tdm_output_commit_handler func, void *user_data);
430 tdm_output_get_dpms_internal(tdm_output *output, tdm_output_dpms *dpms_value);
433 tdm_output_remove_vblank_handler_internal(tdm_output *output, tdm_output_vblank_handler func, void *user_data);
435 tdm_output_remove_commit_handler_internal(tdm_output *output, tdm_output_commit_handler func, void *user_data);
437 tdm_layer_remove_commit_handler_internal(tdm_layer *layer, tdm_layer_commit_handler func, void *user_data);
440 tdm_layer_committed(tdm_private_layer *private_layer, tdm_private_layer_buffer **committed_buffer);
443 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
446 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
449 tdm_vblank_cb_vblank_SW(tdm_vblank *vblank, double vblank_stamp);
451 tdm_vblank_set_add_front(tdm_vblank *vblank, unsigned int add_front);
453 tdm_vblank_set_resource(tdm_vblank *vblank, struct wl_resource *resource);
455 tdm_vblank_set_client_vblank_fps(unsigned int pid, const char *name, unsigned int fps);
457 tdm_vblank_get_vblank_list_information(tdm_display *dpy, char *reply, int *len);
460 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
461 struct list_head *change_handler_list,
462 tdm_output_change_type type,
464 int no_check_thread_id);
467 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
469 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
471 tdm_private_capture *
472 tdm_capture_create_output_internal(tdm_private_output *private_output,
474 tdm_private_capture *
475 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
478 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
480 /* utility buffer functions for private */
482 tdm_buffer_get_info(tbm_surface_h buffer);
484 tdm_buffer_list_get_first_entry(struct list_head *list);
486 tdm_buffer_list_dump(struct list_head *list);
489 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
491 /* event functions for private */
493 tdm_event_loop_init(tdm_private_display *private_display);
495 tdm_event_loop_deinit(tdm_private_display *private_display);
497 tdm_event_loop_stop(tdm_private_display *private_display);
499 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
501 tdm_event_loop_get_fd(tdm_private_display *private_display);
503 tdm_event_loop_dispatch(tdm_private_display *private_display);
505 tdm_event_loop_flush(tdm_private_display *private_display);
507 tdm_event_loop_trace_enable(tdm_private_display *private_display, unsigned int enable);
511 TDM_THREAD_CB_OUTPUT_COMMIT,
512 TDM_THREAD_CB_OUTPUT_VBLANK,
513 TDM_THREAD_CB_OUTPUT_STATUS,
514 TDM_THREAD_CB_OUTPUT_DPMS,
515 TDM_THREAD_CB_PP_DONE,
516 TDM_THREAD_CB_CAPTURE_DONE,
517 TDM_THREAD_CB_VBLANK_SW,
518 } tdm_thread_cb_type;
520 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
521 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
522 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
523 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
524 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
525 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
526 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
527 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
529 struct _tdm_thread_cb_base {
530 tdm_thread_cb_type type;
534 struct _tdm_thread_cb_output_vblank {
535 tdm_thread_cb_base base;
537 unsigned int sequence;
539 unsigned int tv_usec;
543 struct _tdm_thread_cb_output_status {
544 tdm_thread_cb_base base;
546 tdm_output_conn_status status;
550 struct _tdm_thread_cb_output_dpms {
551 tdm_thread_cb_base base;
553 tdm_output_dpms dpms;
557 struct _tdm_thread_cb_pp_done {
558 tdm_thread_cb_base base;
565 struct _tdm_thread_cb_capture_done {
566 tdm_thread_cb_base base;
567 double capture_stamp;
568 tbm_surface_h buffer;
572 struct _tdm_thread_cb_vblank_sw {
573 tdm_thread_cb_base base;
578 tdm_thread_init(tdm_private_loop *private_loop);
580 tdm_thread_deinit(tdm_private_loop *private_loop);
582 tdm_thread_get_fd(tdm_private_loop *private_loop);
584 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
586 tdm_thread_handle_cb(tdm_private_loop *private_loop);
588 tdm_thread_in_display_thread(pid_t tid);
590 tdm_thread_is_running(void);
593 tdm_server_init(tdm_private_loop *private_loop);
595 tdm_server_deinit(tdm_private_loop *private_loop);
597 tdm_server_get_client_name(pid_t pid);
600 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
602 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
604 tdm_helper_get_time(void);
606 extern pthread_mutex_t tdm_mutex_check_lock;
607 extern int tdm_mutex_locked;
608 extern const char *tdm_mutex_lock_func;
609 extern int tdm_mutex_lock_line;
610 extern const char *tdm_mutex_unlock_func;
611 extern int tdm_mutex_unlock_line;
612 extern int tdm_dump_enable;
613 extern char *tdm_debug_dump_dir;
615 #define _pthread_mutex_unlock(l) \
617 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
618 TDM_INFO("mutex unlock"); \
619 pthread_mutex_lock(&tdm_mutex_check_lock); \
620 tdm_mutex_locked = 0; \
621 tdm_mutex_lock_func = NULL; \
622 tdm_mutex_lock_line = 0; \
623 tdm_mutex_unlock_func = __FUNCTION__; \
624 tdm_mutex_unlock_line = __LINE__; \
625 pthread_mutex_unlock(&tdm_mutex_check_lock); \
626 pthread_mutex_unlock(l); \
628 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
629 #define MUTEX_TIMEOUT_SEC 5
630 #define _pthread_mutex_lock(l) \
632 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
633 TDM_INFO("mutex lock"); \
634 struct timespec rtime; \
635 clock_gettime(CLOCK_REALTIME, &rtime); \
636 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
637 if (pthread_mutex_timedlock(l, &rtime)) { \
638 TDM_ERR("Mutex lock failed PID %d", getpid()); \
639 _pthread_mutex_unlock(l); \
642 pthread_mutex_lock(&tdm_mutex_check_lock); \
643 tdm_mutex_locked = 1; \
644 tdm_mutex_lock_func = __FUNCTION__; \
645 tdm_mutex_lock_line = __LINE__; \
646 tdm_mutex_unlock_func = NULL; \
647 tdm_mutex_unlock_line = 0; \
648 pthread_mutex_unlock(&tdm_mutex_check_lock); \
651 #else //TDM_CONFIG_MUTEX_TIMEOUT
652 #define _pthread_mutex_lock(l) \
654 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
655 TDM_INFO("mutex lock"); \
656 pthread_mutex_lock(l); \
657 pthread_mutex_lock(&tdm_mutex_check_lock); \
658 tdm_mutex_locked = 1; \
659 tdm_mutex_lock_func = __FUNCTION__; \
660 tdm_mutex_lock_line = __LINE__; \
661 tdm_mutex_unlock_func = NULL; \
662 tdm_mutex_unlock_line = 0; \
663 pthread_mutex_unlock(&tdm_mutex_check_lock); \
665 #endif //TDM_CONFIG_MUTEX_TIMEOUT
666 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
667 static inline int TDM_MUTEX_IS_LOCKED(void)
670 /* if thread is not running, we don't need to consider mutex things. */
671 if (!tdm_thread_is_running())
673 pthread_mutex_lock(&tdm_mutex_check_lock);
674 ret = (tdm_mutex_locked == 1);
675 pthread_mutex_unlock(&tdm_mutex_check_lock);
679 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
680 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
683 tdm_display_update_output(tdm_private_display *private_display,
684 tdm_output *output_backend, int pipe);
686 tdm_display_enable_debug_module(const char*modules);
688 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
690 tdm_display_enable_path(const char *path);
692 tdm_display_enable_ttrace_vblank(tdm_display *dpy, tdm_output *output, int enable);
694 tdm_display_enable_commit_per_vblank(tdm_private_display *private_display, int enable);
696 tdm_display_enable_fps(tdm_private_display *private_display, int enable);
699 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
702 struct argument_details {
712 #endif /* _TDM_PRIVATE_H_ */