Documentation/media/uapi/rc/lirc-set-rec-timeout.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:
  11 .. _lirc_get_rec_timeout:
  12
  13 ***************************************************
  14 ioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
  15 ***************************************************
  16
  17 Name
  18 ====
  19
  20 LIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout )
  26     :name: LIRC_GET_REC_TIMEOUT
  27
  28 .. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout )
  29     :name: LIRC_SET_REC_TIMEOUT
  30
  31 Arguments
  32 =========
  33
  34 ``fd``
  35     File descriptor returned by open().
  36
  37 ``timeout``
  38     Timeout, in microseconds.
  39
  40
  41 Description
  42 ===========
  43
  44 Get and set the integer value for IR inactivity timeout.
  45
  46 If supported by the hardware, setting it to 0  disables all hardware timeouts
  47 and data should be reported as soon as possible. If the exact value
  48 cannot be set, then the next possible value _greater_ than the
  49 given value should be set.
  50
  51 .. note::
  52
  53    The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
  54
  55
  56 Return Value
  57 ============
  58
  59 On success 0 is returned, on error -1 and the ``errno`` variable is set
  60 appropriately. The generic error codes are described at the
  61 :ref:`Generic Error Codes <gen-errors>` chapter.