| David Brazdil | 0f672f6 | 2019-12-10 10:32:29 +0000 | [diff] [blame^] | 1 | .. Permission is granted to copy, distribute and/or modify this |
| 2 | .. document under the terms of the GNU Free Documentation License, |
| 3 | .. Version 1.1 or any later version published by the Free Software |
| 4 | .. Foundation, with no Invariant Sections, no Front-Cover Texts |
| 5 | .. and no Back-Cover Texts. A copy of the license is included at |
| 6 | .. Documentation/media/uapi/fdl-appendix.rst. |
| 7 | .. |
| 8 | .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections |
| Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 9 | |
| 10 | .. _lirc_get_min_timeout: |
| 11 | .. _lirc_get_max_timeout: |
| 12 | |
| 13 | **************************************************** |
| 14 | ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT |
| 15 | **************************************************** |
| 16 | |
| 17 | Name |
| 18 | ==== |
| 19 | |
| 20 | LIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout |
| 21 | range for IR receive. |
| 22 | |
| 23 | Synopsis |
| 24 | ======== |
| 25 | |
| 26 | .. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout) |
| 27 | :name: LIRC_GET_MIN_TIMEOUT |
| 28 | |
| 29 | .. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout) |
| 30 | :name: LIRC_GET_MAX_TIMEOUT |
| 31 | |
| 32 | Arguments |
| 33 | ========= |
| 34 | |
| 35 | ``fd`` |
| 36 | File descriptor returned by open(). |
| 37 | |
| 38 | ``timeout`` |
| 39 | Timeout, in microseconds. |
| 40 | |
| 41 | |
| 42 | Description |
| 43 | =========== |
| 44 | |
| 45 | Some devices have internal timers that can be used to detect when |
| 46 | there's no IR activity for a long time. This can help lircd in |
| 47 | detecting that a IR signal is finished and can speed up the decoding |
| 48 | process. Returns an integer value with the minimum/maximum timeout |
| 49 | that can be set. |
| 50 | |
| 51 | .. note:: |
| 52 | |
| 53 | Some devices have a fixed timeout, in that case |
| 54 | both ioctls will return the same value even though the timeout |
| 55 | cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`. |
| 56 | |
| 57 | |
| 58 | Return Value |
| 59 | ============ |
| 60 | |
| 61 | On success 0 is returned, on error -1 and the ``errno`` variable is set |
| 62 | appropriately. The generic error codes are described at the |
| 63 | :ref:`Generic Error Codes <gen-errors>` chapter. |