Skip to contentSkip to conversation

keyboard notifier documentation

PATCH In review Samuel Thibault 2 participants 6 messages Feb 9, 2008

Subsystems (3)
Documentation HID Input drivers
lore
Share & tools
lore

Samuel Thibault

author
#0 lore raw

PATCH 1/1 keyboard notifier documentation

Document the keyboard notifier.

Signed-off-by Samuel Thibault <[email protected]>
Documentation/input/notifier.txt new file +52 -0
@@ -0,0 +1,52 @@
+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:
+
+- '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_* ;
+- 'value' depends on the type of event.
+
+- KBD_KEYCODE events are always sent before other events, value is the keycode.
+- KBD_UNBOUND_KEYCODE events are sent if the keycode is not bound to a keysym.
+  value is the keycode.
+- KBD_UNICODE events are sent if the keycode -> keysym translation produced a
+  unicode character. value is the unicode value.
+- KBD_KEYSYM events are sent if the keycode -> keysym translation produced a
+  non-unicode character. value is the keysym.
+- KBD_POST_KEYSYM events are sent after the treatment of non-unicode keysyms.
+  That permits to inspect the resulting LEDs for instance.
+
+For each kind of event but the last, the callback may return NOTIFY_STOP in
+order to "eat" the event: the notify loop is stopped and the keyboard event is
+dropped.
+
+I a rough C snippet, we have:
+
+kbd_keycode(keycode) {
+	...
+	params.value = keycode;
+	if (notifier_call_chain(KBD_KEYCODE,&params) == NOTIFY_STOP)
+	    || !bound) {
+		notifier_call_chain(KBD_UNBOUND_KEYCODE,&params);
+		return;
+	}
+
+	if (unicode) {
+		param.value = unicode;
+		if (notifier_call_chain(KBD_UNICODE,&params) == NOTIFY_STOP)
+			return;
+		emit unicode;
+		return;
+	}
+
+	params.value = keysym;
+	if (notifier_call_chain(KBD_KEYSYM,&params) == NOTIFY_STOP)
+		return;
+	apply keysym;
+	notifier_call_chain(KBD_POST_KEYSYM,&params);
+}
+
+NOTE: This notifier is usually called from interrupt context.
#1 lore raw
Quoted 7 lines · On Sat, 9 Feb 2008 01:33:22 +0000 Samuel Thibault wrote:

Document the keyboard notifier.

Signed-off-by Samuel Thibault <[email protected]>

Documentation/input/notifier.txt line 9

Quoted 9 lines
Documentation/input/notifier.txt new file +9 -0
@@ -0,0 +1,52 @@
+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:
+
+- '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_* ;

No space before the ';' (3 times).

Documentation/input/notifier.txt line 20

Quoted 11 lines
Documentation/input/notifier.txt new file +11 -0
+- 'value' depends on the type of event.
+
+- KBD_KEYCODE events are always sent before other events, value is the keycode.
+- KBD_UNBOUND_KEYCODE events are sent if the keycode is not bound to a keysym.
+  value is the keycode.
+- KBD_UNICODE events are sent if the keycode -> keysym translation produced a
+  unicode character. value is the unicode value.
+- KBD_KEYSYM events are sent if the keycode -> keysym translation produced a
+  non-unicode character. value is the keysym.
+- KBD_POST_KEYSYM events are sent after the treatment of non-unicode keysyms.
+  That permits to inspect the resulting LEDs for instance.

That permits (some object word here, like: you, one, code, etc.) to inspect ...

Documentation/input/notifier.txt line 26

Quoted 6 lines
Documentation/input/notifier.txt new file +6 -0
+
+For each kind of event but the last, the callback may return NOTIFY_STOP in
+order to "eat" the event: the notify loop is stopped and the keyboard event is
+dropped.
+
+I a rough C snippet, we have:

In a rough (?)

Quoted 17 lines
Documentation/input/notifier.txt new file +17 -0
+
+kbd_keycode(keycode) {
+	...
+	params.value = keycode;
+	if (notifier_call_chain(KBD_KEYCODE,&params) == NOTIFY_STOP)
+	    || !bound) {
+		notifier_call_chain(KBD_UNBOUND_KEYCODE,&params);
+		return;
+	}
+
+	if (unicode) {
+		param.value = unicode;
+		if (notifier_call_chain(KBD_UNICODE,&params) == NOTIFY_STOP)
+			return;
+		emit unicode;
+		return;
+	}

Documentation/input/notifier.txt

Quoted 10 lines
Documentation/input/notifier.txt new file +9 -1
+
+	params.value = keysym;
+	if (notifier_call_chain(KBD_KEYSYM,&params) == NOTIFY_STOP)
+		return;
+	apply keysym;
+	notifier_call_chain(KBD_POST_KEYSYM,&params);
+}
+
+NOTE: This notifier is usually called from interrupt context.
--

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

