[media] doc-rst: document ioctl LIRC_GET_REC_MODE
Move the documentation of this ioctl from lirc_ioctl to its own file, and add a short description about the pulse mode used by IR RX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
4ed030af4f
commit
dbe678dd21
|
@ -0,0 +1,59 @@
|
|||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _lirc_get_rec_mode:
|
||||
|
||||
***********************
|
||||
ioctl LIRC_GET_REC_MODE
|
||||
***********************
|
||||
|
||||
Name
|
||||
====
|
||||
|
||||
LIRC_GET_REC_MODE - Get supported receive modes.
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
.. cpp:function:: int ioctl( int fd, int request, __u32 rx_modes)
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
||||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_REC_MODE
|
||||
|
||||
``rx_modes``
|
||||
Bitmask with the supported transmit modes.
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
Get supported receive modes.
|
||||
|
||||
Supported receive modes
|
||||
=======================
|
||||
|
||||
.. _lirc-mode-mode2:
|
||||
|
||||
``LIRC_MODE_MODE2``
|
||||
|
||||
The driver returns a sequence of pulse and space codes to userspace.
|
||||
|
||||
.. _lirc-mode-lirccode:
|
||||
|
||||
``LIRC_MODE_LIRCCODE``
|
||||
|
||||
The IR signal is decoded internally by the receiver. The LIRC interface
|
||||
returns the scancode as an integer value. This is the usual mode used
|
||||
by several TV media cards.
|
||||
|
||||
|
||||
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.
|
|
@ -14,4 +14,5 @@ LIRC Device Interface
|
|||
lirc_write
|
||||
lirc-get-features
|
||||
lirc-get-send-mode
|
||||
lirc-get-rec-mode
|
||||
lirc_ioctl
|
||||
|
|
|
@ -49,15 +49,6 @@ device can rely on working with the default settings initially.
|
|||
I/O control requests
|
||||
====================
|
||||
|
||||
.. _LIRC_GET_REC_MODE:
|
||||
.. _lirc-mode-mode2:
|
||||
.. _lirc-mode-lirccode:
|
||||
|
||||
``LIRC_GET_REC_MODE``
|
||||
|
||||
Get supported receive modes. Only ``LIRC_MODE_MODE2`` and
|
||||
``LIRC_MODE_LIRCCODE`` are supported by lircd.
|
||||
|
||||
.. _LIRC_SET_SEND_DUTY_CYCLE:
|
||||
|
||||
``LIRC_SET_SEND_DUTY_CYCLE``
|
||||
|
|
Loading…
Reference in New Issue