Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: cec-core.rst/cec-ioc-receive.rst: clarify CEC_TX_STATUS_ERROR

CEC_TX_STATUS_ERROR can be used if the HW cannot tell LOST_ARB and
LOW_DRIVE apart, or when some other error occurs. It is not a
replacement for NACK.

So the hardware must be able to tell the difference between OK, NACK and
'something else'.

Clarify the documentation (both public and kernel API) on this point.

Also fix two small typos (this messages -> this message).

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
da634f62 9a59d936

+10 -7
+5 -2
Documentation/media/kapi/cec-core.rst
··· 227 227 retransmission. 228 228 229 229 CEC_TX_STATUS_ERROR: 230 - some unspecified error occurred: this can be one of 231 - the previous two if the hardware cannot differentiate or something 230 + some unspecified error occurred: this can be one of ARB_LOST 231 + or LOW_DRIVE if the hardware cannot differentiate or something 232 232 else entirely. 233 233 234 234 CEC_TX_STATUS_MAX_RETRIES: ··· 237 237 retrying messages. If set, then the framework assumes that it 238 238 doesn't have to make another attempt to transmit the message 239 239 since the hardware did that already. 240 + 241 + The hardware must be able to differentiate between OK, NACK and 'something 242 + else'. 240 243 241 244 The \*_cnt arguments are the number of error conditions that were seen. 242 245 This may be 0 if no information is available. Drivers that do not support
+5 -5
Documentation/media/uapi/cec/cec-ioc-receive.rst
··· 131 131 - ``tx_status`` 132 132 - The status bits of the transmitted message. See 133 133 :ref:`cec-tx-status` for the possible status values. It is 0 if 134 - this messages was received, not transmitted. 134 + this message was received, not transmitted. 135 135 * - __u8 136 136 - ``msg[16]`` 137 137 - The message payload. For :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>` this is filled in by the ··· 168 168 - ``tx_status`` 169 169 - The status bits of the transmitted message. See 170 170 :ref:`cec-tx-status` for the possible status values. It is 0 if 171 - this messages was received, not transmitted. 171 + this message was received, not transmitted. 172 172 * - __u8 173 173 - ``tx_arb_lost_cnt`` 174 174 - A counter of the number of transmit attempts that resulted in the ··· 256 256 - ``CEC_TX_STATUS_ERROR`` 257 257 - 0x10 258 258 - Some error occurred. This is used for any errors that do not fit 259 - the previous two, either because the hardware could not tell which 260 - error occurred, or because the hardware tested for other 261 - conditions besides those two. 259 + ``CEC_TX_STATUS_ARB_LOST`` or ``CEC_TX_STATUS_LOW_DRIVE``, either because 260 + the hardware could not tell which error occurred, or because the hardware 261 + tested for other conditions besides those two. 262 262 * .. _`CEC-TX-STATUS-MAX-RETRIES`: 263 263 264 264 - ``CEC_TX_STATUS_MAX_RETRIES``