linux/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
Mauro Carvalho Chehab ac7f9d0283 media: docs: uAPI: rc: dual-license the docs with GPL v2
Make the license for those documents also compatible with GPLv2.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Sean Young <sean@mess.org>
2020-11-26 14:18:56 +01:00

47 lines
994 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_carrier:
**************************
ioctl LIRC_SET_REC_CARRIER
**************************
Name
====
LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
Synopsis
========
.. c:macro:: LIRC_SET_REC_CARRIER
``int ioctl(int fd, LIRC_SET_REC_CARRIER, __u32 *frequency)``
Arguments
=========
``fd``
File descriptor returned by open().
``frequency``
Frequency of the carrier that modulates PWM data, in Hz.
Description
===========
Set receive carrier used to modulate IR PWM pulses and spaces.
.. note::
If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl
sets the upper bound frequency that will be recognized by the device.
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.