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_CLIENT_H_
37 #define _TDM_CLIENT_H_
39 #include "tdm_client_types.h"
47 * @brief The header file for a client of TDM.
50 * #include <tdm_client.h> //for a client of TDM
55 * @brief Create a TDM client object.
56 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
57 * @return A TDM client object if success. Otherwise, NULL.
58 * @see #tdm_client_destroy
61 tdm_client_create(tdm_error *error);
64 * @brief Destroy a TDM client object
65 * @param[in] client A TDM client object
66 * @see #tdm_client_create
69 tdm_client_destroy(tdm_client *client);
72 * @brief Get the file descriptor
73 * @param[in] client A TDM client object
74 * @param[out] fd The file descriptor
75 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
76 * @see #tdm_client_handle_events
79 * #include <tdm_client.h> //for a client of TDM
81 * err = tdm_client_get_fd(client, &fd);
82 * if (err != TDM_ERROR_NONE) {
86 * fds.events = POLLIN;
91 * ret = poll(&fds, 1, -1);
93 * if (errno == EINTR || errno == EAGAIN)
100 * err = tdm_client_handle_events(client);
101 * if (err != TDM_ERROR_NONE) {
108 tdm_client_get_fd(tdm_client *client, int *fd);
111 * @brief Handle the events of the given file descriptor
112 * @param[in] client A TDM client object
113 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
114 * @see #tdm_client_get_fd
117 tdm_client_handle_events(tdm_client *client);
120 * @brief Handle the events of the given file descriptor with millisecond timeout
122 * -1: infinite. 0: return immediately. Otherwise, waiting for ms_timeout milliseconds.
123 * @param[in] client A TDM client object
124 * @param[in] ms_timeout timeout value.
125 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
126 * @see #tdm_client_get_fd
129 tdm_client_handle_events_timeout(tdm_client *client, int ms_timeout);
132 * @brief @b Deprecated. Wait for VBLANK.
134 * @details After interval vblanks, a client vblank handler will be called.
135 * If 'sw_timer' param is 1 in case of DPMS off, TDM will use the SW timer and
136 * call a client vblank handler. Otherwise, this function will return error.
137 * @param[in] client A TDM client object
138 * @param[in] name The name of a TDM output
139 * @param[in] sw_timer 0: not using SW timer, 1: using SW timer
140 * @param[in] interval vblank interval
141 * @param[in] sync 0: asynchronous, 1:synchronous
142 * @param[in] func A client vblank handler
143 * @param[in] user_data The user data
144 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
145 * @see #tdm_client_vblank_handler
148 tdm_client_wait_vblank(tdm_client *client, char *name,
149 int sw_timer, int interval, int sync,
150 tdm_client_vblank_handler2 func, void *user_data);
153 * @brief Get the client output object which has the given name.
155 * The client output name can be @b 'primary' or @b 'default' to get the main output.
156 * @param[in] client The TDM client object
157 * @param[in] name The name of the TDM client output object
158 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
159 * @return A client output object if success. Otherwise, NULL.
162 tdm_client_get_output(tdm_client *client, char *name, tdm_error *error);
165 * @brief Add the client output change handler
166 * @details The handler will be called when the status of a
167 * client output object is changed. connection, DPMS, etc.
168 * @param[in] output The client output object
169 * @param[in] func The client output change handler
170 * @param[in] user_data The user data
171 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
174 * #include <tdm_client.h> //for a client of TDM
177 * _client_output_handler(tdm_client_output *output, tdm_output_change_type type,
178 * tdm_value value, void *user_data)
180 * char *conn_str[3] = {"disconnected", "connected", "mode_setted"};
181 * char *dpms_str[4] = {"on", "standy", "suspend", "off"};
183 * if (type == TDM_OUTPUT_CHANGE_CONNECTION)
184 * printf("output %s.\n", conn_str[value.u32]);
185 * else if (type == TDM_OUTPUT_CHANGE_DPMS)
186 * printf("dpms %s.\n", dpms_str[value.u32]);
189 * tdm_client_output_add_change_handler(output, _client_output_handler, NULL);
191 * tdm_client_output_remove_change_handler(output, _client_output_handler, NULL);
196 tdm_client_output_add_change_handler(tdm_client_output *output,
197 tdm_client_output_change_handler func,
201 * @brief Remove the client output change handler
202 * @param[in] output The client output object
203 * @param[in] func The client output change handler
204 * @param[in] user_data The user data
205 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
208 tdm_client_output_remove_change_handler(tdm_client_output *output,
209 tdm_client_output_change_handler func,
213 * @brief Get the vertical refresh rate of the given client output
214 * @param[in] output The client output object
215 * @param[out] refresh The refresh rate
216 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
219 tdm_client_output_get_refresh_rate(tdm_client_output *output, unsigned int *refresh);
222 * @brief Get the connection status of the given client output
223 * @param[in] output The client output object
224 * @param[out] status The connection status
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
228 tdm_client_output_get_conn_status(tdm_client_output *output, tdm_output_conn_status *status);
231 * @brief Get the DPMS value of the given client output
232 * @param[in] output The client output object
233 * @param[out] dpms The DPMS value
234 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
237 tdm_client_output_get_dpms(tdm_client_output *output, tdm_output_dpms *dpms);
240 * @brief Create the client vblank object of the given client output
242 * tdm client vblank basically uses the HW vblank resource. Therefore, if HW vblank
243 * is not available for some reasons, such as output disconnection and dpms off,
244 * #tdm_client_vblank_wait will return error. If you want it to work propery in spite
245 * of these reasons, you can use #tdm_client_vblank_set_enable_fake to get SW fake
247 * @param[in] output The client output object
248 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
249 * @return A client vblank object if success. Otherwise, NULL.
252 tdm_client_output_create_vblank(tdm_client_output *output, tdm_error *error);
255 * @brief Destroy the client vblank object
256 * @param[in] vblank The client vblank object
259 tdm_client_vblank_destroy(tdm_client_vblank *vblank);
262 * @brief Set the name to the client vblank object
263 * @param[in] vblank The client vblank object
264 * @param[in] name The client vblank name
265 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
268 tdm_client_vblank_set_name(tdm_client_vblank *vblank, const char *name);
271 * @brief Set the sync value to the client vblank object
273 * If sync == 1, the user client vblank handler of #tdm_client_vblank_wait
274 * will be called before #tdm_client_vblank_wait returns the result. If sync == 0,
275 * the user client vblank handler of #tdm_client_vblank_wait will be called
276 * asynchronously after #tdm_client_vblank_wait returns. Default is @b asynchronous.
277 * @param[in] vblank The client vblank object
278 * @param[in] sync 0: asynchronous, 1:synchronous
279 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
282 tdm_client_vblank_set_sync(tdm_client_vblank *vblank, unsigned int sync);
285 * @brief Set the fps to the client vblank object
286 * @details Default is the @b vertical @b refresh @b rate of the given client output.
287 * @param[in] vblank The client vblank object
288 * @param[in] fps more than 0
289 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
292 tdm_client_vblank_set_fps(tdm_client_vblank *vblank, unsigned int fps);
295 * @brief Set the offset(milli-second) to the client vblank object
296 * @details Default is @b 0.
297 * @param[in] vblank The client vblank object
298 * @param[in] offset_ms the offset(milli-second)
299 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
302 tdm_client_vblank_set_offset(tdm_client_vblank *vblank, int offset_ms);
305 * @brief Enable/Disable the fake vblank to the client vblank object
307 * If enable_fake == 0, #tdm_client_vblank_wait will return error when HW vblank is
308 * not available. Otherwise, #tdm_client_vblank_wait will return TDM_ERROR_NONE
309 * as success. Once #tdm_client_vblank_wait returns TDM_ERROR_NONE, the user client
310 * vblank handler(#tdm_client_vblank_handler) SHOULD be called after the given
311 * interval of #tdm_client_vblank_wait. Default is @b disable.
312 * @param[in] vblank The client vblank object
313 * @param[in] enable_fake 1:enable, 0:disable
314 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
317 tdm_client_vblank_set_enable_fake(tdm_client_vblank *vblank, unsigned int enable_fake);
320 * @brief Wait for a vblank
322 * This function will return error when HW vblank resource is not available. However,
323 * #tdm_client_vblank_wait will return TDM_ERROR_NONE as success if
324 * #tdm_client_vblank_set_enable_fake sets true. Once #tdm_client_vblank_wait
325 * returns TDM_ERROR_NONE, the user client vblank handler(#tdm_client_vblank_handler)
326 * SHOULD be called after the given interval. \n
327 * The sequence value of tdm_client_vblank_handler is the relative value of fps.
328 * If fps = 10, this sequence value should be increased by 10 during 1 second.
329 * @param[in] vblank The client vblank object
330 * @param[in] interval The vblank interval
331 * @param[in] func The user client vblank handler
332 * @param[in] user_data The user data
333 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
336 * #include <tdm_client.h> //for a client of TDM
339 * _client_vblank_handler(tdm_client_vblank *vblank, tdm_error error, unsigned int sequence,
340 * unsigned int tv_sec, unsigned int tv_usec, void *user_data)
342 * if (error != TDM_ERROR_NONE)
347 * tdm_client_output *output;
348 * tdm_client_vblank *vblank;
353 * cliet = tdm_client_create(&error);
354 * if (error != TDM_ERROR_NONE)
357 * output = tdm_client_get_output(client, NULL, &error);
358 * if (error != TDM_ERROR_NONE)
361 * vblank = tdm_client_output_create_vblank(output, &error);
362 * if (error != TDM_ERROR_NONE)
365 * tdm_client_vblank_set_enable_fake(vblank, enable_fake); //default: disable
366 * tdm_client_vblank_set_sync(vblank, 0); //default: async
367 * tdm_client_vblank_set_fps(vblank, fps); //default: refresh rate of output
368 * tdm_client_vblank_set_offset(vblank, offset); //default: 0
370 * error = tdm_client_get_fd(data->client, &fd);
371 * if (error != TDM_ERROR_NONE)
374 * fds.events = POLLIN;
381 * error = tdm_client_vblank_wait(vblank, interval,
382 * _client_vblank_handler, NULL);
383 * if (error != TDM_ERROR_NONE)
386 * ret = poll(&fds, 1, -1);
388 * if (errno == EINTR || errno == EAGAIN) // normal case
394 * error = tdm_client_handle_events(client);
395 * if (error != TDM_ERROR_NONE)
399 * tdm_client_vblank_destroy(vblank);
400 * tdm_client_destroy(client);
405 tdm_client_vblank_wait(tdm_client_vblank *vblank, unsigned int interval, tdm_client_vblank_handler func, void *user_data);
408 * @brief Wait for a vblank with the target sequence number
410 * This function will return error when HW vblank resource is not available. However,
411 * #tdm_client_vblank_wait will return TDM_ERROR_NONE as success if
412 * #tdm_client_vblank_set_enable_fake sets true. Once #tdm_client_vblank_wait_seq
413 * returns TDM_ERROR_NONE, the user client vblank handler(#tdm_client_vblank_handler)
414 * SHOULD be called on reaching the target sequence.
415 * @param[in] vblank The client vblank object
416 * @param[in] sequence The target sequence number
417 * @param[in] func The user client vblank handler
418 * @param[in] user_data The user data
419 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
422 tdm_client_vblank_wait_seq(tdm_client_vblank *vblank, unsigned int sequence, tdm_client_vblank_handler func, void *user_data);
425 * @brief Check if the client vblank object is waiting a vblank event
426 * @param[in] vblank The client vblank object
427 * @return 1 if waiting. 0 if not waiting.
430 tdm_client_vblank_is_waiting(tdm_client_vblank *vblank);
436 #endif /* _TDM_CLIENT_H_ */