include/tdm_common.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_COMMON_H_
  37 #define _TDM_COMMON_H_
  38
  39 #include <stdint.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #define TDM_NAME_LEN        64
  46 #define TDM_PATH_LEN        1024
  47 #define TDM_VBLANK_DEFAULT_NAME   "Unknown"
  48
  49 /**
  50  * @file tdm_common.h
  51  * @brief The header file which defines Enumerations and Structures for TDM
  52  * frontend, backend and client.
  53  */
  54
  55 /**
  56  * @brief The error enumeration
  57  */
  58 typedef enum {
  59         TDM_ERROR_NONE                  = 0,  /**< none */
  60         TDM_ERROR_BAD_REQUEST           = -1, /**< bad request */
  61         TDM_ERROR_OPERATION_FAILED      = -2, /**< operaion failed */
  62         TDM_ERROR_INVALID_PARAMETER     = -3, /**< wrong input parameter */
  63         TDM_ERROR_PERMISSION_DENIED     = -4, /**< access denied */
  64         TDM_ERROR_BUSY                  = -5, /**< hardware resource busy */
  65         TDM_ERROR_OUT_OF_MEMORY         = -6, /**< no free memory */
  66         TDM_ERROR_BAD_MODULE            = -7, /**< bad backend module */
  67         TDM_ERROR_NOT_IMPLEMENTED       = -8, /**< not implemented */
  68         TDM_ERROR_NO_CAPABILITY         = -9, /**< no capability */
  69         TDM_ERROR_DPMS_OFF              = -10, /**< dpms off */
  70         TDM_ERROR_OUTPUT_DISCONNECTED   = -11, /**< output disconnected */
  71         TDM_ERROR_TIMEOUT               = -12, /**< timeout */
  72 } tdm_error;
  73
  74 /**
  75  * @brief The transform enumeration(rotate, flip)
  76  */
  77 typedef enum {
  78         TDM_TRANSFORM_NORMAL            = 0, /**< no transform */
  79         TDM_TRANSFORM_90                = 1, /**< rotate 90 */
  80         TDM_TRANSFORM_180               = 2, /**< rotate 180 */
  81         TDM_TRANSFORM_270               = 3, /**< rotate 270 */
  82         TDM_TRANSFORM_FLIPPED           = 4, /**< no rotate and horizontal flip */
  83         TDM_TRANSFORM_FLIPPED_90        = 5, /**< rotate 90 and horizontal flip */
  84         TDM_TRANSFORM_FLIPPED_180       = 6, /**< rotate 180 and horizontal flip */
  85         TDM_TRANSFORM_FLIPPED_270       = 7, /**< rotate 270 and horizontal flip */
  86 } tdm_transform;
  87
  88 /**
  89  * @brief The output capability enumeration
  90  * @details
  91  * @remark
  92  */
  93 typedef enum {
  94         TDM_OUTPUT_CAPABILITY_ASYNC_DPMS         = (1 << 0), /**< if a outupt supports asynchronous DPMS operation */
  95 } tdm_output_capability;
  96
  97 /**
  98  * @brief The layer capability enumeration
  99  * @details
 100  * A layer can have one of CURSOR, PRIMARY and OVERLAY capability. And a layer
 101  * also can have one of GRAPHIC and VIDEO capability. And a layer also can have
 102  * SCALE and TRANSFORM capability.\n
 103  * @par Example
 104  * @code
 105  *  //For example
 106  *  capabilities = TDM_LAYER_CAPABILITY_PRIMARY | TDM_LAYER_CAPABILITY_GRAPHIC;
 107  *  capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_GRAPHIC | TDM_LAYER_CAPABILITY_SCALE;
 108  *  capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_GRAPHIC | TDM_LAYER_CAPABILITY_SCALE | TDM_LAYER_CAPABILITY_TRANSFORM;
 109  *  capabilities = TDM_LAYER_CAPABILITY_CURSOR | TDM_LAYER_CAPABILITY_GRAPHIC;
 110  *  capabilities = TDM_LAYER_CAPABILITY_OVERLAY | TDM_LAYER_CAPABILITY_VIDEO;
 111  * @endcode
 112  * @remark
 113  * - When a video plays, in most of cases, video buffers will be displayed to
 114  * a GRAPHIC layer after converting RGB buffers via PP. In this case, a backend
 115  * module doesn't need to offer VIDEO layer.
 116  * - But in case that s vendor wants to handle a video by their own way,
 117  * a backend module offer VIDEO layers. And a display server will pass a video
 118  * buffer to a VIDEO layer without converting.
 119  */
 120 typedef enum {
 121         TDM_LAYER_CAPABILITY_CURSOR         = (1 << 0), /**< cursor */
 122         TDM_LAYER_CAPABILITY_PRIMARY        = (1 << 1), /**< primary */
 123         TDM_LAYER_CAPABILITY_OVERLAY        = (1 << 2), /**< overlay */
 124         TDM_LAYER_CAPABILITY_GRAPHIC        = (1 << 4), /**< graphic */
 125         TDM_LAYER_CAPABILITY_VIDEO          = (1 << 5), /**< video */
 126         TDM_LAYER_CAPABILITY_SCALE          = (1 << 8), /**< if a layer has scale capability  */
 127         TDM_LAYER_CAPABILITY_TRANSFORM      = (1 << 9), /**< if a layer has transform capability  */
 128         TDM_LAYER_CAPABILITY_SCANOUT        = (1 << 10), /**< if a layer allows a scanout buffer only */
 129         TDM_LAYER_CAPABILITY_RESEVED_MEMORY = (1 << 11), /**< if a layer allows a reserved buffer only */
 130         TDM_LAYER_CAPABILITY_NO_CROP        = (1 << 12), /**< if a layer has no cropping capability */
 131 } tdm_layer_capability;
 132
 133 /**
 134  * @brief The pp capability enumeration
 135  */
 136 typedef enum {
 137         TDM_PP_CAPABILITY_SYNC           = (1 << 0), /**< The pp device supports synchronous operation */
 138         TDM_PP_CAPABILITY_ASYNC          = (1 << 1), /**< The pp device supports asynchronous operation */
 139         TDM_PP_CAPABILITY_SCALE          = (1 << 4), /**< The pp device supports scale operation */
 140         TDM_PP_CAPABILITY_TRANSFORM      = (1 << 5), /**< The pp device supports transform operation */
 141 } tdm_pp_capability;
 142
 143 /**
 144  * @brief The capture capability enumeration
 145  */
 146 typedef enum {
 147         TDM_CAPTURE_CAPABILITY_OUTPUT    = (1 << 0), /**< The capture device supports to dump a output */
 148         TDM_CAPTURE_CAPABILITY_LAYER     = (1 << 1), /**< The capture device supports to dump a layer */
 149         TDM_CAPTURE_CAPABILITY_ONESHOT   = (1 << 4), /**< The capture device supports oneshot dump */
 150         TDM_CAPTURE_CAPABILITY_STREAM    = (1 << 5), /**< The capture device supports streamp sump */
 151 } tdm_capture_capability;
 152
 153 /**
 154  * @brief The capture type enumeration
 155  */
 156 typedef enum {
 157         TDM_CAPTURE_TYPE_ONESHOT    = (1 << 0), /**< The oneshot capture */
 158         TDM_CAPTURE_TYPE_STREAM     = (1 << 1), /**< The stream capture */
 159 } tdm_capture_type;
 160
 161 /**
 162  * @brief The output change enumeration of #tdm_output_change_handler
 163  */
 164 typedef enum {
 165         TDM_OUTPUT_CHANGE_CONNECTION    = (1 << 0), /**< connection chagne */
 166         TDM_OUTPUT_CHANGE_DPMS          = (1 << 1), /**< dpms change */
 167 } tdm_output_change_type;
 168
 169 /**
 170  * @brief The output connection status enumeration
 171  */
 172 typedef enum {
 173         TDM_OUTPUT_CONN_STATUS_DISCONNECTED, /**< output disconnected */
 174         TDM_OUTPUT_CONN_STATUS_CONNECTED,    /**< output connected */
 175         TDM_OUTPUT_CONN_STATUS_MODE_SETTED,  /**< output connected and setted a mode */
 176 } tdm_output_conn_status;
 177
 178 /**
 179  * @brief The output connection status enumeration
 180  * @details bit compatible with the libdrm definitions.
 181  */
 182 typedef enum {
 183         TDM_OUTPUT_TYPE_Unknown,        /**< unknown */
 184         TDM_OUTPUT_TYPE_VGA,            /**< VGA connection */
 185         TDM_OUTPUT_TYPE_DVII,           /**< DVII connection */
 186         TDM_OUTPUT_TYPE_DVID,           /**< DVID connection */
 187         TDM_OUTPUT_TYPE_DVIA,           /**< DVIA connection */
 188         TDM_OUTPUT_TYPE_Composite,      /**< Composite connection */
 189         TDM_OUTPUT_TYPE_SVIDEO,         /**< SVIDEO connection */
 190         TDM_OUTPUT_TYPE_LVDS,           /**< LVDS connection */
 191         TDM_OUTPUT_TYPE_Component,      /**< Component connection */
 192         TDM_OUTPUT_TYPE_9PinDIN,        /**< 9PinDIN connection */
 193         TDM_OUTPUT_TYPE_DisplayPort,    /**< DisplayPort connection */
 194         TDM_OUTPUT_TYPE_HDMIA,          /**< HDMIA connection */
 195         TDM_OUTPUT_TYPE_HDMIB,          /**< HDMIB connection */
 196         TDM_OUTPUT_TYPE_TV,             /**< TV connection */
 197         TDM_OUTPUT_TYPE_eDP,            /**< eDP connection */
 198         TDM_OUTPUT_TYPE_VIRTUAL,        /**< Virtual connection for WiFi Display */
 199         TDM_OUTPUT_TYPE_DSI,            /**< DSI connection */
 200 } tdm_output_type;
 201
 202 /**
 203  * @brief The DPMS enumeration
 204  * @details bit compatible with the libdrm definitions.
 205  */
 206 typedef enum {
 207         TDM_OUTPUT_DPMS_ON,         /**< On */
 208         TDM_OUTPUT_DPMS_STANDBY,    /**< StandBy */
 209         TDM_OUTPUT_DPMS_SUSPEND,    /**< Suspend */
 210         TDM_OUTPUT_DPMS_OFF,        /**< Off */
 211 } tdm_output_dpms;
 212
 213 /**
 214  * @brief The output mode type enumeration
 215  * @details bit compatible with the libdrm definitions.
 216  */
 217 typedef enum {
 218         TDM_OUTPUT_MODE_TYPE_BUILTIN    = (1 << 0),
 219         TDM_OUTPUT_MODE_TYPE_CLOCK_C    = ((1 << 1) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
 220         TDM_OUTPUT_MODE_TYPE_CRTC_C     = ((1 << 2) | TDM_OUTPUT_MODE_TYPE_BUILTIN),
 221         TDM_OUTPUT_MODE_TYPE_PREFERRED  = (1 << 3),
 222         TDM_OUTPUT_MODE_TYPE_DEFAULT    = (1 << 4),
 223         TDM_OUTPUT_MODE_TYPE_USERDEF    = (1 << 5),
 224         TDM_OUTPUT_MODE_TYPE_DRIVER     = (1 << 6),
 225 } tdm_output_mode_type;
 226
 227 /**
 228  * @brief The output mode flag enumeration
 229  * @details bit compatible with the libdrm definitions.
 230  */
 231 typedef enum {
 232         TDM_OUTPUT_MODE_FLAG_PHSYNC     = (1 << 0),
 233         TDM_OUTPUT_MODE_FLAG_NHSYNC     = (1 << 1),
 234         TDM_OUTPUT_MODE_FLAG_PVSYNC     = (1 << 2),
 235         TDM_OUTPUT_MODE_FLAG_NVSYNC     = (1 << 3),
 236         TDM_OUTPUT_MODE_FLAG_INTERLACE  = (1 << 4),
 237         TDM_OUTPUT_MODE_FLAG_DBLSCAN    = (1 << 5),
 238         TDM_OUTPUT_MODE_FLAG_CSYNC      = (1 << 6),
 239         TDM_OUTPUT_MODE_FLAG_PCSYNC     = (1 << 7),
 240         TDM_OUTPUT_MODE_FLAG_NCSYNC     = (1 << 8),
 241         TDM_OUTPUT_MODE_FLAG_HSKEW      = (1 << 9), /* hskew provided */
 242         TDM_OUTPUT_MODE_FLAG_BCAST      = (1 << 10),
 243         TDM_OUTPUT_MODE_FLAG_PIXMUX     = (1 << 11),
 244         TDM_OUTPUT_MODE_FLAG_DBLCLK     = (1 << 12),
 245         TDM_OUTPUT_MODE_FLAG_CLKDIV2    = (1 << 13),
 246 } tdm_output_mode_flag;
 247
 248 /**
 249  * @brief The size structure
 250  */
 251 typedef struct _tdm_size {
 252         unsigned int h;     /**< width */
 253         unsigned int v;     /**< height */
 254 } tdm_size;
 255
 256 /**
 257  * @brief The pos structure
 258  */
 259 typedef struct _tdm_pos {
 260         unsigned int x;
 261         unsigned int y;
 262         unsigned int w;
 263         unsigned int h;
 264 } tdm_pos;
 265
 266 /**
 267  * @brief The tdm value type enumeration
 268  */
 269 typedef enum {
 270         TDM_VALUE_TYPE_UNKNOWN,
 271         TDM_VALUE_TYPE_PTR,
 272         TDM_VALUE_TYPE_INT32,
 273         TDM_VALUE_TYPE_UINT32,
 274         TDM_VALUE_TYPE_INT64,
 275         TDM_VALUE_TYPE_UINT64,
 276 } tdm_value_type;
 277
 278 /**
 279  * @brief The value union
 280  */
 281 typedef union {
 282         void     *ptr;
 283         int32_t  s32;
 284         uint32_t u32;
 285         int64_t  s64;
 286         uint64_t u64;
 287 } tdm_value;
 288
 289 #ifdef __cplusplus
 290 }
 291 #endif
 292
 293 #endif /* _TDM_COMMON_H_ */