summaryrefslogtreecommitdiffstats
path: root/Documentation/userspace-api/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-09-24 16:56:00 +0200
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-10-15 07:49:39 +0200
commitf9b2e8aa326fefa21360a778e40cae486969293b (patch)
treef92a6fc818108583436b8149eac311c081655a62 /Documentation/userspace-api/media
parent407e84cd1e9a802df1955e281d8956439abc499b (diff)
media: docs: make DVB documents more compatible with Sphinx 3.1+
Sphinx 3.x broke support for the cdomain.py extension, as the c domain code was rewritten. Due to that, the c tags need to be re-written, in order to use the new c domain notation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/userspace-api/media')
-rw-r--r--Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/audio-channel-select.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-clear-buffer.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-continue.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/audio-fclose.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/audio-fopen.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/audio-fwrite.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/audio-get-capabilities.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-get-status.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-pause.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/audio-play.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/audio-select-source.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-set-av-sync.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/audio-set-id.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/audio-set-mixer.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/audio-set-mute.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/audio-set-streamtype.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/audio-stop.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/ca-fclose.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/ca-fopen.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/ca-get-cap.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/ca-get-descr-info.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/ca-get-msg.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/ca-get-slot-info.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/ca-reset.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/ca-send-msg.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/ca-set-descr.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-add-pid.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-expbuf.rst11
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-fclose.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-fopen.rst5
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-fread.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-fwrite.rst6
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst12
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-get-stc.rst12
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-mmap.rst15
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-munmap.rst14
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-qbuf.rst17
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-querybuf.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-remove-pid.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-reqbufs.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-set-filter.rst12
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-set-pes-filter.rst13
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-start.rst11
-rw-r--r--Documentation/userspace-api/media/dvb/dmx-stop.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-diseqc-recv-slave-reply.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-diseqc-reset-overload.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/fe-diseqc-send-master-cmd.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-dishnetwork-send-legacy-cmd.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/fe-enable-high-lnb-voltage.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/fe-get-event.rst12
-rw-r--r--Documentation/userspace-api/media/dvb/fe-get-frontend.rst12
-rw-r--r--Documentation/userspace-api/media/dvb/fe-get-info.rst11
-rw-r--r--Documentation/userspace-api/media/dvb/fe-get-property.rst15
-rw-r--r--Documentation/userspace-api/media/dvb/fe-read-ber.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-read-signal-strength.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-read-snr.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-read-status.rst11
-rw-r--r--Documentation/userspace-api/media/dvb/fe-read-uncorrected-blocks.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/fe-set-frontend.rst11
-rw-r--r--Documentation/userspace-api/media/dvb/fe-set-tone.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/fe-set-voltage.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/frontend_f_close.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/frontend_f_open.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/net-add-if.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/net-get-if.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/net-remove-if.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/video-clear-buffer.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-command.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/video-continue.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-fast-forward.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/video-fclose.rst6
-rw-r--r--Documentation/userspace-api/media/dvb/video-fopen.rst6
-rw-r--r--Documentation/userspace-api/media/dvb/video-freeze.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-fwrite.rst6
-rw-r--r--Documentation/userspace-api/media/dvb/video-get-capabilities.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-get-event.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-get-frame-count.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-get-pts.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-get-size.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-get-status.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/video-play.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-select-source.rst7
-rw-r--r--Documentation/userspace-api/media/dvb/video-set-blank.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-set-display-format.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-set-format.rst9
-rw-r--r--Documentation/userspace-api/media/dvb/video-set-streamtype.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-slowmotion.rst10
-rw-r--r--Documentation/userspace-api/media/dvb/video-stillpicture.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-stop.rst8
-rw-r--r--Documentation/userspace-api/media/dvb/video-try-command.rst8
95 files changed, 329 insertions, 534 deletions
diff --git a/Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst b/Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst
index ba4f48b30d29..33b5363317f1 100644
--- a/Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst
+++ b/Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.audio
.. _AUDIO_BILINGUAL_CHANNEL_SELECT:
@@ -16,9 +17,9 @@ AUDIO_BILINGUAL_CHANNEL_SELECT
Synopsis
--------
-.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select)
- :name: AUDIO_BILINGUAL_CHANNEL_SELECT
+.. c:macro:: AUDIO_BILINGUAL_CHANNEL_SELECT
+``int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct audio_channel_select *select)``
Arguments
---------
@@ -39,7 +40,6 @@ Arguments
- Select the output format of the audio (mono left/right, stereo).
-
Description
-----------
@@ -50,7 +50,6 @@ for MPEG decoders controlled through V4L2.
This ioctl call asks the Audio Device to select the requested channel
for bilingual streams if possible.
-
Return Value
------------
diff --git a/Documentation/userspace-api/media/dvb/audio-channel-select.rst b/Documentation/userspace-api/media/dvb/audio-channel-select.rst
index ba83b639d955..74093df92a68 100644
--- a/Documentation/userspace-api/media/dvb/audio-channel-select.rst
+++ b/Documentation/userspace-api/media/dvb/audio-channel-select.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.audio
.. _AUDIO_CHANNEL_SELECT:
@@ -16,9 +17,9 @@ AUDIO_CHANNEL_SELECT
Synopsis
--------
-.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select)
- :name: AUDIO_CHANNEL_SELECT
+.. c:macro:: AUDIO_CHANNEL_SELECT
+``int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct audio_channel_select *select)``
Arguments
---------
@@ -27,7 +28,6 @@ Arguments
:header-rows: 0
:stub-columns: 0
-
-
- int fd
@@ -40,7 +40,6 @@ Arguments
- Select the output format of the audio (mono left/right, stereo).
-
Description
-----------
@@ -50,7 +49,6 @@ V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
This ioctl call asks the Audio Device to select the requested channel if
possible.
-
Return Value
------------
diff --git a/Documentation/userspace-api/media/dvb/audio-clear-buffer.rst b/Documentation/userspace-api/media/dvb/audio-clear-buffer.rst
index 7035a40c0e3a..a0ebb0278260 100644
--- a/Documentation/userspace-api/media/dvb/audio-clear-buffer.rst
+++ b/Documentation/userspace-api/media/dvb/audio-clear-buffer.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.audio
.. _AUDIO_CLEAR_BUFFER:
@@ -16,8 +17,9 @@ AUDIO_CLEAR_BUFFER
Synopsis
--------
-.. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER)
- :name: AUDIO_CLEAR_BUFFER
+.. c:macro:: AUDIO_CLEAR_BUFFER
+
+``int ioctl(int fd, AUDIO_CLEAR_BUFFER)``
Arguments
---------
@@ -26,7 +28,6 @@ Arguments
:header-rows: 0
:stub-columns: 0
-
- .. row 1
- int fd
@@ -39,7 +40,6 @@ Description
This ioctl call asks the Audio Device to clear all software and hardware
buffers of the audio decoder device.
-
Return Value
------------
diff --git a/Documentation/userspace-api/media/dvb/audio-continue.rst b/Documentation/userspace-api/media/dvb/audio-continue.rst
index c8d514a4eeb0..a2e9850f37f2 100644
--- a/Documentation/userspace-api/media/dvb/audio-continue.rst
+++ b/Documentation/userspace-api/media/dvb/audio-continue.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.audio
.. _AUDIO_CONTINUE:
@@ -16,9 +17,9 @@ AUDIO_CONTINUE
Synopsis
--------
-.. c:function:: int ioctl(int fd, AUDIO_CONTINUE)
- :name: AUDIO_CONTINUE
+.. c:macro:: AUDIO_CONTINUE
+``int ioctl(int fd, AUDIO_CONTINUE)``
Arguments
---------
@@ -27,7 +28,6 @@ Arguments
:header-rows: 0
:stub-columns: 0
-
- .. row 1
- int fd
@@ -40,7 +40,6 @@ Description
This ioctl restarts the decoding and playing process previously paused
with AUDIO_PAUSE command.
-
Return Value
------------
diff --git a/Documentation/userspace-api/media/dvb/audio-fclose.rst b/Documentation/userspace-api/media/dvb/audio-fclose.rst
index c968177b1e3f..77857d578e83 100644
--- a/Documentation/userspace-api/media/dvb/audio-fclose.rst
+++ b/Documentation/userspace-api/media/dvb/audio-fclose.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.audio
.. _audio_fclose:
@@ -17,8 +18,6 @@ Synopsis
--------
.. c:function:: int close(int fd)
- :name: dvb-audio-close
-
Arguments
---------
@@ -27,20 +26,17 @@ Arguments
:header-rows: 0
:stub-columns: 0
-
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
-
Description
-----------
This system call closes a previously opened audio device.
-
Return Value
------------
@@ -48,7 +44,6 @@ Return Value
:header-rows: 0
:stub-columns: 0
-
- .. row 1
- ``EBADF``
diff --git a/Documentation/userspace-api/media/dvb/audio-fopen.rst b/Documentation/userspace-api/media/dvb/audio-fopen.rst
index d34001e038dc..774daaab3bad 100644
--- a/Documentation/userspace-api/media/dvb/audio-fopen.rst
+++ b/Documentation/userspace-api/media/dvb/audio-fopen.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+.. c:namespace:: DTV.audio
.. _audio_fopen:
@@ -17,8 +18,6 @@ Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
- :name: dvb-audio-open
-
Arguments
---------
@@ -27,7 +26,6 @@ Arguments
:header-rows: 0
:stub-columns: 0
-
- .. row 1
- const char \*deviceName
@@ -60,7 +58,6 @@ Arguments
-
- (blocking mode is the default)
-
Description
-----------
@@ -78,7 +75,6 @@ fail, and an error code will be returned. If the Audio Device is opened
in O_RDONLY mode, the only ioctl call that can be used is
AUDIO_GET_STATUS. All other call will return with an error code.
-
Return Value
------------
@@ -88,7 +84,6 @@ Return Value
:header-rows: 0
:stub-columns: 0
-
- .. row 1
- ``ENODEV``
diff --git a/Documentation/userspace-api/media/dvb/audio-fwrite.rst b/Documentation/userspace-api/media/dvb/audio-fwrite.rst
index d17ec719e231..7b096ac2b6c4 100644
--- a/Documentation/userspace-api/media/dvb/audio-fwrite.rst
+++ b/