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

Message ID 20221124121220.47000-10-jacopo@jmondi.org
State Accepted
Headers show
  • libcamera: camera_sensor: Centralize flips handling
Related show

Commit Message

Jacopo Mondi Nov. 24, 2022, 12:12 p.m. UTC
Briefly document the optional requirement support for H/V flip controls.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
 Documentation/sensor_driver_requirements.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff mbox series

diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst
index b0854be3328a..e9f998ca8d31 100644
--- a/Documentation/sensor_driver_requirements.rst
+++ b/Documentation/sensor_driver_requirements.rst
@@ -55,6 +55,19 @@  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 according to the above registered
+properties 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
+and have them 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