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

[media] doc-rst: document ioctl LIRC_GET_REC_MODE 



Move the documentation of this ioctl from lirc_ioctl to its
own file, and add a short description about the pulse mode
used by IR RX.

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

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

0 → 100644
+59 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _lirc_get_rec_mode:



***********************

ioctl LIRC_GET_REC_MODE

***********************



Name

====



LIRC_GET_REC_MODE - Get supported receive modes.



Synopsis

========



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



Arguments

=========



``fd``

    File descriptor returned by open().



``request``

    LIRC_GET_REC_MODE



``rx_modes``

    Bitmask with the supported transmit modes.



Description

===========



Get supported receive modes.



Supported receive modes

=======================



.. _lirc-mode-mode2:



``LIRC_MODE_MODE2``



    The driver returns a sequence of pulse and space codes to userspace.



.. _lirc-mode-lirccode:



``LIRC_MODE_LIRCCODE``



    The IR signal is decoded internally by the receiver. The LIRC interface

    returns the scancode as an integer value. This is the usual mode used

    by several TV media cards.





Return Value

============



On success 0 is returned, on error -1 and the ``errno`` variable is set

appropriately. The generic error codes are described at the

:ref:`Generic Error Codes <gen-errors>` chapter.

Documentation/media/uapi/rc/lirc_device_interface.rst

+1 −0
Original line number Diff line number Diff line
@@ -14,4 +14,5 @@ LIRC Device Interface 
    lirc_write

    lirc-get-features

    lirc-get-send-mode

    lirc-get-rec-mode

    lirc_ioctl

Documentation/media/uapi/rc/lirc_ioctl.rst

+0 −9
Original line number Diff line number Diff line
@@ -49,15 +49,6 @@ device can rely on working with the default settings initially. 
I/O control requests

====================



.. _LIRC_GET_REC_MODE:

.. _lirc-mode-mode2:

.. _lirc-mode-lirccode:



``LIRC_GET_REC_MODE``



    Get supported receive modes. Only ``LIRC_MODE_MODE2`` and

    ``LIRC_MODE_LIRCCODE`` are supported by lircd.



.. _LIRC_SET_SEND_DUTY_CYCLE:



``LIRC_SET_SEND_DUTY_CYCLE``