Merge pull request #1013 from FrameworkComputer/marigold.rw_support

Marigold: add system ro/rw support

Author: JohnAZoidberg

common/system.c

@@ -1043,9 +1043,21 @@ static int handle_pending_reboot(struct ec_params_reboot_ec *p)
 		return system_run_image_copy_with_flags(
 			EC_IMAGE_RO, EC_RESET_FLAG_STAY_IN_RO);
 	case EC_REBOOT_JUMP_RW:
+#if defined(CONFIG_CUSTOMIZED_DESIGN) && defined(CONFIG_PLATFORM_EC_SYSTEM_JUMP_RW_SUPPORT)
+		system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_FLAG, 1);
+		system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS, 0);
+#endif
 		return system_run_image_copy(system_get_active_copy());
 	case EC_REBOOT_COLD:
 	case EC_REBOOT_COLD_AP_OFF:
+#if defined(CONFIG_CUSTOMIZED_DESIGN) && defined(CONFIG_PLATFORM_EC_SYSTEM_JUMP_RW_SUPPORT)
+		/*
+		 * Flash RW image doesn't work if you're already in RW. Need to reboot to RO
+		 * and then jump again, so clear the flag here.
+		 */
+		system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_FLAG, 0);
+		system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS, 0);
+#endif
 		/*
 		 * Reboot the PD chip(s) as well, but first suspend the ports
 		 * if this board has PD tasks running so they don't query the

include/system.h

@@ -516,6 +516,8 @@ enum system_bbram_idx {
 	SYSTEM_BBRAM_IDX_CHASSIS_TOTAL,
 	SYSTEM_BBRAM_IDX_CHASSIS_VTR_OPEN,
 	SYSTEM_BBRAM_IDX_VPRO_STATUS,
+	SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_FLAG,
+	SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS,
 #endif
 };
 

zephyr/Kconfig.system

@@ -122,4 +122,12 @@ config PLATFORM_EC_HOST_COMMAND_MEMORY_DUMP
 	  debugging panics. May not dump all memory, e.g. sensitive memory will
 	  not be dumped.
 
+config PLATFORM_EC_SYSTEM_JUMP_RW_SUPPORT
+	bool "Enable system jump to rw support"
+	default n
+	help
+	  Enable system boot to rw support, system will check bbram flag (SYSTEM_
+	  BBRAM_IDX_SYSTEM_JUMP_RW_FLAG and SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS)
+	  to determine whether to jump to rw on boot. Default will boot from ro.
+
 endif # PLATFORM_EC

zephyr/app/ec/ec_app_main.c

@@ -29,6 +29,18 @@ static void boot_allow_sleep(struct k_timer *timer)
 	pm_policy_state_lock_put(PM_STATE_SUSPEND_TO_IDLE, PM_ALL_SUBSTATES);
 }
 
+#if defined(CONFIG_CUSTOMIZED_DESIGN) && defined(CONFIG_PLATFORM_EC_SYSTEM_JUMP_RW_SUPPORT)
+void check_rw_boot(void)
+{
+	if (system_get_image_copy() == EC_IMAGE_RW)
+		system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS, 1);
+	else
+		system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS, 0);
+
+}
+DECLARE_DEFERRED(check_rw_boot);
+#endif
+
 /* For testing purposes this is not named main. See main_shim.c for the real
  * main() function.
  */
@@ -80,6 +92,22 @@ void ec_app_main(void)
 		button_init();
 	}
 
+#if defined(CONFIG_CUSTOMIZED_DESIGN) && defined(CONFIG_PLATFORM_EC_SYSTEM_JUMP_RW_SUPPORT)
+		uint8_t rw_flag, rw_success;
+
+		system_get_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_FLAG, &rw_flag);
+		system_get_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS, &rw_success);
+		ccprints("Get boot rw_flag:%d, rw_success:%d", rw_flag, rw_success);
+
+		if (rw_flag && rw_success) {
+			/*Clear flag and boot to RW*/
+			system_set_bbram(SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS, 0);
+			system_run_image_copy(system_get_active_copy());
+		}
+
+		hook_call_deferred(&check_rw_boot_data, 5 * SECOND);
+#endif
+
 	if (IS_ENABLED(CONFIG_PLATFORM_EC_VBOOT_EFS2)) {
 		/*
 		 * For RO, it behaves as follows:

zephyr/program/framework/marigold/overlay.dtsi

@@ -134,6 +134,14 @@
 			offset = <0x4c>;
 			size = <0x01>;
 		};
+		system_jump_rw_flag {
+			offset = <0x4d>;
+			size = <0x01>;
+		};
+		system_jump_rw_success {
+			offset = <0x4e>;
+			size = <0x01>;
+		};
 	};
 };
 

zephyr/program/framework/marigold/project.conf

@@ -49,3 +49,10 @@ CONFIG_PLATFORM_EC_8042_AUX=y
 # PD
 CONFIG_PD_COMMON_VBUS_CONTROL=n
 CONFIG_PD_USB_PID=0x001A
+
+# TP test
+CONFIG_PLATFORM_IGNORED_TOUCHPAD_ID=y
+
+
+# System
+CONFIG_PLATFORM_EC_SYSTEM_JUMP_RW_SUPPORT=y

zephyr/program/framework/src/board_host_command.c

@@ -384,7 +384,12 @@ static enum ec_status  host_command_get_simple_version(struct host_cmd_handler_a
 	char temp_version[32] = {0};
 	int idx;
 	int shift = CONFIG_PLATFORM_SIMPLE_VERSION_SHIFT_IDX;
-	enum ec_image active_slot = system_get_active_copy();
+	enum ec_image active_slot;
+
+	if (system_get_image_copy() == EC_IMAGE_RO)
+		active_slot = EC_IMAGE_RO;
+	else
+		active_slot = system_get_active_copy();
 
 	strzcpy(temp_version, system_get_version(active_slot),
 		sizeof(temp_version));

zephyr/shim/src/system.c

@@ -131,6 +131,18 @@ static int bbram_lookup(enum system_bbram_idx idx, int *offset_out,
 		break;
 
 #endif
+#if BBRAM_HAS_REGION(system_jump_rw_flag)
+	case SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_FLAG:
+		*offset_out = BBRAM_REGION_OFFSET(system_jump_rw_flag);
+		*size_out = BBRAM_REGION_SIZE(system_jump_rw_flag);
+		break;
+#endif
+#if BBRAM_HAS_REGION(system_jump_rw_success)
+	case SYSTEM_BBRAM_IDX_SYSTEM_JUMP_RW_SUCCESS:
+		*offset_out = BBRAM_REGION_OFFSET(system_jump_rw_success);
+		*size_out = BBRAM_REGION_SIZE(system_jump_rw_success);
+		break;
+#endif
 #endif /* CONFIG_PLATFORM_EC_CUSTOMIZED_DESIGN */
 	default:
 		return EC_ERROR_INVAL;