xref: /openbmc/linux/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst (revision 9a87ffc99ec8eb8d35eed7c4f816d75f5cc9662e)
1ac7f9d02SMauro Carvalho Chehab.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
25f536f4aSMauro Carvalho Chehab.. c:namespace:: RC
354f38fcaSMauro Carvalho Chehab
454f38fcaSMauro Carvalho Chehab.. _lirc_set_wideband_receiver:
554f38fcaSMauro Carvalho Chehab
654f38fcaSMauro Carvalho Chehab********************************
754f38fcaSMauro Carvalho Chehabioctl LIRC_SET_WIDEBAND_RECEIVER
854f38fcaSMauro Carvalho Chehab********************************
954f38fcaSMauro Carvalho Chehab
1054f38fcaSMauro Carvalho ChehabName
1154f38fcaSMauro Carvalho Chehab====
1254f38fcaSMauro Carvalho Chehab
1354f38fcaSMauro Carvalho ChehabLIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
1454f38fcaSMauro Carvalho Chehab
1554f38fcaSMauro Carvalho ChehabSynopsis
1654f38fcaSMauro Carvalho Chehab========
1754f38fcaSMauro Carvalho Chehab
185f536f4aSMauro Carvalho Chehab.. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
195f536f4aSMauro Carvalho Chehab
205f536f4aSMauro Carvalho Chehab``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
2154f38fcaSMauro Carvalho Chehab
2254f38fcaSMauro Carvalho ChehabArguments
2354f38fcaSMauro Carvalho Chehab=========
2454f38fcaSMauro Carvalho Chehab
2554f38fcaSMauro Carvalho Chehab``fd``
2654f38fcaSMauro Carvalho Chehab    File descriptor returned by open().
2754f38fcaSMauro Carvalho Chehab
2854f38fcaSMauro Carvalho Chehab``enable``
2954f38fcaSMauro Carvalho Chehab    enable = 1 means enable wideband receiver, enable = 0 means disable
3054f38fcaSMauro Carvalho Chehab    wideband receiver.
3154f38fcaSMauro Carvalho Chehab
3254f38fcaSMauro Carvalho ChehabDescription
3354f38fcaSMauro Carvalho Chehab===========
3454f38fcaSMauro Carvalho Chehab
3554f38fcaSMauro Carvalho ChehabSome receivers are equipped with special wide band receiver which is
3654f38fcaSMauro Carvalho Chehabintended to be used to learn output of existing remote. This ioctl
3754f38fcaSMauro Carvalho Chehaballows enabling or disabling it.
3854f38fcaSMauro Carvalho Chehab
3954f38fcaSMauro Carvalho ChehabThis might be useful of receivers that have otherwise narrow band receiver
4054f38fcaSMauro Carvalho Chehabthat prevents them to be used with some remotes. Wide band receiver might
4154f38fcaSMauro Carvalho Chehabalso be more precise. On the other hand its disadvantage it usually
4254f38fcaSMauro Carvalho Chehabreduced range of reception.
4354f38fcaSMauro Carvalho Chehab
4454f38fcaSMauro Carvalho Chehab.. note::
4554f38fcaSMauro Carvalho Chehab
46*c1966bd1SRandy Dunlap    Wide band receiver might be implicitly enabled if you enable
4754f38fcaSMauro Carvalho Chehab    carrier reports. In that case it will be disabled as soon as you disable
4854f38fcaSMauro Carvalho Chehab    carrier reports. Trying to disable wide band receiver while carrier
4954f38fcaSMauro Carvalho Chehab    reports are active will do nothing.
5054f38fcaSMauro Carvalho Chehab
5154f38fcaSMauro Carvalho ChehabReturn Value
5254f38fcaSMauro Carvalho Chehab============
5354f38fcaSMauro Carvalho Chehab
5454f38fcaSMauro Carvalho ChehabOn success 0 is returned, on error -1 and the ``errno`` variable is set
5554f38fcaSMauro Carvalho Chehabappropriately. The generic error codes are described at the
5654f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
57