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