linux/Documentation/media/uapi/rc/lirc-get-rec-mode.rst
Mauro Carvalho Chehab 048eb3ef75 [media] doc-rst: document LIRC set mode ioctls
Add LIRC_SET_[REC|SEND]_MODE ioctls to the corresponding
GET functions, and put all LIRC modes altogether.

As now everything is already documented on its own ioctl
pages, get rid of lirc_ioctl.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12 09:42:59 -03:00

46 lines
976 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _lirc_get_rec_mode:
.. _lirc_set_rec_mode:
**********************************************
ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE
**********************************************
Name
====
LIRC_GET_REC_MODE/LIRC_GET_REC_MODE - Get/set 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 or LIRC_GET_REC_MODE
``rx_modes``
Bitmask with the supported transmit modes.
Description
===========
Get/set supported receive modes. Only :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`
and :ref:`LIRC_MODE_LIRCCODE <lirc-mode-lirccode>` are supported for IR
receive.
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.