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

Commit 15c19014 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] docs-rst: Convert LIRC 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 99547836

Documentation/media/uapi/rc/lirc-get-features.rst

+2 −4
Original line number Original line Diff line number Diff line
@@ -14,7 +14,8 @@ LIRC_GET_FEATURES - Get the underlying hardware device's features 
Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, __u32 *features)

.. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features)

    :name: LIRC_GET_FEATURES





Arguments

Arguments

=========

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

``fd``

    File descriptor returned by open().

    File descriptor returned by open().





``request``

    LIRC_GET_FEATURES



``features``

``features``

    Bitmask with the LIRC features.

    Bitmask with the LIRC features.

Documentation/media/uapi/rc/lirc-get-length.rst

+2 −4
Original line number Original line Diff line number Diff line
@@ -14,7 +14,8 @@ LIRC_GET_LENGTH - Retrieves the code length in bits. 
Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, __u32 *length )

.. c:function:: int ioctl( int fd, LIRC_GET_LENGTH, __u32 *length )

    :name: LIRC_GET_LENGTH





Arguments

Arguments

=========

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

``fd``

    File descriptor returned by open().

    File descriptor returned by open().





``request``

    LIRC_GET_LENGTH



``length``

``length``

    length, in bits

    length, in bits

Documentation/media/uapi/rc/lirc-get-rec-mode.rst

+6 −5
Original line number Original line Diff line number Diff line
@@ -10,12 +10,16 @@ ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE 
Name

Name

====

====





LIRC_GET_REC_MODE/LIRC_GET_REC_MODE - Get/set supported receive modes.

LIRC_GET_REC_MODE/LIRC_SET_REC_MODE - Get/set supported receive modes.





Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, __u32 rx_modes)

.. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 rx_modes)

	:name: LIRC_GET_REC_MODE



.. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 rx_modes)

	:name: LIRC_SET_REC_MODE





Arguments

Arguments

=========

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

``fd``

    File descriptor returned by open().

    File descriptor returned by open().





``request``

    LIRC_GET_REC_MODE or LIRC_GET_REC_MODE



``rx_modes``

``rx_modes``

    Bitmask with the supported transmit modes.

    Bitmask with the supported transmit modes.

Documentation/media/uapi/rc/lirc-get-rec-resolution.rst

+2 −4
Original line number Original line Diff line number Diff line
@@ -14,7 +14,8 @@ LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microsecond 
Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, __u32 *microseconds)

.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)

    :name: LIRC_GET_REC_RESOLUTION





Arguments

Arguments

=========

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

``fd``

    File descriptor returned by open().

    File descriptor returned by open().





``request``

    LIRC_GET_REC_RESOLUTION



``microseconds``

``microseconds``

    Resolution, in microseconds.

    Resolution, in microseconds.

Documentation/media/uapi/rc/lirc-get-send-mode.rst

+5 −4
Original line number Original line Diff line number Diff line
@@ -15,7 +15,11 @@ LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set supported transmit mode. 
Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, __u32 *tx_modes )

.. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *tx_modes )

    :name: LIRC_GET_SEND_MODE



.. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *tx_modes )

    :name: LIRC_SET_SEND_MODE





Arguments

Arguments

=========

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

``fd``

    File descriptor returned by open().

    File descriptor returned by open().





``request``

    LIRC_GET_SEND_MODE



``tx_modes``

``tx_modes``

    Bitmask with the supported transmit modes.

    Bitmask with the supported transmit modes.