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 .. cpp:function:: int ioctl( int fd, int request, __u32 *enable )
  18
  19 Arguments
  20 =========
  21
  22 ``fd``
  23     File descriptor returned by open().
  24
  25 ``request``
  26     LIRC_SET_MEASURE_CARRIER_MODE
  27
  28 ``enable``
  29     enable = 1 means enable measure mode, enable = 0 means disable measure
  30     mode.
  31
  32
  33 Description
  34 ===========
  35
  36 .. _lirc-mode2-frequency:
  37
  38 Enable or disable measure mode. If enabled, from the next key
  39 press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
  40 default this should be turned off.
  41
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned, on error -1 and the ``errno`` variable is set
  47 appropriately. The generic error codes are described at the
  48 :ref:`Generic Error Codes <gen-errors>` chapter.