mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-28 13:34:38 +08:00
15c190146c
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
51 lines
1.1 KiB
ReStructuredText
51 lines
1.1 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _lirc_set_rec_timeout:
|
|
|
|
**************************
|
|
ioctl LIRC_SET_REC_TIMEOUT
|
|
**************************
|
|
|
|
Name
|
|
====
|
|
|
|
LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout.
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout )
|
|
:name: LIRC_SET_REC_TIMEOUT
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by open().
|
|
|
|
``timeout``
|
|
Timeout, in microseconds.
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
Sets 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.
|