[libcamera-devel] [PATCH 03/11] ipa: ipu3: Document IPAIPU3::configure

[Laurent Pinchart]

Hi Jean-Michel,

Thank you for the patch.

On Mon, Sep 13, 2021 at 04:58:02PM +0200, Jean-Michel Hautbois wrote:
> 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>
> ---
>  src/ipa/ipu3/ipu3.cpp | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/src/ipa/ipu3/ipu3.cpp b/src/ipa/ipu3/ipu3.cpp
> index c71f2a6c..c0004ea6 100644
> --- a/src/ipa/ipu3/ipu3.cpp
> +++ b/src/ipa/ipu3/ipu3.cpp
> @@ -409,6 +409,18 @@ void IPAIPU3::calculateBdsGrid(const Size &bdsOutputSize)
>  			    << (int)bdsGrid.height << " << " << (int)bdsGrid.block_height_log2 << ")";
>  }
>  
> +/**
> + * \brief Configure the IPU3 IPA.

s/.$//

> + * \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.

Maybe that's part of a later patch in the series, but it would be useful
to document somewhere what the BDS is, ideally in a block diagram of the
ImgU. This can be done on top of this series too.

> + *
> + * 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.entityControls.empty()) {

-- 
Regards,

Laurent Pinchart