123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529 |
- /** @file
- This will be invoked only once. It will call FspMemoryInit API,
- register TemporaryRamDonePpi to call TempRamExit API, and register MemoryDiscoveredPpi
- notify to call FspSiliconInit API.
- Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include <PiPei.h>
- #include <Library/PeimEntryPoint.h>
- #include <Library/PeiServicesLib.h>
- #include <Library/PeiServicesTablePointerLib.h>
- #include <Library/BaseLib.h>
- #include <Library/DebugLib.h>
- #include <Library/BaseMemoryLib.h>
- #include <Library/HobLib.h>
- #include <Library/PcdLib.h>
- #include <Library/MemoryAllocationLib.h>
- #include <Library/FspWrapperPlatformLib.h>
- #include <Library/FspWrapperHobProcessLib.h>
- #include <Library/TimerLib.h>
- #include <Library/PerformanceLib.h>
- #include <Library/FspWrapperApiLib.h>
- #include <Library/FspMeasurementLib.h>
- #include <Ppi/FspSiliconInitDone.h>
- #include <Ppi/EndOfPeiPhase.h>
- #include <Ppi/MemoryDiscovered.h>
- #include <Ppi/TemporaryRamDone.h>
- #include <Ppi/SecPlatformInformation.h>
- #include <Ppi/Tcg.h>
- #include <Ppi/FirmwareVolumeInfoMeasurementExcluded.h>
- #include <Library/FspWrapperApiTestLib.h>
- #include <FspEas.h>
- #include <FspStatusCode.h>
- extern EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc;
- extern EFI_GUID gFspHobGuid;
- /**
- This function handles S3 resume task at the end of PEI.
- @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 Always return EFI_SUCCESS
- **/
- EFI_STATUS
- EFIAPI
- S3EndOfPeiNotify (
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
- IN VOID *Ppi
- );
- EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc = {
- (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
- &gEfiEndOfPeiSignalPpiGuid,
- S3EndOfPeiNotify
- };
- /**
- This function handles S3 resume task at the end of PEI.
- @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 Always return EFI_SUCCESS
- **/
- EFI_STATUS
- EFIAPI
- S3EndOfPeiNotify (
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
- IN VOID *Ppi
- )
- {
- NOTIFY_PHASE_PARAMS NotifyPhaseParams;
- EFI_STATUS Status;
- DEBUG ((DEBUG_INFO, "S3EndOfPeiNotify enter\n"));
- NotifyPhaseParams.Phase = EnumInitPhaseAfterPciEnumeration;
- Status = CallFspNotifyPhase (&NotifyPhaseParams);
- DEBUG ((DEBUG_INFO, "FSP S3NotifyPhase AfterPciEnumeration status: 0x%x\n", Status));
- //
- // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
- //
- if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {
- DEBUG ((DEBUG_INFO, "FSP S3NotifyPhase AfterPciEnumeration requested reset 0x%x\n", Status));
- CallFspWrapperResetSystem (Status);
- }
- NotifyPhaseParams.Phase = EnumInitPhaseReadyToBoot;
- Status = CallFspNotifyPhase (&NotifyPhaseParams);
- DEBUG ((DEBUG_INFO, "FSP S3NotifyPhase ReadyToBoot status: 0x%x\n", Status));
- //
- // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
- //
- if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {
- DEBUG ((DEBUG_INFO, "FSP S3NotifyPhase ReadyToBoot requested reset 0x%x\n", Status));
- CallFspWrapperResetSystem (Status);
- }
- NotifyPhaseParams.Phase = EnumInitPhaseEndOfFirmware;
- Status = CallFspNotifyPhase (&NotifyPhaseParams);
- DEBUG ((DEBUG_INFO, "FSP S3NotifyPhase EndOfFirmware status: 0x%x\n", Status));
- //
- // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
- //
- if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {
- DEBUG ((DEBUG_INFO, "FSP S3NotifyPhase EndOfFirmware requested reset 0x%x\n", Status));
- CallFspWrapperResetSystem (Status);
- }
- return EFI_SUCCESS;
- }
- /**
- Return Hob list produced by FSP.
- @param[in] PeiServices The pointer to the PEI Services Table.
- @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 Return Hob list produced by FSP successfully.
- **/
- EFI_STATUS
- EFIAPI
- FspSiliconInitDoneGetFspHobList (
- IN CONST EFI_PEI_SERVICES **PeiServices,
- IN FSP_SILICON_INIT_DONE_PPI *This,
- OUT VOID **FspHobList
- );
- FSP_SILICON_INIT_DONE_PPI mFspSiliconInitDonePpi = {
- FspSiliconInitDoneGetFspHobList
- };
- EFI_PEI_PPI_DESCRIPTOR mPeiFspSiliconInitDonePpi = {
- EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
- &gFspSiliconInitDonePpiGuid,
- &mFspSiliconInitDonePpi
- };
- /**
- Return Hob list produced by FSP.
- @param[in] PeiServices The pointer to the PEI Services Table.
- @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 Return Hob list produced by FSP successfully.
- **/
- EFI_STATUS
- EFIAPI
- FspSiliconInitDoneGetFspHobList (
- IN CONST EFI_PEI_SERVICES **PeiServices,
- IN FSP_SILICON_INIT_DONE_PPI *This,
- OUT VOID **FspHobList
- )
- {
- EFI_HOB_GUID_TYPE *GuidHob;
- GuidHob = GetFirstGuidHob (&gFspHobGuid);
- if (GuidHob != NULL) {
- *FspHobList = *(VOID **)GET_GUID_HOB_DATA (GuidHob);
- return EFI_SUCCESS;
- } else {
- return EFI_NOT_FOUND;
- }
- }
- /**
- Get the FSP S UPD Data address
- @return FSP-S UPD Data Address
- **/
- UINTN
- GetFspsUpdDataAddress (
- VOID
- )
- {
- if (PcdGet64 (PcdFspsUpdDataAddress64) != 0) {
- return (UINTN)PcdGet64 (PcdFspsUpdDataAddress64);
- } else {
- return (UINTN)PcdGet32 (PcdFspsUpdDataAddress);
- }
- }
- /**
- 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.
- @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 Always return EFI_SUCCESS
- **/
- EFI_STATUS
- EFIAPI
- PeiMemoryDiscoveredNotify (
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
- IN VOID *Ppi
- );
- EFI_PEI_NOTIFY_DESCRIPTOR mPeiMemoryDiscoveredNotifyDesc = {
- (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
- &gEfiPeiMemoryDiscoveredPpiGuid,
- PeiMemoryDiscoveredNotify
- };
- /**
- This function is called after PEI core discover memory and finish migration.
- @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 Always return EFI_SUCCESS
- **/
- EFI_STATUS
- EFIAPI
- PeiMemoryDiscoveredNotify (
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
- IN VOID *Ppi
- )
- {
- FSP_INFO_HEADER *FspsHeaderPtr;
- UINT64 TimeStampCounterStart;
- EFI_STATUS Status;
- VOID *FspHobListPtr;
- EFI_HOB_GUID_TYPE *GuidHob;
- FSPS_UPD_COMMON *FspsUpdDataPtr;
- UINTN *SourceData;
- DEBUG ((DEBUG_INFO, "PeiMemoryDiscoveredNotify enter\n"));
- FspsUpdDataPtr = NULL;
- FspsHeaderPtr = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspsBaseAddress));
- DEBUG ((DEBUG_INFO, "FspsHeaderPtr - 0x%x\n", FspsHeaderPtr));
- if (FspsHeaderPtr == NULL) {
- return EFI_DEVICE_ERROR;
- }
- if ((GetFspsUpdDataAddress () == 0) && (FspsHeaderPtr->CfgRegionSize != 0) && (FspsHeaderPtr->CfgRegionOffset != 0)) {
- //
- // Copy default FSP-S UPD data from Flash
- //
- FspsUpdDataPtr = (FSPS_UPD_COMMON *)AllocateZeroPool ((UINTN)FspsHeaderPtr->CfgRegionSize);
- ASSERT (FspsUpdDataPtr != NULL);
- SourceData = (UINTN *)((UINTN)FspsHeaderPtr->ImageBase + (UINTN)FspsHeaderPtr->CfgRegionOffset);
- CopyMem (FspsUpdDataPtr, SourceData, (UINTN)FspsHeaderPtr->CfgRegionSize);
- } else {
- FspsUpdDataPtr = (FSPS_UPD_COMMON *)GetFspsUpdDataAddress ();
- ASSERT (FspsUpdDataPtr != NULL);
- }
- UpdateFspsUpdData ((VOID *)FspsUpdDataPtr);
- TimeStampCounterStart = AsmReadTsc ();
- PERF_START_EX (&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);
- Status = CallFspSiliconInit ((VOID *)FspsUpdDataPtr);
- PERF_END_EX (&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_SILICON_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);
- DEBUG ((DEBUG_INFO, "Total time spent executing FspSiliconInitApi: %d millisecond\n", DivU64x32 (GetTimeInNanoSecond (AsmReadTsc () - TimeStampCounterStart), 1000000)));
- //
- // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
- //
- if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {
- DEBUG ((DEBUG_INFO, "FspSiliconInitApi requested reset 0x%x\n", Status));
- CallFspWrapperResetSystem (Status);
- }
- if (EFI_ERROR (Status)) {
- DEBUG ((DEBUG_ERROR, "ERROR - Failed to execute FspSiliconInitApi(), Status = %r\n", Status));
- }
- DEBUG ((DEBUG_INFO, "FspSiliconInit status: 0x%x\n", Status));
- ASSERT_EFI_ERROR (Status);
- Status = TestFspSiliconInitApiOutput ((VOID *)NULL);
- if (RETURN_ERROR (Status)) {
- DEBUG ((DEBUG_ERROR, "ERROR - TestFspSiliconInitApiOutput () fail, Status = %r\n", Status));
- }
- //
- // Now FspHobList complete, process it
- //
- GuidHob = GetFirstGuidHob (&gFspHobGuid);
- ASSERT (GuidHob != NULL);
- FspHobListPtr = *(VOID **)GET_GUID_HOB_DATA (GuidHob);
- DEBUG ((DEBUG_INFO, "FspHobListPtr - 0x%x\n", FspHobListPtr));
- PostFspsHobProcess (FspHobListPtr);
- //
- // Install FspSiliconInitDonePpi so that any other driver can consume this info.
- //
- Status = PeiServicesInstallPpi (&mPeiFspSiliconInitDonePpi);
- ASSERT_EFI_ERROR (Status);
- return Status;
- }
- /**
- Do FSP initialization in API mode.
- @retval EFI_STATUS Always return EFI_SUCCESS
- **/
- EFI_STATUS
- FspsWrapperInitApiMode (
- VOID
- )
- {
- EFI_STATUS Status;
- EFI_BOOT_MODE BootMode;
- //
- // Register MemoryDiscovered Notify to run FspSiliconInit
- //
- Status = PeiServicesNotifyPpi (&mPeiMemoryDiscoveredNotifyDesc);
- ASSERT_EFI_ERROR (Status);
- //
- // Register EndOfPei Notify for S3 to run FSP NotifyPhase
- //
- PeiServicesGetBootMode (&BootMode);
- if (BootMode == BOOT_ON_S3_RESUME) {
- Status = PeiServicesNotifyPpi (&mS3EndOfPeiNotifyDesc);
- ASSERT_EFI_ERROR (Status);
- }
- return EFI_SUCCESS;
- }
- /**
- Do FSP initialization in Dispatch mode.
- @retval FSP initialization status.
- **/
- EFI_STATUS
- FspsWrapperInitDispatchMode (
- VOID
- )
- {
- EFI_STATUS Status;
- EFI_PEI_FIRMWARE_VOLUME_INFO_MEASUREMENT_EXCLUDED_PPI *MeasurementExcludedFvPpi;
- EFI_PEI_PPI_DESCRIPTOR *MeasurementExcludedPpiList;
- MeasurementExcludedFvPpi = AllocatePool (sizeof (*MeasurementExcludedFvPpi));
- ASSERT (MeasurementExcludedFvPpi != NULL);
- MeasurementExcludedFvPpi->Count = 1;
- MeasurementExcludedFvPpi->Fv[0].FvBase = PcdGet32 (PcdFspsBaseAddress);
- MeasurementExcludedFvPpi->Fv[0].FvLength = ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFspsBaseAddress))->FvLength;
- MeasurementExcludedPpiList = AllocatePool (sizeof (*MeasurementExcludedPpiList));
- ASSERT (MeasurementExcludedPpiList != NULL);
- MeasurementExcludedPpiList->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;
- MeasurementExcludedPpiList->Guid = &gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid;
- MeasurementExcludedPpiList->Ppi = MeasurementExcludedFvPpi;
- Status = PeiServicesInstallPpi (MeasurementExcludedPpiList);
- ASSERT_EFI_ERROR (Status);
- //
- // FSP-S Wrapper running in Dispatch mode and reports FSP-S FV to PEI dispatcher.
- //
- PeiServicesInstallFvInfoPpi (
- NULL,
- (VOID *)(UINTN)PcdGet32 (PcdFspsBaseAddress),
- (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFspsBaseAddress))->FvLength,
- NULL,
- NULL
- );
- //
- // Register EndOfPei Nofity to run post FSP-S process.
- //
- Status = PeiServicesNotifyPpi (&mFspsWrapperEndOfPeiNotifyDesc);
- ASSERT_EFI_ERROR (Status);
- return Status;
- }
- /**
- This function is called after TCG installed PPI.
- @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 Always return EFI_SUCCESS
- **/
- EFI_STATUS
- EFIAPI
- TcgPpiNotify (
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
- IN VOID *Ppi
- );
- EFI_PEI_NOTIFY_DESCRIPTOR mTcgPpiNotifyDesc = {
- (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
- &gEdkiiTcgPpiGuid,
- TcgPpiNotify
- };
- /**
- This function is called after TCG installed PPI.
- @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 Always return EFI_SUCCESS
- **/
- EFI_STATUS
- EFIAPI
- TcgPpiNotify (
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,
- IN VOID *Ppi
- )
- {
- UINT32 FspMeasureMask;
- DEBUG ((DEBUG_INFO, "TcgPpiNotify FSPS\n"));
- FspMeasureMask = PcdGet32 (PcdFspMeasurementConfig);
- if ((FspMeasureMask & FSP_MEASURE_FSPS) != 0) {
- MeasureFspFirmwareBlob (
- 0,
- "FSPS",
- PcdGet32 (PcdFspsBaseAddress),
- (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFspsBaseAddress))->FvLength
- );
- }
- return EFI_SUCCESS;
- }
- /**
- This is the entrypoint of PEIM.
- @param[in] FileHandle Handle of the file being invoked.
- @param[in] PeiServices Describes the list of possible PEI Services.
- @retval EFI_SUCCESS if it completed successfully.
- **/
- EFI_STATUS
- EFIAPI
- FspsWrapperPeimEntryPoint (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- )
- {
- EFI_STATUS Status;
- DEBUG ((DEBUG_INFO, "FspsWrapperPeimEntryPoint\n"));
- Status = PeiServicesNotifyPpi (&mTcgPpiNotifyDesc);
- ASSERT_EFI_ERROR (Status);
- if (PcdGet8 (PcdFspModeSelection) == 1) {
- FspsWrapperInitApiMode ();
- } else {
- FspsWrapperInitDispatchMode ();
- }
- return EFI_SUCCESS;
- }
|