summaryrefslogtreecommitdiff
path: root/Documentation/media/kapi/cec-core.rst
diff options
context:
space:
mode:
authorHans Verkuil <hverkuil@xs4all.nl>2018-05-15 03:21:01 -0400
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>2018-05-25 15:34:50 -0400
commit6aecad62670bb728d9616c672114d1627f877f33 (patch)
treec561f8dabff479c0bb53d10be1624fde18a61708 /Documentation/media/kapi/cec-core.rst
parentdf2b23861878f0128083f0d328ca2cfc6e721120 (diff)
media: cec: improve cec status documentation
Clarify the description of status bits, particularly w.r.t. ERROR and NACK. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Hans Verkuil <hansverk@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Diffstat (limited to 'Documentation/media/kapi/cec-core.rst')
-rw-r--r--Documentation/media/kapi/cec-core.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/media/kapi/cec-core.rst b/Documentation/media/kapi/cec-core.rst
index a9f53f069a2d..1d989c544370 100644
--- a/Documentation/media/kapi/cec-core.rst
+++ b/Documentation/media/kapi/cec-core.rst
@@ -246,7 +246,10 @@ CEC_TX_STATUS_LOW_DRIVE:
CEC_TX_STATUS_ERROR:
some unspecified error occurred: this can be one of ARB_LOST
or LOW_DRIVE if the hardware cannot differentiate or something
- else entirely.
+ else entirely. Some hardware only supports OK and FAIL as the
+ result of a transmit, i.e. there is no way to differentiate
+ between the different possible errors. In that case map FAIL
+ to CEC_TX_STATUS_NACK and not to CEC_TX_STATUS_ERROR.
CEC_TX_STATUS_MAX_RETRIES:
could not transmit the message after trying multiple times.