Commit 1473c75e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

media: v4l uAPI: add descriptions for arguments to all ioctls

Several ioctls are missing descriptions for the third argument
of the ioctl() command. They should have a description, as
otherwise the output won't be ok, and will sound like something
is missing.

So, add them.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 7e6854a9
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_create_buffers`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_cropcap`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_dbg_chip_info`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_dbg_register`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_event`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_dv_timings_cap`.
Description Description
......
...@@ -29,7 +29,7 @@ Arguments ...@@ -29,7 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_encoder_cmd`.
Description Description
=========== ===========
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_enum_dv_timings`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_fmtdesc`.
Description Description
......
...@@ -26,9 +26,8 @@ Arguments ...@@ -26,9 +26,8 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to a struct :c:type:`v4l2_frmivalenum` Pointer to struct :c:type:`v4l2_frmivalenum`
structure that contains a pixel format and size and receives a frame that contains a pixel format and size and receives a frame interval.
interval.
Description Description
......
...@@ -26,7 +26,7 @@ Arguments ...@@ -26,7 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to a struct :c:type:`v4l2_frmsizeenum` Pointer to struct :c:type:`v4l2_frmsizeenum`
that contains an index and pixel format and receives a frame width that contains an index and pixel format and receives a frame width
and height. and height.
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_frequency_band`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_audio`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_audioout`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_input`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_output`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_standard`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_exportbuffer`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_audio`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_audioout`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_crop`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_control`.
Description Description
......
...@@ -35,6 +35,7 @@ Arguments ...@@ -35,6 +35,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_dv_timings`.
Description Description
......
...@@ -36,6 +36,7 @@ Arguments ...@@ -36,6 +36,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_edid`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_enc_idx`.
Description Description
......
...@@ -34,6 +34,7 @@ Arguments ...@@ -34,6 +34,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_ext_controls`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_framebuffer`.
Description Description
......
...@@ -31,6 +31,7 @@ Arguments ...@@ -31,6 +31,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_format`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_frequency`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer an integer with input index.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_jpegcompression`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_modulator`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to an integer with output index.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_streamparm`.
Description Description
......
...@@ -29,7 +29,7 @@ Arguments ...@@ -29,7 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to an enum v4l2_priority type. Pointer to an enum :c:type:`v4l2_priority` type.
Description Description
......
...@@ -29,11 +29,8 @@ Arguments ...@@ -29,11 +29,8 @@ Arguments
``fd`` ``fd``
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``request``
VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_selection`.
Description Description
=========== ===========
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_sliced_vbi_cap`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to :c:type:`v4l2_std_id`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_tuner`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to an integer.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_buffer`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_buffer`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_dv_timings`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_buffer`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_capability`.
Description Description
......
...@@ -32,6 +32,8 @@ Arguments ...@@ -32,6 +32,8 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_queryctl`, :c:type:`v4l2_query_ext_ctrl`
or :c:type`v4l2_querymenu` (depending on the ioctl).
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to :c:type:`v4l2_std_id`.
Description Description
......
...@@ -26,7 +26,7 @@ Arguments ...@@ -26,7 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_requestbuffers`.
Description Description
=========== ===========
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_hw_freq_seek`.
Description Description
......
...@@ -29,7 +29,7 @@ Arguments ...@@ -29,7 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to an integer.
Description Description
=========== ===========
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_frame_interval_enum`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_frame_size_enum`.
Description Description
......
...@@ -26,6 +26,7 @@ Arguments ...@@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_mbus_code_enum`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_crop`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_format`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_frame_interval`.
Description Description
......
...@@ -29,6 +29,7 @@ Arguments ...@@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_subdev_selection`.
Description Description
......
...@@ -30,6 +30,7 @@ Arguments ...@@ -30,6 +30,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
``argp`` ``argp``
Pointer to struct :c:type:`v4l2_event_subscription`.
Description Description
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment