media: cec: document the new CEC pin capability, events and mode
Document CEC_CAP_MONITOR_PIN, CEC_EVENT_PIN_LOW/HIGH, CEC_EVENT_FL_DROPPED_EVENTS and CEC_MODE_MONITOR_PIN. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Reviewed-by: Maxime Ripard <maxime.ripard@free-electrons.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
6b2bbb0874
commit
fdb8c88e92
@ -121,6 +121,13 @@ returns the information to the application. The ioctl never fails.
|
||||
high. This makes it impossible to use CEC to wake up displays that
|
||||
set the HPD pin low when in standby mode, but keep the CEC bus
|
||||
alive.
|
||||
* .. _`CEC-CAP-MONITOR-PIN`:
|
||||
|
||||
- ``CEC_CAP_MONITOR_PIN``
|
||||
- 0x00000080
|
||||
- The CEC hardware can monitor CEC pin changes from low to high voltage
|
||||
and vice versa. When in pin monitoring mode the application will
|
||||
receive ``CEC_EVENT_PIN_LOW`` and ``CEC_EVENT_PIN_HIGH`` events.
|
||||
|
||||
|
||||
|
||||
|
@ -146,6 +146,20 @@ it is guaranteed that the state did change in between the two events.
|
||||
- 2
|
||||
- Generated if one or more CEC messages were lost because the
|
||||
application didn't dequeue CEC messages fast enough.
|
||||
* .. _`CEC-EVENT-PIN-LOW`:
|
||||
|
||||
- ``CEC_EVENT_PIN_LOW``
|
||||
- 3
|
||||
- Generated if the CEC pin goes from a high voltage to a low voltage.
|
||||
Only applies to adapters that have the ``CEC_CAP_MONITOR_PIN``
|
||||
capability set.
|
||||
* .. _`CEC-EVENT-PIN-HIGH`:
|
||||
|
||||
- ``CEC_EVENT_PIN_HIGH``
|
||||
- 4
|
||||
- Generated if the CEC pin goes from a low voltage to a high voltage.
|
||||
Only applies to adapters that have the ``CEC_CAP_MONITOR_PIN``
|
||||
capability set.
|
||||
|
||||
|
||||
.. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}|
|
||||
@ -165,6 +179,12 @@ it is guaranteed that the state did change in between the two events.
|
||||
opened. See the table above for which events do this. This allows
|
||||
applications to learn the initial state of the CEC adapter at
|
||||
open() time.
|
||||
* .. _`CEC-EVENT-FL-DROPPED-EVENTS`:
|
||||
|
||||
- ``CEC_EVENT_FL_DROPPED_EVENTS``
|
||||
- 2
|
||||
- Set if one or more events of the given event type have been dropped.
|
||||
This is an indication that the application cannot keep up.
|
||||
|
||||
|
||||
|
||||
|
@ -149,13 +149,28 @@ Available follower modes are:
|
||||
code. 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,
|
||||
the ``EINVAL`` error code is returned in that case.
|
||||
* .. _`CEC-MODE-MONITOR-PIN`:
|
||||
|
||||
- ``CEC_MODE_MONITOR_PIN``
|
||||
- 0xd0
|
||||
- Put the file descriptor into pin monitoring mode. Can only be used in
|
||||
combination with :ref:`CEC_MODE_NO_INITIATOR <CEC-MODE-NO-INITIATOR>`,
|
||||
otherwise the ``EINVAL`` error code will be returned.
|
||||
This mode requires that the :ref:`CEC_CAP_MONITOR_PIN <CEC-CAP-MONITOR-PIN>`
|
||||
capability is set, otherwise the ``EINVAL`` error code is returned.
|
||||
While in pin monitoring mode this file descriptor can receive the
|
||||
``CEC_EVENT_PIN_LOW`` and ``CEC_EVENT_PIN_HIGH`` events to see the
|
||||
low-level CEC pin transitions. This is very useful for debugging.
|
||||
This mode is only allowed if the process has the ``CAP_NET_ADMIN``
|
||||
capability. If that is not set, then the ``EPERM`` error code is returned.
|
||||
* .. _`CEC-MODE-MONITOR`:
|
||||
|
||||
- ``CEC_MODE_MONITOR``
|
||||
- 0xe0
|
||||
- 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
|
||||
code will be returned. In monitor mode all messages this CEC
|
||||
combination with :ref:`CEC_MODE_NO_INITIATOR <CEC-MODE-NO-INITIATOR>`,i
|
||||
otherwise the ``EINVAL`` error code will be returned.
|
||||
In monitor mode all messages this CEC
|
||||
device transmits and all messages it receives (both broadcast
|
||||
messages and directed messages for one its logical addresses) will
|
||||
be reported. This is very useful for debugging. This is only
|
||||
|
Loading…
Reference in New Issue
Block a user