diff options
| author | Hans Verkuil <hverkuil@xs4all.nl> | 2016-07-13 14:48:54 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-13 16:56:26 +0300 |
| commit | 1267c60aa9de9f3d74712d182a4309096a314ed3 (patch) | |
| tree | 92817fd324e9a28b42fa60264717f793965211e2 /Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst | |
| parent | 6710ea47fd8bcd8d5d931d8d296c444162bb6d36 (diff) | |
| download | linux-1267c60aa9de9f3d74712d182a4309096a314ed3.tar.xz | |
[media] doc-rst: improve CEC documentation
Lots of fixups relating to references.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst')
| -rw-r--r-- | Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst index 7d7a3b43aedc..eab734ec0e9a 100644 --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst +++ b/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst @@ -4,9 +4,9 @@ .. _CEC_ADAP_G_LOG_ADDRS: .. _CEC_ADAP_S_LOG_ADDRS: -************************************************ -ioctl CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS -************************************************ +**************************************************** +ioctls CEC_ADAP_G_LOG_ADDRS and CEC_ADAP_S_LOG_ADDRS +**************************************************** Name ==== @@ -38,19 +38,17 @@ Description .. note:: This documents the proposed CEC API. This API is not yet finalized and is currently only available as a staging kernel module. -To query the current CEC logical addresses, applications call the -:ref:`CEC_ADAP_G_LOG_ADDRS` ioctl with a pointer to a -:c:type:`struct cec_log_addrs` structure where the drivers stores -the logical addresses. +To query the current CEC logical addresses, applications call +:ref:`ioctl CEC_ADAP_G_LOG_ADDRS <CEC_ADAP_G_LOG_ADDRS>` with a pointer to a +:c:type:`struct cec_log_addrs` where the driver stores the logical addresses. -To set new logical addresses, applications fill in struct -:c:type:`struct cec_log_addrs` and call the :ref:`CEC_ADAP_S_LOG_ADDRS` -ioctl with a pointer to this struct. The :ref:`CEC_ADAP_S_LOG_ADDRS` ioctl +To set new logical addresses, applications fill in +:c:type:`struct cec_log_addrs` and call :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>` +with a pointer to this struct. The :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>` is only available if ``CEC_CAP_LOG_ADDRS`` is set (ENOTTY error code is returned otherwise). This ioctl will block until all requested logical -addresses have been claimed. :ref:`CEC_ADAP_S_LOG_ADDRS` can only be called -by a file handle in initiator mode (see -:ref:`CEC_S_MODE`). +addresses have been claimed. The :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>` can only be called +by a file handle in initiator mode (see :ref:`CEC_S_MODE`). .. _cec-log-addrs: |