Re: [PATCH v2] IntelFsp2WrapperPkg: Perform post FSP-S process.


Zeng, Star
 

Small comments are added inline. With them handled, Reviewed-by: Star Zeng <star.zeng@...>.
You do not need to send an extra patch for them specifically if no other comment will be received from other.

-----Original Message-----
From: Chiu, Chasel
Sent: Monday, April 15, 2019 2:09 PM
To: devel@edk2.groups.io
Cc: Chiu, Chasel <chasel.chiu@...>; Desimone, Nathaniel L
<@natedesimone>; Zeng, Star <star.zeng@...>
Subject: [PATCH v2] IntelFsp2WrapperPkg: Perform post FSP-S process.

From: "Chasel, Chiu" <chasel.chiu@...>

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1716

In API mode FSP wrapper will perform some post
FSP-S process but such process was skipped in Dispatch
mode which may impact some of the boot loaders.
To align behavior between API and Dispatch, an
End-of-Pei callback is introduced to perform same process
in Dispatch mode.

Note: If boot loader implemented its own
PostFspsHobProcess (), it has to check
PcdFspModeSelection and support each mode
properly.

Test: Verified on internal platform and both
FSP API and Dispatch modes booted successfully.

Cc: Nate DeSimone <@natedesimone>
Cc: Star Zeng <star.zeng@...>
Signed-off-by: Chasel Chiu <chasel.chiu@...>
---
IntelFsp2WrapperPkg/FspsWrapperPeim/FspsWrapperPeim.c
| 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
--

IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/FspWrap
perHobProcessLibSample.c | 18 +++++++++++++++---

IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/PeiFspWr
apperHobProcessLibSample.inf | 3 ++-
3 files changed, 77 insertions(+), 7 deletions(-)

diff --git a/IntelFsp2WrapperPkg/FspsWrapperPeim/FspsWrapperPeim.c
b/IntelFsp2WrapperPkg/FspsWrapperPeim/FspsWrapperPeim.c
index bb126797ae..441233dfda 100644
--- a/IntelFsp2WrapperPkg/FspsWrapperPeim/FspsWrapperPeim.c
+++ b/IntelFsp2WrapperPkg/FspsWrapperPeim/FspsWrapperPeim.c
@@ -3,7 +3,7 @@
register TemporaryRamDonePpi to call TempRamExit API, and register
MemoryDiscoveredPpi
notify to call FspSiliconInit API.

- Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent

