Commit 793e52d4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: docs: move DVB audio/video docs to staging 



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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 819fbd3d

Documentation/userspace-api/media/Makefile

+2 −8
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ 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 \

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)

Documentation/userspace-api/media/audio.h.rst.exceptions

deleted100644 → 0
+0 −19
Original line number Diff line number Diff line 
# 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`

Documentation/userspace-api/media/dvb/headers.rst

+0 −7
Original line number Diff line number Diff line
@@ -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

Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst

+0 −7
Original line number Diff line number Diff line
@@ -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

Documentation/userspace-api/media/video.h.rst.exceptions

deleted100644 → 0
+0 −39
Original line number Diff line number Diff line 
# 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`