diff --git a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst index dda1695e28a9ee16178f76aa6d09db36318609e4..841c9759d5e0a4ed49e39d30dd9f5ac67620f134 100644 --- a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst +++ b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-channel-select.rst index f7f9766d39020967b8d59db4b5feaba3192328c0..f2dd79903c49d8a2f0787ae302e2fcea7fe6a6c0 100644 --- a/Documentation/linux_tv/media/dvb/audio-channel-select.rst +++ b/Documentation/linux_tv/media/dvb/audio-channel-select.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst index 97cb3d98f20d96d90592f95ece6b7ec69b874d99..a576c6b160a4c8ea1d438128964466057a11ba07 100644 --- a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst +++ b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-continue.rst b/Documentation/linux_tv/media/dvb/audio-continue.rst index 1f3d5c35b7ce8b96103fbe2c30d3f46205614e25..b513a39f09354227bf8b3d69e520484945827a86 100644 --- a/Documentation/linux_tv/media/dvb/audio-continue.rst +++ b/Documentation/linux_tv/media/dvb/audio-continue.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-fclose.rst b/Documentation/linux_tv/media/dvb/audio-fclose.rst index 80d9cde4c92675d07b9bc14929bf24be846536eb..e515fb353a145b1d72ea5e01e4ac4f865ad545df 100644 --- a/Documentation/linux_tv/media/dvb/audio-fclose.rst +++ b/Documentation/linux_tv/media/dvb/audio-fclose.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/audio-fopen.rst b/Documentation/linux_tv/media/dvb/audio-fopen.rst index 6596d6427c1fae3dbeada49bb3e8790463a4fcb0..46a15950439f39592705a6419977167b73616f48 100644 --- a/Documentation/linux_tv/media/dvb/audio-fopen.rst +++ b/Documentation/linux_tv/media/dvb/audio-fopen.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/audio-fwrite.rst b/Documentation/linux_tv/media/dvb/audio-fwrite.rst index 9aa9583a3267316bb47a883cfdb55b1ba543cadf..f9307053064f05dec51a4d4c2d183802a65817ae 100644 --- a/Documentation/linux_tv/media/dvb/audio-fwrite.rst +++ b/Documentation/linux_tv/media/dvb/audio-fwrite.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst index 32e55bbc4d03f230b8007dc540397c166d4cc352..8b6fdc664f9daea65cec167d6693af5b1218591b 100644 --- a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst +++ b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-get-pts.rst b/Documentation/linux_tv/media/dvb/audio-get-pts.rst index a8e2ef5a107d20845518777c0dd9a1231f6a24dd..246c78c003de645c5e04450684662777d98b4f76 100644 --- a/Documentation/linux_tv/media/dvb/audio-get-pts.rst +++ b/Documentation/linux_tv/media/dvb/audio-get-pts.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-get-status.rst b/Documentation/linux_tv/media/dvb/audio-get-status.rst index b9a2850b577ad6550a4c1fa2e7981a97ade97131..b0a550af87b3f73ae8907eed1d191eaf50c22ab0 100644 --- a/Documentation/linux_tv/media/dvb/audio-get-status.rst +++ b/Documentation/linux_tv/media/dvb/audio-get-status.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-pause.rst b/Documentation/linux_tv/media/dvb/audio-pause.rst index 8b1517b5427282a7b17a1d01a3e05ee61ce609da..86652c3bca06f930d723c1f75c14399e02334003 100644 --- a/Documentation/linux_tv/media/dvb/audio-pause.rst +++ b/Documentation/linux_tv/media/dvb/audio-pause.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-play.rst b/Documentation/linux_tv/media/dvb/audio-play.rst index 22bd35007b256e1756e573d3489c6f115ea6489e..1af70837582170b365953ce7fb9f48eb6c31c7f7 100644 --- a/Documentation/linux_tv/media/dvb/audio-play.rst +++ b/Documentation/linux_tv/media/dvb/audio-play.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-select-source.rst b/Documentation/linux_tv/media/dvb/audio-select-source.rst index 2242e6f0b6ad116161a9066cab77510dc71d7f52..3e873d9cb34543cf94016551419a44cd1840af2d 100644 --- a/Documentation/linux_tv/media/dvb/audio-select-source.rst +++ b/Documentation/linux_tv/media/dvb/audio-select-source.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst index 820c8b2e229845365137c8d8f1c005c704afcc13..43ff502797424ed89dbeafafa8bb78b21ccd4a4b 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst index 3f5ac9a87bc81183853fec6b6bc398b2bcc33522..4ecfb75d28f1c0f4411c478f2064c16795fefee6 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst index 9377342c646d5aeb431878c4ae020ee51b554eaf..b21d142ec31cd6a2b86d430017a6c598bce1b6b0 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst index 38a255289e8c23b82ee9fcca0b53ae90dfb672fe..1b5b8893a00b70f50fcc17d516a39304033b7d24 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-id.rst b/Documentation/linux_tv/media/dvb/audio-set-id.rst index 60eeee07d24425bfacca82d8bc93889432319323..fed99eae52cbc41d579259dfb852aa92cac51dfa 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-id.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-id.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst index 28138222582ad793df80f793d0c6d3597e67628e..ebb2d41bbec32c7e022bea78fdb8f87d4253196c 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst index 8d5a6f3754196fa118d4715999d8bf0a5219abd1..ce4b2a63917eb55a02562e57a0da8f95e9aec317 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-mute.rst b/Documentation/linux_tv/media/dvb/audio-set-mute.rst index a002d0d7128dc1fc0134a7fba3d9a65e4a521ee8..a2469267508be5c1ce71564b62e9d25f38c7db2a 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-mute.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-mute.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst index a971d43e01cc25203ebec9ebb917f0727ee6be6e..4b13c9b9dffea413a9d613ab01dc5a56d3e6d2b8 100644 --- a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst +++ b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/audio-stop.rst b/Documentation/linux_tv/media/dvb/audio-stop.rst index 558ff2b1effbe9708e92a947babed4cd38ee60d2..d9430978096f5b24d26671ed15b843f4ad43e26c 100644 --- a/Documentation/linux_tv/media/dvb/audio-stop.rst +++ b/Documentation/linux_tv/media/dvb/audio-stop.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-fclose.rst b/Documentation/linux_tv/media/dvb/ca-fclose.rst index a093e8dd3182a34c29b497bcaff290078404dd29..16d7a1e76193b94bc7059f427dd0edd6b8bcef7c 100644 --- a/Documentation/linux_tv/media/dvb/ca-fclose.rst +++ b/Documentation/linux_tv/media/dvb/ca-fclose.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/ca-fopen.rst b/Documentation/linux_tv/media/dvb/ca-fopen.rst index a9bf45a921e9780183d744c225b609b19f787f97..f284461cce206944f5ae52d1bf761ff2f3119e1d 100644 --- a/Documentation/linux_tv/media/dvb/ca-fopen.rst +++ b/Documentation/linux_tv/media/dvb/ca-fopen.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/ca-get-cap.rst b/Documentation/linux_tv/media/dvb/ca-get-cap.rst index b026d4769730c74d2164726186f74e3ab34cd0d0..891fbf2d9a8456b39f44542a1c4830d9b6476e2b 100644 --- a/Documentation/linux_tv/media/dvb/ca-get-cap.rst +++ b/Documentation/linux_tv/media/dvb/ca-get-cap.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst index 446afe89af8268aab83e7842d0b76ce4a46a5a10..cf8e8242db66d363fe47ea3f1832c0d237438cf9 100644 --- a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst +++ b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-get-msg.rst b/Documentation/linux_tv/media/dvb/ca-get-msg.rst index 44c944a700c00847f4bc8ccf03d84a4abeefc12b..56004d5ea3ab40f1f03d0c1aada4d1f70775691a 100644 --- a/Documentation/linux_tv/media/dvb/ca-get-msg.rst +++ b/Documentation/linux_tv/media/dvb/ca-get-msg.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst index e1e580341dadf34106f68c5381e40fa3b6c6f26d..9fea28ccad0f3a521f5c07411da1c98fe095ed3e 100644 --- a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst +++ b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-reset.rst b/Documentation/linux_tv/media/dvb/ca-reset.rst index ff58c62fb0a5f59bc8fc7fd23dba92d47431a676..d5a50088fc2d7864b2f3a40e25bf1abbaedafa74 100644 --- a/Documentation/linux_tv/media/dvb/ca-reset.rst +++ b/Documentation/linux_tv/media/dvb/ca-reset.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-send-msg.rst b/Documentation/linux_tv/media/dvb/ca-send-msg.rst index 9d9b8d2520c15100f1cbdd048967ab4d0bc0da13..18974e61e78853917a936416db6f30b3e59b791d 100644 --- a/Documentation/linux_tv/media/dvb/ca-send-msg.rst +++ b/Documentation/linux_tv/media/dvb/ca-send-msg.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-set-descr.rst b/Documentation/linux_tv/media/dvb/ca-set-descr.rst index e992dd52432df8272ab0160a1de43681f4f8fda4..293e6da5059f49bec86df8698e4becfc1945d43a 100644 --- a/Documentation/linux_tv/media/dvb/ca-set-descr.rst +++ b/Documentation/linux_tv/media/dvb/ca-set-descr.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/ca-set-pid.rst b/Documentation/linux_tv/media/dvb/ca-set-pid.rst index e7e3891fa65e28ee6436f383b78ae4d006991bb6..5afa2fae3206667301cc6300098619f0731d142d 100644 --- a/Documentation/linux_tv/media/dvb/ca-set-pid.rst +++ b/Documentation/linux_tv/media/dvb/ca-set-pid.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst index 36bca4f9317c3e28cabc1b279f28de10b307aeda..37f5ee43d5239fdabd4f11e40a4cd0767960377f 100644 --- a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst +++ b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-fclose.rst b/Documentation/linux_tv/media/dvb/dmx-fclose.rst index 7889d0b76f7d4d71b7bf5e4c48daa9e74d8936da..e442881481a26aebe1a4543d131098da7a459491 100644 --- a/Documentation/linux_tv/media/dvb/dmx-fclose.rst +++ b/Documentation/linux_tv/media/dvb/dmx-fclose.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/dmx-fopen.rst b/Documentation/linux_tv/media/dvb/dmx-fopen.rst index 1e1dbc57c64d75a7bca44174b7c19b56e98d608f..7e640fa860c30fe4d6a6eb69eeb3ac7814a3f69f 100644 --- a/Documentation/linux_tv/media/dvb/dmx-fopen.rst +++ b/Documentation/linux_tv/media/dvb/dmx-fopen.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/dmx-fread.rst b/Documentation/linux_tv/media/dvb/dmx-fread.rst index 55d9bc7f424dc8c4b3d6f72b0fad549a05b6a452..92f7a0632766471c6816a419f899c6db82f46a35 100644 --- a/Documentation/linux_tv/media/dvb/dmx-fread.rst +++ b/Documentation/linux_tv/media/dvb/dmx-fread.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst index f3974368496639756dc19ec2b454231164a6256d..8d2632205c291396bd083a3a94b739707cec0510 100644 --- a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst +++ b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst index 8c8ae48a93da48aeffc7414f2a3ae69531626cdb..20e3d6e55d30ce07e9d90a127ee750ba6818944b 100644 --- a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst +++ b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-get-event.rst b/Documentation/linux_tv/media/dvb/dmx-get-event.rst index ab2ab2ed3bedc04f25a65fb94c1f6efb63a60c78..81a7c7fedd470e6fcc4dfbb44bd75c31fe2b5675 100644 --- a/Documentation/linux_tv/media/dvb/dmx-get-event.rst +++ b/Documentation/linux_tv/media/dvb/dmx-get-event.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst index cf0d8a6463fbfd30338fc396a02072fbe001e236..8b1fbf5d2c81335f2ffae6bf738655daa7694025 100644 --- a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst +++ b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst index 35dd691dee097b2d61c38175ebde0db3937cb2bc..616c745a041888df153d0b31afd39d1f9e846418 100644 --- a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst +++ b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst index 859e1a14de549f87ae12d0c18921c56e7830ec73..ed1a49ce9fc22c44064b9d44bc66d9f1c0d4c856 100644 --- a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst +++ b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst index cf6b32f4e3610ce70b923ff929ef54689f585910..012b9e9792bebb132387b8d937346e36ffb8b6ba 100644 --- a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst +++ b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst index 0aad102f3151c76cc74c2c34f62e1fe8486f6267..d079d8b39597cf220df273b22bfb73bdfb8ae97f 100644 --- a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst +++ b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst index 3dccd7cd0a646fd7de31fa62e49cad402d8f1b5a..910869ebdefd0d56ed1a51d8c30825aa5b85128c 100644 --- a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst +++ b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-set-source.rst b/Documentation/linux_tv/media/dvb/dmx-set-source.rst index 13045327857f630946f309d4ec2f47f0e8e27e55..7aa4dfe3cdc5a62e4f2b5d465ccaa4d7a1a2a760 100644 --- a/Documentation/linux_tv/media/dvb/dmx-set-source.rst +++ b/Documentation/linux_tv/media/dvb/dmx-set-source.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-start.rst b/Documentation/linux_tv/media/dvb/dmx-start.rst index c62e2ad17a6aa6d18beb08e9fdd651ef4d608a40..cc316d00343decb39abca3764d7c5c6759738666 100644 --- a/Documentation/linux_tv/media/dvb/dmx-start.rst +++ b/Documentation/linux_tv/media/dvb/dmx-start.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/dmx-stop.rst b/Documentation/linux_tv/media/dvb/dmx-stop.rst index ff9df400f71f1951113eb8afcb1612c1ebbda285..f9157dd6a8fefdbab9987bbf029bfcfb73fab34f 100644 --- a/Documentation/linux_tv/media/dvb/dmx-stop.rst +++ b/Documentation/linux_tv/media/dvb/dmx-stop.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst index 7ddbce6bcd7ee64ccf6e94fbe9bacf2acbbf7094..7bd02ac7bff43c0951538448106e4a6ff889189a 100644 --- a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst +++ b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst index 236c25c9f7bd285b0272246ea60d18660787eb00..cab157054c1361e9e46d1f7ccc9fcb5b25b5759e 100644 --- a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst +++ b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst index 806ee5a9df68dfda422435c79861138f1e96d875..c022cc290067059e08370f69ab338bf42739e840 100644 --- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst +++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst index 519e91bd47fd7d37d79c938abdbdd00f1fcd4d64..dc83b4f2e58689239c79aeb81507853285bbb4d5 100644 --- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst +++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst index 9435f45f58c3f225d0de75a4d5b7d2ca71b2085e..4b60a42dd52c7c021aa5858154549121defefdd0 100644 --- a/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst +++ b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst index 27f49823e67d086dda799638d258eff96e0fa41a..de99bf5fbf0eced4490d1ce8579e7f3ddf4c4123 100644 --- a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst +++ b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-get-event.rst b/Documentation/linux_tv/media/dvb/fe-get-event.rst index 3d858107b6f9466512ccfef519ec82e069249b2c..79beb1b9da3bbc859fd037539dab4dae1ebdb50f 100644 --- a/Documentation/linux_tv/media/dvb/fe-get-event.rst +++ b/Documentation/linux_tv/media/dvb/fe-get-event.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-get-frontend.rst b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst index 7084070bfe77203031554127267ed0c29c8cf43f..fdf0d1440add89848e2e03a060650d1da27dc39a 100644 --- a/Documentation/linux_tv/media/dvb/fe-get-frontend.rst +++ b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst index 1efb242d7f4a712875a41dea8a20525de12b36cb..8ef1ed7bbf685a3bac23270be091153246c95059 100644 --- a/Documentation/linux_tv/media/dvb/fe-get-info.rst +++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/fe-get-property.rst b/Documentation/linux_tv/media/dvb/fe-get-property.rst index c470105dcd1571a19d2c78350db21681b86b6cfd..749daafe6b218adc900b577184127f043508557a 100644 --- a/Documentation/linux_tv/media/dvb/fe-get-property.rst +++ b/Documentation/linux_tv/media/dvb/fe-get-property.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/fe-read-ber.rst b/Documentation/linux_tv/media/dvb/fe-read-ber.rst index 39cf656a4ca0005195239bc65856c6706caeb445..3262441385ff47e4e5b10ca9a13889212af4a68b 100644 --- a/Documentation/linux_tv/media/dvb/fe-read-ber.rst +++ b/Documentation/linux_tv/media/dvb/fe-read-ber.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst index 7f6f47f4d30e63369ce692e75fdfb8b559995dc6..fcaadcb537fbb3c8390d15214138d974ee0bb07d 100644 --- a/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst +++ b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-read-snr.rst b/Documentation/linux_tv/media/dvb/fe-read-snr.rst index 3ecaeb8007f4dbafcd01486f4a2c8214b2e6e9ca..837af2de9f6f03ecedf750a4bc45a8912618620a 100644 --- a/Documentation/linux_tv/media/dvb/fe-read-snr.rst +++ b/Documentation/linux_tv/media/dvb/fe-read-snr.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst index 697598d3097606a90faf1176c5c4c642fb7f0940..544ce49ee0917568663394aef9646fc1cc0ab6b9 100644 --- a/Documentation/linux_tv/media/dvb/fe-read-status.rst +++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst @@ -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 `. -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 diff --git a/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst index 31ec4c35dd51a7f550e5c25c951e8b3fd6d43c1b..6b753846a0086b8526ba4fbb19bd42b6570b94e0 100644 --- a/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst +++ b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst index 1db22c426b8ca87e6eec8870bb47b25fbce8cd47..411abcf4de582cc73e14606ea6c94c2c2b357c8e 100644 --- a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst +++ b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst index 06edd97e7e53f8dd0db0c89308e60f2479baa692..4e66da0af6fd5c0a89523103c8cfb3514bf5e8de 100644 --- a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst +++ b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst index 18677f205954486523682b6dd7ce7e6ba67d2e5b..12aedb69395d41372c448f39d2501273307120ed 100644 --- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst +++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst index 4fd30ee53f5b01d845a5e38a3fb7e8c9253008df..ec8dbf4e266c0b237cdbfcab7b4eff8caf599c43 100644 --- a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst +++ b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst @@ -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 `. -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 diff --git a/Documentation/linux_tv/media/dvb/frontend_f_close.rst b/Documentation/linux_tv/media/dvb/frontend_f_close.rst index 7946673d071ae65e344c1965ea6606bfb2ec7faa..5cce9262084c751f67797b1957b48b302a4bd355 100644 --- a/Documentation/linux_tv/media/dvb/frontend_f_close.rst +++ b/Documentation/linux_tv/media/dvb/frontend_f_close.rst @@ -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() `. -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 diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst index 97ca34b94d05c37bd016e23dc1c3814edf63fe42..e0c55345f524a13d9fe2cbaea3fcd5a80c38ea64 100644 --- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst +++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst @@ -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() ` returns the new file descriptor. diff --git a/Documentation/linux_tv/media/dvb/net-add-if.rst b/Documentation/linux_tv/media/dvb/net-add-if.rst index dc9735d871ee5601e892dc48052bca9b25698bc8..2b990d0e0fe15b40502baed1c841df5b55998d06 100644 --- a/Documentation/linux_tv/media/dvb/net-add-if.rst +++ b/Documentation/linux_tv/media/dvb/net-add-if.rst @@ -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 ` -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 diff --git a/Documentation/linux_tv/media/dvb/net-get-if.rst b/Documentation/linux_tv/media/dvb/net-get-if.rst index 16dfe78eb77f67be4e3aeaf1c406a828f3ab34fc..92b884143ccd550209741b3a645ce4aa31723a2d 100644 --- a/Documentation/linux_tv/media/dvb/net-get-if.rst +++ b/Documentation/linux_tv/media/dvb/net-get-if.rst @@ -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 `. -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 ` -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 `, 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 diff --git a/Documentation/linux_tv/media/dvb/net-remove-if.rst b/Documentation/linux_tv/media/dvb/net-remove-if.rst index c4177833ecf6baa92951d7e7e588e369cc7d1a7c..d374c1d63d06dcb21201478153a013b6141d6b18 100644 --- a/Documentation/linux_tv/media/dvb/net-remove-if.rst +++ b/Documentation/linux_tv/media/dvb/net-remove-if.rst @@ -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 `. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst index e6d2825f4c9b417dac00808da999b4b9bc4a7011..dd227ad85546e59fd9eb9002455bfcb487d01129 100644 --- a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst +++ b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-command.rst b/Documentation/linux_tv/media/dvb/video-command.rst index 1743f40145ff123da9edac5744ce57357c5b6f04..42a98a47e32381600acc36a367a7d450a22ffab4 100644 --- a/Documentation/linux_tv/media/dvb/video-command.rst +++ b/Documentation/linux_tv/media/dvb/video-command.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-continue.rst b/Documentation/linux_tv/media/dvb/video-continue.rst index 453a87dfb40d968ccae2c3003e4fb406cdef43db..2a6444a4f4dca29ffcf90666e96ef0654891ea73 100644 --- a/Documentation/linux_tv/media/dvb/video-continue.rst +++ b/Documentation/linux_tv/media/dvb/video-continue.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-fast-forward.rst b/Documentation/linux_tv/media/dvb/video-fast-forward.rst index 586a23bb5cfd5a4f4fae3583197218ebb3058efe..0b3a27a22d30682358e77340d92aa7e24c0ca2f9 100644 --- a/Documentation/linux_tv/media/dvb/video-fast-forward.rst +++ b/Documentation/linux_tv/media/dvb/video-fast-forward.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-fclose.rst b/Documentation/linux_tv/media/dvb/video-fclose.rst index e98673768d2bfc990af2f8cb9ca814b31440f5cd..b4dd5ea676b994f5dac138bc6db39bcbfef6f23b 100644 --- a/Documentation/linux_tv/media/dvb/video-fclose.rst +++ b/Documentation/linux_tv/media/dvb/video-fclose.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/video-fopen.rst b/Documentation/linux_tv/media/dvb/video-fopen.rst index 3c30fef2aab6346e64c3648b0a091a1773f18fb6..31d4d62b2c7cb7c8ba6cc648076d53cc6b270731 100644 --- a/Documentation/linux_tv/media/dvb/video-fopen.rst +++ b/Documentation/linux_tv/media/dvb/video-fopen.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/video-freeze.rst b/Documentation/linux_tv/media/dvb/video-freeze.rst index 8fbc7835382c1cdcf82f94b5bbe0ae4a4e187bd9..12e04df990b77042be4050f22abf3bb6b5be111f 100644 --- a/Documentation/linux_tv/media/dvb/video-freeze.rst +++ b/Documentation/linux_tv/media/dvb/video-freeze.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-fwrite.rst b/Documentation/linux_tv/media/dvb/video-fwrite.rst index f56c89caef32086d0a480a0f27ab4c6afaa9694f..da03db4be8deeb73fe25dc335e76c90e79ee7b93 100644 --- a/Documentation/linux_tv/media/dvb/video-fwrite.rst +++ b/Documentation/linux_tv/media/dvb/video-fwrite.rst @@ -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:: diff --git a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst index 5666ae7f20c0a591f542b05ecf02db37698cb1e9..5515dd40a1c1d75d7dd0d1858d509831af55c4e3 100644 --- a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst +++ b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-event.rst b/Documentation/linux_tv/media/dvb/video-get-event.rst index b08ca148ecdc8a64b6ee4df75419525780828b2d..d4345991517948fdd1d49ec860a20805d163fbe2 100644 --- a/Documentation/linux_tv/media/dvb/video-get-event.rst +++ b/Documentation/linux_tv/media/dvb/video-get-event.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst index 97ec0581015443c1cc0642b80d5a8218048a168e..a55f7a1d52acfedb38b0b9dc94f1df7764bcf521 100644 --- a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst +++ b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst index 62a85be537ab68bab0a8d401149392ec1249d1f9..a137b6589599a1e54a6ce20ae591b188680a654b 100644 --- a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst +++ b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-navi.rst b/Documentation/linux_tv/media/dvb/video-get-navi.rst index 95dea513bc4833838b69be0f9dd05f81f5052876..ccb2552722f07f8c218a5f8b4d2fd31438852264 100644 --- a/Documentation/linux_tv/media/dvb/video-get-navi.rst +++ b/Documentation/linux_tv/media/dvb/video-get-navi.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-pts.rst b/Documentation/linux_tv/media/dvb/video-get-pts.rst index f56e02a1f4479bf27e3cb79178e2ed3eedbae6a1..c1ad9576963dad58c9df47f4c63171d57f45d3a7 100644 --- a/Documentation/linux_tv/media/dvb/video-get-pts.rst +++ b/Documentation/linux_tv/media/dvb/video-get-pts.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-size.rst b/Documentation/linux_tv/media/dvb/video-get-size.rst index cbdf976223e5a87908c8c010d33d43f9c1f354df..70fb266e3ed804524681e5fa957db36f0763348b 100644 --- a/Documentation/linux_tv/media/dvb/video-get-size.rst +++ b/Documentation/linux_tv/media/dvb/video-get-size.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-get-status.rst b/Documentation/linux_tv/media/dvb/video-get-status.rst index 25344bf0ea7bd58f1fd4153c86fd37390de9478a..5fd5b37942ecfa3b6fe00b55190ca9a91a3de878 100644 --- a/Documentation/linux_tv/media/dvb/video-get-status.rst +++ b/Documentation/linux_tv/media/dvb/video-get-status.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-play.rst b/Documentation/linux_tv/media/dvb/video-play.rst index 18252d9d2ce6a367f9ec4ca5a82a651a3aaeaeeb..103d0ad3341a2c7a7a165a90b89139b64d8a7506 100644 --- a/Documentation/linux_tv/media/dvb/video-play.rst +++ b/Documentation/linux_tv/media/dvb/video-play.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-select-source.rst b/Documentation/linux_tv/media/dvb/video-select-source.rst index 2e76af3d468b10b8072165f5469fe954a3a82838..f03c544668f59b5da26433f86c3ad4965e756644 100644 --- a/Documentation/linux_tv/media/dvb/video-select-source.rst +++ b/Documentation/linux_tv/media/dvb/video-select-source.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-attributes.rst b/Documentation/linux_tv/media/dvb/video-set-attributes.rst index 6de9378ce1c76576237202decfaec8454e05649b..9de0d9c7c9ca46b31d215448da21b09df22c54d5 100644 --- a/Documentation/linux_tv/media/dvb/video-set-attributes.rst +++ b/Documentation/linux_tv/media/dvb/video-set-attributes.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-blank.rst b/Documentation/linux_tv/media/dvb/video-set-blank.rst index 62b46b8b2d027acdc5feab4cbcdddcb7ddb6b3ad..d8b94c9b56b9efe29771c75efab30cb5780805db 100644 --- a/Documentation/linux_tv/media/dvb/video-set-blank.rst +++ b/Documentation/linux_tv/media/dvb/video-set-blank.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-display-format.rst b/Documentation/linux_tv/media/dvb/video-set-display-format.rst index 7aec080638dec54be42f9d90ef65135eb1a161ea..c1fb7c75b4a8aa7b8c27c37c0b5841fff938f02e 100644 --- a/Documentation/linux_tv/media/dvb/video-set-display-format.rst +++ b/Documentation/linux_tv/media/dvb/video-set-display-format.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-format.rst b/Documentation/linux_tv/media/dvb/video-set-format.rst index af126d2de8c3e5e5f594b79bb19157618d94fe87..257a3c2a46271ea0f29a7c4914a176ba654ea7ba 100644 --- a/Documentation/linux_tv/media/dvb/video-set-format.rst +++ b/Documentation/linux_tv/media/dvb/video-set-format.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-highlight.rst b/Documentation/linux_tv/media/dvb/video-set-highlight.rst index d8628d2827403414cd5930ff81bed4023340e6e1..6ff11af713550697319fa04b05e016b63654a261 100644 --- a/Documentation/linux_tv/media/dvb/video-set-highlight.rst +++ b/Documentation/linux_tv/media/dvb/video-set-highlight.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-id.rst b/Documentation/linux_tv/media/dvb/video-set-id.rst index 31ca41f8b6af0b641e5c034b6fc9439de0ca40ab..61993ab354ca2c40cc0ed82d856289dd5f6da88f 100644 --- a/Documentation/linux_tv/media/dvb/video-set-id.rst +++ b/Documentation/linux_tv/media/dvb/video-set-id.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst index b3b727fec64bf8d2f54d2394b953765b4888ea67..ae9e0da5fd0b4bcec6292e83fa2b30d4770e6b50 100644 --- a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst +++ b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-spu.rst b/Documentation/linux_tv/media/dvb/video-set-spu.rst index d00d0b5272d7e51412e08e2675cb49214cd0b444..ce2860574f20f2275602432ecb7938555029b940 100644 --- a/Documentation/linux_tv/media/dvb/video-set-spu.rst +++ b/Documentation/linux_tv/media/dvb/video-set-spu.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst index 6875ff8db77e3effd84035483083d41f29b5bcd6..a2055369f0cdafe90a13f22d9ab347c32fb8f1f1 100644 --- a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst +++ b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst @@ -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 diff --git a/Documentation/linux_tv/media/dvb/video-set-system.rst b/Documentation/linux_tv/media/dvb/video-set-system.rst index 7fcd1a1fb78b72c4b12e28f7b781bc3be4e14de7..f84906a7d1f492fbf599ee443f96584c6e1da688 100644 --- a/Documentation/linux_tv/media/dvb/video-set-system.rst +++ b/Documentation/linux_tv/media/dvb/video-set-system.rst @@ -6,18 +6,19 @@ VIDEO_SET_SYSTEM ================ -NAME +Name ---- VIDEO_SET_SYSTEM -SYNOPSIS + +Synopsis -------- .. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system) -ARGUMENTS +Arguments --------- .. flat-table:: @@ -44,7 +45,7 @@ ARGUMENTS - video system of TV output. -DESCRIPTION +Description ----------- 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 return an error. -RETURN VALUE +Return Value ------------ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/dvb/video-slowmotion.rst b/Documentation/linux_tv/media/dvb/video-slowmotion.rst index 6472abb1e42d83baa3f998dd46ae5aa0858f2488..c8cc85af590b88b2ad72e3490126110c16a64e37 100644 --- a/Documentation/linux_tv/media/dvb/video-slowmotion.rst +++ b/Documentation/linux_tv/media/dvb/video-slowmotion.rst @@ -6,18 +6,19 @@ VIDEO_SLOWMOTION ================ -NAME +Name ---- VIDEO_SLOWMOTION -SYNOPSIS + +Synopsis -------- .. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames) -ARGUMENTS +Arguments --------- .. flat-table:: @@ -44,7 +45,7 @@ ARGUMENTS - The number of times to repeat each frame. -DESCRIPTION +Description ----------- 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 selected. -RETURN VALUE +Return Value ------------ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/dvb/video-stillpicture.rst b/Documentation/linux_tv/media/dvb/video-stillpicture.rst index 93c9c30bcdd338efcc7f7b1ad452bea5afa83365..053cdbba4ed44ff75468f5f1967c887f6984a469 100644 --- a/Documentation/linux_tv/media/dvb/video-stillpicture.rst +++ b/Documentation/linux_tv/media/dvb/video-stillpicture.rst @@ -6,18 +6,19 @@ VIDEO_STILLPICTURE ================== -NAME +Name ---- VIDEO_STILLPICTURE -SYNOPSIS + +Synopsis -------- .. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp) -ARGUMENTS +Arguments --------- .. flat-table:: @@ -44,7 +45,7 @@ ARGUMENTS - 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 @@ -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. -RETURN VALUE +Return Value ------------ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/dvb/video-stop.rst b/Documentation/linux_tv/media/dvb/video-stop.rst index 2dbf464d85bbd1e37ec2677d51f04b9832bd4564..4e7fbab4b8bcac6a87c7d42546cec164f2ce6b02 100644 --- a/Documentation/linux_tv/media/dvb/video-stop.rst +++ b/Documentation/linux_tv/media/dvb/video-stop.rst @@ -6,18 +6,19 @@ VIDEO_STOP ========== -NAME +Name ---- VIDEO_STOP -SYNOPSIS + +Synopsis -------- .. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode) -ARGUMENTS +Arguments --------- .. flat-table:: @@ -54,7 +55,7 @@ ARGUMENTS - FALSE: Show last decoded frame. -DESCRIPTION +Description ----------- 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 or displaying the last decoded frame. -RETURN VALUE +Return Value ------------ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/dvb/video-try-command.rst b/Documentation/linux_tv/media/dvb/video-try-command.rst index b30cfcd05682aebdaf6df72720bdefe87c3caa49..be21fb01bd0fdfaf53c4d9a22aeaff23217837b4 100644 --- a/Documentation/linux_tv/media/dvb/video-try-command.rst +++ b/Documentation/linux_tv/media/dvb/video-try-command.rst @@ -6,18 +6,19 @@ VIDEO_TRY_COMMAND ================= -NAME +Name ---- VIDEO_TRY_COMMAND -SYNOPSIS + +Synopsis -------- .. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd) -ARGUMENTS +Arguments --------- .. flat-table:: @@ -44,7 +45,7 @@ ARGUMENTS - Try a decoder command. -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 for more information. -RETURN VALUE +Return Value ------------ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/mediactl/media-func-close.rst b/Documentation/linux_tv/media/mediactl/media-func-close.rst index 7ec0baa83482874d2567472ec8c38b5b8607d409..3f3d9bb1f32a34103f9199b3f7c76a56dd5f3ad0 100644 --- a/Documentation/linux_tv/media/mediactl/media-func-close.rst +++ b/Documentation/linux_tv/media/mediactl/media-func-close.rst @@ -6,12 +6,13 @@ media close() ************* -NAME +Name ==== media-close - Close a media device -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -22,21 +23,21 @@ SYNOPSIS .. cpp:function:: int close( int fd ) -ARGUMENTS +Arguments ========= ``fd`` File descriptor returned by :ref:`open() `. -DESCRIPTION +Description =========== Closes the media device. Resources associated with the file descriptor are freed. The device configuration remain unchanged. -RETURN VALUE +Return Value ============ :ref:`close() ` returns 0 on success. On error, -1 is returned, and diff --git a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst index 0d8f706b7e743088076f4b7fa4a7126a310637dd..1b28e2d20de491fa2d97a331328f51863de510ba 100644 --- a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst +++ b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst @@ -6,12 +6,13 @@ media ioctl() ************* -NAME +Name ==== media-ioctl - Control a media device -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -22,7 +23,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, void *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -36,7 +37,7 @@ ARGUMENTS Pointer to a request-specific structure. -DESCRIPTION +Description =========== The :ref:`ioctl() ` function manipulates media device parameters. @@ -52,7 +53,7 @@ requests, their respective function and parameters are specified in :ref:`media-user-func`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/mediactl/media-func-open.rst b/Documentation/linux_tv/media/mediactl/media-func-open.rst index 353114fcb7caaa259e20f2eacd56aa4ca6c4554b..43b9ddc5c38f352a21079d5811f2784fc81d455c 100644 --- a/Documentation/linux_tv/media/mediactl/media-func-open.rst +++ b/Documentation/linux_tv/media/mediactl/media-func-open.rst @@ -6,12 +6,13 @@ media open() ************ -NAME +Name ==== media-open - Open a media 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`` @@ -33,7 +34,7 @@ ARGUMENTS Other flags have no effect. -DESCRIPTION +Description =========== To open a media device applications call :ref:`open() ` with the @@ -45,7 +46,7 @@ configuration will result in an error, and ``errno`` will be set to EBADF. -RETURN VALUE +Return Value ============ :ref:`open() ` returns the new file descriptor on success. On error, diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst b/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst index 52fe981a4036d720cc3c312ea9d3990f7de4e986..cee8312bde7dd725a7f0ad3e4d5bfa1ea57cdff5 100644 --- a/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst +++ b/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst @@ -6,18 +6,19 @@ ioctl MEDIA_IOC_DEVICE_INFO *************************** -NAME +Name ==== MEDIA_IOC_DEVICE_INFO - Query device information -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 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 diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst index 5d11572d48488afe3373916c7a916ff78020bcdf..f11c45ad7278350ac1fe1c01e64392df430f4dec 100644 --- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst +++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst @@ -6,18 +6,19 @@ ioctl MEDIA_IOC_ENUM_ENTITIES ***************************** -NAME +Name ==== MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. - -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst index 88bf10b35ff0a6f2d9b9a6280df7a456c3095515..cc3cc3d2400b50caaf23983af56816da574b57ce 100644 --- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst +++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst @@ -6,18 +6,19 @@ ioctl MEDIA_IOC_ENUM_LINKS ************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To enumerate pads and/or links for a given entity, applications set the @@ -159,7 +160,7 @@ returned during the enumeration process. - 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 diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst index 34d46010c9711f5d45f92e2ff659c5870ef16c77..badcdf6133e26b0edc6114064d2315eb96240239 100644 --- a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst +++ b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst @@ -6,18 +6,19 @@ ioctl MEDIA_IOC_G_TOPOLOGY ************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. this array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst b/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst index f02edbcd3048e6bac58211396d6054115ac56cec..57ae5bcc646ade467a352a39c2c4d9e3295f2938 100644 --- a/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst +++ b/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst @@ -6,18 +6,19 @@ ioctl MEDIA_IOC_SETUP_LINK ************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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`` error code. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/func-close.rst b/Documentation/linux_tv/media/v4l/func-close.rst index 81401cd26d1231b8c4ce2b456c59150dc92593ba..926a2ccc32e54546c7845709fd81d0ad4cb6948c 100644 --- a/Documentation/linux_tv/media/v4l/func-close.rst +++ b/Documentation/linux_tv/media/v4l/func-close.rst @@ -6,12 +6,13 @@ V4L2 close() ************ -NAME +Name ==== v4l2-close - Close a V4L2 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() `. -DESCRIPTION +Description =========== 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 remain unchanged. -RETURN VALUE +Return Value ============ The function returns 0 on success, -1 on failure and the ``errno`` is diff --git a/Documentation/linux_tv/media/v4l/func-ioctl.rst b/Documentation/linux_tv/media/v4l/func-ioctl.rst index 91917e976dd0b4fa303a87652f1efa1c6502b300..5632f48fce1bc7f4a2b731e43ad8ec6dcf146c78 100644 --- a/Documentation/linux_tv/media/v4l/func-ioctl.rst +++ b/Documentation/linux_tv/media/v4l/func-ioctl.rst @@ -6,12 +6,13 @@ V4L2 ioctl() ************ -NAME +Name ==== v4l2-ioctl - Program a V4L2 device -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -22,7 +23,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, void *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -36,7 +37,7 @@ ARGUMENTS Pointer to a function parameter, usually a structure. -DESCRIPTION +Description =========== The :ref:`ioctl() ` function is used to program V4L2 devices. The @@ -50,7 +51,7 @@ All V4L2 ioctl requests, their respective function and parameters are specified in :ref:`user-func`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst index 01a45e2172655725643f3ba09564d4095b1f8981..3502c2afd894e4da032cbc8244a9c0f6f7bce60e 100644 --- a/Documentation/linux_tv/media/v4l/func-mmap.rst +++ b/Documentation/linux_tv/media/v4l/func-mmap.rst @@ -6,12 +6,13 @@ V4L2 mmap() *********** -NAME +Name ==== v4l2-mmap - Map device memory into application address space -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -23,7 +24,7 @@ SYNOPSIS .. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset ) -ARGUMENTS +Arguments ========= ``start`` @@ -90,7 +91,7 @@ ARGUMENTS ``mem_offset`` field for the multi-planar API. -DESCRIPTION +Description =========== The :ref:`mmap() ` function asks to map ``length`` bytes starting at @@ -106,7 +107,7 @@ before they can be queried. To unmap buffers the :ref:`munmap() ` function is used. -RETURN VALUE +Return Value ============ On success :ref:`mmap() ` returns a pointer to the mapped buffer. On diff --git a/Documentation/linux_tv/media/v4l/func-munmap.rst b/Documentation/linux_tv/media/v4l/func-munmap.rst index a6e7a6def558fcdb7ca6009f85b603086b3232fe..c29c03f21279314c6f47f237fe045adbc5ec6e63 100644 --- a/Documentation/linux_tv/media/v4l/func-munmap.rst +++ b/Documentation/linux_tv/media/v4l/func-munmap.rst @@ -6,12 +6,13 @@ V4L2 munmap() ************* -NAME +Name ==== v4l2-munmap - Unmap device memory -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -23,7 +24,7 @@ SYNOPSIS .. cpp:function:: int munmap( void *start, size_t length ) -ARGUMENTS +Arguments ========= ``start`` @@ -39,14 +40,14 @@ ARGUMENTS multi-planar API. -DESCRIPTION +Description =========== Unmaps a previously with the :ref:`mmap() ` function mapped buffer and frees it, if possible. -RETURN VALUE +Return Value ============ On success :ref:`munmap() ` returns 0, on failure -1 and the diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst index 152174e6f646755b9652224d7c86ccc144a04e65..06bcadc269a48c4af3693b1a413e61f09c266996 100644 --- a/Documentation/linux_tv/media/v4l/func-open.rst +++ b/Documentation/linux_tv/media/v4l/func-open.rst @@ -6,12 +6,13 @@ V4L2 open() *********** -NAME +Name ==== v4l2-open - Open a V4L2 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`` @@ -43,7 +44,7 @@ ARGUMENTS Other flags have no effect. -DESCRIPTION +Description =========== To open a V4L2 device applications call :ref:`open() ` with the @@ -54,7 +55,7 @@ driver they will be reset to default values, drivers are never in an undefined state. -RETURN VALUE +Return Value ============ On success :ref:`open() ` returns the new file descriptor. On error diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst index 8632e05ff5b2ba8fe1df3a26f97bb7ac8af87924..e6ceb712b78300674cd4ceff2e1ccb7a4bf0af3e 100644 --- a/Documentation/linux_tv/media/v4l/func-poll.rst +++ b/Documentation/linux_tv/media/v4l/func-poll.rst @@ -6,12 +6,13 @@ V4L2 poll() *********** -NAME +Name ==== v4l2-poll - Wait for some event on a file descriptor -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -22,12 +23,12 @@ SYNOPSIS .. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout ) -ARGUMENTS +Arguments ========= -DESCRIPTION +Description =========== With the :ref:`poll() ` function applications can suspend execution @@ -90,7 +91,7 @@ function. For more details see the :ref:`poll() ` manual page. -RETURN VALUE +Return Value ============ On success, :ref:`poll() ` returns the number structures which have diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst index c4f0e8ab9e14c59d8952b98475f8a8095ad62998..9a2aa5210233f2ed11bf57f226a586fb56cd1583 100644 --- a/Documentation/linux_tv/media/v4l/func-read.rst +++ b/Documentation/linux_tv/media/v4l/func-read.rst @@ -6,12 +6,13 @@ V4L2 read() *********** -NAME +Name ==== v4l2-read - Read from a V4L2 device -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -22,7 +23,7 @@ SYNOPSIS .. cpp:function:: ssize_t read( int fd, void *buf, size_t count ) -ARGUMENTS +Arguments ========= ``fd`` @@ -32,7 +33,7 @@ ARGUMENTS ``count`` -DESCRIPTION +Description =========== :ref:`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. 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 diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst index 34ade67d0f685ff23aeedc2e146a46db4107886a..954dd00b8301af8352094fd996ba79bde7ee57e6 100644 --- a/Documentation/linux_tv/media/v4l/func-select.rst +++ b/Documentation/linux_tv/media/v4l/func-select.rst @@ -6,12 +6,13 @@ V4L2 select() ************* -NAME +Name ==== v4l2-select - Synchronous I/O multiplexing -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -24,12 +25,12 @@ SYNOPSIS .. 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() ` function applications can suspend @@ -71,7 +72,7 @@ function. For more details see the :ref:`select() ` manual page. -RETURN VALUE +Return Value ============ On success, :ref:`select() ` returns the number of descriptors diff --git a/Documentation/linux_tv/media/v4l/func-write.rst b/Documentation/linux_tv/media/v4l/func-write.rst index 6609f191af76244f7871eff2751efc4418be32fd..a3bc9b26fe563a3388aa96aad43f98dfcff8560e 100644 --- a/Documentation/linux_tv/media/v4l/func-write.rst +++ b/Documentation/linux_tv/media/v4l/func-write.rst @@ -6,12 +6,13 @@ V4L2 write() ************ -NAME +Name ==== v4l2-write - Write to a V4L2 device -SYNOPSIS + +Synopsis ======== .. code-block:: c @@ -22,7 +23,7 @@ SYNOPSIS .. cpp:function:: ssize_t write( int fd, void *buf, size_t count ) -ARGUMENTS +Arguments ========= ``fd`` @@ -32,7 +33,7 @@ ARGUMENTS ``count`` -DESCRIPTION +Description =========== :ref:`write() ` writes up to ``count`` bytes to the device @@ -47,7 +48,7 @@ Sliced Teletext or Closed Caption data is not repeated, the driver inserts a blank line instead. -RETURN VALUE +Return Value ============ On success, the number of bytes written are returned. Zero indicates diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst index fe179197536d48f64f4718f0ca7574f1e1f9fde4..abdc0b4d83d5961af73c6d31cd23733792d3f182 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_CREATE_BUFS ************************ -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl is used to create buffers for :ref:`memory mapped ` @@ -130,7 +131,7 @@ than the number requested. must set the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst index 17ae3aa738b094e0adcf01ca150e70297b0259f4..8dcbe6d2621921512ba96937dc0a37e80ca8d57b 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_CROPCAP ******************** -NAME +Name ==== VIDIOC_CROPCAP - Information about the video cropping and scaling abilities -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Applications use this function to query the cropping limits, the pixel @@ -154,7 +155,7 @@ overlay devices. - Height of the rectangle, in pixels. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst index 913c6d47d8210e67578538c5c754a0797d4d5910..efa911c0fb194321977a7c7f5ba6e8c9b63021cb 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_DBG_G_CHIP_INFO **************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== **Note** @@ -192,7 +193,7 @@ instructions. - Match the nth sub-device. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst index 185a011a117c33b7a391e809d98ae6dfd99ecd1d..345aa321f38083b26405094c908a52c6fc2ac683 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER ************************************************** -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== **Note** @@ -196,7 +197,7 @@ instructions. - Match the nth sub-device. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst index bb6d9b8cf12234d6dc4b5b9f42b85a992232211a..2a36e91b57b94f0cf99ca31ea69e4992648c0cc4 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD ************************************************ -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== These ioctls control an audio/video (usually MPEG-) decoder. @@ -255,7 +256,7 @@ introduced in Linux 3.3. flags are defined for this command. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst index 850cb5ed00153de79e8d8a4966f232579e556729..73c0d5be62eecae6b3d605a94cd85ea7961a1a8a 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_DQEVENT ******************** -NAME +Name ==== VIDIOC_DQEVENT - Dequeue event -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Dequeue an event from a video device. No input is required for this @@ -564,7 +565,7 @@ call. decoder. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst index 61fef531363cdd48b62b4a6be611fc3e22cabeeb..b56cdef7673ebb91093b55def3448bb1fe40cf02 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. 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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst index 1991014fd6b525a9de7c3008adacf63f1a9fb570..69bd9b4e0e5604f38854dee348a72dc66173e906 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD ************************************************ -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== These ioctls control an audio/video (usually MPEG-) encoder. @@ -179,7 +180,7 @@ introduced in Linux 2.6.21. rather than immediately. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst index 41fa4313c1c29c199dfa854493ac7cd05195a69c..f0dd0c4ca7d0d9d1687d93a063244d36714185c9 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== While some DV receivers or transmitters support a wide range of timings, @@ -103,7 +104,7 @@ return an ``EINVAL`` error code. - The timings. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst index 3b935b07837a4519a5672683af01c86020888fb1..257c624e27be0001bcaa744a51397be3d15e9e3d 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUM_FMT ********************* -NAME +Name ==== VIDIOC_ENUM_FMT - Enumerate image formats -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To enumerate image formats applications initialize the ``type`` and @@ -151,7 +152,7 @@ formats may be different. format instead for better performance. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst index 3336a166b878a047e1214415cc9e241b01f97f7e..5d5de535a0fe20a840abe52bb5d4365b68e1796b 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUM_FRAMEINTERVALS ******************************** -NAME +Name ==== VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -32,7 +33,7 @@ ARGUMENTS interval. -DESCRIPTION +Description =========== This ioctl allows applications to enumerate all frame intervals that the @@ -265,7 +266,7 @@ Enums - Step-wise defined frame interval. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst index d01fffaeda04f20cb8c47612f3f80f57c959885e..d3b2e97df6c9c967640ef22191b493a1c8d7b13d 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUM_FRAMESIZES **************************** -NAME +Name ==== VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -32,7 +33,7 @@ ARGUMENTS and height. -DESCRIPTION +Description =========== This ioctl allows applications to enumerate all frame sizes (i. e. width @@ -282,7 +283,7 @@ Enums - Step-wise defined frame size. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst index 7fdde4be282c7115c2af67115144580703b254cb..ea754f4f55323657619c1603d613001521cafdb7 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUM_FREQ_BANDS **************************** -NAME +Name ==== VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Enumerates the frequency bands that a tuner or modulator supports. To do @@ -177,7 +178,7 @@ of the corresponding tuner/modulator is set. - 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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst index f833e581f7c33910ea9f3bfada1c96827baf1374..bfdc3533240d05c9f462beef86606653b87cc8b7 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUMAUDIO ********************** -NAME +Name ==== VIDIOC_ENUMAUDIO - Enumerate audio inputs -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the attributes of an audio input applications initialize the @@ -44,7 +45,7 @@ See :ref:`VIDIOC_G_AUDIO ` for a description of struct :ref:`v4l2_audio `. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst index f2caf6c71f4463d659ed6a4447d6e3c1200320dd..4c1756319c09bc56cd2cac42cc123efaa3e297af 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUMAUDOUT *********************** -NAME +Name ==== VIDIOC_ENUMAUDOUT - Enumerate audio outputs -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the attributes of an audio output applications initialize the @@ -47,7 +48,7 @@ See :ref:`VIDIOC_G_AUDIOout ` for a description of struct :ref:`v4l2_audioout `. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst index 01a1cadc71d2a69556f74ae400e3d08c3791c549..c1fc2e1f1d98b0f3720aaaef4dd15e3c35da5e61 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUMINPUT ********************** -NAME +Name ==== VIDIOC_ENUMINPUT - Enumerate video inputs -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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``. :ref:`v4l2-selections-common`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst index 99c70e54c4d6adbf316ad6fff68682261daaccbd..82fc9d3b237fa07a87ed8aaeb9b9fd8645593839 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUMOUTPUT *********************** -NAME +Name ==== VIDIOC_ENUMOUTPUT - Enumerate video outputs -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the attributes of a video outputs applications initialize the @@ -209,7 +210,7 @@ EINVAL. :ref:`v4l2-selections-common`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst index e74514ea44375d8f531666d434953987b1189bfc..ce911c81bd3df200fc4a4b9a2222837c290f589b 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_ENUMSTD ******************** -NAME +Name ==== VIDIOC_ENUMSTD - Enumerate supported video standards -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 - + 6.5 [8]_ -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst index 2c08a349ab454f7b7fd500bddcfa1c5c61ae1f38..ded708e647fa8e41d381e7c4da105c46b2b5c460 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_EXPBUF ******************* -NAME +Name ==== VIDIOC_EXPBUF - Export a buffer as a DMABUF file descriptor. -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl is an extension to the :ref:`memory mapping ` I/O @@ -184,7 +185,7 @@ Examples the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst index 02db00a317222d45bd32a2295fef93977049c284..cccbcdb8c463d33a0ee5d2418f9a78c39f182a68 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst @@ -6,12 +6,13 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the current audio input applications zero out the ``reserved`` @@ -149,7 +150,7 @@ return the actual new audio mode. - AVL mode is on. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst index 9265be57d0f9c1e7eeca07fdc6616360c215db4b..e36b5a11633246dbb85b5831b1c65e8b0f2a37e5 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT ************************************** -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the current audio output applications zero out the ``reserved`` @@ -108,7 +109,7 @@ sound card are not audio outputs in this sense. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst index 206fdd5f825f44bafa91cbc3f26c34f24e0e6e21..6cf76497937ccc2d69cc9dd00d73d06183b49f38 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_CROP, VIDIOC_S_CROP ********************************** -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 :ref:`v4l2_cropcap ` ``bounds`` is used. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst index 50fddb14028846a6b6832fc37eb5fae4782b70b3..ee929f692ebe120669534ee687e9c40377ce641c 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL ********************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 - New value or current value. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst index f6e7fd261ebcb1f2510ed407648b8fc7c1b23603..0dd93d1ee284c90d53b065684d60020d172e9bb9 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -30,7 +31,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 ``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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst index 1414026f5740564058e0ae61df1af91b31ffddc0..907b2c1764a33a2554ebee677d0a55f2331a97eb 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -30,7 +31,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== These ioctls can be used to get or set an EDID associated with an input @@ -143,7 +144,7 @@ EDID is no longer available. ``blocks`` * 128. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst index 16f0e81359523fdd7d772218b66a6041baaca59b..f0f41ac56b801c61ce2698743974fa6e6a677285 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_ENC_INDEX ************************ -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== The :ref:`VIDIOC_G_ENC_INDEX ` ioctl provides meta data about a compressed @@ -201,7 +202,7 @@ video elementary streams. type. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst index 2f69b1cf804bc6be4f3c79d593f0947a30e33dba..96b6eaca755c2433110f8b19b23a8c4291cff7a3 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -30,7 +31,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== These ioctls allow the caller to get or set multiple controls @@ -451,7 +452,7 @@ still cause this situation. described in :ref:`rf-tuner-controls`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst index 4d07994144202edce9d9e0661996978832024bd8..ef4592c338ef6a89b74bf79adfeaa0d69ff313a7 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF ********************************** -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Applications can use the :ref:`VIDIOC_G_FBUF ` and :ref:`VIDIOC_S_FBUF ` ioctl @@ -477,7 +478,7 @@ destructive video overlay. :ref:`v4l2_window ` is being used. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst index aede100b668b8ba0ef6fe4d4842ea9f5d62b7aa9..ee6f11978fd61e682e492cbc9b8cd5c22e6cef4d 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 ` must be identical - Place holder for future extensions. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst index 2b921cda2e4db0f4befdaa8eada0c84af3665517..a1fd2a870de415168c42a2e7b9fe4482a0d18a76 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY ******************************************** -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst index e069ba3952ea59a5a1110edd05b29a99ea402283..29e22f6f8028175d20dd594ff9f03e3ebb9da967 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT ************************************ -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the current video input applications call the @@ -50,7 +51,7 @@ Information about video inputs is available using the :ref:`VIDIOC_ENUMINPUT` ioctl. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst index c8d3a3b53a51c65f823c446c1bb2e006b665ec45..f5bf8b7915edda5ed093307cd370fcc11962cc33 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP ****************************************** -NAME +Name ==== VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== These ioctls are **deprecated**. New drivers and applications should use @@ -175,7 +176,7 @@ encoding. You usually do want to add them. - 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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst index 21b9fea34b8c41d87b8aadfbf4327e094eb63b17..05d83610bdc5bf24f58be4a0a7be8ca4a69f2e0b 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR ******************************************** -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the attributes of a modulator applications initialize the @@ -242,7 +243,7 @@ To change the radio frequency the - 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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst index c9fb075ec5d1ecf2700fc89028c0487377ddff37..ae0ad577ba974ca742b23847077f09e614ed42df 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT ************************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the current video output applications call the @@ -51,7 +52,7 @@ Information about video outputs is available using the :ref:`VIDIOC_ENUMOUTPUT` ioctl. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst index 964e3b8ce275e2798aca5e4dabc42b89d53d54b4..7116e0decddc817021fb8216b79e48f608be4a43 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_PARM, VIDIOC_S_PARM ********************************** -NAME +Name ==== VIDIOC_G_PARM - VIDIOC_S_PARM - Get or set streaming parameters -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== The current video standard determines a nominal number of frames per @@ -340,7 +341,7 @@ union holding separate parameters for input and output devices. - Capture might only work through the :ref:`read() ` call. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst index 8255f2469cd92e6f18a1f2a999f6d0179e98ebaa..4419195661f1078bc54d93652b4e242f92914ef4 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst @@ -6,12 +6,13 @@ 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 -SYNOPSIS + +Synopsis ======== .. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp ) @@ -19,7 +20,7 @@ SYNOPSIS .. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -32,7 +33,7 @@ ARGUMENTS Pointer to an enum v4l2_priority type. -DESCRIPTION +Description =========== To query the current access priority applications call the @@ -102,7 +103,7 @@ with a pointer to this variable. 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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst index c4164eaafca88d06468cb70deff6e23abe2ebcb9..953931fabd00592ba29945ab0ebc444cb5a54912 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION ******************************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== The ioctls are used to query and configure selection rectangles. @@ -187,7 +188,7 @@ Selection targets and flags are documented in this array. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst index 466760241fdbc553d2855e5a59d38c4af64ca904..76dd4ba3254f6bc1432b1c579f0ccfb644e01b09 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_G_SLICED_VBI_CAP ***************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. - :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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst index 4fbc9e9bfeb8a3c7a11b6fd7a0a719098556768d..5c2b861f8d26b4575df23dd6ae5de2cccc52da3f 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst @@ -6,12 +6,13 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 returned. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst index fe904db57597a322e900197ac10f18636835cf29..a8d7ebd73e8a3bb0b78f6a280ae6faf908657e3b 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst @@ -6,12 +6,13 @@ ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER ************************************ -NAME +Name ==== 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 ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the attributes of a tuner applications initialize the ``index`` @@ -692,7 +693,7 @@ To change the radio frequency the - Lang1/Lang2 (preferred) or Lang1/Lang1 -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst index d96d5e4f242a1b98c921e60e7860cd5ff00ac3a8..66fc352c0ffaf4319191504a2556e971fd31aa35 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst @@ -6,23 +6,24 @@ ioctl VIDIOC_LOG_STATUS *********************** -NAME +Name ==== VIDIOC_LOG_STATUS - Log driver status information -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request ) -ARGUMENTS +Arguments ========= -DESCRIPTION +Description =========== 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 in Linux 2.6.15. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst index cd58a34a7ee8ea968e2ce721526eca10c7b099d6..191dbc144ef7b0063336bd88102121eed77d4efd 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_OVERLAY ******************** -NAME +Name ==== VIDIOC_OVERLAY - Start or stop video overlay -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, const int *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl is part of the :ref:`video overlay ` I/O method. @@ -42,7 +43,7 @@ Drivers do not support :ref:`VIDIOC_STREAMON` or ``V4L2_BUF_TYPE_VIDEO_OVERLAY``. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst index 0f51082f8c93a67ec4b6f4d7ccf67184fc8cd3de..79076dff46fdae056eab91403703d9d18e0dc1ab 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_PREPARE_BUF ************************ -NAME +Name ==== VIDIOC_PREPARE_BUF - Prepare a buffer for I/O -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to @@ -45,7 +46,7 @@ The :ref:`struct v4l2_buffer ` structure is specified in :ref:`buffer`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst index bf41f30cf9c482765c9545fc3430245312478585..9870d243131ae8b328c00ec0e053db85988bc756 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_QBUF, VIDIOC_DQBUF ******************************* -NAME +Name ==== VIDIOC_QBUF - VIDIOC_DQBUF - Exchange a buffer with the driver -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Applications call the ``VIDIOC_QBUF`` ioctl to enqueue an empty @@ -116,7 +117,7 @@ The :ref:`struct v4l2_buffer ` structure is specified in :ref:`buffer`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst index 38295fd5f1ad01441700df1377df2f54e475a222..338b80df5b9b8caae3e491be10ec08f9ed37c4e9 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 precise feedback to the user. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst index 6454c302644d156292919ef965f64784276b3ea1..32af6f7b5060590e5ebf2841233a8c44c2f03386 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_QUERYBUF ********************* -NAME +Name ==== VIDIOC_QUERYBUF - Query the status of a buffer -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl is part of the :ref:`streaming ` I/O method. It can @@ -68,7 +69,7 @@ The :ref:`struct v4l2_buffer ` structure is specified in :ref:`buffer`. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst index 406c5eb3403455b708129556c57044327f01a2b2..f0271f834ac18e49f45af476c598eef06424b788 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_QUERYCAP ********************* -NAME +Name ==== VIDIOC_QUERYCAP - Query device capabilities -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== All V4L2 devices support the ``VIDIOC_QUERYCAP`` ioctl. It is used to @@ -420,7 +421,7 @@ specification the ioctl returns an ``EINVAL`` error code. ``device_caps`` field. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst index 4e0eb7b04fd26cd38d9304ee7e8b0f68b25aa56e..0f27e712eec98bebb39f3b91811093f11a4433c5 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst @@ -6,12 +6,13 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp ) @@ -21,7 +22,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -33,7 +34,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To query the attributes of a control applications set the ``id`` field @@ -753,7 +754,7 @@ See also the examples in :ref:`control`. ``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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst index fe540f80ef608d15b0b1be8a7efd012332fa65fd..5bf62775c7409ccfc525948ec55fc477fba5de79 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_QUERYSTD ********************* -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 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 diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst index 2e27708fd7a6379e4a9cab938ee1ca10ef03c297..c25b0719c2ff1c3d877ede11beb3440eb5c1c45d 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_REQBUFS ******************** -NAME +Name ==== VIDIOC_REQBUFS - Initiate Memory Mapping or User Pointer I/O -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl is used to initiate :ref:`memory mapped `, @@ -112,7 +113,7 @@ any DMA in progress, an implicit must set the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst index 068a67e8a523296a81070dd807a7fb3dce0b996f..5fd332a5bfee6e3f6473ffde0ff716b648e2790f 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_S_HW_FREQ_SEEK *************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst index 0e6b750f871813c7302c1451cb1af5f8c521b706..e87500e608e1578ffde4a809eda14e56157c5a9d 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF *************************************** -NAME +Name ==== VIDIOC_STREAMON - VIDIOC_STREAMOFF - Start or stop streaming I/O -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, const int *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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 to synchronize with other events. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst index 0d2b690cf8bcff02b5a5c9bafdcaebb7761c8fba..0aa6482a91a6cab70a80206becaa2ce15b1abb7a 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL *************************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl lets applications enumerate available frame intervals on a @@ -137,7 +138,7 @@ multiple pads of the same sub-device is not defined. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst index c52a02df5b16667d0594416c8ad3e676521dab38..7a5811b71b68ed7e732dac070ca3d1113498ad29 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE *********************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== This ioctl allows applications to enumerate all frame sizes supported by @@ -147,7 +148,7 @@ information about try formats. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst index 1ff173e502f760bebea7e13b20a65ab38bb1615d..bc0531eb56fab456d5d3756dd9332e072b1924f7 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE ********************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== To enumerate media bus formats available at a given sub-device pad @@ -100,7 +101,7 @@ information about the try formats. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst index 94bffa78c486387c3210ec17df1afa6c151c26ba..690034a391d37b04f93e0d3d5f0a344dc757c0f4 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst @@ -6,12 +6,13 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp ) @@ -19,7 +20,7 @@ SYNOPSIS .. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -31,7 +32,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== **Note** @@ -114,7 +115,7 @@ modified format should be as close as possible to the original request. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst index 13615c0d03923fb0665fa7f6a5f6df2a0f52741c..90e2a6635ebc782c49008205eebe8f2c19f1d6be 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== 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. - Active formats, applied to the hardware. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst index 05f5bfb3f1ca13f02236b90f5d68f8b0aca1308a..d8a1cabbd2727a8da4aecf3b3089b1db77fee985 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -30,7 +31,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== These ioctls are used to get and set the frame interval at specific @@ -100,7 +101,7 @@ the same sub-device is not defined. the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst index dd0dab7d7e427de9c38f9e944c770ffa48a22a7d..50838a4a429e195aed9ecfb9b03ca152c99b0e80 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst @@ -6,18 +6,19 @@ 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 -SYNOPSIS + +Synopsis ======== .. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== The selections are used to configure various image processing @@ -122,7 +123,7 @@ Selection targets and flags are documented in the array to zero. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst index 2ecce157f852c6efc3c4a61f4b5573343c85ea5e..a027f602de3d42235a12510c20aa2f74e129ed0e 100644 --- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst +++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst @@ -6,18 +6,19 @@ ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT ****************************************************** -NAME +Name ==== 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 ) -ARGUMENTS +Arguments ========= ``fd`` @@ -29,7 +30,7 @@ ARGUMENTS ``argp`` -DESCRIPTION +Description =========== Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by @@ -126,7 +127,7 @@ using the :ref:`VIDIOC_DQEVENT` ioctl. situations like that. -RETURN VALUE +Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set