Merge pull request #512 from FrameworkComputer/hx20.BIOS_setup

Store the BIOS setup into SPI ROM

Author: kiram9

.github/workflows/lint.yml

@@ -21,7 +21,7 @@ jobs:
 
       - name: checkpatch
         run: |
-          git diff origin/${{ github.base_ref }} | ./checkpatch.pl --mailback --no-tree --ignore MAINTAINERS,FILE_PATH_CHANGES - > checkpatch.txt || true
+          git diff origin/${{ github.base_ref }} | ./checkpatch.pl --mailback --no-tree --ignore MAINTAINERS,FILE_PATH_CHANGES,SPDX_LICENSE_TAG - > checkpatch.txt || true
           if [ -s checkpatch.txt ]; then
             errors=$(cat checkpatch.txt)
             errors="${errors//'%'/'%25'}"

board/hx20/board.c

@@ -21,6 +21,7 @@
 #include "chipset.h"
 #include "console.h"
 #include "cypress5525.h"
+#include "diagnostics.h"
 #include "driver/als_opt3001.h"
 #include "driver/accel_kionix.h"
 #include "driver/accel_kx022.h"
@@ -53,6 +54,7 @@
 #include "pwm_chip.h"
 #include "spi.h"
 #include "spi_chip.h"
+#include "spi_flash.h"
 #include "switch.h"
 #include "system.h"
 #include "task.h"
@@ -71,6 +73,7 @@
 #include "keyboard_8042.h"
 #include "keyboard_8042_sharedlib.h"
 #include "host_command_customization.h"
+#include "flash_storage.h"
 
 /* Console output macros */
 #define CPUTS(outstr) cputs(CC_LPC, outstr)
@@ -360,6 +363,21 @@ void board_reset_pd_mcu(void)
 
 }
 
+void spi_mux_control(int enable)
+{
+	if (enable) {
+		/* Disable LED drv */
+		gpio_set_level(GPIO_TYPEC_G_DRV2_EN, 0);
+		/* Set GPIO56 as SPI for access SPI ROM */
+		gpio_set_alternate_function(1, 0x4000, 2);
+	} else {
+		/* Enable LED drv */
+		gpio_set_level(GPIO_TYPEC_G_DRV2_EN, 1);
+		/* Set GPIO56 as SPI for access SPI ROM */
+		gpio_set_alternate_function(1, 0x4000, 1);
+	}
+}
+
 static int power_button_pressed_on_boot;
 int poweron_reason_powerbtn(void)
 {
@@ -583,15 +601,15 @@ void charger_psys_enable(uint8_t enable)
 static void board_init(void)
 {
 	int version = board_get_version();
-	uint8_t memcap;
 
 	if (version > 6)
 		gpio_set_flags(GPIO_EN_INVPWR, GPIO_OUT_LOW);
 
-	system_get_bbram(SYSTEM_BBRAM_IDX_AC_BOOT, &memcap);
+	if (flash_storage_get(FLASH_FLAGS_ACPOWERON) && !ac_boot_status())
+		*host_get_customer_memmap(0x48) = flash_storage_get(FLASH_FLAGS_ACPOWERON);
 
-	if (memcap && !ac_boot_status())
-		*host_get_customer_memmap(0x48) = (memcap & BIT(0));
+	if (flash_storage_get(FLASH_FLAGS_STANDALONE))
+		set_standalone_mode(1);
 
 	check_chassis_open(1);
 
@@ -1135,17 +1153,7 @@ static int cmd_spimux(int argc, char **argv)
 		if (!parse_bool(argv[1], &enable))
 			return EC_ERROR_PARAM1;
 
-		if (enable){
-			/* Disable LED drv */
-			gpio_set_level(GPIO_TYPEC_G_DRV2_EN, 0);
-			/* Set GPIO56 as SPI for access SPI ROM */
-			gpio_set_alternate_function(1, 0x4000, 2);
-		} else {
-			/* Enable LED drv */
-			gpio_set_level(GPIO_TYPEC_G_DRV2_EN, 1);
-			/* Set GPIO56 as SPI for access SPI ROM */
-			gpio_set_alternate_function(1, 0x4000, 1);
-		}
+		spi_mux_control(enable);
 	}
 	return EC_SUCCESS;
 }

board/hx20/board.h

@@ -728,7 +728,6 @@ void board_reset_pd_mcu(void);
 /* P sensor */
 void psensor_interrupt(enum gpio_signal signal);
 
-
 /* SOC */
 void soc_signal_interrupt(enum gpio_signal signal);
 
@@ -770,6 +769,8 @@ void update_me_change(int change);
 
 int poweron_reason_powerbtn(void);
 
