Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[deliverable/linux.git] / Documentation / media / uapi / rc / lirc-get-rec-resolution.rst
CommitLineData
6d9f4d79
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _lirc_get_rec_resolution:
4
5*****************************
6ioctl LIRC_GET_REC_RESOLUTION
7*****************************
8
9Name
10====
11
12LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
13
14Synopsis
15========
16
17.. cpp:function:: int ioctl( int fd, int request, __u32 *microseconds)
18
19Arguments
20=========
21
22``fd``
23 File descriptor returned by open().
24
25``request``
26 LIRC_GET_REC_RESOLUTION
27
28``microseconds``
29 Resolution, in microseconds.
30
31
32Description
33===========
34
35Some receivers have maximum resolution which is defined by internal
36sample rate or data format limitations. E.g. it's common that
37signals can only be reported in 50 microsecond steps.
38
39This ioctl returns the integer value with such resolution, with can be
40used by userspace applications like lircd to automatically adjust the
41tolerance value.
42
43
44Return Value
45============
46
47On success 0 is returned, on error -1 and the ``errno`` variable is set
48appropriately. The generic error codes are described at the
49:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.035829 seconds and 5 git commands to generate.