linuxdebug/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst

56 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2024-07-16 15:50:57 +02:00
.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_timeout:
.. _lirc_get_rec_timeout:
***************************************************
ioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
***************************************************
Name
====
LIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.
Synopsis
========
.. c:macro:: LIRC_GET_REC_TIMEOUT
``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
.. c:macro:: LIRC_SET_REC_TIMEOUT
``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
Arguments
=========
``fd``
File descriptor returned by open().
``timeout``
Timeout, in microseconds.
Description
===========
Get and set the integer value for IR inactivity timeout.
If supported by the hardware, setting it to 0 disables all hardware timeouts
and data should be reported as soon as possible. If the exact value
cannot be set, then the next possible value _greater_ than the
given value should be set.
.. note::
The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.