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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
7e6854a9bf
commit
1473c75e9a
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_create_buffers`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_cropcap`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_dbg_chip_info`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_dbg_register`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_event`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_dv_timings_cap`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,7 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
|
||||
Pointer to struct :c:type:`v4l2_encoder_cmd`.
|
||||
|
||||
Description
|
||||
===========
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_enum_dv_timings`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_fmtdesc`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,9 +26,8 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to a struct :c:type:`v4l2_frmivalenum`
|
||||
structure that contains a pixel format and size and receives a frame
|
||||
interval.
|
||||
Pointer to struct :c:type:`v4l2_frmivalenum`
|
||||
that contains a pixel format and size and receives a frame interval.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,7 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``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
|
||||
and height.
|
||||
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_frequency_band`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_audio`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_audioout`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_input`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_output`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_standard`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_exportbuffer`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_audio`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_audioout`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_crop`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_control`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -35,6 +35,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_dv_timings`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -36,6 +36,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_edid`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_enc_idx`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -34,6 +34,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_ext_controls`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_framebuffer`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -31,6 +31,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_format`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_frequency`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer an integer with input index.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_jpegcompression`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_modulator`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to an integer with output index.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_streamparm`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,7 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to an enum v4l2_priority type.
|
||||
Pointer to an enum :c:type:`v4l2_priority` type.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,11 +29,8 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``request``
|
||||
VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
|
||||
|
||||
``argp``
|
||||
|
||||
Pointer to struct :c:type:`v4l2_selection`.
|
||||
|
||||
Description
|
||||
===========
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_sliced_vbi_cap`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to :c:type:`v4l2_std_id`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_tuner`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to an integer.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_buffer`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_buffer`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_dv_timings`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_buffer`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_capability`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -32,6 +32,8 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_queryctl`, :c:type:`v4l2_query_ext_ctrl`
|
||||
or :c:type`v4l2_querymenu` (depending on the ioctl).
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to :c:type:`v4l2_std_id`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,7 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
|
||||
Pointer to struct :c:type:`v4l2_requestbuffers`.
|
||||
|
||||
Description
|
||||
===========
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_hw_freq_seek`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,7 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
|
||||
Pointer to an integer.
|
||||
|
||||
Description
|
||||
===========
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_frame_interval_enum`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_frame_size_enum`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -26,6 +26,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_mbus_code_enum`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_crop`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_format`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_frame_interval`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -29,6 +29,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_subdev_selection`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
|
@ -30,6 +30,7 @@ Arguments
|
|||
File descriptor returned by :ref:`open() <func-open>`.
|
||||
|
||||
``argp``
|
||||
Pointer to struct :c:type:`v4l2_event_subscription`.
|
||||
|
||||
|
||||
Description
|
||||
|
|
Loading…
Reference in New Issue