include/tdm_backend.h

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