summaryrefslogtreecommitdiff
path: root/src/libcamera/ipa_controls.cpp
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2020-02-26 10:43:50 +0100
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2020-03-06 18:10:07 +0200
commit3a48f525f9f09300dac47413f9130860c47acbde (patch)
treeb0753f8850ad06073e95ed15e1df37d958ffa250 /src/libcamera/ipa_controls.cpp
parentca2ea056066ff8cdf4d6849d482414d6fd739e59 (diff)
libcamera: ipa: Remove unused IPA control types
The ipa_control_range_data structure is only used to document the IPA control serialization format, but isn't used in code at all as the ControlRange entries are directly serialized to a byte stream buffer. This applies to the ipa_control_value_data structure that is solely used by ipa_control_range_data. Expand the documentation of the IPA control serialization format to describe the layout of the control range data in words and diagrams instead of through a C structure. Remove the unused structures as a result. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'src/libcamera/ipa_controls.cpp')
-rw-r--r--src/libcamera/ipa_controls.cpp38
1 files changed, 16 insertions, 22 deletions
diff --git a/src/libcamera/ipa_controls.cpp b/src/libcamera/ipa_controls.cpp
index ed12830c..6ea71bc6 100644
--- a/src/libcamera/ipa_controls.cpp
+++ b/src/libcamera/ipa_controls.cpp
@@ -100,8 +100,22 @@
*
* Entries are described by the ipa_control_range_entry structure. They contain
* the numerical ID and type of the control. The control range data is stored
- * in the data section as described by the ipa_control_range_data structure.
- * The ipa_control_range_entry::offset field stores the offset from the
+ * in the data section as described by the following diagram.
+ *
+ * ~~~~
+ * +-------------------------+ .
+ * / | ... | | entry[n].offset
+ * | +-------------------------+ <-----ยด
+ * Data | | minimum value (#n) | \
+ * section | +-------------------------+ | Entry #n
+ * | | maximum value (#n) | /
+ * | +-------------------------+
+ * \ | ... |
+ * +-------------------------+
+ * ~~~~
+ *
+ * The minimum and maximum value are stored in the platform's native data
+ * format. The ipa_control_range_entry::offset field stores the offset from the
* beginning of the data section to the range data.
*
* Range data in the data section shall be stored in the same order as the
@@ -164,23 +178,3 @@
* \var ipa_control_range_entry::padding
* Padding bytes (shall be set to 0)
*/
-
-/**
- * \union ipa_control_value_data
- * \brief Serialized control value
- * \var ipa_control_value_data::b
- * Value for ControlTypeBool controls
- * \var ipa_control_value_data::i32
- * Value for ControlTypeInteger32 controls
- * \var ipa_control_value_data::i64
- * Value for ControlTypeInteger64 controls
- */
-
-/**
- * \struct ipa_control_range_data
- * \brief Serialized control range
- * \var ipa_control_range_data::min
- * The control minimum value
- * \var ipa_control_range_data::max
- * The control maximum value
- */