Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit da634f62 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

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: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 9a59d936

Documentation/media/kapi/cec-core.rst

+5 −2
Original line number Diff line number Diff line
@@ -227,8 +227,8 @@ CEC_TX_STATUS_LOW_DRIVE: 
	retransmission.



CEC_TX_STATUS_ERROR:

	some unspecified error occurred: this can be one of

	the previous two if the hardware cannot differentiate or something

	some unspecified error occurred: this can be one of ARB_LOST

	or LOW_DRIVE if the hardware cannot differentiate or something

	else entirely.



CEC_TX_STATUS_MAX_RETRIES:
@@ -238,6 +238,9 @@ CEC_TX_STATUS_MAX_RETRIES: 
	doesn't have to make another attempt to transmit the message

	since the hardware did that already.



The hardware must be able to differentiate between OK, NACK and 'something

else'.



The \*_cnt arguments are the number of error conditions that were seen.

This may be 0 if no information is available. Drivers that do not support

hardware retry can just set the counter corresponding to the transmit error

Documentation/media/uapi/cec/cec-ioc-receive.rst

+5 −5
Original line number Diff line number Diff line
@@ -131,7 +131,7 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). 
      - ``tx_status``

      - The status bits of the transmitted message. See

	:ref:`cec-tx-status` for the possible status values. It is 0 if

	this messages was received, not transmitted.

	this message was received, not transmitted.

    * - __u8

      - ``msg[16]``

      - The message payload. For :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>` this is filled in by the
@@ -168,7 +168,7 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). 
      - ``tx_status``

      - The status bits of the transmitted message. See

	:ref:`cec-tx-status` for the possible status values. It is 0 if

	this messages was received, not transmitted.

	this message was received, not transmitted.

    * - __u8

      - ``tx_arb_lost_cnt``

      - A counter of the number of transmit attempts that resulted in the
@@ -256,9 +256,9 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). 
      - ``CEC_TX_STATUS_ERROR``

      - 0x10

      - Some error occurred. This is used for any errors that do not fit

	the previous two, either because the hardware could not tell which

	error occurred, or because the hardware tested for other

	conditions besides those two.

	``CEC_TX_STATUS_ARB_LOST`` or ``CEC_TX_STATUS_LOW_DRIVE``, either because

	the hardware could not tell which error occurred, or because the hardware

	tested for other conditions besides those two.

    * .. _`CEC-TX-STATUS-MAX-RETRIES`:



      - ``CEC_TX_STATUS_MAX_RETRIES``