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
76 extern int tdm_debug_buffer;
77 extern int tdm_debug_mutex;
78 extern int tdm_debug_thread;
82 #define TDM_TRACE_BEGIN(NAME) traceBegin(TTRACE_TAG_GRAPHICS, "TDM:"#NAME)
83 #define TDM_TRACE_END() traceEnd(TTRACE_TAG_GRAPHICS)
85 #define TDM_TRACE_BEGIN(NAME)
86 #define TDM_TRACE_END()
90 TDM_CAPTURE_TARGET_OUTPUT,
91 TDM_CAPTURE_TARGET_LAYER,
94 typedef struct _tdm_private_display tdm_private_display;
95 typedef struct _tdm_private_output tdm_private_output;
96 typedef struct _tdm_private_layer tdm_private_layer;
97 typedef struct _tdm_private_pp tdm_private_pp;
98 typedef struct _tdm_private_capture tdm_private_capture;
99 typedef struct _tdm_private_loop tdm_private_loop;
100 typedef struct _tdm_private_server tdm_private_server;
101 typedef struct _tdm_private_thread tdm_private_thread;
102 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
103 typedef struct _tdm_private_commit_handler tdm_private_commit_handler;
104 typedef struct _tdm_private_change_handler tdm_private_change_handler;
106 struct _tdm_private_display {
107 pthread_mutex_t lock;
108 unsigned int init_count;
110 /* backend module info */
112 tdm_backend_module *module_data;
113 tdm_backend_data *bdata;
119 /* backend function */
120 tdm_display_capability capabilities;
121 tdm_func_display func_display;
122 tdm_func_output func_output;
123 tdm_func_layer func_layer;
125 tdm_func_capture func_capture;
127 /* backend capability */
128 tdm_caps_display caps_display;
130 tdm_caps_capture caps_capture;
132 /* output, pp list */
133 struct list_head output_list;
134 struct list_head pp_list;
135 struct list_head capture_list;
139 /* for event handling */
140 tdm_private_loop *private_loop;
143 tdm_output **outputs;
146 struct _tdm_private_output {
147 struct list_head link;
151 tdm_private_display *private_display;
153 tdm_caps_output caps;
154 tdm_output *output_backend;
157 tdm_output_dpms current_dpms_value;
159 int regist_vblank_cb;
160 int regist_commit_cb;
161 int regist_change_cb;
163 struct list_head layer_list;
164 struct list_head capture_list;
165 struct list_head vblank_handler_list;
166 struct list_head commit_handler_list;
168 /* seperate list for multi-thread*/
169 struct list_head change_handler_list_main;
170 struct list_head change_handler_list_sub;
174 /* TODO: temp solution for handling DPMS things in sub-htread */
175 tdm_event_loop_source *dpms_changed_timer;
178 struct _tdm_private_layer {
179 struct list_head link;
181 tdm_private_display *private_display;
182 tdm_private_output *private_output;
185 tdm_layer *layer_backend;
187 tbm_surface_h pending_buffer;
188 tbm_surface_h waiting_buffer;
189 tbm_surface_h showing_buffer;
190 tbm_surface_queue_h buffer_queue;
192 struct list_head capture_list;
197 struct _tdm_private_pp {
198 struct list_head link;
202 tdm_private_display *private_display;
206 struct list_head pending_buffer_list;
207 struct list_head buffer_list;
212 struct _tdm_private_capture {
213 struct list_head link;
214 struct list_head display_link;
218 tdm_capture_target target;
220 tdm_private_display *private_display;
221 tdm_private_output *private_output;
222 tdm_private_layer *private_layer;
224 tdm_capture *capture_backend;
226 struct list_head pending_buffer_list;
227 struct list_head buffer_list;
233 * Note that we don't need to (un)lock mutex to use this structure. If there is
234 * no TDM thread, all TDM resources are protected by private_display's mutex.
235 * If there is a TDM thread, this struct will be used only in a TDM thread.
236 * So, we don't need to protect this structure by mutex. Not thread-safe.
238 struct _tdm_private_loop {
239 /* TDM uses wl_event_loop to handle various event sources including the TDM
242 struct wl_display *wl_display;
243 struct wl_event_loop *wl_loop;
246 tdm_event_loop_source *backend_source;
248 /* In event loop, all resources are accessed by this dpy.
250 * - DO NOT include other private structure in this structure because this
251 * struct is not protected by mutex.
255 /* for handling TDM client requests */
256 tdm_private_server *private_server;
258 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
259 * private_thread is NULL.
261 tdm_private_thread *private_thread;
264 struct _tdm_private_vblank_handler {
265 struct list_head link;
267 tdm_private_output *private_output;
268 tdm_output_vblank_handler func;
274 struct _tdm_private_commit_handler {
275 struct list_head link;
277 tdm_private_output *private_output;
278 tdm_output_commit_handler func;
284 struct _tdm_private_change_handler {
285 struct list_head link;
287 tdm_private_output *private_output;
288 tdm_output_change_handler func;
294 typedef struct _tdm_buffer_info {
295 tbm_surface_h buffer;
297 /* ref_count for backend */
298 int backend_ref_count;
300 struct list_head release_funcs;
301 struct list_head destroy_funcs;
303 struct list_head *list;
304 struct list_head link;
308 tdm_display_check_module_abi(tdm_private_display *private_display, int abimaj, int abimin);
311 tdm_display_find_output_stamp(tdm_private_display *private_display,
312 unsigned long stamp);
314 tdm_pp_find_stamp(tdm_private_display *private_display, unsigned long stamp);
315 tdm_private_capture *
316 tdm_capture_find_stamp(tdm_private_display *private_display, unsigned long stamp);
319 tdm_output_cb_vblank(tdm_output *output_backend, unsigned int sequence,
320 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
322 tdm_output_cb_commit(tdm_output *output_backend, unsigned int sequence,
323 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
325 tdm_output_cb_status(tdm_output *output_backend, tdm_output_conn_status status,
328 tdm_pp_cb_done(tdm_pp *pp_backend, tbm_surface_h src, tbm_surface_h dst,
331 tdm_capture_cb_done(tdm_capture *capture_backend, tbm_surface_h buffer,
335 tdm_output_call_change_handler_internal(tdm_private_output *private_output,
336 struct list_head *change_handler_list,
337 tdm_output_change_type type,
339 int no_check_thread_id);
342 tdm_pp_create_internal(tdm_private_display *private_display, tdm_error *error);
344 tdm_pp_destroy_internal(tdm_private_pp *private_pp);
346 tdm_private_capture *
347 tdm_capture_create_output_internal(tdm_private_output *private_output,
349 tdm_private_capture *
350 tdm_capture_create_layer_internal(tdm_private_layer *private_layer,
353 tdm_capture_destroy_internal(tdm_private_capture *private_capture);
355 /* utility buffer functions for private */
357 tdm_buffer_get_info(tbm_surface_h buffer);
359 tdm_buffer_list_get_first_entry(struct list_head *list);
361 tdm_buffer_list_dump(struct list_head *list);
363 /* event functions for private */
365 tdm_event_loop_init(tdm_private_display *private_display);
367 tdm_event_loop_deinit(tdm_private_display *private_display);
369 tdm_event_loop_create_backend_source(tdm_private_display *private_display);
371 tdm_event_loop_get_fd(tdm_private_display *private_display);
373 tdm_event_loop_dispatch(tdm_private_display *private_display);
375 tdm_event_loop_flush(tdm_private_display *private_display);
379 TDM_THREAD_CB_OUTPUT_COMMIT,
380 TDM_THREAD_CB_OUTPUT_VBLANK,
381 TDM_THREAD_CB_OUTPUT_STATUS,
382 TDM_THREAD_CB_PP_DONE,
383 TDM_THREAD_CB_CAPTURE_DONE,
384 } tdm_thread_cb_type;
386 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
387 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
388 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
389 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
390 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
391 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
393 struct _tdm_thread_cb_base {
394 tdm_thread_cb_type type;
398 struct _tdm_thread_cb_output_vblank {
399 tdm_thread_cb_base base;
400 unsigned long output_stamp;
401 unsigned int sequence;
403 unsigned int tv_usec;
407 struct _tdm_thread_cb_output_status {
408 tdm_thread_cb_base base;
409 unsigned long output_stamp;
410 tdm_output_conn_status status;
414 struct _tdm_thread_cb_pp_done {
415 tdm_thread_cb_base base;
416 unsigned long pp_stamp;
422 struct _tdm_thread_cb_capture_done {
423 tdm_thread_cb_base base;
424 unsigned long capture_stamp;
425 tbm_surface_h buffer;
430 tdm_thread_init(tdm_private_loop *private_loop);
432 tdm_thread_deinit(tdm_private_loop *private_loop);
434 tdm_thread_get_fd(tdm_private_loop *private_loop);
436 tdm_thread_send_cb(tdm_private_loop *private_loop, tdm_thread_cb_base *base);
438 tdm_thread_handle_cb(tdm_private_loop *private_loop);
440 tdm_thread_in_display_thread(pid_t tid);
442 tdm_thread_is_running(void);
445 tdm_server_init(tdm_private_loop *private_loop);
447 tdm_server_deinit(tdm_private_loop *private_loop);
450 tdm_helper_get_time_in_millis(void);
452 tdm_helper_get_time_in_micros(void);
454 extern pthread_mutex_t tdm_mutex_check_lock;
455 extern int tdm_mutex_locked;
456 extern int tdm_dump_enable;
458 #define _pthread_mutex_unlock(l) \
460 if (tdm_debug_mutex) \
461 TDM_INFO("mutex unlock"); \
462 pthread_mutex_lock(&tdm_mutex_check_lock); \
463 tdm_mutex_locked = 0; \
464 pthread_mutex_unlock(&tdm_mutex_check_lock); \
465 pthread_mutex_unlock(l); \
467 #ifdef TDM_CONFIG_MUTEX_TIMEOUT
468 #define MUTEX_TIMEOUT_SEC 5
469 #define _pthread_mutex_lock(l) \
471 if (tdm_debug_mutex) \
472 TDM_INFO("mutex lock"); \
473 struct timespec rtime; \
474 clock_gettime(CLOCK_REALTIME, &rtime); \
475 rtime.tv_sec += MUTEX_TIMEOUT_SEC; \
476 if (pthread_mutex_timedlock(l, &rtime)) { \
477 TDM_ERR("Mutex lock failed PID %d", getpid()); \
478 _pthread_mutex_unlock(l); \
481 pthread_mutex_lock(&tdm_mutex_check_lock); \
482 tdm_mutex_locked = 1; \
483 pthread_mutex_unlock(&tdm_mutex_check_lock); \
486 #else //TDM_CONFIG_MUTEX_TIMEOUT
487 #define _pthread_mutex_lock(l) \
489 if (tdm_debug_mutex) \
490 TDM_INFO("mutex lock"); \
491 pthread_mutex_lock(l); \
492 pthread_mutex_lock(&tdm_mutex_check_lock); \
493 tdm_mutex_locked = 1; \
494 pthread_mutex_unlock(&tdm_mutex_check_lock); \
496 #endif //TDM_CONFIG_MUTEX_TIMEOUT
497 //#define TDM_MUTEX_IS_LOCKED() (tdm_mutex_locked == 1)
498 static inline int TDM_MUTEX_IS_LOCKED(void)
501 /* if thread is not running, we don't need to consider mutex things. */
502 if (!tdm_thread_is_running())
504 pthread_mutex_lock(&tdm_mutex_check_lock);
505 ret = (tdm_mutex_locked == 1);
506 pthread_mutex_unlock(&tdm_mutex_check_lock);
510 #define tdm_display_lock(dpy) _pthread_mutex_lock(&((tdm_private_display *)dpy)->lock)
511 #define tdm_display_unlock(dpy) _pthread_mutex_unlock(&((tdm_private_display *)dpy)->lock)
514 tdm_display_update_output(tdm_private_display *private_display,
515 tdm_output *output_backend, int pipe);
519 * @brief The tdm vblank object
521 typedef void tdm_vblank;
523 typedef void (*tdm_vblank_handler)(tdm_vblank *vblank, tdm_error error, unsigned int sequence,
524 unsigned int tv_sec, unsigned int tv_usec, void *user_data);
527 tdm_vblank_create(tdm_display *dpy, tdm_output *output, tdm_error *error);
529 tdm_vblank_destroy(tdm_vblank *vblank);
531 tdm_vblank_set_fps(tdm_vblank *vblank, unsigned int fps);
533 tdm_vblank_set_offset(tdm_vblank *vblank, int offset);
535 tdm_vblank_set_enable_fake(tdm_vblank *vblank, unsigned int enable_fake);
537 tdm_vblank_wait(tdm_vblank *vblank, unsigned int req_sec, unsigned int req_usec, unsigned int interval, tdm_vblank_handler func, void *user_data);
543 #endif /* _TDM_PRIVATE_H_ */