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);
338 void (*reserved1)(void);
339 void (*reserved2)(void);
340 void (*reserved3)(void);
341 void (*reserved4)(void);
342 void (*reserved5)(void);
343 void (*reserved6)(void);
344 void (*reserved7)(void);
345 void (*reserved8)(void);
349 * @brief The output functions for a backend module.
351 typedef struct _tdm_func_output {
353 * @brief Get the capabilities of a output object
354 * @param[in] output A output object
355 * @param[out] caps The capabilities of a output object
356 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
358 * A backend module @b SHOULD implement this function. TDM calls this function
359 * not only at the initial time, but also at the update time when new output
361 * #tdm_caps_output contains connection status, modes, avaiable properties,
362 * size restriction information, etc.
364 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
367 * @brief Get a layer array of a output object
368 * @param[in] output A output object
369 * @param[out] count The count of layers
370 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
371 * @return A layer array which is @b newly-allocated
373 * A backend module @b SHOULD implement this function. TDM calls this function
374 * not only at the initial time, but also at the update time when new output
376 * A backend module @b SHOULD return the @b newly-allocated array which contains
377 * "tdm_layer*" data. It will be freed in frontend.
379 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
383 * @brief Set the property which has a given id
384 * @param[in] output A output object
385 * @param[in] id The property id
386 * @param[in] value The value
387 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
389 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
393 * @brief Get the property which has a given id
394 * @param[in] output A output object
395 * @param[in] id The property id
396 * @param[out] value The value
397 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
399 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
403 * @brief Wait for VBLANK
404 * @param[in] output A output object
405 * @param[in] interval vblank interval
406 * @param[in] sync 0: asynchronous, 1:synchronous
407 * @param[in] user_data The user data
408 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
409 * @see output_set_vblank_handler, tdm_output_vblank_handler
411 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
412 * a user vblank handler with the user data of this function after interval
415 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
419 * @brief Set a user vblank handler
420 * @param[in] output A output object
421 * @param[in] func A user vblank handler
422 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
424 tdm_error (*output_set_vblank_handler)(tdm_output *output,
425 tdm_output_vblank_handler func);
428 * @brief Commit changes for a output object
429 * @param[in] output A output object
430 * @param[in] sync 0: asynchronous, 1:synchronous
431 * @param[in] user_data The user data
432 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
433 * @see output_set_commit_handler, tdm_output_commit_handler
435 * When this function is called, a backend module @b SHOULD apply the all
436 * changes of the given output object to screen as well as the layer changes
438 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
439 * a user commit handler with the user data of this function after all
440 * changes of the given output object are applied.
442 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
445 * @brief Set a user commit handler
446 * @param[in] output A output object
447 * @param[in] func A user commit handler
448 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
450 tdm_error (*output_set_commit_handler)(tdm_output *output,
451 tdm_output_commit_handler func);
454 * @brief Set DPMS of a output object synchronously
455 * @param[in] output A output object
456 * @param[in] dpms_value DPMS value
457 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
459 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
462 * @brief Get DPMS of a output object
463 * @param[in] output A output object
464 * @param[out] dpms_value DPMS value
465 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
467 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
470 * @brief Set one of available modes of a output object
471 * @param[in] output A output object
472 * @param[in] mode A output mode
473 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
475 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
478 * @brief Get the mode of a output object
479 * @param[in] output A output object
480 * @param[out] mode A output mode
481 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
483 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
486 * @brief Create a capture object of a output object
487 * @param[in] output A output object
488 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
489 * @return A capture object
490 * @see capture_destroy() function of #tdm_func_capture
492 * A backend module doesn't need to implement this function if a hardware
493 * doesn't have the capture device.
495 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
498 * @brief Set a output connection status handler
499 * @details A backend module need to call the output status handler when the
500 * output connection status has been changed to let the TDM frontend know
502 * @param[in] output A output object
503 * @param[in] func A output status handler
504 * @param[in] user_data The user data
505 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
508 tdm_error (*output_set_status_handler)(tdm_output *output,
509 tdm_output_status_handler func,
513 * @brief Set a output dpms handler
514 * @details This function can be NULL if an output doesn't support asynchronous
515 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
516 * to let the TDM frontend know the output DPMS change indeed.
517 * @param[in] output A output object
518 * @param[in] func A output dpms handler
519 * @param[in] user_data The user data
520 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
521 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
524 tdm_error (*output_set_dpms_handler)(tdm_output *output,
525 tdm_output_dpms_handler func,
529 * @brief Set DPMS of a output object asynchronously
530 * @param[in] output A output object
531 * @details This function can be NULL if an output doesn't support asynchronous
532 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
533 * flags which #output_get_capability returns. And if a output dpms handler is added with
534 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
535 * to let the TDM frontend know the output DPMS change indeed.
536 * @param[in] dpms_value DPMS value
537 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
538 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
541 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
544 * @brief Creates a new window on the given display.
545 * @param[in] output A output object
546 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
547 * @return A created window object
550 tdm_hwc_window *(*output_hwc_create_window)(tdm_output *output, tdm_error *error);
553 * @brief Destroys the given window.
554 * @param[in] output A output object
555 * @param[in] window the pointer of the window to destroy
556 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
559 tdm_error (*output_hwc_destroy_window)(tdm_output *output, tdm_hwc_window *hwc_window);
562 * @brief Set the client(relative to the TDM) target buffer
563 * @details Sets the buffer which will receive the output of client composition.
564 * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
565 * will be composited into this buffer prior to the call to output_commit(),
566 * and windows not marked as TDM_COMPOSITION_CLIENT and
567 * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
570 * The buffer handle provided may be null if no windows are being composited by
571 * the client. This must not result in an error (unless an invalid display
572 * handle is also provided).
574 * The damage parameter describes a buffer damage region as defined in the
575 * description of hwc_window_set_buffer_damage().
577 * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer)
578 * will be passed along with #target_buffer to allow tdm to make the smooth transition
579 * from a DEVICE type to a CLIENT type.
581 * Will be called before output_commit() if any of the layers are marked as
582 * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
583 * so marked, then it is not necessary to call this function. It is not necessary
584 * to call output_hwc_validate() after changing the target through this function.
585 * @param[in] output A output object
586 * @param[in] target The new target buffer
587 * @param[in] damage The buffer damage region
588 * @param[in] composited_wnds The array of composited hwc_wnds
589 * @param[in] num_wnds The size of #composited_wnds array
590 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
593 tdm_error (*output_hwc_set_client_target_buffer)(tdm_output *output, tbm_surface_h target_buffer, tdm_hwc_region damage);
596 * @brief Unset the client(relative to the TDM) target buffer
598 * @param[in] output A output object
599 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
602 tdm_error (*output_hwc_unset_client_target_buffer)(tdm_output *output);
605 * @brief Get the layer associated with the client target buffer
607 * @param[in] output A output object
608 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
609 * @return A layer object.
612 tdm_layer *(*output_hwc_get_client_target_buffer_layer)(tdm_output *output, tdm_error *error);
615 * @brief Get the buffer which is set to the client target buffer
617 * @param[in] output A output object
618 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
619 * @return A layer object.
622 tbm_surface_h (*output_hwc_get_client_target_buffer)(tdm_output *output, tdm_error *error);
625 * @brief Validate the output
626 * @details Instructs the device to inspect all of the layer state and
627 * determine if there are any composition type changes necessary before
628 * presenting the output. Permitted changes are described in the definition
629 * of tdm_composition_t above.
630 * @param[in] output A output object
631 * @param[out] num_types The number of composition type changes required by
632 * the device; if greater than 0, the client must either set and validate new
633 * types, or call output_hwc_accept_changes() to accept the changes returned by
634 * output_hwc_get_changed_composition_types(); must be the same as the number of
635 * changes returned by output_hwc_get_changed_composition_types (see the
636 * declaration of that function for more information); pointer will be non-NULL
637 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
640 tdm_error (*output_hwc_validate)(tdm_output *output, tdm_hwc_window **composited_wnds, uint32_t num_wnds,
641 uint32_t *num_types);
644 * @brief Get changed composition types
645 * @details Retrieves the windows for which the device requires a different
646 * composition type than had been set prior to the last call to output_hwc_validate().
647 * The client will either update its state with these types and call
648 * output_hwc_accept_changes, or will set new types and attempt to validate the
650 * layers and types may be NULL to retrieve the number of elements which
651 * will be returned. The number of elements returned must be the same as the
652 * value returned in num_types from the last call to output_hwc_validate().
653 * @param[in] output A output object
654 * @param[out] num_elements If windows or types were NULL, the number of layers
655 * and types which would have been returned; if both were non-NULL, the
656 * number of elements returned in layers and types, which must not exceed
657 * the value stored in num_elements prior to the call; pointer will be
659 * @param[out] windows An array of windows
660 * @param[out] composition_types An array of composition types, each
661 * corresponding to an element of windows
662 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
665 tdm_error (*output_hwc_get_changed_composition_types)(tdm_output *output,
666 uint32_t *num_elements,
667 tdm_hwc_window **hwc_window,
668 tdm_hwc_window_composition *composition_types);
670 * @brief Accepts the changes required by the device
671 * @details Accepts the changes required by the device from the previous
672 * output_hwc_validate() call (which may be queried using
673 * output_get_chaged_composition_types()) and revalidates the display. This
674 * function is equivalent to requesting the changed types from
675 * output_get_chaged_composition_types(), setting those types on the
676 * corresponding windows, and then calling output_hwc_validate again.
677 * After this call it must be valid to present this display. Calling this after
678 * output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
679 * should have no other effect.
680 * @param[in] output A output object
681 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
684 tdm_error (*output_hwc_accept_changes)(tdm_output *output);
687 * @brief Get a target buffer queue
688 * @param[in] output A output object
689 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
690 * @return A buffer queue
693 tbm_surface_queue_h (*output_hwc_get_target_buffer_queue)(tdm_output *output,
697 * @brief Get the supported format array for video hwc windows of a output object.
698 * @param[in] output A output object
699 * @param[out] formats The available format array
700 * @param[out] count The count of formats
701 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
703 tdm_error (*output_hwc_get_video_supported_formats)(tdm_layer *layer,
704 const tbm_format **formats, int *count);
707 * @brief Creates a new video window on the given output.
708 * @param[in] output A output object
709 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
710 * @return A created window object. If the video abilities isn't accessed return NULL
713 tdm_hwc_window *(*output_hwc_create_video_window)(tdm_output *output, tdm_error *error);
715 void (*reserved5)(void);
716 void (*reserved6)(void);
717 void (*reserved7)(void);
718 void (*reserved8)(void);
722 * @brief The layer functions for a backend module.
724 typedef struct _tdm_func_layer {
726 * @brief Get the capabilities of a layer object
727 * @param[in] layer A layer object
728 * @param[out] caps The capabilities of a layer object
729 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
731 * A backend module @b SHOULD implement this function. TDM calls this function
732 * not only at the initial time, but also at the update time when new output
734 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
736 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
739 * @brief Set the property which has a given id.
740 * @param[in] layer A layer object
741 * @param[in] id The property id
742 * @param[in] value The value
743 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
745 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
749 * @brief Get the property which has a given id.
750 * @param[in] layer A layer object
751 * @param[in] id The property id
752 * @param[out] value The value
753 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
755 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
759 * @brief Set the geometry information to a layer object
760 * @param[in] layer A layer object
761 * @param[in] info The geometry information
762 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
763 * @see output_commit() function of #tdm_func_output
765 * A backend module would apply the geometry information when the output object
766 * of a layer object is committed.
768 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
771 * @brief Get the geometry information to a layer object
772 * @param[in] layer A layer object
773 * @param[out] info The geometry information
774 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
776 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
779 * @brief Set a TDM buffer to a layer object
780 * @param[in] layer A layer object
781 * @param[in] buffer A TDM buffer
782 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
783 * @see output_commit() function of #tdm_func_output
785 * A backend module would show a TDM buffer on screen when the output object
786 * of a layer object is committed.
788 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
791 * @brief Unset a TDM buffer from a layer object
792 * @param[in] layer A layer object
793 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
795 * A backend module @b SHOULD remove the current showing buffer from screen.
797 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
800 * @brief Set the zpos for a VIDEO layer object
801 * @param[in] layer A layer object
802 * @param[in] zpos z-order
803 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
804 * @see tdm_caps_layer, tdm_layer_capability
806 * A backend module doesn't need to implement this function if a backend
807 * module doesn't have VIDEO layers.\n
808 * This function is for VIDEO layers.
809 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
810 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
811 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
812 * is less than GRAPHIC layers or more than GRAPHIC layers.
813 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
814 * The zpos of VIDEO layers is @b relative. It doesn't need to start
815 * from -1 or 4. Let's suppose that there are two VIDEO layers.
816 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
817 * than -4 VIDEO layer.
819 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
822 * @brief Create a capture object of a layer object
823 * @param[in] output A output object
824 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
825 * @return A capture object
826 * @see capture_destroy() function of #tdm_func_capture
828 * A backend module doesn't need to implement this function if a hardware
829 * doesn't have the capture device.
831 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
834 * @brief Get buffer flags which the layer can support.
835 * @param[in] layer A layer object
836 * @param[out] flags The buffer flags which should be the tbm_bo flags
837 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
839 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
841 void (*reserved1)(void);
842 void (*reserved2)(void);
843 void (*reserved3)(void);
844 void (*reserved4)(void);
845 void (*reserved5)(void);
846 void (*reserved6)(void);
847 void (*reserved7)(void);
851 * @brief The window functions for a backend module.
854 typedef struct _tdm_func_window {
856 * @brief Get a buffer queue for the window object
857 * @param[in] hwc_window A window object
858 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
859 * @return A buffer queue
861 tbm_surface_queue_h (*hwc_window_get_tbm_buffer_queue)(tdm_hwc_window *hwc_window,
865 * @brief Sets the desired composition type of the given window.
866 * @details During output_hwc_validate(), the device may request changes to
867 * the composition types of any of the layers as described in the definition
868 * of tdm_hwc_window_composition_t above.
869 * @param[in] hwc_window A window object
870 * @param[in] composition_type The new composition type
871 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
873 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
874 tdm_hwc_window_composition composition_type);
877 * @brief Set the buffer damage
878 * @details Provides the region of the source buffer which has been modified
879 * since the last frame. This region does not need to be validated before
880 * calling output_commit().
881 * Once set through this function, the damage region remains the same until a
882 * subsequent call to this function.
883 * If damage.num_rects > 0, then it may be assumed that any portion of the source
884 * buffer not covered by one of the rects has not been modified this frame. If
885 * damage.num_rects == 0, then the whole source buffer must be treated as if it
887 * If the layer's contents are not modified relative to the prior frame, damage
888 * will contain exactly one empty rect([0, 0, 0, 0]).
889 * The damage rects are relative to the pre-transformed buffer, and their origin
890 * is the top-left corner. They will not exceed the dimensions of the latched
892 * @param[in] hwc_window A window object
893 * @param[in] damage The new buffer damage region
894 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
896 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
897 tdm_hwc_region damage);
900 * @brief Set the information to a window object
901 * @details The information will be applied when the output object
902 * of a layer object is committed.
903 * @param[in] hwc_window A window object
904 * @param[in] info The geometry information
905 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
907 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
908 tdm_hwc_window_info *info);
911 * @brief Get the geometry information to a layer object
912 * @param[in] layer A layer object
913 * @param[out] info The geometry information
914 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
916 tdm_error (*hwc_window_get_info)(tdm_hwc_window *hwc_window,
917 tdm_hwc_window_info *info);
920 * @brief Set a TDM buffer to a window object
921 * @details A TDM buffer will be applied when the output object
922 * of a layer object is committed.
923 * @param[in] hwc_window A window object
924 * @param[in] buffer A TDM buffer
925 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
927 * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
928 * be updated right now, this won't be interpreted like some critical
931 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
932 tbm_surface_h buffer);
935 * @brief Unset a TDM buffer to a window object
936 * @details A TDM buffer will be applied when the output object
937 * of a layer object is committed.
938 * @param[in] hwc_window A window object
939 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
941 * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
942 * be updated right now, this won't be interpreted like some critical
945 tdm_error (*hwc_window_unset_buffer)(tdm_hwc_window *hwc_window);
948 * @brief Get a buffer which is set to a window object
949 * @details A TDM buffer will be applied when the output object
950 * of a layer object is committed.
951 * @param[in] hwc_window A window object
952 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
953 * @return A buffer which is @b assigend to a window object
955 * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
956 * be updated right now, this won't be interpreted like some critical
959 tbm_surface_h (*hwc_window_get_buffer)(tdm_hwc_window *hwc_window,
963 * @brief Get a layer associated with a window object
964 * @param[in] hwc_window A window object
965 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
966 * @return A layer which is @b assigend to a window object
968 * A backend module @b SHOULD implement this function. The backend should
969 * return the tdm_layer assoicated with a hwc_window which must be assigend
972 tdm_layer *(*hwc_window_get_layer)(tdm_hwc_window *hwc_window,
976 * @brief Set a flags to a window object
977 * @param[in] hwc_window A window object
978 * @param[in] flags A hwc_window flags
979 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
981 tdm_error (*hwc_window_set_flags)(tdm_hwc_window *hwc_window,
982 tdm_hwc_window_flag flags);
985 * @brief Unset a flags from a window object
986 * @param[in] hwc_window A window object
987 * @param[in] flags A hwc_window flags
988 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
990 tdm_error (*hwc_window_unset_flags)(tdm_hwc_window *hwc_window,
991 tdm_hwc_window_flag flags);
994 * @brief Get the window video capability
995 * @param[in] hwc_window A window object
996 * @param[out] video_capability A hwc window video capability
997 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
999 tdm_error (*hwc_window_video_get_capability)(tdm_hwc_window *hwc_window,
1000 tdm_hwc_window_video_capability *video_capability);
1003 * @brief Get the available property array of a video hwc window object.
1004 * @param[in] hwc window A video hwc window object
1005 * @param[out] props The available property array
1006 * @param[out] count The count of properties
1007 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1009 tdm_error (*hwc_window_video_get_available_properties)(
1010 tdm_hwc_window *hwc_window,
1011 const tdm_prop **props, int *count);
1014 * @brief Get the property which has a given id.
1015 * @param[in] hwc window A video hwc window object
1016 * @param[in] id The property id
1017 * @param[out] value The value
1018 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1020 tdm_error (*hwc_window_video_get_property)(tdm_hwc_window *hwc_window,
1021 uint32_t id, tdm_value *value);
1024 * @brief Set the property which has a given id.
1025 * @param[in] hwc window A video hwc window object
1026 * @param[in] id The property id
1027 * @param[in] value The value
1028 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1030 tdm_error (*hwc_window_video_set_property)(tdm_hwc_window *hwc_window,
1031 uint32_t id, tdm_value value);
1033 } tdm_func_hwc_window;
1036 * @brief The pp functions for a backend module.
1038 typedef struct _tdm_func_pp {
1040 * @brief Destroy a pp object
1041 * @param[in] pp A pp object
1042 * @see display_create_pp() function of #tdm_func_display
1044 void (*pp_destroy)(tdm_pp *pp);
1047 * @brief Set the geometry information to a pp object
1048 * @param[in] pp A pp object
1049 * @param[in] info The geometry information
1050 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1051 * @see pp_commit() function of #tdm_func_pp
1053 * A backend module would apply the geometry information when committed.
1055 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1058 * @brief Attach a source buffer and a destination buffer to a pp object
1059 * @param[in] pp A pp object
1060 * @param[in] src A source buffer
1061 * @param[in] dst A destination buffer
1062 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1063 * @see pp_set_info() function of #tdm_func_pp
1064 * @see pp_commit() function of #tdm_func_pp
1065 * @see pp_set_done_handler, tdm_pp_done_handler
1067 * A backend module converts the image of a source buffer to a destination
1068 * buffer when committed. The size/crop/transform information is set via
1069 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1070 * return the source/destination buffer via tdm_pp_done_handler.
1072 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1075 * @brief Commit changes for a pp object
1076 * @param[in] pp A pp object
1077 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1079 tdm_error (*pp_commit)(tdm_pp *pp);
1082 * @brief Set a user done handler to a pp object
1083 * @param[in] pp A pp object
1084 * @param[in] func A user done handler
1085 * @param[in] user_data user data
1086 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1088 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1090 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1093 void (*reserved1)(void);
1094 void (*reserved2)(void);
1095 void (*reserved3)(void);
1096 void (*reserved4)(void);
1097 void (*reserved5)(void);
1098 void (*reserved6)(void);
1099 void (*reserved7)(void);
1100 void (*reserved8)(void);
1104 * @brief The capture functions for a backend module.
1106 typedef struct _tdm_func_capture {
1108 * @brief Destroy a capture object
1109 * @param[in] capture A capture object
1110 * @see output_create_capture() function of #tdm_func_output
1111 * @see layer_create_capture() function of #tdm_func_layer
1113 void (*capture_destroy)(tdm_capture *capture);
1116 * @brief Set the geometry information to a capture object
1117 * @param[in] capture A capture object
1118 * @param[in] info The geometry information
1119 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1120 * @see capture_commit() function of #tdm_func_capture
1122 * A backend module would apply the geometry information when committed.
1124 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1127 * @brief Attach a TDM buffer to a capture object
1128 * @details When capture_commit() function is called, a backend module starts
1129 * to dump a output or a layer to a TDM buffer.
1130 * @param[in] capture A capture object
1131 * @param[in] buffer A TDM buffer
1132 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1133 * @see capture_set_info() function of #tdm_func_capture
1134 * @see capture_commit() function of #tdm_func_capture
1135 * @see capture_set_done_handler, tdm_capture_done_handler
1137 * A backend module starts to dump a output or a layer to to a TDM buffer when
1138 * committed. The size/crop/transform information is set via #capture_set_info()
1139 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1140 * buffer via tdm_capture_done_handler.
1142 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1145 * @brief Commit changes for a capture object
1146 * @param[in] capture A capture object
1147 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1149 tdm_error (*capture_commit)(tdm_capture *capture);
1152 * @brief Set a user done handler to a capture object
1153 * @param[in] capture A capture object
1154 * @param[in] func A user done handler
1155 * @param[in] user_data user data
1156 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1158 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1160 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1161 tdm_capture_done_handler func, void *user_data);
1163 void (*reserved1)(void);
1164 void (*reserved2)(void);
1165 void (*reserved3)(void);
1166 void (*reserved4)(void);
1167 void (*reserved5)(void);
1168 void (*reserved6)(void);
1169 void (*reserved7)(void);
1170 void (*reserved8)(void);
1174 * @brief The tdm event source
1176 typedef void tdm_event_loop_source;
1179 * @brief The fd source handler
1181 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1184 * @brief The timer source handler
1186 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1188 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1189 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1190 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1191 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1195 * The ABI version of TDM backend module. It has a major and minor revision.
1196 * Modules using lower minor revisions will work with TDM frontend of a higher
1197 * minor revision. There is no compatibility between different major revisions.
1198 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1201 * tdm_backend_module tdm_backend_module_data = {
1204 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1210 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1211 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1212 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1216 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1218 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1220 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1223 * @brief The backend module information of the entry point to initialize a TDM
1226 * A backend module @b SHOULD define the global data symbol of which name is
1227 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1228 * at the initial time and call init() function of #tdm_backend_module.
1230 typedef struct _tdm_backend_module {
1231 const char *name; /**< The module name of a backend module */
1232 const char *vendor; /**< The vendor name of a backend module */
1233 unsigned long abi_version; /**< The ABI version of a backend module */
1236 * @brief The init function of a backend module
1237 * @param[in] dpy A display object
1238 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1239 * @return The backend module data
1240 * @see tdm_backend_data
1242 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1245 * @brief The deinit function of a backend module
1246 * @param[in] bdata The backend module data
1248 void (*deinit)(tdm_backend_data *bdata);
1249 } tdm_backend_module;
1252 * @brief Register the backend display functions to a display
1253 * @param[in] dpy A display object
1254 * @param[in] func_display display functions
1255 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1256 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1258 * A backend module @b SHOULD set the backend display functions at least.
1261 tdm_backend_register_func_display(tdm_display *dpy,
1262 tdm_func_display *func_display);
1265 * @brief Register the backend output functions to a display
1266 * @param[in] dpy A display object
1267 * @param[in] func_output output functions
1268 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1269 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1271 * A backend module @b SHOULD set the backend output functions at least.
1274 tdm_backend_register_func_output(tdm_display *dpy,
1275 tdm_func_output *func_output);
1278 * @brief Register the backend layer functions to a display
1279 * @param[in] dpy A display object
1280 * @param[in] func_layer layer functions
1281 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1282 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1284 * A backend module @b SHOULD set the backend layer functions at least.
1287 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1290 * @brief Register the backend hwc_window functions to a display
1291 * @param[in] dpy A display object
1292 * @param[in] func_hwc_window hwc_window functions
1293 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1294 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1296 * A backend module @b SHOULD set the backend hwc_window functions at least.
1300 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1303 * @brief Register the backend pp functions to a display
1304 * @param[in] dpy A display object
1305 * @param[in] func_pp pp functions
1306 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1307 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1309 * A backend module doesn'tcan skip to register the backend pp functions
1310 * if a hardware doesn't have the memory-to-memory converting device.
1313 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1316 * @brief Register the backend capture functions to a display
1317 * @param[in] dpy A display object
1318 * @param[in] func_capture capture functions
1319 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1320 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1322 * A backend module can skip to register the backend capture functions
1323 * if a hardware doesn't have the capture device.
1326 tdm_backend_register_func_capture(tdm_display *dpy,
1327 tdm_func_capture *func_capture);
1330 * @brief Increase the ref_count of a TDM buffer
1332 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1333 * becomes available for a next job. A TDM buffer can be used for TDM to show
1334 * it on screen or to capture an output and a layer. After all operations,
1335 * TDM will release it immediately when TDM doesn't need it any more.
1336 * @param[in] buffer A TDM buffer
1337 * @return A buffer itself. Otherwise, NULL.
1338 * @see tdm_buffer_unref_backend
1340 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1341 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1342 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1345 tdm_buffer_ref_backend(tbm_surface_h buffer);
1348 * @brief Decrease the ref_count of a TDM buffer
1349 * @param[in] buffer A TDM buffer
1350 * @see tdm_buffer_ref_backend
1353 tdm_buffer_unref_backend(tbm_surface_h buffer);
1356 * @brief The destroy handler of a TDM buffer
1357 * @param[in] buffer A TDM buffer
1358 * @param[in] user_data user data
1359 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1361 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1365 * @brief Add a destroy handler to a TDM buffer
1366 * @param[in] buffer A TDM buffer
1367 * @param[in] func A destroy handler
1368 * @param[in] user_data user data
1369 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1370 * @see tdm_buffer_remove_destroy_handler
1372 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1373 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1377 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1378 tdm_buffer_destroy_handler func, void *user_data);
1381 * @brief Remove a destroy handler from a TDM buffer
1382 * @param[in] buffer A TDM buffer
1383 * @param[in] func A destroy handler
1384 * @param[in] user_data user data
1385 * @see tdm_buffer_add_destroy_handler
1388 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1389 tdm_buffer_destroy_handler func, void *user_data);
1392 * @brief Add a FD handler for activity on the given file descriptor
1393 * @param[in] dpy A display object
1394 * @param[in] fd A file descriptor
1395 * @param[in] mask to monitor FD
1396 * @param[in] func A FD handler function
1397 * @param[in] user_data user data
1398 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1399 * @return A FD event source
1400 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1402 tdm_event_loop_source*
1403 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1404 tdm_event_loop_fd_handler func, void *user_data,
1408 * @brief Update the mask of the given FD event source
1409 * @param[in] source The given FD event source
1410 * @param[in] mask to monitor FD
1411 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1414 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1417 * @brief Add a timer handler
1418 * @param[in] dpy A display object
1419 * @param[in] func A timer handler function
1420 * @param[in] user_data user data
1421 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1422 * @return A timer event source
1423 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1425 tdm_event_loop_source*
1426 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1427 void *user_data, tdm_error *error);
1430 * @brief Update the millisecond delay time of the given timer event source.
1431 * @param[in] source The given timer event source
1432 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1436 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1439 * @brief Remove the given event source
1440 * @param[in] source The given event source
1441 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1444 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1448 * @brief Trigger a 'need to validate' event.
1449 * @param[in] output The output the event should be triggered for.
1450 * @note The global display lock has to be locked before the call to this function.
1451 * @see #tdm_output_hwc_set_need_validate_handler
1455 tdm_backend_trigger_need_validate_event(tdm_output *output);
1461 #endif /* _TDM_BACKEND_H_ */