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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_set_measure_carrier_mode:
   4
   5 ***********************************
   6 ioctl LIRC_SET_MEASURE_CARRIER_MODE
   7 ***********************************
   8
   9 Name
  10 ====
  11
  12 LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
  13
  14 Synopsis
  15 ========
  16
  17 .. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable )
  18     :name: LIRC_SET_MEASURE_CARRIER_MODE
  19
  20 Arguments
  21 =========
  22
  23 ``fd``
  24     File descriptor returned by open().
  25
  26 ``enable``
  27     enable = 1 means enable measure mode, enable = 0 means disable measure
  28     mode.
  29
  30
  31 Description
  32 ===========
  33
  34 .. _lirc-mode2-frequency:
  35
  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.
  39
  40
  41 Return Value
  42 ============
  43
  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.