summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorHans Verkuil <hansverk@cisco.com>2016-08-10 06:00:53 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-22 13:27:15 -0300
commit277f963cea4ec87144c6713377322fe3bf172a5e (patch)
tree9d17636b7d6e8900cdec5e94cbf03bc99253532f /Documentation
parent31dc8b7302f1e48952ec8e90cd49dca843146cd0 (diff)
downloadlinux-0-day-277f963cea4ec87144c6713377322fe3bf172a5e.tar.gz
linux-0-day-277f963cea4ec87144c6713377322fe3bf172a5e.tar.xz
[media] cec: improve dqevent documentation
The documentation for the cec_event_state_change struct was incomplete. This patch documents what happens in the corner cases. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/media/uapi/cec/cec-ioc-dqevent.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
index 7a6d6d00ce194..2e1e739283960 100644
--- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
@@ -64,7 +64,8 @@ it is guaranteed that the state did change in between the two events.
- ``phys_addr``
- - The current physical address.
+ - The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
+ valid physical address is set.
- .. row 2
@@ -72,7 +73,10 @@ it is guaranteed that the state did change in between the two events.
- ``log_addr_mask``
- - The current set of claimed logical addresses.
+ - The current set of claimed logical addresses. This is 0 if no logical
+ addresses are claimed or if ``phys_addr`` is ``CEC_PHYS_ADDR_INVALID``.
+ If bit 15 is set (``1 << CEC_LOG_ADDR_UNREGISTERED``) then this device
+ has the unregistered logical address. In that case all other bits are 0.