1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1. !! 1 .. Permission is granted to copy, distribute and/or modify this
2 .. c:namespace:: RC !! 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
3 9
4 .. _lirc_set_send_duty_cycle: 10 .. _lirc_set_send_duty_cycle:
5 11
6 ****************************** 12 ******************************
7 ioctl LIRC_SET_SEND_DUTY_CYCLE 13 ioctl LIRC_SET_SEND_DUTY_CYCLE
8 ****************************** 14 ******************************
9 15
10 Name 16 Name
11 ==== 17 ====
12 18
13 LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle 19 LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
14 IR transmit. 20 IR transmit.
15 21
16 Synopsis 22 Synopsis
17 ======== 23 ========
18 24
19 .. c:macro:: LIRC_SET_SEND_DUTY_CYCLE !! 25 .. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)
20 !! 26 :name: LIRC_SET_SEND_DUTY_CYCLE
21 ``int ioctl(int fd, LIRC_SET_SEND_DUTY_CYCLE, <<
22 27
23 Arguments 28 Arguments
24 ========= 29 =========
25 30
26 ``fd`` 31 ``fd``
27 File descriptor returned by open(). 32 File descriptor returned by open().
28 33
29 ``duty_cycle`` 34 ``duty_cycle``
30 Duty cicle, describing the pulse width in 35 Duty cicle, describing the pulse width in percent (from 1 to 99) of
31 the total cycle. Values 0 and 100 are rese 36 the total cycle. Values 0 and 100 are reserved.
32 37
>> 38
33 Description 39 Description
34 =========== 40 ===========
35 41
36 Get/set the duty cycle of the carrier signal f 42 Get/set the duty cycle of the carrier signal for IR transmit.
37 43
38 Currently, no special meaning is defined for 0 44 Currently, no special meaning is defined for 0 or 100, but this
39 could be used to switch off carrier generation 45 could be used to switch off carrier generation in the future, so
40 these values should be reserved. 46 these values should be reserved.
>> 47
41 48
42 Return Value 49 Return Value
43 ============ 50 ============
44 51
45 On success 0 is returned, on error -1 and the 52 On success 0 is returned, on error -1 and the ``errno`` variable is set
46 appropriately. The generic error codes are des 53 appropriately. The generic error codes are described at the
47 :ref:`Generic Error Codes <gen-errors>` chapte 54 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.