xref: /linux/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst (revision b8265621f4888af9494e1d685620871ec81bc33d)
1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _lirc_set_send_duty_cycle:
11
12******************************
13ioctl LIRC_SET_SEND_DUTY_CYCLE
14******************************
15
16Name
17====
18
19LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
20IR transmit.
21
22Synopsis
23========
24
25.. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)
26    :name: LIRC_SET_SEND_DUTY_CYCLE
27
28Arguments
29=========
30
31``fd``
32    File descriptor returned by open().
33
34``duty_cycle``
35    Duty cicle, describing the pulse width in percent (from 1 to 99) of
36    the total cycle. Values 0 and 100 are reserved.
37
38
39Description
40===========
41
42Get/set the duty cycle of the carrier signal for IR transmit.
43
44Currently, no special meaning is defined for 0 or 100, but this
45could be used to switch off carrier generation in the future, so
46these values should be reserved.
47
48
49Return Value
50============
51
52On success 0 is returned, on error -1 and the ``errno`` variable is set
53appropriately. The generic error codes are described at the
54:ref:`Generic Error Codes <gen-errors>` chapter.
55