Commit 96f69e0e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: add CEC header file to the documentation 



Adding the header file is interesting for several reasons:

1) It makes MC documentation consistend with other parts;
2) The header file can be used as a quick index to all API
   elements;
3) The cross-reference check helps to identify symbols that
   aren't documented.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 6a6e8090

Documentation/media/Makefile

+5 −1
Original line number Diff line number Diff line
@@ -2,10 +2,11 @@ 


PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl

UAPI = $(srctree)/include/uapi/linux

KAPI = $(srctree)/include/linux

SRC_DIR=$(srctree)/Documentation/media



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

	  videodev2.h.rst media.h.rst cec.h.rst



TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
@@ -49,5 +50,8 @@ $(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2. 
$(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PARSER} $(SRC_DIR)/media.h.rst.exceptions

	@$($(quiet)gen_rst)



$(BUILDDIR)/cec.h.rst: ${KAPI}/cec.h ${PARSER} $(SRC_DIR)/cec.h.rst.exceptions

	@$($(quiet)gen_rst)



cleandocs:

	-rm ${TARGETS}

Documentation/media/cec.h.rst.exceptions

0 → 100644
+492 −0
Original line number Diff line number Diff line 
# Ignore header name

ignore define _CEC_UAPI_H



# Rename some symbols, to avoid namespace conflicts

replace struct cec_event_state_change cec-event-state-change_s

replace struct cec_event_lost_msgs cec-event-lost-msgs_s

replace enum cec_mode_initiator cec-mode-initiator_e

replace enum cec_mode_follower cec-mode-follower_e



# define macros to ignore



ignore define CEC_MAX_MSG_SIZE

ignore define CEC_MAX_LOG_ADDRS



ignore define CEC_LOG_ADDR_MASK_TV

ignore define CEC_LOG_ADDR_MASK_RECORD

ignore define CEC_LOG_ADDR_MASK_TUNER

ignore define CEC_LOG_ADDR_MASK_PLAYBACK

ignore define CEC_LOG_ADDR_MASK_AUDIOSYSTEM

ignore define CEC_LOG_ADDR_MASK_BACKUP

ignore define CEC_LOG_ADDR_MASK_SPECIFIC

ignore define CEC_LOG_ADDR_MASK_UNREGISTERED



# Shouldn't them be documented?

ignore define CEC_LOG_ADDR_INVALID

ignore define CEC_PHYS_ADDR_INVALID



ignore define CEC_VENDOR_ID_NONE



ignore define CEC_MODE_INITIATOR_MSK

ignore define CEC_MODE_FOLLOWER_MSK



ignore define CEC_EVENT_FL_INITIAL_STATE



# Part of CEC 2.0 spec - shouldn't be documented too?

ignore define CEC_LOG_ADDR_TV

ignore define CEC_LOG_ADDR_RECORD_1

ignore define CEC_LOG_ADDR_RECORD_2

ignore define CEC_LOG_ADDR_TUNER_1

ignore define CEC_LOG_ADDR_PLAYBACK_1

ignore define CEC_LOG_ADDR_AUDIOSYSTEM

ignore define CEC_LOG_ADDR_TUNER_2

ignore define CEC_LOG_ADDR_TUNER_3

ignore define CEC_LOG_ADDR_PLAYBACK_2

ignore define CEC_LOG_ADDR_RECORD_3

ignore define CEC_LOG_ADDR_TUNER_4

ignore define CEC_LOG_ADDR_PLAYBACK_3

ignore define CEC_LOG_ADDR_BACKUP_1

ignore define CEC_LOG_ADDR_BACKUP_2

ignore define CEC_LOG_ADDR_SPECIFIC

ignore define CEC_LOG_ADDR_UNREGISTERED

ignore define CEC_LOG_ADDR_BROADCAST



# IMHO, those should also be documented



ignore define CEC_MSG_ACTIVE_SOURCE

ignore define CEC_MSG_IMAGE_VIEW_ON

ignore define CEC_MSG_TEXT_VIEW_ON



ignore define CEC_MSG_INACTIVE_SOURCE

ignore define CEC_MSG_REQUEST_ACTIVE_SOURCE

ignore define CEC_MSG_ROUTING_CHANGE

ignore define CEC_MSG_ROUTING_INFORMATION

ignore define CEC_MSG_SET_STREAM_PATH



ignore define CEC_MSG_STANDBY



ignore define CEC_MSG_RECORD_OFF

ignore define CEC_MSG_RECORD_ON



ignore define CEC_OP_RECORD_SRC_OWN

ignore define CEC_OP_RECORD_SRC_DIGITAL

ignore define CEC_OP_RECORD_SRC_ANALOG

ignore define CEC_OP_RECORD_SRC_EXT_PLUG

ignore define CEC_OP_RECORD_SRC_EXT_PHYS_ADDR



ignore define CEC_OP_SERVICE_ID_METHOD_BY_DIG_ID

ignore define CEC_OP_SERVICE_ID_METHOD_BY_CHANNEL



ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_GEN

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_GEN

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_GEN

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_BS

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_CS

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ARIB_T

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_CABLE

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_SAT

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_ATSC_T

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_C

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_S2

ignore define CEC_OP_DIG_SERVICE_BCAST_SYSTEM_DVB_T



ignore define CEC_OP_ANA_BCAST_TYPE_CABLE

ignore define CEC_OP_ANA_BCAST_TYPE_SATELLITE

ignore define CEC_OP_ANA_BCAST_TYPE_TERRESTRIAL



ignore define CEC_OP_BCAST_SYSTEM_PAL_BG

ignore define CEC_OP_BCAST_SYSTEM_SECAM_LQ

ignore define CEC_OP_BCAST_SYSTEM_PAL_M

ignore define CEC_OP_BCAST_SYSTEM_NTSC_M

ignore define CEC_OP_BCAST_SYSTEM_PAL_I

ignore define CEC_OP_BCAST_SYSTEM_SECAM_DK

ignore define CEC_OP_BCAST_SYSTEM_SECAM_BG

ignore define CEC_OP_BCAST_SYSTEM_SECAM_L

ignore define CEC_OP_BCAST_SYSTEM_PAL_DK

ignore define CEC_OP_BCAST_SYSTEM_OTHER



ignore define CEC_OP_CHANNEL_NUMBER_FMT_1_PART

ignore define CEC_OP_CHANNEL_NUMBER_FMT_2_PART



ignore define CEC_MSG_RECORD_STATUS



ignore define CEC_OP_RECORD_STATUS_CUR_SRC

ignore define CEC_OP_RECORD_STATUS_DIG_SERVICE

ignore define CEC_OP_RECORD_STATUS_ANA_SERVICE

ignore define CEC_OP_RECORD_STATUS_EXT_INPUT

ignore define CEC_OP_RECORD_STATUS_NO_DIG_SERVICE

ignore define CEC_OP_RECORD_STATUS_NO_ANA_SERVICE

ignore define CEC_OP_RECORD_STATUS_NO_SERVICE

ignore define CEC_OP_RECORD_STATUS_INVALID_EXT_PLUG

ignore define CEC_OP_RECORD_STATUS_INVALID_EXT_PHYS_ADDR

ignore define CEC_OP_RECORD_STATUS_UNSUP_CA

ignore define CEC_OP_RECORD_STATUS_NO_CA_ENTITLEMENTS

ignore define CEC_OP_RECORD_STATUS_CANT_COPY_SRC

ignore define CEC_OP_RECORD_STATUS_NO_MORE_COPIES

ignore define CEC_OP_RECORD_STATUS_NO_MEDIA

ignore define CEC_OP_RECORD_STATUS_PLAYING

ignore define CEC_OP_RECORD_STATUS_ALREADY_RECORDING

ignore define CEC_OP_RECORD_STATUS_MEDIA_PROT

ignore define CEC_OP_RECORD_STATUS_NO_SIGNAL

ignore define CEC_OP_RECORD_STATUS_MEDIA_PROBLEM

ignore define CEC_OP_RECORD_STATUS_NO_SPACE

ignore define CEC_OP_RECORD_STATUS_PARENTAL_LOCK

ignore define CEC_OP_RECORD_STATUS_TERMINATED_OK

ignore define CEC_OP_RECORD_STATUS_ALREADY_TERM

ignore define CEC_OP_RECORD_STATUS_OTHER



ignore define CEC_MSG_RECORD_TV_SCREEN



ignore define CEC_MSG_CLEAR_ANALOGUE_TIMER



ignore define CEC_OP_REC_SEQ_SUNDAY

ignore define CEC_OP_REC_SEQ_MONDAY

ignore define CEC_OP_REC_SEQ_TUESDAY

ignore define CEC_OP_REC_SEQ_WEDNESDAY

ignore define CEC_OP_REC_SEQ_THURSDAY

ignore define CEC_OP_REC_SEQ_FRIDAY

ignore define CEC_OP_REC_SEQ_SATERDAY

ignore define CEC_OP_REC_SEQ_ONCE_ONLY



ignore define CEC_MSG_CLEAR_DIGITAL_TIMER



ignore define CEC_MSG_CLEAR_EXT_TIMER



ignore define CEC_OP_EXT_SRC_PLUG

ignore define CEC_OP_EXT_SRC_PHYS_ADDR



ignore define CEC_MSG_SET_ANALOGUE_TIMER

ignore define CEC_MSG_SET_DIGITAL_TIMER

ignore define CEC_MSG_SET_EXT_TIMER



ignore define CEC_MSG_SET_TIMER_PROGRAM_TITLE

ignore define CEC_MSG_TIMER_CLEARED_STATUS



ignore define CEC_OP_TIMER_CLR_STAT_RECORDING

ignore define CEC_OP_TIMER_CLR_STAT_NO_MATCHING

ignore define CEC_OP_TIMER_CLR_STAT_NO_INFO

ignore define CEC_OP_TIMER_CLR_STAT_CLEARED



ignore define CEC_MSG_TIMER_STATUS



ignore define CEC_OP_TIMER_OVERLAP_WARNING_NO_OVERLAP

ignore define CEC_OP_TIMER_OVERLAP_WARNING_OVERLAP



ignore define CEC_OP_MEDIA_INFO_UNPROT_MEDIA

ignore define CEC_OP_MEDIA_INFO_PROT_MEDIA

ignore define CEC_OP_MEDIA_INFO_NO_MEDIA



ignore define CEC_OP_PROG_IND_NOT_PROGRAMMED

ignore define CEC_OP_PROG_IND_PROGRAMMED



ignore define CEC_OP_PROG_INFO_ENOUGH_SPACE

ignore define CEC_OP_PROG_INFO_NOT_ENOUGH_SPACE

ignore define CEC_OP_PROG_INFO_MIGHT_NOT_BE_ENOUGH_SPACE

ignore define CEC_OP_PROG_INFO_NONE_AVAILABLE



ignore define CEC_OP_PROG_ERROR_NO_FREE_TIMER

ignore define CEC_OP_PROG_ERROR_DATE_OUT_OF_RANGE

ignore define CEC_OP_PROG_ERROR_REC_SEQ_ERROR

ignore define CEC_OP_PROG_ERROR_INV_EXT_PLUG

ignore define CEC_OP_PROG_ERROR_INV_EXT_PHYS_ADDR

ignore define CEC_OP_PROG_ERROR_CA_UNSUPP

ignore define CEC_OP_PROG_ERROR_INSUF_CA_ENTITLEMENTS

ignore define CEC_OP_PROG_ERROR_RESOLUTION_UNSUPP

ignore define CEC_OP_PROG_ERROR_PARENTAL_LOCK

ignore define CEC_OP_PROG_ERROR_CLOCK_FAILURE

ignore define CEC_OP_PROG_ERROR_DUPLICATE



ignore define CEC_MSG_CEC_VERSION



ignore define CEC_OP_CEC_VERSION_1_3A

ignore define CEC_OP_CEC_VERSION_1_4

ignore define CEC_OP_CEC_VERSION_2_0



ignore define CEC_MSG_GET_CEC_VERSION

ignore define CEC_MSG_GIVE_PHYSICAL_ADDR

ignore define CEC_MSG_GET_MENU_LANGUAGE

ignore define CEC_MSG_REPORT_PHYSICAL_ADDR



ignore define CEC_OP_PRIM_DEVTYPE_TV

ignore define CEC_OP_PRIM_DEVTYPE_RECORD

ignore define CEC_OP_PRIM_DEVTYPE_TUNER

ignore define CEC_OP_PRIM_DEVTYPE_PLAYBACK

ignore define CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM

ignore define CEC_OP_PRIM_DEVTYPE_SWITCH

ignore define CEC_OP_PRIM_DEVTYPE_PROCESSOR



ignore define CEC_MSG_SET_MENU_LANGUAGE

ignore define CEC_MSG_REPORT_FEATURES



ignore define CEC_OP_ALL_DEVTYPE_TV

ignore define CEC_OP_ALL_DEVTYPE_RECORD

ignore define CEC_OP_ALL_DEVTYPE_TUNER

ignore define CEC_OP_ALL_DEVTYPE_PLAYBACK

ignore define CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM

ignore define CEC_OP_ALL_DEVTYPE_SWITCH



ignore define CEC_OP_FEAT_EXT



ignore define CEC_OP_FEAT_RC_TV_PROFILE_NONE

ignore define CEC_OP_FEAT_RC_TV_PROFILE_1

ignore define CEC_OP_FEAT_RC_TV_PROFILE_2

ignore define CEC_OP_FEAT_RC_TV_PROFILE_3

ignore define CEC_OP_FEAT_RC_TV_PROFILE_4

ignore define CEC_OP_FEAT_RC_SRC_HAS_DEV_ROOT_MENU

ignore define CEC_OP_FEAT_RC_SRC_HAS_DEV_SETUP_MENU

ignore define CEC_OP_FEAT_RC_SRC_HAS_CONTENTS_MENU

ignore define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_TOP_MENU

ignore define CEC_OP_FEAT_RC_SRC_HAS_MEDIA_CONTEXT_MENU



ignore define CEC_OP_FEAT_DEV_HAS_RECORD_TV_SCREEN

ignore define CEC_OP_FEAT_DEV_HAS_SET_OSD_STRING

ignore define CEC_OP_FEAT_DEV_HAS_DECK_CONTROL

ignore define CEC_OP_FEAT_DEV_HAS_SET_AUDIO_RATE

ignore define CEC_OP_FEAT_DEV_SINK_HAS_ARC_TX

ignore define CEC_OP_FEAT_DEV_SOURCE_HAS_ARC_RX



ignore define CEC_MSG_GIVE_FEATURES



ignore define CEC_MSG_DECK_CONTROL



ignore define CEC_OP_DECK_CTL_MODE_SKIP_FWD

ignore define CEC_OP_DECK_CTL_MODE_SKIP_REV

ignore define CEC_OP_DECK_CTL_MODE_STOP

ignore define CEC_OP_DECK_CTL_MODE_EJECT



ignore define CEC_MSG_DECK_STATUS



ignore define CEC_OP_DECK_INFO_PLAY

ignore define CEC_OP_DECK_INFO_RECORD

ignore define CEC_OP_DECK_INFO_PLAY_REV

ignore define CEC_OP_DECK_INFO_STILL

ignore define CEC_OP_DECK_INFO_SLOW

ignore define CEC_OP_DECK_INFO_SLOW_REV

ignore define CEC_OP_DECK_INFO_FAST_FWD

ignore define CEC_OP_DECK_INFO_FAST_REV

ignore define CEC_OP_DECK_INFO_NO_MEDIA

ignore define CEC_OP_DECK_INFO_STOP

ignore define CEC_OP_DECK_INFO_SKIP_FWD

ignore define CEC_OP_DECK_INFO_SKIP_REV

ignore define CEC_OP_DECK_INFO_INDEX_SEARCH_FWD

ignore define CEC_OP_DECK_INFO_INDEX_SEARCH_REV

ignore define CEC_OP_DECK_INFO_OTHER



ignore define CEC_MSG_GIVE_DECK_STATUS



ignore define CEC_OP_STATUS_REQ_ON

ignore define CEC_OP_STATUS_REQ_OFF

ignore define CEC_OP_STATUS_REQ_ONCE



ignore define CEC_MSG_PLAY



ignore define CEC_OP_PLAY_MODE_PLAY_FWD

ignore define CEC_OP_PLAY_MODE_PLAY_REV

ignore define CEC_OP_PLAY_MODE_PLAY_STILL

ignore define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MIN

ignore define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MED

ignore define CEC_OP_PLAY_MODE_PLAY_FAST_FWD_MAX

ignore define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MIN

ignore define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MED

ignore define CEC_OP_PLAY_MODE_PLAY_FAST_REV_MAX

ignore define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MIN

ignore define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MED

ignore define CEC_OP_PLAY_MODE_PLAY_SLOW_FWD_MAX

ignore define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MIN

ignore define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MED

ignore define CEC_OP_PLAY_MODE_PLAY_SLOW_REV_MAX



ignore define CEC_MSG_GIVE_TUNER_DEVICE_STATUS

ignore define CEC_MSG_SELECT_ANALOGUE_SERVICE

ignore define CEC_MSG_SELECT_DIGITAL_SERVICE

ignore define CEC_MSG_TUNER_DEVICE_STATUS



ignore define CEC_OP_REC_FLAG_USED

ignore define CEC_OP_REC_FLAG_NOT_USED



ignore define CEC_OP_TUNER_DISPLAY_INFO_DIGITAL

ignore define CEC_OP_TUNER_DISPLAY_INFO_NONE

ignore define CEC_OP_TUNER_DISPLAY_INFO_ANALOGUE



ignore define CEC_MSG_TUNER_STEP_DECREMENT

ignore define CEC_MSG_TUNER_STEP_INCREMENT



ignore define CEC_MSG_DEVICE_VENDOR_ID

ignore define CEC_MSG_GIVE_DEVICE_VENDOR_ID

ignore define CEC_MSG_VENDOR_COMMAND

ignore define CEC_MSG_VENDOR_COMMAND_WITH_ID

ignore define CEC_MSG_VENDOR_REMOTE_BUTTON_DOWN

ignore define CEC_MSG_VENDOR_REMOTE_BUTTON_UP



ignore define CEC_MSG_SET_OSD_STRING



ignore define CEC_OP_DISP_CTL_DEFAULT

ignore define CEC_OP_DISP_CTL_UNTIL_CLEARED

ignore define CEC_OP_DISP_CTL_CLEAR



ignore define CEC_MSG_GIVE_OSD_NAME

ignore define CEC_MSG_SET_OSD_NAME



ignore define CEC_MSG_MENU_REQUEST



ignore define CEC_OP_MENU_REQUEST_ACTIVATE

ignore define CEC_OP_MENU_REQUEST_DEACTIVATE

ignore define CEC_OP_MENU_REQUEST_QUERY



ignore define CEC_MSG_MENU_STATUS



ignore define CEC_OP_MENU_STATE_ACTIVATED

ignore define CEC_OP_MENU_STATE_DEACTIVATED



ignore define CEC_MSG_USER_CONTROL_PRESSED



ignore define CEC_OP_UI_BCAST_TYPE_TOGGLE_ALL

ignore define CEC_OP_UI_BCAST_TYPE_TOGGLE_DIG_ANA

ignore define CEC_OP_UI_BCAST_TYPE_ANALOGUE

ignore define CEC_OP_UI_BCAST_TYPE_ANALOGUE_T

ignore define CEC_OP_UI_BCAST_TYPE_ANALOGUE_CABLE

ignore define CEC_OP_UI_BCAST_TYPE_ANALOGUE_SAT

ignore define CEC_OP_UI_BCAST_TYPE_DIGITAL

ignore define CEC_OP_UI_BCAST_TYPE_DIGITAL_T

ignore define CEC_OP_UI_BCAST_TYPE_DIGITAL_CABLE

ignore define CEC_OP_UI_BCAST_TYPE_DIGITAL_SAT

ignore define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT

ignore define CEC_OP_UI_BCAST_TYPE_DIGITAL_COM_SAT2

ignore define CEC_OP_UI_BCAST_TYPE_IP



ignore define CEC_OP_UI_SND_PRES_CTL_DUAL_MONO

ignore define CEC_OP_UI_SND_PRES_CTL_KARAOKE

ignore define CEC_OP_UI_SND_PRES_CTL_DOWNMIX

ignore define CEC_OP_UI_SND_PRES_CTL_REVERB

ignore define CEC_OP_UI_SND_PRES_CTL_EQUALIZER

ignore define CEC_OP_UI_SND_PRES_CTL_BASS_UP

ignore define CEC_OP_UI_SND_PRES_CTL_BASS_NEUTRAL

ignore define CEC_OP_UI_SND_PRES_CTL_BASS_DOWN

ignore define CEC_OP_UI_SND_PRES_CTL_TREBLE_UP

ignore define CEC_OP_UI_SND_PRES_CTL_TREBLE_NEUTRAL

ignore define CEC_OP_UI_SND_PRES_CTL_TREBLE_DOWN



ignore define CEC_MSG_USER_CONTROL_RELEASED



ignore define CEC_MSG_GIVE_DEVICE_POWER_STATUS

ignore define CEC_MSG_REPORT_POWER_STATUS



ignore define CEC_OP_POWER_STATUS_ON

ignore define CEC_OP_POWER_STATUS_STANDBY

ignore define CEC_OP_POWER_STATUS_TO_ON

ignore define CEC_OP_POWER_STATUS_TO_STANDBY



ignore define CEC_MSG_FEATURE_ABORT



ignore define CEC_OP_ABORT_UNRECOGNIZED_OP

ignore define CEC_OP_ABORT_INCORRECT_MODE

ignore define CEC_OP_ABORT_NO_SOURCE

ignore define CEC_OP_ABORT_INVALID_OP

ignore define CEC_OP_ABORT_REFUSED

ignore define CEC_OP_ABORT_UNDETERMINED



ignore define CEC_MSG_ABORT



ignore define CEC_MSG_GIVE_AUDIO_STATUS

ignore define CEC_MSG_GIVE_SYSTEM_AUDIO_MODE_STATUS

ignore define CEC_MSG_REPORT_AUDIO_STATUS



ignore define CEC_OP_AUD_MUTE_STATUS_OFF

ignore define CEC_OP_AUD_MUTE_STATUS_ON



ignore define CEC_MSG_REPORT_SHORT_AUDIO_DESCRIPTOR

ignore define CEC_MSG_REQUEST_SHORT_AUDIO_DESCRIPTOR

ignore define CEC_MSG_SET_SYSTEM_AUDIO_MODE



ignore define CEC_OP_SYS_AUD_STATUS_OFF

ignore define CEC_OP_SYS_AUD_STATUS_ON



ignore define CEC_MSG_SYSTEM_AUDIO_MODE_REQUEST

ignore define CEC_MSG_SYSTEM_AUDIO_MODE_STATUS



ignore define CEC_OP_AUD_FMT_ID_CEA861

ignore define CEC_OP_AUD_FMT_ID_CEA861_CXT



ignore define CEC_MSG_SET_AUDIO_RATE



ignore define CEC_OP_AUD_RATE_OFF

ignore define CEC_OP_AUD_RATE_WIDE_STD

ignore define CEC_OP_AUD_RATE_WIDE_FAST

ignore define CEC_OP_AUD_RATE_WIDE_SLOW

ignore define CEC_OP_AUD_RATE_NARROW_STD

ignore define CEC_OP_AUD_RATE_NARROW_FAST

ignore define CEC_OP_AUD_RATE_NARROW_SLOW



ignore define CEC_MSG_INITIATE_ARC

ignore define CEC_MSG_REPORT_ARC_INITIATED

ignore define CEC_MSG_REPORT_ARC_TERMINATED

ignore define CEC_MSG_REQUEST_ARC_INITIATION

ignore define CEC_MSG_REQUEST_ARC_TERMINATION

ignore define CEC_MSG_TERMINATE_ARC



ignore define CEC_MSG_REQUEST_CURRENT_LATENCY

ignore define CEC_MSG_REPORT_CURRENT_LATENCY



ignore define CEC_OP_LOW_LATENCY_MODE_OFF

ignore define CEC_OP_LOW_LATENCY_MODE_ON



ignore define CEC_OP_AUD_OUT_COMPENSATED_NA

ignore define CEC_OP_AUD_OUT_COMPENSATED_DELAY

ignore define CEC_OP_AUD_OUT_COMPENSATED_NO_DELAY

ignore define CEC_OP_AUD_OUT_COMPENSATED_PARTIAL_DELAY



ignore define CEC_MSG_CDC_MESSAGE



ignore define CEC_MSG_CDC_HEC_INQUIRE_STATE

ignore define CEC_MSG_CDC_HEC_REPORT_STATE



ignore define CEC_OP_HEC_FUNC_STATE_NOT_SUPPORTED

ignore define CEC_OP_HEC_FUNC_STATE_INACTIVE

ignore define CEC_OP_HEC_FUNC_STATE_ACTIVE

ignore define CEC_OP_HEC_FUNC_STATE_ACTIVATION_FIELD



ignore define CEC_OP_HOST_FUNC_STATE_NOT_SUPPORTED

ignore define CEC_OP_HOST_FUNC_STATE_INACTIVE

ignore define CEC_OP_HOST_FUNC_STATE_ACTIVE



ignore define CEC_OP_ENC_FUNC_STATE_EXT_CON_NOT_SUPPORTED

ignore define CEC_OP_ENC_FUNC_STATE_EXT_CON_INACTIVE

ignore define CEC_OP_ENC_FUNC_STATE_EXT_CON_ACTIVE



ignore define CEC_OP_CDC_ERROR_CODE_NONE

ignore define CEC_OP_CDC_ERROR_CODE_CAP_UNSUPPORTED

ignore define CEC_OP_CDC_ERROR_CODE_WRONG_STATE

ignore define CEC_OP_CDC_ERROR_CODE_OTHER



ignore define CEC_OP_HEC_SUPPORT_NO

ignore define CEC_OP_HEC_SUPPORT_YES



ignore define CEC_OP_HEC_ACTIVATION_ON

ignore define CEC_OP_HEC_ACTIVATION_OFF



ignore define CEC_MSG_CDC_HEC_SET_STATE_ADJACENT

ignore define CEC_MSG_CDC_HEC_SET_STATE



ignore define CEC_OP_HEC_SET_STATE_DEACTIVATE

ignore define CEC_OP_HEC_SET_STATE_ACTIVATE



ignore define CEC_MSG_CDC_HEC_REQUEST_DEACTIVATION

ignore define CEC_MSG_CDC_HEC_NOTIFY_ALIVE

ignore define CEC_MSG_CDC_HEC_DISCOVER



ignore define CEC_MSG_CDC_HPD_SET_STATE



ignore define CEC_OP_HPD_STATE_CP_EDID_DISABLE

ignore define CEC_OP_HPD_STATE_CP_EDID_ENABLE

ignore define CEC_OP_HPD_STATE_CP_EDID_DISABLE_ENABLE

ignore define CEC_OP_HPD_STATE_EDID_DISABLE

ignore define CEC_OP_HPD_STATE_EDID_ENABLE

ignore define CEC_OP_HPD_STATE_EDID_DISABLE_ENABLE

ignore define CEC_MSG_CDC_HPD_REPORT_STATE



ignore define CEC_OP_HPD_ERROR_NONE

ignore define CEC_OP_HPD_ERROR_INITIATOR_NOT_CAPABLE

ignore define CEC_OP_HPD_ERROR_INITIATOR_WRONG_STATE

ignore define CEC_OP_HPD_ERROR_OTHER

ignore define CEC_OP_HPD_ERROR_NONE_NO_VIDEO

Documentation/media/uapi/cec/cec-api.rst

+1 −0
Original line number Diff line number Diff line
@@ -69,6 +69,7 @@ Function Reference 
    cec-ioc-dqevent

    cec-ioc-g-mode

    cec-ioc-receive

    cec-header





**********************

Documentation/media/uapi/cec/cec-header.rst

0 → 100644
+10 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _cec_header:



***************

CEC Header File

***************



.. kernel-include:: $BUILDDIR/cec.h.rst

Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst

+6 −6
Original line number Diff line number Diff line
@@ -93,7 +93,7 @@ returns the information to the application. The ioctl never fails. 
    :widths:       3 1 8





    -  .. _`CEC_CAP_PHYS_ADDR`:

    -  .. _`CEC-CAP-PHYS-ADDR`:



       -  ``CEC_CAP_PHYS_ADDR``
@@ -105,7 +105,7 @@ returns the information to the application. The ioctl never fails. 
          handled by the kernel whenever the EDID is set (for an HDMI

          receiver) or read (for an HDMI transmitter).



    -  .. _`CEC_CAP_LOG_ADDRS`:

    -  .. _`CEC-CAP-LOG-ADDRS`:



       -  ``CEC_CAP_LOG_ADDRS``
@@ -116,7 +116,7 @@ returns the information to the application. The ioctl never fails. 
          this capability isn't set, then the kernel will have configured

          this.



    -  .. _`CEC_CAP_TRANSMIT`:

    -  .. _`CEC-CAP-TRANSMIT`:



       -  ``CEC_CAP_TRANSMIT``
@@ -129,7 +129,7 @@ returns the information to the application. The ioctl never fails. 
          capability isn't set, then the kernel will handle all CEC

          transmits and process all CEC messages it receives.



    -  .. _`CEC_CAP_PASSTHROUGH`:

    -  .. _`CEC-CAP-PASSTHROUGH`:



       -  ``CEC_CAP_PASSTHROUGH``
@@ -138,7 +138,7 @@ returns the information to the application. The ioctl never fails. 
       -  Userspace can use the passthrough mode by calling

          :ref:`CEC_S_MODE`.



    -  .. _`CEC_CAP_RC`:

    -  .. _`CEC-CAP-RC`:



       -  ``CEC_CAP_RC``
@@ -146,7 +146,7 @@ returns the information to the application. The ioctl never fails. 


       -  This adapter supports the remote control protocol.



    -  .. _`CEC_CAP_MONITOR_ALL`:

    -  .. _`CEC-CAP-MONITOR-ALL`:



       -  ``CEC_CAP_MONITOR_ALL``