Merge pull request #807 from FrameworkComputer/lotus-uefi-app-mode

Lotus UEFI App mode and other host commands

Author: kiram9

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,64 @@ 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;
+
+/*****************************************************************************/
+/*
+ * Check state of the Expansion Bay
+ */
+#define EC_CMD_EXPANSION_BAY_STATUS	0x3E1B
+
+enum ec_expansion_bay_states {
+	/* Valid module present and switch closed */
+	MODULE_ENABLED	= BIT(0),
+	/* Board ID invalid */
+	MODULE_FAULT	= BIT(1),
+	/* Hatch switch open/closed status */
+	HATCH_SWITCH_CLOSED	= BIT(2),
+};
+
+struct ec_response_expansion_bay_status {
+	/* Check ec_expansion_bay_states */
+	uint8_t state;
+	uint8_t board_id_0;
+	uint8_t board_id_1;
+} __ec_align1;
+
+/*****************************************************************************/
+/*
+ * Get hardware diagnostics
+ */
+#define EC_CMD_GET_HW_DIAG 0x3E1C
+
+/* See enum diagnostics_device_idx */
+struct ec_response_get_hw_diag {
+	uint32_t hw_diagnostics;
+	uint8_t bios_complete;
+} __ec_align1;
 
 #endif /* __BOARD_HOST_COMMAND_H */

zephyr/program/lotus/include/diagnostics.h

@@ -48,6 +48,9 @@ enum diagnostics_device_idx {
  */
 void set_diagnostic(enum diagnostics_device_idx idx, bool error);
 
+uint32_t get_hw_diagnostic(void);
+uint8_t is_bios_complete(void);
+
 void set_bios_diagnostic(uint8_t code);
 
 void reset_diagnostics(void);

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/lotus/src/gpu.c

@@ -15,6 +15,7 @@
 #include "gpu.h"
 #include "board_adc.h"
 #include "board_function.h"
+#include "board_host_command.h"
 #include "console.h"
 #include "driver/temp_sensor/f75303.h"
 #include "extpower.h"
@@ -39,6 +40,9 @@ LOG_MODULE_REGISTER(gpu, LOG_LEVEL_DBG);
 
 static int module_present;
 static int module_fault;
+static int gpu_id_0;
+static int gpu_id_1;
+static int switch_status;
 
 bool gpu_present(void)
 {
@@ -84,9 +88,9 @@ DECLARE_HOOK(HOOK_INIT, update_thermal_configuration, HOOK_PRIO_DEFAULT + 2);
 
 void check_gpu_module(void)
 {
-	int gpu_id_0 = get_hardware_id(ADC_GPU_BOARD_ID_0);
-	int gpu_id_1 = get_hardware_id(ADC_GPU_BOARD_ID_1);
-	int switch_status = 0;
+	gpu_id_0 = get_hardware_id(ADC_GPU_BOARD_ID_0);
+	gpu_id_1 = get_hardware_id(ADC_GPU_BOARD_ID_1);
+	switch_status = 0;
 
 	if (board_get_version() >= BOARD_VERSION_7) {
 		gpio_enable_dt_interrupt(GPIO_INT_FROM_NODELABEL(int_beam_open));
@@ -100,15 +104,18 @@ void check_gpu_module(void)
 	case VALID_BOARDID(BOARD_VERSION_12, BOARD_VERSION_12):
 		LOG_DBG("Detected dual interposer device");
 		module_present = 1;
+		module_fault = 0;
 		break;
 	case VALID_BOARDID(BOARD_VERSION_11, BOARD_VERSION_15):
 	case VALID_BOARDID(BOARD_VERSION_13, BOARD_VERSION_15):
 		LOG_DBG("Detected single interposer device");
 		module_present = 1;
+		module_fault = 0;
 		break;
 	case VALID_BOARDID(BOARD_VERSION_15, BOARD_VERSION_15):
 		LOG_DBG("No gpu module detected %d %d", gpu_id_0, gpu_id_1);
 		module_present = 0;
+		module_fault = 0;
 		break;
 	default:
 		LOG_DBG("GPU module Fault");
@@ -161,24 +168,6 @@ DECLARE_DEFERRED(gpu_interposer_toggle_deferred);
 
 __override void project_chassis_function(enum gpio_signal signal)
 {
-	int open_state = gpio_pin_get_dt(GPIO_DT_FROM_NODELABEL(gpio_chassis_open_l));
-
-	/* The dGPU SW is SW3 at DVT phase */
-	if (board_get_version() >= BOARD_VERSION_7)
-		return;
-
-	if (!open_state) {
-		/* Make sure the module is off as fast as possible! */
-		LOG_DBG("Powering off GPU");
-		gpio_pin_set_dt(GPIO_DT_FROM_NODELABEL(gpio_gpu_b_gpio02_ec), 0);
-		gpio_pin_set_dt(GPIO_DT_FROM_NODELABEL(gpio_gpu_vsys_en), 0);
-		gpio_pin_set_dt(GPIO_DT_FROM_NODELABEL(gpio_gpu_3v_5v_en), 0);
-		gpio_pin_set_dt(GPIO_DT_FROM_NODELABEL(gpio_edp_mux_pwm_sw), 0);
-		module_present = 0;
-		update_thermal_configuration();
-	} else {
-		hook_call_deferred(&check_gpu_module_data, 50*MSEC);
-	}
 }
 
 void beam_open_interrupt(enum gpio_signal signal)
@@ -211,6 +200,7 @@ void beam_open_interrupt(enum gpio_signal signal)
 			}
 		} else
 			gpu_interposer_toggle_count = 0;
+			switch_status = 0;
 	} else {
 		hook_call_deferred(&check_gpu_module_data, 50*MSEC);
 	}
@@ -322,3 +312,27 @@ void gpu_power_enable_handler(void)
 		hook_call_deferred(&gpu_board_f75303_initial_data, 500 * MSEC);
 
 }
