palkia: add keyboard customization

As the Palkia isn't using chromeos keyboard, we need to
remapping the keyboard matrix for the key event. The
new config option CONFIG_KEYBOARD_CUSTOMIZATION is added
to customize the keyboard matrix in the board layer.
Most of the keys have been remapped except F11-F16, Fn and
win key, we can remap it later.

BUG=b:148034320
BRANCH=firmware-hatch-12672.B
TEST=esc+refresh+power
     alt+vol up+r
     evtest for all of the keys

Change-Id: Ibb02e3a7f5e022eeca36865e8561393fc326f2af
Signed-off-by: Zhuohao Lee <zhuohao@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2035445
Reviewed-by: Jett Rink <jettrink@chromium.org>

6 files changed, 186 insertions, 3 deletions

diff --git a/board/palkia/board.c b/board/palkia/board.c
index a9604daeff..3688064811 100644
--- a/board/palkia/board.c
+++ b/board/palkia/board.c
@@ -21,6 +21,7 @@
 #include "gpio.h"
 #include "hooks.h"
 #include "host_command.h"
+#include "keyboard_scan.h"
 #include "lid_switch.h"
 #include "power.h"
 #include "power_button.h"
@@ -42,11 +43,26 @@
 #define CPRINTS(format, args...) cprints(CC_USBCHARGE, format, ## args)
 #define CPRINTF(format, args...) cprintf(CC_USBCHARGE, format, ## args)
 
+static const uint8_t actual_key_mask[KEYBOARD_COLS_MAX] = {
+	0x01, 0x68, 0xbd, 0x03, 0x7e, 0xff, 0xff,
+	0xff, 0xff, 0x03, 0xfd, 0x48, 0x03, 0xff,
+	0xf7, 0x16  /* full set */
+};
+
 /* GPIO to enable/disable the USB Type-A port. */
 const int usb_port_enable[CONFIG_USB_PORT_POWER_SMART_PORT_COUNT] = {
 	GPIO_EN_USB_A_5V,
 };
 
