include/tdm_types.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_TYPES_H_
  37 #define _TDM_TYPES_H_
  38
  39 #include <tbm_surface.h>
  40
  41 #include "tdm_common.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * @file tdm_types.h
  49  * @brief The header file which defines Enumerations and Structures for frontend and backend.
  50  * @details
  51  * Both frontend(@ref tdm.h) and backend(@ref tdm_backend.h) header files
  52  * include @ref tdm_types.h
  53  * @par Example
  54  * @code
  55  * #include <tdm.h>    //for a frontend user
  56  * @endcode
  57  * @code
  58  * #include <tdm_backend.h>  //for a vendor to implement a backend module
  59  * @endcode
  60  */
  61
  62 typedef enum {
  63         TDM_EVENT_LOOP_READABLE = (1 << 0),
  64         TDM_EVENT_LOOP_WRITABLE = (1 << 1),
  65         TDM_EVENT_LOOP_HANGUP   = (1 << 2),
  66         TDM_EVENT_LOOP_ERROR    = (1 << 3),
  67 } tdm_event_loop_mask;
  68
  69 /**
  70  * @brief The display capability enumeration
  71  */
  72 typedef enum {
  73         TDM_DISPLAY_CAPABILITY_PP       = (1 << 0), /**< if hardware supports pp operation */
  74         TDM_DISPLAY_CAPABILITY_CAPTURE  = (1 << 1), /**< if hardware supports capture operation */
  75 } tdm_display_capability;
  76
  77 /**
  78  * @brief The output mode structure
  79  */
  80 typedef struct _tdm_output_mode {
  81         unsigned int clock;
  82         unsigned int hdisplay, hsync_start, hsync_end, htotal, hskew;
  83         unsigned int vdisplay, vsync_start, vsync_end, vtotal, vscan;
  84         unsigned int vrefresh;
  85         unsigned int flags;
  86         unsigned int type;
  87         char name[TDM_NAME_LEN];
  88 } tdm_output_mode;
  89
  90 /**
  91  * @brief The property structure
  92  */
  93 typedef struct _tdm_prop {
  94         unsigned int id;
  95         char name[TDM_NAME_LEN];
  96         tdm_value_type type;
  97 } tdm_prop;
  98
  99 /**
 100  * @brief The info config structure
 101  */
 102 typedef struct _tdm_info_config {
 103         tdm_size size;
 104         tdm_pos pos;
 105         tbm_format format;
 106 } tdm_info_config;
 107
 108 /**
 109  * @brief The layer info structre
 110  */
 111 typedef struct _tdm_info_layer {
 112         tdm_info_config src_config;
 113         tdm_pos dst_pos;
 114         tdm_transform transform;
 115 } tdm_info_layer;
 116
 117 /**
 118  * @brief The hwc window info structure
 119  * @since 2.0.0
 120  */
 121 typedef struct _tdm_hwc_window_info {
 122         tdm_info_config src_config;
 123         tdm_pos dst_pos;
 124         tdm_transform transform;
 125 } tdm_hwc_window_info;
 126
 127 typedef struct _tdm_hwc_region {
 128         unsigned int num_rects;
 129         tdm_pos const *rects;
 130 } tdm_hwc_region;
 131
 132 /**
 133  * @brief The pp info structre
 134  */
 135 typedef struct _tdm_info_pp {
 136         tdm_info_config src_config;
 137         tdm_info_config dst_config;
 138         tdm_transform transform;
 139         int sync;
 140         int flags;
 141 } tdm_info_pp;
 142
 143 /**
 144  * @brief The capture info structre
 145  */
 146 typedef struct _tdm_info_capture {
 147         tdm_info_config dst_config;
 148         tdm_transform transform;
 149         tdm_capture_type type;
 150         int frequency;
 151         int flags;
 152 } tdm_info_capture;
 153
 154 /**
 155  * @brief Possible composition types for a given window
 156  * @since 2.0.0
 157  */
 158 typedef enum {
 159
 160         /** Set by the client for an invisible window. The value by default.
 161          *
 162          * The device ignores windows of this type.
 163          */
 164         TDM_COMPOSITION_NONE = 0,
 165
 166         /** The client will composite this window into the client target window
 167          *
 168          * User can choose this type for window to avoid a hardware composition for
 169          * this window.
 170          *
 171          * The device must not request any composition type changes for windows of
 172          * this type.
 173          */
 174         TDM_COMPOSITION_CLIENT = 1,
 175
 176         /** Set by the client before tdm_output_hwc_validate().
 177          *
 178          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 179          * TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT. */
 180         TDM_COMPOSITION_DEVICE_CANDIDATE = 2,
 181
 182         /** Set by the HWC after tdm_output_hwc_validate().
 183          *
 184          * The device will handle the composition of this window through a hardware
 185          * overlay or other similar means.
 186          *
 187          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 188          * TDM_COMPOSITION_CLIENT or TDM_COMPOSITION_DEVICE_CANDIDATE. */
 189         TDM_COMPOSITION_DEVICE = 3,
 190
 191         /** Similar to DEVICE, but the position of this layer may also be set
 192          * asynchronously through layer_set_cursor_position. If this functionality is not
 193          * supported on a layer that the client sets to TDM_COMPOSITION_CURSOR, the
 194          * device must request that the composition type of that layer is changed to
 195          * TDM_COMPOSITION_CLIENT upon the next call to tdm_output_hwc_validate().
 196          *
 197          * Upon tdm_output_hwc_validate(), the device may request a change from this type to
 198          * either TDM_COMPOSITION_DEVICE or TDM_COMPOSITION_CLIENT. Changing to
 199          * TDM_COMPOSITION_DEVICE will prevent the use of layer_set_cursor_position but
 200          * still permit the device to composite the layer. */
 201         TDM_COMPOSITION_CURSOR = 4,
 202
 203         /** This type is for the VIDEO window which can be set to the reserved hw overlay
 204          *  which is assigned by the device.
 205          *
 206          * Normally, this VIDEO window displays under the primary hw overlayer of the output. */
 207         TDM_COMPOSITION_VIDEO = 5,
 208 } tdm_hwc_window_composition;
 209
 210 /**
 211  * @brief The hwc window flag enumeration
 212  * @since 2.0.0
 213  */
 214 typedef enum {
 215         TDM_HWC_WINDOW_FLAG_NONE     = 0,
 216 } tdm_hwc_window_flag;
 217
 218 /**
 219  * @brief The tdm display object
 220  */
 221 typedef void tdm_display;
 222
 223 /**
 224  * @brief The tdm output object
 225  */
 226 typedef void tdm_output;
 227
 228 /**
 229  * @brief The tdm layer object
 230  */
 231 typedef void tdm_layer;
 232
 233 /**
 234  * @brief The tdm window object
 235  * @since 2.0.0
 236  */
 237 typedef void tdm_hwc_window;
 238
 239 /**
 240  * @brief The tdm capture object
 241  */
 242 typedef void tdm_capture;
 243
 244 /**
 245  * @brief The tdm pp object
 246  */
 247 typedef void tdm_pp;
 248
 249 /**
 250  * @brief The tdm vblank object
 251  */
 252 typedef void tdm_vblank;
 253
 254 /**
 255  * @brief The output change handler
 256  * @details This handler will be called when the status of a output object is
 257  * changed in runtime.
 258  */
 259 typedef void (*tdm_output_change_handler)(tdm_output *output,
 260                                                                                   tdm_output_change_type type,
 261                                                                                   tdm_value value,
 262                                                                                   void *user_data);
 263
 264 /**
 265  * @brief The vblank handler
 266  * @see output_set_vblank_handler() function of #tdm_func_display
 267  */
 268 typedef void (*tdm_output_vblank_handler)(tdm_output *output, unsigned int sequence,
 269                                                                                   unsigned int tv_sec, unsigned int tv_usec,
 270                                                                                   void *user_data);
 271
 272 /**
 273  * @brief The output commit handler
 274  * @see output_set_commit_handler() function of #tdm_func_display
 275  */
 276 typedef void (*tdm_output_commit_handler)(tdm_output *output, unsigned int sequence,
 277                                                                                   unsigned int tv_sec, unsigned int tv_usec,
 278                                                                                   void *user_data);
 279
 280 /**
 281  * @brief The layer commit handler
 282  */
 283 typedef void (*tdm_layer_commit_handler)(tdm_layer *layer, unsigned int sequence,
 284                                                                                  unsigned int tv_sec, unsigned int tv_usec,
 285                                                                                  void *user_data);
 286
 287 /**
 288  * @brief The hwc_window commit handler
 289  */
 290 typedef void (*tdm_hwc_window_commit_handler)(tdm_hwc_window *hwc_window, unsigned int sequence,
 291                                                                                  unsigned int tv_sec, unsigned int tv_usec,
 292                                                                                  void *user_data);
 293
 294 /**
 295  * @brief The output target_buffer commit handler
 296  */
 297 typedef void (*tdm_output_hwc_target_buffer_commit_handler)(tdm_output *output, unsigned int sequence,
 298                                                                                  unsigned int tv_sec, unsigned int tv_usec,
 299                                                                                  void *user_data);
 300
 301 /**
 302  * @brief The done handler of a pp object
 303  */
 304 typedef void (*tdm_pp_done_handler)(tdm_pp *pp, tbm_surface_h src,
 305                                                                         tbm_surface_h dst, void *user_data);
 306
 307 /**
 308  * @brief The done handler of a capture object
 309  */
 310 typedef void (*tdm_capture_done_handler)(tdm_capture *capture,
 311                                                                                  tbm_surface_h buffer, void *user_data);
 312
 313 /**
 314  * @brief The create handler of a vblank object
 315  */
 316 typedef void (*tdm_vblank_create_handler)(tdm_vblank *vblank, void *user_data);
 317
 318 /**
 319  * @brief The 'need to validate' handler of an output object
 320  * @since 2.0.0
 321  */
 322 typedef void (*tdm_output_need_validate_handler)(tdm_output *output);
 323
 324 #ifdef __cplusplus
 325 }
 326 #endif
 327
 328 #endif /* _TDM_TYPES_H_ */