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