mirror of
https://github.com/torvalds/linux.git
synced 2024-11-11 22:51:42 +00:00
[media] doc-rst: document LIRC_GET_REC_RESOLUTION
Improve the documentation for this ioctl, adding it to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
dbe678dd21
commit
6d9f4d799b
49
Documentation/media/uapi/rc/lirc-get-rec-resolution.rst
Normal file
49
Documentation/media/uapi/rc/lirc-get-rec-resolution.rst
Normal file
@ -0,0 +1,49 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _lirc_get_rec_resolution:
|
||||
|
||||
*****************************
|
||||
ioctl LIRC_GET_REC_RESOLUTION
|
||||
*****************************
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
.. cpp:function:: int ioctl( int fd, int request, __u32 *microseconds)
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_REC_RESOLUTION
|
||||
|
||||
``microseconds``
|
||||
Resolution, in microseconds.
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
Some receivers have maximum resolution which is defined by internal
|
||||
sample rate or data format limitations. E.g. it's common that
|
||||
signals can only be reported in 50 microsecond steps.
|
||||
|
||||
This ioctl returns the integer value with such resolution, with can be
|
||||
used by userspace applications like lircd to automatically adjust the
|
||||
tolerance value.
|
||||
|
||||
|
||||
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.
|
@ -15,4 +15,5 @@ LIRC Device Interface
|
||||
lirc-get-features
|
||||
lirc-get-send-mode
|
||||
lirc-get-rec-mode
|
||||
lirc-get-rec-resolution
|
||||
lirc_ioctl
|
||||
|
@ -58,16 +58,6 @@ I/O control requests
|
||||
could be used to switch off carrier generation in the future, so
|
||||
these values should be reserved.
|
||||
|
||||
.. _LIRC_GET_REC_RESOLUTION:
|
||||
|
||||
``LIRC_GET_REC_RESOLUTION``
|
||||
|
||||
Some receiver have maximum resolution which is defined by internal
|
||||
sample rate or data format limitations. E.g. it's common that
|
||||
signals can only be reported in 50 microsecond steps. This integer
|
||||
value is used by lircd to automatically adjust the aeps tolerance
|
||||
value in the lircd config file.
|
||||
|
||||
.. _LIRC_GET_MIN_TIMEOUT:
|
||||
.. _LIRC_GET_MAX_TIMEOUT:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user