Commit 01fae02d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

media: docs: make CEC documents compatible with Sphinx 3.1+

Sphinx 3.x broke support for the cdomain.py extension, as the
c domain code was rewritten. Due to that, the c tags need to
be re-written, in order to use the new c domain notation.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent c51d9b04
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _cec-func-close: .. _cec-func-close:
...@@ -11,7 +12,6 @@ Name ...@@ -11,7 +12,6 @@ Name
cec-close - Close a cec device cec-close - Close a cec device
Synopsis Synopsis
======== ========
...@@ -19,16 +19,13 @@ Synopsis ...@@ -19,16 +19,13 @@ Synopsis
#include <unistd.h> #include <unistd.h>
.. c:function:: int close( int fd ) .. c:function:: int close( int fd )
:name: cec-close
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
Description Description
=========== ===========
...@@ -36,11 +33,10 @@ Description ...@@ -36,11 +33,10 @@ Description
Closes the cec device. Resources associated with the file descriptor are Closes the cec device. Resources associated with the file descriptor are
freed. The device configuration remain unchanged. freed. The device configuration remain unchanged.
Return Value Return Value
============ ============
:c:func:`close() <cec-close>` returns 0 on success. On error, -1 is returned, and :c:func:`close()` returns 0 on success. On error, -1 is returned, and
``errno`` is set appropriately. Possible error codes are: ``errno`` is set appropriately. Possible error codes are:
``EBADF`` ``EBADF``
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _cec-func-ioctl: .. _cec-func-ioctl:
...@@ -18,15 +19,13 @@ Synopsis ...@@ -18,15 +19,13 @@ Synopsis
#include <sys/ioctl.h> #include <sys/ioctl.h>
``int ioctl(int fd, int request, void *argp)``
.. c:function:: int ioctl( int fd, int request, void *argp )
:name: cec-ioctl
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``request`` ``request``
CEC ioctl request code as defined in the cec.h header file, for CEC ioctl request code as defined in the cec.h header file, for
...@@ -35,11 +34,10 @@ Arguments ...@@ -35,11 +34,10 @@ Arguments
``argp`` ``argp``
Pointer to a request-specific structure. Pointer to a request-specific structure.
Description Description
=========== ===========
The :c:func:`ioctl() <cec-ioctl>` function manipulates cec device parameters. The The :c:func:`ioctl()` function manipulates cec device parameters. The
argument ``fd`` must be an open file descriptor. argument ``fd`` must be an open file descriptor.
The ioctl ``request`` code specifies the cec function to be called. It The ioctl ``request`` code specifies the cec function to be called. It
...@@ -51,7 +49,6 @@ their parameters are located in the cec.h header file. All cec ioctl ...@@ -51,7 +49,6 @@ their parameters are located in the cec.h header file. All cec ioctl
requests, their respective function and parameters are specified in requests, their respective function and parameters are specified in
:ref:`cec-user-func`. :ref:`cec-user-func`.
Return Value Return Value
============ ============
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _cec-func-open: .. _cec-func-open:
...@@ -18,10 +19,7 @@ Synopsis ...@@ -18,10 +19,7 @@ Synopsis
#include <fcntl.h> #include <fcntl.h>
.. c:function:: int open( const char *device_name, int flags ) .. c:function:: int open( const char *device_name, int flags )
:name: cec-open
Arguments Arguments
========= =========
...@@ -42,11 +40,10 @@ Arguments ...@@ -42,11 +40,10 @@ Arguments
Other flags have no effect. Other flags have no effect.
Description Description
=========== ===========
To open a cec device applications call :c:func:`open() <cec-open>` with the To open a cec device applications call :c:func:`open()` with the
desired device name. The function has no side effects; the device desired device name. The function has no side effects; the device
configuration remain unchanged. configuration remain unchanged.
...@@ -54,11 +51,10 @@ When the device is opened in read-only mode, attempts to modify its ...@@ -54,11 +51,10 @@ When the device is opened in read-only mode, attempts to modify its
configuration will result in an error, and ``errno`` will be set to configuration will result in an error, and ``errno`` will be set to
EBADF. EBADF.
Return Value Return Value
============ ============
:c:func:`open() <cec-open>` returns the new file descriptor on success. On error, :c:func:`open()` returns the new file descriptor on success. On error,
-1 is returned, and ``errno`` is set appropriately. Possible error codes -1 is returned, and ``errno`` is set appropriately. Possible error codes
include: include:
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _cec-func-poll: .. _cec-func-poll:
...@@ -11,7 +12,6 @@ Name ...@@ -11,7 +12,6 @@ Name
cec-poll - Wait for some event on a file descriptor cec-poll - Wait for some event on a file descriptor
Synopsis Synopsis
======== ========
...@@ -19,9 +19,7 @@ Synopsis ...@@ -19,9 +19,7 @@ Synopsis
#include <sys/poll.h> #include <sys/poll.h>
.. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout ) .. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
:name: cec-poll
Arguments Arguments
========= =========
...@@ -35,14 +33,13 @@ Arguments ...@@ -35,14 +33,13 @@ Arguments
``timeout`` ``timeout``
Timeout to wait for events Timeout to wait for events
Description Description
=========== ===========
With the :c:func:`poll() <cec-poll>` function applications can wait for CEC With the :c:func:`poll()` function applications can wait for CEC
events. events.
On success :c:func:`poll() <cec-poll>` returns the number of file descriptors On success :c:func:`poll()` returns the number of file descriptors
that have been selected (that is, file descriptors for which the that have been selected (that is, file descriptors for which the
``revents`` field of the respective struct :c:type:`pollfd` ``revents`` field of the respective struct :c:type:`pollfd`
is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in
...@@ -53,13 +50,12 @@ then the ``POLLPRI`` flag is set. When the function times out it returns ...@@ -53,13 +50,12 @@ then the ``POLLPRI`` flag is set. When the function times out it returns
a value of zero, on failure it returns -1 and the ``errno`` variable is a value of zero, on failure it returns -1 and the ``errno`` variable is
set appropriately. set appropriately.
For more details see the :c:func:`poll() <cec-poll>` manual page. For more details see the :c:func:`poll()` manual page.
Return Value Return Value
============ ============
On success, :c:func:`poll() <cec-poll>` returns the number structures which have On success, :c:func:`poll()` returns the number structures which have
non-zero ``revents`` fields, or zero if the call timed out. On error -1 non-zero ``revents`` fields, or zero if the call timed out. On error -1
is returned, and the ``errno`` variable is set appropriately: is returned, and the ``errno`` variable is set appropriately:
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _CEC_ADAP_G_CAPS: .. _CEC_ADAP_G_CAPS:
...@@ -14,18 +15,18 @@ CEC_ADAP_G_CAPS - Query device capabilities ...@@ -14,18 +15,18 @@ CEC_ADAP_G_CAPS - Query device capabilities
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_ADAP_G_CAPS, struct cec_caps *argp ) .. c:macro:: CEC_ADAP_G_CAPS
:name: CEC_ADAP_G_CAPS
``int ioctl(int fd, CEC_ADAP_G_CAPS, struct cec_caps *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Description Description
=========== ===========
...@@ -62,7 +63,6 @@ returns the information to the application. The ioctl never fails. ...@@ -62,7 +63,6 @@ returns the information to the application. The ioctl never fails.
- CEC Framework API version, formatted with the ``KERNEL_VERSION()`` - CEC Framework API version, formatted with the ``KERNEL_VERSION()``
macro. macro.
.. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}| .. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}|
.. _cec-capabilities: .. _cec-capabilities:
......
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
.. ..
.. Copyright 2019 Google LLC .. Copyright 2019 Google LLC
.. ..
.. c:namespace:: CEC
.. _CEC_ADAP_G_CONNECTOR_INFO: .. _CEC_ADAP_G_CONNECTOR_INFO:
******************************* *******************************
...@@ -16,18 +18,18 @@ CEC_ADAP_G_CONNECTOR_INFO - Query HDMI connector information ...@@ -16,18 +18,18 @@ CEC_ADAP_G_CONNECTOR_INFO - Query HDMI connector information
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_ADAP_G_CONNECTOR_INFO, struct cec_connector_info *argp ) .. c:macro:: CEC_ADAP_G_CONNECTOR_INFO
:name: CEC_ADAP_G_CONNECTOR_INFO
``int ioctl(int fd, CEC_ADAP_G_CONNECTOR_INFO, struct cec_connector_info *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Description Description
=========== ===========
...@@ -57,7 +59,6 @@ is only available if the ``CEC_CAP_CONNECTOR_INFO`` capability is set. ...@@ -57,7 +59,6 @@ is only available if the ``CEC_CAP_CONNECTOR_INFO`` capability is set.
* - } * - }
- -
.. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}| .. tabularcolumns:: |p{4.4cm}|p{2.5cm}|p{10.6cm}|
.. _connector-type: .. _connector-type:
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _CEC_ADAP_LOG_ADDRS: .. _CEC_ADAP_LOG_ADDRS:
.. _CEC_ADAP_G_LOG_ADDRS: .. _CEC_ADAP_G_LOG_ADDRS:
...@@ -13,21 +14,22 @@ Name ...@@ -13,21 +14,22 @@ Name
CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS - Get or set the logical addresses CEC_ADAP_G_LOG_ADDRS, CEC_ADAP_S_LOG_ADDRS - Get or set the logical addresses
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_ADAP_G_LOG_ADDRS, struct cec_log_addrs *argp ) .. c:macro:: CEC_ADAP_G_LOG_ADDRS
:name: CEC_ADAP_G_LOG_ADDRS
``int ioctl(int fd, CEC_ADAP_G_LOG_ADDRS, struct cec_log_addrs *argp)``
.. c:macro:: CEC_ADAP_S_LOG_ADDRS
.. c:function:: int ioctl( int fd, CEC_ADAP_S_LOG_ADDRS, struct cec_log_addrs *argp ) ``int ioctl(int fd, CEC_ADAP_S_LOG_ADDRS, struct cec_log_addrs *argp)``
:name: CEC_ADAP_S_LOG_ADDRS
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct :c:type:`cec_log_addrs`. Pointer to struct :c:type:`cec_log_addrs`.
...@@ -148,7 +150,6 @@ logical address types are already defined will return with error ``EBUSY``. ...@@ -148,7 +150,6 @@ logical address types are already defined will return with error ``EBUSY``.
give the CEC framework more information about the device type, even give the CEC framework more information about the device type, even
though the framework won't use it directly in the CEC message. though the framework won't use it directly in the CEC message.
.. tabularcolumns:: |p{7.8cm}|p{1.0cm}|p{8.7cm}| .. tabularcolumns:: |p{7.8cm}|p{1.0cm}|p{8.7cm}|
.. _cec-log-addrs-flags: .. _cec-log-addrs-flags:
...@@ -185,7 +186,6 @@ logical address types are already defined will return with error ``EBUSY``. ...@@ -185,7 +186,6 @@ logical address types are already defined will return with error ``EBUSY``.
All other messages are ignored. All other messages are ignored.
.. tabularcolumns:: |p{7.8cm}|p{1.0cm}|p{8.7cm}| .. tabularcolumns:: |p{7.8cm}|p{1.0cm}|p{8.7cm}|
.. _cec-versions: .. _cec-versions:
...@@ -211,7 +211,6 @@ logical address types are already defined will return with error ``EBUSY``. ...@@ -211,7 +211,6 @@ logical address types are already defined will return with error ``EBUSY``.
- 6 - 6
- CEC version according to the HDMI 2.0 standard. - CEC version according to the HDMI 2.0 standard.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
.. _cec-prim-dev-types: .. _cec-prim-dev-types:
...@@ -257,7 +256,6 @@ logical address types are already defined will return with error ``EBUSY``. ...@@ -257,7 +256,6 @@ logical address types are already defined will return with error ``EBUSY``.
- 7 - 7
- Use for a video processor device. - Use for a video processor device.
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
.. _cec-log-addr-types: .. _cec-log-addr-types:
...@@ -306,7 +304,6 @@ logical address types are already defined will return with error ``EBUSY``. ...@@ -306,7 +304,6 @@ logical address types are already defined will return with error ``EBUSY``.
Control). Control).
.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}| .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
.. _cec-all-dev-types-flags: .. _cec-all-dev-types-flags:
...@@ -348,7 +345,6 @@ logical address types are already defined will return with error ``EBUSY``. ...@@ -348,7 +345,6 @@ logical address types are already defined will return with error ``EBUSY``.
- This supports the CEC Switch or Video Processing type. - This supports the CEC Switch or Video Processing type.
Return Value Return Value
============ ============
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _CEC_ADAP_PHYS_ADDR: .. _CEC_ADAP_PHYS_ADDR:
.. _CEC_ADAP_G_PHYS_ADDR: .. _CEC_ADAP_G_PHYS_ADDR:
...@@ -13,21 +14,22 @@ Name ...@@ -13,21 +14,22 @@ Name
CEC_ADAP_G_PHYS_ADDR, CEC_ADAP_S_PHYS_ADDR - Get or set the physical address CEC_ADAP_G_PHYS_ADDR, CEC_ADAP_S_PHYS_ADDR - Get or set the physical address
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_ADAP_G_PHYS_ADDR, __u16 *argp ) .. c:macro:: CEC_ADAP_G_PHYS_ADDR
:name: CEC_ADAP_G_PHYS_ADDR
``int ioctl(int fd, CEC_ADAP_G_PHYS_ADDR, __u16 *argp)``
.. c:function:: int ioctl( int fd, CEC_ADAP_S_PHYS_ADDR, __u16 *argp ) .. c:macro:: CEC_ADAP_S_PHYS_ADDR
:name: CEC_ADAP_S_PHYS_ADDR
``int ioctl(int fd, CEC_ADAP_S_PHYS_ADDR, __u16 *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to the CEC address. Pointer to the CEC address.
...@@ -71,7 +73,6 @@ For example, the EDID for each HDMI input of the TV will have a ...@@ -71,7 +73,6 @@ For example, the EDID for each HDMI input of the TV will have a
different physical address of the form a.0.0.0 that the sources will different physical address of the form a.0.0.0 that the sources will
read out and use as their physical address. read out and use as their physical address.
Return Value Return Value
============ ============
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _CEC_DQEVENT: .. _CEC_DQEVENT:
...@@ -11,22 +12,21 @@ Name ...@@ -11,22 +12,21 @@ Name
CEC_DQEVENT - Dequeue a CEC event CEC_DQEVENT - Dequeue a CEC event
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_DQEVENT, struct cec_event *argp ) .. c:macro:: CEC_DQEVENT
:name: CEC_DQEVENT
``int ioctl(int fd, CEC_DQEVENT, struct cec_event *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Description Description
=========== ===========
...@@ -72,7 +72,6 @@ it is guaranteed that the state did change in between the two events. ...@@ -72,7 +72,6 @@ it is guaranteed that the state did change in between the two events.
the HDMI driver is still configuring the device or because the HDMI the HDMI driver is still configuring the device or because the HDMI
device was unbound. device was unbound.
.. c:type:: cec_event_lost_msgs .. c:type:: cec_event_lost_msgs
.. tabularcolumns:: |p{1.0cm}|p{2.0cm}|p{14.5cm}| .. tabularcolumns:: |p{1.0cm}|p{2.0cm}|p{14.5cm}|
...@@ -94,7 +93,6 @@ it is guaranteed that the state did change in between the two events. ...@@ -94,7 +93,6 @@ it is guaranteed that the state did change in between the two events.
replied to within a second according to the CEC specification, replied to within a second according to the CEC specification,
this is more than enough. this is more than enough.
.. tabularcolumns:: |p{1.0cm}|p{4.4cm}|p{2.5cm}|p{9.6cm}| .. tabularcolumns:: |p{1.0cm}|p{4.4cm}|p{2.5cm}|p{9.6cm}|
.. c:type:: cec_event .. c:type:: cec_event
...@@ -130,7 +128,6 @@ it is guaranteed that the state did change in between the two events. ...@@ -130,7 +128,6 @@ it is guaranteed that the state did change in between the two events.
* - } * - }
- -
.. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}| .. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}|
.. _cec-events: .. _cec-events:
...@@ -204,7 +201,6 @@ it is guaranteed that the state did change in between the two events. ...@@ -204,7 +201,6 @@ it is guaranteed that the state did change in between the two events.
if the 5V is high, then an initial event will be generated for that if the 5V is high, then an initial event will be generated for that
filehandle. filehandle.
.. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}| .. tabularcolumns:: |p{6.0cm}|p{0.6cm}|p{10.9cm}|
.. _cec-event-flags: .. _cec-event-flags:
...@@ -230,7 +226,6 @@ it is guaranteed that the state did change in between the two events. ...@@ -230,7 +226,6 @@ it is guaranteed that the state did change in between the two events.
This is an indication that the application cannot keep up. This is an indication that the application cannot keep up.
Return Value Return Value
============ ============
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _CEC_MODE: .. _CEC_MODE:
.. _CEC_G_MODE: .. _CEC_G_MODE:
...@@ -13,17 +14,19 @@ CEC_G_MODE, CEC_S_MODE - Get or set exclusive use of the CEC adapter ...@@ -13,17 +14,19 @@ CEC_G_MODE, CEC_S_MODE - Get or set exclusive use of the CEC adapter
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_G_MODE, __u32 *argp ) .. c:macro:: CEC_G_MODE
:name: CEC_G_MODE
.. c:function:: int ioctl( int fd, CEC_S_MODE, __u32 *argp ) ``int ioctl(int fd, CEC_G_MODE, __u32 *argp)``
:name: CEC_S_MODE
.. c:macro:: CEC_S_MODE
``int ioctl(int fd, CEC_S_MODE, __u32 *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to CEC mode. Pointer to CEC mode.
...@@ -101,7 +104,6 @@ Available initiator modes are: ...@@ -101,7 +104,6 @@ Available initiator modes are:
then an attempt to become one will return the ``EBUSY`` error code then an attempt to become one will return the ``EBUSY`` error code
error. error.
Available follower modes are: Available follower modes are:
.. tabularcolumns:: |p{6.6cm}|p{0.9cm}|p{10.0cm}| .. tabularcolumns:: |p{6.6cm}|p{0.9cm}|p{10.0cm}|
...@@ -193,7 +195,6 @@ Available follower modes are: ...@@ -193,7 +195,6 @@ Available follower modes are:
the process has the ``CAP_NET_ADMIN`` capability. If that is not the process has the ``CAP_NET_ADMIN`` capability. If that is not
set, then the ``EPERM`` error code is returned. set, then the ``EPERM`` error code is returned.
Core message processing details: Core message processing details:
.. tabularcolumns:: |p{6.6cm}|p{10.9cm}| .. tabularcolumns:: |p{6.6cm}|p{10.9cm}|
...@@ -272,7 +273,6 @@ Core message processing details: ...@@ -272,7 +273,6 @@ Core message processing details:
and then just pass the message on to the follower(s). and then just pass the message on to the follower(s).
Return Value Return Value
============ ============
......
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: CEC
.. _CEC_TRANSMIT: .. _CEC_TRANSMIT:
.. _CEC_RECEIVE: .. _CEC_RECEIVE:
...@@ -12,21 +13,22 @@ Name ...@@ -12,21 +13,22 @@ Name
CEC_RECEIVE, CEC_TRANSMIT - Receive or transmit a CEC message CEC_RECEIVE, CEC_TRANSMIT - Receive or transmit a CEC message
Synopsis Synopsis
======== ========
.. c:function:: int ioctl( int fd, CEC_RECEIVE, struct cec_msg \*argp ) .. c:macro:: CEC_RECEIVE
:name: CEC_RECEIVE
``int ioctl(int fd, CEC_RECEIVE, struct cec_msg *argp)``
.. c:function:: int ioctl( int fd, CEC_TRANSMIT, struct cec_msg \*argp ) .. c:macro:: CEC_TRANSMIT
:name: CEC_TRANSMIT
``int ioctl(int fd, CEC_TRANSMIT, struct cec_msg *argp)``
Arguments Arguments
========= =========
``fd`` ``fd``
File descriptor returned by :c:func:`open() <cec-open>`. File descriptor returned by :c:func:`open()`.
``argp`` ``argp``
Pointer to struct cec_msg. Pointer to struct cec_msg.
...@@ -194,7 +196,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). ...@@ -194,7 +196,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV').
supports this, otherwise it is always 0. This counter is only supports this, otherwise it is always 0. This counter is only
valid if the :ref:`CEC_TX_STATUS_ERROR <CEC-TX-STATUS-ERROR>` status bit is set. valid if the :ref:`CEC_TX_STATUS_ERROR <CEC-TX-STATUS-ERROR>` status bit is set.
.. tabularcolumns:: |p{6.2cm}|p{1.0cm}|p{10.3cm}| .. tabularcolumns:: |p{6.2cm}|p{1.0cm}|p{10.3cm}|
.. _cec-msg-flags: .. _cec-msg-flags:
...@@ -228,7 +229,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). ...@@ -228,7 +229,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV').
capability. If that is not set, then the ``EPERM`` error code is capability. If that is not set, then the ``EPERM`` error code is
returned. returned.
.. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}| .. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}|
.. _cec-tx-status: .. _cec-tx-status:
...@@ -298,7 +298,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). ...@@ -298,7 +298,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV').
- The transmit timed out. This should not normally happen and this - The transmit timed out. This should not normally happen and this
indicates a driver problem. indicates a driver problem.
.. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}| .. tabularcolumns:: |p{5.6cm}|p{0.9cm}|p{11.0cm}|
.. _cec-rx-status: .. _cec-rx-status:
...@@ -335,7 +334,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV'). ...@@ -335,7 +334,6 @@ View On' messages from initiator 0xf ('Unregistered') to destination 0 ('TV').
reply was interrupted. reply was interrupted.
Return Value Return Value
============ ============
......
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