xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/rc/lirc-get-timeout.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: RC
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _lirc_get_min_timeout:
5*4882a593Smuzhiyun.. _lirc_get_max_timeout:
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun****************************************************
8*4882a593Smuzhiyunioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
9*4882a593Smuzhiyun****************************************************
10*4882a593Smuzhiyun
11*4882a593SmuzhiyunName
12*4882a593Smuzhiyun====
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunLIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout
15*4882a593Smuzhiyunrange for IR receive.
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunSynopsis
18*4882a593Smuzhiyun========
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun.. c:macro:: LIRC_GET_MIN_TIMEOUT
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun.. c:macro:: LIRC_GET_MAX_TIMEOUT
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``
27*4882a593Smuzhiyun
28*4882a593SmuzhiyunArguments
29*4882a593Smuzhiyun=========
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun``fd``
32*4882a593Smuzhiyun    File descriptor returned by open().
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun``timeout``
35*4882a593Smuzhiyun    Timeout, in microseconds.
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunDescription
38*4882a593Smuzhiyun===========
39*4882a593Smuzhiyun
40*4882a593SmuzhiyunSome devices have internal timers that can be used to detect when
41*4882a593Smuzhiyunthere's no IR activity for a long time. This can help lircd in
42*4882a593Smuzhiyundetecting that a IR signal is finished and can speed up the decoding
43*4882a593Smuzhiyunprocess. Returns an integer value with the minimum/maximum timeout
44*4882a593Smuzhiyunthat can be set.
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun.. note::
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun   Some devices have a fixed timeout, in that case
49*4882a593Smuzhiyun   both ioctls will return the same value even though the timeout
50*4882a593Smuzhiyun   cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
51*4882a593Smuzhiyun
52*4882a593SmuzhiyunReturn Value
53*4882a593Smuzhiyun============
54*4882a593Smuzhiyun
55*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
56*4882a593Smuzhiyunappropriately. The generic error codes are described at the
57*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
58