0001 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: RC
0003
0004 .. _lirc_set_rec_timeout:
0005 .. _lirc_get_rec_timeout:
0006
0007 ***************************************************
0008 ioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
0009 ***************************************************
0010
0011 Name
0012 ====
0013
0014 LIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.
0015
0016 Synopsis
0017 ========
0018
0019 .. c:macro:: LIRC_GET_REC_TIMEOUT
0020
0021 ``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
0022
0023 .. c:macro:: LIRC_SET_REC_TIMEOUT
0024
0025 ``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
0026
0027 Arguments
0028 =========
0029
0030 ``fd``
0031 File descriptor returned by open().
0032
0033 ``timeout``
0034 Timeout, in microseconds.
0035
0036 Description
0037 ===========
0038
0039 Get and set the integer value for IR inactivity timeout.
0040
0041 If supported by the hardware, setting it to 0 disables all hardware timeouts
0042 and data should be reported as soon as possible. If the exact value
0043 cannot be set, then the next possible value _greater_ than the
0044 given value should be set.
0045
0046 .. note::
0047
0048 The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
0049
0050 Return Value
0051 ============
0052
0053 On success 0 is returned, on error -1 and the ``errno`` variable is set
0054 appropriately. The generic error codes are described at the
0055 :ref:`Generic Error Codes <gen-errors>` chapter.
