add TDM_OUTPUT_CAPABILITY_MIRROR
[platform/core/uifw/libtdm.git] / include / tdm_backend.h
1 /**************************************************************************
2  *
3  * libtdm
4  *
5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
6  *
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>
13  *
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:
21  *
22  * The above copyright notice and this permission notice (including the
23  * next paragraph) shall be included in all copies or substantial portions
24  * of the Software.
25  *
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.
33  *
34 **************************************************************************/
35
36 #ifndef _TDM_BACKEND_H_
37 #define _TDM_BACKEND_H_
38
39 #include <tbm_surface.h>
40 #include <tbm_surface_queue.h>
41
42 #include "tdm_types.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 /**
49  * @file tdm_backend.h
50  * @brief The backend header file of TDM to implement a TDM backend module.
51  * @par Example
52  * @code
53  * #include <tdm_backend.h>
54  * @endcode
55  */
56
57 /**
58  * @brief The backend module data
59  * @details
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
63  */
64 typedef void tdm_backend_data;
65
66 /**
67  * @brief The output status handler
68  * @details This handler will be called when the status of a output object is
69  * changed in runtime.
70  */
71 typedef void (*tdm_output_status_handler)(tdm_output *output,
72                                                                                   tdm_output_conn_status status,
73                                                                                   void *user_data);
74
75 /**
76  * @brief The output dpms handler
77  * @details This handler will be called when the dpms of a output object is
78  * changed in runtime.
79  */
80 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
81                                                                                 tdm_output_dpms dpms,
82                                                                                 void *user_data);
83
84 /**
85  * @brief The display capabilities structure of a backend module
86  * @see The display_get_capability() function of #tdm_func_display
87  */
88 typedef struct _tdm_caps_display {
89         int max_layer_count;    /**< The maximum layer count */
90 } tdm_caps_display;
91
92 /**
93  * @brief The capabilities structure of a output object
94  * @see The output_get_capability() function of #tdm_func_output
95  */
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 */
100
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 */
104
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. */
107
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. */
110
111         unsigned int mmWidth;           /**< The physical width (milimeter) */
112         unsigned int mmHeight;          /**< The physical height (milimeter) */
113         unsigned int subpixel;          /**< The subpixel */
114
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 */
120
121         tdm_output_capability capabilities;  /**< The capabilities of output. @since 1.4.1 */
122
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 */
128 } tdm_caps_output;
129
130 /**
131  * @brief The capabilities structure of a layer object
132  * @see The layer_get_capability() function of #tdm_func_layer
133  */
134 typedef struct _tdm_caps_layer {
135         tdm_layer_capability capabilities;  /**< The capabilities of layer */
136
137         /**
138          * The z-order
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.
149         */
150         int zpos;
151
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. */
154
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. */
157 } tdm_caps_layer;
158
159 /**
160  * @brief The capabilities structure of a pp object
161  * @see The display_get_pp_capability() function of #tdm_func_display
162  */
163 typedef struct _tdm_caps_pp {
164         tdm_pp_capability capabilities; /**< The capabilities of pp */
165
166         unsigned int format_count;      /**< The count of available formats */
167         tbm_format
168         *formats;            /**< The @b newly-allocated array. will be freed in frontend. */
169
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
176         /**< The attach count which a PP object can handle. @since 1.2.0 */
177         int max_attach_count;
178 } tdm_caps_pp;
179
180 /**
181  * @brief The capabilities structure of a capture object
182  * @see The display_get_capture_capability() function of #tdm_func_display
183  */
184 typedef struct _tdm_caps_capture {
185         tdm_capture_capability capabilities;    /**< The capabilities of capture */
186
187         unsigned int format_count;      /**< The count of available formats */
188         tbm_format
189         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
190
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 */
196
197         /**< The attach count which a capture object can handle. @since 1.2.0 */
198         int max_attach_count;
199 } tdm_caps_capture;
200
201 /**
202  * @brief The display functions for a backend module.
203  */
204 typedef struct _tdm_func_display {
205         /**
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.
210          * @remark
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
213          * is connected.\n
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
216          * structure.
217          */
218         tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
219
220         /**
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
226          * @remark
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.
233          */
234         tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
235
236         /**
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
242          * @remark
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.
249          */
250         tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
251
252         /**
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
259          * @remark
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
262          * is connected.\n
263          * A backend module @b SHOULD return the @b newly-allocated array which contains
264          * "tdm_output*" data. It will be freed in frontend.
265          * @par Example
266          * @code
267          *  tdm_output**
268          *  drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
269          *  {
270          *      tdm_drm_data *drm_data = bdata;
271          *      tdm_drm_output_data *output_data = NULL;
272          *      tdm_output **outputs;
273          *      int i;
274          *
275          *      (*count) = 0;
276          *      LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
277          *          (*count)++;
278          *
279          *      if ((*count) == 0)
280          *      {
281          *          if (error) *error = TDM_ERROR_NONE;
282          *          return NULL;
283          *      }
284          *
285          *      // will be freed in frontend
286          *      outputs = calloc(*count, sizeof(tdm_drm_output_data*));
287          *      if (!outputs)
288          *      {
289          *          (*count) = 0;
290          *          if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
291          *          return NULL;
292          *      }
293          *
294          *      i = 0;
295          *      LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
296          *          outputs[i++] = output_data;
297          *
298          *      if (error) *error = TDM_ERROR_NONE;
299          *
300          *      return outputs;
301          *  }
302          * @endcode
303          */
304         tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
305                                                                                 tdm_error *error);
306
307         /**
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
313          * @remark
314          * A backend module can return epoll's fd which is watching the backend device one more fds.
315          */
316         tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
317
318         /**
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.
322          */
323         tdm_error (*display_handle_events)(tdm_backend_data *bdata);
324
325         /**
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
331          * @remark
332          * A backend module doesn't need to implement this function if a hardware
333          * doesn't have the memory-to-memory converting device.
334          */
335         tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
336
337         /**
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
344          * @remark
345          * A backend module doesn't need to implement this function if doesn't support virtual output.
346          */
347         tdm_voutput *(*voutput_create)(tdm_backend_data *bdata, const char *name, tdm_error *error);
348
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);
356 } tdm_func_display;
357
358 /**
359  * @brief The output functions for a backend module.
360  */
361 typedef struct _tdm_func_output {
362         /**
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.
367          * @remark
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
370          * is connected.\n
371          * #tdm_caps_output contains connection status, modes, avaiable properties,
372          * size restriction information, etc.
373          */
374         tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
375
376         /**
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
382          * @remark
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
385          * is connected.\n
386          * A backend module @b SHOULD return the @b newly-allocated array which contains
387          * "tdm_layer*" data. It will be freed in frontend.
388          */
389         tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
390                                                                          tdm_error *error);
391
392         /**
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.
398          */
399         tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
400                                                                          tdm_value value);
401
402         /**
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.
408          */
409         tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
410                                                                          tdm_value *value);
411
412         /**
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
420          * @remark
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
423          * vblanks.
424          */
425         tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
426                                                                         void *user_data);
427
428         /**
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.
433          */
434         tdm_error (*output_set_vblank_handler)(tdm_output *output,
435                                                                                    tdm_output_vblank_handler func);
436
437         /**
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
444          * @remark
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
447          * of this output.
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.
451          */
452         tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
453
454         /**
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.
459          */
460         tdm_error (*output_set_commit_handler)(tdm_output *output,
461                                                                                    tdm_output_commit_handler func);
462
463         /**
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.
468          */
469         tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
470
471         /**
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.
476          */
477         tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
478
479         /**
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.
484          */
485         tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
486
487         /**
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.
492          */
493         tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
494
495         /**
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
501          * @remark
502          * A backend module doesn't need to implement this function if a hardware
503          * doesn't have the capture device.
504          */
505         tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
506
507         /**
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
511          * the change.
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.
516          * @since 1.1.0
517          */
518         tdm_error (*output_set_status_handler)(tdm_output *output,
519                                                                                    tdm_output_status_handler func,
520                                                                                    void *user_data);
521
522         /**
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
532          * @since 1.4.0
533          */
534         tdm_error (*output_set_dpms_handler)(tdm_output *output,
535                                                                                  tdm_output_dpms_handler func,
536                                                                                  void *user_data);
537
538         /**
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
549          * @since 1.7.0
550          */
551         tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
552
553         /**
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
558          */
559         tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
560
561         void (*reserved3)(void);
562         void (*reserved4)(void);
563         void (*reserved5)(void);
564         void (*reserved6)(void);
565         void (*reserved7)(void);
566         void (*reserved8)(void);
567 } tdm_func_output;
568
569 typedef struct _tdm_func_voutput {
570         /**
571          * @brief Destroy a virtual output object of a backend module
572          * @param[in] voutput The voutput object
573          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
574          * @see voutput_create() function
575          * @remark
576          * A backend module doesn't need to implement this function if doesn't support virtual output.
577          */
578         tdm_error (*voutput_destroy)(tdm_voutput *voutput);
579
580         /**
581          * @brief Set available modes of a virtual output object
582          * @param[in] voutput A voutput object
583          * @param[in] modes Modes of voutput
584          * @param[in] count A count of modes
585          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
586          * @remark
587          * A backend module doesn't need to implement this function if doesn't support virtual output.
588          */
589         tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
590
591         /**
592          * @brief Set physical size(mm) of a virtual output object
593          * @param[in] voutput A voutput object
594          * @param[in] mmwidth Width of voutput
595          * @param[in] mmheight Height of voutput
596          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
597          * @remark
598          * A backend module doesn't need to implement this function if doesn't support virtual output.
599          */
600         tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
601
602         /**
603          * @brief Set connect status of a virtual output object
604          * @param[in] voutput A voutput object
605          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
606          * @remark
607          * A backend module doesn't need to implement this function if doesn't support virtual output.
608          */
609         tdm_error (*voutput_connect)(tdm_voutput *voutput);
610
611         /**
612          * @brief Set disconnect status of a virtual output object
613          * @param[in] voutput A voutput object
614          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
615          * @remark
616          * A backend module doesn't need to implement this function if doesn't support virtual output.
617          */
618         tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
619
620         /**
621          * @brief Get output object from virtual output object
622          * @param[in] voutput A voutput object
623          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
624          * @return A tdm_output object
625          * @remark
626          * A backend module doesn't need to implement this function if doesn't support virtual output.
627          */
628         tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
629
630         /**
631          * @brief Set a user commit function
632          * @param[in] voutput A voutput object
633          * @param[in] func A user voutput commit function
634          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
635          * @remark
636          * A backend module doesn't need to implement this function if doesn't support virtual output.
637          * If virtual output's output_commit is executed, call this voutput commit func.
638          */
639         tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
640
641         /**
642          * @brief Notify commit done to backend
643          * @param[in] voutput A voutput object
644          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
645          * @remark
646          * A backend module doesn't need to implement this function if doesn't support virtual output.
647          */
648         tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
649
650         void (*reserved1)(void);
651         void (*reserved2)(void);
652         void (*reserved3)(void);
653         void (*reserved4)(void);
654         void (*reserved5)(void);
655         void (*reserved6)(void);
656 } tdm_func_voutput;
657 /**
658  * @brief The layer functions for a backend module.
659  */
660 typedef struct _tdm_func_layer {
661         /**
662          * @brief Get the capabilities of a layer object
663          * @param[in] layer A layer object
664          * @param[out] caps The capabilities of a layer object
665          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
666          * @remark
667          * A backend module @b SHOULD implement this function. TDM calls this function
668          * not only at the initial time, but also at the update time when new output
669          * is connected.\n
670          * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
671          */
672         tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
673
674         /**
675          * @brief Set the property which has a given id.
676          * @param[in] layer A layer object
677          * @param[in] id The property id
678          * @param[in] value The value
679          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
680          */
681         tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
682                                                                         tdm_value value);
683
684         /**
685          * @brief Get the property which has a given id.
686          * @param[in] layer A layer object
687          * @param[in] id The property id
688          * @param[out] value The value
689          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
690          */
691         tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
692                                                                         tdm_value *value);
693
694         /**
695          * @brief Set the geometry information to a layer object
696          * @param[in] layer A layer object
697          * @param[in] info The geometry information
698          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
699          * @see output_commit() function of #tdm_func_output
700          * @remark
701          * A backend module would apply the geometry information when the output object
702          * of a layer object is committed.
703          */
704         tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
705
706         /**
707          * @brief Get the geometry information to a layer object
708          * @param[in] layer A layer object
709          * @param[out] info The geometry information
710          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
711          */
712         tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
713
714         /**
715          * @brief Set a TDM buffer to a layer object
716          * @param[in] layer A layer object
717          * @param[in] buffer A TDM buffer
718          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
719          * @see output_commit() function of #tdm_func_output
720          * @remark
721          * A backend module would show a TDM buffer on screen when the output object
722          * of a layer object is committed.
723          */
724         tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
725
726         /**
727          * @brief Unset a TDM buffer from a layer object
728          * @param[in] layer A layer object
729          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
730          * @remark
731          * A backend module @b SHOULD remove the current showing buffer from screen.
732          */
733         tdm_error (*layer_unset_buffer)(tdm_layer *layer);
734
735         /**
736          * @brief Set the zpos for a VIDEO layer object
737          * @param[in] layer A layer object
738          * @param[in] zpos z-order
739          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
740          * @see tdm_caps_layer, tdm_layer_capability
741          * @remark
742          * A backend module doesn't need to implement this function if a backend
743          * module doesn't have VIDEO layers.\n
744          * This function is for VIDEO layers.
745          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
746          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
747          * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
748          * is less than GRAPHIC layers or more than GRAPHIC layers.
749          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
750          * The zpos of VIDEO layers is @b relative. It doesn't need to start
751          * from -1 or 4. Let's suppose that there are two VIDEO layers.
752          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
753          * than -4 VIDEO layer.
754          */
755         tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
756
757         /**
758          * @brief Create a capture object of a layer object
759          * @param[in] output A output object
760          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
761          * @return A capture object
762          * @see capture_destroy() function of #tdm_func_capture
763          * @remark
764          * A backend module doesn't need to implement this function if a hardware
765          * doesn't have the capture device.
766          */
767         tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
768
769         /**
770          * @brief Get buffer flags which the layer can support.
771          * @param[in] layer A layer object
772          * @param[out] flags The buffer flags which should be the tbm_bo flags
773          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
774          */
775         tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
776
777         void (*reserved1)(void);
778         void (*reserved2)(void);
779         void (*reserved3)(void);
780         void (*reserved4)(void);
781         void (*reserved5)(void);
782         void (*reserved6)(void);
783         void (*reserved7)(void);
784 } tdm_func_layer;
785
786 typedef struct _tdm_func_hwc {
787         /**
788          * @brief Create a new window on the given hwc.
789          * @param[in] hwc A hwc object
790          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
791          * @return A created window object
792          * @since 2.0.0
793          */
794         tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
795
796         /**
797          * @brief Get video the supported format array for the hwc windows of a hwc object.
798          * @param[in] hwc A hwc object
799          * @param[out] formats The available format array
800          * @param[out] count The count of formats
801          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
802          */
803         tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
804                                                                                 int *count);
805         /**
806          * @brief Get the available video property array  of a hwc object.
807          * @param[in] hwc A hwc object
808          * @param[out] props The available video property array
809          * @param[out] count The count of video properties
810          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
811          */
812         tdm_error (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
813                                                                                 int *count);
814
815         /**
816          * @brief Get the hwc capabilities
817          * @param[in] hwc A hwc object
818          * @param[out] capabilities A hwc hwc capability
819          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
820          */
821         tdm_error (*hwc_get_capabilities)(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
822
823         /**
824          * @brief Get the available property array  of a hwc object.
825          * @param[in] hwc A hwc object
826          * @param[out] props The available property array
827          * @param[out] count The count of properties
828          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
829          */
830         tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
831                                                                                 int *count);
832
833         /**
834          * @brief Get a target buffer queue
835          * @param[in] hwc A hwc object
836          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
837          * @return A buffer queue
838          * @since 2.0.0
839          */
840         tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
841                                                                                                                 tdm_error *error);
842
843         /**
844          * @brief Set the client(relative to the TDM) target buffer
845          * @details This function lets the backend know the target buffer.
846          * The target buffer contains the result of the gl composition with the
847          * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
848          * @param[in] hwc A hwc object
849          * @param[in] target_buffer The new target buffer
850          * @param[in] damage The buffer damage region
851          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
852          * @since 2.0.0
853          */
854         tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
855                                                                                           tbm_surface_h target_buffer,
856                                                                                           tdm_region damage);
857
858         /**
859          * @brief Validate the hwc
860          * @details Instructs the backend to inspect all of the hw layer state and
861          * determine if there are any composition type changes necessary before
862          * presenting the hwc.
863          * @param[in] hwc A hwc object
864          * @param[in] composited_wnds the hwc window list which is visible.
865          * @param[in] num_wnds the number of the visible windows in the composited_wnds
866          * @param[out] num_types The number of composition type changes
867          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
868          * @remark
869          * The backend has to return the num_types when the assgined comopsite types of
870          * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
871          * 0, the cleint must get the changed composite types of the tdm_hwc_windows
872          * and change the comopsite types
873          * @since 2.0.0
874          */
875         tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
876                                                           uint32_t num_wnds, uint32_t *num_types);
877
878         /**
879          * @brief Get changed composition types
880          * @details Retrieves the windows for which the backend requires a different
881          * composition types that had been set prior to the last call to tdm_hwc_validate().
882          * The client will either update its state with these types and call
883          * tdm_hwc_accept_validation, or will set new types and attempt to validate the
884          * display again. The number of elements returned must be the same as the
885          * value returned in num_types from the last call to tdm_hwc_validate().
886          * @param[in] hwc A hwc object
887          * @param[out] num_elements the number of hwc_windows
888          * @param[out] windows An array of windows
889          * @param[out] composition_types An array of composition types, each corresponding
890          * to an element of windows
891          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
892          * @since 2.0.0
893          */
894         tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
895                                                                                                    tdm_hwc_window **hwc_window,
896                                                                                                    tdm_hwc_window_composition *composition_types);
897         /**
898          * @brief Accepts the validation required by the backend
899          * @details Accepts the validation required by the backend from the previous
900          * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
901          * @param[in] hwc A hwc object
902          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
903          * @since 2.0.0
904          */
905         tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
906
907         /**
908          * @brief Commit changes for a hwc object
909          * @param[in] hwc A hwc object
910          * @param[in] sync 0: asynchronous, 1:synchronous
911          * @param[in] user_data The user data
912          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
913          * @see hwc_set_commit_handler, tdm_hwc_commit_handler
914          * @remark
915          * When this function is called, a backend module @b SHOULD apply the all
916          * changes of the given hwc object to screen as well as the layer changes
917          * of this hwc.
918          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
919          * a user commit handler with the user data of this function after all
920          * changes of the given hwc object are applied.
921          */
922         tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
923
924         /**
925          * @brief Set a user commit handler
926          * @param[in] hwc A hwc object
927          * @param[in] func A user commit handler
928          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
929          */
930         tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
931
932         /**
933          * @brief Set the property which has a given id on the hwc object.
934          * @param[in] hwc A hwc object
935          * @param[in] id The property id
936          * @param[in] value The value of the propery id
937          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
938          */
939         tdm_error (*hwc_set_property)(tdm_hwc *hwc, uint32_t id, tdm_value value);
940
941         /**
942          * @brief Get the property which has a given id on the hwc object.
943          * @param[in] hwc A hwc object
944          * @param[in] id The property id
945          * @param[in] value The value of the propery id
946          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
947          */
948         tdm_error (*hwc_get_property)(tdm_hwc *hwc, uint32_t id, tdm_value *value);
949 } tdm_func_hwc;
950
951 /**
952  * @brief The window functions for a backend module.
953  * @since 2.0.0
954  */
955 typedef struct _tdm_func_hwc_window {
956         /**
957          * @brief Destroys the given window.
958          * @param[in] window the pointer of the window to destroy
959          * @since 2.0.0
960          */
961         void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
962
963         /**
964          * @brief Acquire a buffer queue for the window object
965          * @details These buffers are used to composite by hardware a client content in
966          * the nocomp mode.
967          * @param[in] hwc_window A window object
968          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
969          * @return A buffer queue
970          */
971         tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
972                                                                                                                    tdm_error *error);
973
974         /**
975          * @brief Release a buffer queue for the window object
976          * @details Release buffer queue when the client no longer uses buferrs of queue.
977          * @param[in] hwc_window A window object
978          * @param[in] A tbm buffer queue
979          */
980         void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
981                                                                                         tbm_surface_queue_h queue);
982
983         /**
984          * @brief Sets the desired composition type of the given window.
985          * @details During hwc_validate(), the backend may request changes to
986          * the composition types of any of the layers as described in the definition
987          * of tdm_hwc_window_composition_t above.
988          * @param[in] hwc_window A window object
989          * @param[in] composition_type The new composition type
990          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
991          */
992         tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
993                                                                                                  tdm_hwc_window_composition composition_type);
994
995         /**
996          * @brief Set the buffer damage
997          * @details Provides the region of the source buffer which has been modified
998          * since the last frame. This region does not need to be validated before
999          * calling hwc_commit().
1000          * Once set through this function, the damage region remains the same until a
1001          * subsequent call to this function.
1002          * If damage.num_rects > 0, then it may be assumed that any portion of the source
1003          * buffer not covered by one of the rects has not been modified this frame. If
1004          * damage.num_rects == 0, then the whole source buffer must be treated as if it
1005          * has been modified.
1006          * If the layer's contents are not modified relative to the prior frame, damage
1007          * will contain exactly one empty rect([0, 0, 0, 0]).
1008          * The damage rects are relative to the pre-transformed buffer, and their origin
1009          * is the top-left corner. They will not exceed the dimensions of the latched
1010          * buffer.
1011          * @param[in] hwc_window A window object
1012          * @param[in] damage The new buffer damage region
1013          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1014          */
1015         tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
1016                                                                                           tdm_region damage);
1017
1018         /**
1019          * @brief Set the information to a window object
1020          * @details The information will be applied when the hwc object is committed.
1021          * @param[in] hwc_window A window object
1022          * @param[in] info The geometry information
1023          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1024          */
1025         tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
1026                                                                          tdm_hwc_window_info *info);
1027
1028         /**
1029          * @brief Set a TDM buffer to a window object
1030          * @details A TDM buffer will be applied when the hwc object
1031          * of a layer object is committed.
1032          * @param[in] hwc_window A window object
1033          * @param[in] buffer A TBM buffer
1034          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1035          */
1036         tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
1037                                                                            tbm_surface_h buffer);
1038
1039         /**
1040          * @brief Set the property which has a given id.
1041          * @param[in] hwc_window  A hwc window object
1042          * @param[in] id The property id
1043          * @param[in] value The value of the propery id
1044          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1045          */
1046         tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
1047                                                                                  uint32_t id, tdm_value value);
1048
1049         /**
1050          * @brief Get the property which has a given id.
1051          * @param[in] hwc_window A hwc window object
1052          * @param[in] id The property id
1053          * @param[out] value The value of the propery id
1054          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1055          */
1056         tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
1057                                                                                  uint32_t id, tdm_value *value);
1058
1059         /**
1060          * @brief Get the constraints of hwc_window
1061          * @param[in] hwc_window A hwc window object
1062          * @param[out] constraints The tdm_hwc_window_constraint types
1063          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1064          */
1065         tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
1066                                                                                                 int *constraints);
1067
1068         /**
1069          * @brief Set the name of hwc_window
1070          * @param[in] hwc_window A hwc window object
1071          * @param[in] name of the hwc_window
1072          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1073          */
1074         tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window,
1075                                                                                                 const char *name);
1076
1077         /**
1078          * @brief Get buffer flags of cursor hwc_window
1079          * @param[in] hwc_window A hwc window object
1080          * @param[in] width of the cursor image
1081          * @param[in] height of the cursor image
1082          * @param[in] stride of the cursor image
1083          * @param[in] virtual address of the cursor image
1084          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1085          */
1086         tdm_error (*hwc_window_set_cursor_image)(tdm_hwc_window *hwc_window,
1087                                                                 int width, int height, int stride, void *ptr);
1088 } tdm_func_hwc_window;
1089
1090 /**
1091  * @brief The pp functions for a backend module.
1092  */
1093 typedef struct _tdm_func_pp {
1094         /**
1095          * @brief Destroy a pp object
1096          * @param[in] pp A pp object
1097          * @see display_create_pp() function of #tdm_func_display
1098          */
1099         void (*pp_destroy)(tdm_pp *pp);
1100
1101         /**
1102          * @brief Set the geometry information to a pp object
1103          * @param[in] pp A pp object
1104          * @param[in] info The geometry information
1105          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1106          * @see pp_commit() function of #tdm_func_pp
1107          * @remark
1108          * A backend module would apply the geometry information when committed.
1109          */
1110         tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1111
1112         /**
1113          * @brief Attach a source buffer and a destination buffer to a pp object
1114          * @param[in] pp A pp object
1115          * @param[in] src A source buffer
1116          * @param[in] dst A destination buffer
1117          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1118          * @see pp_set_info() function of #tdm_func_pp
1119          * @see pp_commit() function of #tdm_func_pp
1120          * @see pp_set_done_handler, tdm_pp_done_handler
1121          * @remark
1122          * A backend module converts the image of a source buffer to a destination
1123          * buffer when committed. The size/crop/transform information is set via
1124          * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1125          * return the source/destination buffer via tdm_pp_done_handler.
1126          */
1127         tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1128
1129         /**
1130          * @brief Commit changes for a pp object
1131          * @param[in] pp A pp object
1132          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1133          */
1134         tdm_error (*pp_commit)(tdm_pp *pp);
1135
1136         /**
1137          * @brief Set a user done handler to a pp object
1138          * @param[in] pp A pp object
1139          * @param[in] func A user done handler
1140          * @param[in] user_data user data
1141          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1142          * @remark
1143          * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1144          */
1145         tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1146                                                                          void *user_data);
1147
1148         void (*reserved1)(void);
1149         void (*reserved2)(void);
1150         void (*reserved3)(void);
1151         void (*reserved4)(void);
1152         void (*reserved5)(void);
1153         void (*reserved6)(void);
1154         void (*reserved7)(void);
1155         void (*reserved8)(void);
1156 } tdm_func_pp;
1157
1158 /**
1159  * @brief The capture functions for a backend module.
1160  */
1161 typedef struct _tdm_func_capture {
1162         /**
1163          * @brief Destroy a capture object
1164          * @param[in] capture A capture object
1165          * @see output_create_capture() function of #tdm_func_output
1166          * @see layer_create_capture() function of #tdm_func_layer
1167          */
1168         void (*capture_destroy)(tdm_capture *capture);
1169
1170         /**
1171          * @brief Set the geometry information to a capture object
1172          * @param[in] capture A capture object
1173          * @param[in] info The geometry information
1174          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1175          * @see capture_commit() function of #tdm_func_capture
1176          * @remark
1177          * A backend module would apply the geometry information when committed.
1178          */
1179         tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1180
1181         /**
1182          * @brief Attach a TDM buffer to a capture object
1183          * @details When capture_commit() function is called, a backend module starts
1184          * to dump a output or a layer to a TDM buffer.
1185          * @param[in] capture A capture object
1186          * @param[in] buffer A TDM buffer
1187          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1188          * @see capture_set_info() function of #tdm_func_capture
1189          * @see capture_commit() function of #tdm_func_capture
1190          * @see capture_set_done_handler, tdm_capture_done_handler
1191          * @remark
1192          * A backend module starts to dump a output or a layer to to a TDM buffer when
1193          * committed. The size/crop/transform information is set via #capture_set_info()
1194          * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1195          * buffer via tdm_capture_done_handler.
1196          */
1197         tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1198
1199         /**
1200          * @brief Commit changes for a capture object
1201          * @param[in] capture A capture object
1202          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1203          */
1204         tdm_error (*capture_commit)(tdm_capture *capture);
1205
1206         /**
1207          * @brief Set a user done handler to a capture object
1208          * @param[in] capture A capture object
1209          * @param[in] func A user done handler
1210          * @param[in] user_data user data
1211          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1212          * @remark
1213          * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1214          */
1215         tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1216                                                                                   tdm_capture_done_handler func, void *user_data);
1217
1218         void (*reserved1)(void);
1219         void (*reserved2)(void);
1220         void (*reserved3)(void);
1221         void (*reserved4)(void);
1222         void (*reserved5)(void);
1223         void (*reserved6)(void);
1224         void (*reserved7)(void);
1225         void (*reserved8)(void);
1226 } tdm_func_capture;
1227
1228 /**
1229  * @brief The tdm event source
1230  */
1231 typedef void tdm_event_loop_source;
1232
1233 /**
1234  * @brief The fd source handler
1235  */
1236 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1237
1238 /**
1239  * @brief The timer source handler
1240  */
1241 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1242
1243 #define TDM_BACKEND_MINOR_VERSION_MASK  0x0000FFFF
1244 #define TDM_BACKEND_MAJOR_VERSION_MASK  0xFFFF0000
1245 #define TDM_BACKEND_GET_ABI_MINOR(v)    ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1246 #define TDM_BACKEND_GET_ABI_MAJOR(v)    (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1247
1248 /**
1249  * @brief
1250  * The ABI version of TDM backend module. It has a major and minor revision.
1251  * Modules using lower minor revisions will work with TDM frontend of a higher
1252  * minor revision. There is no compatibility between different major revisions.
1253  * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1254  * @par Example
1255  * @code
1256  *  tdm_backend_module tdm_backend_module_data = {
1257  *      "drm",
1258  *      "Samsung",
1259  *      TDM_BACKEND_SET_ABI_VERSION(1,1),
1260  *      tdm_drm_init,
1261  *      tdm_drm_deinit
1262  *  };
1263  * @endcode
1264  */
1265 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1266         (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1267         ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1268
1269
1270 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1271 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1272 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi  */
1273
1274 /**
1275  * @brief
1276  * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1277  * @deprecated
1278  * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1279  */
1280 #define TDM_BACKEND_ABI_VERSION     TDM_BACKEND_SET_ABI_VERSION(1, 1)
1281
1282 /**
1283  * @brief The backend module information of the entry point to initialize a TDM
1284  * backend module.
1285  * @remark
1286  * A backend module @b SHOULD define the global data symbol of which name is
1287  * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1288  * at the initial time and call init() function of #tdm_backend_module.
1289  */
1290 typedef struct _tdm_backend_module {
1291         const char *name;           /**< The module name of a backend module */
1292         const char *vendor;         /**< The vendor name of a backend module */
1293         unsigned long abi_version;  /**< The ABI version of a backend module */
1294
1295         /**
1296          * @brief The init function of a backend module
1297          * @param[in] dpy A display object
1298          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1299          * @return The backend module data
1300          * @see tdm_backend_data
1301          */
1302         tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1303
1304         /**
1305          * @brief The deinit function of a backend module
1306          * @param[in] bdata The backend module data
1307          */
1308         void (*deinit)(tdm_backend_data *bdata);
1309 } tdm_backend_module;
1310
1311 /**
1312  * @brief Register the backend display functions to a display
1313  * @param[in] dpy A display object
1314  * @param[in] func_display display functions
1315  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1316  * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1317  * @remarks
1318  * A backend module @b SHOULD set the backend display functions at least.
1319  */
1320 tdm_error
1321 tdm_backend_register_func_display(tdm_display *dpy,
1322                                                                   tdm_func_display *func_display);
1323
1324 /**
1325  * @brief Register the backend output functions to a display
1326  * @param[in] dpy A display object
1327  * @param[in] func_output output functions
1328  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1329  * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1330  * @remarks
1331  * A backend module @b SHOULD set the backend output functions at least.
1332  */
1333 tdm_error
1334 tdm_backend_register_func_output(tdm_display *dpy,
1335                                                                  tdm_func_output *func_output);
1336
1337 /**
1338  * @brief Register the backend voutput functions to a display
1339  * @param[in] dpy A display object
1340  * @param[in] func_voutput voutput functions
1341  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1342  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1343  * @remarks
1344  * A backend module doesn't need to implement this function if doesn't support virtual output.
1345  */
1346 tdm_error
1347 tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
1348
1349 /**
1350  * @brief Register the backend layer functions to a display
1351  * @param[in] dpy A display object
1352  * @param[in] func_layer layer functions
1353  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1354  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1355  * @remarks
1356  * A backend module @b SHOULD set the backend layer functions at least.
1357  */
1358 tdm_error
1359 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1360
1361 /**
1362  * @brief Register the backend hwc functions to a display
1363  * @param[in] dpy A display object
1364  * @param[in] func_hwc hwc functions
1365  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1366  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1367  * @remarks
1368  * A backend module @b SHOULD set the backend hwc functions at least.
1369  * @since 2.0.0
1370  */
1371 tdm_error
1372 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1373
1374 /**
1375  * @brief Register the backend hwc_window functions to a display
1376  * @param[in] dpy A display object
1377  * @param[in] func_hwc_window hwc_window functions
1378  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1379  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1380  * @remarks
1381  * A backend module @b SHOULD set the backend hwc_window functions at least.
1382  * @since 2.0.0
1383  */
1384 tdm_error
1385 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1386
1387 /**
1388  * @brief Register the backend pp functions to a display
1389  * @param[in] dpy A display object
1390  * @param[in] func_pp pp functions
1391  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1392  * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1393  * @remark
1394  * A backend module doesn'tcan skip to register the backend pp functions
1395  * if a hardware doesn't have the memory-to-memory converting device.
1396  */
1397 tdm_error
1398 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1399
1400 /**
1401  * @brief Register the backend capture functions to a display
1402  * @param[in] dpy A display object
1403  * @param[in] func_capture capture functions
1404  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1405  * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1406  * @remark
1407  * A backend module can skip to register the backend capture functions
1408  * if a hardware doesn't have the capture device.
1409  */
1410 tdm_error
1411 tdm_backend_register_func_capture(tdm_display *dpy,
1412                                                                   tdm_func_capture *func_capture);
1413
1414 /**
1415  * @brief Register the backend output to a display
1416  * @param[in] dpy A display object
1417  * @param[in] output A backend output object
1418  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1419  * @see tdm_backend_unregister_output
1420  */
1421 tdm_error
1422 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1423
1424 /**
1425  * @brief Unregister the backend output to a display
1426  * @param[in] dpy A display object
1427  * @param[in] output A backend output object
1428  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1429  * @see tdm_backend_register_output
1430  */
1431 void
1432 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1433
1434 /**
1435  * @brief Increase the ref_count of a TDM buffer
1436  * @details
1437  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1438  * becomes available for a next job. A TDM buffer can be used for TDM to show
1439  * it on screen or to capture an output and a layer. After all operations,
1440  * TDM will release it immediately when TDM doesn't need it any more.
1441  * @param[in] buffer A TDM buffer
1442  * @return A buffer itself. Otherwise, NULL.
1443  * @see tdm_buffer_unref_backend
1444  * @remark
1445  * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1446  * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1447  * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1448  */
1449 tbm_surface_h
1450 tdm_buffer_ref_backend(tbm_surface_h buffer);
1451
1452 /**
1453  * @brief Decrease the ref_count of a TDM buffer
1454  * @param[in] buffer A TDM buffer
1455  * @see tdm_buffer_ref_backend
1456  */
1457 void
1458 tdm_buffer_unref_backend(tbm_surface_h buffer);
1459
1460 /**
1461  * @brief The destroy handler of a TDM buffer
1462  * @param[in] buffer A TDM buffer
1463  * @param[in] user_data user data
1464  * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1465  */
1466 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1467                                                                                    void *user_data);
1468
1469 /**
1470  * @brief Add a destroy handler to a TDM buffer
1471  * @param[in] buffer A TDM buffer
1472  * @param[in] func A destroy handler
1473  * @param[in] user_data user data
1474  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1475  * @see tdm_buffer_remove_destroy_handler
1476  * @remark
1477  * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1478  * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1479  * be called.
1480  */
1481 tdm_error
1482 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1483                                                            tdm_buffer_destroy_handler func, void *user_data);
1484
1485 /**
1486  * @brief Remove a destroy handler from a TDM buffer
1487  * @param[in] buffer A TDM buffer
1488  * @param[in] func A destroy handler
1489  * @param[in] user_data user data
1490  * @see tdm_buffer_add_destroy_handler
1491  */
1492 void
1493 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1494                                                                   tdm_buffer_destroy_handler func, void *user_data);
1495
1496 /**
1497  * @brief Add a FD handler for activity on the given file descriptor
1498  * @param[in] dpy A display object
1499  * @param[in] fd A file descriptor
1500  * @param[in] mask to monitor FD
1501  * @param[in] func A FD handler function
1502  * @param[in] user_data user data
1503  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1504  * @return A FD event source
1505  * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1506  */
1507 tdm_event_loop_source*
1508 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1509                                                           tdm_event_loop_fd_handler func, void *user_data,
1510                                                           tdm_error *error);
1511
1512 /**
1513  * @brief Update the mask of the given FD event source
1514  * @param[in] source The given FD event source
1515  * @param[in] mask to monitor FD
1516  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1517  */
1518 tdm_error
1519 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1520
1521 /**
1522  * @brief Add a timer handler
1523  * @param[in] dpy A display object
1524  * @param[in] func A timer handler function
1525  * @param[in] user_data user data
1526  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1527  * @return A timer event source
1528  * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1529  */
1530 tdm_event_loop_source*
1531 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1532                                                                  void *user_data, tdm_error *error);
1533
1534 /**
1535  * @brief Update the millisecond delay time of the given timer event source.
1536  * @param[in] source The given timer event source
1537  * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1538  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1539  */
1540 tdm_error
1541 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1542
1543 /**
1544  * @brief Remove the given event source
1545  * @param[in] source The given event source
1546  * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1547  */
1548 void
1549 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1550
1551 /**
1552  * @brief Get the ini value with given key
1553  * @details
1554  * @param[in] key The given key
1555  * @param[in] default_value The default value
1556  * @return the value of given key if success. Otherwise, default_value.
1557  * @see #tdm_config_get_string
1558  */
1559 int
1560 tdm_config_get_int(const char *key, int default_value);
1561
1562 /**
1563  * @brief Get the ini value with given key
1564  * @details
1565  * @param[in] key The given key
1566  * @param[in] default_value The default value
1567  * @return the value of given key if success. Otherwise, default_value.
1568  * @see #tdm_config_get_int
1569  */
1570 const char *
1571 tdm_config_get_string(const char *key, const char *default_value);
1572
1573 #ifdef __cplusplus
1574 }
1575 #endif
1576
1577 #endif /* _TDM_BACKEND_H_ */