Keyboard: Consolidate keyboard factory tests

This patch consolidates keyboard factory tests, which are currently
duplicated under the chip directories.

Signed-off-by: Daisuke Nojiri <dnojiri@chromium.org>

BUG=none
BRANCH=none
TEST=buildall

Change-Id: I1ab8bc96808e1c284d991d3c2f1f82a37329676e
Reviewed-on: https://chromium-review.googlesource.com/1378654
Commit-Ready: Daisuke Nojiri <dnojiri@chromium.org>
Tested-by: Daisuke Nojiri <dnojiri@chromium.org>
Reviewed-by: Jett Rink <jettrink@chromium.org>

5 files changed, 79 insertions, 198 deletions

diff --git a/chip/mchp/keyboard_raw.c b/chip/mchp/keyboard_raw.c
index 4d146e85f8..ef968c0eb8 100644
--- a/chip/mchp/keyboard_raw.c
+++ b/chip/mchp/keyboard_raw.c
@@ -98,73 +98,7 @@ void keyboard_raw_interrupt(void)
 }
 DECLARE_IRQ(MCHP_IRQ_KSC_INT, keyboard_raw_interrupt, 1);
 
-#ifdef CONFIG_KEYBOARD_FACTORY_TEST
-
-/* Run keyboard factory testing, scan out KSO/KSI if any shorted. */
-int keyboard_factory_test_scan(void)
+int keyboard_raw_is_input_low(int port, int id)
 {
-	int i, j, flags;
-	uint16_t shorted = 0;
-	uint32_t port, id, val;
-
-	/* Disable keyboard scan while testing */
-	keyboard_scan_enable(0, KB_SCAN_DISABLE_LID_CLOSED);
-
-	flags = gpio_get_default_flags(GPIO_KBD_KSO2);
-
-	/* Set all of KSO/KSI pins to internal pull-up and input */
-	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
-
-		if (keyboard_factory_scan_pins[i][0] < 0)
-			continue;
-
-		port = keyboard_factory_scan_pins[i][0];
-		id = keyboard_factory_scan_pins[i][1];
-
-		gpio_set_alternate_function(port, 1 << id, -1);
-		gpio_set_flags_by_mask(port, 1 << id,
-			GPIO_INPUT | GPIO_PULL_UP);
-	}
-
-	/*
-	 * Set start pin to output low, then check other pins
-	 * going to low level, it indicate the two pins are shorted.
-	 */
-	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
-
-		if (keyboard_factory_scan_pins[i][0] < 0)
-			continue;
-
-		port = keyboard_factory_scan_pins[i][0];
-		id = keyboard_factory_scan_pins[i][1];
-
-		gpio_set_flags_by_mask(port, 1 << id, GPIO_OUT_LOW);
-
-		for (j = 0; j < i; j++) {
-
-			if (keyboard_factory_scan_pins[j][0] < 0)
-				continue;
-
-			/*
-			 * Get gpio pin control register,
-			 * bit 24 indicate GPIO input from the pad.
-			 */
-			val = MCHP_GPIO_CTL(keyboard_factory_scan_pins[j][0],
-					keyboard_factory_scan_pins[j][1]);
-
-			if ((val & (1 << 24)) == 0) {
-				shorted = i << 8 | j;
-				goto done;
-			}
-		}
-		gpio_set_flags_by_mask(port, 1 << id,
-			GPIO_INPUT | GPIO_PULL_UP);
-	}
-done:
-	gpio_config_module(MODULE_KEYBOARD_SCAN, 1);
-	gpio_set_flags(GPIO_KBD_KSO2, flags);
-	keyboard_scan_enable(1, KB_SCAN_DISABLE_LID_CLOSED);
-
-	return shorted;
+	return (MCHP_GPIO_CTL(port, id) & (1 << 24)) == 0;
 }
-#endif
diff --git a/chip/mec1322/keyboard_raw.c b/chip/mec1322/keyboard_raw.c
index 2befb00fe6..3269af2cf9 100644
--- a/chip/mec1322/keyboard_raw.c
+++ b/chip/mec1322/keyboard_raw.c
@@ -82,73 +82,7 @@ void keyboard_raw_interrupt(void)
 }
 DECLARE_IRQ(MEC1322_IRQ_KSC_INT, keyboard_raw_interrupt, 1);
 
