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_voutput tdm_private_voutput;
103 typedef struct _tdm_private_layer tdm_private_layer;
104 typedef struct _tdm_private_hwc tdm_private_hwc;
105 typedef struct _tdm_private_hwc_window tdm_private_hwc_window;
106 typedef struct _tdm_private_pp tdm_private_pp;
107 typedef struct _tdm_private_capture tdm_private_capture;
108 typedef struct _tdm_private_loop tdm_private_loop;
109 typedef struct _tdm_private_server tdm_private_server;
110 typedef struct _tdm_private_thread tdm_private_thread;
111 typedef struct _tdm_private_output_create_handler tdm_private_output_create_handler;
112 typedef struct _tdm_private_output_destroy_handler tdm_private_output_destroy_handler;
113 typedef struct _tdm_private_output_change_handler tdm_private_output_change_handler;
114 typedef struct _tdm_private_output_commit_handler tdm_private_output_commit_handler;
115 typedef struct _tdm_private_output_vblank_handler tdm_private_output_vblank_handler;
116 typedef struct _tdm_private_output_mode_change_handler tdm_private_output_mode_change_handler;
117 typedef struct _tdm_private_layer_commit_handler tdm_private_layer_commit_handler;
118 typedef struct _tdm_private_hwc_commit_handler tdm_private_hwc_commit_handler;
119 typedef struct _tdm_private_voutput_commit_handler tdm_private_voutput_commit_handler;
121 typedef struct _tdm_private_layer_buffer tdm_private_layer_buffer;
123 struct _tdm_private_module {
124 struct list_head link;
126 tdm_private_display *private_display;
128 /* backend module info */
130 tdm_backend_module *module_data;
131 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_voutput func_voutput;
138 tdm_func_layer func_layer;
139 tdm_func_hwc func_hwc;
140 tdm_func_hwc_window func_hwc_window;
142 tdm_func_capture func_capture;
144 /* backend capability */
145 tdm_caps_display caps_display;
147 tdm_caps_capture caps_capture;
149 /* output, pp list */
150 struct list_head output_list;
151 struct list_head voutput_list;
152 struct list_head pp_list;
153 struct list_head capture_list;
155 /* backend output objects. allocated in backend. freed in frontend. ordered */
156 tdm_output **outputs;
159 tdm_event_loop_source *event_source;
161 /* backend virtual output target buffer type default set for hwc */
162 int use_default_type_bo;
165 struct _tdm_private_display {
166 pthread_mutex_t lock;
167 unsigned int init_count;
175 struct list_head module_list;
176 tdm_private_module *dummy_module;
177 tdm_private_module *virtual_module;
178 tdm_private_module *current_module; //setted only when loading
179 tdm_private_module *pp_module; //pp-support backend
180 tdm_private_module *capture_module; //TODO: remove later
182 /* for event handling */
183 tdm_private_loop *private_loop;
185 struct list_head output_create_handler_list;
190 struct _tdm_private_output {
191 struct list_head link;
193 tdm_private_module *private_module;
194 tdm_private_voutput *private_voutput;
199 tdm_private_display *private_display;
201 tdm_caps_output caps;
202 tdm_output *output_backend;
205 tdm_output_dpms current_dpms_value;
206 unsigned int waiting_dpms_change;
207 const tdm_output_mode *current_mode;
209 int regist_vblank_cb;
210 int regist_commit_cb;
211 int regist_change_cb;
214 struct list_head layer_list;
215 struct list_head capture_list;
216 struct list_head vblank_handler_list;
217 struct list_head output_commit_handler_list;
219 /* for layer commit */
220 struct list_head layer_commit_handler_list;
221 struct list_head pending_commit_handler_list;
223 int layer_waiting_vblank;
225 tdm_event_loop_source *vblank_timeout_timer;
226 unsigned int vblank_timeout_timer_expired;
228 struct list_head destroy_handler_list;
229 struct list_head change_handler_list;
233 tdm_info_layer target_buffer_info; /* layer_info for the target_buffer */
235 /* calling a output commit per a vblank */
236 int commit_per_vblank;
237 tdm_commit_type commit_type;
239 /* for ttrace vblank */
240 tdm_vblank *ttrace_vblank;
243 int need_set_target_info;
244 tdm_private_hwc *private_hwc;
247 char name[TDM_NAME_LEN];
248 struct list_head mode_change_request_handler_list;
251 struct _tdm_private_voutput {
252 struct list_head link;
254 tdm_private_module *private_module;
256 int regist_commit_cb;
258 struct list_head voutput_commit_handler_list;
262 tdm_private_display *private_display;
263 tdm_private_output *private_output;
265 tdm_voutput *voutput_backend;
267 char name[TDM_NAME_LEN];
268 tdm_output_mode *modes;
270 unsigned int mmwidth;
271 unsigned int mmheight;
274 int set_voutput_commit;
277 struct _tdm_private_layer {
278 struct list_head link;
280 tdm_private_module *private_module;
284 tdm_private_display *private_display;
285 tdm_private_output *private_output;
288 tdm_layer *layer_backend;
290 /* pending data until committed */
291 unsigned int pending_info_changed;
292 tdm_info_layer pending_info;
293 unsigned int pending_buffer_changed;
294 tbm_surface_h pending_buffer;
296 /* When a buffer is set to a layer, it will be stored to waiting_buffer.
297 * And when a layer is committed, it will be moved to committed_buffer.
298 * Finally when a commit handler is called, it will be moved to showing_buffer.
300 tdm_private_layer_buffer *waiting_buffer;
301 tdm_private_layer_buffer *committed_buffer; /* for output_commit */
302 tdm_private_layer_buffer *showing_buffer;
303 tbm_surface_queue_h buffer_queue;
305 struct list_head capture_list;
308 unsigned int committing;
311 unsigned int fps_count;
314 tbm_surface_h commiting_buffer;
317 struct _tdm_private_hwc {
318 struct list_head link;
320 tdm_private_module *private_module;
325 tdm_private_output *private_output;
327 struct list_head hwc_window_list;
328 struct list_head hwc_commit_handler_list;
330 int regist_commit_cb;
332 tdm_hwc *hwc_backend;
334 tbm_surface_h display_target_buffer;
337 unsigned int fps_count;
340 struct _tdm_private_hwc_window {
341 struct list_head link;
343 tdm_private_module *private_module;
345 tdm_private_hwc *private_hwc;
346 tdm_hwc_window *hwc_window_backend;
349 struct _tdm_private_pp {
350 struct list_head link;
352 tdm_private_module *private_module;
356 tdm_private_display *private_display;
360 struct list_head pending_buffer_list;
361 struct list_head buffer_list;
366 tdm_pp_done_handler done_func;
367 void *done_user_data;
370 struct _tdm_private_capture {
371 struct list_head link;
372 struct list_head display_link;
374 tdm_private_module *private_module;
378 tdm_capture_target target;
380 tdm_private_display *private_display;
381 tdm_private_output *private_output;
382 tdm_private_layer *private_layer;
384 tdm_capture *capture_module;
386 struct list_head pending_buffer_list;
387 struct list_head buffer_list;
389 tdm_info_capture info;
392 tdm_capture_done_handler done_func;
393 void *done_user_data;
397 * Note that we don't need to (un)lock mutex to use this structure. If there is
398 * no TDM thread, all TDM resources are protected by private_display's mutex.
399 * If there is a TDM thread, this struct will be used only in a TDM thread.
400 * So, we don't need to protect this structure by mutex. Not thread-safe.
402 struct _tdm_private_loop {
403 /* TDM uses wl_event_loop to handle various event sources including the TDM
406 struct wl_display *wl_display;
407 struct wl_event_loop *wl_loop;
409 /* In event loop, all resources are accessed by this dpy.
411 * - DO NOT include other private structure in this structure because this
412 * struct is not protected by mutex.
416 /* for handling TDM client requests */
417 tdm_private_server *private_server;
419 /* To have a TDM event thread. If TDM_THREAD enviroment variable is not set
420 * private_thread is NULL.
422 tdm_private_thread *private_thread;
424 struct list_head source_list;
427 struct _tdm_private_output_vblank_handler {
428 struct list_head link;
430 tdm_private_output *private_output;
433 tdm_output_vblank_handler func;
436 unsigned int sent_to_frontend;
441 struct _tdm_private_output_create_handler {
442 struct list_head link;
444 tdm_private_display *private_display;
445 tdm_output_create_handler func;
451 struct _tdm_private_output_destroy_handler {
452 struct list_head link;
454 tdm_private_output *private_output;
455 tdm_output_destroy_handler func;
461 struct _tdm_private_output_change_handler {
462 struct list_head link;
464 tdm_private_output *private_output;
465 tdm_output_change_handler func;
471 struct _tdm_private_output_commit_handler {
472 struct list_head link;
474 tdm_private_output *private_output;
475 tdm_output_commit_handler func;
481 struct _tdm_private_voutput_commit_handler {
482 struct list_head link;
484 tdm_private_voutput *private_voutput;
485 tdm_voutput_commit_func func;
491 struct _tdm_private_output_mode_change_handler {
492 struct list_head link;
494 tdm_private_output *private_output;
495 tdm_output_mode_change_request_handler func;
499 struct _tdm_private_hwc_commit_handler {
500 struct list_head link;
502 tdm_private_hwc *private_hwc;
503 tdm_hwc_commit_handler func;
510 struct _tdm_private_layer_commit_handler {
511 struct list_head link;
513 tdm_private_layer *private_layer;
514 tdm_layer_commit_handler func;
517 tdm_private_layer_buffer *committed_buffer; /* for layer_commit */
520 struct _tdm_private_layer_buffer {
521 tbm_surface_h buffer;
522 struct list_head link;
525 typedef struct _tdm_buffer_info {
526 tbm_surface_h buffer;
528 /* ref_count for backend */
529 int backend_ref_count;
531 struct list_head release_funcs;
532 struct list_head destroy_funcs;
534 struct list_head *list;
535 struct list_head link;
538 typedef struct _tdm_pp_private_buffer {
541 struct list_head link;
542 struct list_head commit_link;
543 } tdm_pp_private_buffer;
545 typedef struct _tdm_capture_private_buffer {
546 tbm_surface_h buffer;
547 struct list_head link;
548 struct list_head commit_link;
549 } tdm_capture_private_buffer;
553 TDM_THREAD_CB_EXIT, /* special type to exit the tdm-thread */
554 TDM_THREAD_CB_DISPLAY_OUTPUT_CREATE,
555 TDM_THREAD_CB_OUTPUT_DESTROY,
556 TDM_THREAD_CB_OUTPUT_COMMIT,
557 TDM_THREAD_CB_OUTPUT_VBLANK,
558 TDM_THREAD_CB_OUTPUT_STATUS,
559 TDM_THREAD_CB_OUTPUT_DPMS,
560 TDM_THREAD_CB_PP_DONE,
561 TDM_THREAD_CB_CAPTURE_DONE,
562 TDM_THREAD_CB_VBLANK_SW,
563 TDM_THREAD_CB_VBLANK_CREATE,
564 TDM_THREAD_CB_HWC_COMMIT,
565 TDM_THREAD_CB_VOUTPUT_COMMIT,
567 } tdm_thread_cb_type;
569 typedef struct _tdm_thread_cb_base tdm_thread_cb_base;
570 typedef struct _tdm_thread_cb_display_output_create tdm_thread_cb_display_output_create;
571 typedef struct _tdm_thread_cb_output_destroy tdm_thread_cb_output_destroy;
572 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_commit;
573 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_output_vblank;
574 typedef struct _tdm_thread_cb_output_dpms tdm_thread_cb_output_dpms;
575 typedef struct _tdm_thread_cb_output_status tdm_thread_cb_output_status;
576 typedef struct _tdm_thread_cb_pp_done tdm_thread_cb_pp_done;
577 typedef struct _tdm_thread_cb_capture_done tdm_thread_cb_capture_done;
578 typedef struct _tdm_thread_cb_vblank_sw tdm_thread_cb_vblank_sw;
579 typedef struct _tdm_thread_cb_vblank_create tdm_thread_cb_vblank_create;
580 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_hwc_commit;
581 typedef struct _tdm_thread_cb_output_vblank tdm_thread_cb_voutput_commit;
583 struct _tdm_thread_cb_base {
584 tdm_thread_cb_type type;
591 struct _tdm_thread_cb_display_output_create {
592 tdm_thread_cb_base base;
596 struct _tdm_thread_cb_output_destroy {
597 tdm_thread_cb_base base;
600 struct _tdm_thread_cb_output_vblank {
601 tdm_thread_cb_base base;
602 unsigned int sequence;
604 unsigned int tv_usec;
607 struct _tdm_thread_cb_output_status {
608 tdm_thread_cb_base base;
609 tdm_output_conn_status status;
612 struct _tdm_thread_cb_output_dpms {
613 tdm_thread_cb_base base;
614 tdm_output_dpms dpms;
617 struct _tdm_thread_cb_pp_done {
618 tdm_thread_cb_base base;
623 struct _tdm_thread_cb_capture_done {
624 tdm_thread_cb_base base;
625 tbm_surface_h buffer;
628 struct _tdm_thread_cb_vblank_sw {
629 tdm_thread_cb_base base;
632 struct _tdm_thread_cb_vblank_create {
633 tdm_thread_cb_base base;
637 struct argument_details {
646 #endif /* _TDM_PRIVATE_TYPES_H_ */