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_TYPES_H_
37 #define _TDM_PRIVATE_TYPES_H_
40 #include <tbm_bufmgr.h>
41 #include <tbm_surface_queue.h>
43 #include "tdm_types.h"
47 #include "tdm_backend.h"
55 /*****************************************************************************
56 * This file defines private Enumerations and Structures for frontend
57 *****************************************************************************/
61 TDM_DEBUG_BUFFER = (1 << 0),
62 TDM_DEBUG_MUTEX = (1 << 1),
63 TDM_DEBUG_THREAD = (1 << 2),
64 TDM_DEBUG_SERVER = (1 << 3),
65 TDM_DEBUG_VBLANK = (1 << 4),
66 TDM_DEBUG_COMMIT = (1 << 5),
71 TDM_TTRACE_VSYNC = (1 << 0),
72 TDM_TTRACE_CLIENT_VBLANK = (1 << 1),
73 TDM_TTRACE_SERVER_VBLANK = (1 << 2),
74 TDM_TTRACE_VBLANK = (1 << 3),
75 TDM_TTRACE_LAYER = (1 << 4),
76 TDM_TTRACE_PP = (1 << 5),
77 TDM_TTRACE_CAPTURE = (1 << 6),
81 TDM_CAPTURE_TARGET_OUTPUT,
82 TDM_CAPTURE_TARGET_LAYER,
86 TDM_DUMP_FLAG_LAYER = (1 << 0),
87 TDM_DUMP_FLAG_PP = (1 << 1),
88 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
89 TDM_DUMP_FLAG_WINDOW = (1 << 3),
94 TDM_COMMIT_TYPE_OUTPUT,
95 TDM_COMMIT_TYPE_LAYER,
98 typedef struct _tdm_private_display tdm_private_display;
99 typedef struct _tdm_private_output tdm_private_output;
100 typedef struct _tdm_private_layer tdm_private_layer;
101 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
102 typedef struct _tdm_private_pp tdm_private_pp;
103 typedef struct _tdm_private_capture tdm_private_capture;
104 typedef struct _tdm_private_loop tdm_private_loop;
105 typedef struct _tdm_private_server tdm_private_server;
106 typedef struct _tdm_private_thread tdm_private_thread;
107 typedef struct _tdm_private_vblank_handler tdm_private_vblank_handler;
108 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
109 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
110 typedef struct _tdm_private_hwc_window_commit_handler tdm_private_hwc_window_commit_handler;
111 typedef struct _tdm_private_output_hwc_target_buffer_window_commit_handler tdm_private_output_hwc_target_buffer_commit_handler;
113 typedef struct _tdm_private_change_handler tdm_private_change_handler;
114 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
116 struct _tdm_private_display {
117 pthread_mutex_t lock;
118 unsigned int init_count;
120 /* backend module info */
122 tdm_backend_module *module_data;
123 tdm_backend_data *bdata;
129 /* backend function */
130 tdm_display_capability capabilities;
131 tdm_func_display func_display;
132 tdm_func_output func_output;
133 tdm_func_layer func_layer;
134 tdm_func_hwc_window func_hwc_window;
136 tdm_func_capture func_capture;
138 /* backend capability */
139 tdm_caps_display caps_display;
141 tdm_caps_capture caps_capture;
143 /* output, pp list */
144 struct list_head output_list;
145 struct list_head pp_list;
146 struct list_head capture_list;
150 /* for event handling */
151 tdm_private_loop *private_loop;
154 tdm_output **outputs;
159 struct _tdm_private_output {
160 struct list_head link;
165 tdm_private_display *private_display;
167 tdm_caps_output caps;
168 tdm_output *output_backend;
171 tdm_output_dpms current_dpms_value;
172 unsigned int waiting_dpms_change;
173 const tdm_output_mode *current_mode;
175 int regist_vblank_cb;
176 int regist_commit_cb;
177 int regist_change_cb;
180 struct list_head layer_list;
181 struct list_head hwc_window_list;
182 struct list_head capture_list;
183 struct list_head vblank_handler_list;
184 struct list_head output_commit_handler_list;
186 /* for layer commit */
187 struct list_head layer_commit_handler_list;
188 struct list_head pending_commit_handler_list;
190 int layer_waiting_vblank;
192 tdm_event_loop_source *vblank_timeout_timer;
194 /* seperate list for multi-thread*/
195 struct list_head change_handler_list_main;
196 struct list_head change_handler_list_sub;
200 /* TODO: temp solution for handling DPMS things in sub-htread */
201 tdm_event_loop_source *dpms_changed_timer;
204 /* look at the tdm_output_set_need_revalidate_handler() declaration for the details */
205 tdm_output_need_validate_handler hndl;
207 tdm_event_loop_source *event_source;
210 tdm_info_layer target_buffer_info; /* layer_info for the target_buffer */
212 /* calling a output commit per a vblank */
213 int commit_per_vblank;
214 tdm_commit_type commit_type;
216 /* for ttrace vblank */
217 tdm_vblank *ttrace_vblank;
220 int need_set_target_info;
223 struct _tdm_private_layer {
224 struct list_head link;
228 tdm_private_display *private_display;
229 tdm_private_output *private_output;
232 tdm_layer *layer_backend;
234 /* pending data until committed */
235 unsigned int pending_info_changed;
236 tdm_info_layer pending_info;
237 unsigned int pending_buffer_changed;
238 tbm_surface_h pending_buffer;
240 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
241 * And when a layer is committed, it will be moved to committed_buffer.
242 * Finally when a commit handler is called, it will be moved to showing_buffer.
244 tdm_private_layer_buffer *waiting_buffer;
245 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
246 tdm_private_layer_buffer *showing_buffer;
247 tbm_surface_queue_h buffer_queue;
249 struct list_head capture_list;
252 unsigned int committing;
255 unsigned int fps_count;
258 struct _tdm_private_hwc_window {
259 struct list_head link;
263 tdm_private_display *private_display;
264 tdm_private_output *private_output;
266 tdm_hwc_window *hwc_window_backend;
269 struct _tdm_private_pp {
270 struct list_head link;
274 tdm_private_display *private_display;
278 struct list_head pending_buffer_list;
279 struct list_head buffer_list;
284 tdm_pp_done_handler done_func;
285 void *done_user_data;
288 struct _tdm_private_capture {
289 struct list_head link;
290 struct list_head display_link;
294 tdm_capture_target target;
296 tdm_private_display *private_display;
297 tdm_private_output *private_output;
298 tdm_private_layer *private_layer;
300 tdm_capture *capture_backend;
302 struct list_head pending_buffer_list;
303 struct list_head buffer_list;
305 tdm_info_capture info;
308 tdm_capture_done_handler done_func;
309 void *done_user_data;
313 * Note that we don't need to (un)lock mutex to use this structure. If there is
314 * no TDM thread, all TDM resources are protected by private_display's mutex.
315 * If there is a TDM thread, this struct will be used only in a TDM thread.
316 * So, we don't need to protect this structure by mutex. Not thread-safe.
318 struct _tdm_private_loop {
319 /* TDM uses wl_event_loop to handle various event sources including the TDM
322 struct wl_display *wl_display;
323 struct wl_event_loop *wl_loop;
326 tdm_event_loop_source *backend_source;
328 /* In event loop, all resources are accessed by this dpy.
330 * - DO NOT include other private structure in this structure because this
331 * struct is not protected by mutex.
335 /* for handling TDM client requests */
336 tdm_private_server *private_server;
338 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
339 * private_thread is NULL.
341 tdm_private_thread *private_thread;
344 struct _tdm_private_vblank_handler {
345 struct list_head link;
347 tdm_private_output *private_output;
350 tdm_output_vblank_handler func;
353 unsigned int sent_to_frontend;
358 struct _tdm_private_output_commit_handler {
359 struct list_head link;
361 tdm_private_output *private_output;
362 tdm_output_commit_handler func;
368 struct _tdm_private_layer_commit_handler {
369 struct list_head link;
371 tdm_private_layer *private_layer;
372 tdm_layer_commit_handler func;
375 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
378 struct _tdm_private_hwc_window_commit_handler {
379 tdm_private_hwc_window *private_hwc_window;
380 tdm_hwc_window_commit_handler func;
384 struct _tdm_private_output_hwc_target_buffer_window_commit_handler {
385 tdm_private_output *private_output;
386 tdm_output_hwc_target_buffer_commit_handler func;
390 struct _tdm_private_change_handler {
391 struct list_head link;
393 tdm_private_output *private_output;
394 tdm_output_change_handler func;
400 struct _tdm_private_layer_buffer {
401 tbm_surface_h buffer;
402 struct list_head link;
405 typedef struct _tdm_buffer_info {
406 tbm_surface_h buffer;
408 /* ref_count for backend */
409 int backend_ref_count;
411 struct list_head release_funcs;
412 struct list_head destroy_funcs;
414 struct list_head *list;
415 struct list_head link;
418 typedef struct _tdm_pp_private_buffer {
421 struct list_head link;
422 struct list_head commit_link;
423 } tdm_pp_private_buffer;
425 typedef struct _tdm_capture_private_buffer {
426 tbm_surface_h buffer;
427 struct list_head link;
428 struct list_head commit_link;
429 } tdm_capture_private_buffer;
433 TDM_THREAD_CB_OUTPUT_COMMIT,
434 TDM_THREAD_CB_OUTPUT_VBLANK,
435 TDM_THREAD_CB_OUTPUT_STATUS,
436 TDM_THREAD_CB_OUTPUT_DPMS,
437 TDM_THREAD_CB_PP_DONE,
438 TDM_THREAD_CB_CAPTURE_DONE,
439 TDM_THREAD_CB_VBLANK_SW,
440 TDM_THREAD_CB_VBLANK_CREATE,
441 TDM_THREAD_CB_NEED_VALIDATE,
442 } tdm_thread_cb_type;
444 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
445 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
446 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
447 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
448 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
449 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
450 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
451 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
452 typedef struct _tdm_thread_cb_vblank_create tdm_thread_cb_vblank_create;
453 typedef struct _tdm_thread_cb_need_validate tdm_thread_cb_need_validate;
455 struct _tdm_thread_cb_base {
456 tdm_thread_cb_type type;
460 struct _tdm_thread_cb_output_vblank {
461 tdm_thread_cb_base base;
463 unsigned int sequence;
465 unsigned int tv_usec;
469 struct _tdm_thread_cb_output_status {
470 tdm_thread_cb_base base;
472 tdm_output_conn_status status;
476 struct _tdm_thread_cb_output_dpms {
477 tdm_thread_cb_base base;
479 tdm_output_dpms dpms;
483 struct _tdm_thread_cb_pp_done {
484 tdm_thread_cb_base base;
491 struct _tdm_thread_cb_capture_done {
492 tdm_thread_cb_base base;
493 double capture_stamp;
494 tbm_surface_h buffer;
498 struct _tdm_thread_cb_vblank_sw {
499 tdm_thread_cb_base base;
503 struct _tdm_thread_cb_vblank_create {
504 tdm_thread_cb_base base;
508 struct _tdm_thread_cb_need_validate {
509 tdm_thread_cb_base base;
510 tdm_private_output *o;
513 struct argument_details {
522 #endif /* _TDM_PRIVATE_TYPES_H_ */