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;
176 int regist_vblank_cb;
177 int regist_commit_cb;
178 int regist_change_cb;
181 struct list_head layer_list;
182 struct list_head capture_list;
183 struct list_head vblank_handler_list;
184 struct list_head commit_handler_list;
186 /* seperate list for multi-thread*/
187 struct list_head change_handler_list_main;
188 struct list_head change_handler_list_sub;
192 /* TODO: temp solution for handling DPMS things in sub-htread */
193 tdm_event_loop_source *dpms_changed_timer;
196 struct _tdm_private_layer {
197 struct list_head link;
201 tdm_private_display *private_display;
202 tdm_private_output *private_output;
205 tdm_layer *layer_backend;
207 tbm_surface_h pending_buffer;
208 tbm_surface_h waiting_buffer;
209 tbm_surface_h showing_buffer;
210 tbm_surface_queue_h buffer_queue;
212 struct list_head capture_list;
217 struct _tdm_private_pp {
218 struct list_head link;
222 tdm_private_display *private_display;
226 struct list_head pending_buffer_list;
227 struct list_head buffer_list;
232 tdm_pp_done_handler done_func;
233 void *done_user_data;
236 struct _tdm_private_capture {
237 struct list_head link;
238 struct list_head display_link;
242 tdm_capture_target target;
244 tdm_private_display *private_display;
245 tdm_private_output *private_output;
246 tdm_private_layer *private_layer;
248 tdm_capture *capture_backend;
250 struct list_head pending_buffer_list;
251 struct list_head buffer_list;
253 tdm_info_capture info;
256 tdm_capture_done_handler done_func;
257 void *done_user_data;
261 * Note that we don't need to (un)lock mutex to use this structure. If there is
262 * no TDM thread, all TDM resources are protected by private_display's mutex.
263 * If there is a TDM thread, this struct will be used only in a TDM thread.
264 * So, we don't need to protect this structure by mutex. Not thread-safe.
266 struct _tdm_private_loop {
267 /* TDM uses wl_event_loop to handle various event sources including the TDM
270 struct wl_display *wl_display;
271 struct wl_event_loop *wl_loop;
274 tdm_event_loop_source *backend_source;
276 /* In event loop, all resources are accessed by this dpy.
278 * - DO NOT include other private structure in this structure because this
279 * struct is not protected by mutex.
283 /* for handling TDM client requests */
284 tdm_private_server *private_server;
286 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
287 * private_thread is NULL.
289 tdm_private_thread *private_thread;
292 struct _tdm_private_vblank_handler {
293 struct list_head link;
295 tdm_private_output *private_output;
296 tdm_output_vblank_handler func;
302 struct _tdm_private_commit_handler {
303 struct list_head link;
305 tdm_private_output *private_output;
306 tdm_output_commit_handler func;
312 struct _tdm_private_change_handler {
313 struct list_head link;
315 tdm_private_output *private_output;
316 tdm_output_change_handler func;
322 typedef struct _tdm_buffer_info {
323 tbm_surface_h buffer;
325 /* ref_count for backend */
326 int backend_ref_count;
328 struct list_head release_funcs;
329 struct list_head destroy_funcs;
331 struct list_head *list;
332 struct list_head link;
335 typedef struct _tdm_pp_private_buffer {
338 struct list_head link;
339 struct list_head commit_link;
340 } tdm_pp_private_buffer;
343 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
346 tdm_display_find_output_stamp(tdm_private_display *private_display,
347 unsigned long stamp);
349 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
350 tdm_private_capture *
351 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
354 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
355 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
357 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
358 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
360 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
363 tdm_output_cb_dpms(tdm_output *output_backend, tdm_output_dpms dpms,
366 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
369 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
373 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
374 struct list_head *change_handler_list,
375 tdm_output_change_type type,
377 int no_check_thread_id);
380 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
382 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
384 tdm_private_capture *
385 tdm_capture_create_output_internal(tdm_private_output *private_output,
387 tdm_private_capture *
388 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
391 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
393 /* utility buffer functions for private */
395 tdm_buffer_get_info(tbm_surface_h buffer);
397 tdm_buffer_list_get_first_entry(struct list_head *list);
399 tdm_buffer_list_dump(struct list_head *list);
402 tdm_buffer_remove_release_handler_internal(tbm_surface_h buffer);
404 /* event functions for private */
406 tdm_event_loop_init(tdm_private_display *private_display);
408 tdm_event_loop_deinit(tdm_private_display *private_display);
410 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
412 tdm_event_loop_get_fd(tdm_private_display *private_display);
414 tdm_event_loop_dispatch(tdm_private_display *private_display);
416 tdm_event_loop_flush(tdm_private_display *private_display);
420 TDM_THREAD_CB_OUTPUT_COMMIT,
421 TDM_THREAD_CB_OUTPUT_VBLANK,
422 TDM_THREAD_CB_OUTPUT_STATUS,
423 TDM_THREAD_CB_OUTPUT_DPMS,
424 TDM_THREAD_CB_PP_DONE,
425 TDM_THREAD_CB_CAPTURE_DONE,
426 } tdm_thread_cb_type;
428 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
429 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
430 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
431 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
432 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
433 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
434 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
436 struct _tdm_thread_cb_base {
437 tdm_thread_cb_type type;
441 struct _tdm_thread_cb_output_vblank {
442 tdm_thread_cb_base base;
443 unsigned long output_stamp;
444 unsigned int sequence;
446 unsigned int tv_usec;
450 struct _tdm_thread_cb_output_status {
451 tdm_thread_cb_base base;
452 unsigned long output_stamp;
453 tdm_output_conn_status status;
457 struct _tdm_thread_cb_output_dpms {
458 tdm_thread_cb_base base;
459 unsigned long output_stamp;
460 tdm_output_dpms dpms;
464 struct _tdm_thread_cb_pp_done {
465 tdm_thread_cb_base base;
466 unsigned long pp_stamp;
472 struct _tdm_thread_cb_capture_done {
473 tdm_thread_cb_base base;
474 unsigned long capture_stamp;
475 tbm_surface_h buffer;
480 tdm_thread_init(tdm_private_loop *private_loop);
482 tdm_thread_deinit(tdm_private_loop *private_loop);
484 tdm_thread_get_fd(tdm_private_loop *private_loop);
486 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
488 tdm_thread_handle_cb(tdm_private_loop *private_loop);
490 tdm_thread_in_display_thread(pid_t tid);
492 tdm_thread_is_running(void);
495 tdm_server_init(tdm_private_loop *private_loop);
497 tdm_server_deinit(tdm_private_loop *private_loop);
500 tdm_helper_dump_make_directory(const char *path, char *reply, int *len);
502 tdm_helper_dump_buffer_str(tbm_surface_h buffer, char *dir, char *str);
504 tdm_helper_get_time_in_millis(void);
506 tdm_helper_get_time_in_micros(void);
508 extern pthread_mutex_t tdm_mutex_check_lock;
509 extern int tdm_mutex_locked;
510 extern int tdm_dump_enable;
511 extern char *tdm_debug_dump_dir;
513 #define _pthread_mutex_unlock(l) \
515 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
516 TDM_INFO("mutex unlock"); \
517 pthread_mutex_lock(&tdm_mutex_check_lock); \
518 tdm_mutex_locked = 0; \
519 pthread_mutex_unlock(&tdm_mutex_check_lock); \
520 pthread_mutex_unlock(l); \
522 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
523 #define MUTEX_TIMEOUT_SEC 5
524 #define _pthread_mutex_lock(l) \
526 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
527 TDM_INFO("mutex lock"); \
528 struct timespec rtime; \
529 clock_gettime(CLOCK_REALTIME, &rtime); \
530 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
531 if (pthread_mutex_timedlock(l, &rtime)) { \
532 TDM_ERR("Mutex lock failed PID %d", getpid()); \
533 _pthread_mutex_unlock(l); \
536 pthread_mutex_lock(&tdm_mutex_check_lock); \
537 tdm_mutex_locked = 1; \
538 pthread_mutex_unlock(&tdm_mutex_check_lock); \
541 #else //TDM_CONFIG_MUTEX_TIMEOUT
542 #define _pthread_mutex_lock(l) \
544 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
545 TDM_INFO("mutex lock"); \
546 pthread_mutex_lock(l); \
547 pthread_mutex_lock(&tdm_mutex_check_lock); \
548 tdm_mutex_locked = 1; \
549 pthread_mutex_unlock(&tdm_mutex_check_lock); \
551 #endif //TDM_CONFIG_MUTEX_TIMEOUT
552 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
553 static inline int TDM_MUTEX_IS_LOCKED(void)
556 /* if thread is not running, we don't need to consider mutex things. */
557 if (!tdm_thread_is_running())
559 pthread_mutex_lock(&tdm_mutex_check_lock);
560 ret = (tdm_mutex_locked == 1);
561 pthread_mutex_unlock(&tdm_mutex_check_lock);
565 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
566 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
569 tdm_display_update_output(tdm_private_display *private_display,
570 tdm_output *output_backend, int pipe);
572 tdm_display_enable_debug_module(const char*modules);
574 tdm_display_enable_dump(tdm_private_display *private_display, const char *dump_str, char *reply, int *len);
576 tdm_display_enable_path(const char *path);
579 * @brief The tdm vblank object
581 typedef void tdm_vblank;
583 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
584 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
587 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
589 tdm_vblank_destroy(tdm_vblank *vblank);
591 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
593 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
595 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
597 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec, unsigned int interval, tdm_vblank_handler func, void *user_data);
600 tdm_monitor_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
606 #endif /* _TDM_PRIVATE_H_ */