[PATCH v2 1/1] Documentation: v4l: Document rotation and orientation for sensor drivers

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


Document how rotation and orientation should be taken into account in
writing camera sensor drivers.

Signed-off-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>
since v1:

Use speclial double quotes around functions to use non-proportional font for

 Documentation/driver-api/media/camera-sensor.rst      | 11 +++++++++++
 .../userspace-api/media/v4l/ext-ctrls-camera.rst      |  1 +
 2 files changed, 12 insertions(+)

diff --git a/Documentation/driver-api/media/camera-sensor.rst b/Documentation/driver-api/media/camera-sensor.rst
index c7d4891bd24e..2618a91b0d85 100644
--- a/Documentation/driver-api/media/camera-sensor.rst
+++ b/Documentation/driver-api/media/camera-sensor.rst
@@ -151,3 +151,14 @@ used to obtain device's power state after the power state transition:
 The function returns a non-zero value if it succeeded getting the power count or
 runtime PM was disabled, in either of which cases the driver may proceed to
 access the device.
+Rotation and orientation
+Some systems have been implemented so that the camera sensor has been mounted
+upside down compared to its natural mounting rotation. In such a case, the
+:ref:`V4L2_CID_CAMERA_SENSOR_ROTATION <v4l2-camera-sensor-rotation>` control
+shall indicate the mounting rotation.
+Use ``v4l2_fwnode_device_parse()`` to obtain this information and
+``v4l2_ctrl_new_fwnode_properties()`` to generate the appropriate controls.
diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst
index daa4f40869f8..29fe22da52a2 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst
@@ -536,6 +536,7 @@ enum v4l2_scene_mode -
       - The camera is not directly attached to the device and is freely movable.
+.. _v4l2-camera-sensor-rotation:
     This read-only control describes the rotation correction in degrees in the

[Index of Archives]     [Linux Input]     [Video for Linux]     [Gstreamer Embedded]     [Mplayer Users]     [Linux USB Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]

  Powered by Linux