18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: RC
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _lirc_set_rec_timeout:
58c2ecf20Sopenharmony_ci.. _lirc_get_rec_timeout:
68c2ecf20Sopenharmony_ci
78c2ecf20Sopenharmony_ci***************************************************
88c2ecf20Sopenharmony_ciioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
98c2ecf20Sopenharmony_ci***************************************************
108c2ecf20Sopenharmony_ci
118c2ecf20Sopenharmony_ciName
128c2ecf20Sopenharmony_ci====
138c2ecf20Sopenharmony_ci
148c2ecf20Sopenharmony_ciLIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.
158c2ecf20Sopenharmony_ci
168c2ecf20Sopenharmony_ciSynopsis
178c2ecf20Sopenharmony_ci========
188c2ecf20Sopenharmony_ci
198c2ecf20Sopenharmony_ci.. c:macro:: LIRC_GET_REC_TIMEOUT
208c2ecf20Sopenharmony_ci
218c2ecf20Sopenharmony_ci``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
228c2ecf20Sopenharmony_ci
238c2ecf20Sopenharmony_ci.. c:macro:: LIRC_SET_REC_TIMEOUT
248c2ecf20Sopenharmony_ci
258c2ecf20Sopenharmony_ci``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
268c2ecf20Sopenharmony_ci
278c2ecf20Sopenharmony_ciArguments
288c2ecf20Sopenharmony_ci=========
298c2ecf20Sopenharmony_ci
308c2ecf20Sopenharmony_ci``fd``
318c2ecf20Sopenharmony_ci    File descriptor returned by open().
328c2ecf20Sopenharmony_ci
338c2ecf20Sopenharmony_ci``timeout``
348c2ecf20Sopenharmony_ci    Timeout, in microseconds.
358c2ecf20Sopenharmony_ci
368c2ecf20Sopenharmony_ciDescription
378c2ecf20Sopenharmony_ci===========
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ciGet and set the integer value for IR inactivity timeout.
408c2ecf20Sopenharmony_ci
418c2ecf20Sopenharmony_ciIf supported by the hardware, setting it to 0  disables all hardware timeouts
428c2ecf20Sopenharmony_ciand data should be reported as soon as possible. If the exact value
438c2ecf20Sopenharmony_cicannot be set, then the next possible value _greater_ than the
448c2ecf20Sopenharmony_cigiven value should be set.
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ci.. note::
478c2ecf20Sopenharmony_ci
488c2ecf20Sopenharmony_ci   The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
498c2ecf20Sopenharmony_ci
508c2ecf20Sopenharmony_ciReturn Value
518c2ecf20Sopenharmony_ci============
528c2ecf20Sopenharmony_ci
538c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
548c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
558c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
56