leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Hans Verkuil 2017-09-18 05:23:57 -04:00 committed by Mauro Carvalho Chehab
parent 9a59d9361a
commit da634f623e
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/media/kapi/cec-core.rst
View File

@ -227,8 +227,8 @@ CEC_TX_STATUS_LOW_DRIVE:
retransmission. retransmission.
CEC_TX_STATUS_ERROR: CEC_TX_STATUS_ERROR:
some unspecified error occurred: this can be one of some unspecified error occurred: this can be one of ARB_LOST
the previous two if the hardware cannot differentiate or something or LOW_DRIVE if the hardware cannot differentiate or something
else entirely. else entirely.
CEC_TX_STATUS_MAX_RETRIES: 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 doesn't have to make another attempt to transmit the message
since the hardware did that already. 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. 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 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 hardware retry can just set the counter corresponding to the transmit error

10
Documentation/media/uapi/cec/cec-ioc-receive.rst
View File

@ -131,7 +131,7 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV').
- ``tx_status`` - ``tx_status``
- The status bits of the transmitted message. See - The status bits of the transmitted message. See
:ref:`cec-tx-status` for the possible status values. It is 0 if :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 * - __u8
- ``msg[16]`` - ``msg[16]``
- The message payload. For :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>` this is filled in by the - 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`` - ``tx_status``
- The status bits of the transmitted message. See - The status bits of the transmitted message. See
:ref:`cec-tx-status` for the possible status values. It is 0 if :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 * - __u8
- ``tx_arb_lost_cnt`` - ``tx_arb_lost_cnt``
- A counter of the number of transmit attempts that resulted in the - 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`` - ``CEC_TX_STATUS_ERROR``
- 0x10 - 0x10
- Some error occurred. This is used for any errors that do not fit - Some error occurred. This is used for any errors that do not fit
the previous two, either because the hardware could not tell which ``CEC_TX_STATUS_ARB_LOST`` or ``CEC_TX_STATUS_LOW_DRIVE``, either because
error occurred, or because the hardware tested for other the hardware could not tell which error occurred, or because the hardware
conditions besides those two. tested for other conditions besides those two.
* .. _`CEC-TX-STATUS-MAX-RETRIES`: * .. _`CEC-TX-STATUS-MAX-RETRIES`:
- ``CEC_TX_STATUS_MAX_RETRIES`` - ``CEC_TX_STATUS_MAX_RETRIES``