Commit 572c194b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTS 



Add a separate page for this ioctl and improve its documentation.

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

Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst

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



.. _lirc_set_rec_timeout_reports:



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

ioctl LIRC_SET_REC_TIMEOUT_REPORTS

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



Name

====



LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive



Synopsis

========



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



Arguments

=========



``fd``

    File descriptor returned by open().



``request``

    LIRC_SET_REC_TIMEOUT_REPORTS



``enable``

    enable = 1 means enable timeout report, enable = 0 means disable timeout

    reports.





Description

===========



Enable or disable timeout reports for IR receive. By default, timeout reports

should be turned off.



.. note::



   This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`.





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
@@ -24,4 +24,5 @@ LIRC Device Interface 
    lirc-set-rec-carrier-range

    lirc-set-send-carrier

    lirc-set-transmitter-mask

    lirc-set-rec-timeout-reports

    lirc_ioctl

Documentation/media/uapi/rc/lirc_ioctl.rst

+0 −8
Original line number Diff line number Diff line
@@ -54,14 +54,6 @@ device can rely on working with the default settings initially. 
    Set send/receive mode. Largely obsolete for send, as only

    ``LIRC_MODE_PULSE`` is supported.



.. _LIRC_SET_REC_TIMEOUT_REPORTS:



``LIRC_SET_REC_TIMEOUT_REPORTS``



    Enable (1) or disable (0) timeout reports in ``LIRC_MODE_MODE2.`` By

    default, timeout reports should be turned off.





.. _LIRC_SET_MEASURE_CARRIER_MODE:

.. _lirc-mode2-frequency: