vblank: return TDM_ERROR_TIMEOUT when timeout occurs

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

diff --git a/include/tdm_common.h b/include/tdm_common.h
index 637d883..cfc031c 100644 (file)
--- a/include/tdm_common.h
+++ b/include/tdm_common.h
@@ -68,6 +68,7 @@ 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_TIMEOUT               = -12, /**< timeout */
 } tdm_error;
 
 /**
@@ -87,11 +88,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;
 
 /**
@@ -214,10 +219,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;
 
 /**