Commit 77edf603 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

[media] cec rst: convert tables and drop the 'row' comments

This uses Laurent's python script to convert all tables, dropping
the useless 'row' comments.

See commit c2b66caf ("[media] v4l: doc: Remove row numbers from tables")
for the script that was used.
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent acd49735
...@@ -48,41 +48,21 @@ returns the information to the application. The ioctl never fails. ...@@ -48,41 +48,21 @@ returns the information to the application. The ioctl never fails.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 16 :widths: 1 1 16
* - char
- .. row 1 - ``driver[32]``
- The name of the cec adapter driver.
- char * - char
- ``name[32]``
- ``driver[32]`` - The name of this CEC adapter. The combination ``driver`` and
``name`` must be unique.
- The name of the cec adapter driver. * - __u32
- ``capabilities``
- .. row 2 - The capabilities of the CEC adapter, see
:ref:`cec-capabilities`.
- char * - __u32
- ``version``
- ``name[32]`` - CEC Framework API version, formatted with the ``KERNEL_VERSION()``
macro.
- The name of this CEC adapter. The combination ``driver`` and
``name`` must be unique.
- .. row 3
- __u32
- ``capabilities``
- The capabilities of the CEC adapter, see
:ref:`cec-capabilities`.
- .. row 4
- __u32
- ``version``
- CEC Framework API version, formatted with the ``KERNEL_VERSION()``
macro.
.. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}| .. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}|
...@@ -94,68 +74,50 @@ returns the information to the application. The ioctl never fails. ...@@ -94,68 +74,50 @@ returns the information to the application. The ioctl never fails.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 8 :widths: 3 1 8
* .. _`CEC-CAP-PHYS-ADDR`:
- .. _`CEC-CAP-PHYS-ADDR`:
- ``CEC_CAP_PHYS_ADDR``
- ``CEC_CAP_PHYS_ADDR`` - 0x00000001
- Userspace has to configure the physical address by calling
- 0x00000001 :ref:`ioctl CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>`. If
this capability isn't set, then setting the physical address is
- Userspace has to configure the physical address by calling handled by the kernel whenever the EDID is set (for an HDMI
:ref:`ioctl CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>`. If receiver) or read (for an HDMI transmitter).
this capability isn't set, then setting the physical address is * .. _`CEC-CAP-LOG-ADDRS`:
handled by the kernel whenever the EDID is set (for an HDMI
receiver) or read (for an HDMI transmitter). - ``CEC_CAP_LOG_ADDRS``
- 0x00000002
- .. _`CEC-CAP-LOG-ADDRS`: - Userspace has to configure the logical addresses by calling
:ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>`. If
- ``CEC_CAP_LOG_ADDRS`` this capability isn't set, then the kernel will have configured
this.
- 0x00000002 * .. _`CEC-CAP-TRANSMIT`:
- Userspace has to configure the logical addresses by calling - ``CEC_CAP_TRANSMIT``
:ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>`. If - 0x00000004
this capability isn't set, then the kernel will have configured - Userspace can transmit CEC messages by calling
this. :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>`. This implies that
userspace can be a follower as well, since being able to transmit
- .. _`CEC-CAP-TRANSMIT`: messages is a prerequisite of becoming a follower. If this
capability isn't set, then the kernel will handle all CEC
- ``CEC_CAP_TRANSMIT`` transmits and process all CEC messages it receives.
* .. _`CEC-CAP-PASSTHROUGH`:
- 0x00000004
- ``CEC_CAP_PASSTHROUGH``
- Userspace can transmit CEC messages by calling - 0x00000008
:ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>`. This implies that - Userspace can use the passthrough mode by calling
userspace can be a follower as well, since being able to transmit :ref:`ioctl CEC_S_MODE <CEC_S_MODE>`.
messages is a prerequisite of becoming a follower. If this * .. _`CEC-CAP-RC`:
capability isn't set, then the kernel will handle all CEC
transmits and process all CEC messages it receives. - ``CEC_CAP_RC``
- 0x00000010
- .. _`CEC-CAP-PASSTHROUGH`: - This adapter supports the remote control protocol.
* .. _`CEC-CAP-MONITOR-ALL`:
- ``CEC_CAP_PASSTHROUGH``
- ``CEC_CAP_MONITOR_ALL``
- 0x00000008 - 0x00000020
- The CEC hardware can monitor all messages, not just directed and
- Userspace can use the passthrough mode by calling broadcast messages.
:ref:`ioctl CEC_S_MODE <CEC_S_MODE>`.
- .. _`CEC-CAP-RC`:
- ``CEC_CAP_RC``
- 0x00000010
- This adapter supports the remote control protocol.
- .. _`CEC-CAP-MONITOR-ALL`:
- ``CEC_CAP_MONITOR_ALL``
- 0x00000020
- The CEC hardware can monitor all messages, not just directed and
broadcast messages.
......
...@@ -58,26 +58,16 @@ it is guaranteed that the state did change in between the two events. ...@@ -58,26 +58,16 @@ it is guaranteed that the state did change in between the two events.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 8 :widths: 1 1 8
* - __u16
- .. row 1 - ``phys_addr``
- The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
- __u16
- ``phys_addr``
- The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
valid physical address is set. valid physical address is set.
* - __u16
- .. row 2 - ``log_addr_mask``
- The current set of claimed logical addresses. This is 0 if no logical
- __u16 addresses are claimed or if ``phys_addr`` is ``CEC_PHYS_ADDR_INVALID``.
If bit 15 is set (``1 << CEC_LOG_ADDR_UNREGISTERED``) then this device
- ``log_addr_mask`` has the unregistered logical address. In that case all other bits are 0.
- The current set of claimed logical addresses. This is 0 if no logical
addresses are claimed or if ``phys_addr`` is ``CEC_PHYS_ADDR_INVALID``.
If bit 15 is set (``1 << CEC_LOG_ADDR_UNREGISTERED``) then this device
has the unregistered logical address. In that case all other bits are 0.
.. c:type:: cec_event_lost_msgs .. c:type:: cec_event_lost_msgs
...@@ -89,22 +79,17 @@ it is guaranteed that the state did change in between the two events. ...@@ -89,22 +79,17 @@ it is guaranteed that the state did change in between the two events.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 16 :widths: 1 1 16
* - __u32
- .. row 1 - ``lost_msgs``
- Set to the number of lost messages since the filehandle was opened
- __u32 or since the last time this event was dequeued for this
filehandle. The messages lost are the oldest messages. So when a
- ``lost_msgs`` new message arrives and there is no more room, then the oldest
message is discarded to make room for the new one. The internal
- Set to the number of lost messages since the filehandle was opened size of the message queue guarantees that all messages received in
or since the last time this event was dequeued for this the last two seconds will be stored. Since messages should be
filehandle. The messages lost are the oldest messages. So when a replied to within a second according to the CEC specification,
new message arrives and there is no more room, then the oldest this is more than enough.
message is discarded to make room for the new one. The internal
size of the message queue guarantees that all messages received in
the last two seconds will be stored. Since messages should be
replied to within a second according to the CEC specification,
this is more than enough.
.. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{2.5cm}|p{8.8cm}| .. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{2.5cm}|p{8.8cm}|
...@@ -116,62 +101,32 @@ it is guaranteed that the state did change in between the two events. ...@@ -116,62 +101,32 @@ it is guaranteed that the state did change in between the two events.
:stub-columns: 0 :stub-columns: 0
:widths: 1 1 1 8 :widths: 1 1 1 8
* - __u64
- .. row 1 - ``ts``
- :cspan:`1` Timestamp of the event in ns.
- __u64
The timestamp has been taken from the ``CLOCK_MONOTONIC`` clock. To access
- ``ts`` the same clock from userspace use :c:func:`clock_gettime`.
* - __u32
- :cspan:`1` Timestamp of the event in ns. - ``event``
- :cspan:`1` The CEC event type, see :ref:`cec-events`.
The timestamp has been taken from the ``CLOCK_MONOTONIC`` clock. To access * - __u32
the same clock from userspace use :c:func:`clock_gettime`. - ``flags``
- :cspan:`1` Event flags, see :ref:`cec-event-flags`.
- .. row 2 * - union
- (anonymous)
- __u32 -
-
- ``event`` * -
- struct cec_event_state_change
- :cspan:`1` The CEC event type, see :ref:`cec-events`. - ``state_change``
- The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>`
- .. row 3 event.
* -
- __u32 - struct cec_event_lost_msgs
- ``lost_msgs``
- ``flags`` - The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC-EVENT-LOST-MSGS>`
event.
- :cspan:`1` Event flags, see :ref:`cec-event-flags`.
- .. row 4
- union
- (anonymous)
-
-
- .. row 5
-
- struct cec_event_state_change
- ``state_change``
- The new adapter state as sent by the :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>`
event.
- .. row 6
-
- struct cec_event_lost_msgs
- ``lost_msgs``
- The number of lost messages as sent by the :ref:`CEC_EVENT_LOST_MSGS <CEC-EVENT-LOST-MSGS>`
event.
.. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}| .. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}|
...@@ -183,25 +138,19 @@ it is guaranteed that the state did change in between the two events. ...@@ -183,25 +138,19 @@ it is guaranteed that the state did change in between the two events.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 16 :widths: 3 1 16
* .. _`CEC-EVENT-STATE-CHANGE`:
- .. _`CEC-EVENT-STATE-CHANGE`: - ``CEC_EVENT_STATE_CHANGE``
- 1
- ``CEC_EVENT_STATE_CHANGE`` - Generated when the CEC Adapter's state changes. When open() is
called an initial event will be generated for that filehandle with
- 1 the CEC Adapter's state at that time.
* .. _`CEC-EVENT-LOST-MSGS`:
- Generated when the CEC Adapter's state changes. When open() is
called an initial event will be generated for that filehandle with
the CEC Adapter's state at that time.
- .. _`CEC-EVENT-LOST-MSGS`:
- ``CEC_EVENT_LOST_MSGS`` - ``CEC_EVENT_LOST_MSGS``
- 2
- 2 - Generated if one or more CEC messages were lost because the
application didn't dequeue CEC messages fast enough.
- Generated if one or more CEC messages were lost because the
application didn't dequeue CEC messages fast enough.
.. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}| .. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}|
...@@ -213,17 +162,14 @@ it is guaranteed that the state did change in between the two events. ...@@ -213,17 +162,14 @@ it is guaranteed that the state did change in between the two events.
:stub-columns: 0 :stub-columns: 0
:widths: 3 1 8 :widths: 3 1 8
* .. _`CEC-EVENT-FL-INITIAL-VALUE`:
- .. _`CEC-EVENT-FL-INITIAL-VALUE`: - ``CEC_EVENT_FL_INITIAL_VALUE``
- 1
- ``CEC_EVENT_FL_INITIAL_VALUE`` - Set for the initial events that are generated when the device is
opened. See the table above for which events do this. This allows
- 1 applications to learn the initial state of the CEC adapter at
open() time.
- Set for the initial events that are generated when the device is
opened. See the table above for which events do this. This allows
applications to learn the initial state of the CEC adapter at
open() time.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment