[libcamera-devel] ipa: ipu3: Fix IPAContext documentation
diff mbox series

Message ID 20211119102219.55319-1-jeanmichel.hautbois@ideasonboard.com
State Accepted
Commit 8212671ee74ec89c1422807e4bc80a0fb24ff9c2
Headers show
Series
  • [libcamera-devel] ipa: ipu3: Fix IPAContext documentation
Related show

Commit Message

Jean-Michel Hautbois Nov. 19, 2021, 10:22 a.m. UTC
The shutter speed limits and analogue gains limits are in the agc
structure in IPASessionConfiguration. They are badly mentionned as
beeing part of the grid structure, fix it.

Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
---
 src/ipa/ipu3/ipa_context.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Kieran Bingham Nov. 19, 2021, 10:58 a.m. UTC | #1
Quoting Jean-Michel Hautbois (2021-11-19 10:22:19)
> The shutter speed limits and analogue gains limits are in the agc
> structure in IPASessionConfiguration. They are badly mentionned as

/mentionned/mentioned/

> beeing part of the grid structure, fix it.

/beeing/being/


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

> 
> Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
> ---
>  src/ipa/ipu3/ipa_context.cpp | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
> index 99caf9ad..86794ac1 100644
> --- a/src/ipa/ipu3/ipa_context.cpp
> +++ b/src/ipa/ipu3/ipa_context.cpp
> @@ -76,13 +76,13 @@ namespace libcamera::ipa::ipu3 {
>   * \var IPASessionConfiguration::agc.minShutterSpeed
>   * \brief Minimum shutter speed supported with the configured sensor
>   *
> - * \var IPASessionConfiguration::grid.maxShutterSpeed
> + * \var IPASessionConfiguration::agc.maxShutterSpeed
>   * \brief Maximum shutter speed supported with the configured sensor
>   *
> - * \var IPASessionConfiguration::grid.minAnalogueGain
> + * \var IPASessionConfiguration::agc.minAnalogueGain
>   * \brief Minimum analogue gain supported with the configured sensor
>   *
> - * \var IPASessionConfiguration::grid.maxAnalogueGain
> + * \var IPASessionConfiguration::agc.maxAnalogueGain
>   * \brief Maximum analogue gain supported with the configured sensor
>   */
>  
> -- 
> 2.32.0
>
Laurent Pinchart Nov. 19, 2021, 12:29 p.m. UTC | #2
On Fri, Nov 19, 2021 at 10:58:52AM +0000, Kieran Bingham wrote:
> Quoting Jean-Michel Hautbois (2021-11-19 10:22:19)
> > The shutter speed limits and analogue gains limits are in the agc
> > structure in IPASessionConfiguration. They are badly mentionned as
> 
> /mentionned/mentioned/
> 
> > beeing part of the grid structure, fix it.
> 
> /beeing/being/
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> > 
> > Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
> > ---
> >  src/ipa/ipu3/ipa_context.cpp | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
> > index 99caf9ad..86794ac1 100644
> > --- a/src/ipa/ipu3/ipa_context.cpp
> > +++ b/src/ipa/ipu3/ipa_context.cpp
> > @@ -76,13 +76,13 @@ namespace libcamera::ipa::ipu3 {
> >   * \var IPASessionConfiguration::agc.minShutterSpeed
> >   * \brief Minimum shutter speed supported with the configured sensor
> >   *
> > - * \var IPASessionConfiguration::grid.maxShutterSpeed
> > + * \var IPASessionConfiguration::agc.maxShutterSpeed
> >   * \brief Maximum shutter speed supported with the configured sensor
> >   *
> > - * \var IPASessionConfiguration::grid.minAnalogueGain
> > + * \var IPASessionConfiguration::agc.minAnalogueGain
> >   * \brief Minimum analogue gain supported with the configured sensor
> >   *
> > - * \var IPASessionConfiguration::grid.maxAnalogueGain
> > + * \var IPASessionConfiguration::agc.maxAnalogueGain
> >   * \brief Maximum analogue gain supported with the configured sensor
> >   */
> >

Patch
diff mbox series

diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp
index 99caf9ad..86794ac1 100644
--- a/src/ipa/ipu3/ipa_context.cpp
+++ b/src/ipa/ipu3/ipa_context.cpp
@@ -76,13 +76,13 @@  namespace libcamera::ipa::ipu3 {
  * \var IPASessionConfiguration::agc.minShutterSpeed
  * \brief Minimum shutter speed supported with the configured sensor
  *
- * \var IPASessionConfiguration::grid.maxShutterSpeed
+ * \var IPASessionConfiguration::agc.maxShutterSpeed
  * \brief Maximum shutter speed supported with the configured sensor
  *
- * \var IPASessionConfiguration::grid.minAnalogueGain
+ * \var IPASessionConfiguration::agc.minAnalogueGain
  * \brief Minimum analogue gain supported with the configured sensor
  *
- * \var IPASessionConfiguration::grid.maxAnalogueGain
+ * \var IPASessionConfiguration::agc.maxAnalogueGain
  * \brief Maximum analogue gain supported with the configured sensor
  */