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_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_backend tdm_private_backend;
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_backend {
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 backend_list;
165 tdm_private_backend *current_backend; //setted only when loading
166 tdm_private_backend *pp_backend; //pp-support backend
167 tdm_private_backend *capture_backend; //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_backend *private_backend;
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;
212 struct list_head change_handler_list;
217 /* look at the tdm_output_set_need_revalidate_handler() declaration for the details */
218 tdm_output_need_validate_handler hndl;
220 tdm_event_loop_source *event_source;
223 tdm_info_layer target_buffer_info; /* layer_info for the target_buffer */
225 /* calling a output commit per a vblank */
226 int commit_per_vblank;
227 tdm_commit_type commit_type;
229 /* for ttrace vblank */
230 tdm_vblank *ttrace_vblank;
233 int need_set_target_info;
236 struct _tdm_private_layer {
237 struct list_head link;
239 tdm_private_backend *private_backend;
243 tdm_private_display *private_display;
244 tdm_private_output *private_output;
247 tdm_layer *layer_backend;
249 /* pending data until committed */
250 unsigned int pending_info_changed;
251 tdm_info_layer pending_info;
252 unsigned int pending_buffer_changed;
253 tbm_surface_h pending_buffer;
255 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
256 * And when a layer is committed, it will be moved to committed_buffer.
257 * Finally when a commit handler is called, it will be moved to showing_buffer.
259 tdm_private_layer_buffer *waiting_buffer;
260 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
261 tdm_private_layer_buffer *showing_buffer;
262 tbm_surface_queue_h buffer_queue;
264 struct list_head capture_list;
267 unsigned int committing;
270 unsigned int fps_count;
273 struct _tdm_private_hwc_window {
274 struct list_head link;
278 tdm_private_display *private_display;
279 tdm_private_output *private_output;
281 tdm_hwc_window *hwc_window_backend;
284 struct _tdm_private_pp {
285 struct list_head link;
287 tdm_private_backend *private_backend;
291 tdm_private_display *private_display;
295 struct list_head pending_buffer_list;
296 struct list_head buffer_list;
301 tdm_pp_done_handler done_func;
302 void *done_user_data;
305 struct _tdm_private_capture {
306 struct list_head link;
307 struct list_head display_link;
309 tdm_private_backend *private_backend;
313 tdm_capture_target target;
315 tdm_private_display *private_display;
316 tdm_private_output *private_output;
317 tdm_private_layer *private_layer;
319 tdm_capture *capture_backend;
321 struct list_head pending_buffer_list;
322 struct list_head buffer_list;
324 tdm_info_capture info;
327 tdm_capture_done_handler done_func;
328 void *done_user_data;
332 * Note that we don't need to (un)lock mutex to use this structure. If there is
333 * no TDM thread, all TDM resources are protected by private_display's mutex.
334 * If there is a TDM thread, this struct will be used only in a TDM thread.
335 * So, we don't need to protect this structure by mutex. Not thread-safe.
337 struct _tdm_private_loop {
338 /* TDM uses wl_event_loop to handle various event sources including the TDM
341 struct wl_display *wl_display;
342 struct wl_event_loop *wl_loop;
344 /* In event loop, all resources are accessed by this dpy.
346 * - DO NOT include other private structure in this structure because this
347 * struct is not protected by mutex.
351 /* for handling TDM client requests */
352 tdm_private_server *private_server;
354 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
355 * private_thread is NULL.
357 tdm_private_thread *private_thread;
360 struct _tdm_private_output_vblank_handler {
361 struct list_head link;
363 tdm_private_output *private_output;
366 tdm_output_vblank_handler func;
369 unsigned int sent_to_frontend;
374 struct _tdm_private_output_change_handler {
375 struct list_head link;
377 tdm_private_output *private_output;
378 tdm_output_change_handler func;
384 struct _tdm_private_output_commit_handler {
385 struct list_head link;
387 tdm_private_output *private_output;
388 tdm_output_commit_handler func;
394 struct _tdm_private_hwc_window_commit_handler {
395 tdm_private_hwc_window *private_hwc_window;
396 tdm_hwc_window_commit_handler func;
400 struct _tdm_private_output_hwc_target_buffer_window_commit_handler {
401 tdm_private_output *private_output;
402 tdm_output_hwc_target_buffer_commit_handler func;
406 struct _tdm_private_layer_commit_handler {
407 struct list_head link;
409 tdm_private_layer *private_layer;
410 tdm_layer_commit_handler func;
413 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
416 struct _tdm_private_layer_buffer {
417 tbm_surface_h buffer;
418 struct list_head link;
421 typedef struct _tdm_buffer_info {
422 tbm_surface_h buffer;
424 /* ref_count for backend */
425 int backend_ref_count;
427 struct list_head release_funcs;
428 struct list_head destroy_funcs;
430 struct list_head *list;
431 struct list_head link;
434 typedef struct _tdm_pp_private_buffer {
437 struct list_head link;
438 struct list_head commit_link;
439 } tdm_pp_private_buffer;
441 typedef struct _tdm_capture_private_buffer {
442 tbm_surface_h buffer;
443 struct list_head link;
444 struct list_head commit_link;
445 } tdm_capture_private_buffer;
449 TDM_THREAD_CB_OUTPUT_COMMIT,
450 TDM_THREAD_CB_OUTPUT_VBLANK,
451 TDM_THREAD_CB_OUTPUT_CHANGE,
452 TDM_THREAD_CB_PP_DONE,
453 TDM_THREAD_CB_CAPTURE_DONE,
454 TDM_THREAD_CB_VBLANK_SW,
455 TDM_THREAD_CB_VBLANK_CREATE,
456 TDM_THREAD_CB_NEED_VALIDATE,
458 } tdm_thread_cb_type;
460 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
461 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
462 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
463 typedef struct _tdm_thread_cb_output_change tdm_thread_cb_output_change;
464 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
465 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
466 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
467 typedef struct _tdm_thread_cb_vblank_create tdm_thread_cb_vblank_create;
468 typedef struct _tdm_thread_cb_need_validate tdm_thread_cb_need_validate;
470 struct _tdm_thread_cb_base {
471 tdm_thread_cb_type type;
478 struct _tdm_thread_cb_output_vblank {
479 tdm_thread_cb_base base;
480 unsigned int sequence;
482 unsigned int tv_usec;
485 struct _tdm_thread_cb_output_change {
486 tdm_thread_cb_base base;
487 tdm_output_change_type type;
491 struct _tdm_thread_cb_pp_done {
492 tdm_thread_cb_base base;
497 struct _tdm_thread_cb_capture_done {
498 tdm_thread_cb_base base;
499 tbm_surface_h buffer;
502 struct _tdm_thread_cb_vblank_sw {
503 tdm_thread_cb_base base;
506 struct _tdm_thread_cb_vblank_create {
507 tdm_thread_cb_base base;
511 struct _tdm_thread_cb_need_validate {
512 tdm_thread_cb_base base;
515 struct argument_details {
524 #endif /* _TDM_PRIVATE_TYPES_H_ */