bybrooklyn/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-04-19 07:13:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

media: rc: improve LIRC documentation

Browse Source 
Add documentation for enum rc_proto and struct lirc_scancode
at the generated docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Sean Young <sean@mess.org>
This commit is contained in:
Mauro Carvalho Chehab
2020-11-26 13:55:39 +01:00
parent ac7f9d0283
commit 4fe21dec6c
2 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/userspace-api/media/rc/lirc-dev-intro.rst
View File

@@ -57,12 +57,12 @@ on the following table.
This mode is for both sending and receiving IR.
For transmitting (aka sending), create a ``struct lirc_scancode`` with
For transmitting (aka sending), create a struct lirc_scancode with
the desired scancode set in the ``scancode`` member, :c:type:`rc_proto`
set to the :ref:`IR protocol <Remote_controllers_Protocols>`, and all other
members set to 0. Write this struct to the lirc device.
For receiving, you read ``struct lirc_scancode`` from the LIRC device.
For receiving, you read struct lirc_scancode from the LIRC device.
The ``scancode`` field is set to the received scancode and the
:ref:`IR protocol <Remote_controllers_Protocols>` is set in
:c:type:`rc_proto`. If the scancode maps to a valid key code, this is set
@@ -136,6 +136,13 @@ on the following table.
This mode is used only for IR send.
*************************************
Data types used by LIRC_MODE_SCANCODE
*************************************
.. kernel-doc:: include/uapi/linux/lirc.h
:identifiers: lirc_scancode rc_proto
********************
BPF based IR decoder
********************