+void spi_mux_control(int enable);
+
 #ifdef CONFIG_LOW_POWER_IDLE
 void board_prepare_for_deep_sleep(void);
 void board_resume_from_deep_sleep(void);

board/hx20/build.mk

@@ -17,7 +17,7 @@ CHIP_VARIANT:=mec152x_3400
 
 CHIP_SPI_SIZE_KB:=512
 
-board-y=board.o led.o power_sequence.o cypress5525.o ucsi.o diagnostics.o cpu_power.o
+board-y=board.o led.o power_sequence.o cypress5525.o ucsi.o diagnostics.o cpu_power.o flash_storage.o
 board-$(CONFIG_BATTERY_SMART)+=battery.o
 board-$(CONFIG_FANS)+=fan.o
 board-$(CONFIG_KEYBOARD_CUSTOMIZATION)+=keyboard_customization.o

board/hx20/diagnostics.c

@@ -32,6 +32,20 @@ uint8_t bios_complete;
 uint8_t fan_seen;
 uint8_t s0_seen;
 uint8_t run_diagnostics;
+
+int standalone_mode;
+
+void set_standalone_mode(int enable)
+{
+	CPRINTS("set standalone = %d", enable);
+	standalone_mode = enable;
+}
+
+int get_standalone_mode(void)
+{
+	return standalone_mode;
+}
+
 void reset_diagnostics(void)
 {
 	hw_diagnostics =0;
@@ -100,9 +114,9 @@ bool diagnostics_tick(void)
 		set_hw_diagnostic(DIAGNOSTICS_NO_S0, true);
 	}
 
