Add Wrapper to indicate it for FspWrapper only. Merge several APIs (GetBootMode, GetNvsBuffer, GetUpdRegionSize, GetBootLoaderTolumSize, UpdateFspUpdConfigs) into one UpdateFspmUpdData, because all parameter construcion is done in UpdateFspmUpdData(). Align API name to FSP2.0 spec.
The FSP1.1 compatibility is NOT maintained. The new Intel platform will follow FSP2.0. The old platform can either use an old EDK branch, or move FSP1.1 support to platform directory. Cc: Giri P Mudusuru <[email protected]> Cc: Maurice Ma <[email protected]> Cc: Ravi P Rangarajan <[email protected]> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Jiewen Yao <[email protected]> Reviewed-by: Giri P Mudusuru <[email protected]> Reviewed-by: Maurice Ma <[email protected]> Reviewed-by: Ravi P Rangarajan <[email protected]> --- IntelFspWrapperPkg/Include/Library/FspPlatformInfoLib.h | 155 ---------------- IntelFspWrapperPkg/Include/Library/FspWrapperPlatformLib.h | 73 ++++++++ IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/BaseFspPlatformInfoLibSample.inf | 61 ------ IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/FspPlatformInfoLibSample.c | 195 -------------------- IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/BaseFspWrapperPlatformLibSample.inf | 61 ++++++ IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/FspWrapperPlatformLibSample.c | 83 +++++++++ 6 files changed, 217 insertions(+), 411 deletions(-) diff --git a/IntelFspWrapperPkg/Include/Library/FspPlatformInfoLib.h b/IntelFspWrapperPkg/Include/Library/FspPlatformInfoLib.h deleted file mode 100644 index e5bb2c2..0000000 --- a/IntelFspWrapperPkg/Include/Library/FspPlatformInfoLib.h +++ /dev/null @@ -1,155 +0,0 @@ -/** @file - Provide FSP platform information related function. - - Copyright (c) 2014, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php. - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -**/ - -#ifndef __FSP_PLATFORM_INFO_LIB_H__ -#define __FSP_PLATFORM_INFO_LIB_H__ - -/** - Get current boot mode. - - @note At this point, memory is ready, PeiServices are NOT available to use. - Platform can get some data from chipset register. - - @return BootMode current boot mode. -**/ -UINT32 -EFIAPI -GetBootMode ( - VOID - ); - -/** - Get NVS buffer parameter. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @return NvsBuffer NVS buffer parameter. -**/ -VOID * -EFIAPI -GetNvsBuffer ( - VOID - ); - -/** - Get UPD region size. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @return UPD region size. -**/ -UINT32 -EFIAPI -GetUpdRegionSize ( - VOID - ); - -/** - This function overrides the default configurations in the UPD data region. - - @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture. - - @return FspUpdRgnPtr A pointer to the UPD data region data strcture. -**/ -VOID * -EFIAPI -UpdateFspUpdConfigs ( - IN OUT VOID *FspUpdRgnPtr - ); - -/** - Get BootLoader Tolum size. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @return BootLoader Tolum size. -**/ -UINT32 -EFIAPI -GetBootLoaderTolumSize ( - VOID - ); - -/** - Get TempRamExit parameter. - - @note At this point, memory is ready, PeiServices are available to use. - - @return TempRamExit parameter. -**/ -VOID * -EFIAPI -GetTempRamExitParam ( - VOID - ); - -/** - Get FspSiliconInit parameter. - - @note At this point, memory is ready, PeiServices are available to use. - - @return FspSiliconInit parameter. -**/ -VOID * -EFIAPI -GetFspSiliconInitParam ( - VOID - ); - -/** - Get S3 PEI memory information. - - @note At this point, memory is ready, and PeiServices are available to use. - Platform can get some data from SMRAM directly. - - @param[out] S3PeiMemSize PEI memory size to be installed in S3 phase. - @param[out] S3PeiMemBase PEI memory base to be installed in S3 phase. - - @return If S3 PEI memory information is got successfully. -**/ -EFI_STATUS -EFIAPI -GetS3MemoryInfo ( - OUT UINT64 *S3PeiMemSize, - OUT EFI_PHYSICAL_ADDRESS *S3PeiMemBase - ); - -/** - Get stack information according to boot mode. - - @note If BootMode is BOOT_ON_S3_RESUME or BOOT_ON_FLASH_UPDATE, - this stack should be in some reserved memory space. - - @note If FspInitDone is TRUE, memory is ready, but no PeiServices there. - Platform can get some data from SMRAM directly. - @note If FspInitDone is FALSE, memory is NOT ready, but PeiServices are available to use. - Platform can get some data from variable via VariablePpi. - - @param[in] BootMode Current boot mode. - @param[in] FspInitDone If FspInit is called. - @param[out] StackSize Stack size to be used in PEI phase. - @param[out] StackBase Stack base to be used in PEI phase. - - @return If Stack information is got successfully. -**/ -EFI_STATUS -EFIAPI -GetStackInfo ( - IN UINT32 BootMode, - IN BOOLEAN FspInitDone, - OUT UINT64 *StackSize, - OUT EFI_PHYSICAL_ADDRESS *StackBase - ); - -#endif diff --git a/IntelFspWrapperPkg/Include/Library/FspWrapperPlatformLib.h b/IntelFspWrapperPkg/Include/Library/FspWrapperPlatformLib.h new file mode 100644 index 0000000..30dc8df --- /dev/null +++ b/IntelFspWrapperPkg/Include/Library/FspWrapperPlatformLib.h @@ -0,0 +1,73 @@ +/** @file + Provide FSP wrapper platform related function. + + Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR> + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php. + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#ifndef __FSP_WRAPPER_PLATFORM_LIB_H__ +#define __FSP_WRAPPER_PLATFORM_LIB_H__ + +/** + This function overrides the default configurations in the FSP-M UPD data region. + + @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture. + +**/ +VOID +EFIAPI +UpdateFspmUpdData ( + IN OUT VOID *FspUpdRgnPtr + ); + +/** + This function overrides the default configurations in the FSP-S UPD data region. + + @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture. + +**/ +VOID +EFIAPI +UpdateFspsUpdData ( + IN OUT VOID *FspUpdRgnPtr + ); + +/** + Update TempRamExit parameter. + + @note At this point, memory is ready, PeiServices are available to use. + + @return TempRamExit parameter. +**/ +VOID * +EFIAPI +UpdateTempRamExitParam ( + VOID + ); + +/** + Get S3 PEI memory information. + + @note At this point, memory is ready, and PeiServices are available to use. + Platform can get some data from SMRAM directly. + + @param[out] S3PeiMemSize PEI memory size to be installed in S3 phase. + @param[out] S3PeiMemBase PEI memory base to be installed in S3 phase. + + @return If S3 PEI memory information is got successfully. +**/ +EFI_STATUS +EFIAPI +GetS3MemoryInfo ( + OUT UINT64 *S3PeiMemSize, + OUT EFI_PHYSICAL_ADDRESS *S3PeiMemBase + ); + +#endif diff --git a/IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/BaseFspPlatformInfoLibSample.inf b/IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/BaseFspPlatformInfoLibSample.inf deleted file mode 100644 index 56d0f99..0000000 --- a/IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/BaseFspPlatformInfoLibSample.inf +++ /dev/null @@ -1,61 +0,0 @@ -## @file -# Sample to provide FSP platform information related function. -# -# Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR> -# -# This program and the accompanying materials -# are licensed and made available under the terms and conditions of the BSD License -# which accompanies this distribution. The full text of the license may be found at -# http://opensource.org/licenses/bsd-license.php. -# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -# -## - -################################################################################ -# -# Defines Section - statements that will be processed to create a Makefile. -# -################################################################################ -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = BaseFspPlatformInfoLibSample - FILE_GUID = 24C6F3E2-6ACD-436b-A604-56A5CF742A55 - MODULE_TYPE = SEC - VERSION_STRING = 1.0 - LIBRARY_CLASS = FspPlatformInfoLib - - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 -# - -################################################################################ -# -# Sources Section - list of files that are required for the build to succeed. -# -################################################################################ - -[Sources] - FspPlatformInfoLibSample.c - - -################################################################################ -# -# Package Dependency Section - list of Package files that are required for -# this module. -# -################################################################################ - -[Packages] - MdePkg/MdePkg.dec - IntelFspPkg/IntelFspPkg.dec - IntelFspWrapperPkg/IntelFspWrapperPkg.dec - -[LibraryClasses] - -[Pcd] - gFspWrapperTokenSpaceGuid.PcdTemporaryRamBase ## CONSUMES - gFspWrapperTokenSpaceGuid.PcdTemporaryRamSize ## CONSUMES diff --git a/IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/FspPlatformInfoLibSample.c b/IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/FspPlatformInfoLibSample.c deleted file mode 100644 index 903e26e..0000000 --- a/IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/FspPlatformInfoLibSample.c +++ /dev/null @@ -1,195 +0,0 @@ -/** @file - Sample to provide FSP platform information related function. - - Copyright (c) 2014, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php. - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -**/ - -#include <PiPei.h> -#include <Library/PcdLib.h> - -/** - Get current boot mode. - - @note At this point, memory is ready, PeiServices are NOT available to use. - Platform can get some data from chipset register. - - @return BootMode current boot mode. -**/ -UINT32 -EFIAPI -GetBootMode ( - VOID - ) -{ - return BOOT_WITH_FULL_CONFIGURATION; -} - -/** - Get NVS buffer parameter. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @return NvsBuffer NVS buffer parameter. -**/ -VOID * -EFIAPI -GetNvsBuffer ( - VOID - ) -{ - return NULL; -} - -/** - Get UPD region size. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @return UPD region size. -**/ -UINT32 -EFIAPI -GetUpdRegionSize ( - VOID - ) -{ - return 0; -} - -/** - This function overrides the default configurations in the UPD data region. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture. - - @return FspUpdRgnPtr A pointer to the UPD data region data strcture. -**/ -VOID * -EFIAPI -UpdateFspUpdConfigs ( - IN OUT VOID *FspUpdRgnPtr - ) -{ - return NULL; -} - -/** - Get BootLoader Tolum size. - - @note At this point, memory is NOT ready, PeiServices are available to use. - - @return BootLoader Tolum size. -**/ -UINT32 -EFIAPI -GetBootLoaderTolumSize ( - VOID - ) -{ - return 0; -} - -/** - Get TempRamExit parameter. - - @note At this point, memory is ready, PeiServices are available to use. - - @return TempRamExit parameter. -**/ -VOID * -EFIAPI -GetTempRamExitParam ( - VOID - ) -{ - return NULL; -} - -/** - Get FspSiliconInit parameter. - - @note At this point, memory is ready, PeiServices are available to use. - - @return FspSiliconInit parameter. -**/ -VOID * -EFIAPI -GetFspSiliconInitParam ( - VOID - ) -{ - return NULL; -} - -/** - Get S3 PEI memory information. - - @note At this point, memory is ready, and PeiServices are available to use. - Platform can get some data from SMRAM directly. - - @param[out] S3PeiMemSize PEI memory size to be installed in S3 phase. - @param[out] S3PeiMemBase PEI memory base to be installed in S3 phase. - - @return If S3 PEI memory information is got successfully. -**/ -EFI_STATUS -EFIAPI -GetS3MemoryInfo ( - OUT UINT64 *S3PeiMemSize, - OUT EFI_PHYSICAL_ADDRESS *S3PeiMemBase - ) -{ - return EFI_UNSUPPORTED; -} - -/** - Get stack information according to boot mode. - - @note If BootMode is BOOT_ON_S3_RESUME or BOOT_ON_FLASH_UPDATE, - this stack should be in some reserved memory space. - - @note If FspInitDone is TRUE, memory is ready, but no PeiServices there. - Platform can get some data from SMRAM directly. - @note If FspInitDone is FALSE, memory is NOT ready, but PeiServices are available to use. - Platform can get some data from variable via VariablePpi. - - @param[in] BootMode Current boot mode. - @param[in] FspInitDone If FspInit is called. - @param[out] StackSize Stack size to be used in PEI phase. - @param[out] StackBase Stack base to be used in PEI phase. - - @return If Stack information is got successfully. -**/ -EFI_STATUS -EFIAPI -GetStackInfo ( - IN UINT32 BootMode, - IN BOOLEAN FspInitDone, - OUT UINT64 *StackSize, - OUT EFI_PHYSICAL_ADDRESS *StackBase - ) -{ - *StackBase = PcdGet32 (PcdTemporaryRamBase); - *StackSize = PcdGet32 (PcdTemporaryRamSize); - - if (BootMode == BOOT_ON_S3_RESUME) { - if (!FspInitDone) { - } else { - } - } else if (BootMode == BOOT_ON_FLASH_UPDATE) { - if (!FspInitDone) { - } else { - } - } - - return EFI_SUCCESS; -} diff --git a/IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/BaseFspWrapperPlatformLibSample.inf b/IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/BaseFspWrapperPlatformLibSample.inf new file mode 100644 index 0000000..894b338 --- /dev/null +++ b/IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/BaseFspWrapperPlatformLibSample.inf @@ -0,0 +1,61 @@ +## @file +# Sample to provide FSP wrapper platform related function. +# +# Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR> +# +# This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php. +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# +## + +################################################################################ +# +# Defines Section - statements that will be processed to create a Makefile. +# +################################################################################ +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = BaseFspWrapperPlatformLibSample + FILE_GUID = 24C6F3E2-6ACD-436b-A604-56A5CF742A55 + MODULE_TYPE = BASE + VERSION_STRING = 1.0 + LIBRARY_CLASS = FspWrapperPlatformLib + + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 +# + +################################################################################ +# +# Sources Section - list of files that are required for the build to succeed. +# +################################################################################ + +[Sources] + FspWrapperPlatformLibSample.c + + +################################################################################ +# +# Package Dependency Section - list of Package files that are required for +# this module. +# +################################################################################ + +[Packages] + MdePkg/MdePkg.dec + IntelFspPkg/IntelFspPkg.dec + IntelFspWrapperPkg/IntelFspWrapperPkg.dec + +[LibraryClasses] + +[Pcd] + gIntelFspPkgTokenSpaceGuid.PcdTemporaryRamBase ## CONSUMES + gIntelFspPkgTokenSpaceGuid.PcdTemporaryRamSize ## CONSUMES diff --git a/IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/FspWrapperPlatformLibSample.c b/IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/FspWrapperPlatformLibSample.c new file mode 100644 index 0000000..9c1a84f --- /dev/null +++ b/IntelFspWrapperPkg/Library/BaseFspWrapperPlatformLibSample/FspWrapperPlatformLibSample.c @@ -0,0 +1,83 @@ +/** @file + Sample to provide FSP wrapper related function. + + Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR> + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php. + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +**/ + +#include <PiPei.h> +#include <Library/PcdLib.h> + +/** + This function overrides the default configurations in the FSP-M UPD data region. + + @note At this point, memory is NOT ready, PeiServices are available to use. + + @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture. + +**/ +VOID +EFIAPI +UpdateFspmUpdData ( + IN OUT VOID *FspUpdRgnPtr + ) +{ +} + +/** + This function overrides the default configurations in the FSP-S UPD data region. + + @param[in,out] FspUpdRgnPtr A pointer to the UPD data region data strcture. + +**/ +VOID +EFIAPI +UpdateFspsUpdData ( + IN OUT VOID *FspUpdRgnPtr + ) +{ +} + +/** + Update TempRamExit parameter. + + @note At this point, memory is ready, PeiServices are available to use. + + @return TempRamExit parameter. +**/ +VOID * +EFIAPI +UpdateTempRamExitParam ( + VOID + ) +{ + return NULL; +} + +/** + Get S3 PEI memory information. + + @note At this point, memory is ready, and PeiServices are available to use. + Platform can get some data from SMRAM directly. + + @param[out] S3PeiMemSize PEI memory size to be installed in S3 phase. + @param[out] S3PeiMemBase PEI memory base to be installed in S3 phase. + + @return If S3 PEI memory information is got successfully. +**/ +EFI_STATUS +EFIAPI +GetS3MemoryInfo ( + OUT UINT64 *S3PeiMemSize, + OUT EFI_PHYSICAL_ADDRESS *S3PeiMemBase + ) +{ + return EFI_UNSUPPORTED; +} \ No newline at end of file -- 2.7.4.windows.1 _______________________________________________ edk2-devel mailing list [email protected] https://lists.01.org/mailman/listinfo/edk2-devel
