Commit 978084b1 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: document LIRC_SET_SEND_DUTY_CYCLE 



Add a separate page for this ioctl.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 6d9f4d79

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

0 → 100644
+49 −0
Original line number Diff line number Diff line 
.. -*- 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.

Documentation/media/uapi/rc/lirc_device_interface.rst

+1 −0
Original line number Diff line number Diff line
@@ -16,4 +16,5 @@ LIRC Device Interface 
    lirc-get-send-mode

    lirc-get-rec-mode

    lirc-get-rec-resolution

    lirc-set-send-duty-cycle

    lirc_ioctl

Documentation/media/uapi/rc/lirc_ioctl.rst

+0 −9
Original line number Diff line number Diff line
@@ -49,15 +49,6 @@ device can rely on working with the default settings initially. 
I/O control requests

====================



.. _LIRC_SET_SEND_DUTY_CYCLE:



``LIRC_SET_SEND_DUTY_CYCLE``



    Set the duty cycle (from 0 to 100) of the carrier signal.

    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.



.. _LIRC_GET_MIN_TIMEOUT:

.. _LIRC_GET_MAX_TIMEOUT: