summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2016-07-08 20:55:43 +0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-08 17:39:15 -0300
commit21c62694499800f74def88edfbd5dcd91c492b79 (patch)
treef8998e60c0400ba5475dba3685d9ac0ca1984b9d /Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
parente2460b1d579a6ea4f90cf2915da87b16b59e0082 (diff)
[media] doc-rst: linux_tc CEC enhanced markup
leaved content unchanged, only improved markup and references * more man-like sections (add Name section) * defined target for each stuct field description * replace constant with ":ref:" to (field) description Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst')
-rw-r--r--Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst41
1 files changed, 16 insertions, 25 deletions
diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
index e5441eca6f75..4544b6f86ae0 100644
--- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
@@ -1,20 +1,20 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _cec-ioc-adap-g-caps:
+.. _CEC_ADAP_G_CAPS:
*********************
ioctl CEC_ADAP_G_CAPS
*********************
-*man CEC_ADAP_G_CAPS(2)*
-
-Query device capabilities
+Name
+====
+CEC_ADAP_G_CAPS - Query device capabilities
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, struct cec_caps *argp )
+.. cpp:function:: int ioctl( int fd, int request, struct cec_caps *argp )
Arguments
=========
@@ -34,7 +34,7 @@ Description
Note: this documents the proposed CEC API. This API is not yet finalized
and is currently only available as a staging kernel module.
-All cec devices must support the ``CEC_ADAP_G_CAPS`` ioctl. To query
+All cec devices must support the :ref:`CEC_ADAP_G_CAPS` ioctl. To query
device information, applications call the ioctl with a pointer to a
struct :ref:`cec_caps <cec-caps>`. The driver fills the structure and
returns the information to the application. The ioctl never fails.
@@ -93,52 +93,52 @@ returns the information to the application. The ioctl never fails.
:widths: 3 1 4
- - .. row 1
+ - .. _`CEC_CAP_PHYS_ADDR`:
- ``CEC_CAP_PHYS_ADDR``
- 0x00000001
- Userspace has to configure the physical address by calling
- :ref:`CEC_ADAP_S_PHYS_ADDR <cec-ioc-adap-g-phys-addr>`. If
+ :ref:`CEC_ADAP_S_PHYS_ADDR`. If
this capability isn't set, then setting the physical address is
handled by the kernel whenever the EDID is set (for an HDMI
receiver) or read (for an HDMI transmitter).
- - .. row 2
+ - .. _`CEC_CAP_LOG_ADDRS`:
- ``CEC_CAP_LOG_ADDRS``
- 0x00000002
- Userspace has to configure the logical addresses by calling
- :ref:`CEC_ADAP_S_LOG_ADDRS <cec-ioc-adap-g-log-addrs>`. If
+ :ref:`CEC_ADAP_S_LOG_ADDRS`. If
this capability isn't set, then the kernel will have configured
this.
- - .. row 3
+ - .. _`CEC_CAP_TRANSMIT`:
- ``CEC_CAP_TRANSMIT``
- 0x00000004
- Userspace can transmit CEC messages by calling
- :ref:`CEC_TRANSMIT <cec-ioc-receive>`. This implies that
+ :ref:`CEC_TRANSMIT`. This implies that
userspace can be a follower as well, since being able to transmit
messages is a prerequisite of becoming a follower. If this
capability isn't set, then the kernel will handle all CEC
transmits and process all CEC messages it receives.
- - .. row 4
+ - .. _`CEC_CAP_PASSTHROUGH`:
- ``CEC_CAP_PASSTHROUGH``
- 0x00000008
- Userspace can use the passthrough mode by calling
- :ref:`CEC_S_MODE <cec-ioc-g-mode>`.
+ :ref:`CEC_S_MODE`.
- - .. row 5
+ - .. _`CEC_CAP_RC`:
- ``CEC_CAP_RC``
@@ -146,7 +146,7 @@ returns the information to the application. The ioctl never fails.
- This adapter supports the remote control protocol.
- - .. row 6
+ - .. _`CEC_CAP_MONITOR_ALL`:
- ``CEC_CAP_MONITOR_ALL``
@@ -163,12 +163,3 @@ Return Value
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. ------------------------------------------------------------------------------
-.. This file was automatically converted from DocBook-XML with the dbxml
-.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
-.. from the linux kernel, refer to:
-..
-.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
-.. ------------------------------------------------------------------------------