]>
Commit | Line | Data |
---|---|---|
0284e90c LG |
1 | /** @file\r |
2 | This module install ACPI Firmware Performance Data Table (FPDT).\r | |
3 | \r | |
4 | This module register report status code listener to collect performance data\r | |
d1102dba | 5 | for Firmware Basic Boot Performance Record and other boot performance records,\r |
1c0cc375 | 6 | and install FPDT to ACPI table.\r |
0284e90c | 7 | \r |
466ebdd2 | 8 | Copyright (c) 2011 - 2021, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 9 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
0284e90c LG |
10 | \r |
11 | **/\r | |
12 | \r | |
13 | #include <PiDxe.h>\r | |
14 | \r | |
0284e90c LG |
15 | #include <Protocol/ReportStatusCodeHandler.h>\r |
16 | #include <Protocol/AcpiTable.h>\r | |
db91c620 SZ |
17 | #include <Protocol/LockBox.h>\r |
18 | #include <Protocol/Variable.h>\r | |
466ebdd2 | 19 | #include <Protocol/VariablePolicy.h>\r |
0284e90c LG |
20 | \r |
21 | #include <Guid/Acpi.h>\r | |
22 | #include <Guid/FirmwarePerformance.h>\r | |
0284e90c LG |
23 | \r |
24 | #include <Library/UefiBootServicesTableLib.h>\r | |
25 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
26 | #include <Library/BaseLib.h>\r | |
27 | #include <Library/DebugLib.h>\r | |
65e984cd | 28 | #include <Library/DxeServicesLib.h>\r |
0284e90c LG |
29 | #include <Library/TimerLib.h>\r |
30 | #include <Library/BaseMemoryLib.h>\r | |
31 | #include <Library/MemoryAllocationLib.h>\r | |
32 | #include <Library/PcdLib.h>\r | |
33 | #include <Library/HobLib.h>\r | |
db91c620 SZ |
34 | #include <Library/LockBoxLib.h>\r |
35 | #include <Library/UefiLib.h>\r | |
466ebdd2 DB |
36 | #include <Library/VariablePolicyHelperLib.h>\r |
37 | #include <Library/PerformanceLib.h>\r | |
0284e90c | 38 | \r |
1436aea4 | 39 | #define SMM_BOOT_RECORD_COMM_SIZE (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data) + sizeof(SMM_BOOT_RECORD_COMMUNICATE))\r |
0284e90c | 40 | \r |
1436aea4 | 41 | EFI_RSC_HANDLER_PROTOCOL *mRscHandlerProtocol = NULL;\r |
0284e90c | 42 | \r |
1436aea4 MK |
43 | BOOLEAN mLockBoxReady = FALSE;\r |
44 | EFI_EVENT mReadyToBootEvent;\r | |
45 | EFI_EVENT mLegacyBootEvent;\r | |
46 | static EFI_EVENT mExitBootServicesEvent;\r | |
47 | UINTN mFirmwarePerformanceTableTemplateKey = 0;\r | |
48 | BOOLEAN mDxeCoreReportStatusCodeEnable = FALSE;\r | |
0284e90c | 49 | \r |
1436aea4 MK |
50 | BOOT_PERFORMANCE_TABLE *mAcpiBootPerformanceTable = NULL;\r |
51 | BOOT_PERFORMANCE_TABLE *mReceivedAcpiBootPerformanceTable = NULL;\r | |
52 | S3_PERFORMANCE_TABLE *mAcpiS3PerformanceTable = NULL;\r | |
0284e90c LG |
53 | \r |
54 | FIRMWARE_PERFORMANCE_TABLE mFirmwarePerformanceTableTemplate = {\r | |
55 | {\r | |
56 | EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_DATA_TABLE_SIGNATURE,\r | |
57 | sizeof (FIRMWARE_PERFORMANCE_TABLE),\r | |
1436aea4 MK |
58 | EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION, // Revision\r |
59 | 0x00, // Checksum will be updated at runtime\r | |
0284e90c | 60 | //\r |
e84f07b5 | 61 | // It is expected that these values will be updated at EntryPoint.\r |
0284e90c | 62 | //\r |
1436aea4 | 63 | { 0x00 }, // OEM ID is a 6 bytes long field\r |
e84f07b5 SZ |
64 | 0x00, // OEM Table ID(8 bytes long)\r |
65 | 0x00, // OEM Revision\r | |
66 | 0x00, // Creator ID\r | |
67 | 0x00, // Creator Revision\r | |
0284e90c LG |
68 | },\r |
69 | //\r | |
70 | // Firmware Basic Boot Performance Table Pointer Record.\r | |
71 | //\r | |
72 | {\r | |
73 | {\r | |
1436aea4 | 74 | EFI_ACPI_5_0_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER, // Type\r |
0284e90c LG |
75 | sizeof (EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD), // Length\r |
76 | EFI_ACPI_5_0_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER // Revision\r | |
77 | },\r | |
78 | 0, // Reserved\r | |
79 | 0 // BootPerformanceTablePointer will be updated at runtime.\r | |
80 | },\r | |
81 | //\r | |
82 | // S3 Performance Table Pointer Record.\r | |
83 | //\r | |
84 | {\r | |
85 | {\r | |
86 | EFI_ACPI_5_0_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER, // Type\r | |
87 | sizeof (EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD), // Length\r | |
88 | EFI_ACPI_5_0_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER // Revision\r | |
89 | },\r | |
90 | 0, // Reserved\r | |
91 | 0 // S3PerformanceTablePointer will be updated at runtime.\r | |
92 | }\r | |
93 | };\r | |
94 | \r | |
1436aea4 | 95 | BOOT_PERFORMANCE_TABLE mBootPerformanceTableTemplate = {\r |
0284e90c LG |
96 | {\r |
97 | EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_SIGNATURE,\r | |
98 | sizeof (BOOT_PERFORMANCE_TABLE)\r | |
99 | },\r | |
100 | {\r | |
101 | {\r | |
102 | EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT, // Type\r | |
103 | sizeof (EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD), // Length\r | |
104 | EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_REVISION_FIRMWARE_BASIC_BOOT // Revision\r | |
105 | },\r | |
106 | 0, // Reserved\r | |
107 | //\r | |
108 | // These values will be updated at runtime.\r | |
109 | //\r | |
110 | 0, // ResetEnd\r | |
111 | 0, // OsLoaderLoadImageStart\r | |
112 | 0, // OsLoaderStartImageStart\r | |
113 | 0, // ExitBootServicesEntry\r | |
114 | 0 // ExitBootServicesExit\r | |
115 | }\r | |
116 | };\r | |
117 | \r | |
1436aea4 | 118 | S3_PERFORMANCE_TABLE mS3PerformanceTableTemplate = {\r |
0284e90c LG |
119 | {\r |
120 | EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_SIGNATURE,\r | |
121 | sizeof (S3_PERFORMANCE_TABLE)\r | |
122 | },\r | |
123 | {\r | |
124 | {\r | |
125 | EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME, // Type\r | |
126 | sizeof (EFI_ACPI_5_0_FPDT_S3_RESUME_RECORD), // Length\r | |
127 | EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_REVISION_S3_RESUME // Revision\r | |
128 | },\r | |
129 | //\r | |
130 | // These values will be updated by Firmware Performance PEIM.\r | |
131 | //\r | |
132 | 0, // ResumeCount\r | |
133 | 0, // FullResume\r | |
134 | 0 // AverageResume\r | |
135 | },\r | |
136 | {\r | |
137 | {\r | |
138 | EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND, // Type\r | |
139 | sizeof (EFI_ACPI_5_0_FPDT_S3_SUSPEND_RECORD), // Length\r | |
140 | EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_REVISION_S3_SUSPEND // Revision\r | |
141 | },\r | |
142 | //\r | |
143 | // These values will be updated bye Firmware Performance SMM driver.\r | |
144 | //\r | |
145 | 0, // SuspendStart\r | |
146 | 0 // SuspendEnd\r | |
147 | }\r | |
148 | };\r | |
149 | \r | |
150 | /**\r | |
151 | This function calculates and updates an UINT8 checksum.\r | |
152 | \r | |
153 | @param[in] Buffer Pointer to buffer to checksum\r | |
154 | @param[in] Size Number of bytes to checksum\r | |
155 | \r | |
156 | **/\r | |
157 | VOID\r | |
158 | FpdtAcpiTableChecksum (\r | |
1436aea4 MK |
159 | IN UINT8 *Buffer,\r |
160 | IN UINTN Size\r | |
0284e90c LG |
161 | )\r |
162 | {\r | |
1436aea4 | 163 | UINTN ChecksumOffset;\r |
0284e90c LG |
164 | \r |
165 | ChecksumOffset = OFFSET_OF (EFI_ACPI_DESCRIPTION_HEADER, Checksum);\r | |
166 | \r | |
167 | //\r | |
168 | // Set checksum to 0 first.\r | |
169 | //\r | |
170 | Buffer[ChecksumOffset] = 0;\r | |
171 | \r | |
172 | //\r | |
173 | // Update checksum value.\r | |
174 | //\r | |
175 | Buffer[ChecksumOffset] = CalculateCheckSum8 (Buffer, Size);\r | |
176 | }\r | |
177 | \r | |
db91c620 SZ |
178 | /**\r |
179 | Callback function upon VariableArchProtocol and LockBoxProtocol\r | |
180 | to allocate S3 performance table memory and save the pointer to LockBox.\r | |
181 | \r | |
182 | @param[in] Event Event whose notification function is being invoked.\r | |
183 | @param[in] Context Pointer to the notification function's context.\r | |
184 | **/\r | |
185 | VOID\r | |
186 | EFIAPI\r | |
187 | FpdtAllocateS3PerformanceTableMemory (\r | |
1436aea4 MK |
188 | IN EFI_EVENT Event,\r |
189 | IN VOID *Context\r | |
db91c620 SZ |
190 | )\r |
191 | {\r | |
1436aea4 MK |
192 | EFI_STATUS Status;\r |
193 | VOID *Interface;\r | |
194 | FIRMWARE_PERFORMANCE_VARIABLE PerformanceVariable;\r | |
195 | UINTN Size;\r | |
196 | EFI_PHYSICAL_ADDRESS S3PerformanceTablePointer;\r | |
db91c620 SZ |
197 | \r |
198 | if (mLockBoxReady && (mAcpiS3PerformanceTable != NULL)) {\r | |
199 | //\r | |
200 | // The memory for S3 performance table should have been ready,\r | |
201 | // and the pointer should have been saved to LockBox, just return.\r | |
202 | //\r | |
203 | return;\r | |
204 | }\r | |
205 | \r | |
206 | if (!mLockBoxReady) {\r | |
207 | Status = gBS->LocateProtocol (&gEfiLockBoxProtocolGuid, NULL, &Interface);\r | |
208 | if (!EFI_ERROR (Status)) {\r | |
209 | //\r | |
210 | // LockBox services has been ready.\r | |
211 | //\r | |
212 | mLockBoxReady = TRUE;\r | |
213 | }\r | |
214 | }\r | |
215 | \r | |
216 | if (mAcpiS3PerformanceTable == NULL) {\r | |
217 | Status = gBS->LocateProtocol (&gEfiVariableArchProtocolGuid, NULL, &Interface);\r | |
218 | if (!EFI_ERROR (Status)) {\r | |
219 | //\r | |
220 | // Try to allocate the same runtime buffer as last time boot.\r | |
221 | //\r | |
222 | ZeroMem (&PerformanceVariable, sizeof (PerformanceVariable));\r | |
1436aea4 | 223 | Size = sizeof (PerformanceVariable);\r |
db91c620 SZ |
224 | Status = gRT->GetVariable (\r |
225 | EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME,\r | |
226 | &gEfiFirmwarePerformanceGuid,\r | |
227 | NULL,\r | |
228 | &Size,\r | |
229 | &PerformanceVariable\r | |
230 | );\r | |
231 | if (!EFI_ERROR (Status)) {\r | |
232 | Status = gBS->AllocatePages (\r | |
233 | AllocateAddress,\r | |
234 | EfiReservedMemoryType,\r | |
235 | EFI_SIZE_TO_PAGES (sizeof (S3_PERFORMANCE_TABLE)),\r | |
236 | &PerformanceVariable.S3PerformanceTablePointer\r | |
237 | );\r | |
238 | if (!EFI_ERROR (Status)) {\r | |
1436aea4 | 239 | mAcpiS3PerformanceTable = (S3_PERFORMANCE_TABLE *)(UINTN)PerformanceVariable.S3PerformanceTablePointer;\r |
db91c620 SZ |
240 | }\r |
241 | }\r | |
1436aea4 | 242 | \r |
db91c620 SZ |
243 | if (mAcpiS3PerformanceTable == NULL) {\r |
244 | //\r | |
245 | // Fail to allocate at specified address, continue to allocate at any address.\r | |
246 | //\r | |
1436aea4 MK |
247 | mAcpiS3PerformanceTable = (S3_PERFORMANCE_TABLE *)AllocatePeiAccessiblePages (\r |
248 | EfiReservedMemoryType,\r | |
249 | EFI_SIZE_TO_PAGES (sizeof (S3_PERFORMANCE_TABLE))\r | |
250 | );\r | |
db91c620 | 251 | }\r |
1436aea4 | 252 | \r |
87000d77 | 253 | DEBUG ((DEBUG_INFO, "FPDT: ACPI S3 Performance Table address = 0x%x\n", mAcpiS3PerformanceTable));\r |
db91c620 SZ |
254 | if (mAcpiS3PerformanceTable != NULL) {\r |
255 | CopyMem (mAcpiS3PerformanceTable, &mS3PerformanceTableTemplate, sizeof (mS3PerformanceTableTemplate));\r | |
256 | }\r | |
257 | }\r | |
258 | }\r | |
259 | \r | |
260 | if (mLockBoxReady && (mAcpiS3PerformanceTable != NULL)) {\r | |
261 | //\r | |
262 | // If LockBox services has been ready and memory for FPDT S3 performance table has been allocated,\r | |
263 | // save the pointer to LockBox for use in S3 resume.\r | |
264 | //\r | |
1436aea4 MK |
265 | S3PerformanceTablePointer = (EFI_PHYSICAL_ADDRESS)(UINTN)mAcpiS3PerformanceTable;\r |
266 | Status = SaveLockBox (\r | |
267 | &gFirmwarePerformanceS3PointerGuid,\r | |
268 | &S3PerformanceTablePointer,\r | |
269 | sizeof (EFI_PHYSICAL_ADDRESS)\r | |
270 | );\r | |
db91c620 SZ |
271 | ASSERT_EFI_ERROR (Status);\r |
272 | }\r | |
273 | }\r | |
274 | \r | |
0284e90c LG |
275 | /**\r |
276 | Install ACPI Firmware Performance Data Table (FPDT).\r | |
277 | \r | |
278 | @return Status code.\r | |
279 | \r | |
280 | **/\r | |
281 | EFI_STATUS\r | |
282 | InstallFirmwarePerformanceDataTable (\r | |
283 | VOID\r | |
284 | )\r | |
285 | {\r | |
466ebdd2 DB |
286 | EFI_STATUS Status;\r |
287 | EFI_ACPI_TABLE_PROTOCOL *AcpiTableProtocol;\r | |
288 | UINTN BootPerformanceDataSize;\r | |
289 | FIRMWARE_PERFORMANCE_VARIABLE PerformanceVariable;\r | |
290 | UINTN Size;\r | |
291 | EDKII_VARIABLE_POLICY_PROTOCOL *VariablePolicyProtocol;\r | |
0284e90c LG |
292 | \r |
293 | //\r | |
294 | // Get AcpiTable Protocol.\r | |
295 | //\r | |
1436aea4 | 296 | Status = gBS->LocateProtocol (&gEfiAcpiTableProtocolGuid, NULL, (VOID **)&AcpiTableProtocol);\r |
0284e90c LG |
297 | if (EFI_ERROR (Status)) {\r |
298 | return Status;\r | |
299 | }\r | |
300 | \r | |
466ebdd2 DB |
301 | //\r |
302 | // Get VariablePolicy Protocol.\r | |
303 | //\r | |
1436aea4 | 304 | Status = gBS->LocateProtocol (&gEdkiiVariablePolicyProtocolGuid, NULL, (VOID **)&VariablePolicyProtocol);\r |
466ebdd2 DB |
305 | if (EFI_ERROR (Status)) {\r |
306 | return Status;\r | |
307 | }\r | |
308 | \r | |
9e62c230 | 309 | if (mReceivedAcpiBootPerformanceTable != NULL) {\r |
1436aea4 | 310 | mAcpiBootPerformanceTable = mReceivedAcpiBootPerformanceTable;\r |
9e62c230 DB |
311 | mAcpiBootPerformanceTable->BasicBoot.ResetEnd = mBootPerformanceTableTemplate.BasicBoot.ResetEnd;\r |
312 | } else {\r | |
1c0cc375 | 313 | //\r |
9e62c230 DB |
314 | // Try to allocate the same runtime buffer as last time boot.\r |
315 | //\r | |
316 | BootPerformanceDataSize = sizeof (BOOT_PERFORMANCE_TABLE);\r | |
317 | ZeroMem (&PerformanceVariable, sizeof (PerformanceVariable));\r | |
1436aea4 | 318 | Size = sizeof (PerformanceVariable);\r |
9e62c230 DB |
319 | Status = gRT->GetVariable (\r |
320 | EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME,\r | |
321 | &gEfiFirmwarePerformanceGuid,\r | |
322 | NULL,\r | |
323 | &Size,\r | |
324 | &PerformanceVariable\r | |
325 | );\r | |
d158ba67 | 326 | if (!EFI_ERROR (Status)) {\r |
9e62c230 DB |
327 | Status = gBS->AllocatePages (\r |
328 | AllocateAddress,\r | |
329 | EfiReservedMemoryType,\r | |
330 | EFI_SIZE_TO_PAGES (BootPerformanceDataSize),\r | |
331 | &PerformanceVariable.BootPerformanceTablePointer\r | |
332 | );\r | |
333 | if (!EFI_ERROR (Status)) {\r | |
1436aea4 | 334 | mAcpiBootPerformanceTable = (BOOT_PERFORMANCE_TABLE *)(UINTN)PerformanceVariable.BootPerformanceTablePointer;\r |
d158ba67 | 335 | }\r |
9e62c230 | 336 | }\r |
1436aea4 | 337 | \r |
9e62c230 | 338 | if (mAcpiBootPerformanceTable == NULL) {\r |
1c0cc375 | 339 | //\r |
9e62c230 | 340 | // Fail to allocate at specified address, continue to allocate at any address.\r |
1c0cc375 | 341 | //\r |
1436aea4 MK |
342 | mAcpiBootPerformanceTable = (BOOT_PERFORMANCE_TABLE *)AllocatePeiAccessiblePages (\r |
343 | EfiReservedMemoryType,\r | |
344 | EFI_SIZE_TO_PAGES (BootPerformanceDataSize)\r | |
345 | );\r | |
1c0cc375 | 346 | }\r |
1436aea4 | 347 | \r |
9e62c230 DB |
348 | DEBUG ((DEBUG_INFO, "FPDT: ACPI Boot Performance Table address = 0x%x\n", mAcpiBootPerformanceTable));\r |
349 | if (mAcpiBootPerformanceTable == NULL) {\r | |
350 | return EFI_OUT_OF_RESOURCES;\r | |
db91c620 | 351 | }\r |
1436aea4 | 352 | \r |
1c0cc375 | 353 | //\r |
9e62c230 | 354 | // Fill Basic Boot record to Boot Performance Table.\r |
1c0cc375 | 355 | //\r |
9e62c230 | 356 | CopyMem (mAcpiBootPerformanceTable, &mBootPerformanceTableTemplate, sizeof (mBootPerformanceTableTemplate));\r |
9cf37b40 | 357 | }\r |
1436aea4 MK |
358 | \r |
359 | BootPerformanceDataSize = mAcpiBootPerformanceTable->Header.Length;\r | |
9cf37b40 | 360 | \r |
1c0cc375 | 361 | //\r |
1c0cc375 LG |
362 | // Save Boot Performance Table address to Variable for use in S4 resume.\r |
363 | //\r | |
1436aea4 | 364 | PerformanceVariable.BootPerformanceTablePointer = (EFI_PHYSICAL_ADDRESS)(UINTN)mAcpiBootPerformanceTable;\r |
1c0cc375 LG |
365 | //\r |
366 | // Update Boot Performance Table Pointer in template.\r | |
367 | //\r | |
1436aea4 | 368 | mFirmwarePerformanceTableTemplate.BootPointerRecord.BootPerformanceTablePointer = (UINT64)(UINTN)mAcpiBootPerformanceTable;\r |
1c0cc375 | 369 | \r |
db91c620 SZ |
370 | //\r |
371 | // Save S3 Performance Table address to Variable for use in S4 resume.\r | |
372 | //\r | |
1436aea4 | 373 | PerformanceVariable.S3PerformanceTablePointer = (EFI_PHYSICAL_ADDRESS)(UINTN)mAcpiS3PerformanceTable;\r |
db91c620 SZ |
374 | //\r |
375 | // Update S3 Performance Table Pointer in template.\r | |
376 | //\r | |
1436aea4 | 377 | mFirmwarePerformanceTableTemplate.S3PointerRecord.S3PerformanceTablePointer = (UINT64)(UINTN)mAcpiS3PerformanceTable;\r |
0284e90c LG |
378 | //\r |
379 | // Save Runtime Performance Table pointers to Variable.\r | |
9e62c230 | 380 | // Don't check SetVariable return status. It doesn't impact FPDT table generation.\r |
fd704cbd LG |
381 | //\r |
382 | gRT->SetVariable (\r | |
1436aea4 MK |
383 | EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME,\r |
384 | &gEfiFirmwarePerformanceGuid,\r | |
385 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
386 | sizeof (PerformanceVariable),\r | |
387 | &PerformanceVariable\r | |
388 | );\r | |
0284e90c | 389 | \r |
466ebdd2 DB |
390 | //\r |
391 | // Lock the variable which stores the Performance Table pointers.\r | |
392 | //\r | |
393 | Status = RegisterBasicVariablePolicy (\r | |
394 | VariablePolicyProtocol,\r | |
395 | &gEfiFirmwarePerformanceGuid,\r | |
396 | EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME,\r | |
397 | VARIABLE_POLICY_NO_MIN_SIZE,\r | |
398 | VARIABLE_POLICY_NO_MAX_SIZE,\r | |
399 | VARIABLE_POLICY_NO_MUST_ATTR,\r | |
400 | VARIABLE_POLICY_NO_CANT_ATTR,\r | |
401 | VARIABLE_POLICY_TYPE_LOCK_NOW\r | |
402 | );\r | |
1436aea4 MK |
403 | if (EFI_ERROR (Status)) {\r |
404 | DEBUG ((DEBUG_ERROR, "[FirmwarePerformanceDxe] Error when lock variable %s, Status = %r\n", EFI_FIRMWARE_PERFORMANCE_VARIABLE_NAME, Status));\r | |
405 | ASSERT_EFI_ERROR (Status);\r | |
466ebdd2 DB |
406 | }\r |
407 | \r | |
0284e90c LG |
408 | //\r |
409 | // Publish Firmware Performance Data Table.\r | |
410 | //\r | |
1436aea4 | 411 | FpdtAcpiTableChecksum ((UINT8 *)&mFirmwarePerformanceTableTemplate, mFirmwarePerformanceTableTemplate.Header.Length);\r |
0284e90c LG |
412 | Status = AcpiTableProtocol->InstallAcpiTable (\r |
413 | AcpiTableProtocol,\r | |
414 | &mFirmwarePerformanceTableTemplate,\r | |
415 | mFirmwarePerformanceTableTemplate.Header.Length,\r | |
416 | &mFirmwarePerformanceTableTemplateKey\r | |
417 | );\r | |
418 | if (EFI_ERROR (Status)) {\r | |
9e62c230 DB |
419 | if (mAcpiBootPerformanceTable != NULL) {\r |
420 | FreePages (mAcpiBootPerformanceTable, EFI_SIZE_TO_PAGES (BootPerformanceDataSize));\r | |
421 | }\r | |
1436aea4 | 422 | \r |
db91c620 SZ |
423 | if (mAcpiS3PerformanceTable != NULL) {\r |
424 | FreePages (mAcpiS3PerformanceTable, EFI_SIZE_TO_PAGES (sizeof (S3_PERFORMANCE_TABLE)));\r | |
425 | }\r | |
1436aea4 | 426 | \r |
0284e90c | 427 | mAcpiBootPerformanceTable = NULL;\r |
1436aea4 | 428 | mAcpiS3PerformanceTable = NULL;\r |
0284e90c LG |
429 | return Status;\r |
430 | }\r | |
1436aea4 | 431 | \r |
0284e90c LG |
432 | return EFI_SUCCESS;\r |
433 | }\r | |
434 | \r | |
0284e90c LG |
435 | /**\r |
436 | Report status code listener of FPDT. This is used to collect performance data\r | |
437 | for OsLoaderLoadImageStart and OsLoaderStartImageStart in FPDT.\r | |
438 | \r | |
439 | @param[in] CodeType Indicates the type of status code being reported.\r | |
440 | @param[in] Value Describes the current status of a hardware or software entity.\r | |
441 | This included information about the class and subclass that is used to\r | |
442 | classify the entity as well as an operation.\r | |
443 | @param[in] Instance The enumeration of a hardware or software entity within\r | |
444 | the system. Valid instance numbers start with 1.\r | |
445 | @param[in] CallerId This optional parameter may be used to identify the caller.\r | |
446 | This parameter allows the status code driver to apply different rules to\r | |
447 | different callers.\r | |
448 | @param[in] Data This optional parameter may be used to pass additional data.\r | |
449 | \r | |
450 | @retval EFI_SUCCESS Status code is what we expected.\r | |
451 | @retval EFI_UNSUPPORTED Status code not supported.\r | |
452 | \r | |
453 | **/\r | |
454 | EFI_STATUS\r | |
455 | EFIAPI\r | |
456 | FpdtStatusCodeListenerDxe (\r | |
1436aea4 MK |
457 | IN EFI_STATUS_CODE_TYPE CodeType,\r |
458 | IN EFI_STATUS_CODE_VALUE Value,\r | |
459 | IN UINT32 Instance,\r | |
460 | IN EFI_GUID *CallerId,\r | |
461 | IN EFI_STATUS_CODE_DATA *Data\r | |
0284e90c LG |
462 | )\r |
463 | {\r | |
464 | EFI_STATUS Status;\r | |
465 | \r | |
466 | //\r | |
467 | // Check whether status code is what we are interested in.\r | |
468 | //\r | |
469 | if ((CodeType & EFI_STATUS_CODE_TYPE_MASK) != EFI_PROGRESS_CODE) {\r | |
470 | return EFI_UNSUPPORTED;\r | |
471 | }\r | |
d1102dba | 472 | \r |
40a0f8cb LG |
473 | if (Value == (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT)) {\r |
474 | //\r | |
475 | // DxeCore ReportStatusCode Enable so that the capability can be supported.\r | |
476 | //\r | |
477 | mDxeCoreReportStatusCodeEnable = TRUE;\r | |
478 | }\r | |
0284e90c LG |
479 | \r |
480 | Status = EFI_SUCCESS;\r | |
481 | if (Value == PcdGet32 (PcdProgressCodeOsLoaderLoad)) {\r | |
482 | //\r | |
483 | // Progress code for OS Loader LoadImage.\r | |
484 | //\r | |
485 | if (mAcpiBootPerformanceTable == NULL) {\r | |
486 | return Status;\r | |
487 | }\r | |
488 | \r | |
489 | //\r | |
490 | // Update OS Loader LoadImage Start for UEFI boot.\r | |
491 | //\r | |
492 | mAcpiBootPerformanceTable->BasicBoot.OsLoaderLoadImageStart = GetTimeInNanoSecond (GetPerformanceCounter ());\r | |
493 | } else if (Value == PcdGet32 (PcdProgressCodeOsLoaderStart)) {\r | |
494 | //\r | |
495 | // Progress code for OS Loader StartImage.\r | |
496 | //\r | |
497 | if (mAcpiBootPerformanceTable == NULL) {\r | |
498 | return Status;\r | |
499 | }\r | |
500 | \r | |
501 | //\r | |
502 | // Update OS Loader StartImage Start for UEFI boot.\r | |
503 | //\r | |
504 | mAcpiBootPerformanceTable->BasicBoot.OsLoaderStartImageStart = GetTimeInNanoSecond (GetPerformanceCounter ());\r | |
505 | } else if (Value == (EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_BS_PC_EXIT_BOOT_SERVICES)) {\r | |
40a0f8cb LG |
506 | //\r |
507 | // Unregister boot time report status code listener.\r | |
508 | //\r | |
509 | mRscHandlerProtocol->Unregister (FpdtStatusCodeListenerDxe);\r | |
510 | \r | |
0284e90c LG |
511 | //\r |
512 | // Progress code for ExitBootServices.\r | |
513 | //\r | |
514 | if (mAcpiBootPerformanceTable == NULL) {\r | |
515 | return Status;\r | |
516 | }\r | |
517 | \r | |
518 | //\r | |
519 | // Update ExitBootServicesExit for UEFI boot.\r | |
520 | //\r | |
521 | mAcpiBootPerformanceTable->BasicBoot.ExitBootServicesExit = GetTimeInNanoSecond (GetPerformanceCounter ());\r | |
522dfbf3 LG |
522 | } else if (Value == (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_PC_LEGACY_BOOT_EVENT)) {\r |
523 | if (mAcpiBootPerformanceTable == NULL) {\r | |
524 | //\r | |
525 | // Firmware Performance Data Table not installed, do nothing.\r | |
526 | //\r | |
527 | return Status;\r | |
528 | }\r | |
529 | \r | |
530 | //\r | |
531 | // Update Firmware Basic Boot Performance Record for legacy boot.\r | |
532 | //\r | |
533 | mAcpiBootPerformanceTable->BasicBoot.OsLoaderStartImageStart = GetTimeInNanoSecond (GetPerformanceCounter ());\r | |
534 | \r | |
535 | //\r | |
536 | // Dump FPDT Boot Performance record.\r | |
537 | //\r | |
87000d77 MK |
538 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - ResetEnd = %ld\n", mAcpiBootPerformanceTable->BasicBoot.ResetEnd));\r |
539 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - OsLoaderLoadImageStart = 0\n"));\r | |
540 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - OsLoaderStartImageStart = %ld\n", mAcpiBootPerformanceTable->BasicBoot.OsLoaderStartImageStart));\r | |
541 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - ExitBootServicesEntry = 0\n"));\r | |
542 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - ExitBootServicesExit = 0\n"));\r | |
1436aea4 | 543 | } else if ((Data != NULL) && CompareGuid (&Data->Type, &gEdkiiFpdtExtendedFirmwarePerformanceGuid)) {\r |
9e62c230 DB |
544 | //\r |
545 | // Get the Boot performance table and then install it to ACPI table.\r | |
546 | //\r | |
547 | CopyMem (&mReceivedAcpiBootPerformanceTable, Data + 1, Data->Size);\r | |
466ebdd2 | 548 | InstallFirmwarePerformanceDataTable ();\r |
1436aea4 | 549 | } else if ((Data != NULL) && CompareGuid (&Data->Type, &gEfiFirmwarePerformanceGuid)) {\r |
d4ee449d DB |
550 | DEBUG ((DEBUG_ERROR, "FpdtStatusCodeListenerDxe: Performance data reported through gEfiFirmwarePerformanceGuid will not be collected by FirmwarePerformanceDataTableDxe\n"));\r |
551 | Status = EFI_UNSUPPORTED;\r | |
0284e90c LG |
552 | } else {\r |
553 | //\r | |
554 | // Ignore else progress code.\r | |
555 | //\r | |
556 | Status = EFI_UNSUPPORTED;\r | |
557 | }\r | |
558 | \r | |
559 | return Status;\r | |
560 | }\r | |
561 | \r | |
466ebdd2 DB |
562 | /**\r |
563 | Notify function for event EndOfDxe.\r | |
564 | \r | |
565 | This is used to install ACPI Firmware Performance Data Table for basic boot records.\r | |
566 | \r | |
567 | @param[in] Event The Event that is being processed.\r | |
568 | @param[in] Context The Event Context.\r | |
569 | \r | |
570 | **/\r | |
571 | VOID\r | |
572 | EFIAPI\r | |
573 | FpdtEndOfDxeEventNotify (\r | |
1436aea4 MK |
574 | IN EFI_EVENT Event,\r |
575 | IN VOID *Context\r | |
466ebdd2 DB |
576 | )\r |
577 | {\r | |
578 | //\r | |
579 | // When performance is enabled, the FPDT will be installed when DxeCorePerformanceLib report the data to FimwarePerformanceDxe.\r | |
580 | // This is used to install the FPDT for the basic boot recods when performance infrastructure is not enabled.\r | |
581 | //\r | |
1436aea4 | 582 | if ((PcdGet8 (PcdPerformanceLibraryPropertyMask) & PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED) != 0) {\r |
466ebdd2 DB |
583 | return;\r |
584 | }\r | |
1436aea4 | 585 | \r |
466ebdd2 DB |
586 | ASSERT (mReceivedAcpiBootPerformanceTable == NULL);\r |
587 | InstallFirmwarePerformanceDataTable ();\r | |
588 | }\r | |
40a0f8cb LG |
589 | \r |
590 | /**\r | |
591 | Notify function for event EVT_SIGNAL_EXIT_BOOT_SERVICES. This is used to record\r | |
592 | performance data for ExitBootServicesEntry in FPDT.\r | |
593 | \r | |
594 | @param[in] Event The Event that is being processed.\r | |
595 | @param[in] Context The Event Context.\r | |
596 | \r | |
597 | **/\r | |
598 | VOID\r | |
599 | EFIAPI\r | |
600 | FpdtExitBootServicesEventNotify (\r | |
1436aea4 MK |
601 | IN EFI_EVENT Event,\r |
602 | IN VOID *Context\r | |
40a0f8cb LG |
603 | )\r |
604 | {\r | |
0b24f2cf | 605 | if (!mDxeCoreReportStatusCodeEnable) {\r |
40a0f8cb | 606 | //\r |
d1102dba | 607 | // When DxeCore Report Status Code is disabled,\r |
40a0f8cb LG |
608 | // Unregister boot time report status code listener at ExitBootService Event.\r |
609 | //\r | |
610 | mRscHandlerProtocol->Unregister (FpdtStatusCodeListenerDxe);\r | |
611 | }\r | |
612 | \r | |
613 | if (mAcpiBootPerformanceTable == NULL) {\r | |
614 | //\r | |
615 | // Firmware Performance Data Table not installed, do nothing.\r | |
616 | //\r | |
1436aea4 | 617 | return;\r |
40a0f8cb LG |
618 | }\r |
619 | \r | |
620 | //\r | |
621 | // Update Firmware Basic Boot Performance Record for UEFI boot.\r | |
622 | //\r | |
623 | mAcpiBootPerformanceTable->BasicBoot.ExitBootServicesEntry = GetTimeInNanoSecond (GetPerformanceCounter ());\r | |
624 | \r | |
625 | //\r | |
626 | // Dump FPDT Boot Performance record.\r | |
627 | //\r | |
87000d77 MK |
628 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - ResetEnd = %ld\n", mAcpiBootPerformanceTable->BasicBoot.ResetEnd));\r |
629 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - OsLoaderLoadImageStart = %ld\n", mAcpiBootPerformanceTable->BasicBoot.OsLoaderLoadImageStart));\r | |
630 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - OsLoaderStartImageStart = %ld\n", mAcpiBootPerformanceTable->BasicBoot.OsLoaderStartImageStart));\r | |
631 | DEBUG ((DEBUG_INFO, "FPDT: Boot Performance - ExitBootServicesEntry = %ld\n", mAcpiBootPerformanceTable->BasicBoot.ExitBootServicesEntry));\r | |
40a0f8cb LG |
632 | //\r |
633 | // ExitBootServicesExit will be updated later, so don't dump it here.\r | |
634 | //\r | |
635 | }\r | |
636 | \r | |
0284e90c LG |
637 | /**\r |
638 | The module Entry Point of the Firmware Performance Data Table DXE driver.\r | |
639 | \r | |
640 | @param[in] ImageHandle The firmware allocated handle for the EFI image.\r | |
641 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
642 | \r | |
643 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
644 | @retval Other Some error occurs when executing this entry point.\r | |
645 | \r | |
646 | **/\r | |
647 | EFI_STATUS\r | |
648 | EFIAPI\r | |
649 | FirmwarePerformanceDxeEntryPoint (\r | |
1436aea4 MK |
650 | IN EFI_HANDLE ImageHandle,\r |
651 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
0284e90c LG |
652 | )\r |
653 | {\r | |
1436aea4 MK |
654 | EFI_STATUS Status;\r |
655 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
656 | FIRMWARE_SEC_PERFORMANCE *Performance;\r | |
657 | VOID *Registration;\r | |
658 | UINT64 OemTableId;\r | |
659 | EFI_EVENT EndOfDxeEvent;\r | |
e84f07b5 SZ |
660 | \r |
661 | CopyMem (\r | |
662 | mFirmwarePerformanceTableTemplate.Header.OemId,\r | |
663 | PcdGetPtr (PcdAcpiDefaultOemId),\r | |
664 | sizeof (mFirmwarePerformanceTableTemplate.Header.OemId)\r | |
665 | );\r | |
666 | OemTableId = PcdGet64 (PcdAcpiDefaultOemTableId);\r | |
667 | CopyMem (&mFirmwarePerformanceTableTemplate.Header.OemTableId, &OemTableId, sizeof (UINT64));\r | |
1436aea4 MK |
668 | mFirmwarePerformanceTableTemplate.Header.OemRevision = PcdGet32 (PcdAcpiDefaultOemRevision);\r |
669 | mFirmwarePerformanceTableTemplate.Header.CreatorId = PcdGet32 (PcdAcpiDefaultCreatorId);\r | |
670 | mFirmwarePerformanceTableTemplate.Header.CreatorRevision = PcdGet32 (PcdAcpiDefaultCreatorRevision);\r | |
0284e90c LG |
671 | \r |
672 | //\r | |
673 | // Get Report Status Code Handler Protocol.\r | |
674 | //\r | |
1436aea4 | 675 | Status = gBS->LocateProtocol (&gEfiRscHandlerProtocolGuid, NULL, (VOID **)&mRscHandlerProtocol);\r |
0284e90c LG |
676 | ASSERT_EFI_ERROR (Status);\r |
677 | \r | |
678 | //\r | |
679 | // Register report status code listener for OS Loader load and start.\r | |
680 | //\r | |
681 | Status = mRscHandlerProtocol->Register (FpdtStatusCodeListenerDxe, TPL_HIGH_LEVEL);\r | |
682 | ASSERT_EFI_ERROR (Status);\r | |
683 | \r | |
466ebdd2 DB |
684 | //\r |
685 | // Register the notify function to install FPDT at EndOfDxe.\r | |
686 | //\r | |
687 | Status = gBS->CreateEventEx (\r | |
688 | EVT_NOTIFY_SIGNAL,\r | |
689 | TPL_NOTIFY,\r | |
690 | FpdtEndOfDxeEventNotify,\r | |
691 | NULL,\r | |
692 | &gEfiEndOfDxeEventGroupGuid,\r | |
693 | &EndOfDxeEvent\r | |
694 | );\r | |
695 | ASSERT_EFI_ERROR (Status);\r | |
696 | \r | |
0284e90c LG |
697 | //\r |
698 | // Register the notify function to update FPDT on ExitBootServices Event.\r | |
699 | //\r | |
700 | Status = gBS->CreateEventEx (\r | |
701 | EVT_NOTIFY_SIGNAL,\r | |
702 | TPL_NOTIFY,\r | |
703 | FpdtExitBootServicesEventNotify,\r | |
704 | NULL,\r | |
705 | &gEfiEventExitBootServicesGuid,\r | |
706 | &mExitBootServicesEvent\r | |
707 | );\r | |
708 | ASSERT_EFI_ERROR (Status);\r | |
709 | \r | |
0284e90c LG |
710 | //\r |
711 | // Retrieve GUID HOB data that contains the ResetEnd.\r | |
712 | //\r | |
713 | GuidHob = GetFirstGuidHob (&gEfiFirmwarePerformanceGuid);\r | |
714 | if (GuidHob != NULL) {\r | |
1436aea4 | 715 | Performance = (FIRMWARE_SEC_PERFORMANCE *)GET_GUID_HOB_DATA (GuidHob);\r |
0284e90c LG |
716 | mBootPerformanceTableTemplate.BasicBoot.ResetEnd = Performance->ResetEnd;\r |
717 | } else {\r | |
718 | //\r | |
719 | // SEC Performance Data Hob not found, ResetEnd in ACPI FPDT table will be 0.\r | |
720 | //\r | |
d3d562b9 | 721 | DEBUG ((DEBUG_WARN, "FPDT: WARNING: SEC Performance Data Hob not found, ResetEnd will be set to 0!\n"));\r |
0284e90c LG |
722 | }\r |
723 | \r | |
db91c620 SZ |
724 | if (FeaturePcdGet (PcdFirmwarePerformanceDataTableS3Support)) {\r |
725 | //\r | |
726 | // Register callback function upon VariableArchProtocol and LockBoxProtocol\r | |
727 | // to allocate S3 performance table memory and save the pointer to LockBox.\r | |
728 | //\r | |
729 | EfiCreateProtocolNotifyEvent (\r | |
730 | &gEfiVariableArchProtocolGuid,\r | |
731 | TPL_CALLBACK,\r | |
732 | FpdtAllocateS3PerformanceTableMemory,\r | |
733 | NULL,\r | |
734 | &Registration\r | |
735 | );\r | |
736 | EfiCreateProtocolNotifyEvent (\r | |
737 | &gEfiLockBoxProtocolGuid,\r | |
738 | TPL_CALLBACK,\r | |
739 | FpdtAllocateS3PerformanceTableMemory,\r | |
740 | NULL,\r | |
741 | &Registration\r | |
742 | );\r | |
743 | } else {\r | |
744 | //\r | |
745 | // Exclude S3 Performance Table Pointer from FPDT table template.\r | |
746 | //\r | |
747 | mFirmwarePerformanceTableTemplate.Header.Length -= sizeof (EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD);\r | |
748 | }\r | |
749 | \r | |
0284e90c LG |
750 | return EFI_SUCCESS;\r |
751 | }\r |