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

[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
...@@ -2,10 +2,11 @@ ...@@ -2,10 +2,11 @@
PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
UAPI = $(srctree)/include/uapi/linux UAPI = $(srctree)/include/uapi/linux
KAPI = $(srctree)/include/linux
SRC_DIR=$(srctree)/Documentation/media SRC_DIR=$(srctree)/Documentation/media
FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \ 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)) TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
...@@ -49,5 +50,8 @@ $(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2. ...@@ -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 $(BUILDDIR)/media.h.rst: ${UAPI}/media.h ${PARSER} $(SRC_DIR)/media.h.rst.exceptions
@$($(quiet)gen_rst) @$($(quiet)gen_rst)
$(BUILDDIR)/cec.h.rst: ${KAPI}/cec.h ${PARSER} $(SRC_DIR)/cec.h.rst.exceptions
@$($(quiet)gen_rst)
cleandocs: cleandocs:
-rm ${TARGETS} -rm ${TARGETS}
This diff is collapsed.
...@@ -69,6 +69,7 @@ Function Reference ...@@ -69,6 +69,7 @@ Function Reference
cec-ioc-dqevent cec-ioc-dqevent
cec-ioc-g-mode cec-ioc-g-mode
cec-ioc-receive cec-ioc-receive
cec-header
********************** **********************
......
.. -*- coding: utf-8; mode: rst -*-
.. _cec_header:
***************
CEC Header File
***************
.. kernel-include:: $BUILDDIR/cec.h.rst
...@@ -93,7 +93,7 @@ returns the information to the application. The ioctl never fails. ...@@ -93,7 +93,7 @@ returns the information to the application. The ioctl never fails.
:widths: 3 1 8 :widths: 3 1 8
- .. _`CEC_CAP_PHYS_ADDR`: - .. _`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. ...@@ -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 handled by the kernel whenever the EDID is set (for an HDMI
receiver) or read (for an HDMI transmitter). receiver) or read (for an HDMI transmitter).
- .. _`CEC_CAP_LOG_ADDRS`: - .. _`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. ...@@ -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 capability isn't set, then the kernel will have configured
this. this.
- .. _`CEC_CAP_TRANSMIT`: - .. _`CEC-CAP-TRANSMIT`:
- ``CEC_CAP_TRANSMIT`` - ``CEC_CAP_TRANSMIT``
...@@ -129,7 +129,7 @@ returns the information to the application. The ioctl never fails. ...@@ -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 capability isn't set, then the kernel will handle all CEC
transmits and process all CEC messages it receives. transmits and process all CEC messages it receives.
- .. _`CEC_CAP_PASSTHROUGH`: - .. _`CEC-CAP-PASSTHROUGH`:
- ``CEC_CAP_PASSTHROUGH`` - ``CEC_CAP_PASSTHROUGH``
...@@ -138,7 +138,7 @@ returns the information to the application. The ioctl never fails. ...@@ -138,7 +138,7 @@ returns the information to the application. The ioctl never fails.
- Userspace can use the passthrough mode by calling - Userspace can use the passthrough mode by calling
:ref:`CEC_S_MODE`. :ref:`CEC_S_MODE`.
- .. _`CEC_CAP_RC`: - .. _`CEC-CAP-RC`:
- ``CEC_CAP_RC`` - ``CEC_CAP_RC``
...@@ -146,7 +146,7 @@ returns the information to the application. The ioctl never fails. ...@@ -146,7 +146,7 @@ returns the information to the application. The ioctl never fails.
- This adapter supports the remote control protocol. - This adapter supports the remote control protocol.
- .. _`CEC_CAP_MONITOR_ALL`: - .. _`CEC-CAP-MONITOR-ALL`:
- ``CEC_CAP_MONITOR_ALL`` - ``CEC_CAP_MONITOR_ALL``
......
...@@ -93,7 +93,7 @@ by a file handle in initiator mode (see ...@@ -93,7 +93,7 @@ by a file handle in initiator mode (see
- The CEC version that this adapter shall use. See - The CEC version that this adapter shall use. See
:ref:`cec-versions`. Used to implement the :ref:`cec-versions`. Used to implement the
``CEC_MSG_CEC_VERSION`` and ``CEC_MSG_REPORT_FEATURES`` messages. ``CEC_MSG_CEC_VERSION`` and ``CEC_MSG_REPORT_FEATURES`` messages.
Note that :ref:`CEC_OP_CEC_VERSION_1_3A <CEC_OP_CEC_VERSION_1_3A>` is not allowed by the CEC Note that :ref:`CEC_OP_CEC_VERSION_1_3A <CEC-OP-CEC-VERSION-1-3A>` is not allowed by the CEC
framework. framework.
- .. row 4 - .. row 4
...@@ -161,7 +161,7 @@ by a file handle in initiator mode (see ...@@ -161,7 +161,7 @@ by a file handle in initiator mode (see
- Logical address types. See :ref:`cec-log-addr-types` for - Logical address types. See :ref:`cec-log-addr-types` for
possible types. The driver will update this with the actual possible types. The driver will update this with the actual
logical address type that it claimed (e.g. it may have to fallback logical address type that it claimed (e.g. it may have to fallback
to :ref:`CEC_LOG_ADDR_TYPE_UNREGISTERED <CEC_LOG_ADDR_TYPE_UNREGISTERED>`). to :ref:`CEC_LOG_ADDR_TYPE_UNREGISTERED <CEC-LOG-ADDR-TYPE-UNREGISTERED>`).
- .. row 10 - .. row 10
...@@ -172,7 +172,7 @@ by a file handle in initiator mode (see ...@@ -172,7 +172,7 @@ by a file handle in initiator mode (see
- CEC 2.0 specific: all device types. See - CEC 2.0 specific: all device types. See
:ref:`cec-all-dev-types-flags`. Used to implement the :ref:`cec-all-dev-types-flags`. Used to implement the
``CEC_MSG_REPORT_FEATURES`` message. This field is ignored if ``CEC_MSG_REPORT_FEATURES`` message. This field is ignored if
``cec_version`` < :ref:`CEC_OP_CEC_VERSION_2_0 <CEC_OP_CEC_VERSION_2_0>`. ``cec_version`` < :ref:`CEC_OP_CEC_VERSION_2_0 <CEC-OP-CEC-VERSION-2-0>`.
- .. row 11 - .. row 11
...@@ -183,7 +183,7 @@ by a file handle in initiator mode (see ...@@ -183,7 +183,7 @@ by a file handle in initiator mode (see
- Features for each logical address. Used to implement the - Features for each logical address. Used to implement the
``CEC_MSG_REPORT_FEATURES`` message. The 12 bytes include both the ``CEC_MSG_REPORT_FEATURES`` message. The 12 bytes include both the
RC Profile and the Device Features. This field is ignored if RC Profile and the Device Features. This field is ignored if
``cec_version`` < :ref:`CEC_OP_CEC_VERSION_2_0 <CEC_OP_CEC_VERSION_2_0>`. ``cec_version`` < :ref:`CEC_OP_CEC_VERSION_2_0 <CEC-OP-CEC-VERSION-2-0>`.
...@@ -195,7 +195,7 @@ by a file handle in initiator mode (see ...@@ -195,7 +195,7 @@ by a file handle in initiator mode (see
:widths: 3 1 4 :widths: 3 1 4
- .. _`CEC_OP_CEC_VERSION_1_3A`: - .. _`CEC-OP-CEC-VERSION-1-3A`:
- ``CEC_OP_CEC_VERSION_1_3A`` - ``CEC_OP_CEC_VERSION_1_3A``
...@@ -203,7 +203,7 @@ by a file handle in initiator mode (see ...@@ -203,7 +203,7 @@ by a file handle in initiator mode (see
- CEC version according to the HDMI 1.3a standard. - CEC version according to the HDMI 1.3a standard.
- .. _`CEC_OP_CEC_VERSION_1_4B`: - .. _`CEC-OP-CEC-VERSION-1-4B`:
- ``CEC_OP_CEC_VERSION_1_4B`` - ``CEC_OP_CEC_VERSION_1_4B``
...@@ -211,7 +211,7 @@ by a file handle in initiator mode (see ...@@ -211,7 +211,7 @@ by a file handle in initiator mode (see
- CEC version according to the HDMI 1.4b standard. - CEC version according to the HDMI 1.4b standard.
- .. _`CEC_OP_CEC_VERSION_2_0`: - .. _`CEC-OP-CEC-VERSION-2-0`:
- ``CEC_OP_CEC_VERSION_2_0`` - ``CEC_OP_CEC_VERSION_2_0``
...@@ -229,7 +229,7 @@ by a file handle in initiator mode (see ...@@ -229,7 +229,7 @@ by a file handle in initiator mode (see
:widths: 3 1 4 :widths: 3 1 4
- .. _`CEC_OP_PRIM_DEVTYPE_TV`: - .. _`CEC-OP-PRIM-DEVTYPE-TV`:
- ``CEC_OP_PRIM_DEVTYPE_TV`` - ``CEC_OP_PRIM_DEVTYPE_TV``
...@@ -237,7 +237,7 @@ by a file handle in initiator mode (see ...@@ -237,7 +237,7 @@ by a file handle in initiator mode (see
- Use for a TV. - Use for a TV.
- .. _`CEC_OP_PRIM_DEVTYPE_RECORD`: - .. _`CEC-OP-PRIM-DEVTYPE-RECORD`:
- ``CEC_OP_PRIM_DEVTYPE_RECORD`` - ``CEC_OP_PRIM_DEVTYPE_RECORD``
...@@ -245,7 +245,7 @@ by a file handle in initiator mode (see ...@@ -245,7 +245,7 @@ by a file handle in initiator mode (see
- Use for a recording device. - Use for a recording device.
- .. _`CEC_OP_PRIM_DEVTYPE_TUNER`: - .. _`CEC-OP-PRIM-DEVTYPE-TUNER`:
- ``CEC_OP_PRIM_DEVTYPE_TUNER`` - ``CEC_OP_PRIM_DEVTYPE_TUNER``
...@@ -253,7 +253,7 @@ by a file handle in initiator mode (see ...@@ -253,7 +253,7 @@ by a file handle in initiator mode (see
- Use for a device with a tuner. - Use for a device with a tuner.
- .. _`CEC_OP_PRIM_DEVTYPE_PLAYBACK`: - .. _`CEC-OP-PRIM-DEVTYPE-PLAYBACK`:
- ``CEC_OP_PRIM_DEVTYPE_PLAYBACK`` - ``CEC_OP_PRIM_DEVTYPE_PLAYBACK``
...@@ -261,7 +261,7 @@ by a file handle in initiator mode (see ...@@ -261,7 +261,7 @@ by a file handle in initiator mode (see
- Use for a playback device. - Use for a playback device.
- .. _`CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM`: - .. _`CEC-OP-PRIM-DEVTYPE-AUDIOSYSTEM`:
- ``CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM`` - ``CEC_OP_PRIM_DEVTYPE_AUDIOSYSTEM``
...@@ -269,7 +269,7 @@ by a file handle in initiator mode (see ...@@ -269,7 +269,7 @@ by a file handle in initiator mode (see
- Use for an audio system (e.g. an audio/video receiver). - Use for an audio system (e.g. an audio/video receiver).
- .. _`CEC_OP_PRIM_DEVTYPE_SWITCH`: - .. _`CEC-OP-PRIM-DEVTYPE-SWITCH`:
- ``CEC_OP_PRIM_DEVTYPE_SWITCH`` - ``CEC_OP_PRIM_DEVTYPE_SWITCH``
...@@ -277,7 +277,7 @@ by a file handle in initiator mode (see ...@@ -277,7 +277,7 @@ by a file handle in initiator mode (see
- Use for a CEC switch. - Use for a CEC switch.
- .. _`CEC_OP_PRIM_DEVTYPE_VIDEOPROC`: - .. _`CEC-OP-PRIM-DEVTYPE-VIDEOPROC`:
- ``CEC_OP_PRIM_DEVTYPE_VIDEOPROC`` - ``CEC_OP_PRIM_DEVTYPE_VIDEOPROC``
...@@ -295,7 +295,7 @@ by a file handle in initiator mode (see ...@@ -295,7 +295,7 @@ by a file handle in initiator mode (see
:widths: 3 1 16 :widths: 3 1 16
- .. _`CEC_LOG_ADDR_TYPE_TV`: - .. _`CEC-LOG-ADDR-TYPE-TV`:
- ``CEC_LOG_ADDR_TYPE_TV`` - ``CEC_LOG_ADDR_TYPE_TV``
...@@ -303,7 +303,7 @@ by a file handle in initiator mode (see ...@@ -303,7 +303,7 @@ by a file handle in initiator mode (see
- Use for a TV. - Use for a TV.
- .. _`CEC_LOG_ADDR_TYPE_RECORD`: - .. _`CEC-LOG-ADDR-TYPE-RECORD`:
- ``CEC_LOG_ADDR_TYPE_RECORD`` - ``CEC_LOG_ADDR_TYPE_RECORD``
...@@ -311,7 +311,7 @@ by a file handle in initiator mode (see ...@@ -311,7 +311,7 @@ by a file handle in initiator mode (see
- Use for a recording device. - Use for a recording device.
- .. _`CEC_LOG_ADDR_TYPE_TUNER`: - .. _`CEC-LOG-ADDR-TYPE-TUNER`:
- ``CEC_LOG_ADDR_TYPE_TUNER`` - ``CEC_LOG_ADDR_TYPE_TUNER``
...@@ -319,7 +319,7 @@ by a file handle in initiator mode (see ...@@ -319,7 +319,7 @@ by a file handle in initiator mode (see
- Use for a tuner device. - Use for a tuner device.
- .. _`CEC_LOG_ADDR_TYPE_PLAYBACK`: - .. _`CEC-LOG-ADDR-TYPE-PLAYBACK`:
- ``CEC_LOG_ADDR_TYPE_PLAYBACK`` - ``CEC_LOG_ADDR_TYPE_PLAYBACK``
...@@ -327,7 +327,7 @@ by a file handle in initiator mode (see ...@@ -327,7 +327,7 @@ by a file handle in initiator mode (see
- Use for a playback device. - Use for a playback device.
- .. _`CEC_LOG_ADDR_TYPE_AUDIOSYSTEM`: - .. _`CEC-LOG-ADDR-TYPE-AUDIOSYSTEM`:
- ``CEC_LOG_ADDR_TYPE_AUDIOSYSTEM`` - ``CEC_LOG_ADDR_TYPE_AUDIOSYSTEM``
...@@ -335,7 +335,7 @@ by a file handle in initiator mode (see ...@@ -335,7 +335,7 @@ by a file handle in initiator mode (see
- Use for an audio system device. - Use for an audio system device.
- .. _`CEC_LOG_ADDR_TYPE_SPECIFIC`: - .. _`CEC-LOG-ADDR-TYPE-SPECIFIC`:
- ``CEC_LOG_ADDR_TYPE_SPECIFIC`` - ``CEC_LOG_ADDR_TYPE_SPECIFIC``
...@@ -343,7 +343,7 @@ by a file handle in initiator mode (see ...@@ -343,7 +343,7 @@ by a file handle in initiator mode (see
- Use for a second TV or for a video processor device. - Use for a second TV or for a video processor device.
- .. _`CEC_LOG_ADDR_TYPE_UNREGISTERED`: - .. _`CEC-LOG-ADDR-TYPE-UNREGISTERED`:
- ``CEC_LOG_ADDR_TYPE_UNREGISTERED`` - ``CEC_LOG_ADDR_TYPE_UNREGISTERED``
...@@ -363,7 +363,7 @@ by a file handle in initiator mode (see ...@@ -363,7 +363,7 @@ by a file handle in initiator mode (see
:widths: 3 1 4 :widths: 3 1 4
- .. _`CEC_OP_ALL_DEVTYPE_TV`: - .. _`CEC-OP-ALL-DEVTYPE-TV`:
- ``CEC_OP_ALL_DEVTYPE_TV`` - ``CEC_OP_ALL_DEVTYPE_TV``
...@@ -371,7 +371,7 @@ by a file handle in initiator mode (see ...@@ -371,7 +371,7 @@ by a file handle in initiator mode (see
- This supports the TV type. - This supports the TV type.
- .. _`CEC_OP_ALL_DEVTYPE_RECORD`: - .. _`CEC-OP-ALL-DEVTYPE-RECORD`:
- ``CEC_OP_ALL_DEVTYPE_RECORD`` - ``CEC_OP_ALL_DEVTYPE_RECORD``
...@@ -379,7 +379,7 @@ by a file handle in initiator mode (see ...@@ -379,7 +379,7 @@ by a file handle in initiator mode (see
- This supports the Recording type. - This supports the Recording type.
- .. _`CEC_OP_ALL_DEVTYPE_TUNER`: - .. _`CEC-OP-ALL-DEVTYPE-TUNER`:
- ``CEC_OP_ALL_DEVTYPE_TUNER`` - ``CEC_OP_ALL_DEVTYPE_TUNER``
...@@ -387,7 +387,7 @@ by a file handle in initiator mode (see ...@@ -387,7 +387,7 @@ by a file handle in initiator mode (see
- This supports the Tuner type. - This supports the Tuner type.
- .. _`CEC_OP_ALL_DEVTYPE_PLAYBACK`: - .. _`CEC-OP-ALL-DEVTYPE-PLAYBACK`:
- ``CEC_OP_ALL_DEVTYPE_PLAYBACK`` - ``CEC_OP_ALL_DEVTYPE_PLAYBACK``
...@@ -395,7 +395,7 @@ by a file handle in initiator mode (see ...@@ -395,7 +395,7 @@ by a file handle in initiator mode (see
- This supports the Playback type. - This supports the Playback type.
- .. _`CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM`: - .. _`CEC-OP-ALL-DEVTYPE-AUDIOSYSTEM`:
- ``CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM`` - ``CEC_OP_ALL_DEVTYPE_AUDIOSYSTEM``
...@@ -403,7 +403,7 @@ by a file handle in initiator mode (see ...@@ -403,7 +403,7 @@ by a file handle in initiator mode (see
- This supports the Audio System type. - This supports the Audio System type.
- .. _`CEC_OP_ALL_DEVTYPE_SWITCH`: - .. _`CEC-OP-ALL-DEVTYPE-SWITCH`:
- ``CEC_OP_ALL_DEVTYPE_SWITCH`` - ``CEC_OP_ALL_DEVTYPE_SWITCH``
......
...@@ -50,7 +50,7 @@ the intermediate state changes were lost but it is guaranteed that the ...@@ -50,7 +50,7 @@ the intermediate state changes were lost but it is guaranteed that the
state did change in between the two events. state did change in between the two events.
.. _cec-event-state-change: .. _cec-event-state-change_s:
.. flat-table:: struct cec_event_state_change .. flat-table:: struct cec_event_state_change
:header-rows: 0 :header-rows: 0
...@@ -76,7 +76,7 @@ state did change in between the two events. ...@@ -76,7 +76,7 @@ state did change in between the two events.
.. _cec-event-lost-msgs: .. _cec-event-lost-msgs_s:
.. flat-table:: struct cec_event_lost_msgs .. flat-table:: struct cec_event_lost_msgs
:header-rows: 0 :header-rows: 0
...@@ -156,7 +156,7 @@ state did change in between the two events. ...@@ -156,7 +156,7 @@ state did change in between the two events.
- ``state_change`` - ``state_change``
- The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC_EVENT_STATE_CHANGE>` - The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>`
event. event.
- .. row 6 - .. row 6
...@@ -166,7 +166,7 @@ state did change in between the two events. ...@@ -166,7 +166,7 @@ state did change in between the two events.
- ``lost_msgs`` - ``lost_msgs``
- The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC_EVENT_LOST_MSGS>` - The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC-EVENT-LOST-MSGS>`
event. event.
...@@ -179,7 +179,7 @@ state did change in between the two events. ...@@ -179,7 +179,7 @@ state did change in between the two events.
:widths: 3 1 16 :widths: 3 1 16
- .. _CEC_EVENT_STATE_CHANGE: - .. _`CEC-EVENT-STATE-CHANGE`:
- ``CEC_EVENT_STATE_CHANGE`` - ``CEC_EVENT_STATE_CHANGE``
...@@ -189,7 +189,7 @@ state did change in between the two events. ...@@ -189,7 +189,7 @@ state did change in between the two events.
called an initial event will be generated for that filehandle with called an initial event will be generated for that filehandle with
the CEC Adapter's state at that time. the CEC Adapter's state at that time.
- .. _CEC_EVENT_LOST_MSGS: - .. _`CEC-EVENT-LOST-MSGS`:
- ``CEC_EVENT_LOST_MSGS`` - ``CEC_EVENT_LOST_MSGS``
...@@ -208,7 +208,7 @@ state did change in between the two events. ...@@ -208,7 +208,7 @@ state did change in between the two events.
:widths: 3 1 8 :widths: 3 1 8
- .. _CEC_EVENT_FL_INITIAL_VALUE: - .. _`CEC-EVENT-FL-INITIAL-VALUE`:
- ``CEC_EVENT_FL_INITIAL_VALUE`` - ``CEC_EVENT_FL_INITIAL_VALUE``
......
...@@ -74,7 +74,7 @@ always call :ref:`CEC_TRANSMIT`. ...@@ -74,7 +74,7 @@ always call :ref:`CEC_TRANSMIT`.
Available initiator modes are: Available initiator modes are:
.. _cec-mode-initiator: .. _cec-mode-initiator_e:
.. flat-table:: Initiator Modes .. flat-table:: Initiator Modes
:header-rows: 0 :header-rows: 0
...@@ -82,7 +82,7 @@ Available initiator modes are: ...@@ -82,7 +82,7 @@ Available initiator modes are:
:widths: 3 1 16 :widths: 3 1 16
- .. _`CEC_MODE_NO_INITIATOR`: - .. _`CEC-MODE-NO-INITIATOR`:
- ``CEC_MODE_NO_INITIATOR`` - ``CEC_MODE_NO_INITIATOR``
...@@ -91,7 +91,7 @@ Available initiator modes are: ...@@ -91,7 +91,7 @@ Available initiator modes are:
- This is not an initiator, i.e. it cannot transmit CEC messages or - This is not an initiator, i.e. it cannot transmit CEC messages or
make any other changes to the CEC adapter. make any other changes to the CEC adapter.
- .. _`CEC_MODE_INITIATOR`: - .. _`CEC-MODE-INITIATOR`:
- ``CEC_MODE_INITIATOR`` - ``CEC_MODE_INITIATOR``
...@@ -101,7 +101,7 @@ Available initiator modes are: ...@@ -101,7 +101,7 @@ Available initiator modes are:
it can transmit CEC messages and make changes to the CEC adapter, it can transmit CEC messages and make changes to the CEC adapter,
unless there is an exclusive initiator. unless there is an exclusive initiator.
- .. _`CEC_MODE_EXCL_INITIATOR`: - .. _`CEC-MODE-EXCL-INITIATOR`:
- ``CEC_MODE_EXCL_INITIATOR`` - ``CEC_MODE_EXCL_INITIATOR``
...@@ -117,7 +117,7 @@ Available initiator modes are: ...@@ -117,7 +117,7 @@ Available initiator modes are:
Available follower modes are: Available follower modes are:
.. _cec-mode-follower: .. _cec-mode-follower_e:
.. flat-table:: Follower Modes .. flat-table:: Follower Modes
:header-rows: 0 :header-rows: 0
...@@ -125,7 +125,7 @@ Available follower modes are: ...@@ -125,7 +125,7 @@ Available follower modes are:
:widths: 3 1 16 :widths: 3 1 16
- .. _`CEC_MODE_NO_FOLLOWER`: - .. _`CEC-MODE-NO-FOLLOWER`:
- ``CEC_MODE_NO_FOLLOWER`` - ``CEC_MODE_NO_FOLLOWER``
...@@ -133,7 +133,7 @@ Available follower modes are: ...@@ -133,7 +133,7 @@ Available follower modes are:
- This is not a follower (the default when the device is opened). - This is not a follower (the default when the device is opened).
- .. _`CEC_MODE_FOLLOWER`: - .. _`CEC-MODE-FOLLOWER`:
- ``CEC_MODE_FOLLOWER`` - ``CEC_MODE_FOLLOWER``
...@@ -141,10 +141,10 @@ Available follower modes are: ...@@ -141,10 +141,10 @@ Available follower modes are:
- This is a follower and it will receive CEC messages unless there - This is a follower and it will receive CEC messages unless there
is an exclusive follower. You cannot become a follower if is an exclusive follower. You cannot become a follower if
:ref:`CEC_CAP_TRANSMIT <CEC_CAP_TRANSMIT>` is not set or if :ref:`CEC_MODE_NO_INITIATOR <CEC_MODE_NO_INITIATOR>` :ref:`CEC_CAP_TRANSMIT <CEC-CAP-TRANSMIT>` is not set or if :ref:`CEC-MODE-NO-INITIATOR <CEC-MODE-NO-INITIATOR>`
was specified, EINVAL error code is returned in that case. was specified, EINVAL error code is returned in that case.
- .. _`CEC_MODE_EXCL_FOLLOWER`: - .. _`CEC-MODE-EXCL-FOLLOWER`:
- ``CEC_MODE_EXCL_FOLLOWER`` - ``CEC_MODE_EXCL_FOLLOWER``
...@@ -154,10 +154,10 @@ Available follower modes are: ...@@ -154,10 +154,10 @@ Available follower modes are:
receive CEC messages for processing. If someone else is already receive CEC messages for processing. If someone else is already
the exclusive follower then an attempt to become one will return the exclusive follower then an attempt to become one will return
the EBUSY error code error. You cannot become a follower if the EBUSY error code error. You cannot become a follower if
:ref:`CEC_CAP_TRANSMIT <CEC_CAP_TRANSMIT>` is not set or if :ref:`CEC_MODE_NO_INITIATOR <CEC_MODE_NO_INITIATOR>` :ref:`CEC_CAP_TRANSMIT <CEC-CAP-TRANSMIT>` is not set or if :ref:`CEC-MODE-NO-INITIATOR <CEC-MODE-NO-INITIATOR>`
was specified, EINVAL error code is returned in that case. was specified, EINVAL error code is returned in that case.
- .. _`CEC_MODE_EXCL_FOLLOWER_PASSTHRU`: - .. _`CEC-MODE-EXCL-FOLLOWER-PASSTHRU`:
- ``CEC_MODE_EXCL_FOLLOWER_PASSTHRU`` - ``CEC_MODE_EXCL_FOLLOWER_PASSTHRU``
...@@ -169,18 +169,18 @@ Available follower modes are: ...@@ -169,18 +169,18 @@ Available follower modes are:
to handle most core messages instead of relying on the CEC to handle most core messages instead of relying on the CEC
framework for that. If someone else is already the exclusive framework for that. If someone else is already the exclusive
follower then an attempt to become one will return the EBUSY error follower then an attempt to become one will return the EBUSY error
code error. You cannot become a follower if :ref:`CEC_CAP_TRANSMIT <CEC_CAP_TRANSMIT>` code error. You cannot become a follower if :ref:`CEC_CAP_TRANSMIT <CEC-CAP-TRANSMIT>`
is not set or if :ref:`CEC_MODE_NO_INITIATOR <CEC_MODE_NO_INITIATOR>` was specified, EINVAL is not set or if :ref:`CEC_MODE_NO_INITIATOR <CEC-MODE-NO-INITIATOR>` was specified, EINVAL
error code is returned in that case. error code is returned in that case.
- .. _`CEC_MODE_MONITOR`: - .. _`CEC-MODE-MONITOR`:
- ``CEC_MODE_MONITOR`` - ``CEC_MODE_MONITOR``
- 0xe0 - 0xe0
- Put the file descriptor into monitor mode. Can only be used in - Put the file descriptor into monitor mode. Can only be used in
combination with :ref:`CEC_MODE_NO_INITIATOR <CEC_MODE_NO_INITIATOR>`, otherwise EINVAL error combination with :ref:`CEC_MODE_NO_INITIATOR <CEC-MODE-NO-INITIATOR>`, otherwise EINVAL error
code will be returned. In monitor mode all messages this CEC code will be returned. In monitor mode all messages this CEC
device transmits and all messages it receives (both broadcast device transmits and all messages it receives (both broadcast
messages and directed messages for one its logical addresses) will messages and directed messages for one its logical addresses) will
...@@ -188,19 +188,19 @@ Available follower modes are: ...@@ -188,19 +188,19 @@ Available follower modes are:
allowed if the process has the ``CAP_NET_ADMIN`` capability. If allowed if the process has the ``CAP_NET_ADMIN`` capability. If
that is not set, then EPERM error code is returned. that is not set, then EPERM error code is returned.
- .. _`CEC_MODE_MONITOR_ALL`: - .. _`CEC-MODE-MONITOR-ALL`:
- ``CEC_MODE_MONITOR_ALL`` - ``CEC_MODE_MONITOR_ALL``
- 0xf0 - 0xf0
- Put the file descriptor into 'monitor all' mode. Can only be used - Put the file descriptor into 'monitor all' mode. Can only be used
in combination with :ref:`CEC_MODE_NO_INITIATOR <CEC_MODE_NO_INITIATOR>`, otherwise EINVAL in combination with :ref:`CEC_MODE_NO_INITIATOR <CEC-MODE-NO-INITIATOR>`, otherwise EINVAL
error code will be returned. In 'monitor all' mode all messages error code will be returned. In 'monitor all' mode all messages
this CEC device transmits and all messages it receives, including this CEC device transmits and all messages it receives, including
directed messages for other CEC devices will be reported. This is directed messages for other CEC devices will be reported. This is
very useful for debugging, but not all devices support this. This very useful for debugging, but not all devices support this. This
mode requires that the :ref:`CEC_CAP_MONITOR_ALL <CEC_CAP_MONITOR_ALL>` capability is set, mode requires that the :ref:`CEC_CAP_MONITOR_ALL <CEC-CAP-MONITOR-ALL>` capability is set,
otherwise EINVAL error code is returned. This is only allowed if otherwise EINVAL error code is returned. This is only allowed if
the process has the ``CAP_NET_ADMIN`` capability. If that is not the process has the ``CAP_NET_ADMIN`` capability. If that is not
set, then EPERM error code is returned. set, then EPERM error code is returned.
...@@ -217,7 +217,7 @@ Core message processing details: ...@@ -217,7 +217,7 @@ Core message processing details:
:widths: 1 8 :widths: 1 8
- .. _`CEC_MSG_GET_CEC_VERSION`: - .. _`CEC-MSG-GET-CEC-VERSION`:
- ``CEC_MSG_GET_CEC_VERSION`` - ``CEC_MSG_GET_CEC_VERSION``
...@@ -226,7 +226,7 @@ Core message processing details: ...@@ -226,7 +226,7 @@ Core message processing details:
set with set with
:ref:`CEC_ADAP_S_LOG_ADDRS`. :ref:`CEC_ADAP_S_LOG_ADDRS`.
- .. _`CEC_MSG_GIVE_DEVICE_VENDOR_ID`: - .. _`CEC-MSG-GIVE-DEVICE-VENDOR-ID`:
- ``CEC_MSG_GIVE_DEVICE_VENDOR_ID`` - ``CEC_MSG_GIVE_DEVICE_VENDOR_ID``
...@@ -235,7 +235,7 @@ Core message processing details: ...@@ -235,7 +235,7 @@ Core message processing details:
set with set with
:ref:`CEC_ADAP_S_LOG_ADDRS`. :ref:`CEC_ADAP_S_LOG_ADDRS`.
- .. _`CEC_MSG_ABORT`: - .. _`CEC-MSG-ABORT`:
- ``CEC_MSG_ABORT`` - ``CEC_MSG_ABORT``
...@@ -243,7 +243,7 @@ Core message processing details: ...@@ -243,7 +243,7 @@ Core message processing details:
userspace, otherwise the core will return a feature refused userspace, otherwise the core will return a feature refused
message as per the specification. message as per the specification.
- .. _`CEC_MSG_GIVE_PHYSICAL_ADDR`: - .. _`CEC-MSG-GIVE-PHYSICAL-ADDR`:
- ``CEC_MSG_GIVE_PHYSICAL_ADDR`` - ``CEC_MSG_GIVE_PHYSICAL_ADDR``
...@@ -251,7 +251,7 @@ Core message processing details: ...@@ -251,7 +251,7 @@ Core message processing details:
userspace, otherwise the core will report the current physical userspace, otherwise the core will report the current physical
address. address.
- .. _`CEC_MSG_GIVE_OSD_NAME`: - .. _`CEC-MSG-GIVE-OSD-NAME`:
- ``CEC_MSG_GIVE_OSD_NAME`` - ``CEC_MSG_GIVE_OSD_NAME``
...@@ -260,7 +260,7 @@ Core message processing details: ...@@ -260,7 +260,7 @@ Core message processing details:
was set with was set with
:ref:`CEC_ADAP_S_LOG_ADDRS`. :ref:`CEC_ADAP_S_LOG_ADDRS`.
- .. _`CEC_MSG_GIVE_FEATURES`: - .. _`CEC-MSG-GIVE-FEATURES`:
- ``CEC_MSG_GIVE_FEATURES`` - ``CEC_MSG_GIVE_FEATURES``
...@@ -270,21 +270,21 @@ Core message processing details: ...@@ -270,21 +270,21 @@ Core message processing details:
:ref:`CEC_ADAP_S_LOG_ADDRS` or :ref:`CEC_ADAP_S_LOG_ADDRS` or
the message is ignore if the CEC version was older than 2.0. the message is ignore if the CEC version was older than 2.0.
- .. _`CEC_MSG_USER_CONTROL_PRESSED`: - .. _`CEC-MSG-USER-CONTROL-PRESSED`:
- ``CEC_MSG_USER_CONTROL_PRESSED`` - ``CEC_MSG_USER_CONTROL_PRESSED``
- If :ref:`CEC_CAP_RC <CEC_CAP_RC>` is set, then generate a remote control key - If :ref:`CEC_CAP_RC <CEC-CAP-RC>` is set, then generate a remote control key
press. This message is always passed on to userspace. press. This message is always passed on to userspace.
- .. _`CEC_MSG_USER_CONTROL_RELEASED`: - .. _`CEC-MSG-USER-CONTROL-RELEASED`:
- ``CEC_MSG_USER_CONTROL_RELEASED`` - ``CEC_MSG_USER_CONTROL_RELEASED``
- If :ref:`CEC_CAP_RC <CEC_CAP_RC>` is set, then generate a remote control key - If :ref:`CEC_CAP_RC <CEC-CAP-RC>` is set, then generate a remote control key
release. This message is always passed on to userspace. release. This message is always passed on to userspace.
- .. _`CEC_MSG_REPORT_PHYSICAL_ADDR`: - .. _`CEC-MSG-REPORT-PHYSICAL-ADDR`:
- ``CEC_MSG_REPORT_PHYSICAL_ADDR`` - ``CEC_MSG_REPORT_PHYSICAL_ADDR``
......
...@@ -161,7 +161,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -161,7 +161,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
message) and ``timeout`` is non-zero is specifically allowed to message) and ``timeout`` is non-zero is specifically allowed to
send a message and wait up to ``timeout`` milliseconds for a send a message and wait up to ``timeout`` milliseconds for a
Feature Abort reply. In this case ``rx_status`` will either be set Feature Abort reply. In this case ``rx_status`` will either be set
to :ref:`CEC_RX_STATUS_TIMEOUT <CEC_RX_STATUS_TIMEOUT>` or :ref:`CEC_RX_STATUS_FEATURE_ABORT <CEC_RX_STATUS_FEATURE_ABORT>`. to :ref:`CEC_RX_STATUS_TIMEOUT <CEC-RX-STATUS-TIMEOUT>` or :ref:`CEC_RX_STATUS-FEATURE-ABORT <CEC-RX-STATUS-FEATURE-ABORT>`.
- .. row 10 - .. row 10
...@@ -172,7 +172,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -172,7 +172,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- A counter of the number of transmit attempts that resulted in the - A counter of the number of transmit attempts that resulted in the
Arbitration Lost error. This is only set if the hardware supports Arbitration Lost error. This is only set if the hardware supports
this, otherwise it is always 0. This counter is only valid if the this, otherwise it is always 0. This counter is only valid if the
:ref:`CEC_TX_STATUS_ARB_LOST <CEC_TX_STATUS_ARB_LOST>` status bit is set. :ref:`CEC_TX_STATUS_ARB_LOST <CEC-TX-STATUS-ARB-LOST>` status bit is set.
- .. row 11 - .. row 11
...@@ -183,7 +183,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -183,7 +183,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- A counter of the number of transmit attempts that resulted in the - A counter of the number of transmit attempts that resulted in the
Not Acknowledged error. This is only set if the hardware supports Not Acknowledged error. This is only set if the hardware supports
this, otherwise it is always 0. This counter is only valid if the this, otherwise it is always 0. This counter is only valid if the
:ref:`CEC_TX_STATUS_NACK <CEC_TX_STATUS_NACK>` status bit is set. :ref:`CEC_TX_STATUS_NACK <CEC-TX-STATUS-NACK>` status bit is set.
- .. row 12 - .. row 12
...@@ -194,7 +194,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -194,7 +194,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- A counter of the number of transmit attempts that resulted in the - A counter of the number of transmit attempts that resulted in the
Arbitration Lost error. This is only set if the hardware supports Arbitration Lost error. This is only set if the hardware supports
this, otherwise it is always 0. This counter is only valid if the this, otherwise it is always 0. This counter is only valid if the
:ref:`CEC_TX_STATUS_LOW_DRIVE <CEC_TX_STATUS_LOW_DRIVE>` status bit is set. :ref:`CEC_TX_STATUS_LOW_DRIVE <CEC-TX-STATUS-LOW-DRIVE>` status bit is set.
- .. row 13 - .. row 13
...@@ -205,7 +205,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -205,7 +205,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- A counter of the number of transmit errors other than Arbitration - A counter of the number of transmit errors other than Arbitration
Lost or Not Acknowledged. This is only set if the hardware Lost or Not Acknowledged. This is only set if the hardware
supports this, otherwise it is always 0. This counter is only supports this, otherwise it is always 0. This counter is only
valid if the :ref:`CEC_TX_STATUS_ERROR <CEC_TX_STATUS_ERROR>` status bit is set. valid if the :ref:`CEC_TX_STATUS_ERROR <CEC-TX-STATUS-ERROR>` status bit is set.
...@@ -217,18 +217,18 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -217,18 +217,18 @@ queue, then it will return -1 and set errno to the EBUSY error code.
:widths: 3 1 16 :widths: 3 1 16
- .. _`CEC_TX_STATUS_OK`: - .. _`CEC-TX-STATUS-OK`:
- ``CEC_TX_STATUS_OK`` - ``CEC_TX_STATUS_OK``
- 0x01 - 0x01
- The message was transmitted successfully. This is mutually - The message was transmitted successfully. This is mutually
exclusive with :ref:`CEC_TX_STATUS_MAX_RETRIES <CEC_TX_STATUS_MAX_RETRIES>`. Other bits can still exclusive with :ref:`CEC_TX_STATUS_MAX_RETRIES <CEC-TX-STATUS-MAX-RETRIES>`. Other bits can still
be set if earlier attempts met with failure before the transmit be set if earlier attempts met with failure before the transmit
was eventually successful. was eventually successful.
- .. _`CEC_TX_STATUS_ARB_LOST`: - .. _`CEC-TX-STATUS-ARB-LOST`:
- ``CEC_TX_STATUS_ARB_LOST`` - ``CEC_TX_STATUS_ARB_LOST``
...@@ -236,7 +236,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -236,7 +236,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- CEC line arbitration was lost. - CEC line arbitration was lost.
- .. _`CEC_TX_STATUS_NACK`: - .. _`CEC-TX-STATUS-NACK`:
- ``CEC_TX_STATUS_NACK`` - ``CEC_TX_STATUS_NACK``
...@@ -244,7 +244,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -244,7 +244,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- Message was not acknowledged. - Message was not acknowledged.
- .. _`CEC_TX_STATUS_LOW_DRIVE`: - .. _`CEC-TX-STATUS-LOW-DRIVE`:
- ``CEC_TX_STATUS_LOW_DRIVE`` - ``CEC_TX_STATUS_LOW_DRIVE``
...@@ -254,7 +254,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -254,7 +254,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
follower detected an error on the bus and requests a follower detected an error on the bus and requests a
retransmission. retransmission.
- .. _`CEC_TX_STATUS_ERROR`: - .. _`CEC-TX-STATUS-ERROR`:
- ``CEC_TX_STATUS_ERROR`` - ``CEC_TX_STATUS_ERROR``
...@@ -265,14 +265,14 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -265,14 +265,14 @@ queue, then it will return -1 and set errno to the EBUSY error code.
error occurred, or because the hardware tested for other error occurred, or because the hardware tested for other
conditions besides those two. conditions besides those two.
- .. _`CEC_TX_STATUS_MAX_RETRIES`: - .. _`CEC-TX-STATUS-MAX-RETRIES`:
- ``CEC_TX_STATUS_MAX_RETRIES`` - ``CEC_TX_STATUS_MAX_RETRIES``
- 0x20 - 0x20
- The transmit failed after one or more retries. This status bit is - The transmit failed after one or more retries. This status bit is
mutually exclusive with :ref:`CEC_TX_STATUS_OK <CEC_TX_STATUS_OK>`. Other bits can still mutually exclusive with :ref:`CEC_TX_STATUS_OK <CEC-TX-STATUS-OK>`. Other bits can still
be set to explain which failures were seen. be set to explain which failures were seen.
...@@ -285,7 +285,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -285,7 +285,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
:widths: 3 1 16 :widths: 3 1 16
- .. _`CEC_RX_STATUS_OK`: - .. _`CEC-RX-STATUS-OK`:
- ``CEC_RX_STATUS_OK`` - ``CEC_RX_STATUS_OK``
...@@ -293,7 +293,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -293,7 +293,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- The message was received successfully. - The message was received successfully.
- .. _CEC_RX_STATUS_TIMEOUT: - .. _`CEC-RX-STATUS-TIMEOUT`:
- ``CEC_RX_STATUS_TIMEOUT`` - ``CEC_RX_STATUS_TIMEOUT``
...@@ -301,7 +301,7 @@ queue, then it will return -1 and set errno to the EBUSY error code. ...@@ -301,7 +301,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- The reply to an earlier transmitted message timed out. - The reply to an earlier transmitted message timed out.
- .. _`CEC_RX_STATUS_FEATURE_ABORT`: - .. _`CEC-RX-STATUS-FEATURE-ABORT`:
- ``CEC_RX_STATUS_FEATURE_ABORT`` - ``CEC_RX_STATUS_FEATURE_ABORT``
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment