common: add description for pp, capture capability 61/173161/2
authorBoram Park <boram1288.park@samsung.com>
Tue, 20 Mar 2018 01:53:30 +0000 (10:53 +0900)
committerBoram Park <boram1288.park@samsung.com>
Tue, 20 Mar 2018 08:09:37 +0000 (17:09 +0900)
Change-Id: I3e11cb35c4a4f752282756e339e07e4f939437c0

include/tdm_common.h

index e97170b..35d5c91 100644 (file)
@@ -148,6 +148,9 @@ typedef enum {
 
 /**
  * @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 */
@@ -158,6 +161,9 @@ typedef enum {
 
 /**
  * @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 */