2 This module produces the EFI_PEI_S3_RESUME2_PPI.
3 This module works with StandAloneBootScriptExecutor to S3 resume to OS.
4 This module will execute the boot script saved during last boot and after that,
5 control is passed to OS waking up handler.
7 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
8 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
10 This program and the accompanying materials
11 are licensed and made available under the terms and conditions
12 of the BSD License which accompanies this distribution. The
13 full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #include <Guid/AcpiS3Context.h>
24 #include <Guid/BootScriptExecutorVariable.h>
25 #include <Guid/Performance.h>
26 #include <Ppi/ReadOnlyVariable2.h>
27 #include <Ppi/S3Resume2.h>
28 #include <Ppi/SmmAccess.h>
29 #include <Ppi/PostBootScriptTable.h>
30 #include <Ppi/EndOfPeiPhase.h>
31 #include <Ppi/SmmCommunication.h>
33 #include <Protocol/SmmEndOfS3Resume.h>
35 #include <Library/DebugLib.h>
36 #include <Library/BaseLib.h>
37 #include <Library/TimerLib.h>
38 #include <Library/PeimEntryPoint.h>
39 #include <Library/PeiServicesLib.h>
40 #include <Library/HobLib.h>
41 #include <Library/PerformanceLib.h>
42 #include <Library/PeiServicesTablePointerLib.h>
43 #include <Library/IoLib.h>
44 #include <Library/BaseMemoryLib.h>
45 #include <Library/MemoryAllocationLib.h>
46 #include <Library/PcdLib.h>
47 #include <Library/DebugAgentLib.h>
48 #include <Library/LocalApicLib.h>
49 #include <Library/ReportStatusCodeLib.h>
50 #include <Library/PrintLib.h>
51 #include <Library/HobLib.h>
52 #include <Library/LockBoxLib.h>
53 #include <IndustryStandard/Acpi.h>
56 This macro aligns the address of a variable with auto storage
57 duration down to CPU_STACK_ALIGNMENT.
59 Since the stack grows downward, the result preserves more of the
60 stack than the original address (or the same amount), not less.
62 #define STACK_ALIGN_DOWN(Ptr) \
63 ((UINTN)(Ptr) & ~(UINTN)(CPU_STACK_ALIGNMENT - 1))
65 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
80 UINT32 DefaultSize
: 1;
81 UINT32 Granularity
: 1;
88 // Page-Map Level-4 Offset (PML4) and
89 // Page-Directory-Pointer Offset (PDPE) entries 4K & 2MB
93 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
94 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
95 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
96 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
97 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
98 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
99 UINT64 Reserved
:1; // Reserved
100 UINT64 MustBeZero
:2; // Must Be Zero
101 UINT64 Available
:3; // Available for use by system software
102 UINT64 PageTableBaseAddress
:40; // Page Table Base Address
103 UINT64 AvabilableHigh
:11; // Available for use by system software
104 UINT64 Nx
:1; // No Execute bit
107 } PAGE_MAP_AND_DIRECTORY_POINTER
;
110 // Page Table Entry 2MB
114 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
115 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
116 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
117 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
118 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
119 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
120 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
121 UINT64 MustBe1
:1; // Must be 1
122 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
123 UINT64 Available
:3; // Available for use by system software
125 UINT64 MustBeZero
:8; // Must be zero;
126 UINT64 PageTableBaseAddress
:31; // Page Table Base Address
127 UINT64 AvabilableHigh
:11; // Available for use by system software
128 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
134 // Page Table Entry 1GB
138 UINT64 Present
:1; // 0 = Not present in memory, 1 = Present in memory
139 UINT64 ReadWrite
:1; // 0 = Read-Only, 1= Read/Write
140 UINT64 UserSupervisor
:1; // 0 = Supervisor, 1=User
141 UINT64 WriteThrough
:1; // 0 = Write-Back caching, 1=Write-Through caching
142 UINT64 CacheDisabled
:1; // 0 = Cached, 1=Non-Cached
143 UINT64 Accessed
:1; // 0 = Not accessed, 1 = Accessed (set by CPU)
144 UINT64 Dirty
:1; // 0 = Not Dirty, 1 = written by processor on access to page
145 UINT64 MustBe1
:1; // Must be 1
146 UINT64 Global
:1; // 0 = Not global page, 1 = global page TLB not cleared on CR3 write
147 UINT64 Available
:3; // Available for use by system software
149 UINT64 MustBeZero
:17; // Must be zero;
150 UINT64 PageTableBaseAddress
:22; // Page Table Base Address
151 UINT64 AvabilableHigh
:11; // Available for use by system software
152 UINT64 Nx
:1; // 0 = Execute Code, 1 = No Code Execution
155 } PAGE_TABLE_1G_ENTRY
;
158 // Define two type of smm communicate headers.
159 // One for 32 bits PEI + 64 bits DXE, the other for 32 bits PEI + 32 bits DXE case.
163 UINT32 MessageLength
;
165 } SMM_COMMUNICATE_HEADER_32
;
169 UINT64 MessageLength
;
171 } SMM_COMMUNICATE_HEADER_64
;
176 // Function prototypes
179 a ASM function to transfer control to OS.
181 @param S3WakingVector The S3 waking up vector saved in ACPI Facs table
182 @param AcpiLowMemoryBase a buffer under 1M which could be used during the transfer
186 (EFIAPI
*ASM_TRANSFER_CONTROL
) (
187 IN UINT32 S3WakingVector
,
188 IN UINT32 AcpiLowMemoryBase
192 Restores the platform to its preboot configuration for an S3 resume and
193 jumps to the OS waking vector.
195 This function will restore the platform to its pre-boot configuration that was
196 pre-stored in the boot script table and transfer control to OS waking vector.
197 Upon invocation, this function is responsible for locating the following
198 information before jumping to OS waking vector:
201 - any other information that it needs
203 The S3RestoreConfig() function then executes the pre-stored boot script table
204 and transitions the platform to the pre-boot state. The boot script is recorded
205 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
206 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
207 transfers control to the OS waking vector. If the OS supports only a real-mode
208 waking vector, this function will switch from flat mode to real mode before
209 jumping to the waking vector. If all platform pre-boot configurations are
210 successfully restored and all other necessary information is ready, this
211 function will never return and instead will directly jump to the OS waking
212 vector. If this function returns, it indicates that the attempt to resume
213 from the ACPI S3 sleep state failed.
215 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
217 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
218 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
219 resume boot path could not be located.
225 IN EFI_PEI_S3_RESUME2_PPI
*This
229 Set data segment selectors value including DS/ES/FS/GS/SS.
231 @param[in] SelectorValue Segment selector value to be set.
236 AsmSetDataSelectors (
237 IN UINT16 SelectorValue
243 EFI_PEI_S3_RESUME2_PPI mS3ResumePpi
= { S3RestoreConfig2
};
245 EFI_PEI_PPI_DESCRIPTOR mPpiList
= {
246 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
247 &gEfiPeiS3Resume2PpiGuid
,
251 EFI_PEI_PPI_DESCRIPTOR mPpiListPostScriptTable
= {
252 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
253 &gPeiPostScriptTablePpiGuid
,
257 EFI_PEI_PPI_DESCRIPTOR mPpiListEndOfPeiTable
= {
258 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
259 &gEfiEndOfPeiSignalPpiGuid
,
264 // Global Descriptor Table (GDT)
266 GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT mGdtEntries
[] = {
267 /* selector { Global Segment Descriptor } */
268 /* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
269 /* 0x08 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
270 /* 0x10 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
271 /* 0x18 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 1, 1, 0}},
272 /* 0x20 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
273 /* 0x28 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
274 /* 0x30 */ {{0xFFFF, 0, 0, 0x3, 1, 0, 1, 0xF, 0, 0, 0, 1, 0}},
275 /* 0x38 */ {{0xFFFF, 0, 0, 0xB, 1, 0, 1, 0xF, 0, 1, 0, 1, 0}},
276 /* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
279 #define DATA_SEGEMENT_SELECTOR 0x18
284 GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR mGdt
= {
285 sizeof (mGdtEntries
) - 1,
290 Performance measure function to get S3 detailed performance data.
292 This function will getS3 detailed performance data and saved in pre-reserved ACPI memory.
295 WriteToOsS3PerformanceData (
300 EFI_PHYSICAL_ADDRESS mAcpiLowMemoryBase
;
301 PERF_HEADER
*PerfHeader
;
305 EFI_PEI_READ_ONLY_VARIABLE2_PPI
*VariableServices
;
319 // Retrieve time stamp count as early as possible
321 Ticker
= GetPerformanceCounter ();
323 Freq
= GetPerformanceCounterProperties (&StartValue
, &EndValue
);
325 Freq
= DivU64x32 (Freq
, 1000);
327 Status
= PeiServicesLocatePpi (
328 &gEfiPeiReadOnlyVariable2PpiGuid
,
331 (VOID
**) &VariableServices
333 if (EFI_ERROR (Status
)) {
337 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
338 Status
= VariableServices
->GetVariable (
341 &gPerformanceProtocolGuid
,
346 if (EFI_ERROR (Status
)) {
347 DEBUG ((EFI_D_ERROR
, "Fail to retrieve variable to log S3 performance data \n"));
351 PerfHeader
= (PERF_HEADER
*) (UINTN
) mAcpiLowMemoryBase
;
353 if (PerfHeader
->Signiture
!= PERFORMANCE_SIGNATURE
) {
354 DEBUG ((EFI_D_ERROR
, "Performance data in ACPI memory get corrupted! \n"));
359 // Record total S3 resume time.
361 if (EndValue
>= StartValue
) {
362 PerfHeader
->S3Resume
= Ticker
- StartValue
;
365 PerfHeader
->S3Resume
= StartValue
- Ticker
;
370 // Get S3 detailed performance data
374 while ((LogEntryKey
= GetPerformanceMeasurement (
381 if (EndTicker
!= 0) {
382 PerfData
= &PerfHeader
->S3Entry
[Index
];
385 // Use File Handle to specify the different performance log for PEIM.
386 // File Handle is the base address of PEIM FFS file.
388 if ((AsciiStrnCmp (Token
, "PEIM", PEI_PERFORMANCE_STRING_SIZE
) == 0) && (Handle
!= NULL
)) {
389 AsciiSPrint (PerfData
->Token
, PERF_TOKEN_LENGTH
, "0x%11p", Handle
);
391 AsciiStrnCpyS (PerfData
->Token
, PERF_TOKEN_SIZE
, Token
, PERF_TOKEN_LENGTH
);
393 if (StartTicker
== 1) {
394 StartTicker
= StartValue
;
396 if (EndTicker
== 1) {
397 EndTicker
= StartValue
;
399 Ticker
= CountUp
? (EndTicker
- StartTicker
) : (StartTicker
- EndTicker
);
400 PerfData
->Duration
= (UINT32
) DivU64x32 (Ticker
, (UINT32
) Freq
);
403 // Only Record > 1ms performance data so that more big performance can be recorded.
405 if ((Ticker
> Freq
) && (++Index
>= PERF_PEI_ENTRY_MAX_NUM
)) {
407 // Reach the maximum number of PEI performance log entries.
413 PerfHeader
->S3EntryNum
= (UINT32
) Index
;
417 The function will check if current waking vector is long mode.
419 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
421 @retval TRUE Current context need long mode waking vector.
422 @retval FALSE Current context need not long mode waking vector.
425 IsLongModeWakingVector (
426 IN ACPI_S3_CONTEXT
*AcpiS3Context
429 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
431 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
432 if ((Facs
== NULL
) ||
433 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
434 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
435 // Something wrong with FACS
438 if (Facs
->XFirmwareWakingVector
!= 0) {
439 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
440 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
441 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
442 // Both BIOS and OS wants 64bit vector
443 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
452 Send EndOfS3Resume event to SmmCore through communication buffer way.
454 @retval EFI_SUCCESS Return send the event success.
457 SignalEndOfS3Resume (
462 EFI_PEI_SMM_COMMUNICATION_PPI
*SmmCommunicationPpi
;
464 SMM_COMMUNICATE_HEADER_32 Header32
;
465 SMM_COMMUNICATE_HEADER_64 Header64
;
468 DEBUG ((EFI_D_INFO
, "SignalEndOfS3Resume - Enter\n"));
471 // This buffer consumed in DXE phase, so base on DXE mode to prepare communicate buffer.
472 // Detect whether DXE is 64 bits mode.
473 // if (sizeof(UINTN) == sizeof(UINT64), PEI already 64 bits, assume DXE also 64 bits.
474 // or (FeaturePcdGet (PcdDxeIplSwitchToLongMode)), Dxe will switch to 64 bits.
476 if ((sizeof(UINTN
) == sizeof(UINT64
)) || (FeaturePcdGet (PcdDxeIplSwitchToLongMode
))) {
477 CommBuffer
= &Header64
;
478 Header64
.MessageLength
= 0;
479 CommSize
= OFFSET_OF (SMM_COMMUNICATE_HEADER_64
, Data
);
481 CommBuffer
= &Header32
;
482 Header32
.MessageLength
= 0;
483 CommSize
= OFFSET_OF (SMM_COMMUNICATE_HEADER_32
, Data
);
485 CopyGuid (CommBuffer
, &gEdkiiSmmEndOfS3ResumeProtocolGuid
);
488 // Get needed resource
490 Status
= PeiServicesLocatePpi (
491 &gEfiPeiSmmCommunicationPpiGuid
,
494 (VOID
**)&SmmCommunicationPpi
496 ASSERT_EFI_ERROR (Status
);
501 Status
= SmmCommunicationPpi
->Communicate (
506 ASSERT_EFI_ERROR (Status
);
508 DEBUG ((EFI_D_INFO
, "SignalEndOfS3Resume - Exit (%r)\n", Status
));
514 Jump to OS waking vector.
515 The function will install boot script done PPI, report S3 resume status code, and then jump to OS waking vector.
517 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
518 @param PeiS3ResumeState a pointer to a structure of PEI_S3_RESUME_STATE
523 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
524 IN PEI_S3_RESUME_STATE
*PeiS3ResumeState
528 EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*Facs
;
529 ASM_TRANSFER_CONTROL AsmTransferControl
;
531 UINTN TempStack
[0x10];
536 AsmWriteIdtr (&PeiS3ResumeState
->Idtr
);
538 if (PeiS3ResumeState
->ReturnStatus
!= EFI_SUCCESS
) {
540 // Report Status code that boot script execution is failed
543 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
544 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_BOOT_SCRIPT_ERROR
)
549 // NOTE: Because Debug Timer interrupt and system interrupts will be disabled
550 // in BootScriptExecuteDxe, the rest code in S3ResumeBootOs() cannot be halted
554 PERF_END (NULL
, "ScriptExec", NULL
, 0);
557 // Install BootScriptDonePpi
559 Status
= PeiServicesInstallPpi (&mPpiListPostScriptTable
);
560 ASSERT_EFI_ERROR (Status
);
563 // Get ACPI Table Address
565 Facs
= (EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
));
567 if ((Facs
== NULL
) ||
568 (Facs
->Signature
!= EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE
) ||
569 ((Facs
->FirmwareWakingVector
== 0) && (Facs
->XFirmwareWakingVector
== 0)) ) {
571 // Report Status code that no valid vector is found
574 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
575 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
582 // Install EndOfPeiPpi
584 Status
= PeiServicesInstallPpi (&mPpiListEndOfPeiTable
);
585 ASSERT_EFI_ERROR (Status
);
588 // Signal EndOfS3Resume event.
590 Status
= SignalEndOfS3Resume ();
591 ASSERT_EFI_ERROR (Status
);
594 // report status code on S3 resume
596 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_OS_WAKE
);
599 WriteToOsS3PerformanceData ();
602 AsmTransferControl
= (ASM_TRANSFER_CONTROL
)(UINTN
)PeiS3ResumeState
->AsmTransferControl
;
603 if (Facs
->XFirmwareWakingVector
!= 0) {
605 // Switch to native waking vector
607 TempStackTop
= (UINTN
)&TempStack
+ sizeof(TempStack
);
610 "%a() Stack Base: 0x%x, Stack Size: 0x%x\n",
615 if ((Facs
->Version
== EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_VERSION
) &&
616 ((Facs
->Flags
& EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F
) != 0) &&
617 ((Facs
->Flags
& EFI_ACPI_4_0_OSPM_64BIT_WAKE__F
) != 0)) {
619 // X64 long mode waking vector
621 DEBUG ((DEBUG_INFO
, "Transfer to 64bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
622 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
625 Facs
->XFirmwareWakingVector
,
628 (UINT64
)(UINTN
)TempStackTop
632 // Report Status code that no valid waking vector is found
635 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
636 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
638 DEBUG (( EFI_D_ERROR
, "Unsupported for 32bit DXE transfer to 64bit OS waking vector!\r\n"));
645 // IA32 protected mode waking vector (Page disabled)
647 DEBUG ((DEBUG_INFO
, "Transfer to 32bit OS waking vector - %x\r\n", (UINTN
)Facs
->XFirmwareWakingVector
));
649 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) Facs
->XFirmwareWakingVector
,
652 (VOID
*)(UINTN
)TempStackTop
657 // 16bit Realmode waking vector
659 DEBUG ((DEBUG_INFO
, "Transfer to 16bit OS waking vector - %x\r\n", (UINTN
)Facs
->FirmwareWakingVector
));
660 AsmTransferControl (Facs
->FirmwareWakingVector
, 0x0);
664 // Report Status code the failure of S3Resume
667 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
668 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_OS_WAKE_ERROR
)
678 Restore S3 page table because we do not trust ACPINvs content.
679 If BootScriptExector driver will not run in 64-bit mode, this function will do nothing.
681 @param S3NvsPageTableAddress PageTableAddress in ACPINvs
682 @param Build4GPageTableOnly If BIOS just build 4G page table only
685 RestoreS3PageTables (
686 IN UINTN S3NvsPageTableAddress
,
687 IN BOOLEAN Build4GPageTableOnly
690 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
693 UINT8 PhysicalAddressBits
;
694 EFI_PHYSICAL_ADDRESS PageAddress
;
695 UINTN IndexOfPml4Entries
;
696 UINTN IndexOfPdpEntries
;
697 UINTN IndexOfPageDirectoryEntries
;
698 UINT32 NumberOfPml4EntriesNeeded
;
699 UINT32 NumberOfPdpEntriesNeeded
;
700 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMapLevel4Entry
;
701 PAGE_MAP_AND_DIRECTORY_POINTER
*PageMap
;
702 PAGE_MAP_AND_DIRECTORY_POINTER
*PageDirectoryPointerEntry
;
703 PAGE_TABLE_ENTRY
*PageDirectoryEntry
;
705 BOOLEAN Page1GSupport
;
706 PAGE_TABLE_1G_ENTRY
*PageDirectory1GEntry
;
707 UINT64 AddressEncMask
;
710 // Make sure AddressEncMask is contained to smallest supported address field
712 AddressEncMask
= PcdGet64 (PcdPteMemoryEncryptionAddressOrMask
) & PAGING_1G_ADDRESS_MASK_64
;
715 // NOTE: We have to ASSUME the page table generation format, because we do not know whole page table information.
716 // The whole page table is too large to be saved in SMRAM.
718 // The assumption is : whole page table is allocated in CONTINUOUS memory and CR3 points to TOP page.
720 DEBUG ((DEBUG_INFO
, "S3NvsPageTableAddress - %x (%x)\n", (UINTN
)S3NvsPageTableAddress
, (UINTN
)Build4GPageTableOnly
));
723 // By architecture only one PageMapLevel4 exists - so lets allocate storage for it.
725 PageMap
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
726 S3NvsPageTableAddress
+= SIZE_4KB
;
728 Page1GSupport
= FALSE
;
729 if (PcdGetBool(PcdUse1GPageTable
)) {
730 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
731 if (RegEax
>= 0x80000001) {
732 AsmCpuid (0x80000001, NULL
, NULL
, NULL
, &RegEdx
);
733 if ((RegEdx
& BIT26
) != 0) {
734 Page1GSupport
= TRUE
;
740 // Get physical address bits supported.
742 Hob
= GetFirstHob (EFI_HOB_TYPE_CPU
);
744 PhysicalAddressBits
= ((EFI_HOB_CPU
*) Hob
)->SizeOfMemorySpace
;
746 AsmCpuid (0x80000000, &RegEax
, NULL
, NULL
, NULL
);
747 if (RegEax
>= 0x80000008) {
748 AsmCpuid (0x80000008, &RegEax
, NULL
, NULL
, NULL
);
749 PhysicalAddressBits
= (UINT8
) RegEax
;
751 PhysicalAddressBits
= 36;
756 // IA-32e paging translates 48-bit linear addresses to 52-bit physical addresses.
758 ASSERT (PhysicalAddressBits
<= 52);
759 if (PhysicalAddressBits
> 48) {
760 PhysicalAddressBits
= 48;
764 // NOTE: In order to save time to create full page table, we just create 4G page table by default.
765 // And let PF handler in BootScript driver to create more on request.
767 if (Build4GPageTableOnly
) {
768 PhysicalAddressBits
= 32;
769 ZeroMem (PageMap
, EFI_PAGES_TO_SIZE(2));
772 // Calculate the table entries needed.
774 if (PhysicalAddressBits
<= 39) {
775 NumberOfPml4EntriesNeeded
= 1;
776 NumberOfPdpEntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 30));
778 NumberOfPml4EntriesNeeded
= (UINT32
)LShiftU64 (1, (PhysicalAddressBits
- 39));
779 NumberOfPdpEntriesNeeded
= 512;
782 PageMapLevel4Entry
= PageMap
;
784 for (IndexOfPml4Entries
= 0; IndexOfPml4Entries
< NumberOfPml4EntriesNeeded
; IndexOfPml4Entries
++, PageMapLevel4Entry
++) {
786 // Each PML4 entry points to a page of Page Directory Pointer entires.
787 // So lets allocate space for them and fill them in in the IndexOfPdpEntries loop.
789 PageDirectoryPointerEntry
= (PAGE_MAP_AND_DIRECTORY_POINTER
*)S3NvsPageTableAddress
;
790 S3NvsPageTableAddress
+= SIZE_4KB
;
795 PageMapLevel4Entry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryPointerEntry
| AddressEncMask
;
796 PageMapLevel4Entry
->Bits
.ReadWrite
= 1;
797 PageMapLevel4Entry
->Bits
.Present
= 1;
800 PageDirectory1GEntry
= (VOID
*) PageDirectoryPointerEntry
;
802 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectory1GEntry
++, PageAddress
+= SIZE_1GB
) {
804 // Fill in the Page Directory entries
806 PageDirectory1GEntry
->Uint64
= (UINT64
)PageAddress
| AddressEncMask
;
807 PageDirectory1GEntry
->Bits
.ReadWrite
= 1;
808 PageDirectory1GEntry
->Bits
.Present
= 1;
809 PageDirectory1GEntry
->Bits
.MustBe1
= 1;
812 for (IndexOfPdpEntries
= 0; IndexOfPdpEntries
< NumberOfPdpEntriesNeeded
; IndexOfPdpEntries
++, PageDirectoryPointerEntry
++) {
814 // Each Directory Pointer entries points to a page of Page Directory entires.
815 // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.
817 PageDirectoryEntry
= (PAGE_TABLE_ENTRY
*)S3NvsPageTableAddress
;
818 S3NvsPageTableAddress
+= SIZE_4KB
;
821 // Fill in a Page Directory Pointer Entries
823 PageDirectoryPointerEntry
->Uint64
= (UINT64
)(UINTN
)PageDirectoryEntry
| AddressEncMask
;
824 PageDirectoryPointerEntry
->Bits
.ReadWrite
= 1;
825 PageDirectoryPointerEntry
->Bits
.Present
= 1;
827 for (IndexOfPageDirectoryEntries
= 0; IndexOfPageDirectoryEntries
< 512; IndexOfPageDirectoryEntries
++, PageDirectoryEntry
++, PageAddress
+= SIZE_2MB
) {
829 // Fill in the Page Directory entries
831 PageDirectoryEntry
->Uint64
= (UINT64
)PageAddress
| AddressEncMask
;
832 PageDirectoryEntry
->Bits
.ReadWrite
= 1;
833 PageDirectoryEntry
->Bits
.Present
= 1;
834 PageDirectoryEntry
->Bits
.MustBe1
= 1;
842 // If DXE is running 32-bit mode, no need to establish page table.
849 Jump to boot script executor driver.
851 The function will close and lock SMRAM and then jump to boot script execute driver to executing S3 boot script table.
853 @param AcpiS3Context a pointer to a structure of ACPI_S3_CONTEXT
854 @param EfiBootScriptExecutorVariable The function entry to executing S3 boot Script table. This function is build in
855 boot script execute driver
859 S3ResumeExecuteBootScript (
860 IN ACPI_S3_CONTEXT
*AcpiS3Context
,
861 IN BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
865 PEI_SMM_ACCESS_PPI
*SmmAccess
;
868 IA32_DESCRIPTOR
*IdtDescriptor
;
870 PEI_S3_RESUME_STATE
*PeiS3ResumeState
;
871 BOOLEAN InterruptStatus
;
873 DEBUG ((DEBUG_INFO
, "S3ResumeExecuteBootScript()\n"));
876 // Attempt to use content from SMRAM first
878 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
879 if (GuidHob
!= NULL
) {
881 // Last step for SMM - send SMI for initialization
887 SendSmiIpiAllExcludingSelf ();
891 SendSmiIpi (GetApicId ());
893 Status
= PeiServicesLocatePpi (
894 &gPeiSmmAccessPpiGuid
,
899 if (!EFI_ERROR (Status
)) {
900 DEBUG ((DEBUG_INFO
, "Close all SMRAM regions before executing boot script\n"));
902 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
903 Status
= SmmAccess
->Close ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
906 DEBUG ((DEBUG_INFO
, "Lock all SMRAM regions before executing boot script\n"));
908 for (Index
= 0, Status
= EFI_SUCCESS
; !EFI_ERROR (Status
); Index
++) {
909 Status
= SmmAccess
->Lock ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
914 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
915 AsmWriteCr3 ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
);
918 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
920 // On some platform, such as ECP, a dispatch node in boot script table may execute a 32-bit PEIM which may need PeiServices
921 // pointer. So PeiServices need preserve in (IDTBase- sizeof (UINTN)).
923 IdtDescriptor
= (IA32_DESCRIPTOR
*) (UINTN
) (AcpiS3Context
->IdtrProfile
);
925 // Make sure the newly allocated IDT align with 16-bytes
927 IdtBuffer
= AllocatePages (EFI_SIZE_TO_PAGES((IdtDescriptor
->Limit
+ 1) + 16));
928 if (IdtBuffer
== NULL
) {
930 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
931 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_RESUME_FAILED
)
936 // Additional 16 bytes allocated to save IA32 IDT descriptor and Pei Service Table Pointer
937 // IA32 IDT descriptor will be used to setup IA32 IDT table for 32-bit Framework Boot Script code
939 ZeroMem (IdtBuffer
, 16);
940 AsmReadIdtr ((IA32_DESCRIPTOR
*)IdtBuffer
);
941 CopyMem ((VOID
*)((UINT8
*)IdtBuffer
+ 16),(VOID
*)(IdtDescriptor
->Base
), (IdtDescriptor
->Limit
+ 1));
942 IdtDescriptor
->Base
= (UINTN
)((UINT8
*)IdtBuffer
+ 16);
943 *(UINTN
*)(IdtDescriptor
->Base
- sizeof(UINTN
)) = (UINTN
)GetPeiServicesTablePointer ();
946 InterruptStatus
= SaveAndDisableInterrupts ();
948 // Need to make sure the GDT is loaded with values that support long mode and real mode.
950 AsmWriteGdtr (&mGdt
);
952 // update segment selectors per the new GDT.
954 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
956 // Restore interrupt state.
958 SetInterruptState (InterruptStatus
);
961 // Prepare data for return back
963 PeiS3ResumeState
= AllocatePool (sizeof(*PeiS3ResumeState
));
964 if (PeiS3ResumeState
== NULL
) {
966 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
967 (EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_EC_S3_RESUME_FAILED
)
971 DEBUG ((DEBUG_INFO
, "PeiS3ResumeState - %x\r\n", PeiS3ResumeState
));
972 PeiS3ResumeState
->ReturnCs
= 0x10;
973 PeiS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeBootOs
;
974 PeiS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
978 AsmReadIdtr (&PeiS3ResumeState
->Idtr
);
981 // Report Status Code to indicate S3 boot script execution
983 REPORT_STATUS_CODE (EFI_PROGRESS_CODE
, EFI_SOFTWARE_PEI_MODULE
| EFI_SW_PEI_PC_S3_BOOT_SCRIPT
);
985 PERF_START (NULL
, "ScriptExec", NULL
, 0);
987 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
991 DEBUG ((DEBUG_INFO
, "Enable X64 and transfer control to Standalone Boot Script Executor\r\n"));
994 // Switch to long mode to complete resume.
998 EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
999 (UINT64
)(UINTN
)AcpiS3Context
,
1000 (UINT64
)(UINTN
)PeiS3ResumeState
,
1001 (UINT64
)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
1007 DEBUG ((DEBUG_INFO
, "transfer control to Standalone Boot Script Executor\r\n"));
1009 (SWITCH_STACK_ENTRY_POINT
) (UINTN
) EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
,
1010 (VOID
*)AcpiS3Context
,
1011 (VOID
*)PeiS3ResumeState
,
1012 (VOID
*)(UINTN
)(AcpiS3Context
->BootScriptStackBase
+ AcpiS3Context
->BootScriptStackSize
)
1017 // Never run to here
1022 Restores the platform to its preboot configuration for an S3 resume and
1023 jumps to the OS waking vector.
1025 This function will restore the platform to its pre-boot configuration that was
1026 pre-stored in the boot script table and transfer control to OS waking vector.
1027 Upon invocation, this function is responsible for locating the following
1028 information before jumping to OS waking vector:
1031 - any other information that it needs
1033 The S3RestoreConfig() function then executes the pre-stored boot script table
1034 and transitions the platform to the pre-boot state. The boot script is recorded
1035 during regular boot using the EFI_S3_SAVE_STATE_PROTOCOL.Write() and
1036 EFI_S3_SMM_SAVE_STATE_PROTOCOL.Write() functions. Finally, this function
1037 transfers control to the OS waking vector. If the OS supports only a real-mode
1038 waking vector, this function will switch from flat mode to real mode before
1039 jumping to the waking vector. If all platform pre-boot configurations are
1040 successfully restored and all other necessary information is ready, this
1041 function will never return and instead will directly jump to the OS waking
1042 vector. If this function returns, it indicates that the attempt to resume
1043 from the ACPI S3 sleep state failed.
1045 @param[in] This Pointer to this instance of the PEI_S3_RESUME_PPI
1047 @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
1048 @retval EFI_NOT_FOUND Some necessary information that is used for the S3
1049 resume boot path could not be located.
1055 IN EFI_PEI_S3_RESUME2_PPI
*This
1059 PEI_SMM_ACCESS_PPI
*SmmAccess
;
1061 ACPI_S3_CONTEXT
*AcpiS3Context
;
1062 EFI_PHYSICAL_ADDRESS TempEfiBootScriptExecutorVariable
;
1063 EFI_PHYSICAL_ADDRESS TempAcpiS3Context
;
1064 BOOT_SCRIPT_EXECUTOR_VARIABLE
*EfiBootScriptExecutorVariable
;
1066 EFI_SMRAM_DESCRIPTOR
*SmramDescriptor
;
1067 SMM_S3_RESUME_STATE
*SmmS3ResumeState
;
1069 BOOLEAN Build4GPageTableOnly
;
1070 BOOLEAN InterruptStatus
;
1072 TempAcpiS3Context
= 0;
1073 TempEfiBootScriptExecutorVariable
= 0;
1075 DEBUG ((DEBUG_INFO
, "Enter S3 PEIM\r\n"));
1077 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
1078 Status
= RestoreLockBox (
1079 &gEfiAcpiVariableGuid
,
1083 ASSERT_EFI_ERROR (Status
);
1085 Status
= RestoreLockBox (
1086 &gEfiAcpiS3ContextGuid
,
1090 ASSERT_EFI_ERROR (Status
);
1092 AcpiS3Context
= (ACPI_S3_CONTEXT
*)(UINTN
)TempAcpiS3Context
;
1093 ASSERT (AcpiS3Context
!= NULL
);
1095 VarSize
= sizeof (EFI_PHYSICAL_ADDRESS
);
1096 Status
= RestoreLockBox (
1097 &gEfiBootScriptExecutorVariableGuid
,
1098 &TempEfiBootScriptExecutorVariable
,
1101 ASSERT_EFI_ERROR (Status
);
1103 Status
= RestoreLockBox (
1104 &gEfiBootScriptExecutorContextGuid
,
1108 ASSERT_EFI_ERROR (Status
);
1110 EfiBootScriptExecutorVariable
= (BOOT_SCRIPT_EXECUTOR_VARIABLE
*) (UINTN
) TempEfiBootScriptExecutorVariable
;
1111 ASSERT (EfiBootScriptExecutorVariable
!= NULL
);
1113 DEBUG (( DEBUG_INFO
, "AcpiS3Context = %x\n", AcpiS3Context
));
1114 DEBUG (( DEBUG_INFO
, "Waking Vector = %x\n", ((EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE
*) ((UINTN
) (AcpiS3Context
->AcpiFacsTable
)))->FirmwareWakingVector
));
1115 DEBUG (( DEBUG_INFO
, "AcpiS3Context->AcpiFacsTable = %x\n", AcpiS3Context
->AcpiFacsTable
));
1116 DEBUG (( DEBUG_INFO
, "AcpiS3Context->IdtrProfile = %x\n", AcpiS3Context
->IdtrProfile
));
1117 DEBUG (( DEBUG_INFO
, "AcpiS3Context->S3NvsPageTableAddress = %x\n", AcpiS3Context
->S3NvsPageTableAddress
));
1118 DEBUG (( DEBUG_INFO
, "AcpiS3Context->S3DebugBufferAddress = %x\n", AcpiS3Context
->S3DebugBufferAddress
));
1119 DEBUG (( DEBUG_INFO
, "AcpiS3Context->BootScriptStackBase = %x\n", AcpiS3Context
->BootScriptStackBase
));
1120 DEBUG (( DEBUG_INFO
, "AcpiS3Context->BootScriptStackSize = %x\n", AcpiS3Context
->BootScriptStackSize
));
1121 DEBUG (( DEBUG_INFO
, "EfiBootScriptExecutorVariable->BootScriptExecutorEntrypoint = %x\n", EfiBootScriptExecutorVariable
->BootScriptExecutorEntrypoint
));
1124 // Additional step for BootScript integrity - we only handle BootScript and BootScriptExecutor.
1125 // Script dispatch image and context (parameter) are handled by platform.
1126 // We just use restore all lock box in place, no need restore one by one.
1128 Status
= RestoreAllLockBoxInPlace ();
1129 ASSERT_EFI_ERROR (Status
);
1130 if (EFI_ERROR (Status
)) {
1135 if (FeaturePcdGet (PcdDxeIplSwitchToLongMode
)) {
1137 // Need reconstruct page table here, since we do not trust ACPINvs.
1139 if (IsLongModeWakingVector (AcpiS3Context
)) {
1140 Build4GPageTableOnly
= FALSE
;
1142 Build4GPageTableOnly
= TRUE
;
1144 RestoreS3PageTables ((UINTN
)AcpiS3Context
->S3NvsPageTableAddress
, Build4GPageTableOnly
);
1148 // Attempt to use content from SMRAM first
1150 GuidHob
= GetFirstGuidHob (&gEfiAcpiVariableGuid
);
1151 if (GuidHob
!= NULL
) {
1152 Status
= PeiServicesLocatePpi (
1153 &gPeiSmmAccessPpiGuid
,
1156 (VOID
**) &SmmAccess
1158 for (Index
= 0; !EFI_ERROR (Status
); Index
++) {
1159 Status
= SmmAccess
->Open ((EFI_PEI_SERVICES
**)GetPeiServicesTablePointer (), SmmAccess
, Index
);
1162 SmramDescriptor
= (EFI_SMRAM_DESCRIPTOR
*) GET_GUID_HOB_DATA (GuidHob
);
1163 SmmS3ResumeState
= (SMM_S3_RESUME_STATE
*)(UINTN
)SmramDescriptor
->CpuStart
;
1165 SmmS3ResumeState
->ReturnCs
= AsmReadCs ();
1166 SmmS3ResumeState
->ReturnEntryPoint
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)S3ResumeExecuteBootScript
;
1167 SmmS3ResumeState
->ReturnContext1
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)AcpiS3Context
;
1168 SmmS3ResumeState
->ReturnContext2
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)EfiBootScriptExecutorVariable
;
1169 SmmS3ResumeState
->ReturnStackPointer
= (EFI_PHYSICAL_ADDRESS
)STACK_ALIGN_DOWN (&Status
);
1171 DEBUG (( DEBUG_INFO
, "SMM S3 Signature = %x\n", SmmS3ResumeState
->Signature
));
1172 DEBUG (( DEBUG_INFO
, "SMM S3 Stack Base = %x\n", SmmS3ResumeState
->SmmS3StackBase
));
1173 DEBUG (( DEBUG_INFO
, "SMM S3 Stack Size = %x\n", SmmS3ResumeState
->SmmS3StackSize
));
1174 DEBUG (( DEBUG_INFO
, "SMM S3 Resume Entry Point = %x\n", SmmS3ResumeState
->SmmS3ResumeEntryPoint
));
1175 DEBUG (( DEBUG_INFO
, "SMM S3 CR0 = %x\n", SmmS3ResumeState
->SmmS3Cr0
));
1176 DEBUG (( DEBUG_INFO
, "SMM S3 CR3 = %x\n", SmmS3ResumeState
->SmmS3Cr3
));
1177 DEBUG (( DEBUG_INFO
, "SMM S3 CR4 = %x\n", SmmS3ResumeState
->SmmS3Cr4
));
1178 DEBUG (( DEBUG_INFO
, "SMM S3 Return CS = %x\n", SmmS3ResumeState
->ReturnCs
));
1179 DEBUG (( DEBUG_INFO
, "SMM S3 Return Entry Point = %x\n", SmmS3ResumeState
->ReturnEntryPoint
));
1180 DEBUG (( DEBUG_INFO
, "SMM S3 Return Context1 = %x\n", SmmS3ResumeState
->ReturnContext1
));
1181 DEBUG (( DEBUG_INFO
, "SMM S3 Return Context2 = %x\n", SmmS3ResumeState
->ReturnContext2
));
1182 DEBUG (( DEBUG_INFO
, "SMM S3 Return Stack Pointer = %x\n", SmmS3ResumeState
->ReturnStackPointer
));
1183 DEBUG (( DEBUG_INFO
, "SMM S3 Smst = %x\n", SmmS3ResumeState
->Smst
));
1185 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_32
) {
1187 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1188 (VOID
*)AcpiS3Context
,
1190 (VOID
*)(UINTN
)(SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
)
1193 if (SmmS3ResumeState
->Signature
== SMM_S3_RESUME_SMM_64
) {
1195 // Switch to long mode to complete resume.
1198 InterruptStatus
= SaveAndDisableInterrupts ();
1200 // Need to make sure the GDT is loaded with values that support long mode and real mode.
1202 AsmWriteGdtr (&mGdt
);
1204 // update segment selectors per the new GDT.
1206 AsmSetDataSelectors (DATA_SEGEMENT_SELECTOR
);
1208 // Restore interrupt state.
1210 SetInterruptState (InterruptStatus
);
1212 AsmWriteCr3 ((UINTN
)SmmS3ResumeState
->SmmS3Cr3
);
1215 // Disable interrupt of Debug timer, since IDT table cannot work in long mode.
1216 // NOTE: On x64 platforms, because DisablePaging64() will disable interrupts,
1217 // the code in S3ResumeExecuteBootScript() cannot be halted by soft debugger.
1219 SaveAndSetDebugTimerInterrupt (FALSE
);
1223 SmmS3ResumeState
->SmmS3ResumeEntryPoint
,
1224 (UINT64
)(UINTN
)AcpiS3Context
,
1226 SmmS3ResumeState
->SmmS3StackBase
+ SmmS3ResumeState
->SmmS3StackSize
1232 S3ResumeExecuteBootScript (AcpiS3Context
, EfiBootScriptExecutorVariable
);
1236 Main entry for S3 Resume PEIM.
1238 This routine is to install EFI_PEI_S3_RESUME2_PPI.
1240 @param FileHandle Handle of the file being invoked.
1241 @param PeiServices Pointer to PEI Services table.
1243 @retval EFI_SUCCESS S3Resume Ppi is installed successfully.
1248 PeimS3ResumeEntryPoint (
1249 IN EFI_PEI_FILE_HANDLE FileHandle
,
1250 IN CONST EFI_PEI_SERVICES
**PeiServices
1256 // Install S3 Resume Ppi
1258 Status
= (**PeiServices
).InstallPpi (PeiServices
, &mPpiList
);
1259 ASSERT_EFI_ERROR (Status
);