leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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:
Mauro Carvalho Chehab 2017-09-02 09:54:48 -04:00
parent 7e6854a9bf
commit 1473c75e9a
58 changed files with 60 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/media/uapi/v4l/vidioc-create-bufs.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_create_buffers`.
Description

1
Documentation/media/uapi/v4l/vidioc-cropcap.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_cropcap`.
Description

1
Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_dbg_chip_info`.
Description

1
Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_dbg_register`.
Description

1
Documentation/media/uapi/v4l/vidioc-dqevent.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_event`.
Description

1
Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_dv_timings_cap`.
Description

2
Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst
View File

@ -29,7 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_encoder_cmd`.
Description
===========

1
Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_enum_dv_timings`.
Description

1
Documentation/media/uapi/v4l/vidioc-enum-fmt.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_fmtdesc`.
Description

5
Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst
View File

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

2
Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst
View File

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

1
Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_frequency_band`.
Description

1
Documentation/media/uapi/v4l/vidioc-enumaudio.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_audio`.
Description

1
Documentation/media/uapi/v4l/vidioc-enumaudioout.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_audioout`.
Description

1
Documentation/media/uapi/v4l/vidioc-enuminput.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_input`.
Description

1
Documentation/media/uapi/v4l/vidioc-enumoutput.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_output`.
Description

1
Documentation/media/uapi/v4l/vidioc-enumstd.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_standard`.
Description

1
Documentation/media/uapi/v4l/vidioc-expbuf.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_exportbuffer`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-audio.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_audio`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-audioout.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_audioout`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-crop.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_crop`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-ctrl.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_control`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst
View File

@ -35,6 +35,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_dv_timings`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-edid.rst
View File

@ -36,6 +36,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_edid`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-enc-index.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_enc_idx`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst
View File

@ -34,6 +34,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_ext_controls`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-fbuf.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_framebuffer`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-fmt.rst
View File

@ -31,6 +31,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_format`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-frequency.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_frequency`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-input.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer an integer with input index.
Description

1
Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_jpegcompression`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-modulator.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_modulator`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-output.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to an integer with output index.
Description

1
Documentation/media/uapi/v4l/vidioc-g-parm.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_streamparm`.
Description

2
Documentation/media/uapi/v4l/vidioc-g-priority.rst
View File

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

5
Documentation/media/uapi/v4l/vidioc-g-selection.rst
View File

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

1
Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_sliced_vbi_cap`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-std.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to :c:type:`v4l2_std_id`.
Description

1
Documentation/media/uapi/v4l/vidioc-g-tuner.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_tuner`.
Description

1
Documentation/media/uapi/v4l/vidioc-overlay.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to an integer.
Description

1
Documentation/media/uapi/v4l/vidioc-prepare-buf.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_buffer`.
Description

1
Documentation/media/uapi/v4l/vidioc-qbuf.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_buffer`.
Description

1
Documentation/media/uapi/v4l/vidioc-query-dv-timings.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_dv_timings`.
Description

1
Documentation/media/uapi/v4l/vidioc-querybuf.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_buffer`.
Description

1
Documentation/media/uapi/v4l/vidioc-querycap.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_capability`.
Description

2
Documentation/media/uapi/v4l/vidioc-queryctrl.rst
View File

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

1
Documentation/media/uapi/v4l/vidioc-querystd.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to :c:type:`v4l2_std_id`.
Description

2
Documentation/media/uapi/v4l/vidioc-reqbufs.rst
View File

@ -26,7 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_requestbuffers`.
Description
===========

1
Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst
View File

@ -26,6 +26,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_hw_freq_seek`.
Description

2
Documentation/media/uapi/v4l/vidioc-streamon.rst
View File

@ -29,7 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to an integer.
Description
===========

1
Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst
View File

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

1
Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst
View File

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

1
Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst
View File

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

1
Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_subdev_crop`.
Description

1
Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_subdev_format`.
Description

1
Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_subdev_frame_interval`.
Description

1
Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst
View File

@ -29,6 +29,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_subdev_selection`.
Description

1
Documentation/media/uapi/v4l/vidioc-subscribe-event.rst
View File

@ -30,6 +30,7 @@ Arguments
File descriptor returned by :ref:`open() <func-open>`.
``argp``
Pointer to struct :c:type:`v4l2_event_subscription`.
Description