From 47d09a13b3acead2cd6007d6b6022931756c9ae7 Mon Sep 17 00:00:00 2001
From: Naushir Patuck <naush@raspberrypi.com>
Date: Fri, 24 Apr 2020 11:46:56 +0100
Subject: libcamera: control_ids: Add comment to specify control direction

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>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/control_ids.cpp.in | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src/libcamera/control_ids.cpp.in')

diff --git a/src/libcamera/control_ids.cpp.in b/src/libcamera/control_ids.cpp.in
index 99c511d0..cba6258d 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}
-- 
cgit v1.2.1