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 <tbm_bufmgr.h>
58 #include <tbm_surface_queue.h>
60 #include "tdm_backend.h"
63 #include "tdm_macro.h"
73 * @brief The private header file for a frontend library
78 TDM_DEBUG_BUFFER = (1 << 0),
79 TDM_DEBUG_MUTEX = (1 << 1),
80 TDM_DEBUG_THREAD = (1 << 2),
81 TDM_DEBUG_SERVER = (1 << 3),
82 TDM_DEBUG_VBLANK = (1 << 4),
85 extern int tdm_debug_module;
86 extern int tdm_debug_dump;
90 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
91 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
93 #define TDM_TRACE_BEGIN(NAME)
94 #define TDM_TRACE_END()
98 TDM_CAPTURE_TARGET_OUTPUT,
99 TDM_CAPTURE_TARGET_LAYER,
100 } tdm_capture_target;
103 TDM_DUMP_FLAG_LAYER = (1 << 0),
104 TDM_DUMP_FLAG_PP = (1 << 1),
105 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
108 #define TDM_DUMP_DIR "/tmp"
110 typedef struct _tdm_private_display tdm_private_display;
111 typedef struct _tdm_private_output tdm_private_output;
112 typedef struct _tdm_private_layer tdm_private_layer;
113 typedef struct _tdm_private_pp tdm_private_pp;
114 typedef struct _tdm_private_capture tdm_private_capture;
115 typedef struct _tdm_private_loop tdm_private_loop;
116 typedef struct _tdm_private_server tdm_private_server;
117 typedef struct _tdm_private_thread tdm_private_thread;
118 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
119 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
120 typedef struct _tdm_private_change_handler tdm_private_change_handler;
122 struct _tdm_private_display {
123 pthread_mutex_t lock;
124 unsigned int init_count;
126 /* backend module info */
128 tdm_backend_module *module_data;
129 tdm_backend_data *bdata;
135 /* backend function */
136 tdm_display_capability capabilities;
137 tdm_func_display func_display;
138 tdm_func_output func_output;
139 tdm_func_layer func_layer;
141 tdm_func_capture func_capture;
143 /* backend capability */
144 tdm_caps_display caps_display;
146 tdm_caps_capture caps_capture;
148 /* output, pp list */
149 struct list_head output_list;
150 struct list_head pp_list;
151 struct list_head capture_list;
155 /* for event handling */
156 tdm_private_loop *private_loop;
159 tdm_output **outputs;
162 struct _tdm_private_output {
163 struct list_head link;
168 tdm_private_display *private_display;
170 tdm_caps_output caps;
171 tdm_output *output_backend;
174 tdm_output_dpms current_dpms_value;
175 const tdm_output_mode *current_mode;
177 int regist_vblank_cb;
178 int regist_commit_cb;
179 int regist_change_cb;
182 struct list_head layer_list;
183 struct list_head capture_list;
184 struct list_head vblank_handler_list;
185 struct list_head commit_handler_list;
187 /* seperate list for multi-thread*/
188 struct list_head change_handler_list_main;
189 struct list_head change_handler_list_sub;
193 /* TODO: temp solution for handling DPMS things in sub-htread */
194 tdm_event_loop_source *dpms_changed_timer;
197 struct _tdm_private_layer {
198 struct list_head link;
202 tdm_private_display *private_display;
203 tdm_private_output *private_output;
206 tdm_layer *layer_backend;
208 tbm_surface_h pending_buffer;
209 tbm_surface_h waiting_buffer;
210 tbm_surface_h showing_buffer;
211 tbm_surface_queue_h buffer_queue;
213 struct list_head capture_list;
218 struct _tdm_private_pp {
219 struct list_head link;
223 tdm_private_display *private_display;
227 struct list_head pending_buffer_list;
228 struct list_head buffer_list;
233 tdm_pp_done_handler done_func;
234 void *done_user_data;
237 struct _tdm_private_capture {
238 struct list_head link;
239 struct list_head display_link;
243 tdm_capture_target target;
245 tdm_private_display *private_display;
246 tdm_private_output *private_output;
247 tdm_private_layer *private_layer;
249 tdm_capture *capture_backend;
251 struct list_head pending_buffer_list;
252 struct list_head buffer_list;
254 tdm_info_capture info;
257 tdm_capture_done_handler done_func;
258 void *done_user_data;
262 * Note that we don't need to (un)lock mutex to use this structure. If there is
263 * no TDM thread, all TDM resources are protected by private_display's mutex.
264 * If there is a TDM thread, this struct will be used only in a TDM thread.
265 * So, we don't need to protect this structure by mutex. Not thread-safe.
267 struct _tdm_private_loop {
268 /* TDM uses wl_event_loop to handle various event sources including the TDM
271 struct wl_display *wl_display;
272 struct wl_event_loop *wl_loop;
275 tdm_event_loop_source *backend_source;
277 /* In event loop, all resources are accessed by this dpy.
279 * - DO NOT include other private structure in this structure because this
280 * struct is not protected by mutex.
284 /* for handling TDM client requests */
285 tdm_private_server *private_server;
287 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
288 * private_thread is NULL.
290 tdm_private_thread *private_thread;
293 struct _tdm_private_vblank_handler {
294 struct list_head link;
296 tdm_private_output *private_output;
297 tdm_output_vblank_handler func;
303 struct _tdm_private_commit_handler {
304 struct list_head link;
306 tdm_private_output *private_output;
307 tdm_output_commit_handler func;
313 struct _tdm_private_change_handler {
314 struct list_head link;
316 tdm_private_output *private_output;
317 tdm_output_change_handler func;
323 typedef struct _tdm_buffer_info {
324 tbm_surface_h buffer;
326 /* ref_count for backend */
327 int backend_ref_count;
329 struct list_head release_funcs;
330 struct list_head destroy_funcs;
332 struct list_head *list;
333 struct list_head link;
336 typedef struct _tdm_pp_private_buffer {
339 struct list_head link;
340 struct list_head commit_link;
341 } tdm_pp_private_buffer;
344 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
347 tdm_display_find_output_stamp(tdm_private_display *private_display,
348 unsigned long stamp);
350 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
351 tdm_private_capture *
352 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
355 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
356 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
358 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
359 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
361 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
364 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
367 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
370 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
374 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
375 struct list_head *change_handler_list,
376 tdm_output_change_type type,
378 int no_check_thread_id);
381 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
383 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
385 tdm_private_capture *
386 tdm_capture_create_output_internal(tdm_private_output *private_output,
388 tdm_private_capture *
389 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
392 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
394 /* utility buffer functions for private */
396 tdm_buffer_get_info(tbm_surface_h buffer);
398 tdm_buffer_list_get_first_entry(struct list_head *list);
400 tdm_buffer_list_dump(struct list_head *list);
403 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
405 /* event functions for private */
407 tdm_event_loop_init(tdm_private_display *private_display);
409 tdm_event_loop_deinit(tdm_private_display *private_display);
411 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
413 tdm_event_loop_get_fd(tdm_private_display *private_display);
415 tdm_event_loop_dispatch(tdm_private_display *private_display);
417 tdm_event_loop_flush(tdm_private_display *private_display);
421 TDM_THREAD_CB_OUTPUT_COMMIT,
422 TDM_THREAD_CB_OUTPUT_VBLANK,
423 TDM_THREAD_CB_OUTPUT_STATUS,
424 TDM_THREAD_CB_OUTPUT_DPMS,
425 TDM_THREAD_CB_PP_DONE,
426 TDM_THREAD_CB_CAPTURE_DONE,
427 } tdm_thread_cb_type;
429 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
430 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
431 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
432 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
433 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
434 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
435 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
437 struct _tdm_thread_cb_base {
438 tdm_thread_cb_type type;
442 struct _tdm_thread_cb_output_vblank {
443 tdm_thread_cb_base base;
444 unsigned long output_stamp;
445 unsigned int sequence;
447 unsigned int tv_usec;
451 struct _tdm_thread_cb_output_status {
452 tdm_thread_cb_base base;
453 unsigned long output_stamp;
454 tdm_output_conn_status status;
458 struct _tdm_thread_cb_output_dpms {
459 tdm_thread_cb_base base;
460 unsigned long output_stamp;
461 tdm_output_dpms dpms;
465 struct _tdm_thread_cb_pp_done {
466 tdm_thread_cb_base base;
467 unsigned long pp_stamp;
473 struct _tdm_thread_cb_capture_done {
474 tdm_thread_cb_base base;
475 unsigned long capture_stamp;
476 tbm_surface_h buffer;
481 tdm_thread_init(tdm_private_loop *private_loop);
483 tdm_thread_deinit(tdm_private_loop *private_loop);
485 tdm_thread_get_fd(tdm_private_loop *private_loop);
487 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
489 tdm_thread_handle_cb(tdm_private_loop *private_loop);
491 tdm_thread_in_display_thread(pid_t tid);
493 tdm_thread_is_running(void);
496 tdm_server_init(tdm_private_loop *private_loop);
498 tdm_server_deinit(tdm_private_loop *private_loop);
501 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
503 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
505 tdm_helper_get_time_in_millis(void);
507 tdm_helper_get_time_in_micros(void);
509 extern pthread_mutex_t tdm_mutex_check_lock;
510 extern int tdm_mutex_locked;
511 extern int tdm_dump_enable;
512 extern char *tdm_debug_dump_dir;
514 #define _pthread_mutex_unlock(l) \
516 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
517 TDM_INFO("mutex unlock"); \
518 pthread_mutex_lock(&tdm_mutex_check_lock); \
519 tdm_mutex_locked = 0; \
520 pthread_mutex_unlock(&tdm_mutex_check_lock); \
521 pthread_mutex_unlock(l); \
523 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
524 #define MUTEX_TIMEOUT_SEC 5
525 #define _pthread_mutex_lock(l) \
527 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
528 TDM_INFO("mutex lock"); \
529 struct timespec rtime; \
530 clock_gettime(CLOCK_REALTIME, &rtime); \
531 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
532 if (pthread_mutex_timedlock(l, &rtime)) { \
533 TDM_ERR("Mutex lock failed PID %d", getpid()); \
534 _pthread_mutex_unlock(l); \
537 pthread_mutex_lock(&tdm_mutex_check_lock); \
538 tdm_mutex_locked = 1; \
539 pthread_mutex_unlock(&tdm_mutex_check_lock); \
542 #else //TDM_CONFIG_MUTEX_TIMEOUT
543 #define _pthread_mutex_lock(l) \
545 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
546 TDM_INFO("mutex lock"); \
547 pthread_mutex_lock(l); \
548 pthread_mutex_lock(&tdm_mutex_check_lock); \
549 tdm_mutex_locked = 1; \
550 pthread_mutex_unlock(&tdm_mutex_check_lock); \
552 #endif //TDM_CONFIG_MUTEX_TIMEOUT
553 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
554 static inline int TDM_MUTEX_IS_LOCKED(void)
557 /* if thread is not running, we don't need to consider mutex things. */
558 if (!tdm_thread_is_running())
560 pthread_mutex_lock(&tdm_mutex_check_lock);
561 ret = (tdm_mutex_locked == 1);
562 pthread_mutex_unlock(&tdm_mutex_check_lock);
566 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
567 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
570 tdm_display_update_output(tdm_private_display *private_display,
571 tdm_output *output_backend, int pipe);
573 tdm_display_enable_debug_module(const char*modules);
575 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
577 tdm_display_enable_path(const char *path);
580 * @brief The tdm vblank object
582 typedef void tdm_vblank;
584 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
585 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
588 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
590 tdm_vblank_destroy(tdm_vblank *vblank);
592 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
594 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
596 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
598 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec, unsigned int interval, tdm_vblank_handler func, void *user_data);
601 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
607 #endif /* _TDM_PRIVATE_H_ */