2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-19 02:34:01 +08: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:
Mauro Carvalho Chehab 2016-07-12 07:49:00 -03:00
parent 191fbb903b
commit 98a7b04eed
3 changed files with 53 additions and 11 deletions

View 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.

View File

@ -18,6 +18,7 @@ LIRC Device Interface
lirc-get-rec-resolution
lirc-set-send-duty-cycle
lirc-get-timeout
lirc-set-rec-timeout
lirc-get-length
lirc-set-rec-carrier
lirc-set-rec-carrier-range

View File

@ -54,17 +54,6 @@ device can rely on working with the default settings initially.
Set send/receive mode. Largely obsolete for send, as only
``LIRC_MODE_PULSE`` is supported.
.. _LIRC_SET_REC_TIMEOUT:
``LIRC_SET_REC_TIMEOUT``
Sets the integer value for IR inactivity timeout (cf.
``LIRC_GET_MIN_TIMEOUT`` and ``LIRC_GET_MAX_TIMEOUT).`` A value of 0
(if supported by the hardware) 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.
.. _LIRC_SET_REC_TIMEOUT_REPORTS:
``LIRC_SET_REC_TIMEOUT_REPORTS``