| From 16a7ef36055e414560143ebcb95113f9513ca49d Mon Sep 17 00:00:00 2001 |
| From: Jacopo Mondi <jacopo@jmondi.org> |
| Date: Sat, 9 May 2020 11:04:46 +0200 |
| Subject: [PATCH] media: v4l2-ctrl: Document |
| V4L2_CID_CAMERA_ORIENTATION |
| |
| Add documentation for the V4L2_CID_CAMERA_ORIENTATION camera |
| control. The newly added read-only control reports the camera device |
| orientation relative to the usage orientation of the system the camera |
| is installed on. |
| |
| Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> |
| Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> |
| Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> |
| |
| Commit 9397a83f40183eeafd5c787af2240ed0d6b26daa upstream |
| |
| Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> |
| --- |
| .../media/uapi/v4l/ext-ctrls-camera.rst | 30 +++++++++++++++++++ |
| 1 file changed, 30 insertions(+) |
| |
| --- a/Documentation/media/uapi/v4l/ext-ctrls-camera.rst |
| +++ b/Documentation/media/uapi/v4l/ext-ctrls-camera.rst |
| @@ -510,6 +510,36 @@ enum v4l2_scene_mode - |
| value down. A value of zero stops the motion if one is in progress |
| and has no effect otherwise. |
| |
| +``V4L2_CID_CAMERA_ORIENTATION (menu)`` |
| + This read-only control describes the camera orientation by reporting its |
| + mounting position on the device where the camera is installed. The control |
| + value is constant and not modifiable by software. This control is |
| + particularly meaningful for devices which have a well defined orientation, |
| + such as phones, laptops and portable devices since the control is expressed |
| + as a position relative to the device's intended usage orientation. For |
| + example, a camera installed on the user-facing side of a phone, a tablet or |
| + a laptop device is said to be have ``V4L2_CAMERA_ORIENTATION_FRONT`` |
| + orientation, while a camera installed on the opposite side of the front one |
| + is said to be have ``V4L2_CAMERA_ORIENTATION_BACK`` orientation. Camera |
| + sensors not directly attached to the device, or attached in a way that |
| + allows them to move freely, such as webcams and digital cameras, are said to |
| + have the ``V4L2_CAMERA_ORIENTATION_EXTERNAL`` orientation. |
| + |
| + |
| + |
| +.. flat-table:: |
| + :header-rows: 0 |
| + :stub-columns: 0 |
| + |
| + * - ``V4L2_CAMERA_ORIENTATION_FRONT`` |
| + - The camera is oriented towards the user facing side of the device. |
| + * - ``V4L2_CAMERA_ORIENTATION_BACK`` |
| + - The camera is oriented towards the back facing side of the device. |
| + * - ``V4L2_CAMERA_ORIENTATION_EXTERNAL`` |
| + - The camera is not directly attached to the device and is freely movable. |
| + |
| + |
| + |
| .. [#f1] |
| This control may be changed to a menu control in the future, if more |
| options are required. |