[coreboot-gerrit] Change in coreboot[master]: soc/amd/common: Refactor S3 helpers

[Kyösti Mälkki (Code Review)]

Kyösti Mälkki has submitted this change and it was merged. ( https://review.coreboot.org/c/coreboot/+/31490 )

Change subject: soc/amd/common: Refactor S3 helpers
......................................................................

soc/amd/common: Refactor S3 helpers

Make the prototypes match what drivers/amd/agesa would
rather see, in preparation to use the same code with
open-source AGESA.

Change-Id: I1506ee2f7ecf3cb6ec4cce37a030c05f78ec6d59
Signed-off-by: Kyösti Mälkki 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/31490
Tested-by: build bot (Jenkins) 
Reviewed-by: Martin Roth 
---
M src/soc/amd/common/block/include/amdblocks/s3_resume.h
M src/soc/amd/common/block/pi/agesawrapper.c
M src/soc/amd/common/block/s3/s3_resume.c
3 files changed, 54 insertions(+), 43 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Martin Roth: Looks good to me, approved

diff --git a/src/soc/amd/common/block/include/amdblocks/s3_resume.h b/src/soc/amd/common/block/include/amdblocks/s3_resume.h
index 13f8010..9323baf 100644
--- a/src/soc/amd/common/block/include/amdblocks/s3_resume.h
+++ b/src/soc/amd/common/block/include/amdblocks/s3_resume.h
@@ -17,10 +17,10 @@
 #define __AMD_S3_RESUME_H__

#include <stdint.h>
+#include <agesa_headers.h>

-int save_s3_info(void *nv_base, size_t nv_size,
-			void *vol_base, size_t vol_size);
-void get_s3nv_info(void **base, size_t *size);
-void get_s3vol_info(void **base, size_t *size);
+AGESA_STATUS OemInitResume(S3_DATA_BLOCK *dataBlock);
+AGESA_STATUS OemS3LateRestore(S3_DATA_BLOCK *dataBlock);
+AGESA_STATUS OemS3Save(S3_DATA_BLOCK *dataBlock);

#endif /* __AMD_S3_RESUME_H__ */
diff --git a/src/soc/amd/common/block/pi/agesawrapper.c b/src/soc/amd/common/block/pi/agesawrapper.c
index a39e29f..c5464df 100644
--- a/src/soc/amd/common/block/pi/agesawrapper.c
+++ b/src/soc/amd/common/block/pi/agesawrapper.c
@@ -312,10 +312,10 @@
    Status = amd_dispatch(RtbParams);
    timestamp_add_now(TS_AGESA_INIT_RTB_DONE);

-	if (save_s3_info(RtbParams->S3DataBlock.NvStorage,
-			 RtbParams->S3DataBlock.NvStorageSize,
-			 RtbParams->S3DataBlock.VolatileStorage,
-			 RtbParams->S3DataBlock.VolatileStorageSize))
+	if (Status != AGESA_SUCCESS)
+		return Status;
+
+	if (OemS3Save(&RtbParams->S3DataBlock) != AGESA_SUCCESS)
    	printk(BIOS_ERR, "S3 data not saved, resuming impossible\n");

return Status;
@@ -324,10 +324,8 @@
 static AGESA_STATUS amd_init_resume(AMD_RESUME_PARAMS *InitResumeParams)
 {
    AGESA_STATUS status;
-	size_t nv_size;

-	get_s3nv_info(&InitResumeParams->S3DataBlock.NvStorage, &nv_size);
-	InitResumeParams->S3DataBlock.NvStorageSize = nv_size;
+	OemInitResume(&InitResumeParams->S3DataBlock);

timestamp_add_now(TS_AGESA_INIT_RESUME_START);
    status = amd_dispatch(InitResumeParams);
@@ -339,12 +337,10 @@
 static AGESA_STATUS amd_s3late_restore(AMD_S3LATE_PARAMS *S3LateParams)
 {
    AGESA_STATUS Status;
-	size_t vol_size;

amd_initcpuio();

-	get_s3vol_info(&S3LateParams->S3DataBlock.VolatileStorage, &vol_size);
-	S3LateParams->S3DataBlock.VolatileStorageSize = vol_size;
+	OemS3LateRestore(&S3LateParams->S3DataBlock);

timestamp_add_now(TS_AGESA_S3_LATE_START);
    Status = amd_dispatch(S3LateParams);
@@ -356,10 +352,8 @@
 static AGESA_STATUS amd_s3final_restore(AMD_S3FINAL_PARAMS *S3FinalParams)
 {
    AGESA_STATUS Status;
-	size_t vol_size;

-	get_s3vol_info(&S3FinalParams->S3DataBlock.VolatileStorage, &vol_size);
-	S3FinalParams->S3DataBlock.VolatileStorageSize = vol_size;
+	OemS3LateRestore(&S3FinalParams->S3DataBlock);

timestamp_add_now(TS_AGESA_S3_FINAL_START);
    Status = amd_dispatch(S3FinalParams);
diff --git a/src/soc/amd/common/block/s3/s3_resume.c b/src/soc/amd/common/block/s3/s3_resume.c
index 74aa79c..598036a 100644
--- a/src/soc/amd/common/block/s3/s3_resume.c
+++ b/src/soc/amd/common/block/s3/s3_resume.c
@@ -26,56 +26,73 @@
 /* Training data versioning is not supported or tracked. */
 #define DEFAULT_MRC_VERSION 0

-static void reboot_from_resume(const char *message) /* Does not return */
+static void __noreturn reboot_from_resume(const char *message)
 {
    printk(BIOS_ERR, "%s", message);
    set_pm1cnt_s5();
    board_reset();
 }

-void get_s3nv_info(void **base, size_t *size)
+AGESA_STATUS OemInitResume(S3_DATA_BLOCK *dataBlock)
 {
+	void *base;
+	size_t size;
+	int i;
+	uint32_t erased = 0xffffffff;
    struct region_device rdev;

if (mrc_cache_get_current(MRC_TRAINING_DATA, DEFAULT_MRC_VERSION,
    				&rdev))
    	reboot_from_resume("mrc_cache_get_current error, rebooting.\n");

-	*base = rdev_mmap_full(&rdev);
-	*size = region_device_sz(&rdev);
-	if (!*base || !*size)
+	base = rdev_mmap_full(&rdev);
+	size = region_device_sz(&rdev);
+	if (!base || !size)
    	reboot_from_resume("Error: S3 NV data not found, rebooting.\n");

/* Read 16 bytes to infer if the NV has been erased from flash. */
-	int i;
-	uint32_t erased = 0xffffffff;
    for (i = 0; i < 4; i++)
-		erased &= read32((uint32_t *)*base + i);
-
+		erased &= read32((uint32_t *)base + i);
    if (erased == 0xffffffff)
    	reboot_from_resume("Error: S3 NV data invalid, rebooting.\n");

-	printk(BIOS_SPEW, "S3 NV data @0x%p, 0x%0zx bytes\n", *base, *size);
+	dataBlock->NvStorage = base;
+	dataBlock->NvStorageSize = size;
+	printk(BIOS_SPEW, "S3 NV data @0x%p, 0x%0zx bytes\n",
+		dataBlock->NvStorage, (size_t)dataBlock->NvStorageSize);
+
+	return AGESA_SUCCESS;
 }

-void get_s3vol_info(void **base, size_t *size)
+AGESA_STATUS OemS3LateRestore(S3_DATA_BLOCK *dataBlock)
 {
-	stage_cache_get_raw(STAGE_S3_DATA, base, size);
-	if (!*base || !*size)
+	void *base = NULL;
+	size_t size = 0;
+
+	stage_cache_get_raw(STAGE_S3_DATA, &base, &size);
+	if (!base || !size) {
    	printk(BIOS_ERR, "Error: S3 volatile data not found\n");
-	else
-		printk(BIOS_SPEW, "S3 volatile data @0x%p 0x%0zx total bytes\n",
-							*base, *size);
-}
-
-int save_s3_info(void *nv_base, size_t nv_size, void *vol_base, size_t vol_size)
-{
-	if (mrc_cache_stash_data(MRC_TRAINING_DATA, DEFAULT_MRC_VERSION,
-				nv_base, nv_size) < 0) {
-		printk(BIOS_ERR, "Failed to stash MRC data\n");
-		return -1;
+		return AGESA_FATAL;
    }

-	stage_cache_add_raw(STAGE_S3_DATA, vol_base, vol_size);
-	return 0;
+	dataBlock->VolatileStorage = base;
+	dataBlock->VolatileStorageSize = size;
+	printk(BIOS_SPEW, "S3 volatile data @0x%p, 0x%0zx bytes\n",
+		dataBlock->VolatileStorage, (size_t)dataBlock->VolatileStorageSize);
+
+	return AGESA_SUCCESS;
+}
+
+AGESA_STATUS OemS3Save(S3_DATA_BLOCK *dataBlock)
+{
+	if (mrc_cache_stash_data(MRC_TRAINING_DATA, DEFAULT_MRC_VERSION,
+			dataBlock->NvStorage, dataBlock->NvStorageSize) < 0) {
+		printk(BIOS_ERR, "Failed to stash MRC data\n");
+		return AGESA_CRITICAL;
+	}
+
+	stage_cache_add_raw(STAGE_S3_DATA, dataBlock->VolatileStorage,
+		dataBlock->VolatileStorageSize);
+
+	return AGESA_SUCCESS;
 }