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 .. 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
  28
  29 ``frequency``
  30     Frequency of the carrier that modulates PWM data, in Hz.
  31
  32 Description
  33 ===========
  34
  35 Set receive carrier used to modulate IR PWM pulses and spaces.
  36
  37 .. note::
  38
  39    If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl
  40    sets the upper bound frequency that will be recognized by the device.
  41
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned, on error -1 and the ``errno`` variable is set
  47 appropriately. The generic error codes are described at the
  48 :ref:`Generic Error Codes <gen-errors>` chapter.