0001 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: RC
0003
0004 .. _lirc_set_rec_carrier_range:
0005
0006 ********************************
0007 ioctl LIRC_SET_REC_CARRIER_RANGE
0008 ********************************
0009
0010 Name
0011 ====
0012
0013 LIRC_SET_REC_CARRIER_RANGE - Set lower bound of the carrier used to modulate
0014 IR receive.
0015
0016 Synopsis
0017 ========
0018
0019 .. c:macro:: LIRC_SET_REC_CARRIER_RANGE
0020
0021 ``int ioctl(int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency)``
0022
0023 Arguments
0024 =========
0025
0026 ``fd``
0027 File descriptor returned by open().
0028
0029 ``frequency``
0030 Frequency of the carrier that modulates PWM data, in Hz.
0031
0032 Description
0033 ===========
0034
0035 This ioctl sets the upper range of carrier frequency that will be recognized
0036 by the IR receiver.
0037
0038 .. note::
0039
0040 To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
0041 <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
0042 :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
0043
0044 Return Value
0045 ============
0046
0047 On success 0 is returned, on error -1 and the ``errno`` variable is set
0048 appropriately. The generic error codes are described at the
0049 :ref:`Generic Error Codes <gen-errors>` chapter.
