Package version up to 2.7.1

[platform/core/uifw/libtdm.git] / include / tdm_common.h

diff --git a/include/tdm_common.h b/include/tdm_common.h
index 6ba2784..70a081c 100644 (file)
--- a/include/tdm_common.h
+++ b/include/tdm_common.h
@@ -9,7 +9,7 @@
  *          Taeheon Kim <th908.kim@samsung.com>,
  *          YoungJun Cho <yj44.cho@samsung.com>,
  *          SooChan Lim <sc1.lim@samsung.com>,
- *          Boram Park <sc1.lim@samsung.com>
+ *          Boram Park <boram1288.park@samsung.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the
@@ -68,6 +68,9 @@ typedef enum {
        TDM_ERROR_NO_CAPABILITY         = -9, /**< no capability */
        TDM_ERROR_DPMS_OFF              = -10, /**< dpms off */
        TDM_ERROR_OUTPUT_DISCONNECTED   = -11, /**< output disconnected */
+       TDM_ERROR_PROTOCOL_ERROR        = -12, /**< protocol error */
+       TDM_ERROR_TIMEOUT               = -13, /**< timeout */
+       TDM_ERROR_NO_MODULE             = -14, /**< no backend module */
 } tdm_error;
 
 /**
@@ -87,10 +90,15 @@ typedef enum {
 /**
  * @brief The output capability enumeration
  * @details
- * @remark
+ * If a backend module provides #TDM_OUTPUT_CAPABILITY_EXTENDED_DPMS, we can set
+ * an extended DPMS mode to an output which a backend module supports.
+ * Don't use the low-4bit for an extended DPMS mode value. It's used for default
+ * DPMS modes.
  */
 typedef enum {
        TDM_OUTPUT_CAPABILITY_ASYNC_DPMS         = (1 << 0), /**< if a outupt supports asynchronous DPMS operation */
+       TDM_OUTPUT_CAPABILITY_HWC                = (1 << 1), /**< if a outupt supports hwc operation @since 2.0.0*/
+       TDM_OUTPUT_CAPABILITY_EXTENDED_DPMS      = (1 << 2), /**< if a outupt supports extended DPMS operation @since 2.0.0 */
 } tdm_output_capability;
 
 /**
@@ -130,27 +138,23 @@ typedef enum {
 } tdm_layer_capability;
 
 /**
- * @brief The hwc window capability enumeration
- * @since 2.0.0
- */
-typedef enum {
-       TDM_HWC_WINDOW_VIDEO_CAPABILITY_SCALE          = (1 << 1), /**< if a hwc window video has scale capability  */
-       TDM_HWC_WINDOW_VIDEO_CAPABILITY_TRANSFORM      = (1 << 2), /**< if a hwc window video has transform capability  */
-       TDM_HWC_WINDOW_VIDEO_CAPABILITY_SCANOUT        = (1 << 3), /**< if a hwc_window video allows a scanout buffer only */
-} tdm_hwc_window_video_capability;
-
-/**
  * @brief The pp capability enumeration
+ * @details The scale, transform and CSC functionalities seem the default functions of PP.
+ * If hardware device doesn't support one of them, we'd better let a developer know
+ * what a backend doesn't support like TDM_PP_CAPABILITY_NO_CSC.
  */
 typedef enum {
        TDM_PP_CAPABILITY_SYNC           = (1 << 0), /**< The pp device supports synchronous operation */
        TDM_PP_CAPABILITY_ASYNC          = (1 << 1), /**< The pp device supports asynchronous operation */
-       TDM_PP_CAPABILITY_SCALE          = (1 << 4), /**< The pp device supports scale operation */
-       TDM_PP_CAPABILITY_TRANSFORM      = (1 << 5), /**< The pp device supports transform operation */
+       TDM_PP_CAPABILITY_SCANOUT        = (1 << 4), /**< The pp device supports only scanout buffer */
+       TDM_PP_CAPABILITY_NO_CSC         = (1 << 5), /**< The pp device doesn't supports Color Space Conversion */
 } tdm_pp_capability;
 
 /**
  * @brief The capture capability enumeration
+ * @details The scale, transform and CSC functionalities seem the default functions of capture.
+ * If hardware device doesn't support one of them, we'd better let a developer know
+ * what a backend doesn't support like TDM_PP_CAPABILITY_NO_CSC.
  */
 typedef enum {
        TDM_CAPTURE_CAPABILITY_OUTPUT    = (1 << 0), /**< The capture device supports to dump a output */
@@ -213,10 +217,11 @@ typedef enum {
  * @details bit compatible with the libdrm definitions.
  */
 typedef enum {
-       TDM_OUTPUT_DPMS_ON,         /**< On */
-       TDM_OUTPUT_DPMS_STANDBY,    /**< StandBy */
-       TDM_OUTPUT_DPMS_SUSPEND,    /**< Suspend */
-       TDM_OUTPUT_DPMS_OFF,        /**< Off */
+       TDM_OUTPUT_DPMS_ON,         /**< On, Vsync On */
+       TDM_OUTPUT_DPMS_STANDBY,    /**< StandBy, Vsync On */
+       TDM_OUTPUT_DPMS_SUSPEND,    /**< Suspend, Vsync Off */
+       TDM_OUTPUT_DPMS_OFF,        /**< Off, Vsync Off */
+       TDM_OUTPUT_DPMS_AOD = 0x10, /**< AOD, Vsync On, extended DPMS mode */
 } tdm_output_dpms;
 
 /**
@@ -254,6 +259,17 @@ typedef enum {
        TDM_OUTPUT_MODE_FLAG_CLKDIV2    = (1 << 13),
 } tdm_output_mode_flag;
 
+/*
+ * @brief The hwc video capability enumeration
+ * @since 2.7.0
+ */
+typedef enum {
+       TDM_HWC_CAPABILITY_VIDEO_STREAM         = (1 << 1), /**< if a hwc has video stream capability  */
+       TDM_HWC_CAPABILITY_VIDEO_SCALE          = (1 << 2), /**< if a hwc allows to scale the video buffer  */
+       TDM_HWC_CAPABILITY_VIDEO_TRANSFORM      = (1 << 3), /**< if a hwc allows video to transform the video buffer  */
+       TDM_HWC_CAPABILITY_VIDEO_SCANOUT        = (1 << 4), /**< if a hwc allows video to accept the scanout buffer only */
+} tdm_hwc_capability;
+
 /**
  * @brief The size structure
  */
@@ -272,11 +288,6 @@ typedef struct _tdm_pos {
        unsigned int h;
 } tdm_pos;
 
-typedef struct _tdm_hwc_region {
-       unsigned int num_rects;
-       tdm_pos const *rects;
-} tdm_hwc_region;
-
 /**
  * @brief The tdm value type enumeration
  */
@@ -300,14 +311,6 @@ typedef union {
        uint64_t u64;
 } tdm_value;
 
-/**
- * @brief The hwc window flag enumeration
- * @since 2.0.0
- */
-typedef enum {
-       TDM_HWC_WINDOW_FLAG_SKIP     = (1 << 0),
-} tdm_hwc_window_flag;
-
 #ifdef __cplusplus
 }
 #endif