1.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
2.. c:namespace:: RC
3
4.. _lirc_set_wideband_receiver:
5
6********************************
7ioctl LIRC_SET_WIDEBAND_RECEIVER
8********************************
9
10Name
11====
12
13LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
14
15Synopsis
16========
17
18.. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
19
20``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by open().
27
28``enable``
29    enable = 1 means enable wideband receiver, enable = 0 means disable
30    wideband receiver.
31
32Description
33===========
34
35Some receivers are equipped with special wide band receiver which is
36intended to be used to learn output of existing remote. This ioctl
37allows enabling or disabling it.
38
39This might be useful of receivers that have otherwise narrow band receiver
40that prevents them to be used with some remotes. Wide band receiver might
41also be more precise. On the other hand its disadvantage it usually
42reduced range of reception.
43
44.. note::
45
46    Wide band receiver might be implictly enabled if you enable
47    carrier reports. In that case it will be disabled as soon as you disable
48    carrier reports. Trying to disable wide band receiver while carrier
49    reports are active will do nothing.
50
51Return Value
52============
53
54On success 0 is returned, on error -1 and the ``errno`` variable is set
55appropriately. The generic error codes are described at the
56:ref:`Generic Error Codes <gen-errors>` chapter.
57