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 typedef struct _tdm_private_display tdm_private_display;
109 typedef struct _tdm_private_output tdm_private_output;
110 typedef struct _tdm_private_layer tdm_private_layer;
111 typedef struct _tdm_private_pp tdm_private_pp;
112 typedef struct _tdm_private_capture tdm_private_capture;
113 typedef struct _tdm_private_loop tdm_private_loop;
114 typedef struct _tdm_private_server tdm_private_server;
115 typedef struct _tdm_private_thread tdm_private_thread;
116 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
117 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
118 typedef struct _tdm_private_change_handler tdm_private_change_handler;
120 struct _tdm_private_display {
121 pthread_mutex_t lock;
122 unsigned int init_count;
124 /* backend module info */
126 tdm_backend_module *module_data;
127 tdm_backend_data *bdata;
133 /* backend function */
134 tdm_display_capability capabilities;
135 tdm_func_display func_display;
136 tdm_func_output func_output;
137 tdm_func_layer func_layer;
139 tdm_func_capture func_capture;
141 /* backend capability */
142 tdm_caps_display caps_display;
144 tdm_caps_capture caps_capture;
146 /* output, pp list */
147 struct list_head output_list;
148 struct list_head pp_list;
149 struct list_head capture_list;
153 /* for event handling */
154 tdm_private_loop *private_loop;
157 tdm_output **outputs;
160 struct _tdm_private_output {
161 struct list_head link;
166 tdm_private_display *private_display;
168 tdm_caps_output caps;
169 tdm_output *output_backend;
172 tdm_output_dpms current_dpms_value;
174 int regist_vblank_cb;
175 int regist_commit_cb;
176 int regist_change_cb;
178 struct list_head layer_list;
179 struct list_head capture_list;
180 struct list_head vblank_handler_list;
181 struct list_head commit_handler_list;
183 /* seperate list for multi-thread*/
184 struct list_head change_handler_list_main;
185 struct list_head change_handler_list_sub;
189 /* TODO: temp solution for handling DPMS things in sub-htread */
190 tdm_event_loop_source *dpms_changed_timer;
193 struct _tdm_private_layer {
194 struct list_head link;
198 tdm_private_display *private_display;
199 tdm_private_output *private_output;
202 tdm_layer *layer_backend;
204 tbm_surface_h pending_buffer;
205 tbm_surface_h waiting_buffer;
206 tbm_surface_h showing_buffer;
207 tbm_surface_queue_h buffer_queue;
209 struct list_head capture_list;
214 struct _tdm_private_pp {
215 struct list_head link;
219 tdm_private_display *private_display;
223 struct list_head pending_buffer_list;
224 struct list_head buffer_list;
229 struct _tdm_private_capture {
230 struct list_head link;
231 struct list_head display_link;
235 tdm_capture_target target;
237 tdm_private_display *private_display;
238 tdm_private_output *private_output;
239 tdm_private_layer *private_layer;
241 tdm_capture *capture_backend;
243 struct list_head pending_buffer_list;
244 struct list_head buffer_list;
250 * Note that we don't need to (un)lock mutex to use this structure. If there is
251 * no TDM thread, all TDM resources are protected by private_display's mutex.
252 * If there is a TDM thread, this struct will be used only in a TDM thread.
253 * So, we don't need to protect this structure by mutex. Not thread-safe.
255 struct _tdm_private_loop {
256 /* TDM uses wl_event_loop to handle various event sources including the TDM
259 struct wl_display *wl_display;
260 struct wl_event_loop *wl_loop;
263 tdm_event_loop_source *backend_source;
265 /* In event loop, all resources are accessed by this dpy.
267 * - DO NOT include other private structure in this structure because this
268 * struct is not protected by mutex.
272 /* for handling TDM client requests */
273 tdm_private_server *private_server;
275 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
276 * private_thread is NULL.
278 tdm_private_thread *private_thread;
281 struct _tdm_private_vblank_handler {
282 struct list_head link;
284 tdm_private_output *private_output;
285 tdm_output_vblank_handler func;
291 struct _tdm_private_commit_handler {
292 struct list_head link;
294 tdm_private_output *private_output;
295 tdm_output_commit_handler func;
301 struct _tdm_private_change_handler {
302 struct list_head link;
304 tdm_private_output *private_output;
305 tdm_output_change_handler func;
311 typedef struct _tdm_buffer_info {
312 tbm_surface_h buffer;
314 /* ref_count for backend */
315 int backend_ref_count;
317 struct list_head release_funcs;
318 struct list_head destroy_funcs;
320 struct list_head *list;
321 struct list_head link;
325 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
328 tdm_display_find_output_stamp(tdm_private_display *private_display,
329 unsigned long stamp);
331 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
332 tdm_private_capture *
333 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
336 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
337 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
339 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
340 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
342 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
345 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
348 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
352 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
353 struct list_head *change_handler_list,
354 tdm_output_change_type type,
356 int no_check_thread_id);
359 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
361 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
363 tdm_private_capture *
364 tdm_capture_create_output_internal(tdm_private_output *private_output,
366 tdm_private_capture *
367 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
370 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
372 /* utility buffer functions for private */
374 tdm_buffer_get_info(tbm_surface_h buffer);
376 tdm_buffer_list_get_first_entry(struct list_head *list);
378 tdm_buffer_list_dump(struct list_head *list);
380 /* event functions for private */
382 tdm_event_loop_init(tdm_private_display *private_display);
384 tdm_event_loop_deinit(tdm_private_display *private_display);
386 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
388 tdm_event_loop_get_fd(tdm_private_display *private_display);
390 tdm_event_loop_dispatch(tdm_private_display *private_display);
392 tdm_event_loop_flush(tdm_private_display *private_display);
396 TDM_THREAD_CB_OUTPUT_COMMIT,
397 TDM_THREAD_CB_OUTPUT_VBLANK,
398 TDM_THREAD_CB_OUTPUT_STATUS,
399 TDM_THREAD_CB_PP_DONE,
400 TDM_THREAD_CB_CAPTURE_DONE,
401 } tdm_thread_cb_type;
403 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
404 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
405 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
406 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
407 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
408 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
410 struct _tdm_thread_cb_base {
411 tdm_thread_cb_type type;
415 struct _tdm_thread_cb_output_vblank {
416 tdm_thread_cb_base base;
417 unsigned long output_stamp;
418 unsigned int sequence;
420 unsigned int tv_usec;
424 struct _tdm_thread_cb_output_status {
425 tdm_thread_cb_base base;
426 unsigned long output_stamp;
427 tdm_output_conn_status status;
431 struct _tdm_thread_cb_pp_done {
432 tdm_thread_cb_base base;
433 unsigned long pp_stamp;
439 struct _tdm_thread_cb_capture_done {
440 tdm_thread_cb_base base;
441 unsigned long capture_stamp;
442 tbm_surface_h buffer;
447 tdm_thread_init(tdm_private_loop *private_loop);
449 tdm_thread_deinit(tdm_private_loop *private_loop);
451 tdm_thread_get_fd(tdm_private_loop *private_loop);
453 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
455 tdm_thread_handle_cb(tdm_private_loop *private_loop);
457 tdm_thread_in_display_thread(pid_t tid);
459 tdm_thread_is_running(void);
462 tdm_server_init(tdm_private_loop *private_loop);
464 tdm_server_deinit(tdm_private_loop *private_loop);
467 tdm_helper_dump_buffer_str(tbm_surface_h buffer, const char *str);
469 tdm_helper_get_time_in_millis(void);
471 tdm_helper_get_time_in_micros(void);
473 extern pthread_mutex_t tdm_mutex_check_lock;
474 extern int tdm_mutex_locked;
475 extern int tdm_dump_enable;
477 #define _pthread_mutex_unlock(l) \
479 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
480 TDM_INFO("mutex unlock"); \
481 pthread_mutex_lock(&tdm_mutex_check_lock); \
482 tdm_mutex_locked = 0; \
483 pthread_mutex_unlock(&tdm_mutex_check_lock); \
484 pthread_mutex_unlock(l); \
486 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
487 #define MUTEX_TIMEOUT_SEC 5
488 #define _pthread_mutex_lock(l) \
490 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
491 TDM_INFO("mutex lock"); \
492 struct timespec rtime; \
493 clock_gettime(CLOCK_REALTIME, &rtime); \
494 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
495 if (pthread_mutex_timedlock(l, &rtime)) { \
496 TDM_ERR("Mutex lock failed PID %d", getpid()); \
497 _pthread_mutex_unlock(l); \
500 pthread_mutex_lock(&tdm_mutex_check_lock); \
501 tdm_mutex_locked = 1; \
502 pthread_mutex_unlock(&tdm_mutex_check_lock); \
505 #else //TDM_CONFIG_MUTEX_TIMEOUT
506 #define _pthread_mutex_lock(l) \
508 if (tdm_debug_module & TDM_DEBUG_MUTEX) \
509 TDM_INFO("mutex lock"); \
510 pthread_mutex_lock(l); \
511 pthread_mutex_lock(&tdm_mutex_check_lock); \
512 tdm_mutex_locked = 1; \
513 pthread_mutex_unlock(&tdm_mutex_check_lock); \
515 #endif //TDM_CONFIG_MUTEX_TIMEOUT
516 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
517 static inline int TDM_MUTEX_IS_LOCKED(void)
520 /* if thread is not running, we don't need to consider mutex things. */
521 if (!tdm_thread_is_running())
523 pthread_mutex_lock(&tdm_mutex_check_lock);
524 ret = (tdm_mutex_locked == 1);
525 pthread_mutex_unlock(&tdm_mutex_check_lock);
529 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
530 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
533 tdm_display_update_output(tdm_private_display *private_display,
534 tdm_output *output_backend, int pipe);
536 tdm_display_enable_debug_module(const char*modules);
538 tdm_display_enable_dump(const char *dump_str);
540 tdm_display_enable_path(const char *path);
543 * @brief The tdm vblank object
545 typedef void tdm_vblank;
547 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
548 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
551 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
553 tdm_vblank_destroy(tdm_vblank *vblank);
555 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
557 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
559 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
561 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec, unsigned int interval, tdm_vblank_handler func, void *user_data);
564 tdm_dbg_server_command(tdm_display *dpy, const char *options, char *reply, int *len);
570 #endif /* _TDM_PRIVATE_H_ */