1*ac7f9d02SMauro Carvalho Chehab.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
25f536f4aSMauro Carvalho Chehab.. c:namespace:: RC
354f38fcaSMauro Carvalho Chehab
454f38fcaSMauro Carvalho Chehab.. _lirc_set_rec_timeout:
554f38fcaSMauro Carvalho Chehab.. _lirc_get_rec_timeout:
654f38fcaSMauro Carvalho Chehab
754f38fcaSMauro Carvalho Chehab***************************************************
854f38fcaSMauro Carvalho Chehabioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
954f38fcaSMauro Carvalho Chehab***************************************************
1054f38fcaSMauro Carvalho Chehab
1154f38fcaSMauro Carvalho ChehabName
1254f38fcaSMauro Carvalho Chehab====
1354f38fcaSMauro Carvalho Chehab
1454f38fcaSMauro Carvalho ChehabLIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.
1554f38fcaSMauro Carvalho Chehab
1654f38fcaSMauro Carvalho ChehabSynopsis
1754f38fcaSMauro Carvalho Chehab========
1854f38fcaSMauro Carvalho Chehab
195f536f4aSMauro Carvalho Chehab.. c:macro:: LIRC_GET_REC_TIMEOUT
2054f38fcaSMauro Carvalho Chehab
215f536f4aSMauro Carvalho Chehab``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
225f536f4aSMauro Carvalho Chehab
235f536f4aSMauro Carvalho Chehab.. c:macro:: LIRC_SET_REC_TIMEOUT
245f536f4aSMauro Carvalho Chehab
255f536f4aSMauro Carvalho Chehab``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
2654f38fcaSMauro Carvalho Chehab
2754f38fcaSMauro Carvalho ChehabArguments
2854f38fcaSMauro Carvalho Chehab=========
2954f38fcaSMauro Carvalho Chehab
3054f38fcaSMauro Carvalho Chehab``fd``
3154f38fcaSMauro Carvalho Chehab    File descriptor returned by open().
3254f38fcaSMauro Carvalho Chehab
3354f38fcaSMauro Carvalho Chehab``timeout``
3454f38fcaSMauro Carvalho Chehab    Timeout, in microseconds.
3554f38fcaSMauro Carvalho Chehab
3654f38fcaSMauro Carvalho ChehabDescription
3754f38fcaSMauro Carvalho Chehab===========
3854f38fcaSMauro Carvalho Chehab
3954f38fcaSMauro Carvalho ChehabGet and set the integer value for IR inactivity timeout.
4054f38fcaSMauro Carvalho Chehab
4154f38fcaSMauro Carvalho ChehabIf supported by the hardware, setting it to 0  disables all hardware timeouts
4254f38fcaSMauro Carvalho Chehaband data should be reported as soon as possible. If the exact value
4354f38fcaSMauro Carvalho Chehabcannot be set, then the next possible value _greater_ than the
4454f38fcaSMauro Carvalho Chehabgiven value should be set.
4554f38fcaSMauro Carvalho Chehab
4654f38fcaSMauro Carvalho Chehab.. note::
4754f38fcaSMauro Carvalho Chehab
4854f38fcaSMauro Carvalho Chehab   The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
4954f38fcaSMauro Carvalho Chehab
5054f38fcaSMauro Carvalho ChehabReturn Value
5154f38fcaSMauro Carvalho Chehab============
5254f38fcaSMauro Carvalho Chehab
5354f38fcaSMauro Carvalho ChehabOn success 0 is returned, on error -1 and the ``errno`` variable is set
5454f38fcaSMauro Carvalho Chehabappropriately. The generic error codes are described at the
5554f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
56