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 <boram1288.park@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_EVENT = (1 << 2),
64 TDM_DEBUG_THREAD = (1 << 3),
65 TDM_DEBUG_SERVER = (1 << 4),
66 TDM_DEBUG_VBLANK = (1 << 5),
67 TDM_DEBUG_COMMIT = (1 << 6),
72 TDM_TTRACE_VSYNC = (1 << 0),
73 TDM_TTRACE_CLIENT_VBLANK = (1 << 1),
74 TDM_TTRACE_SERVER_VBLANK = (1 << 2),
75 TDM_TTRACE_VBLANK = (1 << 3),
76 TDM_TTRACE_LAYER = (1 << 4),
77 TDM_TTRACE_PP = (1 << 5),
78 TDM_TTRACE_CAPTURE = (1 << 6),
82 TDM_CAPTURE_TARGET_OUTPUT,
83 TDM_CAPTURE_TARGET_LAYER,
87 TDM_DUMP_FLAG_LAYER = (1 << 0),
88 TDM_DUMP_FLAG_PP = (1 << 1),
89 TDM_DUMP_FLAG_CAPTURE = (1 << 2),
90 TDM_DUMP_FLAG_WINDOW = (1 << 3),
95 TDM_COMMIT_TYPE_OUTPUT,
96 TDM_COMMIT_TYPE_LAYER,
99 typedef struct _tdm_private_module tdm_private_module;
100 typedef struct _tdm_private_display tdm_private_display;
101 typedef struct _tdm_private_output tdm_private_output;
102 typedef struct _tdm_private_layer tdm_private_layer;
103 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
104 typedef struct _tdm_private_pp tdm_private_pp;
105 typedef struct _tdm_private_capture tdm_private_capture;
106 typedef struct _tdm_private_loop tdm_private_loop;
107 typedef struct _tdm_private_server tdm_private_server;
108 typedef struct _tdm_private_thread tdm_private_thread;
109 typedef struct _tdm_private_output_change_handler tdm_private_output_change_handler;
110 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
111 typedef struct _tdm_private_output_vblank_handler tdm_private_output_vblank_handler;
112 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
113 typedef struct _tdm_private_hwc_window_commit_handler tdm_private_hwc_window_commit_handler;
114 typedef struct _tdm_private_output_hwc_target_buffer_window_commit_handler tdm_private_output_hwc_target_buffer_commit_handler;
116 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
118 struct _tdm_private_module {
119 struct list_head link;
121 tdm_private_display *private_display;
123 /* backend module info */
125 tdm_backend_module *module_data;
126 tdm_backend_data *bdata;
128 /* backend function */
129 tdm_display_capability capabilities;
130 tdm_func_display func_display;
131 tdm_func_output func_output;
132 tdm_func_layer func_layer;
133 tdm_func_hwc_window func_hwc_window;
135 tdm_func_capture func_capture;
137 /* backend capability */
138 tdm_caps_display caps_display;
140 tdm_caps_capture caps_capture;
142 /* output, pp list */
143 struct list_head output_list;
144 struct list_head pp_list;
145 struct list_head capture_list;
147 /* backend output objects. allocated in backend. freed in frontend. ordered */
148 tdm_output **outputs;
151 tdm_event_loop_source *event_source;
154 struct _tdm_private_display {
155 pthread_mutex_t lock;
156 unsigned int init_count;
164 struct list_head module_list;
165 tdm_private_module *current_module; //setted only when loading
166 tdm_private_module *pp_module; //pp-support backend
167 tdm_private_module *capture_module; //TODO: remove later
169 /* for event handling */
170 tdm_private_loop *private_loop;
175 struct _tdm_private_output {
176 struct list_head link;
178 tdm_private_module *private_module;
183 tdm_private_display *private_display;
185 tdm_caps_output caps;
186 tdm_output *output_backend;
189 tdm_output_dpms current_dpms_value;
190 unsigned int waiting_dpms_change;
191 const tdm_output_mode *current_mode;
193 int regist_vblank_cb;
194 int regist_commit_cb;
195 int regist_change_cb;
198 struct list_head layer_list;
199 struct list_head hwc_window_list;
200 struct list_head capture_list;
201 struct list_head vblank_handler_list;
202 struct list_head output_commit_handler_list;
204 /* for layer commit */
205 struct list_head layer_commit_handler_list;
206 struct list_head pending_commit_handler_list;
208 int layer_waiting_vblank;
210 tdm_event_loop_source *vblank_timeout_timer;
211 unsigned int vblank_timeout_timer_expired;
213 struct list_head change_handler_list;
218 /* look at the tdm_output_set_need_revalidate_handler() declaration for the details */
219 tdm_output_need_validate_handler hndl;
221 tdm_event_loop_source *event_source;
224 tdm_info_layer target_buffer_info; /* layer_info for the target_buffer */
226 /* calling a output commit per a vblank */
227 int commit_per_vblank;
228 tdm_commit_type commit_type;
230 /* for ttrace vblank */
231 tdm_vblank *ttrace_vblank;
234 int need_set_target_info;
237 struct _tdm_private_layer {
238 struct list_head link;
240 tdm_private_module *private_module;
244 tdm_private_display *private_display;
245 tdm_private_output *private_output;
248 tdm_layer *layer_backend;
250 /* pending data until committed */
251 unsigned int pending_info_changed;
252 tdm_info_layer pending_info;
253 unsigned int pending_buffer_changed;
254 tbm_surface_h pending_buffer;
256 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
257 * And when a layer is committed, it will be moved to committed_buffer.
258 * Finally when a commit handler is called, it will be moved to showing_buffer.
260 tdm_private_layer_buffer *waiting_buffer;
261 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
262 tdm_private_layer_buffer *showing_buffer;
263 tbm_surface_queue_h buffer_queue;
265 struct list_head capture_list;
268 unsigned int committing;
271 unsigned int fps_count;
274 struct _tdm_private_hwc_window {
275 struct list_head link;
279 tdm_private_display *private_display;
280 tdm_private_output *private_output;
282 tdm_hwc_window *hwc_window_backend;
285 struct _tdm_private_pp {
286 struct list_head link;
288 tdm_private_module *private_module;
292 tdm_private_display *private_display;
296 struct list_head pending_buffer_list;
297 struct list_head buffer_list;
302 tdm_pp_done_handler done_func;
303 void *done_user_data;
306 struct _tdm_private_capture {
307 struct list_head link;
308 struct list_head display_link;
310 tdm_private_module *private_module;
314 tdm_capture_target target;
316 tdm_private_display *private_display;
317 tdm_private_output *private_output;
318 tdm_private_layer *private_layer;
320 tdm_capture *capture_module;
322 struct list_head pending_buffer_list;
323 struct list_head buffer_list;
325 tdm_info_capture info;
328 tdm_capture_done_handler done_func;
329 void *done_user_data;
333 * Note that we don't need to (un)lock mutex to use this structure. If there is
334 * no TDM thread, all TDM resources are protected by private_display's mutex.
335 * If there is a TDM thread, this struct will be used only in a TDM thread.
336 * So, we don't need to protect this structure by mutex. Not thread-safe.
338 struct _tdm_private_loop {
339 /* TDM uses wl_event_loop to handle various event sources including the TDM
342 struct wl_display *wl_display;
343 struct wl_event_loop *wl_loop;
345 /* In event loop, all resources are accessed by this dpy.
347 * - DO NOT include other private structure in this structure because this
348 * struct is not protected by mutex.
352 /* for handling TDM client requests */
353 tdm_private_server *private_server;
355 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
356 * private_thread is NULL.
358 tdm_private_thread *private_thread;
360 struct list_head source_list;
363 struct _tdm_private_output_vblank_handler {
364 struct list_head link;
366 tdm_private_output *private_output;
369 tdm_output_vblank_handler func;
372 unsigned int sent_to_frontend;
377 struct _tdm_private_output_change_handler {
378 struct list_head link;
380 tdm_private_output *private_output;
381 tdm_output_change_handler func;
387 struct _tdm_private_output_commit_handler {
388 struct list_head link;
390 tdm_private_output *private_output;
391 tdm_output_commit_handler func;
397 struct _tdm_private_hwc_window_commit_handler {
398 tdm_private_hwc_window *private_hwc_window;
399 tdm_hwc_window_commit_handler func;
403 struct _tdm_private_output_hwc_target_buffer_window_commit_handler {
404 tdm_private_output *private_output;
405 tdm_output_hwc_target_buffer_commit_handler func;
409 struct _tdm_private_layer_commit_handler {
410 struct list_head link;
412 tdm_private_layer *private_layer;
413 tdm_layer_commit_handler func;
416 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
419 struct _tdm_private_layer_buffer {
420 tbm_surface_h buffer;
421 struct list_head link;
424 typedef struct _tdm_buffer_info {
425 tbm_surface_h buffer;
427 /* ref_count for backend */
428 int backend_ref_count;
430 struct list_head release_funcs;
431 struct list_head destroy_funcs;
433 struct list_head *list;
434 struct list_head link;
437 typedef struct _tdm_pp_private_buffer {
440 struct list_head link;
441 struct list_head commit_link;
442 } tdm_pp_private_buffer;
444 typedef struct _tdm_capture_private_buffer {
445 tbm_surface_h buffer;
446 struct list_head link;
447 struct list_head commit_link;
448 } tdm_capture_private_buffer;
452 TDM_THREAD_CB_EXIT, /* special type to exit the tdm-thread */
453 TDM_THREAD_CB_OUTPUT_COMMIT,
454 TDM_THREAD_CB_OUTPUT_VBLANK,
455 TDM_THREAD_CB_OUTPUT_STATUS,
456 TDM_THREAD_CB_OUTPUT_DPMS,
457 TDM_THREAD_CB_PP_DONE,
458 TDM_THREAD_CB_CAPTURE_DONE,
459 TDM_THREAD_CB_VBLANK_SW,
460 TDM_THREAD_CB_VBLANK_CREATE,
461 TDM_THREAD_CB_NEED_VALIDATE,
463 } tdm_thread_cb_type;
465 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
466 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
467 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
468 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
469 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
470 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
471 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
472 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
473 typedef struct _tdm_thread_cb_vblank_create tdm_thread_cb_vblank_create;
474 typedef struct _tdm_thread_cb_need_validate tdm_thread_cb_need_validate;
476 struct _tdm_thread_cb_base {
477 tdm_thread_cb_type type;
484 struct _tdm_thread_cb_output_vblank {
485 tdm_thread_cb_base base;
486 unsigned int sequence;
488 unsigned int tv_usec;
491 struct _tdm_thread_cb_output_status {
492 tdm_thread_cb_base base;
493 tdm_output_conn_status status;
496 struct _tdm_thread_cb_output_dpms {
497 tdm_thread_cb_base base;
498 tdm_output_dpms dpms;
501 struct _tdm_thread_cb_pp_done {
502 tdm_thread_cb_base base;
507 struct _tdm_thread_cb_capture_done {
508 tdm_thread_cb_base base;
509 tbm_surface_h buffer;
512 struct _tdm_thread_cb_vblank_sw {
513 tdm_thread_cb_base base;
516 struct _tdm_thread_cb_vblank_create {
517 tdm_thread_cb_base base;
521 struct _tdm_thread_cb_need_validate {
522 tdm_thread_cb_base base;
525 struct argument_details {
534 #endif /* _TDM_PRIVATE_TYPES_H_ */