[libcamera-devel,02/18] ipa: ipu3: Document IPAIPU3::configure
diff mbox series

Message ID 20210930095513.76213-3-jeanmichel.hautbois@ideasonboard.com
State Changes Requested
Headers show
Series
  • Document IPU3 IPA
Related show

Commit Message

Jean-Michel Hautbois Sept. 30, 2021, 9:54 a.m. UTC 
Further extend the documentation for the IPAIPU3::configure operation.

Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/ipa/ipu3/ipu3.cpp | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Patch
diff mbox series 

diff --git a/src/ipa/ipu3/ipu3.cpp b/src/ipa/ipu3/ipu3.cpp
index bf8fc1e8..b4c889f1 100644
--- a/src/ipa/ipu3/ipu3.cpp
+++ b/src/ipa/ipu3/ipu3.cpp
@@ -426,6 +426,18 @@  void IPAIPU3::calculateBdsGrid(const Size &bdsOutputSize)
 			    << (int)bdsGrid.height << " << " << (int)bdsGrid.block_height_log2 << ")";
 }
 
+/**
+ * \brief Configure the IPU3 IPA.
+ * \param[in] configInfo The IPA configuration data, received from the pipeline
+ * handler
+ *
+ * Calculate the best grid for the statistics based on the Pipeline Handler BDS
+ * output, and parse the minimum and maximum exposure and analogue gain control
+ * values.
+ *
+ * All algorithm modules are called to allow them to prepare the
+ * \a IPASessionConfiguration structure for the \a IPAContext.
+ */
 int IPAIPU3::configure(const IPAConfigInfo &configInfo)
 {
 	if (configInfo.sensorControls.empty()) {