Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst

   1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: RC
   3
   4 .. _lirc_set_rec_carrier:
   5
   6 **************************
   7 ioctl LIRC_SET_REC_CARRIER
   8 **************************
   9
  10 Name
  11 ====
  12
  13 LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:macro:: LIRC_SET_REC_CARRIER
  19
  20 ``int ioctl(int fd, LIRC_SET_REC_CARRIER, __u32 *frequency)``
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by open().
  27
  28 ``frequency``
  29     Frequency of the carrier that modulates PWM data, in Hz.
  30
  31 Description
  32 ===========
  33
  34 Set receive carrier used to modulate IR PWM pulses and spaces.
  35
  36 .. note::
  37
  38    If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl
  39    sets the upper bound frequency that will be recognized by the device.
  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.