18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: RC
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _lirc_get_min_timeout:
58c2ecf20Sopenharmony_ci.. _lirc_get_max_timeout:
68c2ecf20Sopenharmony_ci
78c2ecf20Sopenharmony_ci****************************************************
88c2ecf20Sopenharmony_ciioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
98c2ecf20Sopenharmony_ci****************************************************
108c2ecf20Sopenharmony_ci
118c2ecf20Sopenharmony_ciName
128c2ecf20Sopenharmony_ci====
138c2ecf20Sopenharmony_ci
148c2ecf20Sopenharmony_ciLIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout
158c2ecf20Sopenharmony_cirange for IR receive.
168c2ecf20Sopenharmony_ci
178c2ecf20Sopenharmony_ciSynopsis
188c2ecf20Sopenharmony_ci========
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci.. c:macro:: LIRC_GET_MIN_TIMEOUT
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ci``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ci.. c:macro:: LIRC_GET_MAX_TIMEOUT
258c2ecf20Sopenharmony_ci
268c2ecf20Sopenharmony_ci``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``
278c2ecf20Sopenharmony_ci
288c2ecf20Sopenharmony_ciArguments
298c2ecf20Sopenharmony_ci=========
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ci``fd``
328c2ecf20Sopenharmony_ci    File descriptor returned by open().
338c2ecf20Sopenharmony_ci
348c2ecf20Sopenharmony_ci``timeout``
358c2ecf20Sopenharmony_ci    Timeout, in microseconds.
368c2ecf20Sopenharmony_ci
378c2ecf20Sopenharmony_ciDescription
388c2ecf20Sopenharmony_ci===========
398c2ecf20Sopenharmony_ci
408c2ecf20Sopenharmony_ciSome devices have internal timers that can be used to detect when
418c2ecf20Sopenharmony_cithere's no IR activity for a long time. This can help lircd in
428c2ecf20Sopenharmony_cidetecting that a IR signal is finished and can speed up the decoding
438c2ecf20Sopenharmony_ciprocess. Returns an integer value with the minimum/maximum timeout
448c2ecf20Sopenharmony_cithat can be set.
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ci.. note::
478c2ecf20Sopenharmony_ci
488c2ecf20Sopenharmony_ci   Some devices have a fixed timeout, in that case
498c2ecf20Sopenharmony_ci   both ioctls will return the same value even though the timeout
508c2ecf20Sopenharmony_ci   cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
518c2ecf20Sopenharmony_ci
528c2ecf20Sopenharmony_ciReturn Value
538c2ecf20Sopenharmony_ci============
548c2ecf20Sopenharmony_ci
558c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
568c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
578c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
58