media: docs: move DVB audio/video docs to staging
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 1 Jun 2021 09:41:39 +0000 (11:41 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 4 Jun 2021 06:08:17 +0000 (08:08 +0200)
The only upstream driver using the API described there is the
av7110 driver.

As the driver was moved to staging, move the API bits to staging
as well.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
54 files changed:
Documentation/userspace-api/media/Makefile
Documentation/userspace-api/media/audio.h.rst.exceptions [deleted file]
Documentation/userspace-api/media/dvb/headers.rst
Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst
Documentation/userspace-api/media/video.h.rst.exceptions [deleted file]
drivers/staging/media/av7110/audio-bilingual-channel-select.rst [moved from Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst with 100% similarity]
drivers/staging/media/av7110/audio-channel-select.rst [moved from Documentation/userspace-api/media/dvb/audio-channel-select.rst with 100% similarity]
drivers/staging/media/av7110/audio-clear-buffer.rst [moved from Documentation/userspace-api/media/dvb/audio-clear-buffer.rst with 100% similarity]
drivers/staging/media/av7110/audio-continue.rst [moved from Documentation/userspace-api/media/dvb/audio-continue.rst with 100% similarity]
drivers/staging/media/av7110/audio-fclose.rst [moved from Documentation/userspace-api/media/dvb/audio-fclose.rst with 100% similarity]
drivers/staging/media/av7110/audio-fopen.rst [moved from Documentation/userspace-api/media/dvb/audio-fopen.rst with 100% similarity]
drivers/staging/media/av7110/audio-fwrite.rst [moved from Documentation/userspace-api/media/dvb/audio-fwrite.rst with 100% similarity]
drivers/staging/media/av7110/audio-get-capabilities.rst [moved from Documentation/userspace-api/media/dvb/audio-get-capabilities.rst with 100% similarity]
drivers/staging/media/av7110/audio-get-status.rst [moved from Documentation/userspace-api/media/dvb/audio-get-status.rst with 100% similarity]
drivers/staging/media/av7110/audio-pause.rst [moved from Documentation/userspace-api/media/dvb/audio-pause.rst with 100% similarity]
drivers/staging/media/av7110/audio-play.rst [moved from Documentation/userspace-api/media/dvb/audio-play.rst with 100% similarity]
drivers/staging/media/av7110/audio-select-source.rst [moved from Documentation/userspace-api/media/dvb/audio-select-source.rst with 100% similarity]
drivers/staging/media/av7110/audio-set-av-sync.rst [moved from Documentation/userspace-api/media/dvb/audio-set-av-sync.rst with 100% similarity]
drivers/staging/media/av7110/audio-set-bypass-mode.rst [moved from Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst with 100% similarity]
drivers/staging/media/av7110/audio-set-id.rst [moved from Documentation/userspace-api/media/dvb/audio-set-id.rst with 100% similarity]
drivers/staging/media/av7110/audio-set-mixer.rst [moved from Documentation/userspace-api/media/dvb/audio-set-mixer.rst with 100% similarity]
drivers/staging/media/av7110/audio-set-mute.rst [moved from Documentation/userspace-api/media/dvb/audio-set-mute.rst with 100% similarity]
drivers/staging/media/av7110/audio-set-streamtype.rst [moved from Documentation/userspace-api/media/dvb/audio-set-streamtype.rst with 100% similarity]
drivers/staging/media/av7110/audio-stop.rst [moved from Documentation/userspace-api/media/dvb/audio-stop.rst with 100% similarity]
drivers/staging/media/av7110/audio.rst [moved from Documentation/userspace-api/media/dvb/audio.rst with 100% similarity]
drivers/staging/media/av7110/audio_data_types.rst [moved from Documentation/userspace-api/media/dvb/audio_data_types.rst with 100% similarity]
drivers/staging/media/av7110/audio_function_calls.rst [moved from Documentation/userspace-api/media/dvb/audio_function_calls.rst with 100% similarity]
drivers/staging/media/av7110/video-clear-buffer.rst [moved from Documentation/userspace-api/media/dvb/video-clear-buffer.rst with 100% similarity]
drivers/staging/media/av7110/video-command.rst [moved from Documentation/userspace-api/media/dvb/video-command.rst with 100% similarity]
drivers/staging/media/av7110/video-continue.rst [moved from Documentation/userspace-api/media/dvb/video-continue.rst with 100% similarity]
drivers/staging/media/av7110/video-fast-forward.rst [moved from Documentation/userspace-api/media/dvb/video-fast-forward.rst with 100% similarity]
drivers/staging/media/av7110/video-fclose.rst [moved from Documentation/userspace-api/media/dvb/video-fclose.rst with 100% similarity]
drivers/staging/media/av7110/video-fopen.rst [moved from Documentation/userspace-api/media/dvb/video-fopen.rst with 100% similarity]
drivers/staging/media/av7110/video-freeze.rst [moved from Documentation/userspace-api/media/dvb/video-freeze.rst with 100% similarity]
drivers/staging/media/av7110/video-fwrite.rst [moved from Documentation/userspace-api/media/dvb/video-fwrite.rst with 100% similarity]
drivers/staging/media/av7110/video-get-capabilities.rst [moved from Documentation/userspace-api/media/dvb/video-get-capabilities.rst with 100% similarity]
drivers/staging/media/av7110/video-get-event.rst [moved from Documentation/userspace-api/media/dvb/video-get-event.rst with 100% similarity]
drivers/staging/media/av7110/video-get-frame-count.rst [moved from Documentation/userspace-api/media/dvb/video-get-frame-count.rst with 100% similarity]
drivers/staging/media/av7110/video-get-pts.rst [moved from Documentation/userspace-api/media/dvb/video-get-pts.rst with 100% similarity]
drivers/staging/media/av7110/video-get-size.rst [moved from Documentation/userspace-api/media/dvb/video-get-size.rst with 100% similarity]
drivers/staging/media/av7110/video-get-status.rst [moved from Documentation/userspace-api/media/dvb/video-get-status.rst with 100% similarity]
drivers/staging/media/av7110/video-play.rst [moved from Documentation/userspace-api/media/dvb/video-play.rst with 100% similarity]
drivers/staging/media/av7110/video-select-source.rst [moved from Documentation/userspace-api/media/dvb/video-select-source.rst with 100% similarity]
drivers/staging/media/av7110/video-set-blank.rst [moved from Documentation/userspace-api/media/dvb/video-set-blank.rst with 100% similarity]
drivers/staging/media/av7110/video-set-display-format.rst [moved from Documentation/userspace-api/media/dvb/video-set-display-format.rst with 100% similarity]
drivers/staging/media/av7110/video-set-format.rst [moved from Documentation/userspace-api/media/dvb/video-set-format.rst with 100% similarity]
drivers/staging/media/av7110/video-set-streamtype.rst [moved from Documentation/userspace-api/media/dvb/video-set-streamtype.rst with 100% similarity]
drivers/staging/media/av7110/video-slowmotion.rst [moved from Documentation/userspace-api/media/dvb/video-slowmotion.rst with 100% similarity]
drivers/staging/media/av7110/video-stillpicture.rst [moved from Documentation/userspace-api/media/dvb/video-stillpicture.rst with 100% similarity]
drivers/staging/media/av7110/video-stop.rst [moved from Documentation/userspace-api/media/dvb/video-stop.rst with 100% similarity]
drivers/staging/media/av7110/video-try-command.rst [moved from Documentation/userspace-api/media/dvb/video-try-command.rst with 100% similarity]
drivers/staging/media/av7110/video.rst [moved from Documentation/userspace-api/media/dvb/video.rst with 100% similarity]
drivers/staging/media/av7110/video_function_calls.rst [moved from Documentation/userspace-api/media/dvb/video_function_calls.rst with 100% similarity]
drivers/staging/media/av7110/video_types.rst [moved from Documentation/userspace-api/media/dvb/video_types.rst with 100% similarity]

index 81a4a1a..00922aa 100644 (file)
@@ -7,8 +7,8 @@ PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
 UAPI = $(srctree)/include/uapi/linux
 KAPI = $(srctree)/include/linux
 
-FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
-         videodev2.h.rst media.h.rst cec.h.rst lirc.h.rst
+FILES = ca.h.rst dmx.h.rst frontend.h.rst net.h.rst \
+       videodev2.h.rst media.h.rst cec.h.rst lirc.h.rst
 
 TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
 
@@ -21,9 +21,6 @@ quiet_gen_rst = echo '  PARSE   $(patsubst $(srctree)/%,%,$<)'; \
 
 silent_gen_rst = ${gen_rst}
 
-$(BUILDDIR)/audio.h.rst: ${UAPI}/dvb/audio.h ${PARSER} $(SRC_DIR)/audio.h.rst.exceptions
-       @$($(quiet)gen_rst)
-
 $(BUILDDIR)/ca.h.rst: ${UAPI}/dvb/ca.h ${PARSER} $(SRC_DIR)/ca.h.rst.exceptions
        @$($(quiet)gen_rst)
 
@@ -36,9 +33,6 @@ $(BUILDDIR)/frontend.h.rst: ${UAPI}/dvb/frontend.h ${PARSER} $(SRC_DIR)/frontend
 $(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PARSER} $(SRC_DIR)/net.h.rst.exceptions
        @$($(quiet)gen_rst)
 
-$(BUILDDIR)/video.h.rst: ${UAPI}/dvb/video.h ${PARSER} $(SRC_DIR)/video.h.rst.exceptions
-       @$($(quiet)gen_rst)
-
 $(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
        @$($(quiet)gen_rst)
 
diff --git a/Documentation/userspace-api/media/audio.h.rst.exceptions b/Documentation/userspace-api/media/audio.h.rst.exceptions
deleted file mode 100644 (file)
index cf66204..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0
-
-# Ignore header name
-ignore define _DVBAUDIO_H_
-
-# Undocumented audio caps, as this is a deprecated API anyway
-ignore define AUDIO_CAP_DTS
-ignore define AUDIO_CAP_LPCM
-ignore define AUDIO_CAP_MP1
-ignore define AUDIO_CAP_MP2
-ignore define AUDIO_CAP_MP3
-ignore define AUDIO_CAP_AAC
-ignore define AUDIO_CAP_OGG
-ignore define AUDIO_CAP_SDDS
-ignore define AUDIO_CAP_AC3
-
-# some typedefs should point to struct/enums
-replace typedef audio_mixer_t :c:type:`audio_mixer`
-replace typedef audio_status_t :c:type:`audio_status`
index 9743ffc..88c3eb3 100644 (file)
@@ -14,10 +14,3 @@ Digital TV uAPI headers
 .. kernel-include:: $BUILDDIR/ca.h.rst
 
 .. kernel-include:: $BUILDDIR/net.h.rst
-
-Legacy uAPI
-***********
-
-.. kernel-include:: $BUILDDIR/audio.h.rst
-
-.. kernel-include:: $BUILDDIR/video.h.rst
index 6104879..b97d56e 100644 (file)
@@ -11,11 +11,6 @@ The APIs described here **should not** be used on new drivers or applications.
 The DVBv3 frontend API has issues with new delivery systems, including
 DVB-S2, DVB-T2, ISDB, etc.
 
-There's just one driver for a very legacy hardware using the Digital TV
-audio and video APIs. No modern drivers should use it. Instead, audio and
-video should be using the V4L2 and ALSA APIs, and the pipelines should
-be set via the Media Controller API.
-
 .. attention::
 
    The APIs described here doesn't necessarily reflect the current
@@ -28,5 +23,3 @@ be set via the Media Controller API.
     :maxdepth: 1
 
     frontend_legacy_dvbv3_api
-    video
-    audio
diff --git a/Documentation/userspace-api/media/video.h.rst.exceptions b/Documentation/userspace-api/media/video.h.rst.exceptions
deleted file mode 100644 (file)
index ea9de59..0000000
+++ /dev/null
@@ -1,39 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0
-
-# Ignore header name
-ignore define _UAPI_DVBVIDEO_H_
-
-# This is a deprecated obscure API. Just ignore things we don't know
-ignore define VIDEO_CMD_PLAY
-ignore define VIDEO_CMD_STOP
-ignore define VIDEO_CMD_FREEZE
-ignore define VIDEO_CMD_CONTINUE
-ignore define VIDEO_CMD_FREEZE_TO_BLACK
-ignore define VIDEO_CMD_STOP_TO_BLACK
-ignore define VIDEO_CMD_STOP_IMMEDIATELY
-ignore define VIDEO_PLAY_FMT_NONE
-ignore define VIDEO_PLAY_FMT_GOP
-ignore define VIDEO_VSYNC_FIELD_UNKNOWN
-ignore define VIDEO_VSYNC_FIELD_ODD
-ignore define VIDEO_VSYNC_FIELD_EVEN
-ignore define VIDEO_VSYNC_FIELD_PROGRESSIVE
-ignore define VIDEO_EVENT_SIZE_CHANGED
-ignore define VIDEO_EVENT_FRAME_RATE_CHANGED
-ignore define VIDEO_EVENT_DECODER_STOPPED
-ignore define VIDEO_EVENT_VSYNC
-ignore define VIDEO_CAP_MPEG1
-ignore define VIDEO_CAP_MPEG2
-ignore define VIDEO_CAP_SYS
-ignore define VIDEO_CAP_PROG
-ignore define VIDEO_CAP_SPU
-ignore define VIDEO_CAP_NAVI
-ignore define VIDEO_CAP_CSS
-
-# some typedefs should point to struct/enums
-replace typedef video_format_t :c:type:`video_format`
-replace typedef video_system_t :c:type:`video_system`
-replace typedef video_displayformat_t :c:type:`video_displayformat`
-replace typedef video_size_t :c:type:`video_size`
-replace typedef video_stream_source_t :c:type:`video_stream_source`
-replace typedef video_play_state_t :c:type:`video_play_state`
-replace typedef video_navi_pack_t :c:type:`video_navi_pack`