TOMOYO Linux Cross Reference
Linux/Documentation/input/notifier.rst

Diff markup

Differences between /Documentation/input/notifier.rst (Architecture i386) and /Documentation/input/notifier.rst (Architecture sparc)

   =================                                    =================
   Keyboard notifier                                    Keyboard notifier
   =================                                    =================
                                                        
   One can use register_keyboard_notifier to get        One can use register_keyboard_notifier to get called back on keyboard
   events (see kbd_keycode() function for details       events (see kbd_keycode() function for details).  The passed structure is
   keyboard_notifier_param (see <linux/keyboard.h       keyboard_notifier_param (see <linux/keyboard.h>):
                                                        
   - 'vc' always provide the VC for which the key       - 'vc' always provide the VC for which the keyboard event applies;
  - 'down' is 1 for a key press event, 0 for a k      - 'down' is 1 for a key press event, 0 for a key release;
  - 'shift' is the current modifier state, mask       - 'shift' is the current modifier state, mask bit indexes are KG_*;
  - 'ledstate' is the current LED state;              - 'ledstate' is the current LED state;
  - 'value' depends on the type of event.             - 'value' depends on the type of event.
                                                      
  - KBD_KEYCODE events are always sent before ot      - KBD_KEYCODE events are always sent before other events, value is the keycode.
  - KBD_UNBOUND_KEYCODE events are sent if the k      - KBD_UNBOUND_KEYCODE events are sent if the keycode is not bound to a keysym.
    value is the keycode.                               value is the keycode.
  - KBD_UNICODE events are sent if the keycode -      - KBD_UNICODE events are sent if the keycode -> keysym translation produced a
    unicode character. value is the unicode valu        unicode character. value is the unicode value.
  - KBD_KEYSYM events are sent if the keycode ->      - KBD_KEYSYM events are sent if the keycode -> keysym translation produced a
    non-unicode character. value is the keysym.         non-unicode character. value is the keysym.
  - KBD_POST_KEYSYM events are sent after the tr      - KBD_POST_KEYSYM events are sent after the treatment of non-unicode keysyms.
    That permits one to inspect the resulting LE        That permits one to inspect the resulting LEDs for instance.
                                                      
  For each kind of event but the last, the callb      For each kind of event but the last, the callback may return NOTIFY_STOP in
  order to "eat" the event: the notify loop is s      order to "eat" the event: the notify loop is stopped and the keyboard event is
  dropped.                                            dropped.
                                                      
  In a rough C snippet, we have::                     In a rough C snippet, we have::
                                                      
      kbd_keycode(keycode) {                              kbd_keycode(keycode) {
          ...                                                 ...
          params.value = keycode;                             params.value = keycode;
          if (notifier_call_chain(KBD_KEYCODE,&p              if (notifier_call_chain(KBD_KEYCODE,&params) == NOTIFY_STOP)
              || !bound) {                                        || !bound) {
                  notifier_call_chain(KBD_UNBOUN                      notifier_call_chain(KBD_UNBOUND_KEYCODE,&params);
                  return;                                             return;
          }                                                   }
                                                      
          if (unicode) {                                      if (unicode) {
                  param.value = unicode;                              param.value = unicode;
                  if (notifier_call_chain(KBD_UN                      if (notifier_call_chain(KBD_UNICODE,&params) == NOTIFY_STOP)
                          return;                                             return;
                  emit unicode;                                       emit unicode;
                  return;                                             return;
          }                                                   }
                                                      
          params.value = keysym;                              params.value = keysym;
          if (notifier_call_chain(KBD_KEYSYM,&pa              if (notifier_call_chain(KBD_KEYSYM,&params) == NOTIFY_STOP)
                  return;                                             return;
          apply keysym;                                       apply keysym;
          notifier_call_chain(KBD_POST_KEYSYM,&p              notifier_call_chain(KBD_POST_KEYSYM,&params);
      }                                                   }
                                                      
  .. note:: This notifier is usually called from      .. note:: This notifier is usually called from interrupt context.
                                                      

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.