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