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