1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1. 1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: RC 2 .. c:namespace:: RC
3 3
4 .. _lirc_get_min_timeout: 4 .. _lirc_get_min_timeout:
5 .. _lirc_get_max_timeout: 5 .. _lirc_get_max_timeout:
6 6
7 ********************************************** 7 ****************************************************
8 ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_T 8 ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
9 ********************************************** 9 ****************************************************
10 10
11 Name 11 Name
12 ==== 12 ====
13 13
14 LIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - 14 LIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout
15 range for IR receive. 15 range for IR receive.
16 16
17 Synopsis 17 Synopsis
18 ======== 18 ========
19 19
20 .. c:macro:: LIRC_GET_MIN_TIMEOUT 20 .. c:macro:: LIRC_GET_MIN_TIMEOUT
21 21
22 ``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u3 22 ``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``
23 23
24 .. c:macro:: LIRC_GET_MAX_TIMEOUT 24 .. c:macro:: LIRC_GET_MAX_TIMEOUT
25 25
26 ``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u3 26 ``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``
27 27
28 Arguments 28 Arguments
29 ========= 29 =========
30 30
31 ``fd`` 31 ``fd``
32 File descriptor returned by open(). 32 File descriptor returned by open().
33 33
34 ``timeout`` 34 ``timeout``
35 Timeout, in microseconds. 35 Timeout, in microseconds.
36 36
37 Description 37 Description
38 =========== 38 ===========
39 39
40 Some devices have internal timers that can be 40 Some devices have internal timers that can be used to detect when
41 there's no IR activity for a long time. This c 41 there's no IR activity for a long time. This can help lircd in
42 detecting that a IR signal is finished and can 42 detecting that a IR signal is finished and can speed up the decoding
43 process. Returns an integer value with the min 43 process. Returns an integer value with the minimum/maximum timeout
44 that can be set. 44 that can be set.
45 45
46 .. note:: 46 .. note::
47 47
48 Some devices have a fixed timeout, in that 48 Some devices have a fixed timeout, in that case
49 both ioctls will return the same value even 49 both ioctls will return the same value even though the timeout
50 cannot be changed via :ref:`LIRC_SET_REC_TI 50 cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
51 51
52 Return Value 52 Return Value
53 ============ 53 ============
54 54
55 On success 0 is returned, on error -1 and the 55 On success 0 is returned, on error -1 and the ``errno`` variable is set
56 appropriately. The generic error codes are des 56 appropriately. The generic error codes are described at the
57 :ref:`Generic Error Codes <gen-errors>` chapte 57 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.