soc/intel/alderlake: Move ME firmware status register structures to

pertinent header file

This patch moves ME host firmware status register structures to ME
header file. It also marks unused structure fields to reserved.

The idea here is to decouple ME specification defined structures from
the source file `.c` and keep those into header files so that in future
those spec defined header can move into common code.

The current and future SoC platform will be able to select the correct
ME spec header based on the applicable config. It might be also
beneficial if two different SoC platforms would like to use the same
ME specification and not necessarilly share the same SoC directory.

BUG=b:260309647
Test=Able to build and boot Google/brya.

Signed-off-by: Dinesh Gehlot <digehlot@google.com>
Change-Id: Ic14305b0479a8c57531d9930946eded7ac518b09
Reviewed-on: https://review.coreboot.org/c/coreboot/+/71625
Reviewed-by: Eric Lai <eric_lai@quanta.corp-partner.google.com>
Reviewed-by: Subrata Banik <subratabanik@google.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

2 files changed, 63 insertions, 106 deletions

diff --git a/src/soc/intel/alderlake/include/soc/me.h b/src/soc/intel/alderlake/include/soc/me.h
index e094af611dcf..f029991fc316 100644
--- a/src/soc/intel/alderlake/include/soc/me.h
+++ b/src/soc/intel/alderlake/include/soc/me.h
@@ -3,41 +3,79 @@
 #ifndef _ALDERLAKE_ME_H_
 #define _ALDERLAKE_ME_H_
 
-#include <stdint.h>
-
 /* ME Host Firmware Status register 1 */
 union me_hfsts1 {
-	u32 data;
+	uint32_t data;
+	struct {
+		uint32_t working_state		: 4;
+		uint32_t mfg_mode		: 1;
+		uint32_t fpt_bad		: 1;
+		uint32_t operation_state	: 3;
+		uint32_t fw_init_complete	: 1;
+		uint32_t ft_bup_ld_flr		: 1;
+		uint32_t update_in_progress	: 1;
+		uint32_t error_code		: 4;
+		uint32_t operation_mode		: 4;
+		uint32_t reserved_0		: 4;
+		uint32_t boot_options_present	: 1;
+		uint32_t invoke_enhance_dbg_mode: 1;
+		uint32_t reserved_1		: 5;
+		uint32_t d0i3_support_valid	: 1;
+	} __packed fields;
+};
+
+/* Host Firmware Status Register 2 */
+union me_hfsts2 {
+	uint32_t data;
 	struct {
-		u32 working_state: 4;
-		u32 mfg_mode: 1;
-		u32 fpt_bad: 1;
-		u32 operation_state: 3;
-		u32 fw_init_complete: 1;
-		u32 ft_bup_ld_flr: 1;
-		u32 update_in_progress: 1;
-		u32 error_code: 4;
-		u32 operation_mode: 4;
-		u32 reset_count: 4;
-		u32 boot_options_present: 1;
-		u32 invoke_enhance_dbg_mode: 1;
-		u32 bist_test_state: 1;
-		u32 bist_reset_request: 1;
-		u32 current_power_source: 2;
-		u32 reserved: 1;
-		u32 d0i3_support_valid: 1;
+		uint32_t reserved_0		: 4;
+		uint32_t cpu_replaced		: 1;
+		uint32_t reserved_1		: 3;
+		uint32_t cpu_replaced_valid	: 1;
+		uint32_t low_power_state	: 1;
+		uint32_t reserved_2		: 22;
 	} __packed fields;
 };
 
 /* ME Host Firmware Status Register 3 */
 union me_hfsts3 {
+	uint32_t data;
+	struct {
+		uint32_t reserved_0		: 4;
+		uint32_t fw_sku			: 3;
+		uint32_t reserved_1		: 25;
+	} __packed fields;
+};
+
+
+/* Host Firmware Status Register 4 */
+union me_hfsts4 {
+	uint32_t data;
+	struct {
+		uint32_t rsvd0;
+	} __packed fields;
+};
+
+/* Host Firmware Status Register 5 */
+union me_hfsts5 {
+	uint32_t data;
+	struct {
+		uint32_t rsvd0;
+	} __packed fields;
+};
+
+/* Host Firmware Status Register 6 */
+union me_hfsts6 {
 	u32 data;
 	struct {
-		u32 reserved_0: 4;
-		u32 fw_sku: 3;
-		u32 reserved_7_10: 4;
-		u32 rpmc_status: 3;
-		u32 resered_14_31: 18;
+		uint32_t reserved_0		: 1;
+		uint32_t cpu_debug_disable	: 1;
+		uint32_t reserved_1		: 19;
+		uint32_t manuf_lock		: 1;
+		uint32_t reserved_2		: 8;
+		uint32_t fpf_soc_lock		: 1;
+		uint32_t txt_support		: 1;
 	} __packed fields;
 };
