openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
linux/Documentation/media/uapi/v4l/vidioc-overlay.rst

62 lines
1.5 KiB
ReStructuredText
Raw Normal View History

media: add SPDX header to media uAPI files All those files are under GFDL 1.1 or later, with no invariant sections. Tag them as such. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-08-30 22:15:26 +08:00
.. 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
doc-rst: linux_tv: Replace reference names to match ioctls Due to a limitation at the DocBook language, the references were using lowercase and slashes, instead of the name of the ioctls. On ReST, make them identical. This will hopefully help to cleanup the code a little bit. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-02 00:42:29 +08:00
.. _VIDIOC_OVERLAY:
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
********************
ioctl VIDIOC_OVERLAY
********************
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:14:35 +08:00
Name
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:58:48 +08:00
====
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:58:48 +08:00
VIDIOC_OVERLAY - Start or stop video overlay
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:14:35 +08:00
Synopsis
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
========
[media] docs-rst: Convert V4L2 uAPI to use C function references Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-20 03:53:38 +08:00
.. c:function:: int ioctl( int fd, VIDIOC_OVERLAY, const int *argp )
:name: VIDIOC_OVERLAY
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:58:48 +08:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:14:35 +08:00
Arguments
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
``argp``
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>
2017-09-02 21:54:48 +08:00
Pointer to an integer.
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:14:35 +08:00
Description
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
===========
This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
doc-rst: linux_tv: convert lots of consts to references There were lots of consts at the media docbook that should be, instead, references. Convert the ones that can easily be done by an automatic script. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-02 01:33:56 +08:00
Applications call :ref:`VIDIOC_OVERLAY` to start or stop the overlay. It
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
takes a pointer to an integer which must be set to zero by the
application to stop overlay, to one to start.
doc-rst: linux_tv: simplify references There are lots of internal references in the form: :ref:`foo <foo>` Simplify them to be just: :ref:`foo`. Patch generated via this small script: for j in $(find . -name '*'); do echo $j; perl -ne 'if (m/\`(\S+)\s*\<(\S+)\>\`/) { if (!($1=~'http') && $1 eq $2) { s,\s*\<(\S+)\>,,; } } print $_' <$j >a && mv a $j; done Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-02 00:58:44 +08:00
Drivers do not support :ref:`VIDIOC_STREAMON` or
doc-rst: linux_tv: Replace reference names to match ioctls Due to a limitation at the DocBook language, the references were using lowercase and slashes, instead of the name of the ioctls. On ReST, make them identical. This will hopefully help to cleanup the code a little bit. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-02 00:42:29 +08:00
:ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` with
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-06 02:14:35 +08:00
Return Value
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 21:18:56 +08:00
============
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 overlay parameters have not been set up. See :ref:`overlay`
for the necessary steps.