author
#2 lore raw
Quoted 6 lines · Randy Dunlap, le Fri 08 Feb 2008 20:12:53 -0800, a écrit :
Quoted 3 lines · On Sat, 9 Feb 2008 01:33:22 +0000 Samuel Thibault wrote:
+- '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_* ;

No space before the ';' (3 times).

Well, as expected in French... I'll fix that.

Quoted 7 lines

Documentation/input/notifier.txt line 26

Quoted 5 lines
Documentation/input/notifier.txt new file +5 -0
+For each kind of event but the last, the callback may return NOTIFY_STOP in
+order to "eat" the event: the notify loop is stopped and the keyboard event is
+dropped.
+
+I a rough C snippet, we have:

In a rough (?)

Yes, rough as "something that a C compiler will never accept, but that you, human, will make sense out of it".

Samuel
-
To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

#3 lore raw
Quoted 16 lines · Samuel Thibault
Quoted 5 lines · Randy Dunlap, le Fri 08 Feb 2008 20:12:53 -0800, a écrit :
Quoted 3 lines · On Sat, 9 Feb 2008 01:33:22 +0000 Samuel Thibault wrote:
+- '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_* ;

No space before the ';' (3 times).

Well, as expected in French... I'll fix that.

Quoted 6 lines

Documentation/input/notifier.txt line 26

Quoted 5 lines
Documentation/input/notifier.txt new file +5 -0
+For each kind of event but the last, the callback may return NOTIFY_STOP in
+order to "eat" the event: the notify loop is stopped and the keyboard event is
+dropped.
+
+I a rough C snippet, we have:

In a rough (?)

Quoted 2 lines

Yes, rough as "something that a C compiler will never accept, but that you, human, will make sense out of it".

so s/I/In/ please.

Signature · 5 lines
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
author
#4 lore raw
Quoted 19 lines · Randy Dunlap, le Sat 09 Feb 2008 07:38:59 -0800, a écrit :
Quoted 18 lines · Samuel Thibault
Quoted 5 lines · Randy Dunlap, le Fri 08 Feb 2008 20:12:53 -0800, a écrit :
Quoted 3 lines · On Sat, 9 Feb 2008 01:33:22 +0000 Samuel Thibault wrote:
+- '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_* ;

No space before the ';' (3 times).

Well, as expected in French... I'll fix that.

Quoted 8 lines

Documentation/input/notifier.txt line 26

Quoted 7 lines

+For each kind of event but the last, the callback may return NOTIFY_STOP in
+order to "eat" the event: the notify loop is stopped and the keyboard event is

Documentation/input/notifier.txt new file +3 -0
+dropped.
+
+I a rough C snippet, we have:

In a rough (?)

Quoted 4 lines
Quoted 2 lines

Yes, rough as "something that a C compiler will never accept, but that you, human, will make sense out of it".

so s/I/In/ please.

Ah oops, sorry misunderstood what you raised, I actually had fixed it in the second version.

Thanks,
Samuel
-
To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

author
#5 lore raw
In reply to Samuel Thibault

Document the keyboard notifier.

Signed-off-by Samuel Thibault <[email protected]>
Documentation/input/notifier.txt new file +52 -0
@@ -0,0 +1,52 @@
+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:
+
+- '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_*;
+- 'value' depends on the type of event.
+
+- KBD_KEYCODE events are always sent before other events, value is the keycode.
+- KBD_UNBOUND_KEYCODE events are sent if the keycode is not bound to a keysym.
+  value is the keycode.
+- KBD_UNICODE events are sent if the keycode -> keysym translation produced a
+  unicode character. value is the unicode value.
+- KBD_KEYSYM events are sent if the keycode -> keysym translation produced a
+  non-unicode character. value is the keysym.
+- KBD_POST_KEYSYM events are sent after the treatment of non-unicode keysyms.
+  That permits one to inspect the resulting LEDs for instance.
+
+For each kind of event but the last, the callback may return NOTIFY_STOP in
+order to "eat" the event: the notify loop is stopped and the keyboard event is
+dropped.
+
+In a rough C snippet, we have:
+
+kbd_keycode(keycode) {
+	...
+	params.value = keycode;
+	if (notifier_call_chain(KBD_KEYCODE,&params) == NOTIFY_STOP)
+	    || !bound) {
+		notifier_call_chain(KBD_UNBOUND_KEYCODE,&params);
+		return;
+	}
+
+	if (unicode) {
+		param.value = unicode;
+		if (notifier_call_chain(KBD_UNICODE,&params) == NOTIFY_STOP)
+			return;
+		emit unicode;
+		return;
+	}
+
+	params.value = keysym;
+	if (notifier_call_chain(KBD_KEYSYM,&params) == NOTIFY_STOP)
+		return;
+	apply keysym;
+	notifier_call_chain(KBD_POST_KEYSYM,&params);
+}
+
+NOTE: This notifier is usually called from interrupt context.