56 lines · plain
1.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later2.. c:namespace:: RC3 4.. _lirc_set_rec_timeout:5.. _lirc_get_rec_timeout:6 7***************************************************8ioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT9***************************************************10 11Name12====13 14LIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.15 16Synopsis17========18 19.. c:macro:: LIRC_GET_REC_TIMEOUT20 21``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``22 23.. c:macro:: LIRC_SET_REC_TIMEOUT24 25``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``26 27Arguments28=========29 30``fd``31 File descriptor returned by open().32 33``timeout``34 Timeout, in microseconds.35 36Description37===========38 39Get and set the integer value for IR inactivity timeout.40 41If supported by the hardware, setting it to 0 disables all hardware timeouts42and data should be reported as soon as possible. If the exact value43cannot be set, then the next possible value _greater_ than the44given value should be set.45 46.. note::47 48 The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.49 50Return Value51============52 53On success 0 is returned, on error -1 and the ``errno`` variable is set54appropriately. The generic error codes are described at the55:ref:`Generic Error Codes <gen-errors>` chapter.56