-    if (charge_get_state() == PWR_STATE_ERROR){
-        set_hw_diagnostic(DIAGNOSTICS_HW_NO_BATTERY, true);
-    }
+	if ((charge_get_state() == PWR_STATE_ERROR) && !standalone_mode) {
+		set_hw_diagnostic(DIAGNOSTICS_HW_NO_BATTERY, true);
+	}
 
 	if (hw_diagnostic_tick & 0x01) {
 		/*off*/
@@ -163,13 +177,13 @@ static void diagnostic_check_tempsensor_deferred(void)
 	device_id[0] = get_hardware_id(ADC_TP_BOARD_ID);
 	device_id[1] = get_hardware_id(ADC_AUDIO_BOARD_ID);
 
-	if (device_id[0] <= BOARD_VERSION_1 ||  device_id[0] >= BOARD_VERSION_14 ||
-		(high_adc[0] - low_adc[0]) > ADC_NC_DELTA) {
+	if ((device_id[0] <= BOARD_VERSION_1 ||  device_id[0] >= BOARD_VERSION_14 ||
+		(high_adc[0] - low_adc[0]) > ADC_NC_DELTA) && !standalone_mode) {
 		set_hw_diagnostic(DIAGNOSTICS_TOUCHPAD, true);
 	}
 
-	if (device_id[1] <= BOARD_VERSION_1 ||  device_id[1] >= BOARD_VERSION_14 ||
-		(high_adc[1] - low_adc[1]) > ADC_NC_DELTA) {
+	if ((device_id[1] <= BOARD_VERSION_1 ||  device_id[1] >= BOARD_VERSION_14 ||
+		(high_adc[1] - low_adc[1]) > ADC_NC_DELTA) && !standalone_mode) {
 		set_hw_diagnostic(DIAGNOSTICS_AUDIO_DAUGHTERBOARD, true);
 	}
     CPRINTS("TP  Ver %d, delta %d", device_id[0], high_adc[0] - low_adc[0]);
@@ -204,6 +218,6 @@ void set_bios_diagnostic(uint8_t code)
 
 	if (code == CODE_DDR_FAIL)
 		set_hw_diagnostic(DIAGNOSTICS_NO_DDR, true);
-	if (code == CODE_NO_EDP)
+	if (code == CODE_NO_EDP && !standalone_mode)
 		set_hw_diagnostic(DIAGNOSTICS_NO_EDP, true);
 }

board/hx20/diagnostics.h

@@ -43,6 +43,9 @@ enum diagnostics_device_idx {
 void set_hw_diagnostic(enum diagnostics_device_idx idx, bool error);
 void set_bios_diagnostic(uint8_t code);
 
+void set_standalone_mode(int enable);
+int get_standalone_mode(void);
+
 void reset_diagnostics(void);
 
 void cancel_diagnostics(void);

board/hx20/flash_storage.c

@@ -0,0 +1,174 @@
+/* Copyright 2022 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 "util.h"
+#include "hooks.h"
+
+#include "board.h"
+#include "gpio.h"
+
+#include "spi.h"
+#include "spi_chip.h"
+#include "spi_flash.h"
+
+#include "flash_storage.h"
+
+
+
+
+
+
+#define CPRINTS(format, args...) cprints(CC_SYSTEM, format, ## args)
+#define CPRINTF(format, args...) cprintf(CC_SYSTEM, format, ## args)
+
+static struct ec_flash_flags_info current_flags;
+bool flash_storage_dirty;
+
+bool check_flags_valid_header(void)
+{
+	if (current_flags.magic != FLASH_FLAGS_MAGIC ||
+		current_flags.length != (sizeof(current_flags) - 8) ||
+		current_flags.version != FLASH_FLAGS_VERSION) {
+		return false;
+	} else {
+		return true;
+	}
+}
+
+void flash_storage_load_defaults(void)
+{
+		CPRINTS("Init flash storage to defaults");
+		memset(&current_flags, 0x00, sizeof(current_flags));
+		current_flags.magic = FLASH_FLAGS_MAGIC;
+		current_flags.length = (sizeof(current_flags) - 8);
+		current_flags.version = FLASH_FLAGS_VERSION;
+		flash_storage_dirty = true;
+}
+
+int flash_storage_initialize(void)
+{
+
+	int rv;
+
+	spi_mux_control(1);
+
+	rv = spi_flash_read((void *)&current_flags, SPI_FLAGS_REGION, sizeof(current_flags));
+	if (rv != EC_SUCCESS)
+		CPRINTS("Could not load flash storage");
+
+	spi_mux_control(0);
+
+	/*Check structure is valid*/
+	if (check_flags_valid_header() == false) {
+		CPRINTS("loading flash default flags");
+		flash_storage_load_defaults();
+	}
+
+	return rv;
+}
+
+int flash_storage_update(enum ec_flash_flags_idx idx, uint8_t v)
+{
+	if (idx >= FLASH_FLAGS_MAX)
+		return EC_ERROR_PARAM1;
+
+	if (check_flags_valid_header() == false)
+		flash_storage_initialize();
+
+	if (current_flags.flags[idx] != v) {
+		current_flags.flags[idx] = v;
+		flash_storage_dirty = true;
+	}
+	return EC_SUCCESS;
+}
+
+int flash_storage_commit(void)
+{
+	int rv = EC_SUCCESS;
+
+	if (check_flags_valid_header() == false)
+		flash_storage_initialize();
+
+	if (flash_storage_dirty) {
+
+		spi_mux_control(1);
+
+		rv = spi_flash_erase(SPI_FLAGS_REGION, 0x1000);
+
+		if (rv != EC_SUCCESS) {
+			CPRINTS("SPI fail to erase");
+			goto fail;
+		}
+
+		current_flags.update_number += 1;
+
+		rv = spi_flash_write(SPI_FLAGS_REGION,
+								sizeof(current_flags),
+								(void *)&current_flags);
+
+		if (rv != EC_SUCCESS) {
+			CPRINTS("SPI fail to write");
+			goto fail;
+		}
+
+		CPRINTS("%s, update:%d", __func__, current_flags.update_number);
+
+		spi_mux_control(0);
+		flash_storage_dirty = false;
+	}
+
+	return rv;
+
+fail:
+	spi_mux_control(0);
+	return rv;
+}
+
+int flash_storage_get(enum ec_flash_flags_idx idx)
+{
+	if (idx >= FLASH_FLAGS_MAX)
+		return -1;
+
+	if (check_flags_valid_header() == false)
+		flash_storage_initialize();
+
+	return current_flags.flags[idx];
+}
+
+static int cmd_flash_flags(int argc, char **argv)
+{
+	int data;
+	int i, d;
+	char *e;
+
+
+	if (argc >= 3) {
+
+		i = strtoi(argv[2], &e, 0);
+
+		if (*e)
+			return EC_ERROR_PARAM2;
+
+		if (!strcasecmp(argv[1], "read")) {
+			data = flash_storage_get(i);
+			CPRINTS("Flash data:%d", data);
+		} else if (argc >= 4 && !strcasecmp(argv[1], "write")) {
+
+			d = strtoi(argv[3], &e, 0);
+			if (*e)
+				return EC_ERROR_PARAM3;
+			flash_storage_update(i, d);
+			flash_storage_commit();
+		} else {
+			return EC_ERROR_PARAM3;
+		}
+		return EC_SUCCESS;
+	}
+
+	return EC_ERROR_PARAM2;
+}
+DECLARE_CONSOLE_COMMAND(flashflag, cmd_flash_flags,
+			"[read/write] i [d]",
+			"read or write bytes from flags structure");