xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.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_measure_carrier_mode:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun***********************************
7*4882a593Smuzhiyunioctl LIRC_SET_MEASURE_CARRIER_MODE
8*4882a593Smuzhiyun***********************************
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun====
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunLIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunSynopsis
16*4882a593Smuzhiyun========
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun.. c:macro:: LIRC_SET_MEASURE_CARRIER_MODE
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun``int ioctl(int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable)``
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunArguments
23*4882a593Smuzhiyun=========
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun``fd``
26*4882a593Smuzhiyun    File descriptor returned by open().
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun``enable``
29*4882a593Smuzhiyun    enable = 1 means enable measure mode, enable = 0 means disable measure
30*4882a593Smuzhiyun    mode.
31*4882a593Smuzhiyun
32*4882a593SmuzhiyunDescription
33*4882a593Smuzhiyun===========
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun.. _lirc-mode2-frequency:
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunEnable or disable measure mode. If enabled, from the next key
38*4882a593Smuzhiyunpress on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
39*4882a593Smuzhiyundefault this should be turned off.
40*4882a593Smuzhiyun
41*4882a593SmuzhiyunReturn Value
42*4882a593Smuzhiyun============
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
45*4882a593Smuzhiyunappropriately. The generic error codes are described at the
46*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
47