xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: RC
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _lirc_set_rec_carrier_range:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun********************************
7*4882a593Smuzhiyunioctl LIRC_SET_REC_CARRIER_RANGE
8*4882a593Smuzhiyun********************************
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun====
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunLIRC_SET_REC_CARRIER_RANGE - Set lower bound of the carrier used to modulate
14*4882a593SmuzhiyunIR receive.
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunSynopsis
17*4882a593Smuzhiyun========
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun.. c:macro:: LIRC_SET_REC_CARRIER_RANGE
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun``int ioctl(int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency)``
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunArguments
24*4882a593Smuzhiyun=========
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun``fd``
27*4882a593Smuzhiyun    File descriptor returned by open().
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun``frequency``
30*4882a593Smuzhiyun    Frequency of the carrier that modulates PWM data, in Hz.
31*4882a593Smuzhiyun
32*4882a593SmuzhiyunDescription
33*4882a593Smuzhiyun===========
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunThis ioctl sets the upper range of carrier frequency that will be recognized
36*4882a593Smuzhiyunby the IR receiver.
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun.. note::
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun   To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
41*4882a593Smuzhiyun   <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
42*4882a593Smuzhiyun   :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunReturn Value
45*4882a593Smuzhiyun============
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
48*4882a593Smuzhiyunappropriately. The generic error codes are described at the
49*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
50