0001 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: RC
0003
0004 .. _lirc_set_wideband_receiver:
0005
0006 ********************************
0007 ioctl LIRC_SET_WIDEBAND_RECEIVER
0008 ********************************
0009
0010 Name
0011 ====
0012
0013 LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
0014
0015 Synopsis
0016 ========
0017
0018 .. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
0019
0020 ``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
0021
0022 Arguments
0023 =========
0024
0025 ``fd``
0026 File descriptor returned by open().
0027
0028 ``enable``
0029 enable = 1 means enable wideband receiver, enable = 0 means disable
0030 wideband receiver.
0031
0032 Description
0033 ===========
0034
0035 Some receivers are equipped with special wide band receiver which is
0036 intended to be used to learn output of existing remote. This ioctl
0037 allows enabling or disabling it.
0038
0039 This might be useful of receivers that have otherwise narrow band receiver
0040 that prevents them to be used with some remotes. Wide band receiver might
0041 also be more precise. On the other hand its disadvantage it usually
0042 reduced range of reception.
0043
0044 .. note::
0045
0046 Wide band receiver might be implictly enabled if you enable
0047 carrier reports. In that case it will be disabled as soon as you disable
0048 carrier reports. Trying to disable wide band receiver while carrier
0049 reports are active will do nothing.
0050
0051 Return Value
0052 ============
0053
0054 On success 0 is returned, on error -1 and the ``errno`` variable is set
0055 appropriately. The generic error codes are described at the
0056 :ref:`Generic Error Codes <gen-errors>` chapter.