-#ifdef CONFIG_KEYBOARD_FACTORY_TEST
-
-/* Run keyboard factory testing, scan out KSO/KSI if any shorted. */
-int keyboard_factory_test_scan(void)
+int keyboard_raw_is_input_low(int port, int id)
 {
-	int i, j, flags;
-	uint16_t shorted = 0;
-	uint32_t port, id, val;
-
-	/* Disable keyboard scan while testing */
-	keyboard_scan_enable(0, KB_SCAN_DISABLE_LID_CLOSED);
-
-	flags = gpio_get_default_flags(GPIO_KBD_KSO2);
-
-	/* Set all of KSO/KSI pins to internal pull-up and input */
-	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
-
-		if (keyboard_factory_scan_pins[i][0] < 0)
-			continue;
-
-		port = keyboard_factory_scan_pins[i][0];
-		id = keyboard_factory_scan_pins[i][1];
-
-		gpio_set_alternate_function(port, 1 << id, -1);
-		gpio_set_flags_by_mask(port, 1 << id,
-			GPIO_INPUT | GPIO_PULL_UP);
-	}
-
-	/*
-	 * Set start pin to output low, then check other pins
-	 * going to low level, it indicate the two pins are shorted.
-	 */
-	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
-
-		if (keyboard_factory_scan_pins[i][0] < 0)
-			continue;
-
-		port = keyboard_factory_scan_pins[i][0];
-		id = keyboard_factory_scan_pins[i][1];
-
-		gpio_set_flags_by_mask(port, 1 << id, GPIO_OUT_LOW);
-
-		for (j = 0; j < i; j++) {
-
-			if (keyboard_factory_scan_pins[j][0] < 0)
-				continue;
-
-			/*
-			 * Get gpio pin control register,
-			 * bit 24 indicate GPIO input from the pad.
-			 */
-			val = MEC1322_GPIO_CTL(keyboard_factory_scan_pins[j][0],
-					keyboard_factory_scan_pins[j][1]);
-
-			if ((val & (1 << 24)) == 0) {
-				shorted = i << 8 | j;
-				goto done;
-			}
-		}
-		gpio_set_flags_by_mask(port, 1 << id,
-			GPIO_INPUT | GPIO_PULL_UP);
-	}
-done:
-	gpio_config_module(MODULE_KEYBOARD_SCAN, 1);
-	gpio_set_flags(GPIO_KBD_KSO2, flags);
-	keyboard_scan_enable(1, KB_SCAN_DISABLE_LID_CLOSED);
-
-	return shorted;
+	return (MEC1322_GPIO_CTL(port, id) & (1 << 24)) == 0;
 }
-#endif
diff --git a/chip/npcx/keyboard_raw.c b/chip/npcx/keyboard_raw.c
index 9ab1b1cddf..97a563c53f 100644
--- a/chip/npcx/keyboard_raw.c
+++ b/chip/npcx/keyboard_raw.c
@@ -156,67 +156,8 @@ void keyboard_raw_interrupt(void)
 }
 DECLARE_IRQ(NPCX_IRQ_KSI_WKINTC_1, keyboard_raw_interrupt, 5);
 
-#ifdef CONFIG_KEYBOARD_FACTORY_TEST
-
-/* Run keyboard factory testing, scan out KSO/KSI if any shorted. */
-int keyboard_factory_test_scan(void)
+int keyboard_raw_is_input_low(int port, int id)
 {
-	int i, j, flags;
-	uint16_t shorted = 0;
-	uint32_t port, id;
-
-	/* Disable keyboard scan while testing */
-	keyboard_scan_enable(0, KB_SCAN_DISABLE_LID_CLOSED);
-
-	flags = gpio_get_default_flags(GPIO_KBD_KSO2);
-
-	/* Set all of KSO/KSI pins to internal pull-up and input */
-	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
-
-		if (keyboard_factory_scan_pins[i][0] < 0)
-			continue;
-
-		port = keyboard_factory_scan_pins[i][0];
-		id = keyboard_factory_scan_pins[i][1];
-
-		gpio_set_alternate_function(port, 1 << id, -1);
-		gpio_set_flags_by_mask(port, 1 << id,
-			GPIO_INPUT | GPIO_PULL_UP);
-	}
-
-	/*
-	 * Set start pin to output low, then check other pins
-	 * going to low level, it indicate the two pins are shorted.
-	 */
-	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
-
-		if (keyboard_factory_scan_pins[i][0] < 0)
-			continue;
-
-		port = keyboard_factory_scan_pins[i][0];
-		id = keyboard_factory_scan_pins[i][1];
-
-		gpio_set_flags_by_mask(port, 1 << id, GPIO_OUT_LOW);
-
-		for (j = 0; j < i; j++) {
-
-			if (keyboard_factory_scan_pins[j][0] < 0)
-				continue;
-
-			if ((NPCX_PDIN(keyboard_factory_scan_pins[j][0]) &
-			    (1 << keyboard_factory_scan_pins[j][1])) == 0) {
-				shorted = i << 8 | j;
-				goto done;
-			}
-		}
-		gpio_set_flags_by_mask(port, 1 << id,
-			GPIO_INPUT | GPIO_PULL_UP);
-	}
-done:
-	gpio_config_module(MODULE_KEYBOARD_SCAN, 1);
-	gpio_set_flags(GPIO_KBD_KSO2, flags);
-	keyboard_scan_enable(1, KB_SCAN_DISABLE_LID_CLOSED);
-
-	return shorted;
+	return (NPCX_PDIN(port) & (1 << id)) == 0;
 }
