IntelFsp2Pkg: Add FSP 2.4 MultiPhase interface.

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

Provide FSP 2.4 MultiPhase interface and scripts
support.

Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Signed-off-by: Chasel Chiu <chasel.chiu@intel.com>
Reviewed-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
This commit is contained in:
Chasel Chiu
2022-07-25 12:03:51 -07:00
committed by mergify[bot]
parent 4b7bd4c591
commit df25a5457f
10 changed files with 450 additions and 29 deletions

View File

@@ -0,0 +1,50 @@
## @file
# FSP MultiPhase Lib.
#
# Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
##
################################################################################
#
# Defines Section - statements that will be processed to create a Makefile.
#
################################################################################
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BaseFspMultiPhaseLib
FILE_GUID = C128CADC-623E-4E41-97CB-A7138E627460
MODULE_TYPE = SEC
VERSION_STRING = 1.0
LIBRARY_CLASS = FspMultiPhaseLib
#
# 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]
FspMultiPhaseLib.c
################################################################################
#
# Package Dependency Section - list of Package files that are required for
# this module.
#
################################################################################
[Packages]
MdePkg/MdePkg.dec
IntelFsp2Pkg/IntelFsp2Pkg.dec
[Pcd]
gIntelFsp2PkgTokenSpaceGuid.PcdMultiPhaseNumberOfPhases # CONSUMES

View File

@@ -0,0 +1,184 @@
/** @file
FSP MultiPhase library.
Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <PiPei.h>
#include <Library/FspCommonLib.h>
#include <Library/FspSwitchStackLib.h>
#include <Library/FspSecPlatformLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
#include <FspEas/FspApi.h>
#include <FspGlobalData.h>
EFI_STATUS
EFIAPI
FspMultiPhaseSwitchStack (
)
{
SetFspApiReturnStatus (EFI_SUCCESS);
Pei2LoaderSwitchStack ();
return EFI_SUCCESS;
}
EFI_STATUS
EFIAPI
FspVariableRequestSwitchStack (
IN FSP_MULTI_PHASE_VARIABLE_REQUEST_INFO_PARAMS *FspVariableRequestParams
)
{
FSP_GLOBAL_DATA *FspData;
FspData = GetFspGlobalDataPointer ();
if (((UINTN)FspData == 0) || ((UINTN)FspData == 0xFFFFFFFF)) {
return EFI_UNSUPPORTED;
}
FspData->VariableRequestParameterPtr = (VOID *)FspVariableRequestParams;
SetFspApiReturnStatus (FSP_STATUS_VARIABLE_REQUEST);
Pei2LoaderSwitchStack ();
return EFI_SUCCESS;
}
/**
This function supports FspMultiPhase implementation.
@param[in] ApiIdx Internal index of the FSP API.
@param[in] ApiParam Parameter of the FSP API.
@retval EFI_SUCCESS FSP execution was successful.
@retval EFI_INVALID_PARAMETER Input parameters are invalid.
@retval EFI_UNSUPPORTED The FSP calling conditions were not met.
@retval EFI_DEVICE_ERROR FSP initialization failed.
**/
EFI_STATUS
EFIAPI
FspMultiPhaseWorker (
IN UINT32 ApiIdx,
IN VOID *ApiParam
)
{
FSP_MULTI_PHASE_PARAMS *FspMultiPhaseParams;
FSP_GLOBAL_DATA *FspData;
FSP_MULTI_PHASE_GET_NUMBER_OF_PHASES_PARAMS *FspMultiPhaseGetNumber;
BOOLEAN FspDataValid;
UINT32 NumberOfPhasesSupported;
FspDataValid = TRUE;
FspData = GetFspGlobalDataPointer ();
if (((UINTN)FspData == 0) || ((UINTN)FspData == 0xFFFFFFFF)) {
FspDataValid = FALSE;
}
//
// It is required that FspData->NumberOfPhases to be reset to 0 after
// current FSP component finished.
// The next component FspData->NumberOfPhases will only be re-initialized when FspData->NumberOfPhases = 0
//
if ((FspDataValid == TRUE) && (FspData->NumberOfPhases == 0)) {
FspData->NumberOfPhases = PcdGet32 (PcdMultiPhaseNumberOfPhases);
FspData->PhasesExecuted = 0;
if (FspMultiPhasePlatformGetNumberOfPhases (ApiIdx, &NumberOfPhasesSupported) == TRUE) {
//
// Platform has implemented runtime controlling for NumberOfPhasesSupported
//
FspData->NumberOfPhases = NumberOfPhasesSupported;
}
}
FspMultiPhaseParams = (FSP_MULTI_PHASE_PARAMS *)ApiParam;
if (FspDataValid == FALSE) {
return EFI_DEVICE_ERROR;
} else {
switch (FspMultiPhaseParams->MultiPhaseAction) {
case EnumMultiPhaseGetNumberOfPhases:
if ((FspMultiPhaseParams->MultiPhaseParamPtr == NULL) || (FspMultiPhaseParams->PhaseIndex != 0)) {
return EFI_INVALID_PARAMETER;
}
FspMultiPhaseGetNumber = (FSP_MULTI_PHASE_GET_NUMBER_OF_PHASES_PARAMS *)FspMultiPhaseParams->MultiPhaseParamPtr;
FspMultiPhaseGetNumber->NumberOfPhases = FspData->NumberOfPhases;
FspMultiPhaseGetNumber->PhasesExecuted = FspData->PhasesExecuted;
break;
case EnumMultiPhaseExecutePhase:
if ((FspMultiPhaseParams->PhaseIndex > FspData->PhasesExecuted) && (FspMultiPhaseParams->PhaseIndex <= FspData->NumberOfPhases)) {
FspData->PhasesExecuted = FspMultiPhaseParams->PhaseIndex;
return Loader2PeiSwitchStack ();
} else {
return EFI_INVALID_PARAMETER;
}
break;
case EnumMultiPhaseGetVariableRequestInfo:
//
// return variable request info
//
FspMultiPhaseParams->MultiPhaseParamPtr = FspData->VariableRequestParameterPtr;
break;
case EnumMultiPhaseCompleteVariableRequest:
//
// retrieve complete variable request params
//
FspData->VariableRequestParameterPtr = FspMultiPhaseParams->MultiPhaseParamPtr;
return Loader2PeiSwitchStack ();
break;
default:
return EFI_UNSUPPORTED;
}
}
return EFI_SUCCESS;
}
/**
This function handles FspMultiPhaseMemInitApi.
@param[in] ApiIdx Internal index of the FSP API.
@param[in] ApiParam Parameter of the FSP API.
@retval EFI_SUCCESS FSP execution was successful.
@retval EFI_INVALID_PARAMETER Input parameters are invalid.
@retval EFI_UNSUPPORTED The FSP calling conditions were not met.
@retval EFI_DEVICE_ERROR FSP initialization failed.
**/
EFI_STATUS
EFIAPI
FspMultiPhaseMemInitApiHandler (
IN UINT32 ApiIdx,
IN VOID *ApiParam
)
{
return FspMultiPhaseWorker (ApiIdx, ApiParam);
}
/**
This function handles FspMultiPhaseSiInitApi.
@param[in] ApiIdx Internal index of the FSP API.
@param[in] ApiParam Parameter of the FSP API.
@retval EFI_SUCCESS FSP execution was successful.
@retval EFI_INVALID_PARAMETER Input parameters are invalid.
@retval EFI_UNSUPPORTED The FSP calling conditions were not met.
@retval EFI_DEVICE_ERROR FSP initialization failed.
**/
EFI_STATUS
EFIAPI
FspMultiPhaseSiInitApiHandlerV2 (
IN UINT32 ApiIdx,
IN VOID *ApiParam
)
{
return FspMultiPhaseWorker (ApiIdx, ApiParam);
}