**/
@@ -130,7 +130,7 @@ S3EndOfPeiNotify(
@param[in] This The pointer to this instance of this PPI.
@param[out] FspHobList The pointer to Hob list produced by FSP.

- @return EFI_SUCCESS FReturn Hob list produced by FSP successfully.
+ @return EFI_SUCCESS Return Hob list produced by FSP successfully.
**/
EFI_STATUS
EFIAPI
@@ -157,7 +157,7 @@ EFI_PEI_PPI_DESCRIPTOR
mPeiFspSiliconInitDonePpi = {
@param[in] This The pointer to this instance of this PPI.
@param[out] FspHobList The pointer to Hob list produced by FSP.

- @return EFI_SUCCESS FReturn Hob list produced by FSP successfully.
+ @return EFI_SUCCESS Return Hob list produced by FSP successfully.
**/
EFI_STATUS
EFIAPI
@@ -179,6 +179,49 @@ FspSiliconInitDoneGetFspHobList (
}

/**
+ This function is for FSP dispatch mode to perform post FSP-S process.
+
+ @param[in] PeiServices Pointer to PEI Services Table.
+ @param[in] NotifyDesc Pointer to the descriptor for the Notification
event that
+ caused this function to execute.
+ @param[in] Ppi Pointer to the PPI data associated with this
function.
+
+ @retval EFI_STATUS Status returned by PeiServicesInstallPpi ()
+**/
+EFI_STATUS
+EFIAPI
+FspsWrapperEndOfPeiNotify (
+ IN EFI_PEI_SERVICES **PeiServices,
+ IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
+ IN VOID *Ppi
+ )
+{
+ EFI_STATUS Status;
+
+ //
+ // This step may include platform specific process in some boot loaders so
+ // aligning the same behavior between API and Dispatch modes.
+ // Note: In Dispatch mode no FspHobList so passing NULL to function and
+ // expecting function will handle it.
+ //
+ PostFspsHobProcess (NULL);
+
+ //
+ // Install FspSiliconInitDonePpi so that any other driver can consume this
info.
+ //
+ Status = PeiServicesInstallPpi (&mPeiFspSiliconInitDonePpi);
+ ASSERT_EFI_ERROR(Status);
+
+ return Status;
+}
+
+EFI_PEI_NOTIFY_DESCRIPTOR mFspsWrapperEndOfPeiNotifyDesc = {
+ (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK |
EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
+ &gEfiEndOfPeiSignalPpiGuid,
+ FspsWrapperEndOfPeiNotify
+};
+
+/**
This function is called after PEI core discover memory and finish migration.

@param[in] PeiServices Pointer to PEI Services Table.
@@ -341,11 +384,19 @@ FspsWrapperPeimEntryPoint (
IN CONST EFI_PEI_SERVICES **PeiServices
)
{
+ EFI_STATUS Status;
+
DEBUG ((DEBUG_INFO, "FspsWrapperPeimEntryPoint\n"));

if (PcdGet8 (PcdFspModeSelection) == 1) {
+ //
+ // FSP-S Wrapper running in API mode and calls to FSP API entry point.
+ //
FspsWrapperInit ();
Suggest updating this function name to FspsWrapperInitApiMode() and add the new comments to the FspsWrapperInitApiMode() function header.

} else {
+ //
+ // FSP-S Wrapper running in Dispatch mode and reports FSP-S FV to PEI
dispatcher.
+ //
PeiServicesInstallFvInfoPpi (
NULL,
(VOID *)(UINTN) PcdGet32 (PcdFspsBaseAddress),
@@ -353,6 +404,12 @@ FspsWrapperPeimEntryPoint (
NULL,
NULL
);
+
+ //
+ // Register EndOfPei Nofity to run post FSP-S process.
+ //
+ Status = PeiServicesNotifyPpi (&mFspsWrapperEndOfPeiNotifyDesc);
+ ASSERT_EFI_ERROR (Status);
Suggest abstracting this code block to a new function FspsWrapperInitDispatchMode().

Then the code will be more clear for code symmetry, function name and function header. :)


Thanks,
Star

}

return EFI_SUCCESS;
diff --git
a/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/FspWr
apperHobProcessLibSample.c
b/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/FspWr
apperHobProcessLibSample.c
index 1c7f661c47..54cebe127c 100644
---
a/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/FspWr
apperHobProcessLibSample.c
+++
b/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/FspWr
apperHobProcessLibSample.c
@@ -1,7 +1,7 @@
/** @file
Sample to provide FSP wrapper hob process related function.

- Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent

**/
@@ -378,7 +378,19 @@ PostFspsHobProcess (
IN VOID *FspHobList
)
{
- ProcessFspHobList (FspHobList);
-
+ //
+ // PostFspsHobProcess () will be called in both FSP API and Dispatch
modes to
+ // align the same behavior and support a variety of boot loader
implementations.
+ // Boot loader provided library function is recommended to support both
API and
+ // Dispatch modes by checking PcdFspModeSelection.
+ //
+ if (PcdGet8 (PcdFspModeSelection) == 1) {
+ //
+ // Only in FSP API mode the wrapper has to build hobs basing on FSP
output data.
+ // In this case FspHobList cannot be NULL.
+ //
+ ASSERT (FspHobList != NULL);
+ ProcessFspHobList (FspHobList);
+ }
return EFI_SUCCESS;
}
diff --git
a/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/PeiFsp
WrapperHobProcessLibSample.inf
b/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/PeiFsp
WrapperHobProcessLibSample.inf
index 938ffae494..6d9e306313 100644
---
a/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/PeiFsp
WrapperHobProcessLibSample.inf
+++
b/IntelFsp2WrapperPkg/Library/PeiFspWrapperHobProcessLibSample/PeiFsp
WrapperHobProcessLibSample.inf
@@ -1,7 +1,7 @@
## @file
# Sample to provide FSP wrapper hob process related function.
#
-# Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
@@ -61,6 +61,7 @@
[Pcd]
gIntelFsp2WrapperTokenSpaceGuid.PcdPeiMinMemSize ##
CONSUMES
gIntelFsp2WrapperTokenSpaceGuid.PcdPeiRecoveryMinMemSize ##
CONSUMES
+ gIntelFsp2WrapperTokenSpaceGuid.PcdFspModeSelection ##
CONSUMES

[Guids]
gFspReservedMemoryResourceHobGuid ## CONSUMES ##
HOB
--
2.13.3.windows.1

Join devel@edk2.groups.io to automatically receive all group messages.