KDB: Fix usability issues relating to the 'enter' key.

This fixes the following problems:
1) Typematic-repeat of 'enter' gives warning message
   and leaks make/break if KDB exits. Repeats
   look something like 0x1c 0x1c .... 0x9c
2) Use of 'keypad enter' gives warning message and
   leaks the ENTER break/make code out if KDB exits.
   KP ENTER repeats look someting like 0xe0 0x1c
   0xe0 0x1c ... 0xe0 0x9c.
3) Lag on the order of seconds between "break" and "make" when
   expecting the enter "break" code. Seen under virtualized
   environments such as VMware ESX.

The existing special enter handler tries to glob the enter break code,
but this fails if the other (KP) enter was used, or if there was a key
repeat. It also fails if you mashed some keys along with enter, and
you ended up with a non-enter make or non-enter break code coming
after the enter make code. So first, we modify the handler to handle
these cases. But performing these actions on every enter is annoying
since now you can't hold ENTER down to scroll <more>d messages in
KDB. Since this special behaviour is only necessary to handle the
exiting KDB ('g' + ENTER) without leaking scancodes to the OS.  This
cleanup needs to get executed anytime the kdb_main loop exits.

Tested on QEMU. Set a bp on atkbd.c to verify no scan code was leaked.

Cc: Andrei Warkentin <andreiw@vmware.com>
[jason.wessel@windriver.com: move cleanup calls to kdb_main.c]
Signed-off-by: Andrei Warkentin <andrey.warkentin@gmail.com>
Signed-off-by: Jason Wessel <jason.wessel@windriver.com>

3 files changed, 83 insertions, 22 deletions

diff --git a/kernel/debug/kdb/kdb_keyboard.c b/kernel/debug/kdb/kdb_keyboard.c
index 4bca634975c..118527aa60e 100644
--- a/kernel/debug/kdb/kdb_keyboard.c
+++ b/kernel/debug/kdb/kdb_keyboard.c
@@ -25,6 +25,7 @@
 #define KBD_STAT_MOUSE_OBF      0x20    /* Mouse output buffer full */
 
 static int kbd_exists;
+static int kbd_last_ret;
 
 /*
  * Check if the keyboard controller has a keypress for us.
@@ -90,8 +91,11 @@ int kdb_get_kbd_char(void)
                 return -1;
         }
 
-        if ((scancode & 0x80) != 0)
+        if ((scancode & 0x80) != 0) {
+                if (scancode == 0x9c)
+                        kbd_last_ret = 0;
                 return -1;
+        }
 
         scancode &= 0x7f;
 
@@ -178,35 +182,82 @@ int kdb_get_kbd_char(void)
                 return -1;      /* ignore unprintables */
         }
 
-        if ((scancode & 0x7f) == 0x1c) {
-                /*
-                 * enter key.  All done.  Absorb the release scancode.
-                 */
+        if (scancode == 0x1c) {
+                kbd_last_ret = 1;
+                return 13;
+        }
+
+        return keychar & 0xff;
+}
+EXPORT_SYMBOL_GPL(kdb_get_kbd_char);
+
+/*
+ * Best effort cleanup of ENTER break codes on leaving KDB. Called on
+ * exiting KDB, when we know we processed an ENTER or KP ENTER scan
+ * code.
+ */
+void kdb_kbd_cleanup_state(void)
+{
+        int scancode, scanstatus;
+
+        /*
+         * Nothing to clean up, since either
+         * ENTER was never pressed, or has already
+         * gotten cleaned up.
+         */
+        if (!kbd_last_ret)
+                return;
+
+        kbd_last_ret = 0;
+        /*
+         * Enter key. Need to absorb the break code here, lest it gets
+         * leaked out if we exit KDB as the result of processing 'g'.
+         *
+         * This has several interesting implications:
+         * + Need to handle KP ENTER, which has break code 0xe0 0x9c.
+         * + Need to handle repeat ENTER and repeat KP ENTER. Repeats
+         *   only get a break code at the end of the repeated
+         *   sequence. This means we can't propagate the repeated key
+         *   press, and must swallow it away.
+         * + Need to handle possible PS/2 mouse input.
+         * + Need to handle mashed keys.
+         */
+
+        while (1) {
                 while ((inb(KBD_STATUS_REG) & KBD_STAT_OBF) == 0)
-                        ;
+                        cpu_relax();
 
                 /*
-                 * Fetch the scancode
+                 * Fetch the scancode.
                  */
                 scancode = inb(KBD_DATA_REG);
                 scanstatus = inb(KBD_STATUS_REG);
 
-                while (scanstatus & KBD_STAT_MOUSE_OBF) {
-                        scancode = inb(KBD_DATA_REG);
-                        scanstatus = inb(KBD_STATUS_REG);
-                }
+                /*
+                 * Skip mouse input.
+                 */
+                if (scanstatus & KBD_STAT_MOUSE_OBF)
+                        continue;
 
-                if (scancode != 0x9c) {
-                        /*
-                         * Wasn't an enter-release,  why not?
-                         */
-                        kdb_printf("kdb: expected enter got 0x%x status 0x%x\n",
-                               scancode, scanstatus);
-                }
+                /*
+                 * If we see 0xe0, this is either a break code for KP
+                 * ENTER, or a repeat make for KP ENTER. Either way,
+                 * since the second byte is equivalent to an ENTER,
+                 * skip the 0xe0 and try again.
+                 *
+                 * If we see 0x1c, this must be a repeat ENTER or KP
+                 * ENTER (and we swallowed 0xe0 before). Try again.
+                 *
+                 * We can also see make and break codes for other keys
+                 * mashed before or after pressing ENTER. Thus, if we
+                 * see anything other than 0x9c, we have to try again.
+                 *
+                 * Note, if you held some key as ENTER was depressed,
+                 * that break code would get leaked out.
+                 */
+                if (scancode != 0x9c)
+                        continue;
 
-                return 13;
+                return;
         }
-
-        return keychar & 0xff;
 }
-EXPORT_SYMBOL_GPL(kdb_get_kbd_char);
diff --git a/kernel/debug/kdb/kdb_main.c b/kernel/debug/kdb/kdb_main.c
index e2ae7349437..67b847dfa2b 100644
--- a/kernel/debug/kdb/kdb_main.c
+++ b/kernel/debug/kdb/kdb_main.c
@@ -1400,6 +1400,9 @@ int kdb_main_loop(kdb_reason_t reason, kdb_reason_t reason2, int error,
         if (KDB_STATE(DOING_SS))
                 KDB_STATE_CLEAR(SSBPT);
 
+        /* Clean up any keyboard devices before leaving */
+        kdb_kbd_cleanup_state();
+
         return result;
 }
 
diff --git a/kernel/debug/kdb/kdb_private.h b/kernel/debug/kdb/kdb_private.h
index e381d105b40..47c4e56e513 100644
--- a/kernel/debug/kdb/kdb_private.h
+++ b/kernel/debug/kdb/kdb_private.h
@@ -246,6 +246,13 @@ extern void debug_kusage(void);
 
 extern void kdb_set_current_task(struct task_struct *);
 extern struct task_struct *kdb_current_task;
+
+#ifdef CONFIG_KDB_KEYBOARD
+extern void kdb_kbd_cleanup_state(void);
+#else /* ! CONFIG_KDB_KEYBOARD */
+#define kdb_kbd_cleanup_state()
+#endif /* ! CONFIG_KDB_KEYBOARD */
+
 #ifdef CONFIG_MODULES
 extern struct list_head *kdb_modules;
 #endif /* CONFIG_MODULES */