View File

@@ -28,6 +28,7 @@ FspUpdSignatureCheck (
/**
This function handles FspMultiPhaseSiInitApi.
Starting from FSP 2.4 this function is obsolete and FspMultiPhaseSiInitApiHandlerV2 is the replacement.
@param[in] ApiIdx Internal index of the FSP API.
@param[in] ApiParam Parameter of the FSP API.
@@ -42,3 +43,36 @@ FspMultiPhaseSiInitApiHandler (
{
return EFI_SUCCESS;
}
/**
FSP MultiPhase Platform Get Number Of Phases Function.
Allows an FSP binary to dynamically update the number of phases at runtime.
For example, UPD settings could negate the need to enter the multi-phase flow
in certain scenarios. If this function returns FALSE, the default number of phases
provided by PcdMultiPhaseNumberOfPhases will be returned to the bootloader instead.
@param[in] ApiIdx - Internal index of the FSP API.
@param[in] NumberOfPhasesSupported - How many phases are supported by current FSP Component.
@retval TRUE - NumberOfPhases are modified by Platform during runtime.
@retval FALSE - The Default build time NumberOfPhases should be used.
**/
BOOLEAN
EFIAPI
FspMultiPhasePlatformGetNumberOfPhases (
IN UINT8 ApiIdx,
IN OUT UINT32 *NumberOfPhasesSupported
)
{
/* Example for platform runtime controlling
if ((ApiIdx == FspMultiPhaseSiInitApiIndex) && (Feature1Enable == FALSE)) {
*NumberOfPhasesSupported = 0;
return TRUE;
}
return FALSE
*/
return FALSE;
}