[PATCH 05/12] ipa: rkisp1: Document all AGC parameters in IPAFrameContext

[Paul Elder]

On Sun, Jun 16, 2024 at 07:39:03PM +0300, Laurent Pinchart wrote:
> The IPAFrameContext AGC documentation is lagging behind the
> implementation and misses many variables. Document them.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder at ideasonboard.com>

> ---
>  src/ipa/rkisp1/ipa_context.cpp | 22 ++++++++++++++++++++--
>  1 file changed, 20 insertions(+), 2 deletions(-)
> 
> diff --git a/src/ipa/rkisp1/ipa_context.cpp b/src/ipa/rkisp1/ipa_context.cpp
> index c4895479204c..9e445dcca933 100644
> --- a/src/ipa/rkisp1/ipa_context.cpp
> +++ b/src/ipa/rkisp1/ipa_context.cpp
> @@ -295,12 +295,30 @@ namespace libcamera::ipa::rkisp1 {
>   * applied to the sensor in order to take effect for this frame.
>   *
>   * \var IPAFrameContext::agc.exposure
> - * \brief Exposure time expressed as a number of lines
> + * \brief Exposure time expressed as a number of lines computed by the algorithm
>   *
>   * \var IPAFrameContext::agc.gain
> - * \brief Analogue gain multiplier
> + * \brief Analogue gain multiplier computed by the algorithm
>   *
>   * The gain should be adapted to the sensor specific gain code before applying.
> + *
> + * \var IPAFrameContext::agc.autoEnabled
> + * \brief Manual/automatic AGC state as set by the AeEnable control
> + *
> + * \var IPAFrameContext::agc.constraintMode
> + * \brief Constraint mode as set by the AeConstraintMode control
> + *
> + * \var IPAFrameContext::agc.exposureMode
> + * \brief Exposure mode as set by the AeExposureMode control
> + *
> + * \var IPAFrameContext::agc.meteringMode
> + * \brief Metering mode as set by the AeMeteringMode control
> + *
> + * \var IPAFrameContext::agc.maxShutterSpeed
> + * \brief Maximum frame duration as set by the FrameDurationLimits control
> + *
> + * \var IPAFrameContext::agc.update
> + * \brief Indicate if new ISP parameters need to be applied
>   */
>  
>  /**