[media] cec: add cec_transmit_attempt_done helper function
authorHans Verkuil <hverkuil@xs4all.nl>
Wed, 7 Jun 2017 14:46:10 +0000 (11:46 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 20 Jun 2017 09:52:33 +0000 (06:52 -0300)
A simpler variant of cec_transmit_done to be used where the HW does
just a single attempt at a transmit. So if the status indicates an
error, then the corresponding error count will always be 1 and this
function figures that out based on the status argument.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/kapi/cec-core.rst
drivers/media/cec/cec-adap.c
include/media/cec.h

index 278b358b2f2eea067f855424bffca163fcb30a23..8a65c69ed0712bc6c74d98456cc6f9c4cb01405d 100644 (file)
@@ -194,6 +194,11 @@ When a transmit finished (successfully or otherwise):
        void cec_transmit_done(struct cec_adapter *adap, u8 status, u8 arb_lost_cnt,
                       u8 nack_cnt, u8 low_drive_cnt, u8 error_cnt);
 
+or:
+
+.. c:function::
+       void cec_transmit_attempt_done(struct cec_adapter *adap, u8 status);
+
 The status can be one of:
 
 CEC_TX_STATUS_OK:
@@ -231,6 +236,11 @@ 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.
 
+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
+count argument corresponding to the status. Or all 0 if the status was OK.
+
 When a CEC message was received:
 
 .. c:function::
index 61e39bbe3cf94f773df8f0ca09ef6a59f038fb6c..bd76c15ade4f0c7062a28adceed42a4876e8fc3d 100644 (file)
@@ -553,6 +553,32 @@ unlock:
 }
 EXPORT_SYMBOL_GPL(cec_transmit_done);
 
+void cec_transmit_attempt_done(struct cec_adapter *adap, u8 status)
+{
+       switch (status) {
+       case CEC_TX_STATUS_OK:
+               cec_transmit_done(adap, status, 0, 0, 0, 0);
+               return;
+       case CEC_TX_STATUS_ARB_LOST:
+               cec_transmit_done(adap, status, 1, 0, 0, 0);
+               return;
+       case CEC_TX_STATUS_NACK:
+               cec_transmit_done(adap, status, 0, 1, 0, 0);
+               return;
+       case CEC_TX_STATUS_LOW_DRIVE:
+               cec_transmit_done(adap, status, 0, 0, 1, 0);
+               return;
+       case CEC_TX_STATUS_ERROR:
+               cec_transmit_done(adap, status, 0, 0, 0, 1);
+               return;
+       default:
+               /* Should never happen */
+               WARN(1, "cec-%s: invalid status 0x%02x\n", adap->name, status);
+               return;
+       }
+}
+EXPORT_SYMBOL_GPL(cec_transmit_attempt_done);
+
 /*
  * Called when waiting for a reply times out.
  */
index 3ce73951591e3e77c880010844fdc701016b4742..a2e184d1df008f150f9586ac5ce2b8758ddf2bfd 100644 (file)
@@ -227,6 +227,12 @@ int cec_transmit_msg(struct cec_adapter *adap, struct cec_msg *msg,
 /* Called by the adapter */
 void cec_transmit_done(struct cec_adapter *adap, u8 status, u8 arb_lost_cnt,
                       u8 nack_cnt, u8 low_drive_cnt, u8 error_cnt);
+/*
+ * Simplified version of cec_transmit_done for hardware that doesn't retry
+ * failed transmits. So this is always just one attempt in which case
+ * the status is sufficient.
+ */
+void cec_transmit_attempt_done(struct cec_adapter *adap, u8 status);
 void cec_received_msg(struct cec_adapter *adap, struct cec_msg *msg);
 
 /**