Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_set_rec_carrier_range:
   4
   5 ********************************
   6 ioctl LIRC_SET_REC_CARRIER_RANGE
   7 ********************************
   8
   9 Name
  10 ====
  11
  12 LIRC_SET_REC_CARRIER_RANGE - Set lower bond of the carrier used to modulate
  13 IR receive.
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, __u32 *frequency )
  19
  20 Arguments
  21 =========
  22
  23 ``fd``
  24     File descriptor returned by open().
  25
  26 ``request``
  27     LIRC_SET_REC_CARRIER_RANGE
  28
  29 ``frequency``
  30     Frequency of the carrier that modulates PWM data, in Hz.
  31
  32 Description
  33 ===========
  34
  35 This ioctl sets the upper range of carrier frequency that will be recognized
  36 by the IR receiver.
  37
  38 .. note::
  39
  40    To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
  41    <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
  42    :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
  43
  44 Return Value
  45 ============
  46
  47 On success 0 is returned, on error -1 and the ``errno`` variable is set
  48 appropriately. The generic error codes are described at the
  49 :ref:`Generic Error Codes <gen-errors>` chapter.