linux/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst
Mauro Carvalho Chehab 572c194b88 [media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTS
Add a separate page for this ioctl and improve its documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12 09:42:56 -03:00

50 lines
995 B
ReStructuredText

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