UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

media: docs: v4l2-controls: add links to structs 

This section lacks links to struct definitions. Add one where each struct
is introduced.

Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
Luca Ceresoli 2019-06-13 10:18:21 -04:00 committed by Mauro Carvalho Chehab
parent e050f55207
commit 9e75efb0f2
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/media/kapi/v4l2-controls.rst
View File

@ -26,8 +26,9 @@ The control framework was created in order to implement all the rules of the
V4L2 specification with respect to controls in a central place. And to make V4L2 specification with respect to controls in a central place. And to make
life as easy as possible for the driver developer. life as easy as possible for the driver developer.
Note that the control framework relies on the presence of a struct v4l2_device Note that the control framework relies on the presence of a struct
for V4L2 drivers and struct v4l2_subdev for sub-device drivers. :c:type:`v4l2_device` for V4L2 drivers and struct :c:type:`v4l2_subdev` for
sub-device drivers.
Objects in the framework Objects in the framework
@ -35,12 +36,13 @@ Objects in the framework
There are two main objects: There are two main objects:
The v4l2_ctrl object describes the control properties and keeps track of the The :c:type:`v4l2_ctrl` object describes the control properties and keeps
control's value (both the current value and the proposed new value). track of the control's value (both the current value and the proposed new
value).
v4l2_ctrl_handler is the object that keeps track of controls. It maintains a :c:type:`v4l2_ctrl_handler` is the object that keeps track of controls. It
list of v4l2_ctrl objects that it owns and another list of references to maintains a list of v4l2_ctrl objects that it owns and another list of
controls, possibly to controls owned by other handlers. references to controls, possibly to controls owned by other handlers.
Basic usage for V4L2 and sub-device drivers Basic usage for V4L2 and sub-device drivers
@ -242,7 +244,7 @@ initializes the hardware to the default control values. It is recommended
that you do this as this ensures that both the internal data structures and that you do this as this ensures that both the internal data structures and
the hardware are in sync. the hardware are in sync.
4) Finally: implement the v4l2_ctrl_ops 4) Finally: implement the :c:type:`v4l2_ctrl_ops`
.. code-block:: none .. code-block:: none