+
+static enum ec_status host_command_expansion_bay_status(struct host_cmd_handler_args *args)
+{
+	struct ec_response_expansion_bay_status *r = args->response;
+
+	r->state = 0;
+	if (module_present) {
+		r->state |= MODULE_ENABLED;
+	}
+	if (module_fault) {
+		r->state |= MODULE_FAULT;
+	}
+	if (switch_status) {
+		r->state |= HATCH_SWITCH_CLOSED;
+	}
+	r->board_id_0 = gpu_id_0;
+	r->board_id_1 = gpu_id_1;
+
+	args->response_size = sizeof(*r);
+
+	return EC_RES_SUCCESS;
+}
+DECLARE_HOST_COMMAND(EC_CMD_EXPANSION_BAY_STATUS, host_command_expansion_bay_status,
+		EC_VER_MASK(0));

zephyr/program/lotus/lotus/src/project_diagnostics.c

@@ -43,6 +43,8 @@ void check_device_deferred(void)
 	if (!(fan_get_rpm_actual(1) > 100) && !get_standalone_mode())
 		set_diagnostic(DIAGNOSTICS_NO_LEFT_FAN, true);
 
+	/* TODO: Add something to know whether check has run or not */
+
 	/* Exit the duty mode and let thermal to control the fan */
 	dptf_set_fan_duty_target(-1);
 

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"
 
@@ -227,6 +228,20 @@ static enum ec_status cmd_diagnosis(struct host_cmd_handler_args *args)
 DECLARE_HOST_COMMAND(EC_CMD_DIAGNOSIS, cmd_diagnosis,
 			EC_VER_MASK(0));
 
+static enum ec_status cmd_get_hw_diag(struct host_cmd_handler_args *args)
+{
+	struct ec_response_get_hw_diag *r = args->response;
+
+	r->hw_diagnostics = get_hw_diagnostic();
+	r->bios_complete = is_bios_complete();
+
+	args->response_size = sizeof(*r);
+
+	return EC_RES_SUCCESS;
+}
+DECLARE_HOST_COMMAND(EC_CMD_GET_HW_DIAG, cmd_get_hw_diag,
+			EC_VER_MASK(0));
+
 #ifdef CONFIG_BOARD_AZALEA
 static enum ec_status update_keyboard_matrix(struct host_cmd_handler_args *args)
 {
@@ -376,6 +391,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/diagnostics.c

@@ -35,7 +35,7 @@ uint32_t diagnostics_ctr;
 uint32_t bios_code;
 
 uint8_t bios_complete;
-uint8_t fan_seen;
+uint8_t fan_seen; /* TODO: Unused so far */
 uint8_t run_diagnostics;
 
 int standalone_mode;
@@ -157,3 +157,13 @@ static void diagnostics_check(void)
 
 }
 DECLARE_HOOK(HOOK_CHIPSET_RESUME, diagnostics_check, HOOK_PRIO_DEFAULT);
+
+uint32_t get_hw_diagnostic(void)
+{
+	return hw_diagnostics;
+}
+
+uint8_t is_bios_complete(void)
+{
+	return bios_complete;
+}

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;
+}