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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _lirc_set_rec_timeout_reports:
  11
  12 **********************************
  13 ioctl LIRC_SET_REC_TIMEOUT_REPORTS
  14 **********************************
  15
  16 Name
  17 ====
  18
  19 LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive
  20
  21 Synopsis
  22 ========
  23
  24 .. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable )
  25     :name: LIRC_SET_REC_TIMEOUT_REPORTS
  26
  27 Arguments
  28 =========
  29
  30 ``fd``
  31     File descriptor returned by open().
  32
  33 ``enable``
  34     enable = 1 means enable timeout report, enable = 0 means disable timeout
  35     reports.
  36
  37
  38 Description
  39 ===========
  40
  41 .. _lirc-mode2-timeout:
  42
  43 Enable or disable timeout reports for IR receive. By default, timeout reports
  44 should be turned off.
  45
  46 .. note::
  47
  48    This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`.
  49
  50
  51 Return Value
  52 ============
  53
  54 On success 0 is returned, on error -1 and the ``errno`` variable is set
  55 appropriately. The generic error codes are described at the
  56 :ref:`Generic Error Codes <gen-errors>` chapter.