xref: /linux/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst (revision cdd38c5f1ce4398ec58fec95904b75824daab7b5)
1.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
2.. c:namespace:: RC
3
4.. _lirc_set_measure_carrier_mode:
5
6***********************************
7ioctl LIRC_SET_MEASURE_CARRIER_MODE
8***********************************
9
10Name
11====
12
13LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
14
15Synopsis
16========
17
18.. c:macro:: LIRC_SET_MEASURE_CARRIER_MODE
19
20``int ioctl(int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable)``
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by open().
27
28``enable``
29    enable = 1 means enable measure mode, enable = 0 means disable measure
30    mode.
31
32Description
33===========
34
35.. _lirc-mode2-frequency:
36
37Enable or disable measure mode. If enabled, from the next key
38press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
39default this should be turned off.
40
41Return Value
42============
43
44On success 0 is returned, on error -1 and the ``errno`` variable is set
45appropriately. The generic error codes are described at the
46:ref:`Generic Error Codes <gen-errors>` chapter.
47