xref: /linux/Documentation/userspace-api/media/rc/lirc-get-timeout.rst (revision 54f38fcae536ea202ce7d6a359521492fba30c1f)
1*54f38fcaSMauro Carvalho Chehab.. Permission is granted to copy, distribute and/or modify this
2*54f38fcaSMauro Carvalho Chehab.. document under the terms of the GNU Free Documentation License,
3*54f38fcaSMauro Carvalho Chehab.. Version 1.1 or any later version published by the Free Software
4*54f38fcaSMauro Carvalho Chehab.. Foundation, with no Invariant Sections, no Front-Cover Texts
5*54f38fcaSMauro Carvalho Chehab.. and no Back-Cover Texts. A copy of the license is included at
6*54f38fcaSMauro Carvalho Chehab.. Documentation/userspace-api/media/fdl-appendix.rst.
7*54f38fcaSMauro Carvalho Chehab..
8*54f38fcaSMauro Carvalho Chehab.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9*54f38fcaSMauro Carvalho Chehab
10*54f38fcaSMauro Carvalho Chehab.. _lirc_get_min_timeout:
11*54f38fcaSMauro Carvalho Chehab.. _lirc_get_max_timeout:
12*54f38fcaSMauro Carvalho Chehab
13*54f38fcaSMauro Carvalho Chehab****************************************************
14*54f38fcaSMauro Carvalho Chehabioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
15*54f38fcaSMauro Carvalho Chehab****************************************************
16*54f38fcaSMauro Carvalho Chehab
17*54f38fcaSMauro Carvalho ChehabName
18*54f38fcaSMauro Carvalho Chehab====
19*54f38fcaSMauro Carvalho Chehab
20*54f38fcaSMauro Carvalho ChehabLIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout
21*54f38fcaSMauro Carvalho Chehabrange for IR receive.
22*54f38fcaSMauro Carvalho Chehab
23*54f38fcaSMauro Carvalho ChehabSynopsis
24*54f38fcaSMauro Carvalho Chehab========
25*54f38fcaSMauro Carvalho Chehab
26*54f38fcaSMauro Carvalho Chehab.. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)
27*54f38fcaSMauro Carvalho Chehab    :name: LIRC_GET_MIN_TIMEOUT
28*54f38fcaSMauro Carvalho Chehab
29*54f38fcaSMauro Carvalho Chehab.. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)
30*54f38fcaSMauro Carvalho Chehab    :name: LIRC_GET_MAX_TIMEOUT
31*54f38fcaSMauro Carvalho Chehab
32*54f38fcaSMauro Carvalho ChehabArguments
33*54f38fcaSMauro Carvalho Chehab=========
34*54f38fcaSMauro Carvalho Chehab
35*54f38fcaSMauro Carvalho Chehab``fd``
36*54f38fcaSMauro Carvalho Chehab    File descriptor returned by open().
37*54f38fcaSMauro Carvalho Chehab
38*54f38fcaSMauro Carvalho Chehab``timeout``
39*54f38fcaSMauro Carvalho Chehab    Timeout, in microseconds.
40*54f38fcaSMauro Carvalho Chehab
41*54f38fcaSMauro Carvalho Chehab
42*54f38fcaSMauro Carvalho ChehabDescription
43*54f38fcaSMauro Carvalho Chehab===========
44*54f38fcaSMauro Carvalho Chehab
45*54f38fcaSMauro Carvalho ChehabSome devices have internal timers that can be used to detect when
46*54f38fcaSMauro Carvalho Chehabthere's no IR activity for a long time. This can help lircd in
47*54f38fcaSMauro Carvalho Chehabdetecting that a IR signal is finished and can speed up the decoding
48*54f38fcaSMauro Carvalho Chehabprocess. Returns an integer value with the minimum/maximum timeout
49*54f38fcaSMauro Carvalho Chehabthat can be set.
50*54f38fcaSMauro Carvalho Chehab
51*54f38fcaSMauro Carvalho Chehab.. note::
52*54f38fcaSMauro Carvalho Chehab
53*54f38fcaSMauro Carvalho Chehab   Some devices have a fixed timeout, in that case
54*54f38fcaSMauro Carvalho Chehab   both ioctls will return the same value even though the timeout
55*54f38fcaSMauro Carvalho Chehab   cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
56*54f38fcaSMauro Carvalho Chehab
57*54f38fcaSMauro Carvalho Chehab
58*54f38fcaSMauro Carvalho ChehabReturn Value
59*54f38fcaSMauro Carvalho Chehab============
60*54f38fcaSMauro Carvalho Chehab
61*54f38fcaSMauro Carvalho ChehabOn success 0 is returned, on error -1 and the ``errno`` variable is set
62*54f38fcaSMauro Carvalho Chehabappropriately. The generic error codes are described at the
63*54f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
64