+void board_config_pre_init(void)
+{
+	int i;
+
+	/* override the keyscan key mask */
+	for (i = 0; i < KEYBOARD_COLS_MAX; ++i)
+		keyscan_config.actual_key_mask[i] = actual_key_mask[i];
+}
+
 static void ppc_interrupt(enum gpio_signal signal)
 {
 	switch (signal) {
diff --git a/board/palkia/board.h b/board/palkia/board.h
index 9dd7761a82..62aac0e9a7 100644
--- a/board/palkia/board.h
+++ b/board/palkia/board.h
@@ -25,6 +25,11 @@
 
 /* Keyboard features */
 #define CONFIG_PWM_KBLIGHT
+#define CONFIG_KEYBOARD_CUSTOMIZATION
+#define CONFIG_KEYBOARD_DEBUG
+
+/* Enable board_config_pre_init() */
+#define CONFIG_BOARD_PRE_INIT
 
 /* USB Type C and USB PD defines */
 #define CONFIG_USB_PD_COMM_LOCKED
diff --git a/board/palkia/build.mk b/board/palkia/build.mk
index e91262fd43..cf0939b776 100644
--- a/board/palkia/build.mk
+++ b/board/palkia/build.mk
@@ -13,3 +13,4 @@ BASEBOARD:=hatch
 
 board-y=board.o led.o
 board-$(CONFIG_BATTERY_SMART)+=battery.o
+board-$(CONFIG_KEYBOARD_CUSTOMIZATION)+=keyboard_customization.o
diff --git a/board/palkia/gpio.inc b/board/palkia/gpio.inc
index 3dc181eca0..ec7ce25538 100644
--- a/board/palkia/gpio.inc
+++ b/board/palkia/gpio.inc
@@ -86,12 +86,13 @@ GPIO(I2C7_SDA,                 PIN(B, 2), GPIO_INPUT)           /* EC_I2C_EEPROM
 
 /* Keyboard pins */
 #define GPIO_KB_INPUT (GPIO_INPUT | GPIO_PULL_UP)
-GPIO(KBD_KSO2,                 PIN(1, 7), GPIO_OUT_LOW)        /* KSO_02 inverted */
+GPIO(KBD_KSO4,                 PIN(1, 5), GPIO_OUT_LOW)        /* KSO_04 inverted */
 ALTERNATE(PIN_MASK(3, 0x03), 0, MODULE_KEYBOARD_SCAN, GPIO_KB_INPUT)       /* KSI_00-01 */
 ALTERNATE(PIN_MASK(2, 0xFC), 0, MODULE_KEYBOARD_SCAN, GPIO_KB_INPUT)       /* KSI_02-07 */
 ALTERNATE(PIN_MASK(2, 0x03), 0, MODULE_KEYBOARD_SCAN, GPIO_ODR_HIGH)       /* KSO_00-01 */
-ALTERNATE(PIN_MASK(1, 0x7F), 0, MODULE_KEYBOARD_SCAN, GPIO_ODR_HIGH)       /* KSO_03-09 */
-ALTERNATE(PIN_MASK(0, 0xE0), 0, MODULE_KEYBOARD_SCAN, GPIO_ODR_HIGH)       /* KSO_10-12 */
+ALTERNATE(PIN_MASK(1, 0xDF), 0, MODULE_KEYBOARD_SCAN, GPIO_ODR_HIGH)       /* KSO_02-03,05-09 */
+ALTERNATE(PIN_MASK(0, 0xE8), 0, MODULE_KEYBOARD_SCAN, GPIO_ODR_HIGH)       /* KSO_10-13 */
+ALTERNATE(PIN_MASK(8, 0x0C), 0, MODULE_KEYBOARD_SCAN, GPIO_ODR_HIGH)       /* KSO_14-15 */
 
 /* Alternate functions GPIO definitions */
 ALTERNATE(PIN_MASK(9, 0x01), 0, MODULE_I2C, 0)                             /* I2C1 SCL */
diff --git a/board/palkia/keyboard_customization.c b/board/palkia/keyboard_customization.c
new file mode 100644
index 0000000000..e83b5ecb99
--- /dev/null
+++ b/board/palkia/keyboard_customization.c
@@ -0,0 +1,86 @@
+/* Copyright 2020 The Chromium OS Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include "common.h"
+#include "keyboard_customization.h"
+#include "keyboard_8042_sharedlib.h"
+#include "keyboard_config.h"
+#include "keyboard_protocol.h"
+#include "keyboard_raw.h"
+
+uint16_t scancode_set2[KEYBOARD_COLS_MAX][KEYBOARD_ROWS] = {
+	{0x0021, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000},
+	{0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000},
+	{0x0015, 0x0000, 0x0000, 0x000d, 0x000e, 0x0016, 0x0000, 0x001c},
+	{0xe011, 0x0011, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000},
+	{0x0000, 0x0029, 0x0024, 0x000c, 0xe01f, 0x0026, 0x0004, 0x0000},
+	{0x0022, 0x001a, 0x0006, 0x0005, 0x001b, 0x001e, 0x001d, 0x0076},
+	{0x002a, 0x0032, 0x0034, 0x002c, 0x002e, 0x0025, 0x002d, 0x002b},
+	{0x003a, 0x0031, 0x0033, 0x0035, 0x0036, 0x003d, 0x003c, 0x003b},
+	{0x0049, 0xe072, 0x005d, 0x0044, 0x0009, 0x0046, 0x0000, 0x004b},
+	{0x0059, 0x0012, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000},
+	{0x0041, 0x0000, 0x0083, 0x000b, 0x0003, 0x003e, 0x0043, 0x0042},
+	{0x0000, 0x0000, 0x0000, 0x0001, 0x0000, 0x0000, 0xe06b, 0x0000},
+	{0xe014, 0x0014, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000},
+	{0x004a, 0xe075, 0x004e, 0x0000, 0x0045, 0x004d, 0x0054, 0x004c},
+	{0x0052, 0x005a, 0x0000, 0x0000, 0x0055, 0x0066, 0x005b, 0x0023},
+	{0x0000, 0x000a, 0xe074, 0x0000, 0x0000, 0x0000, 0x0000, 0x0000},
+};
+
+void board_keyboard_drive_col(int col)
+{
+	/* Drive all lines to high */
+	if (col == KEYBOARD_COLUMN_NONE)
+		gpio_set_level(GPIO_KBD_KSO4, 0);
+
+	/* Set KBSOUT to zero to detect key-press */
+	else if (col == KEYBOARD_COLUMN_ALL)
+		gpio_set_level(GPIO_KBD_KSO4, 1);
+
+	/* Drive one line for detection */
+	else {
+		if (col == 4)
+			gpio_set_level(GPIO_KBD_KSO4, 1);
+		else
+			gpio_set_level(GPIO_KBD_KSO4, 0);
+	}
+}
+
+#ifdef CONFIG_KEYBOARD_DEBUG
+char keycap_label[KEYBOARD_COLS_MAX][KEYBOARD_ROWS] = {
+	{'c',        KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+	{KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+	{'q',        KLLI_UNKNO, KLLI_UNKNO, KLLI_TAB,   '`',
+		'1',        KLLI_UNKNO, 'a'},
+	{KLLI_R_ALT, KLLI_L_ALT, KLLI_UNKNO, KLLI_UNKNO,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+	{KLLI_UNKNO, KLLI_SPACE, 'e',        KLLI_F4,
+		KLLI_SEARC, '3',        KLLI_F3,    KLLI_UNKNO},
+	{'x',        'z',        KLLI_F2,    KLLI_F1,
+		's',        '2',        'w',        KLLI_ESC},
+	{'v',        'b',        'g',        't',
+		'5',        '4',        'r',        'f'},
+	{'m',        'n',        'h',        'y',
+		'6',        '7',        'u',        'j'},
+	{'.',        KLLI_DOWN,  '\\',       'o',
+		KLLI_F10,   '9',        KLLI_UNKNO, 'l'},
+	{KLLI_R_SHT, KLLI_L_SHT, KLLI_UNKNO, KLLI_UNKNO,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+	{',',        KLLI_UNKNO, KLLI_F7,    KLLI_F6,
+		KLLI_F5,    '8',        'i',        'k'},
+	{KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_F9,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_LEFT,  KLLI_UNKNO},
+	{KLLI_R_CTR, KLLI_L_CTR, KLLI_UNKNO, KLLI_UNKNO,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+	{'/',        KLLI_UP,    '-',        KLLI_UNKNO,
+		'0',        'p',        '[',        ';'},
+	{'\'',       KLLI_ENTER, KLLI_UNKNO, KLLI_UNKNO,
+		'=',        KLLI_B_SPC, ']',        'd'},
+	{KLLI_UNKNO, KLLI_F8,    KLLI_RIGHT, KLLI_UNKNO,
+		KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO, KLLI_UNKNO},
+};
+#endif
diff --git a/board/palkia/keyboard_customization.h b/board/palkia/keyboard_customization.h
new file mode 100644
index 0000000000..bb19acd0e7
--- /dev/null
+++ b/board/palkia/keyboard_customization.h
@@ -0,0 +1,74 @@
+/* Copyright 2020 The Chromium OS Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+/* Keyboard configuration */
+
+#ifndef __KEYBOARD_CUSTOMIZATION_H
+#define __KEYBOARD_CUSTOMIZATION_H
+
+/*
+ * KEYBOARD_COLS_MAX has the build time column size. It's used to allocate
+ * exact spaces for arrays. Actual keyboard scanning is done using
+ * keyboard_cols, which holds a runtime column size.
+ */
+#define KEYBOARD_COLS_MAX 16
+#define KEYBOARD_ROWS 8
+
+/*
+ * WARNING: Do not directly modify it. You should call keyboard_raw_set_cols,
+ * instead. It checks whether you're eligible or not.
+ */
+extern uint8_t keyboard_cols;
+
+#define KEYBOARD_ROW_TO_MASK(r) (1 << (r))
+
+/* Columns and masks for keys we particularly care about */
+#define KEYBOARD_COL_DOWN	8
+#define KEYBOARD_ROW_DOWN	1
+#define KEYBOARD_MASK_DOWN	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_DOWN)
+#define KEYBOARD_COL_ESC	5
+#define KEYBOARD_ROW_ESC	7
+#define KEYBOARD_MASK_ESC	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_ESC)
+#define KEYBOARD_COL_KEY_H	7
+#define KEYBOARD_ROW_KEY_H	2
+#define KEYBOARD_MASK_KEY_H	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_KEY_H)
+#define KEYBOARD_COL_KEY_R	6
+#define KEYBOARD_ROW_KEY_R	6
+#define KEYBOARD_MASK_KEY_R	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_KEY_R)
+#define KEYBOARD_COL_LEFT_ALT	3
+#define KEYBOARD_ROW_LEFT_ALT	1
+#define KEYBOARD_MASK_LEFT_ALT	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_LEFT_ALT)
+#define KEYBOARD_COL_REFRESH	4
+#define KEYBOARD_ROW_REFRESH	6
+#define KEYBOARD_MASK_REFRESH	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_REFRESH)
+#define KEYBOARD_COL_RIGHT_ALT	3
+#define KEYBOARD_ROW_RIGHT_ALT	0
+#define KEYBOARD_MASK_RIGHT_ALT	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_RIGHT_ALT)
+#define KEYBOARD_COL_VOL_UP	8
+#define KEYBOARD_ROW_VOL_UP	4
+#define KEYBOARD_MASK_VOL_UP	KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_VOL_UP)
+#define KEYBOARD_COL_LEFT_CTRL  12
+#define KEYBOARD_ROW_LEFT_CTRL  1
+#define KEYBOARD_MASK_LEFT_CTRL KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_LEFT_CTRL)
+#define KEYBOARD_COL_RIGHT_CTRL 12
+#define KEYBOARD_ROW_RIGHT_CTRL 0
+#define KEYBOARD_MASK_RIGHT_CTRL KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_RIGHT_CTRL)
+#define KEYBOARD_COL_SEARCH     2
+#define KEYBOARD_ROW_SEARCH     3
+#define KEYBOARD_MASK_SEARCH    KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_SEARCH)
+#define KEYBOARD_COL_KEY_0      13
+#define KEYBOARD_ROW_KEY_0      4
+#define KEYBOARD_MASK_KEY_0     KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_KEY_0)
+#define KEYBOARD_COL_KEY_1      2
+#define KEYBOARD_ROW_KEY_1      5
+#define KEYBOARD_MASK_KEY_1     KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_KEY_1)
+#define KEYBOARD_COL_KEY_2      5
+#define KEYBOARD_ROW_KEY_2      5
+#define KEYBOARD_MASK_KEY_2     KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_KEY_2)
+#define KEYBOARD_COL_LEFT_SHIFT 9
+#define KEYBOARD_ROW_LEFT_SHIFT 1
+#define KEYBOARD_MASK_LEFT_SHIFT KEYBOARD_ROW_TO_MASK(KEYBOARD_ROW_LEFT_SHIFT)
+
+#endif /* __KEYBOARD_CUSTOMIZATION_H */