xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: RC
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _lirc_set_wideband_receiver:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun********************************
7*4882a593Smuzhiyunioctl LIRC_SET_WIDEBAND_RECEIVER
8*4882a593Smuzhiyun********************************
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun====
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunLIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunSynopsis
16*4882a593Smuzhiyun========
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun.. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunArguments
23*4882a593Smuzhiyun=========
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun``fd``
26*4882a593Smuzhiyun    File descriptor returned by open().
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun``enable``
29*4882a593Smuzhiyun    enable = 1 means enable wideband receiver, enable = 0 means disable
30*4882a593Smuzhiyun    wideband receiver.
31*4882a593Smuzhiyun
32*4882a593SmuzhiyunDescription
33*4882a593Smuzhiyun===========
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunSome receivers are equipped with special wide band receiver which is
36*4882a593Smuzhiyunintended to be used to learn output of existing remote. This ioctl
37*4882a593Smuzhiyunallows enabling or disabling it.
38*4882a593Smuzhiyun
39*4882a593SmuzhiyunThis might be useful of receivers that have otherwise narrow band receiver
40*4882a593Smuzhiyunthat prevents them to be used with some remotes. Wide band receiver might
41*4882a593Smuzhiyunalso be more precise. On the other hand its disadvantage it usually
42*4882a593Smuzhiyunreduced range of reception.
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun.. note::
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun    Wide band receiver might be implictly enabled if you enable
47*4882a593Smuzhiyun    carrier reports. In that case it will be disabled as soon as you disable
48*4882a593Smuzhiyun    carrier reports. Trying to disable wide band receiver while carrier
49*4882a593Smuzhiyun    reports are active will do nothing.
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunReturn Value
52*4882a593Smuzhiyun============
53*4882a593Smuzhiyun
54*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
55*4882a593Smuzhiyunappropriately. The generic error codes are described at the
56*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
57