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
 154         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
 155
 156         unsigned int prop_count;        /**< The count of available properties */
 157         tdm_prop *props;                /**< The @b newly-allocated array of properties. will be freed in frontend. */
 158 } tdm_caps_layer;
 159
 160 /**
 161  * @brief The capabilities structure of a pp object
 162  * @see The display_get_pp_capability() function of #tdm_func_display
 163  */
 164 typedef struct _tdm_caps_pp {
 165         tdm_pp_capability capabilities; /**< The capabilities of pp */
 166
 167         unsigned int format_count;      /**< The count of available formats */
 168         tbm_format
 169         *formats;            /**< The @b newly-allocated array. will be freed in frontend. */
 170
 171         int min_w;              /**< The minimun width */
 172         int min_h;              /**< The minimun height */
 173         int max_w;              /**< The maximum width */
 174         int max_h;              /**< The maximum height */
 175         int preferred_align;    /**< The prefered align */
 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         void (*reserved1)(void);
 339         void (*reserved2)(void);
 340         void (*reserved3)(void);
 341         void (*reserved4)(void);
 342         void (*reserved5)(void);
 343         void (*reserved6)(void);
 344         void (*reserved7)(void);
 345         void (*reserved8)(void);
 346 } tdm_func_display;
 347
 348 /**
 349  * @brief The output functions for a backend module.
 350  */
 351 typedef struct _tdm_func_output {
 352         /**
 353          * @brief Get the capabilities of a output object
 354          * @param[in] output A output object
 355          * @param[out] caps The capabilities of a output object
 356          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 357          * @remark
 358          * A backend module @b SHOULD implement this function. TDM calls this function
 359          * not only at the initial time, but also at the update time when new output
 360          * is connected.\n
 361          * #tdm_caps_output contains connection status, modes, avaiable properties,
 362          * size restriction information, etc.
 363          */
 364         tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
 365
 366         /**
 367          * @brief Get a layer array of a output object
 368          * @param[in] output A output object
 369          * @param[out] count The count of layers
 370          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 371          * @return A layer array which is @b newly-allocated
 372          * @remark
 373          * A backend module @b SHOULD implement this function. TDM calls this function
 374          * not only at the initial time, but also at the update time when new output
 375          * is connected.\n
 376          * A backend module @b SHOULD return the @b newly-allocated array which contains
 377          * "tdm_layer*" data. It will be freed in frontend.
 378          */
 379         tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
 380                                                                          tdm_error *error);
 381
 382         /**
 383          * @brief Set the property which has a given id
 384          * @param[in] output A output object
 385          * @param[in] id The property id
 386          * @param[in] value The value
 387          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 388          */
 389         tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
 390                                                                          tdm_value value);
 391
 392         /**
 393          * @brief Get the property which has a given id
 394          * @param[in] output A output object
 395          * @param[in] id The property id
 396          * @param[out] value The value
 397          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 398          */
 399         tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
 400                                                                          tdm_value *value);
 401
 402         /**
 403          * @brief Wait for VBLANK
 404          * @param[in] output A output object
 405          * @param[in] interval vblank interval
 406          * @param[in] sync 0: asynchronous, 1:synchronous
 407          * @param[in] user_data The user data
 408          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 409          * @see output_set_vblank_handler, tdm_output_vblank_handler
 410          * @remark
 411          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 412          * a user vblank handler with the user data of this function after interval
 413          * vblanks.
 414          */
 415         tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
 416                                                                         void *user_data);
 417
 418         /**
 419          * @brief Set a user vblank handler
 420          * @param[in] output A output object
 421          * @param[in] func A user vblank handler
 422          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 423          */
 424         tdm_error (*output_set_vblank_handler)(tdm_output *output,
 425                                                                                    tdm_output_vblank_handler func);
 426
 427         /**
 428          * @brief Commit changes for a output object
 429          * @param[in] output A output object
 430          * @param[in] sync 0: asynchronous, 1:synchronous
 431          * @param[in] user_data The user data
 432          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 433          * @see output_set_commit_handler, tdm_output_commit_handler
 434          * @remark
 435          * When this function is called, a backend module @b SHOULD apply the all
 436          * changes of the given output object to screen as well as the layer changes
 437          * of this output.
 438          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 439          * a user commit handler with the user data of this function after all
 440          * changes of the given output object are applied.
 441          */
 442         tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
 443
 444         /**
 445          * @brief Set a user commit handler
 446          * @param[in] output A output object
 447          * @param[in] func A user commit handler
 448          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 449          */
 450         tdm_error (*output_set_commit_handler)(tdm_output *output,
 451                                                                                    tdm_output_commit_handler func);
 452
 453         /**
 454          * @brief Set DPMS of a output object synchronously
 455          * @param[in] output A output object
 456          * @param[in] dpms_value DPMS value
 457          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 458          */
 459         tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
 460
 461         /**
 462          * @brief Get DPMS of a output object
 463          * @param[in] output A output object
 464          * @param[out] dpms_value DPMS value
 465          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 466          */
 467         tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
 468
 469         /**
 470          * @brief Set one of available modes of a output object
 471          * @param[in] output A output object
 472          * @param[in] mode A output mode
 473          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 474          */
 475         tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
 476
 477         /**
 478          * @brief Get the mode of a output object
 479          * @param[in] output A output object
 480          * @param[out] mode A output mode
 481          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 482          */
 483         tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
 484
 485         /**
 486          * @brief Create a capture object of a output object
 487          * @param[in] output A output object
 488          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 489          * @return A capture object
 490          * @see capture_destroy() function of #tdm_func_capture
 491          * @remark
 492          * A backend module doesn't need to implement this function if a hardware
 493          * doesn't have the capture device.
 494          */
 495         tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
 496
 497         /**
 498          * @brief Set a output connection status handler
 499          * @details A backend module need to call the output status handler when the
 500          * output connection status has been changed to let the TDM frontend know
 501          * the change.
 502          * @param[in] output A output object
 503          * @param[in] func A output status handler
 504          * @param[in] user_data The user data
 505          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 506          * @since 1.1.0
 507          */
 508         tdm_error (*output_set_status_handler)(tdm_output *output,
 509                                                                                    tdm_output_status_handler func,
 510                                                                                    void *user_data);
 511
 512         /**
 513          * @brief Set a output dpms handler
 514          * @details This function can be NULL if an output doesn't support asynchronous
 515          * DPMS control. Otherwise, a backend module needs to call the output dpms handler
 516          * to let the TDM frontend know the output DPMS change indeed.
 517          * @param[in] output A output object
 518          * @param[in] func A output dpms handler
 519          * @param[in] user_data The user data
 520          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 521          * @see #output_set_dpms_async, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
 522          * @since 1.4.0
 523          */
 524         tdm_error (*output_set_dpms_handler)(tdm_output *output,
 525                                                                                  tdm_output_dpms_handler func,
 526                                                                                  void *user_data);
 527
 528         /**
 529          * @brief Set DPMS of a output object asynchronously
 530          * @param[in] output A output object
 531          * @details This function can be NULL if an output doesn't support asynchronous
 532          * DPMS control. Otherwise, an output should have #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
 533          * flags which #output_get_capability returns. And if a output dpms handler is added with
 534          * #output_set_dpms_handler, a backend module needs to call the output dpms handler
 535          * to let the TDM frontend know the output DPMS change indeed.
 536          * @param[in] dpms_value DPMS value
 537          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 538          * @see #output_set_dpms_handler, #TDM_OUTPUT_CAPABILITY_ASYNC_DPMS
 539          * @since 1.7.0
 540          */
 541         tdm_error (*output_set_dpms_async)(tdm_output *output, tdm_output_dpms dpms_value);
 542
 543         /**
 544          * @brief Get a hwc object of a output object
 545          * @param[in] output A output object
 546          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 547          * @return A hwc object
 548          */
 549         tdm_hwc *(*output_get_hwc)(tdm_output *output, tdm_error *error);
 550
 551         void (*reserved5)(void);
 552         void (*reserved6)(void);
 553         void (*reserved7)(void);
 554         void (*reserved8)(void);
 555 } tdm_func_output;
 556
 557 /**
 558  * @brief The layer functions for a backend module.
 559  */
 560 typedef struct _tdm_func_layer {
 561         /**
 562          * @brief Get the capabilities of a layer object
 563          * @param[in] layer A layer object
 564          * @param[out] caps The capabilities of a layer object
 565          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 566          * @remark
 567          * A backend module @b SHOULD implement this function. TDM calls this function
 568          * not only at the initial time, but also at the update time when new output
 569          * is connected.\n
 570          * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
 571          */
 572         tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
 573
 574         /**
 575          * @brief Set the property which has a given id.
 576          * @param[in] layer A layer object
 577          * @param[in] id The property id
 578          * @param[in] value The value
 579          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 580          */
 581         tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
 582                                                                         tdm_value value);
 583
 584         /**
 585          * @brief Get the property which has a given id.
 586          * @param[in] layer A layer object
 587          * @param[in] id The property id
 588          * @param[out] value The value
 589          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 590          */
 591         tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
 592                                                                         tdm_value *value);
 593
 594         /**
 595          * @brief Set the geometry information to a layer object
 596          * @param[in] layer A layer object
 597          * @param[in] info The geometry information
 598          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 599          * @see output_commit() function of #tdm_func_output
 600          * @remark
 601          * A backend module would apply the geometry information when the output object
 602          * of a layer object is committed.
 603          */
 604         tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
 605
 606         /**
 607          * @brief Get the geometry information to a layer object
 608          * @param[in] layer A layer object
 609          * @param[out] info The geometry information
 610          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 611          */
 612         tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
 613
 614         /**
 615          * @brief Set a TDM buffer to a layer object
 616          * @param[in] layer A layer object
 617          * @param[in] buffer A TDM buffer
 618          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 619          * @see output_commit() function of #tdm_func_output
 620          * @remark
 621          * A backend module would show a TDM buffer on screen when the output object
 622          * of a layer object is committed.
 623          */
 624         tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
 625
 626         /**
 627          * @brief Unset a TDM buffer from a layer object
 628          * @param[in] layer A layer object
 629          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 630          * @remark
 631          * A backend module @b SHOULD remove the current showing buffer from screen.
 632          */
 633         tdm_error (*layer_unset_buffer)(tdm_layer *layer);
 634
 635         /**
 636          * @brief Set the zpos for a VIDEO layer object
 637          * @param[in] layer A layer object
 638          * @param[in] zpos z-order
 639          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 640          * @see tdm_caps_layer, tdm_layer_capability
 641          * @remark
 642          * A backend module doesn't need to implement this function if a backend
 643          * module doesn't have VIDEO layers.\n
 644          * This function is for VIDEO layers.
 645          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
 646          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
 647          * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
 648          * is less than GRAPHIC layers or more than GRAPHIC layers.
 649          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 650          * The zpos of VIDEO layers is @b relative. It doesn't need to start
 651          * from -1 or 4. Let's suppose that there are two VIDEO layers.
 652          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
 653          * than -4 VIDEO layer.
 654          */
 655         tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
 656
 657         /**
 658          * @brief Create a capture object of a layer object
 659          * @param[in] output A output object
 660          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 661          * @return A capture object
 662          * @see capture_destroy() function of #tdm_func_capture
 663          * @remark
 664          * A backend module doesn't need to implement this function if a hardware
 665          * doesn't have the capture device.
 666          */
 667         tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
 668
 669         /**
 670          * @brief Get buffer flags which the layer can support.
 671          * @param[in] layer A layer object
 672          * @param[out] flags The buffer flags which should be the tbm_bo flags
 673          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 674          */
 675         tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
 676
 677         void (*reserved1)(void);
 678         void (*reserved2)(void);
 679         void (*reserved3)(void);
 680         void (*reserved4)(void);
 681         void (*reserved5)(void);
 682         void (*reserved6)(void);
 683         void (*reserved7)(void);
 684 } tdm_func_layer;
 685
 686 typedef struct _tdm_func_hwc {
 687         /**
 688          * @brief Create a new window on the given hwc.
 689          * @param[in] hwc A hwc object
 690          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 691          * @return A created window object
 692          * @since 2.0.0
 693          */
 694         tdm_hwc_window *(*hwc_create_window)(tdm_hwc *hwc, tdm_error *error);
 695
 696         /**
 697          * @brief Get video the supported format array for the hwc windows of a hwc object.
 698          * @param[in] hwc A hwc object
 699          * @param[out] formats The available format array
 700          * @param[out] count The count of formats
 701          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 702          */
 703         tdm_error (*hwc_get_video_supported_formats)(tdm_hwc *hwc, const tbm_format **formats,
 704                                                                                 int *count);
 705         /**
 706          * @brief Get the hwc video capability
 707          * @param[in] hwc A hwc object
 708          * @param[out] video_capability A hwc hwc video capability
 709          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 710          */
 711         tdm_error (*hwc_get_video_capability)(tdm_hwc *hwc,
 712                                                         tdm_hwc_video_capability *video_capability);
 713
 714         /**
 715          * @brief Get the available property array  of a hwc object.
 716          * @param[in] hwc A hwc object
 717          * @param[out] props The available property array
 718          * @param[out] count The count of properties
 719          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 720          */
 721         tdm_error (*hwc_get_available_properties)(tdm_hwc *hwc, const tdm_prop **props,
 722                                                                                 int *count);
 723
 724         /**
 725          * @brief Get a target buffer queue
 726          * @param[in] hwc A hwc object
 727          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 728          * @return A buffer queue
 729          * @since 2.0.0
 730          */
 731         tbm_surface_queue_h (*hwc_get_client_target_buffer_queue)(tdm_hwc *hwc,
 732                                                                                                                 tdm_error *error);
 733
 734         /**
 735          * @brief Set the client(relative to the TDM) target buffer
 736          * @details This function lets the backend know the target buffer.
 737          * The target buffer contains the result of the gl composition with the
 738          * tdm_hwc_windows which marked as TDM_COMPOSITION_CLIENT.
 739          * @param[in] hwc A hwc object
 740          * @param[in] target_buffer The new target buffer
 741          * @param[in] damage The buffer damage region
 742          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 743          * @since 2.0.0
 744          */
 745         tdm_error (*hwc_set_client_target_buffer)(tdm_hwc *hwc,
 746                                                                                           tbm_surface_h target_buffer,
 747                                                                                           tdm_region damage);
 748
 749         /**
 750          * @brief Validate the hwc
 751          * @details Instructs the backend to inspect all of the hw layer state and
 752          * determine if there are any composition type changes necessary before
 753          * presenting the hwc.
 754          * @param[in] hwc A hwc object
 755          * @param[in] composited_wnds the hwc window list which is visible.
 756          * @param[in] num_wnds the number of the visible windows in the composited_wnds
 757          * @param[out] num_types The number of composition type changes
 758          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 759          * @remark
 760          * The backend has to return the num_types when the assgined comopsite types of
 761          * the tdm_hwc_windows in the composited_wnds. If the num_types is greater than
 762          * 0, the cleint must get the changed composite types of the tdm_hwc_windows
 763          * and change the comopsite types
 764          * @since 2.0.0
 765          */
 766         tdm_error (*hwc_validate)(tdm_hwc *hwc, tdm_hwc_window **composited_wnds,
 767                                                           uint32_t num_wnds, uint32_t *num_types);
 768
 769         /**
 770          * @brief Get changed composition types
 771          * @details Retrieves the windows for which the backend requires a different
 772          * composition types that had been set prior to the last call to tdm_hwc_validate().
 773          * The client will either update its state with these types and call
 774          * tdm_hwc_accept_changes, or will set new types and attempt to validate the
 775          * display again. The number of elements returned must be the same as the
 776          * value returned in num_types from the last call to tdm_hwc_validate().
 777          * @param[in] hwc A hwc object
 778          * @param[out] num_elements the number of hwc_windows
 779          * @param[out] windows An array of windows
 780          * @param[out] composition_types An array of composition types, each corresponding
 781          * to an element of windows
 782          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 783          * @since 2.0.0
 784          */
 785         tdm_error (*hwc_get_changed_composition_types)(tdm_hwc *hwc, uint32_t *num_elements,
 786                                                                                                    tdm_hwc_window **hwc_window,
 787                                                                                                    tdm_hwc_window_composition *composition_types);
 788         /**
 789          * @brief Accepts the changes required by the backend
 790          * @details Accepts the changes required by the backend from the previous
 791          * tdm_hwc_validate() and tdm_hwc_get_chaged_composition_types().
 792          * @param[in] hwc A hwc object
 793          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 794          * @since 2.0.0
 795          */
 796         tdm_error (*hwc_accept_changes)(tdm_hwc *hwc);
 797
 798         /**
 799          * @brief Commit changes for a hwc object
 800          * @param[in] hwc A hwc object
 801          * @param[in] sync 0: asynchronous, 1:synchronous
 802          * @param[in] user_data The user data
 803          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 804          * @see hwc_set_commit_handler, tdm_hwc_commit_handler
 805          * @remark
 806          * When this function is called, a backend module @b SHOULD apply the all
 807          * changes of the given hwc object to screen as well as the layer changes
 808          * of this hwc.
 809          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 810          * a user commit handler with the user data of this function after all
 811          * changes of the given hwc object are applied.
 812          */
 813         tdm_error (*hwc_commit)(tdm_hwc *hwc, int sync, void *user_data);
 814
 815         /**
 816          * @brief Set a user commit handler
 817          * @param[in] hwc A hwc object
 818          * @param[in] func A user commit handler
 819          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 820          */
 821         tdm_error (*hwc_set_commit_handler)(tdm_hwc *hwc, tdm_hwc_commit_handler func);
 822 } tdm_func_hwc;
 823
 824 /**
 825  * @brief The window functions for a backend module.
 826  * @since 2.0.0
 827  */
 828 typedef struct _tdm_func_hwc_window {
 829         /**
 830          * @brief Destroys the given window.
 831          * @param[in] window the pointer of the window to destroy
 832          * @since 2.0.0
 833          */
 834         void (*hwc_window_destroy)(tdm_hwc_window *hwc_window);
 835
 836         /**
 837          * @brief Acquire a buffer queue for the window object
 838          * @details These buffers are used to composite by hardware a client content in
 839          * the nocomp mode.
 840          * @param[in] hwc_window A window object
 841          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 842          * @return A buffer queue
 843          */
 844         tbm_surface_queue_h (*hwc_window_acquire_buffer_queue)(tdm_hwc_window *hwc_window,
 845                                                                                                                    tdm_error *error);
 846
 847         /**
 848          * @brief Release a buffer queue for the window object
 849          * @details Release buffer queue when the client no longer uses buferrs of queue.
 850          * @param[in] hwc_window A window object
 851          * @param[in] A tbm buffer queue
 852          */
 853         void (*hwc_window_release_buffer_queue)(tdm_hwc_window *hwc_window,
 854                                                                                         tbm_surface_queue_h queue);
 855
 856         /**
 857          * @brief Sets the desired composition type of the given window.
 858          * @details During hwc_validate(), the backend may request changes to
 859          * the composition types of any of the layers as described in the definition
 860          * of tdm_hwc_window_composition_t above.
 861          * @param[in] hwc_window A window object
 862          * @param[in] composition_type The new composition type
 863          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 864          */
 865         tdm_error (*hwc_window_set_composition_type)(tdm_hwc_window *hwc_window,
 866                                                                                                  tdm_hwc_window_composition composition_type);
 867
 868         /**
 869          * @brief Set the buffer damage
 870          * @details Provides the region of the source buffer which has been modified
 871          * since the last frame. This region does not need to be validated before
 872          * calling hwc_commit().
 873          * Once set through this function, the damage region remains the same until a
 874          * subsequent call to this function.
 875          * If damage.num_rects > 0, then it may be assumed that any portion of the source
 876          * buffer not covered by one of the rects has not been modified this frame. If
 877          * damage.num_rects == 0, then the whole source buffer must be treated as if it
 878          * has been modified.
 879          * If the layer's contents are not modified relative to the prior frame, damage
 880          * will contain exactly one empty rect([0, 0, 0, 0]).
 881          * The damage rects are relative to the pre-transformed buffer, and their origin
 882          * is the top-left corner. They will not exceed the dimensions of the latched
 883          * buffer.
 884          * @param[in] hwc_window A window object
 885          * @param[in] damage The new buffer damage region
 886          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 887          */
 888         tdm_error (*hwc_window_set_buffer_damage)(tdm_hwc_window *hwc_window,
 889                                                                                           tdm_region damage);
 890
 891         /**
 892          * @brief Set the information to a window object
 893          * @details The information will be applied when the hwc object is committed.
 894          * @param[in] hwc_window A window object
 895          * @param[in] info The geometry information
 896          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 897          */
 898         tdm_error (*hwc_window_set_info)(tdm_hwc_window *hwc_window,
 899                                                                          tdm_hwc_window_info *info);
 900
 901         /**
 902          * @brief Get the geometry information to a layer object
 903          * @param[in] layer A layer object
 904          * @param[out] info The geometry information
 905          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 906          */
 907         tdm_error (*hwc_window_get_info)(tdm_hwc_window *hwc_window,
 908                                                                          tdm_hwc_window_info *info);
 909
 910         /**
 911          * @brief Set a TDM buffer to a window object
 912          * @details A TDM buffer will be applied when the hwc object
 913          * of a layer object is committed.
 914          * @param[in] hwc_window A window object
 915          * @param[in] buffer A TBM buffer
 916          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 917          */
 918         tdm_error (*hwc_window_set_buffer)(tdm_hwc_window *hwc_window,
 919                                                                            tbm_surface_h buffer);
 920
 921         /**
 922          * @brief Set the property which has a given id.
 923          * @param[in] hwc_window  A hwc window object
 924          * @param[in] id The property id
 925          * @param[in] value The value of the propery id
 926          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 927          */
 928         tdm_error (*hwc_window_set_property)(tdm_hwc_window *hwc_window,
 929                                                                                  uint32_t id, tdm_value value);
 930
 931         /**
 932          * @brief Get the property which has a given id.
 933          * @param[in] hwc_window A hwc window object
 934          * @param[in] id The property id
 935          * @param[out] value The value of the propery id
 936          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 937          */
 938         tdm_error (*hwc_window_get_property)(tdm_hwc_window *hwc_window,
 939                                                                                  uint32_t id, tdm_value *value);
 940
 941         /**
 942          * @brief Get the constraints of hwc_window
 943          * @param[in] hwc_window A hwc window object
 944          * @param[out] constraints The tdm_hwc_window_constraint types
 945          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 946          */
 947         tdm_error (*hwc_window_get_constraints)(tdm_hwc_window *hwc_window,
 948                                                                                                 int *constraints);
 949 } tdm_func_hwc_window;
 950
 951 /**
 952  * @brief The pp functions for a backend module.
 953  */
 954 typedef struct _tdm_func_pp {
 955         /**
 956          * @brief Destroy a pp object
 957          * @param[in] pp A pp object
 958          * @see display_create_pp() function of #tdm_func_display
 959          */
 960         void (*pp_destroy)(tdm_pp *pp);
 961
 962         /**
 963          * @brief Set the geometry information to a pp object
 964          * @param[in] pp A pp object
 965          * @param[in] info The geometry information
 966          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 967          * @see pp_commit() function of #tdm_func_pp
 968          * @remark
 969          * A backend module would apply the geometry information when committed.
 970          */
 971         tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
 972
 973         /**
 974          * @brief Attach a source buffer and a destination buffer to a pp object
 975          * @param[in] pp A pp object
 976          * @param[in] src A source buffer
 977          * @param[in] dst A destination buffer
 978          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 979          * @see pp_set_info() function of #tdm_func_pp
 980          * @see pp_commit() function of #tdm_func_pp
 981          * @see pp_set_done_handler, tdm_pp_done_handler
 982          * @remark
 983          * A backend module converts the image of a source buffer to a destination
 984          * buffer when committed. The size/crop/transform information is set via
 985          * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
 986          * return the source/destination buffer via tdm_pp_done_handler.
 987          */
 988         tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
 989
 990         /**
 991          * @brief Commit changes for a pp object
 992          * @param[in] pp A pp object
 993          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 994          */
 995         tdm_error (*pp_commit)(tdm_pp *pp);
 996
 997         /**
 998          * @brief Set a user done handler to a pp object
 999          * @param[in] pp A pp object
1000          * @param[in] func A user done handler
1001          * @param[in] user_data user data
1002          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1003          * @remark
1004          * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
1005          */
1006         tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
1007                                                                          void *user_data);
1008
1009         void (*reserved1)(void);
1010         void (*reserved2)(void);
1011         void (*reserved3)(void);
1012         void (*reserved4)(void);
1013         void (*reserved5)(void);
1014         void (*reserved6)(void);
1015         void (*reserved7)(void);
1016         void (*reserved8)(void);
1017 } tdm_func_pp;
1018
1019 /**
1020  * @brief The capture functions for a backend module.
1021  */
1022 typedef struct _tdm_func_capture {
1023         /**
1024          * @brief Destroy a capture object
1025          * @param[in] capture A capture object
1026          * @see output_create_capture() function of #tdm_func_output
1027          * @see layer_create_capture() function of #tdm_func_layer
1028          */
1029         void (*capture_destroy)(tdm_capture *capture);
1030
1031         /**
1032          * @brief Set the geometry information to a capture object
1033          * @param[in] capture A capture object
1034          * @param[in] info The geometry information
1035          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1036          * @see capture_commit() function of #tdm_func_capture
1037          * @remark
1038          * A backend module would apply the geometry information when committed.
1039          */
1040         tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
1041
1042         /**
1043          * @brief Attach a TDM buffer to a capture object
1044          * @details When capture_commit() function is called, a backend module starts
1045          * to dump a output or a layer to a TDM buffer.
1046          * @param[in] capture A capture object
1047          * @param[in] buffer A TDM buffer
1048          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1049          * @see capture_set_info() function of #tdm_func_capture
1050          * @see capture_commit() function of #tdm_func_capture
1051          * @see capture_set_done_handler, tdm_capture_done_handler
1052          * @remark
1053          * A backend module starts to dump a output or a layer to to a TDM buffer when
1054          * committed. The size/crop/transform information is set via #capture_set_info()
1055          * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
1056          * buffer via tdm_capture_done_handler.
1057          */
1058         tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
1059
1060         /**
1061          * @brief Commit changes for a capture object
1062          * @param[in] capture A capture object
1063          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1064          */
1065         tdm_error (*capture_commit)(tdm_capture *capture);
1066
1067         /**
1068          * @brief Set a user done handler to a capture object
1069          * @param[in] capture A capture object
1070          * @param[in] func A user done handler
1071          * @param[in] user_data user data
1072          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1073          * @remark
1074          * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
1075          */
1076         tdm_error (*capture_set_done_handler)(tdm_capture *capture,
1077                                                                                   tdm_capture_done_handler func, void *user_data);
1078
1079         void (*reserved1)(void);
1080         void (*reserved2)(void);
1081         void (*reserved3)(void);
1082         void (*reserved4)(void);
1083         void (*reserved5)(void);
1084         void (*reserved6)(void);
1085         void (*reserved7)(void);
1086         void (*reserved8)(void);
1087 } tdm_func_capture;
1088
1089 /**
1090  * @brief The tdm event source
1091  */
1092 typedef void tdm_event_loop_source;
1093
1094 /**
1095  * @brief The fd source handler
1096  */
1097 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
1098
1099 /**
1100  * @brief The timer source handler
1101  */
1102 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
1103
1104 #define TDM_BACKEND_MINOR_VERSION_MASK  0x0000FFFF
1105 #define TDM_BACKEND_MAJOR_VERSION_MASK  0xFFFF0000
1106 #define TDM_BACKEND_GET_ABI_MINOR(v)    ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
1107 #define TDM_BACKEND_GET_ABI_MAJOR(v)    (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
1108
1109 /**
1110  * @brief
1111  * The ABI version of TDM backend module. It has a major and minor revision.
1112  * Modules using lower minor revisions will work with TDM frontend of a higher
1113  * minor revision. There is no compatibility between different major revisions.
1114  * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
1115  * @par Example
1116  * @code
1117  *  tdm_backend_module tdm_backend_module_data = {
1118  *      "drm",
1119  *      "Samsung",
1120  *      TDM_BACKEND_SET_ABI_VERSION(1,1),
1121  *      tdm_drm_init,
1122  *      tdm_drm_deinit
1123  *  };
1124  * @endcode
1125  */
1126 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
1127         (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
1128         ((minor) & TDM_BACKEND_MINOR_VERSION_MASK)
1129
1130
1131 #define TDM_BACKEND_ABI_VERSION_1_0 TDM_BACKEND_SET_ABI_VERSION(1, 0)
1132 #define TDM_BACKEND_ABI_VERSION_2_0 TDM_BACKEND_SET_ABI_VERSION(2, 0)
1133 #define TDM_BACKEND_ABI_LATEST_VERSION TDM_BACKEND_ABI_VERSION_2_0 /**< the latest version of the tdm backend abi  */
1134
1135 /**
1136  * @brief
1137  * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
1138  * @deprecated
1139  * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
1140  */
1141 #define TDM_BACKEND_ABI_VERSION     TDM_BACKEND_SET_ABI_VERSION(1, 1)
1142
1143 /**
1144  * @brief The backend module information of the entry point to initialize a TDM
1145  * backend module.
1146  * @remark
1147  * A backend module @b SHOULD define the global data symbol of which name is
1148  * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
1149  * at the initial time and call init() function of #tdm_backend_module.
1150  */
1151 typedef struct _tdm_backend_module {
1152         const char *name;           /**< The module name of a backend module */
1153         const char *vendor;         /**< The vendor name of a backend module */
1154         unsigned long abi_version;  /**< The ABI version of a backend module */
1155
1156         /**
1157          * @brief The init function of a backend module
1158          * @param[in] dpy A display object
1159          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1160          * @return The backend module data
1161          * @see tdm_backend_data
1162          */
1163         tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
1164
1165         /**
1166          * @brief The deinit function of a backend module
1167          * @param[in] bdata The backend module data
1168          */
1169         void (*deinit)(tdm_backend_data *bdata);
1170 } tdm_backend_module;
1171
1172 /**
1173  * @brief Register the backend display functions to a display
1174  * @param[in] dpy A display object
1175  * @param[in] func_display display functions
1176  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1177  * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
1178  * @remarks
1179  * A backend module @b SHOULD set the backend display functions at least.
1180  */
1181 tdm_error
1182 tdm_backend_register_func_display(tdm_display *dpy,
1183                                                                   tdm_func_display *func_display);
1184
1185 /**
1186  * @brief Register the backend output functions to a display
1187  * @param[in] dpy A display object
1188  * @param[in] func_output output functions
1189  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1190  * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
1191  * @remarks
1192  * A backend module @b SHOULD set the backend output functions at least.
1193  */
1194 tdm_error
1195 tdm_backend_register_func_output(tdm_display *dpy,
1196                                                                  tdm_func_output *func_output);
1197
1198 /**
1199  * @brief Register the backend layer functions to a display
1200  * @param[in] dpy A display object
1201  * @param[in] func_layer layer functions
1202  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1203  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1204  * @remarks
1205  * A backend module @b SHOULD set the backend layer functions at least.
1206  */
1207 tdm_error
1208 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
1209
1210 /**
1211  * @brief Register the backend hwc functions to a display
1212  * @param[in] dpy A display object
1213  * @param[in] func_hwc hwc functions
1214  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1215  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1216  * @remarks
1217  * A backend module @b SHOULD set the backend hwc functions at least.
1218  * @since 2.0.0
1219  */
1220 tdm_error
1221 tdm_backend_register_func_hwc(tdm_display *dpy, tdm_func_hwc *func_hwc);
1222
1223 /**
1224  * @brief Register the backend hwc_window functions to a display
1225  * @param[in] dpy A display object
1226  * @param[in] func_hwc_window hwc_window functions
1227  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1228  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
1229  * @remarks
1230  * A backend module @b SHOULD set the backend hwc_window functions at least.
1231  * @since 2.0.0
1232  */
1233 tdm_error
1234 tdm_backend_register_func_hwc_window(tdm_display *dpy, tdm_func_hwc_window *func_hwc_window);
1235
1236 /**
1237  * @brief Register the backend pp functions to a display
1238  * @param[in] dpy A display object
1239  * @param[in] func_pp pp functions
1240  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1241  * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
1242  * @remark
1243  * A backend module doesn'tcan skip to register the backend pp functions
1244  * if a hardware doesn't have the memory-to-memory converting device.
1245  */
1246 tdm_error
1247 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
1248
1249 /**
1250  * @brief Register the backend capture functions to a display
1251  * @param[in] dpy A display object
1252  * @param[in] func_capture capture functions
1253  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1254  * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
1255  * @remark
1256  * A backend module can skip to register the backend capture functions
1257  * if a hardware doesn't have the capture device.
1258  */
1259 tdm_error
1260 tdm_backend_register_func_capture(tdm_display *dpy,
1261                                                                   tdm_func_capture *func_capture);
1262
1263 /**
1264  * @brief Increase the ref_count of a TDM buffer
1265  * @details
1266  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
1267  * becomes available for a next job. A TDM buffer can be used for TDM to show
1268  * it on screen or to capture an output and a layer. After all operations,
1269  * TDM will release it immediately when TDM doesn't need it any more.
1270  * @param[in] buffer A TDM buffer
1271  * @return A buffer itself. Otherwise, NULL.
1272  * @see tdm_buffer_unref_backend
1273  * @remark
1274  * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
1275  * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
1276  * buffer of a layer for capturing a output or a layer to avoid tearing issue.
1277  */
1278 tbm_surface_h
1279 tdm_buffer_ref_backend(tbm_surface_h buffer);
1280
1281 /**
1282  * @brief Decrease the ref_count of a TDM buffer
1283  * @param[in] buffer A TDM buffer
1284  * @see tdm_buffer_ref_backend
1285  */
1286 void
1287 tdm_buffer_unref_backend(tbm_surface_h buffer);
1288
1289 /**
1290  * @brief The destroy handler of a TDM buffer
1291  * @param[in] buffer A TDM buffer
1292  * @param[in] user_data user data
1293  * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
1294  */
1295 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
1296                                                                                    void *user_data);
1297
1298 /**
1299  * @brief Add a destroy handler to a TDM buffer
1300  * @param[in] buffer A TDM buffer
1301  * @param[in] func A destroy handler
1302  * @param[in] user_data user data
1303  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1304  * @see tdm_buffer_remove_destroy_handler
1305  * @remark
1306  * A backend module can add a TDM buffer destroy handler to a TDM buffer which
1307  * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
1308  * be called.
1309  */
1310 tdm_error
1311 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
1312                                                            tdm_buffer_destroy_handler func, void *user_data);
1313
1314 /**
1315  * @brief Remove a destroy handler from a TDM buffer
1316  * @param[in] buffer A TDM buffer
1317  * @param[in] func A destroy handler
1318  * @param[in] user_data user data
1319  * @see tdm_buffer_add_destroy_handler
1320  */
1321 void
1322 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1323                                                                   tdm_buffer_destroy_handler func, void *user_data);
1324
1325 /**
1326  * @brief Add a FD handler for activity on the given file descriptor
1327  * @param[in] dpy A display object
1328  * @param[in] fd A file descriptor
1329  * @param[in] mask to monitor FD
1330  * @param[in] func A FD handler function
1331  * @param[in] user_data user data
1332  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1333  * @return A FD event source
1334  * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1335  */
1336 tdm_event_loop_source*
1337 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1338                                                           tdm_event_loop_fd_handler func, void *user_data,
1339                                                           tdm_error *error);
1340
1341 /**
1342  * @brief Update the mask of the given FD event source
1343  * @param[in] source The given FD event source
1344  * @param[in] mask to monitor FD
1345  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1346  */
1347 tdm_error
1348 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1349
1350 /**
1351  * @brief Add a timer handler
1352  * @param[in] dpy A display object
1353  * @param[in] func A timer handler function
1354  * @param[in] user_data user data
1355  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1356  * @return A timer event source
1357  * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1358  */
1359 tdm_event_loop_source*
1360 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1361                                                                  void *user_data, tdm_error *error);
1362
1363 /**
1364  * @brief Update the millisecond delay time of the given timer event source.
1365  * @param[in] source The given timer event source
1366  * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1367  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1368  */
1369 tdm_error
1370 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1371
1372 /**
1373  * @brief Remove the given event source
1374  * @param[in] source The given event source
1375  * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1376  */
1377 void
1378 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1379
1380 /**
1381  * @brief Get the ini value with given key
1382  * @details
1383  * @param[in] key The given key
1384  * @param[in] default_value The default value
1385  * @return the value of given key if success. Otherwise, default_value.
1386  * @see #tdm_config_get_string
1387  */
1388 int
1389 tdm_config_get_int(const char *key, int default_value);
1390
1391 /**
1392  * @brief Get the ini value with given key
1393  * @details
1394  * @param[in] key The given key
1395  * @param[in] default_value The default value
1396  * @return the value of given key if success. Otherwise, default_value.
1397  * @see #tdm_config_get_int
1398  */
1399 const char *
1400 tdm_config_get_string(const char *key, const char *default_value);
1401
1402 #ifdef __cplusplus
1403 }
1404 #endif
1405
1406 #endif /* _TDM_BACKEND_H_ */