[libcamera-devel,v2,5/5] documentation: sensor_drivers: Document H/V flip
diff mbox series

Message ID 20230114194712.23272-6-jacopo.mondi@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: camera_sensor: Centralize flips handling
Related show

Commit Message

Jacopo Mondi Jan. 14, 2023, 7:47 p.m. UTC
Briefly document the optional requirement support for H/V flip controls.

Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
---
 Documentation/sensor_driver_requirements.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

David Plowman Jan. 16, 2023, 2:59 p.m. UTC | #1
Hi Jacopo

Thanks for the update!

On Sat, 14 Jan 2023 at 19:47, Jacopo Mondi
<jacopo.mondi@ideasonboard.com> wrote:
>
> Briefly document the optional requirement support for H/V flip controls.
>
> Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

Reviewed-by: David Plowman <david.plowman@raspberrypi.com>

Thanks!
David

> ---
>  Documentation/sensor_driver_requirements.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
>
> diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst
> index 3abc8f35924a..0e516b34a215 100644
> --- a/Documentation/sensor_driver_requirements.rst
> +++ b/Documentation/sensor_driver_requirements.rst
> @@ -62,6 +62,18 @@ The sensor driver should support the following V4L2 controls:
>
>  The controls are used to register the camera location and rotation.
>
> +In order to support rotating the image the sensor driver should support
> +
> +* `V4L2_CID_HFLIP`_
> +* `V4L2_CID_VFLIP`_
> +
> +.. _V4L2_CID_HFLIP: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/control.html
> +.. _V4L2_CID_VFLIP: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/control.html
> +
> +The controls must be writable from userspace. In case of a RAW Bayer sensors,
> +drivers should correctly report if vertical/horizontal flips modify the Bayer
> +pattern ordering by reporting the `V4L2_CTRL_FLAG_MODIFY_LAYOUT` control flag.
> +
>  The sensor driver should implement support for the V4L2 Selection API,
>  specifically it should implement support for the
>  `VIDIOC_SUBDEV_G_SELECTION`_ ioctl with support for the following selection
> --
> 2.39.0
>

Patch
diff mbox series

diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst
index 3abc8f35924a..0e516b34a215 100644
--- a/Documentation/sensor_driver_requirements.rst
+++ b/Documentation/sensor_driver_requirements.rst
@@ -62,6 +62,18 @@  The sensor driver should support the following V4L2 controls:
 
 The controls are used to register the camera location and rotation.
 
+In order to support rotating the image the sensor driver should support
+
+* `V4L2_CID_HFLIP`_
+* `V4L2_CID_VFLIP`_
+
+.. _V4L2_CID_HFLIP: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/control.html
+.. _V4L2_CID_VFLIP: https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/control.html
+
+The controls must be writable from userspace. In case of a RAW Bayer sensors,
+drivers should correctly report if vertical/horizontal flips modify the Bayer
+pattern ordering by reporting the `V4L2_CTRL_FLAG_MODIFY_LAYOUT` control flag.
+
 The sensor driver should implement support for the V4L2 Selection API,
 specifically it should implement support for the
 `VIDIOC_SUBDEV_G_SELECTION`_ ioctl with support for the following selection