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 .. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)
  19     :name: LIRC_SET_SEND_DUTY_CYCLE
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by open().
  26
  27 ``duty_cycle``
  28     Duty cicle, describing the pulse width in percent (from 1 to 99) of
  29     the total cycle. Values 0 and 100 are reserved.
  30
  31
  32 Description
  33 ===========
  34
  35 Get/set the duty cycle of the carrier signal for IR transmit.
  36
  37 Currently, no special meaning is defined for 0 or 100, but this
  38 could be used to switch off carrier generation in the future, so
  39 these values should be reserved.
  40
  41
  42 Return Value
  43 ============
  44
  45 On success 0 is returned, on error -1 and the ``errno`` variable is set
  46 appropriately. The generic error codes are described at the
  47 :ref:`Generic Error Codes <gen-errors>` chapter.