include/tdm_backend.h

   1 /**************************************************************************
   2  *
   3  * libtdm
   4  *
   5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
   6  *
   7  * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
   8  *          JinYoung Jeon <jy0.jeon@samsung.com>,
   9  *          Taeheon Kim <th908.kim@samsung.com>,
  10  *          YoungJun Cho <yj44.cho@samsung.com>,
  11  *          SooChan Lim <sc1.lim@samsung.com>,
  12  *          Boram Park <sc1.lim@samsung.com>
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the
  16  * "Software"), to deal in the Software without restriction, including
  17  * without limitation the rights to use, copy, modify, merge, publish,
  18  * distribute, sub license, and/or sell copies of the Software, and to
  19  * permit persons to whom the Software is furnished to do so, subject to
  20  * the following conditions:
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  27  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  29  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  30  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  31  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  32  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33  *
  34 **************************************************************************/
  35
  36 #ifndef _TDM_BACKEND_H_
  37 #define _TDM_BACKEND_H_
  38
  39 #include <tbm_surface.h>
  40
  41 #include "tdm_types.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * @file tdm_backend.h
  49  * @brief The backend header file of TDM to implement a TDM backend module.
  50  * @par Example
  51  * @code
  52  * #include <tdm_backend.h>
  53  * @endcode
  54  */
  55
  56 /**
  57  * @brief The backend module data
  58  * @details
  59  * The init() function of #tdm_backend_module returns the backend module data.
  60  * And it will be passed to display functions of #tdm_func_display.
  61  * @see tdm_backend_module, tdm_backend_module
  62  */
  63 typedef void tdm_backend_data;
  64
  65 /**
  66  * @brief The output status handler
  67  * @details This handler will be called when the status of a output object is
  68  * changed in runtime.
  69  */
  70 typedef void (*tdm_output_status_handler)(tdm_output *output,
  71                                                                                   tdm_output_conn_status status,
  72                                                                                   void *user_data);
  73
  74 /**
  75  * @brief The output dpms handler
  76  * @details This handler will be called when the dpms of a output object is
  77  * changed in runtime.
  78  */
  79 typedef void (*tdm_output_dpms_handler)(tdm_output *output,
  80                                                                                 tdm_output_dpms dpms,
  81                                                                                 void *user_data);
  82
  83 /**
  84  * @brief The display capabilities structure of a backend module
  85  * @see The display_get_capability() function of #tdm_func_display
  86  */
  87 typedef struct _tdm_caps_display {
  88         int max_layer_count;    /**< The maximum layer count. -1 means "not defined" */
  89 } tdm_caps_display;
  90
  91 /**
  92  * @brief The capabilities structure of a output object
  93  * @see The output_get_capability() function of #tdm_func_output
  94  */
  95 typedef struct _tdm_caps_output {
  96         char maker[TDM_NAME_LEN];       /**< The output maker */
  97         char model[TDM_NAME_LEN];       /**< The output model */
  98         char name[TDM_NAME_LEN];        /**< The output name */
  99
 100         tdm_output_conn_status status;  /**< The connection status */
 101         tdm_output_type type;           /**< The connection type */
 102         unsigned int type_id;           /**< The connection type id */
 103
 104         unsigned int mode_count;        /**< The count of available modes */
 105         tdm_output_mode
 106         *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. -1 means "not defined" */
 116         int min_h;              /**< The minimun height. -1 means "not defined" */
 117         int max_w;              /**< The maximum width. -1 means "not defined" */
 118         int max_h;              /**< The maximum height. -1 means "not defined" */
 119         int preferred_align;    /**< The prefered align. -1 means "not defined" */
 120
 121         tdm_output_capability capabilities;  /**< The capabilities of output. @since 1.4.1 */
 122 } tdm_caps_output;
 123
 124 /**
 125  * @brief The capabilities structure of a layer object
 126  * @see The layer_get_capability() function of #tdm_func_layer
 127  */
 128 typedef struct _tdm_caps_layer {
 129         tdm_layer_capability capabilities;  /**< The capabilities of layer */
 130
 131         /**
 132          * The z-order
 133          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
 134          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
 135          * But the zpos of VIDEO layer is changeable by layer_set_video_pos() function
 136          * of #tdm_func_layer. And The zpos of VIDEO layers is less than GRAPHIC
 137          * layers or more than GRAPHIC layers.
 138          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 139          * The zpos of VIDEO layers is @b relative. It doesn't need to start
 140          * from -1 or 4. Let's suppose that there are two VIDEO layers.
 141          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
 142          * than -4 VIDEO layer.
 143         */
 144         int zpos;
 145
 146         unsigned int format_count;      /**< The count of available formats */
 147         tbm_format
 148         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
 149
 150         unsigned int prop_count;        /**< The count of available properties */
 151         tdm_prop *props;                /**< The @b newly-allocated array of properties. will be freed in frontend. */
 152 } tdm_caps_layer;
 153
 154 /**
 155  * @brief The capabilities structure of a pp object
 156  * @see The display_get_pp_capability() function of #tdm_func_display
 157  */
 158 typedef struct _tdm_caps_pp {
 159         tdm_pp_capability capabilities; /**< The capabilities of pp */
 160
 161         unsigned int format_count;      /**< The count of available formats */
 162         tbm_format
 163         *formats;            /**< The @b newly-allocated array. will be freed in frontend. */
 164
 165         int min_w;              /**< The minimun width. -1 means "not defined" */
 166         int min_h;              /**< The minimun height. -1 means "not defined" */
 167         int max_w;              /**< The maximum width. -1 means "not defined" */
 168         int max_h;              /**< The maximum height. -1 means "not defined" */
 169         int preferred_align;    /**< The prefered align. -1 means "not defined" */
 170
 171         /**< The attach count which a PP object can handle.
 172          *   -1 means "not defined".
 173          * @since 1.2.0
 174          */
 175         int max_attach_count;
 176 } tdm_caps_pp;
 177
 178 /**
 179  * @brief The capabilities structure of a capture object
 180  * @see The display_get_capture_capability() function of #tdm_func_display
 181  */
 182 typedef struct _tdm_caps_capture {
 183         tdm_capture_capability capabilities;    /**< The capabilities of capture */
 184
 185         unsigned int format_count;      /**< The count of available formats */
 186         tbm_format
 187         *formats;            /**< The @b newly-allocated array of formats. will be freed in frontend. */
 188
 189         int min_w;              /**< The minimun width. -1 means "not defined" */
 190         int min_h;              /**< The minimun height. -1 means "not defined" */
 191         int max_w;              /**< The maximum width. -1 means "not defined" */
 192         int max_h;              /**< The maximum height. -1 means "not defined" */
 193         int preferred_align;    /**< The prefered align. -1 means "not defined" */
 194
 195         /**< The attach count which a capture object can handle.
 196          *   -1 means "not defined".
 197          * @since 1.2.0
 198          */
 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. Otherwise, set -1.
 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         tdm_error (*display_get_capabilitiy)(tdm_backend_data *bdata, tdm_caps_display *caps);
 339
 340         void (*reserved2)(void);
 341         void (*reserved3)(void);
 342         void (*reserved4)(void);
 343         void (*reserved5)(void);
 344         void (*reserved6)(void);
 345         void (*reserved7)(void);
 346         void (*reserved8)(void);
 347 } tdm_func_display;
 348
 349 /**
 350  * @brief The output functions for a backend module.
 351  */
 352 typedef struct _tdm_func_output {
 353         /**
 354          * @brief Get the capabilities of a output object
 355          * @param[in] output A output object
 356          * @param[out] caps The capabilities of a output object
 357          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 358          * @remark
 359          * A backend module @b SHOULD implement this function. TDM calls this function
 360          * not only at the initial time, but also at the update time when new output
 361          * is connected.\n
 362          * #tdm_caps_output contains connection status, modes, avaiable properties,
 363          * size restriction information, etc.
 364          */
 365         tdm_error (*output_get_capability)(tdm_output *output, tdm_caps_output *caps);
 366
 367         /**
 368          * @brief Get a layer array of a output object
 369          * @param[in] output A output object
 370          * @param[out] count The count of layers
 371          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 372          * @return A layer array which is @b newly-allocated
 373          * @remark
 374          * A backend module @b SHOULD implement this function. TDM calls this function
 375          * not only at the initial time, but also at the update time when new output
 376          * is connected.\n
 377          * A backend module @b SHOULD return the @b newly-allocated array which contains
 378          * "tdm_layer*" data. It will be freed in frontend.
 379          */
 380         tdm_layer **(*output_get_layers)(tdm_output *output, int *count,
 381                                                                          tdm_error *error);
 382
 383         /**
 384          * @brief Set the property which has a given id
 385          * @param[in] output A output object
 386          * @param[in] id The property id
 387          * @param[in] value The value
 388          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 389          */
 390         tdm_error (*output_set_property)(tdm_output *output, unsigned int id,
 391                                                                          tdm_value value);
 392
 393         /**
 394          * @brief Get the property which has a given id
 395          * @param[in] output A output object
 396          * @param[in] id The property id
 397          * @param[out] value The value
 398          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 399          */
 400         tdm_error (*output_get_property)(tdm_output *output, unsigned int id,
 401                                                                          tdm_value *value);
 402
 403         /**
 404          * @brief Wait for VBLANK
 405          * @param[in] output A output object
 406          * @param[in] interval vblank interval
 407          * @param[in] sync 0: asynchronous, 1:synchronous
 408          * @param[in] user_data The user data
 409          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 410          * @see output_set_vblank_handler, tdm_output_vblank_handler
 411          * @remark
 412          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 413          * a user vblank handler with the user data of this function after interval
 414          * vblanks.
 415          */
 416         tdm_error (*output_wait_vblank)(tdm_output *output, int interval, int sync,
 417                                                                         void *user_data);
 418
 419         /**
 420          * @brief Set a user vblank handler
 421          * @param[in] output A output object
 422          * @param[in] func A user vblank handler
 423          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 424          */
 425         tdm_error (*output_set_vblank_handler)(tdm_output *output,
 426                                                                                    tdm_output_vblank_handler func);
 427
 428         /**
 429          * @brief Commit changes for a output object
 430          * @param[in] output A output object
 431          * @param[in] sync 0: asynchronous, 1:synchronous
 432          * @param[in] user_data The user data
 433          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 434          * @see output_set_commit_handler, tdm_output_commit_handler
 435          * @remark
 436          * When this function is called, a backend module @b SHOULD apply the all
 437          * changes of the given output object to screen as well as the layer changes
 438          * of this output.
 439          * If this function returns TDM_ERROR_NONE, a backend module @b SHOULD call
 440          * a user commit handler with the user data of this function after all
 441          * changes of the given output object are applied.
 442          */
 443         tdm_error (*output_commit)(tdm_output *output, int sync, void *user_data);
 444
 445         /**
 446          * @brief Set a user commit handler
 447          * @param[in] output A output object
 448          * @param[in] func A user commit handler
 449          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 450          */
 451         tdm_error (*output_set_commit_handler)(tdm_output *output,
 452                                                                                    tdm_output_commit_handler func);
 453
 454         /**
 455          * @brief Set DPMS of a output object
 456          * @param[in] output A output object
 457          * @param[in] dpms_value DPMS value
 458          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 459          */
 460         tdm_error (*output_set_dpms)(tdm_output *output, tdm_output_dpms dpms_value);
 461
 462         /**
 463          * @brief Get DPMS of a output object
 464          * @param[in] output A output object
 465          * @param[out] dpms_value DPMS value
 466          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 467          */
 468         tdm_error (*output_get_dpms)(tdm_output *output, tdm_output_dpms *dpms_value);
 469
 470         /**
 471          * @brief Set one of available modes of a output object
 472          * @param[in] output A output object
 473          * @param[in] mode A output mode
 474          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 475          */
 476         tdm_error (*output_set_mode)(tdm_output *output, const tdm_output_mode *mode);
 477
 478         /**
 479          * @brief Get the mode of a output object
 480          * @param[in] output A output object
 481          * @param[out] mode A output mode
 482          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 483          */
 484         tdm_error (*output_get_mode)(tdm_output *output, const tdm_output_mode **mode);
 485
 486         /**
 487          * @brief Create a capture object of a output object
 488          * @param[in] output A output object
 489          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 490          * @return A capture object
 491          * @see capture_destroy() function of #tdm_func_capture
 492          * @remark
 493          * A backend module doesn't need to implement this function if a hardware
 494          * doesn't have the capture device.
 495          */
 496         tdm_capture *(*output_create_capture)(tdm_output *output, tdm_error *error);
 497
 498         /**
 499          * @brief Set a output connection status handler
 500          * @details A backend module need to call the output status handler when the
 501          * output connection status has been changed to let the TDM frontend know
 502          * the change.
 503          * @param[in] output A output object
 504          * @param[in] func A output status handler
 505          * @param[in] user_data The user data
 506          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 507          * @since 1.1.0
 508          */
 509         tdm_error (*output_set_status_handler)(tdm_output *output,
 510                                                                                    tdm_output_status_handler func,
 511                                                                                    void *user_data);
 512
 513         /**
 514          * @brief Set a output dpms handler
 515          * @details A backend module needs to call the output dpms handler when the
 516          * output DPMS has been changed to let the TDM frontend know the change.
 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          * @since 1.4.0
 522          */
 523         tdm_error (*output_set_dpms_handler)(tdm_output *output,
 524                                                                                  tdm_output_dpms_handler func,
 525                                                                                  void *user_data);
 526         void (*reserved2)(void);
 527         void (*reserved3)(void);
 528         void (*reserved4)(void);
 529         void (*reserved5)(void);
 530         void (*reserved6)(void);
 531         void (*reserved7)(void);
 532         void (*reserved8)(void);
 533 } tdm_func_output;
 534
 535 /**
 536  * @brief The layer functions for a backend module.
 537  */
 538 typedef struct _tdm_func_layer {
 539         /**
 540          * @brief Get the capabilities of a layer object
 541          * @param[in] layer A layer object
 542          * @param[out] caps The capabilities of a layer object
 543          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 544          * @remark
 545          * A backend module @b SHOULD implement this function. TDM calls this function
 546          * not only at the initial time, but also at the update time when new output
 547          * is connected.\n
 548          * #tdm_caps_layer contains avaiable formats/properties, zpos information, etc.
 549          */
 550         tdm_error (*layer_get_capability)(tdm_layer *layer, tdm_caps_layer *caps);
 551
 552         /**
 553          * @brief Set the property which has a given id.
 554          * @param[in] layer A layer object
 555          * @param[in] id The property id
 556          * @param[in] value The value
 557          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 558          */
 559         tdm_error (*layer_set_property)(tdm_layer *layer, unsigned int id,
 560                                                                         tdm_value value);
 561
 562         /**
 563          * @brief Get the property which has a given id.
 564          * @param[in] layer A layer object
 565          * @param[in] id The property id
 566          * @param[out] value The value
 567          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 568          */
 569         tdm_error (*layer_get_property)(tdm_layer *layer, unsigned int id,
 570                                                                         tdm_value *value);
 571
 572         /**
 573          * @brief Set the geometry information to a layer object
 574          * @param[in] layer A layer object
 575          * @param[in] info The geometry information
 576          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 577          * @see output_commit() function of #tdm_func_output
 578          * @remark
 579          * A backend module would apply the geometry information when the output object
 580          * of a layer object is committed.
 581          */
 582         tdm_error (*layer_set_info)(tdm_layer *layer, tdm_info_layer *info);
 583
 584         /**
 585          * @brief Get the geometry information to a layer object
 586          * @param[in] layer A layer object
 587          * @param[out] info The geometry information
 588          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 589          */
 590         tdm_error (*layer_get_info)(tdm_layer *layer, tdm_info_layer *info);
 591
 592         /**
 593          * @brief Set a TDM buffer to a layer object
 594          * @param[in] layer A layer object
 595          * @param[in] buffer A TDM buffer
 596          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 597          * @see output_commit() function of #tdm_func_output
 598          * @remark
 599          * A backend module would show a TDM buffer on screen when the output object
 600          * of a layer object is committed.
 601          */
 602         tdm_error (*layer_set_buffer)(tdm_layer *layer, tbm_surface_h buffer);
 603
 604         /**
 605          * @brief Unset a TDM buffer from a layer object
 606          * @param[in] layer A layer object
 607          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 608          * @remark
 609          * A backend module @b SHOULD remove the current showing buffer from screen.
 610          */
 611         tdm_error (*layer_unset_buffer)(tdm_layer *layer);
 612
 613         /**
 614          * @brief Set the zpos for a VIDEO layer object
 615          * @param[in] layer A layer object
 616          * @param[in] zpos z-order
 617          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 618          * @see tdm_caps_layer, tdm_layer_capability
 619          * @remark
 620          * A backend module doesn't need to implement this function if a backend
 621          * module doesn't have VIDEO layers.\n
 622          * This function is for VIDEO layers.
 623          * GRAPHIC layers are non-changeable. The zpos of GRAPHIC layers starts
 624          * from 0. If there are 4 GRAPHIC layers, The zpos SHOULD be 0, 1, 2, 3.\n
 625          * But the zpos of VIDEO layer is changeable. And The zpos of VIDEO layers
 626          * is less than GRAPHIC layers or more than GRAPHIC layers.
 627          * ie, ..., -2, -1, 4, 5, ... (if 0 <= GRAPHIC layer's zpos < 4).
 628          * The zpos of VIDEO layers is @b relative. It doesn't need to start
 629          * from -1 or 4. Let's suppose that there are two VIDEO layers.
 630          * One has -2 zpos. Another has -4 zpos. Then -2 Video layer is higher
 631          * than -4 VIDEO layer.
 632          */
 633         tdm_error (*layer_set_video_pos)(tdm_layer *layer, int zpos);
 634
 635         /**
 636          * @brief Create a capture object of a layer object
 637          * @param[in] output A output object
 638          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 639          * @return A capture object
 640          * @see capture_destroy() function of #tdm_func_capture
 641          * @remark
 642          * A backend module doesn't need to implement this function if a hardware
 643          * doesn't have the capture device.
 644          */
 645         tdm_capture *(*layer_create_capture)(tdm_layer *layer, tdm_error *error);
 646
 647         /**
 648          * @brief Get buffer flags which the layer can support.
 649          * @param[in] layer A layer object
 650          * @param[out] flags The buffer flags which should be the tbm_bo flags
 651          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 652          */
 653         tdm_error (*layer_get_buffer_flags)(tdm_layer *layer, unsigned int *flags);
 654
 655         void (*reserved1)(void);
 656         void (*reserved2)(void);
 657         void (*reserved3)(void);
 658         void (*reserved4)(void);
 659         void (*reserved5)(void);
 660         void (*reserved6)(void);
 661         void (*reserved7)(void);
 662 } tdm_func_layer;
 663
 664 /**
 665  * @brief The pp functions for a backend module.
 666  */
 667 typedef struct _tdm_func_pp {
 668         /**
 669          * @brief Destroy a pp object
 670          * @param[in] pp A pp object
 671          * @see display_create_pp() function of #tdm_func_display
 672          */
 673         void (*pp_destroy)(tdm_pp *pp);
 674
 675         /**
 676          * @brief Set the geometry information to a pp object
 677          * @param[in] pp A pp object
 678          * @param[in] info The geometry information
 679          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 680          * @see pp_commit() function of #tdm_func_pp
 681          * @remark
 682          * A backend module would apply the geometry information when committed.
 683          */
 684         tdm_error (*pp_set_info)(tdm_pp *pp, tdm_info_pp *info);
 685
 686         /**
 687          * @brief Attach a source buffer and a destination buffer to a pp object
 688          * @param[in] pp A pp object
 689          * @param[in] src A source buffer
 690          * @param[in] dst A destination buffer
 691          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 692          * @see pp_set_info() function of #tdm_func_pp
 693          * @see pp_commit() function of #tdm_func_pp
 694          * @see pp_set_done_handler, tdm_pp_done_handler
 695          * @remark
 696          * A backend module converts the image of a source buffer to a destination
 697          * buffer when committed. The size/crop/transform information is set via
 698          * #pp_set_info() of #tdm_func_pp. When done, a backend module @b SHOULD
 699          * return the source/destination buffer via tdm_pp_done_handler.
 700          */
 701         tdm_error (*pp_attach)(tdm_pp *pp, tbm_surface_h src, tbm_surface_h dst);
 702
 703         /**
 704          * @brief Commit changes for a pp object
 705          * @param[in] pp A pp object
 706          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 707          */
 708         tdm_error (*pp_commit)(tdm_pp *pp);
 709
 710         /**
 711          * @brief Set a user done handler to a pp object
 712          * @param[in] pp A pp object
 713          * @param[in] func A user done handler
 714          * @param[in] user_data user data
 715          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 716          * @remark
 717          * A backend module @b SHOULD call #tdm_pp_done_handler when converintg a image is done.
 718          */
 719         tdm_error (*pp_set_done_handler)(tdm_pp *pp, tdm_pp_done_handler func,
 720                                                                          void *user_data);
 721
 722         void (*reserved1)(void);
 723         void (*reserved2)(void);
 724         void (*reserved3)(void);
 725         void (*reserved4)(void);
 726         void (*reserved5)(void);
 727         void (*reserved6)(void);
 728         void (*reserved7)(void);
 729         void (*reserved8)(void);
 730 } tdm_func_pp;
 731
 732 /**
 733  * @brief The capture functions for a backend module.
 734  */
 735 typedef struct _tdm_func_capture {
 736         /**
 737          * @brief Destroy a capture object
 738          * @param[in] capture A capture object
 739          * @see output_create_capture() function of #tdm_func_output
 740          * @see layer_create_capture() function of #tdm_func_layer
 741          */
 742         void (*capture_destroy)(tdm_capture *capture);
 743
 744         /**
 745          * @brief Set the geometry information to a capture object
 746          * @param[in] capture A capture object
 747          * @param[in] info The geometry information
 748          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 749          * @see capture_commit() function of #tdm_func_capture
 750          * @remark
 751          * A backend module would apply the geometry information when committed.
 752          */
 753         tdm_error (*capture_set_info)(tdm_capture *capture, tdm_info_capture *info);
 754
 755         /**
 756          * @brief Attach a TDM buffer to a capture object
 757          * @details When capture_commit() function is called, a backend module starts
 758          * to dump a output or a layer to a TDM buffer.
 759          * @param[in] capture A capture object
 760          * @param[in] buffer A TDM buffer
 761          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 762          * @see capture_set_info() function of #tdm_func_capture
 763          * @see capture_commit() function of #tdm_func_capture
 764          * @see capture_set_done_handler, tdm_capture_done_handler
 765          * @remark
 766          * A backend module starts to dump a output or a layer to to a TDM buffer when
 767          * committed. The size/crop/transform information is set via #capture_set_info()
 768          * of #tdm_func_capture. When done, a backend module @b SHOULD return the TDM
 769          * buffer via tdm_capture_done_handler.
 770          */
 771         tdm_error (*capture_attach)(tdm_capture *capture, tbm_surface_h buffer);
 772
 773         /**
 774          * @brief Commit changes for a capture object
 775          * @param[in] capture A capture object
 776          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 777          */
 778         tdm_error (*capture_commit)(tdm_capture *capture);
 779
 780         /**
 781          * @brief Set a user done handler to a capture object
 782          * @param[in] capture A capture object
 783          * @param[in] func A user done handler
 784          * @param[in] user_data user data
 785          * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 786          * @remark
 787          * A backend module @b SHOULD call #tdm_capture_done_handler when capture operation is done.
 788          */
 789         tdm_error (*capture_set_done_handler)(tdm_capture *capture,
 790                                                                                   tdm_capture_done_handler func, void *user_data);
 791
 792         void (*reserved1)(void);
 793         void (*reserved2)(void);
 794         void (*reserved3)(void);
 795         void (*reserved4)(void);
 796         void (*reserved5)(void);
 797         void (*reserved6)(void);
 798         void (*reserved7)(void);
 799         void (*reserved8)(void);
 800 } tdm_func_capture;
 801
 802 /**
 803  * @brief The tdm event source
 804  */
 805 typedef void tdm_event_loop_source;
 806
 807 /**
 808  * @brief The fd source handler
 809  */
 810 typedef tdm_error (*tdm_event_loop_fd_handler)(int fd, tdm_event_loop_mask mask, void *user_data);
 811
 812 /**
 813  * @brief The timer source handler
 814  */
 815 typedef tdm_error (*tdm_event_loop_timer_handler)(void *user_data);
 816
 817 #define TDM_BACKEND_MINOR_VERSION_MASK  0x0000FFFF
 818 #define TDM_BACKEND_MAJOR_VERSION_MASK  0xFFFF0000
 819 #define TDM_BACKEND_GET_ABI_MINOR(v)    ((v) & TDM_BACKEND_MINOR_VERSION_MASK)
 820 #define TDM_BACKEND_GET_ABI_MAJOR(v)    (((v) & TDM_BACKEND_MAJOR_VERSION_MASK) >> 16)
 821
 822 /**
 823  * @brief
 824  * The ABI version of TDM backend module. It has a major and minor revision.
 825  * Modules using lower minor revisions will work with TDM frontend of a higher
 826  * minor revision. There is no compatibility between different major revisions.
 827  * The minor revision mask is 0x0000FFFF and the major revision mask is 0xFFFF0000.
 828  * @par Example
 829  * @code
 830  *  tdm_backend_module tdm_backend_module_data = {
 831  *      "drm",
 832  *      "Samsung",
 833  *      TDM_BACKEND_SET_ABI_VERSION(1,1),
 834  *      tdm_drm_init,
 835  *      tdm_drm_deinit
 836  *  };
 837  * @endcode
 838  */
 839 #define TDM_BACKEND_SET_ABI_VERSION(major, minor) \
 840         (((major) << 16) & TDM_BACKEND_MAJOR_VERSION_MASK) | \
 841         ((major) & TDM_BACKEND_MINOR_VERSION_MASK)
 842
 843 /**
 844  * @brief
 845  * This MACRO is deprecated since 1.2.0. Use TDM_BACKEND_SET_ABI_VERSION instead of this.
 846  * @deprecated
 847  * Use #TDM_BACKEND_SET_ABI_VERSION macro instead of this macro.
 848  */
 849 #define TDM_BACKEND_ABI_VERSION     TDM_BACKEND_SET_ABI_VERSION(1, 1)
 850
 851 /**
 852  * @brief The backend module information of the entry point to initialize a TDM
 853  * backend module.
 854  * @remark
 855  * A backend module @b SHOULD define the global data symbol of which name is
 856  * @b "tdm_backend_module_data". TDM will read this symbol, @b "tdm_backend_module_data",
 857  * at the initial time and call init() function of #tdm_backend_module.
 858  */
 859 typedef struct _tdm_backend_module {
 860         const char *name;           /**< The module name of a backend module */
 861         const char *vendor;         /**< The vendor name of a backend module */
 862         unsigned long abi_version;  /**< The ABI version of a backend module */
 863
 864         /**
 865          * @brief The init function of a backend module
 866          * @param[in] dpy A display object
 867          * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
 868          * @return The backend module data
 869          * @see tdm_backend_data
 870          */
 871         tdm_backend_data *(*init)(tdm_display *dpy, tdm_error *error);
 872
 873         /**
 874          * @brief The deinit function of a backend module
 875          * @param[in] bdata The backend module data
 876          */
 877         void (*deinit)(tdm_backend_data *bdata);
 878 } tdm_backend_module;
 879
 880 /**
 881  * @brief Register the backend display functions to a display
 882  * @param[in] dpy A display object
 883  * @param[in] func_display display functions
 884  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 885  * @see tdm_backend_register_func_output, tdm_backend_register_func_layer
 886  * @remarks
 887  * A backend module @b SHOULD set the backend display functions at least.
 888  */
 889 tdm_error
 890 tdm_backend_register_func_display(tdm_display *dpy,
 891                                                                   tdm_func_display *func_display);
 892
 893 /**
 894  * @brief Register the backend output functions to a display
 895  * @param[in] dpy A display object
 896  * @param[in] func_output output functions
 897  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 898  * @see tdm_backend_register_func_display, tdm_backend_register_func_layer
 899  * @remarks
 900  * A backend module @b SHOULD set the backend output functions at least.
 901  */
 902 tdm_error
 903 tdm_backend_register_func_output(tdm_display *dpy,
 904                                                                  tdm_func_output *func_output);
 905
 906 /**
 907  * @brief Register the backend layer functions to a display
 908  * @param[in] dpy A display object
 909  * @param[in] func_layer layer functions
 910  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 911  * @see tdm_backend_register_func_display, tdm_backend_register_func_output
 912  * @remarks
 913  * A backend module @b SHOULD set the backend layer functions at least.
 914  */
 915 tdm_error
 916 tdm_backend_register_func_layer(tdm_display *dpy, tdm_func_layer *func_layer);
 917
 918 /**
 919  * @brief Register the backend pp functions to a display
 920  * @param[in] dpy A display object
 921  * @param[in] func_pp pp functions
 922  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 923  * @see tdm_backend_register_func_display, tdm_backend_register_func_capture
 924  * @remark
 925  * A backend module doesn'tcan skip to register the backend pp functions
 926  * if a hardware doesn't have the memory-to-memory converting device.
 927  */
 928 tdm_error
 929 tdm_backend_register_func_pp(tdm_display *dpy, tdm_func_pp *func_pp);
 930
 931 /**
 932  * @brief Register the backend capture functions to a display
 933  * @param[in] dpy A display object
 934  * @param[in] func_capture capture functions
 935  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 936  * @see tdm_backend_register_func_display, tdm_backend_register_func_pp
 937  * @remark
 938  * A backend module can skip to register the backend capture functions
 939  * if a hardware doesn't have the capture device.
 940  */
 941 tdm_error
 942 tdm_backend_register_func_capture(tdm_display *dpy,
 943                                                                   tdm_func_capture *func_capture);
 944
 945 /**
 946  * @brief Increase the ref_count of a TDM buffer
 947  * @details
 948  * TDM has its own buffer release mechanism to let an frontend user know when a TDM buffer
 949  * becomes available for a next job. A TDM buffer can be used for TDM to show
 950  * it on screen or to capture an output and a layer. After all operations,
 951  * TDM will release it immediately when TDM doesn't need it any more.
 952  * @param[in] buffer A TDM buffer
 953  * @return A buffer itself. Otherwise, NULL.
 954  * @see tdm_buffer_unref_backend
 955  * @remark
 956  * - This function @b SHOULD be paired with #tdm_buffer_unref_backend. \n
 957  * - For example, this function @b SHOULD be called in case that a backend module uses the TDM
 958  * buffer of a layer for capturing a output or a layer to avoid tearing issue.
 959  */
 960 tbm_surface_h
 961 tdm_buffer_ref_backend(tbm_surface_h buffer);
 962
 963 /**
 964  * @brief Decrease the ref_count of a TDM buffer
 965  * @param[in] buffer A TDM buffer
 966  * @see tdm_buffer_ref_backend
 967  */
 968 void
 969 tdm_buffer_unref_backend(tbm_surface_h buffer);
 970
 971 /**
 972  * @brief The destroy handler of a TDM buffer
 973  * @param[in] buffer A TDM buffer
 974  * @param[in] user_data user data
 975  * @see tdm_buffer_add_destroy_handler, tdm_buffer_remove_destroy_handler
 976  */
 977 typedef void (*tdm_buffer_destroy_handler)(tbm_surface_h buffer,
 978                                                                                    void *user_data);
 979
 980 /**
 981  * @brief Add a destroy handler to a TDM buffer
 982  * @param[in] buffer A TDM buffer
 983  * @param[in] func A destroy handler
 984  * @param[in] user_data user data
 985  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
 986  * @see tdm_buffer_remove_destroy_handler
 987  * @remark
 988  * A backend module can add a TDM buffer destroy handler to a TDM buffer which
 989  * is a #tbm_surface_h object. When the TDM buffer is destroyed, this handler will
 990  * be called.
 991  */
 992 tdm_error
 993 tdm_buffer_add_destroy_handler(tbm_surface_h buffer,
 994                                                            tdm_buffer_destroy_handler func, void *user_data);
 995
 996 /**
 997  * @brief Remove a destroy handler from a TDM buffer
 998  * @param[in] buffer A TDM buffer
 999  * @param[in] func A destroy handler
1000  * @param[in] user_data user data
1001  * @see tdm_buffer_add_destroy_handler
1002  */
1003 void
1004 tdm_buffer_remove_destroy_handler(tbm_surface_h buffer,
1005                                                                   tdm_buffer_destroy_handler func, void *user_data);
1006
1007 /**
1008  * @brief Add a FD handler for activity on the given file descriptor
1009  * @param[in] dpy A display object
1010  * @param[in] fd A file descriptor
1011  * @param[in] mask to monitor FD
1012  * @param[in] func A FD handler function
1013  * @param[in] user_data user data
1014  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1015  * @return A FD event source
1016  * @see #tdm_event_loop_source_fd_update, #tdm_event_loop_source_remove
1017  */
1018 tdm_event_loop_source*
1019 tdm_event_loop_add_fd_handler(tdm_display *dpy, int fd, tdm_event_loop_mask mask,
1020                                                           tdm_event_loop_fd_handler func, void *user_data,
1021                                                           tdm_error *error);
1022
1023 /**
1024  * @brief Update the mask of the given FD event source
1025  * @param[in] source The given FD event source
1026  * @param[in] mask to monitor FD
1027  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1028  */
1029 tdm_error
1030 tdm_event_loop_source_fd_update(tdm_event_loop_source *source, tdm_event_loop_mask mask);
1031
1032 /**
1033  * @brief Add a timer handler
1034  * @param[in] dpy A display object
1035  * @param[in] func A timer handler function
1036  * @param[in] user_data user data
1037  * @param[out] error #TDM_ERROR_NONE if success. Otherwise, error value.
1038  * @return A timer event source
1039  * @see #tdm_event_loop_source_timer_update, #tdm_event_loop_source_remove
1040  */
1041 tdm_event_loop_source*
1042 tdm_event_loop_add_timer_handler(tdm_display *dpy, tdm_event_loop_timer_handler func,
1043                                                                  void *user_data, tdm_error *error);
1044
1045 /**
1046  * @brief Update the millisecond delay time of the given timer event source.
1047  * @param[in] source The given timer event source
1048  * @param[in] ms_delay The millisecond delay time. zero "0" disarms the timer.
1049  * @return #TDM_ERROR_NONE if success. Otherwise, error value.
1050  */
1051 tdm_error
1052 tdm_event_loop_source_timer_update(tdm_event_loop_source *source, unsigned int ms_delay);
1053
1054 /**
1055  * @brief Remove the given event source
1056  * @param[in] source The given event source
1057  * @see #tdm_event_loop_add_fd_handler, #tdm_event_loop_add_timer_handler
1058  */
1059 void
1060 tdm_event_loop_source_remove(tdm_event_loop_source *source);
1061
1062 #ifdef __cplusplus
1063 }
1064 #endif
1065
1066 #endif /* _TDM_BACKEND_H_ */