lotus: Add UEFI App Mode

TODO:

- [x] Add some comments to explain
- [x] Test
- [ ] Maybe add a hook when OS boots to enable the interrupt again, if the app forgets to do it.
- [ ] Check formatting

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

zephyr/program/lotus/CMakeLists.txt

@@ -11,6 +11,7 @@ zephyr_library_sources("src/board_host_command.c")
 zephyr_library_sources("src/cypress_pd_common.c")
 zephyr_library_sources("src/flash_storage.c")
 zephyr_library_sources("src/factory.c")
+zephyr_library_sources("src/uefi_app_mode.c")
 zephyr_library_sources("src/diagnostics.c")
 zephyr_library_sources("src/ucsi.c")
 zephyr_library_sources("src/als.c")

zephyr/program/lotus/include/board_host_command.h

@@ -286,5 +286,30 @@ struct ec_response_get_active_charge_pd_chip {
 	uint8_t pd_chip;
 } __ec_align1;
 
+/*****************************************************************************/
+/*
+ * Enable/disable UEFI App mode
+ *
+ * Enable disables the power button functionality and allows to read it via
+ * EC_CMD_UEFI_APP_BTN_STATUS host command instead.
+ * This makes it possible to use it as a software button in a UEFI app.
+ */
+#define EC_CMD_UEFI_APP_MODE	0x3E19
+
+struct ec_params_uefi_app_mode {
+	/* 0x01 to enable, 0x00 to disable UEFI App mode */
+	uint8_t flags;
+} __ec_align1;
+
+/*****************************************************************************/
+/*
+ * Read power button status
+ */
+#define EC_CMD_UEFI_APP_BTN_STATUS	0x3E1A
+
+struct ec_response_uefi_app_btn_status {
+	/* 0x00 if not pressed, 0x01 if pressed */
+	uint8_t status;
+} __ec_align1;
 
 #endif /* __BOARD_HOST_COMMAND_H */

zephyr/program/lotus/include/uefi_app_mode.h

@@ -0,0 +1,13 @@
+/* Copyright 202 The ChromiumOS Authors
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef __CROS_EC_UEFI_APP_MODE_H
+#define __CROS_EC_UEFI_APP_MODE_H
+
+void uefi_app_mode_setting(uint8_t enable);
+
+uint8_t uefi_app_btn_status(void);
+
+#endif	/* __CROS_EC_UEFI_APP_MODE_H */

zephyr/program/lotus/src/board_host_command.c

@@ -27,6 +27,7 @@
 #include "lpc.h"
 #include "power_sequence.h"
 #include "system.h"
+#include "uefi_app_mode.h"
 #include "util.h"
 #include "zephyr_console_shim.h"
 
@@ -374,6 +375,34 @@ static enum ec_status get_active_charge_pd_chip(struct host_cmd_handler_args *ar
 }
 DECLARE_HOST_COMMAND(EC_CMD_GET_ACTIVE_CHARGE_PD_CHIP, get_active_charge_pd_chip, EC_VER_MASK(0));
 
+#ifdef CONFIG_BOARD_LOTUS
+static enum ec_status host_command_uefi_app_mode(struct host_cmd_handler_args *args)
+{
+	const struct ec_params_uefi_app_mode *p = args->params;
+	int enable = 1;
+
+	if (p->flags)
+		uefi_app_mode_setting(enable);
+	else
+		uefi_app_mode_setting(!enable);
+
+	return EC_SUCCESS;
+}
+DECLARE_HOST_COMMAND(EC_CMD_UEFI_APP_MODE, host_command_uefi_app_mode, EC_VER_MASK(0));
+
+static enum ec_status host_command_uefi_app_btn_status(struct host_cmd_handler_args *args)
+{
+	struct ec_response_uefi_app_btn_status *r = args->response;
+
+	r->status = uefi_app_btn_status();
+
+	args->response_size = sizeof(*r);
+
+	return EC_RES_SUCCESS;
+}
+DECLARE_HOST_COMMAND(EC_CMD_UEFI_APP_BTN_STATUS, host_command_uefi_app_btn_status, EC_VER_MASK(0));
+#endif /* CONFIG_BOARD_LOTUS */
+
 /*******************************************************************************/
 /*                       EC console command for Project                        */
 /*******************************************************************************/

zephyr/program/lotus/src/uefi_app_mode.c

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023 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 <zephyr/drivers/gpio.h>
+
+#include "ec_commands.h"
+#include "uefi_app_mode.h"
+#include "gpio.h"
+#include "gpio/gpio_int.h"
+
+static uint8_t uefi_app_enable;
+
+void uefi_app_mode_setting(uint8_t enable)
+{
+	uefi_app_enable = enable;
+
+	/* Ignored the power button signal if we are in UEFI app mode */
+	/* TODO: Maybe add a hook when OS boots to enable the interrupt again, */
+	/* if the app forgets to do it. */
+	if (uefi_app_enable) {
+		gpio_disable_dt_interrupt(GPIO_INT_FROM_NODELABEL(int_powerbtn));
+	} else {
+		gpio_enable_dt_interrupt(GPIO_INT_FROM_NODELABEL(int_powerbtn));
+	}
+}
+
+uint8_t uefi_app_btn_status(void)
+{
+	return gpio_pin_get_dt(GPIO_DT_FROM_NODELABEL(gpio_on_off_btn_l)) == 1;
+}