iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
linux/Documentation/media/uapi/dvb/audio-set-bypass-mode.rst

64 lines
1.2 KiB
ReStructuredText
Raw Normal View History

doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
.. -*- coding: utf-8; mode: rst -*-
.. _AUDIO_SET_BYPASS_MODE:
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 07:58:48 -03:00
=====================
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
AUDIO_SET_BYPASS_MODE
=====================
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-05 15:14:35 -03: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 07:58:48 -03:00
----
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03: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 07:58:48 -03:00
AUDIO_SET_BYPASS_MODE
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
[media] docs-rst: Convert DVB 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. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 16:56:15 -03:00
.. attention:: This ioctl is deprecated
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-05 15:14:35 -03:00
Synopsis
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
--------
[media] docs-rst: Convert DVB 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. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 16:56:15 -03:00
.. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)
:name: AUDIO_SET_BYPASS_MODE
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03: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-05 15:14:35 -03:00
Arguments
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 07:58:48 -03:00
---------
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
.. flat-table::
:header-rows: 0
:stub-columns: 0
[media] docs-rst: Convert DVB 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. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 16:56:15 -03:00
-
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
- int fd
- File descriptor returned by a previous call to open().
[media] docs-rst: Convert DVB 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. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 16:56:15 -03:00
-
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
- boolean mode
- Enables or disables the decoding of the current Audio stream in
the DVB subsystem.
[media] docs-rst: Convert DVB 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. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 16:56:15 -03:00
TRUE: Bypass is disabled
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03:00
[media] docs-rst: Convert DVB 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. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 16:56:15 -03:00
FALSE: Bypass is enabled
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03: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-05 15:14:35 -03:00
Description
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 07:58:48 -03:00
-----------
This ioctl call asks the Audio Device to bypass the Audio decoder and
forward the stream without decoding. This mode shall be used if streams
that can’t be handled by the DVB system shall be decoded. Dolby
DigitalTM streams are automatically forwarded by the DVB subsystem if
the hardware can handle it.
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-05 15:14:35 -03:00
Return Value
doc-rst: linux_tv: split DVB function call documentation Just like V4L, split the DVB function calls into one file per system call. This is a requirement for the man pages creator on Sphinx to work, and makes the document easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:37:31 -03: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.
Reference in New Issue Copy Permalink