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

[media] cec: documentation fixes

Fixed a few spelling mistakes, but mostly incorrect rst syntax that caused wrong
references or font style.

No actual documentation changes, just fixes.
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 5086924a
...@@ -30,7 +30,7 @@ Arguments ...@@ -30,7 +30,7 @@ Arguments
``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
example :c:func:`CEC_ADAP_G_CAPS`. example :ref:`CEC_ADAP_G_CAPS <CEC_ADAP_G_CAPS>`.
``argp`` ``argp``
Pointer to a request-specific structure. Pointer to a request-specific structure.
......
...@@ -33,7 +33,7 @@ Arguments ...@@ -33,7 +33,7 @@ Arguments
Open flags. Access mode must be ``O_RDWR``. Open flags. Access mode must be ``O_RDWR``.
When the ``O_NONBLOCK`` flag is given, the When the ``O_NONBLOCK`` flag is given, the
:ref:`CEC_RECEIVE <CEC_RECEIVE>` and :c:func:`CEC_DQEVENT` ioctls :ref:`CEC_RECEIVE <CEC_RECEIVE>` and :ref:`CEC_DQEVENT <CEC_DQEVENT>` ioctls
will return the ``EAGAIN`` error code when no message or event is available, and will return the ``EAGAIN`` error code when no message or event is available, and
ioctls :ref:`CEC_TRANSMIT <CEC_TRANSMIT>`, ioctls :ref:`CEC_TRANSMIT <CEC_TRANSMIT>`,
:ref:`CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>` and :ref:`CEC_ADAP_S_PHYS_ADDR <CEC_ADAP_S_PHYS_ADDR>` and
......
...@@ -30,7 +30,7 @@ Arguments ...@@ -30,7 +30,7 @@ Arguments
List of FD events to be watched List of FD events to be watched
``nfds`` ``nfds``
Number of FD efents at the \*ufds array Number of FD events at the \*ufds array
``timeout`` ``timeout``
Timeout to wait for events Timeout to wait for events
...@@ -49,7 +49,7 @@ is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in ...@@ -49,7 +49,7 @@ is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in
the ``revents`` field if there are messages in the receive queue. If the the ``revents`` field if there are messages in the receive queue. If the
transmit queue has room for new messages, the ``POLLOUT`` and transmit queue has room for new messages, the ``POLLOUT`` and
``POLLWRNORM`` flags are set. If there are events in the event queue, ``POLLWRNORM`` flags are set. If there are events in the event queue,
then the ``POLLPRI`` flag is set. When the function timed out it returns 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.
......
...@@ -56,7 +56,7 @@ it is guaranteed that the state did change in between the two events. ...@@ -56,7 +56,7 @@ it is guaranteed that the state did change in between the two events.
* - __u16 * - __u16
- ``phys_addr`` - ``phys_addr``
- The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no - The current physical address. This is ``CEC_PHYS_ADDR_INVALID`` if no
valid physical address is set. valid physical address is set.
* - __u16 * - __u16
- ``log_addr_mask`` - ``log_addr_mask``
- The current set of claimed logical addresses. This is 0 if no logical - The current set of claimed logical addresses. This is 0 if no logical
......
...@@ -51,13 +51,13 @@ A received message can be: ...@@ -51,13 +51,13 @@ A received message can be:
be non-zero). be non-zero).
To send a CEC message the application has to fill in the struct To send a CEC message the application has to fill in the struct
:c:type:` cec_msg` and pass it to :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>`. :c:type:`cec_msg` and pass it to :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>`.
The :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>` is only available if The :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>` is only available if
``CEC_CAP_TRANSMIT`` is set. If there is no more room in the transmit ``CEC_CAP_TRANSMIT`` is set. If there is no more room in the transmit
queue, then it will return -1 and set errno to the ``EBUSY`` error code. queue, then it will return -1 and set errno to the ``EBUSY`` error code.
The transmit queue has enough room for 18 messages (about 1 second worth The transmit queue has enough room for 18 messages (about 1 second worth
of 2-byte messages). Note that the CEC kernel framework will also reply of 2-byte messages). Note that the CEC kernel framework will also reply
to core messages (see :ref:cec-core-processing), so it is not a good to core messages (see :ref:`cec-core-processing`), so it is not a good
idea to fully fill up the transmit queue. idea to fully fill up the transmit queue.
If the file descriptor is in non-blocking mode then the transmit will If the file descriptor is in non-blocking mode then the transmit will
......
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