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