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

   1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: RC
   3
   4 .. _lirc_set_rec_timeout_reports:
   5
   6 **********************************
   7 ioctl LIRC_SET_REC_TIMEOUT_REPORTS
   8 **********************************
   9
  10 Name
  11 ====
  12
  13 LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive
  14
  15 Synopsis
  16 ========
  17
  18 .. c:macro:: LIRC_SET_REC_TIMEOUT_REPORTS
  19
  20 ``int ioctl(int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable)``
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by open().
  27
  28 ``enable``
  29     enable = 1 means enable timeout report, enable = 0 means disable timeout
  30     reports.
  31
  32 Description
  33 ===========
  34
  35 .. _lirc-mode2-timeout:
  36
  37 Enable or disable timeout reports for IR receive. By default, timeout reports
  38 should be turned off.
  39
  40 .. note::
  41
  42    This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`.
  43
  44 Return Value
  45 ============
  46
  47 On success 0 is returned, on error -1 and the ``errno`` variable is set
  48 appropriately. The generic error codes are described at the
  49 :ref:`Generic Error Codes <gen-errors>` chapter.