Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 99547836 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] docs-rst: Convert CEC uAPI to use C function references 



Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

While here, improve the documentation to make them to look more
like the rest of the document.

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

Documentation/media/uapi/cec/cec-func-close.rst

+2 −1
Original line number Diff line number Diff line
@@ -21,12 +21,13 @@ Synopsis 




.. c:function:: int close( int fd )

    :name: cec-close



Arguments

=========



``fd``

    File descriptor returned by :ref:`open() <func-open>`.

    File descriptor returned by :c:func:`open() <cec-open>`.





Description

Documentation/media/uapi/cec/cec-func-ioctl.rst

+3 −2
Original line number Diff line number Diff line
@@ -20,16 +20,17 @@ Synopsis 




.. c:function:: int ioctl( int fd, int request, void *argp )

   :name: cec-ioctl



Arguments

=========



``fd``

    File descriptor returned by :ref:`open() <func-open>`.

    File descriptor returned by :c:func:`open() <cec-open>`.



``request``

    CEC ioctl request code as defined in the cec.h header file, for

    example :ref:`CEC_ADAP_G_CAPS`.

    example :c:func:`CEC_ADAP_G_CAPS`.



``argp``

    Pointer to a request-specific structure.

Documentation/media/uapi/cec/cec-func-open.rst

+1 −0
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ Synopsis 




.. c:function:: int open( const char *device_name, int flags )

   :name: cec-open





Arguments

Documentation/media/uapi/cec/cec-func-poll.rst

+10 −0
Original line number Diff line number Diff line
@@ -21,10 +21,20 @@ Synopsis 




.. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )

   :name: cec-poll



Arguments

=========



``ufds``

   List of FD events to be watched



``nfds``

   Number of FD efents at the \*ufds array



``timeout``

   Timeout to wait for events





Description

===========

Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst

+2 −4
Original line number Diff line number Diff line
@@ -14,7 +14,8 @@ CEC_ADAP_G_CAPS - Query device capabilities 
Synopsis

========



.. c:function:: int ioctl( int fd, int request, struct cec_caps *argp )

.. c:function:: int ioctl( int fd, CEC_ADAP_G_CAPS, struct cec_caps *argp )

    :name: CEC_ADAP_G_CAPS



Arguments

=========
@@ -22,9 +23,6 @@ Arguments 
``fd``

    File descriptor returned by :ref:`open() <cec-func-open>`.



``request``

    CEC_ADAP_G_CAPS



``argp``