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 *(*display_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          * @param[out] sync A flag for sync call
 548          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 549          * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
 550          * @since 1.7.0
 551          */
 552         tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value, int *sync);
 553
 554         /**
 555          * @brief Get a hwc object of a output object
 556          * @param[in] output A output object
 557          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 558          * @return A hwc object
 559          */
 560         tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
 561
 562         /**
 563          * @brief Set the mirror image of the src_output to the output
 564          * @details This function set the mirro image of the src_output to the output.
 565          * If there is the hardware or the implementation to display the mirror image
 566          * of the src_output to the output, the backend does it in this function.
 567          * If the backend output gets the ability of the mirror displaying, it has to
 568          * set the TDM_OUTPUT_CAPABILITY_MIRROR on the output capability.
 569          * @param[in] output A output object to display the src_output image
 570          * @param[in] src_output A src output object of which image is displayed on the output
 571          * @param[in] transform A transform value
 572          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 573          * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
 574          */
 575         tdm_error (*output_set_mirror)(tdm_output *output,
 576                                                                         tdm_output *src_output,
 577                                                                         tdm_transform transform);
 578         /**
 579          * @brief Unset the mirror image
 580          * @details This function unset the mirro image of the output.
 581          * @param[in] output A output object to display the src_output image
 582          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 583          * @see #output_set_mirror, #TDM_OUTPUT_CAPABILITY_MIRROR
 584          */
 585         tdm_error (*output_unset_mirror)(tdm_output *output);
 586
 587         void (*reserved4)(void);
 588         void (*reserved5)(void);
 589         void (*reserved6)(void);
 590         void (*reserved7)(void);
 591         void (*reserved8)(void);
 592 } tdm_func_output;
 593
 594 typedef struct _tdm_func_voutput {
 595         /**
 596          * @brief Destroy a virtual output object of a backend module
 597          * @param[in] voutput The voutput object
 598          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 599          * @see display_voutput_create() function
 600          * @remark
 601          * A backend module doesn't need to implement this function if doesn't support virtual output.
 602          */
 603         tdm_error (*voutput_destroy)(tdm_voutput *voutput);
 604
 605         /**
 606          * @brief Set available modes of a virtual output object
 607          * @param[in] voutput A voutput object
 608          * @param[in] modes Modes of voutput
 609          * @param[in] count A count of modes
 610          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 611          * @remark
 612          * A backend module doesn't need to implement this function if doesn't support virtual output.
 613          */
 614         tdm_error (*voutput_set_available_mode)(tdm_voutput *voutput, const tdm_output_mode *modes, int count);
 615
 616         /**
 617          * @brief Set physical size(mm) of a virtual output object
 618          * @param[in] voutput A voutput object
 619          * @param[in] mmwidth Width of voutput
 620          * @param[in] mmheight Height of voutput
 621          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 622          * @remark
 623          * A backend module doesn't need to implement this function if doesn't support virtual output.
 624          */
 625         tdm_error (*voutput_set_physical_size)(tdm_voutput *voutput, unsigned int mmwidth, unsigned int mmheight);
 626
 627         /**
 628          * @brief Set connect status of a virtual output object
 629          * @param[in] voutput A voutput object
 630          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 631          * @remark
 632          * A backend module doesn't need to implement this function if doesn't support virtual output.
 633          */
 634         tdm_error (*voutput_connect)(tdm_voutput *voutput);
 635
 636         /**
 637          * @brief Set disconnect status of a virtual output object
 638          * @param[in] voutput A voutput object
 639          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 640          * @remark
 641          * A backend module doesn't need to implement this function if doesn't support virtual output.
 642          */
 643         tdm_error (*voutput_disconnect)(tdm_voutput *voutput);
 644
 645         /**
 646          * @brief Get output object from virtual output object
 647          * @param[in] voutput A voutput object
 648          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 649          * @return A tdm_output object
 650          * @remark
 651          * A backend module doesn't need to implement this function if doesn't support virtual output.
 652          */
 653         tdm_output *(*voutput_get_output)(tdm_voutput *voutput, tdm_error *error);
 654
 655         /**
 656          * @brief Set a user commit function
 657          * @param[in] voutput A voutput object
 658          * @param[in] func A user voutput commit function
 659          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 660          * @remark
 661          * A backend module doesn't need to implement this function if doesn't support virtual output.
 662          * If virtual output's output_commit is executed, call this voutput commit func.
 663          */
 664         tdm_error (*voutput_set_commit_func)(tdm_voutput *voutput, tdm_voutput_commit_handler commit_func);
 665
 666         /**
 667          * @brief Notify commit done to backend
 668          * @param[in] voutput A voutput object
 669          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 670          * @remark
 671          * A backend module doesn't need to implement this function if doesn't support virtual output.
 672          */
 673         tdm_error (*voutput_commit_done)(tdm_voutput *voutput);
 674
 675         void (*reserved1)(void);
 676         void (*reserved2)(void);
 677         void (*reserved3)(void);
 678         void (*reserved4)(void);
 679         void (*reserved5)(void);
 680         void (*reserved6)(void);
 681 } tdm_func_voutput;
 682 /**
 683  * @brief The layer functions for a backend module.
 684  */
 685 typedef struct _tdm_func_layer {
 686         /**
 687          * @brief Get the capabilities of a layer object
 688          * @param[in] layer A layer object
 689          * @param[out] caps The capabilities of a layer object
 690          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 691          * @remark
 692          * A backend module @b SHOULD implement this function. TDM calls this function
 693          * not only at the initial time, but also at the update time when new output
 694          * is connected.\n
 695          * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
 696          */
 697         tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
 698
 699         /**
 700          * @brief Set the property which has a given id.
 701          * @param[in] layer A layer object
 702          * @param[in] id The property id
 703          * @param[in] value The value
 704          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 705          */
 706         tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
 707                                                                         tdm_value value);
 708
 709         /**
 710          * @brief Get the property which has a given id.
 711          * @param[in] layer A layer object
 712          * @param[in] id The property id
 713          * @param[out] value The value
 714          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 715          */
 716         tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
 717                                                                         tdm_value *value);
 718
 719         /**
 720          * @brief Set the geometry information to a layer object
 721          * @param[in] layer A layer object
 722          * @param[in] info The geometry information
 723          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 724          * @see output_commit() function of #tdm_func_output
 725          * @remark
 726          * A backend module would apply the geometry information when the output object
 727          * of a layer object is committed.
 728          */
 729         tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
 730
 731         /**
 732          * @brief Get the geometry information to a layer object
 733          * @param[in] layer A layer object
 734          * @param[out] info The geometry information
 735          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 736          */
 737         tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
 738
 739         /**
 740          * @brief Set a TDM buffer to a layer object
 741          * @param[in] layer A layer object
 742          * @param[in] buffer A TDM buffer
 743          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 744          * @see output_commit() function of #tdm_func_output
 745          * @remark
 746          * A backend module would show a TDM buffer on screen when the output object
 747          * of a layer object is committed.
 748          */
 749         tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
 750
 751         /**
 752          * @brief Unset a TDM buffer from a layer object
 753          * @param[in] layer A layer object
 754          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 755          * @remark
 756          * A backend module @b SHOULD remove the current showing buffer from screen.
 757          */
 758         tdm_error (*layer_unset_buffer)(tdm_layer *layer);
 759
 760         /**
 761          * @brief Set the zpos for a VIDEO layer object
 762          * @param[in] layer A layer object
 763          * @param[in] zpos z-order
 764          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 765          * @see tdm_caps_layer, tdm_layer_capability
 766          * @remark
 767          * A backend module doesn't need to implement this function if a backend
 768          * module doesn't have VIDEO layers.\n
 769          * This function is for VIDEO layers.
 770          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
 771          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
 772          * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
 773          * is less than GRAPHIC layers or more than GRAPHIC layers.
 774          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 775          * The zpos of VIDEO layers is @b relative. It doesn't need to start
 776          * from -1 or 4. Let's suppose that there are two VIDEO layers.
 777          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
 778          * than -4 VIDEO layer.
 779          */
 780         tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
 781
 782         /**
 783          * @brief Create a capture object of a layer object
 784          * @param[in] output A output object
 785          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 786          * @return A capture object
 787          * @see capture_destroy() function of #tdm_func_capture
 788          * @remark
 789          * A backend module doesn't need to implement this function if a hardware
 790          * doesn't have the capture device.
 791          */
 792         tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
 793
 794         /**
 795          * @brief Get buffer flags which the layer can support.
 796          * @param[in] layer A layer object
 797          * @param[out] flags The buffer flags which should be the tbm_bo flags
 798          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 799          */
 800         tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
 801
 802         void (*reserved1)(void);
 803         void (*reserved2)(void);
 804         void (*reserved3)(void);
 805         void (*reserved4)(void);
 806         void (*reserved5)(void);
 807         void (*reserved6)(void);
 808         void (*reserved7)(void);
 809 } tdm_func_layer;
 810
 811 typedef struct _tdm_func_hwc {
 812         /**
 813          * @brief Create a new window on the given hwc.
 814          * @param[in] hwc A hwc object
 815          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 816          * @return A created window object
 817          * @since 2.0.0
 818          */
 819         tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
 820
 821         /**
 822          * @brief Get video the supported format array for the hwc windows of a hwc object.
 823          * @param[in] hwc A hwc object
 824          * @param[out] formats The available format array
 825          * @param[out] count The count of formats
 826          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 827          */
 828         tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
 829                                                                                 int *count);
 830         /**
 831          * @brief Get the available video property array  of a hwc object.
 832          * @param[in] hwc A hwc object
 833          * @param[out] props The available video property array
 834          * @param[out] count The count of video properties
 835          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 836          */
 837         tdm_error (*hwc_get_video_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
 838                                                                                 int *count);
 839
 840         /**
 841          * @brief Get the hwc capabilities
 842          * @param[in] hwc A hwc object
 843          * @param[out] capabilities A hwc hwc capability
 844          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 845          */
 846         tdm_error (*hwc_get_capabilities)(tdm_hwc *hwc, tdm_hwc_capability *capabilities);
 847
 848         /**
 849          * @brief Get the available property array  of a hwc object.
 850          * @param[in] hwc A hwc object
 851          * @param[out] props The available property array
 852          * @param[out] count The count of properties
 853          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 854          */
 855         tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
 856                                                                                 int *count);
 857
 858         /**
 859          * @brief Get a target buffer queue
 860          * @param[in] hwc A hwc object
 861          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 862          * @return A buffer queue
 863          * @since 2.0.0
 864          */
 865         tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
 866                                                                                                                 tdm_error *error);
 867
 868         /**
 869          * @brief Set the client(relative to the TDM) target buffer
 870          * @details This function lets the backend know the target buffer.
 871          * The target buffer contains the result of the gl composition with the
 872          * tdm_hwc_windows which marked as TDM_HWC_WIN_COMPOSITION_CLIENT.
 873          * @param[in] hwc A hwc object
 874          * @param[in] target_buffer The new target buffer
 875          * @param[in] damage The buffer damage region
 876          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 877          * @since 2.0.0
 878          */
 879         tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
 880                                                                                           tbm_surface_h target_buffer,
 881                                                                                           tdm_region damage);
 882
 883         /**
 884          * @brief Validate the hwc
 885          * @details Instructs the backend to inspect all of the hw layer state and
 886          * determine if there are any composition type changes necessary before
 887          * presenting the hwc.
 888          * @param[in] hwc A hwc object
 889          * @param[in] composited_wnds the hwc window list which is visible.
 890          * @param[in] num_wnds the number of the visible windows in the composited_wnds
 891          * @param[out] num_types The number of composition type changes
 892          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 893          * @remark
 894          * The backend has to return the num_types when the assgined comopsite types of
 895          * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
 896          * 0, the cleint must get the changed composite types of the tdm_hwc_windows
 897          * and change the comopsite types
 898          * @since 2.0.0
 899          */
 900         tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
 901                                                           uint32_t num_wnds, uint32_t *num_types);
 902
 903         /**
 904          * @brief Get changed composition types
 905          * @details Retrieves the windows for which the backend requires a different
 906          * composition types that had been set prior to the last call to tdm_hwc_validate().
 907          * The client will either update its state with these types and call
 908          * tdm_hwc_accept_validation, or will set new types and attempt to validate the
 909          * display again. The number of elements returned must be the same as the
 910          * value returned in num_types from the last call to tdm_hwc_validate().
 911          * @param[in] hwc A hwc object
 912          * @param[out] num_elements the number of hwc_windows
 913          * @param[out] windows An array of windows
 914          * @param[out] composition_types An array of composition types, each corresponding
 915          * to an element of windows
 916          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 917          * @since 2.0.0
 918          */
 919         tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
 920                                                                                                    tdm_hwc_window **hwc_window,
 921                                                                                                    tdm_hwc_window_composition *composition_types);
 922         /**
 923          * @brief Accepts the validation required by the backend
 924          * @details Accepts the validation required by the backend from the previous
 925          * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
 926          * @param[in] hwc A hwc object
 927          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 928          * @since 2.0.0
 929          */
 930         tdm_error (*hwc_accept_validation)(tdm_hwc *hwc);
 931
 932         /**
 933          * @brief Commit changes for a hwc object
 934          * @param[in] hwc A hwc object
 935          * @param[in] sync 0: asynchronous, 1:synchronous
 936          * @param[in] user_data The user data
 937          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 938          * @see hwc_set_commit_handler, tdm_hwc_commit_handler
 939          * @remark
 940          * When this function is called, a backend module @b SHOULD apply the all
 941          * changes of the given hwc object to screen as well as the layer changes
 942          * of this hwc.
 943          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 944          * a user commit handler with the user data of this function after all
 945          * changes of the given hwc object are applied.
 946          */
 947         tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
 948
 949         /**
 950          * @brief Set a user commit handler
 951          * @param[in] hwc A hwc object
 952          * @param[in] func A user commit handler
 953          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 954          */
 955         tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
 956
 957         /**
 958          * @brief Set the property which has a given id on the hwc object.
 959          * @param[in] hwc A hwc object
 960          * @param[in] id The property id
 961          * @param[in] value The value of the propery id
 962          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 963          */
 964         tdm_error (*hwc_set_property)(tdm_hwc *hwc, uint32_t id, tdm_value value);
 965
 966         /**
 967          * @brief Get the property which has a given id on the hwc object.
 968          * @param[in] hwc A hwc object
 969          * @param[in] id The property id
 970          * @param[in] value The value of the propery id
 971          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 972          */
 973         tdm_error (*hwc_get_property)(tdm_hwc *hwc, uint32_t id, tdm_value *value);
 974 } tdm_func_hwc;
 975
 976 /**
 977  * @brief The window functions for a backend module.
 978  * @since 2.0.0
 979  */
 980 typedef struct _tdm_func_hwc_window {
 981         /**
 982          * @brief Destroys the given window.
 983          * @param[in] window the pointer of the window to destroy
 984          * @since 2.0.0
 985          */
 986         void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
 987
 988         /**
 989          * @brief Acquire a buffer queue for the window object
 990          * @details These buffers are used to composite by hardware a client content in
 991          * the nocomp mode.
 992          * @param[in] hwc_window A window object
 993          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 994          * @return A buffer queue
 995          */
 996         tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
 997                                                                                                                    tdm_error *error);
 998
 999         /**
1000          * @brief Release a buffer queue for the window object
1001          * @details Release buffer queue when the client no longer uses buferrs of queue.
1002          * @param[in] hwc_window A window object
1003          * @param[in] A tbm buffer queue
1004          */
1005         void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
1006                                                                                         tbm_surface_queue_h queue);
1007
1008         /**
1009          * @brief Sets the desired composition type of the given window.
1010          * @details During hwc_validate(), the backend may request changes to
1011          * the composition types of any of the layers as described in the definition
1012          * of tdm_hwc_window_composition_t above.
1013          * @param[in] hwc_window A window object
1014          * @param[in] composition_type The new composition type
1015          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1016          */
1017         tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
1018                                                                                                  tdm_hwc_window_composition composition_type);
1019
1020         /**
1021          * @brief Set the buffer damage
1022          * @details Provides the region of the source buffer which has been modified
1023          * since the last frame. This region does not need to be validated before
1024          * calling hwc_commit().
1025          * Once set through this function, the damage region remains the same until a
1026          * subsequent call to this function.
1027          * If damage.num_rects > 0, then it may be assumed that any portion of the source
1028          * buffer not covered by one of the rects has not been modified this frame. If
1029          * damage.num_rects == 0, then the whole source buffer must be treated as if it
1030          * has been modified.
1031          * If the layer's contents are not modified relative to the prior frame, damage
1032          * will contain exactly one empty rect([0, 0, 0, 0]).
1033          * The damage rects are relative to the pre-transformed buffer, and their origin
1034          * is the top-left corner. They will not exceed the dimensions of the latched
1035          * buffer.
1036          * @param[in] hwc_window A window object
1037          * @param[in] damage The new buffer damage region
1038          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1039          */
1040         tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
1041                                                                                           tdm_region damage);
1042
1043         /**
1044          * @brief Set the information to a window object
1045          * @details The information will be applied when the hwc object is committed.
1046          * @param[in] hwc_window A window object
1047          * @param[in] info The geometry information
1048          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1049          */
1050         tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
1051                                                                          tdm_hwc_window_info *info);
1052
1053         /**
1054          * @brief Set a TDM buffer to a window object
1055          * @details A TDM buffer will be applied when the hwc object
1056          * of a layer object is committed.
1057          * @param[in] hwc_window A window object
1058          * @param[in] buffer A TBM buffer
1059          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1060          */
1061         tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
1062                                                                            tbm_surface_h buffer);
1063
1064         /**
1065          * @brief Set the property which has a given id.
1066          * @param[in] hwc_window  A hwc window object
1067          * @param[in] id The property id
1068          * @param[in] value The value of the propery id
1069          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1070          */
1071         tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
1072                                                                                  uint32_t id, tdm_value value);
1073
1074         /**
1075          * @brief Get the property which has a given id.
1076          * @param[in] hwc_window A hwc window object
1077          * @param[in] id The property id
1078          * @param[out] value The value of the propery id
1079          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1080          */
1081         tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
1082                                                                                  uint32_t id, tdm_value *value);
1083
1084         /**
1085          * @brief Get the constraints of hwc_window
1086          * @param[in] hwc_window A hwc window object
1087          * @param[out] constraints The tdm_hwc_window_constraint types
1088          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1089          */
1090         tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
1091                                                                                                 int *constraints);
1092
1093         /**
1094          * @brief Set the name of hwc_window
1095          * @param[in] hwc_window A hwc window object
1096          * @param[in] name of the hwc_window
1097          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1098          */
1099         tdm_error (*hwc_window_set_name)(tdm_hwc_window *hwc_window,
1100                                                                                                 const char *name);
1101
1102         /**
1103          * @brief Get buffer flags of cursor hwc_window
1104          * @param[in] hwc_window A hwc window object
1105          * @param[in] width of the cursor image
1106          * @param[in] height of the cursor image
1107          * @param[in] stride of the cursor image
1108          * @param[in] virtual address of the cursor image
1109          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1110          */
1111         tdm_error (*hwc_window_set_cursor_image)(tdm_hwc_window *hwc_window,
1112                                                                 int width, int height, int stride, void *ptr);
1113 } tdm_func_hwc_window;
1114
1115 /**
1116  * @brief The pp functions for a backend module.
1117  */
1118 typedef struct _tdm_func_pp {
1119         /**
1120          * @brief Destroy a pp object
1121          * @param[in] pp A pp object
1122          * @see display_create_pp() function of #tdm_func_display
1123          */
1124         void (*pp_destroy)(tdm_pp *pp);
1125
1126         /**
1127          * @brief Set the geometry information to a pp object
1128          * @param[in] pp A pp object
1129          * @param[in] info The geometry information
1130          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1131          * @see pp_commit() function of #tdm_func_pp
1132          * @remark
1133          * A backend module would apply the geometry information when committed.
1134          */
1135         tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
1136
1137         /**
1138          * @brief Attach a source buffer and a destination buffer to a pp object
1139          * @param[in] pp A pp object
1140          * @param[in] src A source buffer
1141          * @param[in] dst A destination buffer
1142          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1143          * @see pp_set_info() function of #tdm_func_pp
1144          * @see pp_commit() function of #tdm_func_pp
1145          * @see pp_set_done_handler, tdm_pp_done_handler
1146          * @remark
1147          * A backend module converts the image of a source buffer to a destination
1148          * buffer when committed. The size/crop/transform information is set via
1149          * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
1150          * return the source/destination buffer via tdm_pp_done_handler.
1151          */
1152         tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
1153
1154         /**
1155          * @brief Commit changes for a pp object
1156          * @param[in] pp A pp object
1157          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1158          */
1159         tdm_error (*pp_commit)(tdm_pp *pp);
1160
1161         /**
1162          * @brief Set a user done handler to a pp object
1163          * @param[in] pp A pp object
1164          * @param[in] func A user done handler
1165          * @param[in] user_data user data
1166          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1167          * @remark
1168          * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1169          */
1170         tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1171                                                                          void *user_data);
1172
1173         void (*reserved1)(void);
1174         void (*reserved2)(void);
1175         void (*reserved3)(void);
1176         void (*reserved4)(void);
1177         void (*reserved5)(void);
1178         void (*reserved6)(void);
1179         void (*reserved7)(void);
1180         void (*reserved8)(void);
1181 } tdm_func_pp;
1182
1183 /**
1184  * @brief The capture functions for a backend module.
1185  */
1186 typedef struct _tdm_func_capture {
1187         /**
1188          * @brief Destroy a capture object
1189          * @param[in] capture A capture object
1190          * @see output_create_capture() function of #tdm_func_output
1191          * @see layer_create_capture() function of #tdm_func_layer
1192          */
1193         void (*capture_destroy)(tdm_capture *capture);
1194
1195         /**
1196          * @brief Set the geometry information to a capture object
1197          * @param[in] capture A capture object
1198          * @param[in] info The geometry information
1199          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1200          * @see capture_commit() function of #tdm_func_capture
1201          * @remark
1202          * A backend module would apply the geometry information when committed.
1203          */
1204         tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1205
1206         /**
1207          * @brief Attach a TDM buffer to a capture object
1208          * @details When capture_commit() function is called, a backend module starts
1209          * to dump a output or a layer to a TDM buffer.
1210          * @param[in] capture A capture object
1211          * @param[in] buffer A TDM buffer
1212          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1213          * @see capture_set_info() function of #tdm_func_capture
1214          * @see capture_commit() function of #tdm_func_capture
1215          * @see capture_set_done_handler, tdm_capture_done_handler
1216          * @remark
1217          * A backend module starts to dump a output or a layer to to a TDM buffer when
1218          * committed. The size/crop/transform information is set via #capture_set_info()
1219          * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1220          * buffer via tdm_capture_done_handler.
1221          */
1222         tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1223
1224         /**
1225          * @brief Commit changes for a capture object
1226          * @param[in] capture A capture object
1227          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1228          */
1229         tdm_error (*capture_commit)(tdm_capture *capture);
1230
1231         /**
1232          * @brief Set a user done handler to a capture object
1233          * @param[in] capture A capture object
1234          * @param[in] func A user done handler
1235          * @param[in] user_data user data
1236          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1237          * @remark
1238          * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1239          */
1240         tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1241                                                                                   tdm_capture_done_handler func, void *user_data);
1242
1243         void (*reserved1)(void);
1244         void (*reserved2)(void);
1245         void (*reserved3)(void);
1246         void (*reserved4)(void);
1247         void (*reserved5)(void);
1248         void (*reserved6)(void);
1249         void (*reserved7)(void);
1250         void (*reserved8)(void);
1251 } tdm_func_capture;
1252
1253 /**
1254  * @brief The tdm event source
1255  */
1256 typedef void tdm_event_loop_source;
1257
1258 /**
1259  * @brief The fd source handler
1260  */
1261 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1262
1263 /**
1264  * @brief The timer source handler
1265  */
1266 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1267
1268 #define TDM_BACKEND_MINOR_VERSION_MASK  0x0000FFFF
1269 #define TDM_BACKEND_MAJOR_VERSION_MASK  0xFFFF0000
1270 #define TDM_BACKEND_GET_ABI_MINOR(v)    ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1271 #define TDM_BACKEND_GET_ABI_MAJOR(v)    (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1272
1273 /**
1274  * @brief
1275  * The ABI version of TDM backend module. It has a major and minor revision.
1276  * Modules using lower minor revisions will work with TDM frontend of a higher
1277  * minor revision. There is no compatibility between different major revisions.
1278  * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1279  * @par Example
1280  * @code
1281  *  tdm_backend_module tdm_backend_module_data = {
1282  *      "drm",
1283  *      "Samsung",
1284  *      TDM_BACKEND_SET_ABI_VERSION(1,1),
1285  *      tdm_drm_init,
1286  *      tdm_drm_deinit
1287  *  };
1288  * @endcode
1289  */
1290 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1291         (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1292         ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1293
1294
1295 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1296 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1297 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi  */
1298
1299 /**
1300  * @brief
1301  * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1302  * @deprecated
1303  * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1304  */
1305 #define TDM_BACKEND_ABI_VERSION     TDM_BACKEND_SET_ABI_VERSION(1, 1)
1306
1307 /**
1308  * @brief The backend module information of the entry point to initialize a TDM
1309  * backend module.
1310  * @remark
1311  * A backend module @b SHOULD define the global data symbol of which name is
1312  * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1313  * at the initial time and call init() function of #tdm_backend_module.
1314  */
1315 typedef struct _tdm_backend_module {
1316         const char *name;           /**< The module name of a backend module */
1317         const char *vendor;         /**< The vendor name of a backend module */
1318         unsigned long abi_version;  /**< The ABI version of a backend module */
1319
1320         /**
1321          * @brief The init function of a backend module
1322          * @param[in] dpy A display object
1323          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1324          * @return The backend module data
1325          * @see tdm_backend_data
1326          */
1327         tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1328
1329         /**
1330          * @brief The deinit function of a backend module
1331          * @param[in] bdata The backend module data
1332          */
1333         void (*deinit)(tdm_backend_data *bdata);
1334 } tdm_backend_module;
1335
1336 /**
1337  * @brief Register the backend display functions to a display
1338  * @param[in] dpy A display object
1339  * @param[in] func_display display functions
1340  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1341  * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1342  * @remarks
1343  * A backend module @b SHOULD set the backend display functions at least.
1344  */
1345 tdm_error
1346 tdm_backend_register_func_display(tdm_display *dpy,
1347                                                                   tdm_func_display *func_display);
1348
1349 /**
1350  * @brief Register the backend output functions to a display
1351  * @param[in] dpy A display object
1352  * @param[in] func_output output functions
1353  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1354  * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1355  * @remarks
1356  * A backend module @b SHOULD set the backend output functions at least.
1357  */
1358 tdm_error
1359 tdm_backend_register_func_output(tdm_display *dpy,
1360                                                                  tdm_func_output *func_output);
1361
1362 /**
1363  * @brief Register the backend voutput functions to a display
1364  * @param[in] dpy A display object
1365  * @param[in] func_voutput voutput functions
1366  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1367  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1368  * @remarks
1369  * A backend module doesn't need to implement this function if doesn't support virtual output.
1370  */
1371 tdm_error
1372 tdm_backend_register_func_voutput(tdm_display *dpy, tdm_func_voutput *func_voutput);
1373
1374 /**
1375  * @brief Register the backend layer functions to a display
1376  * @param[in] dpy A display object
1377  * @param[in] func_layer layer 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 layer functions at least.
1382  */
1383 tdm_error
1384 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1385
1386 /**
1387  * @brief Register the backend hwc functions to a display
1388  * @param[in] dpy A display object
1389  * @param[in] func_hwc hwc functions
1390  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1391  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1392  * @remarks
1393  * A backend module @b SHOULD set the backend hwc functions at least.
1394  * @since 2.0.0
1395  */
1396 tdm_error
1397 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1398
1399 /**
1400  * @brief Register the backend hwc_window functions to a display
1401  * @param[in] dpy A display object
1402  * @param[in] func_hwc_window hwc_window functions
1403  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1404  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1405  * @remarks
1406  * A backend module @b SHOULD set the backend hwc_window functions at least.
1407  * @since 2.0.0
1408  */
1409 tdm_error
1410 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1411
1412 /**
1413  * @brief Register the backend pp functions to a display
1414  * @param[in] dpy A display object
1415  * @param[in] func_pp pp functions
1416  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1417  * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1418  * @remark
1419  * A backend module doesn'tcan skip to register the backend pp functions
1420  * if a hardware doesn't have the memory-to-memory converting device.
1421  */
1422 tdm_error
1423 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1424
1425 /**
1426  * @brief Register the backend capture functions to a display
1427  * @param[in] dpy A display object
1428  * @param[in] func_capture capture functions
1429  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1430  * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1431  * @remark
1432  * A backend module can skip to register the backend capture functions
1433  * if a hardware doesn't have the capture device.
1434  */
1435 tdm_error
1436 tdm_backend_register_func_capture(tdm_display *dpy,
1437                                                                   tdm_func_capture *func_capture);
1438
1439 /**
1440  * @brief Register the backend output to a display
1441  * @param[in] dpy A display object
1442  * @param[in] output A backend output object
1443  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1444  * @see tdm_backend_unregister_output
1445  */
1446 tdm_error
1447 tdm_backend_register_output(tdm_display *dpy, tdm_output *output);
1448
1449 /**
1450  * @brief Unregister the backend output to a display
1451  * @param[in] dpy A display object
1452  * @param[in] output A backend output object
1453  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1454  * @see tdm_backend_register_output
1455  */
1456 void
1457 tdm_backend_unregister_output(tdm_display *dpy, tdm_output *output);
1458
1459 /**
1460  * @brief Increase the ref_count of a TDM buffer
1461  * @details
1462  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1463  * becomes available for a next job. A TDM buffer can be used for TDM to show
1464  * it on screen or to capture an output and a layer. After all operations,
1465  * TDM will release it immediately when TDM doesn't need it any more.
1466  * @param[in] buffer A TDM buffer
1467  * @return A buffer itself. Otherwise, NULL.
1468  * @see tdm_buffer_unref_backend
1469  * @remark
1470  * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1471  * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1472  * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1473  */
1474 tbm_surface_h
1475 tdm_buffer_ref_backend(tbm_surface_h buffer);
1476
1477 /**
1478  * @brief Decrease the ref_count of a TDM buffer
1479  * @param[in] buffer A TDM buffer
1480  * @see tdm_buffer_ref_backend
1481  */
1482 void
1483 tdm_buffer_unref_backend(tbm_surface_h buffer);
1484
1485 /**
1486  * @brief The destroy handler of a TDM buffer
1487  * @param[in] buffer A TDM buffer
1488  * @param[in] user_data user data
1489  * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1490  */
1491 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1492                                                                                    void *user_data);
1493
1494 /**
1495  * @brief Add a destroy handler to a TDM buffer
1496  * @param[in] buffer A TDM buffer
1497  * @param[in] func A destroy handler
1498  * @param[in] user_data user data
1499  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1500  * @see tdm_buffer_remove_destroy_handler
1501  * @remark
1502  * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1503  * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1504  * be called.
1505  */
1506 tdm_error
1507 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1508                                                            tdm_buffer_destroy_handler func, void *user_data);
1509
1510 /**
1511  * @brief Remove a destroy handler from a TDM buffer
1512  * @param[in] buffer A TDM buffer
1513  * @param[in] func A destroy handler
1514  * @param[in] user_data user data
1515  * @see tdm_buffer_add_destroy_handler
1516  */
1517 void
1518 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1519                                                                   tdm_buffer_destroy_handler func, void *user_data);
1520
1521 /**
1522  * @brief Add a FD handler for activity on the given file descriptor
1523  * @param[in] dpy A display object
1524  * @param[in] fd A file descriptor
1525  * @param[in] mask to monitor FD
1526  * @param[in] func A FD handler function
1527  * @param[in] user_data user data
1528  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1529  * @return A FD event source
1530  * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1531  */
1532 tdm_event_loop_source*
1533 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1534                                                           tdm_event_loop_fd_handler func, void *user_data,
1535                                                           tdm_error *error);
1536
1537 /**
1538  * @brief Update the mask of the given FD event source
1539  * @param[in] source The given FD event source
1540  * @param[in] mask to monitor FD
1541  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1542  */
1543 tdm_error
1544 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1545
1546 /**
1547  * @brief Add a timer handler
1548  * @param[in] dpy A display object
1549  * @param[in] func A timer handler function
1550  * @param[in] user_data user data
1551  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1552  * @return A timer event source
1553  * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1554  */
1555 tdm_event_loop_source*
1556 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1557                                                                  void *user_data, tdm_error *error);
1558
1559 /**
1560  * @brief Update the millisecond delay time of the given timer event source.
1561  * @param[in] source The given timer event source
1562  * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1563  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1564  */
1565 tdm_error
1566 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1567
1568 /**
1569  * @brief Remove the given event source
1570  * @param[in] source The given event source
1571  * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1572  */
1573 void
1574 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1575
1576 /**
1577  * @brief Get the ini value with given key
1578  * @details
1579  * @param[in] key The given key
1580  * @param[in] default_value The default value
1581  * @return the value of given key if success. Otherwise, default_value.
1582  * @see #tdm_config_get_string
1583  */
1584 int
1585 tdm_config_get_int(const char *key, int default_value);
1586
1587 /**
1588  * @brief Get the ini value with given key
1589  * @details
1590  * @param[in] key The given key
1591  * @param[in] default_value The default value
1592  * @return the value of given key if success. Otherwise, default_value.
1593  * @see #tdm_config_get_int
1594  */
1595 const char *
1596 tdm_config_get_string(const char *key, const char *default_value);
1597
1598 #ifdef __cplusplus
1599 }
1600 #endif
1601
1602 #endif /* _TDM_BACKEND_H_ */