-#endif
+
diff --git a/common/keyboard_scan.c b/common/keyboard_scan.c
index f9a64eb806..24fc7bc73c 100644
--- a/common/keyboard_scan.c
+++ b/common/keyboard_scan.c
@@ -861,6 +861,69 @@ DECLARE_HOST_COMMAND(EC_CMD_MKBP_SIMULATE_KEY,
 		     EC_VER_MASK(0));
 
 #ifdef CONFIG_KEYBOARD_FACTORY_TEST
+
+/* Run keyboard factory testing, scan out KSO/KSI if any shorted. */
+int keyboard_factory_test_scan(void)
+{
+	int i, j, flags;
+	uint16_t shorted = 0;
+	int port, id;
+
+	/* Disable keyboard scan while testing */
+	keyboard_scan_enable(0, KB_SCAN_DISABLE_LID_CLOSED);
+	flags = gpio_get_default_flags(GPIO_KBD_KSO2);
+
+	/* Set all of KSO/KSI pins to internal pull-up and input */
+	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
+
+		if (keyboard_factory_scan_pins[i][0] < 0)
+			continue;
+
+		port = keyboard_factory_scan_pins[i][0];
+		id = keyboard_factory_scan_pins[i][1];
+
+		gpio_set_alternate_function(port, 1 << id, -1);
+		gpio_set_flags_by_mask(port, 1 << id,
+			GPIO_INPUT | GPIO_PULL_UP);
+	}
+
+	/*
+	 * Set start pin to output low, then check other pins
+	 * going to low level, it indicate the two pins are shorted.
+	 */
+	for (i = 0; i < keyboard_factory_scan_pins_used; i++) {
+
+		if (keyboard_factory_scan_pins[i][0] < 0)
+			continue;
+
+		port = keyboard_factory_scan_pins[i][0];
+		id = keyboard_factory_scan_pins[i][1];
+
+		gpio_set_flags_by_mask(port, 1 << id, GPIO_OUT_LOW);
+
+		for (j = 0; j < i; j++) {
+
+			if (keyboard_factory_scan_pins[j][0] < 0)
+				continue;
+
+			if (keyboard_raw_is_input_low(
+					keyboard_factory_scan_pins[j][0],
+					keyboard_factory_scan_pins[j][1])) {
+				shorted = i << 8 | j;
+				goto done;
+			}
+		}
+		gpio_set_flags_by_mask(port, 1 << id,
+			GPIO_INPUT | GPIO_PULL_UP);
+	}
+done:
+	gpio_config_module(MODULE_KEYBOARD_SCAN, 1);
+	gpio_set_flags(GPIO_KBD_KSO2, flags);
+	keyboard_scan_enable(1, KB_SCAN_DISABLE_LID_CLOSED);
+
+	return shorted;
+}
+
 static int keyboard_factory_test(struct host_cmd_handler_args *args)
 {
 	struct ec_response_keyboard_factory_test *r = args->response;
diff --git a/include/keyboard_raw.h b/include/keyboard_raw.h
index 7b21898f91..2763c36a9b 100644
--- a/include/keyboard_raw.h
+++ b/include/keyboard_raw.h
@@ -80,6 +80,15 @@ static inline void keyboard_raw_gpio_interrupt(enum gpio_signal signal) { }
  */
 int keyboard_factory_test_scan(void);
 
+/**
+ * Return true if the current value of the given input GPIO port is zero
+ *
+ * @param port: GPIO port/bank number
+ * @param id:   GPIO index in <port>
+ * @return true:input is zero, false:otherwise
+ */
+int keyboard_raw_is_input_low(int port, int id);
+
 static inline int keyboard_raw_get_cols(void) {
 	return keyboard_cols;
 }