Commit f27637f9 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] doc-rst: document LIRC_SET_WIDEBAND_RECEIVER

Put documentation for this ioctl on a separate page and
improve it.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent ae94d4c9
.. -*- coding: utf-8; mode: rst -*-
.. _lirc_set_wideband_receiver:
********************************
ioctl LIRC_SET_WIDEBAND_RECEIVER
********************************
Name
====
LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, __u32 *enable )
Arguments
=========
``fd``
File descriptor returned by open().
``request``
LIRC_SET_WIDEBAND_RECEIVER
``enable``
enable = 1 means enable wideband receiver, enable = 0 means disable
wideband receiver.
Description
===========
Some receivers are equipped with special wide band receiver which is
intended to be used to learn output of existing remote. This ioctl
allows enabling or disabling it.
This might be useful of receivers that have otherwise narrow band receiver
that prevents them to be used with some remotes. Wide band receiver might
also be more precise. On the other hand its disadvantage it usually
reduced range of reception.
.. note:: Wide band receiver might be implictly enabled if you enable
carrier reports. In that case it will be disabled as soon as you disable
carrier reports. Trying to disable wide band receiver while carrier
reports are active will do nothing.
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.
...@@ -26,4 +26,5 @@ LIRC Device Interface ...@@ -26,4 +26,5 @@ LIRC Device Interface
lirc-set-transmitter-mask lirc-set-transmitter-mask
lirc-set-rec-timeout-reports lirc-set-rec-timeout-reports
lirc-set-measure-carrier-mode lirc-set-measure-carrier-mode
lirc-set-wideband-receiver
lirc_ioctl lirc_ioctl
...@@ -54,25 +54,6 @@ device can rely on working with the default settings initially. ...@@ -54,25 +54,6 @@ device can rely on working with the default settings initially.
Set send/receive mode. Largely obsolete for send, as only Set send/receive mode. Largely obsolete for send, as only
``LIRC_MODE_PULSE`` is supported. ``LIRC_MODE_PULSE`` is supported.
.. _LIRC_SET_WIDEBAND_RECEIVER:
``LIRC_SET_WIDEBAND_RECEIVER``
Some receivers are equipped with special wide band receiver which is
intended to be used to learn output of existing remote. Calling that
ioctl with (1) will enable it, and with (0) disable it. This might
be useful of receivers that have otherwise narrow band receiver that
prevents them to be used with some remotes. Wide band receiver might
also be more precise On the other hand its disadvantage it usually
reduced range of reception.
.. note:: Wide band receiver might be
implictly enabled if you enable carrier reports. In that case it
will be disabled as soon as you disable carrier reports. Trying to
disable wide band receiver while carrier reports are active will do
nothing.
.. _lirc_dev_errors: .. _lirc_dev_errors:
Return Value Return Value
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment