mirror of
https://github.com/torvalds/linux.git
synced 2026-05-01 04:52:32 -04:00
[media] doc-rst: document LIRC_SET_REC_TIMEOUT
Add a separate page for this ioctl and adds the cross-references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
52
Documentation/media/uapi/rc/lirc-set-rec-timeout.rst
Normal file
52
Documentation/media/uapi/rc/lirc-set-rec-timeout.rst
Normal file
@@ -0,0 +1,52 @@
|
||||
.. -*- 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
|
||||
========
|
||||
|
||||
.. cpp:function:: int ioctl( int fd, int request, __u32 *timeout )
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_REC_TIMEOUT
|
||||
|
||||
``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.
|
||||
Reference in New Issue
Block a user