Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst

   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/media/uapi/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 ********************************
  13 ioctl LIRC_SET_WIDEBAND_RECEIVER
  14 ********************************
  15
  16 Name
  17 ====
  18
  19 LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
  20
  21 Synopsis
  22 ========
  23
  24 .. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable )
  25     :name: LIRC_SET_WIDEBAND_RECEIVER
  26
  27 Arguments
  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
  38 Description
  39 ===========
  40
  41 Some receivers are equipped with special wide band receiver which is
  42 intended to be used to learn output of existing remote. This ioctl
  43 allows enabling or disabling it.
  44
  45 This might be useful of receivers that have otherwise narrow band receiver
  46 that prevents them to be used with some remotes. Wide band receiver might
  47 also be more precise. On the other hand its disadvantage it usually
  48 reduced 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
  58 Return Value
  59 ============
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.