renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-22 04:03:58 +08:00
Code

media: v4l2-ctrl: Document V4L2_CID_CAMERA_ORIENTATION

Browse Source 
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>
This commit is contained in:
Jacopo Mondi 2020-05-09 11:04:46 +02:00 committed by Mauro Carvalho Chehab
parent 915bd31ce9
commit 9397a83f40
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst
View File

@ -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.