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

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