original_kernel/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst

42 lines
832 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_send_carrier:
***************************
ioctl LIRC_SET_SEND_CARRIER
***************************
Name
====
LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
Synopsis
========
.. c:macro:: LIRC_SET_SEND_CARRIER
``int ioctl(int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency)``
Arguments
=========
``fd``
File descriptor returned by open().
``frequency``
Frequency of the carrier to be modulated, in Hz.
Description
===========
Set send carrier used to modulate IR PWM pulses and spaces.
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.