18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: RC
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _lirc_set_wideband_receiver:
58c2ecf20Sopenharmony_ci
68c2ecf20Sopenharmony_ci********************************
78c2ecf20Sopenharmony_ciioctl LIRC_SET_WIDEBAND_RECEIVER
88c2ecf20Sopenharmony_ci********************************
98c2ecf20Sopenharmony_ci
108c2ecf20Sopenharmony_ciName
118c2ecf20Sopenharmony_ci====
128c2ecf20Sopenharmony_ci
138c2ecf20Sopenharmony_ciLIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ciSynopsis
168c2ecf20Sopenharmony_ci========
178c2ecf20Sopenharmony_ci
188c2ecf20Sopenharmony_ci.. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ciArguments
238c2ecf20Sopenharmony_ci=========
248c2ecf20Sopenharmony_ci
258c2ecf20Sopenharmony_ci``fd``
268c2ecf20Sopenharmony_ci    File descriptor returned by open().
278c2ecf20Sopenharmony_ci
288c2ecf20Sopenharmony_ci``enable``
298c2ecf20Sopenharmony_ci    enable = 1 means enable wideband receiver, enable = 0 means disable
308c2ecf20Sopenharmony_ci    wideband receiver.
318c2ecf20Sopenharmony_ci
328c2ecf20Sopenharmony_ciDescription
338c2ecf20Sopenharmony_ci===========
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ciSome receivers are equipped with special wide band receiver which is
368c2ecf20Sopenharmony_ciintended to be used to learn output of existing remote. This ioctl
378c2ecf20Sopenharmony_ciallows enabling or disabling it.
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ciThis might be useful of receivers that have otherwise narrow band receiver
408c2ecf20Sopenharmony_cithat prevents them to be used with some remotes. Wide band receiver might
418c2ecf20Sopenharmony_cialso be more precise. On the other hand its disadvantage it usually
428c2ecf20Sopenharmony_cireduced range of reception.
438c2ecf20Sopenharmony_ci
448c2ecf20Sopenharmony_ci.. note::
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ci    Wide band receiver might be implictly enabled if you enable
478c2ecf20Sopenharmony_ci    carrier reports. In that case it will be disabled as soon as you disable
488c2ecf20Sopenharmony_ci    carrier reports. Trying to disable wide band receiver while carrier
498c2ecf20Sopenharmony_ci    reports are active will do nothing.
508c2ecf20Sopenharmony_ci
518c2ecf20Sopenharmony_ciReturn Value
528c2ecf20Sopenharmony_ci============
538c2ecf20Sopenharmony_ci
548c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
558c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
568c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
57