Merge branch 'linus' of git://git.kernel.org/pub/scm/linux/kernel/git/herbert/crypto-2.6
[linux/fpc-iii.git] / Documentation / media / uapi / rc / lirc-set-measure-carrier-mode.rst
blob6307b5715595626784dabc7111c50dcae42b0ae5
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _lirc_set_measure_carrier_mode:
5 ***********************************
6 ioctl LIRC_SET_MEASURE_CARRIER_MODE
7 ***********************************
9 Name
10 ====
12 LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
14 Synopsis
15 ========
17 .. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable )
18     :name: LIRC_SET_MEASURE_CARRIER_MODE
20 Arguments
21 =========
23 ``fd``
24     File descriptor returned by open().
26 ``enable``
27     enable = 1 means enable measure mode, enable = 0 means disable measure
28     mode.
31 Description
32 ===========
34 .. _lirc-mode2-frequency:
36 Enable or disable measure mode. If enabled, from the next key
37 press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
38 default this should be turned off.
41 Return Value
42 ============
44 On success 0 is returned, on error -1 and the ``errno`` variable is set
45 appropriately. The generic error codes are described at the
46 :ref:`Generic Error Codes <gen-errors>` chapter.