Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-12-12 06:02:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

[media] doc-rst: update CEC_RECEIVE

Browse Source 
The timestamp field was split into rx_ts and tx_ts, and the rx/tx_status
fields were moved. Update the doc accordingly.

Also fix a bug that stated that a non-zero tx_status field signaled an
error. That's not true, since TX_STATUS_OK is 1, not 0.

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 2016-07-12 15:07:44 -03:00 committed by Mauro Carvalho Chehab
parent ffbab694ed
commit d2cd627be0
1 changed files with 41 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -64,14 +64,20 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- __u64 - __u64
- ``ts`` - ``tx_ts``
- Timestamp of when the message was transmitted in ns in the case of - Timestamp in ns of when the last byte of the message was transmitted.
:ref:`CEC_TRANSMIT` with ``reply`` set to 0, or the timestamp of the
received message in all other cases.
- .. row 2 - .. row 2
- __u64
- ``rx_ts``
- Timestamp in ns of when the last byte of the message was received.
- .. row 3
- __u32 - __u32
- ``len`` - ``len``
@ -81,7 +87,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
:ref:`CEC_RECEIVE` and for :ref:`CEC_TRANSMIT` it will be filled in with :ref:`CEC_RECEIVE` and for :ref:`CEC_TRANSMIT` it will be filled in with
the length of the reply message if ``reply`` was set. the length of the reply message if ``reply`` was set.
- .. row 3 - .. row 4
- __u32 - __u32
@ -94,7 +100,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
then it will be replaced by 1000 if the ``reply`` is non-zero or then it will be replaced by 1000 if the ``reply`` is non-zero or
ignored if ``reply`` is 0. ignored if ``reply`` is 0.
- .. row 4 - .. row 5
- __u32 - __u32
@ -105,7 +111,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
framework to generate an event if a reply for a message was framework to generate an event if a reply for a message was
requested and the message was transmitted in a non-blocking mode. requested and the message was transmitted in a non-blocking mode.
- .. row 5 - .. row 6
- __u32 - __u32
@ -113,18 +119,6 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- Flags. No flags are defined yet, so set this to 0. - Flags. No flags are defined yet, so set this to 0.
- .. row 6
- __u8
- ``rx_status``
- The status bits of the received message. See
:ref:`cec-rx-status` for the possible status values. It is 0 if
this message was transmitted, not received, unless this is the
reply to a transmitted message. In that case both ``rx_status``
and ``tx_status`` are set.
- .. row 7 - .. row 7
- __u8 - __u8
@ -146,7 +140,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
for :ref:`CEC_TRANSMIT` it will be filled in with the payload of the for :ref:`CEC_TRANSMIT` it will be filled in with the payload of the
reply message if ``reply`` was set. reply message if ``reply`` was set.
- .. row 9 - .. row 8
- __u8 - __u8
@ -154,8 +148,8 @@ queue, then it will return -1 and set errno to the EBUSY error code.
- Wait until this message is replied. If ``reply`` is 0 and the - Wait until this message is replied. If ``reply`` is 0 and the
``timeout`` is 0, then don't wait for a reply but return after ``timeout`` is 0, then don't wait for a reply but return after
transmitting the message. If there was an error as indicated by a transmitting the message. If there was an error as indicated by the
non-zero ``tx_status`` field, then ``reply`` and ``timeout`` are ``tx_status`` field, then ``reply`` and ``timeout`` are
both set to 0 by the driver. Ignored by :ref:`CEC_RECEIVE`. The case both set to 0 by the driver. Ignored by :ref:`CEC_RECEIVE`. The case
where ``reply`` is 0 (this is the opcode for the Feature Abort where ``reply`` is 0 (this is the opcode for the Feature Abort
message) and ``timeout`` is non-zero is specifically allowed to message) and ``timeout`` is non-zero is specifically allowed to
@ -163,10 +157,32 @@ queue, then it will return -1 and set errno to the EBUSY error code.
Feature Abort reply. In this case ``rx_status`` will either be set Feature Abort reply. In this case ``rx_status`` will either be set
to :ref:`CEC_RX_STATUS_TIMEOUT <CEC-RX-STATUS-TIMEOUT>` or :ref:`CEC_RX_STATUS-FEATURE-ABORT <CEC-RX-STATUS-FEATURE-ABORT>`. to :ref:`CEC_RX_STATUS_TIMEOUT <CEC-RX-STATUS-TIMEOUT>` or :ref:`CEC_RX_STATUS-FEATURE-ABORT <CEC-RX-STATUS-FEATURE-ABORT>`.
- .. row 9
- __u8
- ``rx_status``
- The status bits of the received message. See
:ref:`cec-rx-status` for the possible status values. It is 0 if
this message was transmitted, not received, unless this is the
reply to a transmitted message. In that case both ``rx_status``
and ``tx_status`` are set.
- .. row 10 - .. row 10
- __u8 - __u8
- ``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.
- .. row 11
- __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
@ -174,7 +190,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
this, otherwise it is always 0. This counter is only valid if the this, otherwise it is always 0. This counter is only valid if the
:ref:`CEC_TX_STATUS_ARB_LOST <CEC-TX-STATUS-ARB-LOST>` status bit is set. :ref:`CEC_TX_STATUS_ARB_LOST <CEC-TX-STATUS-ARB-LOST>` status bit is set.
- .. row 11 - .. row 12
- __u8 - __u8
@ -185,7 +201,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
this, otherwise it is always 0. This counter is only valid if the this, otherwise it is always 0. This counter is only valid if the
:ref:`CEC_TX_STATUS_NACK <CEC-TX-STATUS-NACK>` status bit is set. :ref:`CEC_TX_STATUS_NACK <CEC-TX-STATUS-NACK>` status bit is set.
- .. row 12 - .. row 13
- __u8 - __u8
@ -196,7 +212,7 @@ queue, then it will return -1 and set errno to the EBUSY error code.
this, otherwise it is always 0. This counter is only valid if the this, otherwise it is always 0. This counter is only valid if the
:ref:`CEC_TX_STATUS_LOW_DRIVE <CEC-TX-STATUS-LOW-DRIVE>` status bit is set. :ref:`CEC_TX_STATUS_LOW_DRIVE <CEC-TX-STATUS-LOW-DRIVE>` status bit is set.
- .. row 13 - .. row 14
- __u8 - __u8