diff mbox series

[v7,4/5] media: Documentation: Add ST VGXY61 driver documentation

Message ID 20221011123030.31802-2-benjamin.mugnier@foss.st.com (mailing list archive)
State Superseded
Delegated to: Sakari Ailus
Headers
Series media: Add ST VGXY61 camera sensor driver |

Commit Message

Benjamin Mugnier Oct. 11, 2022, 12:30 p.m. UTC 
  Document V4L2_CID_HDR_MODE possible values for this sensor.

Signed-off-by: Benjamin Mugnier <benjamin.mugnier@foss.st.com>
---
 .../userspace-api/media/drivers/st-vgxy61.rst | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Documentation/userspace-api/media/drivers/st-vgxy61.rst

Comments

Sakari Ailus Oct. 25, 2022, 7:35 a.m. UTC | #1 
Hi Benjamin,

On Tue, Oct 11, 2022 at 02:30:29PM +0200, Benjamin Mugnier wrote:
> Document V4L2_CID_HDR_MODE possible values for this sensor.
> 
> Signed-off-by: Benjamin Mugnier <benjamin.mugnier@foss.st.com>
> ---
>  .../userspace-api/media/drivers/st-vgxy61.rst | 23 +++++++++++++++++++
>  1 file changed, 23 insertions(+)
>  create mode 100644 Documentation/userspace-api/media/drivers/st-vgxy61.rst
> 
> diff --git a/Documentation/userspace-api/media/drivers/st-vgxy61.rst b/Documentation/userspace-api/media/drivers/st-vgxy61.rst
> new file mode 100644
> index 000000000000..213b884dcfa6
> --- /dev/null
> +++ b/Documentation/userspace-api/media/drivers/st-vgxy61.rst
> @@ -0,0 +1,23 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +ST VGXY61 camera sensor driver
> +==============================
> +
> +The ST VGXY61 driver implements the following controls:
> +
> +``V4L2_CID_HDR_SENSOR_MODE``
> +-------------------------------
> +    Change the sensor HDR mode. A HDR picture is obtained by merging two captures of the same scene
> +    using two different exposure periods.
> +
> +.. flat-table::
> +    :header-rows:  0
> +    :stub-columns: 0
> +    :widths:       1 4
> +
> +    * - HDR linearize
> +      - The merger outputs a long exposure capture as long as it is not saturated.
> +    * - HDR substraction
> +      - This involves subtracting the short exposure frame from the long exposure frame.
> +    * - "No HDR"
> +      - This mode is used for standard dynamic range (SDR) exposures.

I wonder if it would be helpful for the user space to have macros to define
these values.

The lines should be wrapped at 80, too. I'll do that while applying...
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/drivers/st-vgxy61.rst b/Documentation/userspace-api/media/drivers/st-vgxy61.rst
new file mode 100644
index 000000000000..213b884dcfa6
--- /dev/null
+++ b/Documentation/userspace-api/media/drivers/st-vgxy61.rst
@@ -0,0 +1,23 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+ST VGXY61 camera sensor driver
+==============================
+
+The ST VGXY61 driver implements the following controls:
+
+``V4L2_CID_HDR_SENSOR_MODE``
+-------------------------------
+    Change the sensor HDR mode. A HDR picture is obtained by merging two captures of the same scene
+    using two different exposure periods.
+
+.. flat-table::
+    :header-rows:  0
+    :stub-columns: 0
+    :widths:       1 4
+
+    * - HDR linearize
+      - The merger outputs a long exposure capture as long as it is not saturated.
+    * - HDR substraction
+      - This involves subtracting the short exposure frame from the long exposure frame.
+    * - "No HDR"
+      - This mode is used for standard dynamic range (SDR) exposures.