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 #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
574 tdm_error (*output_set_mirror)(tdm_output *output,
575 tdm_output *src_output,
576 tdm_transform transform);
578 * @brief Unset the mirror image
579 * @details This function unset the mirro image of the output.
580 * @param[in] output A output object to display the src_output image
581 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
582 * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
584 tdm_error (*output_unset_mirror)(tdm_output *output);
586 void (*reserved4)(void);
587 void (*reserved5)(void);
588 void (*reserved6)(void);
589 void (*reserved7)(void);
590 void (*reserved8)(void);
593 typedef struct _tdm_func_voutput {
595 * @brief Destroy a virtual output object of a backend module
596 * @param[in] voutput The voutput object
597 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
598 * @see voutput_create() function
600 * A backend module doesn't need to implement this function if doesn't support virtual output.
602 tdm_error (*voutput_destroy)(tdm_voutput *voutput);
605 * @brief Set available modes of a virtual output object
606 * @param[in] voutput A voutput object
607 * @param[in] modes Modes of voutput
608 * @param[in] count A count of modes
609 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
611 * A backend module doesn't need to implement this function if doesn't support virtual output.
613 tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
616 * @brief Set physical size(mm) of a virtual output object
617 * @param[in] voutput A voutput object
618 * @param[in] mmwidth Width of voutput
619 * @param[in] mmheight Height of voutput
620 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
622 * A backend module doesn't need to implement this function if doesn't support virtual output.
624 tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
627 * @brief Set connect status of a virtual output object
628 * @param[in] voutput A voutput object
629 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
631 * A backend module doesn't need to implement this function if doesn't support virtual output.
633 tdm_error (*voutput_connect)(tdm_voutput *voutput);
636 * @brief Set disconnect status of a virtual output object
637 * @param[in] voutput A voutput object
638 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
640 * A backend module doesn't need to implement this function if doesn't support virtual output.
642 tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
645 * @brief Get output object from virtual output object
646 * @param[in] voutput A voutput object
647 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
648 * @return A tdm_output object
650 * A backend module doesn't need to implement this function if doesn't support virtual output.
652 tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
655 * @brief Set a user commit function
656 * @param[in] voutput A voutput object
657 * @param[in] func A user voutput commit function
658 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
660 * A backend module doesn't need to implement this function if doesn't support virtual output.
661 * If virtual output's output_commit is executed, call this voutput commit func.
663 tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
666 * @brief Notify commit done to backend
667 * @param[in] voutput A voutput object
668 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
670 * A backend module doesn't need to implement this function if doesn't support virtual output.
672 tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
674 void (*reserved1)(void);
675 void (*reserved2)(void);
676 void (*reserved3)(void);
677 void (*reserved4)(void);
678 void (*reserved5)(void);
679 void (*reserved6)(void);
682 * @brief The layer functions for a backend module.
684 typedef struct _tdm_func_layer {
686 * @brief Get the capabilities of a layer object
687 * @param[in] layer A layer object
688 * @param[out] caps The capabilities of a layer object
689 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
691 * A backend module @b SHOULD implement this function. TDM calls this function
692 * not only at the initial time, but also at the update time when new output
694 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
696 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
699 * @brief Set the property which has a given id.
700 * @param[in] layer A layer object
701 * @param[in] id The property id
702 * @param[in] value The value
703 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
705 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
709 * @brief Get the property which has a given id.
710 * @param[in] layer A layer object
711 * @param[in] id The property id
712 * @param[out] value The value
713 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
715 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
719 * @brief Set the geometry information to a layer object
720 * @param[in] layer A layer object
721 * @param[in] info The geometry information
722 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
723 * @see output_commit() function of #tdm_func_output
725 * A backend module would apply the geometry information when the output object
726 * of a layer object is committed.
728 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
731 * @brief Get the geometry information to a layer object
732 * @param[in] layer A layer object
733 * @param[out] info The geometry information
734 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
736 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
739 * @brief Set a TDM buffer to a layer object
740 * @param[in] layer A layer object
741 * @param[in] buffer A TDM buffer
742 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
743 * @see output_commit() function of #tdm_func_output
745 * A backend module would show a TDM buffer on screen when the output object
746 * of a layer object is committed.
748 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
751 * @brief Unset a TDM buffer from a layer object
752 * @param[in] layer A layer object
753 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
755 * A backend module @b SHOULD remove the current showing buffer from screen.
757 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
760 * @brief Set the zpos for a VIDEO layer object
761 * @param[in] layer A layer object
762 * @param[in] zpos z-order
763 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
764 * @see tdm_caps_layer, tdm_layer_capability
766 * A backend module doesn't need to implement this function if a backend
767 * module doesn't have VIDEO layers.\n
768 * This function is for VIDEO layers.
769 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
770 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
771 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
772 * is less than GRAPHIC layers or more than GRAPHIC layers.
773 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
774 * The zpos of VIDEO layers is @b relative. It doesn't need to start
775 * from -1 or 4. Let's suppose that there are two VIDEO layers.
776 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
777 * than -4 VIDEO layer.
779 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
782 * @brief Create a capture object of a layer object
783 * @param[in] output A output object
784 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
785 * @return A capture object
786 * @see capture_destroy() function of #tdm_func_capture
788 * A backend module doesn't need to implement this function if a hardware
789 * doesn't have the capture device.
791 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
794 * @brief Get buffer flags which the layer can support.
795 * @param[in] layer A layer object
796 * @param[out] flags The buffer flags which should be the tbm_bo flags
797 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
799 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
801 void (*reserved1)(void);
802 void (*reserved2)(void);
803 void (*reserved3)(void);
804 void (*reserved4)(void);
805 void (*reserved5)(void);
806 void (*reserved6)(void);
807 void (*reserved7)(void);
810 typedef struct _tdm_func_hwc {
812 * @brief Create a new window on the given hwc.
813 * @param[in] hwc A hwc object
814 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
815 * @return A created window object
818 tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
821 * @brief Get video the supported format array for the hwc windows of a hwc object.
822 * @param[in] hwc A hwc object
823 * @param[out] formats The available format array
824 * @param[out] count The count of formats
825 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
827 tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
830 * @brief Get the available video property array of a hwc object.
831 * @param[in] hwc A hwc object
832 * @param[out] props The available video property array
833 * @param[out] count The count of video properties
834 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
836 tdm_error (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
840 * @brief Get the hwc capabilities
841 * @param[in] hwc A hwc object
842 * @param[out] capabilities A hwc hwc capability
843 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
845 tdm_error (*hwc_get_capabilities)(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
848 * @brief Get the available property array of a hwc object.
849 * @param[in] hwc A hwc object
850 * @param[out] props The available property array
851 * @param[out] count The count of properties
852 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
854 tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
858 * @brief Get a target buffer queue
859 * @param[in] hwc A hwc object
860 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
861 * @return A buffer queue
864 tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
868 * @brief Set the client(relative to the TDM) target buffer
869 * @details This function lets the backend know the target buffer.
870 * The target buffer contains the result of the gl composition with the
871 * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
872 * @param[in] hwc A hwc object
873 * @param[in] target_buffer The new target buffer
874 * @param[in] damage The buffer damage region
875 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
878 tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
879 tbm_surface_h target_buffer,
883 * @brief Validate the hwc
884 * @details Instructs the backend to inspect all of the hw layer state and
885 * determine if there are any composition type changes necessary before
886 * presenting the hwc.
887 * @param[in] hwc A hwc object
888 * @param[in] composited_wnds the hwc window list which is visible.
889 * @param[in] num_wnds the number of the visible windows in the composited_wnds
890 * @param[out] num_types The number of composition type changes
891 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
893 * The backend has to return the num_types when the assgined comopsite types of
894 * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
895 * 0, the cleint must get the changed composite types of the tdm_hwc_windows
896 * and change the comopsite types
899 tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
900 uint32_t num_wnds, uint32_t *num_types);
903 * @brief Get changed composition types
904 * @details Retrieves the windows for which the backend requires a different
905 * composition types that had been set prior to the last call to tdm_hwc_validate().
906 * The client will either update its state with these types and call
907 * tdm_hwc_accept_validation, or will set new types and attempt to validate the
908 * display again. The number of elements returned must be the same as the
909 * value returned in num_types from the last call to tdm_hwc_validate().
910 * @param[in] hwc A hwc object
911 * @param[out] num_elements the number of hwc_windows
912 * @param[out] windows An array of windows
913 * @param[out] composition_types An array of composition types, each corresponding
914 * to an element of windows
915 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
918 tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
919 tdm_hwc_window **hwc_window,
920 tdm_hwc_window_composition *composition_types);
922 * @brief Accepts the validation required by the backend
923 * @details Accepts the validation required by the backend from the previous
924 * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
925 * @param[in] hwc A hwc object
926 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
929 tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
932 * @brief Commit changes for a hwc object
933 * @param[in] hwc A hwc object
934 * @param[in] sync 0: asynchronous, 1:synchronous
935 * @param[in] user_data The user data
936 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
937 * @see hwc_set_commit_handler, tdm_hwc_commit_handler
939 * When this function is called, a backend module @b SHOULD apply the all
940 * changes of the given hwc object to screen as well as the layer changes
942 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
943 * a user commit handler with the user data of this function after all
944 * changes of the given hwc object are applied.
946 tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
949 * @brief Set a user commit handler
950 * @param[in] hwc A hwc object
951 * @param[in] func A user commit handler
952 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
954 tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
957 * @brief Set the property which has a given id on the hwc object.
958 * @param[in] hwc A hwc object
959 * @param[in] id The property id
960 * @param[in] value The value of the propery id
961 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
963 tdm_error (*hwc_set_property)(tdm_hwc *hwc, uint32_t id, tdm_value value);
966 * @brief Get the property which has a given id on the hwc object.
967 * @param[in] hwc A hwc object
968 * @param[in] id The property id
969 * @param[in] value The value of the propery id
970 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
972 tdm_error (*hwc_get_property)(tdm_hwc *hwc, uint32_t id, tdm_value *value);
976 * @brief The window functions for a backend module.
979 typedef struct _tdm_func_hwc_window {
981 * @brief Destroys the given window.
982 * @param[in] window the pointer of the window to destroy
985 void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
988 * @brief Acquire a buffer queue for the window object
989 * @details These buffers are used to composite by hardware a client content in
991 * @param[in] hwc_window A window object
992 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
993 * @return A buffer queue
995 tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
999 * @brief Release a buffer queue for the window object
1000 * @details Release buffer queue when the client no longer uses buferrs of queue.
1001 * @param[in] hwc_window A window object
1002 * @param[in] A tbm buffer queue
1004 void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
1005 tbm_surface_queue_h queue);
1008 * @brief Sets the desired composition type of the given window.
1009 * @details During hwc_validate(), the backend may request changes to
1010 * the composition types of any of the layers as described in the definition
1011 * of tdm_hwc_window_composition_t above.
1012 * @param[in] hwc_window A window object
1013 * @param[in] composition_type The new composition type
1014 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1016 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
1017 tdm_hwc_window_composition composition_type);
1020 * @brief Set the buffer damage
1021 * @details Provides the region of the source buffer which has been modified
1022 * since the last frame. This region does not need to be validated before
1023 * calling hwc_commit().
1024 * Once set through this function, the damage region remains the same until a
1025 * subsequent call to this function.
1026 * If damage.num_rects > 0, then it may be assumed that any portion of the source
1027 * buffer not covered by one of the rects has not been modified this frame. If
1028 * damage.num_rects == 0, then the whole source buffer must be treated as if it
1029 * has been modified.
1030 * If the layer's contents are not modified relative to the prior frame, damage
1031 * will contain exactly one empty rect([0, 0, 0, 0]).
1032 * The damage rects are relative to the pre-transformed buffer, and their origin
1033 * is the top-left corner. They will not exceed the dimensions of the latched
1035 * @param[in] hwc_window A window object
1036 * @param[in] damage The new buffer damage region
1037 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1039 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
1043 * @brief Set the information to a window object
1044 * @details The information will be applied when the hwc object is committed.
1045 * @param[in] hwc_window A window object
1046 * @param[in] info The geometry information
1047 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1049 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
1050 tdm_hwc_window_info *info);
1053 * @brief Set a TDM buffer to a window object
1054 * @details A TDM buffer will be applied when the hwc object
1055 * of a layer object is committed.
1056 * @param[in] hwc_window A window object
1057 * @param[in] buffer A TBM buffer
1058 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1060 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
1061 tbm_surface_h buffer);
1064 * @brief Set the property which has a given id.
1065 * @param[in] hwc_window A hwc window object
1066 * @param[in] id The property id
1067 * @param[in] value The value of the propery id
1068 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1070 tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
1071 uint32_t id, tdm_value value);
1074 * @brief Get the property which has a given id.
1075 * @param[in] hwc_window A hwc window object
1076 * @param[in] id The property id
1077 * @param[out] value The value of the propery id
1078 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1080 tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
1081 uint32_t id, tdm_value *value);
1084 * @brief Get the constraints of hwc_window
1085 * @param[in] hwc_window A hwc window object
1086 * @param[out] constraints The tdm_hwc_window_constraint types
1087 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1089 tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
1093 * @brief Set the name of hwc_window
1094 * @param[in] hwc_window A hwc window object
1095 * @param[in] name of the hwc_window
1096 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1098 tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window,
1102 * @brief Get buffer flags of cursor hwc_window
1103 * @param[in] hwc_window A hwc window object
1104 * @param[in] width of the cursor image
1105 * @param[in] height of the cursor image
1106 * @param[in] stride of the cursor image
1107 * @param[in] virtual address of the cursor image
1108 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1110 tdm_error (*hwc_window_set_cursor_image)(tdm_hwc_window *hwc_window,
1111 int width, int height, int stride, void *ptr);
1112 } tdm_func_hwc_window;
1115 * @brief The pp functions for a backend module.
1117 typedef struct _tdm_func_pp {
1119 * @brief Destroy a pp object
1120 * @param[in] pp A pp object
1121 * @see display_create_pp() function of #tdm_func_display
1123 void (*pp_destroy)(tdm_pp *pp);
1126 * @brief Set the geometry information to a pp object
1127 * @param[in] pp A pp object
1128 * @param[in] info The geometry information
1129 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1130 * @see pp_commit() function of #tdm_func_pp
1132 * A backend module would apply the geometry information when committed.
1134 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1137 * @brief Attach a source buffer and a destination buffer to a pp object
1138 * @param[in] pp A pp object
1139 * @param[in] src A source buffer
1140 * @param[in] dst A destination buffer
1141 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1142 * @see pp_set_info() function of #tdm_func_pp
1143 * @see pp_commit() function of #tdm_func_pp
1144 * @see pp_set_done_handler, tdm_pp_done_handler
1146 * A backend module converts the image of a source buffer to a destination
1147 * buffer when committed. The size/crop/transform information is set via
1148 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1149 * return the source/destination buffer via tdm_pp_done_handler.
1151 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1154 * @brief Commit changes for a pp object
1155 * @param[in] pp A pp object
1156 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1158 tdm_error (*pp_commit)(tdm_pp *pp);
1161 * @brief Set a user done handler to a pp object
1162 * @param[in] pp A pp object
1163 * @param[in] func A user done handler
1164 * @param[in] user_data user data
1165 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1167 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1169 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1172 void (*reserved1)(void);
1173 void (*reserved2)(void);
1174 void (*reserved3)(void);
1175 void (*reserved4)(void);
1176 void (*reserved5)(void);
1177 void (*reserved6)(void);
1178 void (*reserved7)(void);
1179 void (*reserved8)(void);
1183 * @brief The capture functions for a backend module.
1185 typedef struct _tdm_func_capture {
1187 * @brief Destroy a capture object
1188 * @param[in] capture A capture object
1189 * @see output_create_capture() function of #tdm_func_output
1190 * @see layer_create_capture() function of #tdm_func_layer
1192 void (*capture_destroy)(tdm_capture *capture);
1195 * @brief Set the geometry information to a capture object
1196 * @param[in] capture A capture object
1197 * @param[in] info The geometry information
1198 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1199 * @see capture_commit() function of #tdm_func_capture
1201 * A backend module would apply the geometry information when committed.
1203 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1206 * @brief Attach a TDM buffer to a capture object
1207 * @details When capture_commit() function is called, a backend module starts
1208 * to dump a output or a layer to a TDM buffer.
1209 * @param[in] capture A capture object
1210 * @param[in] buffer A TDM buffer
1211 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1212 * @see capture_set_info() function of #tdm_func_capture
1213 * @see capture_commit() function of #tdm_func_capture
1214 * @see capture_set_done_handler, tdm_capture_done_handler
1216 * A backend module starts to dump a output or a layer to to a TDM buffer when
1217 * committed. The size/crop/transform information is set via #capture_set_info()
1218 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1219 * buffer via tdm_capture_done_handler.
1221 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1224 * @brief Commit changes for a capture object
1225 * @param[in] capture A capture object
1226 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1228 tdm_error (*capture_commit)(tdm_capture *capture);
1231 * @brief Set a user done handler to a capture object
1232 * @param[in] capture A capture object
1233 * @param[in] func A user done handler
1234 * @param[in] user_data user data
1235 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1237 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1239 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1240 tdm_capture_done_handler func, void *user_data);
1242 void (*reserved1)(void);
1243 void (*reserved2)(void);
1244 void (*reserved3)(void);
1245 void (*reserved4)(void);
1246 void (*reserved5)(void);
1247 void (*reserved6)(void);
1248 void (*reserved7)(void);
1249 void (*reserved8)(void);
1253 * @brief The tdm event source
1255 typedef void tdm_event_loop_source;
1258 * @brief The fd source handler
1260 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1263 * @brief The timer source handler
1265 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1267 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1268 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1269 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1270 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1274 * The ABI version of TDM backend module. It has a major and minor revision.
1275 * Modules using lower minor revisions will work with TDM frontend of a higher
1276 * minor revision. There is no compatibility between different major revisions.
1277 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1280 * tdm_backend_module tdm_backend_module_data = {
1283 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1289 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1290 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1291 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1294 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1295 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1296 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */
1300 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1302 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1304 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1307 * @brief The backend module information of the entry point to initialize a TDM
1310 * A backend module @b SHOULD define the global data symbol of which name is
1311 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1312 * at the initial time and call init() function of #tdm_backend_module.
1314 typedef struct _tdm_backend_module {
1315 const char *name; /**< The module name of a backend module */
1316 const char *vendor; /**< The vendor name of a backend module */
1317 unsigned long abi_version; /**< The ABI version of a backend module */
1320 * @brief The init function of a backend module
1321 * @param[in] dpy A display object
1322 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1323 * @return The backend module data
1324 * @see tdm_backend_data
1326 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1329 * @brief The deinit function of a backend module
1330 * @param[in] bdata The backend module data
1332 void (*deinit)(tdm_backend_data *bdata);
1333 } tdm_backend_module;
1336 * @brief Register the backend display functions to a display
1337 * @param[in] dpy A display object
1338 * @param[in] func_display display functions
1339 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1340 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1342 * A backend module @b SHOULD set the backend display functions at least.
1345 tdm_backend_register_func_display(tdm_display *dpy,
1346 tdm_func_display *func_display);
1349 * @brief Register the backend output functions to a display
1350 * @param[in] dpy A display object
1351 * @param[in] func_output output functions
1352 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1353 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1355 * A backend module @b SHOULD set the backend output functions at least.
1358 tdm_backend_register_func_output(tdm_display *dpy,
1359 tdm_func_output *func_output);
1362 * @brief Register the backend voutput functions to a display
1363 * @param[in] dpy A display object
1364 * @param[in] func_voutput voutput functions
1365 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1366 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1368 * A backend module doesn't need to implement this function if doesn't support virtual output.
1371 tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
1374 * @brief Register the backend layer functions to a display
1375 * @param[in] dpy A display object
1376 * @param[in] func_layer layer functions
1377 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1378 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1380 * A backend module @b SHOULD set the backend layer functions at least.
1383 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1386 * @brief Register the backend hwc functions to a display
1387 * @param[in] dpy A display object
1388 * @param[in] func_hwc hwc functions
1389 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1390 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1392 * A backend module @b SHOULD set the backend hwc functions at least.
1396 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1399 * @brief Register the backend hwc_window functions to a display
1400 * @param[in] dpy A display object
1401 * @param[in] func_hwc_window hwc_window functions
1402 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1403 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1405 * A backend module @b SHOULD set the backend hwc_window functions at least.
1409 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1412 * @brief Register the backend pp functions to a display
1413 * @param[in] dpy A display object
1414 * @param[in] func_pp pp functions
1415 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1416 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1418 * A backend module doesn'tcan skip to register the backend pp functions
1419 * if a hardware doesn't have the memory-to-memory converting device.
1422 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1425 * @brief Register the backend capture functions to a display
1426 * @param[in] dpy A display object
1427 * @param[in] func_capture capture functions
1428 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1429 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1431 * A backend module can skip to register the backend capture functions
1432 * if a hardware doesn't have the capture device.
1435 tdm_backend_register_func_capture(tdm_display *dpy,
1436 tdm_func_capture *func_capture);
1439 * @brief Register the backend output to a display
1440 * @param[in] dpy A display object
1441 * @param[in] output A backend output object
1442 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1443 * @see tdm_backend_unregister_output
1446 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1449 * @brief Unregister the backend output to a display
1450 * @param[in] dpy A display object
1451 * @param[in] output A backend output object
1452 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1453 * @see tdm_backend_register_output
1456 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1459 * @brief Increase the ref_count of a TDM buffer
1461 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1462 * becomes available for a next job. A TDM buffer can be used for TDM to show
1463 * it on screen or to capture an output and a layer. After all operations,
1464 * TDM will release it immediately when TDM doesn't need it any more.
1465 * @param[in] buffer A TDM buffer
1466 * @return A buffer itself. Otherwise, NULL.
1467 * @see tdm_buffer_unref_backend
1469 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1470 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1471 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1474 tdm_buffer_ref_backend(tbm_surface_h buffer);
1477 * @brief Decrease the ref_count of a TDM buffer
1478 * @param[in] buffer A TDM buffer
1479 * @see tdm_buffer_ref_backend
1482 tdm_buffer_unref_backend(tbm_surface_h buffer);
1485 * @brief The destroy handler of a TDM buffer
1486 * @param[in] buffer A TDM buffer
1487 * @param[in] user_data user data
1488 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1490 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1494 * @brief Add a destroy handler to a TDM buffer
1495 * @param[in] buffer A TDM buffer
1496 * @param[in] func A destroy handler
1497 * @param[in] user_data user data
1498 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1499 * @see tdm_buffer_remove_destroy_handler
1501 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1502 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1506 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1507 tdm_buffer_destroy_handler func, void *user_data);
1510 * @brief Remove a destroy handler from a TDM buffer
1511 * @param[in] buffer A TDM buffer
1512 * @param[in] func A destroy handler
1513 * @param[in] user_data user data
1514 * @see tdm_buffer_add_destroy_handler
1517 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1518 tdm_buffer_destroy_handler func, void *user_data);
1521 * @brief Add a FD handler for activity on the given file descriptor
1522 * @param[in] dpy A display object
1523 * @param[in] fd A file descriptor
1524 * @param[in] mask to monitor FD
1525 * @param[in] func A FD handler function
1526 * @param[in] user_data user data
1527 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1528 * @return A FD event source
1529 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1531 tdm_event_loop_source*
1532 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1533 tdm_event_loop_fd_handler func, void *user_data,
1537 * @brief Update the mask of the given FD event source
1538 * @param[in] source The given FD event source
1539 * @param[in] mask to monitor FD
1540 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1543 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1546 * @brief Add a timer handler
1547 * @param[in] dpy A display object
1548 * @param[in] func A timer handler function
1549 * @param[in] user_data user data
1550 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1551 * @return A timer event source
1552 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1554 tdm_event_loop_source*
1555 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1556 void *user_data, tdm_error *error);
1559 * @brief Update the millisecond delay time of the given timer event source.
1560 * @param[in] source The given timer event source
1561 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1562 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1565 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1568 * @brief Remove the given event source
1569 * @param[in] source The given event source
1570 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1573 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1576 * @brief Get the ini value with given key
1578 * @param[in] key The given key
1579 * @param[in] default_value The default value
1580 * @return the value of given key if success. Otherwise, default_value.
1581 * @see #tdm_config_get_string
1584 tdm_config_get_int(const char *key, int default_value);
1587 * @brief Get the ini value with given key
1589 * @param[in] key The given key
1590 * @param[in] default_value The default value
1591 * @return the value of given key if success. Otherwise, default_value.
1592 * @see #tdm_config_get_int
1595 tdm_config_get_string(const char *key, const char *default_value);
1601 #endif /* _TDM_BACKEND_H_ */