xref: /openbmc/linux/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst (revision 54f38fcae536ea202ce7d6a359521492fba30c1f)
1*54f38fcaSMauro Carvalho Chehab.. Permission is granted to copy, distribute and/or modify this
2*54f38fcaSMauro Carvalho Chehab.. document under the terms of the GNU Free Documentation License,
3*54f38fcaSMauro Carvalho Chehab.. Version 1.1 or any later version published by the Free Software
4*54f38fcaSMauro Carvalho Chehab.. Foundation, with no Invariant Sections, no Front-Cover Texts
5*54f38fcaSMauro Carvalho Chehab.. and no Back-Cover Texts. A copy of the license is included at
6*54f38fcaSMauro Carvalho Chehab.. Documentation/userspace-api/media/fdl-appendix.rst.
7*54f38fcaSMauro Carvalho Chehab..
8*54f38fcaSMauro Carvalho Chehab.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9*54f38fcaSMauro Carvalho Chehab
10*54f38fcaSMauro Carvalho Chehab.. _lirc_set_wideband_receiver:
11*54f38fcaSMauro Carvalho Chehab
12*54f38fcaSMauro Carvalho Chehab********************************
13*54f38fcaSMauro Carvalho Chehabioctl LIRC_SET_WIDEBAND_RECEIVER
14*54f38fcaSMauro Carvalho Chehab********************************
15*54f38fcaSMauro Carvalho Chehab
16*54f38fcaSMauro Carvalho ChehabName
17*54f38fcaSMauro Carvalho Chehab====
18*54f38fcaSMauro Carvalho Chehab
19*54f38fcaSMauro Carvalho ChehabLIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
20*54f38fcaSMauro Carvalho Chehab
21*54f38fcaSMauro Carvalho ChehabSynopsis
22*54f38fcaSMauro Carvalho Chehab========
23*54f38fcaSMauro Carvalho Chehab
24*54f38fcaSMauro Carvalho Chehab.. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable )
25*54f38fcaSMauro Carvalho Chehab    :name: LIRC_SET_WIDEBAND_RECEIVER
26*54f38fcaSMauro Carvalho Chehab
27*54f38fcaSMauro Carvalho ChehabArguments
28*54f38fcaSMauro Carvalho Chehab=========
29*54f38fcaSMauro Carvalho Chehab
30*54f38fcaSMauro Carvalho Chehab``fd``
31*54f38fcaSMauro Carvalho Chehab    File descriptor returned by open().
32*54f38fcaSMauro Carvalho Chehab
33*54f38fcaSMauro Carvalho Chehab``enable``
34*54f38fcaSMauro Carvalho Chehab    enable = 1 means enable wideband receiver, enable = 0 means disable
35*54f38fcaSMauro Carvalho Chehab    wideband receiver.
36*54f38fcaSMauro Carvalho Chehab
37*54f38fcaSMauro Carvalho Chehab
38*54f38fcaSMauro Carvalho ChehabDescription
39*54f38fcaSMauro Carvalho Chehab===========
40*54f38fcaSMauro Carvalho Chehab
41*54f38fcaSMauro Carvalho ChehabSome receivers are equipped with special wide band receiver which is
42*54f38fcaSMauro Carvalho Chehabintended to be used to learn output of existing remote. This ioctl
43*54f38fcaSMauro Carvalho Chehaballows enabling or disabling it.
44*54f38fcaSMauro Carvalho Chehab
45*54f38fcaSMauro Carvalho ChehabThis might be useful of receivers that have otherwise narrow band receiver
46*54f38fcaSMauro Carvalho Chehabthat prevents them to be used with some remotes. Wide band receiver might
47*54f38fcaSMauro Carvalho Chehabalso be more precise. On the other hand its disadvantage it usually
48*54f38fcaSMauro Carvalho Chehabreduced range of reception.
49*54f38fcaSMauro Carvalho Chehab
50*54f38fcaSMauro Carvalho Chehab.. note::
51*54f38fcaSMauro Carvalho Chehab
52*54f38fcaSMauro Carvalho Chehab    Wide band receiver might be implictly enabled if you enable
53*54f38fcaSMauro Carvalho Chehab    carrier reports. In that case it will be disabled as soon as you disable
54*54f38fcaSMauro Carvalho Chehab    carrier reports. Trying to disable wide band receiver while carrier
55*54f38fcaSMauro Carvalho Chehab    reports are active will do nothing.
56*54f38fcaSMauro Carvalho Chehab
57*54f38fcaSMauro Carvalho Chehab
58*54f38fcaSMauro Carvalho ChehabReturn Value
59*54f38fcaSMauro Carvalho Chehab============
60*54f38fcaSMauro Carvalho Chehab
61*54f38fcaSMauro Carvalho ChehabOn success 0 is returned, on error -1 and the ``errno`` variable is set
62*54f38fcaSMauro Carvalho Chehabappropriately. The generic error codes are described at the
63*54f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
64