[media] doc-rst: add documentation for LIRC_SET_MEASURE_CARRIER_MODE
Place documentation for this ioctl on its own page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
572c194b88
commit
ae94d4c9d4
@ -0,0 +1,48 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _lirc_set_measure_carrier_mode:
|
||||
|
||||
***********************************
|
||||
ioctl LIRC_SET_MEASURE_CARRIER_MODE
|
||||
***********************************
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
.. cpp:function:: int ioctl( int fd, int request, __u32 *enable )
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_MEASURE_CARRIER_MODE
|
||||
|
||||
``enable``
|
||||
enable = 1 means enable measure mode, enable = 0 means disable measure
|
||||
mode.
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
.. _lirc-mode2-frequency:
|
||||
|
||||
Enable or disable measure mode. If enabled, from the next key
|
||||
press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
|
||||
default this should be turned off.
|
||||
|
||||
|
||||
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.
|
@ -25,4 +25,5 @@ LIRC Device Interface
|
||||
lirc-set-send-carrier
|
||||
lirc-set-transmitter-mask
|
||||
lirc-set-rec-timeout-reports
|
||||
lirc-set-measure-carrier-mode
|
||||
lirc_ioctl
|
||||
|
@ -54,15 +54,6 @@ device can rely on working with the default settings initially.
|
||||
Set send/receive mode. Largely obsolete for send, as only
|
||||
``LIRC_MODE_PULSE`` is supported.
|
||||
|
||||
.. _LIRC_SET_MEASURE_CARRIER_MODE:
|
||||
.. _lirc-mode2-frequency:
|
||||
|
||||
``LIRC_SET_MEASURE_CARRIER_MODE``
|
||||
|
||||
Enable (1)/disable (0) measure mode. If enabled, from the next key
|
||||
press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
|
||||
default this should be turned off.
|
||||
|
||||
.. _LIRC_SET_WIDEBAND_RECEIVER:
|
||||
|
||||
``LIRC_SET_WIDEBAND_RECEIVER``
|
||||
|
Loading…
Reference in New Issue
Block a user