2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-23 12:43:55 +08:00
linux-next/Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst
Mauro Carvalho Chehab 15c190146c [media] docs-rst: Convert LIRC uAPI to use C function references
Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

While here, improve the documentation to make them to look more
like the rest of the document.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22 21:23:46 -03:00

48 lines
1.1 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _lirc_set_rec_carrier_range:
********************************
ioctl LIRC_SET_REC_CARRIER_RANGE
********************************
Name
====
LIRC_SET_REC_CARRIER_RANGE - Set lower bond of the carrier used to modulate
IR receive.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency )
:name: LIRC_SET_REC_CARRIER_RANGE
Arguments
=========
``fd``
File descriptor returned by open().
``frequency``
Frequency of the carrier that modulates PWM data, in Hz.
Description
===========
This ioctl sets the upper range of carrier frequency that will be recognized
by the IR receiver.
.. note::
To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
<LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
:ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
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.