+
 #endif /* _ALDERLAKE_ME_H_ */
diff --git a/src/soc/intel/alderlake/me.c b/src/soc/intel/alderlake/me.c
index 8b5e94f26526..6239eb24da1a 100644
--- a/src/soc/intel/alderlake/me.c
+++ b/src/soc/intel/alderlake/me.c
@@ -6,87 +6,6 @@
 #include <soc/me.h>
 #include <stdint.h>
 
-/* Host Firmware Status Register 2 */
-union me_hfsts2 {
-	uint32_t data;
-	struct {
-		uint32_t nftp_load_failure	: 1;
-		uint32_t icc_prog_status	: 2;
-		uint32_t invoke_mebx		: 1;
-		uint32_t cpu_replaced		: 1;
-		uint32_t rsvd0			: 1;
-		uint32_t mfs_failure		: 1;
-		uint32_t warm_reset_rqst	: 1;
-		uint32_t cpu_replaced_valid	: 1;
-		uint32_t low_power_state	: 1;
-		uint32_t me_power_gate		: 1;
-		uint32_t ipu_needed		: 1;
-		uint32_t forced_safe_boot	: 1;
-		uint32_t rsvd1			: 1;
-		uint32_t cse_to_be_disabled	: 1;
-		uint32_t listener_change	: 1;
-		uint32_t status_data		: 8;
-		uint32_t current_pmevent	: 4;
-		uint32_t phase			: 4;
-	} __packed fields;
-};
-
-/* Host Firmware Status Register 4 */
-union me_hfsts4 {
-	uint32_t data;
-	struct {
-		uint32_t rsvd0			: 9;
-		uint32_t enforcement_flow	: 1;
-		uint32_t sx_resume_type		: 1;
-		uint32_t rsvd1			: 1;
-		uint32_t tpms_disconnected	: 1;
-		uint32_t rvsd2			: 1;
-		uint32_t fwsts_valid		: 1;
-		uint32_t boot_guard_self_test	: 1;
-		uint32_t rsvd3			: 16;
-	} __packed fields;
-};
-
-/* Host Firmware Status Register 5 */
-union me_hfsts5 {
-	uint32_t data;
-	struct {
-		uint32_t acm_active		: 1;
-		uint32_t valid			: 1;
-		uint32_t result_code_source	: 1;
-		uint32_t error_status_code	: 5;
-		uint32_t acm_done_sts		: 1;
-		uint32_t timeout_count		: 7;
-		uint32_t scrtm_indicator	: 1;
-		uint32_t rsvd0			: 14;
-		uint32_t start_enforcement	: 1;
-	} __packed fields;
-};
-
-/* Host Firmware Status Register 6 */
-union me_hfsts6 {
-	uint32_t data;
-	struct {
-		uint32_t force_boot_guard_acm	: 1;
-		uint32_t cpu_debug_disable	: 1;
-		uint32_t bsp_init_disable	: 1;
-		uint32_t protect_bios_env	: 1;
-		uint32_t rsvd0			: 2;
-		uint32_t error_enforce_policy	: 2;
-		uint32_t measured_boot		: 1;
-		uint32_t verified_boot		: 1;
-		uint32_t rsvd1			: 11;
-		uint32_t manuf_lock		: 1;
-		uint32_t key_manifest_id	: 4;
-		uint32_t boot_policy_status	: 1;
-		uint32_t error			: 1;
-		uint32_t boot_guard_disable	: 1;
-		uint32_t fpf_disable		: 1;
-		uint32_t fpf_soc_lock		: 1;
-		uint32_t txt_support		: 1;
-	} __packed fields;
-};
-
 static bool is_manuf_mode(union me_hfsts1 hfsts1, union me_hfsts6 hfsts6)
 {
 	/*