0001 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: RC
0003
0004 .. _lirc_get_rec_resolution:
0005
0006 *****************************
0007 ioctl LIRC_GET_REC_RESOLUTION
0008 *****************************
0009
0010 Name
0011 ====
0012
0013 LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
0014
0015 Synopsis
0016 ========
0017
0018 .. c:macro:: LIRC_GET_REC_RESOLUTION
0019
0020 ``int ioctl(int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)``
0021
0022 Arguments
0023 =========
0024
0025 ``fd``
0026 File descriptor returned by open().
0027
0028 ``microseconds``
0029 Resolution, in microseconds.
0030
0031 Description
0032 ===========
0033
0034 Some receivers have maximum resolution which is defined by internal
0035 sample rate or data format limitations. E.g. it's common that
0036 signals can only be reported in 50 microsecond steps.
0037
0038 This ioctl returns the integer value with such resolution, with can be
0039 used by userspace applications like lircd to automatically adjust the
0040 tolerance value.
0041
0042 Return Value
0043 ============
0044
0045 On success 0 is returned, on error -1 and the ``errno`` variable is set
0046 appropriately. The generic error codes are described at the
0047 :ref:`Generic Error Codes <gen-errors>` chapter.
