Skip to content

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

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
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 1107 additions and 913 deletions
Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_BILINGUAL_CHANNEL_SELECT
==============================
NAME
Name
----
AUDIO_BILINGUAL_CHANNEL_SELECT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -55,7 +56,7 @@ This ioctl call asks the Audio Device to select the requested channel
for bilingual streams if possible.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-channel-select.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_CHANNEL_SELECT
====================
NAME
Name
----
AUDIO_CHANNEL_SELECT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -54,7 +55,7 @@ This ioctl call asks the Audio Device to select the requested channel if
possible.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_CLEAR_BUFFER
==================
NAME
Name
----
AUDIO_CLEAR_BUFFER
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_CLEAR_BUFFER for this command.
DESCRIPTION
Description
-----------
This ioctl call asks the Audio Device to clear all software and hardware
buffers of the audio decoder device.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-continue.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_CONTINUE
==============
NAME
Name
----
AUDIO_CONTINUE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_CONTINUE for this command.
DESCRIPTION
Description
-----------
This ioctl restarts the decoding and playing process previously paused
with AUDIO_PAUSE command.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-fclose.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB audio close()
=================
NAME
Name
----
DVB audio close()
SYNOPSIS
Synopsis
--------
.. c:function:: int close(int fd)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -32,13 +33,13 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
DESCRIPTION
Description
-----------
This system call closes a previously opened audio device.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/audio-fopen.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB audio open()
================
NAME
Name
----
DVB audio open()
SYNOPSIS
Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default)
DESCRIPTION
Description
-----------
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
AUDIO_GET_STATUS. All other call will return with an error code.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/audio-fwrite.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB audio write()
=================
NAME
Name
----
DVB audio write()
SYNOPSIS
Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
DESCRIPTION
Description
-----------
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
implied by count.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_GET_CAPABILITIES
======================
NAME
Name
----
AUDIO_GET_CAPABILITIES
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- Returns a bit array of supported sound formats.
DESCRIPTION
Description
-----------
This ioctl call asks the Audio Device to tell us about the decoding
capabilities of the audio hardware.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-get-pts.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_GET_PTS
=============
NAME
Name
----
AUDIO_GET_PTS
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -49,7 +50,7 @@ ARGUMENTS
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
......@@ -60,7 +61,7 @@ This ioctl call asks the Audio Device to return the current PTS
timestamp.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-get-status.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_GET_STATUS
================
NAME
Name
----
AUDIO_GET_STATUS
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- Returns the current state of Audio Device.
DESCRIPTION
Description
-----------
This ioctl call asks the Audio Device to return the current state of the
Audio Device.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-pause.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_PAUSE
===========
NAME
Name
----
AUDIO_PAUSE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,7 +39,7 @@ ARGUMENTS
- Equals AUDIO_PAUSE for this command.
DESCRIPTION
Description
-----------
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
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
......
Documentation/linux_tv/media/dvb/audio-play.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_PLAY
==========
NAME
Name
----
AUDIO_PLAY
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_PLAY for this command.
DESCRIPTION
Description
-----------
This ioctl call asks the Audio Device to start playing an audio stream
from the selected source.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-select-source.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SELECT_SOURCE
===================
NAME
Name
----
AUDIO_SELECT_SOURCE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -53,7 +54,7 @@ AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
through the write command.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-set-attributes.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_ATTRIBUTES
====================
NAME
Name
----
AUDIO_SET_ATTRIBUTES
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- audio attributes according to section ??
DESCRIPTION
Description
-----------
This ioctl is intended for DVD playback and allows you to set certain
information about the audio stream.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_AV_SYNC
=================
NAME
Name
----
AUDIO_SET_AV_SYNC
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -54,14 +55,14 @@ ARGUMENTS
- FALSE AV-sync OFF
DESCRIPTION
Description
-----------
This ioctl call asks the Audio Device to turn ON or OFF A/V
synchronization.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_BYPASS_MODE
=====================
NAME
Name
----
AUDIO_SET_BYPASS_MODE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -55,7 +56,7 @@ ARGUMENTS
- FALSE Bypass is enabled
DESCRIPTION
Description
-----------
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
the hardware can handle it.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_EXT_ID
================
NAME
Name
----
AUDIO_SET_EXT_ID
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- audio sub_stream_id
DESCRIPTION
Description
-----------
This ioctl can be used to set the extension id for MPEG streams in DVD
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
......
Documentation/linux_tv/media/dvb/audio-set-id.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_ID
============
NAME
Name
----
AUDIO_SET_ID
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- audio sub-stream id
DESCRIPTION
Description
-----------
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
recognized.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_KARAOKE
=================
NAME
Name
----
AUDIO_SET_KARAOKE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- karaoke settings according to section ??.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/audio-set-mixer.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_MIXER
===============
NAME
Name
----
AUDIO_SET_MIXER
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- mixer settings.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/audio-set-mute.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_MUTE
==============
NAME
Name
----
AUDIO_SET_MUTE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -54,7 +55,7 @@ ARGUMENTS
- FALSE Audio Un-mute
DESCRIPTION
Description
-----------
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
currently being played.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_SET_STREAMTYPE
====================
NAME
Name
----
AUDIO_SET_STREAMTYPE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- stream type
DESCRIPTION
Description
-----------
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
AC3.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/audio-stop.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
AUDIO_STOP
==========
NAME
Name
----
AUDIO_STOP
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_STOP for this command.
DESCRIPTION
Description
-----------
This ioctl call asks the Audio Device to stop playing the current
stream.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/ca-fclose.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB CA close()
==============
NAME
Name
----
DVB CA close()
SYNOPSIS
Synopsis
--------
.. cpp:function:: int close(int fd)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -32,13 +33,13 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
DESCRIPTION
Description
-----------
This system call closes a previously opened audio device.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/ca-fopen.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB CA open()
=============
NAME
Name
----
DVB CA open()
SYNOPSIS
Synopsis
--------
.. cpp:function:: int open(const char *deviceName, int flags)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default)
DESCRIPTION
Description
-----------
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
the device in this mode will fail, and an error code will be returned.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/ca-get-cap.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_GET_CAP
==========
NAME
Name
----
CA_GET_CAP
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_GET_DESCR_INFO
=================
NAME
Name
----
CA_GET_DESCR_INFO
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-get-msg.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_GET_MSG
==========
NAME
Name
----
CA_GET_MSG
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_GET_SLOT_INFO
================
NAME
Name
----
CA_GET_SLOT_INFO
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-reset.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_RESET
========
NAME
Name
----
CA_RESET
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_RESET)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,13 +39,13 @@ ARGUMENTS
- Equals CA_RESET for this command.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-send-msg.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_SEND_MSG
===========
NAME
Name
----
CA_SEND_MSG
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-set-descr.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_SET_DESCR
============
NAME
Name
----
CA_SET_DESCR
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/ca-set-pid.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
CA_SET_PID
==========
NAME
Name
----
CA_SET_PID
SYNOPSIS
Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/dmx-add-pid.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_ADD_PID
===========
NAME
Name
----
DMX_ADD_PID
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- PID number to be filtered.
DESCRIPTION
Description
-----------
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
DMX_OUT_TSDEMUX_TAP.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/dmx-fclose.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB demux close()
=================
NAME
Name
----
DVB demux close()
SYNOPSIS
Synopsis
--------
.. c:function:: int close(int fd)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -32,14 +33,14 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
DESCRIPTION
Description
-----------
This system call deactivates and deallocates a filter that was
previously allocated via the open() call.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/dmx-fopen.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB demux open()
================
NAME
Name
----
DVB demux open()
SYNOPSIS
Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -53,7 +54,7 @@ ARGUMENTS
- (blocking mode is the default)
DESCRIPTION
Description
-----------
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)
using the F_SETFL command of the fcntl system call.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/dmx-fread.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB demux read()
================
NAME
Name
----
DVB demux read()
SYNOPSIS
Synopsis
--------
.. c:function:: size_t read(int fd, void *buf, size_t count)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
DESCRIPTION
Description
-----------
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
implied by count.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/dmx-fwrite.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DVB demux write()
=================
NAME
Name
----
DVB demux write()
SYNOPSIS
Synopsis
--------
.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
DESCRIPTION
Description
-----------
This system call is only provided by the logical device
......@@ -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.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/dmx-get-caps.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_GET_CAPS
============
NAME
Name
----
DMX_GET_CAPS
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/dmx-get-event.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_GET_EVENT
=============
NAME
Name
----
DMX_GET_EVENT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -54,7 +55,7 @@ errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
event becomes available.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_GET_PES_PIDS
================
NAME
Name
----
DMX_GET_PES_PIDS
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/dmx-get-stc.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_GET_STC
===========
NAME
Name
----
DMX_GET_STC
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -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 .
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_REMOVE_PID
==============
NAME
Name
----
DMX_REMOVE_PID
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -53,7 +54,7 @@ equal to DMX_OUT_TSDEMUX_TAP, created via either
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
......
Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_SET_BUFFER_SIZE
===================
NAME
Name
----
DMX_SET_BUFFER_SIZE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Size of circular buffer.
DESCRIPTION
Description
-----------
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
used.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/dmx-set-filter.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_SET_FILTER
==============
NAME
Name
----
DMX_SET_FILTER
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to structure containing filter parameters.
DESCRIPTION
Description
-----------
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
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
......
Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_SET_PES_FILTER
==================
NAME
Name
----
DMX_SET_PES_FILTER
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to structure containing filter parameters.
DESCRIPTION
Description
-----------
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
capability is supported.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/dmx-set-source.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_SET_SOURCE
==============
NAME
Name
----
DMX_SET_SOURCE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/dmx-start.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_START
=========
NAME
Name
----
DMX_START
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_START)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,14 +39,14 @@ ARGUMENTS
- Equals DMX_START for this command.
DESCRIPTION
Description
-----------
This ioctl call is used to start the actual filtering operation defined
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
......
Documentation/linux_tv/media/dvb/dmx-stop.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
DMX_STOP
========
NAME
Name
----
DMX_STOP
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_STOP)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,7 +39,7 @@ ARGUMENTS
- Equals DMX_STOP for this command.
DESCRIPTION
Description
-----------
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
started via the DMX_START command.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl FE_DISEQC_RECV_SLAVE_REPLY
********************************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
DESCRIPTION
Description
===========
Receives reply from a DiSEqC 2.0 command.
......@@ -73,7 +74,8 @@ struct dvb_diseqc_slave_reply
- Return from ioctl after timeout ms with errorcode when no message
was received
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
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.
SYNOPSIS
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, NULL )
ARGUMENTS
Arguments
=========
``fd``
......@@ -27,7 +28,7 @@ ARGUMENTS
FE_DISEQC_RESET_OVERLOAD
DESCRIPTION
Description
===========
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
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
......
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl FE_DISEQC_SEND_BURST
**************************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -30,7 +31,7 @@ ARGUMENTS
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
......@@ -74,7 +75,8 @@ enum fe_sec_mini_cmd
- 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
......
Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl FE_DISEQC_SEND_MASTER_CMD
*******************************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -31,13 +32,13 @@ ARGUMENTS
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
DESCRIPTION
Description
===========
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
......
Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_DISHNETWORK_SEND_LEGACY_CMD
******************************
NAME
Name
====
FE_DISHNETWORK_SEND_LEGACY_CMD
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -32,7 +33,7 @@ ARGUMENTS
- sends the specified raw cmd to the dish via DISEqC.
DESCRIPTION
Description
===========
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
dishes were already legacy in 2004.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
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.
SYNOPSIS
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int high )
ARGUMENTS
Arguments
=========
``fd``
......@@ -35,7 +36,7 @@ ARGUMENTS
to compensate for long antenna cables.
DESCRIPTION
Description
===========
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
voltages.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-get-event.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_GET_EVENT
************
NAME
Name
====
FE_GET_EVENT
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -49,7 +50,7 @@ ARGUMENTS
- if any, is to be stored.
DESCRIPTION
Description
===========
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
an event becomes available.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-get-frontend.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_GET_FRONTEND
***************
NAME
Name
====
FE_GET_FRONTEND
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -45,14 +46,14 @@ ARGUMENTS
- Points to parameters for tuning operation.
DESCRIPTION
Description
===========
This ioctl call queries the currently effective frontend parameters. 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
......
Documentation/linux_tv/media/dvb/fe-get-info.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
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
SYNOPSIS
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
ARGUMENTS
Arguments
=========
``fd``
......@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`dvb_frontend_info <dvb-frontend-info>`
DESCRIPTION
Description
===========
All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used
......@@ -418,7 +419,8 @@ supported only on some specific frontend types.
- 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
......
Documentation/linux_tv/media/dvb/fe-get-property.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
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.
SYNOPSIS
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
ARGUMENTS
Arguments
=========
``fd``
......@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dtv_properties <dtv-properties>`
DESCRIPTION
Description
===========
All DVB frontend devices support the ``FE_SET_PROPERTY`` and
......@@ -59,7 +60,7 @@ depends on the delivery system and on 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
......
Documentation/linux_tv/media/dvb/fe-read-ber.rst
View file @ 15e7d615
......@@ -6,19 +6,19 @@
FE_READ_BER
***********
Description
-----------
Name
====
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.
FE_READ_BER
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
Arguments
----------
=========
.. flat-table::
:header-rows: 0
......@@ -44,8 +44,16 @@ Arguments
- 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
------------
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
......
Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_READ_SIGNAL_STRENGTH
***********************
NAME
Name
====
FE_READ_SIGNAL_STRENGTH
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -46,7 +47,7 @@ ARGUMENTS
- The signal strength value is stored into \*strength.
DESCRIPTION
Description
===========
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
to the device is sufficient.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-read-snr.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_READ_SNR
***********
NAME
Name
====
FE_READ_SNR
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- The signal-to-noise ratio is stored into \*snr.
DESCRIPTION
Description
===========
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
to the device is sufficient.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-read-status.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
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
SYNOPSIS
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int *status )
ARGUMENTS
Arguments
=========
``fd``
......@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`fe_status <fe-status>`.
DESCRIPTION
Description
===========
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
- The frontend was reinitialized, application is recommended to
reset DiSEqC, tone and parameters
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_READ_UNCORRECTED_BLOCKS
**************************
NAME
Name
====
FE_READ_UNCORRECTED_BLOCKS
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -46,7 +47,7 @@ ARGUMENTS
- 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
......@@ -56,7 +57,7 @@ calculated. 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
......
Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl FE_SET_FRONTEND_TUNE_MODE
*******************************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -39,14 +40,14 @@ ARGUMENTS
device is reopened read-write.
DESCRIPTION
Description
===========
Allow setting tuner mode flags to the frontend, between 0 (normal) or
FE_TUNE_MODE_ONESHOT mode
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-set-frontend.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
FE_SET_FRONTEND
***************
NAME
Name
====
FE_SET_FRONTEND
SYNOPSIS
Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
ARGUMENTS
Arguments
=========
.. flat-table::
......@@ -45,7 +46,7 @@ ARGUMENTS
- Points to parameters for tuning operation.
DESCRIPTION
Description
===========
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
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
......
Documentation/linux_tv/media/dvb/fe-set-tone.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl FE_SET_TONE
*****************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -30,7 +31,7 @@ ARGUMENTS
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.
......@@ -81,7 +82,8 @@ enum fe_sec_tone_mode
- Don't send a 22kHz tone to the antenna (except if the
FE_DISEQC_* ioctls are called)
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/fe-set-voltage.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl FE_SET_VOLTAGE
********************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -33,7 +34,7 @@ ARGUMENTS
:ref:`fe_sec_voltage <fe-sec-voltage>`.
DESCRIPTION
Description
===========
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
recommended.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/frontend_f_close.rst
View file @ 15e7d615
......@@ -6,12 +6,13 @@
DVB frontend close()
********************
NAME
Name
====
fe-close - Close a frontend device
SYNOPSIS
Synopsis
========
.. code-block:: c
......@@ -22,14 +23,14 @@ SYNOPSIS
.. cpp:function:: int close( int fd )
ARGUMENTS
Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
DESCRIPTION
Description
===========
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
down automatically.
RETURN VALUE
Return Value
============
The function returns 0 on success, -1 on failure and the ``errno`` is
......
Documentation/linux_tv/media/dvb/frontend_f_open.rst
View file @ 15e7d615
......@@ -6,12 +6,13 @@
DVB frontend open()
*******************
NAME
Name
====
fe-open - Open a frontend device
SYNOPSIS
Synopsis
========
.. code-block:: c
......@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags )
ARGUMENTS
Arguments
=========
``device_name``
......@@ -44,7 +45,7 @@ ARGUMENTS
Other flags have no effect.
DESCRIPTION
Description
===========
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
that possible.
RETURN VALUE
Return Value
============
On success :ref:`open() <frontend_f_open>` returns the new file descriptor.
......
Documentation/linux_tv/media/dvb/net-add-if.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl NET_ADD_IF
****************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -30,7 +31,7 @@ ARGUMENTS
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
......@@ -82,7 +83,7 @@ struct dvb_net_if description
``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
......
Documentation/linux_tv/media/dvb/net-get-if.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl NET_GET_IF
****************
NAME
Name
====
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 )
ARGUMENTS
Arguments
=========
``fd``
......@@ -30,7 +31,7 @@ ARGUMENTS
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
......@@ -41,7 +42,7 @@ created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
the ``errno`` with ``EINVAL`` error code.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/net-remove-if.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
ioctl NET_REMOVE_IF
*******************
NAME
Name
====
NET_REMOVE_IF - Removes a network interface.
SYNOPSIS
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int ifnum )
ARGUMENTS
Arguments
=========
``fd``
......@@ -30,14 +31,14 @@ ARGUMENTS
number of the interface to be removed
DESCRIPTION
Description
===========
The NET_REMOVE_IF ioctl deletes an interface previously created via
:ref:`NET_ADD_IF <net>`.
RETURN VALUE
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-clear-buffer.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_CLEAR_BUFFER
==================
NAME
Name
----
VIDEO_CLEAR_BUFFER
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,14 +39,14 @@ ARGUMENTS
- Equals VIDEO_CLEAR_BUFFER for this command.
DESCRIPTION
Description
-----------
This ioctl call clears all video buffers in the driver and in the
decoder hardware.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-command.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_COMMAND
=============
NAME
Name
----
VIDEO_COMMAND
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Commands the decoder.
DESCRIPTION
Description
-----------
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
more information.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-continue.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_CONTINUE
==============
NAME
Name
----
VIDEO_CONTINUE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_CONTINUE for this command.
DESCRIPTION
Description
-----------
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
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
......
Documentation/linux_tv/media/dvb/video-fast-forward.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_FAST_FORWARD
==================
NAME
Name
----
VIDEO_FAST_FORWARD
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- The number of frames to skip.
DESCRIPTION
Description
-----------
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
selected.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-fclose.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
dvb video close()
=================
NAME
Name
----
dvb video close()
SYNOPSIS
Synopsis
--------
.. c:function:: int close(int fd)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -32,13 +33,13 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
DESCRIPTION
Description
-----------
This system call closes a previously opened video device.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/video-fopen.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
dvb video open()
================
NAME
Name
----
dvb video open()
SYNOPSIS
Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default)
DESCRIPTION
Description
-----------
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
return an error code.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/video-freeze.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_FREEZE
============
NAME
Name
----
VIDEO_FREEZE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_FREEZE for this command.
DESCRIPTION
Description
-----------
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
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
......
Documentation/linux_tv/media/dvb/video-fwrite.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
dvb video write()
=================
NAME
Name
----
dvb video write()
SYNOPSIS
Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
DESCRIPTION
Description
-----------
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
available. The amount of data to be transferred is implied by count.
RETURN VALUE
Return Value
------------
.. flat-table::
......
Documentation/linux_tv/media/dvb/video-get-capabilities.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_CAPABILITIES
======================
NAME
Name
----
VIDEO_GET_CAPABILITIES
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to a location where to store the capability information.
DESCRIPTION
Description
-----------
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
defines in section ??.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-get-event.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_EVENT
===============
NAME
Name
----
VIDEO_GET_EVENT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -62,7 +63,7 @@ specified as the wake-up condition. Read-only permissions are sufficient
for this ioctl call.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-get-frame-count.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_FRAME_COUNT
=====================
NAME
Name
----
VIDEO_GET_FRAME_COUNT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -45,7 +46,7 @@ ARGUMENTS
started.
DESCRIPTION
Description
-----------
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
frames since the decoder was started.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_FRAME_RATE
====================
NAME
Name
----
VIDEO_GET_FRAME_RATE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Returns the framerate in number of frames per 1000 seconds.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/video-get-navi.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_NAVI
==============
NAME
Name
----
VIDEO_GET_NAVI
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- PCI or DSI pack (private stream 2) according to section ??.
DESCRIPTION
Description
-----------
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
hardware.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-get-pts.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_PTS
=============
NAME
Name
----
VIDEO_GET_PTS
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -49,7 +50,7 @@ ARGUMENTS
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
......@@ -60,7 +61,7 @@ This ioctl call asks the Video Device to return the current PTS
timestamp.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-get-size.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_SIZE
==============
NAME
Name
----
VIDEO_GET_SIZE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- Returns the size and aspect ratio.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/video-get-status.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_GET_STATUS
================
NAME
Name
----
VIDEO_GET_STATUS
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- Returns the current status of the Video Device.
DESCRIPTION
Description
-----------
This ioctl call asks the Video Device to return the current status of
the device.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-play.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_PLAY
==========
NAME
Name
----
VIDEO_PLAY
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_PLAY for this command.
DESCRIPTION
Description
-----------
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
from the selected source.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-select-source.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SELECT_SOURCE
===================
NAME
Name
----
VIDEO_SELECT_SOURCE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- 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
......@@ -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.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-set-attributes.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_ATTRIBUTES
====================
NAME
Name
----
VIDEO_SET_ATTRIBUTES
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- video attributes according to section ??.
DESCRIPTION
Description
-----------
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
playback.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-set-blank.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_BLANK
===============
NAME
Name
----
VIDEO_SET_BLANK
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -49,13 +50,13 @@ ARGUMENTS
- FALSE: Show last decoded frame.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/video-set-display-format.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_DISPLAY_FORMAT
========================
NAME
Name
----
VIDEO_SET_DISPLAY_FORMAT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- Selects the video format to be used.
DESCRIPTION
Description
-----------
This ioctl call asks the Video Device to select the video format to be
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
......
Documentation/linux_tv/media/dvb/video-set-format.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_FORMAT
================
NAME
Name
----
VIDEO_SET_FORMAT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- video format of TV as defined in section ??.
DESCRIPTION
Description
-----------
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
accordingly.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-set-highlight.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_HIGHLIGHT
===================
NAME
Name
----
VIDEO_SET_HIGHLIGHT
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- SPU Highlight information according to section ??.
DESCRIPTION
Description
-----------
This ioctl sets the SPU highlight information for the menu access of a
DVD.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-set-id.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_ID
============
NAME
Name
----
VIDEO_SET_ID
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,14 +45,14 @@ ARGUMENTS
- video sub-stream id
DESCRIPTION
Description
-----------
This ioctl selects which sub-stream is to be decoded if a program or
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
......
Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_SPU_PALETTE
=====================
NAME
Name
----
VIDEO_SET_SPU_PALETTE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,13 +45,13 @@ ARGUMENTS
- SPU palette according to section ??.
DESCRIPTION
Description
-----------
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
......
Documentation/linux_tv/media/dvb/video-set-spu.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_SPU
=============
NAME
Name
----
VIDEO_SET_SPU
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -45,14 +46,14 @@ ARGUMENTS
??.
DESCRIPTION
Description
-----------
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.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
......
Documentation/linux_tv/media/dvb/video-set-streamtype.rst
View file @ 15e7d615
......@@ -6,18 +6,19 @@
VIDEO_SET_STREAMTYPE
====================
NAME
Name
----
VIDEO_SET_STREAMTYPE
SYNOPSIS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
ARGUMENTS
Arguments
---------
.. flat-table::
......@@ -44,7 +45,7 @@ ARGUMENTS
- stream type
DESCRIPTION
Description
-----------
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
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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7