xref: /linux/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst (revision cdd38c5f1ce4398ec58fec95904b75824daab7b5)
1.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
2.. c:namespace:: RC
3
4.. _lirc_set_send_carrier:
5
6***************************
7ioctl LIRC_SET_SEND_CARRIER
8***************************
9
10Name
11====
12
13LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
14
15Synopsis
16========
17
18.. c:macro:: LIRC_SET_SEND_CARRIER
19
20``int ioctl(int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency)``
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by open().
27
28``frequency``
29    Frequency of the carrier to be modulated, in Hz.
30
31Description
32===========
33
34Set send carrier used to modulate IR PWM pulses and spaces.
35
36Return Value
37============
38
39On success 0 is returned, on error -1 and the ``errno`` variable is set
40appropriately. The generic error codes are described at the
41:ref:`Generic Error Codes <gen-errors>` chapter.
42