keyboard: display keycap label in key status debug messages

The current debug message in keyboard_8042.c displays a tuple of
row, column, and press status. Additionally, this CL displays a
keycap label for better readability.
For keycap label mapping table can be adjustable under
"CONFIG_KEYBOARD_SCANCODE_MUTABLE" condition as scancode_set2[] is.

For coral board, Enabling CONFIG_KEYBOARD_DEBUG (w/o this CL)
occupies 652 bytes in flash, and this CL occupies another 312 bytes.

BUG=b:111060830
TEST=manually tested by pressing keyboards and check the EC console
     screen.
BRANCH=kblog

Signed-off-by: Namyoon Woo <namyoon@chromium.org>

 Changes to be committed:
	modified:   board/eve/board.c
	modified:   common/keyboard_8042.c
	modified:   common/keyboard_8042_sharedlib.c
	modified:   include/keyboard_8042_sharedlib.h

Change-Id: Idd71a5475b1ee313f99e087be9143dcfb6f81550
Reviewed-on: https://chromium-review.googlesource.com/1214543
Commit-Ready: ChromeOS CL Exonerator Bot <chromiumos-cl-exonerator@appspot.gserviceaccount.com>
Tested-by: Namyoon Woo <namyoon@chromium.org>
Reviewed-by: Hung-Te Lin <hungte@chromium.org>

4 files changed, 109 insertions, 1 deletions

diff --git a/board/eve/board.c b/board/eve/board.c
index 9943d4688b..e4ff6ad44a 100644
--- a/board/eve/board.c
+++ b/board/eve/board.c
@@ -490,6 +490,9 @@ static void board_init(void)
 		/* Set F13 to new defined key on EVT */
 		CPRINTS("Overriding F13 scan code");
 		scancode_set2[3][9] = 0xe007;
+#ifdef CONFIG_KEYBOARD_DEBUG
+		keycap_label[3][9] = KLLI_F13;
+#endif
 	}
 #endif
 }
diff --git a/common/keyboard_8042.c b/common/keyboard_8042.c
index 7e906a1c04..e561762843 100644
--- a/common/keyboard_8042.c
+++ b/common/keyboard_8042.c
@@ -384,7 +384,15 @@ void keyboard_state_changed(int row, int col, int is_pressed)
 	int32_t len = 0;
 	enum ec_error_list ret;
 
-	CPRINTS5("KB (%d,%d)=%d", row, col, is_pressed);
+#ifdef CONFIG_KEYBOARD_DEBUG
+	char mylabel = keycap_label[row][col];
+
+	if (mylabel & KEYCAP_LONG_LABEL_BIT)
+		CPRINTS("KB (%d,%d)=%d %s", row, col, is_pressed,
+		  keycap_long_label[mylabel & KEYCAP_LONG_LABEL_INDEX_BITMASK]);
+	else
+		CPRINTS("KB (%d,%d)=%d %c", row, col, is_pressed, mylabel);
+#endif
 
 	ret = matrix_callback(row, col, is_pressed, scancode_set, scan_code,
 			      &len);
diff --git a/common/keyboard_8042_sharedlib.c b/common/keyboard_8042_sharedlib.c
index 513a27913d..214eaafb5a 100644
--- a/common/keyboard_8042_sharedlib.c
+++ b/common/keyboard_8042_sharedlib.c
@@ -65,6 +65,55 @@ SHAREDLIB(const uint8_t scancode_translate_table[128] = {
 	0x57, 0x4e, 0x51, 0x4a, 0x37, 0x49, 0x46, 0x54,
 });
 
