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_COMMON_H_
37 #define _TDM_COMMON_H_
45 #define TDM_NAME_LEN 64
46 #define TDM_PATH_LEN 1024
47 #define TDM_VBLANK_DEFAULT_NAME "Unknown"
51 * @brief The header file which defines Enumerations and Structures for TDM
52 * frontend, backend and client.
56 * @brief The error enumeration
59 TDM_ERROR_NONE = 0, /**< none */
60 TDM_ERROR_BAD_REQUEST = -1, /**< bad request */
61 TDM_ERROR_OPERATION_FAILED = -2, /**< operaion failed */
62 TDM_ERROR_INVALID_PARAMETER = -3, /**< wrong input parameter */
63 TDM_ERROR_PERMISSION_DENIED = -4, /**< access denied */
64 TDM_ERROR_BUSY = -5, /**< hardware resource busy */
65 TDM_ERROR_OUT_OF_MEMORY = -6, /**< no free memory */
66 TDM_ERROR_BAD_MODULE = -7, /**< bad backend module */
67 TDM_ERROR_NOT_IMPLEMENTED = -8, /**< not implemented */
68 TDM_ERROR_NO_CAPABILITY = -9, /**< no capability */
69 TDM_ERROR_DPMS_OFF = -10, /**< dpms off */
70 TDM_ERROR_OUTPUT_DISCONNECTED = -11, /**< output disconnected */
74 * @brief The transform enumeration(rotate, flip)
77 TDM_TRANSFORM_NORMAL = 0, /**< no transform */
78 TDM_TRANSFORM_90 = 1, /**< rotate 90 */
79 TDM_TRANSFORM_180 = 2, /**< rotate 180 */
80 TDM_TRANSFORM_270 = 3, /**< rotate 270 */
81 TDM_TRANSFORM_FLIPPED = 4, /**< no rotate and horizontal flip */
82 TDM_TRANSFORM_FLIPPED_90 = 5, /**< rotate 90 and horizontal flip */
83 TDM_TRANSFORM_FLIPPED_180 = 6, /**< rotate 180 and horizontal flip */
84 TDM_TRANSFORM_FLIPPED_270 = 7, /**< rotate 270 and horizontal flip */
88 * @brief The output capability enumeration
93 TDM_OUTPUT_CAPABILITY_ASYNC_DPMS = (1 << 0), /**< if a outupt supports asynchronous DPMS operation */
94 TDM_OUTPUT_CAPABILITY_HWC = (1 << 1), /**< if a outupt supports hwc operation @since 2.0.0*/
95 } tdm_output_capability;
98 * @brief The layer capability enumeration
100 * A layer can have one of CURSOR, PRIMARY and OVERLAY capability. And a layer
101 * also can have one of GRAPHIC and VIDEO capability. And a layer also can have
102 * SCALE and TRANSFORM capability.\n
106 * capabilities = TDM_LAYER_CAPABILITY_PRIMARY | TDM_LAYER_CAPABILITY_GRAPHIC;
107 * capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_GRAPHIC | TDM_LAYER_CAPABILITY_SCALE;
108 * capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_GRAPHIC | TDM_LAYER_CAPABILITY_SCALE | TDM_LAYER_CAPABILITY_TRANSFORM;
109 * capabilities = TDM_LAYER_CAPABILITY_CURSOR | TDM_LAYER_CAPABILITY_GRAPHIC;
110 * capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_VIDEO;
113 * - When a video plays, in most of cases, video buffers will be displayed to
114 * a GRAPHIC layer after converting RGB buffers via PP. In this case, a backend
115 * module doesn't need to offer VIDEO layer.
116 * - But in case that s vendor wants to handle a video by their own way,
117 * a backend module offer VIDEO layers. And a display server will pass a video
118 * buffer to a VIDEO layer without converting.
121 TDM_LAYER_CAPABILITY_CURSOR = (1 << 0), /**< cursor */
122 TDM_LAYER_CAPABILITY_PRIMARY = (1 << 1), /**< primary */
123 TDM_LAYER_CAPABILITY_OVERLAY = (1 << 2), /**< overlay */
124 TDM_LAYER_CAPABILITY_GRAPHIC = (1 << 4), /**< graphic */
125 TDM_LAYER_CAPABILITY_VIDEO = (1 << 5), /**< video */
126 TDM_LAYER_CAPABILITY_SCALE = (1 << 8), /**< if a layer has scale capability */
127 TDM_LAYER_CAPABILITY_TRANSFORM = (1 << 9), /**< if a layer has transform capability */
128 TDM_LAYER_CAPABILITY_SCANOUT = (1 << 10), /**< if a layer allows a scanout buffer only */
129 TDM_LAYER_CAPABILITY_RESEVED_MEMORY = (1 << 11), /**< if a layer allows a reserved buffer only */
130 TDM_LAYER_CAPABILITY_NO_CROP = (1 << 12), /**< if a layer has no cropping capability */
131 } tdm_layer_capability;
134 * @brief The hwc window capability enumeration
138 TDM_HWC_WINDOW_VIDEO_CAPABILITY_SCALE = (1 << 1), /**< if a hwc window video has scale capability */
139 TDM_HWC_WINDOW_VIDEO_CAPABILITY_TRANSFORM = (1 << 2), /**< if a hwc window video has transform capability */
140 TDM_HWC_WINDOW_VIDEO_CAPABILITY_SCANOUT = (1 << 3), /**< if a hwc_window video allows a scanout buffer only */
141 } tdm_hwc_window_video_capability;
144 * @brief The pp capability enumeration
147 TDM_PP_CAPABILITY_SYNC = (1 << 0), /**< The pp device supports synchronous operation */
148 TDM_PP_CAPABILITY_ASYNC = (1 << 1), /**< The pp device supports asynchronous operation */
149 TDM_PP_CAPABILITY_SCALE = (1 << 4), /**< The pp device supports scale operation */
150 TDM_PP_CAPABILITY_TRANSFORM = (1 << 5), /**< The pp device supports transform operation */
154 * @brief The capture capability enumeration
157 TDM_CAPTURE_CAPABILITY_OUTPUT = (1 << 0), /**< The capture device supports to dump a output */
158 TDM_CAPTURE_CAPABILITY_LAYER = (1 << 1), /**< The capture device supports to dump a layer */
159 TDM_CAPTURE_CAPABILITY_ONESHOT = (1 << 4), /**< The capture device supports oneshot dump */
160 TDM_CAPTURE_CAPABILITY_STREAM = (1 << 5), /**< The capture device supports streamp sump */
161 } tdm_capture_capability;
164 * @brief The capture type enumeration
167 TDM_CAPTURE_TYPE_ONESHOT = (1 << 0), /**< The oneshot capture */
168 TDM_CAPTURE_TYPE_STREAM = (1 << 1), /**< The stream capture */
172 * @brief The output change enumeration of #tdm_output_change_handler
175 TDM_OUTPUT_CHANGE_CONNECTION = (1 << 0), /**< connection chagne */
176 TDM_OUTPUT_CHANGE_DPMS = (1 << 1), /**< dpms change */
177 } tdm_output_change_type;
180 * @brief The output connection status enumeration
183 TDM_OUTPUT_CONN_STATUS_DISCONNECTED, /**< output disconnected */
184 TDM_OUTPUT_CONN_STATUS_CONNECTED, /**< output connected */
185 TDM_OUTPUT_CONN_STATUS_MODE_SETTED, /**< output connected and setted a mode */
186 } tdm_output_conn_status;
189 * @brief The output connection status enumeration
190 * @details bit compatible with the libdrm definitions.
193 TDM_OUTPUT_TYPE_Unknown, /**< unknown */
194 TDM_OUTPUT_TYPE_VGA, /**< VGA connection */
195 TDM_OUTPUT_TYPE_DVII, /**< DVII connection */
196 TDM_OUTPUT_TYPE_DVID, /**< DVID connection */
197 TDM_OUTPUT_TYPE_DVIA, /**< DVIA connection */
198 TDM_OUTPUT_TYPE_Composite, /**< Composite connection */
199 TDM_OUTPUT_TYPE_SVIDEO, /**< SVIDEO connection */
200 TDM_OUTPUT_TYPE_LVDS, /**< LVDS connection */
201 TDM_OUTPUT_TYPE_Component, /**< Component connection */
202 TDM_OUTPUT_TYPE_9PinDIN, /**< 9PinDIN connection */
203 TDM_OUTPUT_TYPE_DisplayPort, /**< DisplayPort connection */
204 TDM_OUTPUT_TYPE_HDMIA, /**< HDMIA connection */
205 TDM_OUTPUT_TYPE_HDMIB, /**< HDMIB connection */
206 TDM_OUTPUT_TYPE_TV, /**< TV connection */
207 TDM_OUTPUT_TYPE_eDP, /**< eDP connection */
208 TDM_OUTPUT_TYPE_VIRTUAL, /**< Virtual connection for WiFi Display */
209 TDM_OUTPUT_TYPE_DSI, /**< DSI connection */
213 * @brief The DPMS enumeration
214 * @details bit compatible with the libdrm definitions.
217 TDM_OUTPUT_DPMS_ON, /**< On */
218 TDM_OUTPUT_DPMS_STANDBY, /**< StandBy */
219 TDM_OUTPUT_DPMS_SUSPEND, /**< Suspend */
220 TDM_OUTPUT_DPMS_OFF, /**< Off */
224 * @brief The output mode type enumeration
225 * @details bit compatible with the libdrm definitions.
228 TDM_OUTPUT_MODE_TYPE_BUILTIN = (1 << 0),
229 TDM_OUTPUT_MODE_TYPE_CLOCK_C = ((1 << 1) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
230 TDM_OUTPUT_MODE_TYPE_CRTC_C = ((1 << 2) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
231 TDM_OUTPUT_MODE_TYPE_PREFERRED = (1 << 3),
232 TDM_OUTPUT_MODE_TYPE_DEFAULT = (1 << 4),
233 TDM_OUTPUT_MODE_TYPE_USERDEF = (1 << 5),
234 TDM_OUTPUT_MODE_TYPE_DRIVER = (1 << 6),
235 } tdm_output_mode_type;
238 * @brief The output mode flag enumeration
239 * @details bit compatible with the libdrm definitions.
242 TDM_OUTPUT_MODE_FLAG_PHSYNC = (1 << 0),
243 TDM_OUTPUT_MODE_FLAG_NHSYNC = (1 << 1),
244 TDM_OUTPUT_MODE_FLAG_PVSYNC = (1 << 2),
245 TDM_OUTPUT_MODE_FLAG_NVSYNC = (1 << 3),
246 TDM_OUTPUT_MODE_FLAG_INTERLACE = (1 << 4),
247 TDM_OUTPUT_MODE_FLAG_DBLSCAN = (1 << 5),
248 TDM_OUTPUT_MODE_FLAG_CSYNC = (1 << 6),
249 TDM_OUTPUT_MODE_FLAG_PCSYNC = (1 << 7),
250 TDM_OUTPUT_MODE_FLAG_NCSYNC = (1 << 8),
251 TDM_OUTPUT_MODE_FLAG_HSKEW = (1 << 9), /* hskew provided */
252 TDM_OUTPUT_MODE_FLAG_BCAST = (1 << 10),
253 TDM_OUTPUT_MODE_FLAG_PIXMUX = (1 << 11),
254 TDM_OUTPUT_MODE_FLAG_DBLCLK = (1 << 12),
255 TDM_OUTPUT_MODE_FLAG_CLKDIV2 = (1 << 13),
256 } tdm_output_mode_flag;
259 * @brief The size structure
261 typedef struct _tdm_size {
262 unsigned int h; /**< width */
263 unsigned int v; /**< height */
267 * @brief The pos structure
269 typedef struct _tdm_pos {
276 typedef struct _tdm_hwc_region {
277 unsigned int num_rects;
278 tdm_pos const *rects;
282 * @brief The tdm value type enumeration
285 TDM_VALUE_TYPE_UNKNOWN,
287 TDM_VALUE_TYPE_INT32,
288 TDM_VALUE_TYPE_UINT32,
289 TDM_VALUE_TYPE_INT64,
290 TDM_VALUE_TYPE_UINT64,
294 * @brief The value union
305 * @brief The hwc window flag enumeration
309 TDM_HWC_WINDOW_FLAG_SKIP = (1 << 0),
310 } tdm_hwc_window_flag;
316 #endif /* _TDM_COMMON_H_ */