[PATCH 6/8] input: Documentation: corrections for notifier.rst

From: Randy Dunlap
Date: Tue Mar 02 2021 - 18:41:26 EST


Add 'ledstate' to the keyboard_notifier_param struct info and tell
which header file contains that struct.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Dmitry Torokhov <dmitry.torokhov@xxxxxxxxx>
Cc: linux-input@xxxxxxxxxxxxxxx
Cc: Jonathan Corbet <corbet@xxxxxxx>
Cc: linux-doc@xxxxxxxxxxxxxxx
---
Documentation/input/notifier.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20210202.orig/Documentation/input/notifier.rst
+++ linux-next-20210202/Documentation/input/notifier.rst
@@ -4,11 +4,12 @@ Keyboard notifier

One can use register_keyboard_notifier to get called back on keyboard
events (see kbd_keycode() function for details). The passed structure is
-keyboard_notifier_param:
+keyboard_notifier_param (see <linux/keyboard.h>):

- 'vc' always provide the VC for which the keyboard event applies;
- 'down' is 1 for a key press event, 0 for a key release;
- 'shift' is the current modifier state, mask bit indexes are KG_*;
+- 'ledstate' is the current LED state;
- 'value' depends on the type of event.

- KBD_KEYCODE events are always sent before other events, value is the keycode.