diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-03-04 12:21:39 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-04-14 11:31:49 +0300 |
| commit | 54f38fcae536ea202ce7d6a359521492fba30c1f (patch) | |
| tree | dd1a2b36d8de0b13702f2716526ad3b91650e090 /Documentation/media/uapi/v4l/vidioc-g-input.rst | |
| parent | 5dfb8db56b273740a76e8687ee7efb4b2c0ec83b (diff) | |
| download | linux-54f38fcae536ea202ce7d6a359521492fba30c1f.tar.xz | |
media: docs: move uAPI book to userspace-api/media
Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee3862 ("docs: Create a user-space API guide").
As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.
Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-input.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/vidioc-g-input.rst | 71 |
1 files changed, 0 insertions, 71 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-input.rst b/Documentation/media/uapi/v4l/vidioc-g-input.rst deleted file mode 100644 index 76b7d487466e..000000000000 --- a/Documentation/media/uapi/v4l/vidioc-g-input.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. Permission is granted to copy, distribute and/or modify this -.. document under the terms of the GNU Free Documentation License, -.. Version 1.1 or any later version published by the Free Software -.. Foundation, with no Invariant Sections, no Front-Cover Texts -.. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. -.. -.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections - -.. _VIDIOC_G_INPUT: - -************************************ -ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT -************************************ - -Name -==== - -VIDIOC_G_INPUT - VIDIOC_S_INPUT - Query or select the current video input - - -Synopsis -======== - -.. c:function:: int ioctl( int fd, VIDIOC_G_INPUT, int *argp ) - :name: VIDIOC_G_INPUT - -.. c:function:: int ioctl( int fd, VIDIOC_S_INPUT, int *argp ) - :name: VIDIOC_S_INPUT - - -Arguments -========= - -``fd`` - File descriptor returned by :ref:`open() <func-open>`. - -``argp`` - Pointer an integer with input index. - - -Description -=========== - -To query the current video input applications call the -:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` ioctl with a pointer to an integer where the driver -stores the number of the input, as in the struct -:c:type:`v4l2_input` ``index`` field. This ioctl will fail -only when there are no video inputs, returning ``EINVAL``. - -To select a video input applications store the number of the desired -input in an integer and call the :ref:`VIDIOC_S_INPUT <VIDIOC_G_INPUT>` ioctl with a pointer -to this integer. Side effects are possible. For example inputs may -support different video standards, so the driver may implicitly switch -the current standard. Because of these possible side effects -applications must select an input before querying or negotiating any -other parameters. - -Information about video inputs is available using the -:ref:`VIDIOC_ENUMINPUT` ioctl. - - -Return Value -============ - -On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. The generic error codes are described at the -:ref:`Generic Error Codes <gen-errors>` chapter. - -EINVAL - The number of the video input is out of bounds. |