leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
29566c9c77
linux/Documentation/media/uapi/rc/lirc-get-rec-mode.rst

75 lines
1.6 KiB
ReStructuredText
Raw Normal View History

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
.. Permission is granted to copy, distribute and/or modify this
.. document under the terms of the GNU Free Documentation License,
.. Version 1.1 or any later version published by the Free Software
.. Foundation, with no Invariant Sections, no Front-Cover Texts
.. and no Back-Cover Texts. A copy of the license is included at
.. Documentation/media/uapi/fdl-appendix.rst.
..
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
[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 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 12:11:08 +00:00
.. _lirc_set_rec_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
[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 12:11:08 +00:00
**********************************************
ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_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
Name
====
media: lirc: lirc mode ioctls deal with current mode The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-28 22:03:22 +00:00
LIRC_GET_REC_MODE/LIRC_SET_REC_MODE - Get/set current receive 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
Synopsis
========
media: lirc: lirc mode ioctls deal with current mode The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-28 22:03:22 +00:00
.. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 *mode)
[media] docs-rst: Convert LIRC uAPI to use C function references Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 19:59:31 +00:00
:name: LIRC_GET_REC_MODE
media: lirc: lirc mode ioctls deal with current mode The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-28 22:03:22 +00:00
.. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 *mode)
[media] docs-rst: Convert LIRC uAPI to use C function references Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 19:59:31 +00:00
:name: LIRC_SET_REC_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
Arguments
=========
``fd``
File descriptor returned by open().
media: lirc: lirc mode ioctls deal with current mode The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-28 22:03:22 +00:00
``mode``
Mode used for receive.
[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
Description
===========
media: lirc: lirc mode ioctls deal with current mode The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-28 22:03:22 +00:00
Get and set the current receive mode. Only
:ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>` and
:ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` are supported.
media: lirc: document LIRC_MODE_SCANCODE Lirc supports a new mode which requires documentation. Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-02-25 11:51:34 +00:00
Use :ref:`lirc_get_features` to find out which modes the driver supports.
[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
Return Value
============
media: lirc: lirc mode ioctls deal with current mode The ioctl change the current mode or return the current mode; they do not tell you which modes are possible (use the lirc features ioctl for that). Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-28 22:03:22 +00:00
.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- ``ENODEV``
- Device not available.
- .. row 2
- ``ENOTTY``
- Device does not support receiving.
- .. row 3
- ``EINVAL``
- Invalid mode or invalid mode for this device.
Reference in New Issue Copy Permalink