2 This will be invoked only once. It will call FspMemoryInit API,
3 register TemporaryRamDonePpi to call TempRamExit API, and register MemoryDiscoveredPpi
4 notify to call FspSiliconInit API.
6 Copyright (c) 2014 - 2021, Intel Corporation. All rights reserved.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
13 #include <Library/PeimEntryPoint.h>
14 #include <Library/PeiServicesLib.h>
15 #include <Library/PeiServicesTablePointerLib.h>
16 #include <Library/BaseLib.h>
17 #include <Library/DebugLib.h>
18 #include <Library/BaseMemoryLib.h>
19 #include <Library/HobLib.h>
20 #include <Library/PcdLib.h>
21 #include <Library/MemoryAllocationLib.h>
22 #include <Library/FspWrapperPlatformLib.h>
23 #include <Library/FspWrapperHobProcessLib.h>
24 #include <Library/TimerLib.h>
25 #include <Library/PerformanceLib.h>
26 #include <Library/FspWrapperApiLib.h>
27 #include <Library/FspMeasurementLib.h>
29 #include <Ppi/FspSiliconInitDone.h>
30 #include <Ppi/EndOfPeiPhase.h>
31 #include <Ppi/MemoryDiscovered.h>
32 #include <Ppi/TemporaryRamDone.h>
33 #include <Ppi/SecPlatformInformation.h>
35 #include <Ppi/FirmwareVolumeInfoMeasurementExcluded.h>
36 #include <Library/FspWrapperApiTestLib.h>
38 #include <FspStatusCode.h>
40 extern EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc
;
41 extern EFI_GUID gFspHobGuid
;
44 This function handles S3 resume task at the end of PEI.
46 @param[in] PeiServices Pointer to PEI Services Table.
47 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
48 caused this function to execute.
49 @param[in] Ppi Pointer to the PPI data associated with this function.
51 @retval EFI_STATUS Always return EFI_SUCCESS
56 IN EFI_PEI_SERVICES
**PeiServices
,
57 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
61 EFI_PEI_NOTIFY_DESCRIPTOR mS3EndOfPeiNotifyDesc
= {
62 (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
63 &gEfiEndOfPeiSignalPpiGuid
,
68 This function handles S3 resume task at the end of PEI.
70 @param[in] PeiServices Pointer to PEI Services Table.
71 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
72 caused this function to execute.
73 @param[in] Ppi Pointer to the PPI data associated with this function.
75 @retval EFI_STATUS Always return EFI_SUCCESS
80 IN EFI_PEI_SERVICES
**PeiServices
,
81 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
85 NOTIFY_PHASE_PARAMS NotifyPhaseParams
;
88 DEBUG ((DEBUG_INFO
, "S3EndOfPeiNotify enter\n"));
90 NotifyPhaseParams
.Phase
= EnumInitPhaseAfterPciEnumeration
;
91 Status
= CallFspNotifyPhase (&NotifyPhaseParams
);
92 DEBUG ((DEBUG_INFO
, "FSP S3NotifyPhase AfterPciEnumeration status: 0x%x\n", Status
));
95 // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
97 if ((Status
>= FSP_STATUS_RESET_REQUIRED_COLD
) && (Status
<= FSP_STATUS_RESET_REQUIRED_8
)) {
98 DEBUG ((DEBUG_INFO
, "FSP S3NotifyPhase AfterPciEnumeration requested reset 0x%x\n", Status
));
99 CallFspWrapperResetSystem ((UINT32
)Status
);
102 NotifyPhaseParams
.Phase
= EnumInitPhaseReadyToBoot
;
103 Status
= CallFspNotifyPhase (&NotifyPhaseParams
);
104 DEBUG ((DEBUG_INFO
, "FSP S3NotifyPhase ReadyToBoot status: 0x%x\n", Status
));
107 // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
109 if ((Status
>= FSP_STATUS_RESET_REQUIRED_COLD
) && (Status
<= FSP_STATUS_RESET_REQUIRED_8
)) {
110 DEBUG ((DEBUG_INFO
, "FSP S3NotifyPhase ReadyToBoot requested reset 0x%x\n", Status
));
111 CallFspWrapperResetSystem ((UINT32
)Status
);
114 NotifyPhaseParams
.Phase
= EnumInitPhaseEndOfFirmware
;
115 Status
= CallFspNotifyPhase (&NotifyPhaseParams
);
116 DEBUG ((DEBUG_INFO
, "FSP S3NotifyPhase EndOfFirmware status: 0x%x\n", Status
));
119 // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
121 if ((Status
>= FSP_STATUS_RESET_REQUIRED_COLD
) && (Status
<= FSP_STATUS_RESET_REQUIRED_8
)) {
122 DEBUG ((DEBUG_INFO
, "FSP S3NotifyPhase EndOfFirmware requested reset 0x%x\n", Status
));
123 CallFspWrapperResetSystem ((UINT32
)Status
);
130 Return Hob list produced by FSP.
132 @param[in] PeiServices The pointer to the PEI Services Table.
133 @param[in] This The pointer to this instance of this PPI.
134 @param[out] FspHobList The pointer to Hob list produced by FSP.
136 @return EFI_SUCCESS Return Hob list produced by FSP successfully.
140 FspSiliconInitDoneGetFspHobList (
141 IN CONST EFI_PEI_SERVICES
**PeiServices
,
142 IN FSP_SILICON_INIT_DONE_PPI
*This
,
143 OUT VOID
**FspHobList
146 FSP_SILICON_INIT_DONE_PPI mFspSiliconInitDonePpi
= {
147 FspSiliconInitDoneGetFspHobList
150 EFI_PEI_PPI_DESCRIPTOR mPeiFspSiliconInitDonePpi
= {
151 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
152 &gFspSiliconInitDonePpiGuid
,
153 &mFspSiliconInitDonePpi
157 Return Hob list produced by FSP.
159 @param[in] PeiServices The pointer to the PEI Services Table.
160 @param[in] This The pointer to this instance of this PPI.
161 @param[out] FspHobList The pointer to Hob list produced by FSP.
163 @return EFI_SUCCESS Return Hob list produced by FSP successfully.
167 FspSiliconInitDoneGetFspHobList (
168 IN CONST EFI_PEI_SERVICES
**PeiServices
,
169 IN FSP_SILICON_INIT_DONE_PPI
*This
,
170 OUT VOID
**FspHobList
173 EFI_HOB_GUID_TYPE
*GuidHob
;
175 GuidHob
= GetFirstGuidHob (&gFspHobGuid
);
176 if (GuidHob
!= NULL
) {
177 *FspHobList
= *(VOID
**)GET_GUID_HOB_DATA (GuidHob
);
180 return EFI_NOT_FOUND
;
185 Get the FSP S UPD Data address
187 @return FSP-S UPD Data Address
192 GetFspsUpdDataAddress (
196 if (PcdGet64 (PcdFspsUpdDataAddress64
) != 0) {
197 return (UINTN
) PcdGet64 (PcdFspsUpdDataAddress64
);
199 return (UINTN
) PcdGet32 (PcdFspsUpdDataAddress
);
204 This function is for FSP dispatch mode to perform post FSP-S process.
206 @param[in] PeiServices Pointer to PEI Services Table.
207 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
208 caused this function to execute.
209 @param[in] Ppi Pointer to the PPI data associated with this function.
211 @retval EFI_STATUS Status returned by PeiServicesInstallPpi ()
215 FspsWrapperEndOfPeiNotify (
216 IN EFI_PEI_SERVICES
**PeiServices
,
217 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
224 // This step may include platform specific process in some boot loaders so
225 // aligning the same behavior between API and Dispatch modes.
226 // Note: In Dispatch mode no FspHobList so passing NULL to function and
227 // expecting function will handle it.
229 PostFspsHobProcess (NULL
);
232 // Install FspSiliconInitDonePpi so that any other driver can consume this info.
234 Status
= PeiServicesInstallPpi (&mPeiFspSiliconInitDonePpi
);
235 ASSERT_EFI_ERROR (Status
);
240 EFI_PEI_NOTIFY_DESCRIPTOR mFspsWrapperEndOfPeiNotifyDesc
= {
241 (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
242 &gEfiEndOfPeiSignalPpiGuid
,
243 FspsWrapperEndOfPeiNotify
247 This function is called after PEI core discover memory and finish migration.
249 @param[in] PeiServices Pointer to PEI Services Table.
250 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
251 caused this function to execute.
252 @param[in] Ppi Pointer to the PPI data associated with this function.
254 @retval EFI_STATUS Always return EFI_SUCCESS
258 PeiMemoryDiscoveredNotify (
259 IN EFI_PEI_SERVICES
**PeiServices
,
260 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
264 EFI_PEI_NOTIFY_DESCRIPTOR mPeiMemoryDiscoveredNotifyDesc
= {
265 (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
266 &gEfiPeiMemoryDiscoveredPpiGuid
,
267 PeiMemoryDiscoveredNotify
271 This function is called after PEI core discover memory and finish migration.
273 @param[in] PeiServices Pointer to PEI Services Table.
274 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
275 caused this function to execute.
276 @param[in] Ppi Pointer to the PPI data associated with this function.
278 @retval EFI_STATUS Always return EFI_SUCCESS
282 PeiMemoryDiscoveredNotify (
283 IN EFI_PEI_SERVICES
**PeiServices
,
284 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
288 FSP_INFO_HEADER
*FspsHeaderPtr
;
289 UINT64 TimeStampCounterStart
;
292 EFI_HOB_GUID_TYPE
*GuidHob
;
293 FSPS_UPD_COMMON
*FspsUpdDataPtr
;
296 DEBUG ((DEBUG_INFO
, "PeiMemoryDiscoveredNotify enter\n"));
297 FspsUpdDataPtr
= NULL
;
299 FspsHeaderPtr
= (FSP_INFO_HEADER
*)FspFindFspHeader (PcdGet32 (PcdFspsBaseAddress
));
300 DEBUG ((DEBUG_INFO
, "FspsHeaderPtr - 0x%x\n", FspsHeaderPtr
));
301 if (FspsHeaderPtr
== NULL
) {
302 return EFI_DEVICE_ERROR
;
305 if ((GetFspsUpdDataAddress () == 0) && (FspsHeaderPtr
->CfgRegionSize
!= 0) && (FspsHeaderPtr
->CfgRegionOffset
!= 0)) {
307 // Copy default FSP-S UPD data from Flash
309 FspsUpdDataPtr
= (FSPS_UPD_COMMON
*)AllocateZeroPool ((UINTN
)FspsHeaderPtr
->CfgRegionSize
);
310 ASSERT (FspsUpdDataPtr
!= NULL
);
311 SourceData
= (UINTN
*)((UINTN
)FspsHeaderPtr
->ImageBase
+ (UINTN
)FspsHeaderPtr
->CfgRegionOffset
);
312 CopyMem (FspsUpdDataPtr
, SourceData
, (UINTN
)FspsHeaderPtr
->CfgRegionSize
);
314 FspsUpdDataPtr
= (FSPS_UPD_COMMON
*) GetFspsUpdDataAddress();
315 ASSERT (FspsUpdDataPtr
!= NULL
);
318 UpdateFspsUpdData ((VOID
*)FspsUpdDataPtr
);
320 TimeStampCounterStart
= AsmReadTsc ();
321 PERF_START_EX (&gFspApiPerformanceGuid
, "EventRec", NULL
, 0, FSP_STATUS_CODE_SILICON_INIT
| FSP_STATUS_CODE_COMMON_CODE
| FSP_STATUS_CODE_API_ENTRY
);
322 Status
= CallFspSiliconInit ((VOID
*)FspsUpdDataPtr
);
323 PERF_END_EX (&gFspApiPerformanceGuid
, "EventRec", NULL
, 0, FSP_STATUS_CODE_SILICON_INIT
| FSP_STATUS_CODE_COMMON_CODE
| FSP_STATUS_CODE_API_EXIT
);
324 DEBUG ((DEBUG_INFO
, "Total time spent executing FspSiliconInitApi: %d millisecond\n", DivU64x32 (GetTimeInNanoSecond (AsmReadTsc () - TimeStampCounterStart
), 1000000)));
327 // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status
329 if ((Status
>= FSP_STATUS_RESET_REQUIRED_COLD
) && (Status
<= FSP_STATUS_RESET_REQUIRED_8
)) {
330 DEBUG ((DEBUG_INFO
, "FspSiliconInitApi requested reset 0x%x\n", Status
));
331 CallFspWrapperResetSystem ((UINT32
)Status
);
334 if (EFI_ERROR (Status
)) {
335 DEBUG ((DEBUG_ERROR
, "ERROR - Failed to execute FspSiliconInitApi(), Status = %r\n", Status
));
338 DEBUG ((DEBUG_INFO
, "FspSiliconInit status: 0x%x\n", Status
));
339 ASSERT_EFI_ERROR (Status
);
341 Status
= TestFspSiliconInitApiOutput ((VOID
*)NULL
);
342 if (RETURN_ERROR (Status
)) {
343 DEBUG ((DEBUG_ERROR
, "ERROR - TestFspSiliconInitApiOutput () fail, Status = %r\n", Status
));
347 // Now FspHobList complete, process it
349 GuidHob
= GetFirstGuidHob (&gFspHobGuid
);
350 ASSERT (GuidHob
!= NULL
);
351 FspHobListPtr
= *(VOID
**)GET_GUID_HOB_DATA (GuidHob
);
352 DEBUG ((DEBUG_INFO
, "FspHobListPtr - 0x%x\n", FspHobListPtr
));
353 PostFspsHobProcess (FspHobListPtr
);
356 // Install FspSiliconInitDonePpi so that any other driver can consume this info.
358 Status
= PeiServicesInstallPpi (&mPeiFspSiliconInitDonePpi
);
359 ASSERT_EFI_ERROR (Status
);
365 Do FSP initialization in API mode.
367 @retval EFI_STATUS Always return EFI_SUCCESS
370 FspsWrapperInitApiMode (
375 EFI_BOOT_MODE BootMode
;
378 // Register MemoryDiscovered Notify to run FspSiliconInit
380 Status
= PeiServicesNotifyPpi (&mPeiMemoryDiscoveredNotifyDesc
);
381 ASSERT_EFI_ERROR (Status
);
384 // Register EndOfPei Notify for S3 to run FSP NotifyPhase
386 PeiServicesGetBootMode (&BootMode
);
387 if (BootMode
== BOOT_ON_S3_RESUME
) {
388 Status
= PeiServicesNotifyPpi (&mS3EndOfPeiNotifyDesc
);
389 ASSERT_EFI_ERROR (Status
);
396 Do FSP initialization in Dispatch mode.
398 @retval FSP initialization status.
401 FspsWrapperInitDispatchMode (
406 EFI_PEI_FIRMWARE_VOLUME_INFO_MEASUREMENT_EXCLUDED_PPI
*MeasurementExcludedFvPpi
;
407 EFI_PEI_PPI_DESCRIPTOR
*MeasurementExcludedPpiList
;
409 MeasurementExcludedFvPpi
= AllocatePool (sizeof (*MeasurementExcludedFvPpi
));
410 ASSERT (MeasurementExcludedFvPpi
!= NULL
);
411 MeasurementExcludedFvPpi
->Count
= 1;
412 MeasurementExcludedFvPpi
->Fv
[0].FvBase
= PcdGet32 (PcdFspsBaseAddress
);
413 MeasurementExcludedFvPpi
->Fv
[0].FvLength
= ((EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)PcdGet32 (PcdFspsBaseAddress
))->FvLength
;
415 MeasurementExcludedPpiList
= AllocatePool (sizeof (*MeasurementExcludedPpiList
));
416 ASSERT (MeasurementExcludedPpiList
!= NULL
);
417 MeasurementExcludedPpiList
->Flags
= EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
;
418 MeasurementExcludedPpiList
->Guid
= &gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid
;
419 MeasurementExcludedPpiList
->Ppi
= MeasurementExcludedFvPpi
;
421 Status
= PeiServicesInstallPpi (MeasurementExcludedPpiList
);
422 ASSERT_EFI_ERROR (Status
);
425 // FSP-S Wrapper running in Dispatch mode and reports FSP-S FV to PEI dispatcher.
427 PeiServicesInstallFvInfoPpi (
429 (VOID
*)(UINTN
)PcdGet32 (PcdFspsBaseAddress
),
430 (UINT32
)((EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)PcdGet32 (PcdFspsBaseAddress
))->FvLength
,
435 // Register EndOfPei Nofity to run post FSP-S process.
437 Status
= PeiServicesNotifyPpi (&mFspsWrapperEndOfPeiNotifyDesc
);
438 ASSERT_EFI_ERROR (Status
);
443 This function is called after TCG installed PPI.
445 @param[in] PeiServices Pointer to PEI Services Table.
446 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
447 caused this function to execute.
448 @param[in] Ppi Pointer to the PPI data associated with this function.
450 @retval EFI_STATUS Always return EFI_SUCCESS
455 IN EFI_PEI_SERVICES
**PeiServices
,
456 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
460 EFI_PEI_NOTIFY_DESCRIPTOR mTcgPpiNotifyDesc
= {
461 (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
467 This function is called after TCG installed PPI.
469 @param[in] PeiServices Pointer to PEI Services Table.
470 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that
471 caused this function to execute.
472 @param[in] Ppi Pointer to the PPI data associated with this function.
474 @retval EFI_STATUS Always return EFI_SUCCESS
479 IN EFI_PEI_SERVICES
**PeiServices
,
480 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDesc
,
484 UINT32 FspMeasureMask
;
486 DEBUG ((DEBUG_INFO
, "TcgPpiNotify FSPS\n"));
488 FspMeasureMask
= PcdGet32 (PcdFspMeasurementConfig
);
490 if ((FspMeasureMask
& FSP_MEASURE_FSPS
) != 0) {
491 MeasureFspFirmwareBlob (
494 PcdGet32 (PcdFspsBaseAddress
),
495 (UINT32
)((EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)PcdGet32 (PcdFspsBaseAddress
))->FvLength
503 This is the entrypoint of PEIM.
505 @param[in] FileHandle Handle of the file being invoked.
506 @param[in] PeiServices Describes the list of possible PEI Services.
508 @retval EFI_SUCCESS if it completed successfully.
512 FspsWrapperPeimEntryPoint (
513 IN EFI_PEI_FILE_HANDLE FileHandle
,
514 IN CONST EFI_PEI_SERVICES
**PeiServices
519 DEBUG ((DEBUG_INFO
, "FspsWrapperPeimEntryPoint\n"));
521 Status
= PeiServicesNotifyPpi (&mTcgPpiNotifyDesc
);
522 ASSERT_EFI_ERROR (Status
);
524 if (PcdGet8 (PcdFspModeSelection
) == 1) {
525 FspsWrapperInitApiMode ();
527 FspsWrapperInitDispatchMode ();