+
+#ifdef CONFIG_KEYBOARD_DEBUG
+SHAREDLIB(const
+char * const keycap_long_label[KLLI_MAX & KEYCAP_LONG_LABEL_INDEX_BITMASK] = {
+	"UNKNOWN", "F1",    "F2",    "F3",
+	"F4",      "F5",    "F6",    "F7",
+	"F8",      "F9",    "F10",   "F11",
+	"F12",     "F13",   "RSVD",  "RSVD",
+	"L-ALT",   "R-ALT", "L-CTR", "R-CTR",
+	"L-SHT",   "R-SHT", "ENTER", "SPACE",
+	"B-SPC",   "TAB",   "SEARC", "LEFT",
+	"RIGHT",   "DOWN",  "UP",    "ESC",
+});
+
+#ifndef CONFIG_KEYBOARD_SCANCODE_MUTABLE
+SHAREDLIB(const
+#endif
+char keycap_label[KEYBOARD_ROWS][KEYBOARD_COLS] = {
+	{KLLI_UNKNO, KLLI_SEARC, KLLI_F1,    'b',        KLLI_F10,
+	 KLLI_UNKNO, 'n',        KLLI_UNKNO, '=',        KLLI_UNKNO,
+	 KLLI_R_ALT, KLLI_UNKNO, KLLI_UNKNO},
+	{KLLI_UNKNO, KLLI_ESC,   KLLI_F4,    'g',        KLLI_F7,
+	 KLLI_UNKNO, 'h',        KLLI_UNKNO, '\'',       KLLI_F9,
+	 KLLI_UNKNO, KLLI_B_SPC, KLLI_UNKNO},
+	{KLLI_L_CTR, KLLI_TAB,   KLLI_F3,    't',        KLLI_F6,
+	 ']',        'y',        KLLI_UNKNO, '[',        KLLI_F8,
+	 KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+	{KLLI_UNKNO, '~',        KLLI_F2,    '5',        KLLI_F5,
+	 KLLI_UNKNO, '6',        KLLI_UNKNO, '-',        KLLI_UNKNO,
+	 KLLI_UNKNO, '\\',       KLLI_UNKNO},
+	{KLLI_R_CTR, 'a',        'd',        'f',        's',
+	 'k',        'j',        KLLI_UNKNO, ';',        '|',
+	 KLLI_UNKNO, KLLI_ENTER, KLLI_UNKNO},
+	{KLLI_UNKNO, 'z',        'c',        'v',        'x',
+	 ',',        'm',        KLLI_L_SHT, '/',        '.',
+	 KLLI_UNKNO, KLLI_SPACE, KLLI_UNKNO},
+	{KLLI_UNKNO, '1',        '3',        '4',        '2',
+	 '8',        '7',        KLLI_UNKNO, '0',        '9',
+	 KLLI_L_ALT, KLLI_DOWN,  KLLI_RIGHT},
+	{KLLI_UNKNO, 'q',        'e',        'r',        'w',
+	 'i',        'u',        KLLI_R_SHT, 'p',        'o',
+	 KLLI_UNKNO, KLLI_UP,    KLLI_LEFT},
+}
+#ifndef CONFIG_KEYBOARD_SCANCODE_MUTABLE
+)
+#endif
+;
+#endif
+
 uint8_t scancode_translate_set2_to_1(uint8_t code)
 {
 	if (code & 0x80) {
diff --git a/include/keyboard_8042_sharedlib.h b/include/keyboard_8042_sharedlib.h
index adf2932231..e944e74af2 100644
--- a/include/keyboard_8042_sharedlib.h
+++ b/include/keyboard_8042_sharedlib.h
@@ -28,6 +28,54 @@ extern const uint16_t scancode_set2[KEYBOARD_ROWS][KEYBOARD_COLS];
 extern const uint8_t scancode_translate_table[];
 extern uint8_t scancode_translate_set2_to_1(uint8_t code);
 
+#ifdef CONFIG_KEYBOARD_DEBUG
+#define KEYCAP_LONG_LABEL_BIT   (0x80)
+#define KEYCAP_LONG_LABEL_INDEX_BITMASK		(~KEYCAP_LONG_LABEL_BIT)
+
+enum keycap_long_label_idx {
+	KLLI_UNKNO = 0x80,		/* UNKNOWN */
+	KLLI_F1    = 0x81,		/* F1 or PREVIOUS */
+	KLLI_F2    = 0x82,		/* F2 or NEXT */
+	KLLI_F3    = 0x83,		/* F3 or REFRESH */
+	KLLI_F4    = 0x84,		/* F4 or FULL_SCREEN */
+	KLLI_F5    = 0x85,		/* F5 or OVERVIEW */
+	KLLI_F6    = 0x86,		/* F6 or DIM */
+	KLLI_F7    = 0x87,		/* F7 or BRIGHT */
+	KLLI_F8    = 0x88,		/* F8 or MUTE */
+	KLLI_F9    = 0x89,		/* F9 or VOLUME DOWN */
+	KLLI_F10   = 0x8A,		/* F10 or VOLUME UP */
+	KLLI_F11   = 0x8B,		/* F11 or POWER */
+	KLLI_F12   = 0x8C,		/* F12 or DEV TOOLS */
+	KLLI_F13   = 0x8D,		/* F13 or GOOGLE ASSISTANT */
+	KLLI_RSVD4 = 0x8E,
+	KLLI_RSVD5 = 0x8F,
+	KLLI_L_ALT = 0x90,		/* LEFT ALT */
+	KLLI_R_ALT = 0x91,		/* RIGHT ALT */
+	KLLI_L_CTR = 0x92,		/* LEFT CONTROL */
+	KLLI_R_CTR = 0x93,		/* RIGHT CONTROL */
+	KLLI_L_SHT = 0x94,		/* LEFT SHIFT */
+	KLLI_R_SHT = 0x95,		/* RIGHT SHIFT */
+	KLLI_ENTER = 0x96,		/* ENTER */
+	KLLI_SPACE = 0x97,		/* SPACE */
+	KLLI_B_SPC = 0x98,		/* BACk SPACE*/
+	KLLI_TAB   = 0x99,		/* TAB */
+	KLLI_SEARC = 0x9A,		/* SEARCH */
+	KLLI_LEFT  = 0x9B,		/* LEFT ARROW */
+	KLLI_RIGHT = 0x9C,		/* RIGHT ARROW */
+	KLLI_DOWN  = 0x9D,		/* DOWN ARROW */
+	KLLI_UP    = 0x9E,		/* UP ARROW */
+	KLLI_ESC   = 0x9F,		/* ESCAPE */
+	KLLI_MAX
+};
+
+extern const char * const keycap_long_label[];
+#ifdef CONFIG_KEYBOARD_SCANCODE_MUTABLE
+extern char keycap_label[KEYBOARD_ROWS][KEYBOARD_COLS];
+#else
+extern const char keycap_label[KEYBOARD_ROWS][KEYBOARD_COLS];
+#endif
+#endif
+
 /* Button scancodes (Power, Volume Down, Volume Up, etc.) */
 extern const struct button_8042_t buttons_8042[KEYBOARD_BUTTON_COUNT];