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_BACKEND_H_
37 #define _TDM_BACKEND_H_
39 #include <tbm_surface.h>
40 #include <tbm_surface_queue.h>
42 #include "tdm_types.h"
50 * @brief The backend header file of TDM to implement a TDM backend module.
53 * #include <tdm_backend.h>
58 * @brief The backend module data
60 * The init() function of #tdm_backend_module returns the backend module data.
61 * And it will be passed to display functions of #tdm_func_display.
62 * @see tdm_backend_module, tdm_backend_module
64 typedef void tdm_backend_data;
67 * @brief The output status handler
68 * @details This handler will be called when the status of a output object is
71 typedef void (*tdm_output_status_handler)(tdm_output *output,
72 tdm_output_conn_status status,
76 * @brief The output dpms handler
77 * @details This handler will be called when the dpms of a output object is
80 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
85 * @brief The display capabilities structure of a backend module
86 * @see The display_get_capability() function of #tdm_func_display
88 typedef struct _tdm_caps_display {
89 int max_layer_count; /**< The maximum layer count */
93 * @brief The capabilities structure of a output object
94 * @see The output_get_capability() function of #tdm_func_output
96 typedef struct _tdm_caps_output {
97 char maker[TDM_NAME_LEN]; /**< The output maker */
98 char model[TDM_NAME_LEN]; /**< The output model */
99 char name[TDM_NAME_LEN]; /**< The output name */
101 tdm_output_conn_status status; /**< The connection status */
102 tdm_output_type type; /**< The connection type */
103 unsigned int type_id; /**< The connection type id */
105 unsigned int mode_count; /**< The count of available modes */
106 tdm_output_mode *modes; /**< The @b newly-allocated array of modes. will be freed in frontend. */
108 unsigned int prop_count; /**< The count of available properties */
109 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
111 unsigned int mmWidth; /**< The physical width (milimeter) */
112 unsigned int mmHeight; /**< The physical height (milimeter) */
113 unsigned int subpixel; /**< The subpixel */
115 int min_w; /**< The minimun width */
116 int min_h; /**< The minimun height */
117 int max_w; /**< The maximum width */
118 int max_h; /**< The maximum height */
119 int preferred_align; /**< The prefered align */
121 tdm_output_capability capabilities; /**< The capabilities of output. @since 1.4.1 */
123 int cursor_min_w; /**< The minimun width. @since 1.5.0 */
124 int cursor_min_h; /**< The minimun height. @since 1.5.0 */
125 int cursor_max_w; /**< The maximum width. @since 1.5.0 */
126 int cursor_max_h; /**< The maximum height. @since 1.5.0 */
127 int cursor_preferred_align; /**< The prefered align. @since 1.5.0 */
131 * @brief The capabilities structure of a layer object
132 * @see The layer_get_capability() function of #tdm_func_layer
134 typedef struct _tdm_caps_layer {
135 tdm_layer_capability capabilities; /**< The capabilities of layer */
139 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
140 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
141 * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
142 * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
143 * layers or more than GRAPHIC layers.
144 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
145 * The zpos of VIDEO layers is @b relative. It doesn't need to start
146 * from -1 or 4. Let's suppose that there are two VIDEO layers.
147 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
148 * than -4 VIDEO layer.
152 unsigned int format_count; /**< The count of available formats */
154 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
156 unsigned int prop_count; /**< The count of available properties */
157 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
161 * @brief The capabilities structure of a pp object
162 * @see The display_get_pp_capability() function of #tdm_func_display
164 typedef struct _tdm_caps_pp {
165 tdm_pp_capability capabilities; /**< The capabilities of pp */
167 unsigned int format_count; /**< The count of available formats */
169 *formats; /**< The @b newly-allocated array. will be freed in frontend. */
171 int min_w; /**< The minimun width */
172 int min_h; /**< The minimun height */
173 int max_w; /**< The maximum width */
174 int max_h; /**< The maximum height */
175 int preferred_align; /**< The prefered align */
177 /**< The attach count which a PP object can handle. @since 1.2.0 */
178 int max_attach_count;
182 * @brief The capabilities structure of a capture object
183 * @see The display_get_capture_capability() function of #tdm_func_display
185 typedef struct _tdm_caps_capture {
186 tdm_capture_capability capabilities; /**< The capabilities of capture */
188 unsigned int format_count; /**< The count of available formats */
190 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
192 int min_w; /**< The minimun width */
193 int min_h; /**< The minimun height */
194 int max_w; /**< The maximum width */
195 int max_h; /**< The maximum height */
196 int preferred_align; /**< The prefered align */
198 /**< The attach count which a capture object can handle. @since 1.2.0 */
199 int max_attach_count;
203 * @brief The display functions for a backend module.
205 typedef struct _tdm_func_display {
207 * @brief Get the display capabilities of a backend module
208 * @param[in] bdata The backend module data
209 * @param[out] caps The display capabilities of a backend module
210 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
212 * A backend module @b SHOULD implement this function. TDM calls this function
213 * not only at the initial time, but also at the update time when new output
215 * If a hardware has the restriction of the number of max usable layer count,
216 * a backend module can set the max count to max_layer_count of #tdm_caps_display
219 tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
222 * @brief Get the pp capabilities of a backend module
223 * @param[in] bdata The backend module data
224 * @param[out] caps The pp capabilities of a backend module
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
226 * @see tdm_backend_register_func_pp
228 * TDM calls this function not only at the initial time, but also at the update
229 * time when new output is connected.\n
230 * A backend module doesn't need to implement this function if a hardware
231 * doesn't have the memory-to-memory converting device. Otherwise, a backend module
232 * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
233 * restriction information which a converting device can handle. ie, format, size, etc.
235 tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
238 * @brief Get the capture capabilities of a backend module
239 * @param[in] bdata The backend module data
240 * @param[out] caps The capture capabilities of a backend module
241 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
242 * @see tdm_backend_register_func_capture
244 * TDM calls this function not only at the initial time, but also at the update
245 * time when new output is connected.\n
246 * A backend module doesn't need to implement this function if a hardware
247 * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
248 * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
249 * information which a capture device can handle. ie, format, size, etc.
251 tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
254 * @brief Get a output array of a backend module
255 * @param[in] bdata The backend module data
256 * @param[out] count The count of outputs
257 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
258 * @return A output array which is @b newly-allocated
259 * @see tdm_backend_register_func_capture
261 * A backend module @b SHOULD implement this function. TDM calls this function
262 * not only at the initial time, but also at the update time when new output
264 * A backend module @b SHOULD return the @b newly-allocated array which contains
265 * "tdm_output*" data. It will be freed in frontend.
269 * drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
271 * tdm_drm_data *drm_data = bdata;
272 * tdm_drm_output_data *output_data = NULL;
273 * tdm_output **outputs;
277 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
282 * if (error) *error = TDM_ERROR_NONE;
286 * // will be freed in frontend
287 * outputs = calloc(*count, sizeof(tdm_drm_output_data*));
291 * if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
296 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
297 * outputs[i++] = output_data;
299 * if (error) *error = TDM_ERROR_NONE;
305 tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
309 * @brief Get the file descriptor of a backend module
310 * @param[in] bdata The backend module data
311 * @param[out] fd The fd of a backend module
312 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
313 * @see display_handle_events() function of #tdm_func_display
315 * A backend module can return epoll's fd which is watching the backend device one more fds.
317 tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
320 * @brief Handle the events which happens on the fd of a backend module
321 * @param[in] bdata The backend module data
322 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
324 tdm_error (*display_handle_events)(tdm_backend_data *bdata);
327 * @brief Create a pp object of a backend module
328 * @param[in] bdata The backend module data
329 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
330 * @return A pp object
331 * @see pp_destroy() function of #tdm_func_pp
333 * A backend module doesn't need to implement this function if a hardware
334 * doesn't have the memory-to-memory converting device.
336 tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
339 tdm_output *(*display_output_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
340 tdm_error (*display_output_destroy)(tdm_backend_data *bdata, tdm_output *output);
342 void (*reserved3)(void);
343 void (*reserved4)(void);
344 void (*reserved5)(void);
345 void (*reserved6)(void);
346 void (*reserved7)(void);
347 void (*reserved8)(void);
351 * @brief The output functions for a backend module.
353 typedef struct _tdm_func_output {
355 * @brief Get the capabilities of a output object
356 * @param[in] output A output object
357 * @param[out] caps The capabilities of a output object
358 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
360 * A backend module @b SHOULD implement this function. TDM calls this function
361 * not only at the initial time, but also at the update time when new output
363 * #tdm_caps_output contains connection status, modes, avaiable properties,
364 * size restriction information, etc.
366 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
369 * @brief Get a layer array of a output object
370 * @param[in] output A output object
371 * @param[out] count The count of layers
372 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
373 * @return A layer array which is @b newly-allocated
375 * A backend module @b SHOULD implement this function. TDM calls this function
376 * not only at the initial time, but also at the update time when new output
378 * A backend module @b SHOULD return the @b newly-allocated array which contains
379 * "tdm_layer*" data. It will be freed in frontend.
381 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
385 * @brief Set the property which has a given id
386 * @param[in] output A output object
387 * @param[in] id The property id
388 * @param[in] value The value
389 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
391 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
395 * @brief Get the property which has a given id
396 * @param[in] output A output object
397 * @param[in] id The property id
398 * @param[out] value The value
399 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
401 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
405 * @brief Wait for VBLANK
406 * @param[in] output A output object
407 * @param[in] interval vblank interval
408 * @param[in] sync 0: asynchronous, 1:synchronous
409 * @param[in] user_data The user data
410 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
411 * @see output_set_vblank_handler, tdm_output_vblank_handler
413 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
414 * a user vblank handler with the user data of this function after interval
417 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
421 * @brief Set a user vblank handler
422 * @param[in] output A output object
423 * @param[in] func A user vblank handler
424 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
426 tdm_error (*output_set_vblank_handler)(tdm_output *output,
427 tdm_output_vblank_handler func);
430 * @brief Commit changes for a output object
431 * @param[in] output A output object
432 * @param[in] sync 0: asynchronous, 1:synchronous
433 * @param[in] user_data The user data
434 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
435 * @see output_set_commit_handler, tdm_output_commit_handler
437 * When this function is called, a backend module @b SHOULD apply the all
438 * changes of the given output object to screen as well as the layer changes
440 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
441 * a user commit handler with the user data of this function after all
442 * changes of the given output object are applied.
444 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
447 * @brief Set a user commit handler
448 * @param[in] output A output object
449 * @param[in] func A user commit handler
450 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
452 tdm_error (*output_set_commit_handler)(tdm_output *output,
453 tdm_output_commit_handler func);
456 * @brief Set DPMS of a output object synchronously
457 * @param[in] output A output object
458 * @param[in] dpms_value DPMS value
459 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
461 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
464 * @brief Get DPMS of a output object
465 * @param[in] output A output object
466 * @param[out] dpms_value DPMS value
467 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
469 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
472 * @brief Set one of available modes of a output object
473 * @param[in] output A output object
474 * @param[in] mode A output mode
475 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
477 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
480 * @brief Get the mode of a output object
481 * @param[in] output A output object
482 * @param[out] mode A output mode
483 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
485 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
488 * @brief Create a capture object of a output object
489 * @param[in] output A output object
490 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
491 * @return A capture object
492 * @see capture_destroy() function of #tdm_func_capture
494 * A backend module doesn't need to implement this function if a hardware
495 * doesn't have the capture device.
497 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
500 * @brief Set a output connection status handler
501 * @details A backend module need to call the output status handler when the
502 * output connection status has been changed to let the TDM frontend know
504 * @param[in] output A output object
505 * @param[in] func A output status handler
506 * @param[in] user_data The user data
507 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
510 tdm_error (*output_set_status_handler)(tdm_output *output,
511 tdm_output_status_handler func,
515 * @brief Set a output dpms handler
516 * @details This function can be NULL if an output doesn't support asynchronous
517 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
518 * to let the TDM frontend know the output DPMS change indeed.
519 * @param[in] output A output object
520 * @param[in] func A output dpms handler
521 * @param[in] user_data The user data
522 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
523 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
526 tdm_error (*output_set_dpms_handler)(tdm_output *output,
527 tdm_output_dpms_handler func,
531 * @brief Set DPMS of a output object asynchronously
532 * @param[in] output A output object
533 * @details This function can be NULL if an output doesn't support asynchronous
534 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
535 * flags which #output_get_capability returns. And if a output dpms handler is added with
536 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
537 * to let the TDM frontend know the output DPMS change indeed.
538 * @param[in] dpms_value DPMS value
539 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
540 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
543 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
546 * @brief Get a hwc object of a output object
547 * @param[in] output A output object
548 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
549 * @return A hwc object
551 tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
553 void (*reserved5)(void);
554 void (*reserved6)(void);
555 void (*reserved7)(void);
556 void (*reserved8)(void);
560 * @brief The layer functions for a backend module.
562 typedef struct _tdm_func_layer {
564 * @brief Get the capabilities of a layer object
565 * @param[in] layer A layer object
566 * @param[out] caps The capabilities of a layer object
567 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
569 * A backend module @b SHOULD implement this function. TDM calls this function
570 * not only at the initial time, but also at the update time when new output
572 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
574 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
577 * @brief Set the property which has a given id.
578 * @param[in] layer A layer object
579 * @param[in] id The property id
580 * @param[in] value The value
581 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
583 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
587 * @brief Get the property which has a given id.
588 * @param[in] layer A layer object
589 * @param[in] id The property id
590 * @param[out] value The value
591 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
593 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
597 * @brief Set the geometry information to a layer object
598 * @param[in] layer A layer object
599 * @param[in] info The geometry information
600 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
601 * @see output_commit() function of #tdm_func_output
603 * A backend module would apply the geometry information when the output object
604 * of a layer object is committed.
606 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
609 * @brief Get the geometry information to a layer object
610 * @param[in] layer A layer object
611 * @param[out] info The geometry information
612 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
614 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
617 * @brief Set a TDM buffer to a layer object
618 * @param[in] layer A layer object
619 * @param[in] buffer A TDM buffer
620 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
621 * @see output_commit() function of #tdm_func_output
623 * A backend module would show a TDM buffer on screen when the output object
624 * of a layer object is committed.
626 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
629 * @brief Unset a TDM buffer from a layer object
630 * @param[in] layer A layer object
631 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
633 * A backend module @b SHOULD remove the current showing buffer from screen.
635 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
638 * @brief Set the zpos for a VIDEO layer object
639 * @param[in] layer A layer object
640 * @param[in] zpos z-order
641 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
642 * @see tdm_caps_layer, tdm_layer_capability
644 * A backend module doesn't need to implement this function if a backend
645 * module doesn't have VIDEO layers.\n
646 * This function is for VIDEO layers.
647 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
648 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
649 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
650 * is less than GRAPHIC layers or more than GRAPHIC layers.
651 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
652 * The zpos of VIDEO layers is @b relative. It doesn't need to start
653 * from -1 or 4. Let's suppose that there are two VIDEO layers.
654 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
655 * than -4 VIDEO layer.
657 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
660 * @brief Create a capture object of a layer object
661 * @param[in] output A output object
662 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
663 * @return A capture object
664 * @see capture_destroy() function of #tdm_func_capture
666 * A backend module doesn't need to implement this function if a hardware
667 * doesn't have the capture device.
669 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
672 * @brief Get buffer flags which the layer can support.
673 * @param[in] layer A layer object
674 * @param[out] flags The buffer flags which should be the tbm_bo flags
675 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
677 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
679 void (*reserved1)(void);
680 void (*reserved2)(void);
681 void (*reserved3)(void);
682 void (*reserved4)(void);
683 void (*reserved5)(void);
684 void (*reserved6)(void);
685 void (*reserved7)(void);
688 typedef struct _tdm_func_hwc {
690 * @brief Create a new window on the given hwc.
691 * @param[in] hwc A hwc object
692 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
693 * @return A created window object
696 tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
699 * @brief Get the supported format array for the hwc windows of a hwc object.
700 * @param[in] hwc A hwc object
701 * @param[out] formats The available format array
702 * @param[out] count The count of formats
703 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
705 tdm_error (*hwc_get_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
710 * @brief Get the available property array of a hwc object.
711 * @param[in] hwc A hwc object
712 * @param[out] props The available property array
713 * @param[out] count The count of properties
714 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
716 tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
720 * @brief Get a target buffer queue
721 * @param[in] hwc A hwc object
722 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
723 * @return A buffer queue
726 tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
730 * @brief Set the client(relative to the TDM) target buffer
731 * @details Sets the buffer which will receive the hwc of client composition.
732 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
733 * will be composited into this buffer prior to the call to hwc_commit(),
734 * and windows not marked as TDM_COMPOSITION_CLIENT and
735 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
738 * The buffer handle provided may be null if no windows are being composited by
739 * the client. This must not result in an error (unless an invalid display
740 * handle is also provided).
742 * The damage parameter describes a buffer damage region as defined in the
743 * description of hwc_window_set_buffer_damage().
745 * Will be called before hwc_commit() if any of the layers are marked as
746 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
747 * so marked, then it is not necessary to call this function. It is not necessary
748 * to call hwc_validate() after changing the target through this function.
749 * @param[in] hwc A hwc object
750 * @param[in] target The new target buffer
751 * @param[in] damage The buffer damage region
752 * @param[in] composited_wnds The array of composited hwc_wnds
753 * @param[in] num_wnds The size of #composited_wnds array
754 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
757 tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
758 tbm_surface_h target_buffer,
762 * @brief Validate the hwc
763 * @details Instructs the device to inspect all of the layer state and
764 * determine if there are any composition type changes necessary before
765 * presenting the hwc. Permitted changes are described in the definition
766 * of tdm_composition_t above.
767 * @param[in] hwc A hwc object
768 * @param[out] num_types The number of composition type changes required by
769 * the device; if greater than 0, the client must either set and validate new
770 * types, or call hwc_accept_changes() to accept the changes returned by
771 * hwc_get_changed_composition_types(); must be the same as the number of
772 * changes returned by hwc_get_changed_composition_types (see the
773 * declaration of that function for more information); pointer will be non-NULL
774 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
777 tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
778 uint32_t num_wnds, uint32_t *num_types);
781 * @brief Get changed composition types
782 * @details Retrieves the windows for which the device requires a different
783 * composition type than had been set prior to the last call to hwc_validate().
784 * The client will either update its state with these types and call
785 * hwc_accept_changes, or will set new types and attempt to validate the
787 * layers and types may be NULL to retrieve the number of elements which
788 * will be returned. The number of elements returned must be the same as the
789 * value returned in num_types from the last call to hwc_validate().
790 * @param[in] hwc A hwc object
791 * @param[out] num_elements If windows or types were NULL, the number of layers
792 * and types which would have been returned; if both were non-NULL, the
793 * number of elements returned in layers and types, which must not exceed
794 * the value stored in num_elements prior to the call; pointer will be
796 * @param[out] windows An array of windows
797 * @param[out] composition_types An array of composition types, each
798 * corresponding to an element of windows
799 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
802 tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
803 tdm_hwc_window **hwc_window,
804 tdm_hwc_window_composition *composition_types);
806 * @brief Accepts the changes required by the device
807 * @details Accepts the changes required by the device from the previous
808 * hwc_validate() call (which may be queried using
809 * hwc_get_chaged_composition_types()) and revalidates the display. This
810 * function is equivalent to requesting the changed types from
811 * hwc_get_chaged_composition_types(), setting those types on the
812 * corresponding windows, and then calling hwc_validate again.
813 * After this call it must be valid to present this display. Calling this after
814 * hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
815 * should have no other effect.
816 * @param[in] hwc A hwc object
817 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
820 tdm_error (*hwc_accept_changes)(tdm_hwc *hwc);
823 * @brief Commit changes for a output object
824 * @param[in] hwc A hwc object
825 * @param[in] sync 0: asynchronous, 1:synchronous
826 * @param[in] user_data The user data
827 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
828 * @see hwc_set_commit_handler, tdm_hwc_commit_handler
830 * When this function is called, a backend module @b SHOULD apply the all
831 * changes of the given output object to screen as well as the layer changes
833 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
834 * a user commit handler with the user data of this function after all
835 * changes of the given output object are applied.
837 tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
840 * @brief Set a user commit handler
841 * @param[in] hwc A hwc object
842 * @param[in] func A user commit handler
843 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
845 tdm_error (*hwc_set_commit_handler)(tdm_output *hwc, tdm_hwc_commit_handler func);
849 * @brief The window functions for a backend module.
852 typedef struct _tdm_func_hwc_window {
854 * @brief Destroys the given window.
855 * @param[in] window the pointer of the window to destroy
858 void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
861 * @brief Get a buffer queue for the window object
862 * @param[in] hwc_window A window object
863 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
864 * @return A buffer queue
866 tbm_surface_queue_h (*hwc_window_get_buffer_queue)(tdm_hwc_window *hwc_window,
870 * @brief Sets the desired composition type of the given window.
871 * @details During hwc_validate(), the device may request changes to
872 * the composition types of any of the layers as described in the definition
873 * of tdm_hwc_window_composition_t above.
874 * @param[in] hwc_window A window object
875 * @param[in] composition_type The new composition type
876 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
878 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
879 tdm_hwc_window_composition composition_type);
882 * @brief Set the buffer damage
883 * @details Provides the region of the source buffer which has been modified
884 * since the last frame. This region does not need to be validated before
885 * calling hwc_commit().
886 * Once set through this function, the damage region remains the same until a
887 * subsequent call to this function.
888 * If damage.num_rects > 0, then it may be assumed that any portion of the source
889 * buffer not covered by one of the rects has not been modified this frame. If
890 * damage.num_rects == 0, then the whole source buffer must be treated as if it
892 * If the layer's contents are not modified relative to the prior frame, damage
893 * will contain exactly one empty rect([0, 0, 0, 0]).
894 * The damage rects are relative to the pre-transformed buffer, and their origin
895 * is the top-left corner. They will not exceed the dimensions of the latched
897 * @param[in] hwc_window A window object
898 * @param[in] damage The new buffer damage region
899 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
901 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
905 * @brief Set the information to a window object
906 * @details The information will be applied when the hwc object
907 * of a layer object is committed.
908 * @param[in] hwc_window A window object
909 * @param[in] info The geometry information
910 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
912 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
913 tdm_hwc_window_info *info);
916 * @brief Get the geometry information to a layer object
917 * @param[in] layer A layer object
918 * @param[out] info The geometry information
919 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
921 tdm_error (*hwc_window_get_info)(tdm_hwc_window *hwc_window,
922 tdm_hwc_window_info *info);
925 * @brief Set a TDM buffer to a window object
926 * @details A TDM buffer will be applied when the hwc object
927 * of a layer object is committed.
928 * @param[in] hwc_window A window object
929 * @param[in] buffer A TDM buffer
930 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
932 * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
933 * be updated right now, this won't be interpreted like some critical
936 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
937 tbm_surface_h buffer);
940 * @brief Set the property which has a given id.
941 * @param[in] hwc window A hwc window object
942 * @param[in] id The property id
943 * @param[in] value The value
944 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
946 tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
947 uint32_t id, tdm_value value);
950 * @brief Get the property which has a given id.
951 * @param[in] hwc window A hwc window object
952 * @param[in] id The property id
953 * @param[out] value The value
954 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
956 tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
957 uint32_t id, tdm_value *value);
958 } tdm_func_hwc_window;
961 * @brief The pp functions for a backend module.
963 typedef struct _tdm_func_pp {
965 * @brief Destroy a pp object
966 * @param[in] pp A pp object
967 * @see display_create_pp() function of #tdm_func_display
969 void (*pp_destroy)(tdm_pp *pp);
972 * @brief Set the geometry information to a pp object
973 * @param[in] pp A pp object
974 * @param[in] info The geometry information
975 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
976 * @see pp_commit() function of #tdm_func_pp
978 * A backend module would apply the geometry information when committed.
980 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
983 * @brief Attach a source buffer and a destination buffer to a pp object
984 * @param[in] pp A pp object
985 * @param[in] src A source buffer
986 * @param[in] dst A destination buffer
987 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
988 * @see pp_set_info() function of #tdm_func_pp
989 * @see pp_commit() function of #tdm_func_pp
990 * @see pp_set_done_handler, tdm_pp_done_handler
992 * A backend module converts the image of a source buffer to a destination
993 * buffer when committed. The size/crop/transform information is set via
994 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
995 * return the source/destination buffer via tdm_pp_done_handler.
997 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1000 * @brief Commit changes for a pp object
1001 * @param[in] pp A pp object
1002 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1004 tdm_error (*pp_commit)(tdm_pp *pp);
1007 * @brief Set a user done handler to a pp object
1008 * @param[in] pp A pp object
1009 * @param[in] func A user done handler
1010 * @param[in] user_data user data
1011 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1013 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1015 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1018 void (*reserved1)(void);
1019 void (*reserved2)(void);
1020 void (*reserved3)(void);
1021 void (*reserved4)(void);
1022 void (*reserved5)(void);
1023 void (*reserved6)(void);
1024 void (*reserved7)(void);
1025 void (*reserved8)(void);
1029 * @brief The capture functions for a backend module.
1031 typedef struct _tdm_func_capture {
1033 * @brief Destroy a capture object
1034 * @param[in] capture A capture object
1035 * @see output_create_capture() function of #tdm_func_output
1036 * @see layer_create_capture() function of #tdm_func_layer
1038 void (*capture_destroy)(tdm_capture *capture);
1041 * @brief Set the geometry information to a capture object
1042 * @param[in] capture A capture object
1043 * @param[in] info The geometry information
1044 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1045 * @see capture_commit() function of #tdm_func_capture
1047 * A backend module would apply the geometry information when committed.
1049 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1052 * @brief Attach a TDM buffer to a capture object
1053 * @details When capture_commit() function is called, a backend module starts
1054 * to dump a output or a layer to a TDM buffer.
1055 * @param[in] capture A capture object
1056 * @param[in] buffer A TDM buffer
1057 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1058 * @see capture_set_info() function of #tdm_func_capture
1059 * @see capture_commit() function of #tdm_func_capture
1060 * @see capture_set_done_handler, tdm_capture_done_handler
1062 * A backend module starts to dump a output or a layer to to a TDM buffer when
1063 * committed. The size/crop/transform information is set via #capture_set_info()
1064 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1065 * buffer via tdm_capture_done_handler.
1067 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1070 * @brief Commit changes for a capture object
1071 * @param[in] capture A capture object
1072 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1074 tdm_error (*capture_commit)(tdm_capture *capture);
1077 * @brief Set a user done handler to a capture object
1078 * @param[in] capture A capture object
1079 * @param[in] func A user done handler
1080 * @param[in] user_data user data
1081 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1083 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1085 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1086 tdm_capture_done_handler func, void *user_data);
1088 void (*reserved1)(void);
1089 void (*reserved2)(void);
1090 void (*reserved3)(void);
1091 void (*reserved4)(void);
1092 void (*reserved5)(void);
1093 void (*reserved6)(void);
1094 void (*reserved7)(void);
1095 void (*reserved8)(void);
1099 * @brief The tdm event source
1101 typedef void tdm_event_loop_source;
1104 * @brief The fd source handler
1106 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1109 * @brief The timer source handler
1111 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1113 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1114 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1115 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1116 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1120 * The ABI version of TDM backend module. It has a major and minor revision.
1121 * Modules using lower minor revisions will work with TDM frontend of a higher
1122 * minor revision. There is no compatibility between different major revisions.
1123 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1126 * tdm_backend_module tdm_backend_module_data = {
1129 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1135 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1136 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1137 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1140 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1141 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1142 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */
1146 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1148 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1150 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1153 * @brief The backend module information of the entry point to initialize a TDM
1156 * A backend module @b SHOULD define the global data symbol of which name is
1157 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1158 * at the initial time and call init() function of #tdm_backend_module.
1160 typedef struct _tdm_backend_module {
1161 const char *name; /**< The module name of a backend module */
1162 const char *vendor; /**< The vendor name of a backend module */
1163 unsigned long abi_version; /**< The ABI version of a backend module */
1166 * @brief The init function of a backend module
1167 * @param[in] dpy A display object
1168 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1169 * @return The backend module data
1170 * @see tdm_backend_data
1172 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1175 * @brief The deinit function of a backend module
1176 * @param[in] bdata The backend module data
1178 void (*deinit)(tdm_backend_data *bdata);
1179 } tdm_backend_module;
1182 * @brief Register the backend display functions to a display
1183 * @param[in] dpy A display object
1184 * @param[in] func_display display functions
1185 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1186 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1188 * A backend module @b SHOULD set the backend display functions at least.
1191 tdm_backend_register_func_display(tdm_display *dpy,
1192 tdm_func_display *func_display);
1195 * @brief Register the backend output functions to a display
1196 * @param[in] dpy A display object
1197 * @param[in] func_output output functions
1198 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1199 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1201 * A backend module @b SHOULD set the backend output functions at least.
1204 tdm_backend_register_func_output(tdm_display *dpy,
1205 tdm_func_output *func_output);
1208 * @brief Register the backend layer functions to a display
1209 * @param[in] dpy A display object
1210 * @param[in] func_layer layer functions
1211 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1212 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1214 * A backend module @b SHOULD set the backend layer functions at least.
1217 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1220 * @brief Register the backend hwc functions to a display
1221 * @param[in] dpy A display object
1222 * @param[in] func_hwc hwc functions
1223 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1224 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1226 * A backend module @b SHOULD set the backend hwc functions at least.
1230 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1233 * @brief Register the backend hwc_window functions to a display
1234 * @param[in] dpy A display object
1235 * @param[in] func_hwc_window hwc_window functions
1236 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1237 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1239 * A backend module @b SHOULD set the backend hwc_window functions at least.
1243 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1246 * @brief Register the backend pp functions to a display
1247 * @param[in] dpy A display object
1248 * @param[in] func_pp pp functions
1249 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1250 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1252 * A backend module doesn'tcan skip to register the backend pp functions
1253 * if a hardware doesn't have the memory-to-memory converting device.
1256 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1259 * @brief Register the backend capture functions to a display
1260 * @param[in] dpy A display object
1261 * @param[in] func_capture capture functions
1262 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1263 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1265 * A backend module can skip to register the backend capture functions
1266 * if a hardware doesn't have the capture device.
1269 tdm_backend_register_func_capture(tdm_display *dpy,
1270 tdm_func_capture *func_capture);
1273 * @brief Increase the ref_count of a TDM buffer
1275 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1276 * becomes available for a next job. A TDM buffer can be used for TDM to show
1277 * it on screen or to capture an output and a layer. After all operations,
1278 * TDM will release it immediately when TDM doesn't need it any more.
1279 * @param[in] buffer A TDM buffer
1280 * @return A buffer itself. Otherwise, NULL.
1281 * @see tdm_buffer_unref_backend
1283 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1284 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1285 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1288 tdm_buffer_ref_backend(tbm_surface_h buffer);
1291 * @brief Decrease the ref_count of a TDM buffer
1292 * @param[in] buffer A TDM buffer
1293 * @see tdm_buffer_ref_backend
1296 tdm_buffer_unref_backend(tbm_surface_h buffer);
1299 * @brief The destroy handler of a TDM buffer
1300 * @param[in] buffer A TDM buffer
1301 * @param[in] user_data user data
1302 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1304 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1308 * @brief Add a destroy handler to a TDM buffer
1309 * @param[in] buffer A TDM buffer
1310 * @param[in] func A destroy handler
1311 * @param[in] user_data user data
1312 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1313 * @see tdm_buffer_remove_destroy_handler
1315 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1316 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1320 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1321 tdm_buffer_destroy_handler func, void *user_data);
1324 * @brief Remove a destroy handler from a TDM buffer
1325 * @param[in] buffer A TDM buffer
1326 * @param[in] func A destroy handler
1327 * @param[in] user_data user data
1328 * @see tdm_buffer_add_destroy_handler
1331 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1332 tdm_buffer_destroy_handler func, void *user_data);
1335 * @brief Add a FD handler for activity on the given file descriptor
1336 * @param[in] dpy A display object
1337 * @param[in] fd A file descriptor
1338 * @param[in] mask to monitor FD
1339 * @param[in] func A FD handler function
1340 * @param[in] user_data user data
1341 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1342 * @return A FD event source
1343 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1345 tdm_event_loop_source*
1346 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1347 tdm_event_loop_fd_handler func, void *user_data,
1351 * @brief Update the mask of the given FD event source
1352 * @param[in] source The given FD event source
1353 * @param[in] mask to monitor FD
1354 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1357 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1360 * @brief Add a timer handler
1361 * @param[in] dpy A display object
1362 * @param[in] func A timer handler function
1363 * @param[in] user_data user data
1364 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1365 * @return A timer event source
1366 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1368 tdm_event_loop_source*
1369 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1370 void *user_data, tdm_error *error);
1373 * @brief Update the millisecond delay time of the given timer event source.
1374 * @param[in] source The given timer event source
1375 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1376 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1379 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1382 * @brief Remove the given event source
1383 * @param[in] source The given event source
1384 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1387 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1390 * @brief Get the ini value with given key
1392 * @param[in] key The given key
1393 * @param[in] default_value The default value
1394 * @return the value of given key if success. Otherwise, default_value.
1395 * @see #tdm_config_get_string
1398 tdm_config_get_int(const char *key, int default_value);
1401 * @brief Get the ini value with given key
1403 * @param[in] key The given key
1404 * @param[in] default_value The default value
1405 * @return the value of given key if success. Otherwise, default_value.
1406 * @see #tdm_config_get_int
1409 tdm_config_get_string(const char *key, const char *default_value);
1415 #endif /* _TDM_BACKEND_H_ */