Commit 2606eee4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] docs-rst: fix cec bad cross-references 



Fix some CEC cross references that are broken.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 180965cb

Documentation/media/cec.h.rst.exceptions

+0 −6
Original line number Diff line number Diff line 
# Ignore header name

ignore define _CEC_UAPI_H



# Rename some symbols, to avoid namespace conflicts

replace struct cec_event_state_change cec-event-state-change_s

replace struct cec_event_lost_msgs cec-event-lost-msgs_s

replace enum cec_mode_initiator cec-mode-initiator_e

replace enum cec_mode_follower cec-mode-follower_e



# define macros to ignore



ignore define CEC_MAX_MSG_SIZE

Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst

+5 −5
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ Arguments 
    File descriptor returned by :c:func:`open() <cec-open>`.



``argp``

    Pointer to struct cec_log_addrs

    Pointer to struct :c:type:`cec_log_addrs`.



Description

===========
@@ -42,10 +42,10 @@ Description 


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.

struct :c:type:`cec_log_addrs` where the driver stores the logical addresses.



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>`

struct :c:type:`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 (the ``ENOTTY`` error code is

returned otherwise). The :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>`
@@ -66,10 +66,10 @@ logical addresses are claimed or cleared. 
Attempting to call :ref:`ioctl CEC_ADAP_S_LOG_ADDRS <CEC_ADAP_S_LOG_ADDRS>` when

logical address types are already defined will return with error ``EBUSY``.



.. tabularcolumns:: |p{1.0cm}|p{7.5cm}|p{8.0cm}|



.. c:type:: cec_log_addrs



.. tabularcolumns:: |p{1.0cm}|p{7.5cm}|p{8.0cm}|



.. cssclass:: longtable



.. flat-table:: struct cec_log_addrs

Documentation/media/uapi/cec/cec-ioc-receive.rst

+5 −4
Original line number Diff line number Diff line
@@ -40,7 +40,8 @@ Description 
   and is currently only available as a staging kernel module.



To receive a CEC message the application has to fill in the

``timeout`` field of :c:type:`struct cec_msg` and pass it to :ref:`ioctl CEC_RECEIVE <CEC_RECEIVE>`.

``timeout`` field of struct :c:type:`cec_msg` and pass it to

:ref:`ioctl CEC_RECEIVE <CEC_RECEIVE>`.

If the file descriptor is in non-blocking mode and there are no received

messages pending, then it will return -1 and set errno to the ``EAGAIN``

error code. If the file descriptor is in blocking mode and ``timeout``
@@ -54,9 +55,9 @@ A received message can be: 
2. the result of an earlier non-blocking transmit (the ``sequence`` field will

   be non-zero).



To send a CEC message the application has to fill in the

:c:type:`struct cec_msg` and pass it to

:ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>`. The :ref:`ioctl CEC_TRANSMIT <CEC_TRANSMIT>` is only available if

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>`.

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

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