^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) .. c:namespace:: RC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) .. _lirc_get_min_timeout:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) .. _lirc_get_max_timeout:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) ****************************************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) ****************************************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) Name
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) ====
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) LIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) range for IR receive.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) Synopsis
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) ========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) .. c:macro:: LIRC_GET_MIN_TIMEOUT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) ``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) .. c:macro:: LIRC_GET_MAX_TIMEOUT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) ``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) Arguments
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) =========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) ``fd``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) File descriptor returned by open().
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) ``timeout``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) Timeout, in microseconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) ===========
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) Some devices have internal timers that can be used to detect when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) there's no IR activity for a long time. This can help lircd in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) detecting that a IR signal is finished and can speed up the decoding
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) process. Returns an integer value with the minimum/maximum timeout
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) that can be set.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) .. note::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) Some devices have a fixed timeout, in that case
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) both ioctls will return the same value even though the timeout
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) Return Value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) ============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) On success 0 is returned, on error -1 and the ``errno`` variable is set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) appropriately. The generic error codes are described at the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) :ref:`Generic Error Codes <gen-errors>` chapter.