]> git.proxmox.com Git - mirror_edk2.git/blame - UefiCpuPkg/Universal/Acpi/S3Resume2Pei/S3Resume.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
UefiCpuPkg: Add S3Resume2Pei PEIM
[mirror_edk2.git] / UefiCpuPkg / Universal / Acpi / S3Resume2Pei / S3Resume.c
CommitLineData
1f569620 1/** @file\r
2 This module produces the EFI_PEI_S3_RESUME_PPI.\r
3 This module works with StandAloneBootScriptExecutor to S3 resume to OS.\r
4 This module will excute the boot script saved during last boot and after that,\r
5 control is passed to OS waking up handler.\r
6\r
7 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
8\r
9 This program and the accompanying materials\r
10 are licensed and made available under the terms and conditions\r
11 of the BSD License which accompanies this distribution. The\r
12 full text of the license may be found at\r
13 http://opensource.org/licenses/bsd-license.php\r
14\r
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
17\r
18**/\r
19\r
20#include <PiPei.h>\r
21\r
22#include <Guid/AcpiS3Context.h>\r
23#include <Guid/BootScriptExecutorVariable.h>\r
24#include <Guid/Performance.h>\r
25#include <Ppi/ReadOnlyVariable2.h>\r
26#include <Ppi/S3Resume2.h>\r
27#include <Ppi/SmmAccess.h>\r
28#include <Ppi/PostBootScriptTable.h>\r
29#include <Ppi/EndOfPeiPhase.h>\r
30\r
31#include <Library/DebugLib.h>\r
32#include <Library/BaseLib.h>\r
33#include <Library/TimerLib.h>\r
34#include <Library/PeimEntryPoint.h>\r
35#include <Library/PeiServicesLib.h>\r
36#include <Library/HobLib.h>\r
37#include <Library/PerformanceLib.h>\r
38#include <Library/PeiServicesTablePointerLib.h>\r
39#include <Library/IoLib.h>\r
40#include <Library/BaseMemoryLib.h>\r
41#include <Library/MemoryAllocationLib.h>\r
42#include <Library/PcdLib.h>\r
43#include <Library/DebugAgentLib.h>\r
44#include <Library/LocalApicLib.h>\r
45#include <Library/ReportStatusCodeLib.h>\r
46#include <Library/PrintLib.h>\r
47#include <Library/LockBoxLib.h>\r
48#include <IndustryStandard/Acpi.h>\r
49\r
50#pragma pack(1)\r
51typedef union {\r
52 struct {\r
53 UINT32 LimitLow : 16;\r
54 UINT32 BaseLow : 16;\r
55 UINT32 BaseMid : 8;\r
56 UINT32 Type : 4;\r
57 UINT32 System : 1;\r
58 UINT32 Dpl : 2;\r
59 UINT32 Present : 1;\r
60 UINT32 LimitHigh : 4;\r
61 UINT32 Software : 1;\r
62 UINT32 Reserved : 1;\r
63 UINT32 DefaultSize : 1;\r
64 UINT32 Granularity : 1;\r
65 UINT32 BaseHigh : 8;\r
66 } Bits;\r
67 UINT64 Uint64;\r
68} IA32_GDT;\r
69\r
70//\r
71// Page-Map Level-4 Offset (PML4) and\r
72// Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB\r
73//\r
74typedef union {\r
75 struct {\r
76 UINT64 Present:1; // 0 = Not present in memory, 1 = Present in memory\r
77 UINT64 ReadWrite:1; // 0 = Read-Only, 1= Read/Write\r
78 UINT64 UserSupervisor:1; // 0 = Supervisor, 1=User\r
79 UINT64 WriteThrough:1; // 0 = Write-Back caching, 1=Write-Through caching\r
80 UINT64 CacheDisabled:1; // 0 = Cached, 1=Non-Cached\r
81 UINT64 Accessed:1; // 0 = Not accessed, 1 = Accessed (set by CPU)\r
82 UINT64 Reserved:1; // Reserved\r
83 UINT64 MustBeZero:2; // Must Be Zero\r
84 UINT64 Available:3; // Available for use by system software\r
85 UINT64 PageTableBaseAddress:40; // Page Table Base Address\r
86 UINT64 AvabilableHigh:11; // Available for use by system software\r
87 UINT64 Nx:1; // No Execute bit\r
88 } Bits;\r
89 UINT64 Uint64;\r
90} PAGE_MAP_AND_DIRECTORY_POINTER;\r
91\r
92//\r
93// Page Table Entry 2MB\r
94//\r
95typedef union {\r
96 struct {\r
97 UINT64 Present:1; // 0 = Not present in memory, 1 = Present in memory\r
98 UINT64 ReadWrite:1; // 0 = Read-Only, 1= Read/Write\r
99 UINT64 UserSupervisor:1; // 0 = Supervisor, 1=User\r
100 UINT64 WriteThrough:1; // 0 = Write-Back caching, 1=Write-Through caching\r
101 UINT64 CacheDisabled:1; // 0 = Cached, 1=Non-Cached\r
102 UINT64 Accessed:1; // 0 = Not accessed, 1 = Accessed (set by CPU)\r
103 UINT64 Dirty:1; // 0 = Not Dirty, 1 = written by processor on access to page\r
104 UINT64 MustBe1:1; // Must be 1 \r
105 UINT64 Global:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write\r
106 UINT64 Available:3; // Available for use by system software\r
107 UINT64 PAT:1; //\r
108 UINT64 MustBeZero:8; // Must be zero;\r
109 UINT64 PageTableBaseAddress:31; // Page Table Base Address\r
110 UINT64 AvabilableHigh:11; // Available for use by system software\r
111 UINT64 Nx:1; // 0 = Execute Code, 1 = No Code Execution\r
112 } Bits;\r
113 UINT64 Uint64;\r
114} PAGE_TABLE_ENTRY;\r
115\r
116#pragma pack()\r
117\r
118//\r
119// Function prototypes\r
120//\r
121/**\r
122 a ASM function to transfer control to OS.\r
123 \r
124 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table\r
125 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer \r
126**/\r
127typedef\r
128VOID\r
129(EFIAPI *ASM_TRANSFER_CONTROL) (\r
130 IN UINT32 S3WakingVector,\r
131 IN UINT32 AcpiLowMemoryBase\r
132 );\r
133\r
134/**\r
135 Restores the platform to its preboot configuration for an S3 resume and\r
136 jumps to the OS waking vector.\r
137\r
138 This function will restore the platform to its pre-boot configuration that was\r
139 pre-stored in the boot script table and transfer control to OS waking vector.\r
140 Upon invocation, this function is responsible for locating the following\r
141 information before jumping to OS waking vector:\r
142 - ACPI tables\r
143 - boot script table\r
144 - any other information that it needs\r
145\r
146 The S3RestoreConfig() function then executes the pre-stored boot script table\r
147 and transitions the platform to the pre-boot state. The boot script is recorded\r
148 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and\r
149 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function\r
150 transfers control to the OS waking vector. If the OS supports only a real-mode\r
151 waking vector, this function will switch from flat mode to real mode before\r
152 jumping to the waking vector. If all platform pre-boot configurations are\r
153 successfully restored and all other necessary information is ready, this\r
154 function will never return and instead will directly jump to the OS waking\r
155 vector. If this function returns, it indicates that the attempt to resume\r
156 from the ACPI S3 sleep state failed.\r
157\r
158 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI\r
159\r
160 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r
161 @retval EFI_NOT_FOUND Some necessary information that is used for the S3\r
162 resume boot path could not be located.\r
163\r
164**/\r
165EFI_STATUS\r
166EFIAPI\r
167S3RestoreConfig2 (\r
168 IN EFI_PEI_S3_RESUME2_PPI *This\r
169 );\r
170\r
171//\r
172// Globals\r
173//\r
174EFI_PEI_S3_RESUME2_PPI mS3ResumePpi = { S3RestoreConfig2 };\r
175\r
176EFI_PEI_PPI_DESCRIPTOR mPpiList = {\r
177 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
178 &gEfiPeiS3Resume2PpiGuid,\r
179 &mS3ResumePpi\r
180};\r
181\r
182EFI_PEI_PPI_DESCRIPTOR mPpiListPostScriptTable = {\r
183 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
184 &gPeiPostScriptTablePpiGuid,\r
185 0\r
186};\r
187\r
188EFI_PEI_PPI_DESCRIPTOR mPpiListEndOfPeiTable = {\r
189 (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
190 &gEfiEndOfPeiSignalPpiGuid,\r
191 0\r
192};\r
193\r
194//\r
195// Global Descriptor Table (GDT)\r
196//\r
197GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT mGdtEntries[] = {\r
198/* selector { Global Segment Descriptor } */\r
199/* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
200/* 0x08 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
201/* 0x10 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},\r
202/* 0x18 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},\r
203/* 0x20 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
204/* 0x28 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},\r
205/* 0x30 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},\r
206/* 0x38 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 1, 0, 1, 0}},\r
207/* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r
208};\r
209\r
210//\r
211// IA32 Gdt register\r
212//\r
213GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt = {\r
214 sizeof (mGdtEntries) - 1,\r
215 (UINTN) mGdtEntries\r
216 };\r
217\r
218/**\r
219 Performance measure function to get S3 detailed performance data.\r
220\r
221 This function will getS3 detailed performance data and saved in pre-reserved ACPI memory.\r
222**/\r
223VOID\r
224WriteToOsS3PerformanceData (\r
225 VOID\r
226 )\r
227{\r
228 EFI_STATUS Status;\r
229 EFI_PHYSICAL_ADDRESS mAcpiLowMemoryBase;\r
230 PERF_HEADER *PerfHeader;\r
231 PERF_DATA *PerfData;\r
232 UINT64 Ticker;\r
233 UINTN Index;\r
234 EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariableServices;\r
235 UINTN VarSize;\r
236 UINTN LogEntryKey;\r
237 CONST VOID *Handle;\r
238 CONST CHAR8 *Token;\r
239 CONST CHAR8 *Module;\r
240 UINT64 StartTicker;\r
241 UINT64 EndTicker;\r
242 UINT64 StartValue;\r
243 UINT64 EndValue;\r
244 BOOLEAN CountUp;\r
245 UINT64 Freq;\r
246\r
247 //\r
248 // Retrive time stamp count as early as possilbe\r
249 //\r
250 Ticker = GetPerformanceCounter ();\r
251\r
252 Freq = GetPerformanceCounterProperties (&StartValue, &EndValue);\r
253\r
254 Freq = DivU64x32 (Freq, 1000);\r
255\r
256 Status = PeiServicesLocatePpi (\r
257 &gEfiPeiReadOnlyVariable2PpiGuid,\r
258 0,\r
259 NULL,\r
260 (VOID **) &VariableServices\r
261 );\r
262 ASSERT_EFI_ERROR (Status);\r
263\r
264 VarSize = sizeof (EFI_PHYSICAL_ADDRESS);\r
265 Status = VariableServices->GetVariable (\r
266 VariableServices,\r
267 L"PerfDataMemAddr",\r
268 &gPerformanceProtocolGuid,\r
269 NULL,\r
270 &VarSize,\r
271 &mAcpiLowMemoryBase\r
272 );\r
273 if (EFI_ERROR (Status)) {\r
274 DEBUG ((EFI_D_ERROR, "Fail to retrieve variable to log S3 performance data \n"));\r
275 return;\r
276 }\r
277\r
278 PerfHeader = (PERF_HEADER *) (UINTN) mAcpiLowMemoryBase;\r
279\r
280 if (PerfHeader->Signiture != PERFORMANCE_SIGNATURE) {\r
281 DEBUG ((EFI_D_ERROR, "Performance data in ACPI memory get corrupted! \n"));\r
282 return;\r
283 }\r
284\r
285 //\r
286 // Record total S3 resume time.\r
287 //\r
288 if (EndValue >= StartValue) {\r
289 PerfHeader->S3Resume = Ticker - StartValue;\r
290 CountUp = TRUE;\r
291 } else {\r
292 PerfHeader->S3Resume = StartValue - Ticker;\r
293 CountUp = FALSE;\r
294 }\r
295\r
296 //\r
297 // Get S3 detailed performance data\r
298 //\r
299 Index = 0;\r
300 LogEntryKey = 0;\r
301 while ((LogEntryKey = GetPerformanceMeasurement (\r
302 LogEntryKey,\r
303 &Handle,\r
304 &Token,\r
305 &Module,\r
306 &StartTicker,\r
307 &EndTicker)) != 0) {\r
308 if (EndTicker != 0) {\r
309 PerfData = &PerfHeader->S3Entry[Index];\r
310\r
311 //\r
312 // Use File Handle to specify the different performance log for PEIM.\r
313 // File Handle is the base address of PEIM FFS file.\r
314 //\r
315 if ((AsciiStrnCmp (Token, "PEIM", PEI_PERFORMANCE_STRING_SIZE) == 0) && (Handle != NULL)) {\r
316 AsciiSPrint (PerfData->Token, PERF_TOKEN_LENGTH, "0x%11p", Handle);\r
317 } else {\r
318 AsciiStrnCpy (PerfData->Token, Token, PERF_TOKEN_LENGTH);\r
319 }\r
320 if (StartTicker == 1) {\r
321 StartTicker = StartValue;\r
322 }\r
323 if (EndTicker == 1) {\r
324 EndTicker = StartValue;\r
325 }\r
326 Ticker = CountUp? (EndTicker - StartTicker) : (StartTicker - EndTicker);\r
327 PerfData->Duration = (UINT32) DivU64x32 (Ticker, (UINT32) Freq);\r
328\r
329 //\r
330 // Only Record > 1ms performance data so that more big performance can be recorded.\r
331 //\r
332 if ((Ticker > Freq) && (++Index >= PERF_PEI_ENTRY_MAX_NUM)) {\r
333 //\r
334 // Reach the maximum number of PEI performance log entries.\r
335 //\r
336 break;\r
337 }\r
338 }\r
339 }\r
340 PerfHeader->S3EntryNum = (UINT32) Index;\r
341}\r
342\r
343/**\r
344 Jump to OS waking vector.\r
345 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.\r
346\r
347 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
348 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE\r
349**/\r
350VOID\r
351EFIAPI\r
352S3ResumeBootOs (\r
353 IN ACPI_S3_CONTEXT *AcpiS3Context,\r
354 IN PEI_S3_RESUME_STATE *PeiS3ResumeState\r
355 )\r
356{\r
357 EFI_STATUS Status;\r
358 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *Facs;\r
359 ASM_TRANSFER_CONTROL AsmTransferControl;\r
360 UINTN TempStackTop;\r
361 UINTN TempStack[0x10];\r
362\r
363 //\r
364 // Restore IDT\r
365 //\r
366 AsmWriteIdtr (&PeiS3ResumeState->Idtr);\r
367\r
368 //\r
369 // Install BootScriptDonePpi\r
370 //\r
371 Status = PeiServicesInstallPpi (&mPpiListPostScriptTable);\r
372 ASSERT_EFI_ERROR (Status);\r
373\r
374 //\r
375 // Get ACPI Table Address\r
376 //\r
377 Facs = (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable));\r
378\r
379 if ((Facs == NULL) ||\r
380 (Facs->Signature != EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) ||\r
381 ((Facs->FirmwareWakingVector == 0) && (Facs->XFirmwareWakingVector == 0)) ) {\r
382 CpuDeadLoop ();\r
383 return ;\r
384 }\r
385\r
386 //\r
387 // report status code on S3 resume\r
388 //\r
389 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_OS_WAKE);\r
390\r
391 //\r
392 // Install EndOfPeiPpi\r
393 //\r
394 Status = PeiServicesInstallPpi (&mPpiListEndOfPeiTable);\r
395 ASSERT_EFI_ERROR (Status);\r
396\r
397 PERF_CODE (\r
398 WriteToOsS3PerformanceData ();\r
399 );\r
400\r
401 AsmTransferControl = (ASM_TRANSFER_CONTROL)(UINTN)PeiS3ResumeState->AsmTransferControl;\r
402 if (Facs->XFirmwareWakingVector != 0) {\r
403 //\r
404 // Switch to native waking vector\r
405 //\r
406 TempStackTop = (UINTN)&TempStack + sizeof(TempStack);\r
407 if ((Facs->Version == EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION) &&\r
408 ((Facs->Flags & EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F) != 0) &&\r
409 ((Facs->Flags & EFI_ACPI_4_0_OSPM_64BIT_WAKE__F) != 0)) {\r
410 //\r
411 // X64 long mode waking vector\r
412 //\r
413 DEBUG (( EFI_D_ERROR, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
414 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
415 AsmEnablePaging64 (\r
416 0x38,\r
417 Facs->XFirmwareWakingVector,\r
418 0,\r
419 0,\r
420 (UINT64)(UINTN)TempStackTop\r
421 );\r
422 } else {\r
423 DEBUG (( EFI_D_ERROR, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));\r
424 ASSERT (FALSE);\r
425 }\r
426 } else {\r
427 //\r
428 // IA32 protected mode waking vector (Page disabled)\r
429 //\r
430 DEBUG (( EFI_D_ERROR, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN)Facs->XFirmwareWakingVector));\r
431 SwitchStack (\r
432 (SWITCH_STACK_ENTRY_POINT) (UINTN) Facs->XFirmwareWakingVector,\r
433 NULL,\r
434 NULL,\r
435 (VOID *)(UINTN)TempStackTop\r
436 );\r
437 }\r
438 } else {\r
439 //\r
440 // 16bit Realmode waking vector\r
441 //\r
442 DEBUG (( EFI_D_ERROR, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN)Facs->FirmwareWakingVector));\r
443 AsmTransferControl (Facs->FirmwareWakingVector, 0x0);\r
444 }\r
445\r
446 //\r
447 // Never run to here\r
448 //\r
449 CpuDeadLoop();\r
450}\r
451\r
452/**\r
453 Restore S3 page table because we do not trust ACPINvs content.\r
454 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing. \r
455\r
456 @param S3NvsPageTableAddress PageTableAddress in ACPINvs\r
457**/\r
458VOID\r
459RestoreS3PageTables (\r
460 IN UINTN S3NvsPageTableAddress\r
461 )\r
462{\r
463 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
464 UINT32 RegEax;\r
465 UINT8 PhysicalAddressBits;\r
466 EFI_PHYSICAL_ADDRESS PageAddress;\r
467 UINTN IndexOfPml4Entries;\r
468 UINTN IndexOfPdpEntries;\r
469 UINTN IndexOfPageDirectoryEntries;\r
470 UINT64 NumberOfPml4EntriesNeeded;\r
471 UINT64 NumberOfPdpEntriesNeeded;\r
472 PAGE_MAP_AND_DIRECTORY_POINTER *PageMapLevel4Entry;\r
473 PAGE_MAP_AND_DIRECTORY_POINTER *PageMap;\r
474 PAGE_MAP_AND_DIRECTORY_POINTER *PageDirectoryPointerEntry;\r
475 PAGE_TABLE_ENTRY *PageDirectoryEntry;\r
476\r
477 //\r
478 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.\r
479 // The whole page table is too large to be saved in SMRAM.\r
480 //\r
481 // The assumption is : whole page table is allocated in CONTINOUS memory and CR3 points to TOP page.\r
482 //\r
483 DEBUG ((EFI_D_ERROR, "S3NvsPageTableAddress - %x\n", S3NvsPageTableAddress));\r
484\r
485 //\r
486 // By architecture only one PageMapLevel4 exists - so lets allocate storgage for it.\r
487 //\r
488 PageMap = (PAGE_MAP_AND_DIRECTORY_POINTER *)S3NvsPageTableAddress;\r
489 S3NvsPageTableAddress += SIZE_4KB;\r
490 \r
491 //\r
492 // Get physical address bits supported.\r
493 //\r
494 AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
495 if (RegEax >= 0x80000008) {\r
496 AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);\r
497 PhysicalAddressBits = (UINT8) RegEax;\r
498 } else {\r
499 PhysicalAddressBits = 36;\r
500 }\r
501 \r
502 //\r
503 // Calculate the table entries needed.\r
504 //\r
505 if (PhysicalAddressBits <= 39) {\r
506 NumberOfPml4EntriesNeeded = 1;\r
507 NumberOfPdpEntriesNeeded = LShiftU64 (1, (PhysicalAddressBits - 30));\r
508 } else {\r
509 NumberOfPml4EntriesNeeded = LShiftU64 (1, (PhysicalAddressBits - 39));\r
510 NumberOfPdpEntriesNeeded = 512;\r
511 }\r
512 \r
513 PageMapLevel4Entry = PageMap;\r
514 PageAddress = 0;\r
515 for (IndexOfPml4Entries = 0; IndexOfPml4Entries < NumberOfPml4EntriesNeeded; IndexOfPml4Entries++, PageMapLevel4Entry++) {\r
516 //\r
517 // Each PML4 entry points to a page of Page Directory Pointer entires.\r
518 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.\r
519 //\r
520 PageDirectoryPointerEntry = (PAGE_MAP_AND_DIRECTORY_POINTER *)S3NvsPageTableAddress;\r
521 S3NvsPageTableAddress += SIZE_4KB;\r
522 \r
523 //\r
524 // Make a PML4 Entry\r
525 //\r
526 PageMapLevel4Entry->Uint64 = (UINT64)(UINTN)PageDirectoryPointerEntry;\r
527 PageMapLevel4Entry->Bits.ReadWrite = 1;\r
528 PageMapLevel4Entry->Bits.Present = 1;\r
529 \r
530 for (IndexOfPdpEntries = 0; IndexOfPdpEntries < NumberOfPdpEntriesNeeded; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
531 //\r
532 // Each Directory Pointer entries points to a page of Page Directory entires.\r
533 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.\r
534 // \r
535 PageDirectoryEntry = (PAGE_TABLE_ENTRY *)S3NvsPageTableAddress;\r
536 S3NvsPageTableAddress += SIZE_4KB;\r
537 \r
538 //\r
539 // Fill in a Page Directory Pointer Entries\r
540 //\r
541 PageDirectoryPointerEntry->Uint64 = (UINT64)(UINTN)PageDirectoryEntry;\r
542 PageDirectoryPointerEntry->Bits.ReadWrite = 1;\r
543 PageDirectoryPointerEntry->Bits.Present = 1;\r
544 \r
545 for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PageAddress += SIZE_2MB) {\r
546 //\r
547 // Fill in the Page Directory entries\r
548 //\r
549 PageDirectoryEntry->Uint64 = (UINT64)PageAddress;\r
550 PageDirectoryEntry->Bits.ReadWrite = 1;\r
551 PageDirectoryEntry->Bits.Present = 1;\r
552 PageDirectoryEntry->Bits.MustBe1 = 1;\r
553 }\r
554 }\r
555 }\r
556 return ;\r
557 } else {\r
558 //\r
559 // If DXE is running 32-bit mode, no need to establish page table.\r
560 //\r
561 return ;\r
562 }\r
563}\r
564\r
565/**\r
566 Jump to boot script executor driver.\r
567\r
568 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.\r
569\r
570 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT\r
571 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in\r
572 boot script execute driver\r
573**/\r
574VOID\r
575EFIAPI\r
576S3ResumeExecuteBootScript (\r
577 IN ACPI_S3_CONTEXT *AcpiS3Context,\r
578 IN BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable\r
579 )\r
580{\r
581 EFI_STATUS Status;\r
582 PEI_SMM_ACCESS_PPI *SmmAccess;\r
583 UINTN Index;\r
584 VOID *GuidHob;\r
585 IA32_DESCRIPTOR *IdtDescriptor;\r
586 VOID *IdtBuffer;\r
587 PEI_S3_RESUME_STATE *PeiS3ResumeState;\r
588\r
589 DEBUG ((EFI_D_ERROR, "S3ResumeExecuteBootScript()\n"));\r
590\r
591 //\r
592 // Attempt to use content from SMRAM first\r
593 //\r
594 GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);\r
595 if (GuidHob != NULL) {\r
596 //\r
597 // Last step for SMM - send SMI for initialization\r
598 //\r
599\r
600 //\r
601 // Send SMI to APs\r
602 // \r
603 SendSmiIpiAllExcludingSelf ();\r
604 //\r
605 // Send SMI to BSP\r
606 //\r
607 SendSmiIpi (GetApicId ());\r
608\r
609 Status = PeiServicesLocatePpi (\r
610 &gPeiSmmAccessPpiGuid,\r
611 0,\r
612 NULL,\r
613 (VOID **) &SmmAccess\r
614 );\r
615\r
616 DEBUG ((EFI_D_ERROR, "Close all SMRAM regions before executing boot script\n"));\r
617\r
618 for (Index = 0, Status = EFI_SUCCESS; !EFI_ERROR (Status); Index++) {\r
619 Status = SmmAccess->Close ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);\r
620 }\r
621\r
622 DEBUG ((EFI_D_ERROR, "Lock all SMRAM regions before executing boot script\n"));\r
623\r
624 for (Index = 0, Status = EFI_SUCCESS; !EFI_ERROR (Status); Index++) {\r
625 Status = SmmAccess->Lock ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);\r
626 }\r
627 }\r
628\r
629 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
630 //\r
631 // Need reconstruct page table here, since we do not trust ACPINvs.\r
632 //\r
633 RestoreS3PageTables ((UINTN)AcpiS3Context->S3NvsPageTableAddress);\r
634 AsmWriteCr3 ((UINTN)AcpiS3Context->S3NvsPageTableAddress);\r
635 }\r
636\r
637 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {\r
638 //\r
639 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices\r
640 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)). \r
641 //\r
642 IdtDescriptor = (IA32_DESCRIPTOR *) (UINTN) (AcpiS3Context->IdtrProfile);\r
643 //\r
644 // Make sure the newly allcated IDT align with 16-bytes\r
645 // \r
646 IdtBuffer = AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor->Limit + 1) + 16));\r
647 ASSERT (IdtBuffer != NULL);\r
648 CopyMem ((VOID*)((UINT8*)IdtBuffer + 16),(VOID*)(IdtDescriptor->Base), (IdtDescriptor->Limit + 1));\r
649 IdtDescriptor->Base = (UINTN)((UINT8*)IdtBuffer + 16);\r
650 *(UINTN*)(IdtDescriptor->Base - sizeof(UINTN)) = (UINTN)GetPeiServicesTablePointer ();\r
651 }\r
652\r
653 //\r
654 // Need to make sure the GDT is loaded with values that support long mode and real mode.\r
655 //\r
656 AsmWriteGdtr (&mGdt);\r
657\r
658 //\r
659 // Prepare data for return back\r
660 //\r
661 PeiS3ResumeState = AllocatePool (sizeof(*PeiS3ResumeState));\r
662 ASSERT (PeiS3ResumeState != NULL);\r
663 DEBUG (( EFI_D_ERROR, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState));\r
664 PeiS3ResumeState->ReturnCs = 0x10;\r
665 PeiS3ResumeState->ReturnEntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)S3ResumeBootOs;\r
666 PeiS3ResumeState->ReturnStackPointer = (EFI_PHYSICAL_ADDRESS)(UINTN)&Status;\r
667 //\r
668 // Save IDT\r
669 //\r
670 AsmReadIdtr (&PeiS3ResumeState->Idtr);\r
671\r
672 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode)) {\r
673 //\r
674 // X64 S3 Resume\r
675 //\r
676 DEBUG (( EFI_D_ERROR, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));\r
677\r
678 //\r
679 // Switch to long mode to complete resume.\r
680 //\r
681 AsmEnablePaging64 (\r
682 0x38,\r
683 EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint,\r
684 (UINT64)(UINTN)AcpiS3Context,\r
685 (UINT64)(UINTN)PeiS3ResumeState,\r
686 (UINT64)(UINTN)(AcpiS3Context->BootScriptStackBase + AcpiS3Context->BootScriptStackSize)\r
687 );\r
688 } else {\r
689 //\r
690 // IA32 S3 Resume\r
691 //\r
692 DEBUG (( EFI_D_ERROR, "transfer control to Standalone Boot Script Executor\r\n"));\r
693 SwitchStack (\r
694 (SWITCH_STACK_ENTRY_POINT) (UINTN) EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint,\r
695 (VOID *)AcpiS3Context,\r
696 (VOID *)PeiS3ResumeState,\r
697 (VOID *)(UINTN)(AcpiS3Context->BootScriptStackBase + AcpiS3Context->BootScriptStackSize)\r
698 );\r
699 }\r
700\r
701 //\r
702 // Never run to here\r
703 //\r
704 CpuDeadLoop();\r
705}\r
706/**\r
707 Restores the platform to its preboot configuration for an S3 resume and\r
708 jumps to the OS waking vector.\r
709\r
710 This function will restore the platform to its pre-boot configuration that was\r
711 pre-stored in the boot script table and transfer control to OS waking vector.\r
712 Upon invocation, this function is responsible for locating the following\r
713 information before jumping to OS waking vector:\r
714 - ACPI tables\r
715 - boot script table\r
716 - any other information that it needs\r
717\r
718 The S3RestoreConfig() function then executes the pre-stored boot script table\r
719 and transitions the platform to the pre-boot state. The boot script is recorded\r
720 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and\r
721 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function\r
722 transfers control to the OS waking vector. If the OS supports only a real-mode\r
723 waking vector, this function will switch from flat mode to real mode before\r
724 jumping to the waking vector. If all platform pre-boot configurations are\r
725 successfully restored and all other necessary information is ready, this\r
726 function will never return and instead will directly jump to the OS waking\r
727 vector. If this function returns, it indicates that the attempt to resume\r
728 from the ACPI S3 sleep state failed.\r
729\r
730 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI\r
731\r
732 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.\r
733 @retval EFI_NOT_FOUND Some necessary information that is used for the S3\r
734 resume boot path could not be located.\r
735\r
736**/\r
737EFI_STATUS\r
738EFIAPI\r
739S3RestoreConfig2 (\r
740 IN EFI_PEI_S3_RESUME2_PPI *This\r
741 )\r
742{\r
743 EFI_STATUS Status;\r
744 PEI_SMM_ACCESS_PPI *SmmAccess;\r
745 UINTN Index;\r
746 ACPI_S3_CONTEXT *AcpiS3Context;\r
747 EFI_PEI_READ_ONLY_VARIABLE2_PPI *VariableServices;\r
748 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable;\r
749 EFI_PHYSICAL_ADDRESS TempAcpiS3Context;\r
750 BOOT_SCRIPT_EXECUTOR_VARIABLE *EfiBootScriptExecutorVariable;\r
751 UINTN VarSize;\r
752 EFI_SMRAM_DESCRIPTOR *SmramDescriptor;\r
753 SMM_S3_RESUME_STATE *SmmS3ResumeState;\r
754 VOID *GuidHob;\r
755\r
756 DEBUG ((EFI_D_ERROR, "Enter S3 PEIM\r\n"));\r
757\r
758 Status = PeiServicesLocatePpi (\r
759 &gPeiSmmAccessPpiGuid,\r
760 0,\r
761 NULL,\r
762 (VOID **) &SmmAccess\r
763 );\r
764 for (Index = 0; !EFI_ERROR (Status); Index++) {\r
765 Status = SmmAccess->Open ((EFI_PEI_SERVICES **)GetPeiServicesTablePointer (), SmmAccess, Index);\r
766 }\r
767\r
768 Status = PeiServicesLocatePpi (\r
769 &gEfiPeiReadOnlyVariable2PpiGuid,\r
770 0,\r
771 NULL,\r
772 (VOID **) &VariableServices\r
773 );\r
774 if (EFI_ERROR (Status)) {\r
775 return Status;\r
776 }\r
777\r
778 VarSize = sizeof (EFI_PHYSICAL_ADDRESS);\r
779 Status = RestoreLockBox (\r
780 &gEfiAcpiVariableGuid,\r
781 &TempAcpiS3Context,\r
782 &VarSize\r
783 );\r
784 ASSERT_EFI_ERROR (Status);\r
785\r
786 AcpiS3Context = (ACPI_S3_CONTEXT *)(UINTN)TempAcpiS3Context;\r
787 ASSERT (AcpiS3Context != NULL);\r
788\r
789 Status = RestoreLockBox (\r
790 &gEfiAcpiS3ContextGuid,\r
791 NULL,\r
792 NULL\r
793 );\r
794 ASSERT_EFI_ERROR (Status);\r
795\r
796 VarSize = sizeof (TempEfiBootScriptExecutorVariable);\r
797 Status = RestoreLockBox (\r
798 &gEfiBootScriptExecutorVariableGuid,\r
799 &TempEfiBootScriptExecutorVariable,\r
800 &VarSize\r
801 );\r
802 ASSERT_EFI_ERROR (Status);\r
803\r
804 Status = RestoreLockBox (\r
805 &gEfiBootScriptExecutorContextGuid,\r
806 NULL,\r
807 NULL\r
808 );\r
809 ASSERT_EFI_ERROR (Status);\r
810\r
811 EfiBootScriptExecutorVariable = (BOOT_SCRIPT_EXECUTOR_VARIABLE *) (UINTN) TempEfiBootScriptExecutorVariable;\r
812\r
813 DEBUG (( EFI_D_ERROR, "AcpiS3Context = %x\n", AcpiS3Context));\r
814 DEBUG (( EFI_D_ERROR, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE *) ((UINTN) (AcpiS3Context->AcpiFacsTable)))->FirmwareWakingVector));\r
815 DEBUG (( EFI_D_ERROR, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context->AcpiFacsTable));\r
816 DEBUG (( EFI_D_ERROR, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context->S3NvsPageTableAddress));\r
817 DEBUG (( EFI_D_ERROR, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context->S3DebugBufferAddress));\r
818 DEBUG (( EFI_D_ERROR, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint));\r
819\r
820 //\r
821 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.\r
822 // Script dispatch image and context (parameter) are handled by platform.\r
823 // We just use restore all lock box in place, no need restore one by one.\r
824 //\r
825 Status = RestoreAllLockBoxInPlace ();\r
826 ASSERT_EFI_ERROR (Status);\r
827 if (EFI_ERROR (Status)) {\r
828 // Something wrong\r
829 CpuDeadLoop ();\r
830 }\r
831\r
832 //\r
833 // Attempt to use content from SMRAM first\r
834 //\r
835 GuidHob = GetFirstGuidHob (&gEfiAcpiVariableGuid);\r
836 if (GuidHob != NULL) {\r
837 SmramDescriptor = (EFI_SMRAM_DESCRIPTOR *) GET_GUID_HOB_DATA (GuidHob);\r
838 SmmS3ResumeState = (SMM_S3_RESUME_STATE *)(UINTN)SmramDescriptor->CpuStart;\r
839\r
840 SmmS3ResumeState->ReturnCs = AsmReadCs ();\r
841 SmmS3ResumeState->ReturnEntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)S3ResumeExecuteBootScript;\r
842 SmmS3ResumeState->ReturnContext1 = (EFI_PHYSICAL_ADDRESS)(UINTN)AcpiS3Context;\r
843 SmmS3ResumeState->ReturnContext2 = (EFI_PHYSICAL_ADDRESS)(UINTN)EfiBootScriptExecutorVariable;\r
844 SmmS3ResumeState->ReturnStackPointer = (EFI_PHYSICAL_ADDRESS)(UINTN)&Status;\r
845\r
846 DEBUG (( EFI_D_ERROR, "SMM S3 Signature = %x\n", SmmS3ResumeState->Signature));\r
847 DEBUG (( EFI_D_ERROR, "SMM S3 Stack Base = %x\n", SmmS3ResumeState->SmmS3StackBase));\r
848 DEBUG (( EFI_D_ERROR, "SMM S3 Stack Size = %x\n", SmmS3ResumeState->SmmS3StackSize));\r
849 DEBUG (( EFI_D_ERROR, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState->SmmS3ResumeEntryPoint));\r
850 DEBUG (( EFI_D_ERROR, "SMM S3 CR0 = %x\n", SmmS3ResumeState->SmmS3Cr0));\r
851 DEBUG (( EFI_D_ERROR, "SMM S3 CR3 = %x\n", SmmS3ResumeState->SmmS3Cr3));\r
852 DEBUG (( EFI_D_ERROR, "SMM S3 CR4 = %x\n", SmmS3ResumeState->SmmS3Cr4));\r
853 DEBUG (( EFI_D_ERROR, "SMM S3 Return CS = %x\n", SmmS3ResumeState->ReturnCs));\r
854 DEBUG (( EFI_D_ERROR, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState->ReturnEntryPoint));\r
855 DEBUG (( EFI_D_ERROR, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState->ReturnContext1));\r
856 DEBUG (( EFI_D_ERROR, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState->ReturnContext2));\r
857 DEBUG (( EFI_D_ERROR, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState->ReturnStackPointer));\r
858 DEBUG (( EFI_D_ERROR, "SMM S3 Smst = %x\n", SmmS3ResumeState->Smst));\r
859\r
860 //\r
861 // Disable interrupt of Debug timer.\r
862 //\r
863 SaveAndSetDebugTimerInterrupt (FALSE);\r
864\r
865 if (SmmS3ResumeState->Signature == SMM_S3_RESUME_SMM_32) {\r
866 SwitchStack (\r
867 (SWITCH_STACK_ENTRY_POINT)(UINTN)SmmS3ResumeState->SmmS3ResumeEntryPoint,\r
868 (VOID *)AcpiS3Context,\r
869 0,\r
870 (VOID *)(UINTN)(SmmS3ResumeState->SmmS3StackBase + SmmS3ResumeState->SmmS3StackSize)\r
871 );\r
872 }\r
873 if (SmmS3ResumeState->Signature == SMM_S3_RESUME_SMM_64) {\r
874 //\r
875 // Switch to long mode to complete resume.\r
876 //\r
877\r
878 //\r
879 // Need to make sure the GDT is loaded with values that support long mode and real mode.\r
880 //\r
881 AsmWriteGdtr (&mGdt);\r
882 AsmWriteCr3 ((UINTN)SmmS3ResumeState->SmmS3Cr3);\r
883 AsmEnablePaging64 (\r
884 0x38,\r
885 SmmS3ResumeState->SmmS3ResumeEntryPoint,\r
886 (UINT64)(UINTN)AcpiS3Context,\r
887 0,\r
888 SmmS3ResumeState->SmmS3StackBase + SmmS3ResumeState->SmmS3StackSize\r
889 );\r
890 }\r
891\r
892 }\r
893\r
894 S3ResumeExecuteBootScript (AcpiS3Context, EfiBootScriptExecutorVariable );\r
895 return EFI_SUCCESS;\r
896}\r
897/**\r
898 Main entry for S3 Resume PEIM.\r
899\r
900 This routine is to install EFI_PEI_S3_RESUME2_PPI.\r
901 \r
902 @param FileHandle Handle of the file being invoked.\r
903 @param PeiServices Pointer to PEI Services table.\r
904\r
905 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.\r
906\r
907**/\r
908EFI_STATUS\r
909EFIAPI\r
910PeimS3ResumeEntryPoint (\r
911 IN EFI_PEI_FILE_HANDLE FileHandle,\r
912 IN CONST EFI_PEI_SERVICES **PeiServices\r
913 )\r
914{\r
915 EFI_STATUS Status;\r
916\r
917 //\r
918 // Install S3 Resume Ppi\r
919 //\r
920 Status = (**PeiServices).InstallPpi (PeiServices, &mPpiList);\r
921 ASSERT_EFI_ERROR (Status);\r
922\r
923 return EFI_SUCCESS;\r
924}\r
925\r
EFI Development Kit II mirror for PVE