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 **************************************************************************/
39 #include <tbm_surface.h>
41 #include "tdm_common.h"
49 * @brief The header file which defines Enumerations and Structures for frontend and backend.
51 * Both frontend(@ref tdm.h) and backend(@ref tdm_backend.h) header files
52 * include @ref tdm_types.h
55 * #include <tdm.h> //for a frontend user
58 * #include <tdm_backend.h> //for a vendor to implement a backend module
63 TDM_EVENT_LOOP_READABLE = (1 << 0),
64 TDM_EVENT_LOOP_WRITABLE = (1 << 1),
65 TDM_EVENT_LOOP_HANGUP = (1 << 2),
66 TDM_EVENT_LOOP_ERROR = (1 << 3),
67 } tdm_event_loop_mask;
70 * @brief The output mode structure
72 typedef struct _tdm_output_mode {
74 unsigned int hdisplay, hsync_start, hsync_end, htotal, hskew;
75 unsigned int vdisplay, vsync_start, vsync_end, vtotal, vscan;
76 unsigned int vrefresh;
79 char name[TDM_NAME_LEN];
83 * @brief The property structure
85 typedef struct _tdm_prop {
87 char name[TDM_NAME_LEN];
92 * @brief The info config structure
94 typedef struct _tdm_info_config {
101 * @brief The layer info structre
103 typedef struct _tdm_info_layer {
104 tdm_info_config src_config;
106 tdm_transform transform;
110 * @brief The hwc window info structure
113 typedef struct _tdm_hwc_window_info {
114 tdm_info_config src_config;
116 tdm_transform transform;
117 } tdm_hwc_window_info;
119 typedef struct _tdm_hwc_region {
120 unsigned int num_rects;
121 tdm_pos const *rects;
125 * @brief The pp info structre
127 typedef struct _tdm_info_pp {
128 tdm_info_config src_config;
129 tdm_info_config dst_config;
130 tdm_transform transform;
136 * @brief The capture info structre
138 typedef struct _tdm_info_capture {
139 tdm_info_config dst_config;
140 tdm_transform transform;
141 tdm_capture_type type;
147 * @brief Possible composition types for a given window
152 /** Set by the client for an invisible window. The value by default.
154 * The device ignores windows of this type.
156 TDM_COMPOSITION_NONE = 0,
158 /** The client will composite this window into the client target window
160 * User can choose this type for window to avoid a hardware composition for
163 * The device must not request any composition type changes for windows of
166 TDM_COMPOSITION_CLIENT = 1,
168 /** Set by the client before tdm_output_hwc_validate().
170 * Upon tdm_output_hwc_validate(), the device may request a change from this type to
171 * TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT. */
172 TDM_COMPOSITION_DEVICE_CANDIDATE = 2,
174 /** Set by the HWC after tdm_output_hwc_validate().
176 * The device will handle the composition of this window through a hardware
177 * overlay or other similar means.
179 * Upon tdm_output_hwc_validate(), the device may request a change from this type to
180 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. */
181 TDM_COMPOSITION_DEVICE = 3,
183 /** Similar to DEVICE, but the position of this layer may also be set
184 * asynchronously through layer_set_cursor_position. If this functionality is not
185 * supported on a layer that the client sets to TDM_COMPOSITION_CURSOR, the
186 * device must request that the composition type of that layer is changed to
187 * TDM_COMPOSITION_CLIENT upon the next call to tdm_output_hwc_validate().
189 * Upon tdm_output_hwc_validate(), the device may request a change from this type to
190 * either TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT. Changing to
191 * TDM_COMPOSITION_DEVICE will prevent the use of layer_set_cursor_position but
192 * still permit the device to composite the layer. */
193 TDM_COMPOSITION_CURSOR = 4,
195 /** This type is for the VIDEO window which can be set to the reserved hw overlay
196 * which is assigned by the device.
198 * Normally, this VIDEO window displays under the primary hw overlayer of the output. */
199 TDM_COMPOSITION_VIDEO = 5,
200 } tdm_hwc_window_composition;
203 * @brief The hwc window flag enumeration
207 TDM_HWC_WINDOW_FLAG_NONE = 0,
208 } tdm_hwc_window_flag;
211 * @brief The tdm display object
213 typedef void tdm_display;
216 * @brief The tdm output object
218 typedef void tdm_output;
221 * @brief The tdm layer object
223 typedef void tdm_layer;
226 * @brief The tdm window object
229 typedef void tdm_hwc_window;
232 * @brief The tdm capture object
234 typedef void tdm_capture;
237 * @brief The tdm pp object
242 * @brief The tdm vblank object
244 typedef void tdm_vblank;
247 * @brief The vblank handler
248 * @see output_set_vblank_handler() function of #tdm_func_display
250 typedef void (*tdm_output_vblank_handler)(tdm_output *output, unsigned int sequence,
251 unsigned int tv_sec, unsigned int tv_usec,
255 * @brief The output commit handler
256 * @see output_set_commit_handler() function of #tdm_func_display
258 typedef void (*tdm_output_commit_handler)(tdm_output *output, unsigned int sequence,
259 unsigned int tv_sec, unsigned int tv_usec,
263 * @brief The layer commit handler
265 typedef void (*tdm_layer_commit_handler)(tdm_layer *layer, unsigned int sequence,
266 unsigned int tv_sec, unsigned int tv_usec,
270 * @brief The hwc_window commit handler
272 typedef void (*tdm_hwc_window_commit_handler)(tdm_hwc_window *hwc_window, unsigned int sequence,
273 unsigned int tv_sec, unsigned int tv_usec,
277 * @brief The done handler of a pp object
279 typedef void (*tdm_pp_done_handler)(tdm_pp *pp, tbm_surface_h src,
280 tbm_surface_h dst, void *user_data);
283 * @brief The done handler of a capture object
285 typedef void (*tdm_capture_done_handler)(tdm_capture *capture,
286 tbm_surface_h buffer, void *user_data);
289 * @brief The create handler of a vblank object
291 typedef void (*tdm_vblank_create_handler)(tdm_vblank *vblank, void *user_data);
294 * @brief The 'need to validate' handler of an output object
297 typedef void (*tdm_output_need_validate_handler)(tdm_output *output);
303 #endif /* _TDM_TYPES_H_ */