hwc: add tdm_output_hwc_unset_client_target_buffer
[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 <sc1.lim@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
107         *modes;         /**< The @b newly-allocated array of modes. will be freed in frontend. */
108
109         unsigned int prop_count;        /**< The count of available properties */
110         tdm_prop *props;                /**< The @b newly-allocated array of properties. will be freed in frontend. */
111
112         unsigned int mmWidth;           /**< The physical width (milimeter) */
113         unsigned int mmHeight;          /**< The physical height (milimeter) */
114         unsigned int subpixel;          /**< The subpixel */
115
116         int min_w;              /**< The minimun width */
117         int min_h;              /**< The minimun height */
118         int max_w;              /**< The maximum width */
119         int max_h;              /**< The maximum height */
120         int preferred_align;    /**< The prefered align */
121
122         tdm_output_capability capabilities;  /**< The capabilities of output. @since 1.4.1 */
123
124         int cursor_min_w;              /**< The minimun width.  @since 1.5.0 */
125         int cursor_min_h;              /**< The minimun height. @since 1.5.0 */
126         int cursor_max_w;              /**< The maximum width. @since 1.5.0 */
127         int cursor_max_h;              /**< The maximum height. @since 1.5.0 */
128         int cursor_preferred_align;    /**< The prefered align. @since 1.5.0 */
129 } tdm_caps_output;
130
131 /**
132  * @brief The capabilities structure of a layer object
133  * @see The layer_get_capability() function of #tdm_func_layer
134  */
135 typedef struct _tdm_caps_layer {
136         tdm_layer_capability capabilities;  /**< The capabilities of layer */
137
138         /**
139          * The z-order
140          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
141          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
142          * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
143          * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
144          * layers or more than GRAPHIC layers.
145          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
146          * The zpos of VIDEO layers is @b relative. It doesn't need to start
147          * from -1 or 4. Let's suppose that there are two VIDEO layers.
148          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
149          * than -4 VIDEO layer.
150         */
151         int zpos;
152
153         unsigned int format_count;      /**< The count of available formats */
154         tbm_format
155         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
156
157         unsigned int prop_count;        /**< The count of available properties */
158         tdm_prop *props;                /**< The @b newly-allocated array of properties. will be freed in frontend. */
159 } tdm_caps_layer;
160
161 /**
162  * @brief The capabilities structure of a pp object
163  * @see The display_get_pp_capability() function of #tdm_func_display
164  */
165 typedef struct _tdm_caps_pp {
166         tdm_pp_capability capabilities; /**< The capabilities of pp */
167
168         unsigned int format_count;      /**< The count of available formats */
169         tbm_format
170         *formats;            /**< The @b newly-allocated array. will be freed in frontend. */
171
172         int min_w;              /**< The minimun width */
173         int min_h;              /**< The minimun height */
174         int max_w;              /**< The maximum width */
175         int max_h;              /**< The maximum height */
176         int preferred_align;    /**< The prefered align */
177
178         /**< The attach count which a PP object can handle. @since 1.2.0 */
179         int max_attach_count;
180 } tdm_caps_pp;
181
182 /**
183  * @brief The capabilities structure of a capture object
184  * @see The display_get_capture_capability() function of #tdm_func_display
185  */
186 typedef struct _tdm_caps_capture {
187         tdm_capture_capability capabilities;    /**< The capabilities of capture */
188
189         unsigned int format_count;      /**< The count of available formats */
190         tbm_format
191         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
192
193         int min_w;              /**< The minimun width */
194         int min_h;              /**< The minimun height */
195         int max_w;              /**< The maximum width */
196         int max_h;              /**< The maximum height */
197         int preferred_align;    /**< The prefered align */
198
199         /**< The attach count which a capture object can handle. @since 1.2.0 */
200         int max_attach_count;
201 } tdm_caps_capture;
202
203 /**
204  * @brief The display functions for a backend module.
205  */
206 typedef struct _tdm_func_display {
207         /**
208          * @brief Get the display capabilities of a backend module
209          * @param[in] bdata The backend module data
210          * @param[out] caps The display capabilities of a backend module
211          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
212          * @remark
213          * A backend module @b SHOULD implement this function. TDM calls this function
214          * not only at the initial time, but also at the update time when new output
215          * is connected.\n
216          * If a hardware has the restriction of the number of max usable layer count,
217          * a backend module can set the max count to max_layer_count of #tdm_caps_display
218          * structure.
219          */
220         tdm_error (*display_get_capability)(tdm_backend_data *bdata, tdm_caps_display *caps);
221
222         /**
223          * @brief Get the pp capabilities of a backend module
224          * @param[in] bdata The backend module data
225          * @param[out] caps The pp capabilities of a backend module
226          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
227          * @see tdm_backend_register_func_pp
228          * @remark
229          * TDM calls this function not only at the initial time, but also at the update
230          * time when new output is connected.\n
231          * A backend module doesn't need to implement this function if a hardware
232          * doesn't have the memory-to-memory converting device. Otherwise, a backend module
233          * @b SHOULD fill the #tdm_caps_pp data. #tdm_caps_pp contains the hardware
234          * restriction information which a converting device can handle. ie, format, size, etc.
235          */
236         tdm_error (*display_get_pp_capability)(tdm_backend_data *bdata, tdm_caps_pp *caps);
237
238         /**
239          * @brief Get the capture capabilities of a backend module
240          * @param[in] bdata The backend module data
241          * @param[out] caps The capture capabilities of a backend module
242          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
243          * @see tdm_backend_register_func_capture
244          * @remark
245          * TDM calls this function not only at the initial time, but also at the update
246          * time when new output is connected.\n
247          * A backend module doesn't need to implement this function if a hardware
248          * doesn't have the capture device. Otherwise, a backend module @b SHOULD fill the
249          * #tdm_caps_capture data. #tdm_caps_capture contains the hardware restriction
250          * information which a capture device can handle. ie, format, size, etc.
251          */
252         tdm_error (*display_get_capture_capability)(tdm_backend_data *bdata, tdm_caps_capture *caps);
253
254         /**
255          * @brief Get a output array of a backend module
256          * @param[in] bdata The backend module data
257          * @param[out] count The count of outputs
258          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
259          * @return A output array which is @b newly-allocated
260          * @see tdm_backend_register_func_capture
261          * @remark
262          * A backend module @b SHOULD implement this function. TDM calls this function
263          * not only at the initial time, but also at the update time when new output
264          * is connected.\n
265          * A backend module @b SHOULD return the @b newly-allocated array which contains
266          * "tdm_output*" data. It will be freed in frontend.
267          * @par Example
268          * @code
269          *  tdm_output**
270          *  drm_display_get_outputs(tdm_backend_data *bdata, int *count, tdm_error *error)
271          *  {
272          *      tdm_drm_data *drm_data = bdata;
273          *      tdm_drm_output_data *output_data = NULL;
274          *      tdm_output **outputs;
275          *      int i;
276          *
277          *      (*count) = 0;
278          *      LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
279          *          (*count)++;
280          *
281          *      if ((*count) == 0)
282          *      {
283          *          if (error) *error = TDM_ERROR_NONE;
284          *          return NULL;
285          *      }
286          *
287          *      // will be freed in frontend
288          *      outputs = calloc(*count, sizeof(tdm_drm_output_data*));
289          *      if (!outputs)
290          *      {
291          *          (*count) = 0;
292          *          if (error) *error = TDM_ERROR_OUT_OF_MEMORY;
293          *          return NULL;
294          *      }
295          *
296          *      i = 0;
297          *      LIST_FOR_EACH_ENTRY(output_data, &drm_data->output_list, link)
298          *          outputs[i++] = output_data;
299          *
300          *      if (error) *error = TDM_ERROR_NONE;
301          *
302          *      return outputs;
303          *  }
304          * @endcode
305          */
306         tdm_output **(*display_get_outputs)(tdm_backend_data *bdata, int *count,
307                                                                                 tdm_error *error);
308
309         /**
310          * @brief Get the file descriptor of a backend module
311          * @param[in] bdata The backend module data
312          * @param[out] fd The fd of a backend module
313          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
314          * @see display_handle_events() function of #tdm_func_display
315          * @remark
316          * A backend module can return epoll's fd which is watching the backend device one more fds.
317          */
318         tdm_error (*display_get_fd)(tdm_backend_data *bdata, int *fd);
319
320         /**
321          * @brief Handle the events which happens on the fd of a backend module
322          * @param[in] bdata The backend module data
323          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
324          */
325         tdm_error (*display_handle_events)(tdm_backend_data *bdata);
326
327         /**
328          * @brief Create a pp object of a backend module
329          * @param[in] bdata The backend module data
330          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
331          * @return A pp object
332          * @see pp_destroy() function of #tdm_func_pp
333          * @remark
334          * A backend module doesn't need to implement this function if a hardware
335          * doesn't have the memory-to-memory converting device.
336          */
337         tdm_pp *(*display_create_pp)(tdm_backend_data *bdata, tdm_error *error);
338
339         void (*reserved1)(void);
340         void (*reserved2)(void);
341         void (*reserved3)(void);
342         void (*reserved4)(void);
343         void (*reserved5)(void);
344         void (*reserved6)(void);
345         void (*reserved7)(void);
346         void (*reserved8)(void);
347 } tdm_func_display;
348
349 /**
350  * @brief The output functions for a backend module.
351  */
352 typedef struct _tdm_func_output {
353         /**
354          * @brief Get the capabilities of a output object
355          * @param[in] output A output object
356          * @param[out] caps The capabilities of a output object
357          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
358          * @remark
359          * A backend module @b SHOULD implement this function. TDM calls this function
360          * not only at the initial time, but also at the update time when new output
361          * is connected.\n
362          * #tdm_caps_output contains connection status, modes, avaiable properties,
363          * size restriction information, etc.
364          */
365         tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
366
367         /**
368          * @brief Get a layer array of a output object
369          * @param[in] output A output object
370          * @param[out] count The count of layers
371          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
372          * @return A layer array which is @b newly-allocated
373          * @remark
374          * A backend module @b SHOULD implement this function. TDM calls this function
375          * not only at the initial time, but also at the update time when new output
376          * is connected.\n
377          * A backend module @b SHOULD return the @b newly-allocated array which contains
378          * "tdm_layer*" data. It will be freed in frontend.
379          */
380         tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
381                                                                          tdm_error *error);
382
383         /**
384          * @brief Set the property which has a given id
385          * @param[in] output A output object
386          * @param[in] id The property id
387          * @param[in] value The value
388          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
389          */
390         tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
391                                                                          tdm_value value);
392
393         /**
394          * @brief Get the property which has a given id
395          * @param[in] output A output object
396          * @param[in] id The property id
397          * @param[out] value The value
398          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
399          */
400         tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
401                                                                          tdm_value *value);
402
403         /**
404          * @brief Wait for VBLANK
405          * @param[in] output A output object
406          * @param[in] interval vblank interval
407          * @param[in] sync 0: asynchronous, 1:synchronous
408          * @param[in] user_data The user data
409          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
410          * @see output_set_vblank_handler, tdm_output_vblank_handler
411          * @remark
412          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
413          * a user vblank handler with the user data of this function after interval
414          * vblanks.
415          */
416         tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
417                                                                         void *user_data);
418
419         /**
420          * @brief Set a user vblank handler
421          * @param[in] output A output object
422          * @param[in] func A user vblank handler
423          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
424          */
425         tdm_error (*output_set_vblank_handler)(tdm_output *output,
426                                                                                    tdm_output_vblank_handler func);
427
428         /**
429          * @brief Commit changes for a output object
430          * @param[in] output A output object
431          * @param[in] sync 0: asynchronous, 1:synchronous
432          * @param[in] user_data The user data
433          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
434          * @see output_set_commit_handler, tdm_output_commit_handler
435          * @remark
436          * When this function is called, a backend module @b SHOULD apply the all
437          * changes of the given output object to screen as well as the layer changes
438          * of this output.
439          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
440          * a user commit handler with the user data of this function after all
441          * changes of the given output object are applied.
442          */
443         tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
444
445         /**
446          * @brief Set a user commit handler
447          * @param[in] output A output object
448          * @param[in] func A user commit handler
449          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
450          */
451         tdm_error (*output_set_commit_handler)(tdm_output *output,
452                                                                                    tdm_output_commit_handler func);
453
454         /**
455          * @brief Set DPMS of a output object synchronously
456          * @param[in] output A output object
457          * @param[in] dpms_value DPMS value
458          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
459          */
460         tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
461
462         /**
463          * @brief Get DPMS of a output object
464          * @param[in] output A output object
465          * @param[out] dpms_value DPMS value
466          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
467          */
468         tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
469
470         /**
471          * @brief Set one of available modes of a output object
472          * @param[in] output A output object
473          * @param[in] mode A output mode
474          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
475          */
476         tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
477
478         /**
479          * @brief Get the mode of a output object
480          * @deprecated
481          * @param[in] output A output object
482          * @param[out] mode A output mode
483          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
484          */
485         tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
486
487         /**
488          * @brief Create a capture object of a output object
489          * @param[in] output A output object
490          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
491          * @return A capture object
492          * @see capture_destroy() function of #tdm_func_capture
493          * @remark
494          * A backend module doesn't need to implement this function if a hardware
495          * doesn't have the capture device.
496          */
497         tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
498
499         /**
500          * @brief Set a output connection status handler
501          * @details A backend module need to call the output status handler when the
502          * output connection status has been changed to let the TDM frontend know
503          * the change.
504          * @param[in] output A output object
505          * @param[in] func A output status handler
506          * @param[in] user_data The user data
507          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
508          * @since 1.1.0
509          */
510         tdm_error (*output_set_status_handler)(tdm_output *output,
511                                                                                    tdm_output_status_handler func,
512                                                                                    void *user_data);
513
514         /**
515          * @brief Set a output dpms handler
516          * @details This function can be NULL if an output doesn't support asynchronous
517          * DPMS control. Otherwise, a backend module needs to call the output dpms handler
518          * to let the TDM frontend know the output DPMS change indeed.
519          * @param[in] output A output object
520          * @param[in] func A output dpms handler
521          * @param[in] user_data The user data
522          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
523          * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
524          * @since 1.4.0
525          */
526         tdm_error (*output_set_dpms_handler)(tdm_output *output,
527                                                                                  tdm_output_dpms_handler func,
528                                                                                  void *user_data);
529
530         /**
531          * @brief Set DPMS of a output object asynchronously
532          * @param[in] output A output object
533          * @details This function can be NULL if an output doesn't support asynchronous
534          * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
535          * flags which #output_get_capability returns. And if a output dpms handler is added with
536          * #output_set_dpms_handler, a backend module needs to call the output dpms handler
537          * to let the TDM frontend know the output DPMS change indeed.
538          * @param[in] dpms_value DPMS value
539          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
540          * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
541          * @since 1.7.0
542          */
543         tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
544
545         /**
546          * @brief Creates a new window on the given display.
547          * @param[in] output A output object
548          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
549          * @return A created window object
550          * @since 2.0.0
551          */
552         tdm_hwc_window *(*output_hwc_create_window)(tdm_output *output, tdm_error *error);
553
554         /**
555          * @brief Destroys the given window.
556          * @param[in] output A output object
557          * @param[in] window the pointer of the window to destroy
558          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
559          * @since 2.0.0
560          */
561         tdm_error (*output_hwc_destroy_window)(tdm_output *output, tdm_hwc_window *hwc_window);
562
563         /**
564          * @brief Set the client(relative to the TDM) target buffer
565          * @details Sets the buffer which will receive the output of client composition.
566          * Window marked as TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE
567          * will be composited into this buffer prior to the call to output_commit(),
568          * and windows not marked as TDM_COMPOSITION_CLIENT and
569          * TDM_COMPOSITION_DEVICE_CANDIDATE should be composited with this buffer by the
570          * device.
571          *
572          * The buffer handle provided may be null if no windows are being composited by
573          * the client. This must not result in an error (unless an invalid display
574          * handle is also provided).
575          *
576          * The damage parameter describes a buffer damage region as defined in the
577          * description of hwc_window_set_buffer_damage().
578          *
579          * List of composited hwc_windows (hwc_windows which buffers are presented on #target_buffer)
580          * will be passed along with #target_buffer to allow tdm to make the smooth transition
581          * from a DEVICE type to a CLIENT type.
582          *
583          * Will be called before output_commit() if any of the layers are marked as
584          * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. If no layers are
585          * so marked, then it is not necessary to call this function. It is not necessary
586          * to call output_hwc_validate() after changing the target through this function.
587          * @param[in] output A output object
588          * @param[in] target The new target buffer
589          * @param[in] damage The buffer damage region
590          * @param[in] composited_wnds The array of composited hwc_wnds
591          * @param[in] num_wnds The size of #composited_wnds array
592          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
593          * @since 2.0.0
594          */
595         tdm_error (*output_hwc_set_client_target_buffer)(tdm_output *output, tbm_surface_h target_buffer, tdm_hwc_region damage);
596
597         /**
598          * @brief Unset the client(relative to the TDM) target buffer
599          * @details TODO
600          * @param[in] output A output object
601          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
602          * @since 2.0.0
603          */
604         tdm_error (*output_hwc_unset_client_target_buffer)(tdm_output *output);
605
606         /**
607          * @brief Validate the output
608          * @details Instructs the device to inspect all of the layer state and
609          * determine if there are any composition type changes necessary before
610          * presenting the output. Permitted changes are described in the definition
611          * of tdm_composition_t above.
612          * @param[in] output A output object
613          * @param[out] num_types The number of composition type changes required by
614          * the device; if greater than 0, the client must either set and validate new
615          * types, or call output_hwc_accept_changes() to accept the changes returned by
616          * output_hwc_get_changed_composition_types(); must be the same as the number of
617          * changes returned by output_hwc_get_changed_composition_types (see the
618          * declaration of that function for more information); pointer will be non-NULL
619          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
620          * @since 2.0.0
621          */
622         tdm_error (*output_hwc_validate)(tdm_output *output, tdm_hwc_window **composited_wnds, uint32_t num_wnds,
623                                                                 uint32_t *num_types);
624
625         /**
626          * @brief Get changed composition types
627          * @details Retrieves the windows for which the device requires a different
628          * composition type than had been set prior to the last call to output_hwc_validate().
629          * The client will either update its state with these types and call
630          * output_hwc_accept_changes, or will set new types and attempt to validate the
631          * display again.
632          * layers and types may be NULL to retrieve the number of elements which
633          * will be returned. The number of elements returned must be the same as the
634          * value returned in num_types from the last call to output_hwc_validate().
635          * @param[in] output A output object
636          * @param[out] num_elements If windows or types were NULL, the number of layers
637          * and types which would have been returned; if both were non-NULL, the
638          * number of elements returned in layers and types, which must not exceed
639          * the value stored in num_elements prior to the call; pointer will be
640          * non-NULL
641          * @param[out] windows An array of windows
642          * @param[out] composition_types An array of composition types, each
643          * corresponding to an element of windows
644          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
645          * @since 2.0.0
646          */
647         tdm_error (*output_hwc_get_changed_composition_types)(tdm_output *output,
648                                                                                                           uint32_t *num_elements,
649                                                                                                           tdm_hwc_window **hwc_window,
650                                                                                                           tdm_hwc_window_composition *composition_types);
651         /**
652          * @brief Accepts the changes required by the device
653          * @details Accepts the changes required by the device from the previous
654          * output_hwc_validate() call (which may be queried using
655          * output_get_chaged_composition_types()) and revalidates the display. This
656          * function is equivalent to requesting the changed types from
657          * output_get_chaged_composition_types(), setting those types on the
658          * corresponding windows, and then calling output_hwc_validate again.
659          * After this call it must be valid to present this display. Calling this after
660          * output_hwc_validate() returns 0 changes must succeed with TDM_ERROR_NONE, but
661          * should have no other effect.
662          * @param[in] output A output object
663          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
664          * @since 2.0.0
665          */
666         tdm_error (*output_hwc_accept_changes)(tdm_output *output);
667
668         /**
669          * @brief Get a target buffer queue
670          * @param[in] output A output object
671          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
672          * @return A buffer queue
673          * @since 2.0.0
674          */
675         tbm_surface_queue_h (*output_hwc_get_target_buffer_queue)(tdm_output *output,
676                                                                                                                    tdm_error *error);
677
678         /**
679          * @brief Get the supported format array for video hwc windows of a output object.
680          * @param[in] output A output object
681          * @param[out] formats The available format array
682          * @param[out] count The count of formats
683          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
684          */
685         tdm_error (*output_hwc_get_video_supported_formats)(tdm_layer *layer,
686                                                                         const tbm_format **formats, int *count);
687
688         /**
689          * @brief Creates a new video window on the given output.
690          * @param[in] output A output object
691          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
692          * @return A created window object. If the video abilities isn't accessed return NULL
693          * @since 2.0.0
694          */
695         tdm_hwc_window *(*output_hwc_create_video_window)(tdm_output *output, tdm_error *error);
696
697         void (*reserved5)(void);
698         void (*reserved6)(void);
699         void (*reserved7)(void);
700         void (*reserved8)(void);
701 } tdm_func_output;
702
703 /**
704  * @brief The layer functions for a backend module.
705  */
706 typedef struct _tdm_func_layer {
707         /**
708          * @brief Get the capabilities of a layer object
709          * @param[in] layer A layer object
710          * @param[out] caps The capabilities of a layer object
711          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
712          * @remark
713          * A backend module @b SHOULD implement this function. TDM calls this function
714          * not only at the initial time, but also at the update time when new output
715          * is connected.\n
716          * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
717          */
718         tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
719
720         /**
721          * @brief Set the property which has a given id.
722          * @param[in] layer A layer object
723          * @param[in] id The property id
724          * @param[in] value The value
725          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
726          */
727         tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
728                                                                         tdm_value value);
729
730         /**
731          * @brief Get the property which has a given id.
732          * @param[in] layer A layer object
733          * @param[in] id The property id
734          * @param[out] value The value
735          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
736          */
737         tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
738                                                                         tdm_value *value);
739
740         /**
741          * @brief Set the geometry information to a layer object
742          * @param[in] layer A layer object
743          * @param[in] info The geometry information
744          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
745          * @see output_commit() function of #tdm_func_output
746          * @remark
747          * A backend module would apply the geometry information when the output object
748          * of a layer object is committed.
749          */
750         tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
751
752         /**
753          * @brief Get the geometry information to a layer object
754          * @param[in] layer A layer object
755          * @param[out] info The geometry information
756          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
757          */
758         tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
759
760         /**
761          * @brief Set a TDM buffer to a layer object
762          * @param[in] layer A layer object
763          * @param[in] buffer A TDM buffer
764          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
765          * @see output_commit() function of #tdm_func_output
766          * @remark
767          * A backend module would show a TDM buffer on screen when the output object
768          * of a layer object is committed.
769          */
770         tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
771
772         /**
773          * @brief Unset a TDM buffer from a layer object
774          * @param[in] layer A layer object
775          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
776          * @remark
777          * A backend module @b SHOULD remove the current showing buffer from screen.
778          */
779         tdm_error (*layer_unset_buffer)(tdm_layer *layer);
780
781         /**
782          * @brief Set the zpos for a VIDEO layer object
783          * @param[in] layer A layer object
784          * @param[in] zpos z-order
785          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
786          * @see tdm_caps_layer, tdm_layer_capability
787          * @remark
788          * A backend module doesn't need to implement this function if a backend
789          * module doesn't have VIDEO layers.\n
790          * This function is for VIDEO layers.
791          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
792          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
793          * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
794          * is less than GRAPHIC layers or more than GRAPHIC layers.
795          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
796          * The zpos of VIDEO layers is @b relative. It doesn't need to start
797          * from -1 or 4. Let's suppose that there are two VIDEO layers.
798          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
799          * than -4 VIDEO layer.
800          */
801         tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
802
803         /**
804          * @brief Create a capture object of a layer object
805          * @param[in] output A output object
806          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
807          * @return A capture object
808          * @see capture_destroy() function of #tdm_func_capture
809          * @remark
810          * A backend module doesn't need to implement this function if a hardware
811          * doesn't have the capture device.
812          */
813         tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
814
815         /**
816          * @brief Get buffer flags which the layer can support.
817          * @param[in] layer A layer object
818          * @param[out] flags The buffer flags which should be the tbm_bo flags
819          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
820          */
821         tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
822
823         void (*reserved1)(void);
824         void (*reserved2)(void);
825         void (*reserved3)(void);
826         void (*reserved4)(void);
827         void (*reserved5)(void);
828         void (*reserved6)(void);
829         void (*reserved7)(void);
830 } tdm_func_layer;
831
832 /**
833  * @brief The window functions for a backend module.
834  * @since 2.0.0
835  */
836 typedef struct _tdm_func_window {
837         /**
838          * @brief Get a buffer queue for the window object
839          * @param[in] hwc_window A window object
840          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
841          * @return A buffer queue
842          */
843         tbm_surface_queue_h (*hwc_window_get_tbm_buffer_queue)(tdm_hwc_window *hwc_window,
844                                                                                                                         tdm_error *error);
845
846         /**
847          * @brief Sets the desired composition type of the given window.
848          * @details During output_hwc_validate(), the device may request changes to
849          * the composition types of any of the layers as described in the definition
850          * of tdm_hwc_window_composition_t above.
851          * @param[in] hwc_window A window object
852          * @param[in] composition_type The new composition type
853          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
854          */
855         tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
856                                                                                                  tdm_hwc_window_composition composition_type);
857
858         /**
859          * @brief Set the buffer damage
860          * @details Provides the region of the source buffer which has been modified
861          * since the last frame. This region does not need to be validated before
862          * calling output_commit().
863          * Once set through this function, the damage region remains the same until a
864          * subsequent call to this function.
865          * If damage.num_rects > 0, then it may be assumed that any portion of the source
866          * buffer not covered by one of the rects has not been modified this frame. If
867          * damage.num_rects == 0, then the whole source buffer must be treated as if it
868          * has been modified.
869          * If the layer's contents are not modified relative to the prior frame, damage
870          * will contain exactly one empty rect([0, 0, 0, 0]).
871          * The damage rects are relative to the pre-transformed buffer, and their origin
872          * is the top-left corner. They will not exceed the dimensions of the latched
873          * buffer.
874          * @param[in] hwc_window A window object
875          * @param[in] damage The new buffer damage region
876          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
877          */
878         tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
879                                                                                            tdm_hwc_region damage);
880
881         /**
882          * @brief Set the information to a window object
883          * @details The information will be applied when the output object
884          * of a layer object is committed.
885          * @param[in] hwc_window A window object
886          * @param[in] info The geometry information
887          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
888          */
889         tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
890                                                                          tdm_hwc_window_info *info);
891
892         /**
893          * @brief Set a TDM buffer to a window object
894          * @details A TDM buffer will be applied when the output object
895          * of a layer object is committed.
896          * @param[in] hwc_window A window object
897          * @param[in] buffer A TDM buffer
898          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
899          *
900          * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
901          * be updated right now, this won't be interpreted like some critical
902          * error.
903          */
904         tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
905                                                                            tbm_surface_h buffer);
906
907         /**
908          * @brief Unset a TDM buffer to a window object
909          * @details A TDM buffer will be applied when the output object
910          * of a layer object is committed.
911          * @param[in] hwc_window A window object
912          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
913          *
914          * Implementation should return #TDM_ERROR_BUSY if #hwc_window can't
915          * be updated right now, this won't be interpreted like some critical
916          * error.
917          */
918         tdm_error (*hwc_window_unset_buffer)(tdm_hwc_window *hwc_window);
919
920         /**
921          * @brief Set a flags to a window object
922          * @param[in] hwc_window A window object
923          * @param[in] flags A hwc_window flags
924          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
925          */
926         tdm_error (*hwc_window_set_flags)(tdm_hwc_window *hwc_window,
927                                                                           tdm_hwc_window_flag flags);
928
929         /**
930          * @brief Unset a flags from a window object
931          * @param[in] hwc_window A window object
932          * @param[in] flags A hwc_window flags
933          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
934          */
935         tdm_error (*hwc_window_unset_flags)(tdm_hwc_window *hwc_window,
936                                                                                 tdm_hwc_window_flag flags);
937
938         /**
939          * @brief Get the window video capability
940          * @param[in] hwc_window A window object
941          * @param[out] video_capability A hwc window video capability
942          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
943          */
944         tdm_error (*hwc_window_video_get_capability)(tdm_hwc_window *hwc_window,
945                                                         tdm_hwc_window_video_capability *video_capability);
946
947         /**
948          * @brief Get the available property array  of a video hwc window object.
949          * @param[in] hwc window A video hwc window object
950          * @param[out] props The available property array
951          * @param[out] count The count of properties
952          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
953          */
954         tdm_error (*hwc_window_video_get_available_properties)(
955                                                                                         tdm_hwc_window *hwc_window,
956                                                                                         const tdm_prop **props, int *count);
957
958         /**
959          * @brief Get the property which has a given id.
960          * @param[in] hwc window A video hwc window object
961          * @param[in] id The property id
962          * @param[out] value The value
963          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
964          */
965         tdm_error (*hwc_window_video_get_property)(tdm_hwc_window *hwc_window,
966                                                                                            uint32_t id, tdm_value *value);
967
968         /**
969          * @brief Set the property which has a given id.
970          * @param[in] hwc window  A video hwc window object
971          * @param[in] id The property id
972          * @param[in] value The value
973          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
974          */
975         tdm_error (*hwc_window_video_set_property)(tdm_hwc_window *hwc_window,
976                                                                                            uint32_t id, tdm_value value);
977
978 } tdm_func_hwc_window;
979
980 /**
981  * @brief The pp functions for a backend module.
982  */
983 typedef struct _tdm_func_pp {
984         /**
985          * @brief Destroy a pp object
986          * @param[in] pp A pp object
987          * @see display_create_pp() function of #tdm_func_display
988          */
989         void (*pp_destroy)(tdm_pp *pp);
990
991         /**
992          * @brief Set the geometry information to a pp object
993          * @param[in] pp A pp object
994          * @param[in] info The geometry information
995          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
996          * @see pp_commit() function of #tdm_func_pp
997          * @remark
998          * A backend module would apply the geometry information when committed.
999          */
1000         tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1001
1002         /**
1003          * @brief Attach a source buffer and a destination buffer to a pp object
1004          * @param[in] pp A pp object
1005          * @param[in] src A source buffer
1006          * @param[in] dst A destination buffer
1007          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1008          * @see pp_set_info() function of #tdm_func_pp
1009          * @see pp_commit() function of #tdm_func_pp
1010          * @see pp_set_done_handler, tdm_pp_done_handler
1011          * @remark
1012          * A backend module converts the image of a source buffer to a destination
1013          * buffer when committed. The size/crop/transform information is set via
1014          * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1015          * return the source/destination buffer via tdm_pp_done_handler.
1016          */
1017         tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1018
1019         /**
1020          * @brief Commit changes for a pp object
1021          * @param[in] pp A pp object
1022          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1023          */
1024         tdm_error (*pp_commit)(tdm_pp *pp);
1025
1026         /**
1027          * @brief Set a user done handler to a pp object
1028          * @param[in] pp A pp object
1029          * @param[in] func A user done handler
1030          * @param[in] user_data user data
1031          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1032          * @remark
1033          * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1034          */
1035         tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1036                                                                          void *user_data);
1037
1038         void (*reserved1)(void);
1039         void (*reserved2)(void);
1040         void (*reserved3)(void);
1041         void (*reserved4)(void);
1042         void (*reserved5)(void);
1043         void (*reserved6)(void);
1044         void (*reserved7)(void);
1045         void (*reserved8)(void);
1046 } tdm_func_pp;
1047
1048 /**
1049  * @brief The capture functions for a backend module.
1050  */
1051 typedef struct _tdm_func_capture {
1052         /**
1053          * @brief Destroy a capture object
1054          * @param[in] capture A capture object
1055          * @see output_create_capture() function of #tdm_func_output
1056          * @see layer_create_capture() function of #tdm_func_layer
1057          */
1058         void (*capture_destroy)(tdm_capture *capture);
1059
1060         /**
1061          * @brief Set the geometry information to a capture object
1062          * @param[in] capture A capture object
1063          * @param[in] info The geometry information
1064          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1065          * @see capture_commit() function of #tdm_func_capture
1066          * @remark
1067          * A backend module would apply the geometry information when committed.
1068          */
1069         tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1070
1071         /**
1072          * @brief Attach a TDM buffer to a capture object
1073          * @details When capture_commit() function is called, a backend module starts
1074          * to dump a output or a layer to a TDM buffer.
1075          * @param[in] capture A capture object
1076          * @param[in] buffer A TDM buffer
1077          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1078          * @see capture_set_info() function of #tdm_func_capture
1079          * @see capture_commit() function of #tdm_func_capture
1080          * @see capture_set_done_handler, tdm_capture_done_handler
1081          * @remark
1082          * A backend module starts to dump a output or a layer to to a TDM buffer when
1083          * committed. The size/crop/transform information is set via #capture_set_info()
1084          * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1085          * buffer via tdm_capture_done_handler.
1086          */
1087         tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1088
1089         /**
1090          * @brief Commit changes for a capture object
1091          * @param[in] capture A capture object
1092          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1093          */
1094         tdm_error (*capture_commit)(tdm_capture *capture);
1095
1096         /**
1097          * @brief Set a user done handler to a capture object
1098          * @param[in] capture A capture object
1099          * @param[in] func A user done handler
1100          * @param[in] user_data user data
1101          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1102          * @remark
1103          * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1104          */
1105         tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1106                                                                                   tdm_capture_done_handler func, void *user_data);
1107
1108         void (*reserved1)(void);
1109         void (*reserved2)(void);
1110         void (*reserved3)(void);
1111         void (*reserved4)(void);
1112         void (*reserved5)(void);
1113         void (*reserved6)(void);
1114         void (*reserved7)(void);
1115         void (*reserved8)(void);
1116 } tdm_func_capture;
1117
1118 /**
1119  * @brief The tdm event source
1120  */
1121 typedef void tdm_event_loop_source;
1122
1123 /**
1124  * @brief The fd source handler
1125  */
1126 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1127
1128 /**
1129  * @brief The timer source handler
1130  */
1131 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1132
1133 #define TDM_BACKEND_MINOR_VERSION_MASK  0x0000FFFF
1134 #define TDM_BACKEND_MAJOR_VERSION_MASK  0xFFFF0000
1135 #define TDM_BACKEND_GET_ABI_MINOR(v)    ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1136 #define TDM_BACKEND_GET_ABI_MAJOR(v)    (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1137
1138 /**
1139  * @brief
1140  * The ABI version of TDM backend module. It has a major and minor revision.
1141  * Modules using lower minor revisions will work with TDM frontend of a higher
1142  * minor revision. There is no compatibility between different major revisions.
1143  * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1144  * @par Example
1145  * @code
1146  *  tdm_backend_module tdm_backend_module_data = {
1147  *      "drm",
1148  *      "Samsung",
1149  *      TDM_BACKEND_SET_ABI_VERSION(1,1),
1150  *      tdm_drm_init,
1151  *      tdm_drm_deinit
1152  *  };
1153  * @endcode
1154  */
1155 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1156         (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1157         ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1158
1159 /**
1160  * @brief
1161  * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1162  * @deprecated
1163  * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1164  */
1165 #define TDM_BACKEND_ABI_VERSION     TDM_BACKEND_SET_ABI_VERSION(1, 1)
1166
1167 /**
1168  * @brief The backend module information of the entry point to initialize a TDM
1169  * backend module.
1170  * @remark
1171  * A backend module @b SHOULD define the global data symbol of which name is
1172  * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1173  * at the initial time and call init() function of #tdm_backend_module.
1174  */
1175 typedef struct _tdm_backend_module {
1176         const char *name;           /**< The module name of a backend module */
1177         const char *vendor;         /**< The vendor name of a backend module */
1178         unsigned long abi_version;  /**< The ABI version of a backend module */
1179
1180         /**
1181          * @brief The init function of a backend module
1182          * @param[in] dpy A display object
1183          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1184          * @return The backend module data
1185          * @see tdm_backend_data
1186          */
1187         tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1188
1189         /**
1190          * @brief The deinit function of a backend module
1191          * @param[in] bdata The backend module data
1192          */
1193         void (*deinit)(tdm_backend_data *bdata);
1194 } tdm_backend_module;
1195
1196 /**
1197  * @brief Register the backend display functions to a display
1198  * @param[in] dpy A display object
1199  * @param[in] func_display display functions
1200  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1201  * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1202  * @remarks
1203  * A backend module @b SHOULD set the backend display functions at least.
1204  */
1205 tdm_error
1206 tdm_backend_register_func_display(tdm_display *dpy,
1207                                                                   tdm_func_display *func_display);
1208
1209 /**
1210  * @brief Register the backend output functions to a display
1211  * @param[in] dpy A display object
1212  * @param[in] func_output output functions
1213  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1214  * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1215  * @remarks
1216  * A backend module @b SHOULD set the backend output functions at least.
1217  */
1218 tdm_error
1219 tdm_backend_register_func_output(tdm_display *dpy,
1220                                                                  tdm_func_output *func_output);
1221
1222 /**
1223  * @brief Register the backend layer functions to a display
1224  * @param[in] dpy A display object
1225  * @param[in] func_layer layer functions
1226  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1227  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1228  * @remarks
1229  * A backend module @b SHOULD set the backend layer functions at least.
1230  */
1231 tdm_error
1232 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1233
1234 /**
1235  * @brief Register the backend hwc_window functions to a display
1236  * @param[in] dpy A display object
1237  * @param[in] func_hwc_window hwc_window functions
1238  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1239  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1240  * @remarks
1241  * A backend module @b SHOULD set the backend hwc_window functions at least.
1242  * @since 2.0.0
1243  */
1244 tdm_error
1245 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1246
1247 /**
1248  * @brief Register the backend pp functions to a display
1249  * @param[in] dpy A display object
1250  * @param[in] func_pp pp functions
1251  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1252  * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1253  * @remark
1254  * A backend module doesn'tcan skip to register the backend pp functions
1255  * if a hardware doesn't have the memory-to-memory converting device.
1256  */
1257 tdm_error
1258 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1259
1260 /**
1261  * @brief Register the backend capture functions to a display
1262  * @param[in] dpy A display object
1263  * @param[in] func_capture capture functions
1264  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1265  * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1266  * @remark
1267  * A backend module can skip to register the backend capture functions
1268  * if a hardware doesn't have the capture device.
1269  */
1270 tdm_error
1271 tdm_backend_register_func_capture(tdm_display *dpy,
1272                                                                   tdm_func_capture *func_capture);
1273
1274 /**
1275  * @brief Increase the ref_count of a TDM buffer
1276  * @details
1277  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1278  * becomes available for a next job. A TDM buffer can be used for TDM to show
1279  * it on screen or to capture an output and a layer. After all operations,
1280  * TDM will release it immediately when TDM doesn't need it any more.
1281  * @param[in] buffer A TDM buffer
1282  * @return A buffer itself. Otherwise, NULL.
1283  * @see tdm_buffer_unref_backend
1284  * @remark
1285  * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1286  * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1287  * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1288  */
1289 tbm_surface_h
1290 tdm_buffer_ref_backend(tbm_surface_h buffer);
1291
1292 /**
1293  * @brief Decrease the ref_count of a TDM buffer
1294  * @param[in] buffer A TDM buffer
1295  * @see tdm_buffer_ref_backend
1296  */
1297 void
1298 tdm_buffer_unref_backend(tbm_surface_h buffer);
1299
1300 /**
1301  * @brief The destroy handler of a TDM buffer
1302  * @param[in] buffer A TDM buffer
1303  * @param[in] user_data user data
1304  * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1305  */
1306 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1307                                                                                    void *user_data);
1308
1309 /**
1310  * @brief Add a destroy handler to a TDM buffer
1311  * @param[in] buffer A TDM buffer
1312  * @param[in] func A destroy handler
1313  * @param[in] user_data user data
1314  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1315  * @see tdm_buffer_remove_destroy_handler
1316  * @remark
1317  * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1318  * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1319  * be called.
1320  */
1321 tdm_error
1322 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1323                                                            tdm_buffer_destroy_handler func, void *user_data);
1324
1325 /**
1326  * @brief Remove a destroy handler from a TDM buffer
1327  * @param[in] buffer A TDM buffer
1328  * @param[in] func A destroy handler
1329  * @param[in] user_data user data
1330  * @see tdm_buffer_add_destroy_handler
1331  */
1332 void
1333 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1334                                                                   tdm_buffer_destroy_handler func, void *user_data);
1335
1336 /**
1337  * @brief Add a FD handler for activity on the given file descriptor
1338  * @param[in] dpy A display object
1339  * @param[in] fd A file descriptor
1340  * @param[in] mask to monitor FD
1341  * @param[in] func A FD handler function
1342  * @param[in] user_data user data
1343  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1344  * @return A FD event source
1345  * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1346  */
1347 tdm_event_loop_source*
1348 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1349                                                           tdm_event_loop_fd_handler func, void *user_data,
1350                                                           tdm_error *error);
1351
1352 /**
1353  * @brief Update the mask of the given FD event source
1354  * @param[in] source The given FD event source
1355  * @param[in] mask to monitor FD
1356  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1357  */
1358 tdm_error
1359 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1360
1361 /**
1362  * @brief Add a timer handler
1363  * @param[in] dpy A display object
1364  * @param[in] func A timer handler function
1365  * @param[in] user_data user data
1366  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1367  * @return A timer event source
1368  * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1369  */
1370 tdm_event_loop_source*
1371 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1372                                                                  void *user_data, tdm_error *error);
1373
1374 /**
1375  * @brief Update the millisecond delay time of the given timer event source.
1376  * @param[in] source The given timer event source
1377  * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1378  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1379  */
1380 tdm_error
1381 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1382
1383 /**
1384  * @brief Remove the given event source
1385  * @param[in] source The given event source
1386  * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1387  */
1388 void
1389 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1390
1391 /**
1392  * @brief Trigger a 'need to validate' event.
1393  * @param[in] output The output the event should be triggered for.
1394  * @note The global display lock has to be locked before the call to this function.
1395  * @see #tdm_output_hwc_set_need_validate_handler
1396  * @since 2.0.0
1397  */
1398 tdm_error
1399 tdm_backend_trigger_need_validate_event(tdm_output *output);
1400
1401 #ifdef __cplusplus
1402 }
1403 #endif
1404
1405 #endif /* _TDM_BACKEND_H_ */