Back to home page

OSCL-LXR

 
 

    


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:
0005 
0006 **************************
0007 ioctl LIRC_SET_REC_CARRIER
0008 **************************
0009 
0010 Name
0011 ====
0012 
0013 LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
0014 
0015 Synopsis
0016 ========
0017 
0018 .. c:macro:: LIRC_SET_REC_CARRIER
0019 
0020 ``int ioctl(int fd, LIRC_SET_REC_CARRIER, __u32 *frequency)``
0021 
0022 Arguments
0023 =========
0024 
0025 ``fd``
0026     File descriptor returned by open().
0027 
0028 ``frequency``
0029     Frequency of the carrier that modulates PWM data, in Hz.
0030 
0031 Description
0032 ===========
0033 
0034 Set receive carrier used to modulate IR PWM pulses and spaces.
0035 
0036 .. note::
0037 
0038    If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl
0039    sets the upper bound frequency that will be recognized by the device.
0040 
0041 Return Value
0042 ============
0043 
0044 On success 0 is returned, on error -1 and the ``errno`` variable is set
0045 appropriately. The generic error codes are described at the
0046 :ref:`Generic Error Codes <gen-errors>` chapter.