Skip to content

L
linux
Commit f9b2e8aa authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files
Options

media: docs: make DVB documents more compatible with Sphinx 3.1+ 

Sphinx 3.x broke support for the cdomain.py extension, as the
c domain code was rewritten. Due to that, the c tags need to
be re-written, in order to use the new c domain notation.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 407e84cd
Show whitespace changes
Inline Side-by-side
Showing with 329 additions and 534 deletions
Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_BILINGUAL_CHANNEL_SELECT: .. _AUDIO_BILINGUAL_CHANNEL_SELECT:
...@@ -16,9 +17,9 @@ AUDIO_BILINGUAL_CHANNEL_SELECT ...@@ -16,9 +17,9 @@ AUDIO_BILINGUAL_CHANNEL_SELECT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select) .. c:macro:: AUDIO_BILINGUAL_CHANNEL_SELECT
:name: AUDIO_BILINGUAL_CHANNEL_SELECT
``int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct audio_channel_select *select)``
Arguments Arguments
--------- ---------
...@@ -39,7 +40,6 @@ Arguments ...@@ -39,7 +40,6 @@ Arguments
- Select the output format of the audio (mono left/right, stereo). - Select the output format of the audio (mono left/right, stereo).
Description Description
----------- -----------
...@@ -50,7 +50,6 @@ for MPEG decoders controlled through V4L2. ...@@ -50,7 +50,6 @@ for MPEG decoders controlled through V4L2.
This ioctl call asks the Audio Device to select the requested channel This ioctl call asks the Audio Device to select the requested channel
for bilingual streams if possible. for bilingual streams if possible.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-channel-select.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_CHANNEL_SELECT: .. _AUDIO_CHANNEL_SELECT:
...@@ -16,9 +17,9 @@ AUDIO_CHANNEL_SELECT ...@@ -16,9 +17,9 @@ AUDIO_CHANNEL_SELECT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select) .. c:macro:: AUDIO_CHANNEL_SELECT
:name: AUDIO_CHANNEL_SELECT
``int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct audio_channel_select *select)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -40,7 +40,6 @@ Arguments ...@@ -40,7 +40,6 @@ Arguments
- Select the output format of the audio (mono left/right, stereo). - Select the output format of the audio (mono left/right, stereo).
Description Description
----------- -----------
...@@ -50,7 +49,6 @@ V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead. ...@@ -50,7 +49,6 @@ V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
This ioctl call asks the Audio Device to select the requested channel if This ioctl call asks the Audio Device to select the requested channel if
possible. possible.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-clear-buffer.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_CLEAR_BUFFER: .. _AUDIO_CLEAR_BUFFER:
...@@ -16,8 +17,9 @@ AUDIO_CLEAR_BUFFER ...@@ -16,8 +17,9 @@ AUDIO_CLEAR_BUFFER
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER) .. c:macro:: AUDIO_CLEAR_BUFFER
:name: AUDIO_CLEAR_BUFFER
``int ioctl(int fd, AUDIO_CLEAR_BUFFER)``
Arguments Arguments
--------- ---------
...@@ -26,7 +28,6 @@ Arguments ...@@ -26,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -39,7 +40,6 @@ Description ...@@ -39,7 +40,6 @@ Description
This ioctl call asks the Audio Device to clear all software and hardware This ioctl call asks the Audio Device to clear all software and hardware
buffers of the audio decoder device. buffers of the audio decoder device.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-continue.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_CONTINUE: .. _AUDIO_CONTINUE:
...@@ -16,9 +17,9 @@ AUDIO_CONTINUE ...@@ -16,9 +17,9 @@ AUDIO_CONTINUE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_CONTINUE) .. c:macro:: AUDIO_CONTINUE
:name: AUDIO_CONTINUE
``int ioctl(int fd, AUDIO_CONTINUE)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -40,7 +40,6 @@ Description ...@@ -40,7 +40,6 @@ Description
This ioctl restarts the decoding and playing process previously paused This ioctl restarts the decoding and playing process previously paused
with AUDIO_PAUSE command. with AUDIO_PAUSE command.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-fclose.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _audio_fclose: .. _audio_fclose:
...@@ -17,8 +18,6 @@ Synopsis ...@@ -17,8 +18,6 @@ Synopsis
-------- --------
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
:name: dvb-audio-close
Arguments Arguments
--------- ---------
...@@ -27,20 +26,17 @@ Arguments ...@@ -27,20 +26,17 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
- File descriptor returned by a previous call to open(). - File descriptor returned by a previous call to open().
Description Description
----------- -----------
This system call closes a previously opened audio device. This system call closes a previously opened audio device.
Return Value Return Value
------------ ------------
...@@ -48,7 +44,6 @@ Return Value ...@@ -48,7 +44,6 @@ Return Value
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EBADF`` - ``EBADF``
......
Documentation/userspace-api/media/dvb/audio-fopen.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _audio_fopen: .. _audio_fopen:
...@@ -17,8 +18,6 @@ Synopsis ...@@ -17,8 +18,6 @@ Synopsis
-------- --------
.. c:function:: int open(const char *deviceName, int flags) .. c:function:: int open(const char *deviceName, int flags)
:name: dvb-audio-open
Arguments Arguments
--------- ---------
...@@ -27,7 +26,6 @@ Arguments ...@@ -27,7 +26,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- const char \*deviceName - const char \*deviceName
...@@ -60,7 +58,6 @@ Arguments ...@@ -60,7 +58,6 @@ Arguments
- -
- (blocking mode is the default) - (blocking mode is the default)
Description Description
----------- -----------
...@@ -78,7 +75,6 @@ fail, and an error code will be returned. If the Audio Device is opened ...@@ -78,7 +75,6 @@ fail, and an error code will be returned. If the Audio Device is opened
in O_RDONLY mode, the only ioctl call that can be used is in O_RDONLY mode, the only ioctl call that can be used is
AUDIO_GET_STATUS. All other call will return with an error code. AUDIO_GET_STATUS. All other call will return with an error code.
Return Value Return Value
------------ ------------
...@@ -88,7 +84,6 @@ Return Value ...@@ -88,7 +84,6 @@ Return Value
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``ENODEV`` - ``ENODEV``
......
Documentation/userspace-api/media/dvb/audio-fwrite.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _audio_fwrite: .. _audio_fwrite:
...@@ -17,8 +18,6 @@ Synopsis ...@@ -17,8 +18,6 @@ Synopsis
-------- --------
.. c:function:: size_t write(int fd, const void *buf, size_t count) .. c:function:: size_t write(int fd, const void *buf, size_t count)
:name: dvb-audio-write
Arguments Arguments
--------- ---------
...@@ -27,7 +26,6 @@ Arguments ...@@ -27,7 +26,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +44,6 @@ Arguments ...@@ -46,7 +44,6 @@ Arguments
- Size of buf. - Size of buf.
Description Description
----------- -----------
...@@ -56,7 +53,6 @@ PES format. If O_NONBLOCK is not specified the function will block ...@@ -56,7 +53,6 @@ PES format. If O_NONBLOCK is not specified the function will block
until buffer space is available. The amount of data to be transferred is until buffer space is available. The amount of data to be transferred is
implied by count. implied by count.
Return Value Return Value
------------ ------------
...@@ -64,7 +60,6 @@ Return Value ...@@ -64,7 +60,6 @@ Return Value
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EPERM`` - ``EPERM``
......
Documentation/userspace-api/media/dvb/audio-get-capabilities.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_GET_CAPABILITIES: .. _AUDIO_GET_CAPABILITIES:
...@@ -16,9 +17,9 @@ AUDIO_GET_CAPABILITIES ...@@ -16,9 +17,9 @@ AUDIO_GET_CAPABILITIES
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_GET_CAPABILITIES, unsigned int *cap) .. c:macro:: AUDIO_GET_CAPABILITIES
:name: AUDIO_GET_CAPABILITIES
``int ioctl(int fd, AUDIO_GET_CAPABILITIES, unsigned int *cap)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -40,14 +40,12 @@ Arguments ...@@ -40,14 +40,12 @@ Arguments
- Returns a bit array of supported sound formats. - Returns a bit array of supported sound formats.
Description Description
----------- -----------
This ioctl call asks the Audio Device to tell us about the decoding This ioctl call asks the Audio Device to tell us about the decoding
capabilities of the audio hardware. capabilities of the audio hardware.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-get-status.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_GET_STATUS: .. _AUDIO_GET_STATUS:
...@@ -16,9 +17,9 @@ AUDIO_GET_STATUS ...@@ -16,9 +17,9 @@ AUDIO_GET_STATUS
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status) .. c:macro:: AUDIO_GET_STATUS
:name: AUDIO_GET_STATUS
``int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -40,14 +40,12 @@ Arguments ...@@ -40,14 +40,12 @@ Arguments
- Returns the current state of Audio Device. - Returns the current state of Audio Device.
Description Description
----------- -----------
This ioctl call asks the Audio Device to return the current state of the This ioctl call asks the Audio Device to return the current state of the
Audio Device. Audio Device.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-pause.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_PAUSE: .. _AUDIO_PAUSE:
...@@ -16,8 +17,9 @@ AUDIO_PAUSE ...@@ -16,8 +17,9 @@ AUDIO_PAUSE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_PAUSE) .. c:macro:: AUDIO_PAUSE
:name: AUDIO_PAUSE
``int ioctl(int fd, AUDIO_PAUSE)``
Arguments Arguments
--------- ---------
...@@ -26,14 +28,12 @@ Arguments ...@@ -26,14 +28,12 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
- File descriptor returned by a previous call to open(). - File descriptor returned by a previous call to open().
Description Description
----------- -----------
...@@ -41,7 +41,6 @@ This ioctl call suspends the audio stream being played. Decoding and ...@@ -41,7 +41,6 @@ This ioctl call suspends the audio stream being played. Decoding and
playing are paused. It is then possible to restart again decoding and playing are paused. It is then possible to restart again decoding and
playing process of the audio stream using AUDIO_CONTINUE command. playing process of the audio stream using AUDIO_CONTINUE command.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-play.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_PLAY: .. _AUDIO_PLAY:
...@@ -16,9 +17,9 @@ AUDIO_PLAY ...@@ -16,9 +17,9 @@ AUDIO_PLAY
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_PLAY) .. c:macro:: AUDIO_PLAY
:name: AUDIO_PLAY
``int ioctl(int fd, AUDIO_PLAY)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -40,7 +40,6 @@ Description ...@@ -40,7 +40,6 @@ Description
This ioctl call asks the Audio Device to start playing an audio stream This ioctl call asks the Audio Device to start playing an audio stream
from the selected source. from the selected source.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-select-source.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SELECT_SOURCE: .. _AUDIO_SELECT_SOURCE:
...@@ -16,9 +17,9 @@ AUDIO_SELECT_SOURCE ...@@ -16,9 +17,9 @@ AUDIO_SELECT_SOURCE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, struct audio_stream_source *source) .. c:macro:: AUDIO_SELECT_SOURCE
:name: AUDIO_SELECT_SOURCE
``int ioctl(int fd, AUDIO_SELECT_SOURCE, struct audio_stream_source *source)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -40,7 +40,6 @@ Arguments ...@@ -40,7 +40,6 @@ Arguments
- Indicates the source that shall be used for the Audio stream. - Indicates the source that shall be used for the Audio stream.
Description Description
----------- -----------
...@@ -49,7 +48,6 @@ the input data. The possible sources are demux or memory. If ...@@ -49,7 +48,6 @@ the input data. The possible sources are demux or memory. If
AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
through the write command. through the write command.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-set-av-sync.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SET_AV_SYNC: .. _AUDIO_SET_AV_SYNC:
...@@ -16,9 +17,9 @@ AUDIO_SET_AV_SYNC ...@@ -16,9 +17,9 @@ AUDIO_SET_AV_SYNC
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state) .. c:macro:: AUDIO_SET_AV_SYNC
:name: AUDIO_SET_AV_SYNC
``int ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -44,14 +44,12 @@ Arguments ...@@ -44,14 +44,12 @@ Arguments
FALSE: AV-sync OFF FALSE: AV-sync OFF
Description Description
----------- -----------
This ioctl call asks the Audio Device to turn ON or OFF A/V This ioctl call asks the Audio Device to turn ON or OFF A/V
synchronization. synchronization.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SET_BYPASS_MODE: .. _AUDIO_SET_BYPASS_MODE:
...@@ -16,8 +17,9 @@ AUDIO_SET_BYPASS_MODE ...@@ -16,8 +17,9 @@ AUDIO_SET_BYPASS_MODE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode) .. c:macro:: AUDIO_SET_BYPASS_MODE
:name: AUDIO_SET_BYPASS_MODE
``int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode)``
Arguments Arguments
--------- ---------
...@@ -26,7 +28,6 @@ Arguments ...@@ -26,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -44,7 +45,6 @@ Arguments ...@@ -44,7 +45,6 @@ Arguments
FALSE: Bypass is enabled FALSE: Bypass is enabled
Description Description
----------- -----------
...@@ -54,7 +54,6 @@ that can’t be handled by the Digital TV system shall be decoded. Dolby ...@@ -54,7 +54,6 @@ that can’t be handled by the Digital TV system shall be decoded. Dolby
DigitalTM streams are automatically forwarded by the Digital TV subsystem if DigitalTM streams are automatically forwarded by the Digital TV subsystem if
the hardware can handle it. the hardware can handle it.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-set-id.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SET_ID: .. _AUDIO_SET_ID:
...@@ -16,8 +17,9 @@ AUDIO_SET_ID ...@@ -16,8 +17,9 @@ AUDIO_SET_ID
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SET_ID, int id) .. c:macro:: AUDIO_SET_ID
:name: AUDIO_SET_ID
``int ioctl(int fd, AUDIO_SET_ID, int id)``
Arguments Arguments
--------- ---------
...@@ -26,7 +28,6 @@ Arguments ...@@ -26,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -39,7 +40,6 @@ Arguments ...@@ -39,7 +40,6 @@ Arguments
- audio sub-stream id - audio sub-stream id
Description Description
----------- -----------
...@@ -51,7 +51,6 @@ other stream types. If the stream type is set the id just specifies the ...@@ -51,7 +51,6 @@ other stream types. If the stream type is set the id just specifies the
substream id of the audio stream and only the first 5 bits are substream id of the audio stream and only the first 5 bits are
recognized. recognized.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-set-mixer.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SET_MIXER: .. _AUDIO_SET_MIXER:
...@@ -16,8 +17,9 @@ AUDIO_SET_MIXER ...@@ -16,8 +17,9 @@ AUDIO_SET_MIXER
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix) .. c:macro:: AUDIO_SET_MIXER
:name: AUDIO_SET_MIXER
``int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix)``
Arguments Arguments
--------- ---------
...@@ -26,7 +28,6 @@ Arguments ...@@ -26,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -39,13 +40,11 @@ Arguments ...@@ -39,13 +40,11 @@ Arguments
- mixer settings. - mixer settings.
Description Description
----------- -----------
This ioctl lets you adjust the mixer settings of the audio decoder. This ioctl lets you adjust the mixer settings of the audio decoder.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-set-mute.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SET_MUTE: .. _AUDIO_SET_MUTE:
...@@ -16,9 +17,9 @@ AUDIO_SET_MUTE ...@@ -16,9 +17,9 @@ AUDIO_SET_MUTE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_SET_MUTE, boolean state) .. c:macro:: AUDIO_SET_MUTE
:name: AUDIO_SET_MUTE
``int ioctl(int fd, AUDIO_SET_MUTE, boolean state)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -44,7 +44,6 @@ Arguments ...@@ -44,7 +44,6 @@ Arguments
FALSE: Audio Un-mute FALSE: Audio Un-mute
Description Description
----------- -----------
...@@ -55,7 +54,6 @@ V4L2 :ref:`VIDIOC_DECODER_CMD` with the ...@@ -55,7 +54,6 @@ V4L2 :ref:`VIDIOC_DECODER_CMD` with the
This ioctl call asks the audio device to mute the stream that is This ioctl call asks the audio device to mute the stream that is
currently being played. currently being played.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/audio-set-streamtype.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_SET_STREAMTYPE: .. _AUDIO_SET_STREAMTYPE:
...@@ -16,9 +17,9 @@ AUDIO_SET_STREAMTYPE ...@@ -16,9 +17,9 @@ AUDIO_SET_STREAMTYPE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, AUDIO_SET_STREAMTYPE, int type) .. c:macro:: AUDIO_SET_STREAMTYPE
:name: AUDIO_SET_STREAMTYPE
``int ioctl(fd, AUDIO_SET_STREAMTYPE, int type)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- -
- int fd - int fd
...@@ -40,7 +40,6 @@ Arguments ...@@ -40,7 +40,6 @@ Arguments
- stream type - stream type
Description Description
----------- -----------
...@@ -48,7 +47,6 @@ This ioctl tells the driver which kind of audio stream to expect. This ...@@ -48,7 +47,6 @@ This ioctl tells the driver which kind of audio stream to expect. This
is useful if the stream offers several audio sub-streams like LPCM and is useful if the stream offers several audio sub-streams like LPCM and
AC3. AC3.
Return Value Return Value
------------ ------------
...@@ -57,12 +55,10 @@ appropriately. The generic error codes are described at the ...@@ -57,12 +55,10 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
.. flat-table:: .. flat-table::
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EINVAL`` - ``EINVAL``
......
Documentation/userspace-api/media/dvb/audio-stop.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.audio
.. _AUDIO_STOP: .. _AUDIO_STOP:
...@@ -16,8 +17,9 @@ AUDIO_STOP ...@@ -16,8 +17,9 @@ AUDIO_STOP
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, AUDIO_STOP) .. c:macro:: AUDIO_STOP
:name: AUDIO_STOP
``int ioctl(int fd, AUDIO_STOP)``
Arguments Arguments
--------- ---------
...@@ -26,21 +28,18 @@ Arguments ...@@ -26,21 +28,18 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
- File descriptor returned by a previous call to open(). - File descriptor returned by a previous call to open().
Description Description
----------- -----------
This ioctl call asks the Audio Device to stop playing the current This ioctl call asks the Audio Device to stop playing the current
stream. stream.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/ca-fclose.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _ca_fclose: .. _ca_fclose:
...@@ -11,26 +12,22 @@ Name ...@@ -11,26 +12,22 @@ Name
Digital TV CA close() Digital TV CA close()
Synopsis Synopsis
-------- --------
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
:name: dvb-ca-close
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. File descriptor returned by a previous call to :c:func:`open()`.
Description Description
----------- -----------
This system call closes a previously opened CA device. This system call closes a previously opened CA device.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/ca-fopen.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _ca_fopen: .. _ca_fopen:
...@@ -11,13 +12,10 @@ Name ...@@ -11,13 +12,10 @@ Name
Digital TV CA open() Digital TV CA open()
Synopsis Synopsis
-------- --------
.. c:function:: int open(const char *name, int flags) .. c:function:: int open(const char *name, int flags)
:name: dvb-ca-open
Arguments Arguments
--------- ---------
...@@ -45,7 +43,6 @@ Arguments ...@@ -45,7 +43,6 @@ Arguments
- open in non-blocking mode - open in non-blocking mode
(blocking mode is the default) (blocking mode is the default)
Description Description
----------- -----------
...@@ -63,11 +60,9 @@ Only one user can open the CA Device in ``O_RDWR`` mode. All other ...@@ -63,11 +60,9 @@ Only one user can open the CA Device in ``O_RDWR`` mode. All other
attempts to open the device in this mode will fail, and an error code attempts to open the device in this mode will fail, and an error code
will be returned. will be returned.
Return Value Return Value
------------ ------------
On success 0 is returned. On success 0 is returned.
On error -1 is returned, and the ``errno`` variable is set On error -1 is returned, and the ``errno`` variable is set
......
Documentation/userspace-api/media/dvb/ca-get-cap.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_GET_CAP: .. _CA_GET_CAP:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
CA_GET_CAP CA_GET_CAP
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_GET_CAP, struct ca_caps *caps) .. c:macro:: CA_GET_CAP
:name: CA_GET_CAP
``int ioctl(fd, CA_GET_CAP, struct ca_caps *caps)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``caps`` ``caps``
Pointer to struct :c:type:`ca_caps`. Pointer to struct :c:type:`ca_caps`.
......
Documentation/userspace-api/media/dvb/ca-get-descr-info.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_GET_DESCR_INFO: .. _CA_GET_DESCR_INFO:
...@@ -11,18 +12,18 @@ Name ...@@ -11,18 +12,18 @@ Name
CA_GET_DESCR_INFO CA_GET_DESCR_INFO
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_GET_DESCR_INFO, struct ca_descr_info *desc) .. c:macro:: CA_GET_DESCR_INFO
:name: CA_GET_DESCR_INFO
``int ioctl(fd, CA_GET_DESCR_INFO, struct ca_descr_info *desc)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``desc`` ``desc``
Pointer to struct :c:type:`ca_descr_info`. Pointer to struct :c:type:`ca_descr_info`.
......
Documentation/userspace-api/media/dvb/ca-get-msg.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_GET_MSG: .. _CA_GET_MSG:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
CA_GET_MSG CA_GET_MSG
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg) .. c:macro:: CA_GET_MSG
:name: CA_GET_MSG
``int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``msg`` ``msg``
Pointer to struct :c:type:`ca_msg`. Pointer to struct :c:type:`ca_msg`.
...@@ -38,11 +38,9 @@ Receives a message via a CI CA module. ...@@ -38,11 +38,9 @@ Receives a message via a CI CA module.
Please notice that, on most drivers, this is done by reading from Please notice that, on most drivers, this is done by reading from
the /dev/adapter?/ca? device node. the /dev/adapter?/ca? device node.
Return Value Return Value
------------ ------------
On success 0 is returned. On success 0 is returned.
On error -1 is returned, and the ``errno`` variable is set On error -1 is returned, and the ``errno`` variable is set
......
Documentation/userspace-api/media/dvb/ca-get-slot-info.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_GET_SLOT_INFO: .. _CA_GET_SLOT_INFO:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
CA_GET_SLOT_INFO CA_GET_SLOT_INFO
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info) .. c:macro:: CA_GET_SLOT_INFO
:name: CA_GET_SLOT_INFO
``int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``info`` ``info``
Pointer to struct :c:type:`ca_slot_info`. Pointer to struct :c:type:`ca_slot_info`.
...@@ -34,7 +34,6 @@ Description ...@@ -34,7 +34,6 @@ Description
Returns information about a CA slot identified by Returns information about a CA slot identified by
:c:type:`ca_slot_info`.slot_num. :c:type:`ca_slot_info`.slot_num.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/ca-reset.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_RESET: .. _CA_RESET:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
CA_RESET CA_RESET
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_RESET) .. c:macro:: CA_RESET
:name: CA_RESET
``int ioctl(fd, CA_RESET)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`. File descriptor returned by a previous call to :c:func:`open()`.
Description Description
----------- -----------
...@@ -31,7 +31,6 @@ Description ...@@ -31,7 +31,6 @@ Description
Puts the Conditional Access hardware on its initial state. It should Puts the Conditional Access hardware on its initial state. It should
be called before start using the CA hardware. be called before start using the CA hardware.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/ca-send-msg.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_SEND_MSG: .. _CA_SEND_MSG:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
CA_SEND_MSG CA_SEND_MSG
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_SEND_MSG, struct ca_msg *msg) .. c:macro:: CA_SEND_MSG
:name: CA_SEND_MSG
``int ioctl(fd, CA_SEND_MSG, struct ca_msg *msg)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``msg`` ``msg``
Pointer to struct :c:type:`ca_msg`. Pointer to struct :c:type:`ca_msg`.
Description Description
----------- -----------
......
Documentation/userspace-api/media/dvb/ca-set-descr.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.ca
.. _CA_SET_DESCR: .. _CA_SET_DESCR:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
CA_SET_DESCR CA_SET_DESCR
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, CA_SET_DESCR, struct ca_descr *desc) .. c:macro:: CA_SET_DESCR
:name: CA_SET_DESCR
``int ioctl(fd, CA_SET_DESCR, struct ca_descr *desc)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <cec-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``msg`` ``msg``
Pointer to struct :c:type:`ca_descr`. Pointer to struct :c:type:`ca_descr`.
......
Documentation/userspace-api/media/dvb/dmx-add-pid.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_ADD_PID: .. _DMX_ADD_PID:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
DMX_ADD_PID DMX_ADD_PID
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, DMX_ADD_PID, __u16 *pid) .. c:macro:: DMX_ADD_PID
:name: DMX_ADD_PID
``int ioctl(fd, DMX_ADD_PID, __u16 *pid)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``pid`` ``pid``
PID number to be filtered. PID number to be filtered.
Description Description
----------- -----------
...@@ -36,7 +35,6 @@ This ioctl call allows to add multiple PIDs to a transport stream filter ...@@ -36,7 +35,6 @@ This ioctl call allows to add multiple PIDs to a transport stream filter
previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to
:c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`. :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/dmx-expbuf.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_EXPBUF: .. _DMX_EXPBUF:
...@@ -13,24 +14,22 @@ DMX_EXPBUF - Export a buffer as a DMABUF file descriptor. ...@@ -13,24 +14,22 @@ DMX_EXPBUF - Export a buffer as a DMABUF file descriptor.
.. warning:: this API is still experimental .. warning:: this API is still experimental
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, DMX_EXPBUF, struct dmx_exportbuffer *argp ) .. c:macro:: DMX_EXPBUF
:name: DMX_EXPBUF
``int ioctl(int fd, DMX_EXPBUF, struct dmx_exportbuffer *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <dmx_fopen>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct :c:type:`dmx_exportbuffer`. Pointer to struct :c:type:`dmx_exportbuffer`.
Description Description
=========== ===========
...@@ -54,11 +53,9 @@ driver, on success. This is a DMABUF file descriptor. The application may ...@@ -54,11 +53,9 @@ driver, on success. This is a DMABUF file descriptor. The application may
pass it to other DMABUF-aware devices. It is recommended to close a DMABUF pass it to other DMABUF-aware devices. It is recommended to close a DMABUF
file when it is no longer used to allow the associated memory to be reclaimed. file when it is no longer used to allow the associated memory to be reclaimed.
Examples Examples
======== ========
.. code-block:: c .. code-block:: c
int buffer_export(int v4lfd, enum dmx_buf_type bt, int index, int *dmafd) int buffer_export(int v4lfd, enum dmx_buf_type bt, int index, int *dmafd)
......
Documentation/userspace-api/media/dvb/dmx-fclose.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _dmx_fclose: .. _dmx_fclose:
...@@ -11,27 +12,23 @@ Name ...@@ -11,27 +12,23 @@ Name
Digital TV demux close() Digital TV demux close()
Synopsis Synopsis
-------- --------
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
:name: dvb-dmx-close
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to File descriptor returned by a previous call to
:c:func:`open() <dvb-dmx-open>`. :c:func:`open()`.
Description Description
----------- -----------
This system call deactivates and deallocates a filter that was This system call deactivates and deallocates a filter that was
previously allocated via the :c:func:`open() <dvb-dmx-open>` call. previously allocated via the :c:func:`open()` call.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/dmx-fopen.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _dmx_fopen: .. _dmx_fopen:
...@@ -11,12 +12,10 @@ Name ...@@ -11,12 +12,10 @@ Name
Digital TV demux open() Digital TV demux open()
Synopsis Synopsis
-------- --------
.. c:function:: int open(const char *deviceName, int flags) .. c:function:: int open(const char *deviceName, int flags)
:name: dvb-dmx-open
Arguments Arguments
--------- ---------
...@@ -47,7 +46,6 @@ Arguments ...@@ -47,7 +46,6 @@ Arguments
- open in non-blocking mode - open in non-blocking mode
(blocking mode is the default) (blocking mode is the default)
Description Description
----------- -----------
...@@ -68,7 +66,6 @@ affect the semantics of the ``open()`` call itself. A device opened ...@@ -68,7 +66,6 @@ affect the semantics of the ``open()`` call itself. A device opened
in blocking mode can later be put into non-blocking mode (and vice versa) in blocking mode can later be put into non-blocking mode (and vice versa)
using the ``F_SETFL`` command of the fcntl system call. using the ``F_SETFL`` command of the fcntl system call.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/dmx-fread.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _dmx_fread: .. _dmx_fread:
...@@ -11,18 +12,16 @@ Name ...@@ -11,18 +12,16 @@ Name
Digital TV demux read() Digital TV demux read()
Synopsis Synopsis
-------- --------
.. c:function:: size_t read(int fd, void *buf, size_t count) .. c:function:: size_t read(int fd, void *buf, size_t count)
:name: dvb-dmx-read
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``buf`` ``buf``
Buffer to be filled Buffer to be filled
...@@ -44,7 +43,6 @@ to be transferred is implied by count. ...@@ -44,7 +43,6 @@ to be transferred is implied by count.
:c:type:`DMX_CHECK_CRC <dmx_sct_filter_params>` flag set, :c:type:`DMX_CHECK_CRC <dmx_sct_filter_params>` flag set,
data that fails on CRC check will be silently ignored. data that fails on CRC check will be silently ignored.
Return Value Return Value
------------ ------------
...@@ -75,6 +73,5 @@ appropriately. ...@@ -75,6 +73,5 @@ appropriately.
- The driver failed to write to the callers buffer due to an - The driver failed to write to the callers buffer due to an
invalid \*buf pointer. invalid \*buf pointer.
The generic error codes are described at the The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
Documentation/userspace-api/media/dvb/dmx-fwrite.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _dmx_fwrite: .. _dmx_fwrite:
...@@ -11,18 +12,16 @@ Name ...@@ -11,18 +12,16 @@ Name
Digital TV demux write() Digital TV demux write()
Synopsis Synopsis
-------- --------
.. c:function:: ssize_t write(int fd, const void *buf, size_t count) .. c:function:: ssize_t write(int fd, const void *buf, size_t count)
:name: dvb-dmx-write
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. File descriptor returned by a previous call to :c:func:`open()`.
``buf`` ``buf``
Buffer with data to be written Buffer with data to be written
...@@ -40,7 +39,6 @@ digitally recorded Transport Stream. Matching filters have to be defined ...@@ -40,7 +39,6 @@ digitally recorded Transport Stream. Matching filters have to be defined
in the corresponding physical demux device, ``/dev/dvb/adapter?/demux?``. in the corresponding physical demux device, ``/dev/dvb/adapter?/demux?``.
The amount of data to be transferred is implied by count. The amount of data to be transferred is implied by count.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_GET_PES_PIDS: .. _DMX_GET_PES_PIDS:
...@@ -11,23 +12,22 @@ Name ...@@ -11,23 +12,22 @@ Name
DMX_GET_PES_PIDS DMX_GET_PES_PIDS
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, DMX_GET_PES_PIDS, __u16 pids[5]) .. c:macro:: DMX_GET_PES_PIDS
:name: DMX_GET_PES_PIDS
``int ioctl(fd, DMX_GET_PES_PIDS, __u16 pids[5])``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``pids`` ``pids``
Array used to store 5 Program IDs. Array used to store 5 Program IDs.
Description Description
----------- -----------
...@@ -45,13 +45,11 @@ pids[DMX_PES_SUBTITLE] 3 first subtitle PID ...@@ -45,13 +45,11 @@ pids[DMX_PES_SUBTITLE] 3 first subtitle PID
pids[DMX_PES_PCR] 4 first Program Clock Reference PID pids[DMX_PES_PCR] 4 first Program Clock Reference PID
======================= ======== ======================================= ======================= ======== =======================================
.. note:: .. note::
A value equal to 0xffff means that the PID was not filled by the A value equal to 0xffff means that the PID was not filled by the
Kernel. Kernel.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/dmx-get-stc.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_GET_STC: .. _DMX_GET_STC:
...@@ -11,23 +12,22 @@ Name ...@@ -11,23 +12,22 @@ Name
DMX_GET_STC DMX_GET_STC
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl( int fd, DMX_GET_STC, struct dmx_stc *stc) .. c:macro:: DMX_GET_STC
:name: DMX_GET_STC
``int ioctl(int fd, DMX_GET_STC, struct dmx_stc *stc)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``stc`` ``stc``
Pointer to :c:type:`dmx_stc` where the stc data is to be stored. Pointer to :c:type:`dmx_stc` where the stc data is to be stored.
Description Description
----------- -----------
...@@ -39,7 +39,6 @@ The result is returned in form of a ratio with a 64 bit numerator ...@@ -39,7 +39,6 @@ The result is returned in form of a ratio with a 64 bit numerator
and a 32 bit denominator, so the real 90kHz STC value is and a 32 bit denominator, so the real 90kHz STC value is
``stc->stc / stc->base``. ``stc->stc / stc->base``.
Return Value Return Value
------------ ------------
...@@ -61,6 +60,5 @@ appropriately. ...@@ -61,6 +60,5 @@ appropriately.
- Invalid stc number. - Invalid stc number.
The generic error codes are described at the The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
Documentation/userspace-api/media/dvb/dmx-mmap.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _dmx-mmap: .. _dmx-mmap:
...@@ -21,9 +22,7 @@ Synopsis ...@@ -21,9 +22,7 @@ Synopsis
#include <unistd.h> #include <unistd.h>
#include <sys/mman.h> #include <sys/mman.h>
.. c:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset ) .. c:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
:name: dmx-mmap
Arguments Arguments
========= =========
...@@ -54,7 +53,7 @@ Arguments ...@@ -54,7 +53,7 @@ Arguments
``MAP_FIXED`` requests that the driver selects no other address than ``MAP_FIXED`` requests that the driver selects no other address than
the one specified. If the specified address cannot be used, the one specified. If the specified address cannot be used,
:ref:`mmap() <dmx-mmap>` will fail. If ``MAP_FIXED`` is specified, :c:func:`mmap()` will fail. If ``MAP_FIXED`` is specified,
``start`` must be a multiple of the pagesize. Use of this option is ``start`` must be a multiple of the pagesize. Use of this option is
discouraged. discouraged.
...@@ -69,17 +68,16 @@ Arguments ...@@ -69,17 +68,16 @@ Arguments
flags. flags.
``fd`` ``fd``
File descriptor returned by :ref:`open() <dmx_fopen>`. File descriptor returned by :c:func:`open()`.
``offset`` ``offset``
Offset of the buffer in device memory, as returned by Offset of the buffer in device memory, as returned by
:ref:`DMX_QUERYBUF` ioctl. :ref:`DMX_QUERYBUF` ioctl.
Description Description
=========== ===========
The :ref:`mmap() <dmx-mmap>` function asks to map ``length`` bytes starting at The :c:func:`mmap()` function asks to map ``length`` bytes starting at
``offset`` in the memory of the device specified by ``fd`` into the ``offset`` in the memory of the device specified by ``fd`` into the
application address space, preferably at address ``start``. This latter application address space, preferably at address ``start``. This latter
address is a hint only, and is usually specified as 0. address is a hint only, and is usually specified as 0.
...@@ -88,13 +86,12 @@ Suitable length and offset parameters are queried with the ...@@ -88,13 +86,12 @@ Suitable length and offset parameters are queried with the
:ref:`DMX_QUERYBUF` ioctl. Buffers must be allocated with the :ref:`DMX_QUERYBUF` ioctl. Buffers must be allocated with the
:ref:`DMX_REQBUFS` ioctl before they can be queried. :ref:`DMX_REQBUFS` ioctl before they can be queried.
To unmap buffers the :ref:`munmap() <dmx-munmap>` function is used. To unmap buffers the :c:func:`munmap()` function is used.
Return Value Return Value
============ ============
On success :ref:`mmap() <dmx-mmap>` returns a pointer to the mapped buffer. On On success :c:func:`mmap()` returns a pointer to the mapped buffer. On
error ``MAP_FAILED`` (-1) is returned, and the ``errno`` variable is set error ``MAP_FAILED`` (-1) is returned, and the ``errno`` variable is set
appropriately. Possible error codes are: appropriately. Possible error codes are:
......
Documentation/userspace-api/media/dvb/dmx-munmap.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _dmx-munmap: .. _dmx-munmap:
...@@ -13,7 +14,6 @@ dmx-munmap - Unmap device memory ...@@ -13,7 +14,6 @@ dmx-munmap - Unmap device memory
.. warning:: This API is still experimental. .. warning:: This API is still experimental.
Synopsis Synopsis
======== ========
...@@ -22,33 +22,29 @@ Synopsis ...@@ -22,33 +22,29 @@ Synopsis
#include <unistd.h> #include <unistd.h>
#include <sys/mman.h> #include <sys/mman.h>
.. c:function:: int munmap( void *start, size_t length ) .. c:function:: int munmap( void *start, size_t length )
:name: dmx-munmap
Arguments Arguments
========= =========
``start`` ``start``
Address of the mapped buffer as returned by the Address of the mapped buffer as returned by the
:ref:`mmap() <dmx-mmap>` function. :c:func:`mmap()` function.
``length`` ``length``
Length of the mapped buffer. This must be the same value as given to Length of the mapped buffer. This must be the same value as given to
:ref:`mmap() <dmx-mmap>`. :c:func:`mmap()`.
Description Description
=========== ===========
Unmaps a previously with the :ref:`mmap() <dmx-mmap>` function mapped Unmaps a previously with the :c:func:`mmap()` function mapped
buffer and frees it, if possible. buffer and frees it, if possible.
Return Value Return Value
============ ============
On success :ref:`munmap() <dmx-munmap>` returns 0, on failure -1 and the On success :c:func:`munmap()` returns 0, on failure -1 and the
``errno`` variable is set appropriately: ``errno`` variable is set appropriately:
EINVAL EINVAL
......
Documentation/userspace-api/media/dvb/dmx-qbuf.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_QBUF: .. _DMX_QBUF:
...@@ -13,27 +14,26 @@ DMX_QBUF - DMX_DQBUF - Exchange a buffer with the driver ...@@ -13,27 +14,26 @@ DMX_QBUF - DMX_DQBUF - Exchange a buffer with the driver
.. warning:: this API is still experimental .. warning:: this API is still experimental
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, DMX_QBUF, struct dmx_buffer *argp ) .. c:macro:: DMX_QBUF
:name: DMX_QBUF
``int ioctl(int fd, DMX_QBUF, struct dmx_buffer *argp)``
.. c:function:: int ioctl( int fd, DMX_DQBUF, struct dmx_buffer *argp ) .. c:macro:: DMX_DQBUF
:name: DMX_DQBUF
``int ioctl(int fd, DMX_DQBUF, struct dmx_buffer *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <dmx_fopen>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct :c:type:`dmx_buffer`. Pointer to struct :c:type:`dmx_buffer`.
Description Description
=========== ===========
...@@ -60,13 +60,12 @@ the driver fills the remaining fields or returns an error code. ...@@ -60,13 +60,12 @@ the driver fills the remaining fields or returns an error code.
By default ``DMX_DQBUF`` blocks when no buffer is in the outgoing By default ``DMX_DQBUF`` blocks when no buffer is in the outgoing
queue. When the ``O_NONBLOCK`` flag was given to the queue. When the ``O_NONBLOCK`` flag was given to the
:ref:`open() <dmx_fopen>` function, ``DMX_DQBUF`` returns :c:func:`open()` function, ``DMX_DQBUF`` returns
immediately with an ``EAGAIN`` error code when no buffer is available. immediately with an ``EAGAIN`` error code when no buffer is available.
The struct :c:type:`dmx_buffer` structure is specified in The struct :c:type:`dmx_buffer` structure is specified in
:ref:`buffer`. :ref:`buffer`.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/dmx-querybuf.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_QUERYBUF: .. _DMX_QUERYBUF:
...@@ -13,24 +14,22 @@ DMX_QUERYBUF - Query the status of a buffer ...@@ -13,24 +14,22 @@ DMX_QUERYBUF - Query the status of a buffer
.. warning:: this API is still experimental .. warning:: this API is still experimental
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, DMX_QUERYBUF, struct dvb_buffer *argp ) .. c:macro:: DMX_QUERYBUF
:name: DMX_QUERYBUF
``int ioctl(int fd, DMX_QUERYBUF, struct dvb_buffer *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <dmx_fopen>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct :c:type:`dvb_buffer`. Pointer to struct :c:type:`dvb_buffer`.
Description Description
=========== ===========
......
Documentation/userspace-api/media/dvb/dmx-remove-pid.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_REMOVE_PID: .. _DMX_REMOVE_PID:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
DMX_REMOVE_PID DMX_REMOVE_PID
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, DMX_REMOVE_PID, __u16 *pid) .. c:macro:: DMX_REMOVE_PID
:name: DMX_REMOVE_PID
``int ioctl(fd, DMX_REMOVE_PID, __u16 *pid)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``pid`` ``pid``
PID of the PES filter to be removed. PID of the PES filter to be removed.
Description Description
----------- -----------
...@@ -37,7 +36,6 @@ transport stream filter, e. g. a filter previously set up with output ...@@ -37,7 +36,6 @@ transport stream filter, e. g. a filter previously set up with output
equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either
:ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`. :ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/dmx-reqbufs.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_REQBUFS: .. _DMX_REQBUFS:
...@@ -13,19 +14,18 @@ DMX_REQBUFS - Initiate Memory Mapping and/or DMA buffer I/O ...@@ -13,19 +14,18 @@ DMX_REQBUFS - Initiate Memory Mapping and/or DMA buffer I/O
.. warning:: this API is still experimental .. warning:: this API is still experimental
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, DMX_REQBUFS, struct dmx_requestbuffers *argp ) .. c:macro:: DMX_REQBUFS
:name: DMX_REQBUFS
``int ioctl(int fd, DMX_REQBUFS, struct dmx_requestbuffers *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <dmx_fopen>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct :c:type:`dmx_requestbuffers`. Pointer to struct :c:type:`dmx_requestbuffers`.
...@@ -64,7 +64,6 @@ buffers, however this cannot succeed when any buffers are still mapped. ...@@ -64,7 +64,6 @@ buffers, however this cannot succeed when any buffers are still mapped.
A ``count`` value of zero frees all buffers, after aborting or finishing A ``count`` value of zero frees all buffers, after aborting or finishing
any DMA in progress. any DMA in progress.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_SET_BUFFER_SIZE: .. _DMX_SET_BUFFER_SIZE:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
DMX_SET_BUFFER_SIZE DMX_SET_BUFFER_SIZE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size) .. c:macro:: DMX_SET_BUFFER_SIZE
:name: DMX_SET_BUFFER_SIZE
``int ioctl(int fd, DMX_SET_BUFFER_SIZE, unsigned long size)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``size`` ``size``
Unsigned long size Unsigned long size
...@@ -36,11 +36,9 @@ filtered data. The default size is two maximum sized sections, i.e. if ...@@ -36,11 +36,9 @@ filtered data. The default size is two maximum sized sections, i.e. if
this function is not called a buffer size of ``2 * 4096`` bytes will be this function is not called a buffer size of ``2 * 4096`` bytes will be
used. used.
Return Value Return Value
------------ ------------
On success 0 is returned. On success 0 is returned.
On error -1 is returned, and the ``errno`` variable is set On error -1 is returned, and the ``errno`` variable is set
......
Documentation/userspace-api/media/dvb/dmx-set-filter.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_SET_FILTER: .. _DMX_SET_FILTER:
...@@ -11,24 +12,23 @@ Name ...@@ -11,24 +12,23 @@ Name
DMX_SET_FILTER DMX_SET_FILTER
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl( int fd, DMX_SET_FILTER, struct dmx_sct_filter_params *params) .. c:macro:: DMX_SET_FILTER
:name: DMX_SET_FILTER
``int ioctl(int fd, DMX_SET_FILTER, struct dmx_sct_filter_params *params)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``params`` ``params``
Pointer to structure containing filter parameters. Pointer to structure containing filter parameters.
Description Description
----------- -----------
...@@ -43,11 +43,9 @@ operation should be started immediately (without waiting for a ...@@ -43,11 +43,9 @@ operation should be started immediately (without waiting for a
:ref:`DMX_START` ioctl call). If a filter was previously set-up, this :ref:`DMX_START` ioctl call). If a filter was previously set-up, this
filter will be canceled, and the receive buffer will be flushed. filter will be canceled, and the receive buffer will be flushed.
Return Value Return Value
------------ ------------
On success 0 is returned. On success 0 is returned.
On error -1 is returned, and the ``errno`` variable is set On error -1 is returned, and the ``errno`` variable is set
......
Documentation/userspace-api/media/dvb/dmx-set-pes-filter.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_SET_PES_FILTER: .. _DMX_SET_PES_FILTER:
...@@ -11,25 +12,22 @@ Name ...@@ -11,25 +12,22 @@ Name
DMX_SET_PES_FILTER DMX_SET_PES_FILTER
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl( int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params) .. c:macro:: DMX_SET_PES_FILTER
:name: DMX_SET_PES_FILTER
``int ioctl(int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
``params`` ``params``
Pointer to structure containing filter parameters. Pointer to structure containing filter parameters.
Description Description
----------- -----------
...@@ -38,7 +36,6 @@ provided. By a PES filter is meant a filter that is based just on the ...@@ -38,7 +36,6 @@ provided. By a PES filter is meant a filter that is based just on the
packet identifier (PID), i.e. no PES header or payload filtering packet identifier (PID), i.e. no PES header or payload filtering
capability is supported. capability is supported.
Return Value Return Value
------------ ------------
...@@ -54,7 +51,6 @@ appropriately. ...@@ -54,7 +51,6 @@ appropriately.
:stub-columns: 0 :stub-columns: 0
:widths: 1 16 :widths: 1 16
- .. row 1 - .. row 1
- ``EBUSY`` - ``EBUSY``
...@@ -64,6 +60,5 @@ appropriately. ...@@ -64,6 +60,5 @@ appropriately.
Make sure that these filters are stopped before starting this Make sure that these filters are stopped before starting this
filter. filter.
The generic error codes are described at the The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
Documentation/userspace-api/media/dvb/dmx-start.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_START: .. _DMX_START:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
DMX_START DMX_START
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl( int fd, DMX_START) .. c:macro:: DMX_START
:name: DMX_START
``int ioctl(int fd, DMX_START)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
Description Description
----------- -----------
...@@ -31,7 +31,6 @@ Description ...@@ -31,7 +31,6 @@ Description
This ioctl call is used to start the actual filtering operation defined This ioctl call is used to start the actual filtering operation defined
via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`. via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`.
Return Value Return Value
------------ ------------
...@@ -46,7 +45,6 @@ appropriately. ...@@ -46,7 +45,6 @@ appropriately.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EINVAL`` - ``EINVAL``
...@@ -63,6 +61,5 @@ appropriately. ...@@ -63,6 +61,5 @@ appropriately.
Make sure that these filters are stopped before starting this Make sure that these filters are stopped before starting this
filter. filter.
The generic error codes are described at the The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
Documentation/userspace-api/media/dvb/dmx-stop.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.dmx
.. _DMX_STOP: .. _DMX_STOP:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
DMX_STOP DMX_STOP
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl( int fd, DMX_STOP) .. c:macro:: DMX_STOP
:name: DMX_STOP
``int ioctl(int fd, DMX_STOP)``
Arguments Arguments
--------- ---------
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`. File descriptor returned by :c:func:`open()`.
Description Description
----------- -----------
...@@ -32,7 +32,6 @@ This ioctl call is used to stop the actual filtering operation defined ...@@ -32,7 +32,6 @@ This ioctl call is used to stop the actual filtering operation defined
via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and
started via the :ref:`DMX_START` command. started via the :ref:`DMX_START` command.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/fe-diseqc-recv-slave-reply.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_DISEQC_RECV_SLAVE_REPLY: .. _FE_DISEQC_RECV_SLAVE_REPLY:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_DISEQC_RECV_SLAVE_REPLY, struct dvb_diseqc_slave_reply *argp ) .. c:macro:: FE_DISEQC_RECV_SLAVE_REPLY
:name: FE_DISEQC_RECV_SLAVE_REPLY
``int ioctl(int fd, FE_DISEQC_RECV_SLAVE_REPLY, struct dvb_diseqc_slave_reply *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
pointer to struct :c:type:`dvb_diseqc_slave_reply`. pointer to struct :c:type:`dvb_diseqc_slave_reply`.
Description Description
=========== ===========
......
Documentation/userspace-api/media/dvb/fe-diseqc-reset-overload.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_DISEQC_RESET_OVERLOAD: .. _FE_DISEQC_RESET_OVERLOAD:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload. FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_DISEQC_RESET_OVERLOAD, NULL ) .. c:macro:: FE_DISEQC_RESET_OVERLOAD
:name: FE_DISEQC_RESET_OVERLOAD
``int ioctl(int fd, FE_DISEQC_RESET_OVERLOAD, NULL)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
Description Description
=========== ===========
...@@ -33,7 +33,6 @@ this ioctl call restores the power to the bus. The call requires ...@@ -33,7 +33,6 @@ this ioctl call restores the power to the bus. The call requires
read/write access to the device. This call has no effect if the device read/write access to the device. This call has no effect if the device
is manually powered off. Not all Digital TV adapters support this ioctl. is manually powered off. Not all Digital TV adapters support this ioctl.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_DISEQC_SEND_BURST: .. _FE_DISEQC_SEND_BURST:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection. FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone ) .. c:macro:: FE_DISEQC_SEND_BURST
:name: FE_DISEQC_SEND_BURST
``int ioctl(int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``tone`` ``tone``
An integer enumered value described at :c:type:`fe_sec_mini_cmd`. An integer enumered value described at :c:type:`fe_sec_mini_cmd`.
Description Description
=========== ===========
...@@ -39,7 +38,6 @@ read/write permissions. ...@@ -39,7 +38,6 @@ read/write permissions.
It provides support for what's specified at It provides support for what's specified at
`Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__ `Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-diseqc-send-master-cmd.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_DISEQC_SEND_MASTER_CMD: .. _FE_DISEQC_SEND_MASTER_CMD:
...@@ -11,25 +12,23 @@ Name ...@@ -11,25 +12,23 @@ Name
FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp ) .. c:macro:: FE_DISEQC_SEND_MASTER_CMD
:name: FE_DISEQC_SEND_MASTER_CMD
``int ioctl(int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
pointer to struct pointer to struct
:c:type:`dvb_diseqc_master_cmd` :c:type:`dvb_diseqc_master_cmd`
Description Description
=========== ===========
......
Documentation/userspace-api/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_DISHNETWORK_SEND_LEGACY_CMD: .. _FE_DISHNETWORK_SEND_LEGACY_CMD:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
FE_DISHNETWORK_SEND_LEGACY_CMD FE_DISHNETWORK_SEND_LEGACY_CMD
Synopsis Synopsis
======== ========
.. c:function:: int ioctl(int fd, FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd) .. c:macro:: FE_DISHNETWORK_SEND_LEGACY_CMD
:name: FE_DISHNETWORK_SEND_LEGACY_CMD
``int ioctl(int fd, FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``cmd`` ``cmd``
Sends the specified raw cmd to the dish via DISEqC. Sends the specified raw cmd to the dish via DISEqC.
Description Description
=========== ===========
...@@ -42,7 +41,6 @@ frontend, for Dish Network legacy switches. ...@@ -42,7 +41,6 @@ frontend, for Dish Network legacy switches.
As support for this ioctl were added in 2004, this means that such As support for this ioctl were added in 2004, this means that such
dishes were already legacy in 2004. dishes were already legacy in 2004.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-enable-high-lnb-voltage.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_ENABLE_HIGH_LNB_VOLTAGE: .. _FE_ENABLE_HIGH_LNB_VOLTAGE:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
FE_ENABLE_HIGH_LNB_VOLTAGE - Select output DC level between normal LNBf voltages or higher LNBf - voltages. FE_ENABLE_HIGH_LNB_VOLTAGE - Select output DC level between normal LNBf voltages or higher LNBf - voltages.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_ENABLE_HIGH_LNB_VOLTAGE, unsigned int high ) .. c:macro:: FE_ENABLE_HIGH_LNB_VOLTAGE
:name: FE_ENABLE_HIGH_LNB_VOLTAGE
``int ioctl(int fd, FE_ENABLE_HIGH_LNB_VOLTAGE, unsigned int high)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``high`` ``high``
Valid flags: Valid flags:
...@@ -33,7 +33,6 @@ Arguments ...@@ -33,7 +33,6 @@ Arguments
- >0 - enables slightly higher voltages instead of 13/18V, in order - >0 - enables slightly higher voltages instead of 13/18V, in order
to compensate for long antenna cables. to compensate for long antenna cables.
Description Description
=========== ===========
...@@ -41,7 +40,6 @@ Select output DC level between normal LNBf voltages or higher LNBf ...@@ -41,7 +40,6 @@ Select output DC level between normal LNBf voltages or higher LNBf
voltages between 0 (normal) or a value grater than 0 for higher voltages between 0 (normal) or a value grater than 0 for higher
voltages. voltages.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-get-event.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_GET_EVENT: .. _FE_GET_EVENT:
...@@ -13,24 +14,22 @@ FE_GET_EVENT ...@@ -13,24 +14,22 @@ FE_GET_EVENT
.. attention:: This ioctl is deprecated. .. attention:: This ioctl is deprecated.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev) .. c:macro:: FE_GET_EVENT
:name: FE_GET_EVENT
``int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``ev`` ``ev``
Points to the location where the event, if any, is to be stored. Points to the location where the event, if any, is to be stored.
Description Description
=========== ===========
...@@ -40,7 +39,6 @@ or non-blocking mode. In the latter case, the call fails immediately ...@@ -40,7 +39,6 @@ or non-blocking mode. In the latter case, the call fails immediately
with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
an event becomes available. an event becomes available.
Return Value Return Value
============ ============
...@@ -49,12 +47,10 @@ On success 0 is returned. ...@@ -49,12 +47,10 @@ On success 0 is returned.
On error -1 is returned, and the ``errno`` variable is set On error -1 is returned, and the ``errno`` variable is set
appropriately. appropriately.
.. flat-table:: .. flat-table::
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EWOULDBLOCK`` - ``EWOULDBLOCK``
......
Documentation/userspace-api/media/dvb/fe-get-frontend.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_GET_FRONTEND: .. _FE_GET_FRONTEND:
...@@ -13,32 +14,28 @@ FE_GET_FRONTEND ...@@ -13,32 +14,28 @@ FE_GET_FRONTEND
.. attention:: This ioctl is deprecated. .. attention:: This ioctl is deprecated.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p) .. c:macro:: FE_GET_FRONTEND
:name: FE_GET_FRONTEND
``int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``p`` ``p``
Points to parameters for tuning operation. Points to parameters for tuning operation.
Description Description
=========== ===========
This ioctl call queries the currently effective frontend parameters. For This ioctl call queries the currently effective frontend parameters. For
this command, read-only access to the device is sufficient. this command, read-only access to the device is sufficient.
Return Value Return Value
============ ============
...@@ -51,7 +48,6 @@ appropriately. ...@@ -51,7 +48,6 @@ appropriately.
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EINVAL`` - ``EINVAL``
......
Documentation/userspace-api/media/dvb/fe-get-info.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_GET_INFO: .. _FE_GET_INFO:
...@@ -12,24 +13,22 @@ Name ...@@ -12,24 +13,22 @@ Name
FE_GET_INFO - Query Digital TV frontend capabilities and returns information FE_GET_INFO - Query Digital TV frontend capabilities and returns information
about the - front-end. This call only requires read-only access to the device. about the - front-end. This call only requires read-only access to the device.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_GET_INFO, struct dvb_frontend_info *argp ) .. c:macro:: FE_GET_INFO
:name: FE_GET_INFO
``int ioctl(int fd, FE_GET_INFO, struct dvb_frontend_info *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
pointer to struct :c:type:`dvb_frontend_info` pointer to struct :c:type:`dvb_frontend_info`
Description Description
=========== ===========
...@@ -40,7 +39,6 @@ takes a pointer to dvb_frontend_info which is filled by the driver. ...@@ -40,7 +39,6 @@ takes a pointer to dvb_frontend_info which is filled by the driver.
When the driver is not compatible with this specification the ioctl When the driver is not compatible with this specification the ioctl
returns an error. returns an error.
frontend capabilities frontend capabilities
===================== =====================
...@@ -49,7 +47,6 @@ supported only on some specific frontend types. ...@@ -49,7 +47,6 @@ supported only on some specific frontend types.
The frontend capabilities are described at :c:type:`fe_caps`. The frontend capabilities are described at :c:type:`fe_caps`.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-get-property.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_GET_PROPERTY: .. _FE_GET_PROPERTY:
...@@ -11,27 +12,26 @@ Name ...@@ -11,27 +12,26 @@ Name
FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties. FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_GET_PROPERTY, struct dtv_properties *argp ) .. c:macro:: FE_GET_PROPERTY
:name: FE_GET_PROPERTY
``int ioctl(int fd, FE_GET_PROPERTY, struct dtv_properties *argp)``
.. c:function:: int ioctl( int fd, FE_SET_PROPERTY, struct dtv_properties *argp ) .. c:macro:: FE_SET_PROPERTY
:name: FE_SET_PROPERTY
``int ioctl(int fd, FE_SET_PROPERTY, struct dtv_properties *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct :c:type:`dtv_properties`. Pointer to struct :c:type:`dtv_properties`.
Description Description
=========== ===========
...@@ -63,7 +63,6 @@ depends on the delivery system and on the device: ...@@ -63,7 +63,6 @@ depends on the delivery system and on the device:
- This call only requires read-only access to the device. - This call only requires read-only access to the device.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-read-ber.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_READ_BER: .. _FE_READ_BER:
...@@ -16,20 +17,19 @@ FE_READ_BER ...@@ -16,20 +17,19 @@ FE_READ_BER
Synopsis Synopsis
======== ========
.. c:function:: int ioctl(int fd, FE_READ_BER, uint32_t *ber) .. c:macro:: FE_READ_BER
:name: FE_READ_BER
``int ioctl(int fd, FE_READ_BER, uint32_t *ber)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``ber`` ``ber``
The bit error rate is stored into \*ber. The bit error rate is stored into \*ber.
Description Description
=========== ===========
...@@ -37,7 +37,6 @@ This ioctl call returns the bit error rate for the signal currently ...@@ -37,7 +37,6 @@ This ioctl call returns the bit error rate for the signal currently
received/demodulated by the front-end. For this command, read-only received/demodulated by the front-end. For this command, read-only
access to the device is sufficient. access to the device is sufficient.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-read-signal-strength.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_READ_SIGNAL_STRENGTH: .. _FE_READ_SIGNAL_STRENGTH:
...@@ -16,20 +17,19 @@ FE_READ_SIGNAL_STRENGTH ...@@ -16,20 +17,19 @@ FE_READ_SIGNAL_STRENGTH
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength) .. c:macro:: FE_READ_SIGNAL_STRENGTH
:name: FE_READ_SIGNAL_STRENGTH
``int ioctl(int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``strength`` ``strength``
The signal strength value is stored into \*strength. The signal strength value is stored into \*strength.
Description Description
=========== ===========
...@@ -37,7 +37,6 @@ This ioctl call returns the signal strength value for the signal ...@@ -37,7 +37,6 @@ This ioctl call returns the signal strength value for the signal
currently received by the front-end. For this command, read-only access currently received by the front-end. For this command, read-only access
to the device is sufficient. to the device is sufficient.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-read-snr.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_READ_SNR: .. _FE_READ_SNR:
...@@ -16,20 +17,19 @@ FE_READ_SNR ...@@ -16,20 +17,19 @@ FE_READ_SNR
Synopsis Synopsis
======== ========
.. c:function:: int ioctl(int fd, FE_READ_SNR, int16_t *snr) .. c:macro:: FE_READ_SNR
:name: FE_READ_SNR
``int ioctl(int fd, FE_READ_SNR, int16_t *snr)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``snr`` ``snr``
The signal-to-noise ratio is stored into \*snr. The signal-to-noise ratio is stored into \*snr.
Description Description
=========== ===========
...@@ -37,7 +37,6 @@ This ioctl call returns the signal-to-noise ratio for the signal ...@@ -37,7 +37,6 @@ This ioctl call returns the signal-to-noise ratio for the signal
currently received by the front-end. For this command, read-only access currently received by the front-end. For this command, read-only access
to the device is sufficient. to the device is sufficient.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-read-status.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_READ_STATUS: .. _FE_READ_STATUS:
...@@ -11,25 +12,23 @@ Name ...@@ -11,25 +12,23 @@ Name
FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_READ_STATUS, unsigned int *status ) .. c:macro:: FE_READ_STATUS
:name: FE_READ_STATUS
``int ioctl(int fd, FE_READ_STATUS, unsigned int *status)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``status`` ``status``
pointer to a bitmask integer filled with the values defined by enum pointer to a bitmask integer filled with the values defined by enum
:c:type:`fe_status`. :c:type:`fe_status`.
Description Description
=========== ===========
...@@ -44,7 +43,6 @@ written. ...@@ -44,7 +43,6 @@ written.
varies according with the architecture. This needs to be fixed in the varies according with the architecture. This needs to be fixed in the
future. future.
int fe_status int fe_status
============= =============
...@@ -52,7 +50,6 @@ The fe_status parameter is used to indicate the current state and/or ...@@ -52,7 +50,6 @@ The fe_status parameter is used to indicate the current state and/or
state changes of the frontend hardware. It is produced using the enum state changes of the frontend hardware. It is produced using the enum
:c:type:`fe_status` values on a bitmask :c:type:`fe_status` values on a bitmask
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-read-uncorrected-blocks.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_READ_UNCORRECTED_BLOCKS: .. _FE_READ_UNCORRECTED_BLOCKS:
...@@ -16,20 +17,19 @@ FE_READ_UNCORRECTED_BLOCKS ...@@ -16,20 +17,19 @@ FE_READ_UNCORRECTED_BLOCKS
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks) .. c:macro:: FE_READ_UNCORRECTED_BLOCKS
:name: FE_READ_UNCORRECTED_BLOCKS
``int ioctl(int fd, FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``ublocks`` ``ublocks``
The total number of uncorrected blocks seen by the driver so far. The total number of uncorrected blocks seen by the driver so far.
Description Description
=========== ===========
...@@ -39,7 +39,6 @@ increment in block count during a specific time interval should be ...@@ -39,7 +39,6 @@ increment in block count during a specific time interval should be
calculated. For this command, read-only access to the device is calculated. For this command, read-only access to the device is
sufficient. sufficient.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_SET_FRONTEND_TUNE_MODE: .. _FE_SET_FRONTEND_TUNE_MODE:
...@@ -11,19 +12,18 @@ Name ...@@ -11,19 +12,18 @@ Name
FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend. FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags ) .. c:macro:: FE_SET_FRONTEND_TUNE_MODE
:name: FE_SET_FRONTEND_TUNE_MODE
``int ioctl(int fd, FE_SET_FRONTEND_TUNE_MODE, unsigned int flags)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``flags`` ``flags``
Valid flags: Valid flags:
...@@ -37,14 +37,12 @@ Arguments ...@@ -37,14 +37,12 @@ Arguments
is closed, this flag will be automatically turned off when the is closed, this flag will be automatically turned off when the
device is reopened read-write. device is reopened read-write.
Description Description
=========== ===========
Allow setting tuner mode flags to the frontend, between 0 (normal) or Allow setting tuner mode flags to the frontend, between 0 (normal) or
``FE_TUNE_MODE_ONESHOT`` mode ``FE_TUNE_MODE_ONESHOT`` mode
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-set-frontend.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_SET_FRONTEND: .. _FE_SET_FRONTEND:
...@@ -13,24 +14,22 @@ Name ...@@ -13,24 +14,22 @@ Name
FE_SET_FRONTEND FE_SET_FRONTEND
Synopsis Synopsis
======== ========
.. c:function:: int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p) .. c:macro:: FE_SET_FRONTEND
:name: FE_SET_FRONTEND
``int ioctl(int fd, FE_SET_FRONTEND, struct dvb_frontend_parameters *p)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
``p`` ``p``
Points to parameters for tuning operation. Points to parameters for tuning operation.
Description Description
=========== ===========
...@@ -44,7 +43,6 @@ operation is initiated before the previous one was completed, the ...@@ -44,7 +43,6 @@ operation is initiated before the previous one was completed, the
previous operation will be aborted in favor of the new one. This command previous operation will be aborted in favor of the new one. This command
requires read/write access to the device. requires read/write access to the device.
Return Value Return Value
============ ============
...@@ -66,6 +64,5 @@ appropriately. ...@@ -66,6 +64,5 @@ appropriately.
- Maximum supported symbol rate reached. - Maximum supported symbol rate reached.
Generic error codes are described at the Generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
Documentation/userspace-api/media/dvb/fe-set-tone.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_SET_TONE: .. _FE_SET_TONE:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone. FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_SET_TONE, enum fe_sec_tone_mode tone ) .. c:macro:: FE_SET_TONE
:name: FE_SET_TONE
``int ioctl(int fd, FE_SET_TONE, enum fe_sec_tone_mode tone)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``tone`` ``tone``
an integer enumered value described at :c:type:`fe_sec_tone_mode` an integer enumered value described at :c:type:`fe_sec_tone_mode`
Description Description
=========== ===========
...@@ -45,7 +44,6 @@ this is done using the DiSEqC ioctls. ...@@ -45,7 +44,6 @@ this is done using the DiSEqC ioctls.
capability of selecting the band. So, it is recommended that applications capability of selecting the band. So, it is recommended that applications
would change to SEC_TONE_OFF when the device is not used. would change to SEC_TONE_OFF when the device is not used.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/fe-set-voltage.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _FE_SET_VOLTAGE: .. _FE_SET_VOLTAGE:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem. FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, FE_SET_VOLTAGE, enum fe_sec_voltage voltage ) .. c:macro:: FE_SET_VOLTAGE
:name: FE_SET_VOLTAGE
``int ioctl(int fd, FE_SET_VOLTAGE, enum fe_sec_voltage voltage)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``voltage`` ``voltage``
an integer enumered value described at :c:type:`fe_sec_voltage` an integer enumered value described at :c:type:`fe_sec_voltage`
Description Description
=========== ===========
...@@ -49,7 +48,6 @@ power up the LNBf. ...@@ -49,7 +48,6 @@ power up the LNBf.
the voltage to SEC_VOLTAGE_OFF while the device is not is used is the voltage to SEC_VOLTAGE_OFF while the device is not is used is
recommended. recommended.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/frontend_f_close.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _frontend_f_close: .. _frontend_f_close:
...@@ -11,7 +12,6 @@ Name ...@@ -11,7 +12,6 @@ Name
fe-close - Close a frontend device fe-close - Close a frontend device
Synopsis Synopsis
======== ========
...@@ -19,16 +19,13 @@ Synopsis ...@@ -19,16 +19,13 @@ Synopsis
#include <unistd.h> #include <unistd.h>
.. c:function:: int close( int fd ) .. c:function:: int close( int fd )
:name: dvb-fe-close
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`. File descriptor returned by :c:func:`open()`.
Description Description
=========== ===========
...@@ -37,7 +34,6 @@ This system call closes a previously opened front-end device. After ...@@ -37,7 +34,6 @@ This system call closes a previously opened front-end device. After
closing a front-end device, its corresponding hardware might be powered closing a front-end device, its corresponding hardware might be powered
down automatically. down automatically.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/frontend_f_open.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.fe
.. _frontend_f_open: .. _frontend_f_open:
...@@ -11,7 +12,6 @@ Name ...@@ -11,7 +12,6 @@ Name
fe-open - Open a frontend device fe-open - Open a frontend device
Synopsis Synopsis
======== ========
...@@ -19,9 +19,7 @@ Synopsis ...@@ -19,9 +19,7 @@ Synopsis
#include <fcntl.h> #include <fcntl.h>
.. c:function:: int open( const char *device_name, int flags ) .. c:function:: int open( const char *device_name, int flags )
:name: dvb-fe-open
Arguments Arguments
========= =========
...@@ -44,7 +42,6 @@ Arguments ...@@ -44,7 +42,6 @@ Arguments
Other flags have no effect. Other flags have no effect.
Description Description
=========== ===========
...@@ -70,16 +67,14 @@ the specified mode. This implies that the corresponding hardware is ...@@ -70,16 +67,14 @@ the specified mode. This implies that the corresponding hardware is
powered up, and that other front-ends may have been powered down to make powered up, and that other front-ends may have been powered down to make
that possible. that possible.
Return Value Return Value
============ ============
On success :ref:`open() <frontend_f_open>` returns the new file descriptor. On success :c:func:`open()` returns the new file descriptor.
On error, -1 is returned, and the ``errno`` variable is set appropriately. On error, -1 is returned, and the ``errno`` variable is set appropriately.
Possible error codes are: Possible error codes are:
On success 0 is returned, and :c:type:`ca_slot_info` is filled. On success 0 is returned, and :c:type:`ca_slot_info` is filled.
On error -1 is returned, and the ``errno`` variable is set On error -1 is returned, and the ``errno`` variable is set
...@@ -105,6 +100,5 @@ appropriately. ...@@ -105,6 +100,5 @@ appropriately.
- The limit on the total number of files open on the system has been - The limit on the total number of files open on the system has been
reached. reached.
The generic error codes are described at the The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
Documentation/userspace-api/media/dvb/net-add-if.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.net
.. _NET_ADD_IF: .. _NET_ADD_IF:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
NET_ADD_IF - Creates a new network interface for a given Packet ID. NET_ADD_IF - Creates a new network interface for a given Packet ID.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, NET_ADD_IF, struct dvb_net_if *net_if ) .. c:macro:: NET_ADD_IF
:name: NET_ADD_IF
``int ioctl(int fd, NET_ADD_IF, struct dvb_net_if *net_if)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``net_if`` ``net_if``
pointer to struct :c:type:`dvb_net_if` pointer to struct :c:type:`dvb_net_if`
Description Description
=========== ===========
......
Documentation/userspace-api/media/dvb/net-get-if.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.net
.. _NET_GET_IF: .. _NET_GET_IF:
...@@ -11,24 +12,22 @@ Name ...@@ -11,24 +12,22 @@ Name
NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`. NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if ) .. c:macro:: NET_GET_IF
:name: NET_GET_IF
``int ioctl(int fd, NET_GET_IF, struct dvb_net_if *net_if)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``net_if`` ``net_if``
pointer to struct :c:type:`dvb_net_if` pointer to struct :c:type:`dvb_net_if`
Description Description
=========== ===========
...@@ -39,7 +38,6 @@ encapsulation type used on such interface. If the interface was not ...@@ -39,7 +38,6 @@ encapsulation type used on such interface. If the interface was not
created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
the ``errno`` with ``EINVAL`` error code. the ``errno`` with ``EINVAL`` error code.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/net-remove-if.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.net
.. _NET_REMOVE_IF: .. _NET_REMOVE_IF:
...@@ -11,31 +12,28 @@ Name ...@@ -11,31 +12,28 @@ Name
NET_REMOVE_IF - Removes a network interface. NET_REMOVE_IF - Removes a network interface.
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, NET_REMOVE_IF, int ifnum ) .. c:macro:: NET_REMOVE_IF
:name: NET_REMOVE_IF
``int ioctl(int fd, NET_REMOVE_IF, int ifnum)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`. File descriptor returned by :c:func:`open()`.
``net_if`` ``net_if``
number of the interface to be removed number of the interface to be removed
Description Description
=========== ===========
The NET_REMOVE_IF ioctl deletes an interface previously created via The NET_REMOVE_IF ioctl deletes an interface previously created via
:ref:`NET_ADD_IF <net>`. :ref:`NET_ADD_IF <net>`.
Return Value Return Value
============ ============
......
Documentation/userspace-api/media/dvb/video-clear-buffer.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_CLEAR_BUFFER: .. _VIDEO_CLEAR_BUFFER:
...@@ -16,9 +17,9 @@ VIDEO_CLEAR_BUFFER ...@@ -16,9 +17,9 @@ VIDEO_CLEAR_BUFFER
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_CLEAR_BUFFER) .. c:macro:: VIDEO_CLEAR_BUFFER
:name: VIDEO_CLEAR_BUFFER
``int ioctl(fd, VIDEO_CLEAR_BUFFER)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -40,14 +40,12 @@ Arguments ...@@ -40,14 +40,12 @@ Arguments
- Equals VIDEO_CLEAR_BUFFER for this command. - Equals VIDEO_CLEAR_BUFFER for this command.
Description Description
----------- -----------
This ioctl call clears all video buffers in the driver and in the This ioctl call clears all video buffers in the driver and in the
decoder hardware. decoder hardware.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-command.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_COMMAND: .. _VIDEO_COMMAND:
...@@ -16,9 +17,9 @@ VIDEO_COMMAND ...@@ -16,9 +17,9 @@ VIDEO_COMMAND
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd) .. c:macro:: VIDEO_COMMAND
:name: VIDEO_COMMAND
``int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Commands the decoder. - Commands the decoder.
Description Description
----------- -----------
...@@ -59,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the ...@@ -59,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
:ref:`VIDIOC_DECODER_CMD` documentation for :ref:`VIDIOC_DECODER_CMD` documentation for
more information. more information.
.. c:type:: struct video_command .. c:type:: video_command
.. code-block:: c .. code-block:: c
...@@ -89,7 +88,6 @@ more information. ...@@ -89,7 +88,6 @@ more information.
}; };
}; };
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-continue.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_CONTINUE: .. _VIDEO_CONTINUE:
...@@ -16,9 +17,9 @@ VIDEO_CONTINUE ...@@ -16,9 +17,9 @@ VIDEO_CONTINUE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_CONTINUE) .. c:macro:: VIDEO_CONTINUE
:name: VIDEO_CONTINUE
``int ioctl(fd, VIDEO_CONTINUE)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -40,7 +40,6 @@ Arguments ...@@ -40,7 +40,6 @@ Arguments
- Equals VIDEO_CONTINUE for this command. - Equals VIDEO_CONTINUE for this command.
Description Description
----------- -----------
...@@ -50,7 +49,6 @@ V4L2 :ref:`VIDIOC_DECODER_CMD` instead. ...@@ -50,7 +49,6 @@ V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call restarts decoding and playing processes of the video This ioctl call restarts decoding and playing processes of the video
stream which was played before a call to VIDEO_FREEZE was made. stream which was played before a call to VIDEO_FREEZE was made.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-fast-forward.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_FAST_FORWARD: .. _VIDEO_FAST_FORWARD:
...@@ -16,9 +17,9 @@ VIDEO_FAST_FORWARD ...@@ -16,9 +17,9 @@ VIDEO_FAST_FORWARD
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames) .. c:macro:: VIDEO_FAST_FORWARD
:name: VIDEO_FAST_FORWARD
``int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- The number of frames to skip. - The number of frames to skip.
Description Description
----------- -----------
...@@ -54,7 +53,6 @@ This ioctl call asks the Video Device to skip decoding of N number of ...@@ -54,7 +53,6 @@ This ioctl call asks the Video Device to skip decoding of N number of
I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
selected. selected.
Return Value Return Value
------------ ------------
...@@ -63,12 +61,10 @@ appropriately. The generic error codes are described at the ...@@ -63,12 +61,10 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
.. flat-table:: .. flat-table::
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EPERM`` - ``EPERM``
......
Documentation/userspace-api/media/dvb/video-fclose.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _video_fclose: .. _video_fclose:
...@@ -18,7 +19,6 @@ Synopsis ...@@ -18,7 +19,6 @@ Synopsis
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
Arguments Arguments
--------- ---------
...@@ -26,20 +26,17 @@ Arguments ...@@ -26,20 +26,17 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
- File descriptor returned by a previous call to open(). - File descriptor returned by a previous call to open().
Description Description
----------- -----------
This system call closes a previously opened video device. This system call closes a previously opened video device.
Return Value Return Value
------------ ------------
...@@ -47,7 +44,6 @@ Return Value ...@@ -47,7 +44,6 @@ Return Value
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EBADF`` - ``EBADF``
......
Documentation/userspace-api/media/dvb/video-fopen.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _video_fopen: .. _video_fopen:
...@@ -18,7 +19,6 @@ Synopsis ...@@ -18,7 +19,6 @@ Synopsis
.. c:function:: int open(const char *deviceName, int flags) .. c:function:: int open(const char *deviceName, int flags)
Arguments Arguments
--------- ---------
...@@ -26,7 +26,6 @@ Arguments ...@@ -26,7 +26,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- const char \*deviceName - const char \*deviceName
...@@ -59,7 +58,6 @@ Arguments ...@@ -59,7 +58,6 @@ Arguments
- -
- (blocking mode is the default) - (blocking mode is the default)
Description Description
----------- -----------
...@@ -79,7 +77,6 @@ returned. If the Video Device is opened in O_RDONLY mode, the only ...@@ -79,7 +77,6 @@ returned. If the Video Device is opened in O_RDONLY mode, the only
ioctl call that can be used is VIDEO_GET_STATUS. All other call will ioctl call that can be used is VIDEO_GET_STATUS. All other call will
return an error code. return an error code.
Return Value Return Value
------------ ------------
...@@ -89,7 +86,6 @@ Return Value ...@@ -89,7 +86,6 @@ Return Value
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``ENODEV`` - ``ENODEV``
......
Documentation/userspace-api/media/dvb/video-freeze.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_FREEZE: .. _VIDEO_FREEZE:
...@@ -16,9 +17,9 @@ VIDEO_FREEZE ...@@ -16,9 +17,9 @@ VIDEO_FREEZE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_FREEZE) .. c:macro:: VIDEO_FREEZE
:name: VIDEO_FREEZE
``int ioctl(fd, VIDEO_FREEZE)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -40,7 +40,6 @@ Arguments ...@@ -40,7 +40,6 @@ Arguments
- Equals VIDEO_FREEZE for this command. - Equals VIDEO_FREEZE for this command.
Description Description
----------- -----------
...@@ -54,7 +53,6 @@ If VIDEO_SOURCE_MEMORY is selected in the ioctl call ...@@ -54,7 +53,6 @@ If VIDEO_SOURCE_MEMORY is selected in the ioctl call
VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed. until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-fwrite.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _video_fwrite: .. _video_fwrite:
...@@ -18,7 +19,6 @@ Synopsis ...@@ -18,7 +19,6 @@ Synopsis
.. c:function:: size_t write(int fd, const void *buf, size_t count) .. c:function:: size_t write(int fd, const void *buf, size_t count)
Arguments Arguments
--------- ---------
...@@ -26,7 +26,6 @@ Arguments ...@@ -26,7 +26,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -45,7 +44,6 @@ Arguments ...@@ -45,7 +44,6 @@ Arguments
- Size of buf. - Size of buf.
Description Description
----------- -----------
...@@ -55,7 +53,6 @@ PES format, unless the capability allows other formats. If O_NONBLOCK ...@@ -55,7 +53,6 @@ PES format, unless the capability allows other formats. If O_NONBLOCK
is not specified the function will block until buffer space is is not specified the function will block until buffer space is
available. The amount of data to be transferred is implied by count. available. The amount of data to be transferred is implied by count.
Return Value Return Value
------------ ------------
...@@ -63,7 +60,6 @@ Return Value ...@@ -63,7 +60,6 @@ Return Value
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EPERM`` - ``EPERM``
......
Documentation/userspace-api/media/dvb/video-get-capabilities.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_GET_CAPABILITIES: .. _VIDEO_GET_CAPABILITIES:
...@@ -16,9 +17,9 @@ VIDEO_GET_CAPABILITIES ...@@ -16,9 +17,9 @@ VIDEO_GET_CAPABILITIES
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap) .. c:macro:: VIDEO_GET_CAPABILITIES
:name: VIDEO_GET_CAPABILITIES
``int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Pointer to a location where to store the capability information. - Pointer to a location where to store the capability information.
Description Description
----------- -----------
...@@ -54,7 +53,6 @@ This ioctl call asks the video device about its decoding capabilities. ...@@ -54,7 +53,6 @@ This ioctl call asks the video device about its decoding capabilities.
On success it returns and integer which has bits set according to the On success it returns and integer which has bits set according to the
defines in section ??. defines in section ??.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-get-event.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_GET_EVENT: .. _VIDEO_GET_EVENT:
...@@ -16,9 +17,9 @@ VIDEO_GET_EVENT ...@@ -16,9 +17,9 @@ VIDEO_GET_EVENT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_GET_EVENT, struct video_event *ev) .. c:macro:: VIDEO_GET_EVENT
:name: VIDEO_GET_EVENT
``int ioctl(fd, VIDEO_GET_EVENT, struct video_event *ev)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Points to the location where the event, if any, is to be stored. - Points to the location where the event, if any, is to be stored.
Description Description
----------- -----------
...@@ -93,7 +92,6 @@ appropriately. The generic error codes are described at the ...@@ -93,7 +92,6 @@ appropriately. The generic error codes are described at the
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EWOULDBLOCK`` - ``EWOULDBLOCK``
......
Documentation/userspace-api/media/dvb/video-get-frame-count.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_GET_FRAME_COUNT: .. _VIDEO_GET_FRAME_COUNT:
...@@ -16,9 +17,9 @@ VIDEO_GET_FRAME_COUNT ...@@ -16,9 +17,9 @@ VIDEO_GET_FRAME_COUNT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_COUNT, __u64 *pts) .. c:macro:: VIDEO_GET_FRAME_COUNT
:name: VIDEO_GET_FRAME_COUNT
``int ioctl(int fd, VIDEO_GET_FRAME_COUNT, __u64 *pts)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -47,7 +47,6 @@ Arguments ...@@ -47,7 +47,6 @@ Arguments
- Returns the number of frames displayed since the decoder was - Returns the number of frames displayed since the decoder was
started. started.
Description Description
----------- -----------
...@@ -58,7 +57,6 @@ control. ...@@ -58,7 +57,6 @@ control.
This ioctl call asks the Video Device to return the number of displayed This ioctl call asks the Video Device to return the number of displayed
frames since the decoder was started. frames since the decoder was started.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-get-pts.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_GET_PTS: .. _VIDEO_GET_PTS:
...@@ -16,9 +17,9 @@ VIDEO_GET_PTS ...@@ -16,9 +17,9 @@ VIDEO_GET_PTS
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts) .. c:macro:: VIDEO_GET_PTS
:name: VIDEO_GET_PTS
``int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -51,7 +51,6 @@ Arguments ...@@ -51,7 +51,6 @@ Arguments
but may also be a value close to it like the PTS of the last but may also be a value close to it like the PTS of the last
decoded frame or the last PTS extracted by the PES parser. decoded frame or the last PTS extracted by the PES parser.
Description Description
----------- -----------
...@@ -62,7 +61,6 @@ control. ...@@ -62,7 +61,6 @@ control.
This ioctl call asks the Video Device to return the current PTS This ioctl call asks the Video Device to return the current PTS
timestamp. timestamp.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-get-size.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_GET_SIZE: .. _VIDEO_GET_SIZE:
...@@ -16,9 +17,9 @@ VIDEO_GET_SIZE ...@@ -16,9 +17,9 @@ VIDEO_GET_SIZE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size) .. c:macro:: VIDEO_GET_SIZE
:name: VIDEO_GET_SIZE
``int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Returns the size and aspect ratio. - Returns the size and aspect ratio.
Description Description
----------- -----------
...@@ -62,7 +61,6 @@ This ioctl returns the size and aspect ratio. ...@@ -62,7 +61,6 @@ This ioctl returns the size and aspect ratio.
video_format_t aspect_ratio; video_format_t aspect_ratio;
} video_size_t; } video_size_t;
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-get-status.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_GET_STATUS: .. _VIDEO_GET_STATUS:
...@@ -16,9 +17,9 @@ VIDEO_GET_STATUS ...@@ -16,9 +17,9 @@ VIDEO_GET_STATUS
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status) .. c:macro:: VIDEO_GET_STATUS
:name: VIDEO_GET_STATUS
``int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Returns the current status of the Video Device. - Returns the current status of the Video Device.
Description Description
----------- -----------
......
Documentation/userspace-api/media/dvb/video-play.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_PLAY: .. _VIDEO_PLAY:
...@@ -16,9 +17,9 @@ VIDEO_PLAY ...@@ -16,9 +17,9 @@ VIDEO_PLAY
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_PLAY) .. c:macro:: VIDEO_PLAY
:name: VIDEO_PLAY
``int ioctl(fd, VIDEO_PLAY)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -40,7 +40,6 @@ Arguments ...@@ -40,7 +40,6 @@ Arguments
- Equals VIDEO_PLAY for this command. - Equals VIDEO_PLAY for this command.
Description Description
----------- -----------
...@@ -50,7 +49,6 @@ V4L2 :ref:`VIDIOC_DECODER_CMD` instead. ...@@ -50,7 +49,6 @@ V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call asks the Video Device to start playing a video stream This ioctl call asks the Video Device to start playing a video stream
from the selected source. from the selected source.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-select-source.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_SELECT_SOURCE: .. _VIDEO_SELECT_SOURCE:
...@@ -16,9 +17,9 @@ VIDEO_SELECT_SOURCE ...@@ -16,9 +17,9 @@ VIDEO_SELECT_SOURCE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SELECT_SOURCE, video_stream_source_t source) .. c:macro:: VIDEO_SELECT_SOURCE
:name: VIDEO_SELECT_SOURCE
``int ioctl(fd, VIDEO_SELECT_SOURCE, video_stream_source_t source)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Indicates which source shall be used for the Video stream. - Indicates which source shall be used for the Video stream.
Description Description
----------- -----------
......
Documentation/userspace-api/media/dvb/video-set-blank.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_SET_BLANK: .. _VIDEO_SET_BLANK:
...@@ -16,9 +17,9 @@ VIDEO_SET_BLANK ...@@ -16,9 +17,9 @@ VIDEO_SET_BLANK
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode) .. c:macro:: VIDEO_SET_BLANK
:name: VIDEO_SET_BLANK
``int ioctl(fd, VIDEO_SET_BLANK, boolean mode)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -51,13 +51,11 @@ Arguments ...@@ -51,13 +51,11 @@ Arguments
- -
- FALSE: Show last decoded frame. - FALSE: Show last decoded frame.
Description Description
----------- -----------
This ioctl call asks the Video Device to blank out the picture. This ioctl call asks the Video Device to blank out the picture.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-set-display-format.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_SET_DISPLAY_FORMAT: .. _VIDEO_SET_DISPLAY_FORMAT:
...@@ -16,9 +17,9 @@ VIDEO_SET_DISPLAY_FORMAT ...@@ -16,9 +17,9 @@ VIDEO_SET_DISPLAY_FORMAT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT) .. c:macro:: VIDEO_SET_DISPLAY_FORMAT
:name: VIDEO_SET_DISPLAY_FORMAT
``int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,14 +46,12 @@ Arguments ...@@ -46,14 +46,12 @@ Arguments
- Selects the video format to be used. - Selects the video format to be used.
Description Description
----------- -----------
This ioctl call asks the Video Device to select the video format to be This ioctl call asks the Video Device to select the video format to be
applied by the MPEG chip on the video. applied by the MPEG chip on the video.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-set-format.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_SET_FORMAT: .. _VIDEO_SET_FORMAT:
...@@ -16,9 +17,9 @@ VIDEO_SET_FORMAT ...@@ -16,9 +17,9 @@ VIDEO_SET_FORMAT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format) .. c:macro:: VIDEO_SET_FORMAT
:name: VIDEO_SET_FORMAT
``int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- video format of TV as defined in section ??. - video format of TV as defined in section ??.
Description Description
----------- -----------
...@@ -72,12 +71,10 @@ appropriately. The generic error codes are described at the ...@@ -72,12 +71,10 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
.. flat-table:: .. flat-table::
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EINVAL`` - ``EINVAL``
......
Documentation/userspace-api/media/dvb/video-set-streamtype.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_SET_STREAMTYPE: .. _VIDEO_SET_STREAMTYPE:
...@@ -16,9 +17,9 @@ VIDEO_SET_STREAMTYPE ...@@ -16,9 +17,9 @@ VIDEO_SET_STREAMTYPE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_STREAMTYPE, int type) .. c:macro:: VIDEO_SET_STREAMTYPE
:name: VIDEO_SET_STREAMTYPE
``int ioctl(fd, VIDEO_SET_STREAMTYPE, int type)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- stream type - stream type
Description Description
----------- -----------
...@@ -54,7 +53,6 @@ This ioctl tells the driver which kind of stream to expect being written ...@@ -54,7 +53,6 @@ This ioctl tells the driver which kind of stream to expect being written
to it. If this call is not used the default of video PES is used. Some to it. If this call is not used the default of video PES is used. Some
drivers might not support this call and always expect PES. drivers might not support this call and always expect PES.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-slowmotion.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_SLOWMOTION: .. _VIDEO_SLOWMOTION:
...@@ -16,9 +17,9 @@ VIDEO_SLOWMOTION ...@@ -16,9 +17,9 @@ VIDEO_SLOWMOTION
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SLOWMOTION, int nFrames) .. c:macro:: VIDEO_SLOWMOTION
:name: VIDEO_SLOWMOTION
``int ioctl(fd, VIDEO_SLOWMOTION, int nFrames)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- The number of times to repeat each frame. - The number of times to repeat each frame.
Description Description
----------- -----------
...@@ -54,7 +53,6 @@ This ioctl call asks the video device to repeat decoding frames N number ...@@ -54,7 +53,6 @@ This ioctl call asks the video device to repeat decoding frames N number
of times. This call can only be used if VIDEO_SOURCE_MEMORY is of times. This call can only be used if VIDEO_SOURCE_MEMORY is
selected. selected.
Return Value Return Value
------------ ------------
...@@ -63,12 +61,10 @@ appropriately. The generic error codes are described at the ...@@ -63,12 +61,10 @@ appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter. :ref:`Generic Error Codes <gen-errors>` chapter.
.. flat-table:: .. flat-table::
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- ``EPERM`` - ``EPERM``
......
Documentation/userspace-api/media/dvb/video-stillpicture.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_STILLPICTURE: .. _VIDEO_STILLPICTURE:
...@@ -16,9 +17,9 @@ VIDEO_STILLPICTURE ...@@ -16,9 +17,9 @@ VIDEO_STILLPICTURE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp) .. c:macro:: VIDEO_STILLPICTURE
:name: VIDEO_STILLPICTURE
``int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Pointer to a location where an I-frame and size is stored. - Pointer to a location where an I-frame and size is stored.
Description Description
----------- -----------
...@@ -54,7 +53,6 @@ This ioctl call asks the Video Device to display a still picture ...@@ -54,7 +53,6 @@ This ioctl call asks the Video Device to display a still picture
(I-frame). The input data shall contain an I-frame. If the pointer is (I-frame). The input data shall contain an I-frame. If the pointer is
NULL, then the current displayed still picture is blanked. NULL, then the current displayed still picture is blanked.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-stop.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_STOP: .. _VIDEO_STOP:
...@@ -16,9 +17,9 @@ VIDEO_STOP ...@@ -16,9 +17,9 @@ VIDEO_STOP
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode) .. c:macro:: VIDEO_STOP
:name: VIDEO_STOP
``int ioctl(fd, VIDEO_STOP, boolean mode)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -56,7 +56,6 @@ Arguments ...@@ -56,7 +56,6 @@ Arguments
- -
- FALSE: Show last decoded frame. - FALSE: Show last decoded frame.
Description Description
----------- -----------
...@@ -67,7 +66,6 @@ This ioctl call asks the Video Device to stop playing the current ...@@ -67,7 +66,6 @@ This ioctl call asks the Video Device to stop playing the current
stream. Depending on the input parameter, the screen can be blanked out stream. Depending on the input parameter, the screen can be blanked out
or displaying the last decoded frame. or displaying the last decoded frame.
Return Value Return Value
------------ ------------
......
Documentation/userspace-api/media/dvb/video-try-command.rst
View file @ f9b2e8aa
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: DTV.video
.. _VIDEO_TRY_COMMAND: .. _VIDEO_TRY_COMMAND:
...@@ -16,9 +17,9 @@ VIDEO_TRY_COMMAND ...@@ -16,9 +17,9 @@ VIDEO_TRY_COMMAND
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd) .. c:macro:: VIDEO_TRY_COMMAND
:name: VIDEO_TRY_COMMAND
``int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd)``
Arguments Arguments
--------- ---------
...@@ -27,7 +28,6 @@ Arguments ...@@ -27,7 +28,6 @@ Arguments
:header-rows: 0 :header-rows: 0
:stub-columns: 0 :stub-columns: 0
- .. row 1 - .. row 1
- int fd - int fd
...@@ -46,7 +46,6 @@ Arguments ...@@ -46,7 +46,6 @@ Arguments
- Try a decoder command. - Try a decoder command.
Description Description
----------- -----------
...@@ -59,7 +58,6 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the ...@@ -59,7 +58,6 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation :ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
for more information. for more information.
Return Value Return Value
------------ ------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7