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