Merge pull request #706 from FrameworkComputer/azalea.keyboard_issue

azalea: modify 8042 ibf handle.

Author: kiram9

common/keyboard_8042.c

@@ -241,6 +241,13 @@ void keyboard_host_write(int data, int is_cmd)
 	task_wake(TASK_ID_KEYPROTO);
 }
 
+#ifdef CONFIG_CUSTOMIZED_DESIGN
+int keyboard_host_write_avaliable(void)
+{
+	return queue_count(&from_host);
+}
+#endif
+
 /**
  * Enable keyboard IRQ generation.
  *

include/keyboard_8042.h

@@ -28,6 +28,17 @@ void button_state_changed(enum keyboard_button_type button, int is_pressed);
  */
 void keyboard_host_write(int data, int is_cmd);
 
+#ifdef CONFIG_CUSTOMIZED_DESIGN
+/**
+ * Get the amount of free 8042 buffer slots
+ * this is used to put backpressure on the host
+ * if the keyboard task gets too slow
+ * @return bytes_avaliable
+ */
+int keyboard_host_write_avaliable(void);
+
+#endif
+
 /*
  * Board specific callback function when a key state is changed.
  *

zephyr/program/lotus/azalea/project.conf

@@ -24,3 +24,6 @@ CONFIG_PLATFORM_EC_PWM_KBLIGHT=y
 CONFIG_PLATFORM_EC_KEYBOARD_VIVALDI=n
 CONFIG_PLATFORM_EC_KEYBOARD_CUSTOMIZATION=y
 CONFIG_PLATFORM_KEYBOARD_SCANCODE_CALLBACK=y
+
+# Thrid party change
+CONFIG_THIRD_PARTY_CUSTOMIZED_DESIGN=y

zephyr/program/lotus/azalea/src/keyboard_customization.c

@@ -87,14 +87,14 @@ static char keycap_label[KEYBOARD_COLS_MAX][KEYBOARD_ROWS] = {
 			KLLI_UNKNO, KLLI_UNKNO, KLLI_RIGHT, KLLI_LEFT},
 };
 
-char get_keycap_label(uint8_t row, uint8_t col)
+uint8_t get_keycap_label(uint8_t row, uint8_t col)
 {
 	if (col < KEYBOARD_COLS_MAX && row < KEYBOARD_ROWS)
 		return keycap_label[col][row];
 	return KLLI_UNKNO;
 }
 
-void set_keycap_label(uint8_t row, uint8_t col, char val)
+void set_keycap_label(uint8_t row, uint8_t col, uint8_t val)
 {
 	if (col < KEYBOARD_COLS_MAX && row < KEYBOARD_ROWS)
 		keycap_label[col][row] = val;

zephyr/shim/src/espi.c

@@ -644,6 +644,70 @@ void lpc_aux_put_char(uint8_t chr, int send_irq)
 	LOG_INF("AUX put %02x", kb_char);
 }
 
+#ifdef CONFIG_THIRD_PARTY_CUSTOMIZED_DESIGN
+
+/*
+ * this can delay EC release irq and clear IBF
+ * it will let host not send data too fast, make EC
+ * have time to process 8042 data and also not lose data
+ * after delay finish read HIKMDI clear IBF data and release 8042 irq
+ */
+static void lpc_kbc_irq_handle(void)
+{
+	int rv;
+
+	rv = espi_write_lpc_request(espi_dev, E8042_RESUME_IRQ, 0);
+	if (rv) {
+		LOG_ERR("ESPI write failed: E8042_RESUME_IRQ = %d", rv);
+	}
+}
+DECLARE_DEFERRED(lpc_kbc_irq_handle);
+
+static void kbc_ibf_obe_handler(uint32_t data)
+{
+#ifdef HAS_TASK_KEYPROTO
+	uint8_t is_ibf = is_8042_ibf(data);
+	uint32_t status = I8042_AUX_DATA;
+	uint32_t request;
+	int rv;
+
+	if (is_ibf == HOST_KBC_EVT_IBF) {
+
+		/* reserve one buffer size for 8042 data handle. */
+		if (keyboard_host_write_avaliable() <= 1) {
+			/* Pause 8042 irq let KB task process data */
+			rv = espi_write_lpc_request(espi_dev, E8042_PAUSE_IRQ, 0);
+			if (rv) {
+				LOG_ERR("ESPI write failed: E8042_PAUSE_IRQ = %d", rv);
+			}
+
+			hook_call_deferred(&lpc_kbc_irq_handle_data, MSEC);
+		} else {
+			/* put data to queue and trigger 8042 task*/
+			keyboard_host_write(get_8042_data(data), get_8042_type(data));
+
+			/* clear IBF let host send next data */
+			rv = espi_read_lpc_request(espi_dev, E8042_CLEAR_IBF, &request);
+			if (rv) {
+				LOG_ERR("ESPI read failed: E8042_CLEAR_IBF = %d", rv);
+				return;
+			}
+		}
+	} else if (IS_ENABLED(CONFIG_8042_AUX)) {
+		rv = espi_write_lpc_request(espi_dev, E8042_CLEAR_FLAG,
+					    &status);
+		if (rv) {
+			LOG_ERR("ESPI write failed: E8042_CLEAR_FLAG = %d", rv);
+		}
+	}
+
+	/* OBE data coming */
+	if (is_ibf != HOST_KBC_EVT_IBF)
+		task_wake(TASK_ID_KEYPROTO);
+
+#endif
+}
+#else
 static void kbc_ibf_obe_handler(uint32_t data)
 {
 #ifdef HAS_TASK_KEYPROTO
@@ -663,6 +727,7 @@ static void kbc_ibf_obe_handler(uint32_t data)
 	task_wake(TASK_ID_KEYPROTO);
 #endif
 }
+#endif
 
 int lpc_keyboard_input_pending(void)
 {