linux-stable/Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst
Mauro Carvalho Chehab 978084b193 [media] doc-rst: document LIRC_SET_SEND_DUTY_CYCLE
Add a separate page for this ioctl.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12 09:29:30 -03:00

49 lines
1 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _lirc_set_send_duty_cycle:
******************************
ioctl LIRC_SET_SEND_DUTY_CYCLE
******************************
Name
====
LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
IR transmit.
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, __u32 *duty_cycle)
Arguments
=========
``fd``
File descriptor returned by open().
``request``
LIRC_SET_SEND_DUTY_CYCLE
``duty_cycle``
Duty cicle, describing the pulse width in percent (from 1 to 99) of
the total cycle. Values 0 and 100 are reserved.
Description
===========
Get/set the duty cycle of the carrier signal for IR transmit.
Currently, no special meaning is defined for 0 or 100, but this
could be used to switch off carrier generation in the future, so
these values should be reserved.
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.