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 */
175 int preferred_align_vertical; /**< The prefered align vertical */
177 /**< The attach count which a PP object can handle. @since 1.2.0 */
178 int max_attach_count;
182 * @brief The capabilities structure of a capture object
183 * @see The display_get_capture_capability() function of #tdm_func_display
185 typedef struct _tdm_caps_capture {
186 tdm_capture_capability capabilities; /**< The capabilities of capture */
188 unsigned int format_count; /**< The count of available formats */
190 *formats; /**< The @b newly-allocated array of formats. will be freed in frontend. */
192 int min_w; /**< The minimun width */
193 int min_h; /**< The minimun height */
194 int max_w; /**< The maximum width */
195 int max_h; /**< The maximum height */
196 int preferred_align; /**< The prefered align */
198 /**< The attach count which a capture object can handle. @since 1.2.0 */
199 int max_attach_count;
203 * @brief The display functions for a backend module.
205 typedef struct _tdm_func_display {
207 * @brief Get the display capabilities of a backend module
208 * @param[in] bdata The backend module data
209 * @param[out] caps The display capabilities of a backend module
210 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
212 * A backend module @b SHOULD implement this function. TDM calls this function
213 * not only at the initial time, but also at the update time when new output
215 * If a hardware has the restriction of the number of max usable layer count,
216 * a backend module can set the max count to max_layer_count of #tdm_caps_display
219 tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
222 * @brief Get the pp capabilities of a backend module
223 * @param[in] bdata The backend module data
224 * @param[out] caps The pp capabilities of a backend module
225 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
226 * @see tdm_backend_register_func_pp
228 * TDM calls this function not only at the initial time, but also at the update
229 * time when new output is connected.\n
230 * A backend module doesn't need to implement this function if a hardware
231 * doesn't have the memory-to-memory converting device. Otherwise, a backend module
232 * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
233 * restriction information which a converting device can handle. ie, format, size, etc.
235 tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
238 * @brief Get the capture capabilities of a backend module
239 * @param[in] bdata The backend module data
240 * @param[out] caps The capture capabilities of a backend module
241 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
242 * @see tdm_backend_register_func_capture
244 * TDM calls this function not only at the initial time, but also at the update
245 * time when new output is connected.\n
246 * A backend module doesn't need to implement this function if a hardware
247 * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
248 * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
249 * information which a capture device can handle. ie, format, size, etc.
251 tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
254 * @brief Get a output array of a backend module
255 * @param[in] bdata The backend module data
256 * @param[out] count The count of outputs
257 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
258 * @return A output array which is @b newly-allocated
259 * @see tdm_backend_register_func_capture
261 * A backend module @b SHOULD implement this function. TDM calls this function
262 * not only at the initial time, but also at the update time when new output
264 * A backend module @b SHOULD return the @b newly-allocated array which contains
265 * "tdm_output*" data. It will be freed in frontend.
269 * drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
271 * tdm_drm_data *drm_data = bdata;
272 * tdm_drm_output_data *output_data = NULL;
273 * tdm_output **outputs;
277 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
282 * if (error) *error = TDM_ERROR_NONE;
286 * // will be freed in frontend
287 * outputs = calloc(*count, sizeof(tdm_drm_output_data*));
291 * if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
296 * LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
297 * outputs[i++] = output_data;
299 * if (error) *error = TDM_ERROR_NONE;
305 tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
309 * @brief Get the file descriptor of a backend module
310 * @param[in] bdata The backend module data
311 * @param[out] fd The fd of a backend module
312 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
313 * @see display_handle_events() function of #tdm_func_display
315 * A backend module can return epoll's fd which is watching the backend device one more fds.
317 tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
320 * @brief Handle the events which happens on the fd of a backend module
321 * @param[in] bdata The backend module data
322 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
324 tdm_error (*display_handle_events)(tdm_backend_data *bdata);
327 * @brief Create a pp object of a backend module
328 * @param[in] bdata The backend module data
329 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
330 * @return A pp object
331 * @see pp_destroy() function of #tdm_func_pp
333 * A backend module doesn't need to implement this function if a hardware
334 * doesn't have the memory-to-memory converting device.
336 tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
339 * @brief Create a virtual output object of a backend module
340 * @param[in] bdata The backend module data
341 * @param[in] name The output name
342 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
343 * @return A tdm_voutput object
344 * @see voutput_destroy() function
346 * A backend module doesn't need to implement this function if doesn't support virtual output.
348 tdm_voutput *(*display_voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
350 void (*reserved2)(void);
351 void (*reserved3)(void);
352 void (*reserved4)(void);
353 void (*reserved5)(void);
354 void (*reserved6)(void);
355 void (*reserved7)(void);
356 void (*reserved8)(void);
360 * @brief The output functions for a backend module.
362 typedef struct _tdm_func_output {
364 * @brief Get the capabilities of a output object
365 * @param[in] output A output object
366 * @param[out] caps The capabilities of a output object
367 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
369 * A backend module @b SHOULD implement this function. TDM calls this function
370 * not only at the initial time, but also at the update time when new output
372 * #tdm_caps_output contains connection status, modes, avaiable properties,
373 * size restriction information, etc.
375 tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
378 * @brief Get a layer array of a output object
379 * @param[in] output A output object
380 * @param[out] count The count of layers
381 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
382 * @return A layer array which is @b newly-allocated
384 * A backend module @b SHOULD implement this function. TDM calls this function
385 * not only at the initial time, but also at the update time when new output
387 * A backend module @b SHOULD return the @b newly-allocated array which contains
388 * "tdm_layer*" data. It will be freed in frontend.
390 tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
394 * @brief Set the property which has a given id
395 * @param[in] output A output object
396 * @param[in] id The property id
397 * @param[in] value The value
398 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
400 tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
404 * @brief Get the property which has a given id
405 * @param[in] output A output object
406 * @param[in] id The property id
407 * @param[out] value The value
408 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
410 tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
414 * @brief Wait for VBLANK
415 * @param[in] output A output object
416 * @param[in] interval vblank interval
417 * @param[in] sync 0: asynchronous, 1:synchronous
418 * @param[in] user_data The user data
419 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
420 * @see output_set_vblank_handler, tdm_output_vblank_handler
422 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
423 * a user vblank handler with the user data of this function after interval
426 tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
430 * @brief Set a user vblank handler
431 * @param[in] output A output object
432 * @param[in] func A user vblank handler
433 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
435 tdm_error (*output_set_vblank_handler)(tdm_output *output,
436 tdm_output_vblank_handler func);
439 * @brief Commit changes for a output object
440 * @param[in] output A output object
441 * @param[in] sync 0: asynchronous, 1:synchronous
442 * @param[in] user_data The user data
443 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
444 * @see output_set_commit_handler, tdm_output_commit_handler
446 * When this function is called, a backend module @b SHOULD apply the all
447 * changes of the given output object to screen as well as the layer changes
449 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
450 * a user commit handler with the user data of this function after all
451 * changes of the given output object are applied.
453 tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
456 * @brief Set a user commit handler
457 * @param[in] output A output object
458 * @param[in] func A user commit handler
459 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
461 tdm_error (*output_set_commit_handler)(tdm_output *output,
462 tdm_output_commit_handler func);
465 * @brief Set DPMS of a output object synchronously
466 * @param[in] output A output object
467 * @param[in] dpms_value DPMS value
468 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
470 tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
473 * @brief Get DPMS of a output object
474 * @param[in] output A output object
475 * @param[out] dpms_value DPMS value
476 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
478 tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
481 * @brief Set one of available modes of a output object
482 * @param[in] output A output object
483 * @param[in] mode A output mode
484 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
486 tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
489 * @brief Get the mode of a output object
490 * @param[in] output A output object
491 * @param[out] mode A output mode
492 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
494 tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
497 * @brief Create a capture object of a output object
498 * @param[in] output A output object
499 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
500 * @return A capture object
501 * @see capture_destroy() function of #tdm_func_capture
503 * A backend module doesn't need to implement this function if a hardware
504 * doesn't have the capture device.
506 tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
509 * @brief Set a output connection status handler
510 * @details A backend module need to call the output status handler when the
511 * output connection status has been changed to let the TDM frontend know
513 * @param[in] output A output object
514 * @param[in] func A output status handler
515 * @param[in] user_data The user data
516 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
519 tdm_error (*output_set_status_handler)(tdm_output *output,
520 tdm_output_status_handler func,
524 * @brief Set a output dpms handler
525 * @details This function can be NULL if an output doesn't support asynchronous
526 * DPMS control. Otherwise, a backend module needs to call the output dpms handler
527 * to let the TDM frontend know the output DPMS change indeed.
528 * @param[in] output A output object
529 * @param[in] func A output dpms handler
530 * @param[in] user_data The user data
531 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
532 * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
535 tdm_error (*output_set_dpms_handler)(tdm_output *output,
536 tdm_output_dpms_handler func,
540 * @brief Set DPMS of a output object asynchronously
541 * @param[in] output A output object
542 * @details This function can be NULL if an output doesn't support asynchronous
543 * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
544 * flags which #output_get_capability returns. And if a output dpms handler is added with
545 * #output_set_dpms_handler, a backend module needs to call the output dpms handler
546 * to let the TDM frontend know the output DPMS change indeed.
547 * @param[in] dpms_value DPMS value
548 * @param[out] sync A flag for sync call
549 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
550 * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
553 tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value, int *sync);
556 * @brief Get a hwc object of a output object
557 * @param[in] output A output object
558 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
559 * @return A hwc object
561 tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
564 * @brief Set the mirror image of the src_output to the output
565 * @details This function set the mirro image of the src_output to the output.
566 * If there is the hardware or the implementation to display the mirror image
567 * of the src_output to the output, the backend does it in this function.
568 * If the backend output gets the ability of the mirror displaying, it has to
569 * set the TDM_OUTPUT_CAPABILITY_MIRROR on the output capability.
570 * @param[in] output A output object to display the src_output image
571 * @param[in] src_output A src output object of which image is displayed on the output
572 * @param[in] transform A transform value
573 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
574 * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
576 tdm_error (*output_set_mirror)(tdm_output *output,
577 tdm_output *src_output,
578 tdm_transform transform);
580 * @brief Unset the mirror image
581 * @details This function unset the mirro image of the output.
582 * @param[in] output A output object to display the src_output image
583 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
584 * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
586 tdm_error (*output_unset_mirror)(tdm_output *output);
588 void (*reserved4)(void);
589 void (*reserved5)(void);
590 void (*reserved6)(void);
591 void (*reserved7)(void);
592 void (*reserved8)(void);
595 typedef struct _tdm_func_voutput {
597 * @brief Destroy a virtual output object of a backend module
598 * @param[in] voutput The voutput object
599 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
600 * @see display_voutput_create() function
602 * A backend module doesn't need to implement this function if doesn't support virtual output.
604 tdm_error (*voutput_destroy)(tdm_voutput *voutput);
607 * @brief Set available modes of a virtual output object
608 * @param[in] voutput A voutput object
609 * @param[in] modes Modes of voutput
610 * @param[in] count A count of modes
611 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
613 * A backend module doesn't need to implement this function if doesn't support virtual output.
615 tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
618 * @brief Set physical size(mm) of a virtual output object
619 * @param[in] voutput A voutput object
620 * @param[in] mmwidth Width of voutput
621 * @param[in] mmheight Height of voutput
622 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
624 * A backend module doesn't need to implement this function if doesn't support virtual output.
626 tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
629 * @brief Set connect status of a virtual output object
630 * @param[in] voutput A voutput object
631 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
633 * A backend module doesn't need to implement this function if doesn't support virtual output.
635 tdm_error (*voutput_connect)(tdm_voutput *voutput);
638 * @brief Set disconnect status of a virtual output object
639 * @param[in] voutput A voutput object
640 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
642 * A backend module doesn't need to implement this function if doesn't support virtual output.
644 tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
647 * @brief Get output object from virtual output object
648 * @param[in] voutput A voutput object
649 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
650 * @return A tdm_output object
652 * A backend module doesn't need to implement this function if doesn't support virtual output.
654 tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
657 * @brief Set a user commit function
658 * @param[in] voutput A voutput object
659 * @param[in] func A user voutput commit function
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.
663 * If virtual output's output_commit is executed, call this voutput commit func.
665 tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
668 * @brief Notify commit done to backend
669 * @param[in] voutput A voutput object
670 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
672 * A backend module doesn't need to implement this function if doesn't support virtual output.
674 tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
677 * @brief Set target buffer queue flag of a virtual output's hwc object
678 * @param[in] voutput A voutput object
679 * @param[in] flags Flags of target buffer queue
680 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
682 * A backend module doesn't need to implement this function if doesn't support virtual output.
684 tdm_error (*voutput_set_target_buffer_queue_flag)(tdm_voutput *voutput, int flags);
686 void (*reserved2)(void);
687 void (*reserved3)(void);
688 void (*reserved4)(void);
689 void (*reserved5)(void);
690 void (*reserved6)(void);
693 * @brief The layer functions for a backend module.
695 typedef struct _tdm_func_layer {
697 * @brief Get the capabilities of a layer object
698 * @param[in] layer A layer object
699 * @param[out] caps The capabilities of a layer object
700 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
702 * A backend module @b SHOULD implement this function. TDM calls this function
703 * not only at the initial time, but also at the update time when new output
705 * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
707 tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
710 * @brief Set the property which has a given id.
711 * @param[in] layer A layer object
712 * @param[in] id The property id
713 * @param[in] value The value
714 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
716 tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
720 * @brief Get the property which has a given id.
721 * @param[in] layer A layer object
722 * @param[in] id The property id
723 * @param[out] value The value
724 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
726 tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
730 * @brief Set the geometry information to a layer object
731 * @param[in] layer A layer object
732 * @param[in] info The geometry information
733 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
734 * @see output_commit() function of #tdm_func_output
736 * A backend module would apply the geometry information when the output object
737 * of a layer object is committed.
739 tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
742 * @brief Get the geometry information to a layer object
743 * @param[in] layer A layer object
744 * @param[out] info The geometry information
745 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
747 tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
750 * @brief Set a TDM buffer to a layer object
751 * @param[in] layer A layer object
752 * @param[in] buffer A TDM buffer
753 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
754 * @see output_commit() function of #tdm_func_output
756 * A backend module would show a TDM buffer on screen when the output object
757 * of a layer object is committed.
759 tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
762 * @brief Unset a TDM buffer from a layer object
763 * @param[in] layer A layer object
764 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
766 * A backend module @b SHOULD remove the current showing buffer from screen.
768 tdm_error (*layer_unset_buffer)(tdm_layer *layer);
771 * @brief Set the zpos for a VIDEO layer object
772 * @param[in] layer A layer object
773 * @param[in] zpos z-order
774 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
775 * @see tdm_caps_layer, tdm_layer_capability
777 * A backend module doesn't need to implement this function if a backend
778 * module doesn't have VIDEO layers.\n
779 * This function is for VIDEO layers.
780 * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
781 * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
782 * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
783 * is less than GRAPHIC layers or more than GRAPHIC layers.
784 * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
785 * The zpos of VIDEO layers is @b relative. It doesn't need to start
786 * from -1 or 4. Let's suppose that there are two VIDEO layers.
787 * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
788 * than -4 VIDEO layer.
790 tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
793 * @brief Create a capture object of a layer object
794 * @param[in] output A output object
795 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
796 * @return A capture object
797 * @see capture_destroy() function of #tdm_func_capture
799 * A backend module doesn't need to implement this function if a hardware
800 * doesn't have the capture device.
802 tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
805 * @brief Get buffer flags which the layer can support.
806 * @param[in] layer A layer object
807 * @param[out] flags The buffer flags which should be the tbm_bo flags
808 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
810 tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
812 void (*reserved1)(void);
813 void (*reserved2)(void);
814 void (*reserved3)(void);
815 void (*reserved4)(void);
816 void (*reserved5)(void);
817 void (*reserved6)(void);
818 void (*reserved7)(void);
821 typedef struct _tdm_func_hwc {
823 * @brief Create a new window on the given hwc.
824 * @param[in] hwc A hwc object
825 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
826 * @return A created window object
829 tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
832 * @brief Get video the supported format array for the hwc windows of a hwc object.
833 * @param[in] hwc A hwc object
834 * @param[out] formats The available format array
835 * @param[out] count The count of formats
836 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
838 tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
841 * @brief Get the available video property array of a hwc object.
842 * @param[in] hwc A hwc object
843 * @param[out] props The available video property array
844 * @param[out] count The count of video properties
845 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
847 tdm_error (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
851 * @brief Get the hwc capabilities
852 * @param[in] hwc A hwc object
853 * @param[out] capabilities A hwc hwc capability
854 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
856 tdm_error (*hwc_get_capabilities)(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
859 * @brief Get the available property array of a hwc object.
860 * @param[in] hwc A hwc object
861 * @param[out] props The available property array
862 * @param[out] count The count of properties
863 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
865 tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
869 * @brief Get a target buffer queue
870 * @param[in] hwc A hwc object
871 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
872 * @return A buffer queue
875 tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
879 * @brief Set the client(relative to the TDM) target buffer
880 * @details This function lets the backend know the target buffer.
881 * The target buffer contains the result of the gl composition with the
882 * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
883 * @param[in] hwc A hwc object
884 * @param[in] target_buffer The new target buffer
885 * @param[in] damage The buffer damage region
886 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
889 tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
890 tbm_surface_h target_buffer,
894 * @brief Set the acquire fence of client(relative to the TDM) target buffer
895 * @param[in] hwc A output hwc
896 * @param[in] acquire_fence The acquire fence fd of target
897 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
900 tdm_error (*hwc_set_client_target_acquire_fence)(tdm_hwc *hwc,
905 * @brief Validate the hwc
906 * @details Instructs the backend to inspect all of the hw layer state and
907 * determine if there are any composition type changes necessary before
908 * presenting the hwc.
909 * @param[in] hwc A hwc object
910 * @param[in] composited_wnds the hwc window list which is visible.
911 * @param[in] num_wnds the number of the visible windows in the composited_wnds
912 * @param[out] num_types The number of composition type changes
913 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
915 * The backend has to return the num_types when the assgined comopsite types of
916 * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
917 * 0, the cleint must get the changed composite types of the tdm_hwc_windows
918 * and change the comopsite types
921 tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
922 uint32_t num_wnds, uint32_t *num_types);
925 * @brief Get changed composition types
926 * @details Retrieves the windows for which the backend requires a different
927 * composition types that had been set prior to the last call to tdm_hwc_validate().
928 * The client will either update its state with these types and call
929 * tdm_hwc_accept_validation, or will set new types and attempt to validate the
930 * display again. The number of elements returned must be the same as the
931 * value returned in num_types from the last call to tdm_hwc_validate().
932 * @param[in] hwc A hwc object
933 * @param[out] num_elements the number of hwc_windows
934 * @param[out] windows An array of windows
935 * @param[out] composition_types An array of composition types, each corresponding
936 * to an element of windows
937 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
940 tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
941 tdm_hwc_window **hwc_window,
942 tdm_hwc_window_composition *composition_types);
944 * @brief Accepts the validation required by the backend
945 * @details Accepts the validation required by the backend from the previous
946 * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
947 * @param[in] hwc A hwc object
948 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
951 tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
954 * @brief Commit changes for a hwc object
955 * @param[in] hwc A hwc object
956 * @param[in] sync 0: asynchronous, 1:synchronous
957 * @param[in] user_data The user data
958 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
959 * @see hwc_set_commit_handler, tdm_hwc_commit_handler
961 * When this function is called, a backend module @b SHOULD apply the all
962 * changes of the given hwc object to screen as well as the layer changes
964 * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
965 * a user commit handler with the user data of this function after all
966 * changes of the given hwc object are applied.
968 tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
971 * @brief Set a user commit handler
972 * @param[in] hwc A hwc object
973 * @param[in] func A user commit handler
974 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
976 tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
979 * @brief Get commit fence
980 * @details After all change of a window object are applied about last tdm_hwc_commit,
981 * the fence is signaled.
982 * @param[in] hwc A hwc object
983 * @param[out] commit_fence the commit fence fd of tdm_hwc_commit
984 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
986 tdm_error (*hwc_get_commit_fence)(tdm_hwc *hwc, int *commit_fence);
989 * @brief Set the property which has a given id on the hwc object.
990 * @param[in] hwc A hwc object
991 * @param[in] id The property id
992 * @param[in] value The value of the propery id
993 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
995 tdm_error (*hwc_set_property)(tdm_hwc *hwc, uint32_t id, tdm_value value);
998 * @brief Get the property which has a given id on the hwc object.
999 * @param[in] hwc A hwc object
1000 * @param[in] id The property id
1001 * @param[in] value The value of the propery id
1002 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1004 tdm_error (*hwc_get_property)(tdm_hwc *hwc, uint32_t id, tdm_value *value);
1008 * @brief The window functions for a backend module.
1011 typedef struct _tdm_func_hwc_window {
1013 * @brief Destroys the given window.
1014 * @param[in] window the pointer of the window to destroy
1017 void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
1020 * @brief Acquire a buffer queue for the window object
1021 * @details These buffers are used to composite by hardware a client content in
1023 * @param[in] hwc_window A window object
1024 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1025 * @return A buffer queue
1027 tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
1031 * @brief Release a buffer queue for the window object
1032 * @details Release buffer queue when the client no longer uses buferrs of queue.
1033 * @param[in] hwc_window A window object
1034 * @param[in] A tbm buffer queue
1036 void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
1037 tbm_surface_queue_h queue);
1040 * @brief Sets the desired composition type of the given window.
1041 * @details During hwc_validate(), the backend may request changes to
1042 * the composition types of any of the layers as described in the definition
1043 * of tdm_hwc_window_composition_t above.
1044 * @param[in] hwc_window A window object
1045 * @param[in] composition_type The new composition type
1046 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1048 tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
1049 tdm_hwc_window_composition composition_type);
1052 * @brief Set the buffer damage
1053 * @details Provides the region of the source buffer which has been modified
1054 * since the last frame. This region does not need to be validated before
1055 * calling hwc_commit().
1056 * Once set through this function, the damage region remains the same until a
1057 * subsequent call to this function.
1058 * If damage.num_rects > 0, then it may be assumed that any portion of the source
1059 * buffer not covered by one of the rects has not been modified this frame. If
1060 * damage.num_rects == 0, then the whole source buffer must be treated as if it
1061 * has been modified.
1062 * If the layer's contents are not modified relative to the prior frame, damage
1063 * will contain exactly one empty rect([0, 0, 0, 0]).
1064 * The damage rects are relative to the pre-transformed buffer, and their origin
1065 * is the top-left corner. They will not exceed the dimensions of the latched
1067 * @param[in] hwc_window A window object
1068 * @param[in] damage The new buffer damage region
1069 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1071 tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
1075 * @brief Set the information to a window object
1076 * @details The information will be applied when the hwc object is committed.
1077 * @param[in] hwc_window A window object
1078 * @param[in] info The geometry information
1079 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1081 tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
1082 tdm_hwc_window_info *info);
1085 * @brief Set a TDM buffer to a window object
1086 * @details A TDM buffer will be applied when the hwc object
1087 * of a layer object is committed.
1088 * @param[in] hwc_window A window object
1089 * @param[in] buffer A TBM buffer
1090 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1092 tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
1093 tbm_surface_h buffer);
1096 * @brief Set the property which has a given id.
1097 * @param[in] hwc_window A hwc window object
1098 * @param[in] id The property id
1099 * @param[in] value The value of the propery id
1100 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1102 tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
1103 uint32_t id, tdm_value value);
1106 * @brief Get the property which has a given id.
1107 * @param[in] hwc_window A hwc window object
1108 * @param[in] id The property id
1109 * @param[out] value The value of the propery id
1110 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1112 tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
1113 uint32_t id, tdm_value *value);
1116 * @brief Get the constraints of hwc_window
1117 * @param[in] hwc_window A hwc window object
1118 * @param[out] constraints The tdm_hwc_window_constraint types
1119 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1121 tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
1125 * @brief Set the name of hwc_window
1126 * @param[in] hwc_window A hwc window object
1127 * @param[in] name of the hwc_window
1128 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1130 tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window,
1134 * @brief Get buffer flags of cursor hwc_window
1135 * @param[in] hwc_window A hwc window object
1136 * @param[in] width of the cursor image
1137 * @param[in] height of the cursor image
1138 * @param[in] stride of the cursor image
1139 * @param[in] virtual address of the cursor image
1140 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1142 tdm_error (*hwc_window_set_cursor_image)(tdm_hwc_window *hwc_window,
1143 int width, int height, int stride, void *ptr);
1146 * @brief Set the acquire fence of hwc_window
1147 * @param[in] hwc_window A hwc window object
1148 * @param[in] acquire_fence the acquire fence fd of a hwc window object
1149 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1151 tdm_error (*hwc_window_set_acquire_fence)(tdm_hwc_window *hwc_window,
1153 } tdm_func_hwc_window;
1156 * @brief The pp functions for a backend module.
1158 typedef struct _tdm_func_pp {
1160 * @brief Destroy a pp object
1161 * @param[in] pp A pp object
1162 * @see display_create_pp() function of #tdm_func_display
1164 void (*pp_destroy)(tdm_pp *pp);
1167 * @brief Set the geometry information to a pp object
1168 * @param[in] pp A pp object
1169 * @param[in] info The geometry information
1170 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1171 * @see pp_commit() function of #tdm_func_pp
1173 * A backend module would apply the geometry information when committed.
1175 tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1178 * @brief Attach a source buffer and a destination buffer to a pp object
1179 * @param[in] pp A pp object
1180 * @param[in] src A source buffer
1181 * @param[in] dst A destination buffer
1182 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1183 * @see pp_set_info() function of #tdm_func_pp
1184 * @see pp_commit() function of #tdm_func_pp
1185 * @see pp_set_done_handler, tdm_pp_done_handler
1187 * A backend module converts the image of a source buffer to a destination
1188 * buffer when committed. The size/crop/transform information is set via
1189 * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1190 * return the source/destination buffer via tdm_pp_done_handler.
1192 tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1195 * @brief Commit changes for a pp object
1196 * @param[in] pp A pp object
1197 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1199 tdm_error (*pp_commit)(tdm_pp *pp);
1202 * @brief Set a user done handler to a pp object
1203 * @param[in] pp A pp object
1204 * @param[in] func A user done handler
1205 * @param[in] user_data user data
1206 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1208 * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1210 tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1213 void (*reserved1)(void);
1214 void (*reserved2)(void);
1215 void (*reserved3)(void);
1216 void (*reserved4)(void);
1217 void (*reserved5)(void);
1218 void (*reserved6)(void);
1219 void (*reserved7)(void);
1220 void (*reserved8)(void);
1224 * @brief The capture functions for a backend module.
1226 typedef struct _tdm_func_capture {
1228 * @brief Destroy a capture object
1229 * @param[in] capture A capture object
1230 * @see output_create_capture() function of #tdm_func_output
1231 * @see layer_create_capture() function of #tdm_func_layer
1233 void (*capture_destroy)(tdm_capture *capture);
1236 * @brief Set the geometry information to a capture object
1237 * @param[in] capture A capture object
1238 * @param[in] info The geometry information
1239 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1240 * @see capture_commit() function of #tdm_func_capture
1242 * A backend module would apply the geometry information when committed.
1244 tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1247 * @brief Attach a TDM buffer to a capture object
1248 * @details When capture_commit() function is called, a backend module starts
1249 * to dump a output or a layer to a TDM buffer.
1250 * @param[in] capture A capture object
1251 * @param[in] buffer A TDM buffer
1252 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1253 * @see capture_set_info() function of #tdm_func_capture
1254 * @see capture_commit() function of #tdm_func_capture
1255 * @see capture_set_done_handler, tdm_capture_done_handler
1257 * A backend module starts to dump a output or a layer to to a TDM buffer when
1258 * committed. The size/crop/transform information is set via #capture_set_info()
1259 * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1260 * buffer via tdm_capture_done_handler.
1262 tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1265 * @brief Commit changes for a capture object
1266 * @param[in] capture A capture object
1267 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1269 tdm_error (*capture_commit)(tdm_capture *capture);
1272 * @brief Set a user done handler to a capture object
1273 * @param[in] capture A capture object
1274 * @param[in] func A user done handler
1275 * @param[in] user_data user data
1276 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1278 * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1280 tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1281 tdm_capture_done_handler func, void *user_data);
1283 void (*reserved1)(void);
1284 void (*reserved2)(void);
1285 void (*reserved3)(void);
1286 void (*reserved4)(void);
1287 void (*reserved5)(void);
1288 void (*reserved6)(void);
1289 void (*reserved7)(void);
1290 void (*reserved8)(void);
1294 * @brief The tdm event source
1296 typedef void tdm_event_loop_source;
1299 * @brief The fd source handler
1301 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1304 * @brief The timer source handler
1306 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1308 #define TDM_BACKEND_MINOR_VERSION_MASK 0x0000FFFF
1309 #define TDM_BACKEND_MAJOR_VERSION_MASK 0xFFFF0000
1310 #define TDM_BACKEND_GET_ABI_MINOR(v) ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1311 #define TDM_BACKEND_GET_ABI_MAJOR(v) (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1315 * The ABI version of TDM backend module. It has a major and minor revision.
1316 * Modules using lower minor revisions will work with TDM frontend of a higher
1317 * minor revision. There is no compatibility between different major revisions.
1318 * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1321 * tdm_backend_module tdm_backend_module_data = {
1324 * TDM_BACKEND_SET_ABI_VERSION(1,1),
1330 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1331 (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1332 ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1335 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1336 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1337 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi */
1341 * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1343 * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1345 #define TDM_BACKEND_ABI_VERSION TDM_BACKEND_SET_ABI_VERSION(1, 1)
1348 * @brief The backend module information of the entry point to initialize a TDM
1351 * A backend module @b SHOULD define the global data symbol of which name is
1352 * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1353 * at the initial time and call init() function of #tdm_backend_module.
1355 typedef struct _tdm_backend_module {
1356 const char *name; /**< The module name of a backend module */
1357 const char *vendor; /**< The vendor name of a backend module */
1358 unsigned long abi_version; /**< The ABI version of a backend module */
1361 * @brief The init function of a backend module
1362 * @param[in] dpy A display object
1363 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1364 * @return The backend module data
1365 * @see tdm_backend_data
1367 tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1370 * @brief The deinit function of a backend module
1371 * @param[in] bdata The backend module data
1373 void (*deinit)(tdm_backend_data *bdata);
1374 } tdm_backend_module;
1377 * @brief Register the backend display functions to a display
1378 * @param[in] dpy A display object
1379 * @param[in] func_display display functions
1380 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1381 * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1383 * A backend module @b SHOULD set the backend display functions at least.
1386 tdm_backend_register_func_display(tdm_display *dpy,
1387 tdm_func_display *func_display);
1390 * @brief Register the backend output functions to a display
1391 * @param[in] dpy A display object
1392 * @param[in] func_output output functions
1393 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1394 * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1396 * A backend module @b SHOULD set the backend output functions at least.
1399 tdm_backend_register_func_output(tdm_display *dpy,
1400 tdm_func_output *func_output);
1403 * @brief Register the backend voutput functions to a display
1404 * @param[in] dpy A display object
1405 * @param[in] func_voutput voutput functions
1406 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1407 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1409 * A backend module doesn't need to implement this function if doesn't support virtual output.
1412 tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
1415 * @brief Register the backend layer functions to a display
1416 * @param[in] dpy A display object
1417 * @param[in] func_layer layer functions
1418 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1419 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1421 * A backend module @b SHOULD set the backend layer functions at least.
1424 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1427 * @brief Register the backend hwc functions to a display
1428 * @param[in] dpy A display object
1429 * @param[in] func_hwc hwc functions
1430 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1431 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1433 * A backend module @b SHOULD set the backend hwc functions at least.
1437 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1440 * @brief Register the backend hwc_window functions to a display
1441 * @param[in] dpy A display object
1442 * @param[in] func_hwc_window hwc_window functions
1443 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1444 * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1446 * A backend module @b SHOULD set the backend hwc_window functions at least.
1450 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1453 * @brief Register the backend pp functions to a display
1454 * @param[in] dpy A display object
1455 * @param[in] func_pp pp functions
1456 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1457 * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1459 * A backend module doesn'tcan skip to register the backend pp functions
1460 * if a hardware doesn't have the memory-to-memory converting device.
1463 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1466 * @brief Register the backend capture functions to a display
1467 * @param[in] dpy A display object
1468 * @param[in] func_capture capture functions
1469 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1470 * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1472 * A backend module can skip to register the backend capture functions
1473 * if a hardware doesn't have the capture device.
1476 tdm_backend_register_func_capture(tdm_display *dpy,
1477 tdm_func_capture *func_capture);
1480 * @brief Register the backend output to a display
1481 * @param[in] dpy A display object
1482 * @param[in] output A backend output object
1483 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1484 * @see tdm_backend_unregister_output
1487 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1490 * @brief Unregister the backend output to a display
1491 * @param[in] dpy A display object
1492 * @param[in] output A backend output object
1493 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1494 * @see tdm_backend_register_output
1497 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1500 * @brief Increase the ref_count of a TDM buffer
1502 * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1503 * becomes available for a next job. A TDM buffer can be used for TDM to show
1504 * it on screen or to capture an output and a layer. After all operations,
1505 * TDM will release it immediately when TDM doesn't need it any more.
1506 * @param[in] buffer A TDM buffer
1507 * @return A buffer itself. Otherwise, NULL.
1508 * @see tdm_buffer_unref_backend
1510 * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1511 * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1512 * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1515 tdm_buffer_ref_backend(tbm_surface_h buffer);
1518 * @brief Decrease the ref_count of a TDM buffer
1519 * @param[in] buffer A TDM buffer
1520 * @see tdm_buffer_ref_backend
1523 tdm_buffer_unref_backend(tbm_surface_h buffer);
1526 * @brief The destroy handler of a TDM buffer
1527 * @param[in] buffer A TDM buffer
1528 * @param[in] user_data user data
1529 * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1531 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1535 * @brief Add a destroy handler to a TDM buffer
1536 * @param[in] buffer A TDM buffer
1537 * @param[in] func A destroy handler
1538 * @param[in] user_data user data
1539 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1540 * @see tdm_buffer_remove_destroy_handler
1542 * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1543 * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1547 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1548 tdm_buffer_destroy_handler func, void *user_data);
1551 * @brief Remove a destroy handler from a TDM buffer
1552 * @param[in] buffer A TDM buffer
1553 * @param[in] func A destroy handler
1554 * @param[in] user_data user data
1555 * @see tdm_buffer_add_destroy_handler
1558 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1559 tdm_buffer_destroy_handler func, void *user_data);
1562 * @brief Add a FD handler for activity on the given file descriptor
1563 * @param[in] dpy A display object
1564 * @param[in] fd A file descriptor
1565 * @param[in] mask to monitor FD
1566 * @param[in] func A FD handler function
1567 * @param[in] user_data user data
1568 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1569 * @return A FD event source
1570 * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1572 tdm_event_loop_source*
1573 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1574 tdm_event_loop_fd_handler func, void *user_data,
1578 * @brief Update the mask of the given FD event source
1579 * @param[in] source The given FD event source
1580 * @param[in] mask to monitor FD
1581 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1584 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1587 * @brief Add a timer handler
1588 * @param[in] dpy A display object
1589 * @param[in] func A timer handler function
1590 * @param[in] user_data user data
1591 * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1592 * @return A timer event source
1593 * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1595 tdm_event_loop_source*
1596 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1597 void *user_data, tdm_error *error);
1600 * @brief Update the millisecond delay time of the given timer event source.
1601 * @param[in] source The given timer event source
1602 * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1603 * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1606 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1609 * @brief Remove the given event source
1610 * @param[in] source The given event source
1611 * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1614 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1617 * @brief Get the ini value with given key
1619 * @param[in] key The given key
1620 * @param[in] default_value The default value
1621 * @return the value of given key if success. Otherwise, default_value.
1622 * @see #tdm_config_get_string
1625 tdm_config_get_int(const char *key, int default_value);
1628 * @brief Get the ini value with given key
1630 * @param[in] key The given key
1631 * @param[in] default_value The default value
1632 * @return the value of given key if success. Otherwise, default_value.
1633 * @see #tdm_config_get_int
1636 tdm_config_get_string(const char *key, const char *default_value);
1642 #endif /* _TDM_BACKEND_H_ */