Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _lirc_set_send_duty_cycle:
   4
   5 ******************************
   6 ioctl LIRC_SET_SEND_DUTY_CYCLE
   7 ******************************
   8
   9 Name
  10 ====
  11
  12 LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
  13 IR transmit.
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, __u32 *duty_cycle)
  19
  20 Arguments
  21 =========
  22
  23 ``fd``
  24     File descriptor returned by open().
  25
  26 ``request``
  27     LIRC_SET_SEND_DUTY_CYCLE
  28
  29 ``duty_cycle``
  30     Duty cicle, describing the pulse width in percent (from 1 to 99) of
  31     the total cycle. Values 0 and 100 are reserved.
  32
  33
  34 Description
  35 ===========
  36
  37 Get/set the duty cycle of the carrier signal for IR transmit.
  38
  39 Currently, no special meaning is defined for 0 or 100, but this
  40 could be used to switch off carrier generation in the future, so
  41 these values should be reserved.
  42
  43
  44 Return Value
  45 ============
  46
  47 On success 0 is returned, on error -1 and the ``errno`` variable is set
  48 appropriately. The generic error codes are described at the
  49 :ref:`Generic Error Codes <gen-errors>` chapter.