include/tdm_backend.h

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