Documentation/media/uapi/rc/lirc-set-rec-carrier-range.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_rec_carrier_range:
  11
  12 ********************************
  13 ioctl LIRC_SET_REC_CARRIER_RANGE
  14 ********************************
  15
  16 Name
  17 ====
  18
  19 LIRC_SET_REC_CARRIER_RANGE - Set lower bound of the carrier used to modulate
  20 IR receive.
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency )
  26     :name: LIRC_SET_REC_CARRIER_RANGE
  27
  28 Arguments
  29 =========
  30
  31 ``fd``
  32     File descriptor returned by open().
  33
  34 ``frequency``
  35     Frequency of the carrier that modulates PWM data, in Hz.
  36
  37 Description
  38 ===========
  39
  40 This ioctl sets the upper range of carrier frequency that will be recognized
  41 by the IR receiver.
  42
  43 .. note::
  44
  45    To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
  46    <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
  47    :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
  48
  49 Return Value
  50 ============
  51
  52 On success 0 is returned, on error -1 and the ``errno`` variable is set
  53 appropriately. The generic error codes are described at the
  54 :ref:`Generic Error Codes <gen-errors>` chapter.