summaryrefslogtreecommitdiff
path: root/Documentation/media
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2018-10-05 08:58:12 -0400
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>2018-10-05 11:04:39 -0400
commit81e33279d154599db64d608b2a1db619f3b56ce1 (patch)
treedb24c9c1153ce25ec6aad32475dfb310d570f077 /Documentation/media
parent9afc82194de9a1ce298f0d77d7d779d585bf962c (diff)
media: cec-core.rst: improve cec_transmit_done documentation
Clarify that calling cec_transmit_done can start a new transmit and that you should put the hardware in a state that allows for a new transmit before calling this function. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Diffstat (limited to 'Documentation/media')
-rw-r--r--Documentation/media/kapi/cec-core.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/media/kapi/cec-core.rst b/Documentation/media/kapi/cec-core.rst
index 1d989c544370..bca1d9d1d223 100644
--- a/Documentation/media/kapi/cec-core.rst
+++ b/Documentation/media/kapi/cec-core.rst
@@ -268,6 +268,10 @@ to 1, if the hardware does support retry then either set these counters to
0 if the hardware provides no feedback of which errors occurred and how many
times, or fill in the correct values as reported by the hardware.
+Be aware that calling these functions can immediately start a new transmit
+if there is one pending in the queue. So make sure that the hardware is in
+a state where new transmits can be started *before* calling these functions.
+
The cec_transmit_attempt_done() function is a helper for cases where the
hardware never retries, so the transmit is always for just a single
attempt. It will call cec_transmit_done() in turn, filling in 1 for the