linux-stable/Documentation/userspace-api/media/rc/lirc-func.rst

.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later

.. _lirc_func:

LIRC Function Reference
=======================


.. toctree::
    :maxdepth: 1

    lirc-read
    lirc-write
    lirc-get-features
    lirc-get-send-mode
    lirc-get-rec-mode
    lirc-get-rec-resolution
    lirc-set-send-duty-cycle
    lirc-get-timeout
    lirc-set-rec-timeout
    lirc-set-rec-carrier
    lirc-set-rec-carrier-range
    lirc-set-send-carrier
    lirc-set-transmitter-mask
    lirc-set-rec-timeout-reports
    lirc-set-measure-carrier-mode
    lirc-set-wideband-receiver
media: docs: uAPI: rc: dual-license the docs with GPL v2 Make the license for those documents also compatible with GPLv2. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Sean Young <sean@mess.org> 2020-11-26 11:13:36 +00:00			`.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later`
media: add SPDX header to media uAPI files All those files are under GFDL 1.1 or later, with no invariant sections. Tag them as such. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 2018-08-30 14:15:26 +00:00
[media] doc-rst: reorganize LIRC ReST files Reorganize the LIRC rst files, using "-" instead of "_" on their names, and creating a separate chapter for syscalls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 12:35:26 +00:00			`.. _lirc_func:`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00
[media] doc-rst: reorganize LIRC ReST files Reorganize the LIRC rst files, using "-" instead of "_" on their names, and creating a separate chapter for syscalls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 12:35:26 +00:00			`LIRC Function Reference`
			`=======================`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-06-30 13:18:56 +00:00

			`.. toctree::`
			`:maxdepth: 1`

[media] doc-rst: reorganize LIRC ReST files Reorganize the LIRC rst files, using "-" instead of "_" on their names, and creating a separate chapter for syscalls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 12:35:26 +00:00			`lirc-read`
			`lirc-write`
[media] doc-rst: Document ioctl LIRC_GET_FEATURES The documentation for this ioctl was really crappy. Add a better documentation, using the lirc.4 man pages as a reference, plus what was written originally at the lirc-ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-11 01:33:57 +00:00			`lirc-get-features`
[media] doc-rst: document ioctl LIRC_GET_SEND_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 TX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-11 01:35:21 +00:00			`lirc-get-send-mode`
[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> 2016-07-11 01:46:12 +00:00			`lirc-get-rec-mode`
[media] doc-rst: document LIRC_GET_REC_RESOLUTION Improve the documentation for this ioctl, adding it to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-11 11:25:30 +00:00			`lirc-get-rec-resolution`
[media] doc-rst: document LIRC_SET_SEND_DUTY_CYCLE Add a separate page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-11 02:27:31 +00:00			`lirc-set-send-duty-cycle`
[media] doc-rst: document LIRC_GET_*_TIMEOUT ioctls Improve the documentation for those ioctls, adding them to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for those ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-11 11:36:29 +00:00			`lirc-get-timeout`
[media] doc-rst: document LIRC_SET_REC_TIMEOUT Add a separate page for this ioctl and adds the cross-references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 10:49:00 +00:00			`lirc-set-rec-timeout`
[media] doc-rst: document LIRC set carrier ioctls Put each ioctl on its own page and improve documentation, adding cross-references for LIRC_SET_REC_CARRIER_RANGE and LIRC_SET_REC_CARRIER, with can be used together to set a carrier frequency range. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 10:21:23 +00:00			`lirc-set-rec-carrier`
			`lirc-set-rec-carrier-range`
			`lirc-set-send-carrier`
[media] doc-rst: document LIRC_SET_TRANSMITTER_MASK Add proper documentation for this ioctl, providing some additional information about its usage. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 10:38:58 +00:00			`lirc-set-transmitter-mask`
[media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTS Add a separate page for this ioctl and improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 10:56:28 +00:00			`lirc-set-rec-timeout-reports`
[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> 2016-07-12 11:05:03 +00:00			`lirc-set-measure-carrier-mode`
[media] doc-rst: document LIRC_SET_WIDEBAND_RECEIVER Put documentation for this ioctl on a separate page and improve it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 2016-07-12 11:10:50 +00:00			`lirc-set-wideband-receiver`