Documentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _lirc_set_measure_carrier_mode:
  11
  12 ***********************************
  13 ioctl LIRC_SET_MEASURE_CARRIER_MODE
  14 ***********************************
  15
  16 Name
  17 ====
  18
  19 LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
  20
  21 Synopsis
  22 ========
  23
  24 .. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable )
  25     :name: LIRC_SET_MEASURE_CARRIER_MODE
  26
  27 Arguments
  28 =========
  29
  30 ``fd``
  31     File descriptor returned by open().
  32
  33 ``enable``
  34     enable = 1 means enable measure mode, enable = 0 means disable measure
  35     mode.
  36
  37
  38 Description
  39 ===========
  40
  41 .. _lirc-mode2-frequency:
  42
  43 Enable or disable measure mode. If enabled, from the next key
  44 press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
  45 default this should be turned off.
  46
  47
  48 Return Value
  49 ============
  50
  51 On success 0 is returned, on error -1 and the ``errno`` variable is set
  52 appropriately. The generic error codes are described at the
  53 :ref:`Generic Error Codes <gen-errors>` chapter.