[libcamera-devel,v5,3/7] libcamera: control_ids: Add comment to specify control direction
diff mbox series

Message ID 20200425004533.26907-4-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Patchset for libcamera controls
Related show

Commit Message

Laurent Pinchart April 25, 2020, 12:45 a.m. UTC 
From: Naushir Patuck <naush@raspberrypi.com>

Document that controls are bi-directional by default. If a control
is only returned in metadata, this must be specified in the control's
description.

Signed-off-by: Naushir Patuck <naush@raspberrypi.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/control_ids.cpp.in | 3 +++
 src/libcamera/control_ids.yaml   | 2 ++
 2 files changed, 5 insertions(+)

Patch
diff mbox series 

diff --git a/src/libcamera/control_ids.cpp.in b/src/libcamera/control_ids.cpp.in
index 99c511d0e712..cba6258d68dd 100644
--- a/src/libcamera/control_ids.cpp.in
+++ b/src/libcamera/control_ids.cpp.in
@@ -33,6 +33,9 @@  ${controls_def}
 
 /**
  * \brief List of all supported libcamera controls
+ *
+ * Unless otherwise stated, all controls are bi-directional, i.e. they can be
+ * set through Request::controls() and returned out through Request::metadata().
  */
 extern const ControlIdMap controls {
 ${controls_map}
diff --git a/src/libcamera/control_ids.yaml b/src/libcamera/control_ids.yaml
index 4befec746a59..bcbab195a374 100644
--- a/src/libcamera/control_ids.yaml
+++ b/src/libcamera/control_ids.yaml
@@ -4,6 +4,8 @@ 
 #
 %YAML 1.2
 ---
+# Unless otherwise stated, all controls are bi-directional, i.e. they can be
+# set through Request::controls() and returned out through Request::metadata().
 controls:
   - AeEnable:
       type: bool