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 */
153 tbm_format *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
155 unsigned int prop_count; /**< The count of available properties */
156 tdm_prop *props; /**< The @b newly-allocated array of properties. will be freed in frontend. */
160 * @brief The capabilities structure of a pp object
161 * @see The display_get_pp_capability() function of #tdm_func_display
163 typedef struct _tdm_caps_pp {
164 tdm_pp_capability capabilities; /**< The capabilities of pp */
166 unsigned int format_count; /**< The count of available formats */
168 *formats; /**< The @b newly-allocated array. will be freed in frontend. */
170 int min_w; /**< The minimun width */
171 int min_h; /**< The minimun height */
172 int max_w; /**< The maximum width */
173 int max_h; /**< The maximum height */
174 int preferred_align; /**< The prefered align */
176 /**< The attach count which a PP object can handle. @since 1.2.0 */
177 int max_attach_count;
181 * @brief The capabilities structure of a capture object
182 * @see The display_get_capture_capability() function of #tdm_func_display
184 typedef struct _tdm_caps_capture {
185 tdm_capture_capability capabilities; /**< The capabilities of capture */
187 unsigned int format_count; /**< The count of available formats */
189 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
191 int min_w; /**< The minimun width */
192 int min_h; /**< The minimun height */
193 int max_w; /**< The maximum width */
194 int max_h; /**< The maximum height */
195 int preferred_align; /**< The prefered align */
197 /**< The attach count which a capture object can handle. @since 1.2.0 */
198 int max_attach_count;
202 * @brief The display functions for a backend module.
204 typedef struct _tdm_func_display {
206 * @brief Get the display capabilities of a backend module
207 * @param[in] bdata The backend module data
208 * @param[out] caps The display capabilities of a backend module
209 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
211 * A backend module @b SHOULD implement this function. TDM calls this function
212 * not only at the initial time, but also at the update time when new output
214 * If a hardware has the restriction of the number of max usable layer count,
215 * a backend module can set the max count to max_layer_count of #tdm_caps_display
218 tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
221 * @brief Get the pp capabilities of a backend module
222 * @param[in] bdata The backend module data
223 * @param[out] caps The pp capabilities of a backend module
224 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
225 * @see tdm_backend_register_func_pp
227 * TDM calls this function not only at the initial time, but also at the update
228 * time when new output is connected.\n
229 * A backend module doesn't need to implement this function if a hardware
230 * doesn't have the memory-to-memory converting device. Otherwise, a backend module
231 * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
232 * restriction information which a converting device can handle. ie, format, size, etc.
234 tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
237 * @brief Get the capture capabilities of a backend module
238 * @param[in] bdata The backend module data
239 * @param[out] caps The capture capabilities of a backend module
240 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
241 * @see tdm_backend_register_func_capture
243 * TDM calls this function not only at the initial time, but also at the update
244 * time when new output is connected.\n
245 * A backend module doesn't need to implement this function if a hardware
246 * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
247 * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
248 * information which a capture device can handle. ie, format, size, etc.
250 tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
253 * @brief Get a output array of a backend module
254 * @param[in] bdata The backend module data
255 * @param[out] count The count of outputs
256 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
257 * @return A output array which is @b newly-allocated
258 * @see tdm_backend_register_func_capture
260 * A backend module @b SHOULD implement this function. TDM calls this function
261 * not only at the initial time, but also at the update time when new output
263 * A backend module @b SHOULD return the @b newly-allocated array which contains
264 * "tdm_output*" data. It will be freed in frontend.
268 * drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
270 * tdm_drm_data *drm_data = bdata;
271 * tdm_drm_output_data *output_data = NULL;
272 * tdm_output **outputs;
276 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
281 * if (error) *error = TDM_ERROR_NONE;
285 * // will be freed in frontend
286 * outputs = calloc(*count, sizeof(tdm_drm_output_data*));
290 * if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
295 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
296 * outputs[i++] = output_data;
298 * if (error) *error = TDM_ERROR_NONE;
304 tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
308 * @brief Get the file descriptor of a backend module
309 * @param[in] bdata The backend module data
310 * @param[out] fd The fd of a backend module
311 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
312 * @see display_handle_events() function of #tdm_func_display
314 * A backend module can return epoll's fd which is watching the backend device one more fds.
316 tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
319 * @brief Handle the events which happens on the fd of a backend module
320 * @param[in] bdata The backend module data
321 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
323 tdm_error (*display_handle_events)(tdm_backend_data *bdata);
326 * @brief Create a pp object of a backend module
327 * @param[in] bdata The backend module data
328 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
329 * @return A pp object
330 * @see pp_destroy() function of #tdm_func_pp
332 * A backend module doesn't need to implement this function if a hardware
333 * doesn't have the memory-to-memory converting device.
335 tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
338 * @brief Create a virtual output object of a backend module
339 * @param[in] bdata The backend module data
340 * @param[in] name The output name
341 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
342 * @return A tdm_voutput object
343 * @see voutput_destroy() function
345 * A backend module doesn't need to implement this function if doesn't support virtual output.
347 tdm_voutput *(*voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
349 void (*reserved2)(void);
350 void (*reserved3)(void);
351 void (*reserved4)(void);
352 void (*reserved5)(void);
353 void (*reserved6)(void);
354 void (*reserved7)(void);
355 void (*reserved8)(void);
359 * @brief The output functions for a backend module.
361 typedef struct _tdm_func_output {
363 * @brief Get the capabilities of a output object
364 * @param[in] output A output object
365 * @param[out] caps The capabilities of a output object
366 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
368 * A backend module @b SHOULD implement this function. TDM calls this function
369 * not only at the initial time, but also at the update time when new output
371 * #tdm_caps_output contains connection status, modes, avaiable properties,
372 * size restriction information, etc.
374 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
377 * @brief Get a layer array of a output object
378 * @param[in] output A output object
379 * @param[out] count The count of layers
380 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
381 * @return A layer array which is @b newly-allocated
383 * A backend module @b SHOULD implement this function. TDM calls this function
384 * not only at the initial time, but also at the update time when new output
386 * A backend module @b SHOULD return the @b newly-allocated array which contains
387 * "tdm_layer*" data. It will be freed in frontend.
389 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
393 * @brief Set the property which has a given id
394 * @param[in] output A output object
395 * @param[in] id The property id
396 * @param[in] value The value
397 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
399 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
403 * @brief Get the property which has a given id
404 * @param[in] output A output object
405 * @param[in] id The property id
406 * @param[out] value The value
407 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
409 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
413 * @brief Wait for VBLANK
414 * @param[in] output A output object
415 * @param[in] interval vblank interval
416 * @param[in] sync 0: asynchronous, 1:synchronous
417 * @param[in] user_data The user data
418 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
419 * @see output_set_vblank_handler, tdm_output_vblank_handler
421 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
422 * a user vblank handler with the user data of this function after interval
425 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
429 * @brief Set a user vblank handler
430 * @param[in] output A output object
431 * @param[in] func A user vblank handler
432 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
434 tdm_error (*output_set_vblank_handler)(tdm_output *output,
435 tdm_output_vblank_handler func);
438 * @brief Commit changes for a output object
439 * @param[in] output A output object
440 * @param[in] sync 0: asynchronous, 1:synchronous
441 * @param[in] user_data The user data
442 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
443 * @see output_set_commit_handler, tdm_output_commit_handler
445 * When this function is called, a backend module @b SHOULD apply the all
446 * changes of the given output object to screen as well as the layer changes
448 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
449 * a user commit handler with the user data of this function after all
450 * changes of the given output object are applied.
452 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
455 * @brief Set a user commit handler
456 * @param[in] output A output object
457 * @param[in] func A user commit handler
458 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
460 tdm_error (*output_set_commit_handler)(tdm_output *output,
461 tdm_output_commit_handler func);
464 * @brief Set DPMS of a output object synchronously
465 * @param[in] output A output object
466 * @param[in] dpms_value DPMS value
467 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
469 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
472 * @brief Get DPMS of a output object
473 * @param[in] output A output object
474 * @param[out] dpms_value DPMS value
475 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
477 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
480 * @brief Set one of available modes of a output object
481 * @param[in] output A output object
482 * @param[in] mode A output mode
483 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
485 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
488 * @brief Get the mode of a output object
489 * @param[in] output A output object
490 * @param[out] mode A output mode
491 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
493 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
496 * @brief Create a capture object of a output object
497 * @param[in] output A output object
498 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
499 * @return A capture object
500 * @see capture_destroy() function of #tdm_func_capture
502 * A backend module doesn't need to implement this function if a hardware
503 * doesn't have the capture device.
505 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
508 * @brief Set a output connection status handler
509 * @details A backend module need to call the output status handler when the
510 * output connection status has been changed to let the TDM frontend know
512 * @param[in] output A output object
513 * @param[in] func A output status handler
514 * @param[in] user_data The user data
515 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
518 tdm_error (*output_set_status_handler)(tdm_output *output,
519 tdm_output_status_handler func,
523 * @brief Set a output dpms handler
524 * @details This function can be NULL if an output doesn't support asynchronous
525 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
526 * to let the TDM frontend know the output DPMS change indeed.
527 * @param[in] output A output object
528 * @param[in] func A output dpms handler
529 * @param[in] user_data The user data
530 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
531 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
534 tdm_error (*output_set_dpms_handler)(tdm_output *output,
535 tdm_output_dpms_handler func,
539 * @brief Set DPMS of a output object asynchronously
540 * @param[in] output A output object
541 * @details This function can be NULL if an output doesn't support asynchronous
542 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
543 * flags which #output_get_capability returns. And if a output dpms handler is added with
544 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
545 * to let the TDM frontend know the output DPMS change indeed.
546 * @param[in] dpms_value DPMS value
547 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
548 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
551 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
554 * @brief Get a hwc object of a output object
555 * @param[in] output A output object
556 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
557 * @return A hwc object
559 tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
562 * @brief Set the mirror image of the src_output to the output
563 * @details This function set the mirro image of the src_output to the output.
564 * If there is the hardware or the implementation to display the mirror image
565 * of the src_output to the output, the backend does it in this function.
566 * If the backend output gets the ability of the mirror displaying, it has to
567 * set the TDM_OUTPUT_CAPABILITY_MIRROR on the output capability.
568 * @param[in] output A output object to display the src_output image
569 * @param[in] src_output A src output object of which image is displayed on the output
570 * @param[in] transform A transform value
571 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
572 * @see #TDM_OUTPUT_CAPABILITY_MIRROR
574 tdm_error (*output_set_mirror)(tdm_output *output,
575 tdm_output *src_output,
576 tdm_transform transform);
578 void (*reserved4)(void);
579 void (*reserved5)(void);
580 void (*reserved6)(void);
581 void (*reserved7)(void);
582 void (*reserved8)(void);
585 typedef struct _tdm_func_voutput {
587 * @brief Destroy a virtual output object of a backend module
588 * @param[in] voutput The voutput object
589 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
590 * @see voutput_create() function
592 * A backend module doesn't need to implement this function if doesn't support virtual output.
594 tdm_error (*voutput_destroy)(tdm_voutput *voutput);
597 * @brief Set available modes of a virtual output object
598 * @param[in] voutput A voutput object
599 * @param[in] modes Modes of voutput
600 * @param[in] count A count of modes
601 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
603 * A backend module doesn't need to implement this function if doesn't support virtual output.
605 tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
608 * @brief Set physical size(mm) of a virtual output object
609 * @param[in] voutput A voutput object
610 * @param[in] mmwidth Width of voutput
611 * @param[in] mmheight Height of voutput
612 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
614 * A backend module doesn't need to implement this function if doesn't support virtual output.
616 tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
619 * @brief Set connect status of a virtual output object
620 * @param[in] voutput A voutput object
621 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
623 * A backend module doesn't need to implement this function if doesn't support virtual output.
625 tdm_error (*voutput_connect)(tdm_voutput *voutput);
628 * @brief Set disconnect status of a virtual output object
629 * @param[in] voutput A voutput object
630 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
632 * A backend module doesn't need to implement this function if doesn't support virtual output.
634 tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
637 * @brief Get output object from virtual output object
638 * @param[in] voutput A voutput object
639 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
640 * @return A tdm_output object
642 * A backend module doesn't need to implement this function if doesn't support virtual output.
644 tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
647 * @brief Set a user commit function
648 * @param[in] voutput A voutput object
649 * @param[in] func A user voutput commit function
650 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
652 * A backend module doesn't need to implement this function if doesn't support virtual output.
653 * If virtual output's output_commit is executed, call this voutput commit func.
655 tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
658 * @brief Notify commit done to backend
659 * @param[in] voutput A voutput object
660 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
662 * A backend module doesn't need to implement this function if doesn't support virtual output.
664 tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
666 void (*reserved1)(void);
667 void (*reserved2)(void);
668 void (*reserved3)(void);
669 void (*reserved4)(void);
670 void (*reserved5)(void);
671 void (*reserved6)(void);
674 * @brief The layer functions for a backend module.
676 typedef struct _tdm_func_layer {
678 * @brief Get the capabilities of a layer object
679 * @param[in] layer A layer object
680 * @param[out] caps The capabilities of a layer object
681 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
683 * A backend module @b SHOULD implement this function. TDM calls this function
684 * not only at the initial time, but also at the update time when new output
686 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
688 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
691 * @brief Set the property which has a given id.
692 * @param[in] layer A layer object
693 * @param[in] id The property id
694 * @param[in] value The value
695 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
697 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
701 * @brief Get the property which has a given id.
702 * @param[in] layer A layer object
703 * @param[in] id The property id
704 * @param[out] value The value
705 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
707 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
711 * @brief Set the geometry information to a layer object
712 * @param[in] layer A layer object
713 * @param[in] info The geometry information
714 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
715 * @see output_commit() function of #tdm_func_output
717 * A backend module would apply the geometry information when the output object
718 * of a layer object is committed.
720 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
723 * @brief Get the geometry information to a layer object
724 * @param[in] layer A layer object
725 * @param[out] info The geometry information
726 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
728 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
731 * @brief Set a TDM buffer to a layer object
732 * @param[in] layer A layer object
733 * @param[in] buffer A TDM buffer
734 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
735 * @see output_commit() function of #tdm_func_output
737 * A backend module would show a TDM buffer on screen when the output object
738 * of a layer object is committed.
740 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
743 * @brief Unset a TDM buffer from a layer object
744 * @param[in] layer A layer object
745 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
747 * A backend module @b SHOULD remove the current showing buffer from screen.
749 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
752 * @brief Set the zpos for a VIDEO layer object
753 * @param[in] layer A layer object
754 * @param[in] zpos z-order
755 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
756 * @see tdm_caps_layer, tdm_layer_capability
758 * A backend module doesn't need to implement this function if a backend
759 * module doesn't have VIDEO layers.\n
760 * This function is for VIDEO layers.
761 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
762 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
763 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
764 * is less than GRAPHIC layers or more than GRAPHIC layers.
765 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
766 * The zpos of VIDEO layers is @b relative. It doesn't need to start
767 * from -1 or 4. Let's suppose that there are two VIDEO layers.
768 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
769 * than -4 VIDEO layer.
771 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
774 * @brief Create a capture object of a layer object
775 * @param[in] output A output object
776 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
777 * @return A capture object
778 * @see capture_destroy() function of #tdm_func_capture
780 * A backend module doesn't need to implement this function if a hardware
781 * doesn't have the capture device.
783 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
786 * @brief Get buffer flags which the layer can support.
787 * @param[in] layer A layer object
788 * @param[out] flags The buffer flags which should be the tbm_bo flags
789 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
791 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
793 void (*reserved1)(void);
794 void (*reserved2)(void);
795 void (*reserved3)(void);
796 void (*reserved4)(void);
797 void (*reserved5)(void);
798 void (*reserved6)(void);
799 void (*reserved7)(void);
802 typedef struct _tdm_func_hwc {
804 * @brief Create a new window on the given hwc.
805 * @param[in] hwc A hwc object
806 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
807 * @return A created window object
810 tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
813 * @brief Get video the supported format array for the hwc windows of a hwc object.
814 * @param[in] hwc A hwc object
815 * @param[out] formats The available format array
816 * @param[out] count The count of formats
817 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
819 tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
822 * @brief Get the available video property array of a hwc object.
823 * @param[in] hwc A hwc object
824 * @param[out] props The available video property array
825 * @param[out] count The count of video properties
826 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
828 tdm_error (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
832 * @brief Get the hwc capabilities
833 * @param[in] hwc A hwc object
834 * @param[out] capabilities A hwc hwc capability
835 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
837 tdm_error (*hwc_get_capabilities)(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
840 * @brief Get the available property array of a hwc object.
841 * @param[in] hwc A hwc object
842 * @param[out] props The available property array
843 * @param[out] count The count of properties
844 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
846 tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
850 * @brief Get a target buffer queue
851 * @param[in] hwc A hwc object
852 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
853 * @return A buffer queue
856 tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
860 * @brief Set the client(relative to the TDM) target buffer
861 * @details This function lets the backend know the target buffer.
862 * The target buffer contains the result of the gl composition with the
863 * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
864 * @param[in] hwc A hwc object
865 * @param[in] target_buffer The new target buffer
866 * @param[in] damage The buffer damage region
867 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
870 tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
871 tbm_surface_h target_buffer,
875 * @brief Validate the hwc
876 * @details Instructs the backend to inspect all of the hw layer state and
877 * determine if there are any composition type changes necessary before
878 * presenting the hwc.
879 * @param[in] hwc A hwc object
880 * @param[in] composited_wnds the hwc window list which is visible.
881 * @param[in] num_wnds the number of the visible windows in the composited_wnds
882 * @param[out] num_types The number of composition type changes
883 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
885 * The backend has to return the num_types when the assgined comopsite types of
886 * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
887 * 0, the cleint must get the changed composite types of the tdm_hwc_windows
888 * and change the comopsite types
891 tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
892 uint32_t num_wnds, uint32_t *num_types);
895 * @brief Get changed composition types
896 * @details Retrieves the windows for which the backend requires a different
897 * composition types that had been set prior to the last call to tdm_hwc_validate().
898 * The client will either update its state with these types and call
899 * tdm_hwc_accept_validation, or will set new types and attempt to validate the
900 * display again. The number of elements returned must be the same as the
901 * value returned in num_types from the last call to tdm_hwc_validate().
902 * @param[in] hwc A hwc object
903 * @param[out] num_elements the number of hwc_windows
904 * @param[out] windows An array of windows
905 * @param[out] composition_types An array of composition types, each corresponding
906 * to an element of windows
907 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
910 tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
911 tdm_hwc_window **hwc_window,
912 tdm_hwc_window_composition *composition_types);
914 * @brief Accepts the validation required by the backend
915 * @details Accepts the validation required by the backend from the previous
916 * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
917 * @param[in] hwc A hwc object
918 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
921 tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
924 * @brief Commit changes for a hwc object
925 * @param[in] hwc A hwc object
926 * @param[in] sync 0: asynchronous, 1:synchronous
927 * @param[in] user_data The user data
928 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
929 * @see hwc_set_commit_handler, tdm_hwc_commit_handler
931 * When this function is called, a backend module @b SHOULD apply the all
932 * changes of the given hwc object to screen as well as the layer changes
934 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
935 * a user commit handler with the user data of this function after all
936 * changes of the given hwc object are applied.
938 tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
941 * @brief Set a user commit handler
942 * @param[in] hwc A hwc object
943 * @param[in] func A user commit handler
944 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
946 tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
949 * @brief Set the property which has a given id on the hwc object.
950 * @param[in] hwc A hwc object
951 * @param[in] id The property id
952 * @param[in] value The value of the propery id
953 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
955 tdm_error (*hwc_set_property)(tdm_hwc *hwc, uint32_t id, tdm_value value);
958 * @brief Get the property which has a given id on the hwc object.
959 * @param[in] hwc A hwc object
960 * @param[in] id The property id
961 * @param[in] value The value of the propery id
962 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
964 tdm_error (*hwc_get_property)(tdm_hwc *hwc, uint32_t id, tdm_value *value);
968 * @brief The window functions for a backend module.
971 typedef struct _tdm_func_hwc_window {
973 * @brief Destroys the given window.
974 * @param[in] window the pointer of the window to destroy
977 void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
980 * @brief Acquire a buffer queue for the window object
981 * @details These buffers are used to composite by hardware a client content in
983 * @param[in] hwc_window A window object
984 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
985 * @return A buffer queue
987 tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
991 * @brief Release a buffer queue for the window object
992 * @details Release buffer queue when the client no longer uses buferrs of queue.
993 * @param[in] hwc_window A window object
994 * @param[in] A tbm buffer queue
996 void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
997 tbm_surface_queue_h queue);
1000 * @brief Sets the desired composition type of the given window.
1001 * @details During hwc_validate(), the backend may request changes to
1002 * the composition types of any of the layers as described in the definition
1003 * of tdm_hwc_window_composition_t above.
1004 * @param[in] hwc_window A window object
1005 * @param[in] composition_type The new composition type
1006 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1008 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
1009 tdm_hwc_window_composition composition_type);
1012 * @brief Set the buffer damage
1013 * @details Provides the region of the source buffer which has been modified
1014 * since the last frame. This region does not need to be validated before
1015 * calling hwc_commit().
1016 * Once set through this function, the damage region remains the same until a
1017 * subsequent call to this function.
1018 * If damage.num_rects > 0, then it may be assumed that any portion of the source
1019 * buffer not covered by one of the rects has not been modified this frame. If
1020 * damage.num_rects == 0, then the whole source buffer must be treated as if it
1021 * has been modified.
1022 * If the layer's contents are not modified relative to the prior frame, damage
1023 * will contain exactly one empty rect([0, 0, 0, 0]).
1024 * The damage rects are relative to the pre-transformed buffer, and their origin
1025 * is the top-left corner. They will not exceed the dimensions of the latched
1027 * @param[in] hwc_window A window object
1028 * @param[in] damage The new buffer damage region
1029 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1031 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
1035 * @brief Set the information to a window object
1036 * @details The information will be applied when the hwc object is committed.
1037 * @param[in] hwc_window A window object
1038 * @param[in] info The geometry information
1039 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1041 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
1042 tdm_hwc_window_info *info);
1045 * @brief Set a TDM buffer to a window object
1046 * @details A TDM buffer will be applied when the hwc object
1047 * of a layer object is committed.
1048 * @param[in] hwc_window A window object
1049 * @param[in] buffer A TBM buffer
1050 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1052 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
1053 tbm_surface_h buffer);
1056 * @brief Set the property which has a given id.
1057 * @param[in] hwc_window A hwc window object
1058 * @param[in] id The property id
1059 * @param[in] value The value of the propery id
1060 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1062 tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
1063 uint32_t id, tdm_value value);
1066 * @brief Get the property which has a given id.
1067 * @param[in] hwc_window A hwc window object
1068 * @param[in] id The property id
1069 * @param[out] value The value of the propery id
1070 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1072 tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
1073 uint32_t id, tdm_value *value);
1076 * @brief Get the constraints of hwc_window
1077 * @param[in] hwc_window A hwc window object
1078 * @param[out] constraints The tdm_hwc_window_constraint types
1079 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1081 tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
1085 * @brief Set the name of hwc_window
1086 * @param[in] hwc_window A hwc window object
1087 * @param[in] name of the hwc_window
1088 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1090 tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window,
1094 * @brief Get buffer flags of cursor hwc_window
1095 * @param[in] hwc_window A hwc window object
1096 * @param[in] width of the cursor image
1097 * @param[in] height of the cursor image
1098 * @param[in] stride of the cursor image
1099 * @param[in] virtual address of the cursor image
1100 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1102 tdm_error (*hwc_window_set_cursor_image)(tdm_hwc_window *hwc_window,
1103 int width, int height, int stride, void *ptr);
1104 } tdm_func_hwc_window;
1107 * @brief The pp functions for a backend module.
1109 typedef struct _tdm_func_pp {
1111 * @brief Destroy a pp object
1112 * @param[in] pp A pp object
1113 * @see display_create_pp() function of #tdm_func_display
1115 void (*pp_destroy)(tdm_pp *pp);
1118 * @brief Set the geometry information to a pp object
1119 * @param[in] pp A pp object
1120 * @param[in] info The geometry information
1121 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1122 * @see pp_commit() function of #tdm_func_pp
1124 * A backend module would apply the geometry information when committed.
1126 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1129 * @brief Attach a source buffer and a destination buffer to a pp object
1130 * @param[in] pp A pp object
1131 * @param[in] src A source buffer
1132 * @param[in] dst A destination buffer
1133 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1134 * @see pp_set_info() function of #tdm_func_pp
1135 * @see pp_commit() function of #tdm_func_pp
1136 * @see pp_set_done_handler, tdm_pp_done_handler
1138 * A backend module converts the image of a source buffer to a destination
1139 * buffer when committed. The size/crop/transform information is set via
1140 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1141 * return the source/destination buffer via tdm_pp_done_handler.
1143 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1146 * @brief Commit changes for a pp object
1147 * @param[in] pp A pp object
1148 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1150 tdm_error (*pp_commit)(tdm_pp *pp);
1153 * @brief Set a user done handler to a pp object
1154 * @param[in] pp A pp object
1155 * @param[in] func A user done handler
1156 * @param[in] user_data user data
1157 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1159 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1161 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1164 void (*reserved1)(void);
1165 void (*reserved2)(void);
1166 void (*reserved3)(void);
1167 void (*reserved4)(void);
1168 void (*reserved5)(void);
1169 void (*reserved6)(void);
1170 void (*reserved7)(void);
1171 void (*reserved8)(void);
1175 * @brief The capture functions for a backend module.
1177 typedef struct _tdm_func_capture {
1179 * @brief Destroy a capture object
1180 * @param[in] capture A capture object
1181 * @see output_create_capture() function of #tdm_func_output
1182 * @see layer_create_capture() function of #tdm_func_layer
1184 void (*capture_destroy)(tdm_capture *capture);
1187 * @brief Set the geometry information to a capture object
1188 * @param[in] capture A capture object
1189 * @param[in] info The geometry information
1190 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1191 * @see capture_commit() function of #tdm_func_capture
1193 * A backend module would apply the geometry information when committed.
1195 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1198 * @brief Attach a TDM buffer to a capture object
1199 * @details When capture_commit() function is called, a backend module starts
1200 * to dump a output or a layer to a TDM buffer.
1201 * @param[in] capture A capture object
1202 * @param[in] buffer A TDM buffer
1203 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1204 * @see capture_set_info() function of #tdm_func_capture
1205 * @see capture_commit() function of #tdm_func_capture
1206 * @see capture_set_done_handler, tdm_capture_done_handler
1208 * A backend module starts to dump a output or a layer to to a TDM buffer when
1209 * committed. The size/crop/transform information is set via #capture_set_info()
1210 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1211 * buffer via tdm_capture_done_handler.
1213 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1216 * @brief Commit changes for a capture object
1217 * @param[in] capture A capture object
1218 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1220 tdm_error (*capture_commit)(tdm_capture *capture);
1223 * @brief Set a user done handler to a capture object
1224 * @param[in] capture A capture object
1225 * @param[in] func A user done handler
1226 * @param[in] user_data user data
1227 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1229 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1231 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1232 tdm_capture_done_handler func, void *user_data);
1234 void (*reserved1)(void);
1235 void (*reserved2)(void);
1236 void (*reserved3)(void);
1237 void (*reserved4)(void);
1238 void (*reserved5)(void);
1239 void (*reserved6)(void);
1240 void (*reserved7)(void);
1241 void (*reserved8)(void);
1245 * @brief The tdm event source
1247 typedef void tdm_event_loop_source;
1250 * @brief The fd source handler
1252 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1255 * @brief The timer source handler
1257 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1259 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1260 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1261 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1262 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1266 * The ABI version of TDM backend module. It has a major and minor revision.
1267 * Modules using lower minor revisions will work with TDM frontend of a higher
1268 * minor revision. There is no compatibility between different major revisions.
1269 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1272 * tdm_backend_module tdm_backend_module_data = {
1275 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1281 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1282 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1283 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1286 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1287 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1288 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */
1292 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1294 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1296 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1299 * @brief The backend module information of the entry point to initialize a TDM
1302 * A backend module @b SHOULD define the global data symbol of which name is
1303 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1304 * at the initial time and call init() function of #tdm_backend_module.
1306 typedef struct _tdm_backend_module {
1307 const char *name; /**< The module name of a backend module */
1308 const char *vendor; /**< The vendor name of a backend module */
1309 unsigned long abi_version; /**< The ABI version of a backend module */
1312 * @brief The init function of a backend module
1313 * @param[in] dpy A display object
1314 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1315 * @return The backend module data
1316 * @see tdm_backend_data
1318 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1321 * @brief The deinit function of a backend module
1322 * @param[in] bdata The backend module data
1324 void (*deinit)(tdm_backend_data *bdata);
1325 } tdm_backend_module;
1328 * @brief Register the backend display functions to a display
1329 * @param[in] dpy A display object
1330 * @param[in] func_display display functions
1331 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1332 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1334 * A backend module @b SHOULD set the backend display functions at least.
1337 tdm_backend_register_func_display(tdm_display *dpy,
1338 tdm_func_display *func_display);
1341 * @brief Register the backend output functions to a display
1342 * @param[in] dpy A display object
1343 * @param[in] func_output output functions
1344 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1345 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1347 * A backend module @b SHOULD set the backend output functions at least.
1350 tdm_backend_register_func_output(tdm_display *dpy,
1351 tdm_func_output *func_output);
1354 * @brief Register the backend voutput functions to a display
1355 * @param[in] dpy A display object
1356 * @param[in] func_voutput voutput functions
1357 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1358 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1360 * A backend module doesn't need to implement this function if doesn't support virtual output.
1363 tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
1366 * @brief Register the backend layer functions to a display
1367 * @param[in] dpy A display object
1368 * @param[in] func_layer layer functions
1369 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1370 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1372 * A backend module @b SHOULD set the backend layer functions at least.
1375 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1378 * @brief Register the backend hwc functions to a display
1379 * @param[in] dpy A display object
1380 * @param[in] func_hwc hwc functions
1381 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1382 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1384 * A backend module @b SHOULD set the backend hwc functions at least.
1388 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1391 * @brief Register the backend hwc_window functions to a display
1392 * @param[in] dpy A display object
1393 * @param[in] func_hwc_window hwc_window functions
1394 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1395 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1397 * A backend module @b SHOULD set the backend hwc_window functions at least.
1401 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1404 * @brief Register the backend pp functions to a display
1405 * @param[in] dpy A display object
1406 * @param[in] func_pp pp functions
1407 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1408 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1410 * A backend module doesn'tcan skip to register the backend pp functions
1411 * if a hardware doesn't have the memory-to-memory converting device.
1414 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1417 * @brief Register the backend capture functions to a display
1418 * @param[in] dpy A display object
1419 * @param[in] func_capture capture functions
1420 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1421 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1423 * A backend module can skip to register the backend capture functions
1424 * if a hardware doesn't have the capture device.
1427 tdm_backend_register_func_capture(tdm_display *dpy,
1428 tdm_func_capture *func_capture);
1431 * @brief Register the backend output to a display
1432 * @param[in] dpy A display object
1433 * @param[in] output A backend output object
1434 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1435 * @see tdm_backend_unregister_output
1438 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1441 * @brief Unregister the backend output to a display
1442 * @param[in] dpy A display object
1443 * @param[in] output A backend output object
1444 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1445 * @see tdm_backend_register_output
1448 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1451 * @brief Increase the ref_count of a TDM buffer
1453 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1454 * becomes available for a next job. A TDM buffer can be used for TDM to show
1455 * it on screen or to capture an output and a layer. After all operations,
1456 * TDM will release it immediately when TDM doesn't need it any more.
1457 * @param[in] buffer A TDM buffer
1458 * @return A buffer itself. Otherwise, NULL.
1459 * @see tdm_buffer_unref_backend
1461 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1462 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1463 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1466 tdm_buffer_ref_backend(tbm_surface_h buffer);
1469 * @brief Decrease the ref_count of a TDM buffer
1470 * @param[in] buffer A TDM buffer
1471 * @see tdm_buffer_ref_backend
1474 tdm_buffer_unref_backend(tbm_surface_h buffer);
1477 * @brief The destroy handler of a TDM buffer
1478 * @param[in] buffer A TDM buffer
1479 * @param[in] user_data user data
1480 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1482 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1486 * @brief Add a destroy handler to a TDM buffer
1487 * @param[in] buffer A TDM buffer
1488 * @param[in] func A destroy handler
1489 * @param[in] user_data user data
1490 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1491 * @see tdm_buffer_remove_destroy_handler
1493 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1494 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1498 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1499 tdm_buffer_destroy_handler func, void *user_data);
1502 * @brief Remove a destroy handler from a TDM buffer
1503 * @param[in] buffer A TDM buffer
1504 * @param[in] func A destroy handler
1505 * @param[in] user_data user data
1506 * @see tdm_buffer_add_destroy_handler
1509 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1510 tdm_buffer_destroy_handler func, void *user_data);
1513 * @brief Add a FD handler for activity on the given file descriptor
1514 * @param[in] dpy A display object
1515 * @param[in] fd A file descriptor
1516 * @param[in] mask to monitor FD
1517 * @param[in] func A FD handler function
1518 * @param[in] user_data user data
1519 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1520 * @return A FD event source
1521 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1523 tdm_event_loop_source*
1524 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1525 tdm_event_loop_fd_handler func, void *user_data,
1529 * @brief Update the mask of the given FD event source
1530 * @param[in] source The given FD event source
1531 * @param[in] mask to monitor FD
1532 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1535 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1538 * @brief Add a timer handler
1539 * @param[in] dpy A display object
1540 * @param[in] func A timer handler function
1541 * @param[in] user_data user data
1542 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1543 * @return A timer event source
1544 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1546 tdm_event_loop_source*
1547 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1548 void *user_data, tdm_error *error);
1551 * @brief Update the millisecond delay time of the given timer event source.
1552 * @param[in] source The given timer event source
1553 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1554 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1557 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1560 * @brief Remove the given event source
1561 * @param[in] source The given event source
1562 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1565 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1568 * @brief Get the ini value with given key
1570 * @param[in] key The given key
1571 * @param[in] default_value The default value
1572 * @return the value of given key if success. Otherwise, default_value.
1573 * @see #tdm_config_get_string
1576 tdm_config_get_int(const char *key, int default_value);
1579 * @brief Get the ini value with given key
1581 * @param[in] key The given key
1582 * @param[in] default_value The default value
1583 * @return the value of given key if success. Otherwise, default_value.
1584 * @see #tdm_config_get_int
1587 tdm_config_get_string(const char *key, const char *default_value);
1593 #endif /* _TDM_BACKEND_H_ */