Commit 15e7d615 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

doc-rst: linux_tv: don't use uppercases for syscall sections

On the syscall conversions, we used uppercase for the sections,
but this is too bold. So, convert them to Camel Case, as it
looks visually better.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 4eb40f14
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_BILINGUAL_CHANNEL_SELECT AUDIO_BILINGUAL_CHANNEL_SELECT
============================== ==============================
NAME Name
---- ----
AUDIO_BILINGUAL_CHANNEL_SELECT AUDIO_BILINGUAL_CHANNEL_SELECT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t) .. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ 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
----------- -----------
This ioctl is obsolete. Do not use in new drivers. It has been replaced This ioctl is obsolete. Do not use in new drivers. It has been replaced
...@@ -55,7 +56,7 @@ This ioctl call asks the Audio Device to select the requested channel ...@@ -55,7 +56,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_CHANNEL_SELECT AUDIO_CHANNEL_SELECT
==================== ====================
NAME Name
---- ----
AUDIO_CHANNEL_SELECT AUDIO_CHANNEL_SELECT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t) .. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ 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
----------- -----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
...@@ -54,7 +55,7 @@ This ioctl call asks the Audio Device to select the requested channel if ...@@ -54,7 +55,7 @@ This ioctl call asks the Audio Device to select the requested channel if
possible. possible.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_CLEAR_BUFFER AUDIO_CLEAR_BUFFER
================== ==================
NAME Name
---- ----
AUDIO_CLEAR_BUFFER AUDIO_CLEAR_BUFFER
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER) .. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,14 +39,14 @@ ARGUMENTS ...@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_CLEAR_BUFFER for this command. - Equals AUDIO_CLEAR_BUFFER for this command.
DESCRIPTION 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_CONTINUE AUDIO_CONTINUE
============== ==============
NAME Name
---- ----
AUDIO_CONTINUE AUDIO_CONTINUE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE) .. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,14 +39,14 @@ ARGUMENTS ...@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_CONTINUE for this command. - Equals AUDIO_CONTINUE for this command.
DESCRIPTION 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB audio close() DVB audio close()
================= =================
NAME Name
---- ----
DVB audio close() DVB audio close()
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -32,13 +33,13 @@ ARGUMENTS ...@@ -32,13 +33,13 @@ ARGUMENTS
- 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB audio open() DVB audio open()
================ ================
NAME Name
---- ----
DVB audio open() DVB audio open()
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int open(const char *deviceName, int flags) .. c:function:: int open(const char *deviceName, int flags)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -58,7 +59,7 @@ ARGUMENTS ...@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default) - (blocking mode is the default)
DESCRIPTION Description
----------- -----------
This system call opens a named audio device (e.g. This system call opens a named audio device (e.g.
...@@ -76,7 +77,7 @@ in O_RDONLY mode, the only ioctl call that can be used is ...@@ -76,7 +77,7 @@ 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB audio write() DVB audio write()
================= =================
NAME Name
---- ----
DVB audio write() DVB audio write()
SYNOPSIS
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
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf. - Size of buf.
DESCRIPTION Description
----------- -----------
This system call can only be used if AUDIO_SOURCE_MEMORY is selected This system call can only be used if AUDIO_SOURCE_MEMORY is selected
...@@ -54,7 +55,7 @@ until buffer space is available. The amount of data to be transferred is ...@@ -54,7 +55,7 @@ until buffer space is available. The amount of data to be transferred is
implied by count. implied by count.
RETURN VALUE Return Value
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_GET_CAPABILITIES AUDIO_GET_CAPABILITIES
====================== ======================
NAME Name
---- ----
AUDIO_GET_CAPABILITIES AUDIO_GET_CAPABILITIES
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap) .. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_GET_PTS AUDIO_GET_PTS
============= =============
NAME Name
---- ----
AUDIO_GET_PTS AUDIO_GET_PTS
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts) .. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -49,7 +50,7 @@ ARGUMENTS ...@@ -49,7 +50,7 @@ ARGUMENTS
decoded frame or the last PTS extracted by the PES parser. decoded frame or the last PTS extracted by the PES parser.
DESCRIPTION Description
----------- -----------
This ioctl is obsolete. Do not use in new drivers. If you need this This ioctl is obsolete. Do not use in new drivers. If you need this
...@@ -60,7 +61,7 @@ This ioctl call asks the Audio Device to return the current PTS ...@@ -60,7 +61,7 @@ This ioctl call asks the Audio Device to return the current PTS
timestamp. timestamp.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_GET_STATUS AUDIO_GET_STATUS
================ ================
NAME Name
---- ----
AUDIO_GET_STATUS AUDIO_GET_STATUS
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status) .. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_PAUSE AUDIO_PAUSE
=========== ===========
NAME Name
---- ----
AUDIO_PAUSE AUDIO_PAUSE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE) .. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,7 +39,7 @@ ARGUMENTS ...@@ -38,7 +39,7 @@ ARGUMENTS
- Equals AUDIO_PAUSE for this command. - Equals AUDIO_PAUSE for this command.
DESCRIPTION Description
----------- -----------
This ioctl call suspends the audio stream being played. Decoding and This ioctl call suspends the audio stream being played. Decoding and
...@@ -46,7 +47,7 @@ playing are paused. It is then possible to restart again decoding and ...@@ -46,7 +47,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_PLAY AUDIO_PLAY
========== ==========
NAME Name
---- ----
AUDIO_PLAY AUDIO_PLAY
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY) .. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,14 +39,14 @@ ARGUMENTS ...@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_PLAY for this command. - Equals AUDIO_PLAY for this command.
DESCRIPTION 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SELECT_SOURCE AUDIO_SELECT_SOURCE
=================== ===================
NAME Name
---- ----
AUDIO_SELECT_SOURCE AUDIO_SELECT_SOURCE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source) .. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ 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
----------- -----------
This ioctl call informs the audio device which source shall be used for This ioctl call informs the audio device which source shall be used for
...@@ -53,7 +54,7 @@ AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device ...@@ -53,7 +54,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_ATTRIBUTES AUDIO_SET_ATTRIBUTES
==================== ====================
NAME Name
---- ----
AUDIO_SET_ATTRIBUTES AUDIO_SET_ATTRIBUTES
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr ) .. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ ARGUMENTS
- audio attributes according to section ?? - audio attributes according to section ??
DESCRIPTION Description
----------- -----------
This ioctl is intended for DVD playback and allows you to set certain This ioctl is intended for DVD playback and allows you to set certain
information about the audio stream. information about the audio stream.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_AV_SYNC AUDIO_SET_AV_SYNC
================= =================
NAME Name
---- ----
AUDIO_SET_AV_SYNC AUDIO_SET_AV_SYNC
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state) .. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -54,14 +55,14 @@ ARGUMENTS ...@@ -54,14 +55,14 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_BYPASS_MODE AUDIO_SET_BYPASS_MODE
===================== =====================
NAME Name
---- ----
AUDIO_SET_BYPASS_MODE AUDIO_SET_BYPASS_MODE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode) .. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -55,7 +56,7 @@ ARGUMENTS ...@@ -55,7 +56,7 @@ ARGUMENTS
- FALSE Bypass is enabled - FALSE Bypass is enabled
DESCRIPTION Description
----------- -----------
This ioctl call asks the Audio Device to bypass the Audio decoder and This ioctl call asks the Audio Device to bypass the Audio decoder and
...@@ -65,7 +66,7 @@ DigitalTM streams are automatically forwarded by the DVB subsystem if ...@@ -65,7 +66,7 @@ DigitalTM streams are automatically forwarded by the DVB subsystem if
the hardware can handle it. the hardware can handle it.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_EXT_ID AUDIO_SET_EXT_ID
================ ================
NAME Name
---- ----
AUDIO_SET_EXT_ID AUDIO_SET_EXT_ID
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id) .. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ ARGUMENTS
- audio sub_stream_id - audio sub_stream_id
DESCRIPTION Description
----------- -----------
This ioctl can be used to set the extension id for MPEG streams in DVD This ioctl can be used to set the extension id for MPEG streams in DVD
playback. Only the first 3 bits are recognized. playback. Only the first 3 bits are recognized.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_ID AUDIO_SET_ID
============ ============
NAME Name
---- ----
AUDIO_SET_ID AUDIO_SET_ID
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id) .. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- audio sub-stream id - audio sub-stream id
DESCRIPTION Description
----------- -----------
This ioctl selects which sub-stream is to be decoded if a program or This ioctl selects which sub-stream is to be decoded if a program or
...@@ -56,7 +57,7 @@ substream id of the audio stream and only the first 5 bits are ...@@ -56,7 +57,7 @@ substream id of the audio stream and only the first 5 bits are
recognized. recognized.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_KARAOKE AUDIO_SET_KARAOKE
================= =================
NAME Name
---- ----
AUDIO_SET_KARAOKE AUDIO_SET_KARAOKE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke) .. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- karaoke settings according to section ??. - karaoke settings according to section ??.
DESCRIPTION Description
----------- -----------
This ioctl allows one to set the mixer settings for a karaoke DVD. This ioctl allows one to set the mixer settings for a karaoke DVD.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_MIXER AUDIO_SET_MIXER
=============== ===============
NAME Name
---- ----
AUDIO_SET_MIXER AUDIO_SET_MIXER
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix) .. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_MUTE AUDIO_SET_MUTE
============== ==============
NAME Name
---- ----
AUDIO_SET_MUTE AUDIO_SET_MUTE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state) .. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -54,7 +55,7 @@ ARGUMENTS ...@@ -54,7 +55,7 @@ ARGUMENTS
- FALSE Audio Un-mute - FALSE Audio Un-mute
DESCRIPTION Description
----------- -----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
...@@ -65,7 +66,7 @@ This ioctl call asks the audio device to mute the stream that is ...@@ -65,7 +66,7 @@ This ioctl call asks the audio device to mute the stream that is
currently being played. currently being played.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_SET_STREAMTYPE AUDIO_SET_STREAMTYPE
==================== ====================
NAME Name
---- ----
AUDIO_SET_STREAMTYPE AUDIO_SET_STREAMTYPE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type) .. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- stream type - stream type
DESCRIPTION Description
----------- -----------
This ioctl tells the driver which kind of audio stream to expect. This This ioctl tells the driver which kind of audio stream to expect. This
...@@ -52,7 +53,7 @@ is useful if the stream offers several audio sub-streams like LPCM and ...@@ -52,7 +53,7 @@ is useful if the stream offers several audio sub-streams like LPCM and
AC3. AC3.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
AUDIO_STOP AUDIO_STOP
========== ==========
NAME Name
---- ----
AUDIO_STOP AUDIO_STOP
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = AUDIO_STOP) .. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,14 +39,14 @@ ARGUMENTS ...@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_STOP for this command. - Equals AUDIO_STOP for this command.
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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB CA close() DVB CA close()
============== ==============
NAME Name
---- ----
DVB CA close() DVB CA close()
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int close(int fd) .. cpp:function:: int close(int fd)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -32,13 +33,13 @@ ARGUMENTS ...@@ -32,13 +33,13 @@ ARGUMENTS
- 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB CA open() DVB CA open()
============= =============
NAME Name
---- ----
DVB CA open() DVB CA open()
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int open(const char *deviceName, int flags) .. cpp:function:: int open(const char *deviceName, int flags)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -58,7 +59,7 @@ ARGUMENTS ...@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default) - (blocking mode is the default)
DESCRIPTION Description
----------- -----------
This system call opens a named ca device (e.g. /dev/ost/ca) for This system call opens a named ca device (e.g. /dev/ost/ca) for
...@@ -75,7 +76,7 @@ user can open the CA Device in O_RDWR mode. All other attempts to open ...@@ -75,7 +76,7 @@ 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 will be returned. the device in this mode will fail, and an error code will be returned.
RETURN VALUE Return Value
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_GET_CAP CA_GET_CAP
========== ==========
NAME Name
---- ----
CA_GET_CAP CA_GET_CAP
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *) .. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_GET_DESCR_INFO CA_GET_DESCR_INFO
================= =================
NAME Name
---- ----
CA_GET_DESCR_INFO CA_GET_DESCR_INFO
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *) .. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_GET_MSG CA_GET_MSG
========== ==========
NAME Name
---- ----
CA_GET_MSG CA_GET_MSG
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *) .. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_GET_SLOT_INFO CA_GET_SLOT_INFO
================ ================
NAME Name
---- ----
CA_GET_SLOT_INFO CA_GET_SLOT_INFO
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *) .. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_RESET CA_RESET
======== ========
NAME Name
---- ----
CA_RESET CA_RESET
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_RESET) .. cpp:function:: int ioctl(fd, int request = CA_RESET)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,13 +39,13 @@ ARGUMENTS ...@@ -38,13 +39,13 @@ ARGUMENTS
- Equals CA_RESET for this command. - Equals CA_RESET for this command.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_SEND_MSG CA_SEND_MSG
=========== ===========
NAME Name
---- ----
CA_SEND_MSG CA_SEND_MSG
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *) .. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_SET_DESCR CA_SET_DESCR
============ ============
NAME Name
---- ----
CA_SET_DESCR CA_SET_DESCR
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *) .. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
CA_SET_PID CA_SET_PID
========== ==========
NAME Name
---- ----
CA_SET_PID CA_SET_PID
SYNOPSIS
Synopsis
-------- --------
.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *) .. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_ADD_PID DMX_ADD_PID
=========== ===========
NAME Name
---- ----
DMX_ADD_PID DMX_ADD_PID
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *) .. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- PID number to be filtered. - PID number to be filtered.
DESCRIPTION Description
----------- -----------
This ioctl call allows to add multiple PIDs to a transport stream filter This ioctl call allows to add multiple PIDs to a transport stream filter
...@@ -52,7 +53,7 @@ previously set up with DMX_SET_PES_FILTER and output equal to ...@@ -52,7 +53,7 @@ previously set up with DMX_SET_PES_FILTER and output equal to
DMX_OUT_TSDEMUX_TAP. DMX_OUT_TSDEMUX_TAP.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB demux close() DVB demux close()
================= =================
NAME Name
---- ----
DVB demux close() DVB demux close()
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -32,14 +33,14 @@ ARGUMENTS ...@@ -32,14 +33,14 @@ ARGUMENTS
- File descriptor returned by a previous call to open(). - File descriptor returned by a previous call to 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 open() call. previously allocated via the open() call.
RETURN VALUE Return Value
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB demux open() DVB demux open()
================ ================
NAME Name
---- ----
DVB demux open() DVB demux open()
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int open(const char *deviceName, int flags) .. c:function:: int open(const char *deviceName, int flags)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -53,7 +54,7 @@ ARGUMENTS ...@@ -53,7 +54,7 @@ ARGUMENTS
- (blocking mode is the default) - (blocking mode is the default)
DESCRIPTION Description
----------- -----------
This system call, used with a device name of /dev/dvb/adapter0/demux0, This system call, used with a device name of /dev/dvb/adapter0/demux0,
...@@ -74,7 +75,7 @@ blocking mode can later be put into non-blocking mode (and vice versa) ...@@ -74,7 +75,7 @@ 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB demux read() DVB demux read()
================ ================
NAME Name
---- ----
DVB demux read() DVB 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)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf. - Size of buf.
DESCRIPTION Description
----------- -----------
This system call returns filtered data, which might be section or PES This system call returns filtered data, which might be section or PES
...@@ -53,7 +54,7 @@ circular buffer to buf. The maximum amount of data to be transferred is ...@@ -53,7 +54,7 @@ circular buffer to buf. The maximum amount of data to be transferred is
implied by count. implied by count.
RETURN VALUE Return Value
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DVB demux write() DVB demux write()
================= =================
NAME Name
---- ----
DVB demux write() DVB 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)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf. - Size of buf.
DESCRIPTION Description
----------- -----------
This system call is only provided by the logical device This system call is only provided by the logical device
...@@ -55,7 +56,7 @@ in the corresponding physical demux device, /dev/dvb/adapter0/demux0. ...@@ -55,7 +56,7 @@ in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_GET_CAPS DMX_GET_CAPS
============ ============
NAME Name
---- ----
DMX_GET_CAPS DMX_GET_CAPS
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *) .. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_GET_EVENT DMX_GET_EVENT
============= =============
NAME Name
---- ----
DMX_GET_EVENT DMX_GET_EVENT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev) .. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to the location where the event is to be stored. - Pointer to the location where the event is to be stored.
DESCRIPTION Description
----------- -----------
This ioctl call returns an event if available. If an event is not This ioctl call returns an event if available. If an event is not
...@@ -54,7 +55,7 @@ errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an ...@@ -54,7 +55,7 @@ errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
event becomes available. event becomes available.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_GET_PES_PIDS DMX_GET_PES_PIDS
================ ================
NAME Name
---- ----
DMX_GET_PES_PIDS DMX_GET_PES_PIDS
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5]) .. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_GET_STC DMX_GET_STC
=========== ===========
NAME Name
---- ----
DMX_GET_STC DMX_GET_STC
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc) .. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to the location where the stc is to be stored. - Pointer to the location where the stc is to be stored.
DESCRIPTION Description
----------- -----------
This ioctl call returns the current value of the system time counter This ioctl call returns the current value of the system time counter
...@@ -55,7 +56,7 @@ in form of a ratio with a 64 bit numerator and a 32 bit denominator, so ...@@ -55,7 +56,7 @@ in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
the real 90kHz STC value is stc->stc / stc->base . the real 90kHz STC value is stc->stc / stc->base .
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_REMOVE_PID DMX_REMOVE_PID
============== ==============
NAME Name
---- ----
DMX_REMOVE_PID DMX_REMOVE_PID
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *) .. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- PID of the PES filter to be removed. - PID of the PES filter to be removed.
DESCRIPTION Description
----------- -----------
This ioctl call allows to remove a PID when multiple PIDs are set on a This ioctl call allows to remove a PID when multiple PIDs are set on a
...@@ -53,7 +54,7 @@ equal to DMX_OUT_TSDEMUX_TAP, created via either ...@@ -53,7 +54,7 @@ equal to DMX_OUT_TSDEMUX_TAP, created via either
DMX_SET_PES_FILTER or DMX_ADD_PID. DMX_SET_PES_FILTER or DMX_ADD_PID.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_SET_BUFFER_SIZE DMX_SET_BUFFER_SIZE
=================== ===================
NAME Name
---- ----
DMX_SET_BUFFER_SIZE DMX_SET_BUFFER_SIZE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size) .. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Size of circular buffer. - Size of circular buffer.
DESCRIPTION Description
----------- -----------
This ioctl call is used to set the size of the circular buffer used for This ioctl call is used to set the size of the circular buffer used for
...@@ -53,7 +54,7 @@ this function is not called a buffer size of 2 \* 4096 bytes will be ...@@ -53,7 +54,7 @@ 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 error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_SET_FILTER DMX_SET_FILTER
============== ==============
NAME Name
---- ----
DMX_SET_FILTER DMX_SET_FILTER
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params) .. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to structure containing filter parameters. - Pointer to structure containing filter parameters.
DESCRIPTION Description
----------- -----------
This ioctl call sets up a filter according to the filter and mask This ioctl call sets up a filter according to the filter and mask
...@@ -59,7 +60,7 @@ DMX_START ioctl call). If a filter was previously set-up, this filter ...@@ -59,7 +60,7 @@ DMX_START ioctl call). If a filter was previously set-up, this filter
will be canceled, and the receive buffer will be flushed. will be canceled, and the receive buffer will be flushed.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_SET_PES_FILTER DMX_SET_PES_FILTER
================== ==================
NAME Name
---- ----
DMX_SET_PES_FILTER DMX_SET_PES_FILTER
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params) .. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to structure containing filter parameters. - Pointer to structure containing filter parameters.
DESCRIPTION Description
----------- -----------
This ioctl call sets up a PES filter according to the parameters This ioctl call sets up a PES filter according to the parameters
...@@ -53,7 +54,7 @@ packet identifier (PID), i.e. no PES header or payload filtering ...@@ -53,7 +54,7 @@ packet identifier (PID), i.e. no PES header or payload filtering
capability is supported. capability is supported.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_SET_SOURCE DMX_SET_SOURCE
============== ==============
NAME Name
---- ----
DMX_SET_SOURCE DMX_SET_SOURCE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *) .. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented. - Undocumented.
DESCRIPTION Description
----------- -----------
This ioctl is undocumented. Documentation is welcome. This ioctl is undocumented. Documentation is welcome.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_START DMX_START
========= =========
NAME Name
---- ----
DMX_START DMX_START
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_START) .. c:function:: int ioctl( int fd, int request = DMX_START)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,14 +39,14 @@ ARGUMENTS ...@@ -38,14 +39,14 @@ ARGUMENTS
- Equals DMX_START for this command. - Equals DMX_START for this command.
DESCRIPTION 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 DMX_SET_FILTER or DMX_SET_PES_FILTER. via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
DMX_STOP DMX_STOP
======== ========
NAME Name
---- ----
DMX_STOP DMX_STOP
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl( int fd, int request = DMX_STOP) .. c:function:: int ioctl( int fd, int request = DMX_STOP)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,7 +39,7 @@ ARGUMENTS ...@@ -38,7 +39,7 @@ ARGUMENTS
- Equals DMX_STOP for this command. - Equals DMX_STOP for this command.
DESCRIPTION Description
----------- -----------
This ioctl call is used to stop the actual filtering operation defined This ioctl call is used to stop the actual filtering operation defined
...@@ -46,7 +47,7 @@ via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and ...@@ -46,7 +47,7 @@ via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and
started via the DMX_START command. started via the DMX_START command.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_DISEQC_RECV_SLAVE_REPLY ioctl FE_DISEQC_RECV_SLAVE_REPLY
******************************** ********************************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp ) .. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>` :ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
DESCRIPTION Description
=========== ===========
Receives reply from a DiSEqC 2.0 command. Receives reply from a DiSEqC 2.0 command.
...@@ -73,7 +74,8 @@ struct dvb_diseqc_slave_reply ...@@ -73,7 +74,8 @@ struct dvb_diseqc_slave_reply
- Return from ioctl after timeout ms with errorcode when no message - Return from ioctl after timeout ms with errorcode when no message
was received was received
RETURN VALUE
Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_DISEQC_RESET_OVERLOAD ioctl FE_DISEQC_RESET_OVERLOAD
****************************** ******************************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, NULL ) .. cpp:function:: int ioctl( int fd, int request, NULL )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -27,7 +28,7 @@ ARGUMENTS ...@@ -27,7 +28,7 @@ ARGUMENTS
FE_DISEQC_RESET_OVERLOAD FE_DISEQC_RESET_OVERLOAD
DESCRIPTION Description
=========== ===========
If the bus has been automatically powered off due to power overload, If the bus has been automatically powered off due to power overload,
...@@ -36,7 +37,7 @@ read/write access to the device. This call has no effect if the device ...@@ -36,7 +37,7 @@ read/write access to the device. This call has no effect if the device
is manually powered off. Not all DVB adapters support this ioctl. is manually powered off. Not all DVB adapters support this ioctl.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_DISEQC_SEND_BURST ioctl FE_DISEQC_SEND_BURST
************************** **************************
NAME 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, int request, enum fe_sec_mini_cmd *tone ) .. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>` pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
DESCRIPTION Description
=========== ===========
This ioctl is used to set the generation of a 22kHz tone burst for mini This ioctl is used to set the generation of a 22kHz tone burst for mini
...@@ -74,7 +75,8 @@ enum fe_sec_mini_cmd ...@@ -74,7 +75,8 @@ enum fe_sec_mini_cmd
- Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B - Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
RETURN VALUE
Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_DISEQC_SEND_MASTER_CMD ioctl FE_DISEQC_SEND_MASTER_CMD
******************************* *******************************
NAME Name
==== ====
FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp ) .. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,13 +32,13 @@ ARGUMENTS ...@@ -31,13 +32,13 @@ ARGUMENTS
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>` :ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
DESCRIPTION Description
=========== ===========
Sends a DiSEqC command to the antenna subsystem. Sends a DiSEqC command to the antenna subsystem.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_DISHNETWORK_SEND_LEGACY_CMD FE_DISHNETWORK_SEND_LEGACY_CMD
****************************** ******************************
NAME Name
==== ====
FE_DISHNETWORK_SEND_LEGACY_CMD FE_DISHNETWORK_SEND_LEGACY_CMD
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd) .. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -32,7 +33,7 @@ ARGUMENTS ...@@ -32,7 +33,7 @@ ARGUMENTS
- sends the specified raw cmd to the dish via DISEqC. - sends the specified raw cmd to the dish via DISEqC.
DESCRIPTION Description
=========== ===========
WARNING: This is a very obscure legacy command, used only at stv0299 WARNING: This is a very obscure legacy command, used only at stv0299
...@@ -45,7 +46,7 @@ As support for this ioctl were added in 2004, this means that such ...@@ -45,7 +46,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_ENABLE_HIGH_LNB_VOLTAGE ioctl FE_ENABLE_HIGH_LNB_VOLTAGE
******************************** ********************************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, unsigned int high ) .. cpp:function:: int ioctl( int fd, int request, unsigned int high )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -35,7 +36,7 @@ ARGUMENTS ...@@ -35,7 +36,7 @@ ARGUMENTS
to compensate for long antenna cables. to compensate for long antenna cables.
DESCRIPTION Description
=========== ===========
Select output DC level between normal LNBf voltages or higher LNBf Select output DC level between normal LNBf voltages or higher LNBf
...@@ -43,7 +44,7 @@ voltages between 0 (normal) or a value grater than 0 for higher ...@@ -43,7 +44,7 @@ voltages between 0 (normal) or a value grater than 0 for higher
voltages. voltages.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_GET_EVENT FE_GET_EVENT
************ ************
NAME Name
==== ====
FE_GET_EVENT FE_GET_EVENT
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev) .. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -49,7 +50,7 @@ ARGUMENTS ...@@ -49,7 +50,7 @@ ARGUMENTS
- if any, is to be stored. - if any, is to be stored.
DESCRIPTION Description
=========== ===========
This ioctl call returns a frontend event if available. If an event is This ioctl call returns a frontend event if available. If an event is
...@@ -59,7 +60,7 @@ with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until ...@@ -59,7 +60,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_GET_FRONTEND FE_GET_FRONTEND
*************** ***************
NAME Name
==== ====
FE_GET_FRONTEND FE_GET_FRONTEND
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p) .. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -45,14 +46,14 @@ ARGUMENTS ...@@ -45,14 +46,14 @@ ARGUMENTS
- 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_GET_INFO ioctl FE_GET_INFO
***************** *****************
NAME Name
==== ====
FE_GET_INFO - Query DVB frontend capabilities and returns information about the - front-end. This call only requires read-only access to the device FE_GET_INFO - Query DVB frontend capabilities and returns information about the - front-end. This call only requires read-only access to the device
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp ) .. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`dvb_frontend_info <dvb-frontend-info>` :ref:`dvb_frontend_info <dvb-frontend-info>`
DESCRIPTION Description
=========== ===========
All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used
...@@ -418,7 +419,8 @@ supported only on some specific frontend types. ...@@ -418,7 +419,8 @@ supported only on some specific frontend types.
- The frontend can stop spurious TS data output - The frontend can stop spurious TS data output
RETURN VALUE
Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_SET_PROPERTY, FE_GET_PROPERTY ioctl FE_SET_PROPERTY, FE_GET_PROPERTY
************************************** **************************************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp ) .. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dtv_properties <dtv-properties>` pointer to struct :ref:`dtv_properties <dtv-properties>`
DESCRIPTION Description
=========== ===========
All DVB frontend devices support the ``FE_SET_PROPERTY`` and All DVB frontend devices support the ``FE_SET_PROPERTY`` and
...@@ -59,7 +60,7 @@ depends on the delivery system and on the device: ...@@ -59,7 +60,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,19 +6,19 @@ ...@@ -6,19 +6,19 @@
FE_READ_BER FE_READ_BER
*********** ***********
Description Name
----------- ====
This ioctl call returns the bit error rate for the signal currently FE_READ_BER
received/demodulated by the front-end. For this command, read-only
access to the device is sufficient.
SYNOPSIS Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber) .. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
Arguments Arguments
---------- =========
.. flat-table:: .. flat-table::
:header-rows: 0 :header-rows: 0
...@@ -44,8 +44,16 @@ Arguments ...@@ -44,8 +44,16 @@ Arguments
- The bit error rate is stored into \*ber. - The bit error rate is stored into \*ber.
Description
===========
This ioctl call returns the bit error rate for the signal currently
received/demodulated by the front-end. For this command, read-only
access to the device is sufficient.
Return Value Return Value
------------ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the appropriately. The generic error codes are described at the
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_READ_SIGNAL_STRENGTH FE_READ_SIGNAL_STRENGTH
*********************** ***********************
NAME Name
==== ====
FE_READ_SIGNAL_STRENGTH FE_READ_SIGNAL_STRENGTH
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength) .. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -46,7 +47,7 @@ ARGUMENTS ...@@ -46,7 +47,7 @@ ARGUMENTS
- The signal strength value is stored into \*strength. - The signal strength value is stored into \*strength.
DESCRIPTION Description
=========== ===========
This ioctl call returns the signal strength value for the signal This ioctl call returns the signal strength value for the signal
...@@ -54,7 +55,7 @@ currently received by the front-end. For this command, read-only access ...@@ -54,7 +55,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_READ_SNR FE_READ_SNR
*********** ***********
NAME Name
==== ====
FE_READ_SNR FE_READ_SNR
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr) .. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- The signal-to-noise ratio is stored into \*snr. - The signal-to-noise ratio is stored into \*snr.
DESCRIPTION Description
=========== ===========
This ioctl call returns the signal-to-noise ratio for the signal This ioctl call returns the signal-to-noise ratio for the signal
...@@ -52,7 +53,7 @@ currently received by the front-end. For this command, read-only access ...@@ -52,7 +53,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_READ_STATUS ioctl FE_READ_STATUS
******************** ********************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, unsigned int *status ) .. cpp:function:: int ioctl( int fd, int request, unsigned int *status )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`fe_status <fe-status>`. :ref:`fe_status <fe-status>`.
DESCRIPTION Description
=========== ===========
All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is
...@@ -125,7 +126,8 @@ state changes of the frontend hardware. It is produced using the enum ...@@ -125,7 +126,8 @@ state changes of the frontend hardware. It is produced using the enum
- The frontend was reinitialized, application is recommended to - The frontend was reinitialized, application is recommended to
reset DiSEqC, tone and parameters reset DiSEqC, tone and parameters
RETURN VALUE
Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_READ_UNCORRECTED_BLOCKS FE_READ_UNCORRECTED_BLOCKS
************************** **************************
NAME Name
==== ====
FE_READ_UNCORRECTED_BLOCKS FE_READ_UNCORRECTED_BLOCKS
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks) .. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -46,7 +47,7 @@ ARGUMENTS ...@@ -46,7 +47,7 @@ ARGUMENTS
- 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
=========== ===========
This ioctl call returns the number of uncorrected blocks detected by the This ioctl call returns the number of uncorrected blocks detected by the
...@@ -56,7 +57,7 @@ calculated. For this command, read-only access to the device is ...@@ -56,7 +57,7 @@ calculated. For this command, read-only access to the device is
sufficient. sufficient.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_SET_FRONTEND_TUNE_MODE ioctl FE_SET_FRONTEND_TUNE_MODE
******************************* *******************************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, unsigned int flags ) .. cpp:function:: int ioctl( int fd, int request, unsigned int flags )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -39,14 +40,14 @@ ARGUMENTS ...@@ -39,14 +40,14 @@ ARGUMENTS
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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
FE_SET_FRONTEND FE_SET_FRONTEND
*************** ***************
NAME Name
==== ====
FE_SET_FRONTEND FE_SET_FRONTEND
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p) .. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
ARGUMENTS Arguments
========= =========
.. flat-table:: .. flat-table::
...@@ -45,7 +46,7 @@ ARGUMENTS ...@@ -45,7 +46,7 @@ ARGUMENTS
- Points to parameters for tuning operation. - Points to parameters for tuning operation.
DESCRIPTION Description
=========== ===========
This ioctl call starts a tuning operation using specified parameters. This ioctl call starts a tuning operation using specified parameters.
...@@ -59,7 +60,7 @@ previous operation will be aborted in favor of the new one. This command ...@@ -59,7 +60,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_SET_TONE ioctl FE_SET_TONE
***************** *****************
NAME 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, int request, enum fe_sec_tone_mode *tone ) .. c:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>` pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>`
DESCRIPTION Description
=========== ===========
This ioctl is used to set the generation of the continuous 22kHz tone. This ioctl is used to set the generation of the continuous 22kHz tone.
...@@ -81,7 +82,8 @@ enum fe_sec_tone_mode ...@@ -81,7 +82,8 @@ enum fe_sec_tone_mode
- Don't send a 22kHz tone to the antenna (except if the - Don't send a 22kHz tone to the antenna (except if the
FE_DISEQC_* ioctls are called) FE_DISEQC_* ioctls are called)
RETURN VALUE
Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl FE_SET_VOLTAGE ioctl FE_SET_VOLTAGE
******************** ********************
NAME 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, int request, enum fe_sec_voltage *voltage ) .. c:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -33,7 +34,7 @@ ARGUMENTS ...@@ -33,7 +34,7 @@ ARGUMENTS
:ref:`fe_sec_voltage <fe-sec-voltage>`. :ref:`fe_sec_voltage <fe-sec-voltage>`.
DESCRIPTION Description
=========== ===========
This ioctl allows to set the DC voltage level sent through the antenna This ioctl allows to set the DC voltage level sent through the antenna
...@@ -54,7 +55,7 @@ the voltage to SEC_VOLTAGE_OFF while the device is not is used is ...@@ -54,7 +55,7 @@ the voltage to SEC_VOLTAGE_OFF while the device is not is used is
recommended. recommended.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
DVB frontend close() DVB frontend close()
******************** ********************
NAME Name
==== ====
fe-close - Close a frontend device fe-close - Close a frontend device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,14 +23,14 @@ SYNOPSIS ...@@ -22,14 +23,14 @@ SYNOPSIS
.. cpp:function:: int close( int fd ) .. cpp:function:: int close( int fd )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
DESCRIPTION Description
=========== ===========
This system call closes a previously opened front-end device. After This system call closes a previously opened front-end device. After
...@@ -37,7 +38,7 @@ closing a front-end device, its corresponding hardware might be powered ...@@ -37,7 +38,7 @@ closing a front-end device, its corresponding hardware might be powered
down automatically. down automatically.
RETURN VALUE Return Value
============ ============
The function returns 0 on success, -1 on failure and the ``errno`` is The function returns 0 on success, -1 on failure and the ``errno`` is
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
DVB frontend open() DVB frontend open()
******************* *******************
NAME Name
==== ====
fe-open - Open a frontend device fe-open - Open a frontend device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags ) .. cpp:function:: int open( const char *device_name, int flags )
ARGUMENTS Arguments
========= =========
``device_name`` ``device_name``
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
Other flags have no effect. Other flags have no effect.
DESCRIPTION Description
=========== ===========
This system call opens a named frontend device This system call opens a named frontend device
...@@ -70,7 +71,7 @@ powered up, and that other front-ends may have been powered down to make ...@@ -70,7 +71,7 @@ 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 :ref:`open() <frontend_f_open>` returns the new file descriptor.
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl NET_ADD_IF ioctl NET_ADD_IF
**************** ****************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if ) .. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dvb_net_if <dvb-net-if>` pointer to struct :ref:`dvb_net_if <dvb-net-if>`
DESCRIPTION Description
=========== ===========
The NET_ADD_IF ioctl system call selects the Packet ID (PID) that The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
...@@ -82,7 +83,7 @@ struct dvb_net_if description ...@@ -82,7 +83,7 @@ struct dvb_net_if description
``DVB_NET_FEEDTYPE_ULE`` for ULE encoding. ``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl NET_GET_IF ioctl NET_GET_IF
**************** ****************
NAME 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
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if ) .. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dvb_net_if <dvb-net-if>` pointer to struct :ref:`dvb_net_if <dvb-net-if>`
DESCRIPTION Description
=========== ===========
The NET_GET_IF ioctl uses the interface number given by the struct The NET_GET_IF ioctl uses the interface number given by the struct
...@@ -41,7 +42,7 @@ created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill ...@@ -41,7 +42,7 @@ 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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl NET_REMOVE_IF ioctl NET_REMOVE_IF
******************* *******************
NAME Name
==== ====
NET_REMOVE_IF - Removes a network interface. NET_REMOVE_IF - Removes a network interface.
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, int ifnum ) .. cpp:function:: int ioctl( int fd, int request, int ifnum )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,14 +31,14 @@ ARGUMENTS ...@@ -30,14 +31,14 @@ ARGUMENTS
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
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_CLEAR_BUFFER VIDEO_CLEAR_BUFFER
================== ==================
NAME Name
---- ----
VIDEO_CLEAR_BUFFER VIDEO_CLEAR_BUFFER
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER) .. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,14 +39,14 @@ ARGUMENTS ...@@ -38,14 +39,14 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_COMMAND VIDEO_COMMAND
============= =============
NAME Name
---- ----
VIDEO_COMMAND VIDEO_COMMAND
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd) .. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Commands the decoder. - Commands the decoder.
DESCRIPTION Description
----------- -----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
...@@ -57,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the ...@@ -57,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
more information. more information.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_CONTINUE VIDEO_CONTINUE
============== ==============
NAME Name
---- ----
VIDEO_CONTINUE VIDEO_CONTINUE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE) .. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,7 +39,7 @@ ARGUMENTS ...@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_CONTINUE for this command. - Equals VIDEO_CONTINUE for this command.
DESCRIPTION Description
----------- -----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
...@@ -48,7 +49,7 @@ This ioctl call restarts decoding and playing processes of the video ...@@ -48,7 +49,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_FAST_FORWARD VIDEO_FAST_FORWARD
================== ==================
NAME Name
---- ----
VIDEO_FAST_FORWARD VIDEO_FAST_FORWARD
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames) .. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- The number of frames to skip. - The number of frames to skip.
DESCRIPTION Description
----------- -----------
This ioctl call asks the Video Device to skip decoding of N number of This ioctl call asks the Video Device to skip decoding of N number of
...@@ -52,7 +53,7 @@ I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is ...@@ -52,7 +53,7 @@ I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
selected. selected.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
dvb video close() dvb video close()
================= =================
NAME Name
---- ----
dvb video close() dvb video close()
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int close(int fd) .. c:function:: int close(int fd)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -32,13 +33,13 @@ ARGUMENTS ...@@ -32,13 +33,13 @@ ARGUMENTS
- 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
dvb video open() dvb video open()
================ ================
NAME Name
---- ----
dvb video open() dvb video open()
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int open(const char *deviceName, int flags) .. c:function:: int open(const char *deviceName, int flags)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -58,7 +59,7 @@ ARGUMENTS ...@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default) - (blocking mode is the default)
DESCRIPTION Description
----------- -----------
This system call opens a named video device (e.g. This system call opens a named video device (e.g.
...@@ -78,7 +79,7 @@ ioctl call that can be used is VIDEO_GET_STATUS. All other call will ...@@ -78,7 +79,7 @@ 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_FREEZE VIDEO_FREEZE
============ ============
NAME Name
---- ----
VIDEO_FREEZE VIDEO_FREEZE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE) .. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,7 +39,7 @@ ARGUMENTS ...@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_FREEZE for this command. - Equals VIDEO_FREEZE for this command.
DESCRIPTION Description
----------- -----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
...@@ -52,7 +53,7 @@ VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data ...@@ -52,7 +53,7 @@ VIDEO_SELECT_SOURCE, the DVB 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
dvb video write() dvb video write()
================= =================
NAME Name
---- ----
dvb video write() dvb video write()
SYNOPSIS
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
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf. - Size of buf.
DESCRIPTION Description
----------- -----------
This system call can only be used if VIDEO_SOURCE_MEMORY is selected This system call can only be used if VIDEO_SOURCE_MEMORY is selected
...@@ -54,7 +55,7 @@ is not specified the function will block until buffer space is ...@@ -54,7 +55,7 @@ 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
------------ ------------
.. flat-table:: .. flat-table::
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_CAPABILITIES VIDEO_GET_CAPABILITIES
====================== ======================
NAME Name
---- ----
VIDEO_GET_CAPABILITIES VIDEO_GET_CAPABILITIES
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap) .. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to a location where to store the capability information. - Pointer to a location where to store the capability information.
DESCRIPTION Description
----------- -----------
This ioctl call asks the video device about its decoding capabilities. This ioctl call asks the video device about its decoding capabilities.
...@@ -52,7 +53,7 @@ On success it returns and integer which has bits set according to the ...@@ -52,7 +53,7 @@ On success it returns and integer which has bits set according to the
defines in section ??. defines in section ??.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_EVENT VIDEO_GET_EVENT
=============== ===============
NAME Name
---- ----
VIDEO_GET_EVENT VIDEO_GET_EVENT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev) .. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ 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
----------- -----------
This ioctl is for DVB devices only. To get events from a V4L2 decoder This ioctl is for DVB devices only. To get events from a V4L2 decoder
...@@ -62,7 +63,7 @@ specified as the wake-up condition. Read-only permissions are sufficient ...@@ -62,7 +63,7 @@ specified as the wake-up condition. Read-only permissions are sufficient
for this ioctl call. for this ioctl call.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_FRAME_COUNT VIDEO_GET_FRAME_COUNT
===================== =====================
NAME Name
---- ----
VIDEO_GET_FRAME_COUNT VIDEO_GET_FRAME_COUNT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts) .. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -45,7 +46,7 @@ ARGUMENTS ...@@ -45,7 +46,7 @@ ARGUMENTS
started. started.
DESCRIPTION Description
----------- -----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
...@@ -56,7 +57,7 @@ This ioctl call asks the Video Device to return the number of displayed ...@@ -56,7 +57,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_FRAME_RATE VIDEO_GET_FRAME_RATE
==================== ====================
NAME Name
---- ----
VIDEO_GET_FRAME_RATE VIDEO_GET_FRAME_RATE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate) .. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Returns the framerate in number of frames per 1000 seconds. - Returns the framerate in number of frames per 1000 seconds.
DESCRIPTION Description
----------- -----------
This ioctl call asks the Video Device to return the current framerate. This ioctl call asks the Video Device to return the current framerate.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_NAVI VIDEO_GET_NAVI
============== ==============
NAME Name
---- ----
VIDEO_GET_NAVI VIDEO_GET_NAVI
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack) .. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- PCI or DSI pack (private stream 2) according to section ??. - PCI or DSI pack (private stream 2) according to section ??.
DESCRIPTION Description
----------- -----------
This ioctl returns navigational information from the DVD stream. This is This ioctl returns navigational information from the DVD stream. This is
...@@ -52,7 +53,7 @@ especially needed if an encoded stream has to be decoded by the ...@@ -52,7 +53,7 @@ especially needed if an encoded stream has to be decoded by the
hardware. hardware.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_PTS VIDEO_GET_PTS
============= =============
NAME Name
---- ----
VIDEO_GET_PTS VIDEO_GET_PTS
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts) .. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -49,7 +50,7 @@ ARGUMENTS ...@@ -49,7 +50,7 @@ ARGUMENTS
decoded frame or the last PTS extracted by the PES parser. decoded frame or the last PTS extracted by the PES parser.
DESCRIPTION Description
----------- -----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
...@@ -60,7 +61,7 @@ This ioctl call asks the Video Device to return the current PTS ...@@ -60,7 +61,7 @@ This ioctl call asks the Video Device to return the current PTS
timestamp. timestamp.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_SIZE VIDEO_GET_SIZE
============== ==============
NAME Name
---- ----
VIDEO_GET_SIZE VIDEO_GET_SIZE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size) .. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- Returns the size and aspect ratio. - Returns the size and aspect ratio.
DESCRIPTION Description
----------- -----------
This ioctl returns the size and aspect ratio. This ioctl returns the size and aspect ratio.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_GET_STATUS VIDEO_GET_STATUS
================ ================
NAME Name
---- ----
VIDEO_GET_STATUS VIDEO_GET_STATUS
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status) .. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ ARGUMENTS
- Returns the current status of the Video Device. - Returns the current status of the Video Device.
DESCRIPTION Description
----------- -----------
This ioctl call asks the Video Device to return the current status of This ioctl call asks the Video Device to return the current status of
the device. the device.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_PLAY VIDEO_PLAY
========== ==========
NAME Name
---- ----
VIDEO_PLAY VIDEO_PLAY
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_PLAY) .. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -38,7 +39,7 @@ ARGUMENTS ...@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_PLAY for this command. - Equals VIDEO_PLAY for this command.
DESCRIPTION Description
----------- -----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
...@@ -48,7 +49,7 @@ This ioctl call asks the Video Device to start playing a video stream ...@@ -48,7 +49,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SELECT_SOURCE VIDEO_SELECT_SOURCE
=================== ===================
NAME Name
---- ----
VIDEO_SELECT_SOURCE VIDEO_SELECT_SOURCE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source) .. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Indicates which source shall be used for the Video stream. - Indicates which source shall be used for the Video stream.
DESCRIPTION Description
----------- -----------
This ioctl is for DVB devices only. This ioctl was also supported by the This ioctl is for DVB devices only. This ioctl was also supported by the
...@@ -56,7 +57,7 @@ the input data. The possible sources are demux or memory. If memory is ...@@ -56,7 +57,7 @@ the input data. The possible sources are demux or memory. If memory is
selected, the data is fed to the video device through the write command. selected, the data is fed to the video device through the write command.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_ATTRIBUTES VIDEO_SET_ATTRIBUTES
==================== ====================
NAME Name
---- ----
VIDEO_SET_ATTRIBUTES VIDEO_SET_ATTRIBUTES
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr) .. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- video attributes according to section ??. - video attributes according to section ??.
DESCRIPTION Description
----------- -----------
This ioctl is intended for DVD playback and allows you to set certain This ioctl is intended for DVD playback and allows you to set certain
...@@ -53,7 +54,7 @@ information, but the call also tells the hardware to prepare for DVD ...@@ -53,7 +54,7 @@ information, but the call also tells the hardware to prepare for DVD
playback. playback.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_BLANK VIDEO_SET_BLANK
=============== ===============
NAME Name
---- ----
VIDEO_SET_BLANK VIDEO_SET_BLANK
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode) .. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -49,13 +50,13 @@ ARGUMENTS ...@@ -49,13 +50,13 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_DISPLAY_FORMAT VIDEO_SET_DISPLAY_FORMAT
======================== ========================
NAME Name
---- ----
VIDEO_SET_DISPLAY_FORMAT VIDEO_SET_DISPLAY_FORMAT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format) .. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_FORMAT VIDEO_SET_FORMAT
================ ================
NAME Name
---- ----
VIDEO_SET_FORMAT VIDEO_SET_FORMAT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format) .. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- video format of TV as defined in section ??. - video format of TV as defined in section ??.
DESCRIPTION Description
----------- -----------
This ioctl sets the screen format (aspect ratio) of the connected output This ioctl sets the screen format (aspect ratio) of the connected output
...@@ -52,7 +53,7 @@ device (TV) so that the output of the decoder can be adjusted ...@@ -52,7 +53,7 @@ device (TV) so that the output of the decoder can be adjusted
accordingly. accordingly.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_HIGHLIGHT VIDEO_SET_HIGHLIGHT
=================== ===================
NAME Name
---- ----
VIDEO_SET_HIGHLIGHT VIDEO_SET_HIGHLIGHT
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite) .. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ ARGUMENTS
- SPU Highlight information according to section ??. - SPU Highlight information according to section ??.
DESCRIPTION Description
----------- -----------
This ioctl sets the SPU highlight information for the menu access of a This ioctl sets the SPU highlight information for the menu access of a
DVD. DVD.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_ID VIDEO_SET_ID
============ ============
NAME Name
---- ----
VIDEO_SET_ID VIDEO_SET_ID
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id) .. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,14 +45,14 @@ ARGUMENTS ...@@ -44,14 +45,14 @@ ARGUMENTS
- video sub-stream id - video sub-stream id
DESCRIPTION Description
----------- -----------
This ioctl selects which sub-stream is to be decoded if a program or This ioctl selects which sub-stream is to be decoded if a program or
system stream is sent to the video device. system stream is sent to the video device.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_SPU_PALETTE VIDEO_SET_SPU_PALETTE
===================== =====================
NAME Name
---- ----
VIDEO_SET_SPU_PALETTE VIDEO_SET_SPU_PALETTE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette ) .. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,13 +45,13 @@ ARGUMENTS ...@@ -44,13 +45,13 @@ ARGUMENTS
- SPU palette according to section ??. - SPU palette according to section ??.
DESCRIPTION Description
----------- -----------
This ioctl sets the SPU color palette. This ioctl sets the SPU color palette.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_SPU VIDEO_SET_SPU
============= =============
NAME Name
---- ----
VIDEO_SET_SPU VIDEO_SET_SPU
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu) .. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -45,14 +46,14 @@ ARGUMENTS ...@@ -45,14 +46,14 @@ ARGUMENTS
??. ??.
DESCRIPTION Description
----------- -----------
This ioctl activates or deactivates SPU decoding in a DVD input stream. This ioctl activates or deactivates SPU decoding in a DVD input stream.
It can only be used, if the driver is able to handle a DVD stream. It can only be used, if the driver is able to handle a DVD stream.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_STREAMTYPE VIDEO_SET_STREAMTYPE
==================== ====================
NAME Name
---- ----
VIDEO_SET_STREAMTYPE VIDEO_SET_STREAMTYPE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type) .. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- stream type - stream type
DESCRIPTION Description
----------- -----------
This ioctl tells the driver which kind of stream to expect being written This ioctl tells the driver which kind of stream to expect being written
...@@ -52,7 +53,7 @@ to it. If this call is not used the default of video PES is used. Some ...@@ -52,7 +53,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SET_SYSTEM VIDEO_SET_SYSTEM
================ ================
NAME Name
---- ----
VIDEO_SET_SYSTEM VIDEO_SET_SYSTEM
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system) .. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- video system of TV output. - video system of TV output.
DESCRIPTION Description
----------- -----------
This ioctl sets the television output format. The format (see section This ioctl sets the television output format. The format (see section
...@@ -53,7 +54,7 @@ hardware is not able to display the requested format the call will ...@@ -53,7 +54,7 @@ hardware is not able to display the requested format the call will
return an error. return an error.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_SLOWMOTION VIDEO_SLOWMOTION
================ ================
NAME Name
---- ----
VIDEO_SLOWMOTION VIDEO_SLOWMOTION
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames) .. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- The number of times to repeat each frame. - The number of times to repeat each frame.
DESCRIPTION Description
----------- -----------
This ioctl call asks the video device to repeat decoding frames N number This ioctl call asks the video device to repeat decoding frames N number
...@@ -52,7 +53,7 @@ of times. This call can only be used if VIDEO_SOURCE_MEMORY is ...@@ -52,7 +53,7 @@ of times. This call can only be used if VIDEO_SOURCE_MEMORY is
selected. selected.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_STILLPICTURE VIDEO_STILLPICTURE
================== ==================
NAME Name
---- ----
VIDEO_STILLPICTURE VIDEO_STILLPICTURE
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp) .. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ 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
----------- -----------
This ioctl call asks the Video Device to display a still picture This ioctl call asks the Video Device to display a still picture
...@@ -52,7 +53,7 @@ This ioctl call asks the Video Device to display a still picture ...@@ -52,7 +53,7 @@ This ioctl call asks the Video Device to display a still picture
NULL, then the current displayed still picture is blanked. NULL, then the current displayed still picture is blanked.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_STOP VIDEO_STOP
========== ==========
NAME Name
---- ----
VIDEO_STOP VIDEO_STOP
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode) .. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -54,7 +55,7 @@ ARGUMENTS ...@@ -54,7 +55,7 @@ ARGUMENTS
- FALSE: Show last decoded frame. - FALSE: Show last decoded frame.
DESCRIPTION Description
----------- -----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the This ioctl is for DVB devices only. To control a V4L2 decoder use the
...@@ -65,7 +66,7 @@ stream. Depending on the input parameter, the screen can be blanked out ...@@ -65,7 +66,7 @@ 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
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
VIDEO_TRY_COMMAND VIDEO_TRY_COMMAND
================= =================
NAME Name
---- ----
VIDEO_TRY_COMMAND VIDEO_TRY_COMMAND
SYNOPSIS
Synopsis
-------- --------
.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd) .. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
ARGUMENTS Arguments
--------- ---------
.. flat-table:: .. flat-table::
...@@ -44,7 +45,7 @@ ARGUMENTS ...@@ -44,7 +45,7 @@ ARGUMENTS
- Try a decoder command. - Try a decoder command.
DESCRIPTION Description
----------- -----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
...@@ -57,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the ...@@ -57,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
for more information. for more information.
RETURN VALUE Return Value
------------ ------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
media close() media close()
************* *************
NAME Name
==== ====
media-close - Close a media device media-close - Close a media device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,21 +23,21 @@ SYNOPSIS ...@@ -22,21 +23,21 @@ SYNOPSIS
.. cpp:function:: int close( int fd ) .. cpp:function:: int close( int fd )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
DESCRIPTION Description
=========== ===========
Closes the media device. Resources associated with the file descriptor Closes the media device. Resources associated with the file descriptor
are freed. The device configuration remain unchanged. are freed. The device configuration remain unchanged.
RETURN VALUE Return Value
============ ============
:ref:`close() <func-close>` returns 0 on success. On error, -1 is returned, and :ref:`close() <func-close>` returns 0 on success. On error, -1 is returned, and
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
media ioctl() media ioctl()
************* *************
NAME Name
==== ====
media-ioctl - Control a media device media-ioctl - Control a media device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, void *argp ) .. cpp:function:: int ioctl( int fd, int request, void *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -36,7 +37,7 @@ ARGUMENTS ...@@ -36,7 +37,7 @@ ARGUMENTS
Pointer to a request-specific structure. Pointer to a request-specific structure.
DESCRIPTION Description
=========== ===========
The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters. The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters.
...@@ -52,7 +53,7 @@ requests, their respective function and parameters are specified in ...@@ -52,7 +53,7 @@ requests, their respective function and parameters are specified in
:ref:`media-user-func`. :ref:`media-user-func`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
media open() media open()
************ ************
NAME Name
==== ====
media-open - Open a media device media-open - Open a media device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags ) .. cpp:function:: int open( const char *device_name, int flags )
ARGUMENTS Arguments
========= =========
``device_name`` ``device_name``
...@@ -33,7 +34,7 @@ ARGUMENTS ...@@ -33,7 +34,7 @@ ARGUMENTS
Other flags have no effect. Other flags have no effect.
DESCRIPTION Description
=========== ===========
To open a media device applications call :ref:`open() <func-open>` with the To open a media device applications call :ref:`open() <func-open>` with the
...@@ -45,7 +46,7 @@ configuration will result in an error, and ``errno`` will be set to ...@@ -45,7 +46,7 @@ configuration will result in an error, and ``errno`` will be set to
EBADF. EBADF.
RETURN VALUE Return Value
============ ============
:ref:`open() <func-open>` returns the new file descriptor on success. On error, :ref:`open() <func-open>` returns the new file descriptor on success. On error,
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_DEVICE_INFO ioctl MEDIA_IOC_DEVICE_INFO
*************************** ***************************
NAME Name
==== ====
MEDIA_IOC_DEVICE_INFO - Query device information MEDIA_IOC_DEVICE_INFO - Query device information
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp ) .. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
All media devices must support the ``MEDIA_IOC_DEVICE_INFO`` ioctl. To All media devices must support the ``MEDIA_IOC_DEVICE_INFO`` ioctl. To
...@@ -133,7 +134,7 @@ used instead. The ``bus_info`` field is guaranteed to be unique, but can ...@@ -133,7 +134,7 @@ used instead. The ``bus_info`` field is guaranteed to be unique, but can
vary across reboots or device unplug/replug. vary across reboots or device unplug/replug.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_ENUM_ENTITIES ioctl MEDIA_IOC_ENUM_ENTITIES
***************************** *****************************
NAME Name
==== ====
MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp ) .. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of an entity, applications set the id field of a To query the attributes of an entity, applications set the id field of a
...@@ -183,7 +184,7 @@ id's until they get an error. ...@@ -183,7 +184,7 @@ id's until they get an error.
- -
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_ENUM_LINKS ioctl MEDIA_IOC_ENUM_LINKS
************************** **************************
NAME Name
==== ====
MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct media_links_enum *argp ) .. cpp:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To enumerate pads and/or links for a given entity, applications set the To enumerate pads and/or links for a given entity, applications set the
...@@ -159,7 +160,7 @@ returned during the enumeration process. ...@@ -159,7 +160,7 @@ returned during the enumeration process.
- Link flags, see :ref:`media-link-flag` for more details. - Link flags, see :ref:`media-link-flag` for more details.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_G_TOPOLOGY ioctl MEDIA_IOC_G_TOPOLOGY
************************** **************************
NAME Name
==== ====
MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct media_v2_topology *argp ) .. cpp:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The typical usage of this ioctl is to call it twice. On the first call, The typical usage of this ioctl is to call it twice. On the first call,
...@@ -410,7 +411,7 @@ desired arrays with the media graph elements. ...@@ -410,7 +411,7 @@ desired arrays with the media graph elements.
this array to zero. this array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_SETUP_LINK ioctl MEDIA_IOC_SETUP_LINK
************************** **************************
NAME Name
==== ====
MEDIA_IOC_SETUP_LINK - Modify the properties of a link MEDIA_IOC_SETUP_LINK - Modify the properties of a link
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp ) .. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To change link properties applications fill a struct To change link properties applications fill a struct
...@@ -54,7 +55,7 @@ If the specified link can't be found the driver returns with an ``EINVAL`` ...@@ -54,7 +55,7 @@ If the specified link can't be found the driver returns with an ``EINVAL``
error code. error code.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 close() V4L2 close()
************ ************
NAME Name
==== ====
v4l2-close - Close a V4L2 device v4l2-close - Close a V4L2 device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,14 +23,14 @@ SYNOPSIS ...@@ -22,14 +23,14 @@ SYNOPSIS
.. cpp:function:: int close( int fd ) .. cpp:function:: int close( int fd )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :ref:`open() <func-open>`. File descriptor returned by :ref:`open() <func-open>`.
DESCRIPTION Description
=========== ===========
Closes the device. Any I/O in progress is terminated and resources Closes the device. Any I/O in progress is terminated and resources
...@@ -38,7 +39,7 @@ parameters, current input or output, control values or other properties ...@@ -38,7 +39,7 @@ parameters, current input or output, control values or other properties
remain unchanged. remain unchanged.
RETURN VALUE Return Value
============ ============
The function returns 0 on success, -1 on failure and the ``errno`` is The function returns 0 on success, -1 on failure and the ``errno`` is
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 ioctl() V4L2 ioctl()
************ ************
NAME Name
==== ====
v4l2-ioctl - Program a V4L2 device v4l2-ioctl - Program a V4L2 device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, void *argp ) .. cpp:function:: int ioctl( int fd, int request, void *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -36,7 +37,7 @@ ARGUMENTS ...@@ -36,7 +37,7 @@ ARGUMENTS
Pointer to a function parameter, usually a structure. Pointer to a function parameter, usually a structure.
DESCRIPTION Description
=========== ===========
The :ref:`ioctl() <func-ioctl>` function is used to program V4L2 devices. The The :ref:`ioctl() <func-ioctl>` function is used to program V4L2 devices. The
...@@ -50,7 +51,7 @@ All V4L2 ioctl requests, their respective function and parameters are ...@@ -50,7 +51,7 @@ All V4L2 ioctl requests, their respective function and parameters are
specified in :ref:`user-func`. specified in :ref:`user-func`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 mmap() V4L2 mmap()
*********** ***********
NAME Name
==== ====
v4l2-mmap - Map device memory into application address space v4l2-mmap - Map device memory into application address space
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -23,7 +24,7 @@ SYNOPSIS ...@@ -23,7 +24,7 @@ SYNOPSIS
.. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset ) .. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
ARGUMENTS Arguments
========= =========
``start`` ``start``
...@@ -90,7 +91,7 @@ ARGUMENTS ...@@ -90,7 +91,7 @@ ARGUMENTS
``mem_offset`` field for the multi-planar API. ``mem_offset`` field for the multi-planar API.
DESCRIPTION Description
=========== ===========
The :ref:`mmap() <func-mmap>` function asks to map ``length`` bytes starting at The :ref:`mmap() <func-mmap>` function asks to map ``length`` bytes starting at
...@@ -106,7 +107,7 @@ before they can be queried. ...@@ -106,7 +107,7 @@ before they can be queried.
To unmap buffers the :ref:`munmap() <func-munmap>` function is used. To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
RETURN VALUE Return Value
============ ============
On success :ref:`mmap() <func-mmap>` returns a pointer to the mapped buffer. On On success :ref:`mmap() <func-mmap>` returns a pointer to the mapped buffer. On
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 munmap() V4L2 munmap()
************* *************
NAME Name
==== ====
v4l2-munmap - Unmap device memory v4l2-munmap - Unmap device memory
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -23,7 +24,7 @@ SYNOPSIS ...@@ -23,7 +24,7 @@ SYNOPSIS
.. cpp:function:: int munmap( void *start, size_t length ) .. cpp:function:: int munmap( void *start, size_t length )
ARGUMENTS Arguments
========= =========
``start`` ``start``
...@@ -39,14 +40,14 @@ ARGUMENTS ...@@ -39,14 +40,14 @@ ARGUMENTS
multi-planar API. multi-planar API.
DESCRIPTION Description
=========== ===========
Unmaps a previously with the :ref:`mmap() <func-mmap>` function mapped Unmaps a previously with the :ref:`mmap() <func-mmap>` function mapped
buffer and frees it, if possible. buffer and frees it, if possible.
RETURN VALUE Return Value
============ ============
On success :ref:`munmap() <func-munmap>` returns 0, on failure -1 and the On success :ref:`munmap() <func-munmap>` returns 0, on failure -1 and the
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 open() V4L2 open()
*********** ***********
NAME Name
==== ====
v4l2-open - Open a V4L2 device v4l2-open - Open a V4L2 device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags ) .. cpp:function:: int open( const char *device_name, int flags )
ARGUMENTS Arguments
========= =========
``device_name`` ``device_name``
...@@ -43,7 +44,7 @@ ARGUMENTS ...@@ -43,7 +44,7 @@ ARGUMENTS
Other flags have no effect. Other flags have no effect.
DESCRIPTION Description
=========== ===========
To open a V4L2 device applications call :ref:`open() <func-open>` with the To open a V4L2 device applications call :ref:`open() <func-open>` with the
...@@ -54,7 +55,7 @@ driver they will be reset to default values, drivers are never in an ...@@ -54,7 +55,7 @@ driver they will be reset to default values, drivers are never in an
undefined state. undefined state.
RETURN VALUE Return Value
============ ============
On success :ref:`open() <func-open>` returns the new file descriptor. On error On success :ref:`open() <func-open>` returns the new file descriptor. On error
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 poll() V4L2 poll()
*********** ***********
NAME Name
==== ====
v4l2-poll - Wait for some event on a file descriptor v4l2-poll - Wait for some event on a file descriptor
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,12 +23,12 @@ SYNOPSIS ...@@ -22,12 +23,12 @@ SYNOPSIS
.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout ) .. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
ARGUMENTS Arguments
========= =========
DESCRIPTION Description
=========== ===========
With the :ref:`poll() <func-poll>` function applications can suspend execution With the :ref:`poll() <func-poll>` function applications can suspend execution
...@@ -90,7 +91,7 @@ function. ...@@ -90,7 +91,7 @@ function.
For more details see the :ref:`poll() <func-poll>` manual page. For more details see the :ref:`poll() <func-poll>` manual page.
RETURN VALUE Return Value
============ ============
On success, :ref:`poll() <func-poll>` returns the number structures which have On success, :ref:`poll() <func-poll>` returns the number structures which have
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 read() V4L2 read()
*********** ***********
NAME Name
==== ====
v4l2-read - Read from a V4L2 device v4l2-read - Read from a V4L2 device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: ssize_t read( int fd, void *buf, size_t count ) .. cpp:function:: ssize_t read( int fd, void *buf, size_t count )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -32,7 +33,7 @@ ARGUMENTS ...@@ -32,7 +33,7 @@ ARGUMENTS
``count`` ``count``
DESCRIPTION Description
=========== ===========
:ref:`read() <func-read>` attempts to read up to ``count`` bytes from file :ref:`read() <func-read>` attempts to read up to ``count`` bytes from file
...@@ -92,7 +93,7 @@ however. The discarding policy is not reported and cannot be changed. ...@@ -92,7 +93,7 @@ however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`. For minimum requirements see :ref:`devices`.
RETURN VALUE Return Value
============ ============
On success, the number of bytes read is returned. It is not an error if On success, the number of bytes read is returned. It is not an error if
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 select() V4L2 select()
************* *************
NAME Name
==== ====
v4l2-select - Synchronous I/O multiplexing v4l2-select - Synchronous I/O multiplexing
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -24,12 +25,12 @@ SYNOPSIS ...@@ -24,12 +25,12 @@ SYNOPSIS
.. cpp:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout ) .. cpp:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout )
ARGUMENTS Arguments
========= =========
DESCRIPTION Description
=========== ===========
With the :ref:`select() <func-select>` function applications can suspend With the :ref:`select() <func-select>` function applications can suspend
...@@ -71,7 +72,7 @@ function. ...@@ -71,7 +72,7 @@ function.
For more details see the :ref:`select() <func-select>` manual page. For more details see the :ref:`select() <func-select>` manual page.
RETURN VALUE Return Value
============ ============
On success, :ref:`select() <func-select>` returns the number of descriptors On success, :ref:`select() <func-select>` returns the number of descriptors
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
V4L2 write() V4L2 write()
************ ************
NAME Name
==== ====
v4l2-write - Write to a V4L2 device v4l2-write - Write to a V4L2 device
SYNOPSIS
Synopsis
======== ========
.. code-block:: c .. code-block:: c
...@@ -22,7 +23,7 @@ SYNOPSIS ...@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: ssize_t write( int fd, void *buf, size_t count ) .. cpp:function:: ssize_t write( int fd, void *buf, size_t count )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -32,7 +33,7 @@ ARGUMENTS ...@@ -32,7 +33,7 @@ ARGUMENTS
``count`` ``count``
DESCRIPTION Description
=========== ===========
:ref:`write() <func-write>` writes up to ``count`` bytes to the device :ref:`write() <func-write>` writes up to ``count`` bytes to the device
...@@ -47,7 +48,7 @@ Sliced Teletext or Closed Caption data is not repeated, the driver ...@@ -47,7 +48,7 @@ Sliced Teletext or Closed Caption data is not repeated, the driver
inserts a blank line instead. inserts a blank line instead.
RETURN VALUE Return Value
============ ============
On success, the number of bytes written are returned. Zero indicates On success, the number of bytes written are returned. Zero indicates
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_CREATE_BUFS ioctl VIDIOC_CREATE_BUFS
************************ ************************
NAME Name
==== ====
VIDIOC_CREATE_BUFS - Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O VIDIOC_CREATE_BUFS - Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl is used to create buffers for :ref:`memory mapped <mmap>` This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
...@@ -130,7 +131,7 @@ than the number requested. ...@@ -130,7 +131,7 @@ than the number requested.
must set the array to zero. must set the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_CROPCAP ioctl VIDIOC_CROPCAP
******************** ********************
NAME Name
==== ====
VIDIOC_CROPCAP - Information about the video cropping and scaling abilities VIDIOC_CROPCAP - Information about the video cropping and scaling abilities
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Applications use this function to query the cropping limits, the pixel Applications use this function to query the cropping limits, the pixel
...@@ -154,7 +155,7 @@ overlay devices. ...@@ -154,7 +155,7 @@ overlay devices.
- Height of the rectangle, in pixels. - Height of the rectangle, in pixels.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_DBG_G_CHIP_INFO ioctl VIDIOC_DBG_G_CHIP_INFO
**************************** ****************************
NAME Name
==== ====
VIDIOC_DBG_G_CHIP_INFO - Identify the chips on a TV card VIDIOC_DBG_G_CHIP_INFO - Identify the chips on a TV card
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
**Note** **Note**
...@@ -192,7 +193,7 @@ instructions. ...@@ -192,7 +193,7 @@ instructions.
- Match the nth sub-device. - Match the nth sub-device.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER
************************************************** **************************************************
NAME Name
==== ====
VIDIOC_DBG_G_REGISTER - VIDIOC_DBG_S_REGISTER - Read or write hardware registers VIDIOC_DBG_G_REGISTER - VIDIOC_DBG_S_REGISTER - Read or write hardware registers
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
**Note** **Note**
...@@ -196,7 +197,7 @@ instructions. ...@@ -196,7 +197,7 @@ instructions.
- Match the nth sub-device. - Match the nth sub-device.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
************************************************ ************************************************
NAME Name
==== ====
VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls control an audio/video (usually MPEG-) decoder. These ioctls control an audio/video (usually MPEG-) decoder.
...@@ -255,7 +256,7 @@ introduced in Linux 3.3. ...@@ -255,7 +256,7 @@ introduced in Linux 3.3.
flags are defined for this command. flags are defined for this command.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_DQEVENT ioctl VIDIOC_DQEVENT
******************** ********************
NAME Name
==== ====
VIDIOC_DQEVENT - Dequeue event VIDIOC_DQEVENT - Dequeue event
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Dequeue an event from a video device. No input is required for this Dequeue an event from a video device. No input is required for this
...@@ -564,7 +565,7 @@ call. ...@@ -564,7 +565,7 @@ call.
decoder. decoder.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
********************************************************* *********************************************************
NAME Name
==== ====
VIDIOC_DV_TIMINGS_CAP - VIDIOC_SUBDEV_DV_TIMINGS_CAP - The capabilities of the Digital Video receiver/transmitter VIDIOC_DV_TIMINGS_CAP - VIDIOC_SUBDEV_DV_TIMINGS_CAP - The capabilities of the Digital Video receiver/transmitter
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the capabilities of the DV receiver/transmitter applications To query the capabilities of the DV receiver/transmitter applications
...@@ -241,7 +242,7 @@ that doesn't support them will return an ``EINVAL`` error code. ...@@ -241,7 +242,7 @@ that doesn't support them will return an ``EINVAL`` error code.
the standards set in the ``standards`` field. the standards set in the ``standards`` field.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
************************************************ ************************************************
NAME Name
==== ====
VIDIOC_ENCODER_CMD - VIDIOC_TRY_ENCODER_CMD - Execute an encoder command VIDIOC_ENCODER_CMD - VIDIOC_TRY_ENCODER_CMD - Execute an encoder command
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls control an audio/video (usually MPEG-) encoder. These ioctls control an audio/video (usually MPEG-) encoder.
...@@ -179,7 +180,7 @@ introduced in Linux 2.6.21. ...@@ -179,7 +180,7 @@ introduced in Linux 2.6.21.
rather than immediately. rather than immediately.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
*********************************************************** ***********************************************************
NAME Name
==== ====
VIDIOC_ENUM_DV_TIMINGS - VIDIOC_SUBDEV_ENUM_DV_TIMINGS - Enumerate supported Digital Video timings VIDIOC_ENUM_DV_TIMINGS - VIDIOC_SUBDEV_ENUM_DV_TIMINGS - Enumerate supported Digital Video timings
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
While some DV receivers or transmitters support a wide range of timings, While some DV receivers or transmitters support a wide range of timings,
...@@ -103,7 +104,7 @@ return an ``EINVAL`` error code. ...@@ -103,7 +104,7 @@ return an ``EINVAL`` error code.
- The timings. - The timings.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FMT ioctl VIDIOC_ENUM_FMT
********************* *********************
NAME Name
==== ====
VIDIOC_ENUM_FMT - Enumerate image formats VIDIOC_ENUM_FMT - Enumerate image formats
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To enumerate image formats applications initialize the ``type`` and To enumerate image formats applications initialize the ``type`` and
...@@ -151,7 +152,7 @@ formats may be different. ...@@ -151,7 +152,7 @@ formats may be different.
format instead for better performance. format instead for better performance.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FRAMEINTERVALS ioctl VIDIOC_ENUM_FRAMEINTERVALS
******************************** ********************************
NAME Name
==== ====
VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -32,7 +33,7 @@ ARGUMENTS ...@@ -32,7 +33,7 @@ ARGUMENTS
interval. interval.
DESCRIPTION Description
=========== ===========
This ioctl allows applications to enumerate all frame intervals that the This ioctl allows applications to enumerate all frame intervals that the
...@@ -265,7 +266,7 @@ Enums ...@@ -265,7 +266,7 @@ Enums
- Step-wise defined frame interval. - Step-wise defined frame interval.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FRAMESIZES ioctl VIDIOC_ENUM_FRAMESIZES
**************************** ****************************
NAME Name
==== ====
VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -32,7 +33,7 @@ ARGUMENTS ...@@ -32,7 +33,7 @@ ARGUMENTS
and height. and height.
DESCRIPTION Description
=========== ===========
This ioctl allows applications to enumerate all frame sizes (i. e. width This ioctl allows applications to enumerate all frame sizes (i. e. width
...@@ -282,7 +283,7 @@ Enums ...@@ -282,7 +283,7 @@ Enums
- Step-wise defined frame size. - Step-wise defined frame size.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FREQ_BANDS ioctl VIDIOC_ENUM_FREQ_BANDS
**************************** ****************************
NAME Name
==== ====
VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Enumerates the frequency bands that a tuner or modulator supports. To do Enumerates the frequency bands that a tuner or modulator supports. To do
...@@ -177,7 +178,7 @@ of the corresponding tuner/modulator is set. ...@@ -177,7 +178,7 @@ of the corresponding tuner/modulator is set.
- Amplitude Modulation, commonly used for analog radio. - Amplitude Modulation, commonly used for analog radio.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMAUDIO ioctl VIDIOC_ENUMAUDIO
********************** **********************
NAME Name
==== ====
VIDIOC_ENUMAUDIO - Enumerate audio inputs VIDIOC_ENUMAUDIO - Enumerate audio inputs
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of an audio input applications initialize the To query the attributes of an audio input applications initialize the
...@@ -44,7 +45,7 @@ See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct ...@@ -44,7 +45,7 @@ See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`. :ref:`v4l2_audio <v4l2-audio>`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMAUDOUT ioctl VIDIOC_ENUMAUDOUT
*********************** ***********************
NAME Name
==== ====
VIDIOC_ENUMAUDOUT - Enumerate audio outputs VIDIOC_ENUMAUDOUT - Enumerate audio outputs
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of an audio output applications initialize the To query the attributes of an audio output applications initialize the
...@@ -47,7 +48,7 @@ See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct ...@@ -47,7 +48,7 @@ See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`. :ref:`v4l2_audioout <v4l2-audioout>`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMINPUT ioctl VIDIOC_ENUMINPUT
********************** **********************
NAME Name
==== ====
VIDIOC_ENUMINPUT - Enumerate video inputs VIDIOC_ENUMINPUT - Enumerate video inputs
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of a video input applications initialize the To query the attributes of a video input applications initialize the
...@@ -354,7 +355,7 @@ at index zero, incrementing by one until the driver returns ``EINVAL``. ...@@ -354,7 +355,7 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:ref:`v4l2-selections-common`. :ref:`v4l2-selections-common`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMOUTPUT ioctl VIDIOC_ENUMOUTPUT
*********************** ***********************
NAME Name
==== ====
VIDIOC_ENUMOUTPUT - Enumerate video outputs VIDIOC_ENUMOUTPUT - Enumerate video outputs
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of a video outputs applications initialize the To query the attributes of a video outputs applications initialize the
...@@ -209,7 +210,7 @@ EINVAL. ...@@ -209,7 +210,7 @@ EINVAL.
:ref:`v4l2-selections-common`. :ref:`v4l2-selections-common`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMSTD ioctl VIDIOC_ENUMSTD
******************** ********************
NAME Name
==== ====
VIDIOC_ENUMSTD - Enumerate supported video standards VIDIOC_ENUMSTD - Enumerate supported video standards
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of a video standard, especially a custom (driver To query the attributes of a video standard, especially a custom (driver
...@@ -385,7 +386,7 @@ support digital TV. See also the Linux DVB API at ...@@ -385,7 +386,7 @@ support digital TV. See also the Linux DVB API at
- + 6.5 [8]_ - + 6.5 [8]_
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_EXPBUF ioctl VIDIOC_EXPBUF
******************* *******************
NAME Name
==== ====
VIDIOC_EXPBUF - Export a buffer as a DMABUF file descriptor. VIDIOC_EXPBUF - Export a buffer as a DMABUF file descriptor.
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
...@@ -184,7 +185,7 @@ Examples ...@@ -184,7 +185,7 @@ Examples
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
************************************ ************************************
NAME Name
==== ====
VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the current audio input applications zero out the ``reserved`` To query the current audio input applications zero out the ``reserved``
...@@ -149,7 +150,7 @@ return the actual new audio mode. ...@@ -149,7 +150,7 @@ return the actual new audio mode.
- AVL mode is on. - AVL mode is on.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
************************************** **************************************
NAME Name
==== ====
VIDIOC_G_AUDOUT - VIDIOC_S_AUDOUT - Query or select the current audio output VIDIOC_G_AUDOUT - VIDIOC_S_AUDOUT - Query or select the current audio output
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the current audio output applications zero out the ``reserved`` To query the current audio output applications zero out the ``reserved``
...@@ -108,7 +109,7 @@ sound card are not audio outputs in this sense. ...@@ -108,7 +109,7 @@ sound card are not audio outputs in this sense.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_CROP, VIDIOC_S_CROP ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
********************************** **********************************
NAME Name
==== ====
VIDIOC_G_CROP - VIDIOC_S_CROP - Get or set the current cropping rectangle VIDIOC_G_CROP - VIDIOC_S_CROP - Get or set the current cropping rectangle
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_crop *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_crop *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the cropping rectangle size and position applications set the To query the cropping rectangle size and position applications set the
...@@ -104,7 +105,7 @@ When cropping is not supported then no parameters are changed and ...@@ -104,7 +105,7 @@ When cropping is not supported then no parameters are changed and
:ref:`v4l2_cropcap <v4l2-cropcap>` ``bounds`` is used. :ref:`v4l2_cropcap <v4l2-cropcap>` ``bounds`` is used.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
********************************** **********************************
NAME Name
==== ====
VIDIOC_G_CTRL - VIDIOC_S_CTRL - Get or set the value of a control VIDIOC_G_CTRL - VIDIOC_S_CTRL - Get or set the value of a control
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_control *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_control *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To get the current value of a control applications initialize the ``id`` To get the current value of a control applications initialize the ``id``
...@@ -78,7 +79,7 @@ These ioctls work only with user controls. For other control classes the ...@@ -78,7 +79,7 @@ These ioctls work only with user controls. For other control classes the
- New value or current value. - New value or current value.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS
********************************************** **********************************************
NAME Name
==== ====
VIDIOC_G_DV_TIMINGS - VIDIOC_S_DV_TIMINGS - VIDIOC_SUBDEV_G_DV_TIMINGS - VIDIOC_SUBDEV_S_DV_TIMINGS - Get or set DV timings for input or output VIDIOC_G_DV_TIMINGS - VIDIOC_S_DV_TIMINGS - VIDIOC_SUBDEV_G_DV_TIMINGS - VIDIOC_SUBDEV_S_DV_TIMINGS - Get or set DV timings for input or output
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To set DV timings for the input or output, applications use the To set DV timings for the input or output, applications use the
...@@ -49,7 +50,7 @@ the current input or output does not support DV timings (e.g. if ...@@ -49,7 +50,7 @@ the current input or output does not support DV timings (e.g. if
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ``ENODATA`` error code is returned. ``V4L2_IN_CAP_DV_TIMINGS`` flag), then ``ENODATA`` error code is returned.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
****************************************************************************** ******************************************************************************
NAME Name
==== ====
VIDIOC_G_EDID - VIDIOC_S_EDID - VIDIOC_SUBDEV_G_EDID - VIDIOC_SUBDEV_S_EDID - Get or set the EDID of a video receiver/transmitter VIDIOC_G_EDID - VIDIOC_S_EDID - VIDIOC_SUBDEV_G_EDID - VIDIOC_SUBDEV_S_EDID - Get or set the EDID of a video receiver/transmitter
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls can be used to get or set an EDID associated with an input These ioctls can be used to get or set an EDID associated with an input
...@@ -143,7 +144,7 @@ EDID is no longer available. ...@@ -143,7 +144,7 @@ EDID is no longer available.
``blocks`` * 128. ``blocks`` * 128.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_ENC_INDEX ioctl VIDIOC_G_ENC_INDEX
************************ ************************
NAME Name
==== ====
VIDIOC_G_ENC_INDEX - Get meta data about a compressed video stream VIDIOC_G_ENC_INDEX - Get meta data about a compressed video stream
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` ioctl provides meta data about a compressed The :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` ioctl provides meta data about a compressed
...@@ -201,7 +202,7 @@ video elementary streams. ...@@ -201,7 +202,7 @@ video elementary streams.
type. type.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS
****************************************************************** ******************************************************************
NAME Name
==== ====
VIDIOC_G_EXT_CTRLS - VIDIOC_S_EXT_CTRLS - VIDIOC_TRY_EXT_CTRLS - Get or set the value of several controls, try control values VIDIOC_G_EXT_CTRLS - VIDIOC_S_EXT_CTRLS - VIDIOC_TRY_EXT_CTRLS - Get or set the value of several controls, try control values
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls allow the caller to get or set multiple controls These ioctls allow the caller to get or set multiple controls
...@@ -451,7 +452,7 @@ still cause this situation. ...@@ -451,7 +452,7 @@ still cause this situation.
described in :ref:`rf-tuner-controls`. described in :ref:`rf-tuner-controls`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF
********************************** **********************************
NAME Name
==== ====
VIDIOC_G_FBUF - VIDIOC_S_FBUF - Get or set frame buffer overlay parameters VIDIOC_G_FBUF - VIDIOC_S_FBUF - Get or set frame buffer overlay parameters
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Applications can use the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl Applications can use the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
...@@ -477,7 +478,7 @@ destructive video overlay. ...@@ -477,7 +478,7 @@ destructive video overlay.
:ref:`v4l2_window <v4l2-window>` is being used. :ref:`v4l2_window <v4l2-window>` is being used.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
************************************************ ************************************************
NAME Name
==== ====
VIDIOC_G_FMT - VIDIOC_S_FMT - VIDIOC_TRY_FMT - Get or set the data format, try a format VIDIOC_G_FMT - VIDIOC_S_FMT - VIDIOC_TRY_FMT - Get or set the data format, try a format
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls are used to negotiate the format of data (typically image These ioctls are used to negotiate the format of data (typically image
...@@ -175,7 +176,7 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical ...@@ -175,7 +176,7 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
- Place holder for future extensions. - Place holder for future extensions.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
******************************************** ********************************************
NAME Name
==== ====
VIDIOC_G_FREQUENCY - VIDIOC_S_FREQUENCY - Get or set tuner or modulator radio frequency VIDIOC_G_FREQUENCY - VIDIOC_S_FREQUENCY - Get or set tuner or modulator radio frequency
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To get the current tuner or modulator radio frequency applications set To get the current tuner or modulator radio frequency applications set
...@@ -107,7 +108,7 @@ write-only ioctl, it does not return the actual new frequency. ...@@ -107,7 +108,7 @@ write-only ioctl, it does not return the actual new frequency.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT
************************************ ************************************
NAME Name
==== ====
VIDIOC_G_INPUT - VIDIOC_S_INPUT - Query or select the current video input VIDIOC_G_INPUT - VIDIOC_S_INPUT - Query or select the current video input
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, int *argp ) .. cpp:function:: int ioctl( int fd, int request, int *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the current video input applications call the To query the current video input applications call the
...@@ -50,7 +51,7 @@ Information about video inputs is available using the ...@@ -50,7 +51,7 @@ Information about video inputs is available using the
:ref:`VIDIOC_ENUMINPUT` ioctl. :ref:`VIDIOC_ENUMINPUT` ioctl.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
****************************************** ******************************************
NAME Name
==== ====
VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp ) .. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp ) .. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls are **deprecated**. New drivers and applications should use These ioctls are **deprecated**. New drivers and applications should use
...@@ -175,7 +176,7 @@ encoding. You usually do want to add them. ...@@ -175,7 +176,7 @@ encoding. You usually do want to add them.
- App segment, driver will always use APP0 - App segment, driver will always use APP0
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR
******************************************** ********************************************
NAME Name
==== ====
VIDIOC_G_MODULATOR - VIDIOC_S_MODULATOR - Get or set modulator attributes VIDIOC_G_MODULATOR - VIDIOC_S_MODULATOR - Get or set modulator attributes
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of a modulator applications initialize the To query the attributes of a modulator applications initialize the
...@@ -242,7 +243,7 @@ To change the radio frequency the ...@@ -242,7 +243,7 @@ To change the radio frequency the
- Enable the RDS encoder for a radio FM transmitter. - Enable the RDS encoder for a radio FM transmitter.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
************************************** **************************************
NAME Name
==== ====
VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, int *argp ) .. cpp:function:: int ioctl( int fd, int request, int *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the current video output applications call the To query the current video output applications call the
...@@ -51,7 +52,7 @@ Information about video outputs is available using the ...@@ -51,7 +52,7 @@ Information about video outputs is available using the
:ref:`VIDIOC_ENUMOUTPUT` ioctl. :ref:`VIDIOC_ENUMOUTPUT` ioctl.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_PARM, VIDIOC_S_PARM ioctl VIDIOC_G_PARM, VIDIOC_S_PARM
********************************** **********************************
NAME Name
==== ====
VIDIOC_G_PARM - VIDIOC_S_PARM - Get or set streaming parameters VIDIOC_G_PARM - VIDIOC_S_PARM - Get or set streaming parameters
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp ) .. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The current video standard determines a nominal number of frames per The current video standard determines a nominal number of frames per
...@@ -340,7 +341,7 @@ union holding separate parameters for input and output devices. ...@@ -340,7 +341,7 @@ union holding separate parameters for input and output devices.
- Capture might only work through the :ref:`read() <func-read>` call. - Capture might only work through the :ref:`read() <func-read>` call.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY
****************************************** ******************************************
NAME Name
==== ====
VIDIOC_G_PRIORITY - VIDIOC_S_PRIORITY - Query or request the access priority associated with a file descriptor VIDIOC_G_PRIORITY - VIDIOC_S_PRIORITY - Query or request the access priority associated with a file descriptor
SYNOPSIS
Synopsis
======== ========
.. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp ) .. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp ) .. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -32,7 +33,7 @@ ARGUMENTS ...@@ -32,7 +33,7 @@ ARGUMENTS
Pointer to an enum v4l2_priority type. Pointer to an enum v4l2_priority type.
DESCRIPTION Description
=========== ===========
To query the current access priority applications call the To query the current access priority applications call the
...@@ -102,7 +103,7 @@ with a pointer to this variable. ...@@ -102,7 +103,7 @@ with a pointer to this variable.
applications which must not be interrupted, like video recording. applications which must not be interrupted, like video recording.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
******************************************** ********************************************
NAME Name
==== ====
VIDIOC_G_SELECTION - VIDIOC_S_SELECTION - Get or set one of the selection rectangles VIDIOC_G_SELECTION - VIDIOC_S_SELECTION - Get or set one of the selection rectangles
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_selection *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_selection *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The ioctls are used to query and configure selection rectangles. The ioctls are used to query and configure selection rectangles.
...@@ -187,7 +188,7 @@ Selection targets and flags are documented in ...@@ -187,7 +188,7 @@ Selection targets and flags are documented in
this array. this array.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_G_SLICED_VBI_CAP ioctl VIDIOC_G_SLICED_VBI_CAP
***************************** *****************************
NAME Name
==== ====
VIDIOC_G_SLICED_VBI_CAP - Query sliced VBI capabilities VIDIOC_G_SLICED_VBI_CAP - Query sliced VBI capabilities
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To find out which data services are supported by a sliced VBI capture or To find out which data services are supported by a sliced VBI capture or
...@@ -264,7 +265,7 @@ to write-read, in Linux 2.6.19. ...@@ -264,7 +265,7 @@ to write-read, in Linux 2.6.19.
- :cspan:`2` Set of services applicable to 625 line systems. - :cspan:`2` Set of services applicable to 625 line systems.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_STD, VIDIOC_S_STD ioctl VIDIOC_G_STD, VIDIOC_S_STD
******************************** ********************************
NAME Name
==== ====
VIDIOC_G_STD - VIDIOC_S_STD - Query or select the video standard of the current input VIDIOC_G_STD - VIDIOC_S_STD - Query or select the video standard of the current input
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp ) .. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp ) .. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query and select the current video standard applications use the To query and select the current video standard applications use the
...@@ -53,7 +54,7 @@ does not set the ``V4L2_IN_CAP_STD`` flag), then ``ENODATA`` error code is ...@@ -53,7 +54,7 @@ does not set the ``V4L2_IN_CAP_STD`` flag), then ``ENODATA`` error code is
returned. returned.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER
************************************ ************************************
NAME Name
==== ====
VIDIOC_G_TUNER - VIDIOC_S_TUNER - Get or set tuner attributes VIDIOC_G_TUNER - VIDIOC_S_TUNER - Get or set tuner attributes
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of a tuner applications initialize the ``index`` To query the attributes of a tuner applications initialize the ``index``
...@@ -692,7 +693,7 @@ To change the radio frequency the ...@@ -692,7 +693,7 @@ To change the radio frequency the
- Lang1/Lang2 (preferred) or Lang1/Lang1 - Lang1/Lang2 (preferred) or Lang1/Lang1
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,23 +6,24 @@ ...@@ -6,23 +6,24 @@
ioctl VIDIOC_LOG_STATUS ioctl VIDIOC_LOG_STATUS
*********************** ***********************
NAME Name
==== ====
VIDIOC_LOG_STATUS - Log driver status information VIDIOC_LOG_STATUS - Log driver status information
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request ) .. cpp:function:: int ioctl( int fd, int request )
ARGUMENTS Arguments
========= =========
DESCRIPTION Description
=========== ===========
As the video/audio devices become more complicated it becomes harder to As the video/audio devices become more complicated it becomes harder to
...@@ -37,7 +38,7 @@ This ioctl is optional and not all drivers support it. It was introduced ...@@ -37,7 +38,7 @@ This ioctl is optional and not all drivers support it. It was introduced
in Linux 2.6.15. in Linux 2.6.15.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_OVERLAY ioctl VIDIOC_OVERLAY
******************** ********************
NAME Name
==== ====
VIDIOC_OVERLAY - Start or stop video overlay VIDIOC_OVERLAY - Start or stop video overlay
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, const int *argp ) .. cpp:function:: int ioctl( int fd, int request, const int *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl is part of the :ref:`video overlay <overlay>` I/O method. This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
...@@ -42,7 +43,7 @@ Drivers do not support :ref:`VIDIOC_STREAMON` or ...@@ -42,7 +43,7 @@ Drivers do not support :ref:`VIDIOC_STREAMON` or
``V4L2_BUF_TYPE_VIDEO_OVERLAY``. ``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_PREPARE_BUF ioctl VIDIOC_PREPARE_BUF
************************ ************************
NAME Name
==== ====
VIDIOC_PREPARE_BUF - Prepare a buffer for I/O VIDIOC_PREPARE_BUF - Prepare a buffer for I/O
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to
...@@ -45,7 +46,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in ...@@ -45,7 +46,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`. :ref:`buffer`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_QBUF, VIDIOC_DQBUF ioctl VIDIOC_QBUF, VIDIOC_DQBUF
******************************* *******************************
NAME Name
==== ====
VIDIOC_QBUF - VIDIOC_DQBUF - Exchange a buffer with the driver VIDIOC_QBUF - VIDIOC_DQBUF - Exchange a buffer with the driver
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Applications call the ``VIDIOC_QBUF`` ioctl to enqueue an empty Applications call the ``VIDIOC_QBUF`` ioctl to enqueue an empty
...@@ -116,7 +117,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in ...@@ -116,7 +117,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`. :ref:`buffer`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERY_DV_TIMINGS ioctl VIDIOC_QUERY_DV_TIMINGS
***************************** *****************************
NAME Name
==== ====
VIDIOC_QUERY_DV_TIMINGS - VIDIOC_SUBDEV_QUERY_DV_TIMINGS - Sense the DV preset received by the current input VIDIOC_QUERY_DV_TIMINGS - VIDIOC_SUBDEV_QUERY_DV_TIMINGS - Sense the DV preset received by the current input
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The hardware may be able to detect the current DV timings automatically, The hardware may be able to detect the current DV timings automatically,
...@@ -61,7 +62,7 @@ found timings with the hardware's capabilities in order to give more ...@@ -61,7 +62,7 @@ found timings with the hardware's capabilities in order to give more
precise feedback to the user. precise feedback to the user.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERYBUF ioctl VIDIOC_QUERYBUF
********************* *********************
NAME Name
==== ====
VIDIOC_QUERYBUF - Query the status of a buffer VIDIOC_QUERYBUF - Query the status of a buffer
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
...@@ -68,7 +69,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in ...@@ -68,7 +69,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`. :ref:`buffer`.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERYCAP ioctl VIDIOC_QUERYCAP
********************* *********************
NAME Name
==== ====
VIDIOC_QUERYCAP - Query device capabilities VIDIOC_QUERYCAP - Query device capabilities
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
All V4L2 devices support the ``VIDIOC_QUERYCAP`` ioctl. It is used to All V4L2 devices support the ``VIDIOC_QUERYCAP`` ioctl. It is used to
...@@ -420,7 +421,7 @@ specification the ioctl returns an ``EINVAL`` error code. ...@@ -420,7 +421,7 @@ specification the ioctl returns an ``EINVAL`` error code.
``device_caps`` field. ``device_caps`` field.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctls VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU ioctls VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU
******************************************************************* *******************************************************************
NAME Name
==== ====
VIDIOC_QUERYCTRL - VIDIOC_QUERY_EXT_CTRL - VIDIOC_QUERYMENU - Enumerate controls and menu control items VIDIOC_QUERYCTRL - VIDIOC_QUERY_EXT_CTRL - VIDIOC_QUERYMENU - Enumerate controls and menu control items
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp )
...@@ -21,7 +22,7 @@ SYNOPSIS ...@@ -21,7 +22,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -33,7 +34,7 @@ ARGUMENTS ...@@ -33,7 +34,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To query the attributes of a control applications set the ``id`` field To query the attributes of a control applications set the ``id`` field
...@@ -753,7 +754,7 @@ See also the examples in :ref:`control`. ...@@ -753,7 +754,7 @@ See also the examples in :ref:`control`.
``V4L2_CTRL_TYPE_BUTTON`` have this flag set. ``V4L2_CTRL_TYPE_BUTTON`` have this flag set.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERYSTD ioctl VIDIOC_QUERYSTD
********************* *********************
NAME Name
==== ====
VIDIOC_QUERYSTD - Sense the video standard received by the current input VIDIOC_QUERYSTD - Sense the video standard received by the current input
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp ) .. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The hardware may be able to detect the current video standard The hardware may be able to detect the current video standard
...@@ -54,7 +55,7 @@ standard is valid they will have to stop streaming, set the new ...@@ -54,7 +55,7 @@ standard is valid they will have to stop streaming, set the new
standard, allocate new buffers and start streaming again. standard, allocate new buffers and start streaming again.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_REQBUFS ioctl VIDIOC_REQBUFS
******************** ********************
NAME Name
==== ====
VIDIOC_REQBUFS - Initiate Memory Mapping or User Pointer I/O VIDIOC_REQBUFS - Initiate Memory Mapping or User Pointer I/O
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl is used to initiate :ref:`memory mapped <mmap>`, This ioctl is used to initiate :ref:`memory mapped <mmap>`,
...@@ -112,7 +113,7 @@ any DMA in progress, an implicit ...@@ -112,7 +113,7 @@ any DMA in progress, an implicit
must set the array to zero. must set the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_S_HW_FREQ_SEEK ioctl VIDIOC_S_HW_FREQ_SEEK
*************************** ***************************
NAME Name
==== ====
VIDIOC_S_HW_FREQ_SEEK - Perform a hardware frequency seek VIDIOC_S_HW_FREQ_SEEK - Perform a hardware frequency seek
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Start a hardware frequency seek from the current frequency. To do this Start a hardware frequency seek from the current frequency. To do this
...@@ -155,7 +156,7 @@ error code is returned and no seek takes place. ...@@ -155,7 +156,7 @@ error code is returned and no seek takes place.
zero. zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF
*************************************** ***************************************
NAME Name
==== ====
VIDIOC_STREAMON - VIDIOC_STREAMOFF - Start or stop streaming I/O VIDIOC_STREAMON - VIDIOC_STREAMOFF - Start or stop streaming I/O
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, const int *argp ) .. cpp:function:: int ioctl( int fd, int request, const int *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The ``VIDIOC_STREAMON`` and ``VIDIOC_STREAMOFF`` ioctl start and stop The ``VIDIOC_STREAMON`` and ``VIDIOC_STREAMOFF`` ioctl start and stop
...@@ -81,7 +82,7 @@ no notion of starting or stopping "now". Buffer timestamps can be used ...@@ -81,7 +82,7 @@ no notion of starting or stopping "now". Buffer timestamps can be used
to synchronize with other events. to synchronize with other events.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL
*************************************** ***************************************
NAME Name
==== ====
VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL - Enumerate frame intervals VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL - Enumerate frame intervals
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl lets applications enumerate available frame intervals on a This ioctl lets applications enumerate available frame intervals on a
...@@ -137,7 +138,7 @@ multiple pads of the same sub-device is not defined. ...@@ -137,7 +138,7 @@ multiple pads of the same sub-device is not defined.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE
*********************************** ***********************************
NAME Name
==== ====
VIDIOC_SUBDEV_ENUM_FRAME_SIZE - Enumerate media bus frame sizes VIDIOC_SUBDEV_ENUM_FRAME_SIZE - Enumerate media bus frame sizes
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
This ioctl allows applications to enumerate all frame sizes supported by This ioctl allows applications to enumerate all frame sizes supported by
...@@ -147,7 +148,7 @@ information about try formats. ...@@ -147,7 +148,7 @@ information about try formats.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
********************************** **********************************
NAME Name
==== ====
VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
To enumerate media bus formats available at a given sub-device pad To enumerate media bus formats available at a given sub-device pad
...@@ -100,7 +101,7 @@ information about the try formats. ...@@ -100,7 +101,7 @@ information about the try formats.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,12 +6,13 @@ ...@@ -6,12 +6,13 @@
ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
************************************************ ************************************************
NAME Name
==== ====
VIDIOC_SUBDEV_G_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle on a subdev pad VIDIOC_SUBDEV_G_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle on a subdev pad
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp )
...@@ -19,7 +20,7 @@ SYNOPSIS ...@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp ) .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -31,7 +32,7 @@ ARGUMENTS ...@@ -31,7 +32,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
**Note** **Note**
...@@ -114,7 +115,7 @@ modified format should be as close as possible to the original request. ...@@ -114,7 +115,7 @@ modified format should be as close as possible to the original request.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT
********************************************** **********************************************
NAME Name
==== ====
VIDIOC_SUBDEV_G_FMT - VIDIOC_SUBDEV_S_FMT - Get or set the data format on a subdev pad VIDIOC_SUBDEV_G_FMT - VIDIOC_SUBDEV_S_FMT - Get or set the data format on a subdev pad
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls are used to negotiate the frame format at specific subdev These ioctls are used to negotiate the frame format at specific subdev
...@@ -144,7 +145,7 @@ should be as close as possible to the original request. ...@@ -144,7 +145,7 @@ should be as close as possible to the original request.
- Active formats, applied to the hardware. - Active formats, applied to the hardware.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL
******************************************************************** ********************************************************************
NAME Name
==== ====
VIDIOC_SUBDEV_G_FRAME_INTERVAL - VIDIOC_SUBDEV_S_FRAME_INTERVAL - Get or set the frame interval on a subdev pad VIDIOC_SUBDEV_G_FRAME_INTERVAL - VIDIOC_SUBDEV_S_FRAME_INTERVAL - Get or set the frame interval on a subdev pad
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -30,7 +31,7 @@ ARGUMENTS ...@@ -30,7 +31,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
These ioctls are used to get and set the frame interval at specific These ioctls are used to get and set the frame interval at specific
...@@ -100,7 +101,7 @@ the same sub-device is not defined. ...@@ -100,7 +101,7 @@ the same sub-device is not defined.
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
********************************************************** **********************************************************
NAME Name
==== ====
VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
The selections are used to configure various image processing The selections are used to configure various image processing
...@@ -122,7 +123,7 @@ Selection targets and flags are documented in ...@@ -122,7 +123,7 @@ Selection targets and flags are documented in
the array to zero. the array to zero.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
...@@ -6,18 +6,19 @@ ...@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
****************************************************** ******************************************************
NAME Name
==== ====
VIDIOC_SUBSCRIBE_EVENT - VIDIOC_UNSUBSCRIBE_EVENT - Subscribe or unsubscribe event VIDIOC_SUBSCRIBE_EVENT - VIDIOC_UNSUBSCRIBE_EVENT - Subscribe or unsubscribe event
SYNOPSIS
Synopsis
======== ========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp ) .. cpp:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp )
ARGUMENTS Arguments
========= =========
``fd`` ``fd``
...@@ -29,7 +30,7 @@ ARGUMENTS ...@@ -29,7 +30,7 @@ ARGUMENTS
``argp`` ``argp``
DESCRIPTION Description
=========== ===========
Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
...@@ -126,7 +127,7 @@ using the :ref:`VIDIOC_DQEVENT` ioctl. ...@@ -126,7 +127,7 @@ using the :ref:`VIDIOC_DQEVENT` ioctl.
situations like that. situations like that.
RETURN VALUE Return Value
============ ============
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
......
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