[libcamera-devel] [PATCH v3 02/19] ipa: ipu3: Document IPAIPU3::configure

[Kieran Bingham]

Quoting Jean-Michel Hautbois (2021-10-22 16:12:01)
> Further extend the documentation for the IPAIPU3::configure operation.
> 
> Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois at ideasonboard.com>
> Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>


Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

> ---
>  src/ipa/ipu3/ipu3.cpp | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/src/ipa/ipu3/ipu3.cpp b/src/ipa/ipu3/ipu3.cpp
> index b5438ed1..6e28a5aa 100644
> --- a/src/ipa/ipu3/ipu3.cpp
> +++ b/src/ipa/ipu3/ipu3.cpp
> @@ -502,6 +502,21 @@ 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
> + * \param[in] ipaControls The IPA controls to update
> + *
> + * 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.
> + *
> + * \todo Document what the BDS is, ideally in a block diagram of the ImgU.
> + *
> + * All algorithm modules are called to allow them to prepare the
> + * \a IPASessionConfiguration structure for the \a IPAContext.
> + */
>  int IPAIPU3::configure(const IPAConfigInfo &configInfo,
>                        ControlInfoMap *ipaControls)
>  {
> -- 
> 2.32.0
>