]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFsp2WrapperPkg/FspmWrapperPeim/FspmWrapperPeim.c
OvmfPkg: Implement MeasureHobList/MeasureFvImage
[mirror_edk2.git] / IntelFsp2WrapperPkg / FspmWrapperPeim / FspmWrapperPeim.c
CommitLineData
cf1d4549
JY
1/** @file\r
2 This will be invoked only once. It will call FspMemoryInit API,\r
3 register TemporaryRamDonePpi to call TempRamExit API, and register MemoryDiscoveredPpi\r
4 notify to call FspSiliconInit API.\r
5\r
4a6ed7e4 6 Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>\r
512e23a3 7 SPDX-License-Identifier: BSD-2-Clause-Patent\r
cf1d4549
JY
8\r
9**/\r
10\r
cf1d4549
JY
11#include <PiPei.h>\r
12\r
13#include <Library/PeimEntryPoint.h>\r
14#include <Library/PeiServicesLib.h>\r
15#include <Library/PeiServicesTablePointerLib.h>\r
16#include <Library/BaseLib.h>\r
17#include <Library/DebugLib.h>\r
18#include <Library/BaseMemoryLib.h>\r
19#include <Library/MemoryAllocationLib.h>\r
20#include <Library/HobLib.h>\r
21#include <Library/PcdLib.h>\r
22#include <Library/TimerLib.h>\r
23#include <Library/PerformanceLib.h>\r
24#include <Library/FspWrapperPlatformLib.h>\r
25#include <Library/FspWrapperHobProcessLib.h>\r
26#include <Library/FspWrapperApiLib.h>\r
53ea57fe 27#include <Library/FspMeasurementLib.h>\r
cf1d4549
JY
28\r
29#include <Ppi/FspSiliconInitDone.h>\r
30#include <Ppi/EndOfPeiPhase.h>\r
31#include <Ppi/MemoryDiscovered.h>\r
32#include <Ppi/SecPlatformInformation.h>\r
53ea57fe
JY
33#include <Ppi/Tcg.h>\r
34#include <Ppi/FirmwareVolumeInfoMeasurementExcluded.h>\r
cf1d4549
JY
35#include <Library/FspWrapperApiTestLib.h>\r
36#include <FspEas.h>\r
19d29d35 37#include <FspStatusCode.h>\r
cf1d4549 38\r
7c7184e2 39extern EFI_GUID gFspHobGuid;\r
cf1d4549 40\r
de9e5b7d
AA
41/**\r
42 Get the FSP M UPD Data address\r
43\r
44 @return FSP-M UPD Data Address\r
45**/\r
46\r
47UINTN\r
de9e5b7d
AA
48GetFspmUpdDataAddress (\r
49 VOID\r
50 )\r
51{\r
52 if (PcdGet64 (PcdFspmUpdDataAddress64) != 0) {\r
53 return (UINTN) PcdGet64 (PcdFspmUpdDataAddress64);\r
54 } else {\r
55 return (UINTN) PcdGet32 (PcdFspmUpdDataAddress);\r
56 }\r
57}\r
58\r
cf1d4549
JY
59/**\r
60 Call FspMemoryInit API.\r
61\r
62 @return Status returned by FspMemoryInit API.\r
63**/\r
64EFI_STATUS\r
65PeiFspMemoryInit (\r
66 VOID\r
67 )\r
68{\r
7c7184e2
MK
69 FSP_INFO_HEADER *FspmHeaderPtr;\r
70 EFI_STATUS Status;\r
71 UINT64 TimeStampCounterStart;\r
72 VOID *FspHobListPtr;\r
73 VOID *HobData;\r
4a6ed7e4 74 VOID *FspmUpdDataPtr;\r
7c7184e2 75 UINTN *SourceData;\r
cf1d4549
JY
76\r
77 DEBUG ((DEBUG_INFO, "PeiFspMemoryInit enter\n"));\r
78\r
7c7184e2 79 FspHobListPtr = NULL;\r
e69dcef5 80 FspmUpdDataPtr = NULL;\r
cf1d4549 81\r
7c7184e2 82 FspmHeaderPtr = (FSP_INFO_HEADER *)FspFindFspHeader (PcdGet32 (PcdFspmBaseAddress));\r
599c45ff
HW
83 DEBUG ((DEBUG_INFO, "FspmHeaderPtr - 0x%x\n", FspmHeaderPtr));\r
84 if (FspmHeaderPtr == NULL) {\r
85 return EFI_DEVICE_ERROR;\r
86 }\r
87\r
de9e5b7d 88 if ((GetFspmUpdDataAddress () == 0) && (FspmHeaderPtr->CfgRegionSize != 0) && (FspmHeaderPtr->CfgRegionOffset != 0)) {\r
e69dcef5
CC
89 //\r
90 // Copy default FSP-M UPD data from Flash\r
91 //\r
4a6ed7e4 92 FspmUpdDataPtr = AllocateZeroPool ((UINTN)FspmHeaderPtr->CfgRegionSize);\r
e69dcef5
CC
93 ASSERT (FspmUpdDataPtr != NULL);\r
94 SourceData = (UINTN *)((UINTN)FspmHeaderPtr->ImageBase + (UINTN)FspmHeaderPtr->CfgRegionOffset);\r
95 CopyMem (FspmUpdDataPtr, SourceData, (UINTN)FspmHeaderPtr->CfgRegionSize);\r
96 } else {\r
97 //\r
98 // External UPD is ready, get the buffer from PCD pointer.\r
99 //\r
4a6ed7e4 100 FspmUpdDataPtr = (VOID *) GetFspmUpdDataAddress();\r
e69dcef5
CC
101 ASSERT (FspmUpdDataPtr != NULL);\r
102 }\r
cf1d4549 103\r
1f1ec99d 104 DEBUG ((DEBUG_INFO, "UpdateFspmUpdData enter\n"));\r
4a6ed7e4
TK
105 UpdateFspmUpdData (FspmUpdDataPtr);\r
106 if (((FSPM_UPD_COMMON *)FspmUpdDataPtr)->FspmArchUpd.Revision >= 3) {\r
107 DEBUG ((DEBUG_INFO, " StackBase - 0x%lx\n", ((FSPM_UPD_COMMON_FSP24 *)FspmUpdDataPtr)->FspmArchUpd.StackBase));\r
108 DEBUG ((DEBUG_INFO, " StackSize - 0x%lx\n", ((FSPM_UPD_COMMON_FSP24 *)FspmUpdDataPtr)->FspmArchUpd.StackSize));\r
109 DEBUG ((DEBUG_INFO, " BootLoaderTolumSize - 0x%x\n", ((FSPM_UPD_COMMON_FSP24 *)FspmUpdDataPtr)->FspmArchUpd.BootLoaderTolumSize));\r
110 DEBUG ((DEBUG_INFO, " BootMode - 0x%x\n", ((FSPM_UPD_COMMON_FSP24 *)FspmUpdDataPtr)->FspmArchUpd.BootMode));\r
111 } else {\r
112 DEBUG ((DEBUG_INFO, " NvsBufferPtr - 0x%x\n", ((FSPM_UPD_COMMON *)FspmUpdDataPtr)->FspmArchUpd.NvsBufferPtr));\r
113 DEBUG ((DEBUG_INFO, " StackBase - 0x%x\n", ((FSPM_UPD_COMMON *)FspmUpdDataPtr)->FspmArchUpd.StackBase));\r
114 DEBUG ((DEBUG_INFO, " StackSize - 0x%x\n", ((FSPM_UPD_COMMON *)FspmUpdDataPtr)->FspmArchUpd.StackSize));\r
115 DEBUG ((DEBUG_INFO, " BootLoaderTolumSize - 0x%x\n", ((FSPM_UPD_COMMON *)FspmUpdDataPtr)->FspmArchUpd.BootLoaderTolumSize));\r
116 DEBUG ((DEBUG_INFO, " BootMode - 0x%x\n", ((FSPM_UPD_COMMON *)FspmUpdDataPtr)->FspmArchUpd.BootMode));\r
117 }\r
cf1d4549
JY
118 DEBUG ((DEBUG_INFO, " HobListPtr - 0x%x\n", &FspHobListPtr));\r
119\r
120 TimeStampCounterStart = AsmReadTsc ();\r
7c7184e2 121 Status = CallFspMemoryInit (FspmUpdDataPtr, &FspHobListPtr);\r
cf1d4549 122 // Create hobs after memory initialization and not in temp RAM. Hence passing the recorded timestamp here\r
7c7184e2
MK
123 PERF_START_EX (&gFspApiPerformanceGuid, "EventRec", NULL, TimeStampCounterStart, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_ENTRY);\r
124 PERF_END_EX (&gFspApiPerformanceGuid, "EventRec", NULL, 0, FSP_STATUS_CODE_MEMORY_INIT | FSP_STATUS_CODE_COMMON_CODE | FSP_STATUS_CODE_API_EXIT);\r
cf1d4549 125 DEBUG ((DEBUG_INFO, "Total time spent executing FspMemoryInitApi: %d millisecond\n", DivU64x32 (GetTimeInNanoSecond (AsmReadTsc () - TimeStampCounterStart), 1000000)));\r
f862a3b6
JY
126\r
127 //\r
128 // Reset the system if FSP API returned FSP_STATUS_RESET_REQUIRED status\r
129 //\r
130 if ((Status >= FSP_STATUS_RESET_REQUIRED_COLD) && (Status <= FSP_STATUS_RESET_REQUIRED_8)) {\r
7c7184e2 131 DEBUG ((DEBUG_INFO, "FspMemoryInitApi requested reset 0x%x\n", Status));\r
f862a3b6
JY
132 CallFspWrapperResetSystem ((UINT32)Status);\r
133 }\r
134\r
7c7184e2 135 if (EFI_ERROR (Status)) {\r
cf1d4549
JY
136 DEBUG ((DEBUG_ERROR, "ERROR - Failed to execute FspMemoryInitApi(), Status = %r\n", Status));\r
137 }\r
cf1d4549 138\r
7c7184e2
MK
139 DEBUG ((DEBUG_INFO, "FspMemoryInit status: 0x%x\n", Status));\r
140 ASSERT_EFI_ERROR (Status);\r
cf1d4549
JY
141\r
142 Status = TestFspMemoryInitApiOutput (FspmUpdDataPtr, &FspHobListPtr);\r
143 if (EFI_ERROR (Status)) {\r
144 DEBUG ((DEBUG_ERROR, "ERROR - TestFspMemoryInitApiOutput () fail, Status = %r\n", Status));\r
145 }\r
146\r
147 DEBUG ((DEBUG_INFO, " FspHobListPtr (returned) - 0x%x\n", FspHobListPtr));\r
148 ASSERT (FspHobListPtr != NULL);\r
149\r
150 PostFspmHobProcess (FspHobListPtr);\r
151\r
152 //\r
153 // FspHobList is not complete at this moment.\r
154 // Save FspHobList pointer to hob, so that it can be got later\r
155 //\r
156 HobData = BuildGuidHob (\r
7c7184e2
MK
157 &gFspHobGuid,\r
158 sizeof (VOID *)\r
159 );\r
cf1d4549
JY
160 ASSERT (HobData != NULL);\r
161 CopyMem (HobData, &FspHobListPtr, sizeof (FspHobListPtr));\r
162\r
163 return Status;\r
164}\r
165\r
166/**\r
167 Do FSP initialization.\r
168\r
169 @return FSP initialization status.\r
170**/\r
171EFI_STATUS\r
172EFIAPI\r
173FspmWrapperInit (\r
174 VOID\r
175 )\r
176{\r
7c7184e2
MK
177 EFI_STATUS Status;\r
178 EFI_PEI_FIRMWARE_VOLUME_INFO_MEASUREMENT_EXCLUDED_PPI *MeasurementExcludedFvPpi;\r
179 EFI_PEI_PPI_DESCRIPTOR *MeasurementExcludedPpiList;\r
180\r
181 MeasurementExcludedFvPpi = AllocatePool (sizeof (*MeasurementExcludedFvPpi));\r
182 ASSERT (MeasurementExcludedFvPpi != NULL);\r
183 MeasurementExcludedFvPpi->Count = 1;\r
184 MeasurementExcludedFvPpi->Fv[0].FvBase = PcdGet32 (PcdFspmBaseAddress);\r
185 MeasurementExcludedFvPpi->Fv[0].FvLength = ((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFspmBaseAddress))->FvLength;\r
186\r
187 MeasurementExcludedPpiList = AllocatePool (sizeof (*MeasurementExcludedPpiList));\r
188 ASSERT (MeasurementExcludedPpiList != NULL);\r
53ea57fe
JY
189 MeasurementExcludedPpiList->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
190 MeasurementExcludedPpiList->Guid = &gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid;\r
191 MeasurementExcludedPpiList->Ppi = MeasurementExcludedFvPpi;\r
cf1d4549 192\r
2098de62
CC
193 Status = EFI_SUCCESS;\r
194\r
e8f40b77 195 if (PcdGet8 (PcdFspModeSelection) == 1) {\r
2098de62
CC
196 Status = PeiFspMemoryInit ();\r
197 ASSERT_EFI_ERROR (Status);\r
198 } else {\r
53ea57fe
JY
199 Status = PeiServicesInstallPpi (MeasurementExcludedPpiList);\r
200 ASSERT_EFI_ERROR (Status);\r
201\r
2098de62
CC
202 PeiServicesInstallFvInfoPpi (\r
203 NULL,\r
7c7184e2
MK
204 (VOID *)(UINTN)PcdGet32 (PcdFspmBaseAddress),\r
205 (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFspmBaseAddress))->FvLength,\r
2098de62
CC
206 NULL,\r
207 NULL\r
208 );\r
209 }\r
cf1d4549
JY
210\r
211 return Status;\r
212}\r
213\r
53ea57fe
JY
214/**\r
215 This function is called after TCG installed PPI.\r
216\r
217 @param[in] PeiServices Pointer to PEI Services Table.\r
218 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that\r
219 caused this function to execute.\r
220 @param[in] Ppi Pointer to the PPI data associated with this function.\r
221\r
222 @retval EFI_STATUS Always return EFI_SUCCESS\r
223**/\r
224EFI_STATUS\r
225EFIAPI\r
226TcgPpiNotify (\r
7c7184e2
MK
227 IN EFI_PEI_SERVICES **PeiServices,\r
228 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
229 IN VOID *Ppi\r
53ea57fe
JY
230 );\r
231\r
7c7184e2 232EFI_PEI_NOTIFY_DESCRIPTOR mTcgPpiNotifyDesc = {\r
53ea57fe
JY
233 (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
234 &gEdkiiTcgPpiGuid,\r
235 TcgPpiNotify\r
236};\r
237\r
238/**\r
239 This function is called after TCG installed PPI.\r
240\r
241 @param[in] PeiServices Pointer to PEI Services Table.\r
242 @param[in] NotifyDesc Pointer to the descriptor for the Notification event that\r
243 caused this function to execute.\r
244 @param[in] Ppi Pointer to the PPI data associated with this function.\r
245\r
246 @retval EFI_STATUS Always return EFI_SUCCESS\r
247**/\r
248EFI_STATUS\r
249EFIAPI\r
250TcgPpiNotify (\r
7c7184e2
MK
251 IN EFI_PEI_SERVICES **PeiServices,\r
252 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDesc,\r
253 IN VOID *Ppi\r
53ea57fe
JY
254 )\r
255{\r
7c7184e2 256 UINT32 FspMeasureMask;\r
53ea57fe
JY
257\r
258 DEBUG ((DEBUG_INFO, "TcgPpiNotify FSPM\n"));\r
259\r
260 FspMeasureMask = PcdGet32 (PcdFspMeasurementConfig);\r
261\r
262 if ((FspMeasureMask & FSP_MEASURE_FSPT) != 0) {\r
7c7184e2
MK
263 MeasureFspFirmwareBlob (\r
264 0,\r
265 "FSPT",\r
266 PcdGet32 (PcdFsptBaseAddress),\r
267 (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFsptBaseAddress))->FvLength\r
268 );\r
53ea57fe
JY
269 }\r
270\r
271 if ((FspMeasureMask & FSP_MEASURE_FSPM) != 0) {\r
7c7184e2
MK
272 MeasureFspFirmwareBlob (\r
273 0,\r
274 "FSPM",\r
275 PcdGet32 (PcdFspmBaseAddress),\r
276 (UINT32)((EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)PcdGet32 (PcdFspmBaseAddress))->FvLength\r
277 );\r
53ea57fe
JY
278 }\r
279\r
280 return EFI_SUCCESS;\r
281}\r
282\r
cf1d4549
JY
283/**\r
284 This is the entrypoint of PEIM\r
285\r
286 @param[in] FileHandle Handle of the file being invoked.\r
287 @param[in] PeiServices Describes the list of possible PEI Services.\r
288\r
289 @retval EFI_SUCCESS if it completed successfully.\r
290**/\r
291EFI_STATUS\r
292EFIAPI\r
293FspmWrapperPeimEntryPoint (\r
294 IN EFI_PEI_FILE_HANDLE FileHandle,\r
295 IN CONST EFI_PEI_SERVICES **PeiServices\r
296 )\r
297{\r
53ea57fe
JY
298 EFI_STATUS Status;\r
299\r
7c7184e2 300 DEBUG ((DEBUG_INFO, "FspmWrapperPeimEntryPoint\n"));\r
cf1d4549 301\r
53ea57fe
JY
302 Status = PeiServicesNotifyPpi (&mTcgPpiNotifyDesc);\r
303 ASSERT_EFI_ERROR (Status);\r
304\r
cf1d4549
JY
305 FspmWrapperInit ();\r
306\r
307 return EFI_SUCCESS;\r
308}\r