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_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 */
107 *modes; /**< The @b newly-allocated array of modes. will be freed in frontend. */
109 unsigned int prop_count; /**< The count of available properties */
110 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
112 unsigned int mmWidth; /**< The physical width (milimeter) */
113 unsigned int mmHeight; /**< The physical height (milimeter) */
114 unsigned int subpixel; /**< The subpixel */
116 int min_w; /**< The minimun width */
117 int min_h; /**< The minimun height */
118 int max_w; /**< The maximum width */
119 int max_h; /**< The maximum height */
120 int preferred_align; /**< The prefered align */
122 tdm_output_capability capabilities; /**< The capabilities of output. @since 1.4.1 */
124 int cursor_min_w; /**< The minimun width. @since 1.5.0 */
125 int cursor_min_h; /**< The minimun height. @since 1.5.0 */
126 int cursor_max_w; /**< The maximum width. @since 1.5.0 */
127 int cursor_max_h; /**< The maximum height. @since 1.5.0 */
128 int cursor_preferred_align; /**< The prefered align. @since 1.5.0 */
132 * @brief The capabilities structure of a layer object
133 * @see The layer_get_capability() function of #tdm_func_layer
135 typedef struct _tdm_caps_layer {
136 tdm_layer_capability capabilities; /**< The capabilities of layer */
140 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
141 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
142 * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
143 * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
144 * layers or more than GRAPHIC layers.
145 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
146 * The zpos of VIDEO layers is @b relative. It doesn't need to start
147 * from -1 or 4. Let's suppose that there are two VIDEO layers.
148 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
149 * than -4 VIDEO layer.
153 unsigned int format_count; /**< The count of available formats */
155 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
157 unsigned int prop_count; /**< The count of available properties */
158 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
162 * @brief The capabilities structure of a pp object
163 * @see The display_get_pp_capability() function of #tdm_func_display
165 typedef struct _tdm_caps_pp {
166 tdm_pp_capability capabilities; /**< The capabilities of pp */
168 unsigned int format_count; /**< The count of available formats */
170 *formats; /**< The @b newly-allocated array. will be freed in frontend. */
172 int min_w; /**< The minimun width */
173 int min_h; /**< The minimun height */
174 int max_w; /**< The maximum width */
175 int max_h; /**< The maximum height */
176 int preferred_align; /**< The prefered align */
178 /**< The attach count which a PP object can handle. @since 1.2.0 */
179 int max_attach_count;
183 * @brief The capabilities structure of a capture object
184 * @see The display_get_capture_capability() function of #tdm_func_display
186 typedef struct _tdm_caps_capture {
187 tdm_capture_capability capabilities; /**< The capabilities of capture */
189 unsigned int format_count; /**< The count of available formats */
191 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
193 int min_w; /**< The minimun width */
194 int min_h; /**< The minimun height */
195 int max_w; /**< The maximum width */
196 int max_h; /**< The maximum height */
197 int preferred_align; /**< The prefered align */
199 /**< The attach count which a capture object can handle. @since 1.2.0 */
200 int max_attach_count;
204 * @brief The display functions for a backend module.
206 typedef struct _tdm_func_display {
208 * @brief Get the display capabilities of a backend module
209 * @param[in] bdata The backend module data
210 * @param[out] caps The display capabilities of a backend module
211 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
213 * A backend module @b SHOULD implement this function. TDM calls this function
214 * not only at the initial time, but also at the update time when new output
216 * If a hardware has the restriction of the number of max usable layer count,
217 * a backend module can set the max count to max_layer_count of #tdm_caps_display
220 tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
223 * @brief Get the pp capabilities of a backend module
224 * @param[in] bdata The backend module data
225 * @param[out] caps The pp capabilities of a backend module
226 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
227 * @see tdm_backend_register_func_pp
229 * TDM calls this function not only at the initial time, but also at the update
230 * time when new output is connected.\n
231 * A backend module doesn't need to implement this function if a hardware
232 * doesn't have the memory-to-memory converting device. Otherwise, a backend module
233 * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
234 * restriction information which a converting device can handle. ie, format, size, etc.
236 tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
239 * @brief Get the capture capabilities of a backend module
240 * @param[in] bdata The backend module data
241 * @param[out] caps The capture capabilities of a backend module
242 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
243 * @see tdm_backend_register_func_capture
245 * TDM calls this function not only at the initial time, but also at the update
246 * time when new output is connected.\n
247 * A backend module doesn't need to implement this function if a hardware
248 * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
249 * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
250 * information which a capture device can handle. ie, format, size, etc.
252 tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
255 * @brief Get a output array of a backend module
256 * @param[in] bdata The backend module data
257 * @param[out] count The count of outputs
258 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
259 * @return A output array which is @b newly-allocated
260 * @see tdm_backend_register_func_capture
262 * A backend module @b SHOULD implement this function. TDM calls this function
263 * not only at the initial time, but also at the update time when new output
265 * A backend module @b SHOULD return the @b newly-allocated array which contains
266 * "tdm_output*" data. It will be freed in frontend.
270 * drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
272 * tdm_drm_data *drm_data = bdata;
273 * tdm_drm_output_data *output_data = NULL;
274 * tdm_output **outputs;
278 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
283 * if (error) *error = TDM_ERROR_NONE;
287 * // will be freed in frontend
288 * outputs = calloc(*count, sizeof(tdm_drm_output_data*));
292 * if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
297 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
298 * outputs[i++] = output_data;
300 * if (error) *error = TDM_ERROR_NONE;
306 tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
310 * @brief Get the file descriptor of a backend module
311 * @param[in] bdata The backend module data
312 * @param[out] fd The fd of a backend module
313 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314 * @see display_handle_events() function of #tdm_func_display
316 * A backend module can return epoll's fd which is watching the backend device one more fds.
318 tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
321 * @brief Handle the events which happens on the fd of a backend module
322 * @param[in] bdata The backend module data
323 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
325 tdm_error (*display_handle_events)(tdm_backend_data *bdata);
328 * @brief Create a pp object of a backend module
329 * @param[in] bdata The backend module data
330 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
331 * @return A pp object
332 * @see pp_destroy() function of #tdm_func_pp
334 * A backend module doesn't need to implement this function if a hardware
335 * doesn't have the memory-to-memory converting device.
337 tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
339 void (*reserved1)(void);
340 void (*reserved2)(void);
341 void (*reserved3)(void);
342 void (*reserved4)(void);
343 void (*reserved5)(void);
344 void (*reserved6)(void);
345 void (*reserved7)(void);
346 void (*reserved8)(void);
350 * @brief The output functions for a backend module.
352 typedef struct _tdm_func_output {
354 * @brief Get the capabilities of a output object
355 * @param[in] output A output object
356 * @param[out] caps The capabilities of a output object
357 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
359 * A backend module @b SHOULD implement this function. TDM calls this function
360 * not only at the initial time, but also at the update time when new output
362 * #tdm_caps_output contains connection status, modes, avaiable properties,
363 * size restriction information, etc.
365 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
368 * @brief Get a layer array of a output object
369 * @param[in] output A output object
370 * @param[out] count The count of layers
371 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
372 * @return A layer array which is @b newly-allocated
374 * A backend module @b SHOULD implement this function. TDM calls this function
375 * not only at the initial time, but also at the update time when new output
377 * A backend module @b SHOULD return the @b newly-allocated array which contains
378 * "tdm_layer*" data. It will be freed in frontend.
380 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
384 * @brief Set the property which has a given id
385 * @param[in] output A output object
386 * @param[in] id The property id
387 * @param[in] value The value
388 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
390 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
394 * @brief Get the property which has a given id
395 * @param[in] output A output object
396 * @param[in] id The property id
397 * @param[out] value The value
398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
400 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
404 * @brief Wait for VBLANK
405 * @param[in] output A output object
406 * @param[in] interval vblank interval
407 * @param[in] sync 0: asynchronous, 1:synchronous
408 * @param[in] user_data The user data
409 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
410 * @see output_set_vblank_handler, tdm_output_vblank_handler
412 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
413 * a user vblank handler with the user data of this function after interval
416 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
420 * @brief Set a user vblank handler
421 * @param[in] output A output object
422 * @param[in] func A user vblank handler
423 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
425 tdm_error (*output_set_vblank_handler)(tdm_output *output,
426 tdm_output_vblank_handler func);
429 * @brief Commit changes for a output object
430 * @param[in] output A output object
431 * @param[in] sync 0: asynchronous, 1:synchronous
432 * @param[in] user_data The user data
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
434 * @see output_set_commit_handler, tdm_output_commit_handler
436 * When this function is called, a backend module @b SHOULD apply the all
437 * changes of the given output object to screen as well as the layer changes
439 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
440 * a user commit handler with the user data of this function after all
441 * changes of the given output object are applied.
443 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
446 * @brief Set a user commit handler
447 * @param[in] output A output object
448 * @param[in] func A user commit handler
449 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
451 tdm_error (*output_set_commit_handler)(tdm_output *output,
452 tdm_output_commit_handler func);
455 * @brief Set DPMS of a output object synchronously
456 * @param[in] output A output object
457 * @param[in] dpms_value DPMS value
458 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
460 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
463 * @brief Get DPMS of a output object
464 * @param[in] output A output object
465 * @param[out] dpms_value DPMS value
466 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
468 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
471 * @brief Set one of available modes of a output object
472 * @param[in] output A output object
473 * @param[in] mode A output mode
474 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
476 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
479 * @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 Creates a new window on the given display.
547 * @param[in] output A output object
548 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
549 * @return A created window object
552 tdm_hwc_window *(*output_hwc_create_window)(tdm_output *output, tdm_error *error);
555 * @brief Destroys the given window.
556 * @param[in] output A output object
557 * @param[in] window the pointer of the window to destroy
558 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
561 tdm_error (*output_hwc_destroy_window)(tdm_output *output, tdm_hwc_window *hwc_window);
564 * @brief Set the client(relative to the TDM) target buffer
565 * @details Sets the buffer which will receive the output of client composition.
566 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
567 * will be composited into this buffer prior to the call to output_commit(),
568 * and windows not marked as TDM_COMPOSITION_CLIENT and
569 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
572 * The buffer handle provided may be null if no windows are being composited by
573 * the client. This must not result in an error (unless an invalid display
574 * handle is also provided).
576 * The damage parameter describes a buffer damage region as defined in the
577 * description of hwc_window_set_buffer_damage().
579 * Will be called before output_commit() if any of the layers are marked as
580 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
581 * so marked, then it is not necessary to call this function. It is not necessary
582 * to call output_hwc_validate() after changing the target through this function.
583 * @param[in] output A output object
584 * @param[in] target The new target buffer
585 * @param[in] damage The buffer damage region
586 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
589 tdm_error (*output_hwc_set_client_target_buffer)(tdm_output *output, tbm_surface_h target_buffer,
590 tdm_hwc_region damage);
593 * @brief Validate the output
594 * @details Instructs the device to inspect all of the layer state and
595 * determine if there are any composition type changes necessary before
596 * presenting the output. Permitted changes are described in the definition
597 * of tdm_composition_t above.
598 * @param[in] output A output object
599 * @param[out] num_types The number of composition type changes required by
600 * the device; if greater than 0, the client must either set and validate new
601 * types, or call output_hwc_accept_changes() to accept the changes returned by
602 * output_hwc_get_changed_composition_types(); must be the same as the number of
603 * changes returned by output_hwc_get_changed_composition_types (see the
604 * declaration of that function for more information); pointer will be non-NULL
605 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
608 tdm_error (*output_hwc_validate)(tdm_output *output, uint32_t *num_types);
611 * @brief Get changed composition types
612 * @details Retrieves the windows for which the device requires a different
613 * composition type than had been set prior to the last call to output_hwc_validate().
614 * The client will either update its state with these types and call
615 * output_hwc_accept_changes, or will set new types and attempt to validate the
617 * layers and types may be NULL to retrieve the number of elements which
618 * will be returned. The number of elements returned must be the same as the
619 * value returned in num_types from the last call to output_hwc_validate().
620 * @param[in] output A output object
621 * @param[out] num_elements If windows or types were NULL, the number of layers
622 * and types which would have been returned; if both were non-NULL, the
623 * number of elements returned in layers and types, which must not exceed
624 * the value stored in num_elements prior to the call; pointer will be
626 * @param[out] windows An array of windows
627 * @param[out] composition_types An array of composition types, each
628 * corresponding to an element of windows
629 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
632 tdm_error (*output_hwc_get_changed_composition_types)(tdm_output *output,
633 uint32_t *num_elements,
634 tdm_hwc_window **hwc_window,
635 tdm_hwc_window_composition *composition_types);
637 * @brief Accepts the changes required by the device
638 * @details Accepts the changes required by the device from the previous
639 * output_hwc_validate() call (which may be queried using
640 * output_get_chaged_composition_types()) and revalidates the display. This
641 * function is equivalent to requesting the changed types from
642 * output_get_chaged_composition_types(), setting those types on the
643 * corresponding windows, and then calling output_hwc_validate again.
644 * After this call it must be valid to present this display. Calling this after
645 * output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
646 * should have no other effect.
647 * @param[in] output A output object
648 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
651 tdm_error (*output_hwc_accept_changes)(tdm_output *output);
654 * @brief Get a target buffer queue
655 * @param[in] output A output object
656 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
657 * @return A buffer queue
660 tbm_surface_queue_h (*output_hwc_get_target_buffer_queue)(tdm_output *output,
664 * @brief Get the supported format array for video hwc windows of a output object.
665 * @param[in] output A output object
666 * @param[out] formats The available format array
667 * @param[out] count The count of formats
668 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
670 tdm_error (*output_hwc_get_video_supported_formats)(tdm_layer *layer,
671 const tbm_format **formats, int *count);
674 * @brief Creates a new video window on the given output.
675 * @param[in] output A output object
676 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
677 * @return A created window object. If the video abilities isn't accessed return NULL
680 tdm_hwc_window *(*output_hwc_create_video_window)(tdm_output *output, tdm_error *error);
682 void (*reserved5)(void);
683 void (*reserved6)(void);
684 void (*reserved7)(void);
685 void (*reserved8)(void);
689 * @brief The layer functions for a backend module.
691 typedef struct _tdm_func_layer {
693 * @brief Get the capabilities of a layer object
694 * @param[in] layer A layer object
695 * @param[out] caps The capabilities of a layer object
696 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
698 * A backend module @b SHOULD implement this function. TDM calls this function
699 * not only at the initial time, but also at the update time when new output
701 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
703 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
706 * @brief Set the property which has a given id.
707 * @param[in] layer A layer object
708 * @param[in] id The property id
709 * @param[in] value The value
710 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
712 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
716 * @brief Get the property which has a given id.
717 * @param[in] layer A layer object
718 * @param[in] id The property id
719 * @param[out] value The value
720 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
722 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
726 * @brief Set the geometry information to a layer object
727 * @param[in] layer A layer object
728 * @param[in] info The geometry information
729 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
730 * @see output_commit() function of #tdm_func_output
732 * A backend module would apply the geometry information when the output object
733 * of a layer object is committed.
735 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
738 * @brief Get the geometry information to a layer object
739 * @param[in] layer A layer object
740 * @param[out] info The geometry information
741 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
743 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
746 * @brief Set a TDM buffer to a layer object
747 * @param[in] layer A layer object
748 * @param[in] buffer A TDM buffer
749 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
750 * @see output_commit() function of #tdm_func_output
752 * A backend module would show a TDM buffer on screen when the output object
753 * of a layer object is committed.
755 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
758 * @brief Unset a TDM buffer from a layer object
759 * @param[in] layer A layer object
760 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
762 * A backend module @b SHOULD remove the current showing buffer from screen.
764 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
767 * @brief Set the zpos for a VIDEO layer object
768 * @param[in] layer A layer object
769 * @param[in] zpos z-order
770 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
771 * @see tdm_caps_layer, tdm_layer_capability
773 * A backend module doesn't need to implement this function if a backend
774 * module doesn't have VIDEO layers.\n
775 * This function is for VIDEO layers.
776 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
777 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
778 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
779 * is less than GRAPHIC layers or more than GRAPHIC layers.
780 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
781 * The zpos of VIDEO layers is @b relative. It doesn't need to start
782 * from -1 or 4. Let's suppose that there are two VIDEO layers.
783 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
784 * than -4 VIDEO layer.
786 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
789 * @brief Create a capture object of a layer object
790 * @param[in] output A output object
791 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
792 * @return A capture object
793 * @see capture_destroy() function of #tdm_func_capture
795 * A backend module doesn't need to implement this function if a hardware
796 * doesn't have the capture device.
798 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
801 * @brief Get buffer flags which the layer can support.
802 * @param[in] layer A layer object
803 * @param[out] flags The buffer flags which should be the tbm_bo flags
804 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
806 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
808 void (*reserved1)(void);
809 void (*reserved2)(void);
810 void (*reserved3)(void);
811 void (*reserved4)(void);
812 void (*reserved5)(void);
813 void (*reserved6)(void);
814 void (*reserved7)(void);
818 * @brief The window functions for a backend module.
821 typedef struct _tdm_func_window {
823 * @brief Get a buffer queue for the window object
824 * @param[in] hwc_window A window object
825 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
826 * @return A buffer queue
828 tbm_surface_queue_h (*hwc_window_get_tbm_buffer_queue)(tdm_hwc_window *hwc_window,
832 * @brief Sets the desired Z order (height) of the given window. A window with
833 * a greater Z value occludes a window with a lesser Z value.
834 * @param[in] hwc_window A window object
835 * @param[in] z the new Z order
836 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
838 tdm_error (*hwc_window_set_zpos)(tdm_hwc_window *hwc_window, uint32_t zpos);
841 * @brief Sets the desired composition type of the given window.
842 * @details During output_hwc_validate(), the device may request changes to
843 * the composition types of any of the layers as described in the definition
844 * of tdm_hwc_window_composition_t above.
845 * @param[in] hwc_window A window object
846 * @param[in] composition_type The new composition type
847 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
849 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
850 tdm_hwc_window_composition composition_type);
853 * @brief Set the buffer damage
854 * @details Provides the region of the source buffer which has been modified
855 * since the last frame. This region does not need to be validated before
856 * calling output_commit().
857 * Once set through this function, the damage region remains the same until a
858 * subsequent call to this function.
859 * If damage.num_rects > 0, then it may be assumed that any portion of the source
860 * buffer not covered by one of the rects has not been modified this frame. If
861 * damage.num_rects == 0, then the whole source buffer must be treated as if it
863 * If the layer's contents are not modified relative to the prior frame, damage
864 * will contain exactly one empty rect([0, 0, 0, 0]).
865 * The damage rects are relative to the pre-transformed buffer, and their origin
866 * is the top-left corner. They will not exceed the dimensions of the latched
868 * @param[in] hwc_window A window object
869 * @param[in] damage The new buffer damage region
870 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
872 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
873 tdm_hwc_region damage);
876 * @brief Set the information to a window object
877 * @details The information will be applied when the output object
878 * of a layer object is committed.
879 * @param[in] hwc_window A window object
880 * @param[in] info The geometry information
881 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
883 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
884 tdm_hwc_window_info *info);
887 * @brief Set a TDM buffer to a window object
888 * @details A TDM buffer will be applied when the output object
889 * of a layer object is committed.
890 * @param[in] hwc_window A window object
891 * @param[in] buffer A TDM buffer
892 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
894 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
895 tbm_surface_h buffer);
898 * @brief Set a flags to a window object
899 * @param[in] hwc_window A window object
900 * @param[in] flags A hwc_window flags
901 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
903 tdm_error (*hwc_window_set_flags)(tdm_hwc_window *hwc_window,
904 tdm_hwc_window_flag flags);
907 * @brief Unset a flags from a window object
908 * @param[in] hwc_window A window object
909 * @param[in] flags A hwc_window flags
910 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
912 tdm_error (*hwc_window_unset_flags)(tdm_hwc_window *hwc_window,
913 tdm_hwc_window_flag flags);
916 * @brief Get the window video capability
917 * @param[in] hwc_window A window object
918 * @param[out] video_capability A hwc window video capability
919 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
921 tdm_error (*hwc_window_video_get_capability)(tdm_hwc_window *hwc_window,
922 tdm_hwc_window_video_capability *video_capability);
925 * @brief Get the available property array of a video hwc window object.
926 * @param[in] hwc window A video hwc window object
927 * @param[out] props The available property array
928 * @param[out] count The count of properties
929 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
931 tdm_error (*hwc_window_video_get_available_properties)(
932 tdm_hwc_window *hwc_window,
933 const tdm_prop **props, int *count);
936 * @brief Get the property which has a given id.
937 * @param[in] hwc window A video hwc window object
938 * @param[in] id The property id
939 * @param[out] value The value
940 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
942 tdm_error (*hwc_window_video_get_property)(tdm_hwc_window *hwc_window,
943 uint32_t id, tdm_value *value);
946 * @brief Set the property which has a given id.
947 * @param[in] hwc window A video hwc window object
948 * @param[in] id The property id
949 * @param[in] value The value
950 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
952 tdm_error (*hwc_window_video_set_property)(tdm_hwc_window *hwc_window,
953 uint32_t id, tdm_value value);
955 } tdm_func_hwc_window;
958 * @brief The pp functions for a backend module.
960 typedef struct _tdm_func_pp {
962 * @brief Destroy a pp object
963 * @param[in] pp A pp object
964 * @see display_create_pp() function of #tdm_func_display
966 void (*pp_destroy)(tdm_pp *pp);
969 * @brief Set the geometry information to a pp object
970 * @param[in] pp A pp object
971 * @param[in] info The geometry information
972 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
973 * @see pp_commit() function of #tdm_func_pp
975 * A backend module would apply the geometry information when committed.
977 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
980 * @brief Attach a source buffer and a destination buffer to a pp object
981 * @param[in] pp A pp object
982 * @param[in] src A source buffer
983 * @param[in] dst A destination buffer
984 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
985 * @see pp_set_info() function of #tdm_func_pp
986 * @see pp_commit() function of #tdm_func_pp
987 * @see pp_set_done_handler, tdm_pp_done_handler
989 * A backend module converts the image of a source buffer to a destination
990 * buffer when committed. The size/crop/transform information is set via
991 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
992 * return the source/destination buffer via tdm_pp_done_handler.
994 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
997 * @brief Commit changes for a pp object
998 * @param[in] pp A pp object
999 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1001 tdm_error (*pp_commit)(tdm_pp *pp);
1004 * @brief Set a user done handler to a pp object
1005 * @param[in] pp A pp object
1006 * @param[in] func A user done handler
1007 * @param[in] user_data user data
1008 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1010 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1012 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1015 void (*reserved1)(void);
1016 void (*reserved2)(void);
1017 void (*reserved3)(void);
1018 void (*reserved4)(void);
1019 void (*reserved5)(void);
1020 void (*reserved6)(void);
1021 void (*reserved7)(void);
1022 void (*reserved8)(void);
1026 * @brief The capture functions for a backend module.
1028 typedef struct _tdm_func_capture {
1030 * @brief Destroy a capture object
1031 * @param[in] capture A capture object
1032 * @see output_create_capture() function of #tdm_func_output
1033 * @see layer_create_capture() function of #tdm_func_layer
1035 void (*capture_destroy)(tdm_capture *capture);
1038 * @brief Set the geometry information to a capture object
1039 * @param[in] capture A capture object
1040 * @param[in] info The geometry information
1041 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1042 * @see capture_commit() function of #tdm_func_capture
1044 * A backend module would apply the geometry information when committed.
1046 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1049 * @brief Attach a TDM buffer to a capture object
1050 * @details When capture_commit() function is called, a backend module starts
1051 * to dump a output or a layer to a TDM buffer.
1052 * @param[in] capture A capture object
1053 * @param[in] buffer A TDM buffer
1054 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1055 * @see capture_set_info() function of #tdm_func_capture
1056 * @see capture_commit() function of #tdm_func_capture
1057 * @see capture_set_done_handler, tdm_capture_done_handler
1059 * A backend module starts to dump a output or a layer to to a TDM buffer when
1060 * committed. The size/crop/transform information is set via #capture_set_info()
1061 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1062 * buffer via tdm_capture_done_handler.
1064 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1067 * @brief Commit changes for a capture object
1068 * @param[in] capture A capture object
1069 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1071 tdm_error (*capture_commit)(tdm_capture *capture);
1074 * @brief Set a user done handler to a capture object
1075 * @param[in] capture A capture object
1076 * @param[in] func A user done handler
1077 * @param[in] user_data user data
1078 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1080 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1082 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1083 tdm_capture_done_handler func, void *user_data);
1085 void (*reserved1)(void);
1086 void (*reserved2)(void);
1087 void (*reserved3)(void);
1088 void (*reserved4)(void);
1089 void (*reserved5)(void);
1090 void (*reserved6)(void);
1091 void (*reserved7)(void);
1092 void (*reserved8)(void);
1096 * @brief The tdm event source
1098 typedef void tdm_event_loop_source;
1101 * @brief The fd source handler
1103 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1106 * @brief The timer source handler
1108 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1110 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1111 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1112 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1113 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1117 * The ABI version of TDM backend module. It has a major and minor revision.
1118 * Modules using lower minor revisions will work with TDM frontend of a higher
1119 * minor revision. There is no compatibility between different major revisions.
1120 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1123 * tdm_backend_module tdm_backend_module_data = {
1126 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1132 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1133 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1134 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1138 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1140 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1142 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1145 * @brief The backend module information of the entry point to initialize a TDM
1148 * A backend module @b SHOULD define the global data symbol of which name is
1149 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1150 * at the initial time and call init() function of #tdm_backend_module.
1152 typedef struct _tdm_backend_module {
1153 const char *name; /**< The module name of a backend module */
1154 const char *vendor; /**< The vendor name of a backend module */
1155 unsigned long abi_version; /**< The ABI version of a backend module */
1158 * @brief The init function of a backend module
1159 * @param[in] dpy A display object
1160 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1161 * @return The backend module data
1162 * @see tdm_backend_data
1164 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1167 * @brief The deinit function of a backend module
1168 * @param[in] bdata The backend module data
1170 void (*deinit)(tdm_backend_data *bdata);
1171 } tdm_backend_module;
1174 * @brief Register the backend display functions to a display
1175 * @param[in] dpy A display object
1176 * @param[in] func_display display functions
1177 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1178 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1180 * A backend module @b SHOULD set the backend display functions at least.
1183 tdm_backend_register_func_display(tdm_display *dpy,
1184 tdm_func_display *func_display);
1187 * @brief Register the backend output functions to a display
1188 * @param[in] dpy A display object
1189 * @param[in] func_output output functions
1190 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1191 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1193 * A backend module @b SHOULD set the backend output functions at least.
1196 tdm_backend_register_func_output(tdm_display *dpy,
1197 tdm_func_output *func_output);
1200 * @brief Register the backend layer functions to a display
1201 * @param[in] dpy A display object
1202 * @param[in] func_layer layer functions
1203 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1204 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1206 * A backend module @b SHOULD set the backend layer functions at least.
1209 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1212 * @brief Register the backend hwc_window functions to a display
1213 * @param[in] dpy A display object
1214 * @param[in] func_hwc_window hwc_window functions
1215 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1216 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1218 * A backend module @b SHOULD set the backend hwc_window functions at least.
1222 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1225 * @brief Register the backend pp functions to a display
1226 * @param[in] dpy A display object
1227 * @param[in] func_pp pp functions
1228 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1229 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1231 * A backend module doesn'tcan skip to register the backend pp functions
1232 * if a hardware doesn't have the memory-to-memory converting device.
1235 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1238 * @brief Register the backend capture functions to a display
1239 * @param[in] dpy A display object
1240 * @param[in] func_capture capture functions
1241 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1242 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1244 * A backend module can skip to register the backend capture functions
1245 * if a hardware doesn't have the capture device.
1248 tdm_backend_register_func_capture(tdm_display *dpy,
1249 tdm_func_capture *func_capture);
1252 * @brief Increase the ref_count of a TDM buffer
1254 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1255 * becomes available for a next job. A TDM buffer can be used for TDM to show
1256 * it on screen or to capture an output and a layer. After all operations,
1257 * TDM will release it immediately when TDM doesn't need it any more.
1258 * @param[in] buffer A TDM buffer
1259 * @return A buffer itself. Otherwise, NULL.
1260 * @see tdm_buffer_unref_backend
1262 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1263 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1264 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1267 tdm_buffer_ref_backend(tbm_surface_h buffer);
1270 * @brief Decrease the ref_count of a TDM buffer
1271 * @param[in] buffer A TDM buffer
1272 * @see tdm_buffer_ref_backend
1275 tdm_buffer_unref_backend(tbm_surface_h buffer);
1278 * @brief The destroy handler of a TDM buffer
1279 * @param[in] buffer A TDM buffer
1280 * @param[in] user_data user data
1281 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1283 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1287 * @brief Add a destroy handler to a TDM buffer
1288 * @param[in] buffer A TDM buffer
1289 * @param[in] func A destroy handler
1290 * @param[in] user_data user data
1291 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1292 * @see tdm_buffer_remove_destroy_handler
1294 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1295 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1299 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1300 tdm_buffer_destroy_handler func, void *user_data);
1303 * @brief Remove a destroy handler from a TDM buffer
1304 * @param[in] buffer A TDM buffer
1305 * @param[in] func A destroy handler
1306 * @param[in] user_data user data
1307 * @see tdm_buffer_add_destroy_handler
1310 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1311 tdm_buffer_destroy_handler func, void *user_data);
1314 * @brief Add a FD handler for activity on the given file descriptor
1315 * @param[in] dpy A display object
1316 * @param[in] fd A file descriptor
1317 * @param[in] mask to monitor FD
1318 * @param[in] func A FD handler function
1319 * @param[in] user_data user data
1320 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1321 * @return A FD event source
1322 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1324 tdm_event_loop_source*
1325 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1326 tdm_event_loop_fd_handler func, void *user_data,
1330 * @brief Update the mask of the given FD event source
1331 * @param[in] source The given FD event source
1332 * @param[in] mask to monitor FD
1333 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1336 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1339 * @brief Add a timer handler
1340 * @param[in] dpy A display object
1341 * @param[in] func A timer handler function
1342 * @param[in] user_data user data
1343 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1344 * @return A timer event source
1345 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1347 tdm_event_loop_source*
1348 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1349 void *user_data, tdm_error *error);
1352 * @brief Update the millisecond delay time of the given timer event source.
1353 * @param[in] source The given timer event source
1354 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1355 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1358 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1361 * @brief Remove the given event source
1362 * @param[in] source The given event source
1363 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1366 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1369 * @brief Trigger a 'need to validate' event.
1370 * @param[in] output The output the event should be triggered for.
1371 * @note The global display lock has to be locked before the call to this function.
1372 * @see #tdm_output_hwc_set_need_validate_handler
1376 tdm_backend_trigger_need_validate_event(tdm_output *output);
1382 #endif /* _TDM_BACKEND_H_ */