1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _lirc_get_rec_resolution:
11
12*****************************
13ioctl LIRC_GET_REC_RESOLUTION
14*****************************
15
16Name
17====
18
19LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
20
21Synopsis
22========
23
24.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)
25    :name: LIRC_GET_REC_RESOLUTION
26
27Arguments
28=========
29
30``fd``
31    File descriptor returned by open().
32
33``microseconds``
34    Resolution, in microseconds.
35
36
37Description
38===========
39
40Some receivers have maximum resolution which is defined by internal
41sample rate or data format limitations. E.g. it's common that
42signals can only be reported in 50 microsecond steps.
43
44This ioctl returns the integer value with such resolution, with can be
45used by userspace applications like lircd to automatically adjust the
46tolerance value.
47
48
49Return Value
50============
51
52On success 0 is returned, on error -1 and the ``errno`` variable is set
53appropriately. The generic error codes are described at the
54:ref:`Generic Error Codes <gen-errors>` chapter.
55