[libcamera-devel] [PATCH 01/12] libcamera: CameraSensor: Mention V4L2 in get/setControls()

[Laurent Pinchart]

Hi Jacopo,

Thank you for the patch.

On Tue, Jan 05, 2021 at 08:05:11PM +0100, Jacopo Mondi wrote:
> The current CameraSensor interface for reading and writing controls
> is currently based on V4L2 controls.
> 
> Mention that more clearly in the documentation and, while at it, re-sort
> the documentation to match the methods declaration order.
> 
> Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>

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

> ---
>  src/libcamera/camera_sensor.cpp | 24 +++++++++++++-----------
>  1 file changed, 13 insertions(+), 11 deletions(-)
> 
> diff --git a/src/libcamera/camera_sensor.cpp b/src/libcamera/camera_sensor.cpp
> index 046474c03f4a..05a1d7c22e97 100644
> --- a/src/libcamera/camera_sensor.cpp
> +++ b/src/libcamera/camera_sensor.cpp
> @@ -593,11 +593,12 @@ const ControlInfoMap &CameraSensor::controls() const
>  }
>  
>  /**
> - * \brief Read controls from the sensor
> + * \brief Read V4L2 controls from the sensor
>   * \param[in] ids The list of controls to read, specified by their ID
>   *
>   * This method reads the value of all controls contained in \a ids, and returns
> - * their values as a ControlList.
> + * their values as a ControlList. The control identifiers are defined by the
> + * V4L2 specification (V4L2_CID_*).
>   *
>   * If any control in \a ids is not supported by the device, is disabled (i.e.
>   * has the V4L2_CTRL_FLAG_DISABLED flag set), or if any other error occurs
> @@ -615,18 +616,13 @@ ControlList CameraSensor::getControls(const std::vector<uint32_t> &ids)
>  }
>  
>  /**
> - * \fn CameraSensor::properties()
> - * \brief Retrieve the camera sensor properties
> - * \return The list of camera sensor properties
> - */
> -
> -/**
> - * \brief Write controls to the sensor
> + * \brief Write V4L2 controls to the sensor
>   * \param[in] ctrls The list of controls to write
>   *
>   * This method writes the value of all controls contained in \a ctrls, and
> - * stores the values actually applied to the device in the corresponding
> - * \a ctrls entry.
> + * stores the values actually applied to the device in the corresponding \a
> + * ctrls entry. The control identifiers are defined by the V4L2 specification
> + * (V4L2_CID_*).
>   *
>   * If any control in \a ctrls is not supported by the device, is disabled (i.e.
>   * has the V4L2_CTRL_FLAG_DISABLED flag set), is read-only, or if any other
> @@ -649,6 +645,12 @@ int CameraSensor::setControls(ControlList *ctrls)
>  	return subdev_->setControls(ctrls);
>  }
>  
> +/**
> + * \fn CameraSensor::properties()
> + * \brief Retrieve the camera sensor properties
> + * \return The list of camera sensor properties
> + */
> +
>  /**
>   * \brief Assemble and return the camera sensor info
>   * \param[out] info The camera sensor info

-- 
Regards,

Laurent Pinchart