mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-19 02:34:01 +08:00
[media] doc-rst: document LIRC_GET_*_TIMEOUT ioctls
Improve the documentation for those ioctls, adding them to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for those ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
978084b193
commit
76e23479f9
55
Documentation/media/uapi/rc/lirc-get-timeout.rst
Normal file
55
Documentation/media/uapi/rc/lirc-get-timeout.rst
Normal file
@ -0,0 +1,55 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _lirc_get_min_timeout:
|
||||
.. _lirc_get_max_timeout:
|
||||
|
||||
****************************************************
|
||||
ioctls LIRC_GET_MIN_TIMEOUT and LIRC_GET_MAX_TIMEOUT
|
||||
****************************************************
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
LIRC_GET_MIN_TIMEOUT / LIRC_GET_MAX_TIMEOUT - Obtain the possible timeout
|
||||
range for IR receive.
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
.. cpp:function:: int ioctl( int fd, int request, __u32 *timeout)
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_MIN_TIMEOUT or LIRC_GET_MAX_TIMEOUT
|
||||
|
||||
``timeout``
|
||||
Timeout, in microseconds.
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
Some devices have internal timers that can be used to detect when
|
||||
there's no IR activity for a long time. This can help lircd in
|
||||
detecting that a IR signal is finished and can speed up the decoding
|
||||
process. Returns an integer value with the minimum/maximum timeout
|
||||
that can be set.
|
||||
|
||||
.. note::
|
||||
|
||||
Some devices have a fixed timeout, in that case
|
||||
both ioctls will return the same value even though the timeout
|
||||
cannot be changed via :ref:`LIRC_SET_REC_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.
|
@ -17,4 +17,5 @@ LIRC Device Interface
|
||||
lirc-get-rec-mode
|
||||
lirc-get-rec-resolution
|
||||
lirc-set-send-duty-cycle
|
||||
lirc-get-timeout
|
||||
lirc_ioctl
|
||||
|
@ -49,19 +49,6 @@ device can rely on working with the default settings initially.
|
||||
I/O control requests
|
||||
====================
|
||||
|
||||
.. _LIRC_GET_MIN_TIMEOUT:
|
||||
.. _LIRC_GET_MAX_TIMEOUT:
|
||||
|
||||
``LIRC_GET_M{IN,AX}_TIMEOUT``
|
||||
|
||||
Some devices have internal timers that can be used to detect when
|
||||
there's no IR activity for a long time. This can help lircd in
|
||||
detecting that a IR signal is finished and can speed up the decoding
|
||||
process. Returns an integer value with the minimum/maximum timeout
|
||||
that can be set. Some devices have a fixed timeout, in that case
|
||||
both ioctls will return the same value even though the timeout
|
||||
cannot be changed.
|
||||
|
||||
.. _LIRC_GET_LENGTH:
|
||||
|
||||
``LIRC_GET_LENGTH``
|
||||
|
Loading…
Reference in New Issue
Block a user