media: lirc: document LIRC_MODE_SCANCODE (7d402db8) · Commits · 戴 / test

Documentation/media/lirc.h.rst.exceptions

+26 −0

Original line number	Diff line number	Diff line
		@@ -32,6 +32,32 @@ ignore define LIRC_CAN_SET_REC_DUTY_CYCLE

		ignore ioctl LIRC_GET_LENGTH

		# rc protocols

		ignore symbol RC_PROTO_UNKNOWN
		ignore symbol RC_PROTO_OTHER
		ignore symbol RC_PROTO_RC5
		ignore symbol RC_PROTO_RC5X_20
		ignore symbol RC_PROTO_RC5_SZ
		ignore symbol RC_PROTO_JVC
		ignore symbol RC_PROTO_SONY12
		ignore symbol RC_PROTO_SONY15
		ignore symbol RC_PROTO_SONY20
		ignore symbol RC_PROTO_NEC
		ignore symbol RC_PROTO_NECX
		ignore symbol RC_PROTO_NEC32
		ignore symbol RC_PROTO_SANYO
		ignore symbol RC_PROTO_MCIR2_KBD
		ignore symbol RC_PROTO_MCIR2_MSE
		ignore symbol RC_PROTO_RC6_0
		ignore symbol RC_PROTO_RC6_6A_20
		ignore symbol RC_PROTO_RC6_6A_24
		ignore symbol RC_PROTO_RC6_6A_32
		ignore symbol RC_PROTO_RC6_MCE
		ignore symbol RC_PROTO_SHARP
		ignore symbol RC_PROTO_XMP
		ignore symbol RC_PROTO_CEC

		# Undocumented macros

		ignore define PULSE_BIT

Documentation/media/uapi/rc/lirc-dev-intro.rst

+46 −5

Original line number	Diff line number	Diff line
		@@ -6,11 +6,12 @@
		Introduction
		************

		The LIRC device interface is a bi-directional interface for transporting
		raw IR data between userspace and kernelspace. Fundamentally, it is just
		a chardev (/dev/lircX, for X = 0, 1, 2, ...), with a number of standard
		struct file_operations defined on it. With respect to transporting raw
		IR data to and fro, the essential fops are read, write and ioctl.
		LIRC stands for Linux Infrared Remote Control. The LIRC device interface is
		a bi-directional interface for transporting raw IR and decoded scancodes
		data between userspace and kernelspace. Fundamentally, it is just a chardev
		(/dev/lircX, for X = 0, 1, 2, ...), with a number of standard struct
		file_operations defined on it. With respect to transporting raw IR and
		decoded scancodes to and fro, the essential fops are read, write and ioctl.

		Example dmesg output upon a driver registering w/LIRC:

		@@ -36,6 +37,46 @@ LIRC modes
		LIRC supports some modes of receiving and sending IR codes, as shown
		on the following table.

		.. _lirc-mode-scancode:
		.. _lirc-scancode-flag-toggle:
		.. _lirc-scancode-flag-repeat:

		``LIRC_MODE_SCANCODE``

		This mode is for both sending and receiving IR.

		For transmitting (aka sending), create a ``struct lirc_scancode`` with
		the desired scancode set in the ``scancode`` member, ``rc_proto`` set
		the IR protocol, 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,
		with ``scancode`` set to the received scancode and the IR protocol
		``rc_proto``. If the scancode maps to a valid key code, this is set
		in the ``keycode`` field, else it is set to ``KEY_RESERVED``.

		The ``flags`` can have ``LIRC_SCANCODE_FLAG_TOGGLE`` set if the toggle
		bit is set in protocols that support it (e.g. rc-5 and rc-6), or
		``LIRC_SCANCODE_FLAG_REPEAT`` for when a repeat is received for protocols
		that support it (e.g. nec).

		In the Sanyo and NEC protocol, if you hold a button on remote, rather than
		repeating the entire scancode, the remote sends a shorter message with
		no scancode, which just means button is held, a "repeat". When this is
		received, the ``LIRC_SCANCODE_FLAG_REPEAT`` is set and the scancode and
		keycode is repeated.

		With nec, there is no way to distinguish "button hold" from "repeatedly
		pressing the same button". The rc-5 and rc-6 protocols have a toggle bit.
		When a button is released and pressed again, the toggle bit is inverted.
		If the toggle bit is set, the ``LIRC_SCANCODE_FLAG_TOGGLE`` is set.

		The ``timestamp`` field is filled with the time nanoseconds
		(in ``CLOCK_MONOTONIC``) when the scancode was decoded.

		An ``enum rc_proto`` in the :ref:`lirc_header` lists all the supported
		IR protocols.

		.. _lirc-mode-mode2:

		``LIRC_MODE_MODE2``

Documentation/media/uapi/rc/lirc-get-features.rst

+16 −0

Original line number	Diff line number	Diff line
		@@ -64,6 +64,14 @@ LIRC features

		Unused. Kept just to avoid breaking uAPI.

		.. _LIRC-CAN-REC-SCANCODE:

		``LIRC_CAN_REC_SCANCODE``

		The driver is capable of receiving using
		:ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>`.


		.. _LIRC-CAN-SET-SEND-CARRIER:

		``LIRC_CAN_SET_SEND_CARRIER``
		@@ -171,6 +179,14 @@ LIRC features

		Unused. Kept just to avoid breaking uAPI.

		.. _LIRC-CAN-SEND-SCANCODE:

		``LIRC_CAN_SEND_SCANCODE``

		The driver supports sending (also called as IR blasting or IR TX) using
		:ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>`.


		Return Value
		============

Documentation/media/uapi/rc/lirc-get-rec-mode.rst

+2 −1

Original line number	Diff line number	Diff line
		@@ -34,7 +34,8 @@ Description
		===========

		Get/set supported receive modes. Only :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`
		is supported for IR receive.
		and :ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` are supported.
		Use :ref:`lirc_get_features` to find out which modes the driver supports.

		Return Value
		============

Documentation/media/uapi/rc/lirc-get-send-mode.rst

+2 −1

Original line number	Diff line number	Diff line
		@@ -36,7 +36,8 @@ Description

		Get/set current transmit mode.

		Only :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` is supported by for IR send,
		Only :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` and
		:ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` are supported by for IR send,
		depending on the driver. Use :ref:`lirc_get_features` to find out which
		modes the driver supports.

Admin message