Commit 4fe21dec authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: rc: improve LIRC documentation 



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

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarSean Young <sean@mess.org>
parent ac7f9d02

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

+9 −2
Original line number Diff line number Diff line
@@ -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

********************

include/uapi/linux/lirc.h

+1 −1
Original line number Diff line number Diff line
@@ -139,7 +139,7 @@ 
 */

#define LIRC_GET_REC_TIMEOUT	       _IOR('i', 0x00000024, __u32)



/*

/**

 * struct lirc_scancode - decoded scancode with protocol for use with

 *	LIRC_MODE_SCANCODE

 *